SoTextMarginElement Class Reference

Stores the current text margin. More...

#include <Inventor/elements/SoTextMarginElement.h>

Inheritance diagram for SoTextMarginElement:

Public Member Functions
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.

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, float margin)
	Sets the current horizontal text margin in the state.
static void	set (SoState *state, SoNode *, float margin)
	Sets the current horizontal text margin in the state.
static float	get (SoState *state)
	Returns current margin from the state.
static float	getDefault ()
	Returns the default margin.
Static Public Member Functions inherited from SoFloatElement
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.

Detailed Description

Stores the current text margin.

This element stores the current text margin value. The margin value is a factor of current font size.

SEE ALSO

SoTextProperty

Definition at line 41 of file SoTextMarginElement.h.

Member Function Documentation

get()

static float SoTextMarginElement::get ( SoState *  state )

inlinestatic

Returns current margin from the state.

Definition at line 61 of file SoTextMarginElement.h.

getClassStackIndex()

static int SoTextMarginElement::getClassStackIndex ( )

static

Returns the stack id for this element.

getClassTypeId()

static SoType SoTextMarginElement::getClassTypeId ( )

static

Returns the type identifier for this class.

getDefault()

static float SoTextMarginElement::getDefault ( )

static

Returns the default margin.

print()

virtual void SoTextMarginElement::print ( FILE *  fp ) const

virtual

Prints element (for debugging).

Reimplemented from SoFloatElement.

set() [1/2]

static void SoTextMarginElement::set ( SoState *  state, float  margin  )

static

Sets the current horizontal text margin in the state.

set() [2/2]

static void SoTextMarginElement::set ( SoState *  state, SoNode *  , float  margin  )

inlinestatic

Sets the current horizontal text margin in the state.

Definition at line 56 of file SoTextMarginElement.h.

---

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

• Inventor/elements/SoTextMarginElement.h