libyui-mga  1.0.7
YMGA_CBTable Class Referenceabstract

See document of YMGA_CBTable Table: Selection list with multiple columns. More...

#include <YMGA_CBTable.h>

Inheritance diagram for YMGA_CBTable:
Collaboration diagram for YMGA_CBTable:

Public Member Functions

virtual ~YMGA_CBTable ()
 Destructor.
 
virtual const char * widgetClass () const
 Return a descriptive name of this widget class for logging, debugging etc.
 
int columns () const
 Return the number of columns of this table.
 
bool hasColumn (int column) const
 Return 'true' if this table has a column no. More...
 
std::string header (int column) const
 Return the header text for the specified column.
 
YAlignmentType alignment (int column) const
 Return the alignment for the specified column.
 
bool immediateMode () const
 Deliver even more events than with notify() set. More...
 
void setImmediateMode (bool immediateMode=true)
 Set immediateMode() on or off.
 
bool keepSorting () const
 Return 'true' if the sort order is to be kept in item insertion order, i.e. More...
 
virtual void setKeepSorting (bool keepSorting)
 Switch between sorting by item insertion order (keepSorting: true) or allowing the user to sort by an arbitrary column (by clicking on the column header). More...
 
bool hasMultiSelection () const
 Return 'true' if the user can select multiple items at the same time (e.g., with shift-click or ctrl-click).
 
YCBTableMode tableMode ()
 returns the YCBTable checkbox position mode More...
 
virtual void cellChanged (const YTableCell *cell)=0
 Notification that a cell (its text and/or its icon) was changed from the outside. More...
 
virtual void checkItem (YItem *item, bool checked=true)=0
 check/uncheck Item from application. 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 YPropertySet & propertySet ()
 Return this class's property set. More...
 
const char * userInputProperty ()
 The name of the widget property that will return user input. More...
 
virtual void addItem (YItem *item_disown)
 Add one item. More...
 
void setTableHeader (YTableHeader *newHeader)
 Exchange the previous table header with a new one. More...
 
virtual YItem * item (int index) const
 From YSelectionWidget returns the item at index 'index' (from 0) or 0 if there is no such item.
 
virtual void setChangedItem (YCBTableItem *pItem)
 When derived classes emit YWidgetEvent with reason ValueChanged they have to set which item is changed. More...
 
virtual YCBTableItemchangedItem ()
 Return the item which value is changed (e.g. More...
 
YItemIterator nextItem (YItemIterator currentIterator)
 YSelectionWidget does not implement the increment of iterator and bindings seem not to work with iterator++, next function just returns the iterator icrementation, NOTE that it does not check input parameter, just increment it.
 
virtual void deleteAllItems ()
 Delete all items.
 
YItem * YItemIteratorToYItem (YItemIterator iter)
 useful cast for bindings. More...
 
YCBTableItemtoCBYTableItem (YItem *item)
 useful cast for bindings. More...
 

Protected Member Functions

 YMGA_CBTable (YWidget *parent, YTableHeader *header, YCBTableMode mode)
 Constructor. More...
 

Detailed Description

See document of YMGA_CBTable Table: Selection list with multiple columns.

The user can select exactly one row (with all its columns) from that list. Each cell (each column within each row) has a label text and an optional icon (*).

This widget is similar to SelectionBox, but it has several columns for each item (each row). If just one column is desired, consider using SelectionBox instead.

Note: This is not something like a spread sheet, and it doesn't pretend or want to be. Actions are performed on rows, not on individual cells (columns within one row).

(*) Not all UIs (in particular not text-based UIs) support displaying icons, so an icon should never be an exclusive means to display any kind of information.

Definition at line 114 of file YMGA_CBTable.h.

Constructor & Destructor Documentation

◆ YMGA_CBTable()

YMGA_CBTable::YMGA_CBTable ( YWidget *  parent,
YTableHeader *  header,
YCBTableMode  mode 
)
protected

Constructor.

'header' describes the table's headers: Number of columns, column headings, and column alignment. The widget assumes ownership of this object and will delete it when appropriate. The header cannot be changed after creating the widget.

'mode' indicates whether the checkbox is in the first or in the last column.

header must contains also header for checkbox column (empty string is allowed if not wanted)

Definition at line 55 of file YMGA_CBTable.cc.

Member Function Documentation

◆ addItem()

void YMGA_CBTable::addItem ( YItem *  item_disown)
virtual

Add one item.

This widget assumes ownership of the item object and will delete it in its destructor.

NOTE: For tree items, call this only for the toplevel items; all non-toplevel items are already owned by their respective parent items. Adding them to the parent widget will clash with this ownership.

Reimplementation of YSelectionWidget::addItem.

Definition at line 92 of file YMGA_CBTable.cc.

◆ cellChanged()

virtual void YMGA_CBTable::cellChanged ( const YTableCell *  cell)
pure virtual

Notification that a cell (its text and/or its icon) was changed from the outside.

Applications are required to call this whenever a table cell is changed after adding the corresponding table item (the row) to the table widget.

Derived classes are required to implement this and update the display accordingly.

Note that the position of this cell can be retrieved with cell->column() and cell->itemIndex().

◆ changedItem()

YCBTableItem * YMGA_CBTable::changedItem ( )
virtual

Return the item which value is changed (e.g.

checkbox).

Definition at line 75 of file YMGA_CBTable.cc.

◆ checkItem()

virtual void YMGA_CBTable::checkItem ( YItem *  item,
bool  checked = true 
)
pure virtual

check/uncheck Item from application.

Derived classes are required to implement this and update the display accordingly.

Note that item->check(true) does not update the table

◆ getProperty()

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

Get a property.

Reimplemented from YWidget.

This method may throw YUIPropertyExceptions.

Definition at line 256 of file YMGA_CBTable.cc.

Here is the call graph for this function:

◆ hasColumn()

bool YMGA_CBTable::hasColumn ( int  column) const

Return 'true' if this table has a column no.

'column' (counting from 0 on).

Definition at line 117 of file YMGA_CBTable.cc.

◆ immediateMode()

bool YMGA_CBTable::immediateMode ( ) const

Deliver even more events than with notify() set.

With "notify" alone, a table widget sends an ActivatedEvent when the user double-clicks an item or presses the "space" key on it. It does not send an event when the user just sends another item.

With "immediate", it also sends a SelectionChangedEvent when the user selects another item. "immediate" implicitly includes "notify".

Definition at line 135 of file YMGA_CBTable.cc.

◆ keepSorting()

bool YMGA_CBTable::keepSorting ( ) const

Return 'true' if the sort order is to be kept in item insertion order, i.e.

if sorting the table by clicking on a column header should be disabled.

Definition at line 150 of file YMGA_CBTable.cc.

◆ propertySet()

const YPropertySet & YMGA_CBTable::propertySet ( )
virtual

Return this class's property set.

This also initializes the property upon the first call.

Reimplemented from YWidget.

Definition at line 195 of file YMGA_CBTable.cc.

◆ setChangedItem()

void YMGA_CBTable::setChangedItem ( YCBTableItem pItem)
virtual

When derived classes emit YWidgetEvent with reason ValueChanged they have to set which item is changed.

Who manages the event have to use changedItem() to get it.

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

Definition at line 80 of file YMGA_CBTable.cc.

◆ setKeepSorting()

void YMGA_CBTable::setKeepSorting ( bool  keepSorting)
virtual

Switch between sorting by item insertion order (keepSorting: true) or allowing the user to sort by an arbitrary column (by clicking on the column header).

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

Definition at line 156 of file YMGA_CBTable.cc.

Here is the call graph for this function:

◆ setProperty()

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

Set a property.

Reimplemented from YWidget.

This function may throw YUIPropertyExceptions.

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

Definition at line 229 of file YMGA_CBTable.cc.

Here is the call graph for this function:

◆ setTableHeader()

void YMGA_CBTable::setTableHeader ( YTableHeader *  newHeader)

Exchange the previous table header with a new one.

This will delete the old YTableHeader object.

If the new header has a different number of columns than the old one, all items will implicitly be deleted.

Definition at line 99 of file YMGA_CBTable.cc.

Here is the call graph for this function:

◆ tableMode()

YCBTableMode YMGA_CBTable::tableMode ( )

returns the YCBTable checkbox position mode

Definition at line 86 of file YMGA_CBTable.cc.

◆ toCBYTableItem()

YCBTableItem * YMGA_CBTable::toCBYTableItem ( YItem *  item)

useful cast for bindings.

it just performs a dynamic_cast

Definition at line 190 of file YMGA_CBTable.cc.

Here is the call graph for this function:

◆ userInputProperty()

const char* YMGA_CBTable::userInputProperty ( )
inline

The name of the widget property that will return user input.

Inherited from YWidget.

Definition at line 272 of file YMGA_CBTable.h.

◆ YItemIteratorToYItem()

YItem * YMGA_CBTable::YItemIteratorToYItem ( YItemIterator  iter)

useful cast for bindings.

it does not any assunption on iter, so it is up to the user to check if it is valid, it just returns *it.

Definition at line 185 of file YMGA_CBTable.cc.


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