LibreOffice Module sw (master) 1
Classes | Public Types | Public Member Functions | Protected Member Functions | Private Attributes | Friends | List of all members
SwFrameFormat Class Reference

Style of a layout element. More...

#include <frmfmt.hxx>

Inheritance diagram for SwFrameFormat:
[legend]
Collaboration diagram for SwFrameFormat:
[legend]

Classes

struct  change_name
 

Public Types

enum  tLayoutDir {
  HORI_L2R ,
  HORI_R2L ,
  VERT_R2L
}
 

Public Member Functions

const std::shared_ptr< SwTextBoxNode > & GetOtherTextBoxFormats () const
 
void SetOtherTextBoxFormats (const std::shared_ptr< SwTextBoxNode > &rNew)
 
virtual ~SwFrameFormat () override
 
 SwFrameFormat (SwFrameFormat const &)=default
 
 SwFrameFormat (SwFrameFormat &&)=default
 
SwFrameFormatoperator= (SwFrameFormat const &)=default
 
SwFrameFormatoperator= (SwFrameFormat &&)=default
 
virtual void DelFrames ()
 Destroys all Frames in aDepend (Frames are identified via dynamic_cast). More...
 
virtual void MakeFrames ()
 Creates the views. More...
 
virtual Graphic MakeGraphic (ImageMap *pMap=nullptr, const sal_uInt32 nMaximumQuadraticPixels=500000, const std::optional< Size > &rTargetDPI=std::nullopt)
 
IMapObjectGetIMapObject (const Point &rPoint, const SwFlyFrame *pFly=nullptr) const
 
SwRect FindLayoutRect (const bool bPrtArea=false, const Point *pPoint=nullptr) const
 
SdrObjectFindSdrObject ()
 
const SdrObjectFindSdrObject () const
 
SdrObjectFindRealSdrObject ()
 
const SdrObjectFindRealSdrObject () const
 
bool IsLowerOf (const SwFrameFormat &rFormat) const
 
virtual SwFrameFormat::tLayoutDir GetLayoutDir () const
 
virtual void SetLayoutDir (const SwFrameFormat::tLayoutDir _eLayoutDir)
 
virtual sal_Int16 GetPositionLayoutDir () const
 
virtual void SetPositionLayoutDir (const sal_Int16 _nPositionLayoutDir)
 
virtual OUString GetDescription () const
 
SAL_DLLPRIVATE css::uno::WeakReference< css::uno::XInterface > const & GetXObject () const
 
SAL_DLLPRIVATE void SetXObject (css::uno::Reference< css::uno::XInterface > const &xObject)
 
void RegisterToFormat (SwFormat &rFormat)
 
virtual drawinglayer::attribute::SdrAllFillAttributesHelperPtr getSdrAllFillAttributesHelper () const override
 
virtual bool supportsFullDrawingLayerFillAttributeSet () const override
 
void dumpAsXml (xmlTextWriterPtr pWriter) const
 
virtual void SetFormatName (const OUString &rNewName, bool bBroadcast=false) override
 
void MoveTableBox (SwTableBox &rTableBox, const SwFrameFormat *pOldFormat)
 
virtual bool IsVisible () const
 
- Public Member Functions inherited from SwFormat
virtual ~SwFormat () override
 
SwFormatoperator= (const SwFormat &)
 
sal_uInt16 Which () const
 for Querying of Writer-functions. More...
 
void CopyAttrs (const SwFormat &)
 Copy attributes even among documents. More...
 
void DelDiffs (const SfxItemSet &rSet)
 Delete all attributes that are not in rFormat. More...
 
void DelDiffs (const SwFormat &rFormat)
 
bool SetDerivedFrom (SwFormat *pDerivedFrom=nullptr)
 0 is Default. More...
 
const SfxPoolItemGetFormatAttr (sal_uInt16 nWhich, bool bInParents=true) const
 If bInParents is FALSE, search only in this format for attribute. More...
 
template<class T >
const T & GetFormatAttr (TypedWhichId< T > nWhich, bool bInParents=true) const
 
SfxItemState GetItemState (sal_uInt16 nWhich, bool bSrchInParent=true, const SfxPoolItem **ppItem=nullptr) const
 
template<class T >
SfxItemState GetItemState (TypedWhichId< T > nWhich, bool bSrchInParent=true, const T **ppItem=nullptr) const
 
template<class T >
const T * GetItemIfSet (TypedWhichId< T > nWhich, bool bSrchInParent=true) const
 Templatized version of GetItemState() to directly return the correct type. More...
 
SfxItemState GetBackgroundState (std::unique_ptr< SvxBrushItem > &rItem) const
 
virtual bool SetFormatAttr (const SfxPoolItem &rAttr)
 
virtual bool SetFormatAttr (const SfxItemSet &rSet)
 
virtual bool ResetFormatAttr (sal_uInt16 nWhich1, sal_uInt16 nWhich2=0)
 
virtual sal_uInt16 ResetAllFormatAttr ()
 Takes all hints from Delta-Array,. More...
 
SwFormatDerivedFrom () const
 
bool IsDefault () const
 
const OUString & GetName () const
 
bool HasName (std::u16string_view rName) const
 
virtual void SetFormatName (const OUString &rNewName, bool bBroadcast=false)
 
const SwAttrSetGetAttrSet () const
 For querying the attribute array. More...
 
const SwDocGetDoc () const
 The document is set in SwAttrPool now, therefore you always can access it. More...
 
SwDocGetDoc ()
 
const IDocumentSettingAccessgetIDocumentSettingAccess () const
 Provides access to the document settings interface. More...
 
const IDocumentDrawModelAccessgetIDocumentDrawModelAccess () const
 Provides access to the document draw model interface. More...
 
IDocumentDrawModelAccessgetIDocumentDrawModelAccess ()
 
const IDocumentLayoutAccessgetIDocumentLayoutAccess () const
 Provides access to the document layout interface. More...
 
IDocumentLayoutAccessgetIDocumentLayoutAccess ()
 
IDocumentTimerAccessgetIDocumentTimerAccess ()
 Provides access to the document idle timer interface. More...
 
IDocumentFieldsAccessgetIDocumentFieldsAccess ()
 Provides access to the document idle timer interface. More...
 
IDocumentChartDataProviderAccessgetIDocumentChartDataProviderAccess ()
 Gives access to the chart data-provider. More...
 
sal_uInt16 GetPoolFormatId () const
 Get and set Pool style IDs. More...
 
void SetPoolFormatId (sal_uInt16 nId)
 
sal_uInt16 GetPoolHelpId () const
 Get and set Help-IDs for document templates. More...
 
void SetPoolHelpId (sal_uInt16 nId)
 
sal_uInt8 GetPoolHlpFileId () const
 
void SetPoolHlpFileId (sal_uInt8 nId)
 
void GetPresentation (SfxItemPresentation ePres, MapUnit eCoreMetric, MapUnit ePresMetric, OUString &rText) const
 Get attribute-description. Returns passed string. More...
 
bool IsAuto () const
 Query / set AutoFormat-flag. More...
 
void SetAuto (bool bNew)
 
bool IsHidden () const
 
void SetHidden (bool bValue)
 
void GetGrabBagItem (css::uno::Any &rVal) const
 
void SetGrabBagItem (const css::uno::Any &rVal)
 
bool IsAutoUpdateOnDirectFormat () const
 Query / set m_bAutoUpdateOnDirectFormat-flag. More...
 
void SetAutoUpdateOnDirectFormat (bool bNew=true)
 
bool IsFormatInDTOR () const
 
const SvxUnderlineItemGetUnderline (bool=true) const
 GetMethods: Bool indicates whether to search only in Set (FALSE) or also in Parents. More...
 
const SvxFontHeightItemGetSize (bool=true) const
 
const SvxFontItemGetFont (bool=true) const
 
const SvxColorItemGetColor (bool=true) const
 
const SvxFontItemGetCJKFont (bool=true) const
 
const SvxFontItemGetCTLFont (bool=true) const
 
const SwFormatFillOrderGetFillOrder (bool=true) const
 Frame-attributes - implemented in frmatr.hxx. More...
 
const SwFormatFrameSizeGetFrameSize (bool=true) const
 
const SwFormatHeaderGetHeader (bool=true) const
 
const SwFormatFooterGetFooter (bool=true) const
 
const SwFormatSurroundGetSurround (bool=true) const
 
const SwFormatHoriOrientGetHoriOrient (bool=true) const
 
const SwFormatAnchorGetAnchor (bool=true) const
 
const SwFormatColGetCol (bool=true) const
 
const SvxPaperBinItemGetPaperBin (bool=true) const
 
const SvxLeftMarginItemGetLeftMargin (bool=true) const
 
const SvxTextLeftMarginItemGetTextLeftMargin (bool=true) const
 
const SvxFirstLineIndentItemGetFirstLineIndent (bool=true) const
 
const SvxRightMarginItemGetRightMargin (bool=true) const
 
const SvxGutterLeftMarginItemGetGutterLeftMargin (bool=true) const
 
const SvxGutterRightMarginItemGetGutterRightMargin (bool=true) const
 
const SvxLRSpaceItemGetLRSpace (bool=true) const
 
const SvxULSpaceItemGetULSpace (bool=true) const
 
const SwFormatContentGetContent (bool=true) const
 
const SvxPrintItemGetPrint (bool=true) const
 
const SvxOpaqueItemGetOpaque (bool=true) const
 
const SvxProtectItemGetProtect (bool=true) const
 
const SwFormatVertOrientGetVertOrient (bool=true) const
 
const SvxBoxItemGetBox (bool=true) const
 
const SvxFormatKeepItemGetKeep (bool=true) const
 
std::unique_ptr< SvxBrushItemmakeBackgroundBrushItem (bool=true) const
 
const SvxShadowItemGetShadow (bool=true) const
 
const SwFormatPageDescGetPageDesc (bool=true) const
 
const SvxFormatBreakItemGetBreak (bool=true) const
 
const SvxMacroItemGetMacro (bool=true) const
 
const SwFormatURLGetURL (bool=true) const
 
const SwFormatEditInReadonlyGetEditInReadonly (bool=true) const
 
const SwFormatLayoutSplitGetLayoutSplit (bool=true) const
 
const SwFormatRowSplitGetRowSplit (bool=true) const
 
const SwFormatFlySplitGetFlySplit (bool=true) const
 
const SwFormatChainGetChain (bool=true) const
 
const SwFormatFootnoteAtTextEndGetFootnoteAtTextEnd (bool=true) const
 
const SwFormatEndAtTextEndGetEndAtTextEnd (bool=true) const
 
const SwFormatNoBalancedColumnsGetBalancedColumns (bool=true) const
 
const SvxFrameDirectionItemGetFrameDir (bool=true) const
 
const SwTextGridItemGetTextGrid (bool=true) const
 
const SwHeaderAndFooterEatSpacingItemGetHeaderAndFooterEatSpacing (bool=true) const
 
const SwFormatFollowTextFlowGetFollowTextFlow (bool=true) const
 
const SwFormatWrapInfluenceOnObjPosGetWrapInfluenceOnObjPos (bool=true) const
 
const SdrTextVertAdjustItemGetTextVertAdjust (bool=true) const
 
const SvxLineSpacingItemGetLineSpacing (bool=true) const
 Paragraph-attributes - implemented in paratr.hxx. More...
 
const SwNumRuleItemGetNumRule (bool=true) const
 
const SvxTabStopItemGetTabStops (bool=true) const
 
const SwFormatDropGetDrop (bool=true) const
 
const SwTableBoxNumFormatGetTableBoxNumFormat (bool=true) const
 TableBox attributes - implemented in cellatr.hxx. More...
 
const SwTableBoxFormulaGetTableBoxFormula (bool=true) const
 
const SwTableBoxValueGetTableBoxValue (bool=true) const
 
void SetPageFormatToDefault ()
 
virtual bool IsBackgroundTransparent () const
 SwFormat::IsBackgroundTransparent. More...
 
virtual drawinglayer::attribute::SdrAllFillAttributesHelperPtr getSdrAllFillAttributesHelper () const
 
virtual bool supportsFullDrawingLayerFillAttributeSet () const
 
void RemoveAllUnos ()
 
- Public Member Functions inherited from sw::BorderCacheOwner
 BorderCacheOwner ()
 
 BorderCacheOwner (BorderCacheOwner &)
 
BorderCacheOwneroperator= (const BorderCacheOwner &)
 
 ~BorderCacheOwner ()
 
bool IsInCache () const
 
void InvalidateInSwCache (const sal_uInt16)
 

Protected Member Functions

 SwFrameFormat (SwAttrPool &rPool, const char *pFormatNm, SwFrameFormat *pDrvdFrame, sal_uInt16 nFormatWhich=RES_FRMFMT, const WhichRangesContainer &pWhichRange=aFrameFormatSetRange)
 
 SwFrameFormat (SwAttrPool &rPool, const OUString &rFormatNm, SwFrameFormat *pDrvdFrame, sal_uInt16 nFormatWhich=RES_FRMFMT, const WhichRangesContainer &pWhichRange=aFrameFormatSetRange)
 
virtual void SwClientNotify (const SwModify &, const SfxHint &) override
 
- Protected Member Functions inherited from SwFormat
 SwFormat (SwAttrPool &rPool, const char *pFormatNm, const WhichRangesContainer &pWhichRanges, SwFormat *pDrvdFrame, sal_uInt16 nFormatWhich)
 
 SwFormat (SwAttrPool &rPool, OUString aFormatNm, const WhichRangesContainer &pWhichRanges, SwFormat *pDrvdFrame, sal_uInt16 nFormatWhich)
 
 SwFormat (const SwFormat &rFormat)
 
virtual void SwClientNotify (const SwModify &, const SfxHint &) override
 

Private Attributes

css::uno::WeakReference< css::uno::XInterface > m_wXObject
 
drawinglayer::attribute::SdrAllFillAttributesHelperPtr maFillAttributes
 
SwFormatsBasem_ffList
 
std::shared_ptr< SwTextBoxNodem_pOtherTextBoxFormats
 

Friends

class SwDoc
 
class SwPageDesc
 Is allowed to call protected CTor. More...
 
class ::sw::DocumentLayoutManager
 Is allowed to call protected CTor. More...
 
class sw::FrameFormats< SwTableFormat * >
 Is allowed to update the list backref. More...
 
class sw::FrameFormats< sw::SpzFrameFormat * >
 Is allowed to update the list backref. More...
 
class sw::FrameFormats< SwFrameFormat * >
 Is allowed to update the list backref. More...
 
class SwTextBoxHelper
 
class SwUndoFlyBase
 calls SetOtherTextBoxFormat More...
 

Detailed Description

Style of a layout element.

Definition at line 70 of file frmfmt.hxx.

Member Enumeration Documentation

◆ tLayoutDir

Enumerator
HORI_L2R 
HORI_R2L 
VERT_R2L 

Definition at line 168 of file frmfmt.hxx.

Constructor & Destructor Documentation

◆ SwFrameFormat() [1/4]

SwFrameFormat::SwFrameFormat ( SwAttrPool rPool,
const char *  pFormatNm,
SwFrameFormat pDrvdFrame,
sal_uInt16  nFormatWhich = RES_FRMFMT,
const WhichRangesContainer pWhichRange = aFrameFormatSetRange 
)
protected

Definition at line 2555 of file atrfrm.cxx.

◆ SwFrameFormat() [2/4]

SwFrameFormat::SwFrameFormat ( SwAttrPool rPool,
const OUString &  rFormatNm,
SwFrameFormat pDrvdFrame,
sal_uInt16  nFormatWhich = RES_FRMFMT,
const WhichRangesContainer pWhichRange = aFrameFormatSetRange 
)
protected

Definition at line 2566 of file atrfrm.cxx.

◆ ~SwFrameFormat()

SwFrameFormat::~SwFrameFormat ( )
overridevirtual

◆ SwFrameFormat() [3/4]

SwFrameFormat::SwFrameFormat ( SwFrameFormat const &  )
default

◆ SwFrameFormat() [4/4]

SwFrameFormat::SwFrameFormat ( SwFrameFormat &&  )
default

Member Function Documentation

◆ DelFrames()

void SwFrameFormat::DelFrames ( )
virtual

◆ dumpAsXml()

void SwFrameFormat::dumpAsXml ( xmlTextWriterPtr  pWriter) const

◆ FindLayoutRect()

SwRect SwFrameFormat::FindLayoutRect ( const bool  bPrtArea = false,
const Point pPoint = nullptr 
) const

◆ FindRealSdrObject() [1/2]

SdrObject * SwFrameFormat::FindRealSdrObject ( )

◆ FindRealSdrObject() [2/2]

const SdrObject * SwFrameFormat::FindRealSdrObject ( ) const
inline

Definition at line 163 of file frmfmt.hxx.

◆ FindSdrObject() [1/2]

SdrObject * SwFrameFormat::FindSdrObject ( )
inline

◆ FindSdrObject() [2/2]

const SdrObject * SwFrameFormat::FindSdrObject ( ) const
inline

Definition at line 159 of file frmfmt.hxx.

◆ GetDescription()

OUString SwFrameFormat::GetDescription ( ) const
virtual

Reimplemented in SwDrawFrameFormat.

Definition at line 2887 of file atrfrm.cxx.

References SwResId().

Referenced by SwWrtShell::GetSelDescr().

◆ GetIMapObject()

IMapObject * SwFrameFormat::GetIMapObject ( const Point rPoint,
const SwFlyFrame pFly = nullptr 
) const

◆ GetLayoutDir()

SwFrameFormat::tLayoutDir SwFrameFormat::GetLayoutDir ( ) const
virtual

◆ GetOtherTextBoxFormats()

const std::shared_ptr< SwTextBoxNode > & SwFrameFormat::GetOtherTextBoxFormats ( ) const
inline

◆ GetPositionLayoutDir()

sal_Int16 SwFrameFormat::GetPositionLayoutDir ( ) const
virtual

Reimplemented in SwDrawFrameFormat.

Definition at line 2878 of file atrfrm.cxx.

Referenced by SwXShape::getPropertyValue().

◆ getSdrAllFillAttributesHelper()

drawinglayer::attribute::SdrAllFillAttributesHelperPtr SwFrameFormat::getSdrAllFillAttributesHelper ( ) const
overridevirtual

◆ GetXObject()

SAL_DLLPRIVATE css::uno::WeakReference< css::uno::XInterface > const & SwFrameFormat::GetXObject ( ) const
inline

◆ IsLowerOf()

bool SwFrameFormat::IsLowerOf ( const SwFrameFormat rFormat) const

◆ IsVisible()

bool SwFrameFormat::IsVisible ( ) const
virtual

◆ MakeFrames()

void SwFrameFormat::MakeFrames ( )
virtual

◆ MakeGraphic()

Graphic SwFrameFormat::MakeGraphic ( ImageMap pMap = nullptr,
const sal_uInt32  nMaximumQuadraticPixels = 500000,
const std::optional< Size > &  rTargetDPI = std::nullopt 
)
virtual

Reimplemented in SwFlyFrameFormat, and SwDrawFrameFormat.

Definition at line 7818 of file paintfrm.cxx.

◆ MoveTableBox()

void SwFrameFormat::MoveTableBox ( SwTableBox rTableBox,
const SwFrameFormat pOldFormat 
)

◆ operator=() [1/2]

SwFrameFormat & SwFrameFormat::operator= ( SwFrameFormat &&  )
default

◆ operator=() [2/2]

SwFrameFormat & SwFrameFormat::operator= ( SwFrameFormat const &  )
default

◆ RegisterToFormat()

void SwFrameFormat::RegisterToFormat ( SwFormat rFormat)

Definition at line 2727 of file atrfrm.cxx.

Referenced by SwClientNotify(), and SwSection::~SwSection().

◆ SetFormatName()

void SwFrameFormat::SetFormatName ( const OUString &  rNewName,
bool  bBroadcast = false 
)
overridevirtual

◆ SetLayoutDir()

void SwFrameFormat::SetLayoutDir ( const SwFrameFormat::tLayoutDir  _eLayoutDir)
virtual

Reimplemented in SwDrawFrameFormat.

Definition at line 2872 of file atrfrm.cxx.

Referenced by SwAnchoredObject::UpdateLayoutDir().

◆ SetOtherTextBoxFormats()

void SwFrameFormat::SetOtherTextBoxFormats ( const std::shared_ptr< SwTextBoxNode > &  rNew)
inline

◆ SetPositionLayoutDir()

void SwFrameFormat::SetPositionLayoutDir ( const sal_Int16  _nPositionLayoutDir)
virtual

Reimplemented in SwDrawFrameFormat.

Definition at line 2882 of file atrfrm.cxx.

Referenced by SwAnchoredDrawObject::SetPositioningAttr(), and SwXShape::setPropertyValue().

◆ SetXObject()

SAL_DLLPRIVATE void SwFrameFormat::SetXObject ( css::uno::Reference< css::uno::XInterface > const &  xObject)
inline

◆ supportsFullDrawingLayerFillAttributeSet()

bool SwFrameFormat::supportsFullDrawingLayerFillAttributeSet ( ) const
overridevirtual

◆ SwClientNotify()

void SwFrameFormat::SwClientNotify ( const SwModify rMod,
const SfxHint rHint 
)
overrideprotectedvirtual

Friends And Related Function Documentation

◆ ::sw::DocumentLayoutManager

friend class ::sw::DocumentLayoutManager
friend

Is allowed to call protected CTor.

Definition at line 75 of file frmfmt.hxx.

◆ sw::FrameFormats< sw::SpzFrameFormat * >

friend class sw::FrameFormats< sw::SpzFrameFormat * >
friend

Is allowed to update the list backref.

Definition at line 75 of file frmfmt.hxx.

◆ sw::FrameFormats< SwFrameFormat * >

friend class sw::FrameFormats< SwFrameFormat * >
friend

Is allowed to update the list backref.

Definition at line 75 of file frmfmt.hxx.

◆ sw::FrameFormats< SwTableFormat * >

friend class sw::FrameFormats< SwTableFormat * >
friend

Is allowed to update the list backref.

Definition at line 75 of file frmfmt.hxx.

◆ SwDoc

friend class SwDoc
friend

Definition at line 73 of file frmfmt.hxx.

◆ SwPageDesc

friend class SwPageDesc
friend

Is allowed to call protected CTor.

Definition at line 74 of file frmfmt.hxx.

◆ SwTextBoxHelper

friend class SwTextBoxHelper
friend

Definition at line 79 of file frmfmt.hxx.

◆ SwUndoFlyBase

friend class SwUndoFlyBase
friend

calls SetOtherTextBoxFormat

Definition at line 80 of file frmfmt.hxx.

Member Data Documentation

◆ m_ffList

SwFormatsBase* SwFrameFormat::m_ffList
private

Definition at line 88 of file frmfmt.hxx.

Referenced by SetFormatName().

◆ m_pOtherTextBoxFormats

std::shared_ptr< SwTextBoxNode > SwFrameFormat::m_pOtherTextBoxFormats
private

Definition at line 90 of file frmfmt.hxx.

Referenced by dumpAsXml(), and ~SwFrameFormat().

◆ m_wXObject

css::uno::WeakReference<css::uno::XInterface> SwFrameFormat::m_wXObject
private

Definition at line 82 of file frmfmt.hxx.

◆ maFillAttributes

drawinglayer::attribute::SdrAllFillAttributesHelperPtr SwFrameFormat::maFillAttributes
private

Definition at line 85 of file frmfmt.hxx.

Referenced by getSdrAllFillAttributesHelper(), and SwClientNotify().


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