#include <objectformatter.hxx>

Inheritance diagram for SwObjectFormatter:

Collaboration diagram for SwObjectFormatter:

Public Member Functions
virtual	~SwObjectFormatter ()

virtual bool	DoFormatObj (SwAnchoredObject &_rAnchoredObj, const bool _bCheckForMovedFwd=false)=0
	intrinsic method to format a certain floating screen object More...

virtual bool	DoFormatObjs ()=0
	intrinsic method to format all floating screen objects More...

Static Public Member Functions
static bool	FormatObjsAtFrame (SwFrame &_rAnchorFrame, const SwPageFrame &_rPageFrame, SwLayAction *_pLayAction=nullptr)
	method to format all floating screen objects at the given anchor frame More...

static bool	FormatObj (SwAnchoredObject &_rAnchoredObj, SwFrame _pAnchorFrame=nullptr, const SwPageFrame _pPageFrame=nullptr)
	method to format a given floating screen object More...

Protected Member Functions
	SwObjectFormatter (const SwPageFrame &_rPageFrame, SwLayAction *_pLayAction, const bool _bCollectPgNumOfAnchors=false)

virtual SwFrame &	GetAnchorFrame ()=0

const SwPageFrame &	GetPageFrame () const

bool	ConsiderWrapOnObjPos () const

SwLayAction *	GetLayAction ()

void	FormatObj_ (SwAnchoredObject &_rAnchoredObj)
	performs the intrinsic format of a given floating screen object and its content. More...

bool	FormatObjsAtFrame_ (SwTextFrame *_pMasterTextFrame=nullptr)
	invokes the intrinsic format method for all floating screen objects, anchored at anchor frame on the given page frame More...

SwAnchoredObject *	GetCollectedObj (const sal_uInt32 _nIndex)
	accessor to collected anchored object More...

sal_uInt32	GetPgNumOfCollected (const sal_uInt32 _nIndex)
	accessor to 'anchor' page number of collected anchored object More...

bool	IsCollectedAnchoredAtMaster (const sal_uInt32 _nIndex)
	accessor to 'anchor' type of collected anchored object More...

sal_uInt32	CountOfCollected ()
	accessor to total number of collected anchored objects More...

Static Protected Member Functions
static std::unique_ptr< SwObjectFormatter >	CreateObjFormatter (SwFrame &_rAnchorFrame, const SwPageFrame &_rPageFrame, SwLayAction *_pLayAction)

Private Member Functions
void	FormatLayout_ (SwLayoutFrame &_rLayoutFrame)
	helper method for method <FormatObj_(..)> - performs the intrinsic format of the layout of the given layout frame and all its lower layout frames. More...

void	FormatObjContent (SwAnchoredObject &_rAnchoredObj)
	helper method for method <FormatObj_(..)> - performs the intrinsic format of the content of the given floating screen object. More...

Private Attributes
const SwPageFrame &	mrPageFrame

const bool	mbConsiderWrapOnObjPos

SwLayAction *	mpLayAction

std::unique_ptr< SwPageNumAndTypeOfAnchors >	mpPgNumAndTypeOfAnchors

Detailed Description

Definition at line 39 of file objectformatter.hxx.

Constructor & Destructor Documentation

◆ SwObjectFormatter()

SwObjectFormatter::SwObjectFormatter	(	const SwPageFrame &	_rPageFrame,
		SwLayAction *	_pLayAction,
		const bool	_bCollectPgNumOfAnchors = `false`
	)

protected

Definition at line 104 of file objectformatter.cxx.

References CONSIDER_WRAP_ON_OBJECT_POSITION, and GetFormat().

◆ ~SwObjectFormatter()

SwObjectFormatter::~SwObjectFormatter ( )

virtual

Definition at line 115 of file objectformatter.cxx.

Member Function Documentation

◆ ConsiderWrapOnObjPos()

bool SwObjectFormatter::ConsiderWrapOnObjPos ( ) const

inlineprotected

Definition at line 91 of file objectformatter.hxx.

References mbConsiderWrapOnObjPos.

Referenced by SwObjectFormatterTextFrame::DoFormatObjs().

◆ CountOfCollected()

sal_uInt32 SwObjectFormatter::CountOfCollected ( )

protected

accessor to total number of collected anchored objects

#i28701#

Definition at line 473 of file objectformatter.cxx.

References mpPgNumAndTypeOfAnchors.

Referenced by SwObjectFormatterTextFrame::DoFormatObj(), and SwObjectFormatterTextFrame::GetFirstObjWithMovedFwdAnchor().

◆ CreateObjFormatter()

std::unique_ptr< SwObjectFormatter > SwObjectFormatter::CreateObjFormatter	(	SwFrame &	_rAnchorFrame,
		const SwPageFrame &	_rPageFrame,
		SwLayAction *	_pLayAction
	)

staticprotected

Definition at line 119 of file objectformatter.cxx.

References SwObjectFormatterLayFrame::CreateObjFormatter(), SwObjectFormatterTextFrame::CreateObjFormatter(), SwFrame::IsLayoutFrame(), and SwFrame::IsTextFrame().

Referenced by FormatObj(), and FormatObjsAtFrame().

◆ DoFormatObj()

virtual bool SwObjectFormatter::DoFormatObj	(	SwAnchoredObject &	_rAnchoredObj,
		const bool	_bCheckForMovedFwd = `false`
	)

pure virtual

intrinsic method to format a certain floating screen object

#i40147# - add parameter <_bCheckForMovedFwd>

Parameters

_rAnchoredObj	input parameter - anchored object, which have to be formatted.
_bCheckForMovedFwd	input parameter - boolean indicating, that after a successful format of the anchored object the anchor frame has to be checked, if it would moved forward due to the positioning of the anchored object. default value: false value only considered, if wrapping style influence has to be considered for the positioning of the anchored object.

Implemented in SwObjectFormatterLayFrame, and SwObjectFormatterTextFrame.

Referenced by FormatObjsAtFrame_().

◆ DoFormatObjs()

virtual bool SwObjectFormatter::DoFormatObjs ( )

pure virtual

intrinsic method to format all floating screen objects

Implemented in SwObjectFormatterLayFrame, and SwObjectFormatterTextFrame.

◆ FormatLayout_()

void SwObjectFormatter::FormatLayout_ ( SwLayoutFrame & _rLayoutFrame )

private

helper method for method <FormatObj_(..)> - performs the intrinsic format of the layout of the given layout frame and all its lower layout frames.

#i28701# IMPORTANT NOTE: Method corresponds to methods <SwLayAction::FormatLayoutFly(..)> and <SwLayAction::FormatLayout(..)>. Thus, its code for the formatting have to be synchronised.

Definition at line 205 of file objectformatter.cxx.

References SwFrame::Calc(), FormatLayout_(), SwRootFrame::GetCurrShell(), SwFrame::GetNext(), SwViewShell::GetOut(), SwFrame::getRootFrame(), SwFrame::IsLayoutFrame(), and SwLayoutFrame::Lower().

Referenced by FormatLayout_(), and FormatObj_().

◆ FormatObj()

bool SwObjectFormatter::FormatObj	(	SwAnchoredObject &	_rAnchoredObj,
		SwFrame *	_pAnchorFrame = `nullptr`,
		const SwPageFrame *	_pPageFrame = `nullptr`
	)

static

method to format a given floating screen object

Definition at line 168 of file objectformatter.cxx.

References SwAnchoredObject::AnchorFrame(), CreateObjFormatter(), SwFrame::FindPageFrame(), and SwAnchoredObject::GetAnchorFrame().

Referenced by SwTextFlyCnt::GetFlyFrame_(), and GetFrameOfModify().

◆ FormatObj_()

void SwObjectFormatter::FormatObj_ ( SwAnchoredObject & _rAnchoredObj )

protected

performs the intrinsic format of a given floating screen object and its content.

#i28701#

Definition at line 263 of file objectformatter.cxx.

References SwAnchoredObject::DynCastFlyFrame(), SwLayAction::FormatFlyContent(), FormatLayout_(), SwLayAction::FormatLayoutFly(), FormatObjContent(), FormatObjsAtFrame(), GetAnchorFrame(), SwLayAction::IsAgain(), SwAnchoredObject::MakeObjPos(), mpLayAction, mpPgNumAndTypeOfAnchors, and SwAnchoredObject::RestartLayoutProcess().

Referenced by SwObjectFormatterLayFrame::DoFormatObj(), and SwObjectFormatterTextFrame::DoFormatObj().

◆ FormatObjContent()

void SwObjectFormatter::FormatObjContent ( SwAnchoredObject & _rAnchoredObj )

private

helper method for method <FormatObj_(..)> - performs the intrinsic format of the content of the given floating screen object.

#i28701#

Definition at line 225 of file objectformatter.cxx.

References SwLayoutFrame::ContainsContent(), SwAnchoredObject::DynCastFlyFrame(), SwFrame::FindPageFrame(), FormatObjsAtFrame(), GetLayAction(), SwContentFrame::GetNextContentFrame(), SwFrame::IsTextFrame(), and SwFrame::OptCalc().

Referenced by FormatObj_().

◆ FormatObjsAtFrame()

bool SwObjectFormatter::FormatObjsAtFrame	(	SwFrame &	_rAnchorFrame,
		const SwPageFrame &	_rPageFrame,
		SwLayAction *	_pLayAction = `nullptr`
	)

static

method to format all floating screen objects at the given anchor frame

Definition at line 147 of file objectformatter.cxx.

References CreateObjFormatter().

Referenced by SwFootnoteBossFrame::AppendFootnote(), SwContentFrame::CalcLowers(), SwLayAction::FormatFlyContent(), FormatObj_(), FormatObjContent(), SwHeadFootFrame::FormatSize(), SwLayAction::InternalAction(), SwFootnoteBossFrame::MoveFootnotes_(), SwFootnoteBossFrame::RearrangeFootnotes(), and SwLayAction::TurboAction_().

◆ FormatObjsAtFrame_()

bool SwObjectFormatter::FormatObjsAtFrame_ ( SwTextFrame * _pMasterTextFrame = nullptr )

protected

invokes the intrinsic format method for all floating screen objects, anchored at anchor frame on the given page frame

for format of floating screen objects for follow text frames, the 'master' text frame is passed to the method. Thus, the objects, whose anchor character is inside the follow text frame can be formatted.

Parameters

_pMasterTextFrame input parameter - pointer to 'master' text frame. default value: NULL

#i28701# #i26945# - for format of floating screen objects for follow text frames, the 'master' text frame is passed to the method. Thus, the objects, whose anchor character is inside the follow text frame can be formatted.

Definition at line 352 of file objectformatter.cxx.

References SwAnchoredObject::AnchorFrame(), DoFormatObj(), SwAnchoredObject::FindAnchorCharFrame(), SwFrame::FindBodyFrame(), SwAnchoredObject::FindPageFrameOfAnchor(), SwAnchoredObject::GetAnchorFrame(), GetAnchorFrame(), SwFrame::GetDrawObjs(), i, SwSortedObjs::ListPosOf(), mrPageFrame, size, and SwSortedObjs::size().