The purpose of this class is to be the universal interface between formatting/text output and the possibly overlapping free-flying frames. More...

#include <txtfly.hxx>

Collaboration diagram for SwTextFly:

[legend]

Public Member Functions
SwAnchoredObjList *	GetAnchoredObjList () const

	SwTextFly ()

	SwTextFly (const SwTextFrame *pFrame)

	SwTextFly (const SwTextFly &rTextFly)

	~SwTextFly ()

void	CtorInitTextFly (const SwTextFrame *pFrame)

void	SetTopRule ()

SwRect	GetFrame (const SwRect &rPortion) const

bool	IsOn () const

bool	Relax (const SwRect &rRect)
	If there is no flying object frame standing in rRect (usually the current row), then we are turning ourself off. More...

bool	Relax ()

SwTwips	GetMinBottom () const

SwTwips	GetMaxBottom (const SwBreakPortion &rPortion, const SwTextFormatInfo &rInfo) const
	Gets the maximum of the fly frame bottoms. More...

const SwTextFrame *	GetMaster () const

tools::Long	GetNextTop () const

void	SetNextTop (tools::Long nNew) const

SwRect	AnchoredObjToRect (const SwAnchoredObject *pAnchoredObj, const SwRect &rRect) const
	Determines the demanded rectangle for an anchored object, considering its surround for text wrapping. More...

void	DrawTextOpaque (SwDrawTextInfo &rInf)
	This method is called by DrawText(). More...

void	DrawFlyRect (OutputDevice *pOut, const SwRect &rRect)
	Two subtleties needs to be mentioned: More...

bool	IsAnyFrame (const SwRect &rLine) const
	Used to switch off the SwTextFly when there is no overlapping object (Relax). More...

bool	IsAnyFrame () const
	Same as IsAnyFrame(const SwRect&), but uses the current frame print area. More...

bool	IsAnyObj (const SwRect &rRect) const
	true when a frame or DrawObj must be taken in account. More...

void	SetIgnoreCurrentFrame (bool bNew)

void	SetIgnoreContour (bool bNew)

void	SetIgnoreObjsInHeaderFooter (const bool bNew)

SwRect	GetFrameArea () const

Private Member Functions
SwRect	GetFrame_ (const SwRect &rPortion) const
	This method will be called during the LineIter formatting. More...

SwAnchoredObjList *	InitAnchoredObjList ()

bool	ForEach (const SwRect &rRect, SwRect *pRect, bool bAvoid) const
	Look for the first object which overlaps with the rectangle. More...

css::text::WrapTextMode	GetSurroundForTextWrap (const SwAnchoredObject *pAnchoredObj) const

void	CalcRightMargin (SwRect &rFly, SwAnchoredObjList::size_type nPos, const SwRect &rLine) const
	The right margin is the right margin or it is determined by the next object standing on the line. More...

void	CalcLeftMargin (SwRect &rFly, SwAnchoredObjList::size_type nPos, const SwRect &rLine) const
	The left margin is the left margin of the current PrintArea or it is determined by the last FlyFrame, which stands on the line. More...

SwAnchoredObjList::size_type	GetPos (const SwAnchoredObject *pAnchoredObj) const

bool	GetTop (const SwAnchoredObject *_pAnchoredObj, const bool bInFootnote, const bool bInFooterOrHeader)
	#i26945# - change first parameter Now it's the <SwAnchoredObject> instance of the floating screen object More...

SwTwips	CalcMinBottom () const

const SwTextFrame *	GetMaster_ ()

Private Attributes
const SwPageFrame *	m_pPage

const SwAnchoredObject *	mpCurrAnchoredObj

const SwTextFrame *	m_pCurrFrame

const SwTextFrame *	m_pMaster

std::unique_ptr< SwAnchoredObjList >	mpAnchoredObjList

tools::Long	m_nMinBottom

tools::Long	m_nNextTop

SwNodeOffset	m_nCurrFrameNodeIndex
	Stores the upper edge of the "next" frame. More...

bool	m_bOn: 1

bool	m_bTopRule: 1

bool	mbIgnoreCurrentFrame: 1

bool	mbIgnoreContour: 1

bool	mbIgnoreObjsInHeaderFooter: 1
	boolean, indicating if objects in page header\|footer are considered for text frames not in page header\|footer. More...

Detailed Description

The purpose of this class is to be the universal interface between formatting/text output and the possibly overlapping free-flying frames.

During formatting the formatter gets the information from SwTextFly, whether a certain area is present by the attributes of an overlapping frame. Such areas are represented by dummy portions.

The whole text output and touch-up is, again, forwarded to a SwTextFly. This one decides, whether parts of the text need to be clipped and splits the areas for e.g. a DrawRect.

Please note that all free-flying frames are located in a PtrArray, sorted by TopLeft.

Internally we always use document-global values. The IN and OUT parameters are, however, adjusted to the needs of the LineIter most of the time. That is: they are converted to frame- and window-local coordinates. If multiple frames with wrap attributes are located on the same line, we get the following settings for the text flow:

 L/R    P     L     R     N
  P   -P-P- -P-L  -P R- -P N
  L   -L P- -L L  -L R- -L N
  R    R-P-  R-L   R R-  R N
  N    N P-  N L   N R-  N N

(P=parallel, L=left, R=right, N=no wrap)

We can describe the behaviour as follows: Every frame can push away text, with the restriction that it only has influence until the next frame.

Definition at line 124 of file txtfly.hxx.

Constructor & Destructor Documentation

◆ SwTextFly() [1/3]

SwTextFly::SwTextFly ( )

Definition at line 309 of file txtfly.cxx.

◆ SwTextFly() [2/3]

SwTextFly::SwTextFly ( const SwTextFrame * pFrame )

Definition at line 326 of file txtfly.cxx.

References CtorInitTextFly().

◆ SwTextFly() [3/3]

SwTextFly::SwTextFly ( const SwTextFly & rTextFly )

Definition at line 331 of file txtfly.cxx.

References m_bOn, m_bTopRule, m_nCurrFrameNodeIndex, m_nMinBottom, m_nNextTop, m_pCurrFrame, m_pMaster, m_pPage, mbIgnoreContour, mbIgnoreCurrentFrame, mbIgnoreObjsInHeaderFooter, mpAnchoredObjList, and mpCurrAnchoredObj.

◆ ~SwTextFly()

SwTextFly::~SwTextFly ( )

Definition at line 352 of file txtfly.cxx.

Member Function Documentation

◆ AnchoredObjToRect()

SwRect SwTextFly::AnchoredObjToRect	(	const SwAnchoredObject *	pAnchoredObj,
		const SwRect &	rRect
	)		const

Determines the demanded rectangle for an anchored object, considering its surround for text wrapping.

Parameters

pAnchoredObj	the object for which to get the bounds
rLine	the bounds of the line to format

Returns: the flying object bounds

Definition at line 1332 of file txtfly.cxx.

References SwContourCache::CalcBoundRect(), CalcLeftMargin(), CalcRightMargin(), SwRectFnSet::GetBottom(), SwRectFnSet::GetLeft(), SwAnchoredObject::GetObjRectWithSpaces(), GetPos(), GetSurroundForTextWrap(), SwFrame::IsRightToLeft(), m_pCurrFrame, mbIgnoreContour, SwRect::Right(), SetNextTop(), and SwRect::Width().

Referenced by ForEach(), and SwTextFrame::FormatImpl().

◆ CalcLeftMargin()

void SwTextFly::CalcLeftMargin	(	SwRect &	rFly,
		SwAnchoredObjList::size_type	nPos,
		const SwRect &	rLine
	)		const

private

The left margin is the left margin of the current PrintArea or it is determined by the last FlyFrame, which stands on the line.

Definition at line 1268 of file txtfly.cxx.

References SwContourCache::CalcBoundRect(), SwRectFnSet::GetLeft(), SwAnchoredObject::GetObjRectWithSpaces(), SwRectFnSet::GetPrtLeft(), SwRectFnSet::GetRight(), GetSurroundForTextWrap(), SwTextFrame::IsSwapped(), SwFrame::IsVertical(), SwRect::Left(), m_pCurrFrame, mpCurrAnchoredObj, SwRect::Overlaps(), SwRectFnSet::SetLeft(), and size.

Referenced by AnchoredObjToRect().

◆ CalcMinBottom()

SwTwips SwTextFly::CalcMinBottom ( ) const

private

◆ CalcRightMargin()

void SwTextFly::CalcRightMargin	(	SwRect &	rFly,
		SwAnchoredObjList::size_type	nPos,
		const SwRect &	rLine
	)		const

private

The right margin is the right margin or it is determined by the next object standing on the line.

Definition at line 1179 of file txtfly.cxx.

References SwContourCache::CalcBoundRect(), SwRectFnSet::GetBottom(), SwRectFnSet::GetHeight(), SwRectFnSet::GetLeft(), SwRectFnSet::GetPrtRight(), SwRectFnSet::GetRight(), GetSurroundForTextWrap(), SwRectFnSet::GetTop(), SwRectFnSet::GetWidth(), SwTextFrame::IsSwapped(), SwFrame::IsVertical(), m_nNextTop, m_pCurrFrame, mpCurrAnchoredObj, nPos, SwRect::Overlaps(), SwRectFnSet::SetLeft(), SetNextTop(), SwRectFnSet::SetRight(), size, and SwRectFnSet::YDiff().

Referenced by AnchoredObjToRect().

◆ CtorInitTextFly()

void SwTextFly::CtorInitTextFly ( const SwTextFrame * pFrame )

Definition at line 356 of file txtfly.cxx.

References SwFrame::FindFlyFrame(), SwFrame::FindPageFrame(), SwPageFrame::GetSortedObjs(), m_bOn, m_bTopRule, m_nCurrFrameNodeIndex, m_nMinBottom, m_nNextTop, m_pCurrFrame, m_pMaster, m_pPage, mbIgnoreContour, mbIgnoreCurrentFrame, mbIgnoreObjsInHeaderFooter, mpCurrAnchoredObj, and NODE_OFFSET_MAX().

Referenced by SwTextPaintInfo::CtorInitTextPaintInfo(), and SwTextFly().

◆ DrawFlyRect()

void SwTextFly::DrawFlyRect	(	OutputDevice *	pOut,
		const SwRect &	rRect
	)

Two subtleties needs to be mentioned:

DrawRect() is allowed over the ClipRects
FlyToRect() returns bigger values than the frame data

Ensure that the overlapping frames (except the transparent frames) won't be scribbled

Definition at line 576 of file txtfly.cxx.

References SwAnchoredObject::DynCastFlyFrame(), GetAnchoredObjList(), SwRootFrame::GetCurrShell(), SwAnchoredObject::GetDrawObj(), SwAnchoredObject::GetFrameFormat(), IDocumentDrawModelAccess::GetHellId(), SwViewShell::getIDocumentDrawModelAccess(), SdrObject::GetLayer(), SwAnchoredObject::GetObjRect(), SwFrame::getRootFrame(), SwFormatSurround::GetSurround(), SwFormat::GetSurround(), i, SwFlyFrame::IsBackgroundTransparent(), SwFormatSurround::IsContour(), SwRect::IsEmpty(), SwFrame::IsNoTextFrame(), SwLayoutFrame::Lower(), m_bOn, m_bTopRule, m_pPage, mpCurrAnchoredObj, nCount, pOut, size, and SwAlignRect().

◆ DrawTextOpaque()

void SwTextFly::DrawTextOpaque ( SwDrawTextInfo & rInf )

This method is called by DrawText().

Ensures that the overlapping frames (except the transparent frames) won't be scribbled by setting clip regions so that only the portions that are not in the area of FlyFrames that are opaque and above the current frame will be output.

DrawText() takes over the on optimization!

Definition at line 455 of file txtfly.cxx.

Referenced by SwTextPaintInfo::DrawText_().

◆ ForEach()

bool SwTextFly::ForEach	(	const SwRect &	rRect,
		SwRect *	pRect,
		bool	bAvoid
	)		const

private

Look for the first object which overlaps with the rectangle.

Iterates over the anchored object list mpAnchoredObjList.

Definition at line 1068 of file txtfly.cxx.

References AnchoredObjToRect(), FAR_AWAY, SwFormat::GetAnchor(), GetAnchoredObjList(), SwAnchoredObject::GetAnchorFrame(), SwFormatAnchor::GetAnchorId(), SwPageDesc::GetFollow(), SwFrameAreaDefinition::getFrameArea(), SwAnchoredObject::GetFrameFormat(), SwRectFnSet::GetHeight(), SwRectFnSet::GetLeft(), GetMaster(), SwAnchoredObject::GetObjRectWithSpaces(), SwPageFrame::GetPageDesc(), SwRectFnSet::GetRight(), SwFormatSurround::GetSurround(), SwFormat::GetSurround(), i, SwFormatSurround::IsAnchorOnly(), SwFormatSurround::IsContour(), SwRect::IsEmpty(), SwFrame::IsRightToLeft(), m_bOn, m_pCurrFrame, m_pPage, mbIgnoreCurrentFrame, mpCurrAnchoredObj, nCount, SwRect::Overlaps(), size, swap(), and SwRect::Top().

Referenced by GetFrame_(), and IsAnyFrame().

◆ GetAnchoredObjList()

SwAnchoredObjList * SwTextFly::GetAnchoredObjList ( ) const

inline

Definition at line 314 of file txtfly.hxx.

References InitAnchoredObjList(), and mpAnchoredObjList.

Referenced by DrawFlyRect(), DrawTextOpaque(), ForEach(), SwTextFrame::FormatImpl(), GetMaxBottom(), and GetPos().

◆ GetFrame()

SwRect SwTextFly::GetFrame ( const SwRect & rPortion ) const

inline

Definition at line 369 of file txtfly.hxx.

References GetFrame_(), and m_bOn.

Referenced by SwTextAdjuster::CalcFlyPortion(), SwTextFormatter::CalcFlyWidth(), SwTextFormatter::ChkFlyUnderflow(), lcl_CalcFlyBasePos(), and lcl_IsDropFlyInter().

◆ GetFrame_()

SwRect SwTextFly::GetFrame_ ( const SwRect & rPortion ) const

private

This method will be called during the LineIter formatting.

to compute the position of the next FlyPortion
remember new overlappings after a change of the line height.

Parameters

[in] rPortion Scope: document global.

Definition at line 379 of file txtfly.cxx.

References ForEach(), SwRectFnSet::GetBottom(), SwRectFnSet::GetHeight(), SwRectFnSet::GetTop(), m_pCurrFrame, SwRectFnSet::SetBottom(), SwRectFnSet::SetTop(), and SwRectFnSet::YDiff().

Referenced by GetFrame().

◆ GetFrameArea()

SwRect SwTextFly::GetFrameArea ( ) const

Definition at line 832 of file txtfly.cxx.

References IDocumentSettingAccess::get(), SwTextFrame::GetDoc(), SwFrameAreaDefinition::getFrameArea(), SwFrameAreaDefinition::getFramePrintArea(), SwDoc::getIDocumentSettingAccess(), m_pCurrFrame, SwRect::Pos(), and USE_FORMER_TEXT_WRAPPING.

Referenced by SwTextFrame::FormatImpl(), and InitAnchoredObjList().

◆ GetMaster()

const SwTextFrame * SwTextFly::GetMaster ( ) const

inline

Definition at line 354 of file txtfly.hxx.

References GetMaster_(), and m_pMaster.

Referenced by CalcMinBottom(), DrawTextOpaque(), ForEach(), GetSurroundForTextWrap(), and InitAnchoredObjList().

◆ GetMaster_()

const SwTextFrame * SwTextFly::GetMaster_ ( )

private

Definition at line 447 of file txtfly.cxx.

References SwContentFrame::FindMaster(), m_pCurrFrame, and m_pMaster.

Referenced by GetMaster().

◆ GetMaxBottom()

SwTwips SwTextFly::GetMaxBottom	(	const SwBreakPortion &	rPortion,
		const SwTextFormatInfo &	rInfo
	)		const

Gets the maximum of the fly frame bottoms.

Definition at line 1010 of file txtfly.cxx.

References SwFrame::FindFooterOrHeader(), GetAnchoredObjList(), SwAnchoredObject::GetAnchorFrame(), SwBreakPortion::GetClear(), SwFrameAreaDefinition::getFrameArea(), SwFrameAreaDefinition::getFramePrintArea(), SwAnchoredObject::GetObjRectWithSpaces(), SwRect::Height(), i, SwFrame::IsVertical(), LEFT, SwRect::Left(), m_bOn, m_pCurrFrame, nCount, RIGHT, SwRect::Right(), size, SwTextFrame::SwitchVerticalToHorizontal(), SwRect::Top(), and SwTextPaintInfo::X().

Referenced by SwBreakPortion::Format().

◆ GetMinBottom()

SwTwips SwTextFly::GetMinBottom ( ) const

inline

Definition at line 349 of file txtfly.hxx.

References CalcMinBottom(), m_nMinBottom, and mpAnchoredObjList.

Referenced by SwTextFormatter::CalcBottomLine().

◆ GetNextTop()

tools::Long SwTextFly::GetNextTop ( ) const

inline

Definition at line 359 of file txtfly.hxx.

References m_nNextTop.

Referenced by SwTextFormatter::CalcFlyWidth().

◆ GetPos()

SwAnchoredObjList::size_type SwTextFly::GetPos ( const SwAnchoredObject * pAnchoredObj ) const

private

Returns: the position in sorted array

Definition at line 1169 of file txtfly.cxx.

References GetAnchoredObjList(), mpAnchoredObjList, and nCount.

Referenced by AnchoredObjToRect().

◆ GetSurroundForTextWrap()

css::text::WrapTextMode SwTextFly::GetSurroundForTextWrap ( const SwAnchoredObject * pAnchoredObj ) const

private

There is less than 2cm space on both sides for the text: no surround (css::text::WrapTextMode_NONE)

There is more than 2cm space on only one side: surround on that side (css::text::WrapTextMode_LEFT or css::text::WrapTextMode_RIGHT)

There is more than 2cm space on both sides, the object is larger than 1.5cm: surround on the wider side (css::text::WrapTextMode_LEFT or css::text::WrapTextMode_RIGHT)