libyui  3.4.2
YDumbTab Class Reference

DumbTab: A very simple tab widget that can display and switch between a number of tabs, but will only deliver the "user clicked on tab " event very much like a PushButton does. More...

#include <YDumbTab.h>

Inheritance diagram for YDumbTab:
YSelectionWidget YWidget

Public Member Functions

virtual ~YDumbTab ()
 Destructor.
 
virtual const char * widgetClass () const
 Returns a descriptive name of this widget class for logging, debugging etc.
 
virtual void addItem (YItem *item)
 Add an item (a tab page). More...
 
virtual void shortcutChanged ()
 Notification that any shortcut of any item was changed by the shortcut conflict manager. More...
 
virtual bool setProperty (const std::string &propertyName, const YPropertyValue &val)
 Set a property. More...
 
virtual YPropertyValue getProperty (const std::string &propertyName)
 Get a property. More...
 
virtual const YPropertySetpropertySet ()
 Return this class's property set. More...
 
virtual std::string shortcutString () const
 Get the string of this widget that holds the keyboard shortcut. More...
 
virtual void setShortcutString (const std::string &str)
 Set the string of this widget that holds the keyboard shortcut. More...
 
virtual bool stretchable (YUIDimension dim) const
 Returns 'true' if this widget is stretchable in the specified dimension. More...
 
virtual std::string debugLabel () const
 Descriptive label for debugging. More...
 
- Public Member Functions inherited from YSelectionWidget
virtual ~YSelectionWidget ()
 Destructor.
 
std::string label () const
 Return this widget's label (the caption above the item list).
 
void addItem (const std::string &itemLabel, bool selected=false)
 Overloaded for convenience: Add an item by string.
 
void addItem (const std::string &itemLabel, const std::string &iconName, bool selected=false)
 Overloaded for convenience: Add an item with a text and an icon. More...
 
virtual void addItems (const YItemCollection &itemCollection)
 Add multiple items. More...
 
virtual void deleteAllItems ()
 Delete all items. More...
 
void setItems (const YItemCollection &itemCollection)
 Delete all items and add new items.
 
YItemIterator itemsBegin ()
 Return an iterator that points to the first item. More...
 
YItemConstIterator itemsBegin () const
 
YItemIterator itemsEnd ()
 Return an iterator that points behind the last item.
 
YItemConstIterator itemsEnd () const
 
bool hasItems () const
 Return 'true' if this widget has any items.
 
int itemsCount () const
 Return the number of items. More...
 
YItemfirstItem () const
 Return the first item or 0 if there is none.
 
virtual YItemselectedItem ()
 Return the (first) selected item or 0 if none is selected.
 
virtual YItemCollection selectedItems ()
 Return all selected items. More...
 
bool hasSelectedItem ()
 Return 'true' if any item is selected.
 
virtual void selectItem (YItem *item, bool selected=true)
 Select or deselect an item. More...
 
virtual void deselectAllItems ()
 Deselect all items. More...
 
void setIconBasePath (const std::string &basePath)
 Set this widget's base path where to look up icons. More...
 
std::string iconBasePath () const
 Return this widget's base path where to look up icons as set with setIconBasePath().
 
std::string iconFullPath (const std::string &iconName) const
 Return the full path + file name for the specified icon name. More...
 
std::string iconFullPath (YItem *item) const
 Return the full path + file name for the icon of the specified item. More...
 
bool itemsContain (YItem *item) const
 Return 'true' if this widget's items contain the specified item.
 
YItemfindItem (const std::string &itemLabel) const
 Find the (first) item with the specified label. More...
 
- Public Member Functions inherited from YWidget
virtual ~YWidget ()
 Destructor.
 
std::string helpText () const
 Return the help text for this widget.
 
void setHelpText (const std::string &helpText)
 Set a help text for this widget. More...
 
bool hasChildren () const
 Returns 'true' if this widget has any children.
 
YWidgetfirstChild () const
 Returns the first child or 0 if there is none. More...
 
YWidgetlastChild () const
 Returns the last child or 0 if there is none.
 
YWidgetListIterator childrenBegin () const
 Return an iterator that points to the first child or to childrenEnd() if there are no children.
 
YWidgetListIterator childrenEnd () const
 Return an interator that points after the last child.
 
YWidgetListConstIterator childrenConstBegin () const
 Return a const iterator that points to the first child or to childrenEnd() if there are no children.
 
YWidgetListConstIterator childrenConstEnd () const
 Return a const interator that points after the last child.
 
YWidgetListIterator begin ()
 A helper for the range-based "for" loop. More...
 
YWidgetListIterator end ()
 A helper for the range-based "for" loop. More...
 
int childrenCount () const
 Returns the current number of children.
 
bool contains (YWidget *child) const
 Checks if 'child' is a (direct!) child of this widget.
 
virtual void addChild (YWidget *child)
 Add a new child. More...
 
virtual void removeChild (YWidget *child)
 Remove a child. More...
 
void deleteChildren ()
 Delete all children and remove them from the children manager's list.
 
YWidgetparent () const
 Return this widget's parent or 0 if it doesn't have a parent.
 
bool hasParent () const
 Return 'true' if this widget has a parent, 'false' if not.
 
void setParent (YWidget *newParent)
 Set this widget's parent.
 
YDialogfindDialog ()
 Traverse up the widget hierarchy and find the dialog this widget belongs to. More...
 
YWidgetfindWidget (YWidgetID *id, bool doThrow=true) const
 Recursively find a widget by its ID. More...
 
virtual int preferredWidth ()=0
 Preferred width of the widget. More...
 
virtual int preferredHeight ()=0
 Preferred height of the widget. More...
 
virtual int preferredSize (YUIDimension dim)
 Preferred size of the widget in the specified dimension. More...
 
virtual void setSize (int newWidth, int newHeight)=0
 Set the new size of the widget. More...
 
bool isValid () const
 Checks whether or not this object is valid. More...
 
bool beingDestroyed () const
 Check if this widget is in the process of being destroyed.
 
void * widgetRep () const
 Return a pointer to the underlying toolkit's (Qt, ...) widget representing this abstract UI widget.
 
void setWidgetRep (void *toolkitWidgetRep)
 Set the pointer to the underlying toolkit's (Qt, ...) widget representing this abstract UI widget. More...
 
bool hasId () const
 Returns 'true' if this widget has an ID.
 
YWidgetIDid () const
 Returns this widget's ID.
 
void setId (YWidgetID *newId_disown)
 Set this widget's ID. More...
 
virtual void setEnabled (bool enabled=true)
 Enable or disable this widget, i.e. More...
 
void setDisabled ()
 Disable this widget (overloaded for better readability).
 
virtual bool isEnabled () const
 Returns 'true' if this widget is enabled.
 
void setStretchable (YUIDimension dim, bool newStretch)
 Set the stretchable state to "newStretch" regardless of any hstretch or vstretch options.
 
void setDefaultStretchable (YUIDimension dim, bool newStretch)
 Set the stretchable state to "newStretch". More...
 
virtual int weight (YUIDimension dim)
 The weight is used in situations where all widgets can get their preferred size and yet space is available. More...
 
bool hasWeight (YUIDimension dim)
 Return whether or not the widget has a weight in the specified dimension.
 
void setWeight (YUIDimension dim, int weight)
 Set a weight in the specified dimension.
 
void setNotify (bool notify=true)
 Sets the Notify property.
 
bool notify () const
 Returns whether the widget will notify, i.e. More...
 
void setNotifyContextMenu (bool notifyContextMenu=true)
 Sets the notifyContextMenu property.
 
bool notifyContextMenu () const
 Returns whether the widget will send an event when the user clicks selects the context menu e.g. More...
 
bool sendKeyEvents () const
 Returns 'true' if this widget should send key events, i.e. More...
 
void setSendKeyEvents (bool doSend)
 Specify whether or not this widget should send key events.
 
bool autoShortcut () const
 Returns 'true' if a keyboard shortcut should automatically be assigned to this widget - without complaints in the log file.
 
void setAutoShortcut (bool _newAutoShortcut)
 Sets the 'autoShortcut' flag.
 
int functionKey () const
 Return a function key number that is assigned to this widget. More...
 
bool hasFunctionKey () const
 Check if a function key is assigned to this widget.
 
virtual void setFunctionKey (int fkey_no)
 Assign a function key to this widget (1 for F1, 2 for F2, etc. More...
 
virtual bool setKeyboardFocus ()
 Set the keyboard focus to this widget. More...
 
virtual const char * userInputProperty ()
 The name of the widget property that will return user input, if there is any. More...
 
void dumpWidgetTree (int indentationLevel=0)
 Debugging function: Dump the widget tree from here on to the log file.
 
void dumpDialogWidgetTree ()
 Debugging function: Dump the widget tree from this widget's dialog parent. More...
 
void setChildrenEnabled (bool enabled)
 Enable or disable all widgets in this widget tree.
 
virtual void saveUserInput (YMacroRecorder *macroRecorder)
 Recursively save the user input of all child widgets to a macro recorder: More...
 
void * operator new (size_t size)
 Overloaded operator new to ensure widgets are always created on the heap, never on the stack. More...
 
virtual void startMultipleChanges ()
 In some UIs updating the screen content is an expensive operation. More...
 
virtual void doneMultipleChanges ()
 

Protected Member Functions

 YDumbTab (YWidget *parent)
 Constructor.
 
- Protected Member Functions inherited from YSelectionWidget
 YSelectionWidget (YWidget *parent, const std::string &label, bool enforceSingleSelection, bool recurisveSelection=false)
 Constructor. More...
 
void setEnforceSingleSelection (bool on)
 Set single selection mode on or off. More...
 
bool enforceSingleSelection () const
 Return 'true' if this base class should enforce single selection.
 
bool recursiveSelection () const
 Return 'true' if this base class should select children recursively.
 
YItemfindSelectedItem (YItemConstIterator begin, YItemConstIterator end)
 Recursively try to find the first selected item between iterators 'begin' and 'end'. More...
 
void findSelectedItems (YItemCollection &selectedItems, YItemConstIterator begin, YItemConstIterator end)
 Recursively find all selected items between iterators 'begin' and 'end' and add each of them to the 'selectedItems' YItemCollection.
 
void deselectAllItems (YItemIterator begin, YItemIterator end)
 Recursively deselect all items between iterators 'begin' and 'end'.
 
YItemfindItem (const std::string &wantedItemLabel, YItemConstIterator begin, YItemConstIterator end) const
 Recursively try to find an item with label 'wantedItemLabel' between iterators 'begin' and 'end'. More...
 
bool itemsContain (YItem *wantedItem, YItemConstIterator begin, YItemConstIterator end) const
 Recursively check if 'wantedItem' is between iterators 'begin' and 'end'.
 
YItemitemAt (int index) const
 Return the item at index 'index' (from 0) or 0 if there is no such item.
 
- Protected Member Functions inherited from YWidget
 YWidget (YWidget *parent)
 Constructor.
 
YWidgetChildrenManagerchildrenManager () const
 Returns this widget's children manager.
 
void setChildrenManager (YWidgetChildrenManager *manager)
 Sets a new children manager for this widget. More...
 
void setBeingDestroyed ()
 Set the "being destroyed" flag, i.e. More...
 
void dumpWidget (YWidget *w, int indentationLevel)
 Helper function for dumpWidgetTree(): Dump one widget to the log file.
 

Detailed Description

DumbTab: A very simple tab widget that can display and switch between a number of tabs, but will only deliver the "user clicked on tab " event very much like a PushButton does.

Actually exchanging the content of the tab is left to the application.

DumbTab accepts a single child widget.

Definition at line 40 of file YDumbTab.h.

Member Function Documentation

◆ addItem()

void YDumbTab::addItem ( YItem item)
virtual

Add an item (a tab page).

Reimplemented from YSelectionWidget.

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

Reimplemented from YSelectionWidget.

Definition at line 66 of file YDumbTab.cc.

◆ debugLabel()

std::string YDumbTab::debugLabel ( ) const
virtual

Descriptive label for debugging.

Derived from this widget's only child (if there is one).

Reimplemented from YWidget.

Definition at line 83 of file YDumbTab.cc.

◆ getProperty()

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

Get a property.

Reimplemented from YWidget.

This method may throw exceptions, for example

  • if there is no property with that name

Reimplemented from YWidget.

Definition at line 139 of file YDumbTab.cc.

◆ propertySet()

const YPropertySet & YDumbTab::propertySet ( )
virtual

Return this class's property set.

This also initializes the property set upon the first call.

Reimplemented from YWidget.

Reimplemented from YWidget.

Definition at line 100 of file YDumbTab.cc.

◆ setProperty()

bool YDumbTab::setProperty ( const std::string &  propertyName,
const YPropertyValue val 
)
virtual

Set a property.

Reimplemented from YWidget.

This method may throw exceptions, for example

  • if there is no property with that name
  • if the expected type and the type mismatch
  • if the value is out of range

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.

Definition at line 122 of file YDumbTab.cc.

◆ setShortcutString()

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

Set the string of this widget that holds the keyboard shortcut.

Since YDumbTab doesn't have a shortcut for the widget itself (only for the tab pages, i.e. the items), this will simply trigger a shortcutChanged() notification.

Reimplemented from YSelectionWidget.

Reimplemented from YSelectionWidget.

Definition at line 130 of file YDumbTab.h.

◆ shortcutChanged()

virtual void YDumbTab::shortcutChanged ( )
inlinevirtual

Notification that any shortcut of any item was changed by the shortcut conflict manager.

Derived classes should reimplement this.

Definition at line 76 of file YDumbTab.h.

◆ shortcutString()

virtual std::string YDumbTab::shortcutString ( ) const
inlinevirtual

Get the string of this widget that holds the keyboard shortcut.

Notice that since YDumbTab has one shortcut for each tab page (for each item), this is not meaningful for this widget class.

Check YItemShortcut in YShortcut.{cc,h} for more details.

Reimplemented from YSelectionWidget.

Reimplemented from YSelectionWidget.

Definition at line 120 of file YDumbTab.h.

◆ stretchable()

bool YDumbTab::stretchable ( YUIDimension  dim) const
virtual

Returns 'true' if this widget is stretchable in the specified dimension.

In this case, the stretchability of the single child is returned.

Reimplemented from YWidget.

Reimplemented from YWidget.

Definition at line 73 of file YDumbTab.cc.


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