#include <YContextMenu.h>

Inheritance diagram for YContextMenu:

Collaboration diagram for YContextMenu:

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 std::string &propertyName, const YPropertyValue &val)

virtual YPropertyValue	getProperty (const std::string &propertyName)

virtual const YPropertySet &	propertySet ()

Public Member Functions inherited from YSelectionWidget
virtual	~YSelectionWidget ()

std::string	label () const

virtual void	setLabel (const std::string &newLabel)

void	addItem (const std::string &itemLabel, bool selected=false)

void	addItem (const std::string &itemLabel, const std::string &iconName, bool selected=false)

void	setItems (const YItemCollection &itemCollection)

YItemIterator	itemsBegin ()

YItemConstIterator	itemsBegin () const

YItemIterator	itemsEnd ()

YItemConstIterator	itemsEnd () const

bool	hasItems () const

int	itemsCount () const

YItem *	itemAt (int index) const

YItem *	firstItem () const

virtual YItem *	selectedItem ()

virtual YItemCollection	selectedItems ()

bool	hasSelectedItem ()

virtual void	selectItem (YItem *item, bool selected=true)

virtual void	setItemStatus (YItem *item, int status)

virtual void	deselectAllItems ()

void	setIconBasePath (const std::string &basePath)

std::string	iconBasePath () const

std::string	iconFullPath (const std::string &iconName) const

std::string	iconFullPath (YItem *item) const

bool	itemsContain (YItem *item) const

YItem *	findItem (const std::string &itemLabel) const

void	dumpItems () const

bool	enforceSingleSelection () const

virtual void	shortcutChanged ()

virtual std::string	shortcutString () const

virtual void	setShortcutString (const std::string &str)

Public Member Functions inherited from YWidget
virtual	~YWidget ()

virtual std::string	debugLabel () const

std::string	helpText () const

void	setHelpText (const std::string &helpText)

bool	hasChildren () const

YWidget *	firstChild () const

YWidget *	lastChild () const

YWidgetListIterator	childrenBegin () const

YWidgetListIterator	childrenEnd () const

YWidgetListConstIterator	childrenConstBegin () const

YWidgetListConstIterator	childrenConstEnd () const

YWidgetListIterator	begin ()

YWidgetListIterator	end ()

int	childrenCount () const

bool	contains (YWidget *child) const

virtual void	addChild (YWidget *child)

virtual void	removeChild (YWidget *child)

void	deleteChildren ()

YWidget *	parent () const

bool	hasParent () const

void	setParent (YWidget *newParent)

YDialog *	findDialog ()

YWidget *	findWidget (YWidgetID *id, bool doThrow=true) const

virtual int	preferredWidth ()=0

virtual int	preferredHeight ()=0

virtual int	preferredSize (YUIDimension dim)

virtual void	setSize (int newWidth, int newHeight)=0

bool	isValid () const

bool	beingDestroyed () const

void *	widgetRep () const

void	setWidgetRep (void *toolkitWidgetRep)

bool	hasId () const

YWidgetID *	id () const

void	setId (YWidgetID *newId_disown)

virtual void	setEnabled (bool enabled=true)

void	setDisabled ()

virtual bool	isEnabled () const

virtual bool	stretchable (YUIDimension dim) const

void	setStretchable (YUIDimension dim, bool newStretch)

void	setDefaultStretchable (YUIDimension dim, bool newStretch)

virtual int	weight (YUIDimension dim)

bool	hasWeight (YUIDimension dim)

void	setWeight (YUIDimension dim, int weight)

void	setNotify (bool notify=true)

bool	notify () const

void	setNotifyContextMenu (bool notifyContextMenu=true)

bool	notifyContextMenu () const

bool	sendKeyEvents () const

void	setSendKeyEvents (bool doSend)

bool	autoShortcut () const

void	setAutoShortcut (bool _newAutoShortcut)

int	functionKey () const

bool	hasFunctionKey () const

virtual void	setFunctionKey (int fkey_no)

virtual bool	setKeyboardFocus ()

virtual const char *	userInputProperty ()

void	dumpWidgetTree (int indentationLevel=0)

void	dumpDialogWidgetTree ()

void	setChildrenEnabled (bool enabled)

virtual void	saveUserInput (YMacroRecorder *macroRecorder)

void *	operator new (size_t size)

void	operator delete (void *ptr) noexcept

virtual void	startMultipleChanges ()

virtual void	doneMultipleChanges ()

Protected Member Functions
	YContextMenu ()

YMenuItem *	findMenuItem (int index)

YMenuItem *	findMenuItem (int index, YItemConstIterator begin, YItemConstIterator end)

YMenuItem *	itemAt (int index)

Protected Member Functions inherited from YSelectionWidget
	YSelectionWidget (YWidget *parent, const std::string &label, bool enforceSingleSelection, bool recursiveSelection=false)

void	setEnforceSingleSelection (bool on)

void	setEnforceInitialSelection (bool on)

bool	enforceInitialSelection () const

bool	recursiveSelection () const

YItem *	findSelectedItem (YItemConstIterator begin, YItemConstIterator end)

void	findSelectedItems (YItemCollection &selectedItems, YItemConstIterator begin, YItemConstIterator end)

void	deselectAllItems (YItemIterator begin, YItemIterator end)

YItem *	findItem (const std::string &wantedItemLabel, YItemConstIterator begin, YItemConstIterator end) const

bool	itemsContain (YItem *wantedItem, YItemConstIterator begin, YItemConstIterator end) const

Protected Member Functions inherited from YWidget
	YWidget (YWidget *parent)

YWidgetChildrenManager *	childrenManager () const

void	setChildrenManager (YWidgetChildrenManager *manager)

void	setBeingDestroyed ()

void	dumpWidget (YWidget *w, int indentationLevel)

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.

Note: unlike other widgets, this one is not created via YWidgetFactory or YOptionalWidgetFactory but with YApplication::openContextMenu()

Constructor & Destructor Documentation

◆ YContextMenu()

YContextMenu::YContextMenu ( )

protected

Constructor.

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

◆ ~YContextMenu()

YContextMenu::~YContextMenu ( )

virtual

Destructor.

Member Function Documentation

◆ addItem()

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.

◆ addItems()

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.

◆ deleteAllItems()

void YContextMenu::deleteAllItems ( )

virtual

Delete all items.

Reimplemented from YSelectionWidget.

◆ findMenuItem() [1/2]

YMenuItem * YContextMenu::findMenuItem ( int index )

protected

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

◆ findMenuItem() [2/2]

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.

◆ getProperty()

YPropertyValue YContextMenu::getProperty ( const std::string & propertyName )

virtual

Get a property. Reimplemented from YWidget.

This method may throw YUIPropertyExceptions.

Reimplemented from YWidget.

◆ itemAt()

YMenuItem * YContextMenu::itemAt ( int index )

inlineprotected

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

◆ propertySet()

const YPropertySet & YContextMenu::propertySet ( )

virtual

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

Reimplemented from YWidget.

◆ rebuildMenuTree()

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.

◆ resolveShortcutConflicts()

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.

◆ setProperty()

bool YContextMenu::setProperty	(	const std::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.

◆ widgetClass()

virtual const char * YContextMenu::widgetClass ( ) const

inlinevirtual

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:

/__w/libyui/libyui/libyui/src/YContextMenu.h
/__w/libyui/libyui/libyui/src/YContextMenu.cc

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ YContextMenu()

◆ ~YContextMenu()

Member Function Documentation

◆ addItem()

◆ addItems()

◆ deleteAllItems()

◆ findMenuItem() [1/2]

◆ findMenuItem() [2/2]

◆ getProperty()

◆ itemAt()

◆ propertySet()

◆ rebuildMenuTree()

◆ resolveShortcutConflicts()

◆ setProperty()

◆ widgetClass()