libyui  3.0.5
 All Classes Functions Variables Enumerations Friends
YTable Class Referenceabstract

#include <YTable.h>

Inheritance diagram for YTable:
Collaboration diagram for YTable:

Public Member Functions

virtual ~YTable ()
 
virtual const char * widgetClass () const
 
int columns () const
 
bool hasColumn (int column) const
 
std::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 std::string &propertyName, const YPropertyValue &val)
 
virtual YPropertyValue getProperty (const std::string &propertyName)
 
virtual const YPropertySetpropertySet ()
 
const char * userInputProperty ()
 
- Public Member Functions inherited from YSelectionWidget
virtual ~YSelectionWidget ()
 
std::string label () const
 
virtual void setLabel (const std::string &newLabel)
 
virtual void addItem (YItem *item_disown)
 
void addItem (const std::string &itemLabel, bool selected=false)
 
void addItem (const std::string &itemLabel, const std::string &iconName, bool selected=false)
 
virtual void addItems (const YItemCollection &itemCollection)
 
virtual void deleteAllItems ()
 
void setItems (const YItemCollection &itemCollection)
 
YItemIterator itemsBegin ()
 
YItemConstIterator itemsBegin () const
 
YItemIterator itemsEnd ()
 
YItemConstIterator itemsEnd () const
 
bool hasItems () const
 
int itemsCount () const
 
YItemfirstItem () const
 
virtual YItemselectedItem ()
 
virtual YItemCollection selectedItems ()
 
bool hasSelectedItem ()
 
virtual void selectItem (YItem *item, bool selected=true)
 
virtual void deselectAllItems ()
 
void setIconBasePath (const std::string &basePath)
 
std::string iconBasePath () const
 
std::string iconFullPath (const std::string &iconName) const
 
std::string iconFullPath (YItem *item) const
 
bool itemsContain (YItem *item) const
 
YItemfindItem (const std::string &itemLabel) const
 
virtual std::string shortcutString () const
 
virtual void setShortcutString (const std::string &str)
 
- Public Member Functions inherited from YWidget
virtual ~YWidget ()
 
virtual std::string debugLabel () const
 
std::string helpText () const
 
void setHelpText (const std::string &helpText)
 
bool hasChildren () const
 
YWidgetfirstChild () const
 
YWidgetlastChild () const
 
YWidgetListConstIterator childrenBegin () const
 
YWidgetListConstIterator childrenEnd () const
 
int childrenCount () const
 
bool contains (YWidget *child) const
 
virtual void addChild (YWidget *child)
 
virtual void removeChild (YWidget *child)
 
void deleteChildren ()
 
YWidgetparent () const
 
bool hasParent () const
 
void setParent (YWidget *newParent)
 
YDialogfindDialog ()
 
YWidgetfindWidget (YWidgetID *id, bool doThrow=true) const
 
virtual int preferredWidth ()=0
 
virtual int preferredHeight ()=0
 
virtual int preferredSize (YUIDimension dim)
 
virtual void setSize (int newWidth, int newHeight)=0
 
bool isValid () const
 
bool beingDestroyed () const
 
void * widgetRep () const
 
void setWidgetRep (void *toolkitWidgetRep)
 
bool hasId () const
 
YWidgetIDid () const
 
void setId (YWidgetID *newId_disown)
 
virtual void setEnabled (bool enabled=true)
 
void setDisabled ()
 
virtual bool isEnabled () const
 
virtual bool stretchable (YUIDimension dim) const
 
void setStretchable (YUIDimension dim, bool newStretch)
 
void setDefaultStretchable (YUIDimension dim, bool newStretch)
 
virtual int weight (YUIDimension dim)
 
bool hasWeight (YUIDimension dim)
 
void setWeight (YUIDimension dim, int weight)
 
void setNotify (bool notify=true)
 
bool notify () const
 
void setNotifyContextMenu (bool notifyContextMenu=true)
 
bool notifyContextMenu () const
 
bool sendKeyEvents () const
 
void setSendKeyEvents (bool doSend)
 
bool autoShortcut () const
 
void setAutoShortcut (bool _newAutoShortcut)
 
int functionKey () const
 
bool hasFunctionKey () const
 
virtual void setFunctionKey (int fkey_no)
 
virtual bool setKeyboardFocus ()
 
void dumpWidgetTree (int indentationLevel=0)
 
void dumpDialogWidgetTree ()
 
void setChildrenEnabled (bool enabled)
 
virtual void saveUserInput (YMacroRecorder *macroRecorder)
 
void * operator new (size_t size)
 
virtual void startMultipleChanges ()
 
virtual void doneMultipleChanges ()
 

Protected Member Functions

 YTable (YWidget *parent, YTableHeader *header, bool multiSelection)
 
void setTableHeader (YTableHeader *newHeader)
 
- Protected Member Functions inherited from YSelectionWidget
 YSelectionWidget (YWidget *parent, const std::string &label, bool enforceSingleSelection, bool recurisveSelection=false)
 
void setEnforceSingleSelection (bool on)
 
bool enforceSingleSelection () const
 
bool recursiveSelection () const
 
YItemfindSelectedItem (YItemConstIterator begin, YItemConstIterator end)
 
void findSelectedItems (YItemCollection &selectedItems, YItemConstIterator begin, YItemConstIterator end)
 
void deselectAllItems (YItemIterator begin, YItemIterator end)
 
YItemfindItem (const std::string &wantedItemLabel, YItemConstIterator begin, YItemConstIterator end) const
 
bool itemsContain (YItem *wantedItem, YItemConstIterator begin, YItemConstIterator end) const
 
YItemitemAt (int index) const
 
- Protected Member Functions inherited from YWidget
 YWidget (YWidget *parent)
 
YWidgetChildrenManagerchildrenManager () const
 
void setChildrenManager (YWidgetChildrenManager *manager)
 
void setBeingDestroyed ()
 
void dumpWidget (YWidget *w, int indentationLevel)
 

Detailed Description

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 55 of file YTable.h.

Constructor & Destructor Documentation

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.

Definition at line 50 of file YTable.cc.

Here is the call graph for this function:

YTable::~YTable ( )
virtual

Destructor.

Definition at line 64 of file YTable.cc.

Member Function Documentation

YAlignmentType YTable::alignment ( int  column) const

Return the alignment for the specified column.

Definition at line 106 of file YTable.cc.

Here is the call graph for this function:

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.

Definition at line 85 of file YTable.cc.

Here is the call graph for this function:

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

Get a property. Reimplemented from YWidget.

This method may throw YUIPropertyExceptions.

Reimplemented from YWidget.

Definition at line 207 of file YTable.cc.

Here is the call graph for this function:

bool YTable::hasColumn ( int  column) const

Return 'true' if this table has a column no. 'column' (counting from 0 on).

Definition at line 92 of file YTable.cc.

Here is the call graph for this function:

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

Definition at line 144 of file YTable.cc.

Here is the call graph for this function:

std::string YTable::header ( int  column) const

Return the header text for the specified column.

Definition at line 99 of file YTable.cc.

Here is the call graph for this function:

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

Definition at line 113 of file YTable.cc.

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.

Definition at line 130 of file YTable.cc.

const YPropertySet & YTable::propertySet ( )
virtual

Return this class's property set. This also initializes the property upon the first call.

Reimplemented from YWidget.

Reimplemented from YWidget.

Definition at line 151 of file YTable.cc.

Here is the call graph for this function:

void YTable::setImmediateMode ( bool  immediateMode = true)

Set immediateMode() on or off.

Definition at line 120 of file YTable.cc.

Here is the call graph for this function:

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.

Definition at line 137 of file YTable.cc.

Here is the call graph for this function:

bool YTable::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).

Reimplemented from YWidget.

Definition at line 186 of file YTable.cc.

Here is the call graph for this function:

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.

Definition at line 72 of file YTable.cc.

Here is the call graph for this function:

const char* YTable::userInputProperty ( )
inlinevirtual

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

Reimplemented from YWidget.

Definition at line 194 of file YTable.h.

virtual const char* YTable::widgetClass ( ) const
inlinevirtual

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

Reimplemented from YSelectionWidget.

Definition at line 83 of file YTable.h.


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