include/editeng/editview.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 // MyEDITVIEW, due to exported EditView
  20 #ifndef INCLUDED_EDITENG_EDITVIEW_HXX
  21 #define INCLUDED_EDITENG_EDITVIEW_HXX
  22
  23 #include <memory>
  24 #include <com/sun/star/i18n/WordType.hpp>
  25
  26 #include <rsc/rscsfx.hxx>
  27 #include <i18nlangtag/lang.h>
  28 #include <tools/color.hxx>
  29 #include <tools/gen.hxx>
  30 #include <tools/link.hxx>
  31 #include <vcl/cursor.hxx>
  32 #include <editeng/editstat.hxx>
  33 #include <svl/languageoptions.hxx>
  34 #include <LibreOfficeKit/LibreOfficeKitTypes.h>
  35 #include <editeng/editdata.hxx>
  36 #include <com/sun/star/uno/Reference.h>
  37 #include <editeng/editengdllapi.h>
  38
  39
  40 class EditEngine;
  41 class ImpEditEngine;
  42 class ImpEditView;
  43 class OutlinerViewShell;
  44 class SvxSearchItem;
  45 class SvxFieldItem;
  46 namespace vcl { class Window; }
  47 class Pointer;
  48 class KeyEvent;
  49 class MouseEvent;
  50 class CommandEvent;
  51 namespace tools { class Rectangle; }
  52 class Pair;
  53 class Point;
  54 class Range;
  55 class SvStream;
  56 class SvKeyValueIterator;
  57 class SfxStyleSheet;
  58 namespace vcl { class Font; }
  59 class FontList;
  60 class OutputDevice;
  61 enum class TransliterationFlags;
  62
  63 namespace com {
  64 namespace sun {
  65 namespace star {
  66 namespace datatransfer {
  67     class XTransferable;
  68 }
  69 namespace linguistic2 {
  70     class XSpellChecker1;
  71     class XLanguageGuessing;
  72 }
  73 }}}
  74
  75 enum class ScrollRangeCheck
  76 {
  77     NoNegative    = 1,   // No negative VisArea when scrolling
  78     PaperWidthTextSize = 2,   // VisArea must be within paper width, Text Size
  79 };
  80
  81
  82 class EDITENG_DLLPUBLIC EditView final
  83 {
  84     friend class EditEngine;
  85     friend class ImpEditEngine;
  86     friend class EditSelFunctionSet;
  87
  88 public:
  89     typedef std::vector<VclPtr<vcl::Window>> OutWindowSet;
  90
  91 public: // Needed for Undo
  92     ImpEditView*    GetImpEditView() const      { return pImpEditView.get(); }
  93     ImpEditEngine*  GetImpEditEngine() const;
  94
  95 private:
  96     std::unique_ptr<ImpEditView>
  97                     pImpEditView;
  98     OUString        aDicNameSingle;
  99
 100                     EditView( const EditView& ) = delete;
 101     EditView&       operator=( const EditView& ) = delete;
 102
 103 public:
 104                     EditView( EditEngine* pEng, vcl::Window* pWindow );
 105                     ~EditView();
 106
 107     void            SetEditEngine( EditEngine* pEditEngine );
 108     EditEngine*     GetEditEngine() const;
 109
 110     void            SetWindow( vcl::Window* pWin );
 111     vcl::Window*    GetWindow() const;
 112
 113     bool            HasOtherViewWindow( vcl::Window* pWin );
 114     bool            AddOtherViewWindow( vcl::Window* pWin );
 115     bool            RemoveOtherViewWindow( vcl::Window* pWin );
 116
 117     void            Paint( const tools::Rectangle& rRect, OutputDevice* pTargetDevice = nullptr );
 118     tools::Rectangle       GetInvalidateRect() const;
 119     void            InvalidateOtherViewWindows( const tools::Rectangle& rInvRect );
 120     void            Invalidate();
 121     Pair            Scroll( long nHorzScroll, long nVertScroll, ScrollRangeCheck nRangeCheck = ScrollRangeCheck::NoNegative );
 122
 123     void            ShowCursor( bool bGotoCursor = true, bool bForceVisCursor = true, bool bActivate = false );
 124     void            HideCursor( bool bDeactivate = false );
 125
 126     void            SetSelectionMode( EESelectionMode eMode );
 127
 128     void            SetReadOnly( bool bReadOnly );
 129     bool            IsReadOnly() const;
 130
 131     bool            HasSelection() const;
 132     ESelection      GetSelection() const;
 133     void            SetSelection( const ESelection& rNewSel );
 134     void            SelectCurrentWord( sal_Int16 nWordType = css::i18n::WordType::ANYWORD_IGNOREWHITESPACES );
 135     /// Returns the rectangles of the current selection in TWIPs.
 136     void GetSelectionRectangles(std::vector<tools::Rectangle>& rLogicRects) const;
 137
 138     bool            IsInsertMode() const;
 139     void            SetInsertMode( bool bInsert );
 140
 141     OUString        GetSelected();
 142     void            DeleteSelected();
 143
 144     SvtScriptType       GetSelectedScriptType() const;
 145
 146                         // VisArea position of the Output window.
 147                         // A size change also affects the VisArea
 148     void                SetOutputArea( const tools::Rectangle& rRect );
 149     const tools::Rectangle&    GetOutputArea() const;
 150
 151                         // Document position.
 152                         // A size change also affects the VisArea
 153     void                SetVisArea( const tools::Rectangle& rRect );
 154     const tools::Rectangle&    GetVisArea() const;
 155
 156     const Pointer&  GetPointer() const;
 157
 158     vcl::Cursor*    GetCursor() const;
 159
 160     void            InsertText( const OUString& rNew, bool bSelect = false );
 161
 162     bool            PostKeyEvent( const KeyEvent& rKeyEvent, vcl::Window* pFrameWin = nullptr );
 163
 164     bool            MouseButtonUp( const MouseEvent& rMouseEvent );
 165     bool            MouseButtonDown( const MouseEvent& rMouseEvent );
 166     void            ReleaseMouse();
 167     bool            MouseMove( const MouseEvent& rMouseEvent );
 168     void            Command( const CommandEvent& rCEvt );
 169
 170     void            Cut();
 171     void            Copy();
 172     void            Paste();
 173     void            PasteSpecial();
 174
 175     void            Undo();
 176     void            Redo();
 177
 178     // especially for Oliver Specht
 179     Point           GetWindowPosTopLeft( sal_Int32 nParagraph );
 180     void            MoveParagraphs( Range aParagraphs, sal_Int32 nNewPos );
 181     void            MoveParagraphs( long nDiff );
 182
 183     const SfxItemSet&   GetEmptyItemSet();
 184     SfxItemSet          GetAttribs();
 185     void                SetAttribs( const SfxItemSet& rSet );
 186     void                RemoveAttribs( bool bRemoveParaAttribs = false, sal_uInt16 nWhich = 0 );
 187     void                RemoveCharAttribs( sal_Int32 nPara, sal_uInt16 nWhich );
 188     void                RemoveAttribsKeepLanguages( bool bRemoveParaAttribs );
 189
 190     sal_uInt32          Read( SvStream& rInput, EETextFormat eFormat, SvKeyValueIterator* pHTTPHeaderAttrs );
 191
 192     void            SetBackgroundColor( const Color& rColor );
 193     Color           GetBackgroundColor() const;
 194
 195     /// Informs this edit view about which view shell contains it.
 196     void RegisterViewShell(OutlinerViewShell* pViewShell);
 197     /// Informs this edit view about which other shell listens to it.
 198     void RegisterOtherShell(OutlinerViewShell* pOtherShell);
 199
 200     void            SetControlWord( EVControlBits nWord );
 201     EVControlBits   GetControlWord() const;
 202
 203     EditTextObject* CreateTextObject();
 204     void            InsertText( const EditTextObject& rTextObject );
 205     void            InsertText( css::uno::Reference< css::datatransfer::XTransferable > const & xDataObj, const OUString& rBaseURL, bool bUseSpecial );
 206
 207     css::uno::Reference< css::datatransfer::XTransferable > GetTransferable();
 208
 209     // An EditView, so that when TRUE the update will be free from flickering:
 210     void            SetEditEngineUpdateMode( bool bUpdate );
 211     void            ForceUpdate();
 212
 213     const SfxStyleSheet* GetStyleSheet() const;
 214     SfxStyleSheet* GetStyleSheet();
 215
 216     void            SetAnchorMode( EEAnchorMode eMode );
 217     EEAnchorMode    GetAnchorMode() const;
 218
 219     void            CompleteAutoCorrect( vcl::Window* pFrameWin = nullptr );
 220
 221     EESpellState    StartSpeller( bool bMultipleDoc = false );
 222     EESpellState    StartThesaurus();
 223     sal_Int32       StartSearchAndReplace( const SvxSearchItem& rSearchItem );
 224
 225     // for text conversion
 226     void            StartTextConversion( LanguageType nSrcLang, LanguageType nDestLang, const vcl::Font *pDestFont, sal_Int32 nOptions, bool bIsInteractive, bool bMultipleDoc );
 227
 228     void            TransliterateText( TransliterationFlags nTransliterationMode );
 229
 230     bool            IsCursorAtWrongSpelledWord();
 231     bool            IsWrongSpelledWordAtPos( const Point& rPosPixel, bool bMarkIfWrong = false );
 232     void            ExecuteSpellPopup( const Point& rPosPixel, Link<SpellCallbackInfo&,void>* pCallBack );
 233
 234     void                InsertField( const SvxFieldItem& rFld );
 235     const SvxFieldItem* GetFieldUnderMousePointer() const;
 236     const SvxFieldItem* GetFieldUnderMousePointer( sal_Int32& nPara, sal_Int32& nPos ) const;
 237     const SvxFieldItem* GetField( const Point& rPos, sal_Int32* pnPara = nullptr, sal_Int32* pnPos = nullptr ) const;
 238
 239     const SvxFieldItem* GetFieldAtSelection() const;
 240
 241     void            SetInvalidateMore( sal_uInt16 nPixel );
 242     sal_uInt16      GetInvalidateMore() const;
 243
 244     // grows or shrinks the font height for the current selection
 245     void            ChangeFontSize( bool bGrow, const FontList* pList );
 246
 247     static bool     ChangeFontSize( bool bGrow, SfxItemSet& rSet, const FontList* pFontList );
 248
 249     OUString        GetSurroundingText() const;
 250     Selection       GetSurroundingTextSelection() const;
 251
 252     /** Tries to determine the language of 'rText', returning a matching known
 253         locale if possible, or a fallback, or LANGUAGE_NONE if nothing found or
 254         matched.
 255
 256         @param bIsParaText
 257                 If TRUE, rText is a paragraph and the language is obtained by
 258                 passing the text to xLangGuess.
 259                 IF FALSE, a language match is tried for, in order,
 260                     1. the default document language (non-CTL, non-CJK, aka LATIN)
 261                     2. the UI language (Tools->Options->LanguageSettings->Languages User Interface)
 262                     3. the locale (Tools->Options->LanguageSettings->Languages Locale)
 263                     4. en-US
 264                     If nothing matched, LANGUAGE_NONE is returned.
 265     */
 266     static LanguageType CheckLanguage(
 267                             const OUString &rText,
 268                             const css::uno::Reference< css::linguistic2::XSpellChecker1 >& xSpell,
 269                             const css::uno::Reference< css::linguistic2::XLanguageGuessing >& xLangGuess,
 270                             bool bIsParaText );
 271     /// Allows adjusting the point or mark of the selection to a document coordinate.
 272     void SetCursorLogicPosition(const Point& rPosition, bool bPoint, bool bClearMark);
 273     /// Trigger selection drawing callback in pOtherShell based on our shell's selection state.
 274     void DrawSelection(OutlinerViewShell* pOtherShell);
 275 };
 276
 277 #endif // INCLUDED_EDITENG_EDITVIEW_HXX
 278
 279 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */