HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | List of all members
GR_UserOption Class Referenceabstract

#include <GR_UserOption.h>

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_DecorVisibility getVisibility () const
 
void setVisibility (GR_DecorVisibility v)
 
void setRefineRequired (bool ref_req)
 
bool isRefineRequired () const
 
void setHidden (bool hide)
 
bool isHidden () const
 
GR_OptionTemplate * getTemplate () const
 
int getVersion () const
 
void bumpVersion ()
 
virtual GR_UserOption * duplicate () const =0
 
virtual int saveCommand (std::ostream &os) const
 
virtual bool loadCommand (UT_IStream &is)
 
virtual bool save (std::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 const char * getAttribute () const
 
virtual int getAttributeType () const
 
virtual fpreal getScale () const
 
virtual bool getArrowTip () const
 
virtual bool getOverrideColor () const
 
virtual UT_Vector3 getColor () const
 
virtual UT_Vector3 getSelectColor () const
 
virtual GR_UserOptionType getOptionType () const
 

Static Public Member Functions

static int saveSettings (std::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)
 
static bool querySetting (const UT_Options &options, const char *name, exint &i)
 

Detailed Description

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

Definition at line 65 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 bool GR_UserOption::applySettings ( const UT_Options &  options)
pure virtual
void GR_UserOption::bumpVersion ( )
inline

Definition at line 98 of file GR_UserOption.h.

virtual GR_UserOption* GR_UserOption::duplicate ( ) const
pure virtual
virtual bool GR_UserOption::getArrowTip ( ) const
inlinevirtual

Definition at line 117 of file GR_UserOption.h.

virtual const char* GR_UserOption::getAttribute ( ) const
inlinevirtual

Definition at line 114 of file GR_UserOption.h.

virtual int GR_UserOption::getAttributeType ( ) const
inlinevirtual

Definition at line 115 of file GR_UserOption.h.

virtual UT_Vector3 GR_UserOption::getColor ( ) const
inlinevirtual

Definition at line 119 of file GR_UserOption.h.

static void GR_UserOption::getDefaultColor ( UT_Vector3 &  clr)
staticprotected
static void GR_UserOption::getDefaultSelColor ( UT_Vector3 &  clr)
staticprotected
const char* GR_UserOption::getIconName ( ) const
inline

Definition at line 77 of file GR_UserOption.h.

const char* GR_UserOption::getLabel ( ) const
inline

Definition at line 75 of file GR_UserOption.h.

const char* GR_UserOption::getName ( ) const
inline
Examples:
GUI/GUI_PolySoupBox.C, and GUI/GUI_PrimFramework.C.

Definition at line 73 of file GR_UserOption.h.

virtual GR_UserOptionType GR_UserOption::getOptionType ( ) const
inlinevirtual

Definition at line 121 of file GR_UserOption.h.

virtual bool GR_UserOption::getOverrideColor ( ) const
inlinevirtual

Definition at line 118 of file GR_UserOption.h.

virtual fpreal GR_UserOption::getScale ( ) const
inlinevirtual

Definition at line 116 of file GR_UserOption.h.

virtual UT_Vector3 GR_UserOption::getSelectColor ( ) const
inlinevirtual

Definition at line 120 of file GR_UserOption.h.

virtual const GR_UserOptionParm* GR_UserOption::getSettingTemplates ( ) const
protectedpure virtual
GR_OptionTemplate* GR_UserOption::getTemplate ( ) const
inline

Definition at line 93 of file GR_UserOption.h.

int GR_UserOption::getVersion ( ) const
inline

Definition at line 97 of file GR_UserOption.h.

GR_DecorVisibility GR_UserOption::getVisibility ( ) const
inline

Definition at line 79 of file GR_UserOption.h.

bool GR_UserOption::isHidden ( ) const
inline

Definition at line 91 of file GR_UserOption.h.

bool GR_UserOption::isRefineRequired ( ) const
inline

Definition at line 86 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,
bool &  v 
)
staticprotected
static bool GR_UserOption::querySetting ( const UT_Options &  options,
const char *  name,
float &  v 
)
staticprotected
static bool GR_UserOption::querySetting ( const UT_Options &  options,
const char *  name,
UT_String &  v 
)
staticprotected
static bool GR_UserOption::querySetting ( const UT_Options &  options,
const char *  name,
UT_Vector3 &  v 
)
staticprotected
static bool GR_UserOption::querySetting ( const UT_Options &  options,
const char *  name,
exint &  i 
)
staticprotected
virtual void GR_UserOption::querySettings ( UT_Options &  options) const
pure virtual
virtual bool GR_UserOption::save ( std::ostream &  os,
int  indent 
) const
virtual
virtual int GR_UserOption::saveCommand ( std::ostream &  os) const
virtual
static int GR_UserOption::saveSettings ( std::ostream &  os,
const UT_Options &  options,
bool  for_cmd 
)
static
void GR_UserOption::setHidden ( bool  hide)
inline

Definition at line 90 of file GR_UserOption.h.

void GR_UserOption::setIconName ( const char *  name)
void GR_UserOption::setLabel ( const char *  label)
inline

Definition at line 76 of file GR_UserOption.h.

void GR_UserOption::setName ( const char *  name)
inline

Definition at line 74 of file GR_UserOption.h.

void GR_UserOption::setRefineRequired ( bool  ref_req)
inline

Definition at line 85 of file GR_UserOption.h.

void GR_UserOption::setVisibility ( GR_DecorVisibility  v)
inline

Definition at line 80 of file GR_UserOption.h.

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