libyui
 
Loading...
Searching...
No Matches
YDumbTab Class Referenceabstract

#include <YDumbTab.h>

Inheritance diagram for YDumbTab:
Collaboration diagram for YDumbTab:

Public Member Functions

virtual ~YDumbTab ()
 
virtual const char * widgetClass () const
 
virtual void addItem (YItem *item)
 
virtual bool setProperty (const std::string &propertyName, const YPropertyValue &val)
 
virtual YPropertyValue getProperty (const std::string &propertyName)
 
virtual const YPropertySetpropertySet ()
 
virtual bool stretchable (YUIDimension dim) const
 
virtual std::string debugLabel () const
 
virtual void activate ()=0
 
- Public Member Functions inherited from YSelectionWidget
virtual ~YSelectionWidget ()
 
std::string label () const
 
void addItem (const std::string &itemLabel, bool selected=false)
 
void addItem (const std::string &itemLabel, const std::string &iconName, bool selected=false)
 
virtual void addItems (const YItemCollection &itemCollection)
 
virtual void deleteAllItems ()
 
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 ()
 
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
 
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

 YDumbTab (YWidget *parent)
 
- 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

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.

Constructor & Destructor Documentation

◆ YDumbTab()

YDumbTab::YDumbTab ( YWidget * parent)
protected

Constructor.

◆ ~YDumbTab()

YDumbTab::~YDumbTab ( )
virtual

Destructor.

Member Function Documentation

◆ activate()

virtual void YDumbTab::activate ( )
pure virtual

Activate selected tab. Can be used in tests to simulate user input.

Derived classes are required to implement this.

◆ 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.

◆ debugLabel()

string YDumbTab::debugLabel ( ) const
virtual

Descriptive label for debugging. Derived from this widget's only child (if there is one).

Reimplemented from YWidget.

◆ 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.

◆ 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.

◆ 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.

◆ 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.

◆ widgetClass()

virtual const char * YDumbTab::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: