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

#include <coRowMenuItem.h>

Inheritance diagram for vrui::coRowMenuItem:
Inheritance graph
[legend]
Collaboration diagram for vrui::coRowMenuItem:
Collaboration graph
[legend]

Public Member Functions

 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 ()
 
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)
 activates or deactivates the item More...
 
virtual void selected (bool selected)
 MenuItem is selected via joystick. More...
 
- 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 updateContentBool (bool)
 set 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 doActionRelease ()
 Action is called via joystick. More...
 
virtual void doSecondActionPress ()
 second Action for Item More...
 
virtual void doSecondActionRelease ()
 second Action for Item More...
 

Protected Attributes

coMenuContainercontainer
 container to store menu elements More...
 
coColoredBackgroundbackground
 menu item background which changes its color when menu item is selected More...
 
coLabellabel
 label text More...
 
- Protected Attributes inherited from vrui::coMenuItem
bool visible
 
coMenumyMenu
 this menu item More...
 
coMenuListenerlistener
 on menu selection More...
 
std::string myName
 symbolic name, or displayed as label) More...
 
coMenuItemmyTwin
 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...
 

Static Protected Attributes

static const int LEFTMARGIN
 size of margin at left edge of menu item More...
 

Detailed Description

This is the base class of all row menu items. It provides a container for menu elements and a label string.

See Also
coButtonMenuItem
coLabelMenuItem
coSubMenuItem
coPotiMenuItem
coSliderMenuItem
coCheckboxMenuItem

Constructor & Destructor Documentation

vrui::coRowMenuItem::coRowMenuItem ( const std::string &  labelString)
vrui::coRowMenuItem::coRowMenuItem ( const std::string &  symbolicName,
const std::string &  labelString 
)
virtual vrui::coRowMenuItem::~coRowMenuItem ( )
virtual

Member Function Documentation

virtual const char* vrui::coRowMenuItem::getClassName ( ) const
virtual
coLabel* vrui::coRowMenuItem::getLabel ( )
virtual coUIElement* vrui::coRowMenuItem::getUIElement ( )
virtual

Reimplemented from vrui::coMenuItem.

virtual bool vrui::coRowMenuItem::isOfClassName ( const char *  ) const
virtual
virtual void vrui::coRowMenuItem::selected ( bool  select)
virtual

MenuItem is selected via joystick.

Reimplemented from vrui::coMenuItem.

Reimplemented in vrui::coButtonMenuItem, vrui::coCheckboxMenuItem, vrui::coSliderMenuItem, vrui::coSubMenuItem, and vrui::coPotiMenuItem.

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

activates or deactivates the item

Reimplemented from vrui::coMenuItem.

Reimplemented in vrui::coSubMenuItem, vrui::coButtonMenuItem, vrui::coSliderMenuItem, and vrui::coCheckboxMenuItem.

virtual void vrui::coRowMenuItem::setLabel ( coLabel label)
virtual
void vrui::coRowMenuItem::setLabel ( const std::string &  newName)
virtual

this function may be overloaded - it is called by setName()

Reimplemented from vrui::coMenuItem.

Member Data Documentation

coColoredBackground* vrui::coRowMenuItem::background
protected

menu item background which changes its color when menu item is selected

coMenuContainer* vrui::coRowMenuItem::container
protected

container to store menu elements

coLabel* vrui::coRowMenuItem::label
protected

label text

const int vrui::coRowMenuItem::LEFTMARGIN
staticprotected

size of margin at left edge of menu item


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