GR_OptionTable Class Reference

#include <GR_OptionTable.h>

Public Member Functions
	GR_OptionTable ()
virtual	~GR_OptionTable ()
void	addTemplate (GR_OptionTemplate *tplate)
int	getNumTemplates () const
GR_OptionTemplate *	getTemplate (int i) const
int	getNumOptions () const
const GR_UserOption *	getOption (int i) const
GR_UserOption *	createOption (const char *type, const char *name, const char *label=NULL)
bool	destroyOption (const char *name)
int	destroyOptionsByPattern (const char *pattern)
bool	renameOption (const char *old_name, const char *new_name, bool notify)
void	optionChanged (const char *name)
GR_UserOption *	getOption (const char *name)
int	getOptionId (const char *name) const
GR_UserOption *	getOptionById (int unique_id)
void	getOptionsByPattern (const char *pattern, UT_ValArray< GR_UserOption * > &l)
UT_NotifierImpl < GR_OptionTableEvent & > &	getEventNotifier ()
void	saveDefaultOptionDefinitions ()
void	loadDefaultOptionDefinitions ()
bool	saveOptions (std::ostream &os, int indent=0) const
	Return true if the save/load was successful, and false otherwise. More...
bool	loadOptions (UT_IStream &is)

Static Public Member Functions
static void	overrideDefinitionFile (const char *filename)

Protected Attributes
UT_ValArray< GR_OptionTemplate * >	myTemplates
UT_SymbolMap< GR_OptionTemplate * >	myTemplateLUT
UT_ValArray< GR_UserOption * >	myOptions
UT_SymbolMap< exint >	myOptionsLUT
UT_ValArray< GR_UserOption * >	myOptionsByID
UT_NotifierImpl < GR_OptionTableEvent & >	myEventNotifier

Detailed Description

Definition at line 43 of file GR_OptionTable.h.

Constructor & Destructor Documentation

GR_OptionTable::GR_OptionTable

(

)

virtual GR_OptionTable::~GR_OptionTable ( )

virtual

Member Function Documentation

void GR_OptionTable::addTemplate

(

GR_OptionTemplate *

tplate

)

GR_UserOption* GR_OptionTable::createOption	(	const char *	type,
		const char *	name,
		const char *	label = NULL
	)

bool GR_OptionTable::destroyOption

(

const char *

name

)

int GR_OptionTable::destroyOptionsByPattern

(

const char *

pattern

)

UT_NotifierImpl<GR_OptionTableEvent &>& GR_OptionTable::getEventNotifier ( )

inline

Returns a notifier that distributes events when options are added, removed or changed.

Definition at line 83 of file GR_OptionTable.h.

int GR_OptionTable::getNumOptions ( ) const

inline

Definition at line 57 of file GR_OptionTable.h.

int GR_OptionTable::getNumTemplates

(

)

const

const GR_UserOption* GR_OptionTable::getOption ( int  i ) const

inline

Examples:

GUI/GUI_PolySoupBox.C, and GUI/GUI_PrimFramework.C.

Definition at line 58 of file GR_OptionTable.h.

GR_UserOption* GR_OptionTable::getOption

(

const char *

name

)

GR_UserOption* GR_OptionTable::getOptionById ( int  unique_id )

inline

Definition at line 70 of file GR_OptionTable.h.

int GR_OptionTable::getOptionId

(

const char *

name

)

const

void GR_OptionTable::getOptionsByPattern	(	const char *	pattern,
		UT_ValArray< GR_UserOption * > &	l
	)

GR_OptionTemplate* GR_OptionTable::getTemplate

(

int

i

)

const

void GR_OptionTable::loadDefaultOptionDefinitions

(

)

bool GR_OptionTable::loadOptions

(

UT_IStream &

is

)

void GR_OptionTable::optionChanged

(

const char *

name

)

static void GR_OptionTable::overrideDefinitionFile ( const char *  filename )

static

bool GR_OptionTable::renameOption	(	const char *	old_name,
		const char *	new_name,
		bool	notify
	)

void GR_OptionTable::saveDefaultOptionDefinitions

(

)

bool GR_OptionTable::saveOptions	(	std::ostream &	os,
		int	indent = 0
	)		const

Return true if the save/load was successful, and false otherwise.

Member Data Documentation

UT_NotifierImpl<GR_OptionTableEvent &> GR_OptionTable::myEventNotifier

protected

Definition at line 112 of file GR_OptionTable.h.

UT_ValArray<GR_UserOption *> GR_OptionTable::myOptions

protected

Definition at line 104 of file GR_OptionTable.h.

UT_ValArray<GR_UserOption *> GR_OptionTable::myOptionsByID

protected

Definition at line 108 of file GR_OptionTable.h.

UT_SymbolMap<exint> GR_OptionTable::myOptionsLUT

protected

Definition at line 105 of file GR_OptionTable.h.

UT_SymbolMap<GR_OptionTemplate *> GR_OptionTable::myTemplateLUT

protected

Definition at line 102 of file GR_OptionTable.h.

UT_ValArray<GR_OptionTemplate *> GR_OptionTable::myTemplates

protected

Definition at line 101 of file GR_OptionTable.h.

---

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

• GR/GR_OptionTable.h