Describes a popup menu item. More...
#include <juce_PopupMenu.h>
Public Member Functions | |
Item () | |
Creates a null item. | |
Item (String text) | |
Creates an item with the given text. | |
Item (const Item &) | |
Item & | operator= (const Item &) |
Item (Item &&) | |
Item & | operator= (Item &&) |
Item & | setTicked (bool shouldBeTicked=true) &noexcept |
Sets the isTicked flag (and returns a reference to this item to allow chaining). | |
Item & | setEnabled (bool shouldBeEnabled) &noexcept |
Sets the isEnabled flag (and returns a reference to this item to allow chaining). | |
Item & | setAction (std::function< void()> action) &noexcept |
Sets the action property (and returns a reference to this item to allow chaining). | |
Item & | setID (int newID) &noexcept |
Sets the itemID property (and returns a reference to this item to allow chaining). | |
Item & | setColour (Colour) &noexcept |
Sets the colour property (and returns a reference to this item to allow chaining). | |
Item & | setCustomComponent (ReferenceCountedObjectPtr< CustomComponent > customComponent) &noexcept |
Sets the customComponent property (and returns a reference to this item to allow chaining). | |
Item & | setImage (std::unique_ptr< Drawable >) &noexcept |
Sets the image property (and returns a reference to this item to allow chaining). | |
Item && | setTicked (bool shouldBeTicked=true) &&noexcept |
Sets the isTicked flag (and returns a reference to this item to allow chaining). | |
Item && | setEnabled (bool shouldBeEnabled) &&noexcept |
Sets the isEnabled flag (and returns a reference to this item to allow chaining). | |
Item && | setAction (std::function< void()> action) &&noexcept |
Sets the action property (and returns a reference to this item to allow chaining). | |
Item && | setID (int newID) &&noexcept |
Sets the itemID property (and returns a reference to this item to allow chaining). | |
Item && | setColour (Colour) &&noexcept |
Sets the colour property (and returns a reference to this item to allow chaining). | |
Item && | setCustomComponent (ReferenceCountedObjectPtr< CustomComponent > customComponent) &&noexcept |
Sets the customComponent property (and returns a reference to this item to allow chaining). | |
Item && | setImage (std::unique_ptr< Drawable >) &&noexcept |
Sets the image property (and returns a reference to this item to allow chaining). | |
Public Attributes | |
String | text |
The menu item's name. | |
int | itemID = 0 |
The menu item's ID. | |
std::function< void()> | action |
An optional function which should be invoked when this menu item is triggered. | |
std::unique_ptr< PopupMenu > | subMenu |
A sub-menu, or nullptr if there isn't one. | |
std::unique_ptr< Drawable > | image |
A drawable to use as an icon, or nullptr if there isn't one. | |
ReferenceCountedObjectPtr< CustomComponent > | customComponent |
A custom component for the item to display, or nullptr if there isn't one. | |
ReferenceCountedObjectPtr< CustomCallback > | customCallback |
A custom callback for the item to use, or nullptr if there isn't one. | |
ApplicationCommandManager * | commandManager = nullptr |
A command manager to use to automatically invoke the command, or nullptr if none is specified. | |
String | shortcutKeyDescription |
An optional string describing the shortcut key for this item. | |
Colour | colour |
A colour to use to draw the menu text. | |
bool | isEnabled = true |
True if this menu item is enabled. | |
bool | isTicked = false |
True if this menu item should have a tick mark next to it. | |
bool | isSeparator = false |
True if this menu item is a separator line. | |
bool | isSectionHeader = false |
True if this menu item is a section header. | |
bool | shouldBreakAfter = false |
True if this is the final item in the current column. | |
Describes a popup menu item.
PopupMenu::Item::Item | ( | ) |
PopupMenu::Item::Item | ( | String | text | ) |
Creates an item with the given text.
This constructor also initialises the itemID to -1, which makes it suitable for creating lambda-based item actions.
PopupMenu::Item::Item | ( | Item && | ) |
Sets the isTicked flag (and returns a reference to this item to allow chaining).
Sets the isEnabled flag (and returns a reference to this item to allow chaining).
Sets the action property (and returns a reference to this item to allow chaining).
Sets the itemID property (and returns a reference to this item to allow chaining).
Sets the colour property (and returns a reference to this item to allow chaining).
|
noexcept |
Sets the customComponent property (and returns a reference to this item to allow chaining).
Sets the image property (and returns a reference to this item to allow chaining).
Sets the isTicked flag (and returns a reference to this item to allow chaining).
Sets the isEnabled flag (and returns a reference to this item to allow chaining).
Sets the action property (and returns a reference to this item to allow chaining).
Sets the itemID property (and returns a reference to this item to allow chaining).
Sets the colour property (and returns a reference to this item to allow chaining).
|
noexcept |
Sets the customComponent property (and returns a reference to this item to allow chaining).
Sets the image property (and returns a reference to this item to allow chaining).
String PopupMenu::Item::text |
The menu item's name.
int PopupMenu::Item::itemID = 0 |
The menu item's ID.
This must not be 0 if you want the item to be triggerable, but if you're attaching an action callback to the item, you can set the itemID to -1 to indicate that it isn't actively needed.
std::function<void()> PopupMenu::Item::action |
An optional function which should be invoked when this menu item is triggered.
std::unique_ptr<PopupMenu> PopupMenu::Item::subMenu |
A sub-menu, or nullptr if there isn't one.
std::unique_ptr<Drawable> PopupMenu::Item::image |
A drawable to use as an icon, or nullptr if there isn't one.
ReferenceCountedObjectPtr<CustomComponent> PopupMenu::Item::customComponent |
A custom component for the item to display, or nullptr if there isn't one.
ReferenceCountedObjectPtr<CustomCallback> PopupMenu::Item::customCallback |
A custom callback for the item to use, or nullptr if there isn't one.
ApplicationCommandManager* PopupMenu::Item::commandManager = nullptr |
A command manager to use to automatically invoke the command, or nullptr if none is specified.
String PopupMenu::Item::shortcutKeyDescription |
An optional string describing the shortcut key for this item.
This is only used for displaying at the right-hand edge of a menu item - the menu won't attempt to actually catch or process the key. If you supply a commandManager parameter then the menu will attempt to fill-in this field automatically.
Colour PopupMenu::Item::colour |
A colour to use to draw the menu text.
By default this is transparent black, which means that the LookAndFeel should choose the colour.
True if this is the final item in the current column.