SoTextStyleElement Class Reference

Stores the current text effect settings. More...

#include <Inventor/elements/SoTextStyleElement.h>

Inheritance diagram for SoTextStyleElement:

Public Types
enum	Style {   NONE = 1 << 0 ,   UNDERLINE = 1 << 1 ,   STRIKETHROUGH = 1 << 2 ,   DOUBLE_STRIKETHROUGH = 1 << 3 ,   BACK_FRAME = 1 << 4 ,   BACK_FRAME_LINE = 1 << 5 ,   OVERLINE = 1 << 6 }
	Available styles (may be combined): More...

Static Public Member Functions
static SoType	getClassTypeId ()
	Returns the type identifier for this class.
static int	getClassStackIndex ()
	Returns the stack id for this element.
static void	set (SoState *state, Style style)
	Sets the current style type in the state.
static void	set (SoState *state, SoNode *, Style style)
	Sets the current style type in the state.
static Style	get (SoState *state)
	Returns current style from the state.
static Style	getDefault ()
	Returns the default style.
Static Public Member Functions inherited from SoInt32Element
static SoType	getClassTypeId ()
	Returns the type identifier for this class.
static int	getClassStackIndex ()
	Returns the stack id for this element.
Static Public Member Functions inherited from SoElement
static SoType	getClassTypeId ()
	Returns type identifier for SoElement class.
Static Public Member Functions inherited from SoTypedObject
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

Additional Inherited Members
Public Member Functions inherited from SoInt32Element
virtual void	print (FILE *fp) const
	Prints element (for debugging).
Public Member Functions inherited from SoElement
virtual void	push (SoState *state)
	Pushes element.
virtual void	pop (SoState *state, const SoElement *prevTopElement)
	Pops element.
virtual SoType	getTypeId () const
	Returns type identifier for element instance.
Public Member Functions inherited from SoTypedObject
SbBool	isOfType (const SoType &type) const
	Returns TRUE if this object is of the type specified in type or is derived from that type.
template<typename TypedObjectClass >
SbBool	isOfType () const
	Returns TRUE if this object is of the type of class TypedObjectClass or is derived from that class.

Detailed Description

Stores the current text effect settings.

This element stores the current text effects settings.

SEE ALSO

SoTextProperty

Definition at line 41 of file SoTextStyleElement.h.

Member Enumeration Documentation

Style

enum SoTextStyleElement::Style

Available styles (may be combined):

Enumerator
NONE	No effects.
UNDERLINE	UNDERLINE.
STRIKETHROUGH	STRIKETHROUGH.
DOUBLE_STRIKETHROUGH	DOUBLE_STRIKETHROUGH.
BACK_FRAME	BACK_FRAME.
BACK_FRAME_LINE	BACK_FRAME_LINE.
OVERLINE	OVERLINE.

Definition at line 50 of file SoTextStyleElement.h.

Member Function Documentation

get()

static Style SoTextStyleElement::get ( SoState *  state )

inlinestatic

Returns current style from the state.

Definition at line 82 of file SoTextStyleElement.h.

getClassStackIndex()

static int SoTextStyleElement::getClassStackIndex ( )

static

Returns the stack id for this element.

getClassTypeId()

static SoType SoTextStyleElement::getClassTypeId ( )

static

Returns the type identifier for this class.

getDefault()

static Style SoTextStyleElement::getDefault ( )

static

Returns the default style.

set() [1/2]

static void SoTextStyleElement::set ( SoState *  state, SoNode *  , Style  style  )

inlinestatic

Sets the current style type in the state.

Definition at line 76 of file SoTextStyleElement.h.

set() [2/2]

static void SoTextStyleElement::set ( SoState *  state, Style  style  )

static

Sets the current style type in the state.

---

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

• Inventor/elements/SoTextStyleElement.h