GlobalStyle_t Class Reference

Detailed Description

render A style that can be associated with a layout.

Global styles are the style information objects used in GlobalRenderInformation_t. Global styles can be associated with layout objects by role and type, but not by identifier; in other respects, global styles and local styles are equivalent.

Since GlobalStyle_t is derived from Styles, it inherits all of the methods and attributes from Style_t.

See also

GlobalRenderInformation_t

Style_t

Public Member Functions
GlobalStyle_t *	GlobalStyle_clone (const GlobalStyle_t *gs)
	Creates and returns a deep copy of this GlobalStyle_t object. More...
GlobalStyle_t *	GlobalStyle_create (unsigned int level, unsigned int version, unsigned int pkgVersion)
	Creates a new GlobalStyle_t using the given SBML Level, Version and “render” package version. More...
void	GlobalStyle_free (GlobalStyle_t *gs)
	Frees this GlobalStyle_t object. More...
int	GlobalStyle_hasRequiredAttributes (const GlobalStyle_t *gs)
	Predicate returning 1 (true) if all the required attributes for this GlobalStyle_t object have been set. More...

Member Function Documentation

GlobalStyle_t * GlobalStyle_clone

(

const GlobalStyle_t *

gs

)

Creates and returns a deep copy of this GlobalStyle_t object.

Parameters

gs	the GlobalStyle_t structure.

Returns

a (deep) copy of this GlobalStyle_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.

GlobalStyle_t * GlobalStyle_create	(	unsigned int	level,
		unsigned int	version,
		unsigned int	pkgVersion
	)

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

Parameters

level	an unsigned int, the SBML Level to assign to this GlobalStyle_t.
version	an unsigned int, the SBML Version to assign to this GlobalStyle_t.
pkgVersion	an unsigned int, the SBML Render Version to assign to this GlobalStyle_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 GlobalStyle_free

(

GlobalStyle_t *

gs

)

Frees this GlobalStyle_t object.

Parameters

gs	the GlobalStyle_t structure.

int GlobalStyle_hasRequiredAttributes

(

const GlobalStyle_t *

gs

)

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

Parameters

gs	the GlobalStyle_t structure.

Returns

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