VOSGUI::Input Class Reference

MetaObject implementing Input Object Type. More...

#include <input.hh>

Inheritance diagram for VOSGUI::Input:

List of all members.

Public Member Functions

• Input (MetaObject *superobject)

  Constructor.
  
  

• virtual ~Input ()

  Destructor.
  
  

• virtual const string getType ()

  Return type string ("gui:widget.input").
  
  

Access Subobjects

• virtual string getTarget ()

  Get the value of gui:target property (The contents/target of the control).
  
  

• virtual string getTargetDatatype ()

  Get the datatype of gui:target property.
  
  

• virtual void setTarget (const string &value, const string &datatype="?", PropertyAccessControl *ac=0)

  Set gui:target property.
  
  

• virtual Property * getTargetObj ()

  Get the gui:target object.
  
  

• virtual void setTargetObj (Property *newobj)

  Set the gui:target object.
  
  

• virtual bool getMultiline ()

  Get the value of gui:multiline property (If the value of this property is "yes", then the input widget may be more than one line tall, and the user may input more than one line (seperated by a newline charater, ASCII value 10).
  
  

• virtual void setMultiline (bool value=true, PropertyAccessControl *ac=0)

  Set gui:multiline property.
  
  

• virtual Property * getMultilineObj ()

  Get the gui:multiline object.
  
  

• virtual void setMultilineObj (Property *newobj)

  Set the gui:multiline object.
  
  

Static Public Member Functions

• void registerExtenders ()

  Register Extenders.
  
  

---

Detailed Description

MetaObject implementing Input Object Type.

A text input widget. May be single or multiline.

Definition at line 47 of file input.hh.

---

Constructor & Destructor Documentation

Input::Input (  MetaObject *  superobject  )

Constructor. Definition at line 32 of file input.cc.

Input::~Input (   )  [virtual]

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

---

Member Function Documentation

bool Input::getMultiline (   )  [virtual]

Get the value of gui:multiline property (If the value of this property is "yes", then the input widget may be more than one line tall, and the user may input more than one line (seperated by a newline charater, ASCII value 10). If absent, a default value of "no" should be used. ). Definition at line 125 of file input.cc.

Property * Input::getMultilineObj (   )  [virtual]

Get the gui:multiline object. Definition at line 135 of file input.cc.

string Input::getTarget (   )  [virtual]

Get the value of gui:target property (The contents/target of the control). Definition at line 87 of file input.cc.

string Input::getTargetDatatype (   )  [virtual]

Get the datatype of gui:target property. Definition at line 96 of file input.cc.

Property * Input::getTargetObj (   )  [virtual]

Get the gui:target object. Definition at line 109 of file input.cc.

const string Input::getType (   )  [virtual]

Return type string ("gui:widget.input"). Reimplemented from VOSGUI::Widget. Reimplemented in VOSGUI::ColorInput, VOSGUI::FileInput, VOSGUI::NumericInput, and VOSGUI::SliderNumericInput. Definition at line 71 of file input.cc.

void Input::registerExtenders (   )  [static]

Register Extenders. Reimplemented from VOSGUI::Widget. Reimplemented in VOSGUI::ColorInput, VOSGUI::FileInput, VOSGUI::NumericInput, and VOSGUI::SliderNumericInput. Definition at line 76 of file input.cc. Referenced by VOSGUI::registerAll().

void Input::setMultiline (  bool  value = true, PropertyAccessControl *  ac = 0 )  [virtual]

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

void Input::setMultilineObj (  Property *  newobj  )  [virtual]

Set the gui:multiline object. Parameters: newobj  The new subobject. Definition at line 141 of file input.cc.

void Input::setTarget (  const string &  value, const string &  datatype = "?", PropertyAccessControl *  ac = 0 )  [virtual]

Set gui:target property. Parameters: value  The new value datatype  The new datatype: if omitted, then the existing datatype will be preserved. ac  Property access control policy. If omitted, then &NoAccessControl::static_ will be used. Definition at line 103 of file input.cc. Referenced by VOSGUI::LocalInput::initialize(), and VOSGUI::NumericInput::setValue().

void Input::setTargetObj (  Property *  newobj  )  [virtual]

Set the gui:target object. Parameters: newobj  The new subobject. Definition at line 115 of file input.cc.

---

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

• vos/gui/gui/input.hh
• vos/gui/gui/input.cc

---