libyui  3.0.10
 All Classes Functions Variables Enumerations Friends
YTableItem Class Reference

#include <YTableItem.h>

Inheritance diagram for YTableItem:
YItem

Public Member Functions

 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())
 
virtual ~YTableItem ()
 
void addCell (YTableCell *cell_disown)
 
void addCell (const std::string &label, const std::string &iconName=std::string())
 
void deleteCells ()
 
YTableCellIterator cellsBegin ()
 
YTableCellConstIterator cellsBegin () const
 
YTableCellIterator cellsEnd ()
 
YTableCellConstIterator cellsEnd () const
 
const YTableCellcell (int index) const
 
YTableCellcell (int index)
 
int cellCount () const
 
bool hasCell (int index) const
 
std::string label (int index) const
 
std::string iconName (int index) const
 
bool hasIconName (int index) const
 
std::string label () const
 
- Public Member Functions inherited from YItem
 YItem (const std::string &label, bool selected=false)
 
 YItem (const std::string &label, const std::string &iconName, bool selected=false)
 
virtual ~YItem ()
 
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)
 
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 YItemparent () const
 

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 52 of file YTableItem.h.

Constructor & Destructor Documentation

YTableItem::YTableItem ( )

Default constructor. Use addCell() to give it any content.

Definition at line 29 of file YTableItem.cc.

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 ( )
virtual

Destructor.

This will delete all cells.

Definition at line 82 of file YTableItem.cc.

Member Function Documentation

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.

void YTableItem::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).

Definition at line 115 of file YTableItem.cc.

const YTableCell * YTableItem::cell ( int  index) const

Return the cell at the specified index (counting from 0 on) or 0 if there is none.

Definition at line 132 of file YTableItem.cc.

int YTableItem::cellCount ( ) const
inline

Return the number of cells this item has.

Definition at line 139 of file YTableItem.h.

YTableCellIterator YTableItem::cellsBegin ( )
inline

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

Definition at line 120 of file YTableItem.h.

YTableCellIterator YTableItem::cellsEnd ( )
inline

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

Definition at line 126 of file YTableItem.h.

void YTableItem::deleteCells ( )

Delete all cells.

Definition at line 89 of file YTableItem.cc.

bool YTableItem::hasCell ( int  index) const

Return 'true' if this item has a cell with the specified index (counting from 0 on), 'false' otherwise.

Definition at line 125 of file YTableItem.cc.

bool YTableItem::hasIconName ( int  index) const

Return 'true' if there is a cell with the specified index that has an icon name.

Definition at line 162 of file YTableItem.cc.

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.

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.

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

Just for debugging.

Definition at line 168 of file YTableItem.h.


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