A GenericMenuItem that holds a bit-per-pixel icon to represent the item. More...

#include <BppIconItem.hpp>

Inheritance diagram for duds::ui::menu::renderers::GenericBppMenuIconItem:

Collaboration diagram for duds::ui::menu::renderers::GenericBppMenuIconItem:

Static Public Member Functions
static std::shared_ptr< GenericBppMenuIconItem >	make (const std::string &label, Flags flags=Flags::Zero())
	Makes a shared pointer holding a new GenericBppMenuIconItem. More...

static std::shared_ptr< GenericBppMenuIconItem >	make (const duds::ui::graphics::ConstBppImageSptr &icon, const std::string &label, Flags flags=Flags::Zero())
	Makes a shared pointer holding a new GenericBppMenuIconItem. More...

static std::shared_ptr< GenericBppMenuIconItem >	make (duds::ui::graphics::ConstBppImageSptr &&icon, const std::string &label, Flags flags=Flags::Zero())
	Makes a shared pointer holding a new GenericBppMenuIconItem. More...

static std::shared_ptr< GenericBppMenuIconItem >	make (const std::string &label, const std::string &description, Flags flags=Flags::Zero())
	Makes a shared pointer holding a new GenericBppMenuIconItem. More...

static std::shared_ptr< GenericBppMenuIconItem >	make (const duds::ui::graphics::ConstBppImageSptr &icon, const std::string &label, const std::string &description, Flags flags=Flags::Zero())
	Makes a shared pointer holding a new GenericBppMenuIconItem. More...

static std::shared_ptr< GenericBppMenuIconItem >	make (duds::ui::graphics::ConstBppImageSptr &&icon, const std::string &label, const std::string &description, Flags flags=Flags::Zero())
	Makes a shared pointer holding a new GenericBppMenuIconItem. More...

static std::shared_ptr< GenericBppMenuIconItem >	make (const std::string &label, const std::string &description, const std::string &value, Flags flags=Flags::Zero())
	Makes a shared pointer holding a new GenericBppMenuIconItem. More...

static std::shared_ptr< GenericBppMenuIconItem >	make (const duds::ui::graphics::ConstBppImageSptr &icon, const std::string &label, const std::string &description, const std::string &value, Flags flags=Flags::Zero())
	Makes a shared pointer holding a new GenericBppMenuIconItem. More...

static std::shared_ptr< GenericBppMenuIconItem >	make (duds::ui::graphics::ConstBppImageSptr &&icon, const std::string &label, const std::string &description, const std::string &value, Flags flags=Flags::Zero())
	Makes a shared pointer holding a new GenericBppMenuIconItem. More...

Static Public Member Functions inherited from duds::ui::menu::GenericMenuItem
static std::shared_ptr< GenericMenuItem >	make (const std::string &label, Flags flags=Flags::Zero())
	Makes a shared pointer holding a new GenericMenuItem. More...

static std::shared_ptr< GenericMenuItem >	make (const std::string &label, const std::string &description, Flags flags=Flags::Zero())
	Makes a shared pointer holding a new GenericMenuItem. More...

static std::shared_ptr< GenericMenuItem >	make (const std::string &label, const std::string &description, const std::string &value, Flags flags=Flags::Zero())
	Makes a shared pointer holding a new GenericMenuItem with an associated value. More...

Protected Member Functions
	GenericBppMenuIconItem (MenuItemToken, const std::string &label, Flags flags=Flags::Zero())
	Constructs a new GenericBppMenuIconItem. More...

	GenericBppMenuIconItem (MenuItemToken, const duds::ui::graphics::ConstBppImageSptr &icon, const std::string &label, Flags flags=Flags::Zero())
	Constructs a new GenericBppMenuIconItem. More...

	GenericBppMenuIconItem (MenuItemToken, duds::ui::graphics::ConstBppImageSptr &&icon, const std::string &label, Flags flags=Flags::Zero())
	Constructs a new GenericBppMenuIconItem. More...

	GenericBppMenuIconItem (MenuItemToken, const std::string &label, const std::string &description, Flags flags=Flags::Zero())
	Constructs a new GenericBppMenuIconItem. More...

	GenericBppMenuIconItem (MenuItemToken, const duds::ui::graphics::ConstBppImageSptr &icon, const std::string &label, const std::string &description, Flags flags=Flags::Zero())
	Constructs a new GenericBppMenuIconItem. More...

	GenericBppMenuIconItem (MenuItemToken, duds::ui::graphics::ConstBppImageSptr &&icon, const std::string &label, const std::string &description, Flags flags=Flags::Zero())
	Constructs a new GenericBppMenuIconItem. More...

	GenericBppMenuIconItem (MenuItemToken, const std::string &label, const std::string &description, const std::string &value, Flags flags=Flags::Zero())
	Constructs a new GenericBppMenuIconItem with an associated value. More...

	GenericBppMenuIconItem (MenuItemToken, const duds::ui::graphics::ConstBppImageSptr &icon, const std::string &label, const std::string &description, const std::string &value, Flags flags=Flags::Zero())
	Constructs a new GenericBppMenuIconItem with an associated value. More...

	GenericBppMenuIconItem (MenuItemToken, duds::ui::graphics::ConstBppImageSptr &&icon, const std::string &label, const std::string &description, const std::string &value, Flags flags=Flags::Zero())
	Constructs a new GenericBppMenuIconItem with an associated value. More...

Protected Member Functions inherited from duds::ui::menu::GenericMenuItem
	GenericMenuItem (MenuItemToken, const std::string &label, Flags flags=Flags::Zero())
	Constructs a new GenericMenuItem. More...

	GenericMenuItem (MenuItemToken, const std::string &label, const std::string &description, Flags flags=Flags::Zero())
	Constructs a new GenericMenuItem. More...

	GenericMenuItem (MenuItemToken, const std::string &label, const std::string &description, const std::string &value, Flags flags=Flags::Zero())
	Constructs a new GenericMenuItem with an associated value. More...

Protected Member Functions inherited from duds::ui::menu::MenuItem
	MenuItem (MenuItemToken, const std::string &label, Flags flags=Flags::Zero())
	Constructs a new MenuItem. More...

	MenuItem (MenuItemToken, const std::string &label, const std::string &description, Flags flags=Flags::Zero())
	Constructs a new MenuItem. More...

	MenuItem (MenuItemToken, const std::string &label, const std::string &description, const std::string &value, Flags flags=Flags::Zero())
	Constructs a new MenuItem with an associated value. More...

	MenuItem (MenuItemToken, const MenuItem &mi)
	Copy constructs a new MenuItem. More...

Additional Inherited Members
Public Types inherited from duds::ui::menu::GenericMenuItem
typedef boost::signals2::signal< void(MenuView &invokingView, const MenuAccess &access, GenericMenuItem &self) >	Signal
	The signal type invoked when the item is chosen, selected, or deselected. More...

Public Types inherited from duds::ui::menu::MenuItem
typedef duds::general::BitFlags< struct MenuItemFlags >	Flags
	A set of option and state flags for menu items. More...

Public Member Functions inherited from duds::ui::menu::GenericMenuItem
virtual void	chose (MenuView &invokingView, const MenuAccess &access)
	Invokes the choseSig signal in response to the user chosing this menu item. More...

boost::signals2::connection	choseConnect (const typename Signal::slot_type &slot, boost::signals2::connect_position at=boost::signals2::at_back)
	Make a connection to the generic menu item chose signal. More...

boost::signals2::connection	choseConnect (const typename Signal::group_type &group, const typename Signal::slot_type &slot, boost::signals2::connect_position at=boost::signals2::at_back)
	Make a connection to the generic menu item chose signal. More...

boost::signals2::connection	choseConnectExtended (const typename Signal::extended_slot_type &slot, boost::signals2::connect_position at=boost::signals2::at_back)
	Make a connection to the generic menu item chose signal. More...

boost::signals2::connection	choseConnectExtended (const typename Signal::group_type &group, const typename Signal::extended_slot_type &slot, boost::signals2::connect_position at=boost::signals2::at_back)
	Make a connection to the generic menu item chose signal. More...

void	choseDisconnect (const typename Signal::group_type &group)
	Disconnect a group from the generic menu item chose signal. More...

template<typename Slot >
void	choseDisconnect (const Slot &slotFunc)
	Disconnect from the generic menu item chose signal. More...

virtual void	deselect (MenuView &invokingView, const MenuAccess &access)
	Invokes the deselSig signal in response to the user deselecting this menu item. More...

boost::signals2::connection	deselectConnect (const typename Signal::slot_type &slot, boost::signals2::connect_position at=boost::signals2::at_back)
	Make a connection to the generic menu item deselect signal. More...

boost::signals2::connection	deselectConnect (const typename Signal::group_type &group, const typename Signal::slot_type &slot, boost::signals2::connect_position at=boost::signals2::at_back)
	Make a connection to the generic menu item deselect signal. More...

boost::signals2::connection	deselectConnectExtended (const typename Signal::extended_slot_type &slot, boost::signals2::connect_position at=boost::signals2::at_back)
	Make a connection to the generic menu item deselect signal. More...

boost::signals2::connection	deselectConnectExtended (const typename Signal::group_type &group, const typename Signal::extended_slot_type &slot, boost::signals2::connect_position at=boost::signals2::at_back)
	Make a connection to the generic menu item deselect signal. More...

void	deselectDisconnect (const typename Signal::group_type &group)
	Disconnect a group from the generic menu item deselect signal. More...

template<typename Slot >
void	deselectDisconnect (const Slot &slotFunc)
	Disconnect from the generic menu item deselect signal. More...

virtual void	select (MenuView &invokingView, const MenuAccess &access)
	Invokes the selSig signal in response to the user selecting this menu item. More...

boost::signals2::connection	selectConnect (const typename Signal::slot_type &slot, boost::signals2::connect_position at=boost::signals2::at_back)
	Make a connection to the generic menu item select signal. More...

boost::signals2::connection	selectConnect (const typename Signal::group_type &group, const typename Signal::slot_type &slot, boost::signals2::connect_position at=boost::signals2::at_back)
	Make a connection to the generic menu item select signal. More...

boost::signals2::connection	selectConnectExtended (const typename Signal::extended_slot_type &slot, boost::signals2::connect_position at=boost::signals2::at_back)
	Make a connection to the generic menu item select signal. More...

boost::signals2::connection	selectConnectExtended (const typename Signal::group_type &group, const typename Signal::extended_slot_type &slot, boost::signals2::connect_position at=boost::signals2::at_back)
	Make a connection to the generic menu item select signal. More...

void	selectDisconnect (const typename Signal::group_type &group)
	Disconnect a group from the generic menu item select signal. More...

template<typename Slot >
void	selectDisconnect (const Slot &slotFunc)
	Disconnect from the generic menu item select signal. More...

Public Member Functions inherited from duds::ui::menu::MenuItem
void	changeEnabledState (bool state)
	Changes the state of the item to either enabled or disabled. More...

void	changeToggle (bool state)
	Changes the toggle state of the item to the indicated state. More...

void	changeVisibility (bool vis)
	Changes the visibility of the item. More...

void	clearToggle ()
	Clears the toggle state of the item. More...

const std::string &	description () const
	Returns the optional description text for this item. More...

void	description (const std::string &d)
	Changes the optional description text for this item. More...

void	disable ()
	Makes the item disabled. More...

void	enable ()
	Makes the item enabled. More...

Flags	flags () const
	Returns the option flags for the item. More...

bool	hasValue () const
	True if the item is flagged as having a value. More...

void	hide ()
	Makes the item invisible. More...

bool	isDisabled () const
	True if the item is flagged as disabled. More...

bool	isEnabled () const
	True if the item is flagged as enabled. More...

bool	isInvisible () const
	True if the item is flagged as invisible. More...

bool	isSelectable () const
	Returns true if the item is both visible and enabled. More...

bool	isToggle () const
	True if the item is flagged as being a toggle. More...

bool	isToggledOn () const
	True if the item is in the toggled on (true) state. More...

bool	isVisible () const
	True if the item is flagged as visible. More...

const std::string &	label () const
	Returns the label text for this item. More...

void	label (const std::string &l)
	Changes the label text for this item. More...

Menu *	menu () const
	Returns the menu object that owns this item. More...

void	remove ()
	Removes the item from its parent menu. More...

void	setToggle ()
	Sets the toggle state of the item. More...

void	show ()
	Makes the item visible. More...

bool	toggle ()
	Toggles the toggle state of the item and returns the new toggle state. More...

const std::string &	value () const
	Returns the optional value text for the item. More...

void	value (const std::string &v)
	Changes the optional value text for the item. More...

Public Member Functions inherited from duds::ui::menu::renderers::BppIconItem
	BppIconItem ()=default
	Constructs the item without an icon. More...

	BppIconItem (const duds::ui::graphics::ConstBppImageSptr &icon)
	Constructs the item with the given icon. More...

	BppIconItem (duds::ui::graphics::ConstBppImageSptr &&icon)
	Constructs the item with the given icon. More...

const duds::ui::graphics::ConstBppImageSptr &	icon () const
	Returns the item's icon. More...

void	icon (const duds::ui::graphics::ConstBppImageSptr &newimg)
	Sets the item's icon to the given image. More...

void	icon (duds::ui::graphics::ConstBppImageSptr &&newimg)
	Sets the item's icon to the given image. More...

Static Public Attributes inherited from duds::ui::menu::MenuItem
static constexpr Flags	Disabled = Flags::Bit(0)
	Indicates that the item may not be chosen by the user. More...

static constexpr Flags	HasValue = Flags::Bit(2)
	Indicates that the item has a value, or setting, that should be shown in the menu if possible. More...

static constexpr Flags	Invisible = Flags::Bit(1)
	Indicates that the item will not be rendered. More...

static constexpr Flags	Toggle = Flags::Bit(3)
	Denotes that the item is a toggle, and that the toggle state should be visible on the menu. More...

static constexpr Flags	ToggledOn = Flags::Bit(4)
	The toggle state; true when the state is on, when the item is true. More...

Detailed Description

A GenericMenuItem that holds a bit-per-pixel icon to represent the item.

When using a dynamic_cast from a MenuItem in an attempt to obtain an icon, cast to a BppIconItem.

Author: Jeff Jackowski

Definition at line 254 of file BppIconItem.hpp.

Constructor & Destructor Documentation

◆ GenericBppMenuIconItem() [1/9]

duds::ui::menu::renderers::GenericBppMenuIconItem::GenericBppMenuIconItem	(	MenuItemToken	,
		const std::string &	label,
		Flags	flags = `Flags::Zero()`
	)

inlineprotected

Constructs a new GenericBppMenuIconItem.

Note: All GenericBppMenuIconItem objects must be managed by std::shared_ptr.

Parameters

label	Short text presented to the user as the menu item.
flags	The option flags for the item. The default is zero: enabled, visible, no value, and not a toggle.

Definition at line 265 of file BppIconItem.hpp.

◆ GenericBppMenuIconItem() [2/9]

duds::ui::menu::renderers::GenericBppMenuIconItem::GenericBppMenuIconItem	(	MenuItemToken	,
		const duds::ui::graphics::ConstBppImageSptr &	icon,
		const std::string &	label,
		Flags	flags = `Flags::Zero()`
	)

inlineprotected

Constructs a new GenericBppMenuIconItem.

Note: All GenericBppMenuIconItem objects must be managed by std::shared_ptr.

Parameters

icon	The image for the item's icon.
label	Short text presented to the user as the menu item.
flags	The option flags for the item. The default is zero: enabled, visible, no value, and not a toggle.

Definition at line 280 of file BppIconItem.hpp.

◆ GenericBppMenuIconItem() [3/9]

duds::ui::menu::renderers::GenericBppMenuIconItem::GenericBppMenuIconItem	(	MenuItemToken	,
		duds::ui::graphics::ConstBppImageSptr &&	icon,
		const std::string &	label,
		Flags	flags = `Flags::Zero()`
	)

inlineprotected

Constructs a new GenericBppMenuIconItem.

Note: All GenericBppMenuIconItem objects must be managed by std::shared_ptr.

Parameters

icon	The image for the item's icon. The shared pointer is moved into this object.
label	Short text presented to the user as the menu item.
flags	The option flags for the item. The default is zero: enabled, visible, no value, and not a toggle.

Definition at line 297 of file BppIconItem.hpp.

◆ GenericBppMenuIconItem() [4/9]

duds::ui::menu::renderers::GenericBppMenuIconItem::GenericBppMenuIconItem	(	MenuItemToken	,
		const std::string &	label,
		const std::string &	description,
		Flags	flags = `Flags::Zero()`
	)

inlineprotected

Constructs a new GenericBppMenuIconItem.

Note: All GenericBppMenuIconItem objects must be managed by std::shared_ptr.

Parameters

label	Short text presented to the user as the menu item.
description	Longer text optionally presented to the user to provide a better idea of what the option does.
flags	The option flags for the item. The default is zero: enabled, visible, no value, and not a toggle.

Definition at line 315 of file BppIconItem.hpp.

◆ GenericBppMenuIconItem() [5/9]

duds::ui::menu::renderers::GenericBppMenuIconItem::GenericBppMenuIconItem	(	MenuItemToken	,
		const duds::ui::graphics::ConstBppImageSptr &	icon,
		const std::string &	label,
		const std::string &	description,
		Flags	flags = `Flags::Zero()`
	)

inlineprotected

Constructs a new GenericBppMenuIconItem.

Note: All GenericBppMenuIconItem objects must be managed by std::shared_ptr.

Parameters

icon	The image for the item's icon.
label	Short text presented to the user as the menu item.
description	Longer text optionally presented to the user to provide a better idea of what the option does.
flags	The option flags for the item. The default is zero: enabled, visible, no value, and not a toggle.

Definition at line 333 of file BppIconItem.hpp.

◆ GenericBppMenuIconItem() [6/9]

duds::ui::menu::renderers::GenericBppMenuIconItem::GenericBppMenuIconItem	(	MenuItemToken	,
		duds::ui::graphics::ConstBppImageSptr &&	icon,
		const std::string &	label,
		const std::string &	description,
		Flags	flags = `Flags::Zero()`
	)

inlineprotected

Constructs a new GenericBppMenuIconItem.

Note: All GenericBppMenuIconItem objects must be managed by std::shared_ptr.

Parameters

icon	The image for the item's icon. The shared pointer is moved into this object.
label	Short text presented to the user as the menu item.
description	Longer text optionally presented to the user to provide a better idea of what the option does.
flags	The option flags for the item. The default is zero: enabled, visible, no value, and not a toggle.

Definition at line 354 of file BppIconItem.hpp.

◆ GenericBppMenuIconItem() [7/9]

duds::ui::menu::renderers::GenericBppMenuIconItem::GenericBppMenuIconItem	(	MenuItemToken	,
		const std::string &	label,
		const std::string &	description,
		const std::string &	value,
		Flags	flags = `Flags::Zero()`
	)

inlineprotected

Constructs a new GenericBppMenuIconItem with an associated value.

Note: All GenericBppMenuIconItem objects must be managed by std::shared_ptr.

Parameters

label	Short text presented to the user as the menu item.
description	Longer text optionally presented to the user to provide a better idea of what the option does.
value	The current value associated with the menu item.
flags	The option flags for the item. While the default is zero, the MenuItem::HasValue flag will be OR'd with the given value by the constructor.

Definition at line 375 of file BppIconItem.hpp.

◆ GenericBppMenuIconItem() [8/9]

duds::ui::menu::renderers::GenericBppMenuIconItem::GenericBppMenuIconItem	(	MenuItemToken	,
		const duds::ui::graphics::ConstBppImageSptr &	icon,
		const std::string &	label,
		const std::string &	description,
		const std::string &	value,
		Flags	flags = `Flags::Zero()`
	)

inlineprotected

Constructs a new GenericBppMenuIconItem with an associated value.

Note: All GenericBppMenuIconItem objects must be managed by std::shared_ptr.

Parameters

icon	The image for the item's icon.
label	Short text presented to the user as the menu item.
description	Longer text optionally presented to the user to provide a better idea of what the option does.
value	The current value associated with the menu item.
flags	The option flags for the item. While the default is zero, the MenuItem::HasValue flag will be OR'd with the given value by the constructor.

Definition at line 396 of file BppIconItem.hpp.

◆ GenericBppMenuIconItem() [9/9]

duds::ui::menu::renderers::GenericBppMenuIconItem::GenericBppMenuIconItem	(	MenuItemToken	,
		duds::ui::graphics::ConstBppImageSptr &&	icon,
		const std::string &	label,
		const std::string &	description,
		const std::string &	value,
		Flags	flags = `Flags::Zero()`
	)

inlineprotected

Constructs a new GenericBppMenuIconItem with an associated value.

Note: All GenericBppMenuIconItem objects must be managed by std::shared_ptr.

Parameters

icon	The image for the item's icon. The shared pointer is moved into this object.
label	Short text presented to the user as the menu item.
description	Longer text optionally presented to the user to provide a better idea of what the option does.
value	The current value associated with the menu item.
flags	The option flags for the item. While the default is zero, the MenuItem::HasValue flag will be OR'd with the given value by the constructor.

Definition at line 420 of file BppIconItem.hpp.

Member Function Documentation

◆ make() [1/9]

static std::shared_ptr<GenericBppMenuIconItem> duds::ui::menu::renderers::GenericBppMenuIconItem::make	(	const std::string &	label,
		Flags	flags = `Flags::Zero()`
	)

inlinestatic

Makes a shared pointer holding a new GenericBppMenuIconItem.

Parameters

label	Short text presented to the user as the menu item.
flags	The option flags for the item. The default is zero: enabled, visible, no value, and not a toggle.

Examples:: bppmenu.cpp.

Definition at line 435 of file BppIconItem.hpp.

◆ make() [2/9]

static std::shared_ptr<GenericBppMenuIconItem> duds::ui::menu::renderers::GenericBppMenuIconItem::make	(	const duds::ui::graphics::ConstBppImageSptr &	icon,
		const std::string &	label,
		Flags	flags = `Flags::Zero()`
	)

inlinestatic

Makes a shared pointer holding a new GenericBppMenuIconItem.

Parameters

icon	The image for the item's icon.
label	Short text presented to the user as the menu item.
flags	The option flags for the item. The default is zero: enabled, visible, no value, and not a toggle.

Definition at line 452 of file BppIconItem.hpp.

◆ make() [3/9]

static std::shared_ptr<GenericBppMenuIconItem> duds::ui::menu::renderers::GenericBppMenuIconItem::make	(	duds::ui::graphics::ConstBppImageSptr &&	icon,
		const std::string &	label,
		Flags	flags = `Flags::Zero()`
	)

inlinestatic

Makes a shared pointer holding a new GenericBppMenuIconItem.

Parameters

icon	The image for the item's icon. The shared pointer is moved into this object.
label	Short text presented to the user as the menu item.
flags	The option flags for the item. The default is zero: enabled, visible, no value, and not a toggle.

Definition at line 472 of file BppIconItem.hpp.

◆ make() [4/9]

static std::shared_ptr<GenericBppMenuIconItem> duds::ui::menu::renderers::GenericBppMenuIconItem::make	(	const std::string &	label,
		const std::string &	description,
		Flags	flags = `Flags::Zero()`
	)

inlinestatic

Makes a shared pointer holding a new GenericBppMenuIconItem.

Parameters

label	Short text presented to the user as the menu item.
description	Longer text optionally presented to the user to provide a better idea of what the option does.
flags	The option flags for the item. The default is zero: enabled, visible, no value, and not a toggle.

Definition at line 492 of file BppIconItem.hpp.

◆ make() [5/9]

static std::shared_ptr<GenericBppMenuIconItem> duds::ui::menu::renderers::GenericBppMenuIconItem::make	(	const duds::ui::graphics::ConstBppImageSptr &	icon,
		const std::string &	label,
		const std::string &	description,
		Flags	flags = `Flags::Zero()`
	)

inlinestatic

Makes a shared pointer holding a new GenericBppMenuIconItem.

Parameters

icon	The image for the item's icon.
label	Short text presented to the user as the menu item.
description	Longer text optionally presented to the user to provide a better idea of what the option does.
flags	The option flags for the item. The default is zero: enabled, visible, no value, and not a toggle.

Definition at line 513 of file BppIconItem.hpp.

◆ make() [6/9]

static std::shared_ptr<GenericBppMenuIconItem> duds::ui::menu::renderers::GenericBppMenuIconItem::make	(	duds::ui::graphics::ConstBppImageSptr &&	icon,
		const std::string &	label,
		const std::string &	description,
		Flags	flags = `Flags::Zero()`
	)

inlinestatic

Makes a shared pointer holding a new GenericBppMenuIconItem.

Parameters

icon	The image for the item's icon. The shared pointer is moved into this object.
label	Short text presented to the user as the menu item.
description	Longer text optionally presented to the user to provide a better idea of what the option does.
flags	The option flags for the item. The default is zero: enabled, visible, no value, and not a toggle.

Definition at line 537 of file BppIconItem.hpp.

◆ make() [7/9]

static std::shared_ptr<GenericBppMenuIconItem> duds::ui::menu::renderers::GenericBppMenuIconItem::make	(	const std::string &	label,
		const std::string &	description,
		const std::string &	value,
		Flags	flags = `Flags::Zero()`
	)

inlinestatic

Makes a shared pointer holding a new GenericBppMenuIconItem.

Parameters

label	Short text presented to the user as the menu item.
description	Longer text optionally presented to the user to provide a better idea of what the option does.
value	The current value associated with the menu item.
flags	The option flags for the item. The default is zero: enabled, visible, no value, and not a toggle.

Definition at line 560 of file BppIconItem.hpp.

◆ make() [8/9]

static std::shared_ptr<GenericBppMenuIconItem> duds::ui::menu::renderers::GenericBppMenuIconItem::make	(	const duds::ui::graphics::ConstBppImageSptr &	icon,
		const std::string &	label,
		const std::string &	description,
		const std::string &	value,
		Flags	flags = `Flags::Zero()`
	)

inlinestatic

Makes a shared pointer holding a new GenericBppMenuIconItem.

Parameters

icon	The image for the item's icon.
label	Short text presented to the user as the menu item.
description	Longer text optionally presented to the user to provide a better idea of what the option does.
value	The current value associated with the menu item.
flags	The option flags for the item. The default is zero: enabled, visible, no value, and not a toggle.

Definition at line 584 of file BppIconItem.hpp.

◆ make() [9/9]

static std::shared_ptr<GenericBppMenuIconItem> duds::ui::menu::renderers::GenericBppMenuIconItem::make	(	duds::ui::graphics::ConstBppImageSptr &&	icon,
		const std::string &	label,
		const std::string &	description,
		const std::string &	value,
		Flags	flags = `Flags::Zero()`
	)

inlinestatic

Makes a shared pointer holding a new GenericBppMenuIconItem.

Parameters

icon	The image for the item's icon. The shared pointer is moved into this object.
label	Short text presented to the user as the menu item.
description	Longer text optionally presented to the user to provide a better idea of what the option does.
value	The current value associated with the menu item.
flags	The option flags for the item. The default is zero: enabled, visible, no value, and not a toggle.

Definition at line 611 of file BppIconItem.hpp.

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

BppIconItem.hpp

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ GenericBppMenuIconItem() [1/9]

◆ GenericBppMenuIconItem() [2/9]

◆ GenericBppMenuIconItem() [3/9]

◆ GenericBppMenuIconItem() [4/9]

◆ GenericBppMenuIconItem() [5/9]

◆ GenericBppMenuIconItem() [6/9]

◆ GenericBppMenuIconItem() [7/9]

◆ GenericBppMenuIconItem() [8/9]

◆ GenericBppMenuIconItem() [9/9]

Member Function Documentation

◆ make() [1/9]

◆ make() [2/9]

◆ make() [3/9]

◆ make() [4/9]

◆ make() [5/9]

◆ make() [6/9]

◆ make() [7/9]

◆ make() [8/9]

◆ make() [9/9]