Public Member Functions | Protected Member Functions

YContextMenu Class Reference

#include <YContextMenu.h>

Inheritance diagram for YContextMenu:
YSelectionWidget YWidget

List of all members.

Public Member Functions

virtual ~YContextMenu ()
virtual const char * widgetClass () const
virtual void rebuildMenuTree ()=0
virtual void addItems (const YItemCollection &itemCollection)
virtual void addItem (YItem *item_disown)
virtual void deleteAllItems ()
void resolveShortcutConflicts ()
virtual bool setProperty (const string &propertyName, const YPropertyValue &val)
virtual YPropertyValue getProperty (const string &propertyName)
virtual const YPropertySetpropertySet ()

Protected Member Functions

 YContextMenu ()
YMenuItemfindMenuItem (int index)
YMenuItemfindMenuItem (int index, YItemConstIterator begin, YItemConstIterator end)
YMenuItemitemAt (int index)

Detailed Description

ContextMenu: Similar to PushButton, but with several actions: Upon clicking on a ContextMenu (or activating it with the keyboard), a pop-up menu opens where the user can activate an action. Menu items in that pop-up menu can have submenus (that will pop up in separate pop-up menus).

Internally, this widget is more similar to the Tree widget. The difference is that it does not keep a "selected" status, but triggers an action right away, just like a PushButton. Like PushButton, ContextMenu sends an event right away when the user selects an item (clicks on a menu item or activates it with the keyboard). Items that have a submenu never send an event, they simply open their submenu when activated.

Constructor & Destructor Documentation

YContextMenu::YContextMenu ( ) [protected]


'label' is the user-visible text on the button (not above it like all other SelectionWidgets).

YContextMenu::~YContextMenu ( ) [virtual]


Member Function Documentation

void YContextMenu::addItem ( YItem item_disown) [virtual]

Add one item. This widget assumes ownership of the item object and will delete it in its destructor.

This reimplementation will an index to the item that is unique for all items in this ContextMenu. That index can be used later with findMenuItem() to find the item by that index.

Reimplemented from YSelectionWidget.

Reimplemented from YSelectionWidget.

void YContextMenu::addItems ( const YItemCollection &  itemCollection) [virtual]

Add multiple items. For some UIs, this can be more efficient than calling addItem() multiple times. This function also automatically calls resolveShortcutConflicts() and rebuildMenuTree() at the end.

Derived classes can overwrite this function, but they should call this base class function at the end of the new implementation.

Reimplemented from YSelectionWidget.

Reimplemented from YSelectionWidget.

void YContextMenu::deleteAllItems ( ) [virtual]

Delete all items.

Reimplemented from YSelectionWidget.

Reimplemented from YSelectionWidget.

YMenuItem * YContextMenu::findMenuItem ( int  index,
YItemConstIterator  begin,
YItemConstIterator  end 
) [protected]

Recursively find the first menu item with the specified index from iterator 'begin' to iterator 'end'.

Returns 0 if there is no such item.

YMenuItem * YContextMenu::findMenuItem ( int  index) [protected]

Recursively find the first menu item with the specified index. Returns 0 if there is no such item.

YPropertyValue YContextMenu::getProperty ( const string &  propertyName) [virtual]

Get a property. Reimplemented from YWidget.

This method may throw YUIPropertyExceptions.

Reimplemented from YWidget.

YMenuItem* YContextMenu::itemAt ( int  index) [inline, protected]

Alias for findMenuItem(). Reimplemented to ensure consistent behaviour with YSelectionWidget::itemAt().

const YPropertySet & YContextMenu::propertySet ( ) [virtual]

Return this class's property set. This also initializes the property upon the first call.

Reimplemented from YWidget.

Reimplemented from YWidget.

virtual void YContextMenu::rebuildMenuTree ( ) [pure virtual]

Rebuild the displayed menu tree from the internally stored YMenuItems.

The application should call this (once) after all items have been added with addItem(). YContextMenu::addItems() calls this automatically.

Derived classes are required to implement this.

void YContextMenu::resolveShortcutConflicts ( )

Resolve keyboard shortcut conflicts: Change shortcuts of menu items if there are duplicates in the respective menu level.

This has to be called after all items are added, but before rebuildMenuTree() (see above). YContextMenu::addItems() calls this automatically.

bool YContextMenu::setProperty ( const string &  propertyName,
const YPropertyValue val 
) [virtual]

Set a property. Reimplemented from YWidget.

This function may throw YUIPropertyExceptions.

This function returns 'true' if the value was successfully set and 'false' if that value requires special handling (not in error cases: those are covered by exceptions).

Reimplemented from YWidget.

virtual const char* YContextMenu::widgetClass ( ) const [inline, virtual]

Returns a descriptive name of this widget class for logging, debugging etc.

Reimplemented from YSelectionWidget.

The documentation for this class was generated from the following files:
 All Classes Functions Variables Enumerations Friends