A TextBox is a TextFrame, that is tied to a drawinglayer shape. More...

#include <textboxhelper.hxx>

Public Types
using	SavedLink = std::map< const SwFrameFormat , const SwFrameFormat >
	Maps a draw format to a fly format. More...

using	SavedContent = std::map< const SwFrameFormat *, SwFormatContent >
	Maps a draw format to content. More...

Static Public Member Functions
static void	create (SwFrameFormat *pShape, bool bCopyText=false)
	Create a TextBox for a shape. More...

static void	destroy (SwFrameFormat *pShape)
	Destroy a TextBox for a shape. More...

static css::uno::Any	queryInterface (const SwFrameFormat *pShape, const css::uno::Type &rType)
	Get interface of a shape's TextBox, if there is any. More...

static void	syncProperty (SwFrameFormat *pShape, sal_uInt16 nWID, sal_uInt8 nMemberID, const css::uno::Any &rValue)
	Sync property of TextBox with the one of the shape. More...

static void	syncProperty (SwFrameFormat *pShape, const OUString &rPropertyName, const css::uno::Any &rValue)
	Does the same, but works on properties which lack an sw-specific WID / MemberID. More...

static void	getProperty (SwFrameFormat const *pShape, sal_uInt16 nWID, sal_uInt8 nMemberID, css::uno::Any &rValue)
	Get a property of the underlying TextFrame. More...

static void	syncFlyFrameAttr (SwFrameFormat &rShape, SfxItemSet const &rSet)
	Similar to syncProperty(), but used by the internal API (e.g. for UI purposes). More...

static void	updateTextBoxMargin (SdrObject *pObj)
	Copy shape attributes to the text frame. More...

static SwFrameFormat *	getOtherTextBoxFormat (const SwFrameFormat *pFormat, sal_uInt16 nType)
	If we have an associated TextFrame, then return that. More...

static SwFrameFormat *	getOtherTextBoxFormat (css::uno::Reference< css::drawing::XShape > const &xShape)
	If we have an associated TextFrame, then return that. More...

static tools::Rectangle	getTextRectangle (SwFrameFormat *pShape, bool bAbsolute=true)
	Return the textbox rectangle of a draw shape (in twips). More...

static bool	isTextBox (const SwFrameFormat *pFormat, sal_uInt16 nType)
	Is the frame format a text box? More...

static bool	hasTextFrame (const SdrObject *pObj)
	Returns true if the SdrObject has a SwTextFrame otherwise false. More...

static sal_Int32	getCount (const SwDoc &rDoc)
	Count number of shapes in the document, excluding TextBoxes. More...

static sal_Int32	getCount (SdrPage const *pPage)
	Count number of shapes on the page, excluding TextBoxes. More...

static css::uno::Any	getByIndex (SdrPage const *pPage, sal_Int32 nIndex)
	Get a shape by index, excluding TextBoxes. More...

static sal_Int32	getOrdNum (const SdrObject *pObject)
	Get the order of the shape, excluding TextBoxes. More...

static void	getShapeWrapThrough (const SwFrameFormat *pTextBox, bool &rWrapThrough)
	If pTextBox is a textbox, then set rWrapThrough to the surround of its shape. More...

static void	saveLinks (const SwFrameFormats &rFormats, std::map< const SwFrameFormat , const SwFrameFormat > &rLinks)
	Saves the current shape -> textbox links in a map, so they can be restored later. More...

static void	restoreLinks (std::set< ZSortFly > &rOld, std::vector< SwFrameFormat * > &rNew, SavedLink &rSavedLinks)
	Undo the effect of saveLinks() + individual resetLink() calls. More...

Detailed Description

A TextBox is a TextFrame, that is tied to a drawinglayer shape.

This class provides helper methods to create, query and maintain such TextBoxes.

Definition at line 45 of file textboxhelper.hxx.

Member Typedef Documentation

using SwTextBoxHelper::SavedContent = std::map<const SwFrameFormat*, SwFormatContent>

Maps a draw format to content.

Definition at line 51 of file textboxhelper.hxx.

using SwTextBoxHelper::SavedLink = std::map<const SwFrameFormat*, const SwFrameFormat*>

Maps a draw format to a fly format.

Definition at line 49 of file textboxhelper.hxx.

Member Function Documentation

void SwTextBoxHelper::create	(	SwFrameFormat *	pShape,
		bool	bCopyText = `false`
	)

static

Create a TextBox for a shape.

If the second parameter is true, the original text in the shape will be copied to the frame

Definition at line 55 of file textboxhelper.cxx.

References aFrameFormatSetRange, assert(), eMode, SwFrameFormat::FindRealSdrObject(), SwFormat::GetAnchor(), SwFormatAnchor::GetAnchorId(), SwDoc::GetAttrPool(), SwFormat::GetAttrSet(), SfxObjectShell::GetBaseModel(), SwFormatAnchor::GetContentAnchor(), SwFormat::GetDoc(), SwDoc::GetDocShell(), SwFormatHoriOrient::GetHoriOrient(), SwFormat::GetHoriOrient(), SwDoc::getIDocumentState(), SwFrameFormat::GetOtherTextBoxFormat(), SwFormatAnchor::GetPageNum(), SwFormatVertOrient::GetRelationOrient(), SwFormatHoriOrient::GetRelationOrient(), SwDoc::GetUniqueFrameName(), SdrObject::getUnoShape(), SwFormatVertOrient::GetVertOrient(), SwFormat::GetVertOrient(), SfxItemSet::HasItem(), com::sun::star::uno::makeAny(), SwXServiceProvider::MakeInstance(), MID_ANCHOR_ANCHORTYPE, MID_FOLLOW_TEXT_FLOW, MID_FRMSIZE_IS_AUTO_HEIGHT, MID_FRMSIZE_SIZE, MID_HORIORIENT_ORIENT, MID_HORIORIENT_POSITION, MID_HORIORIENT_RELATION, MID_VERTORIENT_ORIENT, MID_VERTORIENT_POSITION, MID_VERTORIENT_RELATION, RES_ANCHOR(), RES_CNTNT(), RES_FOLLOW_TEXT_FLOW(), RES_FRAMEDIR(), RES_FRM_SIZE(), RES_HORI_ORIENT(), RES_TEXT_VERT_ADJUST(), RES_VERT_ORIENT(), SwFormat::SetFormatAttr(), SwFormatHoriOrient::SetHoriOrient(), IDocumentState::SetModified(), SwFrameFormat::SetOtherTextBoxFormat(), TypeTextFrame, UNO_NAME_ANCHOR_TYPE, UNO_NAME_BOTTOM_BORDER, UNO_NAME_FILL_TRANSPARENCE, UNO_NAME_HORI_ORIENT, UNO_NAME_HORI_ORIENT_POSITION, UNO_NAME_HORI_ORIENT_RELATION, UNO_NAME_IS_FOLLOWING_TEXT_FLOW, UNO_NAME_LEFT_BORDER, UNO_NAME_RIGHT_BORDER, UNO_NAME_SIZE_TYPE, UNO_NAME_SURROUND, UNO_NAME_TEXT_AUTOGROWHEIGHT, UNO_NAME_TEXT_VERT_ADJUST, UNO_NAME_TEXT_WRITINGMODE, UNO_NAME_TOP_BORDER, UNO_NAME_VERT_ORIENT, UNO_NAME_VERT_ORIENT_POSITION, UNO_NAME_VERT_ORIENT_RELATION, and sw::XTextRangeToSwPaM().

Referenced by SwDrawShell::Execute(), and SwXShape::setPropertyValue().

void SwTextBoxHelper::destroy ( SwFrameFormat * pShape )

static

Destroy a TextBox for a shape.

Definition at line 217 of file textboxhelper.cxx.

References IDocumentLayoutAccess::DelLayoutFormat(), SwFormat::GetAttrSet(), SwFormat::GetDoc(), SwDoc::getIDocumentLayoutAccess(), SwFrameFormat::GetOtherTextBoxFormat(), SfxItemSet::HasItem(), RES_CNTNT(), and SwFormat::ResetFormatAttr().

Referenced by SwDrawShell::Execute(), and SwXShape::setPropertyValue().

uno::Any SwTextBoxHelper::getByIndex	(	SdrPage const *	pPage,
		sal_Int32	nIndex
	)

static

Get a shape by index, excluding TextBoxes.

Exceptions

css::lang::IndexOutOfBoundsException

Definition at line 289 of file textboxhelper.cxx.

References SdrObjList::GetObj(), SdrObjList::GetObjCount(), SdrObject::getUnoShape(), i, SdrObject::IsTextBox(), com::sun::star::uno::makeAny(), nCount, and p.

Referenced by SwXDrawPage::getByIndex().

sal_Int32 SwTextBoxHelper::getCount ( const SwDoc & rDoc )

static

Count number of shapes in the document, excluding TextBoxes.

Definition at line 277 of file textboxhelper.cxx.

References SwDoc::GetSpzFrameFormats(), and RES_FLYFRMFMT().

Referenced by SwXDrawPage::getCount().

sal_Int32 SwTextBoxHelper::getCount ( SdrPage const * pPage )

static

Count number of shapes on the page, excluding TextBoxes.

Definition at line 264 of file textboxhelper.cxx.

References SdrObjList::GetObj(), SdrObjList::GetObjCount(), i, SdrObject::IsTextBox(), and p.

sal_Int32 SwTextBoxHelper::getOrdNum ( const SdrObject * pObject )

static

Get the order of the shape, excluding TextBoxes.

Definition at line 315 of file textboxhelper.cxx.

References SdrObject::GetOrdNum(), SdrObject::getSdrPageFromSdrObject(), i, SdrObject::IsTextBox(), p, and SAL_WARN.

Referenced by SwXShape::getPropertyValue().

SwFrameFormat * SwTextBoxHelper::getOtherTextBoxFormat	(	const SwFrameFormat *	pFormat,
		sal_uInt16	nType
	)

static

If we have an associated TextFrame, then return that.

Parameters

nType Expected frame format type. Valid types are RES_DRAWFRMFMT and RES_FLYFRMFMT.

See also: isTextBox

Definition at line 342 of file textboxhelper.cxx.

References SwFrameFormat::GetOtherTextBoxFormat().

Referenced by objectpositioning::SwToContentAnchoredObjectPosition::CalcOverlap(), sw::DocumentLayoutManager::CopyLayoutFormat(), SwDrawView::DeleteMarked(), SwDrawBaseShell::Execute(), SwFEShell::FindAnchorPos(), SwFlyFrame::Format(), SwFrame::GetBackgroundBrush(), getShapeWrapThrough(), hasTextFrame(), lcl_goIntoTextBox(), lcl_queryInterface(), SwEditWin::MouseButtonUp(), SwFEShell::SelectObj(), SwTextFlyCnt::SetAnchor(), SwFlyCntPortion::SetBase(), RtfSdrExport::StartShape(), DocxAttributeOutput::WriteTextBox(), and DocxAttributeOutput::WriteVMLTextBox().

static SwFrameFormat* SwTextBoxHelper::getOtherTextBoxFormat ( css::uno::Reference< css::drawing::XShape > const & xShape )

static

If we have an associated TextFrame, then return that.

void SwTextBoxHelper::getProperty	(	SwFrameFormat const *	pShape,
		sal_uInt16	nWID,
		sal_uInt8	nMemberID,
		css::uno::Any &	rValue
	)

static

Get a property of the underlying TextFrame.

Definition at line 545 of file textboxhelper.cxx.

References CONVERT_TWIPS, SwFormat::GetChain(), SwFormat::GetName(), MID_CHAIN_NAME, MID_CHAIN_NEXTNAME, MID_CHAIN_PREVNAME, SwFormatChain::QueryValue(), RES_CHAIN(), and RES_DRAWFRMFMT().

Referenced by SwXShape::getPropertyValue().

void SwTextBoxHelper::getShapeWrapThrough	(	const SwFrameFormat *	pTextBox,
		bool &	rWrapThrough
	)

static

If pTextBox is a textbox, then set rWrapThrough to the surround of its shape.

Definition at line 335 of file textboxhelper.cxx.

References getOtherTextBoxFormat(), SwFormatSurround::GetSurround(), SwFormat::GetSurround(), and RES_FLYFRMFMT().

Referenced by objectpositioning::SwAnchoredObjectPosition::GetHoriAlignmentValues(), and objectpositioning::SwAnchoredObjectPosition::GetTopForObjPos().

tools::Rectangle SwTextBoxHelper::getTextRectangle	(	SwFrameFormat *	pShape,
		bool	bAbsolute = `true`
	)

static

Return the textbox rectangle of a draw shape (in twips).

Definition at line 390 of file textboxhelper.cxx.

References SwFrameFormat::FindRealSdrObject(), SdrObjCustomShape::GetTextBounds(), tools::Rectangle::Left(), tools::Rectangle::Move(), Point, tools::Rectangle::SetEmpty(), and tools::Rectangle::Top().

Referenced by SwFlyCntPortion::SetBase().

bool SwTextBoxHelper::hasTextFrame ( const SdrObject * pObj )

static

Returns true if the SdrObject has a SwTextFrame otherwise false.

Definition at line 253 of file textboxhelper.cxx.

References getOtherTextBoxFormat(), and SdrObject::getWeakUnoShape().

Referenced by SwDrawShell::ExecDrawDlg().

bool SwTextBoxHelper::isTextBox	(	const SwFrameFormat *	pFormat,
		sal_uInt16	nType
	)

static

Is the frame format a text box?

A text box consists of a coupled fly and draw format. Most times you just want to check for a single type, otherwise you get duplicate results.

Parameters

nType Expected frame format input type. Valid types are RES_DRAWFRMFMT and RES_FLYFRMFMT.

Definition at line 233 of file textboxhelper.cxx.

References assert(), SwFormat::GetAttrSet(), SwFormat::GetContent(), SwFrameFormat::GetOtherTextBoxFormat(), SfxItemSet::HasItem(), RES_CNTNT(), RES_DRAWFRMFMT(), RES_FLYFRMFMT(), and SwFormat::Which().

Referenced by objectpositioning::SwToContentAnchoredObjectPosition::CalcOverlap(), sw::DocumentContentOperationsManager::CopyFlyInFlyImpl(), SwObjectFormatterTextFrame::DoFormatObjs(), SwXMLExport::ExportTable(), SwFEShell::FindAnchorPos(), SwDoc::GetFlyCount(), SwDoc::GetFlyFrameFormats(), SwDoc::GetFlyNum(), objectpositioning::SwAnchoredObjectPosition::GetInfoAboutObj(), SwAnchoredDrawObject::GetObjBoundRect(), SwXShape::getPropertyStates(), SwXShape::getPropertyValue(), SwDrawShell::GetState(), RtfSdrExport::isTextBox(), DocxSdrExport::isTextBox(), SwVirtFlyDrawObj::IsTextBox(), lcl_ExportHints(), lcl_isTextBox(), lcl_textBoxSizeNotify(), SwFEShell::Paste(), and SwXFrame::setPropertyValue().

uno::Any SwTextBoxHelper::queryInterface	(	const SwFrameFormat *	pShape,
		const css::uno::Type &	rType
	)

static

Get interface of a shape's TextBox, if there is any.

Definition at line 370 of file textboxhelper.cxx.

Referenced by SwXShape::queryInterface().

void SwTextBoxHelper::restoreLinks	(	std::set< ZSortFly > &	rOld,
		std::vector< SwFrameFormat * > &	rNew,
		SavedLink &	rSavedLinks
	)

static

Undo the effect of saveLinks() + individual resetLink() calls.

Definition at line 798 of file textboxhelper.cxx.

References i.

Referenced by sw::DocumentContentOperationsManager::CopyFlyInFlyImpl().

void SwTextBoxHelper::saveLinks	(	const SwFrameFormats &	rFormats,
		std::map< const SwFrameFormat , const SwFrameFormat > &	rLinks
	)

static

Saves the current shape -> textbox links in a map, so they can be restored later.

Definition at line 788 of file textboxhelper.cxx.

References RES_DRAWFRMFMT().

Referenced by sw::DocumentContentOperationsManager::CopyFlyInFlyImpl().

void SwTextBoxHelper::syncFlyFrameAttr	(	SwFrameFormat &	rShape,
		SfxItemSet const &	rSet
	)

static

Similar to syncProperty(), but used by the internal API (e.g. for UI purposes).

Definition at line 819 of file textboxhelper.cxx.

References aFrameFormatSetRange, SwFormat::GetAnchor(), SwFormatAnchor::GetAnchorId(), SwDoc::GetAttrPool(), SwFormatAnchor::GetContentAnchor(), SwFormat::GetDoc(), SwFormat::GetFrameSize(), tools::Rectangle::getHeight(), SwFormat::GetHoriOrient(), SwFormatAnchor::GetPageNum(), SwFormatVertOrient::GetPos(), SwFormatHoriOrient::GetPos(), SwFormatVertOrient::GetRelationOrient(), SwFormatHoriOrient::GetRelationOrient(), SwFormat::GetVertOrient(), tools::Rectangle::getX(), tools::Rectangle::getY(), tools::Rectangle::IsEmpty(), RES_DRAWFRMFMT(), RES_FRM_SIZE(), RES_HORI_ORIENT(), RES_VERT_ORIENT(), SAL_WARN, SwFormatAnchor::SetAnchor(), SwDoc::SetFlyFrameAttr(), SvxSizeItem::SetHeight(), SwFormatAnchor::SetPageNum(), SwFormatVertOrient::SetPos(), SwFormatHoriOrient::SetPos(), SwFormatVertOrient::SetRelationOrient(), SwFormatHoriOrient::SetRelationOrient(), SwFormatAnchor::SetType(), and SfxPoolItem::Which().

Referenced by SwObjectFormatterTextFrame::DoFormatObjs(), SwFEShell::FindAnchorPos(), lcl_textBoxSizeNotify(), and SwDoc::SetFlyFrameAttr().

void SwTextBoxHelper::syncProperty	(	SwFrameFormat *	pShape,
		sal_uInt16	nWID,
		sal_uInt8	nMemberID,
		const css::uno::Any &	rValue
	)

static

Sync property of TextBox with the one of the shape.

Definition at line 575 of file textboxhelper.cxx.

References BOTTOM_BORDER_DISTANCE, CONVERT_TWIPS, SwXTextFrame::CreateXTextFrame(), FN_TEXT_RANGE, SwFormat::GetAnchor(), SwFormat::GetDoc(), tools::Rectangle::getHeight(), SwFormatAnchor::GetPageNum(), tools::Rectangle::getWidth(), tools::Rectangle::getX(), tools::Rectangle::getY(), tools::Rectangle::IsEmpty(), LEFT_BORDER_DISTANCE, com::sun::star::uno::makeAny(), MID_ALLOW_OVERLAP, MID_ANCHOR_ANCHORTYPE, MID_CHAIN_NEXTNAME, MID_CHAIN_PREVNAME, MID_FRMSIZE_IS_AUTO_HEIGHT, MID_FRMSIZE_REL_HEIGHT_RELATION, MID_FRMSIZE_REL_WIDTH_RELATION, MID_HORIORIENT_ORIENT, MID_HORIORIENT_POSITION, MID_HORIORIENT_RELATION, MID_L_MARGIN, MID_R_MARGIN, MID_VERTORIENT_ORIENT, MID_VERTORIENT_POSITION, MID_VERTORIENT_RELATION, nValue, RES_ANCHOR(), RES_BOX(), RES_CHAIN(), RES_DRAWFRMFMT(), RES_FRAMEDIR(), RES_FRM_SIZE(), RES_HORI_ORIENT(), RES_LR_SPACE(), RES_OPAQUE(), RES_TEXT_VERT_ADJUST(), RES_VERT_ORIENT(), RES_WRAP_INFLUENCE_ON_OBJPOS(), RIGHT_BORDER_DISTANCE, SwFormatAnchor::SetAnchor(), SwFormat::SetFormatAttr(), TOP_BORDER_DISTANCE, TWIPS_TO_MM, UNO_NAME_ALLOW_OVERLAP, UNO_NAME_ANCHOR_PAGE_NO, UNO_NAME_ANCHOR_TYPE, UNO_NAME_BOTTOM_BORDER_DISTANCE, UNO_NAME_CHAIN_NEXT_NAME, UNO_NAME_CHAIN_PREV_NAME, UNO_NAME_FRAME_ISAUTOMATIC_HEIGHT, UNO_NAME_HORI_ORIENT, UNO_NAME_HORI_ORIENT_POSITION, UNO_NAME_HORI_ORIENT_RELATION, UNO_NAME_LEFT_BORDER_DISTANCE, UNO_NAME_LEFT_MARGIN, UNO_NAME_OPAQUE, UNO_NAME_RELATIVE_HEIGHT_RELATION, UNO_NAME_RELATIVE_WIDTH_RELATION, UNO_NAME_RIGHT_BORDER_DISTANCE, UNO_NAME_RIGHT_MARGIN, UNO_NAME_SIZE, UNO_NAME_SURROUND, UNO_NAME_TEXT_VERT_ADJUST, UNO_NAME_TOP_BORDER_DISTANCE, UNO_NAME_VERT_ORIENT, UNO_NAME_VERT_ORIENT_POSITION, UNO_NAME_VERT_ORIENT_RELATION, UNO_NAME_WRITING_MODE, and sw::XTextRangeToSwPaM().

Referenced by SwAnchoredDrawObject::GetObjBoundRect(), SwXShape::setPropertyValue(), and SwXShape::setSize().

void SwTextBoxHelper::syncProperty	(	SwFrameFormat *	pShape,
		const OUString &	rPropertyName,
		const css::uno::Any &	rValue
	)

static

Does the same, but works on properties which lack an sw-specific WID / MemberID.

Definition at line 430 of file textboxhelper.cxx.

References BOTTOM_BORDER_DISTANCE, convertTwipToMm100(), SwXTextFrame::CreateXTextFrame(), eMode, comphelper::SequenceAsHashMap::end(), comphelper::SequenceAsHashMap::find(), SwFrameFormat::FindRealSdrObject(), SwFormat::GetDoc(), SdrObject::GetSnapRect(), LEFT_BORDER_DISTANCE, com::sun::star::uno::makeAny(), MID_FRMSIZE_IS_AUTO_HEIGHT, MID_FRMSIZE_SIZE, MID_HORIORIENT_POSITION, MID_VERTORIENT_POSITION, pObject, RES_BOX(), RES_DRAWFRMFMT(), RES_FRAMEDIR(), RES_FRM_SIZE(), RES_HORI_ORIENT(), RES_TEXT_VERT_ADJUST(), RES_VERT_ORIENT(), RIGHT_BORDER_DISTANCE, TOP_BORDER_DISTANCE, UNO_NAME_PARA_ADJUST, UNO_NAME_TEXT_AUTOGROWHEIGHT, UNO_NAME_TEXT_HORZADJUST, UNO_NAME_TEXT_LEFTDIST, UNO_NAME_TEXT_LOWERDIST, UNO_NAME_TEXT_RIGHTDIST, UNO_NAME_TEXT_UPPERDIST, UNO_NAME_TEXT_VERT_ADJUST, and UNO_NAME_TEXT_WRITINGMODE.

void SwTextBoxHelper::updateTextBoxMargin ( SdrObject * pObj )

static

Copy shape attributes to the text frame.

Definition at line 923 of file textboxhelper.cxx.

References SdrObject::getUnoShape(), RES_FLYFRMFMT(), UNO_NAME_TEXT_HORZADJUST, UNO_NAME_TEXT_LEFTDIST, UNO_NAME_TEXT_LOWERDIST, UNO_NAME_TEXT_RIGHTDIST, UNO_NAME_TEXT_UPPERDIST, and UNO_NAME_TEXT_VERTADJUST.

Referenced by SwDrawShell::ExecDrawDlg().

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

Public Types

Static Public Member Functions

Detailed Description

Member Typedef Documentation

Member Function Documentation