CIP C++ documentation for class "pfcTextStyle"

Class pfcTextStyle

# include <pfcBase.h> class pfcTextStyle : public virtual xobject { xdeclare(pfcTextStyle) ... }; This is a COMPACT class.

Description

This class specifies the text attributes.

Method Summary


`static pfcTextStyle_ptr`	`Create ()`
	Creates a new text style object.

`xreal`	`GetAngle ()`
`void`	`SetAngle (xreal value)`
	The angle of rotation of the whole text, in counterclockwise degrees.

`xstring`	`GetFontName ()`
`void`	`SetFontName (xrstring value)`
	The font name.

`xreal`	`GetHeight ()`
`void`	`SetHeight (xreal value)`
	The text height, in screen coordinates.

`optional xbool`	`GetIsMirrored ()`
`void`	`SetIsMirrored (optional xbool value)`
	If this is `true`, the text is mirrored. Otherwise, the text is not mirrored.

`optional xbool`	`GetIsUnderlined ()`
`void`	`SetIsUnderlined (optional xbool value)`
	If this is `true`, the text is underlined. Otherwise, the text is not underlined.

`xreal`	`GetSlantAngle ()`
`void`	`SetSlantAngle (xreal value)`
	The slant angle of the text, in clockwise degrees.

`xreal`	`GetThickness ()`
`void`	`SetThickness (xreal value)`
	The text thickness.

`xreal`	`GetWidthFactor ()`
`void`	`SetWidthFactor (xreal value)`
	The ratio of the width of each character (including the gap) as a proportion of the height.

Method Detail

`xreal`	`GetAngle`	`()`
`void`	`SetAngle`	`(xreal value)`

The angle of rotation of the whole text, in counterclockwise degrees.

Manual References:: Annotations: Annotation Features and Annotations: Text Style Properties, Annotations: Annotation Features and Annotations: Text Style Properties, Annotations: Annotation Features and Annotations: Text Style Properties, Annotations: Annotation Features and Annotations: Text Style Properties

`xstring`	`GetFontName`	`()`
`void`	`SetFontName`	`(xrstring value)`

The font name.

Manual References:: Annotations: Annotation Features and Annotations: Text Style Properties, Annotations: Annotation Features and Annotations: Text Style Properties, Annotations: Annotation Features and Annotations: Text Style Properties, Annotations: Annotation Features and Annotations: Text Style Properties

`xreal`	`GetHeight`	`()`
`void`	`SetHeight`	`(xreal value)`

The text height, in screen coordinates.

Manual References:: Annotations: Annotation Features and Annotations: Text Style Properties, Annotations: Annotation Features and Annotations: Text Style Properties, Annotations: Annotation Features and Annotations: Text Style Properties, Annotations: Annotation Features and Annotations: Text Style Properties

`xreal`	`GetWidthFactor`	`()`
`void`	`SetWidthFactor`	`(xreal value)`

The ratio of the width of each character (including the gap) as a proportion of the height.

Manual References:: Annotations: Annotation Features and Annotations: Text Style Properties, Annotations: Annotation Features and Annotations: Text Style Properties, Annotations: Annotation Features and Annotations: Text Style Properties, Annotations: Annotation Features and Annotations: Text Style Properties

`xreal`	`GetSlantAngle`	`()`
`void`	`SetSlantAngle`	`(xreal value)`

The slant angle of the text, in clockwise degrees.

Manual References:: Annotations: Annotation Features and Annotations: Text Style Properties, Annotations: Annotation Features and Annotations: Text Style Properties, Annotations: Annotation Features and Annotations: Text Style Properties, Annotations: Annotation Features and Annotations: Text Style Properties

`xreal`	`GetThickness`	`()`
`void`	`SetThickness`	`(xreal value)`

The text thickness.

Manual References:: Annotations: Annotation Features and Annotations: Text Style Properties, Annotations: Annotation Features and Annotations: Text Style Properties, Annotations: Annotation Features and Annotations: Text Style Properties, Annotations: Annotation Features and Annotations: Text Style Properties

`optional xbool`	`GetIsUnderlined`	`()`
`void`	`SetIsUnderlined`	`(optional xbool value)`

If this is true, the text is underlined. Otherwise, the text is not underlined.

Manual References:: Annotations: Annotation Features and Annotations: Text Style Properties, Annotations: Annotation Features and Annotations: Text Style Properties, Annotations: Annotation Features and Annotations: Text Style Properties, Annotations: Annotation Features and Annotations: Text Style Properties

`optional xbool`	`GetIsMirrored`	`()`
`void`	`SetIsMirrored`	`(optional xbool value)`

If this is true, the text is mirrored. Otherwise, the text is not mirrored.

Manual References:: Annotations: Annotation Features and Annotations: Text Style Properties, Annotations: Annotation Features and Annotations: Text Style Properties, Annotations: Annotation Features and Annotations: Text Style Properties, Annotations: Annotation Features and Annotations: Text Style Properties

static pfcTextStyle_ptr Create ()

Creates a new text style object.