makVrv::DtWidgetLabel Class Reference

This is the implementation independent widget class for showing text. More...

Inheritance diagram for makVrv::DtWidgetLabel:

List of all members.

Public Types
enum	HorizontalAlignment { AlignLeft, AlignCenter, AlignRight, AlignJustify }
enum	GlyphCenterPolicy { CenterNone, CenterHorizontal, CenterVertical, CenterBoth }
Public Member Functions
	DtWidgetLabel (DtDe &de, DtUniqueID id)
	A widget label CTOR.
virtual	~DtWidgetLabel ()
	DTOR.
virtual void	setText (const DtUnicode &string)=0
	Set the labels string.
virtual void	setTextColor (float r, float g, float b, float a)=0
	Set the label's font color.
virtual void	setTextAlignment (HorizontalAlignment ha)=0
	Set the text alignment mode.
virtual void	setFont (const std::string &fontFace, float size)=0
	Set the font for the label.
virtual void	setFontScale (float scale)=0
	Set the font scale for the label.
virtual void	setBoundsLength (int len)=0
	Sets the length of the string to check when determining bounds.
virtual void	setGlyphCenterPolicy (GlyphCenterPolicy gcp)=0
	Sets the policy for how the glyph is located wrt its origin.
virtual void	setRotation (float angle)=0
	Sets the rotation applied to the label.

---

Detailed Description

This is the implementation independent widget class for showing text.

---

Member Enumeration Documentation

enum makVrv::DtWidgetLabel::HorizontalAlignment

Enumerator:

AlignLeft
AlignCenter
AlignRight
AlignJustify

enum makVrv::DtWidgetLabel::GlyphCenterPolicy

Enumerator:

CenterNone
CenterHorizontal
CenterVertical
CenterBoth

---

Constructor & Destructor Documentation

makVrv::DtWidgetLabel::DtWidgetLabel	(	DtDe &	de,
		DtUniqueID	id
	)

A widget label CTOR.

virtual makVrv::DtWidgetLabel::~DtWidgetLabel

(

)

[virtual]

DTOR.

---

Member Function Documentation

virtual void makVrv::DtWidgetLabel::setText

(

const DtUnicode &

string

)

[pure virtual]

Set the labels string.

Labels support multi lines when the string contains new line characters.

Implemented in makVrv::DtOsgWidgetLabel.

virtual void makVrv::DtWidgetLabel::setTextColor	(	float	r,
		float	g,
		float	b,
		float	a
	)		[pure virtual]

Set the label's font color.

Implemented in makVrv::DtOsgWidgetLabel.

virtual void makVrv::DtWidgetLabel::setTextAlignment

(

HorizontalAlignment

ha

)

[pure virtual]

Set the text alignment mode.

Implemented in makVrv::DtOsgWidgetLabel.

virtual void makVrv::DtWidgetLabel::setFont	(	const std::string &	fontFace,
		float	size
	)		[pure virtual]

Set the font for the label.

Implemented in makVrv::DtOsgWidgetLabel.

virtual void makVrv::DtWidgetLabel::setFontScale

(

float

scale

)

[pure virtual]

Set the font scale for the label.

Implemented in makVrv::DtOsgWidgetLabel.

virtual void makVrv::DtWidgetLabel::setBoundsLength

(

int

len

)

[pure virtual]

Sets the length of the string to check when determining bounds.

This is useful when needing text to line up.

Implemented in makVrv::DtOsgWidgetLabel.

virtual void makVrv::DtWidgetLabel::setGlyphCenterPolicy

(

GlyphCenterPolicy

gcp

)

[pure virtual]

Sets the policy for how the glyph is located wrt its origin.

Implemented in makVrv::DtOsgWidgetLabel.

virtual void makVrv::DtWidgetLabel::setRotation

(

float

angle

)

[pure virtual]

Sets the rotation applied to the label.

Implemented in makVrv::DtOsgWidgetLabel.

---

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

• include/vrvCore/DtWidgetLabel.h