VOSGUI::Widget Class Reference

MetaObject implementing "gui:widget" Object Type. More...

#include <widget.hh>

Inheritance diagram for VOSGUI::Widget:

List of all members.

Public Member Functions

• Widget (MetaObject *superobject)

  Constructor.
  
  

• virtual const string getType ()

  Return type string ("gui:widget").
  
  

• virtual ~Widget ()

  Destructor.
  
  

• virtual void setPropertyAccessControl (PropertyAccessControl *ac)

  Set default access control policy.
  
  

• virtual PropertyAccessControl * getPropertyAccessControl ()

  Get default access control policy.
  
  

• virtual void initialize (PropertyAccessControl *ac)

  Initialize required subproperties with given access control and set that as the default.
  
  

• virtual void initialize ()

  Initialize required subproperties.
  
  

Access Subobjects

• virtual string getAlignment ()

  Get the value of gui:alignment property.
  
  

• virtual int getPadding ()

  Get the value of gui:padding property.
  
  

• virtual int getProportion ()

  Get the value of the gui:proportion property.
  
  

• virtual void setAlignment (const string &value, PropertyAccessControl *ac=0)

  Set alignment property.
  
  

• virtual void setPadding (int value, PropertyAccessControl *ac=0)

  Set gui:padding property.
  
  

• virtual void setProportion (int value, PropertyAccessControl *ac=0)

  Set the gui:proportion value.
  
  

• virtual string getLabel ()

  Get gui:label property.
  
  

• virtual void setLabel (const string &value, const string &datatype="text/plain", PropertyAccessControl *ac=0)

  Set gui:label property.
  
  

• virtual void setLabelObj (Property *newobj)

  Set Vobject for the gui:label property.
  
  

• virtual string getLabelDatatype ()

  Get datatype for label property.
  
  

• virtual Property * getLabelObj ()

  Get Vobject for the gui:label property.
  
  

• virtual void setEnabled (bool q=true, PropertyAccessControl *defaultAC=&NoPropertyAccessControl::static_)

  Set enabled or disabled ("dimmed").
  
  

• virtual bool getEnabled ()

  Get enabled or disabled.
  
  

• virtual void setEnabledObj (Property *obj)

  Set enabled or disabled object.
  
  

• virtual Property * getEnabledObj ()

  Get enabled or disabled object.
  
  

• virtual void setVisible (bool q=true, PropertyAccessControl *defaultAC=&NoPropertyAccessControl::static_)

  Set visible.
  
  

• virtual bool getVisible ()

  Get visible.
  
  

• virtual void setVisibleObj (Property *obj)

  Set visible property object.
  
  

• virtual Property * getVisibleObj ()

  Get visible property object.
  
  

Static Public Member Functions

• void registerExtenders ()

  Register Extenders.
  
  

Protected Member Functions

• void setOrInsertChild (const string &name, Vobject *obj)

Protected Attributes

• PropertyAccessControl * accessControl

---

Detailed Description

MetaObject implementing "gui:widget" Object Type.

Definition at line 45 of file widget.hh.

---

Constructor & Destructor Documentation

Widget::Widget (  MetaObject *  superobject  )

Constructor. Definition at line 27 of file widget.cc.

Widget::~Widget (   )  [virtual]

Destructor. Definition at line 31 of file widget.cc.

---

Member Function Documentation

string Widget::getAlignment (   )  [virtual]

Get the value of gui:alignment property. Definition at line 85 of file widget.cc.

bool Widget::getEnabled (   )  [virtual]

Get enabled or disabled. Definition at line 216 of file widget.cc.

Property * Widget::getEnabledObj (   )  [virtual]

Get enabled or disabled object. Definition at line 229 of file widget.cc.

string Widget::getLabel (   )  [virtual]

Get gui:label property. Exceptions: Vobject::NoSuchObjectError  if there is no label property. bad_cast  if "gui:label" is not a property. Definition at line 128 of file widget.cc. Referenced by VOSChatGUI::AvatarList::setup().

string Widget::getLabelDatatype (   )  [virtual]

Get datatype for label property. Definition at line 183 of file widget.cc.

Property * Widget::getLabelObj (   )  [virtual]

Get Vobject for the gui:label property. Exceptions: Vobject::NoSuchObjectError  if no label object exists bad_cast  if the label object is not a property. Definition at line 179 of file widget.cc.

int Widget::getPadding (   )  [virtual]

Get the value of gui:padding property. Definition at line 98 of file widget.cc.

PropertyAccessControl * Widget::getPropertyAccessControl (   )  [virtual]

Get default access control policy. Definition at line 40 of file widget.cc.

int Widget::getProportion (   )  [virtual]

Get the value of the gui:proportion property. Definition at line 113 of file widget.cc.

const string Widget::getType (   )  [virtual]

Return type string ("gui:widget"). Reimplemented in VOSGUI::Button, VOSGUI::Container, VOSGUI::Input, VOSGUI::ColorInput, VOSGUI::FileInput, VOSGUI::NumericInput, VOSGUI::SliderNumericInput, VOSGUI::Label, VOSGUI::Select, VOSGUI::SelectBoolean, VOSGUI::SelectList, and VOSGUI::SelectValue. Definition at line 69 of file widget.cc.

bool Widget::getVisible (   )  [virtual]

Get visible. Definition at line 237 of file widget.cc.

Property * Widget::getVisibleObj (   )  [virtual]

Get visible property object. Definition at line 250 of file widget.cc.

void Widget::initialize (   )  [virtual]

Initialize required subproperties. If access control has been previously set with initialize(PropertyAccessControl*) or setPropertyAccessControl(), then that policy will be used. Otherwise, NoPropertyAccessControl will be used. Reimplemented in VOSGUI::LocalButton, VOSGUI::SelectList, VOSGUI::LocalSelectList, VOSGUI::SelectValue, and VOSGUI::LocalSelectValue. Definition at line 57 of file widget.cc.

void Widget::initialize (  PropertyAccessControl *  ac  )  [virtual]

Initialize required subproperties with given access control and set that as the default. Reimplemented in VOSGUI::LocalButton, VOSGUI::LocalInput, VOSGUI::LocalSliderNumericInput, and VOSGUI::LocalLabel. Definition at line 51 of file widget.cc.

void Widget::registerExtenders (   )  [static]

Register Extenders. Reimplemented in VOSChatGUI::AvatarList, VOSChatGUI::PrivMsg, VOSGUI::Button, VOSGUI::Container, VOSGUI::Input, VOSGUI::ColorInput, VOSGUI::FileInput, VOSGUI::NumericInput, VOSGUI::SliderNumericInput, VOSGUI::Label, VOSGUI::Select, VOSGUI::SelectBoolean, VOSGUI::SelectList, and VOSGUI::SelectValue. Definition at line 74 of file widget.cc.

void Widget::setAlignment (  const string &  value, PropertyAccessControl *  ac = 0 )  [virtual]

Set alignment property. Parameters: value  Property value. Must be one of the following: center fill expand top bottom left right ac  Access control policy. If omitted, a pointer to NoPropertyAccessControl::static_ will be used. Definition at line 141 of file widget.cc.

void Widget::setEnabled (  bool  q = true, PropertyAccessControl *  defaultAC = &NoPropertyAccessControl::static_ )  [virtual]

Set enabled or disabled ("dimmed"). Definition at line 212 of file widget.cc. Referenced by initialize().

void Widget::setEnabledObj (  Property *  obj  )  [virtual]

Set enabled or disabled object. Definition at line 220 of file widget.cc.

void Widget::setLabel (  const string &  value, const string &  datatype = "text/plain", PropertyAccessControl *  ac = 0 )  [virtual]

Set gui:label property. Definition at line 161 of file widget.cc. Referenced by VOSGUI::LocalLabel::initialize(), VOSGUI::LocalButton::initialize(), and VOSChatGUI::AvatarList::setup().

void Widget::setLabelObj (  Property *  newobj  )  [virtual]

Set Vobject for the gui:label property. Definition at line 167 of file widget.cc.

void Widget::setOrInsertChild (  const string &  name, Vobject *  obj )  [protected]

Definition at line 203 of file widget.cc.

void Widget::setPadding (  int  value, PropertyAccessControl *  ac = 0 )  [virtual]

Set gui:padding property. Parameters: value  The new value ac  Property access control policy. If omitted, then &NoAccessControl::static_ will be used. Definition at line 147 of file widget.cc.

void Widget::setPropertyAccessControl (  PropertyAccessControl *  ac  )  [virtual]

Set default access control policy. Definition at line 36 of file widget.cc. Referenced by initialize().

void Widget::setProportion (  int  value, PropertyAccessControl *  ac = 0 )  [virtual]

Set the gui:proportion value. Parameters: value  the new value ac  Property access control policy. if omitted, then &NoAccessControl::static_ will be used. Definition at line 154 of file widget.cc.

void Widget::setVisible (  bool  q = true, PropertyAccessControl *  defaultAC = &NoPropertyAccessControl::static_ )  [virtual]

Set visible. Definition at line 233 of file widget.cc. Referenced by initialize().

void Widget::setVisibleObj (  Property *  obj  )  [virtual]

Set visible property object. Definition at line 241 of file widget.cc.

---

Member Data Documentation

PropertyAccessControl* VOSGUI::Widget::accessControl [protected]

Definition at line 49 of file widget.hh. Referenced by getPropertyAccessControl(), setAlignment(), VOSGUI::Container::setBorder(), VOSGUI::Container::setCompact(), VOSGUI::NumericInput::setIncrement(), VOSGUI::Button::setIsDefaultButton(), setLabel(), VOSGUI::Label::setLabelToFile(), VOSGUI::Container::setLayout(), VOSGUI::NumericInput::setMaximum(), VOSGUI::NumericInput::setMinimum(), VOSGUI::Input::setMultiline(), VOSGUI::SelectList::setMultiple(), VOSGUI::SliderNumericInput::setOrientation(), setPadding(), setPropertyAccessControl(), setProportion(), VOSGUI::SelectValue::setRadioOrientation(), VOSGUI::SelectValue::setRadioSize(), VOSGUI::SliderNumericInput::setShowLabels(), VOSGUI::SelectValue::setStyle(), VOSGUI::SelectBoolean::setTarget(), and VOSGUI::Input::setTarget().

---

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

• vos/gui/gui/widget.hh
• vos/gui/gui/widget.cc

---