vrui::coRowMenuItem Class Reference

#include <coRowMenuItem.h>

Inheritance diagram for vrui::coRowMenuItem:

Collaboration diagram for vrui::coRowMenuItem:

Public Member Functions
	coRowMenuItem (const std::string &labelString)
	coRowMenuItem (const std::string &symbolicName, const std::string &labelString)
virtual	~coRowMenuItem ()
virtual void	setLabel (coLabel *label)
coLabel *	getLabel ()
void	setLabel (const std::string &labelString) override
	this function may be overloaded - it is called by setName() More...
coUIElement *	getUIElement () override
const char *	getClassName () const override
	get the Element's classname More...
bool	isOfClassName (const char *) const override
	check if the Element or any ancestor is this classname More...
void	setActive (bool a) override
	activates or deactivates the item More...
void	selected (bool selected) override
	MenuItem is selected via joystick. More...
void	setVisible (bool visible) override
Public Member Functions inherited from vrui::coMenuItem
	coMenuItem (const std::string &name)
virtual	~coMenuItem ()
virtual void	setMenuListener (coMenuListener *listener)
virtual coMenuListener *	getMenuListener ()
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 coUIElement *	getUIElement ()
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...
coMenu *	getParentMenu ()
	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 void	setActive (bool a)
	functions activates or deactivates the item More...
virtual bool	getActive ()
	return if item is active More...
virtual void	setLabel (const std::string &newName)
	this function may be overloaded - it is called by setName() More...
virtual void	selected (bool select)
	MenuItem is selected via joystick. 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
coMenuContainer *	container
	container to store menu elements More...
coColoredBackground *	background
	menu item background which changes its color when menu item is selected More...
coLabel *	label
	label text More...
Protected Attributes inherited from vrui::coMenuItem
bool	visible
coMenu *	myMenu
	this menu item More...
coMenuListener *	listener
	on menu selection More...
std::string	myName
	symbolic name, or displayed as label) 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

coRowMenuItem() [1/2]

vrui::coRowMenuItem::coRowMenuItem

(

const std::string &

labelString

)

coRowMenuItem() [2/2]

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

~coRowMenuItem()

virtual vrui::coRowMenuItem::~coRowMenuItem ( )

virtual

Member Function Documentation

getClassName()

const char * vrui::coRowMenuItem::getClassName ( ) const

overridevirtual

get the Element's classname

Reimplemented from vrui::coMenuItem.

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

getLabel()

coLabel * vrui::coRowMenuItem::getLabel

(

)

getUIElement()

coUIElement * vrui::coRowMenuItem::getUIElement ( )

overridevirtual

Reimplemented from vrui::coMenuItem.

isOfClassName()

bool vrui::coRowMenuItem::isOfClassName ( const char *  ) const

overridevirtual

check if the Element or any ancestor is this classname

Reimplemented from vrui::coMenuItem.

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

selected()

void vrui::coRowMenuItem::selected ( bool  select )

overridevirtual

MenuItem is selected via joystick.

Reimplemented from vrui::coMenuItem.

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

setActive()

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

overridevirtual

activates or deactivates the item

Reimplemented from vrui::coMenuItem.

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

setLabel() [1/2]

virtual void vrui::coRowMenuItem::setLabel ( coLabel *  label )

virtual

setLabel() [2/2]

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

overridevirtual

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

Reimplemented from vrui::coMenuItem.

setVisible()

void vrui::coRowMenuItem::setVisible ( bool  visible )

overridevirtual

Reimplemented from vrui::coMenuItem.

Member Data Documentation

background

coColoredBackground* vrui::coRowMenuItem::background

protected

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

container

coMenuContainer* vrui::coRowMenuItem::container

protected

container to store menu elements

label

coLabel* vrui::coRowMenuItem::label

protected

label text

LEFTMARGIN

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:

• OpenVRUI/coRowMenuItem.h