#include <tgrditem.hxx>

Inheritance diagram for SwTextGridItem:

Collaboration diagram for SwTextGridItem:

Public Member Functions
	SwTextGridItem ()

virtual	~SwTextGridItem () override

	SwTextGridItem (SwTextGridItem const &)=default

	SwTextGridItem (SwTextGridItem &&)=default

SwTextGridItem &	operator= (SwTextGridItem const &)=delete

SwTextGridItem &	operator= (SwTextGridItem &&)=delete

virtual bool	operator== (const SfxPoolItem &) const override

virtual SwTextGridItem *	Clone (SfxItemPool *pPool=nullptr) const override

virtual bool	GetPresentation (SfxItemPresentation ePres, MapUnit eCoreMetric, MapUnit ePresMetric, OUString &rText, const IntlWrapper &rIntl) 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

const Color &	GetColor () const

void	SetColor (const Color &rCol)

sal_Int32	GetLines () const

void	SetLines (sal_Int32 nNew)

sal_uInt16	GetBaseHeight () const

void	SetBaseHeight (sal_uInt16 nNew)

sal_uInt16	GetRubyHeight () const

void	SetRubyHeight (sal_uInt16 nNew)

SwTextGrid	GetGridType () const

void	SetGridType (SwTextGrid eNew)

bool	IsRubyTextBelow () const

bool	GetRubyTextBelow () const

void	SetRubyTextBelow (bool bNew)

bool	IsPrintGrid () const

bool	GetPrintGrid () const

void	SetPrintGrid (bool bNew)

bool	IsDisplayGrid () const

bool	GetDisplayGrid () const

void	SetDisplayGrid (bool bNew)

sal_uInt16	GetBaseWidth () const

void	SetBaseWidth (sal_uInt16 nNew)

bool	IsSnapToChars () const

bool	GetSnapToChars () const

void	SetSnapToChars (bool bNew)

bool	IsSquaredMode () const

bool	GetSquaredMode () const

void	SetSquaredMode (bool bNew)

void	SwitchPaperMode (bool bNew)

void	Init ()

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

Private Attributes
Color	m_aColor

sal_Int32	m_nLines

sal_uInt16	m_nBaseHeight

sal_uInt16	m_nRubyHeight

SwTextGrid	m_eGridType

bool	m_bRubyTextBelow

bool	m_bPrintGrid

bool	m_bDisplayGrid

sal_uInt16	m_nBaseWidth

bool	m_bSnapToChars

bool	m_bSquaredMode

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 32 of file tgrditem.hxx.

Constructor & Destructor Documentation

◆ SwTextGridItem() [1/3]

SwTextGridItem::SwTextGridItem ( )

Definition at line 2281 of file atrfrm.cxx.

References COL_LIGHTGRAY(), and m_aColor.

Referenced by Clone().

◆ ~SwTextGridItem()

SwTextGridItem::~SwTextGridItem ( )

overridevirtual

Definition at line 2289 of file atrfrm.cxx.

◆ SwTextGridItem() [2/3]

SwTextGridItem::SwTextGridItem ( SwTextGridItem const & )

default

◆ SwTextGridItem() [3/3]

SwTextGridItem::SwTextGridItem ( SwTextGridItem && )

default

Member Function Documentation

◆ Clone()

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

overridevirtual

Implements SfxPoolItem.

Definition at line 2310 of file atrfrm.cxx.

References SwTextGridItem().

◆ GetBaseHeight()

sal_uInt16 SwTextGridItem::GetBaseHeight ( ) const

inline

Definition at line 75 of file tgrditem.hxx.

Referenced by SwTextFormatter::CalcRealHeight(), SwBodyFrame::Format(), SwTextFrame::FormatEmpty(), DocxAttributeOutput::FormatTextGrid(), WW8AttributeOutput::FormatTextGrid(), GetGridWidth(), AttributeOutputBase::GridCharacterPitch(), operator==(), SwTextFrame::PaintEmpty(), SwPageFrame::PaintGrid(), and SwTextGridPage::Reset().

◆ GetBaseWidth()

sal_uInt16 SwTextGridItem::GetBaseWidth ( ) const

inline

Definition at line 97 of file tgrditem.hxx.

Referenced by GetGridWidth(), AttributeOutputBase::GridCharacterPitch(), operator==(), and SwTextGridPage::Reset().

◆ GetColor()

const Color & SwTextGridItem::GetColor ( ) const

inline

Definition at line 69 of file tgrditem.hxx.

References m_aColor.

Referenced by operator==(), SwPageFrame::PaintGrid(), QueryValue(), and SwTextGridPage::Reset().

◆ GetDisplayGrid()

bool SwTextGridItem::GetDisplayGrid ( ) const

inline

Definition at line 93 of file tgrditem.hxx.

Referenced by operator==(), and SwPageFrame::PaintGrid().

◆ GetGridType()

SwTextGrid SwTextGridItem::GetGridType ( ) const

inline

◆ GetLines()

sal_Int32 SwTextGridItem::GetLines ( ) const

inline

Definition at line 72 of file tgrditem.hxx.

Referenced by SwBodyFrame::Format(), operator==(), QueryValue(), and SwTextGridPage::Reset().

◆ GetPresentation()

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

overridevirtual

Reimplemented from SfxPoolItem.

Definition at line 635 of file attrdesc.cxx.

References GetGridType(), GRID_LINES_CHARS, GRID_LINES_ONLY, GRID_NONE, and SwResId().

◆ GetPrintGrid()

bool SwTextGridItem::GetPrintGrid ( ) const

inline

Definition at line 89 of file tgrditem.hxx.

Referenced by operator==(), and SwPageFrame::PaintGrid().

◆ GetRubyHeight()

sal_uInt16 SwTextGridItem::GetRubyHeight ( ) const

inline

Definition at line 78 of file tgrditem.hxx.

Referenced by SwTextCursor::AdjustBaseLine(), SwTextFormatter::CalcRealHeight(), SwBodyFrame::Format(), SwTextFrame::FormatEmpty(), DocxAttributeOutput::FormatTextGrid(), WW8AttributeOutput::FormatTextGrid(), SwTextCursor::GetCharRect_(), operator==(), SwTextFrame::PaintEmpty(), SwPageFrame::PaintGrid(), SwTextPainter::PaintMultiPortion(), and SwTextGridPage::Reset().

◆ GetRubyTextBelow()

bool SwTextGridItem::GetRubyTextBelow ( ) const

inline

Definition at line 85 of file tgrditem.hxx.

Referenced by SwTextCursor::AdjustBaseLine(), SwTextFormatter::BuildMultiPortion(), SwTextFormatter::CalcRealHeight(), operator==(), SwTextFrame::PaintEmpty(), SwPageFrame::PaintGrid(), SwTextPainter::PaintMultiPortion(), and SwRubyPortion::SwRubyPortion().

◆ GetSnapToChars()

bool SwTextGridItem::GetSnapToChars ( ) const

inline

Definition at line 101 of file tgrditem.hxx.

Referenced by operator==().

◆ GetSquaredMode()

bool SwTextGridItem::GetSquaredMode ( ) const

inline

Definition at line 105 of file tgrditem.hxx.

Referenced by operator==().

◆ Init()

void SwTextGridItem::Init ( void )

Definition at line 2522 of file atrfrm.cxx.

References GRID_NONE, m_bDisplayGrid, m_bPrintGrid, m_bRubyTextBelow, m_bSnapToChars, m_bSquaredMode, m_eGridType, m_nBaseHeight, m_nBaseWidth, m_nLines, and m_nRubyHeight.

Referenced by SwDoc::SetDefaultPageMode(), and SwitchPaperMode().

◆ IsDisplayGrid()

bool SwTextGridItem::IsDisplayGrid ( ) const

inline

Definition at line 92 of file tgrditem.hxx.

Referenced by SwTextGridPage::Reset().

◆ IsPrintGrid()

bool SwTextGridItem::IsPrintGrid ( ) const

inline

Definition at line 88 of file tgrditem.hxx.

Referenced by SwTextGridPage::Reset().

◆ IsRubyTextBelow()

bool SwTextGridItem::IsRubyTextBelow ( ) const

inline

Definition at line 84 of file tgrditem.hxx.

Referenced by SwTextGridPage::Reset().

◆ IsSnapToChars()

bool SwTextGridItem::IsSnapToChars ( ) const

inline

Definition at line 100 of file tgrditem.hxx.

Referenced by SwTextFormatter::BuildPortions(), SwTextPortion::CalcSpacing(), SwFntObj::DrawText(), DocxAttributeOutput::FormatTextGrid(), WW8AttributeOutput::FormatTextGrid(), SwFntObj::GetModelPositionForViewPoint(), SwTextPortion::GetSpaceCnt(), SwFont::GetTextBreak(), SwFntObj::GetTextSize(), and SwTextGridPage::Reset().

◆ IsSquaredMode()

bool SwTextGridItem::IsSquaredMode ( ) const

inline

Definition at line 104 of file tgrditem.hxx.

Referenced by SwTextCursor::AdjustBaseLine(), AttributeOutputBase::GridCharacterPitch(), SwDoc::IsSquaredPageMode(), and SwTextPainter::PaintMultiPortion().

◆ operator=() [1/2]

SwTextGridItem & SwTextGridItem::operator= ( SwTextGridItem && )

delete

◆ operator=() [2/2]

SwTextGridItem & SwTextGridItem::operator= ( SwTextGridItem const & )

delete

◆ operator==()

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

overridevirtual

Implements SfxPoolItem.

Definition at line 2293 of file atrfrm.cxx.

References GetBaseHeight(), GetBaseWidth(), GetColor(), GetDisplayGrid(), GetGridType(), GetLines(), GetPrintGrid(), GetRubyHeight(), GetRubyTextBelow(), GetSnapToChars(), GetSquaredMode(), m_aColor, m_bDisplayGrid, m_bPrintGrid, m_bRubyTextBelow, m_bSnapToChars, m_bSquaredMode, m_eGridType, m_nBaseHeight, m_nBaseWidth, m_nLines, and m_nRubyHeight.

◆ PutValue()

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

overridevirtual

Reimplemented from SfxPoolItem.

Definition at line 2384 of file atrfrm.cxx.

References CONVERT_TWIPS, GRID_LINES_CHARS, GRID_LINES_ONLY, GRID_NONE, MID_GRID_BASEHEIGHT, MID_GRID_BASEWIDTH, MID_GRID_COLOR, MID_GRID_DISPLAY, MID_GRID_LINES, MID_GRID_PRINT, MID_GRID_RUBY_BELOW, MID_GRID_RUBYHEIGHT, MID_GRID_SNAPTOCHARS, MID_GRID_STANDARD_MODE, MID_GRID_TYPE, MIN_TEXTGRID_SIZE, o3tl::mm100, SwPostItHelper::NONE, SAL_MAX_UINT16, SetBaseHeight(), SetBaseWidth(), SetColor(), SetDisplayGrid(), SetGridType(), SetLines(), SetPrintGrid(), SetRubyHeight(), SetRubyTextBelow(), SetSnapToChars(), SetSquaredMode(), and o3tl::toTwips().

◆ QueryValue()

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

overridevirtual

Reimplemented from SfxPoolItem.

Definition at line 2315 of file atrfrm.cxx.

References CONVERT_TWIPS, convertTwipToMm100(), GetColor(), GetGridType(), GetLines(), GRID_LINES_CHARS, GRID_LINES_ONLY, GRID_NONE, m_bDisplayGrid, m_bPrintGrid, m_bRubyTextBelow, m_bSnapToChars, m_bSquaredMode, m_nBaseHeight, m_nBaseWidth, m_nRubyHeight, MID_GRID_BASEHEIGHT, MID_GRID_BASEWIDTH, MID_GRID_COLOR, MID_GRID_DISPLAY, MID_GRID_LINES, MID_GRID_PRINT, MID_GRID_RUBY_BELOW, MID_GRID_RUBYHEIGHT, MID_GRID_SNAPTOCHARS, MID_GRID_STANDARD_MODE, MID_GRID_TYPE, and SwPostItHelper::NONE.

◆ SetBaseHeight()

void SwTextGridItem::SetBaseHeight ( sal_uInt16 nNew )

inline

Definition at line 76 of file tgrditem.hxx.

Referenced by SwTextGridPage::PutGridItem(), PutValue(), and SwWW8ImplReader::SetDocumentGrid().

◆ SetBaseWidth()

void SwTextGridItem::SetBaseWidth ( sal_uInt16 nNew )

inline

Definition at line 98 of file tgrditem.hxx.

Referenced by SwTextGridPage::PutGridItem(), PutValue(), and SwWW8ImplReader::SetDocumentGrid().

◆ SetColor()

void SwTextGridItem::SetColor ( const Color & rCol )

inline

Definition at line 70 of file tgrditem.hxx.

References m_aColor.

Referenced by SwTextGridPage::PutGridItem(), and PutValue().

◆ SetDisplayGrid()

void SwTextGridItem::SetDisplayGrid ( bool bNew )

inline

Definition at line 94 of file tgrditem.hxx.

Referenced by SwTextGridPage::PutGridItem(), PutValue(), and SwWW8ImplReader::SetDocumentGrid().

◆ SetGridType()

void SwTextGridItem::SetGridType ( SwTextGrid eNew )

inline

Definition at line 82 of file tgrditem.hxx.

Referenced by SwTextGridPage::PutGridItem(), PutValue(), and SwWW8ImplReader::SetDocumentGrid().

◆ SetLines()

void SwTextGridItem::SetLines ( sal_Int32 nNew )

inline

Definition at line 73 of file tgrditem.hxx.

Referenced by SwTextGridPage::PutGridItem(), PutValue(), and SwWW8ImplReader::SetDocumentGrid().

◆ SetPrintGrid()

void SwTextGridItem::SetPrintGrid ( bool bNew )

inline

Definition at line 90 of file tgrditem.hxx.

Referenced by SwTextGridPage::PutGridItem(), PutValue(), and SwWW8ImplReader::SetDocumentGrid().

◆ SetRubyHeight()

void SwTextGridItem::SetRubyHeight ( sal_uInt16 nNew )

inline

Definition at line 79 of file tgrditem.hxx.

Referenced by SwTextGridPage::PutGridItem(), PutValue(), and SwWW8ImplReader::SetDocumentGrid().

◆ SetRubyTextBelow()

void SwTextGridItem::SetRubyTextBelow ( bool bNew )

inline

Definition at line 86 of file tgrditem.hxx.

Referenced by SwTextGridPage::PutGridItem(), and PutValue().

◆ SetSnapToChars()

void SwTextGridItem::SetSnapToChars ( bool bNew )

inline

Definition at line 102 of file tgrditem.hxx.

Referenced by SwTextGridPage::PutGridItem(), PutValue(), and SwWW8ImplReader::SetDocumentGrid().

◆ SetSquaredMode()

void SwTextGridItem::SetSquaredMode ( bool bNew )

inline

Definition at line 106 of file tgrditem.hxx.

Referenced by SwTextGridPage::PutGridItem(), PutValue(), SwDoc::SetDefaultPageMode(), and SwWW8ImplReader::SetDocumentGrid().

◆ SwitchPaperMode()

void SwTextGridItem::SwitchPaperMode ( bool bNew )

Definition at line 2489 of file atrfrm.cxx.

References GRID_NONE, Init(), m_bSquaredMode, m_eGridType, m_nBaseHeight, m_nBaseWidth, and m_nRubyHeight.

Referenced by SwDoc::SetDefaultPageMode().

Member Data Documentation

◆ m_aColor

Color SwTextGridItem::m_aColor

private

Definition at line 35 of file tgrditem.hxx.

Referenced by operator==().

◆ m_bDisplayGrid

bool SwTextGridItem::m_bDisplayGrid

private

Definition at line 42 of file tgrditem.hxx.

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

◆ m_bPrintGrid

bool SwTextGridItem::m_bPrintGrid

private

Definition at line 41 of file tgrditem.hxx.

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

◆ m_bRubyTextBelow

bool SwTextGridItem::m_bRubyTextBelow

private

Definition at line 40 of file tgrditem.hxx.

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

◆ m_bSnapToChars

bool SwTextGridItem::m_bSnapToChars

private

Definition at line 46 of file tgrditem.hxx.

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

◆ m_bSquaredMode

bool SwTextGridItem::m_bSquaredMode

private

Definition at line 47 of file tgrditem.hxx.

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

◆ m_eGridType

SwTextGrid SwTextGridItem::m_eGridType

private

Definition at line 39 of file tgrditem.hxx.

Referenced by Init(), operator==(), and SwitchPaperMode().

◆ m_nBaseHeight

sal_uInt16 SwTextGridItem::m_nBaseHeight

private

Definition at line 37 of file tgrditem.hxx.

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

◆ m_nBaseWidth

sal_uInt16 SwTextGridItem::m_nBaseWidth

private

Definition at line 45 of file tgrditem.hxx.

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

◆ m_nLines

sal_Int32 SwTextGridItem::m_nLines

private

Definition at line 36 of file tgrditem.hxx.

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

◆ m_nRubyHeight

sal_uInt16 SwTextGridItem::m_nRubyHeight

private

Definition at line 38 of file tgrditem.hxx.

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

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

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SwTextGridItem() [1/3]

◆ ~SwTextGridItem()

◆ SwTextGridItem() [2/3]

◆ SwTextGridItem() [3/3]

Member Function Documentation

◆ Clone()

◆ GetBaseHeight()

◆ GetBaseWidth()

◆ GetColor()

◆ GetDisplayGrid()

◆ GetGridType()

◆ GetLines()

◆ GetPresentation()

◆ GetPrintGrid()

◆ GetRubyHeight()

◆ GetRubyTextBelow()

◆ GetSnapToChars()

◆ GetSquaredMode()

◆ Init()

◆ IsDisplayGrid()

◆ IsPrintGrid()

◆ IsRubyTextBelow()

◆ IsSnapToChars()

◆ IsSquaredMode()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ PutValue()

◆ QueryValue()

◆ SetBaseHeight()

◆ SetBaseWidth()

◆ SetColor()

◆ SetDisplayGrid()

◆ SetGridType()

◆ SetLines()

◆ SetPrintGrid()

◆ SetRubyHeight()

◆ SetRubyTextBelow()

◆ SetSnapToChars()

◆ SetSquaredMode()

◆ SwitchPaperMode()

Member Data Documentation

◆ m_aColor

◆ m_bDisplayGrid

◆ m_bPrintGrid

◆ m_bRubyTextBelow

◆ m_bSnapToChars

◆ m_bSquaredMode

◆ m_eGridType

◆ m_nBaseHeight

◆ m_nBaseWidth

◆ m_nLines

◆ m_nRubyHeight