|
libyui
|
#include <YTable.h>
Public Member Functions | |
| virtual | ~YTable () |
| virtual const char * | widgetClass () const |
| int | columns () const |
| bool | hasColumn (int column) const |
| string | header (int column) const |
| YAlignmentType | alignment (int column) const |
| bool | immediateMode () const |
| void | setImmediateMode (bool immediateMode=true) |
| bool | keepSorting () const |
| virtual void | setKeepSorting (bool keepSorting) |
| bool | hasMultiSelection () const |
| virtual void | cellChanged (const YTableCell *cell)=0 |
| virtual bool | setProperty (const string &propertyName, const YPropertyValue &val) |
| virtual YPropertyValue | getProperty (const string &propertyName) |
| virtual const YPropertySet & | propertySet () |
| const char * | userInputProperty () |
Protected Member Functions | |
| YTable (YWidget *parent, YTableHeader *header, bool multiSelection) | |
| void | setTableHeader (YTableHeader *newHeader) |
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.
| YTable::YTable | ( | YWidget * | parent, |
| YTableHeader * | header, | ||
| bool | multiSelection | ||
| ) | [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.
'multiSelection' indicates whether or not the user can select multiple items at the same time (e.g., with shift-click or ctrl-click). This can only be set in the constructor.
| YTable::~YTable | ( | ) | [virtual] |
Destructor.
| YAlignmentType YTable::alignment | ( | int | column | ) | const |
Return the alignment for the specified column.
| virtual void YTable::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().
| int YTable::columns | ( | ) | const |
Return the number of columns of this table.
| YPropertyValue YTable::getProperty | ( | const string & | propertyName | ) | [virtual] |
| bool YTable::hasColumn | ( | int | column | ) | const |
Return 'true' if this table has a column no. 'column' (counting from 0 on).
| bool YTable::hasMultiSelection | ( | ) | const |
Return 'true' if the user can select multiple items at the same time (e.g., with shift-click or ctrl-click).
| string YTable::header | ( | int | column | ) | const |
Return the header text for the specified column.
| bool YTable::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".
| bool YTable::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.
| const YPropertySet & YTable::propertySet | ( | ) | [virtual] |
| void YTable::setImmediateMode | ( | bool | immediateMode = true | ) |
Set immediateMode() on or off.
| void YTable::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.
| bool YTable::setProperty | ( | const string & | propertyName, |
| const YPropertyValue & | val | ||
| ) | [virtual] |
| void YTable::setTableHeader | ( | YTableHeader * | newHeader | ) | [protected] |
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.
| const char* YTable::userInputProperty | ( | ) | [inline, virtual] |
| virtual const char* YTable::widgetClass | ( | ) | const [inline, virtual] |
Return a descriptive name of this widget class for logging, debugging etc.
Reimplemented from YSelectionWidget.
1.7.3
