VOSGUI::Button Class Reference

MetaObject implementing Button Object Type. More...

#include <button.hh>

Inheritance diagram for VOSGUI::Button:

List of all members.

Public Member Functions

• Button (MetaObject *superobject)

  Constructor.
  
  

• virtual ~Button ()

  Destructor.
  
  

• virtual const string getType ()

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

• virtual void push (const string &userid="")=0

  Call on remote objects to indicate a putton press.
  
  

• virtual void setIsDefaultButton (bool v=true, PropertyAccessControl *pac=0)
• virtual bool getIsDefaultButton ()
• virtual void setIsDefaultButtonObj (Property *newobj)
• virtual Property * getIsDefaultButtonObj ()

Static Public Member Functions

• void registerExtenders ()

  Register Extenders.
  
  

---

Detailed Description

MetaObject implementing Button Object Type.

Represents a button component, which sends a message back to the LocalButton when pressed.

Definition at line 42 of file button.hh.

---

Constructor & Destructor Documentation

Button::Button (  MetaObject *  superobject  )

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

Button::~Button (   )  [virtual]

Destructor. Definition at line 35 of file button.cc.

---

Member Function Documentation

bool Button::getIsDefaultButton (   )  [virtual]

Definition at line 83 of file button.cc.

Property * Button::getIsDefaultButtonObj (   )  [virtual]

Definition at line 94 of file button.cc.

const string Button::getType (   )  [virtual]

Return type string ("gui:widget.button"). Reimplemented from VOSGUI::Widget. Definition at line 68 of file button.cc.

virtual void VOSGUI::Button::push (  const string &  userid = ""  )  [pure virtual]

Call on remote objects to indicate a putton press. Local objects will notify listeners (see LocalButton::push). Parameters: userid  If available, this is a string that can be used to identify a particular user. Typically, it will be in the form "user@hostname" or "usertype:someid@hostname" Implemented in VOSGUI::LocalButton, and VOSGUI::RemoteButton.

void Button::registerExtenders (   )  [static]

Register Extenders. Reimplemented from VOSGUI::Widget. Definition at line 73 of file button.cc. Referenced by VOSGUI::registerAll().

void Button::setIsDefaultButton (  bool  v = true, PropertyAccessControl *  pac = 0 )  [virtual]

Use this property to indicate which button you want to be the default. If more than one button has this property set to true, then the client application will choose one (typically the last one it loads.) Changing this property to true will also probably cause already-connected clients to use this button as their new default. Definition at line 87 of file button.cc.

void Button::setIsDefaultButtonObj (  Property *  newobj  )  [virtual]

Definition at line 100 of file button.cc.

---

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

• vos/gui/gui/button.hh
• vos/gui/gui/button.cc

---