OpenCMISS::Zinc::Fontmodule Class Reference

Module managing all fonts. More...

#include <font.hpp>

Public Member Functions
	Fontmodule (cmzn_fontmodule_id in_fontmodule_id)
	Fontmodule (const Fontmodule &fontModule)
Fontmodule &	operator= (const Fontmodule &fontModule)
bool	isValid () const
cmzn_fontmodule_id	getId () const
Font	createFont ()
Font	findFontByName (const char *name)
int	beginChange ()
int	endChange ()
Font	getDefaultFont ()
int	setDefaultFont (const Font &font)

Protected Attributes
cmzn_fontmodule_id	id

Detailed Description

Module managing all fonts.

Module managing all fonts.

Member Function Documentation

int OpenCMISS::Zinc::Fontmodule::beginChange ( )

inline

Begin caching or increment cache level for this font module. Call this function before making multiple changes to minimise number of change messages sent to clients. Must remember to end change after completing changes. Can be nested.

See also

Fontmodule::endChange

Returns

Status OpenCMISS::Zinc::OK on success, otherwise OpenCMISS::Zinc::ERROR_ARGUMENT.

Font OpenCMISS::Zinc::Fontmodule::createFont ( )

inline

Create and return a new font.

font will belong to.

Returns

Handle to new font, or NULL/invalid handle on failure.

int OpenCMISS::Zinc::Fontmodule::endChange ( )

inline

Decrement cache level or end caching of changes for the font module. Call fontmodule begin change before making multiple changes and call this afterwards. When change level is restored to zero, cached change messages are sent out to clients.

See also

Fontmodule::beginChange

Returns

Status OpenCMISS::Zinc::OK on success, any other value on failure.

Font OpenCMISS::Zinc::Fontmodule::findFontByName ( const char *  name )

inline

Find the font with the specified name, if any.

Parameters

name	The name of the font.

Returns

Handle to font, or NULL/invalid handle if not found or failed.

Font OpenCMISS::Zinc::Fontmodule::getDefaultFont ( )

inline

Get the default font, if any.

Returns

Handle to font, or NULL/invalid handle if none or failed.

cmzn_fontmodule_id OpenCMISS::Zinc::Fontmodule::getId ( ) const

inline

Return the C handle of the Fontmodule object.

Returns

C handle of Fontmodule if this objects is valid, 0 otherwise.

bool OpenCMISS::Zinc::Fontmodule::isValid ( ) const

inline

Check if this is a valid Fontmodule object.

Returns

Status True if object is valid, false otherwise.

int OpenCMISS::Zinc::Fontmodule::setDefaultFont ( const Font &  font )

inline

Set the default font.

Parameters

font	The font to set as default.

Returns

OpenCMISS::Zinc::OK on success otherwise OpenCMISS::Zinc::ERROR_ARGUMENT.

---

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

• auto_comments_output/font.hpp