VOSGUI::SelectValue Class Reference

MetaObject implementing SelectValue Object Type. More...

#include <select_value.hh>

Inheritance diagram for VOSGUI::SelectValue:

List of all members.

Public Member Functions

• SelectValue (MetaObject *superobject)

  Constructor.
  
  

• virtual ~SelectValue ()

  Destructor.
  
  

• virtual const std::string getType ()

  Return type string ("gui:widget.select.value").
  
  

• std::string getValue ()

  Get the selected value.
  
  

• void getValue (std::string &v)

  Get the selected value.
  
  

• void setValue (const std::string &v)

  Set the selected value.
  
  

• void add (const std::string &label, Property *property)

  Add a value choice.
  
  

• void add (Property *property)

  Add a value choice.
  
  

• void add (const std::string &label, const std::string &value, PropertyAccessControl *defaultValueAC=&NoPropertyAccessControl::static_)

  Add a value choice.
  
  

• void add (const std::string &value, PropertyAccessControl *defaultValueAC=&NoPropertyAccessControl::static_)

  Add a value choice.
  
  

• void remove (const std::string &value) throw (NoSuchObjectError)

  Remove (the first occurance of) an object from the value.
  
  

• Vobject * getChoicesObj ()

  Return the Vobject containing choices objects.
  
  

• void setChoicesObj (Vobject *obj)

  Set the choices container object.
  
  

• virtual void initialize ()

  Find/create certain subobjects.
  
  

• Property * getSelectedObj ()
• Property * getTargetObj ()

• void setSelectedObj (Property *p)
• void setTargetObj (Property *p)

• void setStyle (const std::string &style, PropertyAccessControl *pac=0)
• void setPopup (PropertyAccessControl *pac=0)
• void setRadio (PropertyAccessControl *pac=0)
• std::string getStyle ()
• Property * getStyleObj ()

• void setRadioOrientation (const std::string &ori, PropertyAccessControl *pac=0)
• std::string getRadioOrientation ()
• void setRadioSize (int n, PropertyAccessControl *pac=0)
• int getRadioSize ()

Static Public Member Functions

• void registerExtenders ()

  Register Extenders.
  
  

Protected Attributes

• vRef< Vobject > choices
• vRef< Property > selected

---

Detailed Description

MetaObject implementing SelectValue Object Type.

This control presents a choice of values for a property, one of which may be selected using a radio button or popup menu.

Todo:

add property specifying order to try determining what text to display in value (e.g. "subobj(misc:title),property-contents,context-name"). or use a value of properties. Or change the choices group to contain small structure objects (linking to label and the actual object)

Warning:

You must call initialize() for this object to work correctly.

Definition at line 51 of file select_value.hh.

---

Constructor & Destructor Documentation

SelectValue::SelectValue (  MetaObject *  superobject  )

Constructor. Definition at line 31 of file select_value.cc.

SelectValue::~SelectValue (   )  [virtual]

Destructor. Definition at line 37 of file select_value.cc.

---

Member Function Documentation

void SelectValue::add (  const std::string &  value, PropertyAccessControl *  defaultValueAC = &NoPropertyAccessControl::static_ )

Add a value choice. Definition at line 101 of file select_value.cc.

void SelectValue::add (  const std::string &  label, const std::string &  value, PropertyAccessControl *  defaultValueAC = &NoPropertyAccessControl::static_ )

Add a value choice. Definition at line 93 of file select_value.cc.

void SelectValue::add (  Property *  property  )

Add a value choice. Definition at line 89 of file select_value.cc.

void SelectValue::add (  const std::string &  label, Property *  property )

Add a value choice. Definition at line 85 of file select_value.cc. Referenced by add().

Vobject * SelectValue::getChoicesObj (   )

Return the Vobject containing choices objects. Definition at line 144 of file select_value.cc.

string SelectValue::getRadioOrientation (   )

Definition at line 178 of file select_value.cc.

int SelectValue::getRadioSize (   )

Definition at line 188 of file select_value.cc.

Property * SelectValue::getSelectedObj (   )

Definition at line 127 of file select_value.cc.

string SelectValue::getStyle (   )

Definition at line 168 of file select_value.cc.

Property * SelectValue::getStyleObj (   )

Definition at line 131 of file select_value.cc.

Property* VOSGUI::SelectValue::getTargetObj (   )  [inline]

Definition at line 76 of file select_value.hh.

const string SelectValue::getType (   )  [virtual]

Return type string ("gui:widget.select.value"). Reimplemented from VOSGUI::Select. Definition at line 58 of file select_value.cc.

void SelectValue::getValue (  std::string &  v  )

Get the selected value. Definition at line 76 of file select_value.cc.

string SelectValue::getValue (   )

Get the selected value. Definition at line 72 of file select_value.cc.

void SelectValue::initialize (   )  [virtual]

Find/create certain subobjects. You MUST call this for things to work correctly. Reimplemented from VOSGUI::Widget. Reimplemented in VOSGUI::LocalSelectValue. Definition at line 221 of file select_value.cc.

void SelectValue::registerExtenders (   )  [static]

Register Extenders. Reimplemented from VOSGUI::Select. Definition at line 63 of file select_value.cc. Referenced by VOSGUI::registerAll().

void SelectValue::remove (  const std::string &  value  )  throw (NoSuchObjectError)

Remove (the first occurance of) an object from the value. Bug: only removes the first occurance of the object. Definition at line 105 of file select_value.cc.

void SelectValue::setChoicesObj (  Vobject *  obj  )

Set the choices container object. Don't call after initialize() or it won't work right. Definition at line 149 of file select_value.cc.

void SelectValue::setPopup (  PropertyAccessControl *  pac = 0  )

Definition at line 160 of file select_value.cc. Referenced by VOSGUI::LocalSelectValue::initialize().

void SelectValue::setRadio (  PropertyAccessControl *  pac = 0  )

Definition at line 164 of file select_value.cc.

void SelectValue::setRadioOrientation (  const std::string &  ori, PropertyAccessControl *  pac = 0 )

Definition at line 172 of file select_value.cc.

void SelectValue::setRadioSize (  int  n, PropertyAccessControl *  pac = 0 )

Definition at line 182 of file select_value.cc.

void SelectValue::setSelectedObj (  Property *  p  )

Definition at line 137 of file select_value.cc.

void SelectValue::setStyle (  const std::string &  style, PropertyAccessControl *  pac = 0 )

Definition at line 155 of file select_value.cc. Referenced by setPopup(), and setRadio().

void VOSGUI::SelectValue::setTargetObj (  Property *  p  )  [inline]

Definition at line 84 of file select_value.hh.

void SelectValue::setValue (  const std::string &  v  )

Set the selected value. Definition at line 80 of file select_value.cc.

---

Member Data Documentation

vRef<Vobject> VOSGUI::SelectValue::choices [protected]

Definition at line 55 of file select_value.hh. Referenced by add(), getChoicesObj(), initialize(), VOSGUI::LocalSelectValue::initialize(), and setChoicesObj().

vRef<Property> VOSGUI::SelectValue::selected [protected]

Definition at line 56 of file select_value.hh. Referenced by getSelectedObj(), getValue(), initialize(), VOSGUI::LocalSelectValue::initialize(), setSelectedObj(), and setValue().

---

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

• vos/gui/gui/select_value.hh
• vos/gui/gui/select_value.cc

---