Banshee Engine Docs

class GUIDropDownDataEntry

Represents a single entry in a drop down box.

Public

Methods

staticSeparator

static GUIDropDownDataEntry Separator()

Creates a new separator entry.

staticButton

static GUIDropDownDataEntry Button(const String &label, std::function<void ()> callback, const String &shortcutTag = StringUtility::kBlank)

Creates a new button entry with the specified callback that is triggered when button is selected.

staticSubMenu

static GUIDropDownDataEntry SubMenu(const String &label, const GUIDropDownData &data)

Creates a new sub-menu entry that will open the provided drop down data sub-menu when activated.

IsSeparator

bool IsSeparator() const

Check is the entry a separator.

IsSubMenu

bool IsSubMenu() const

Check is the entry a sub menu.

GetLabel

const String &GetLabel() const

Returns display label of the entry (if an entry is a button or a sub-menu).

GetShortcutTag

const String &GetShortcutTag() const

Returns the shortcut key combination string that is to be displayed along the entry label.

GetCallback

std::function<void ()> GetCallback() const

Returns a button callback if the entry (if an entry is a button).

GetSubMenuData

const GUIDropDownData &GetSubMenuData() const

Returns sub-menu data that is used for creating a sub-menu (if an entry is a sub-menu).

Private

Constructors

GUIDropDownDataEntry

GUIDropDownDataEntry()

Fields

mCallback

std::function<void ()> mCallback

mChildData

GUIDropDownData mChildData

mLabel

String mLabel

mShortcutTag

String mShortcutTag

mType

Type mType