SwFrameFormat Class Reference

Style of a layout element. More...

#include <frmfmt.hxx>

Inheritance diagram for SwFrameFormat:

Collaboration diagram for SwFrameFormat:

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
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)

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
SwFormatsBase *	m_ffList
std::shared_ptr< SwTextBoxNode >	m_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

enum SwFrameFormat::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

Definition at line 2577 of file atrfrm.cxx.

References SwFormat::GetAnchor(), SwFormatAnchor::GetAnchorNode(), SwFormat::GetDoc(), m_pOtherTextBoxFormats, RES_DRAWFRMFMT(), RES_FLYFRMFMT(), and SwFormat::Which().

SwFrameFormat() [3/4]

SwFrameFormat::SwFrameFormat ( SwFrameFormat const &  )

default

SwFrameFormat() [4/4]

SwFrameFormat::SwFrameFormat ( SwFrameFormat &&  )

default

Member Function Documentation

DelFrames()

void SwFrameFormat::DelFrames ( )

virtual

Destroys all Frames in aDepend (Frames are identified via dynamic_cast).

Delete all Frames that are registered in aDepend.

Reimplemented in SwDrawFrameFormat, and SwSectionFormat.

Definition at line 2733 of file atrfrm.cxx.

References SwFrame::Cut(), SwFrame::DestroyFrame(), SwIterator< TElementType, TSource, eMode >::First(), and SwIterator< TElementType, TSource, eMode >::Next().

Referenced by SwUndoFlyBase::DelFly(), sw::DocumentLayoutManager::DelLayoutFormat(), lcl_InsertLabel(), SwFEShell::NewFlyFrame(), SwReader::Read(), SwUndoFormatAttr::RestoreFlyAnchor(), SaveFlyInRange(), SwTextFlyCnt::SetAnchor(), SwHTMLParser::SetAttr_(), SwDoc::SetFlyFrameAnchor(), SwHistoryChangeFlyAnchor::SetInDoc(), SwXShape::setPropertyValue(), SwTextNode::SplitContentNode(), and SwUndoSetFlyFormat::UndoImpl().

dumpAsXml()

void SwFrameFormat::dumpAsXml

(

xmlTextWriterPtr

pWriter

)

const

Definition at line 2892 of file atrfrm.cxx.

References SfxItemSet::dumpAsXml(), FindSdrObject(), SwFormat::GetAttrSet(), SwFormat::GetName(), m_pOtherTextBoxFormats, RES_DRAWFRMFMT(), RES_FLYFRMFMT(), and SwFormat::Which().

Referenced by SwPageDesc::dumpAsXml(), SwUndoFlyBase::dumpAsXml(), and SwUndoDrawDelete::dumpAsXml().

FindLayoutRect()

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

Returns

the real size of the frame - or an empty rectangle if no layout exists. If pPoint is given, look for the frame closest to it.

Definition at line 2749 of file atrfrm.cxx.

References Fly, FRM_ALL, SwFrameAreaDefinition::getFrameArea(), GetFrameOfModify(), SwFrameAreaDefinition::getFramePrintArea(), SwNode::GetIndex(), SwNode::GetSectionNode(), SwFrame::KnowsFormat(), SwNode2Layout::NextFrame(), SwRect::Pos(), RES_FLYFRMFMT(), and SwFormat::Which().

Referenced by myImplHelpers::CalcHdFtDist(), SwXMLExport::ExportTableAutoStyles(), SwContentType::FillMemberList(), ww8::Frame::Frame(), AttributeOutputBase::GetTablePageSize(), lcl_dbg_out(), OutHTML_SwTableNode(), WW8AttributeOutput::OutputFlyFrame_Impl(), DocxSdrExport::startDMLAnchorInline(), and PlcDrawObj::WritePlc().

FindRealSdrObject() [1/2]

SdrObject * SwFrameFormat::FindRealSdrObject

(

)

Definition at line 2802 of file atrfrm.cxx.

References FindSdrObject(), Fly, SfxObjectShell::GetCreateMode(), SwFormat::GetDoc(), SwDoc::GetDocShell(), GetFrameOfModify(), SwFlyFrame::GetVirtDrawObj(), RES_FLYFRMFMT(), and SwFormat::Which().

Referenced by SwDrawContact::Changed_(), SwWW8ImplReader::CreateContactObject(), SwTextBoxHelper::doTextBoxPositioning(), SwTextBoxHelper::DoTextBoxZOrderCorrection(), DocxAttributeOutput::FormatBox(), ww8::Frame::Frame(), SwFrame::GetBackgroundBrush(), SwTextBoxHelper::getOtherTextBoxFormat(), SwXShape::getPropertyValue(), WW8Export::GetSdrOrdNum(), SwFlyFrame::IsShowUnfloatButton(), SwTextBoxHelper::isTextBox(), lcl_textBoxSizeNotify(), SwFlyAtContentFrame::MakeAll(), WW8Export::MiserableFormFieldExportHack(), SwWW8AttrIter::OutFlys(), RtfAttributeOutput::OutputFlyFrame_Impl(), DocxSdrExport::startDMLAnchorInline(), SwEscherEx::SwEscherEx(), SwTextBoxHelper::syncFlyFrameAttr(), SwTextBoxHelper::syncProperty(), DocxAttributeOutput::TextBoxIsFramePr(), DocxSdrExport::writeDMLTextFrame(), SwEscherEx::WriteFlyFrame(), DocxAttributeOutput::WriteFlyFrame(), SwBasicEscherEx::WriteFlyFrameAttr(), SwEscherEx::WriteOCXControl(), SwBasicEscherEx::WriteOLEFlyFrame(), PlcDrawObj::WritePlc(), and DocxSdrExport::writeVMLTextFrame().

FindRealSdrObject() [2/2]

const SdrObject * SwFrameFormat::FindRealSdrObject ( ) const

inline

Definition at line 163 of file frmfmt.hxx.

FindSdrObject() [1/2]

SdrObject * SwFrameFormat::FindSdrObject ( )

inline

Returns

the SdrObject, that is connected to the ContactObject. Only DrawFrameFormats are connected to the "real SdrObject". FlyFrameFormats are connected to a Master and all FlyFrames has the "real SdrObject". "Real SdrObject" has position and a Z-order.

Definition at line 153 of file frmfmt.hxx.

References pObject.

Referenced by SwTextBoxNode::Clone(), SwXText::convertToTextFrame(), SwFEShell::CopyDrawSel(), sw::DocumentLayoutManager::CopyLayoutFormat(), SwWW8ImplReader::CreateContactObject(), SwXShape::dispose(), dumpAsXml(), FindRealSdrObject(), SwUndoInsLayFormat::GetComment(), SwDrawFrameFormat::GetDescription(), SwHTMLWriter::GetHTMLControl(), SwHTMLWriter::GetMarqueeTextObj(), SwTextNode::GetMinMaxSize(), SwFlyFrameFormat::GetObjDescription(), SwFlyFrameFormat::GetObjTitle(), SwEditShell::HandleUndoRedoContext(), lcl_MinMaxNode(), SwDrawFrameFormat::MakeGraphic(), SwWW8ImplReader::MapWrapIntoFlyFormat(), SwEditWin::MouseButtonUp(), SwHTMLWriter::OutCSS1_FrameFormatOptions(), OutHTML_FrameFormatAsImage(), SwUndoInsertLabel::RedoImpl(), SwUndoFormatAttr::RestoreFlyAnchor(), sw::DocumentDrawModelManager::Search(), SwCursorShell::SelectNxtPrvHyperlink(), SwTextFlyCnt::SetAnchor(), SwHTMLParser::SetControlSize(), SwFlyFrameFormat::SetObjDecorative(), SwFlyFrameFormat::SetObjDescription(), SwFlyFrameFormat::SetObjTitle(), SwXShape::setPropertyValue(), SwUndoInsertLabel::UndoImpl(), and SwHTMLWriter::writeFrameFormatOptions().

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

Returns

the IMapObject defined at format (Fly) in the ImageMap at position Point. rPoint - test on DocPosition. pFly - optional FlyFrame, in case it is already known.

Definition at line 3539 of file atrfrm.cxx.

References Both, o3tl::convert(), SwIterator< TElementType, TSource, eMode >::First(), SwFlyFrame::GetFormat(), SwFrameAreaDefinition::getFrameArea(), SwFrameAreaDefinition::getFramePrintArea(), SwFormat::GetFrameSize(), ImageMap::GetHitIMapObject(), SwFormatURL::GetMap(), GetNode(), SwNode::GetNoTextNode(), SvxSizeItem::GetSize(), SwContentNode::GetSwAttrSet(), SwNoTextNode::GetTwipSize(), SwFormat::GetURL(), Horizontal, IMAP_MIRROR_HORZ, IMAP_MIRROR_VERT, Size::IsEmpty(), SwNode::IsGrfNode(), SwFrame::IsNoTextFrame(), SwLayoutFrame::Lower(), o3tl::mm100, SwRect::Pos(), SwRect::SSize(), o3tl::twip, and Vertical.

Referenced by SwVirtFlyDrawObj::CheckMacroHit(), SwFEShell::IsURLGrfAtPos(), SwEditWin::MouseMove(), and SwDPage::RequestHelp().

GetLayoutDir()

SwFrameFormat::tLayoutDir SwFrameFormat::GetLayoutDir ( ) const

virtual

Reimplemented in SwDrawFrameFormat.

Definition at line 2867 of file atrfrm.cxx.

References HORI_L2R.

Referenced by SwDrawContact::Changed_(), SwXShape::ConvertPositionToHoriL2R(), and SwAnchoredDrawObject::SetPositioningAttr().

GetOtherTextBoxFormats()

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

inline

Definition at line 118 of file frmfmt.hxx.

Referenced by SwTextBoxHelper::changeAnchor(), SwDoc::ChgAnchor(), SwTextBoxNode::Clone_Impl(), SwXText::convertToTextFrame(), sw::DocumentLayoutManager::CopyLayoutFormat(), SwTextBoxHelper::create(), SwUndoFlyBase::DelFly(), SwTextBoxHelper::destroy(), SwTextBoxHelper::doTextBoxPositioning(), SwTextBoxHelper::getOtherTextBoxFormat(), SwTextBoxNode::GetTextBox(), SwEditShell::HandleUndoRedoContext(), SwUndoFlyBase::InsFly(), SwTextBoxHelper::isAnchorSyncNeeded(), SwTextBoxHelper::isTextBox(), lcl_CollectTextBoxesForSubGroupObj(), SwUndoDrawGroup::RedoImpl(), SwUndoDrawUnGroup::RedoImpl(), SwTextBoxHelper::set(), SwXShape::setPropertyValue(), SwTextBoxHelper::syncFlyFrameAttr(), SwTextBoxHelper::syncProperty(), SwTextBoxHelper::syncTextBoxSize(), SwUndoDrawGroup::UndoImpl(), SwUndoDrawUnGroup::UndoImpl(), SwUndoDrawDelete::UndoImpl(), and SwUndoFlyBase::~SwUndoFlyBase().

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

Reimplemented from SwFormat.

Definition at line 3600 of file atrfrm.cxx.

References SwFormat::GetAttrSet(), maFillAttributes, and supportsFullDrawingLayerFillAttributeSet().

Referenced by SwFlyFrameFormat::IsBackgroundBrushInherited(), SwFlyFrameFormat::IsBackgroundTransparent(), and SwFlyFrame::PaintSwFrame().

GetXObject()

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

inline

Definition at line 183 of file frmfmt.hxx.

Referenced by SwXDocumentIndex::CreateXDocumentIndex(), SwXHeadFootText::CreateXHeadFootText(), and SwXTextTable::CreateXTextTable().

IsLowerOf()

bool SwFrameFormat::IsLowerOf

(

const SwFrameFormat &

rFormat

)

const

Definition at line 2822 of file atrfrm.cxx.

References SwNode::FindFlyStartNode(), SwIterator< TElementType, TSource, eMode >::First(), SwFormat::GetAnchor(), SwFormatAnchor::GetAnchorId(), SwFormatAnchor::GetAnchorNode(), SwFormat::GetDoc(), SwNodeIndex::GetNode(), and SwFlyFrame::IsLowerOf().

Referenced by SwDoc::Chainable().

IsVisible()

bool SwFrameFormat::IsVisible ( ) const

virtual

Reimplemented in SwSectionFormat.

Definition at line 3631 of file atrfrm.cxx.

References SwIterator< TElementType, TSource, eMode >::First().

Referenced by SwContentType::FillMemberList(), and SwSectionFormat::IsVisible().

MakeFrames()

void SwFrameFormat::MakeFrames ( )

virtual

Creates the views.

Reimplemented in SwFlyFrameFormat, SwDrawFrameFormat, and SwSectionFormat.

Definition at line 2744 of file atrfrm.cxx.

Referenced by sw::DocumentLayoutManager::CopyLayoutFormat(), SwUndoFlyBase::InsFly(), lcl_SetFlyFrameAttr(), SwReader::Read(), RestFlyInRange(), SwUndoFormatAttr::RestoreFlyAnchor(), SwHTMLParser::SetAttr_(), SwFltControlStack::SetAttrInDoc(), SwDoc::SetFlyFrameAnchor(), SwDoc::SetFrameFormatToFly(), SwNodes::TableToText(), and SwUndoSetFlyFormat::UndoImpl().

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
	)

Definition at line 3619 of file atrfrm.cxx.

References Add, SwFormat::GetFormatAttr(), RES_BOXATR_FORMAT(), and SwClientNotify().

Referenced by SaveTable::NewFrameFormatForBox().

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

Reimplemented from SwFormat.

Definition at line 2608 of file atrfrm.cxx.

References SwFormat::m_aFormatName, m_ffList, SwFormatsBase::Rename(), SAL_INFO_IF, and SwFormat::SetFormatName().

Referenced by SwFmDrawPage::add(), sw::DocumentLayoutManager::CopyLayoutFormat(), SwFEShell::ImpEndCreate(), SwWW8ImplReader::ImportGraf(), SwFEShell::InsertDrawObj(), SwHTMLParser::InsertEmbed(), SwHTMLParser::InsertFlyFrame(), SwHTMLParser::InsertImage(), SwDoc::InsertSwSection(), InsertTableImpl(), SwTable::MakeCopy(), SwDoc::MakeTableBoxFormat(), SwDoc::MakeTableLineFormat(), SwNodes::MergeTable(), SwWW8ImplReader::Read_GrafLayer(), SwDoc::SetAllUniqueFlyNames(), SwDoc::SetFlyName(), SwXTextTable::setName(), SwDocStyleSheet::SetName(), SwDoc::SetTableName(), wwFrameNamer::SetUniqueGraphName(), and SwUndoMergeTable::UndoImpl().

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

Definition at line 119 of file frmfmt.hxx.

Referenced by SwTextBoxNode::Clone_Impl(), SwTextBoxHelper::create(), SwDoc::GroupSelection(), lcl_CollectTextBoxesForSubGroupObj(), SwUndoDrawUnGroup::RedoImpl(), SwTextBoxHelper::set(), SwUndoDrawGroup::UndoImpl(), SwDoc::UnGroupSelection(), and SwUndoFlyBase::~SwUndoFlyBase().

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

Definition at line 185 of file frmfmt.hxx.

Referenced by SwXDocumentIndex::attach(), SwXTextSection::attach(), SwXDocumentIndex::CreateXDocumentIndex(), SwXHeadFootText::CreateXHeadFootText(), SwXTextTable::CreateXTextTable(), and SwClientNotify().

supportsFullDrawingLayerFillAttributeSet()

bool SwFrameFormat::supportsFullDrawingLayerFillAttributeSet ( ) const

overridevirtual

Reimplemented from SwFormat.

Reimplemented in SwSectionFormat, SwTableFormat, SwTableLineFormat, and SwTableBoxFormat.

Definition at line 2622 of file atrfrm.cxx.

Referenced by getSdrAllFillAttributesHelper(), SwFlyFrameFormat::IsBackgroundBrushInherited(), SwFlyFrameFormat::IsBackgroundTransparent(), SwFlyFrame::PaintSwFrame(), and SwClientNotify().

SwClientNotify()

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

overrideprotectedvirtual

Reimplemented from SwFormat.

Reimplemented in SwSectionFormat, and SwTableBoxFormat.

Definition at line 2627 of file atrfrm.cxx.

References SwNode::AddAnchoredFly(), SwFormatAnchor::GetAnchorNode(), SwAttrSetChg::GetChgSet(), SfxItemIter::GetCurItem(), SwFormat::GetDoc(), SwFormatFooter::GetFooterFormat(), SwFormatHeader::GetHeaderFormat(), SfxHint::GetId(), SwDoc::getIDocumentLayoutAccess(), SwNode::GetIndex(), SfxItemSet::GetItem(), SwAttrSetChg::GetTheChgdSet(), SwFormatHeader::IsActive(), SwFormatFooter::IsActive(), IsInvalidItem(), SwFormat::m_aSet, sw::LegacyModifyHint::m_pNew, maFillAttributes, IDocumentLayoutAccess::MakeLayoutFormat(), SfxItemIter::NextItem(), RegisterToFormat(), SwNode::RemoveAnchoredFly(), RES_ANCHOR(), RES_ATTRSET_CHG(), RES_FMT_CHG(), RES_FOOTER(), RES_HEADER(), RES_REMOVE_UNO_OBJECT(), SetXObject(), supportsFullDrawingLayerFillAttributeSet(), SwFormat::SwClientNotify(), SfxPoolItem::Which(), XATTR_FILL_FIRST(), and XATTR_FILL_LAST().

Referenced by MoveTableBox(), SwSectionFormat::SwClientNotify(), and SwTableBoxFormat::SwClientNotify().

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:

• frmfmt.hxx
• atrfrm.cxx
• paintfrm.cxx