SwTextBoxNode Class Reference

Textboxes are basically textframe + shape pairs. More...

#include <textboxhelper.hxx>

Collaboration diagram for SwTextBoxNode:

Classes
struct	SwTextBoxElement

Public Member Functions
	SwTextBoxNode ()=delete
	SwTextBoxNode (SwFrameFormat *pOwnerShapeFormat)
	~SwTextBoxNode ()
	SwTextBoxNode (const SwTextBoxNode &)=default
void	AddTextBox (SdrObject *pDrawObject, SwFrameFormat *pNewTextBox)
void	DelTextBox (const SdrObject *pDrawObject, bool bDelFromDoc=false)
void	DelTextBox (const SwFrameFormat *pTextBox, bool bDelFromDoc=false)
SwFrameFormat *	GetTextBox (const SdrObject *pDrawObject) const
void	ClearAll ()
bool	IsGroupTextBox () const
SwFrameFormat *	GetOwnerShape ()
size_t	GetTextBoxCount () const
std::map< SdrObject *, SwFrameFormat * >	GetAllTextBoxes () const
void	Clone (SwDoc *pDoc, const SwFormatAnchor &rNewAnc, SwFrameFormat *o_pTarget, bool bSetAttr, bool bMakeFrame) const

Private Member Functions
void	Clone_Impl (SwDoc *pDoc, const SwFormatAnchor &rNewAnc, SwFrameFormat *o_pTarget, const SdrObject *pSrcObj, SdrObject *pDestObj, bool bSetAttr, bool bMakeFrame) const

Private Attributes
std::vector< SwTextBoxElement >	m_pTextBoxes
SwFrameFormat *	m_pOwnerShapeFormat
bool	m_bIsCloningInProgress
bool	m_bLock

Friends
class	SwTextBoxLockGuard

Detailed Description

Textboxes are basically textframe + shape pairs.

This means one shape has one frame. This is not enough for group shapes, because they have only one shape format and can have many frame formats. This class provides if there is a group shape for example, it can have multiple textboxes.

Definition at line 191 of file textboxhelper.hxx.

Constructor & Destructor Documentation

SwTextBoxNode() [1/3]

SwTextBoxNode::SwTextBoxNode ( )

delete

Referenced by Clone_Impl().

SwTextBoxNode() [2/3]

SwTextBoxNode::SwTextBoxNode

(

SwFrameFormat *

pOwnerShapeFormat

)

Definition at line 1679 of file textboxhelper.cxx.

References m_bIsCloningInProgress, m_bLock, m_pOwnerShapeFormat, m_pTextBoxes, RES_DRAWFRMFMT(), and SwFormat::Which().

~SwTextBoxNode()

SwTextBoxNode::~SwTextBoxNode

(

)

Definition at line 1692 of file textboxhelper.cxx.

References m_pTextBoxes, and SAL_WARN.

SwTextBoxNode() [3/3]

SwTextBoxNode::SwTextBoxNode ( const SwTextBoxNode &  )

default

Member Function Documentation

AddTextBox()

void SwTextBoxNode::AddTextBox	(	SdrObject *	pDrawObject,
		SwFrameFormat *	pNewTextBox
	)

Definition at line 1701 of file textboxhelper.cxx.

References SwTextBoxNode::SwTextBoxElement::m_pDrawObject, m_pTextBoxes, SwTextBoxNode::SwTextBoxElement::m_pTextBoxFormat, RES_FLYFRMFMT(), SAL_WARN, SwFlyDrawObj::SetTextBox(), and SwFormat::Which().

ClearAll()

void SwTextBoxNode::ClearAll

(

)

Definition at line 1820 of file textboxhelper.cxx.

References IDocumentLayoutAccess::DelLayoutFormat(), SwFormat::GetDoc(), SwDoc::getIDocumentLayoutAccess(), SwDoc::IsInDtor(), m_pOwnerShapeFormat, m_pTextBoxes, and SAL_WARN.

Clone()

void SwTextBoxNode::Clone	(	SwDoc *	pDoc,
		const SwFormatAnchor &	rNewAnc,
		SwFrameFormat *	o_pTarget,
		bool	bSetAttr,
		bool	bMakeFrame
	)		const

Definition at line 1878 of file textboxhelper.cxx.

References SwTextBoxHelper::changeAnchor(), Clone_Impl(), SwTextBoxHelper::doTextBoxPositioning(), SwTextBoxHelper::DoTextBoxZOrderCorrection(), SwFrameFormat::FindSdrObject(), m_bIsCloningInProgress, m_pOwnerShapeFormat, m_pTextBoxes, RES_DRAWFRMFMT(), SwTextBoxHelper::syncTextBoxSize(), and SwFormat::Which().

Clone_Impl()

void SwTextBoxNode::Clone_Impl ( SwDoc *  pDoc, const SwFormatAnchor &  rNewAnc, SwFrameFormat *  o_pTarget, const SdrObject *  pSrcObj, SdrObject *  pDestObj, bool  bSetAttr, bool  bMakeFrame  ) const

private

Definition at line 1906 of file textboxhelper.cxx.

References Clone_Impl(), IDocumentLayoutAccess::CopyLayoutFormat(), SwFormatAnchor::GetAnchorId(), SdrObject::getChildrenOfSdrObject(), SwDoc::getIDocumentLayoutAccess(), SwFrameFormat::GetOtherTextBoxFormats(), GetTextBox(), i, SAL_WARN, SwFormat::SetFormatAttr(), SwFrameFormat::SetOtherTextBoxFormats(), SwFormatAnchor::SetType(), and SwTextBoxNode().

Referenced by Clone(), and Clone_Impl().

DelTextBox() [1/2]

void SwTextBoxNode::DelTextBox	(	const SdrObject *	pDrawObject,
		bool	bDelFromDoc = false
	)

Definition at line 1729 of file textboxhelper.cxx.

References m_pTextBoxes, and SAL_WARN.

DelTextBox() [2/2]

void SwTextBoxNode::DelTextBox	(	const SwFrameFormat *	pTextBox,
		bool	bDelFromDoc = false
	)

Definition at line 1759 of file textboxhelper.cxx.

References m_pTextBoxes, and SAL_WARN.

GetAllTextBoxes()

std::map< SdrObject *, SwFrameFormat * > SwTextBoxNode::GetAllTextBoxes

(

)

const

Definition at line 1868 of file textboxhelper.cxx.

References m_pTextBoxes.

GetOwnerShape()

SwFrameFormat * SwTextBoxNode::GetOwnerShape ( )

inline

Definition at line 255 of file textboxhelper.hxx.

References m_pOwnerShapeFormat.

GetTextBox()

SwFrameFormat * SwTextBoxNode::GetTextBox

(

const SdrObject *

pDrawObject

)

const

Definition at line 1788 of file textboxhelper.cxx.

References SwFrameFormat::GetOtherTextBoxFormats(), m_bLock, m_pOwnerShapeFormat, m_pTextBoxes, and SAL_WARN.

Referenced by Clone_Impl().

GetTextBoxCount()

size_t SwTextBoxNode::GetTextBoxCount ( ) const

inline

Definition at line 258 of file textboxhelper.hxx.

References m_pTextBoxes.

IsGroupTextBox()

bool SwTextBoxNode::IsGroupTextBox

(

)

const

Definition at line 1866 of file textboxhelper.cxx.

References m_pTextBoxes.

Friends And Related Function Documentation

SwTextBoxLockGuard

friend class SwTextBoxLockGuard

friend

Definition at line 193 of file textboxhelper.hxx.

Member Data Documentation

m_bIsCloningInProgress

bool SwTextBoxNode::m_bIsCloningInProgress

mutableprivate

Definition at line 211 of file textboxhelper.hxx.

Referenced by Clone(), and SwTextBoxNode().

m_bLock

bool SwTextBoxNode::m_bLock

private

Definition at line 214 of file textboxhelper.hxx.

Referenced by GetTextBox(), SwTextBoxLockGuard::SwTextBoxLockGuard(), SwTextBoxNode(), and SwTextBoxLockGuard::~SwTextBoxLockGuard().

m_pOwnerShapeFormat

SwFrameFormat* SwTextBoxNode::m_pOwnerShapeFormat

private

Definition at line 208 of file textboxhelper.hxx.

Referenced by ClearAll(), Clone(), GetOwnerShape(), GetTextBox(), and SwTextBoxNode().

m_pTextBoxes

std::vector<SwTextBoxElement> SwTextBoxNode::m_pTextBoxes

private

Definition at line 205 of file textboxhelper.hxx.

Referenced by AddTextBox(), ClearAll(), Clone(), DelTextBox(), GetAllTextBoxes(), GetTextBox(), GetTextBoxCount(), IsGroupTextBox(), SwTextBoxNode(), and ~SwTextBoxNode().

---

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

• textboxhelper.hxx
• textboxhelper.cxx