libyui
 
Loading...
Searching...
No Matches
YMenuBar Class Reference

#include <YMenuBar.h>

Inheritance diagram for YMenuBar:
Collaboration diagram for YMenuBar:

Public Member Functions

virtual ~YMenuBar ()
 
YMenuItemaddMenu (const std::string &label, const std::string &iconName="")
 
virtual const char * widgetClass () const
 
virtual bool setProperty (const std::string &propertyName, const YPropertyValue &val)
 
virtual YPropertyValue getProperty (const std::string &propertyName)
 
virtual const YPropertySetpropertySet ()
 
- Public Member Functions inherited from YMenuWidget
virtual ~YMenuWidget ()
 
virtual void rebuildMenuTree ()=0
 
virtual void addItems (const YItemCollection &itemCollection)
 
virtual void addItem (YItem *item_disown)
 
virtual void deleteAllItems ()
 
void resolveShortcutConflicts ()
 
virtual void setItemEnabled (YMenuItem *item, bool enabled)
 
virtual void setItemVisible (YMenuItem *item, bool visible)
 
YMenuItemfindItem (std::vector< std::string > &path) const
 
virtual void activateItem (YMenuItem *item)=0
 
YMenuItemfindMenuItem (int index)
 
- 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
 
YItemitemAt (int index) const
 
YItemfirstItem () const
 
virtual YItemselectedItem ()
 
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
 
YItemfindItem (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
 
YWidgetfirstChild () const
 
YWidgetlastChild () 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 ()
 
YWidgetparent () const
 
bool hasParent () const
 
void setParent (YWidget *newParent)
 
YDialogfindDialog ()
 
YWidgetfindWidget (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
 
YWidgetIDid () 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

 YMenuBar (YWidget *parent)
 
- Protected Member Functions inherited from YMenuWidget
 YMenuWidget (YWidget *parent, const std::string &label="")
 
void resolveShortcutConflicts (YItemConstIterator begin, YItemConstIterator end)
 
YMenuItemfindMenuItem (int index, YItemConstIterator begin, YItemConstIterator end)
 
YMenuItemfindItem (std::vector< std::string >::iterator path_begin, std::vector< std::string >::iterator path_end, YItemConstIterator begin, YItemConstIterator end) const
 
YMenuItemitemAt (int index)
 
void assignUniqueIndex (YItemIterator begin, YItemIterator end)
 
- 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
 
YItemfindSelectedItem (YItemConstIterator begin, YItemConstIterator end)
 
void findSelectedItems (YItemCollection &selectedItems, YItemConstIterator begin, YItemConstIterator end)
 
void deselectAllItems (YItemIterator begin, YItemIterator end)
 
YItemfindItem (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)
 
YWidgetChildrenManagerchildrenManager () const
 
void setChildrenManager (YWidgetChildrenManager *manager)
 
void setBeingDestroyed ()
 
void dumpWidget (YWidget *w, int indentationLevel)
 

Detailed Description

A classical menu bar for pulldown menus.

Use this only when appropriate: In most places, YaST follows a wizard-driven UI strategy, asking the user (ideally) one question at a time, with a [Next] and a [Back] button to move between wizard steps. One of the last steps is usually presenting the collected information to the user until everything is applied.

A menu bar OTOH is meant for the opposite UI strategy: Presenting some kind of document (which may also be a number of input fields) to the user as the central point and providing lots of different operations on that document. The two concepts don't mix very well, so use this widget with caution.

A menu bar should only contain menus, no direct actions.

Constructor & Destructor Documentation

◆ YMenuBar()

YMenuBar::YMenuBar ( YWidget * parent)
protected

Constructor.

◆ ~YMenuBar()

YMenuBar::~YMenuBar ( )
virtual

Destructor.

Member Function Documentation

◆ addMenu()

YMenuItem * YMenuBar::addMenu ( const std::string & label,
const std::string & iconName = "" )

Create a new menu and add it.

◆ getProperty()

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

Get a property. Reimplemented from YWidget.

This method may throw YUIPropertyExceptions.

Reimplemented from YWidget.

◆ propertySet()

const YPropertySet & YMenuBar::propertySet ( )
virtual

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

Reimplemented from YWidget.

Reimplemented from YWidget.

◆ setProperty()

bool YMenuBar::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 * YMenuBar::widgetClass ( ) const
inlinevirtual

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

Reimplemented from YMenuWidget.


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