LibreOffice Module sw (master) 1
Public Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
SwSectionFormat Class Referencefinal

#include <section.hxx>

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

Public Member Functions

virtual ~SwSectionFormat () override
 
virtual void DelFrames () override
 Destroys all Frames in aDepend (Frames are identified via dynamic_cast). More...
 
virtual void MakeFrames () override
 Creates the views. More...
 
virtual bool GetInfo (SfxPoolItem &) const override
 
virtual bool IsVisible () const override
 
SwSection * GetSection () const
 
SwSectionFormat * GetParent () const
 
SwSection * GetParentSection () const
 
void GetChildSections (SwSections &rArr, SectionSort eSort=SectionSort::Not, bool bAllSections=true) const
 
bool IsInNodesArr () const
 
SwSectionNode * GetSectionNode ()
 
const SwSectionNode * GetSectionNode () const
 
const SwSection * GetGlobalDocSection () const
 
SAL_DLLPRIVATE unotools::WeakReference< SwXTextSection > const & GetXTextSection () const
 
SAL_DLLPRIVATE void SetXTextSection (rtl::Reference< SwXTextSection > const &xTextSection)
 
virtual ::sfx2::IXmlIdRegistry & GetRegistry () override
 
virtual bool IsInClipboard () const override
 
virtual bool IsInUndo () const override
 
virtual bool IsInContent () const override
 
virtual css::uno::Reference< css::rdf::XMetadatable > MakeUnoObject () override
 
virtual bool supportsFullDrawingLayerFillAttributeSet () const override
 
void dumpAsXml (xmlTextWriterPtr pWriter) const
 
- Public Member Functions inherited from SwFrameFormat
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
 
SwFrameFormat & operator= (SwFrameFormat const &)=default
 
SwFrameFormat & operator= (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)
 
IMapObject * GetIMapObject (const Point &rPoint, const SwFlyFrame *pFly=nullptr) const
 
SwRect FindLayoutRect (const bool bPrtArea=false, const Point *pPoint=nullptr) const
 
SdrObject * FindSdrObject ()
 
const SdrObject * FindSdrObject () const
 
SdrObject * FindRealSdrObject ()
 
const SdrObject * FindRealSdrObject () 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
 
SwFormat & operator= (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 SfxPoolItem & GetFormatAttr (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...
 
SwFormat * DerivedFrom () 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 SwAttrSet & GetAttrSet () const
 For querying the attribute array. More...
 
const SwDoc * GetDoc () const
 The document is set in SwAttrPool now, therefore you always can access it. More...
 
SwDoc * GetDoc ()
 
const IDocumentSettingAccess & getIDocumentSettingAccess () const
 Provides access to the document settings interface. More...
 
const IDocumentDrawModelAccess & getIDocumentDrawModelAccess () const
 Provides access to the document draw model interface. More...
 
IDocumentDrawModelAccess & getIDocumentDrawModelAccess ()
 
const IDocumentLayoutAccess & getIDocumentLayoutAccess () const
 Provides access to the document layout interface. More...
 
IDocumentLayoutAccess & getIDocumentLayoutAccess ()
 
IDocumentTimerAccess & getIDocumentTimerAccess ()
 Provides access to the document idle timer interface. More...
 
IDocumentFieldsAccess & getIDocumentFieldsAccess ()
 Provides access to the document idle timer interface. More...
 
IDocumentChartDataProviderAccess & getIDocumentChartDataProviderAccess ()
 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 SvxUnderlineItem & GetUnderline (bool=true) const
 GetMethods: Bool indicates whether to search only in Set (FALSE) or also in Parents. More...
 
const SvxFontHeightItem & GetSize (bool=true) const
 
const SvxFontItem & GetFont (bool=true) const
 
const SvxColorItem & GetColor (bool=true) const
 
const SvxFontItem & GetCJKFont (bool=true) const
 
const SvxFontItem & GetCTLFont (bool=true) const
 
const SwFormatFillOrder & GetFillOrder (bool=true) const
 Frame-attributes - implemented in frmatr.hxx. More...
 
const SwFormatFrameSize & GetFrameSize (bool=true) const
 
const SwFormatHeader & GetHeader (bool=true) const
 
const SwFormatFooter & GetFooter (bool=true) const
 
const SwFormatSurround & GetSurround (bool=true) const
 
const SwFormatHoriOrient & GetHoriOrient (bool=true) const
 
const SwFormatAnchor & GetAnchor (bool=true) const
 
const SwFormatCol & GetCol (bool=true) const
 
const SvxPaperBinItem & GetPaperBin (bool=true) const
 
const SvxLeftMarginItem & GetLeftMargin (bool=true) const
 
const SvxTextLeftMarginItem & GetTextLeftMargin (bool=true) const
 
const SvxFirstLineIndentItem & GetFirstLineIndent (bool=true) const
 
const SvxRightMarginItem & GetRightMargin (bool=true) const
 
const SvxGutterLeftMarginItem & GetGutterLeftMargin (bool=true) const
 
const SvxGutterRightMarginItem & GetGutterRightMargin (bool=true) const
 
const SvxLRSpaceItem & GetLRSpace (bool=true) const
 
const SvxULSpaceItem & GetULSpace (bool=true) const
 
const SwFormatContent & GetContent (bool=true) const
 
const SvxPrintItem & GetPrint (bool=true) const
 
const SvxOpaqueItem & GetOpaque (bool=true) const
 
const SvxProtectItem & GetProtect (bool=true) const
 
const SwFormatVertOrient & GetVertOrient (bool=true) const
 
const SvxBoxItem & GetBox (bool=true) const
 
const SvxFormatKeepItem & GetKeep (bool=true) const
 
std::unique_ptr< SvxBrushItem > makeBackgroundBrushItem (bool=true) const
 
const SvxShadowItem & GetShadow (bool=true) const
 
const SwFormatPageDesc & GetPageDesc (bool=true) const
 
const SvxFormatBreakItem & GetBreak (bool=true) const
 
const SvxMacroItem & GetMacro (bool=true) const
 
const SwFormatURL & GetURL (bool=true) const
 
const SwFormatEditInReadonly & GetEditInReadonly (bool=true) const
 
const SwFormatLayoutSplit & GetLayoutSplit (bool=true) const
 
const SwFormatRowSplit & GetRowSplit (bool=true) const
 
const SwFormatFlySplit & GetFlySplit (bool=true) const
 
const SwFormatChain & GetChain (bool=true) const
 
const SwFormatFootnoteAtTextEnd & GetFootnoteAtTextEnd (bool=true) const
 
const SwFormatEndAtTextEnd & GetEndAtTextEnd (bool=true) const
 
const SwFormatNoBalancedColumns & GetBalancedColumns (bool=true) const
 
const SvxFrameDirectionItem & GetFrameDir (bool=true) const
 
const SwTextGridItem & GetTextGrid (bool=true) const
 
const SwHeaderAndFooterEatSpacingItem & GetHeaderAndFooterEatSpacing (bool=true) const
 
const SwFormatFollowTextFlow & GetFollowTextFlow (bool=true) const
 
const SwFormatWrapInfluenceOnObjPos & GetWrapInfluenceOnObjPos (bool=true) const
 
const SdrTextVertAdjustItem & GetTextVertAdjust (bool=true) const
 
const SvxLineSpacingItem & GetLineSpacing (bool=true) const
 Paragraph-attributes - implemented in paratr.hxx. More...
 
const SwNumRuleItem & GetNumRule (bool=true) const
 
const SvxTabStopItem & GetTabStops (bool=true) const
 
const SwFormatDrop & GetDrop (bool=true) const
 
const SwTableBoxNumFormat & GetTableBoxNumFormat (bool=true) const
 TableBox attributes - implemented in cellatr.hxx. More...
 
const SwTableBoxFormula & GetTableBoxFormula (bool=true) const
 
const SwTableBoxValue & GetTableBoxValue (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 &)
 
BorderCacheOwner & operator= (const BorderCacheOwner &)
 
 ~BorderCacheOwner ()
 
bool IsInCache () const
 
void InvalidateInSwCache (const sal_uInt16)
 

Private Member Functions

SAL_DLLPRIVATE void UpdateParent ()
 
 SwSectionFormat (SwFrameFormat *pDrvdFrame, SwDoc *pDoc)
 
virtual void SwClientNotify (const SwModify &, const SfxHint &) override
 

Private Attributes

unotools::WeakReference< SwXTextSection > m_wXTextSection
 Why does this exist in addition to the m_wXObject in SwFrameFormat? in case of an index, both a SwXDocumentIndex and a SwXTextSection register at this SwSectionFormat, so we need to have two refs. More...
 

Friends

class SwDoc
 

Additional Inherited Members

- Public Types inherited from SwFrameFormat
enum  tLayoutDir {
  HORI_L2R ,
  HORI_R2L ,
  VERT_R2L
}
 
- Protected Member Functions inherited from SwFrameFormat
 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
 

Detailed Description

Definition at line 273 of file section.hxx.

Constructor & Destructor Documentation

◆ SwSectionFormat()

SwSectionFormat::SwSectionFormat ( SwFrameFormat *  pDrvdFrame,
SwDoc *  pDoc 
)
private

Definition at line 599 of file section.cxx.

References GetDfltAttr(), RES_COL(), and SwFormat::SetFormatAttr().

◆ ~SwSectionFormat()

SwSectionFormat::~SwSectionFormat ( )
overridevirtual

Member Function Documentation

◆ DelFrames()

void SwSectionFormat::DelFrames ( )
overridevirtual

◆ dumpAsXml()

void SwSectionFormat::dumpAsXml ( xmlTextWriterPtr  pWriter) const

◆ GetChildSections()

void SwSectionFormat::GetChildSections ( SwSections &  rArr,
SectionSort  eSort = SectionSort::Not,
bool  bAllSections = true 
) const

◆ GetGlobalDocSection()

const SwSection * SwSectionFormat::GetGlobalDocSection ( ) const

◆ GetInfo()

bool SwSectionFormat::GetInfo ( SfxPoolItem &  rInfo) const
overridevirtual

◆ GetParent()

SwSectionFormat * SwSectionFormat::GetParent ( ) const
inline

◆ GetParentSection()

SwSection * SwSectionFormat::GetParentSection ( ) const
inline

Definition at line 368 of file section.hxx.

References GetParent(), and GetSection().

Referenced by SwSection::GetParent(), SwSection::ImplSetHiddenFlag(), and UpdateParent().

◆ GetRegistry()

sfx2::IXmlIdRegistry & SwSectionFormat::GetRegistry ( )
override

Definition at line 946 of file section.cxx.

References SwFormat::GetDoc(), and SwDoc::GetXmlIdRegistry().

◆ GetSection()

SwSection * SwSectionFormat::GetSection ( ) const

◆ GetSectionNode() [1/2]

SwSectionNode * SwSectionFormat::GetSectionNode ( )

◆ GetSectionNode() [2/2]

const SwSectionNode * SwSectionFormat::GetSectionNode ( ) const
inline

Definition at line 319 of file section.hxx.

◆ GetXTextSection()

SAL_DLLPRIVATE unotools::WeakReference< SwXTextSection > const & SwSectionFormat::GetXTextSection ( ) const
inline

Definition at line 326 of file section.hxx.

Referenced by SwXTextSection::CreateXTextSection().

◆ IsInClipboard()

bool SwSectionFormat::IsInClipboard ( ) const
overridevirtual

Definition at line 951 of file section.cxx.

References SwFormat::GetDoc(), and SwDoc::IsClipBoard().

◆ IsInContent()

bool SwSectionFormat::IsInContent ( ) const
overridevirtual

◆ IsInNodesArr()

bool SwSectionFormat::IsInNodesArr ( ) const

◆ IsInUndo()

bool SwSectionFormat::IsInUndo ( ) const
overridevirtual

Definition at line 956 of file section.cxx.

References IsInNodesArr().

◆ IsVisible()

bool SwSectionFormat::IsVisible ( ) const
overridevirtual

◆ MakeFrames()

void SwSectionFormat::MakeFrames ( )
overridevirtual

◆ MakeUnoObject()

uno::Reference< rdf::XMetadatable > SwSectionFormat::MakeUnoObject ( )
overridevirtual

◆ SetXTextSection()

void SwSectionFormat::SetXTextSection ( rtl::Reference< SwXTextSection > const &  xTextSection)

Definition at line 808 of file section.cxx.

References m_wXTextSection.

Referenced by SwXTextSection::CreateXTextSection(), and SwClientNotify().

◆ supportsFullDrawingLayerFillAttributeSet()

bool SwSectionFormat::supportsFullDrawingLayerFillAttributeSet ( ) const
overridevirtual

Reimplemented from SwFrameFormat.

Definition at line 986 of file section.cxx.

◆ SwClientNotify()

void SwSectionFormat::SwClientNotify ( const SwModify &  rMod,
const SfxHint &  rHint 
)
overrideprivatevirtual

◆ UpdateParent()

void SwSectionFormat::UpdateParent ( )
private

Friends And Related Function Documentation

◆ SwDoc

friend class SwDoc
friend

Definition at line 277 of file section.hxx.

Member Data Documentation

◆ m_wXTextSection

unotools::WeakReference<SwXTextSection> SwSectionFormat::m_wXTextSection
private

Why does this exist in addition to the m_wXObject in SwFrameFormat? in case of an index, both a SwXDocumentIndex and a SwXTextSection register at this SwSectionFormat, so we need to have two refs.

Definition at line 283 of file section.hxx.

Referenced by SetXTextSection().


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