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:
Collaboration diagram for SwSectionFormat:

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
SwSectionGetSection () const
SwSectionFormatGetParent () const
SwSectionGetParentSection () const
void GetChildSections (SwSections &rArr, SectionSort eSort=SectionSort::Not, bool bAllSections=true) const
bool IsInNodesArr () const
SwSectionNodeGetSectionNode ()
const SwSectionNodeGetSectionNode () const
const SwSectionGetGlobalDocSection () const
SAL_DLLPRIVATE css::uno::WeakReference< css::text::XTextSection > const & GetXTextSection () const
SAL_DLLPRIVATE void SetXTextSection (css::uno::Reference< css::text::XTextSection > const &xTextSection)
virtual ::sfx2::IXmlIdRegistryGetRegistry () 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
SwFrameFormatoperator= (SwFrameFormat const &)=default
SwFrameFormatoperator= (SwFrameFormat &&)=default
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
void dumpAsXml (xmlTextWriterPtr pWriter) const
virtual void SetName (const OUString &rNewName, bool bBroadcast=false) override
void MoveTableBox (SwTableBox &rTableBox, const SwFrameFormat *pOldFormat)
- 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
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 IsAutoUpdateFormat () const
 Query / set bAutoUpdateFormat-flag. More...
void SetAutoUpdateFormat (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 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 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...
void RemoveAllUnos ()
- Public Member Functions inherited from sw::BorderCacheOwner
 BorderCacheOwner ()
 BorderCacheOwner (BorderCacheOwner &)
BorderCacheOwneroperator= (const BorderCacheOwner &)
 ~BorderCacheOwner ()
bool IsInCache () const
void InvalidateInSwCache (const sal_uInt16)
- Public Member Functions inherited from sw::BroadcastingModify
virtual void CallSwClientNotify (const SfxHint &rHint) const override
- Public Member Functions inherited from SwModify
 SwModify ()
virtual ~SwModify () override
void Add (SwClient *pDepend)
SwClientRemove (SwClient *pDepend)
bool HasWriterListeners () const
bool HasOnlyOneListener () const
void LockModify ()
void UnlockModify ()
bool IsModifyLocked () const
- Public Member Functions inherited from SwClient
 SwClient ()
 SwClient (SwClient &&) noexcept
virtual ~SwClient () override
std::optional< sw::ModifyChangedHintCheckRegistration (const SfxPoolItem *pOldValue)
void CheckRegistrationFormat (SwFormat &rOld)
const SwModifyGetRegisteredIn () const
SwModifyGetRegisteredIn ()
void EndListeningAll ()
void StartListeningToSameModifyAs (const SwClient &)
- Public Member Functions inherited from sw::WriterListener
bool IsLast () const
virtual const SwCellFrameDynCastCellFrame () const
virtual const SwTabFrameDynCastTabFrame () const
virtual const SwRowFrameDynCastRowFrame () const
- Public Member Functions inherited from sw::BroadcasterMixin
 BroadcasterMixin ()=default
 BroadcasterMixin (BroadcasterMixin const &)=default
BroadcasterMixinoperator= (const BroadcasterMixin &)
SvtBroadcasterGetNotifier ()
- Public Member Functions inherited from sfx2::Metadatable
 Metadatable ()
virtual ~Metadatable ()
css::beans::StringPair GetMetadataReference () const
void SetMetadataReference (const css::beans::StringPair &i_rReference)
void EnsureMetadataReference ()
void RemoveMetadataReference ()
void RegisterAsCopyOf (Metadatable const &i_rSource, const bool i_bCopyPrecedesSource=false)
std::shared_ptr< MetadatableUndoCreateUndo () const
std::shared_ptr< MetadatableUndoCreateUndoForDelete ()
void RestoreMetadata (std::shared_ptr< MetadatableUndo > const &i_pUndo)
void JoinMetadatable (Metadatable const &i_rOther, const bool i_isMergedEmpty, const bool i_isOtherEmpty)

Private Member Functions

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

Private Attributes

css::uno::WeakReference< css::text::XTextSection > 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...


class SwDoc

Additional Inherited Members

- Public Types inherited from SwFrameFormat
enum  tLayoutDir {
- 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)
- Protected Member Functions inherited from SwFormat
 SwFormat (SwAttrPool &rPool, const char *pFormatNm, const WhichRangesContainer &pWhichRanges, SwFormat *pDrvdFrame, sal_uInt16 nFormatWhich)
 SwFormat (SwAttrPool &rPool, const OUString &rFormatNm, const WhichRangesContainer &pWhichRanges, SwFormat *pDrvdFrame, sal_uInt16 nFormatWhich)
 SwFormat (const SwFormat &rFormat)
- Protected Member Functions inherited from SwClient
 SwClient (SwModify *pToRegisterIn)
SwModifyGetRegisteredInNonConst () const
- Protected Member Functions inherited from sw::WriterListener
 WriterListener ()
virtual ~WriterListener () COVERITY_NOEXCEPT_FALSE

Detailed Description

Definition at line 269 of file section.hxx.

Constructor & Destructor Documentation

SwSectionFormat::SwSectionFormat ( SwFrameFormat pDrvdFrame,
SwDoc pDoc 
SwSectionFormat::~SwSectionFormat ( )

Member Function Documentation

void SwSectionFormat::DelFrames ( )
void SwSectionFormat::dumpAsXml ( xmlTextWriterPtr  pWriter) const
void SwSectionFormat::GetChildSections ( SwSections rArr,
SectionSort  eSort = SectionSort::Not,
bool  bAllSections = true 
) const
const SwSection * SwSectionFormat::GetGlobalDocSection ( ) const
bool SwSectionFormat::GetInfo ( SfxPoolItem rInfo) const
SwSectionFormat * SwSectionFormat::GetParent ( ) const
SwSection * SwSectionFormat::GetParentSection ( ) const

Definition at line 363 of file section.hxx.

References GetParent(), and GetSection().

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

sfx2::IXmlIdRegistry & SwSectionFormat::GetRegistry ( )

Implements sfx2::Metadatable.

Definition at line 945 of file section.cxx.

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

SwSection * SwSectionFormat::GetSection ( ) const
SwSectionNode * SwSectionFormat::GetSectionNode ( )
const SwSectionNode* SwSectionFormat::GetSectionNode ( ) const

Definition at line 313 of file section.hxx.

SAL_DLLPRIVATE css::uno::WeakReference<css::text::XTextSection> const& SwSectionFormat::GetXTextSection ( ) const

Definition at line 320 of file section.hxx.

Referenced by SwXTextSection::CreateXTextSection().

bool SwSectionFormat::IsInClipboard ( ) const

Implements sfx2::Metadatable.

Definition at line 950 of file section.cxx.

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

bool SwSectionFormat::IsInContent ( ) const
bool SwSectionFormat::IsInNodesArr ( ) const
bool SwSectionFormat::IsInUndo ( ) const

Implements sfx2::Metadatable.

Definition at line 955 of file section.cxx.

References IsInNodesArr().

void SwSectionFormat::MakeFrames ( )
uno::Reference< rdf::XMetadatable > SwSectionFormat::MakeUnoObject ( )
SAL_DLLPRIVATE void SwSectionFormat::SetXTextSection ( css::uno::Reference< css::text::XTextSection > const &  xTextSection)

Definition at line 322 of file section.hxx.

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

bool SwSectionFormat::supportsFullDrawingLayerFillAttributeSet ( ) const

Reimplemented from SwFrameFormat.

Definition at line 986 of file section.cxx.

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

Friends And Related Function Documentation

friend class SwDoc

Definition at line 273 of file section.hxx.

Member Data Documentation

css::uno::WeakReference<css::text::XTextSection> SwSectionFormat::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.

Definition at line 279 of file section.hxx.

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