libyui
 
Loading...
Searching...
No Matches
Public Member Functions | List of all members
YItem Class Reference

#include <YItem.h>

Inheritance diagram for YItem:
Inheritance graph
[legend]

Public Member Functions

 YItem (const std::string &label, bool selected=false)
 
 YItem (const std::string &label, const std::string &iconName, bool selected=false)
 
virtual ~YItem ()
 
virtual const char * itemClass () const
 
std::string label () const
 
void setLabel (const std::string &newLabel)
 
std::string iconName () const
 
bool hasIconName () const
 
void setIconName (const std::string &newIconName)
 
bool selected () const
 
void setSelected (bool sel=true)
 
int status () const
 
void setStatus (int newStatus)
 
void setIndex (int index)
 
int index () const
 
void setData (void *newData)
 
void * data () const
 
virtual bool hasChildren () const
 
virtual YItemIterator childrenBegin ()
 
virtual YItemConstIterator childrenBegin () const
 
virtual YItemIterator childrenEnd ()
 
virtual YItemConstIterator childrenEnd () const
 
virtual YItem * parent () const
 
virtual std::string debugLabel () const
 
std::string limitLength (const std::string &text, int limit) const
 

Detailed Description

Simple item class for SelectionBox, ComboBox, MultiSelectionBox etc. items. This class provides stubs for children management.

See also https://github.com/libyui/libyui-ncurses/blob/master/doc/nctable-and-nctree.md

Constructor & Destructor Documentation

◆ YItem() [1/2]

YItem::YItem ( const std::string & label,
bool selected = false )
inline

Constructor with just the label and optionally the selected state.

◆ YItem() [2/2]

YItem::YItem ( const std::string & label,
const std::string & iconName,
bool selected = false )
inline

Constructor with label and icon name and optionally the selected state.

◆ ~YItem()

virtual YItem::~YItem ( )
inlinevirtual

Destructor.

Member Function Documentation

◆ childrenBegin()

virtual YItemIterator YItem::childrenBegin ( )
inlinevirtual

Return an iterator that points to the first child item of this item.

This default implementation returns the 'end' iterator of the class-static always empty _noChildren YItemCollection. It is safe to use this iterator in classic iterator loops:

for ( YItemIterator it = myItem->childrenBegin(); it != myItem->childrenEnd(); ++it ) { ... }

The loop body will only ever be executed if this item is a derived class that actually manages child items.

Reimplemented in YTreeItem.

◆ childrenEnd()

virtual YItemIterator YItem::childrenEnd ( )
inlinevirtual

Return an iterator that points after the last child item of this item.

This default implementation returns the 'end' iterator of the class-static always empty _noChildren YItemCollection.

Reimplemented in YTreeItem.

◆ data()

void * YItem::data ( ) const
inline

Return the opaque data pointer.

◆ debugLabel()

string YItem::debugLabel ( ) const
virtual

Return a descriptive label of this item instance for debugging. This might be truncated if the original label is too long.

Reimplemented in YTableItem.

◆ hasChildren()

virtual bool YItem::hasChildren ( ) const
inlinevirtual

Return 'true' if this item has any child items.

Reimplemented in YTreeItem.

◆ hasIconName()

bool YItem::hasIconName ( ) const
inline

Return 'true' if this item has an icon name.

◆ iconName()

std::string YItem::iconName ( ) const
inline

Return this item's icon name.

◆ index()

int YItem::index ( ) const
inline

Return the index of this item (as set with setIndex() ).

◆ itemClass()

virtual const char * YItem::itemClass ( ) const
inlinevirtual

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

Reimplemented in YTableItem, and YTreeItem.

◆ label()

std::string YItem::label ( ) const
inline

Return this item's label. This is what the user sees in a dialog, so this will usually be a translated text.

◆ limitLength()

string YItem::limitLength ( const std::string & text,
int limit ) const

Return a string of maximum 'limit' characters. Add an ellipsis ("...") if it was truncated.

◆ parent()

virtual YItem * YItem::parent ( ) const
inlinevirtual

Return this item's parent item or 0 if it is a toplevel item. This default implementation always returns 0. Derived classes that handle children should reimplement this.

Reimplemented in YMenuItem, and YTreeItem.

◆ selected()

bool YItem::selected ( ) const
inline

Return 'true' if this item is currently selected.

◆ setData()

void YItem::setData ( void * newData)
inline

Set the opaque data pointer for application use.

Applications can use this to store the pointer to a counterpart of this tree item. It is the application's responsibility to watch for dangling pointers and possibliy deleting the data. All this class ever does with this pointer is to store it.

◆ setIconName()

void YItem::setIconName ( const std::string & newIconName)
inline

Set this item's icon name.

◆ setIndex()

void YItem::setIndex ( int index)
inline

Set this item's index.

◆ setLabel()

void YItem::setLabel ( const std::string & newLabel)
inline

Set this item's label.

◆ setSelected()

void YItem::setSelected ( bool sel = true)
inline

Select or unselect this item. This does not have any effect on any other item; if it is desired that only one item is selected at any time, the caller has to take care of that.

◆ setStatus()

void YItem::setStatus ( int newStatus)
inline

Set the status of this item. Most widgets only use 0 for "not selected" or nonzero for "selected". Some widgets may make use of other values as well.

◆ status()

int YItem::status ( ) const
inline

Return the status of this item. This is a bit more generalized than 'selected'. Values other than 0 or 1 can mean different things to the application or to the specific widget.

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