Detailed Description

render Representation of text elements.

The Text_t class represents text to be rendered in the context of a style. The Text_t class inherits all attributes and methods from its base class GraphicalPrimitive1D_t.

The text also holds a string for the actual text that is to be rendered for the Text_t object.

Additional attributes specify how the text is to be rendered, for example which font family is to be used and how the text is to be aligned within the viewport.

Public Member Functions
Text_t *	Text_clone (const Text_t *t)
	Creates and returns a deep copy of this Text_t object. More...

Text_t *	Text_create (unsigned int level, unsigned int version, unsigned int pkgVersion)
	Creates a new Text_t using the given SBML Level, Version and “render” package version. More...

void	Text_free (Text_t *t)
	Frees this Text_t object. More...

char *	Text_getFontFamily (const Text_t *t)
	Returns the value of the "font-family" attribute of this Text_t. More...

RelAbsVector_t *	Text_getFontSize (const Text_t *t)
	Returns the value of the "font-size" element of this Text_t. More...

FontStyle_t	Text_getFontStyle (const Text_t *t)
	Returns the value of the "font-style" attribute of this Text_t. More...

char *	Text_getFontStyleAsString (const Text_t *t)
	Returns the value of the "font-style" attribute of this Text_t. More...

FontWeight_t	Text_getFontWeight (const Text_t *t)
	Returns the value of the "font-weight" attribute of this Text_t. More...

char *	Text_getFontWeightAsString (const Text_t *t)
	Returns the value of the "font-weight" attribute of this Text_t. More...

HTextAnchor_t	Text_getTextAnchor (const Text_t *t)
	Returns the value of the "text-anchor" attribute of this Text_t. More...

char *	Text_getTextAnchorAsString (const Text_t *t)
	Returns the value of the "text-anchor" attribute of this Text_t. More...

VTextAnchor_t	Text_getVTextAnchor (const Text_t *t)
	Returns the value of the "vtext-anchor" attribute of this Text_t. More...

char *	Text_getVTextAnchorAsString (const Text_t *t)
	Returns the value of the "vtext-anchor" attribute of this Text_t. More...

RelAbsVector_t *	Text_getX (const Text_t *t)
	Returns the value of the "x" element of this Text_t. More...

RelAbsVector_t *	Text_getY (const Text_t *t)
	Returns the value of the "y" element of this Text_t. More...

RelAbsVector_t *	Text_getZ (const Text_t *t)
	Returns the value of the "z" element of this Text_t. More...

int	Text_hasRequiredAttributes (const Text_t *t)
	Predicate returning `1` (true) if all the required attributes for this Text_t object have been set. More...

int	Text_isSetFontFamily (const Text_t *t)
	Predicate returning `1` (true) if this Text_t's "font-family" attribute is set. More...

int	Text_isSetFontSize (const Text_t *t)
	Predicate returning `1` (true) if this Text_t's "font-size" element is set. More...

int	Text_isSetFontStyle (const Text_t *t)
	Predicate returning `1` (true) if this Text_t's "font-style" attribute is set. More...

int	Text_isSetFontWeight (const Text_t *t)
	Predicate returning `1` (true) if this Text_t's "font-weight" attribute is set. More...

int	Text_isSetTextAnchor (const Text_t *t)
	Predicate returning `1` (true) if this Text_t's "text-anchor" attribute is set. More...

int	Text_isSetVTextAnchor (const Text_t *t)
	Predicate returning `1` (true) if this Text_t's "vtext-anchor" attribute is set. More...

int	Text_isSetX (const Text_t *t)
	Predicate returning `1` (true) if this Text_t's "x" element is set. More...

int	Text_isSetY (const Text_t *t)
	Predicate returning `1` (true) if this Text_t's "y" element is set. More...

int	Text_isSetZ (const Text_t *t)
	Predicate returning `1` (true) if this Text_t's "z" element is set. More...

int	Text_setFontFamily (Text_t t, const char fontFamily)
	Sets the value of the "font-family" attribute of this Text_t. More...

int	Text_setFontSize (Text_t t, const RelAbsVector_t fontSize)
	Sets the value of the "font-size" element of this Text_t. More...

int	Text_setFontStyle (Text_t *t, FontStyle_t fontStyle)
	Sets the value of the "font-style" attribute of this Text_t. More...

int	Text_setFontStyleAsString (Text_t t, const char fontStyle)
	Sets the value of the "font-style" attribute of this Text_t. More...

int	Text_setFontWeight (Text_t *t, FontWeight_t fontWeight)
	Sets the value of the "font-weight" attribute of this Text_t. More...

int	Text_setFontWeightAsString (Text_t t, const char fontWeight)
	Sets the value of the "font-weight" attribute of this Text_t. More...

int	Text_setTextAnchor (Text_t *t, HTextAnchor_t textAnchor)
	Sets the value of the "text-anchor" attribute of this Text_t. More...

int	Text_setTextAnchorAsString (Text_t t, const char textAnchor)
	Sets the value of the "text-anchor" attribute of this Text_t. More...

int	Text_setVTextAnchor (Text_t *t, VTextAnchor_t vtextAnchor)
	Sets the value of the "vtext-anchor" attribute of this Text_t. More...

int	Text_setVTextAnchorAsString (Text_t t, const char vtextAnchor)
	Sets the value of the "vtext-anchor" attribute of this Text_t. More...

int	Text_setX (Text_t t, const RelAbsVector_t x)
	Sets the value of the "x" element of this Text_t. More...

int	Text_setY (Text_t t, const RelAbsVector_t y)
	Sets the value of the "y" element of this Text_t. More...

int	Text_setZ (Text_t t, const RelAbsVector_t z)
	Sets the value of the "z" element of this Text_t. More...

int	Text_unsetFontFamily (Text_t *t)
	Unsets the value of the "font-family" attribute of this Text_t. More...

int	Text_unsetFontSize (Text_t *t)
	Unsets the value of the "font-size" element of this Text_t. More...

int	Text_unsetFontStyle (Text_t *t)
	Unsets the value of the "font-style" attribute of this Text_t. More...

int	Text_unsetFontWeight (Text_t *t)
	Unsets the value of the "font-weight" attribute of this Text_t. More...

int	Text_unsetTextAnchor (Text_t *t)
	Unsets the value of the "text-anchor" attribute of this Text_t. More...

int	Text_unsetVTextAnchor (Text_t *t)
	Unsets the value of the "vtext-anchor" attribute of this Text_t. More...

int	Text_unsetX (Text_t *t)
	Unsets the value of the "x" element of this Text_t. More...

int	Text_unsetY (Text_t *t)
	Unsets the value of the "y" element of this Text_t. More...

int	Text_unsetZ (Text_t *t)
	Unsets the value of the "z" element of this Text_t. More...

Member Function Documentation

Text_t * Text_clone ( const Text_t * t )

Creates and returns a deep copy of this Text_t object.

Parameters

t	the Text_t structure.

Returns: a (deep) copy of this Text_t object.

Warning: The pointer that is returned by this function is owned by the caller, who is responsible for deleting it. Any changes made to the element will not be reflected in any resulting SBML document unless the element is added to an SBML Document. Even in this case, the element's deletion is still the responsibility of the caller with two exceptions: if it is used as the "disownedItem" in the ListOf_appendAndOwn() or ListOf_insertAndOwn() functions. All other functions in libsbml add a copy of the element, and do not transfer ownership of the pointer.

Text_t * Text_create	(	unsigned int	level,
		unsigned int	version,
		unsigned int	pkgVersion
	)

Creates a new Text_t using the given SBML Level, Version and “render” package version.

Parameters

level	an unsigned int, the SBML Level to assign to this Text_t.
version	an unsigned int, the SBML Version to assign to this Text_t.
pkgVersion	an unsigned int, the SBML Render Version to assign to this Text_t.

Note: Attempting to add an object to an SBMLDocument_t having a different combination of SBML Level, Version and XML namespaces than the object itself will result in an error at the time a caller attempts to make the addition. A parent object must have compatible Level, Version and XML namespaces. (Strictly speaking, a parent may also have more XML namespaces than a child, but the reverse is not permitted.) The restriction is necessary to ensure that an SBML model has a consistent overall structure. This requires callers to manage their objects carefully, but the benefit is increased flexibility in how models can be created by permitting callers to create objects bottom-up if desired. In situations where objects are not yet attached to parents (e.g., SBMLDocument_t), knowledge of the intented SBML Level and Version help libSBML determine such things as whether it is valid to assign a particular value to an attribute. For packages, this means that the parent object to which this package element is being added must have been created with the package namespace, or that the package namespace was added to it, even if that parent is not a package object itself.

Warning: The pointer that is returned by this function is owned by the caller, who is responsible for deleting it. Any changes made to the element will not be reflected in any resulting SBML document unless the element is added to an SBML Document. Even in this case, the element's deletion is still the responsibility of the caller with two exceptions: if it is used as the "disownedItem" in the ListOf_appendAndOwn() or ListOf_insertAndOwn() functions. All other functions in libsbml add a copy of the element, and do not transfer ownership of the pointer.

void Text_free ( Text_t * t )

Frees this Text_t object.

Parameters

t	the Text_t structure.

char * Text_getFontFamily ( const Text_t * t )

Returns the value of the "font-family" attribute of this Text_t.

Parameters

t	the Text_t structure whose font-family is sought.

Returns: the value of the "font-family" attribute of this Text_t as a pointer to a string.

Warning: The string returned by this function is owned by the caller, who is responsible for deleting it. Any changes made to the string will not be reflected in any resulting SBML document unless the string is added to an SBML Document. Even in this case, the string should be deleted, as adding a string to an SBML Document adds a copy of the string, and does not transfer ownership of that string.

RelAbsVector_t * Text_getFontSize ( const Text_t * t )

Returns the value of the "font-size" element of this Text_t.

Parameters

t	the Text_t structure whose font-size is sought.

Returns: the value of the "font-size" element of this Text_t as a RelAbsVector_t.

FontStyle_t Text_getFontStyle ( const Text_t * t )

Returns the value of the "font-style" attribute of this Text_t.

The attribute "font-style" is used to specify whether the text is to be "normal" or "italic". If omitted, the text may be rendered in either way. In the SBML Level 3 Version 1 Render specification, the following are the allowable values for "font-style":

"italic", slanted print
"normal", upright print

Parameters

t	the Text_t structure whose font-style is sought.

Returns

the value of the "font-style" attribute of this Text_t as a FontStyle_t. The possible values returned by this method are:

char * Text_getFontStyleAsString ( const Text_t * t )

Returns the value of the "font-style" attribute of this Text_t.

The attribute "font-style" is used to specify whether the text is to be "normal" or "italic". If omitted, the text may be rendered in either way. In the SBML Level 3 Version 1 Render specification, the following are the allowable values for "font-style":

"italic", slanted print
"normal", upright print

Parameters

t	the Text_t structure whose font-style is sought.

Returns

the value of the "font-style" attribute of this Text_t as a const char *. The possible values returned by this method are:

"italic"
"normal"
"(Unknown FontStyle value)"

Note: The string returned by this function is a pointer to a string literal defined in the libSBML library, and may not be modified or deleted.

FontWeight_t Text_getFontWeight ( const Text_t * t )

Returns the value of the "font-weight" attribute of this Text_t.

The attribute "font-weight" is used to specify whether the text is to be "normal" or "bold". If omitted, the text may be rendered in either way. In the SBML Level 3 Version 1 Render specification, the following are the allowable values for "font-weight":

"bold", darker and/or thicker than normal print.
"normal", the typical print weight; lighter and/or thinner than "bold".

Parameters

t	the Text_t structure whose font-weight is sought.

Returns

the value of the "font-weight" attribute of this Text_t as a FontWeight_t. The possible values returned by this method are:

char * Text_getFontWeightAsString ( const Text_t * t )

Returns the value of the "font-weight" attribute of this Text_t.

The attribute "font-weight" is used to specify whether the text is to be "normal" or "bold". If omitted, the text may be rendered in either way. In the SBML Level 3 Version 1 Render specification, the following are the allowable values for "font-weight":

"bold", darker and/or thicker than normal print.
"normal", the typical print weight; lighter and/or thinner than "bold".

Parameters

t	the Text_t structure whose font-weight is sought.

Returns

the value of the "font-weight" attribute of this Text_t as a const char *. The possible values returned by this method are:

"bold"
"normal"
"(Unknown FontWeight value)"

Note: The string returned by this function is a pointer to a string literal defined in the libSBML library, and may not be modified or deleted.

HTextAnchor_t Text_getTextAnchor ( const Text_t * t )

Returns the value of the "text-anchor" attribute of this Text_t.

The attribute "text-anchor" is used to specify the horizontal alignment of the text. If omitted, the text may be aligned in any way. In the SBML Level 3 Version 1 Render specification, the following are the allowable values for "text-anchor":

"start", the start of the text is aligned to the horizontal center of the box.
"middle", the horizontal center of the text is aligned to the horizontal center of the box.
"end", the end of the text is aligned to the horizontal center of the box.

Parameters

t	the Text_t structure whose text-anchor is sought.

Returns

the value of the "text-anchor" attribute of this Text_t as a HTextAnchor_t. The possible values returned by this method are:

char * Text_getTextAnchorAsString ( const Text_t * t )

Returns the value of the "text-anchor" attribute of this Text_t.

The attribute "text-anchor" is used to specify the horizontal alignment of the text. If omitted, the text may be aligned in any way. In the SBML Level 3 Version 1 Render specification, the following are the allowable values for "text-anchor":

"start", the start of the text is aligned to the horizontal center of the box.
"middle", the horizontal center of the text is aligned to the horizontal center of the box.
"end", the end of the text is aligned to the horizontal center of the box.

Parameters

t	the Text_t structure whose text-anchor is sought.

Returns

the value of the "text-anchor" attribute of this Text_t as a const char *. The possible values returned by this method are:

"start"
"middle"
"end"
"(Unknown HTextAnchor value)"

Note: The string returned by this function is a pointer to a string literal defined in the libSBML library, and may not be modified or deleted.

VTextAnchor_t Text_getVTextAnchor ( const Text_t * t )

Returns the value of the "vtext-anchor" attribute of this Text_t.

The attribute "vtext-anchor" is used to specify the vertical alignment of the text. If omitted, the text may be aligned in any way. In the SBML Level 3 Version 1 Render specification, the following are the allowable values for "vtext-anchor":

"top", the top of the text is aligned to the vertical center of the box.
"middle", the vertical center of the text is aligned with the vertical center of the box.
"bottom", the bottom of the text (i.e. the very bottom of any descending letter like 'y' or 'p') is aligned with the vertical center of the box.
"baseline", the baseline of the text (i.e. the bottom of any non-descending letter like 'a' or e') is aligned with the vertical center of the box.

Parameters

t	the Text_t structure whose vtext-anchor is sought.

Returns

the value of the "vtext-anchor" attribute of this Text_t as a VTextAnchor_t. The possible values returned by this method are:

char * Text_getVTextAnchorAsString ( const Text_t * t )

Returns the value of the "vtext-anchor" attribute of this Text_t.

The attribute "vtext-anchor" is used to specify the vertical alignment of the text. If omitted, the text may be aligned in any way. In the SBML Level 3 Version 1 Render specification, the following are the allowable values for "vtext-anchor":

"top", the top of the text is aligned to the vertical center of the box.
"middle", the vertical center of the text is aligned with the vertical center of the box.
"bottom", the bottom of the text (i.e. the very bottom of any descending letter like 'y' or 'p') is aligned with the vertical center of the box.
"baseline", the baseline of the text (i.e. the bottom of any non-descending letter like 'a' or e') is aligned with the vertical center of the box.

Parameters

t	the Text_t structure whose vtext-anchor is sought.

Returns

the value of the "vtext-anchor" attribute of this Text_t as a const char *. The possible values returned by this method are:

"top"
"middle"
"bottom"
"baseline"
"(Unknown VTextAnchor value)"

Note: The string returned by this function is a pointer to a string literal defined in the libSBML library, and may not be modified or deleted.

RelAbsVector_t * Text_getX ( const Text_t * t )

Returns the value of the "x" element of this Text_t.

Parameters

t	the Text_t structure whose x is sought.

Returns: the value of the "x" element of this Text_t as a RelAbsVector_t.

RelAbsVector_t * Text_getY ( const Text_t * t )

Returns the value of the "y" element of this Text_t.

Parameters

t	the Text_t structure whose y is sought.

Returns: the value of the "y" element of this Text_t as a RelAbsVector_t.

RelAbsVector_t * Text_getZ ( const Text_t * t )

Returns the value of the "z" element of this Text_t.

Parameters

t	the Text_t structure whose z is sought.

Returns: the value of the "z" element of this Text_t as a RelAbsVector_t.

int Text_hasRequiredAttributes ( const Text_t * t )

Predicate returning 1 (true) if all the required attributes for this Text_t object have been set.

Parameters

t	the Text_t structure.

Returns: 1 (true) to indicate that all the required attributes of this Text_t have been set, otherwise 0 (false) is returned.

Note

The required attributes for the Text_t object are:

"x"
"y"

int Text_isSetFontFamily ( const Text_t * t )

Predicate returning 1 (true) if this Text_t's "font-family" attribute is set.

Parameters

t	the Text_t structure.

Returns: 1 (true) if this Text_t's "font-family" attribute has been set, otherwise 0 (false) is returned.

int Text_isSetFontSize ( const Text_t * t )

Predicate returning 1 (true) if this Text_t's "font-size" element is set.

Parameters

t	the Text_t structure.

Returns: 1 (true) if this Text_t's "font-size" element has been set, otherwise 0 (false) is returned.

int Text_isSetFontStyle ( const Text_t * t )

Predicate returning 1 (true) if this Text_t's "font-style" attribute is set.

The attribute "font-style" is used to specify whether the text is to be "normal" or "italic". If omitted, the text may be rendered in either way. In the SBML Level 3 Version 1 Render specification, the following are the allowable values for "font-style":

"italic", slanted print
"normal", upright print

Parameters

t	the Text_t structure.

Returns: 1 (true) if this Text_t's "font-style" attribute has been set, otherwise 0 (false) is returned.

int Text_isSetFontWeight ( const Text_t * t )

Predicate returning 1 (true) if this Text_t's "font-weight" attribute is set.

The attribute "font-weight" is used to specify whether the text is to be "normal" or "bold". If omitted, the text may be rendered in either way. In the SBML Level 3 Version 1 Render specification, the following are the allowable values for "font-weight":

"bold", darker and/or thicker than normal print.
"normal", the typical print weight; lighter and/or thinner than "bold".

Parameters

t	the Text_t structure.

Returns: 1 (true) if this Text_t's "font-weight" attribute has been set, otherwise 0 (false) is returned.

int Text_isSetTextAnchor ( const Text_t * t )

Predicate returning 1 (true) if this Text_t's "text-anchor" attribute is set.

The attribute "text-anchor" is used to specify the horizontal alignment of the text. If omitted, the text may be aligned in any way. In the SBML Level 3 Version 1 Render specification, the following are the allowable values for "text-anchor":

"start", the start of the text is aligned to the horizontal center of the box.
"middle", the horizontal center of the text is aligned to the horizontal center of the box.
"end", the end of the text is aligned to the horizontal center of the box.

Parameters

t	the Text_t structure.

Returns: 1 (true) if this Text_t's "text-anchor" attribute has been set, otherwise 0 (false) is returned.

int Text_isSetVTextAnchor ( const Text_t * t )

Predicate returning 1 (true) if this Text_t's "vtext-anchor" attribute is set.

The attribute "vtext-anchor" is used to specify the vertical alignment of the text. If omitted, the text may be aligned in any way. In the SBML Level 3 Version 1 Render specification, the following are the allowable values for "vtext-anchor":

"top", the top of the text is aligned to the vertical center of the box.
"middle", the vertical center of the text is aligned with the vertical center of the box.
"bottom", the bottom of the text (i.e. the very bottom of any descending letter like 'y' or 'p') is aligned with the vertical center of the box.
"baseline", the baseline of the text (i.e. the bottom of any non-descending letter like 'a' or e') is aligned with the vertical center of the box.

Parameters

t	the Text_t structure.

Returns: 1 (true) if this Text_t's "vtext-anchor" attribute has been set, otherwise 0 (false) is returned.

int Text_isSetX ( const Text_t * t )

Predicate returning 1 (true) if this Text_t's "x" element is set.

Parameters

t	the Text_t structure.

Returns: 1 (true) if this Text_t's "x" element has been set, otherwise 0 (false) is returned.

int Text_isSetY ( const Text_t * t )

Predicate returning 1 (true) if this Text_t's "y" element is set.

Parameters

t	the Text_t structure.

Returns: 1 (true) if this Text_t's "y" element has been set, otherwise 0 (false) is returned.

int Text_isSetZ ( const Text_t * t )

Predicate returning 1 (true) if this Text_t's "z" element is set.

Parameters

t	the Text_t structure.

Returns: 1 (true) if this Text_t's "z" element has been set, otherwise 0 (false) is returned.

int Text_setFontFamily	(	Text_t *	t,
		const char *	fontFamily
	)

Sets the value of the "font-family" attribute of this Text_t.

Parameters

t	the Text_t structure.
fontFamily	const char * value of the "font-family" attribute to be set. Calling this function with `fontFamily` = `NULL` or an empty string is equivalent to calling Text_unsetFontFamily().

Returns

integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:

int Text_setFontSize	(	Text_t *	t,
		const RelAbsVector_t *	fontSize
	)

Sets the value of the "font-size" element of this Text_t.

Parameters

t	the Text_t structure.
fontSize	RelAbsVector_t value of the "font-size" element to be set.

Returns

integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:

int Text_setFontStyle	(	Text_t *	t,
		FontStyle_t	fontStyle
	)

Sets the value of the "font-style" attribute of this Text_t.

The attribute "font-style" is used to specify whether the text is to be "normal" or "italic". If omitted, the text may be rendered in either way. In the SBML Level 3 Version 1 Render specification, the following are the allowable values for "font-style":

"italic", slanted print
"normal", upright print

Parameters

t	the Text_t structure.
fontStyle	FontStyle_t value of the "font-style" attribute to be set.

Returns

integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:

int Text_setFontStyleAsString	(	Text_t *	t,
		const char *	fontStyle
	)

Sets the value of the "font-style" attribute of this Text_t.

The attribute "font-style" is used to specify whether the text is to be "normal" or "italic". If omitted, the text may be rendered in either way. In the SBML Level 3 Version 1 Render specification, the following are the allowable values for "font-style":

"italic", slanted print
"normal", upright print

Parameters

t	the Text_t structure.
fontStyle	const char * of the "font-style" attribute to be set.

Returns

integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:

int Text_setFontWeight	(	Text_t *	t,
		FontWeight_t	fontWeight
	)

Sets the value of the "font-weight" attribute of this Text_t.

The attribute "font-weight" is used to specify whether the text is to be "normal" or "bold". If omitted, the text may be rendered in either way. In the SBML Level 3 Version 1 Render specification, the following are the allowable values for "font-weight":

"bold", darker and/or thicker than normal print.
"normal", the typical print weight; lighter and/or thinner than "bold".

Parameters

t	the Text_t structure.
fontWeight	FontWeight_t value of the "font-weight" attribute to be set.

Returns

integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:

int Text_setFontWeightAsString	(	Text_t *	t,
		const char *	fontWeight
	)

Sets the value of the "font-weight" attribute of this Text_t.

The attribute "font-weight" is used to specify whether the text is to be "normal" or "bold". If omitted, the text may be rendered in either way. In the SBML Level 3 Version 1 Render specification, the following are the allowable values for "font-weight":

"bold", darker and/or thicker than normal print.
"normal", the typical print weight; lighter and/or thinner than "bold".

Parameters

t	the Text_t structure.
fontWeight	const char * of the "font-weight" attribute to be set.

Returns

integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:

int Text_setTextAnchor	(	Text_t *	t,
		HTextAnchor_t	textAnchor
	)

Sets the value of the "text-anchor" attribute of this Text_t.

The attribute "text-anchor" is used to specify the horizontal alignment of the text. If omitted, the text may be aligned in any way. In the SBML Level 3 Version 1 Render specification, the following are the allowable values for "text-anchor":

"start", the start of the text is aligned to the horizontal center of the box.
"middle", the horizontal center of the text is aligned to the horizontal center of the box.
"end", the end of the text is aligned to the horizontal center of the box.

Parameters

t	the Text_t structure.
textAnchor	HTextAnchor_t value of the "text-anchor" attribute to be set.

Returns

integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:

int Text_setTextAnchorAsString	(	Text_t *	t,
		const char *	textAnchor
	)

Sets the value of the "text-anchor" attribute of this Text_t.

The attribute "text-anchor" is used to specify the horizontal alignment of the text. If omitted, the text may be aligned in any way. In the SBML Level 3 Version 1 Render specification, the following are the allowable values for "text-anchor":

"start", the start of the text is aligned to the horizontal center of the box.
"middle", the horizontal center of the text is aligned to the horizontal center of the box.
"end", the end of the text is aligned to the horizontal center of the box.

Parameters

t	the Text_t structure.
textAnchor	const char * of the "text-anchor" attribute to be set.

Returns

integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:

int Text_setVTextAnchor	(	Text_t *	t,
		VTextAnchor_t	vtextAnchor
	)

Sets the value of the "vtext-anchor" attribute of this Text_t.

The attribute "vtext-anchor" is used to specify the vertical alignment of the text. If omitted, the text may be aligned in any way. In the SBML Level 3 Version 1 Render specification, the following are the allowable values for "vtext-anchor":

"top", the top of the text is aligned to the vertical center of the box.
"middle", the vertical center of the text is aligned with the vertical center of the box.
"bottom", the bottom of the text (i.e. the very bottom of any descending letter like 'y' or 'p') is aligned with the vertical center of the box.
"baseline", the baseline of the text (i.e. the bottom of any non-descending letter like 'a' or e') is aligned with the vertical center of the box.

Parameters

t	the Text_t structure.
vtextAnchor	VTextAnchor_t value of the "vtext-anchor" attribute to be set.

Returns

integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:

int Text_setVTextAnchorAsString	(	Text_t *	t,
		const char *	vtextAnchor
	)

Sets the value of the "vtext-anchor" attribute of this Text_t.

The attribute "vtext-anchor" is used to specify the vertical alignment of the text. If omitted, the text may be aligned in any way. In the SBML Level 3 Version 1 Render specification, the following are the allowable values for "vtext-anchor":

"top", the top of the text is aligned to the vertical center of the box.
"middle", the vertical center of the text is aligned with the vertical center of the box.
"bottom", the bottom of the text (i.e. the very bottom of any descending letter like 'y' or 'p') is aligned with the vertical center of the box.
"baseline", the baseline of the text (i.e. the bottom of any non-descending letter like 'a' or e') is aligned with the vertical center of the box.

Parameters

t	the Text_t structure.
vtextAnchor	const char * of the "vtext-anchor" attribute to be set.

Returns

integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:

int Text_setX	(	Text_t *	t,
		const RelAbsVector_t *	x
	)

Sets the value of the "x" element of this Text_t.

Parameters

t	the Text_t structure.
x	RelAbsVector_t value of the "x" element to be set.

Returns

integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:

int Text_setY	(	Text_t *	t,
		const RelAbsVector_t *	y
	)

Sets the value of the "y" element of this Text_t.

Parameters

t	the Text_t structure.
y	RelAbsVector_t value of the "y" element to be set.

Returns

integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:

int Text_setZ	(	Text_t *	t,
		const RelAbsVector_t *	z
	)

Sets the value of the "z" element of this Text_t.

Parameters

t	the Text_t structure.
z	RelAbsVector_t value of the "z" element to be set.

Returns

integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:

int Text_unsetFontFamily ( Text_t * t )

Unsets the value of the "font-family" attribute of this Text_t.

Parameters

t	the Text_t structure.

Returns

integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:

int Text_unsetFontSize ( Text_t * t )

Unsets the value of the "font-size" element of this Text_t.

Parameters

t	the Text_t structure.

Returns

integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:

int Text_unsetFontStyle ( Text_t * t )

Unsets the value of the "font-style" attribute of this Text_t.

The attribute "font-style" is used to specify whether the text is to be "normal" or "italic". If omitted, the text may be rendered in either way. In the SBML Level 3 Version 1 Render specification, the following are the allowable values for "font-style":

"italic", slanted print
"normal", upright print

Parameters

t	the Text_t structure.

Returns

integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:

int Text_unsetFontWeight ( Text_t * t )

Unsets the value of the "font-weight" attribute of this Text_t.

The attribute "font-weight" is used to specify whether the text is to be "normal" or "bold". If omitted, the text may be rendered in either way. In the SBML Level 3 Version 1 Render specification, the following are the allowable values for "font-weight":

"bold", darker and/or thicker than normal print.
"normal", the typical print weight; lighter and/or thinner than "bold".

Parameters

t	the Text_t structure.

Returns

integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:

int Text_unsetTextAnchor ( Text_t * t )

Unsets the value of the "text-anchor" attribute of this Text_t.

The attribute "text-anchor" is used to specify the horizontal alignment of the text. If omitted, the text may be aligned in any way. In the SBML Level 3 Version 1 Render specification, the following are the allowable values for "text-anchor":

"start", the start of the text is aligned to the horizontal center of the box.
"middle", the horizontal center of the text is aligned to the horizontal center of the box.
"end", the end of the text is aligned to the horizontal center of the box.

Parameters

t	the Text_t structure.

Returns

integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:

int Text_unsetVTextAnchor ( Text_t * t )

Unsets the value of the "vtext-anchor" attribute of this Text_t.

The attribute "vtext-anchor" is used to specify the vertical alignment of the text. If omitted, the text may be aligned in any way. In the SBML Level 3 Version 1 Render specification, the following are the allowable values for "vtext-anchor":

"top", the top of the text is aligned to the vertical center of the box.
"middle", the vertical center of the text is aligned with the vertical center of the box.
"bottom", the bottom of the text (i.e. the very bottom of any descending letter like 'y' or 'p') is aligned with the vertical center of the box.
"baseline", the baseline of the text (i.e. the bottom of any non-descending letter like 'a' or e') is aligned with the vertical center of the box.

Parameters

t	the Text_t structure.

Returns

integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:

int Text_unsetX ( Text_t * t )

Unsets the value of the "x" element of this Text_t.

Parameters

t	the Text_t structure.

Returns

integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:

int Text_unsetY ( Text_t * t )

Unsets the value of the "y" element of this Text_t.

Parameters

t	the Text_t structure.

Returns

integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:

int Text_unsetZ ( Text_t * t )

Unsets the value of the "z" element of this Text_t.

Parameters

t	the Text_t structure.

Returns

integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:

Detailed Description

Public Member Functions

Member Function Documentation