LibreOffice Module sw (master)  1
Public Member Functions | Private Attributes | List of all members
objectpositioning::SwEnvironmentOfAnchoredObject Class Reference

#include <environmentofanchoredobject.hxx>

Public Member Functions

 SwEnvironmentOfAnchoredObject (const bool _bFollowTextFlow, const bool _bLayoutInCell=false)
 constructor More...
 
 ~SwEnvironmentOfAnchoredObject ()
 destructor More...
 
const SwLayoutFrameGetHoriEnvironmentLayoutFrame (const SwFrame &_rHoriOrientFrame) const
 determine environment layout frame for possible horizontal object positions respectively for alignment to 'page areas' More...
 
const SwLayoutFrameGetVertEnvironmentLayoutFrame (const SwFrame &_rVertOrientFrame) const
 determine environment layout frame for possible vertical object positions respectively for alignments to 'page areas' More...
 

Private Attributes

const bool mbFollowTextFlow
 
const bool mbLayoutInCell = false
 

Detailed Description

Definition at line 28 of file environmentofanchoredobject.hxx.

Constructor & Destructor Documentation

SwEnvironmentOfAnchoredObject::SwEnvironmentOfAnchoredObject ( const bool  _bFollowTextFlow,
const bool  _bLayoutInCell = false 
)

constructor

Parameters
_bFollowTextFlowinput parameter - indicates, if the anchored object, for which this environment is instantiated, follow the text flow or not
_bLayoutInCellinput parameter - indicates, if the anchored object should be laid out within a (table) cell

Definition at line 27 of file environmentofanchoredobject.cxx.

SwEnvironmentOfAnchoredObject::~SwEnvironmentOfAnchoredObject ( )

destructor

Definition at line 34 of file environmentofanchoredobject.cxx.

Member Function Documentation

const SwLayoutFrame & SwEnvironmentOfAnchoredObject::GetHoriEnvironmentLayoutFrame ( const SwFrame _rHoriOrientFrame) const

determine environment layout frame for possible horizontal object positions respectively for alignment to 'page areas'

determine environment layout frame for possible horizontal object positions

this is, if object has to follow the text flow:

  • cell frame, if anchored inside a cell
  • fly frame, if anchored inside a fly frame otherwise it's the page frame

this is, if object hasn't to follow the text flow:

  • page frame.
  • no exception any more. Thus remove parameter <_bForPageAlignment>
Parameters
_rHoriOrientFrameinput parameter - frame, at which the horizontal position is oriented at (typically it's the anchor frame). starting point for the search of the layout frame.
Returns
reference to the layout frame, which determines the horizontal environment the object has to be positioned in.

Definition at line 38 of file environmentofanchoredobject.cxx.

References SwFrame::FindPageFrame(), SwFrame::GetUpper(), SwFrame::IsCellFrame(), SwFrame::IsFlyFrame(), SwFrame::IsPageFrame(), and mbFollowTextFlow.

Referenced by SwFEShell::CalcBoundRect(), and objectpositioning::SwAnchoredObjectPosition::CalcRelPosX().

const SwLayoutFrame & SwEnvironmentOfAnchoredObject::GetVertEnvironmentLayoutFrame ( const SwFrame _rVertOrientFrame) const

determine environment layout frame for possible vertical object positions respectively for alignments to 'page areas'

determine environment layout frame for possible vertical object positions

this is, if object has to follow the text flow:

  • cell frame, if anchored inside a cell
  • fly frame, if anchored inside a fly frame
  • header/footer frame, if anchored inside page header/footer
  • footnote frame, if anchored inside footnote otherwise it's the document body frame

this is, if object hasn't to follow the text flow:

  • page frame.
  • no exception any more. Thus remove parameter <_bForPageAlignment>
Parameters
_rVertOrientFrameinput parameter - frame, at which the vertical position is oriented at (typically it's the anchor frame). starting point for the search of the layout frame.
Returns
reference to the layout frame, which determines the vertical environment the object has to be positioned in.

Definition at line 68 of file environmentofanchoredobject.cxx.

References SwFrame::FindPageFrame(), SwFrame::GetUpper(), SwFrame::IsCellFrame(), SwFrame::IsFlyFrame(), SwFrame::IsFooterFrame(), SwFrame::IsFootnoteFrame(), SwFrame::IsHeaderFrame(), SwFrame::IsPageBodyFrame(), SwFrame::IsPageFrame(), mbFollowTextFlow, and mbLayoutInCell.

Referenced by SwFEShell::CalcBoundRect(), CalcClipRect(), and objectpositioning::SwToContentAnchoredObjectPosition::CalcPosition().

Member Data Documentation

const bool objectpositioning::SwEnvironmentOfAnchoredObject::mbFollowTextFlow
private
const bool objectpositioning::SwEnvironmentOfAnchoredObject::mbLayoutInCell = false
private

Definition at line 32 of file environmentofanchoredobject.hxx.

Referenced by GetVertEnvironmentLayoutFrame().


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