Holds the generalized menu infrastructure code. More...

Namespaces
	renderers

Classes
class	GenericMenuItem
	A generic take on MenuItem that invokes a Boost signal when the item is chosen, selected, or deselected. More...

class	Menu
	Stores the data that defines a menu and provides thread-safe access to that data. More...

class	MenuAccess
	Provides an exclusive lock on a Menu to allow the menu to be changed. More...

struct	MenuBoundsError
	An attempt was made to inset a MenuItem beyond the bounds of the menu. More...

struct	MenuError
	The base exception type for all errors about menus. More...

class	MenuItem
	Represents an option that a user can chose from a menu of options. More...

struct	MenuItemDisabled
	An operation was attempted on a disabled MenuItem that requires a non-disabled item. More...

struct	MenuItemDoesNotExist
	The specified MenuItem does not exist in the Menu. More...

struct	MenuItemLacksValue
	A request was made to change the value of a MenuItem that does not have a value. More...

struct	MenuItemNotAToggle
	A request was made to change the toggle state of a MenuItem that is not a toggle item. More...

struct	MenuItemNotVisible
	An operation was attempted on an invisible MenuItem that requires a visible item. More...

struct	MenuNoItemError
	A required MenuItem object is missing. More...

class	MenuOutput
	Compiles a list of visible menu items based on the selected item of a MenuView. More...

class	MenuOutputAccess
	Provides access to a MenuOutput for rendering. More...

struct	MenuOutputNotAttached
	Attempted use of a MenuOutput object that hasn't been attached to a MenuView. More...

struct	MenuTooSmall
	There is inadequate room to render the menu. More...

class	MenuView
	Keeps track of the selected menu item, and updates it based on user input. More...

struct	MenuViewAlreadyAttached
	MenuView::attach() was called more than once on a MenuView object. More...

Typedefs
typedef std::shared_ptr< GenericMenuItem >	GenericMenuItemSptr
	A shared pointer to a GenericMenuItem. More...

typedef std::weak_ptr< GenericMenuItem >	GenericMenuItemWptr
	A weak pointer to a GenericMenuItem. More...

typedef boost::error_info< struct Info_MenuItemIndex, std::size_t >	MenuItemIndex
	The index (position) of the MenuItem involved in an error. More...

typedef boost::error_info< struct Info_MenuItem, std::shared_ptr< const MenuItem > >	MenuItemObject
	The MenuItem object that is involved in an error. More...

typedef std::shared_ptr< MenuItem >	MenuItemSptr
	A shared pointer to a MenuItem. More...

typedef std::weak_ptr< MenuItem >	MenuItemWptr
	A weak pointer to a MenuItem. More...

typedef boost::error_info< struct Info_Menu, std::shared_ptr< const Menu > >	MenuObject
	The Menu object that is involved in an error. More...

typedef std::shared_ptr< MenuOutput >	MenuOutputSptr
	A shared pointer to a MenuOutput. More...

typedef std::weak_ptr< MenuOutput >	MenuOutputWptr
	A weak pointer to a MenuOutput. More...

typedef std::shared_ptr< Menu >	MenuSptr
	A shared pointer to a Menu. More...

typedef std::shared_ptr< MenuView >	MenuViewSptr
	A shared pointer to a MenuView. More...

typedef std::weak_ptr< MenuView >	MenuViewWptr
	A weak pointer to a MenuView. More...

typedef std::list< MenuItem * >	MenuVisibleList
	Type used by MenuOutput and MenuOutputAccess for the list of visible menu items. More...

typedef std::weak_ptr< Menu >	MenuWptr
	A weak pointer to a Menu. More...

Detailed Description

Holds the generalized menu infrastructure code.

Typedef Documentation

◆ GenericMenuItemSptr

typedef std::shared_ptr<GenericMenuItem> duds::ui::menu::GenericMenuItemSptr

A shared pointer to a GenericMenuItem.

Examples:: bppmenu.cpp.

Definition at line 395 of file GenericMenuItem.hpp.

◆ GenericMenuItemWptr

typedef std::weak_ptr<GenericMenuItem> duds::ui::menu::GenericMenuItemWptr

A weak pointer to a GenericMenuItem.

Definition at line 400 of file GenericMenuItem.hpp.

◆ MenuItemIndex

typedef boost::error_info<struct Info_MenuItemIndex, std::size_t> duds::ui::menu::MenuItemIndex

The index (position) of the MenuItem involved in an error.

Definition at line 85 of file MenuErrors.hpp.

◆ MenuItemObject

typedef boost::error_info< struct Info_MenuItem, std::shared_ptr<const MenuItem> > duds::ui::menu::MenuItemObject

The MenuItem object that is involved in an error.

Definition at line 94 of file MenuErrors.hpp.

◆ MenuItemSptr

typedef std::shared_ptr<MenuItem> duds::ui::menu::MenuItemSptr

A shared pointer to a MenuItem.

Definition at line 411 of file MenuItem.hpp.

◆ MenuItemWptr

typedef std::weak_ptr<MenuItem> duds::ui::menu::MenuItemWptr

A weak pointer to a MenuItem.

Definition at line 416 of file MenuItem.hpp.

◆ MenuObject

typedef boost::error_info< struct Info_Menu, std::shared_ptr<const Menu> > duds::ui::menu::MenuObject

The Menu object that is involved in an error.

Definition at line 100 of file MenuErrors.hpp.

◆ MenuOutputSptr

typedef std::shared_ptr<MenuOutput> duds::ui::menu::MenuOutputSptr

A shared pointer to a MenuOutput.

Definition at line 231 of file MenuOutput.hpp.

◆ MenuOutputWptr

typedef std::weak_ptr<MenuOutput> duds::ui::menu::MenuOutputWptr

A weak pointer to a MenuOutput.

Definition at line 236 of file MenuOutput.hpp.

◆ MenuSptr

typedef std::shared_ptr<Menu> duds::ui::menu::MenuSptr

A shared pointer to a Menu.

Examples:: bppmenu.cpp.

Definition at line 289 of file Menu.hpp.

◆ MenuViewSptr

typedef std::shared_ptr<MenuView> duds::ui::menu::MenuViewSptr

A shared pointer to a MenuView.

Examples:: bppmenu.cpp.

Definition at line 390 of file MenuView.hpp.

◆ MenuViewWptr

typedef std::weak_ptr<MenuView> duds::ui::menu::MenuViewWptr

A weak pointer to a MenuView.

Definition at line 395 of file MenuView.hpp.

◆ MenuVisibleList

typedef std::list<MenuItem*> duds::ui::menu::MenuVisibleList

Type used by MenuOutput and MenuOutputAccess for the list of visible menu items.

Definition at line 18 of file MenuOutput.hpp.

◆ MenuWptr

typedef std::weak_ptr<Menu> duds::ui::menu::MenuWptr

A weak pointer to a Menu.

Definition at line 294 of file Menu.hpp.

Namespaces

Classes

Typedefs