#include <fmtruby.hxx>

Inheritance diagram for SwFormatRuby:

Collaboration diagram for SwFormatRuby:

Public Member Functions
	SwFormatRuby (OUString aRubyText)

	SwFormatRuby (const SwFormatRuby &rAttr)

virtual	~SwFormatRuby () override

SwFormatRuby &	operator= (const SwFormatRuby &rAttr)

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

virtual SwFormatRuby *	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 SwTextRuby *	GetTextRuby () const

const OUString &	GetText () const

void	SetText (const OUString &rText)

const OUString &	GetCharFormatName () const

void	SetCharFormatName (const OUString &rNm)

sal_uInt16	GetCharFormatId () const

void	SetCharFormatId (sal_uInt16 nNew)

sal_uInt16	GetPosition () const

void	SetPosition (sal_uInt16 nNew)

css::text::RubyAdjust	GetAdjustment () const

void	SetAdjustment (css::text::RubyAdjust nNew)

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
OUString	m_sRubyText
	The ruby text. More...

OUString	m_sCharFormatName
	Name of the charformat. More...

SwTextRuby *	m_pTextAttr
	The TextAttribute. More...

sal_uInt16	m_nCharFormatId
	PoolId of the charformat. More...

sal_uInt16	m_nPosition
	Position of the Ruby-character. More...

css::text::RubyAdjust	m_eAdjustment
	Specific adjustment of the Ruby-ch. More...

Friends
class	SwTextRuby

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 28 of file fmtruby.hxx.

Constructor & Destructor Documentation

◆ SwFormatRuby() [1/2]

SwFormatRuby::SwFormatRuby ( OUString aRubyText )

Definition at line 401 of file fmtatr2.cxx.

References m_nPosition, m_sRubyText, and text().

Referenced by Clone().

◆ SwFormatRuby() [2/2]

SwFormatRuby::SwFormatRuby ( const SwFormatRuby & rAttr )

Definition at line 411 of file fmtatr2.cxx.

References m_nPosition, and m_sRubyText.

◆ ~SwFormatRuby()

SwFormatRuby::~SwFormatRuby ( )

overridevirtual

Definition at line 422 of file fmtatr2.cxx.

Member Function Documentation

◆ Clone()

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

overridevirtual

Implements SfxPoolItem.

Definition at line 450 of file fmtatr2.cxx.

References SwFormatRuby().

◆ GetAdjustment()

css::text::RubyAdjust SwFormatRuby::GetAdjustment ( ) const

inline

Definition at line 73 of file fmtruby.hxx.

Referenced by SwXTextView::getRubyList(), SwRubyPortion::SwRubyPortion(), and WW8Ruby::WW8Ruby().

◆ GetCharFormatId()

sal_uInt16 SwFormatRuby::GetCharFormatId ( ) const

inline

Definition at line 67 of file fmtruby.hxx.

Referenced by SwTextRuby::GetCharFormat().

◆ GetCharFormatName()

const OUString & SwFormatRuby::GetCharFormatName ( ) const

inline

Definition at line 64 of file fmtruby.hxx.

Referenced by SwTextRuby::GetCharFormat(), and SwXTextView::getRubyList().

◆ GetPosition()

sal_uInt16 SwFormatRuby::GetPosition ( ) const

inline

Definition at line 70 of file fmtruby.hxx.

References m_nPosition.

Referenced by SwXTextView::getRubyList(), SwRubyPortion::SwRubyPortion(), and WW8Ruby::WW8Ruby().

◆ GetPresentation()

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

overridevirtual

Reimplemented from SfxPoolItem.

Definition at line 134 of file attrdesc.cxx.

◆ GetText()

const OUString & SwFormatRuby::GetText ( ) const

inline

Definition at line 61 of file fmtruby.hxx.

References m_sRubyText.

Referenced by SwTextAttr::dumpAsXml(), SwTextRuby::GetCharFormat(), SwXTextView::getRubyList(), SwDoc::SetRubyList(), DocxAttributeOutput::StartRuby(), RtfAttributeOutput::StartRuby(), WW8AttributeOutput::StartRuby(), SwRubyPortion::SwRubyPortion(), and WW8Ruby::WW8Ruby().

◆ GetTextRuby()

const SwTextRuby * SwFormatRuby::GetTextRuby ( ) const

inline

Definition at line 59 of file fmtruby.hxx.

Referenced by DocxAttributeOutput::StartRuby(), and WW8Ruby::WW8Ruby().

◆ operator=()

SwFormatRuby & SwFormatRuby::operator= ( const SwFormatRuby & rAttr )

Definition at line 426 of file fmtatr2.cxx.

References m_eAdjustment, m_nCharFormatId, m_nPosition, m_pTextAttr, m_sCharFormatName, and m_sRubyText.

◆ operator==()

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

overridevirtual

Implements SfxPoolItem.

Definition at line 440 of file fmtatr2.cxx.

References m_eAdjustment, m_nCharFormatId, m_nPosition, m_sCharFormatName, and m_sRubyText.

◆ PutValue()

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

overridevirtual

Reimplemented from SfxPoolItem.

Definition at line 486 of file fmtatr2.cxx.

References ChrFmt, cppu::UnoType< typename T >::get(), SwStyleNameMapper::GetUIName(), uno::Any::hasValue(), m_eAdjustment, m_nPosition, m_sCharFormatName, m_sRubyText, MID_RUBY_ABOVE, MID_RUBY_ADJUST, MID_RUBY_CHARSTYLE, MID_RUBY_POSITION, and MID_RUBY_TEXT.

◆ QueryValue()

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

overridevirtual

Reimplemented from SfxPoolItem.

Definition at line 455 of file fmtatr2.cxx.

References ChrFmt, SwStyleNameMapper::FillProgName(), m_eAdjustment, m_nPosition, m_sCharFormatName, m_sRubyText, MID_RUBY_ABOVE, MID_RUBY_ADJUST, MID_RUBY_CHARSTYLE, MID_RUBY_POSITION, and MID_RUBY_TEXT.

◆ SetAdjustment()

void SwFormatRuby::SetAdjustment ( css::text::RubyAdjust nNew )

inline

Definition at line 74 of file fmtruby.hxx.

Referenced by SwWW8ImplReader::Read_SubF_Ruby().

◆ SetCharFormatId()

void SwFormatRuby::SetCharFormatId ( sal_uInt16 nNew )

inline

Definition at line 68 of file fmtruby.hxx.

Referenced by SwWW8ImplReader::Read_SubF_Ruby().

◆ SetCharFormatName()

void SwFormatRuby::SetCharFormatName ( const OUString & rNm )

inline

Definition at line 65 of file fmtruby.hxx.

Referenced by SwWW8ImplReader::Read_SubF_Ruby().

◆ SetPosition()

void SwFormatRuby::SetPosition ( sal_uInt16 nNew )

inline

Definition at line 71 of file fmtruby.hxx.

References m_nPosition.

◆ SetText()

void SwFormatRuby::SetText ( const OUString & rText )

inline

Definition at line 62 of file fmtruby.hxx.

References m_sRubyText.

Friends And Related Function Documentation

◆ SwTextRuby

friend class SwTextRuby

friend

Definition at line 30 of file fmtruby.hxx.

Member Data Documentation

◆ m_eAdjustment

css::text::RubyAdjust SwFormatRuby::m_eAdjustment

private

Specific adjustment of the Ruby-ch.

Definition at line 37 of file fmtruby.hxx.

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

◆ m_nCharFormatId

sal_uInt16 SwFormatRuby::m_nCharFormatId

private

PoolId of the charformat.

Definition at line 35 of file fmtruby.hxx.

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

◆ m_nPosition

sal_uInt16 SwFormatRuby::m_nPosition

private

Position of the Ruby-character.

Definition at line 36 of file fmtruby.hxx.

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

◆ m_pTextAttr

SwTextRuby* SwFormatRuby::m_pTextAttr

private

The TextAttribute.

Definition at line 34 of file fmtruby.hxx.

Referenced by operator=(), and SwTextRuby::SwTextRuby().

◆ m_sCharFormatName

OUString SwFormatRuby::m_sCharFormatName

private

Name of the charformat.

Definition at line 33 of file fmtruby.hxx.

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

◆ m_sRubyText

OUString SwFormatRuby::m_sRubyText

private

The ruby text.

Definition at line 32 of file fmtruby.hxx.

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

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

Public Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SwFormatRuby() [1/2]

◆ SwFormatRuby() [2/2]

◆ ~SwFormatRuby()

Member Function Documentation

◆ Clone()

◆ GetAdjustment()

◆ GetCharFormatId()

◆ GetCharFormatName()

◆ GetPosition()

◆ GetPresentation()

◆ GetText()

◆ GetTextRuby()

◆ operator=()

◆ operator==()

◆ PutValue()

◆ QueryValue()

◆ SetAdjustment()

◆ SetCharFormatId()

◆ SetCharFormatName()

◆ SetPosition()

◆ SetText()

Friends And Related Function Documentation

◆ SwTextRuby

Member Data Documentation

◆ m_eAdjustment

◆ m_nCharFormatId

◆ m_nPosition

◆ m_pTextAttr

◆ m_sCharFormatName

◆ m_sRubyText