This is the base class of all row menu items. More...

#include <coRowMenuItem.h>

Inheritance diagram for vrui::coRowMenuItem:

Public Member Functions
	coRowMenuItem (const std::string &labelString)

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

virtual	~coRowMenuItem ()
	Destructor. Removes this menu item from the parent menu. More...

virtual void	setLabel (coLabel *label)
	Set a new label for the menu item. More...

coLabel *	getLabel ()
	Get the current label. More...

void	setLabel (const std::string &labelString) override
	this function may be overloaded - it is called by setName() More...

coUIElement *	getUIElement () override
	return the actual UI Element that represents this menu. More...

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
	show or hide this menu item., just removes it from the scenegraph in the default implementation, should do something better in the real implementation More...

Public Member Functions inherited from vrui::coMenuItem
	coMenuItem (const std::string &name)
	Constructor. More...

virtual	~coMenuItem ()
	Destructor. Removes this menu item from the parent menu. More...

virtual void	setMenuListener (coMenuListener *listener)
	Set a new menu listener to receive menu item events. More...

virtual coMenuListener *	getMenuListener ()
	Get the menu listener to receive menu item events. More...

virtual void	setParentMenu (coMenu *parent)
	Set the parent menu in which this menu item is listed. More...

virtual void	setVisible (bool visible)
	show or hide this menu item., just removes it from the scenegraph in the default implementation, should do something better in the real implementation More...

virtual bool	isVisible () const

virtual void	setAttachment (int)
	sets the attachment border More...

virtual const char *	getName () const
	returns the symbolic name of this menu item. More...

virtual coUIElement *	getUIElement ()
	return the actual UI Element that represents this menu. 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...

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
	parent menu which contains More...

coMenuListener *	listener
	menu event listener, triggered More...

std::string	myName
	name of the item (internal More...

bool	active_
	flag if item is active More...

Static Protected Attributes
static const int	LEFTMARGIN = 30
	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()

vrui::coRowMenuItem::~coRowMenuItem ( )

virtual

Destructor. Removes this menu item from the parent menu.

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 ( )

Get the current label.

Returns: label

◆ getUIElement()

coUIElement * vrui::coRowMenuItem::getUIElement ( )

overridevirtual

return the actual UI Element that represents this menu.

Reimplemented from vrui::coMenuItem.

◆ isOfClassName()

bool vrui::coRowMenuItem::isOfClassName ( const char * classname ) 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.

if item should do any action if joystick selects the item, overwrite this function

Reimplemented from vrui::coMenuItem.

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

◆ setActive()

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

overridevirtual

activates or deactivates the item

activates or deactivates the item and deactivates the highlight

Reimplemented from vrui::coMenuItem.

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

◆ setLabel() [1/2]

void vrui::coRowMenuItem::setLabel ( coLabel * newLabel )

virtual

Set a new label for the menu item.

The label must already be of type coLabel.

Parameters

newLabel

◆ 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

show or hide this menu item., just removes it from the scenegraph in the default implementation, should do something better in the real implementation

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 = 30

staticprotected

size of margin at left edge of menu item

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

COVISE Online Documentation

Public Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ coRowMenuItem() [1/2]

◆ coRowMenuItem() [2/2]

◆ ~coRowMenuItem()

Member Function Documentation

◆ getClassName()

◆ getLabel()

◆ getUIElement()

◆ isOfClassName()

◆ selected()

◆ setActive()

◆ setLabel() [1/2]

◆ setLabel() [2/2]

◆ setVisible()

Member Data Documentation

◆ background

◆ container

◆ label

◆ LEFTMARGIN