Allows you to iterate through the items in a pop-up menu, and examine their properties. More...
#include <juce_PopupMenu.h>
Public Member Functions | |
MenuItemIterator (const PopupMenu &menu, bool searchRecursively=false) | |
Creates an iterator that will scan through the items in the specified menu. More... | |
~MenuItemIterator () | |
Destructor. More... | |
Item & | getItem () const |
Returns a reference to the description of the current item. More... | |
bool | next () |
Returns true if there is another item, and sets up all this object's member variables to reflect that item's properties. More... | |
Private Member Functions | |
MenuItemIterator & | operator= (const MenuItemIterator &) |
Private Attributes | |
PopupMenu::Item * | currentItem = nullptr |
Array< int > | index |
Array< const PopupMenu * > | menus |
bool | searchRecursively |
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.
juce::PopupMenu::MenuItemIterator::MenuItemIterator | ( | const PopupMenu & | menu, |
bool | searchRecursively = false |
||
) |
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.
menu | the menu that needs to be scanned |
searchRecursively | if true, all submenus will be recursed into to do an exhaustive search |
juce::PopupMenu::MenuItemIterator::~MenuItemIterator | ( | ) |
Destructor.
Item& juce::PopupMenu::MenuItemIterator::getItem | ( | ) | const |
Returns a reference to the description of the current item.
It is only valid to call this after next() has returned true!
bool juce::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.
|
private |
|
private |
|
private |