#include <coMenuItem.h>

Inheritance diagram for vrui::coMenuItem:

[legend]

Collaboration diagram for vrui::coMenuItem:

[legend]

Public Member Functions
	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
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...

Detailed Description

This is the base class of all menu items. It stores the action listener which is to be called when a menu item is selected by the user.

See also: coMenuListener

Constructor & Destructor Documentation

◆ coMenuItem()

vrui::coMenuItem::coMenuItem ( const std::string & name )

◆ ~coMenuItem()

virtual vrui::coMenuItem::~coMenuItem ( )

virtual

Member Function Documentation

◆ doActionPress()

virtual void vrui::coMenuItem::doActionPress ( )

virtual

Action is called via joystick.

Reimplemented in vrui::coPotiMenuItem, vrui::coPotiToolboxItem, vrui::coSliderMenuItem, and vrui::coSliderToolboxItem.

◆ doActionRelease()

virtual void vrui::coMenuItem::doActionRelease ( )

virtual

Action is called via joystick.

Reimplemented in vrui::coButtonMenuItem, vrui::coCheckboxMenuItem, vrui::coIconButtonToolboxItem, vrui::coIconToggleButtonToolboxItem, vrui::coSliderMenuItem, vrui::coSubMenuItem, and vrui::coSubMenuToolboxItem.

◆ doSecondActionPress()

virtual void vrui::coMenuItem::doSecondActionPress ( )

virtual

second Action for Item

Reimplemented in vrui::coPotiMenuItem, vrui::coPotiToolboxItem, vrui::coSliderMenuItem, and vrui::coSliderToolboxItem.

◆ doSecondActionRelease()

virtual void vrui::coMenuItem::doSecondActionRelease ( )

virtual

second Action for Item

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

◆ getActive()

virtual bool vrui::coMenuItem::getActive ( )

inlinevirtual

return if item is active

◆ getClassName()

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

virtual

get the Element's classname

Reimplemented in vrui::coButtonMenuItem, vrui::coCheckboxMenuItem, vrui::coIconButtonToolboxItem, vrui::coIconSubMenuToolboxItem, vrui::coIconToggleButtonToolboxItem, vrui::coLabelMenuItem, vrui::coLabelSubMenuToolboxItem, vrui::coMovableBackgroundMenuItem, vrui::coPotiMenuItem, vrui::coPotiToolboxItem, vrui::coProgressBarMenuItem, vrui::coSliderMenuItem, vrui::coSliderToolboxItem, vrui::coSubMenuItem, vrui::coToolboxMenuItem, opencover::VruiPartnerMenuItem, vrui::coRowMenuItem, vrui::coSubMenuToolboxItem, and opencover::coColorBar.

◆ getMenuListener()

virtual coMenuListener * vrui::coMenuItem::getMenuListener ( )

virtual

◆ getName()

virtual const char * vrui::coMenuItem::getName ( ) const

virtual

Reimplemented in opencover::coColorBar.

◆ getParentMenu()

coMenu * vrui::coMenuItem::getParentMenu ( )

inline

get my parent menu

◆ getUIElement()

virtual coUIElement * vrui::coMenuItem::getUIElement ( )

virtual

Reimplemented in vrui::coMovableBackgroundMenuItem, vrui::coToolboxMenuItem, vrui::coRowMenuItem, and opencover::coColorBar.

◆ isOfClassName()

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

virtual

check if the Element or any ancestor is this classname

Reimplemented in vrui::coButtonMenuItem, vrui::coCheckboxMenuItem, vrui::coIconButtonToolboxItem, vrui::coIconToggleButtonToolboxItem, vrui::coLabelMenuItem, vrui::coMovableBackgroundMenuItem, vrui::coPotiMenuItem, vrui::coPotiToolboxItem, vrui::coProgressBarMenuItem, vrui::coSliderMenuItem, vrui::coSliderToolboxItem, vrui::coSubMenuItem, vrui::coToolboxMenuItem, opencover::VruiPartnerMenuItem, vrui::coRowMenuItem, vrui::coSubMenuToolboxItem, opencover::coColorBar, vrui::coIconSubMenuToolboxItem, and vrui::coLabelSubMenuToolboxItem.

◆ isVisible()

virtual bool vrui::coMenuItem::isVisible ( ) const

virtual

◆ selected()

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

virtual

MenuItem is selected via joystick.

Reimplemented in vrui::coButtonMenuItem, vrui::coCheckboxMenuItem, vrui::coIconButtonToolboxItem, vrui::coIconToggleButtonToolboxItem, vrui::coSliderMenuItem, vrui::coSliderToolboxItem, vrui::coSubMenuItem, vrui::coSubMenuToolboxItem, vrui::coRowMenuItem, vrui::coPotiMenuItem, and vrui::coPotiToolboxItem.

◆ setActive()

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

inlinevirtual

functions activates or deactivates the item

Reimplemented in vrui::coButtonMenuItem, vrui::coCheckboxMenuItem, vrui::coIconButtonToolboxItem, vrui::coIconToggleButtonToolboxItem, vrui::coSliderMenuItem, vrui::coSliderToolboxItem, vrui::coSubMenuItem, vrui::coToolboxMenuItem, vrui::coRowMenuItem, and vrui::coSubMenuToolboxItem.

◆ setAttachment()

virtual void vrui::coMenuItem::setAttachment ( int )

inlinevirtual

sets the attachment border

Reimplemented in vrui::coSubMenuItem, vrui::coSubMenuToolboxItem, vrui::coIconSubMenuToolboxItem, and vrui::coLabelSubMenuToolboxItem.

◆ setLabel()

virtual void vrui::coMenuItem::setLabel ( const std::string & newName )

virtual

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

Reimplemented in vrui::coSliderToolboxItem, vrui::coLabelSubMenuToolboxItem, and vrui::coRowMenuItem.

◆ setMenuListener()

virtual void vrui::coMenuItem::setMenuListener ( coMenuListener * listener )

virtual

◆ setName()

void vrui::coMenuItem::setName	(	const std::string &	newName,
		bool	updateTwins = `true`
	)

set my name - items with labels must call this when changing label

◆ setParentMenu()

virtual void vrui::coMenuItem::setParentMenu ( coMenu * parent )

virtual

◆ setVisible()

virtual void vrui::coMenuItem::setVisible ( bool visible )

virtual

Reimplemented in vrui::coRowMenuItem.

Member Data Documentation

◆ active_

bool vrui::coMenuItem::active_

protected

flag if item is active

◆ listener

coMenuListener* vrui::coMenuItem::listener

protected

on menu selection

menu event listener, triggered

◆ myMenu

coMenu* vrui::coMenuItem::myMenu

protected

this menu item

parent menu which contains

◆ myName

std::string vrui::coMenuItem::myName

protected

symbolic name, or displayed as label)

name of the item (internal

◆ visible

bool vrui::coMenuItem::visible

protected

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

OpenVRUI/coMenuItem.h

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ coMenuItem()

◆ ~coMenuItem()

Member Function Documentation

◆ doActionPress()

◆ doActionRelease()

◆ doSecondActionPress()

◆ doSecondActionRelease()

◆ getActive()

◆ getClassName()

◆ getMenuListener()

◆ getName()

◆ getParentMenu()

◆ getUIElement()

◆ isOfClassName()

◆ isVisible()

◆ selected()

◆ setActive()

◆ setAttachment()

◆ setLabel()

◆ setMenuListener()

◆ setName()

◆ setParentMenu()

◆ setVisible()

Member Data Documentation

◆ active_

◆ listener

◆ myMenu

◆ myName

◆ visible