Describes a popup menu item. More...

Public Member Functions

 Item () noexcept
 Creates a null item. More...
 
 Item (const Item &)
 Creates a copy of an item. More...
 
Itemoperator= (const Item &)
 Creates a copy of an item. More...
 

Public Attributes

String text
 The menu item's name. More...
 
int itemID = 0
 The menu item's ID. More...
 
ScopedPointer< PopupMenusubMenu
 A sub-menu, or nullptr if there isn't one. More...
 
ScopedPointer< Drawableimage
 A drawable to use as an icon, or nullptr if there isn't one. More...
 
ReferenceCountedObjectPtr< CustomComponentcustomComponent
 A custom component for the item to display, or nullptr if there isn't one. More...
 
ReferenceCountedObjectPtr< CustomCallbackcustomCallback
 A custom callback for the item to use, or nullptr if there isn't one. More...
 
ApplicationCommandManagercommandManager = nullptr
 A command manager to use to automatically invoke the command, or nullptr if none is specified. More...
 
String shortcutKeyDescription
 An optional string describing the shortcut key for this item. More...
 
Colour colour
 A colour to use to draw the menu text. More...
 
bool isEnabled = true
 True if this menu item is enabled. More...
 
bool isTicked = false
 True if this menu item should have a tick mark next to it. More...
 
bool isSeparator = false
 True if this menu item is a separator line. More...
 
bool isSectionHeader = false
 True if this menu item is a section header. More...
 

Detailed Description

Describes a popup menu item.

Constructor & Destructor Documentation

◆ Item() [1/2]

PopupMenu::Item::Item ( )
noexcept

Creates a null item.

You'll need to set some fields after creating an Item before you can add it to a PopupMenu

◆ Item() [2/2]

PopupMenu::Item::Item ( const Item )

Creates a copy of an item.

Member Function Documentation

◆ operator=()

Item& PopupMenu::Item::operator= ( const Item )

Creates a copy of an item.

Member Data Documentation

◆ text

String PopupMenu::Item::text

The menu item's name.

◆ itemID

int PopupMenu::Item::itemID = 0

The menu item's ID.

This must not be 0 if you want the item to be triggerable!

◆ subMenu

ScopedPointer<PopupMenu> PopupMenu::Item::subMenu

A sub-menu, or nullptr if there isn't one.

◆ image

ScopedPointer<Drawable> PopupMenu::Item::image

A drawable to use as an icon, or nullptr if there isn't one.

◆ customComponent

ReferenceCountedObjectPtr<CustomComponent> PopupMenu::Item::customComponent

A custom component for the item to display, or nullptr if there isn't one.

◆ customCallback

ReferenceCountedObjectPtr<CustomCallback> PopupMenu::Item::customCallback

A custom callback for the item to use, or nullptr if there isn't one.

◆ commandManager

ApplicationCommandManager* PopupMenu::Item::commandManager = nullptr

A command manager to use to automatically invoke the command, or nullptr if none is specified.

◆ shortcutKeyDescription

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

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.

◆ isEnabled

bool PopupMenu::Item::isEnabled = true

True if this menu item is enabled.

◆ isTicked

bool PopupMenu::Item::isTicked = false

True if this menu item should have a tick mark next to it.

◆ isSeparator

bool PopupMenu::Item::isSeparator = false

True if this menu item is a separator line.

◆ isSectionHeader

bool PopupMenu::Item::isSectionHeader = false

True if this menu item is a section header.


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