#include <unoforou.hxx>

Inheritance diagram for SvxOutlinerForwarder:

Collaboration diagram for SvxOutlinerForwarder:

Public Member Functions
	SvxOutlinerForwarder (Outliner &rOutl, bool bOutlText)

virtual	~SvxOutlinerForwarder () override

virtual sal_Int32	GetParagraphCount () const override

virtual sal_Int32	GetTextLen (sal_Int32 nParagraph) const override

virtual OUString	GetText (const ESelection &rSel) const override

virtual SfxItemSet	GetAttribs (const ESelection &rSel, EditEngineAttribs nOnlyHardAttrib=EditEngineAttribs::All) const override

virtual SfxItemSet	GetParaAttribs (sal_Int32 nPara) const override

virtual void	SetParaAttribs (sal_Int32 nPara, const SfxItemSet &rSet) override

virtual void	RemoveAttribs (const ESelection &rSelection) override

virtual void	GetPortions (sal_Int32 nPara, std::vector< sal_Int32 > &rList) const override

virtual OUString	GetStyleSheet (sal_Int32 nPara) const override

virtual void	SetStyleSheet (sal_Int32 nPara, const OUString &rStyleName) override

virtual SfxItemState	GetItemState (const ESelection &rSel, sal_uInt16 nWhich) const override

virtual SfxItemState	GetItemState (sal_Int32 nPara, sal_uInt16 nWhich) const override

virtual void	QuickInsertText (const OUString &rText, const ESelection &rSel) override

virtual void	QuickInsertField (const SvxFieldItem &rFld, const ESelection &rSel) override

virtual void	QuickSetAttribs (const SfxItemSet &rSet, const ESelection &rSel) override

virtual void	QuickInsertLineBreak (const ESelection &rSel) override

virtual SfxItemPool *	GetPool () const override

virtual OUString	CalcFieldValue (const SvxFieldItem &rField, sal_Int32 nPara, sal_Int32 nPos, std::optional< Color > &rpTxtColor, std::optional< Color > &rpFldColor, std::optional< FontLineStyle > &rpFldLineStyle) override

virtual void	FieldClicked (const SvxFieldItem &rField) override

virtual bool	IsValid () const override
	Query state of forwarder. More...

virtual LanguageType	GetLanguage (sal_Int32, sal_Int32) const override
	Query language of character at given position on the underlying edit engine. More...

virtual sal_Int32	GetFieldCount (sal_Int32 nPara) const override
	Query number of fields in the underlying edit engine. More...

virtual EFieldInfo	GetFieldInfo (sal_Int32 nPara, sal_uInt16 nField) const override
	Query information for given field number in the underlying edit engine. More...

virtual EBulletInfo	GetBulletInfo (sal_Int32 nPara) const override
	Query information regarding bullets for given paragraph on the underlying edit engine. More...

virtual tools::Rectangle	GetCharBounds (sal_Int32 nPara, sal_Int32 nIndex) const override
	Query the bounding rectangle of the given character. More...

virtual tools::Rectangle	GetParaBounds (sal_Int32 nPara) const override
	Query the bounding rectangle of the given paragraph. More...

virtual MapMode	GetMapMode () const override
	Query the map mode of the underlying EditEngine/Outliner. More...

virtual OutputDevice *	GetRefDevice () const override
	Query the reference output device of the underlying EditEngine/Outliner. More...

virtual bool	GetIndexAtPoint (const Point &, sal_Int32 &nPara, sal_Int32 &nIndex) const override
	Query paragraph and character index of the character at the given point. More...

virtual bool	GetWordIndices (sal_Int32 nPara, sal_Int32 nIndex, sal_Int32 &nStart, sal_Int32 &nEnd) const override
	Get the start and the end index of the word at the given index. More...

virtual bool	GetAttributeRun (sal_Int32 &nStartIndex, sal_Int32 &nEndIndex, sal_Int32 nPara, sal_Int32 nIndex, bool bInCell=false) const override
	Query range of similar attributes. More...

virtual sal_Int32	GetLineCount (sal_Int32 nPara) const override
	Query number of lines in the formatted paragraph. More...

virtual sal_Int32	GetLineLen (sal_Int32 nPara, sal_Int32 nLine) const override
	Query line length. More...

virtual void	GetLineBoundaries (sal_Int32 &rStart, sal_Int32 &rEnd, sal_Int32 nPara, sal_Int32 nLine) const override
	Query bounds of line in paragraph. More...

virtual sal_Int32	GetLineNumberAtIndex (sal_Int32 nPara, sal_Int32 nIndex) const override
	Query the line number for an index in the paragraphs text. More...

virtual bool	Delete (const ESelection &) override
	Delete given text range and reformat text. More...

virtual bool	InsertText (const OUString &, const ESelection &) override
	Insert/Replace given text in given range and reformat text. More...

virtual bool	QuickFormatDoc (bool bFull=false) override
	Updates the formatting. More...

virtual sal_Int16	GetDepth (sal_Int32 nPara) const override
	Get the outline depth of given paragraph. More...

virtual bool	SetDepth (sal_Int32 nPara, sal_Int16 nNewDepth) override
	Set the outline depth of given paragraph. More...

virtual sal_Int32	GetNumberingStartValue (sal_Int32 nPara) override

virtual void	SetNumberingStartValue (sal_Int32 nPara, sal_Int32 nNumberingStartValue) override

virtual bool	IsParaIsNumberingRestart (sal_Int32 nPara) override

virtual void	SetParaIsNumberingRestart (sal_Int32 nPara, bool bParaIsNumberingRestart) override

void	flushCache ()

virtual const SfxItemSet *	GetEmptyItemSetPtr () override

virtual void	AppendParagraph () override

virtual sal_Int32	AppendTextPortion (sal_Int32 nPara, const OUString &rText, const SfxItemSet &rSet) override

virtual void	CopyText (const SvxTextForwarder &rSource) override

Public Member Functions inherited from SvxTextForwarder
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< sal_Int32 > &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< Color > &rpTxtColor, std::optional< Color > &rpFldColor, std::optional< FontLineStyle > &rpFldLineStyle)=0

virtual void	FieldClicked (const SvxFieldItem &rField)=0

virtual SfxItemPool *	GetPool () const =0

virtual const SfxItemSet *	GetEmptyItemSetPtr ()=0

virtual void	AppendParagraph ()=0

virtual sal_Int32	AppendTextPortion (sal_Int32 nPara, const OUString &rText, const SfxItemSet &rSet)=0

virtual void	CopyText (const SvxTextForwarder &rSource)=0

virtual bool	IsValid () const =0
	Query state of forwarder. More...

virtual LanguageType	GetLanguage (sal_Int32 nPara, sal_Int32 nIndex) const =0
	Query language of character at given position on the underlying edit engine. More...

virtual sal_Int32	GetFieldCount (sal_Int32 nPara) const =0
	Query number of fields in the underlying edit engine. More...

virtual EFieldInfo	GetFieldInfo (sal_Int32 nPara, sal_uInt16 nField) const =0
	Query information for given field number in the underlying edit engine. More...

virtual EBulletInfo	GetBulletInfo (sal_Int32 nPara) const =0
	Query information regarding bullets for given paragraph on the underlying edit engine. More...

virtual tools::Rectangle	GetCharBounds (sal_Int32 nPara, sal_Int32 nIndex) const =0
	Query the bounding rectangle of the given character. More...

virtual tools::Rectangle	GetParaBounds (sal_Int32 nPara) const =0
	Query the bounding rectangle of the given paragraph. More...

virtual MapMode	GetMapMode () const =0
	Query the map mode of the underlying EditEngine/Outliner. More...

virtual OutputDevice *	GetRefDevice () const =0
	Query the reference output device of the underlying EditEngine/Outliner. More...

virtual bool	GetIndexAtPoint (const Point &rPoint, sal_Int32 &rPara, sal_Int32 &rIndex) const =0
	Query paragraph and character index of the character at the given point. More...

virtual bool	GetWordIndices (sal_Int32 nPara, sal_Int32 nIndex, sal_Int32 &rStart, sal_Int32 &rEnd) const =0
	Get the start and the end index of the word at the given index. More...

virtual bool	GetAttributeRun (sal_Int32 &nStartIndex, sal_Int32 &nEndIndex, sal_Int32 nPara, sal_Int32 nIndex, bool bInCell=false) const =0
	Query range of similar attributes. More...

virtual sal_Int32	GetLineCount (sal_Int32 nPara) const =0
	Query number of lines in the formatted paragraph. More...

virtual sal_Int32	GetLineLen (sal_Int32 nPara, sal_Int32 nLine) const =0
	Query line length. More...

virtual void	GetLineBoundaries (sal_Int32 &rStart, sal_Int32 &rEnd, sal_Int32 nParagraph, sal_Int32 nLine) const =0
	Query bounds of line in paragraph. More...

virtual sal_Int32	GetLineNumberAtIndex (sal_Int32 nPara, sal_Int32 nIndex) const =0
	Query the line number for an index in the paragraphs text. More...

virtual bool	Delete (const ESelection &rSelection)=0
	Delete given text range and reformat text. More...

virtual bool	InsertText (const OUString &rText, const ESelection &rSel)=0
	Insert/Replace given text in given range and reformat text. More...

virtual bool	QuickFormatDoc (bool bFull=false)=0
	Updates the formatting. More...

virtual sal_Int16	GetDepth (sal_Int32 nPara) const =0
	Get the outline depth of given paragraph. More...

virtual bool	SetDepth (sal_Int32 nPara, sal_Int16 nNewDepth)=0
	Set the outline depth of given paragraph. More...

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)

Private Attributes
Outliner &	rOutliner

bool	bOutlinerText

std::optional< SfxItemSet >	moAttribsCache
	this pointer may be null or point to an item set for the attribs of the selection maAttribsSelection More...

ESelection	maAttribCacheSelection
	if we have a cached attribute item set, this is the selection of it More...

std::optional< SfxItemSet >	moParaAttribsCache
	this pointer may be null or point to an item set for the paragraph mnParaAttribsCache More...

sal_Int32	mnParaAttribsCache
	if we have a cached para attribute item set, this is the paragraph of it More...

Detailed Description

Definition at line 33 of file unoforou.hxx.

Constructor & Destructor Documentation

◆ SvxOutlinerForwarder()

SvxOutlinerForwarder::SvxOutlinerForwarder	(	Outliner &	rOutl,
		bool	bOutlText
	)

Definition at line 40 of file unoforou.cxx.

◆ ~SvxOutlinerForwarder()

SvxOutlinerForwarder::~SvxOutlinerForwarder ( )

overridevirtual

Definition at line 47 of file unoforou.cxx.

References flushCache().

Member Function Documentation

◆ AppendParagraph()

void SvxOutlinerForwarder::AppendParagraph ( )

overridevirtual

Implements SvxTextForwarder.

Definition at line 531 of file unoforou.cxx.

References Outliner::GetEditEngine(), EditEngine::GetParagraphCount(), EditEngine::InsertParagraph(), and rOutliner.

◆ AppendTextPortion()

sal_Int32 SvxOutlinerForwarder::AppendTextPortion	(	sal_Int32	nPara,
		const OUString &	rText,
		const SfxItemSet &	rSet
	)

overridevirtual

Implements SvxTextForwarder.

Definition at line 537 of file unoforou.cxx.

References DBG_ASSERT, Outliner::GetEditEngine(), EditEngine::GetParagraphCount(), EditEngine::GetTextLen(), EditEngine::QuickInsertText(), and rOutliner.

◆ CalcFieldValue()

OUString SvxOutlinerForwarder::CalcFieldValue	(	const SvxFieldItem &	rField,
		sal_Int32	nPara,
		sal_Int32	nPos,
		std::optional< Color > &	rpTxtColor,
		std::optional< Color > &	rpFldColor,
		std::optional< FontLineStyle > &	rpFldLineStyle
	)

overridevirtual

Implements SvxTextForwarder.

Definition at line 234 of file unoforou.cxx.

References Outliner::CalcFieldValue(), nPos, and rOutliner.

◆ CopyText()

void SvxOutlinerForwarder::CopyText ( const SvxTextForwarder & rSource )

overridevirtual

Implements SvxTextForwarder.

Definition at line 553 of file unoforou.cxx.

References Outliner::CreateParaObject(), rOutliner, and Outliner::SetText().

◆ Delete()

bool SvxOutlinerForwarder::Delete ( const ESelection & rSelection )

overridevirtual

Delete given text range and reformat text.

Parameters

rSelection The text range to be deleted

Returns: true if text has been successfully deleted

Implements SvxTextForwarder.

Definition at line 421 of file unoforou.cxx.

References flushCache(), Outliner::QuickDelete(), Outliner::QuickFormatDoc(), and rOutliner.

◆ FieldClicked()

void SvxOutlinerForwarder::FieldClicked ( const SvxFieldItem & rField )

overridevirtual

Implements SvxTextForwarder.

Definition at line 239 of file unoforou.cxx.

◆ flushCache()

void SvxOutlinerForwarder::flushCache ( )

Definition at line 262 of file unoforou.cxx.

References moAttribsCache, and moParaAttribsCache.

Referenced by Delete(), InsertText(), QuickInsertField(), QuickInsertLineBreak(), QuickInsertText(), QuickSetAttribs(), SetParaAttribs(), and ~SvxOutlinerForwarder().

◆ GetAttribs()

SfxItemSet SvxOutlinerForwarder::GetAttribs	(	const ESelection &	rSel,
		EditEngineAttribs	nOnlyHardAttrib = `EditEngineAttribs::All`
	)		const

overridevirtual

Does it not exist on the Outliner? and why is the GetAttribs on the EditEngine not a const?

Implements SvxTextForwarder.

Definition at line 95 of file unoforou.cxx.

References All, Outliner::GetEditEngine(), SfxStyleSheetBase::GetItemSet(), EditEngine::GetStyleSheet(), ImplOutlinerForwarderGetAttribs(), maAttribCacheSelection, moAttribsCache, ESelection::nStartPara, rOutliner, and SfxItemSet::SetParent().

◆ GetAttributeRun()

bool SvxOutlinerForwarder::GetAttributeRun	(	sal_Int32 &	nStartIndex,
		sal_Int32 &	nEndIndex,
		sal_Int32	nPara,
		sal_Int32	nIndex,
		bool	bInCell = `false`
	)		const

overridevirtual

Query range of similar attributes.

Please note that the range returned is half-open: [nStartIndex,nEndIndex)

Parameters

nStartIndex	Herein, the start index of the range of similar attributes is returned
nEndIndex	Herein, the end index (exclusive) of the range of similar attributes is returned
nIndex	The character index from which the range of similar attributed characters is requested

Returns: true, if the range has been successfully determined

Implements SvxTextForwarder.

Definition at line 388 of file unoforou.cxx.

References SvxEditSourceHelper::GetAttributeRun(), Outliner::GetEditEngine(), nIndex, and rOutliner.

◆ GetBulletInfo()

EBulletInfo SvxOutlinerForwarder::GetBulletInfo ( sal_Int32 nPara ) const

overridevirtual

Query information regarding bullets for given paragraph on the underlying edit engine.

Parameters

nPara[0 .. n-1] Index of paragraph to query bullet info on

Implements SvxTextForwarder.

Definition at line 283 of file unoforou.cxx.

References Outliner::GetBulletInfo(), and rOutliner.

◆ GetCharBounds()

tools::Rectangle SvxOutlinerForwarder::GetCharBounds	(	sal_Int32	nPara,
		sal_Int32	nIndex
	)		const

overridevirtual

Query the bounding rectangle of the given character.

Parameters

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.

Parameters

nIndex[0 .. m-1] Index of character to query the bounds of

Returns: 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().

Implements SvxTextForwarder.

Definition at line 288 of file unoforou.cxx.

References Outliner::CalcTextSize(), SvxEditSourceHelper::EEToUserSpace(), EditEngine::GetCharacterBounds(), Outliner::GetEditEngine(), tools::Rectangle::GetHeight(), Outliner::GetLineHeight(), GetParaBounds(), GetTextLen(), Size::Height(), Outliner::IsVertical(), tools::Rectangle::Left(), tools::Rectangle::Move(), nIndex, tools::Rectangle::Right(), rOutliner, Size::setHeight(), tools::Rectangle::SetSize(), Size::setWidth(), and Size::Width().

◆ GetDepth()

sal_Int16 SvxOutlinerForwarder::GetDepth ( sal_Int32 nPara ) const

overridevirtual

Get the outline depth of given paragraph.

Parameters

nPara Index of the paragraph to query the depth of

Returns: the outline level of the given paragraph. The range is [0,n), where n is the maximal outline level.

Implements SvxTextForwarder.

Definition at line 439 of file unoforou.cxx.

References DBG_ASSERT, Outliner::GetDepth(), Outliner::GetParagraph(), GetParagraphCount(), and rOutliner.

◆ GetEmptyItemSetPtr()

const SfxItemSet * SvxOutlinerForwarder::GetEmptyItemSetPtr ( )

overridevirtual

Implements SvxTextForwarder.

Definition at line 525 of file unoforou.cxx.

References Outliner::GetEditEngine(), EditEngine::GetEmptyItemSet(), and rOutliner.

◆ GetFieldCount()

sal_Int32 SvxOutlinerForwarder::GetFieldCount ( sal_Int32 nPara ) const

overridevirtual

Query number of fields in the underlying edit engine.

Parameters

nPara[0 .. n-1] Index of paragraph to query field number in

Implements SvxTextForwarder.

Definition at line 273 of file unoforou.cxx.

References Outliner::GetEditEngine(), EditEngine::GetFieldCount(), and rOutliner.

◆ GetFieldInfo()

EFieldInfo SvxOutlinerForwarder::GetFieldInfo	(	sal_Int32	nPara,
		sal_uInt16	nField
	)		const

overridevirtual

Query information for given field number in the underlying edit engine.

Parameters

nPara[0	.. n-1] Index of paragraph to query field info in
nField[0	.. m-1] Index of field to query information of

Implements SvxTextForwarder.

Definition at line 278 of file unoforou.cxx.

References Outliner::GetEditEngine(), EditEngine::GetFieldInfo(), and rOutliner.

◆ GetIndexAtPoint()

bool SvxOutlinerForwarder::GetIndexAtPoint	(	const Point &	rPoint,
		sal_Int32 &	rPara,
		sal_Int32 &	rIndex
	)		const

overridevirtual

Query paragraph and character index of the character at the given point.

Returns sal_True on success, sal_False otherwise

Parameters

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()
rPara[0	.. n-1] Index of paragraph the point is within
rIndex[0	.. m-1] Index of character the point is over

Returns: true, if the point is over any text and both rPara and rIndex are valid

Implements SvxTextForwarder.

Definition at line 353 of file unoforou.cxx.

References Outliner::CalcTextSize(), EditEngine::FindDocPosition(), Outliner::GetEditEngine(), Size::Height(), Outliner::IsVertical(), nIndex, EPosition::nIndex, EPosition::nPara, rOutliner, Size::setHeight(), Size::setWidth(), SvxEditSourceHelper::UserSpaceToEE(), and Size::Width().

◆ GetItemState() [1/2]

SfxItemState SvxOutlinerForwarder::GetItemState	(	const ESelection &	rSel,
		sal_uInt16	nWhich
	)		const

overridevirtual

Implements SvxTextForwarder.

Definition at line 250 of file unoforou.cxx.

References Outliner::GetEditEngine(), GetSvxEditEngineItemState(), and rOutliner.

◆ GetItemState() [2/2]

SfxItemState SvxOutlinerForwarder::GetItemState	(	sal_Int32	nPara,
		sal_uInt16	nWhich
	)		const

overridevirtual

Implements SvxTextForwarder.

Definition at line 255 of file unoforou.cxx.

References SfxItemSet::GetItemState(), Outliner::GetParaAttribs(), rOutliner, and rSet.

◆ GetLanguage()

LanguageType SvxOutlinerForwarder::GetLanguage	(	sal_Int32	nPara,
		sal_Int32	nIndex
	)		const

overridevirtual

Query language of character at given position on the underlying edit engine.

Parameters

nPara[0	.. n-1] Index of paragraph to query language in
nIndex[0	.. m-1] Index of character to query language of

Implements SvxTextForwarder.

Definition at line 268 of file unoforou.cxx.

References Outliner::GetLanguage(), nIndex, and rOutliner.

◆ GetLineBoundaries()

void SvxOutlinerForwarder::GetLineBoundaries	(	sal_Int32 &	rStart,
		sal_Int32 &	rEnd,
		sal_Int32	nParagraph,
		sal_Int32	nLine
	)		const

overridevirtual

Query bounds of line in paragraph.

Parameters

rStart	[output param; 0 .. text_len] The index in the paragraph text that belongs to the chara at the start of the line
rEnd	[output param; 0 .. text_len] The index in the paragraph text that follows the last chara in the line
nParagraph[0	.. n-1] Index of paragraph to query line length in
nLine[0	.. m-1] Index of line in paragraph to query line length of

Implements SvxTextForwarder.

Definition at line 404 of file unoforou.cxx.

References Outliner::GetEditEngine(), EditEngine::GetLineBoundaries(), and rOutliner.

◆ GetLineCount()

sal_Int32 SvxOutlinerForwarder::GetLineCount ( sal_Int32 nPara ) const

overridevirtual

Query number of lines in the formatted paragraph.

Parameters

nPara[0 .. n-1] Index of paragraph to query number of lines in

Returns: number of lines in given paragraph

Implements SvxTextForwarder.

Definition at line 394 of file unoforou.cxx.

References Outliner::GetLineCount(), and rOutliner.

◆ GetLineLen()

sal_Int32 SvxOutlinerForwarder::GetLineLen	(	sal_Int32	nPara,
		sal_Int32	nLine
	)		const

overridevirtual

Query line length.

Parameters

nPara[0	.. n-1] Index of paragraph to query line length in
nLine[0	.. m-1] Index of line in paragraph to query line length of

Implements SvxTextForwarder.

Definition at line 399 of file unoforou.cxx.

References Outliner::GetLineLen(), and rOutliner.

◆ GetLineNumberAtIndex()

sal_Int32 SvxOutlinerForwarder::GetLineNumberAtIndex	(	sal_Int32	nPara,
		sal_Int32	nIndex
	)		const

overridevirtual

Query the line number for an index in the paragraphs text.

Parameters

nPara[0	.. n-1] Index of paragraph to query line length in
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

Implements SvxTextForwarder.

Definition at line 409 of file unoforou.cxx.

References Outliner::GetEditEngine(), EditEngine::GetLineNumberAtIndex(), nIndex, and rOutliner.

◆ GetMapMode()

MapMode SvxOutlinerForwarder::GetMapMode ( ) const

overridevirtual

Query the map mode of the underlying EditEngine/Outliner.

Returns: 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.

Implements SvxTextForwarder.

Definition at line 343 of file unoforou.cxx.

References Outliner::GetRefMapMode(), and rOutliner.

◆ GetNumberingStartValue()

sal_Int32 SvxOutlinerForwarder::GetNumberingStartValue ( sal_Int32 nPara )

overridevirtual

Reimplemented from SvxTextForwarder.

Definition at line 475 of file unoforou.cxx.

References Outliner::GetNumberingStartValue(), GetParagraphCount(), and rOutliner.

◆ GetParaAttribs()

SfxItemSet SvxOutlinerForwarder::GetParaAttribs ( sal_Int32 nPara ) const

overridevirtual

Implements SvxTextForwarder.

Definition at line 131 of file unoforou.cxx.

References Outliner::GetEditEngine(), SfxStyleSheetBase::GetItemSet(), Outliner::GetParaAttribs(), EditEngine::GetStyleSheet(), mnParaAttribsCache, moParaAttribsCache, and rOutliner.

◆ GetParaBounds()

tools::Rectangle SvxOutlinerForwarder::GetParaBounds ( sal_Int32 nPara ) const

overridevirtual

Query the bounding rectangle of the given paragraph.

Parameters

nPara[0 .. n-1] Index of paragraph to query the bounds of

Returns: 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().

Implements SvxTextForwarder.

Definition at line 338 of file unoforou.cxx.

References Outliner::GetParaBounds(), and rOutliner.

Referenced by GetCharBounds().

◆ GetParagraphCount()

sal_Int32 SvxOutlinerForwarder::GetParagraphCount ( ) const

overridevirtual

Implements SvxTextForwarder.

Definition at line 52 of file unoforou.cxx.

References Outliner::GetParagraphCount(), and rOutliner.

Referenced by GetDepth(), GetNumberingStartValue(), IsParaIsNumberingRestart(), SetDepth(), SetNumberingStartValue(), and SetParaIsNumberingRestart().

◆ GetPool()

SfxItemPool * SvxOutlinerForwarder::GetPool ( ) const

overridevirtual

Implements SvxTextForwarder.

Definition at line 179 of file unoforou.cxx.

References Outliner::GetEmptyItemSet(), SfxItemSet::GetPool(), and rOutliner.

◆ GetPortions()

void SvxOutlinerForwarder::GetPortions	(	sal_Int32	nPara,
		std::vector< sal_Int32 > &	rList
	)		const

overridevirtual

Implements SvxTextForwarder.

Definition at line 184 of file unoforou.cxx.

References Outliner::GetEditEngine(), GetPortions(), and rOutliner.

Referenced by GetPortions().

◆ GetRefDevice()

OutputDevice * SvxOutlinerForwarder::GetRefDevice ( ) const

overridevirtual

Query the reference output device of the underlying EditEngine/Outliner.

Returns: 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.

Implements SvxTextForwarder.

Definition at line 348 of file unoforou.cxx.

References Outliner::GetRefDevice(), and rOutliner.

◆ GetStyleSheet()

OUString SvxOutlinerForwarder::GetStyleSheet ( sal_Int32 nPara ) const

overridevirtual

Implements SvxTextForwarder.

Definition at line 189 of file unoforou.cxx.

References Outliner::GetStyleSheet(), and rOutliner.

◆ GetText()

OUString SvxOutlinerForwarder::GetText ( const ESelection & rSel ) const

overridevirtual

GetText (ESelection) should probably also be in the Outliner

Implements SvxTextForwarder.

Definition at line 62 of file unoforou.cxx.

References Outliner::GetEditEngine(), EditEngine::GetText(), and rOutliner.

◆ GetTextLen()

sal_Int32 SvxOutlinerForwarder::GetTextLen ( sal_Int32 nParagraph ) const

overridevirtual

Implements SvxTextForwarder.

Definition at line 57 of file unoforou.cxx.

References Outliner::GetEditEngine(), EditEngine::GetTextLen(), and rOutliner.

Referenced by GetCharBounds().

◆ GetWordIndices()

bool SvxOutlinerForwarder::GetWordIndices	(	sal_Int32	nPara,
		sal_Int32	nIndex,
		sal_Int32 &	rStart,
		sal_Int32 &	rEnd
	)		const

overridevirtual

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.

Parameters

nPara[0	.. n-1] Index of paragraph to start the search in
nIndex[0	.. m-1] Index of character to query the search on
rStart	Start index (in the same paragraph)
rEnd	End index (in the same paragraph), this point to the last character still contained in the query

Returns: true, if the result is non-empty

Implements SvxTextForwarder.

Definition at line 372 of file unoforou.cxx.

References Outliner::GetEditEngine(), EditEngine::GetWord(), ESelection::nEndPara, ESelection::nEndPos, nIndex, ESelection::nStartPara, ESelection::nStartPos, and rOutliner.

◆ InsertText()

bool SvxOutlinerForwarder::InsertText	(	const OUString &	rText,
		const ESelection &	rSel
	)

overridevirtual

Insert/Replace given text in given range and reformat text.

Parameters

rText	Text to insert/replace
rSel	Selection where text should be replaced. The empty selection inserts

Returns: true if text has been successfully inserted

Implements SvxTextForwarder.

Definition at line 430 of file unoforou.cxx.

References flushCache(), Outliner::QuickFormatDoc(), Outliner::QuickInsertText(), and rOutliner.

◆ IsParaIsNumberingRestart()

bool SvxOutlinerForwarder::IsParaIsNumberingRestart ( sal_Int32 nPara )

overridevirtual

Reimplemented from SvxTextForwarder.

Definition at line 500 of file unoforou.cxx.

References GetParagraphCount(), Outliner::IsParaIsNumberingRestart(), and rOutliner.

◆ IsValid()

bool SvxOutlinerForwarder::IsValid ( ) const

overridevirtual

Query state of forwarder.

Returns: false, if no longer valid

Implements SvxTextForwarder.

Definition at line 243 of file unoforou.cxx.

References Outliner::IsUpdateLayout(), and rOutliner.

◆ QuickFormatDoc()

bool SvxOutlinerForwarder::QuickFormatDoc ( bool bFull = false )

overridevirtual

Updates the formatting.

See also: EditEngine::QuickFormatDoc() for details

Returns: true if text have been successfully reformatted

Implements SvxTextForwarder.

Definition at line 414 of file unoforou.cxx.

References Outliner::QuickFormatDoc(), and rOutliner.

◆ QuickInsertField()

void SvxOutlinerForwarder::QuickInsertField	(	const SvxFieldItem &	rFld,
		const ESelection &	rSel
	)

overridevirtual

Implements SvxTextForwarder.

Definition at line 222 of file unoforou.cxx.

References flushCache(), Outliner::QuickInsertField(), and rOutliner.

◆ QuickInsertLineBreak()

void SvxOutlinerForwarder::QuickInsertLineBreak ( const ESelection & rSel )

overridevirtual

Implements SvxTextForwarder.

Definition at line 216 of file unoforou.cxx.

References flushCache(), Outliner::QuickInsertLineBreak(), and rOutliner.

◆ QuickInsertText()

void SvxOutlinerForwarder::QuickInsertText	(	const OUString &	rText,
		const ESelection &	rSel
	)

overridevirtual

Implements SvxTextForwarder.

Definition at line 203 of file unoforou.cxx.

References flushCache(), Outliner::QuickDelete(), Outliner::QuickInsertText(), and rOutliner.

◆ QuickSetAttribs()

void SvxOutlinerForwarder::QuickSetAttribs	(	const SfxItemSet &	rSet,
		const ESelection &	rSel
	)

overridevirtual

Implements SvxTextForwarder.

Definition at line 228 of file unoforou.cxx.

References flushCache(), Outliner::QuickSetAttribs(), rOutliner, and rSet.

◆ RemoveAttribs()

void SvxOutlinerForwarder::RemoveAttribs ( const ESelection & rSelection )

overridevirtual

Implements SvxTextForwarder.

Definition at line 174 of file unoforou.cxx.

References Outliner::RemoveAttribs(), and rOutliner.

◆ SetDepth()

bool SvxOutlinerForwarder::SetDepth	(	sal_Int32	nPara,
		sal_Int16	nNewDepth
	)

overridevirtual

Set the outline depth of given paragraph.

Parameters

nPara	Index of the paragraph to set the depth of
nNewDepth	The depth to set on the given paragraph. The range is [0,n), where n is the maximal outline level.

Returns: 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.

Implements SvxTextForwarder.

Definition at line 453 of file unoforou.cxx.

References bOutlinerText, DBG_ASSERT, Outliner::GetParagraph(), GetParagraphCount(), rOutliner, Outliner::SetDepth(), and Outliner::SetLevelDependentStyleSheet().

◆ SetNumberingStartValue()

void SvxOutlinerForwarder::SetNumberingStartValue	(	sal_Int32	nPara,
		sal_Int32	nNumberingStartValue
	)

overridevirtual

Reimplemented from SvxTextForwarder.

Definition at line 488 of file unoforou.cxx.

References GetParagraphCount(), rOutliner, and Outliner::SetNumberingStartValue().

◆ SetParaAttribs()

void SvxOutlinerForwarder::SetParaAttribs	(	sal_Int32	nPara,
		const SfxItemSet &	rSet
	)

overridevirtual

Implements SvxTextForwarder.

Definition at line 160 of file unoforou.cxx.

References flushCache(), SfxItemSet::GetParent(), rOutliner, rSet, and Outliner::SetParaAttribs().

◆ SetParaIsNumberingRestart()

void SvxOutlinerForwarder::SetParaIsNumberingRestart	(	sal_Int32	nPara,
		bool	bParaIsNumberingRestart
	)

overridevirtual

Reimplemented from SvxTextForwarder.

Definition at line 513 of file unoforou.cxx.

References GetParagraphCount(), rOutliner, and Outliner::SetParaIsNumberingRestart().

◆ SetStyleSheet()

void SvxOutlinerForwarder::SetStyleSheet	(	sal_Int32	nPara,
		const OUString &	rStyleName
	)

overridevirtual

Implements SvxTextForwarder.

Definition at line 196 of file unoforou.cxx.

References Outliner::GetStyleSheetPool(), rOutliner, and Outliner::SetStyleSheet().

Member Data Documentation

◆ bOutlinerText

bool SvxOutlinerForwarder::bOutlinerText

private

Definition at line 37 of file unoforou.hxx.

Referenced by SetDepth().

◆ maAttribCacheSelection

ESelection SvxOutlinerForwarder::maAttribCacheSelection

mutableprivate

if we have a cached attribute item set, this is the selection of it

Definition at line 44 of file unoforou.hxx.

Referenced by GetAttribs().

◆ mnParaAttribsCache

sal_Int32 SvxOutlinerForwarder::mnParaAttribsCache

mutableprivate

if we have a cached para attribute item set, this is the paragraph of it

Definition at line 51 of file unoforou.hxx.

Referenced by GetParaAttribs().

◆ moAttribsCache

std::optional<SfxItemSet> SvxOutlinerForwarder::moAttribsCache

mutableprivate

this pointer may be null or point to an item set for the attribs of the selection maAttribsSelection

Definition at line 41 of file unoforou.hxx.

Referenced by flushCache(), and GetAttribs().

◆ moParaAttribsCache

std::optional<SfxItemSet> SvxOutlinerForwarder::moParaAttribsCache

mutableprivate

this pointer may be null or point to an item set for the paragraph mnParaAttribsCache

Definition at line 48 of file unoforou.hxx.

Referenced by flushCache(), and GetParaAttribs().

◆ rOutliner

Outliner& SvxOutlinerForwarder::rOutliner

private

Definition at line 36 of file unoforou.hxx.

Referenced by AppendParagraph(), AppendTextPortion(), CalcFieldValue(), CopyText(), Delete(), GetAttribs(), GetAttributeRun(), GetBulletInfo(), GetCharBounds(), GetDepth(), GetEmptyItemSetPtr(), GetFieldCount(), GetFieldInfo(), GetIndexAtPoint(), GetItemState(), GetLanguage(), GetLineBoundaries(), GetLineCount(), GetLineLen(), GetLineNumberAtIndex(), GetMapMode(), GetNumberingStartValue(), GetParaAttribs(), GetParaBounds(), GetParagraphCount(), GetPool(), GetPortions(), GetRefDevice(), GetStyleSheet(), GetText(), GetTextLen(), GetWordIndices(), InsertText(), IsParaIsNumberingRestart(), IsValid(), QuickFormatDoc(), QuickInsertField(), QuickInsertLineBreak(), QuickInsertText(), QuickSetAttribs(), RemoveAttribs(), SetDepth(), SetNumberingStartValue(), SetParaAttribs(), SetParaIsNumberingRestart(), and SetStyleSheet().

The documentation for this class was generated from the following files:

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SvxOutlinerForwarder()

◆ ~SvxOutlinerForwarder()

Member Function Documentation

◆ AppendParagraph()

◆ AppendTextPortion()

◆ CalcFieldValue()

◆ CopyText()

◆ Delete()

◆ FieldClicked()

◆ flushCache()

◆ GetAttribs()

◆ GetAttributeRun()

◆ GetBulletInfo()

◆ GetCharBounds()

◆ GetDepth()

◆ GetEmptyItemSetPtr()

◆ GetFieldCount()

◆ GetFieldInfo()

◆ GetIndexAtPoint()

◆ GetItemState() [1/2]

◆ GetItemState() [2/2]

◆ GetLanguage()

◆ GetLineBoundaries()

◆ GetLineCount()

◆ GetLineLen()

◆ GetLineNumberAtIndex()

◆ GetMapMode()

◆ GetNumberingStartValue()

◆ GetParaAttribs()

◆ GetParaBounds()

◆ GetParagraphCount()

◆ GetPool()

◆ GetPortions()

◆ GetRefDevice()

◆ GetStyleSheet()

◆ GetText()

◆ GetTextLen()

◆ GetWordIndices()

◆ InsertText()

◆ IsParaIsNumberingRestart()

◆ IsValid()

◆ QuickFormatDoc()

◆ QuickInsertField()

◆ QuickInsertLineBreak()

◆ QuickInsertText()

◆ QuickSetAttribs()

◆ RemoveAttribs()

◆ SetDepth()

◆ SetNumberingStartValue()

◆ SetParaAttribs()

◆ SetParaIsNumberingRestart()

◆ SetStyleSheet()

Member Data Documentation

◆ bOutlinerText

◆ maAttribCacheSelection

◆ mnParaAttribsCache

◆ moAttribsCache

◆ moParaAttribsCache

◆ rOutliner