SvxLRSpaceItem Class Reference

#include <lrspitem.hxx>

Inheritance diagram for SvxLRSpaceItem:

Collaboration diagram for SvxLRSpaceItem:

Public Member Functions
	SvxLRSpaceItem (const sal_uInt16 nId)
	SvxLRSpaceItem (const tools::Long nLeft, const tools::Long nRight, const short nOfset, const sal_uInt16 nId)
	SvxLRSpaceItem (SvxLRSpaceItem const &)=default
virtual bool	operator== (const SfxPoolItem &) const override
virtual bool	QueryValue (css::uno::Any &rVal, sal_uInt8 nMemberId=0) const override
virtual bool	PutValue (const css::uno::Any &rVal, sal_uInt8 nMemberId) override
virtual bool	GetPresentation (SfxItemPresentation ePres, MapUnit eCoreMetric, MapUnit ePresMetric, OUString &rText, const IntlWrapper &) const override
virtual SvxLRSpaceItem *	Clone (SfxItemPool *pPool=nullptr) const override
virtual void	ScaleMetrics (tools::Long nMult, tools::Long nDiv) override
virtual bool	HasMetrics () const override
void	SetLeft (const tools::Long nL, const sal_uInt16 nProp=100)
void	SetRight (const tools::Long nR, const sal_uInt16 nProp=100)
tools::Long	GetLeft () const
tools::Long	GetRight () const
void	SetLeftValue (const tools::Long nL)
void	SetRightValue (const tools::Long nR)
bool	IsAutoFirst () const
void	SetAutoFirst (const bool bNew)
bool	IsExplicitZeroMarginValRight () const
bool	IsExplicitZeroMarginValLeft () const
void	SetExplicitZeroMarginValRight (const bool eR)
void	SetExplicitZeroMarginValLeft (const bool eL)
sal_uInt16	GetPropLeft () const
sal_uInt16	GetPropRight () const
void	SetTextLeft (const tools::Long nL, const sal_uInt16 nProp=100)
tools::Long	GetTextLeft () const
void	SetTextFirstLineOffset (const short nF, const sal_uInt16 nProp=100)
short	GetTextFirstLineOffset () const
void	SetPropTextFirstLineOffset (const sal_uInt16 nProp)
sal_uInt16	GetPropTextFirstLineOffset () const
void	SetTextFirstLineOffsetValue (const short nValue)
void	SetGutterMargin (const tools::Long nGutterMargin)
tools::Long	GetGutterMargin () const
void	SetRightGutterMargin (const tools::Long nRightGutterMargin)
tools::Long	GetRightGutterMargin () const
void	dumpAsXml (xmlTextWriterPtr pWriter) const override
virtual boost::property_tree::ptree	dumpAsJSON () const override
Public Member Functions inherited from SfxPoolItem
void	AddRef (sal_uInt32 n=1) const
virtual	~SfxPoolItem ()
void	SetWhich (sal_uInt16 nId)
sal_uInt16	Which () const
T &	StaticWhichCast (TypedWhichId< T > nId)
const T &	StaticWhichCast (TypedWhichId< T > nId) const
T *	DynamicWhichCast (TypedWhichId< T > nId)
const T *	DynamicWhichCast (TypedWhichId< T > nId) const
virtual bool	operator== (const SfxPoolItem &) const=0
bool	operator!= (const SfxPoolItem &rItem) const
virtual bool	operator< (const SfxPoolItem &) const
virtual bool	IsSortable () const
virtual bool	HasLookup () const
virtual lookup_iterator	Lookup (lookup_iterator, lookup_iterator end) const
virtual bool	GetPresentation (SfxItemPresentation ePresentation, MapUnit eCoreMetric, MapUnit ePresentationMetric, OUString &rText, const IntlWrapper &rIntlWrapper) const
virtual void	ScaleMetrics (tools::Long lMult, tools::Long lDiv)
virtual bool	HasMetrics () const
virtual bool	QueryValue (css::uno::Any &rVal, sal_uInt8 nMemberId=0) const
virtual bool	PutValue (const css::uno::Any &rVal, sal_uInt8 nMemberId)
virtual SfxPoolItem *	Clone (SfxItemPool *pPool=nullptr) const=0
std::unique_ptr< SfxPoolItem >	CloneSetWhich (sal_uInt16 nNewWhich) const
std::unique_ptr< T >	CloneSetWhich (TypedWhichId< T > nId) const
sal_uInt32	GetRefCount () const
SfxItemKind	GetKind () const
virtual void	dumpAsXml (xmlTextWriterPtr pWriter) const
virtual boost::property_tree::ptree	dumpAsJSON () const
virtual bool	IsVoidItem () const

Static Public Member Functions
static SfxPoolItem *	CreateDefault ()

Private Attributes
short	nFirstLineOffset
	First-line indent always relative to GetTextLeft() More...
tools::Long	nLeftMargin
tools::Long	nRightMargin
tools::Long	m_nGutterMargin
	The amount of extra space added to the left margin. More...
tools::Long	m_nRightGutterMargin
	The amount of extra space added to the right margin, on mirrored pages. More...
sal_uInt16	nPropFirstLineOffset
sal_uInt16	nPropLeftMargin
sal_uInt16	nPropRightMargin
bool	bAutoFirst
bool	bExplicitZeroMarginValRight
bool	bExplicitZeroMarginValLeft

Additional Inherited Members
Public Types inherited from SfxPoolItem
typedef std::vector< SfxPoolItem * >::const_iterator	lookup_iterator
Protected Member Functions inherited from SfxPoolItem
	SfxPoolItem (sal_uInt16 nWhich=0)
	SfxPoolItem (const SfxPoolItem &rCopy)

Detailed Description

Definition at line 281 of file lrspitem.hxx.

Constructor & Destructor Documentation

SvxLRSpaceItem() [1/3]

SvxLRSpaceItem::SvxLRSpaceItem ( const sal_uInt16  nId )

explicit

Definition at line 290 of file frmitems.cxx.

References nFirstLineOffset, nId, nLeftMargin, and nRightMargin.

Referenced by Clone(), and CreateDefault().

SvxLRSpaceItem() [2/3]

SvxLRSpaceItem::SvxLRSpaceItem	(	const tools::Long	nLeft,
		const tools::Long	nRight,
		const short	nOfset,
		const sal_uInt16	nId
	)

Definition at line 307 of file frmitems.cxx.

References nFirstLineOffset, nId, nLeftMargin, and nRightMargin.

SvxLRSpaceItem() [3/3]

SvxLRSpaceItem::SvxLRSpaceItem ( SvxLRSpaceItem const &  )

default

Member Function Documentation

Clone()

SvxLRSpaceItem * SvxLRSpaceItem::Clone ( SfxItemPool *  pPool = nullptr ) const

overridevirtual

Implements SfxPoolItem.

Definition at line 1512 of file frmitems.cxx.

References SvxLRSpaceItem().

CreateDefault()

SfxPoolItem * SvxLRSpaceItem::CreateDefault ( )

static

Definition at line 91 of file frmitems.cxx.

References SvxLRSpaceItem().

dumpAsJSON()

boost::property_tree::ptree SvxLRSpaceItem::dumpAsJSON ( ) const

overridevirtual

Reimplemented from SfxPoolItem.

Definition at line 1636 of file frmitems.cxx.

References SfxPoolItem::dumpAsJSON(), GetLeft(), GetMetricText(), GetRight(), and GetTextFirstLineOffset().

dumpAsXml()

void SvxLRSpaceItem::dumpAsXml ( xmlTextWriterPtr  pWriter ) const

overridevirtual

Reimplemented from SfxPoolItem.

Definition at line 1615 of file frmitems.cxx.

References bAutoFirst, bExplicitZeroMarginValLeft, bExplicitZeroMarginValRight, m_nGutterMargin, m_nRightGutterMargin, nFirstLineOffset, nLeftMargin, nPropFirstLineOffset, nPropLeftMargin, nPropRightMargin, nRightMargin, and SfxPoolItem::Which().

GetGutterMargin()

tools::Long SvxLRSpaceItem::GetGutterMargin ( ) const

inline

Definition at line 354 of file lrspitem.hxx.

Referenced by operator==().

GetLeft()

tools::Long SvxLRSpaceItem::GetLeft ( ) const

inline

Definition at line 327 of file lrspitem.hxx.

References nLeftMargin.

Referenced by dumpAsJSON(), and operator==().

GetPresentation()

bool SvxLRSpaceItem::GetPresentation ( SfxItemPresentation  ePres, MapUnit  eCoreMetric, MapUnit  ePresMetric, OUString &  rText, const IntlWrapper &  rIntl  ) const

overridevirtual

Reimplemented from SfxPoolItem.

Definition at line 1517 of file frmitems.cxx.

References cpDelim, EditResId(), unicode::formatPercent(), GetMetricId(), GetMetricText(), Application::GetSettings(), nFirstLineOffset, nLeftMargin, nPropFirstLineOffset, nPropLeftMargin, nPropRightMargin, and nRightMargin.

GetPropLeft()

sal_uInt16 SvxLRSpaceItem::GetPropLeft ( ) const

inline

Definition at line 338 of file lrspitem.hxx.

Referenced by operator==().

GetPropRight()

sal_uInt16 SvxLRSpaceItem::GetPropRight ( ) const

inline

Definition at line 339 of file lrspitem.hxx.

Referenced by operator==().

GetPropTextFirstLineOffset()

sal_uInt16 SvxLRSpaceItem::GetPropTextFirstLineOffset ( ) const

inline

Definition at line 349 of file lrspitem.hxx.

Referenced by operator==().

GetRight()

tools::Long SvxLRSpaceItem::GetRight ( ) const

inline

Definition at line 328 of file lrspitem.hxx.

References nRightMargin.

Referenced by ImpEditEngine::CalcParaWidth(), ConvertItem(), ImpEditEngine::CreateAndInsertEmptyLine(), ImpEditEngine::CreateLines(), dumpAsJSON(), and operator==().

GetRightGutterMargin()

tools::Long SvxLRSpaceItem::GetRightGutterMargin ( ) const

inline

Definition at line 356 of file lrspitem.hxx.

Referenced by operator==().

GetTextFirstLineOffset()

short SvxLRSpaceItem::GetTextFirstLineOffset ( ) const

inline

Definition at line 346 of file lrspitem.hxx.

References nFirstLineOffset.

Referenced by ImpEditEngine::CalcParaWidth(), ConvertItem(), ImpEditEngine::CreateAndInsertEmptyLine(), ImpEditEngine::CreateLines(), dumpAsJSON(), EditEngine::GetDocPosTopLeft(), Outliner::ImpCalcBulletArea(), and operator==().

GetTextLeft()

tools::Long SvxLRSpaceItem::GetTextLeft

(

)

const

Definition at line 567 of file frmitems.cxx.

References nFirstLineOffset, and nLeftMargin.

Referenced by ImpEditEngine::CalcParaWidth(), ConvertItem(), ImpEditEngine::CreateAndInsertEmptyLine(), ImpEditEngine::CreateLines(), EditEngine::GetDocPosTopLeft(), Outliner::ImpCalcBulletArea(), and QueryValue().

HasMetrics()

bool SvxLRSpaceItem::HasMetrics ( ) const

overridevirtual

Reimplemented from SfxPoolItem.

Definition at line 1609 of file frmitems.cxx.

IsAutoFirst()

bool SvxLRSpaceItem::IsAutoFirst ( ) const

inline

Definition at line 331 of file lrspitem.hxx.

Referenced by operator==(), and QueryValue().

IsExplicitZeroMarginValLeft()

bool SvxLRSpaceItem::IsExplicitZeroMarginValLeft ( ) const

inline

Definition at line 335 of file lrspitem.hxx.

Referenced by operator==().

IsExplicitZeroMarginValRight()

bool SvxLRSpaceItem::IsExplicitZeroMarginValRight ( ) const

inline

Definition at line 334 of file lrspitem.hxx.

Referenced by operator==().

operator==()

bool SvxLRSpaceItem::operator== ( const SfxPoolItem &  rAttr ) const

overridevirtual

Implements SfxPoolItem.

Definition at line 1492 of file frmitems.cxx.

References bAutoFirst, bExplicitZeroMarginValLeft, bExplicitZeroMarginValRight, GetGutterMargin(), GetLeft(), GetPropLeft(), GetPropRight(), GetPropTextFirstLineOffset(), GetRight(), GetRightGutterMargin(), GetTextFirstLineOffset(), IsAutoFirst(), IsExplicitZeroMarginValLeft(), IsExplicitZeroMarginValRight(), m_nGutterMargin, m_nRightGutterMargin, nFirstLineOffset, nLeftMargin, nPropFirstLineOffset, nPropLeftMargin, nPropRightMargin, and nRightMargin.

PutValue()

bool SvxLRSpaceItem::PutValue ( const css::uno::Any &  rVal, sal_uInt8  nMemberId  )

overridevirtual

Reimplemented from SfxPoolItem.

Definition at line 391 of file frmitems.cxx.

References Any2Bool(), CONVERT_TWIPS, MID_FIRST_AUTO, MID_FIRST_LINE_INDENT, MID_FIRST_LINE_REL_INDENT, MID_GUTTER_MARGIN, MID_L_MARGIN, MID_L_REL_MARGIN, MID_R_MARGIN, MID_R_REL_MARGIN, MID_TXT_LMARGIN, o3tl::mm100, nPropLeftMargin, nPropRightMargin, SAL_MAX_UINT16, SetAutoFirst(), SetGutterMargin(), SetLeft(), SetPropTextFirstLineOffset(), SetRight(), SetTextFirstLineOffset(), SetTextLeft(), and o3tl::toTwips().

QueryValue()

bool SvxLRSpaceItem::QueryValue ( css::uno::Any &  rVal, sal_uInt8  nMemberId = 0  ) const

overridevirtual

Reimplemented from SfxPoolItem.

Definition at line 326 of file frmitems.cxx.

References CONVERT_TWIPS, convertTwipToMm100(), GetTextLeft(), IsAutoFirst(), m_nGutterMargin, MID_FIRST_AUTO, MID_FIRST_LINE_INDENT, MID_FIRST_LINE_REL_INDENT, MID_GUTTER_MARGIN, MID_L_MARGIN, MID_L_REL_MARGIN, MID_R_MARGIN, MID_R_REL_MARGIN, MID_TXT_LMARGIN, nFirstLineOffset, nLeftMargin, nPropFirstLineOffset, nPropLeftMargin, nPropRightMargin, and nRightMargin.

ScaleMetrics()

void SvxLRSpaceItem::ScaleMetrics ( tools::Long  nMult, tools::Long  nDiv  )

overridevirtual

Reimplemented from SfxPoolItem.

Definition at line 1601 of file frmitems.cxx.

References nFirstLineOffset, nLeftMargin, nRightMargin, and BigInt::Scale().

SetAutoFirst()

void SvxLRSpaceItem::SetAutoFirst ( const bool  bNew )

inline

Definition at line 332 of file lrspitem.hxx.

Referenced by PutValue().

SetExplicitZeroMarginValLeft()

void SvxLRSpaceItem::SetExplicitZeroMarginValLeft ( const bool  eL )

inline

Definition at line 337 of file lrspitem.hxx.

Referenced by SetTextLeft().

SetExplicitZeroMarginValRight()

void SvxLRSpaceItem::SetExplicitZeroMarginValRight ( const bool  eR )

inline

Definition at line 336 of file lrspitem.hxx.

Referenced by SetRight().

SetGutterMargin()

void SvxLRSpaceItem::SetGutterMargin ( const tools::Long  nGutterMargin )

inline

Definition at line 353 of file lrspitem.hxx.

Referenced by PutValue().

SetLeft()

void SvxLRSpaceItem::SetLeft	(	const tools::Long	nL,
		const sal_uInt16	nProp = 100
	)

Definition at line 474 of file frmitems.cxx.

References nFirstLineOffset, nLeftMargin, nPropLeftMargin, and SAL_WARN_IF.

Referenced by PutValue().

SetLeftValue()

void SvxLRSpaceItem::SetLeftValue ( const tools::Long  nL )

inline

Definition at line 329 of file lrspitem.hxx.

References nFirstLineOffset, and nLeftMargin.

SetPropTextFirstLineOffset()

void SvxLRSpaceItem::SetPropTextFirstLineOffset ( const sal_uInt16  nProp )

inline

Definition at line 347 of file lrspitem.hxx.

Referenced by PutValue().

SetRight()

void SvxLRSpaceItem::SetRight	(	const tools::Long	nR,
		const sal_uInt16	nProp = 100
	)

Definition at line 487 of file frmitems.cxx.

References nPropRightMargin, nRightMargin, and SetExplicitZeroMarginValRight().

Referenced by ConvertItem(), PutValue(), and SvxRTFParser::ReadAttr().

SetRightGutterMargin()

void SvxLRSpaceItem::SetRightGutterMargin ( const tools::Long  nRightGutterMargin )

inline

Definition at line 355 of file lrspitem.hxx.

SetRightValue()

void SvxLRSpaceItem::SetRightValue ( const tools::Long  nR )

inline

Definition at line 330 of file lrspitem.hxx.

References nRightMargin.

SetTextFirstLineOffset()

void SvxLRSpaceItem::SetTextFirstLineOffset	(	const short	nF,
		const sal_uInt16	nProp = 100
	)

Definition at line 504 of file frmitems.cxx.

References nFirstLineOffset, nLeftMargin, and nPropFirstLineOffset.

Referenced by ConvertItem(), PutValue(), and SvxRTFParser::ReadAttr().

SetTextFirstLineOffsetValue()

void SvxLRSpaceItem::SetTextFirstLineOffsetValue ( const short  nValue )

inline

Definition at line 351 of file lrspitem.hxx.

References nFirstLineOffset, and nValue.

SetTextLeft()

void SvxLRSpaceItem::SetTextLeft	(	const tools::Long	nL,
		const sal_uInt16	nProp = 100
	)

Definition at line 539 of file frmitems.cxx.

References nFirstLineOffset, nLeftMargin, nPropLeftMargin, and SetExplicitZeroMarginValLeft().

Referenced by ConvertItem(), PutValue(), and SvxRTFParser::ReadAttr().

Member Data Documentation

bAutoFirst

bool SvxLRSpaceItem::bAutoFirst

private

Definition at line 293 of file lrspitem.hxx.

Referenced by dumpAsXml(), and operator==().

bExplicitZeroMarginValLeft

bool SvxLRSpaceItem::bExplicitZeroMarginValLeft

private

Definition at line 295 of file lrspitem.hxx.

Referenced by dumpAsXml(), and operator==().

bExplicitZeroMarginValRight

bool SvxLRSpaceItem::bExplicitZeroMarginValRight

private

Definition at line 294 of file lrspitem.hxx.

Referenced by dumpAsXml(), and operator==().

m_nGutterMargin

tools::Long SvxLRSpaceItem::m_nGutterMargin

private

The amount of extra space added to the left margin.

Definition at line 288 of file lrspitem.hxx.

Referenced by dumpAsXml(), operator==(), and QueryValue().

m_nRightGutterMargin

tools::Long SvxLRSpaceItem::m_nRightGutterMargin

private

The amount of extra space added to the right margin, on mirrored pages.

Definition at line 290 of file lrspitem.hxx.

Referenced by dumpAsXml(), and operator==().

nFirstLineOffset

short SvxLRSpaceItem::nFirstLineOffset

private

First-line indent always relative to GetTextLeft()

Definition at line 284 of file lrspitem.hxx.

Referenced by dumpAsXml(), GetPresentation(), GetTextLeft(), operator==(), QueryValue(), ScaleMetrics(), SetLeft(), SetTextFirstLineOffset(), and SetTextLeft().

nLeftMargin

tools::Long SvxLRSpaceItem::nLeftMargin

private

Definition at line 285 of file lrspitem.hxx.

Referenced by dumpAsXml(), GetPresentation(), GetTextLeft(), operator==(), QueryValue(), ScaleMetrics(), SetLeft(), SetTextFirstLineOffset(), and SetTextLeft().

nPropFirstLineOffset

sal_uInt16 SvxLRSpaceItem::nPropFirstLineOffset

private

Definition at line 292 of file lrspitem.hxx.

Referenced by dumpAsXml(), GetPresentation(), operator==(), QueryValue(), and SetTextFirstLineOffset().

nPropLeftMargin

sal_uInt16 SvxLRSpaceItem::nPropLeftMargin

private

Definition at line 292 of file lrspitem.hxx.

Referenced by dumpAsXml(), GetPresentation(), operator==(), PutValue(), QueryValue(), SetLeft(), and SetTextLeft().

nPropRightMargin

sal_uInt16 SvxLRSpaceItem::nPropRightMargin

private

Definition at line 292 of file lrspitem.hxx.

Referenced by dumpAsXml(), GetPresentation(), operator==(), PutValue(), QueryValue(), and SetRight().

nRightMargin

tools::Long SvxLRSpaceItem::nRightMargin

private

Definition at line 286 of file lrspitem.hxx.

Referenced by dumpAsXml(), GetPresentation(), operator==(), QueryValue(), ScaleMetrics(), and SetRight().

---

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

• lrspitem.hxx
• frmitems.cxx