libyui  3.4.2
YTableItem Class Reference

Item class for YTable items. More...

#include <YTableItem.h>

Inheritance diagram for YTableItem:
YItem

Public Member Functions

 YTableItem ()
 Default constructor. More...
 
 YTableItem (const std::string &label_0, const std::string &label_1=std::string(), const std::string &label_2=std::string(), const std::string &label_3=std::string(), const std::string &label_4=std::string(), const std::string &label_5=std::string(), const std::string &label_6=std::string(), const std::string &label_7=std::string(), const std::string &label_8=std::string(), const std::string &label_9=std::string())
 Convenience constructor for table items without any icons. More...
 
virtual ~YTableItem ()
 Destructor. More...
 
void addCell (YTableCell *cell_disown)
 Add a cell. More...
 
void addCell (const std::string &label, const std::string &iconName=std::string())
 Create a new cell and add it (even if both 'label' and 'iconName' are empty).
 
void deleteCells ()
 Delete all cells.
 
YTableCellIterator cellsBegin ()
 Return an iterator that points to the first cell of this item.
 
YTableCellConstIterator cellsBegin () const
 
YTableCellIterator cellsEnd ()
 Return an iterator that points after the last cell of this item.
 
YTableCellConstIterator cellsEnd () const
 
const YTableCellcell (int index) const
 Return the cell at the specified index (counting from 0 on) or 0 if there is none.
 
YTableCellcell (int index)
 
int cellCount () const
 Return the number of cells this item has.
 
bool hasCell (int index) const
 Return 'true' if this item has a cell with the specified index (counting from 0 on), 'false' otherwise.
 
std::string label (int index) const
 Return the label of cell no. More...
 
std::string iconName (int index) const
 Return the icon name of cell no. More...
 
bool hasIconName (int index) const
 Return 'true' if there is a cell with the specified index that has an icon name.
 
std::string label () const
 Just for debugging.
 
- Public Member Functions inherited from YItem
 YItem (const std::string &label, bool selected=false)
 Constructor with just the label and optionally the selected state.
 
 YItem (const std::string &label, const std::string &iconName, bool selected=false)
 Constructor with label and icon name and optionally the selected state.
 
virtual ~YItem ()
 Destructor.
 
std::string label () const
 Return this item's label. More...
 
void setLabel (const std::string &newLabel)
 Set this item's label.
 
std::string iconName () const
 Return this item's icon name.
 
bool hasIconName () const
 Return 'true' if this item has an icon name.
 
void setIconName (const std::string &newIconName)
 Set this item's icon name.
 
bool selected () const
 Return 'true' if this item is currently selected.
 
void setSelected (bool sel=true)
 Select or unselect this item. More...
 
void setIndex (int index)
 Set this item's index.
 
int index () const
 Return the index of this item (as set with setIndex() ).
 
void setData (void *newData)
 Set the opaque data pointer for application use. More...
 
void * data () const
 Return the opaque data pointer.
 
virtual bool hasChildren () const
 Return 'true' if this item has any child items.
 
virtual YItemIterator childrenBegin ()
 Return an iterator that points to the first child item of this item. More...
 
virtual YItemConstIterator childrenBegin () const
 
virtual YItemIterator childrenEnd ()
 Return an iterator that points after the last child item of this item. More...
 
virtual YItemConstIterator childrenEnd () const
 
virtual YItemparent () const
 Returns this item's parent item or 0 if it is a toplevel item. More...
 

Detailed Description

Item class for YTable items.

Each YTableItem corresponds to one row in a YTable.

A YTableItem might have any number of cells (columns within this row), including none. The YTable widget is free to ignore any excess cells if there are more than the YTable widget has columns. The YTable widget is to treat nonexistent cells like empty ones.

Note that while YTable items and their cells can be manipulated through pointers, their visual representation on screen might be updated only upon calling certain methods of the YTable widget. See the YTable reference for details.

Definition at line 58 of file YTableItem.h.

Constructor & Destructor Documentation

◆ YTableItem() [1/2]

YTableItem::YTableItem ( )

Default constructor.

Use addCell() to give it any content.

Definition at line 29 of file YTableItem.cc.

◆ YTableItem() [2/2]

YTableItem::YTableItem ( const std::string &  label_0,
const std::string &  label_1 = std::string(),
const std::string &  label_2 = std::string(),
const std::string &  label_3 = std::string(),
const std::string &  label_4 = std::string(),
const std::string &  label_5 = std::string(),
const std::string &  label_6 = std::string(),
const std::string &  label_7 = std::string(),
const std::string &  label_8 = std::string(),
const std::string &  label_9 = std::string() 
)

Convenience constructor for table items without any icons.

This will create up to 10 (0..9) cells. Empty cells for empty labels at the end of the labels are not created, but empty cells in between are.

new YTableItem( "one", "two", "", "", "five" );

will create an item with 5 cells:

cell[0] ==> "one"
cell[1] ==> "two"
cell[2] ==> ""
cell[3] ==> ""
cell[4] ==> "five"

Definition at line 36 of file YTableItem.cc.

◆ ~YTableItem()

YTableItem::~YTableItem ( )
virtual

Destructor.

This will delete all cells.

Definition at line 82 of file YTableItem.cc.

Member Function Documentation

◆ addCell()

void YTableItem::addCell ( YTableCell cell_disown)

Add a cell.

This item will assume ownership over the cell and delete it when appropriate (when the table is destroyed or when table items are replaced), at which time the pointer will become invalid.

Cells can still be changed after they (and the item they belong to) are added, but in that case, YTable::cellChanged() needs to be called to update the table display accordingly.

Definition at line 105 of file YTableItem.cc.

◆ iconName()

std::string YTableItem::iconName ( int  index) const

Return the icon name of cell no.

'index' (counting from 0 on) or an empty string if there is no cell with that index.

Definition at line 155 of file YTableItem.cc.

◆ label()

std::string YTableItem::label ( int  index) const

Return the label of cell no.

'index' (counting from 0 on) or an empty string if there is no cell with that index.

Definition at line 148 of file YTableItem.cc.


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