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

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)
 
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 SetName (const OUString &rNewName, bool bBroadcast=false) override
 
- 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
 
SfxItemState GetBackgroundState (std::shared_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 (const OUString &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::shared_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
 
virtual bool IsBackgroundTransparent () const
 SwFormat::IsBackgroundTransparent. More...
 
- Public Member Functions inherited from sw::BroadcastingModify
virtual void CallSwClientNotify (const SfxHint &rHint) const override
 
- Public Member Functions inherited from SwModify
 SwModify ()
 
 SwModify (SwModify *pToRegisterIn)
 
void NotifyClients (const SfxPoolItem *pOldValue, const SfxPoolItem *pNewValue)
 
void ModifyBroadcast (const SfxPoolItem *pOldValue, const SfxPoolItem *pNewValue)
 
virtual ~SwModify () override
 
void Add (SwClient *pDepend)
 
SwClientRemove (SwClient *pDepend)
 
bool HasWriterListeners () const
 
virtual bool GetInfo (SfxPoolItem &) const override
 
void LockModify ()
 
void UnlockModify ()
 
void SetInCache (bool bNew)
 
void SetInSwFntCache (bool bNew)
 
void SetInDocDTOR ()
 
bool IsModifyLocked () const
 
bool IsInCache () const
 
bool IsInSwFntCache () const
 
void CheckCaching (const sal_uInt16 nWhich)
 
bool HasOnlyOneListener ()
 
- Public Member Functions inherited from SwClient
 SwClient ()
 
 SwClient (SwClient &&) noexcept
 
virtual ~SwClient () override
 
virtual void SwClientNotify (const SwModify &, const SfxHint &rHint) override
 
std::unique_ptr< sw::ModifyChangedHintCheckRegistration (const SfxPoolItem *pOldValue)
 
virtual void ModifyNotification (const SfxPoolItem *pOldValue, const SfxPoolItem *pNewValue)
 
void SwClientNotifyCall (const SwModify &rModify, const SfxHint &rHint)
 
const SwModifyGetRegisteredIn () const
 
SwModifyGetRegisteredIn ()
 
void EndListeningAll ()
 
void StartListeningToSameModifyAs (const SwClient &)
 
- Public Member Functions inherited from sw::WriterListener
bool IsLast () const
 
- Public Member Functions inherited from sw::BroadcasterMixin
 BroadcasterMixin ()=default
 
 BroadcasterMixin (BroadcasterMixin const &)=default
 
BroadcasterMixinoperator= (const BroadcasterMixin &)
 
SvtBroadcasterGetNotifier ()
 

Protected Member Functions

 SwFrameFormat (SwAttrPool &rPool, const sal_Char *pFormatNm, SwFrameFormat *pDrvdFrame, sal_uInt16 nFormatWhich=RES_FRMFMT, const sal_uInt16 *pWhichRange=nullptr)
 
 SwFrameFormat (SwAttrPool &rPool, const OUString &rFormatNm, SwFrameFormat *pDrvdFrame, sal_uInt16 nFormatWhich=RES_FRMFMT, const sal_uInt16 *pWhichRange=nullptr)
 
virtual void Modify (const SfxPoolItem *pOld, const SfxPoolItem *pNewValue) override
 
SwFrameFormatGetOtherTextBoxFormat () const
 
void SetOtherTextBoxFormat (SwFrameFormat *pFormat)
 
- Protected Member Functions inherited from SwFormat
 SwFormat (SwAttrPool &rPool, const sal_Char *pFormatNm, const sal_uInt16 *pWhichRanges, SwFormat *pDrvdFrame, sal_uInt16 nFormatWhich)
 
 SwFormat (SwAttrPool &rPool, const OUString &rFormatNm, const sal_uInt16 *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
 

Private Attributes

css::uno::WeakReference< css::uno::XInterface > m_wXObject
 
drawinglayer::attribute::SdrAllFillAttributesHelperPtr maFillAttributes
 
SwFrameFormatsm_ffList
 
SwFrameFormatm_pOtherTextBoxFormat
 

Friends

class SwDoc
 
class SwPageDesc
 Is allowed to call protected CTor. More...
 
class ::sw::DocumentLayoutManager
 Is allowed to call protected CTor. More...
 
class SwFrameFormats
 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 57 of file frmfmt.hxx.

Member Enumeration Documentation

Enumerator
HORI_L2R 
HORI_R2L 
VERT_R2L 

Definition at line 152 of file frmfmt.hxx.

Constructor & Destructor Documentation

SwFrameFormat::SwFrameFormat ( SwAttrPool rPool,
const sal_Char pFormatNm,
SwFrameFormat pDrvdFrame,
sal_uInt16  nFormatWhich = RES_FRMFMT,
const sal_uInt16 *  pWhichRange = nullptr 
)
protected

Definition at line 2418 of file atrfrm.cxx.

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

Definition at line 2432 of file atrfrm.cxx.

SwFrameFormat::~SwFrameFormat ( )
overridevirtual
SwFrameFormat::SwFrameFormat ( SwFrameFormat const &  )
default
SwFrameFormat::SwFrameFormat ( SwFrameFormat &&  )
default

Member Function Documentation

void SwFrameFormat::DelFrames ( )
virtual
void SwFrameFormat::dumpAsXml ( xmlTextWriterPtr  pWriter) const
SwRect SwFrameFormat::FindLayoutRect ( const bool  bPrtArea = false,
const Point pPoint = nullptr 
) const
SdrObject * SwFrameFormat::FindRealSdrObject ( )
const SdrObject* SwFrameFormat::FindRealSdrObject ( ) const
inline

Definition at line 147 of file frmfmt.hxx.

SdrObject* SwFrameFormat::FindSdrObject ( )
inline
const SdrObject* SwFrameFormat::FindSdrObject ( ) const
inline

Definition at line 143 of file frmfmt.hxx.

OUString SwFrameFormat::GetDescription ( ) const
virtual

Reimplemented in SwDrawFrameFormat.

Definition at line 2774 of file atrfrm.cxx.

References SwResId().

Referenced by SwContentTree::GetEntryLongDescription(), and SwWrtShell::GetSelDescr().

IMapObject * SwFrameFormat::GetIMapObject ( const Point rPoint,
const SwFlyFrame pFly = nullptr 
) const
SwFrameFormat::tLayoutDir SwFrameFormat::GetLayoutDir ( ) const
virtual
SwFrameFormat* SwFrameFormat::GetOtherTextBoxFormat ( ) const
inlineprotected
sal_Int16 SwFrameFormat::GetPositionLayoutDir ( ) const
virtual

Reimplemented in SwDrawFrameFormat.

Definition at line 2765 of file atrfrm.cxx.

Referenced by SwXShape::getPropertyValue().

drawinglayer::attribute::SdrAllFillAttributesHelperPtr SwFrameFormat::getSdrAllFillAttributesHelper ( ) const
overridevirtual
SAL_DLLPRIVATE css::uno::WeakReference<css::uno::XInterface> const& SwFrameFormat::GetXObject ( ) const
inline
bool SwFrameFormat::IsLowerOf ( const SwFrameFormat rFormat) const
void SwFrameFormat::MakeFrames ( )
virtual
Graphic SwFrameFormat::MakeGraphic ( ImageMap pMap = nullptr)
virtual

Reimplemented in SwDrawFrameFormat, and SwFlyFrameFormat.

Definition at line 7323 of file paintfrm.cxx.

void SwFrameFormat::Modify ( const SfxPoolItem pOld,
const SfxPoolItem pNewValue 
)
overrideprotectedvirtual
SwFrameFormat& SwFrameFormat::operator= ( SwFrameFormat const &  )
default
SwFrameFormat& SwFrameFormat::operator= ( SwFrameFormat &&  )
default
void SwFrameFormat::RegisterToFormat ( SwFormat rFormat)

Definition at line 2611 of file atrfrm.cxx.

References SwModify::Add().

Referenced by Modify(), SwUndoTableToText::UndoImpl(), and SwSection::~SwSection().

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

Reimplemented in SwDrawFrameFormat.

Definition at line 2759 of file atrfrm.cxx.

Referenced by SwAnchoredObject::UpdateLayoutDir().

void SwFrameFormat::SetName ( const OUString &  rNewName,
bool  bBroadcast = false 
)
overridevirtual
void SwFrameFormat::SetOtherTextBoxFormat ( SwFrameFormat pFormat)
protected
void SwFrameFormat::SetPositionLayoutDir ( const sal_Int16  _nPositionLayoutDir)
virtual

Reimplemented in SwDrawFrameFormat.

Definition at line 2769 of file atrfrm.cxx.

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

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

Friends And Related Function Documentation

friend class ::sw::DocumentLayoutManager
friend

Is allowed to call protected CTor.

Definition at line 62 of file frmfmt.hxx.

friend class SwDoc
friend

Definition at line 60 of file frmfmt.hxx.

friend class SwFrameFormats
friend

Is allowed to update the list backref.

Definition at line 63 of file frmfmt.hxx.

friend class SwPageDesc
friend

Is allowed to call protected CTor.

Definition at line 61 of file frmfmt.hxx.

friend class SwTextBoxHelper
friend

Definition at line 64 of file frmfmt.hxx.

friend class SwUndoFlyBase
friend

calls SetOtherTextBoxFormat

Definition at line 65 of file frmfmt.hxx.

Member Data Documentation

SwFrameFormats* SwFrameFormat::m_ffList
private

Definition at line 73 of file frmfmt.hxx.

Referenced by SwFrameFormats::ContainsFormat(), and SetName().

SwFrameFormat* SwFrameFormat::m_pOtherTextBoxFormat
private

Definition at line 75 of file frmfmt.hxx.

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

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

Definition at line 67 of file frmfmt.hxx.

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

Definition at line 70 of file frmfmt.hxx.

Referenced by getSdrAllFillAttributesHelper(), and Modify().


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