OdPdfPublish::OdText Class Reference

#include <PdfPublishText.h>

Inheritance diagram for OdPdfPublish::OdText:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdText)
	ODRX_HEAP_OPERATORS ()
	OdText ()
virtual	~OdText ()
void	setText (const OdString &text)
void	setFont (Text::StandardFontsType fontType)
void	setFont (const OdString &fontName, Text::Language language, bool embed)
void	setSize (OdUInt16 size)
void	setColor (ODCOLORREF color)
void	getText (OdString &text) const
void	getFont (Text::StorageType &storageType, Text::StandardFontsType &fontType, OdString &fontName, Text::Language &language, bool &embed) const
void	getSize (OdUInt16 &size) const
void	getColor (ODCOLORREF &color) const
Public Member Functions inherited from OdPdfPublish::OdObject
	ODRX_DECLARE_MEMBERS (OdObject)
	ODRX_HEAP_OPERATORS ()
virtual	~OdObject ()
virtual bool	isEmpty () const
virtual bool	isValid () const
virtual void	clear ()
Public Member Functions inherited from OdRxObject
	ODRX_HEAP_OPERATORS ()
	OdRxObject ()
virtual	~OdRxObject ()
virtual OdRxObject *	queryX (const OdRxClass *pClass) const
virtual OdRxObject *	x (const OdRxClass *pClass) const
virtual OdRxClass *	isA () const
virtual void	addRef ()=0
virtual void	release ()=0
virtual long	numRefs () const
bool	isKindOf (const OdRxClass *pClass) const
virtual OdRxObjectPtr	clone () const
virtual void	copyFrom (const OdRxObject *pSource)
virtual OdRx::Ordering	comparedTo (const OdRxObject *pOther) const
virtual bool	isEqualTo (const OdRxObject *pOther) const

Additional Inherited Members
Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)
static OdRxClass *	desc ()
Protected Member Functions inherited from OdPdfPublish::OdObject
	OdObject (OdPublishObjectImpl *pImpl)

Detailed Description

This class implements a text label for .pdf documents created with Teigha Publish. Text label options consist of two parts: text content and formatting parameters (font type, size, color).

Definition at line 45 of file PdfPublishText.h.

Constructor & Destructor Documentation

OdText()

OdPdfPublish::OdText::OdText

(

)

Creates a text label.

~OdText()

virtual OdPdfPublish::OdText::~OdText ( )

virtual

Destroys a text label.

Member Function Documentation

getColor()

void OdPdfPublish::OdText::getColor

(

ODCOLORREF &

color

)

const

Returns the text label color. The method fills a passed ODCOLORREF value and returns it to a calling subroutine.

Parameters

color

[out] A placeholder for the text label color value.

getFont()

void OdPdfPublish::OdText::getFont	(	Text::StorageType &	storageType,
		Text::StandardFontsType &	fontType,
		OdString &	fontName,
		Text::Language &	language,
		bool &	embed
	)		const

getSize()

void OdPdfPublish::OdText::getSize

(

OdUInt16 &

size

)

const

Returns the text label font size. The method fills a passed value and returns it to a calling subroutine.

Parameters

size	[out] A placeholder for the font size value.

getText()

void OdPdfPublish::OdText::getText

(

OdString &

text

)

const

Returns the text label content. The method fills a passed string object with label text and returns this string to a calling subroutine.

Parameters

text	[out] A placeholder for the label text.

ODRX_DECLARE_MEMBERS()

OdPdfPublish::OdText::ODRX_DECLARE_MEMBERS

(

OdText

)

ODRX_HEAP_OPERATORS()

OdPdfPublish::OdText::ODRX_HEAP_OPERATORS

(

)

setColor()

void OdPdfPublish::OdText::setColor

(

ODCOLORREF

color

)

Sets the text label foreground color.

Parameters

color

[in] A new color value.

setFont() [1/2]

void OdPdfPublish::OdText::setFont	(	const OdString &	fontName,
		Text::Language	language,
		bool	embed
	)

setFont() [2/2]

void OdPdfPublish::OdText::setFont

(

Text::StandardFontsType

fontType

)

Sets the text label font type.

Parameters

font_type

[in] A new font type value.

See also

<link OdPdfPublish::Text::StandardFontsType, Text::StandardFontsType enumeration>.

setSize()

void OdPdfPublish::OdText::setSize

(

OdUInt16

size

)

Sets the text label font size.

Parameters

font_type

[in] A new font size value.

setText()

void OdPdfPublish::OdText::setText

(

const OdString &

text

)

Sets the label text.

Parameters

text	[in] A new label text.

---

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

• PdfPublishText.h