openshot-audio  0.1.5
Public Member Functions | Public Attributes | List of all members
PopupMenu::MenuItemIterator Class Reference

#include <juce_PopupMenu.h>

Public Member Functions

 MenuItemIterator (const PopupMenu &menu)
 
 ~MenuItemIterator ()
 
bool next ()
 
void addItemTo (PopupMenu &targetMenu)
 

Public Attributes

String itemName
 
const PopupMenusubMenu
 
int itemId
 
bool isSeparator
 
bool isTicked
 
bool isEnabled
 
bool isCustomComponent
 
bool isSectionHeader
 
const ColourcustomColour
 
const Drawableicon
 
ApplicationCommandManagercommandManager
 

Detailed Description

Allows you to iterate through the items in a pop-up menu, and examine their properties.

To use this, just create one and repeatedly call its next() method. When this returns true, all the member variables of the iterator are filled-out with information describing the menu item. When it returns false, the end of the list has been reached.

Constructor & Destructor Documentation

◆ MenuItemIterator()

PopupMenu::MenuItemIterator::MenuItemIterator ( const PopupMenu menu)

Creates an iterator that will scan through the items in the specified menu.

Be careful not to add any items to a menu while it is being iterated, or things could get out of step.

◆ ~MenuItemIterator()

PopupMenu::MenuItemIterator::~MenuItemIterator ( )

Destructor.

Member Function Documentation

◆ addItemTo()

void PopupMenu::MenuItemIterator::addItemTo ( PopupMenu targetMenu)

Adds an item to the target menu which has all the properties of this item.

◆ next()

bool PopupMenu::MenuItemIterator::next ( )

Returns true if there is another item, and sets up all this object's member variables to reflect that item's properties.

Member Data Documentation

◆ commandManager

ApplicationCommandManager* PopupMenu::MenuItemIterator::commandManager

◆ customColour

const Colour* PopupMenu::MenuItemIterator::customColour

◆ icon

const Drawable* PopupMenu::MenuItemIterator::icon

◆ isCustomComponent

bool PopupMenu::MenuItemIterator::isCustomComponent

◆ isEnabled

bool PopupMenu::MenuItemIterator::isEnabled

◆ isSectionHeader

bool PopupMenu::MenuItemIterator::isSectionHeader

◆ isSeparator

bool PopupMenu::MenuItemIterator::isSeparator

◆ isTicked

bool PopupMenu::MenuItemIterator::isTicked

◆ itemId

int PopupMenu::MenuItemIterator::itemId

◆ itemName

String PopupMenu::MenuItemIterator::itemName

◆ subMenu

const PopupMenu* PopupMenu::MenuItemIterator::subMenu

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