/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ /* * This file is part of the LibreOffice project. * * This Source Code Form is subject to the terms of the Mozilla Public * License, v. 2.0. If a copy of the MPL was not distributed with this * file, You can obtain one at http://mozilla.org/MPL/2.0/. * * This file incorporates work covered by the following license notice: * * Licensed to the Apache Software Foundation (ASF) under one or more * contributor license agreements. See the NOTICE file distributed * with this work for additional information regarding copyright * ownership. The ASF licenses this file to you under the Apache * License, Version 2.0 (the "License"); you may not use this file * except in compliance with the License. You may obtain a copy of * the License at http://www.apache.org/licenses/LICENSE-2.0 . */ #ifndef INCLUDED_EDITENG_UNOEDSRC_HXX #define INCLUDED_EDITENG_UNOEDSRC_HXX #include #include #include #include #include #include #include #include #include struct ESelection; struct EFieldInfo; struct EBulletInfo; class Color; class OutputDevice; class SfxItemSet; class SvxTextForwarder; class SvxViewForwarder; class SvxEditViewForwarder; class SvxFieldItem; class SfxBroadcaster; class SvxUnoTextRangeBase; typedef std::vector< SvxUnoTextRangeBase* > SvxUnoTextRangeBaseVec; /** Wrapper class for unified EditEngine/Outliner access This class wraps a textual object, which might or might not contain an EditEngine/Outliner. Is used e.g. for filling an EditEngine with the content of a cell, note page or page template. */ class EDITENG_DLLPUBLIC SvxEditSource { public: SvxEditSource() = default; SvxEditSource(SvxEditSource const &) = default; SvxEditSource(SvxEditSource &&) = default; SvxEditSource & operator =(SvxEditSource const &) = default; SvxEditSource & operator =(SvxEditSource &&) = default; virtual ~SvxEditSource(); /// Returns a new reference to the same object. This is a shallow copy virtual std::unique_ptr Clone() const = 0; /** Query the text forwarder @return the text forwarder, or NULL if the underlying object is dead */ virtual SvxTextForwarder* GetTextForwarder() = 0; /** Query the view forwarder @return the view forwarder, or NULL if the underlying object is dead, or if no view is available @derive default implementation provided, overriding is optional */ virtual SvxViewForwarder* GetViewForwarder(); /** Query the edit view forwarder @param bCreate Determines whether an EditView should be created, if there is none active. If set to sal_True, and the underlying object is not in EditMode, the text forwarder changes and the object is set to EditMode. @return the edit view forwarder, or NULL if the underlying object is dead, or if no view is available (if bCreate is sal_False, NULL is also returned if the object is not in EditMode) @derive default implementation provided, overriding is optional @attention If this method is called with bCreate equal to sal_True, all previously returned text forwarder can become invalid */ virtual SvxEditViewForwarder* GetEditViewForwarder( bool bCreate = false ); /// Write back data to model virtual void UpdateData() = 0; /** Returns broadcaster the underlying edit engine's events are sent from @derive default implementation provided, overriding is optional */ virtual SfxBroadcaster& GetBroadcaster() const; /** adds the given SvxUnoTextRangeBase to the text object capsulated by this SvxEditSource. This allows the text object to inform all created text ranges about changes and also allows to re use already created instances. All SvxUnoTextRangeBase must remove itself with removeRange() before they are deleted. */ virtual void addRange( SvxUnoTextRangeBase* pNewRange ); /** removes the given SvxUnoTextRangeBase from the text object capsulated by this SvxEditSource. This text range will not be informed any longer of changes on the underlying text and will also not re used anymore. */ virtual void removeRange( SvxUnoTextRangeBase* pOldRange ); /** returns a const list of all text ranges that are registered for the underlying text object. */ virtual const SvxUnoTextRangeBaseVec& getRanges() const; }; /** Contains an EditEngine or an Outliner and unifies access to them. The EditEngine-UNO objects use this class only. To reflect changes not only in the EditEngine, but also in the model data, call SvxEditSource::UpdateData(). This copies back the data to the model's EditTextObject/OutlinerParaObject. */ class EDITENG_DLLPUBLIC SvxTextForwarder { public: virtual ~SvxTextForwarder() COVERITY_NOEXCEPT_FALSE; virtual sal_Int32 GetParagraphCount() const = 0; virtual sal_Int32 GetTextLen( sal_Int32 nParagraph ) const = 0; virtual OUString GetText( const ESelection& rSel ) const = 0; virtual SfxItemSet GetAttribs( const ESelection& rSel, EditEngineAttribs nOnlyHardAttrib = EditEngineAttribs::All ) const = 0; virtual SfxItemSet GetParaAttribs( sal_Int32 nPara ) const = 0; virtual void SetParaAttribs( sal_Int32 nPara, const SfxItemSet& rSet ) = 0; virtual void RemoveAttribs( const ESelection& rSelection ) = 0; virtual void GetPortions( sal_Int32 nPara, std::vector& rList ) const = 0; virtual OUString GetStyleSheet(sal_Int32 nPara) const = 0; virtual void SetStyleSheet(sal_Int32 nPara, const OUString& rStyleName) = 0; virtual SfxItemState GetItemState( const ESelection& rSel, sal_uInt16 nWhich ) const = 0; virtual SfxItemState GetItemState( sal_Int32 nPara, sal_uInt16 nWhich ) const = 0; virtual void QuickInsertText( const OUString& rText, const ESelection& rSel ) = 0; virtual void QuickInsertField( const SvxFieldItem& rFld, const ESelection& rSel ) = 0; virtual void QuickSetAttribs( const SfxItemSet& rSet, const ESelection& rSel ) = 0; virtual void QuickInsertLineBreak( const ESelection& rSel ) = 0; virtual OUString CalcFieldValue( const SvxFieldItem& rField, sal_Int32 nPara, sal_Int32 nPos, std::optional& rpTxtColor, std::optional& rpFldColor, std::optional& rpFldLineStyle ) = 0; virtual void FieldClicked( const SvxFieldItem& rField ) = 0; virtual SfxItemPool* GetPool() const = 0; virtual const SfxItemSet* GetEmptyItemSetPtr() = 0; // implementation functions for XParagraphAppend and XTextPortionAppend virtual void AppendParagraph() = 0; virtual sal_Int32 AppendTextPortion( sal_Int32 nPara, const OUString &rText, const SfxItemSet &rSet ) = 0; // XTextCopy virtual void CopyText(const SvxTextForwarder& rSource) = 0; /** Query state of forwarder @return false, if no longer valid */ virtual bool IsValid() const = 0; /** Query language of character at given position on the underlying edit engine @param nPara[0 .. n-1] Index of paragraph to query language in @param nIndex[0 .. m-1] Index of character to query language of */ virtual LanguageType GetLanguage( sal_Int32 nPara, sal_Int32 nIndex ) const = 0; /** Query information for fields in the underlying edit engine @param nPara[0 .. n-1] Index of paragraph to query field info in */ virtual std::vector GetFieldInfo( sal_Int32 nPara ) const = 0; /** Query information regarding bullets for given paragraph on the underlying edit engine @param nPara[0 .. n-1] Index of paragraph to query bullet info on */ virtual EBulletInfo GetBulletInfo( sal_Int32 nPara ) const = 0; /** Query the bounding rectangle of the given character @param nPara[0 .. n] Index of paragraph to query the bounds in.

The virtual character after the last character of the represented text, i.e. the one at position n is a special case. Because it does not represent an existing character its bounding box is defined in relation to preceding characters. It should be roughly equivalent to the bounding box of some character when inserted at the end of the text. Its height typically being the maximal height of all the characters in the text or the height of the preceding character, its width being at least one pixel so that the bounding box is not degenerate.
@param nIndex[0 .. m-1] Index of character to query the bounds of @return rectangle in logical coordinates, relative to upper left corner of text. The coordinates returned here are to be interpreted in the map mode given by GetMapMode(). */ virtual tools::Rectangle GetCharBounds( sal_Int32 nPara, sal_Int32 nIndex ) const = 0; /** Query the bounding rectangle of the given paragraph @param nPara[0 .. n-1] Index of paragraph to query the bounds of @return rectangle in logical coordinates, relative to upper left corner of text. The coordinates returned here are to be interpreted in the map mode given by GetMapMode(). */ virtual tools::Rectangle GetParaBounds( sal_Int32 nPara ) const = 0; /** Query the map mode of the underlying EditEngine/Outliner @return the map mode used on the EditEngine/Outliner. The values returned by GetParaBounds() and GetCharBounds() are to be interpreted in this map mode, the point given to GetIndexAtPoint() is interpreted in this map mode. */ virtual MapMode GetMapMode() const = 0; /** Query the reference output device of the underlying EditEngine/Outliner @return the OutputDevice used from the EditEngine/Outliner to format the text. It should be used when performing e.g. font calculations, since this is usually a printer with fonts and resolution different from the screen. */ virtual OutputDevice* GetRefDevice() const = 0; /** Query paragraph and character index of the character at the given point. Returns sal_True on success, sal_False otherwise @param rPoint Point to query text position of. Is interpreted in logical coordinates, relative to the upper left corner of the text, and in the map mode given by GetMapMode() @param rPara[0 .. n-1] Index of paragraph the point is within @param rIndex[0 .. m-1] Index of character the point is over @return true, if the point is over any text and both rPara and rIndex are valid */ virtual bool GetIndexAtPoint( const Point& rPoint, sal_Int32& rPara, sal_Int32& rIndex ) const = 0; /** Get the start and the end index of the word at the given index An index value on a word leads from the first character of that word up to and including the last space before the next word. The index values returned do not contain any leading or trailing white-space. If the input indices are invalid, sal_False is returned. @param nPara[0 .. n-1] Index of paragraph to start the search in @param nIndex[0 .. m-1] Index of character to query the search on @param rStart Start index (in the same paragraph) @param rEnd End index (in the same paragraph), this point to the last character still contained in the query @return true, if the result is non-empty */ virtual bool GetWordIndices( sal_Int32 nPara, sal_Int32 nIndex, sal_Int32& rStart, sal_Int32& rEnd ) const = 0; /** Query range of similar attributes Please note that the range returned is half-open: [nStartIndex,nEndIndex) @param nStartIndex Herein, the start index of the range of similar attributes is returned @param nEndIndex Herein, the end index (exclusive) of the range of similar attributes is returned @param nIndex The character index from which the range of similar attributed characters is requested @return true, if the range has been successfully determined */ virtual bool GetAttributeRun( sal_Int32& nStartIndex, sal_Int32& nEndIndex, sal_Int32 nPara, sal_Int32 nIndex, bool bInCell = false ) const = 0; /** Query number of lines in the formatted paragraph @param nPara[0 .. n-1] Index of paragraph to query number of lines in @return number of lines in given paragraph */ virtual sal_Int32 GetLineCount( sal_Int32 nPara ) const = 0; /** Query line length @param nPara[0 .. n-1] Index of paragraph to query line length in @param nLine[0 .. m-1] Index of line in paragraph to query line length of */ virtual sal_Int32 GetLineLen( sal_Int32 nPara, sal_Int32 nLine ) const = 0; /** Query bounds of line in paragraph @param rStart [output param; 0 .. text_len] The index in the paragraph text that belongs to the chara at the start of the line @param rEnd [output param; 0 .. text_len] The index in the paragraph text that follows the last chara in the line @param nParagraph[0 .. n-1] Index of paragraph to query line length in @param nLine[0 .. m-1] Index of line in paragraph to query line length of */ virtual void GetLineBoundaries( /*out*/sal_Int32 &rStart, /*out*/sal_Int32 &rEnd, sal_Int32 nParagraph, sal_Int32 nLine ) const = 0; /** Query the line number for an index in the paragraphs text @param nPara[0 .. n-1] Index of paragraph to query line length in @param nIndex[0 .. m-1] Index of the char in the paragraph text @returns [0 .. k-1] The line number of the char in the paragraph */ virtual sal_Int32 GetLineNumberAtIndex( sal_Int32 nPara, sal_Int32 nIndex ) const = 0; /** Delete given text range and reformat text @param rSelection The text range to be deleted @return true if text has been successfully deleted */ virtual bool Delete( const ESelection& rSelection ) = 0; /** Insert/Replace given text in given range and reformat text @param rText Text to insert/replace @param rSel Selection where text should be replaced. The empty selection inserts @return true if text has been successfully inserted */ virtual bool InsertText( const OUString& rText, const ESelection& rSel ) = 0; /** Updates the formatting @see EditEngine::QuickFormatDoc() for details @return true if text have been successfully reformatted */ virtual bool QuickFormatDoc( bool bFull = false ) = 0; // Is able to use Outline depth functions (GetDepth and SetDepth) meaningfully virtual bool SupportsOutlineDepth() const = 0; /** Get the outline depth of given paragraph @param nPara Index of the paragraph to query the depth of @return the outline level of the given paragraph. The range is [0,n), where n is the maximal outline level. */ virtual sal_Int16 GetDepth( sal_Int32 nPara ) const = 0; /** Set the outline depth of given paragraph @param nPara Index of the paragraph to set the depth of @param nNewDepth The depth to set on the given paragraph. The range is [0,n), where n is the maximal outline level. @return true, if depth could be successfully set. Reasons for failure are e.g. the text does not support outline level (EditEngine), or the depth range is exceeded. */ virtual bool SetDepth( sal_Int32 nPara, sal_Int16 nNewDepth ) = 0; virtual sal_Int32 GetNumberingStartValue( sal_Int32 nPara ); virtual void SetNumberingStartValue( sal_Int32 nPara, sal_Int32 nNumberingStartValue ); virtual bool IsParaIsNumberingRestart( sal_Int32 nPara ); virtual void SetParaIsNumberingRestart( sal_Int32 nPara, bool bParaIsNumberingRestart ); }; /** Encapsulates the document view for the purpose of unified EditEngine/Outliner access. This one has to be different from the SvxEditViewForwarder, since the latter is only valid in edit mode. */ class EDITENG_DLLPUBLIC SvxViewForwarder { public: virtual ~SvxViewForwarder(); /** Query state of forwarder @return sal_False, if no longer valid */ virtual bool IsValid() const = 0; /** Convert from logical, EditEngine-relative coordinates to screen coordinates @param rPoint Point in logical, EditEngine-relative coordinates. @param rMapMode The map mode to interpret the coordinates in. @return the point in screen coordinates */ virtual Point LogicToPixel( const Point& rPoint, const MapMode& rMapMode ) const = 0; /** Convert from screen to logical, EditEngine-relative coordinates @param rPoint Point in screen coordinates @param rMapMode The map mode to interpret the coordinates in. @return the point in logical coordinates. */ virtual Point PixelToLogic( const Point& rPoint, const MapMode& rMapMode ) const = 0; }; /** Encapsulates EditView and OutlinerView for the purpose of unified EditEngine/Outliner access */ class SvxEditViewForwarder : public SvxViewForwarder { public: /** Query current selection. @param rSelection Contains the current selection after method call @return false, if there is no view or no selection (the empty selection _is_ a selection) */ virtual bool GetSelection( ESelection& rSelection ) const = 0; /** Set selection in view. @param rSelection The selection to set @return false, if there is no view or selection is invalid */ virtual bool SetSelection( const ESelection& rSelection ) = 0; /** Copy current selection to clipboard. @return false if no selection or no view (the empty selection _is_ a selection) */ virtual bool Copy() = 0; /** Cut current selection to clipboard. @return false if no selection or no view (the empty selection _is_ a selection) */ virtual bool Cut() = 0; /** Paste clipboard into current selection. @return false if no view or no selection (the empty selection _is_ a selection) */ virtual bool Paste() = 0; }; #endif /* vim:set shiftwidth=4 softtabstop=4 expandtab: */