GR_UserOption Class Reference

#include <GR_UserOption.h>

List of all members.

Public Member Functions
	GR_UserOption (const char *name, const char *label, GR_OptionTemplate *entry)
virtual	~GR_UserOption ()
const char *	getName () const
void	setName (const char *name)
const char *	getLabel () const
void	setLabel (const char *label)
const char *	getIconName () const
void	setIconName (const char *name)
GR_OptionTemplate *	getTemplate () const
int	getVersion () const
void	bumpVersion ()
virtual GR_UserOption *	duplicate () const =0
virtual int	saveCommand (ostream &os) const
virtual bool	loadCommand (UT_IStream &is)
virtual bool	save (ostream &os, int indent) const
virtual bool	load (UT_IStream &is)
virtual void	querySettings (UT_Options &options) const =0
virtual bool	applySettings (const UT_Options &options)=0
virtual GR_UserDecoration *	allocDecoration (const GU_Detail *) const
virtual void	freeDecoration (GR_UserDecoration *) const
Static Public Member Functions
static int	saveSettings (ostream &os, const UT_Options &options, bool for_cmd)
static bool	loadSettings (UT_IStream &is, const GR_UserOptionParm *parm_templates, UT_Options &options, bool for_cmd, const char *terminal_token=0)
Protected Member Functions
	GR_UserOption (const GR_UserOption &src)
virtual const GR_UserOptionParm *	getSettingTemplates () const =0
Static Protected Member Functions
static void	getDefaultColor (UT_Vector3 &clr)
static void	getDefaultSelColor (UT_Vector3 &clr)
static bool	querySetting (const UT_Options &options, const char *name, bool &v)
static bool	querySetting (const UT_Options &options, const char *name, float &v)
static bool	querySetting (const UT_Options &options, const char *name, UT_String &v)
static bool	querySetting (const UT_Options &options, const char *name, UT_Vector3 &v)

---

Detailed Description

Definition at line 41 of file GR_UserOption.h.

---

Constructor & Destructor Documentation

GR_UserOption::GR_UserOption	(	const char *	name,
		const char *	label,
		GR_OptionTemplate *	entry
	)

virtual GR_UserOption::~GR_UserOption

(

)

[virtual]

GR_UserOption::GR_UserOption

(

const GR_UserOption &

src

)

[protected]

---

Member Function Documentation

virtual GR_UserDecoration* GR_UserOption::allocDecoration

(

const GU_Detail *

)

const [inline, virtual]

Definition at line 78 of file GR_UserOption.h.

virtual bool GR_UserOption::applySettings

(

const UT_Options &

options

)

[pure virtual]

void GR_UserOption::bumpVersion

(

)

[inline]

Definition at line 61 of file GR_UserOption.h.

virtual GR_UserOption* GR_UserOption::duplicate

(

)

const [pure virtual]

virtual void GR_UserOption::freeDecoration

(

GR_UserDecoration *

)

const [inline, virtual]

Definition at line 80 of file GR_UserOption.h.

static void GR_UserOption::getDefaultColor

(

UT_Vector3 &

clr

)

[static, protected]

static void GR_UserOption::getDefaultSelColor

(

UT_Vector3 &

clr

)

[static, protected]

const char* GR_UserOption::getIconName

(

)

const [inline]

Definition at line 53 of file GR_UserOption.h.

const char* GR_UserOption::getLabel

(

)

const [inline]

Definition at line 51 of file GR_UserOption.h.

const char* GR_UserOption::getName

(

void

)

const [inline]

Definition at line 49 of file GR_UserOption.h.

virtual const GR_UserOptionParm* GR_UserOption::getSettingTemplates

(

)

const [protected, pure virtual]

GR_OptionTemplate* GR_UserOption::getTemplate

(

)

const [inline]

Definition at line 56 of file GR_UserOption.h.

int GR_UserOption::getVersion

(

void

)

const [inline]

Definition at line 60 of file GR_UserOption.h.

virtual bool GR_UserOption::load

(

UT_IStream &

is

)

[virtual]

virtual bool GR_UserOption::loadCommand

(

UT_IStream &

is

)

[virtual]

static bool GR_UserOption::loadSettings	(	UT_IStream &	is,
		const GR_UserOptionParm *	parm_templates,
		UT_Options &	options,
		bool	for_cmd,
		const char *	terminal_token = 0
	)			[static]

static bool GR_UserOption::querySetting	(	const UT_Options &	options,
		const char *	name,
		UT_Vector3 &	v
	)			[static, protected]

static bool GR_UserOption::querySetting	(	const UT_Options &	options,
		const char *	name,
		UT_String &	v
	)			[static, protected]

static bool GR_UserOption::querySetting	(	const UT_Options &	options,
		const char *	name,
		float &	v
	)			[static, protected]

static bool GR_UserOption::querySetting	(	const UT_Options &	options,
		const char *	name,
		bool &	v
	)			[static, protected]

virtual void GR_UserOption::querySettings

(

UT_Options &

options

)

const [pure virtual]

virtual bool GR_UserOption::save	(	ostream &	os,
		int	indent
	)			const [virtual]

virtual int GR_UserOption::saveCommand

(

ostream &

os

)

const [virtual]

static int GR_UserOption::saveSettings	(	ostream &	os,
		const UT_Options &	options,
		bool	for_cmd
	)			[static]

void GR_UserOption::setIconName

(

const char *

name

)

[inline]

Definition at line 54 of file GR_UserOption.h.

void GR_UserOption::setLabel

(

const char *

label

)

[inline]

Definition at line 52 of file GR_UserOption.h.

void GR_UserOption::setName

(

const char *

name

)

[inline]

Definition at line 50 of file GR_UserOption.h.

---

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

• GR/GR_UserOption.h