All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vrui::coCheckboxMenuItem Class Reference

#include <coCheckboxMenuItem.h>

Inheritance diagram for vrui::coCheckboxMenuItem:
Inheritance graph
Collaboration diagram for vrui::coCheckboxMenuItem:
Collaboration graph

Public Member Functions

 coCheckboxMenuItem (const std::string &name, bool on, coCheckboxGroup *group=0)
virtual ~coCheckboxMenuItem ()
void setState (bool newState, bool generateEvent, bool updateGroup=false)
void setState (bool newState)
bool getState () const
coCheckboxGroupgetGroup ()
int hit (vruiHit *hit)
void miss ()
virtual void selected (bool select)
 MenuItem is selected via joystick. More...
virtual void doActionRelease ()
 Action is called via joystick. More...
virtual const char * getClassName () const
 get the Element's classname More...
virtual bool isOfClassName (const char *) const
 check if the Element or any ancestor is this classname More...
virtual void setActive (bool a)
 functions activates or deactivates the item More...
bool updateContentBool (bool newState)
 set the twin MenuItem More...
- Public Member Functions inherited from vrui::coRowMenuItem
 coRowMenuItem (const std::string &labelString)
 coRowMenuItem (const std::string &symbolicName, const std::string &labelString)
virtual ~coRowMenuItem ()
virtual void setLabel (coLabel *label)
coLabelgetLabel ()
void setLabel (const std::string &labelString)
 this function may be overloaded - it is called by setName() More...
virtual coUIElementgetUIElement ()
- Public Member Functions inherited from vrui::coMenuItem
 coMenuItem (const std::string &name)
virtual ~coMenuItem ()
virtual void setMenuListener (coMenuListener *listener)
virtual coMenuListenergetMenuListener ()
virtual void setParentMenu (coMenu *parent)
virtual void setVisible (bool visible)
virtual bool isVisible () const
virtual void setAttachment (int)
 sets the attachment border More...
virtual const char * getName () const
virtual coMenuItemgetTwin ()
virtual void setTwin (coMenuItem *twin)
 get the twin MenuItem More...
virtual bool updateContentPressed ()
 for boolean state transfers More...
virtual bool updateContentReleased ()
 for boolean state transfers More...
virtual bool updateContentInt (int)
 for boolean state transfers More...
virtual bool updateContentFloat (float)
 for discrete state transfers More...
virtual bool updateContentRange (float, float, float, bool, float)
 for floating point state transfers between fixed boundaries More...
virtual bool updateContentPointer (void *)
coMenugetParentMenu ()
 get my parent menu More...
void setName (const std::string &newName, bool updateTwins=true)
 set my name - items with labels must call this when changing label More...
virtual bool getActive ()
 return if item is active More...
virtual void doActionPress ()
 Action is called via joystick. More...
virtual void doSecondActionPress ()
 second Action for Item More...
virtual void doSecondActionRelease ()
 second Action for Item More...
- Public Member Functions inherited from vrui::coButtonActor
virtual ~coButtonActor ()
- Public Member Functions inherited from vrui::coAction
 coAction ()
 Constructor. More...
virtual ~coAction ()
 Destructor. More...
void setFrame (unsigned int frame)
 INTERNAL set the framecounter (used to produce the miss call) More...
unsigned int getFrame () const
 INTERNAL get the framecounter (used to produce the miss call) More...
void setNode (vruiNode *)
 INTERNAL set the node this action belongs to. More...
void addChild (coAction *)
 INTERNAL add a child action. More...
virtual int hitAll (vruiHit *hit)
 INTERNAL same as miss/hit, but do it for all children as well. More...
virtual void missAll ()
 INTERNAL same as miss/hit, but do it for all children as well. More...

Protected Member Functions

virtual void buttonEvent (coButton *source)

Protected Attributes

 actual button which is used for interaction More...
 checkbox group this checkbox belongs to More...
bool myState
- Protected Attributes inherited from vrui::coRowMenuItem
 container to store menu elements More...
 menu item background which changes its color when menu item is selected More...
 label text More...
- Protected Attributes inherited from vrui::coMenuItem
bool visible
 this menu item More...
 on menu selection More...
std::string myName
 symbolic name, or displayed as label) More...
 pointer to a cloned 'twin' version (toolbar/menu) of this item. On changes the current content state should be forwarded to the twin so it can update is representation to it. (see 'updateContent()' methods) More...
bool active_
 flag if item is active More...
- Protected Attributes inherited from vrui::coAction
std::string actionName

Additional Inherited Members

- Public Types inherited from vrui::coAction
enum  Result { ACTION_DONE = 0x00, ACTION_CALL_ON_MISS = 0x01, ACTION_UNDEF = 0x02 }
- Static Protected Attributes inherited from vrui::coRowMenuItem
static const int LEFTMARGIN
 size of margin at left edge of menu item More...

Detailed Description

Menu item which is usable as a toggle button, a radio button, or a group of toggle buttons. The usage type is detemined by:

Constructor & Destructor Documentation

vrui::coCheckboxMenuItem::coCheckboxMenuItem ( const std::string &  name,
bool  on,
coCheckboxGroup group = 0 
virtual vrui::coCheckboxMenuItem::~coCheckboxMenuItem ( )

Member Function Documentation

virtual void vrui::coCheckboxMenuItem::buttonEvent ( coButton source)

Implements vrui::coButtonActor.

Reimplemented in opencover::coPartnerMenuItem.

virtual void vrui::coCheckboxMenuItem::doActionRelease ( )

Action is called via joystick.

Reimplemented from vrui::coMenuItem.

virtual const char* vrui::coCheckboxMenuItem::getClassName ( ) const

get the Element's classname

Reimplemented from vrui::coRowMenuItem.

coCheckboxGroup* vrui::coCheckboxMenuItem::getGroup ( )
bool vrui::coCheckboxMenuItem::getState ( ) const
int vrui::coCheckboxMenuItem::hit ( vruiHit hit)

hit is called whenever the node, or any node underneath the node with this action is intersected return ACTION_CALL_ON_MISS if you want miss to be called otherwise return ACTION_DONE

Implements vrui::coAction.

virtual bool vrui::coCheckboxMenuItem::isOfClassName ( const char *  ) const

check if the Element or any ancestor is this classname

Reimplemented from vrui::coRowMenuItem.

void vrui::coCheckboxMenuItem::miss ( )

miss is called once after a hit, if the node is not intersected anymore

Reimplemented from vrui::coAction.

virtual void vrui::coCheckboxMenuItem::selected ( bool  select)

MenuItem is selected via joystick.

Reimplemented from vrui::coRowMenuItem.

virtual void vrui::coCheckboxMenuItem::setActive ( bool  a)

functions activates or deactivates the item

Reimplemented from vrui::coRowMenuItem.

void vrui::coCheckboxMenuItem::setState ( bool  newState,
bool  generateEvent,
bool  updateGroup = false 
void vrui::coCheckboxMenuItem::setState ( bool  newState)
bool vrui::coCheckboxMenuItem::updateContentBool ( bool  )

set the twin MenuItem

Reimplemented from vrui::coMenuItem.

Member Data Documentation

coButton* vrui::coCheckboxMenuItem::checkBox

actual button which is used for interaction

coCheckboxGroup* vrui::coCheckboxMenuItem::group

checkbox group this checkbox belongs to

bool vrui::coCheckboxMenuItem::myState

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