Wt: Wt::WAbstractItemView Class Reference

Wt 3.3.0

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes

- Class List
- Class Hierarchy
- Class Members

Public Types | Public Member Functions | Protected Member Functions
Wt::WAbstractItemView Class Reference
Model/view system

An abstract base class for item Views. More...

`#include <Wt/WAbstractItemView>`

Inheritance diagram for Wt::WAbstractItemView:
[legend]

List of all members.

## Public Types
enum | EditTrigger { NoEditTrigger = 0x0, SingleClicked = 0x1, DoubleClicked = 0x2, SelectedClicked = 0x4 }
| Enumeration that specifies the user action that triggers editing. More...
enum | EditOption { SingleEditor = 0x1, MultipleEditors = 0x2, SaveWhenClosed = 0x4, LeaveEditorsOpen = 0x8 }
| Enumeration that specifies editing options. More...
enum | ScrollHint { EnsureVisible, PositionAtTop, PositionAtBottom, PositionAtCenter }
| Enumeration that specifies a scrolling option. More...
## Public Member Functions
virtual void | setModel (WAbstractItemModel *model)
| Sets the model.
WAbstractItemModel * | model () const
| Returns the model.
void | setRootIndex (const WModelIndex &rootIndex)
| Sets the root index.
const WModelIndex & | rootIndex () const
| Returns the root index.
void | setItemDelegate (WAbstractItemDelegate *delegate)
| Sets the default item delegate.
WAbstractItemDelegate * | itemDelegate () const
| Returns the default item delegate.
void | setItemDelegateForColumn (int column, WAbstractItemDelegate *delegate)
| Sets the delegate for a column.
WAbstractItemDelegate * | itemDelegateForColumn (int column) const
| Returns the delegate that was set for a column.
WAbstractItemDelegate * | itemDelegate (const WModelIndex &index) const
| Returns the delegate for rendering an item.
WAbstractItemDelegate * | itemDelegate (int column) const
| Returns the delegate for a column.
virtual WWidget * | itemWidget (const WModelIndex &index) const =0
| Returns the widget that renders an item.
void | setHeaderItemDelegate (WAbstractItemDelegate *delegate)
| Sets the header item delegate.
WAbstractItemDelegate * | headerItemDelegate () const
| Returns the header item delegate.
virtual void | setColumnAlignment (int column, AlignmentFlag alignment)
| Sets the content alignment for a column.
virtual AlignmentFlag | columnAlignment (int column) const
| Returns the content alignment for a column.
virtual void | setHeaderAlignment (int column, WFlags< AlignmentFlag > alignment)
| Sets the header alignment for a column.
AlignmentFlag | headerAlignment (int column) const
| Returns the horizontal header alignment for a column (deprecated).
AlignmentFlag | horizontalHeaderAlignment (int column) const
| Returns the horizontal header alignment for a column.
AlignmentFlag | verticalHeaderAlignment (int column) const
| Returns the vertical header alignment for a column.
void | setHeaderWordWrap (int column, bool enabled)
| Configures header text wrapping.
virtual void | setAlternatingRowColors (bool enable)
| Sets if alternating row colors are to be used.
virtual bool | alternatingRowColors () const
| Returns whether alternating row colors are used.
void | sortByColumn (int column, SortOrder order)
| Sorts the data according to a column.
int | sortColumn () const
| Returns the current sorting columm.
SortOrder | sortOrder () const
| Returns the current sorting order.
void | setSortingEnabled (bool enabled)
| Enables or disables sorting for all columns.
void | setSortingEnabled (int column, bool enabled)
| Enables or disables sorting for a single column.
bool | isSortingEnabled () const
| Returns whether sorting is enabled.
bool | isSortingEnabled (int column) const
| Returns whether sorting is enabled for a single column.
void | setColumnResizeEnabled (bool enabled)
| Enables interactive column resizing.
bool | isColumnResizeEnabled () const
| Returns whether column resizing is enabled.
void | setSelectionBehavior (SelectionBehavior behavior)
| Changes the selection behaviour.
SelectionBehavior | selectionBehavior () const
| Returns the selection behaviour.
void | setSelectionMode (SelectionMode mode)
| Sets the selection mode.
SelectionMode | selectionMode () const
| Returns the selection mode.
WItemSelectionModel * | selectionModel () const
| Returns the selection model.
void | setSelectedIndexes (const WModelIndexSet &indexes)
| Sets the selected items.
void | select (const WModelIndex &index, SelectionFlag option=Select)
| Selects a single item.
bool | isSelected (const WModelIndex &index) const
| Returns wheter an item is selected.
WModelIndexSet | selectedIndexes () const
| Returns the set of selected items.
void | setDragEnabled (bool enable)
| Enables the selection to be dragged (drag & drop).
void | setDropsEnabled (bool enable)
| Enables drop operations (drag & drop).
virtual void | setRowHeight (const WLength &rowHeight)
| Sets the row height.
const WLength & | rowHeight () const
| Returns the row height.
virtual void | setColumnWidth (int column, const WLength &width)=0
| Sets the column width.
WLength | columnWidth (int column) const
| Returns the column width.
virtual void | setColumnHidden (int column, bool hide)
| Changes the visibility of a column.
bool | isColumnHidden (int column) const
| Returns if a column is hidden.
void | hideColumn (int column)
| Hides a column.
void | showColumn (int column)
| Shows a column.
virtual void | setColumnBorder (const WColor &color)=0
| Sets the column border color.
virtual void | setHeaderHeight (const WLength &height)
| Sets the header height.
void | setHeaderHeight (const WLength &height, bool multiLine)
| Sets the header height, and vertical alignment (deprecated). By default, the header text is a single line that is centered vertically.
const WLength & | headerHeight () const
| Returns the header height.
virtual int | pageCount () const =0
| Returns the number of pages.
virtual int | pageSize () const =0
| Returns the page size.
virtual int | currentPage () const =0
| Returns the current page.
virtual void | setCurrentPage (int page)=0
| Sets the current page.
virtual void | scrollTo (const WModelIndex &index, ScrollHint hint=EnsureVisible)=0
| Scrolls the view to an item.
void | setEditTriggers (WFlags< EditTrigger > editTriggers)
| Configures what actions should trigger editing.
WFlags< EditTrigger > | editTriggers () const
| Returns the editing triggers.
void | setEditOptions (WFlags< EditOption > options)
| Configures editing options.
WFlags< EditOption > | editOptions () const
| Returns the editing options.
void | edit (const WModelIndex &index)
| Opens an editor for the given index.
void | closeEditor (const WModelIndex &index, bool saveData=true)
| Closes the editor for the given index.
void | closeEditors (bool saveData=true)
| Closes all open editors.
WValidator::State | validateEditor (const WModelIndex &index)
| Validates the editor for the given index.
WValidator::State | validateEditors ()
| Validates all editors.
bool | isEditing (const WModelIndex &index) const
| Returns whether an editor is open for a given index.
bool | isValid (const WModelIndex &index) const
| Returns whether an editor's state is valid.
Signal< WModelIndex, WMouseEvent > & | clicked ()
| Signal emitted when clicked.
Signal< WModelIndex, WMouseEvent > & | doubleClicked ()
| Signal emitted when double clicked.
Signal< WModelIndex, WMouseEvent > & | mouseWentDown ()
| Signal emitted when a mouse button is pressed down.
Signal< WModelIndex, WMouseEvent > & | mouseWentUp ()
| Signal emitted when the mouse button is released.
Signal & | selectionChanged ()
| Signal emitted when the selection is changed.
Signal & | pageChanged ()
| Signal emitted when page information was updated.
Signal< int, WLength > & | columnResized ()
| Returns the signal emitted when a column is resized by the user.
virtual void | setRowHeaderCount (int count)
| Configures the number of columns that are used as row headers.
int | rowHeaderCount () const
| Returns the number of columns that are used as row headers.
void | setColumn1Fixed (bool enable)
| Configures whether horizontal scrolling includes the first column (deprecated)
bool | column1Fixed () const
| Returns whether horizontal scrolling includes the first column. (deprecated)
## Protected Member Functions
| WAbstractItemView (WContainerWidget *parent=0)
| Creates a new item view.
virtual void | dropEvent (const WDropEvent &event, const WModelIndex &target)
| Handles a drop event (drag & drop).
virtual WWidget * | createExtraHeaderWidget (int column)
| Create an extra widget in the header.
WWidget * | extraHeaderWidget (int column)
| Returns the extra header widget.
virtual WWidget * | createPageNavigationBar ()
| Returns a page navigation widget.
virtual void | handleClick (const WModelIndex &index, const WMouseEvent &event)
| Handles a click event.
virtual void | handleDoubleClick (const WModelIndex &index, const WMouseEvent &event)
| Handles a double click event.
virtual void | handleMouseDown (const WModelIndex &index, const WMouseEvent &event)
| Handles a mouse down event.
virtual void | handleMouseUp (const WModelIndex &index, const WMouseEvent &event)
| Handles a mouse up event.

## Detailed Description

An abstract base class for item Views.

See WTableView or WTreeView for a description.

### i18n

The strings used in this class can be translated by overriding the default values for the following localization keys:

- Wt.WAbstractItemView.PageIOfN: {1} of {2}
- Wt.WAbstractItemView.PageBar.First: &#xc2ab; First
- Wt.WAbstractItemView.PageBar.Previous: &#xe280b9; Previous
- Wt.WAbstractItemView.PageBar.Next: Next &#xe280ba;
- Wt.WAbstractItemView.PageBar.Last: Last &#xc2bb;

## Member Enumeration Documentation

enum Wt::WAbstractItemView::EditOption

Enumeration that specifies editing options.

See also:
  setEditOptions()

Enumerator:

  SingleEditor | Never show more than one active editor.
  MultipleEditors | Allow multiple editors at the same time.
  SaveWhenClosed | Always save the current edit value when closing.
  LeaveEditorsOpen | Editors can only be closed using closeEditor()

enum Wt::WAbstractItemView::EditTrigger

Enumeration that specifies the user action that triggers editing.

See also:
  setEditTriggers(), edit()

Enumerator:

  NoEditTrigger | Do not allow user to initiate editing.
  SingleClicked | Edit an item when clicked.
  DoubleClicked | Edit an item when double clicked.
  SelectedClicked | Edit a selected item that is clicked again.

enum Wt::WAbstractItemView::ScrollHint

Enumeration that specifies a scrolling option.

See also:
  scrollTo()

Enumerator:

  EnsureVisible | Scrolls minimally to make it visible.
  PositionAtTop | Positions the item at the top of the viewport.
  PositionAtBottom | Positions the item at the bottom of the viewport.
  PositionAtCenter | Positions the item at the center of the viewport.

## Member Function Documentation

virtual bool Wt::WAbstractItemView::alternatingRowColors | ( |  | ) | const`[virtual]`

Returns whether alternating row colors are used.

When enabled, rows are displayed in alternating row colors, according to the current theme's definition.

See also:
  setAlternatingRowColors()

Signal<WModelIndex, WMouseEvent>& Wt::WAbstractItemView::clicked | ( |  | ) |

Signal emitted when clicked.

When the event happened over an item, the first argument indicates the item that was clicked on.

See also:
  doubleClicked()

void Wt::WAbstractItemView::closeEditor | ( | const WModelIndex & | index,
|  | bool | saveData = `true`
| ) |  |

Closes the editor for the given index.

If `saveData` is true, then the currently edited value is saved first to the model.

See also:
  edit()

void Wt::WAbstractItemView::closeEditors | ( | bool | saveData = `true` | ) |

Closes all open editors.

If `saveData` is true, then the currently edited values are saved to the model before closing the editor.

See also:
  closeEditor()

bool Wt::WAbstractItemView::column1Fixed | ( |  | ) | const

Returns whether horizontal scrolling includes the first column. (deprecated)

See also:
  setColumn1Fixed()

Deprecated:
  Use rowHeaderCount() instead.

AlignmentFlag Wt::WAbstractItemView::columnAlignment | ( | int | column | ) | const`[virtual]`

Returns the content alignment for a column.

See also:
  setColumnAlignment()

Signal<int, WLength>& Wt::WAbstractItemView::columnResized | ( |  | ) |

Returns the signal emitted when a column is resized by the user.

The arguments of the signal are: the column index and the new width of the column.

WLength Wt::WAbstractItemView::columnWidth | ( | int | column | ) | const

Returns the column width.

See also:
  setColumnWidth()

WWidget * Wt::WAbstractItemView::createExtraHeaderWidget | ( | int | column | ) | `[protected, virtual]`

Create an extra widget in the header.

You may reimplement this method to provide an extra widget to be placed below the header label. The extra widget will be visible only if a multi-line header is configured using setHeaderHeight().

The widget is created only once, but this method may be called repeatedly for a column for which prior calls returned `0` (i.e. each time the header is rerendered).

The default implementation returns `0`.

See also:
  setHeaderHeight(), extraHeaderWidget()

WWidget * Wt::WAbstractItemView::createPageNavigationBar | ( |  | ) | `[protected, virtual]`

Returns a page navigation widget.

When Ajax/JavaScript is not available, the view will use a paging navigation bar to allow scrolling through the data, created by this method. The default implementation displays a simple navigation bar with (First, Prevous, Next, Last) buttons and a page counter.

You may want to reimplement this method to provide a custom page navigation bar. You can use the currentPage(), pageCount(), and setCurrentPage() methods to set or get the page information, and listen to the pageChanged() signal to react to changes.

virtual int Wt::WAbstractItemView::currentPage | ( |  | ) | const`[pure virtual]`

Returns the current page.

When Ajax/JavaScript is not available, the view will use a paging navigation bar to allow scrolling through the data. This returns the current page (between 0 and pageCount() - 1).

See also:
  createPageNavigationBar(), pageChanged()

Implemented in Wt::WTreeView, and Wt::WTableView.

Signal<WModelIndex, WMouseEvent>& Wt::WAbstractItemView::doubleClicked | ( |  | ) |

Signal emitted when double clicked.

When the event happened over an item, the first argument indicates the item that was double clicked on.

See also:
  clicked()

void Wt::WAbstractItemView::dropEvent | ( | const WDropEvent & | event,
|  | const WModelIndex & | target
| ) |  | `[protected, virtual]`

Handles a drop event (drag & drop).

The `event` object contains details about the drop operation, identifying the source (which provides the data) and the mime-type of the data. The drop was received on the `target` item.

The drop event can be handled either by the view itself, or by the model. The default implementation checks if the mime-type is accepted by the model, and if so passes the drop event to the model. If the source is the view's own selection model, then the drop event will be handled as a MoveAction, otherwise the drop event will be handled as a CopyAction.

See also:
  WAbstractItemModel::dropEvent()

void Wt::WAbstractItemView::edit | ( | const WModelIndex & | index | ) |

Opens an editor for the given index.

Unless multiple editors are enabled, any other open editor is closed first.

See also:
  setEditTriggers(), setEditOptions(), closeEditor()

WFlags<EditOption> Wt::WAbstractItemView::editOptions | ( |  | ) | const

Returns the editing options.

See also:
  setEditOptions()

WFlags<EditTrigger> Wt::WAbstractItemView::editTriggers | ( |  | ) | const

Returns the editing triggers.

See also:
  setEditTriggers()

WWidget * Wt::WAbstractItemView::extraHeaderWidget | ( | int | column | ) | `[protected]`

Returns the extra header widget.

Returns the widget previously created using createExtraHeaderWidget()

See also:
  createExtraHeaderWidget()

void Wt::WAbstractItemView::handleClick | ( | const WModelIndex & | index,
|  | const WMouseEvent & | event
| ) |  | `[protected, virtual]`

Handles a click event.

This processes the event for internal purposes (such as selection or editing) and emits the clicked() signal.

You may want to override this signal to override the built-in selection or editing behaviour.

void Wt::WAbstractItemView::handleDoubleClick | ( | const WModelIndex & | index,
|  | const WMouseEvent & | event
| ) |  | `[protected, virtual]`

Handles a double click event.

This processes the event for internal purposes (such as editing) and emits the doubleClicked() signal.

You may want to override this signal to override the built-in editing behaviour.

void Wt::WAbstractItemView::handleMouseDown | ( | const WModelIndex & | index,
|  | const WMouseEvent & | event
| ) |  | `[protected, virtual]`

Handles a mouse down event.

This emits the mouseWentDown() signal.

void Wt::WAbstractItemView::handleMouseUp | ( | const WModelIndex & | index,
|  | const WMouseEvent & | event
| ) |  | `[protected, virtual]`

Handles a mouse up event.

This emits the mouseWentUp() signal.

AlignmentFlag Wt::WAbstractItemView::headerAlignment | ( | int | column | ) | const

Returns the horizontal header alignment for a column (deprecated).

See also:
  setHeaderAlignment()

Deprecated:
  use horizontalHeaderAlignment() instead.

const WLength& Wt::WAbstractItemView::headerHeight | ( |  | ) | const

Returns the header height.

See also:
  setHeaderHeight()

WAbstractItemDelegate * Wt::WAbstractItemView::headerItemDelegate | ( |  | ) | const

Returns the header item delegate.

See also:
  setHeaderItemDelegate()

void Wt::WAbstractItemView::hideColumn | ( | int | column | ) |

Hides a column.

See also:
  showColumn(), setColumnHidden()

AlignmentFlag Wt::WAbstractItemView::horizontalHeaderAlignment | ( | int | column | ) | const

Returns the horizontal header alignment for a column.

See also:
  setHeaderAlignment()

bool Wt::WAbstractItemView::isColumnHidden | ( | int | column | ) | const

Returns if a column is hidden.

See also:
  setColumnHidden()

bool Wt::WAbstractItemView::isColumnResizeEnabled | ( |  | ) | const

Returns whether column resizing is enabled.

See also:
  setColumnResizeEnabled()

bool Wt::WAbstractItemView::isEditing | ( | const WModelIndex & | index | ) | const

Returns whether an editor is open for a given index.

See also:
  edit()

bool Wt::WAbstractItemView::isSelected | ( | const WModelIndex & | index | ) | const

Returns wheter an item is selected.

When selection operates on rows (SelectRows), this method returns true for each element in a selected row.

This is a convenience method for:

     selectionModel()->isSelected(index)

See also:
  selectedIndexes(), select(), selectionModel()

bool Wt::WAbstractItemView::isSortingEnabled | ( |  | ) | const

Returns whether sorting is enabled.

See also:
  setSortingEnabled()

bool Wt::WAbstractItemView::isSortingEnabled | ( | int | column | ) | const

Returns whether sorting is enabled for a single column.

See also:
  setSortingEnabled()

WAbstractItemDelegate* Wt::WAbstractItemView::itemDelegate | ( |  | ) | const

Returns the default item delegate.

See also:
  setItemDelegate()

WAbstractItemDelegate * Wt::WAbstractItemView::itemDelegate | ( | const WModelIndex & | index | ) | const

Returns the delegate for rendering an item.

See also:
  setItemDelegateForColumn(), setItemDelegate()

WAbstractItemDelegate * Wt::WAbstractItemView::itemDelegate | ( | int | column | ) | const

Returns the delegate for a column.

Returns either the delegate that was set for the column, or the default delegate.

WAbstractItemDelegate * Wt::WAbstractItemView::itemDelegateForColumn | ( | int | column | ) | const

Returns the delegate that was set for a column.

Returns `0` if no delegate was set for the column.

See also:
  setItemDelegateForColumn()

virtual WWidget* Wt::WAbstractItemView::itemWidget | ( | const WModelIndex & | index | ) | const`[pure virtual]`

Returns the widget that renders an item.

This returns the widget that renders the given item. This may return 0 if the item is currently not rendered.

This widget has been created by an item delegate, and usually an item delegate is involved when updating it.

Implemented in Wt::WTreeView, and Wt::WTableView.

WAbstractItemModel* Wt::WAbstractItemView::model | ( |  | ) | const

Returns the model.

See also:
  setModel()

Signal<WModelIndex, WMouseEvent>& Wt::WAbstractItemView::mouseWentDown | ( |  | ) |

Signal emitted when a mouse button is pressed down.

When the event happened over an item, the first argument indicates the item where the mouse went down.

See also:
  mouseWentUp()

Signal<WModelIndex, WMouseEvent>& Wt::WAbstractItemView::mouseWentUp | ( |  | ) |

Signal emitted when the mouse button is released.

When the event happened over an item, the first argument indicates the item where the mouse went up.

See also:
  mouseWentDown()

Signal& Wt::WAbstractItemView::pageChanged | ( |  | ) |

Signal emitted when page information was updated.

When Ajax/JavaScript is not available, the view will use a paging navigation bar to allow scrolling through the data. This signal is emitted when page-related information changed (e.g. the current page was changed, or the number of rows was changed).

See also:
  createPageNavigationBar()

virtual int Wt::WAbstractItemView::pageCount | ( |  | ) | const`[pure virtual]`

Returns the number of pages.

When Ajax/JavaScript is not available, the view will use a paging navigation bar to allow scrolling through the data. This returns the number of pages currently shown.

See also:
  createPageNavigationBar(), pageChanged()

Implemented in Wt::WTreeView, and Wt::WTableView.

virtual int Wt::WAbstractItemView::pageSize | ( |  | ) | const`[pure virtual]`

Returns the page size.

When Ajax/JavaScript is not available, the view will use a paging navigation bar to allow scrolling through the data. This returns the number of items per page.

See also:
  createPageNavigationBar(), pageChanged()

Implemented in Wt::WTreeView, and Wt::WTableView.

const WModelIndex& Wt::WAbstractItemView::rootIndex | ( |  | ) | const

Returns the root index.

See also:
  setRootIndex()

int Wt::WAbstractItemView::rowHeaderCount | ( |  | ) | const

Returns the number of columns that are used as row headers.

See also:
  setRowHeaderCount()

virtual void Wt::WAbstractItemView::scrollTo | ( | const WModelIndex & | index,
|  | ScrollHint | hint = `EnsureVisible`
| ) |  | `[pure virtual]`

Scrolls the view to an item.

Scrolls the view to ensure that the item which represents the provided `index` is visible. A `hint` may indicate how the item should appear in the viewport (if possible).

Note:
  Currently only implemented to scroll to the correct row, not taking into account the column.

Implemented in Wt::WTreeView, and Wt::WTableView.

void Wt::WAbstractItemView::select | ( | const WModelIndex & | index,
|  | SelectionFlag | option = `Select`
| ) |  |

Selects a single item.

See also:
  setSelectedIndexes(), selectionModel()

WModelIndexSet Wt::WAbstractItemView::selectedIndexes | ( |  | ) | const

Returns the set of selected items.

The model indexes are returned as a set, topologically ordered (in the order they appear in the view).

When selection operates on rows (SelectRows), this method only returns the model index of first column's element of the selected rows.

This is a convenience method for:

     selectionModel()->selectedIndexes()

See also:
  setSelectedIndexes()

SelectionBehavior Wt::WAbstractItemView::selectionBehavior | ( |  | ) | const

Returns the selection behaviour.

See also:
  setSelectionBehavior()

Signal& Wt::WAbstractItemView::selectionChanged | ( |  | ) |

Signal emitted when the selection is changed.

See also:
  select(), setSelectionMode(), setSelectionBehavior()

SelectionMode Wt::WAbstractItemView::selectionMode | ( |  | ) | const

Returns the selection mode.

See also:
  setSelectionMode()

WItemSelectionModel* Wt::WAbstractItemView::selectionModel | ( |  | ) | const

Returns the selection model.

The selection model keeps track of the currently selected items.

void Wt::WAbstractItemView::setAlternatingRowColors | ( | bool | enable | ) | `[virtual]`

Sets if alternating row colors are to be used.

Configure whether rows get alternating background colors, defined by the current CSS theme.

The default value is `false`.

Reimplemented in Wt::WTreeView, and Wt::WTableView.

void Wt::WAbstractItemView::setColumn1Fixed | ( | bool | enable | ) |

Configures whether horizontal scrolling includes the first column (deprecated)

To display a model with many columns, this option allows you to keep the first column fixed while scrolling through the other columns of the model.

The default value is `false`.

Deprecated:
  Use setRowHeaderCount() instead.

void Wt::WAbstractItemView::setColumnAlignment | ( | int | column,
|  | AlignmentFlag | alignment
| ) |  | `[virtual]`

Sets the content alignment for a column.

The default value is Wt::AlignLeft.

See also:
  setHeaderAlignment()

virtual void Wt::WAbstractItemView::setColumnBorder | ( | const WColor & | color | ) | `[pure virtual]`

Sets the column border color.

The default border color is defined by the CSS theme.

Implemented in Wt::WTreeView, and Wt::WTableView.

void Wt::WAbstractItemView::setColumnHidden | ( | int | column,
|  | bool | hide
| ) |  | `[virtual]`

Changes the visibility of a column.

See also:
  isColumnHidden()

Reimplemented in Wt::WTreeView, and Wt::WTableView.

void Wt::WAbstractItemView::setColumnResizeEnabled | ( | bool | enabled | ) |

Enables interactive column resizing.

Enable or disable column resize handles for interactive resizing of the columns.

Column resizing is enabled by default when JavaScript is available.

See also:
  setColumnResizeEnabled()

virtual void Wt::WAbstractItemView::setColumnWidth | ( | int | column,
|  | const WLength & | width
| ) |  | `[pure virtual]`

Sets the column width.

The default column width is 150 pixels.

Note:
  The actual space occupied by each column is the column width augmented by 7 pixels for internal padding and a border.

Implemented in Wt::WTreeView, and Wt::WTableView.

virtual void Wt::WAbstractItemView::setCurrentPage | ( | int | page | ) | `[pure virtual]`

Sets the current page.

When Ajax/JavaScript is not available, the view will use a paging navigation bar to allow scrolling through the data. This method can be used to change the current page.

See also:
  createPageNavigationBar(), pageChanged()

Implemented in Wt::WTreeView, and Wt::WTableView.

void Wt::WAbstractItemView::setDragEnabled | ( | bool | enable | ) |

Enables the selection to be dragged (drag & drop).

To enable dragging of the selection, you first need to enable selection using setSelectionMode().

Whether an individual item may be dragged is controlled by the item's ItemIsDragEnabled flag. The selection can be dragged only if all items currently selected can be dragged.

See also:
  setDropsEnabled()

void Wt::WAbstractItemView::setDropsEnabled | ( | bool | enable | ) |

Enables drop operations (drag & drop).

When drop is enabled, the tree view will indicate that something may be dropped when the mime-type of the dragged object is compatible with one of the model's accepted drop mime-types (see WAbstractItemModel::acceptDropMimeTypes()) or this widget's accepted drop mime-types (see WWidget::acceptDrops()), and the target item has drop enabled (which is controlled by the item's ItemIsDropEnabled flag).

Drop events must be handled in dropEvent().

See also:
  setDragEnabled(), dropEvent()

void Wt::WAbstractItemView::setEditOptions | ( | WFlags< EditOption > | options | ) |

Configures editing options.

The default value is SingleEditor;

void Wt::WAbstractItemView::setEditTriggers | ( | WFlags< EditTrigger > | editTriggers | ) |

Configures what actions should trigger editing.

The default value is DoubleClicked.

See also:
  edit()

void Wt::WAbstractItemView::setHeaderAlignment | ( | int | column,
|  | WFlags< AlignmentFlag > | alignment
| ) |  | `[virtual]`

Sets the header alignment for a column.

The default alignemnt is horizontally left, and vertically centered. (Wt::AlignLeft | Wt::AlignMiddle).

Valid options for horizontal alignment are Wt::AlignLeft, Wt::AlignCenter or Wt::AlignRight.

Valid options for vertical alignment are Wt::AlignMiddle or Wt::AlignTop. In the latter case, other contents may be added below the label in createExtraHeaderWidget().

See also:
  setColumnAlignment()

void Wt::WAbstractItemView::setHeaderHeight | ( | const WLength & | height | ) | `[virtual]`

Sets the header height.

The default value is 20 pixels.

Reimplemented in Wt::WTreeView, and Wt::WTableView.

void Wt::WAbstractItemView::setHeaderHeight | ( | const WLength & | height,
|  | bool | multiLine
| ) |  |

Sets the header height, and vertical alignment (deprecated). By default, the header text is a single line that is centered vertically.

Along with setting the header height, this also configures vertical aligment and header label word wrapping. This has been deprecated in favour of the more fine grained control using setHeaderAlignment() and setHeaderWordWrap().

When `multiLine` is `false`, the header alignment is set to Wt::AlignMiddle. When `multiLine` is `true`, the header alignment is set to Wt::AlignTop and header word wrap is set to `true`.

Deprecated:
  use setHeaderHeight(), setHeaderAlignment() and setHeaderWordWrap() instead.

void Wt::WAbstractItemView::setHeaderItemDelegate | ( | WAbstractItemDelegate * | delegate | ) |

Sets the header item delegate.

This item delegate is used for rendering items in the header.

The previous delegate is not deleted. This item delegate is for all columns for which no specific item delegate is set.

The default item delegate is a WItemDelegate.

void Wt::WAbstractItemView::setHeaderWordWrap | ( | int | column,
|  | bool | enabled
| ) |  |

Configures header text wrapping.

This setting only affects a multiline header, and the default value is `true`. When set to `false`, the header itself will not wrap (as with a vertically centered header), and thus extra widgets will not shift down when there is a long header label.

void Wt::WAbstractItemView::setItemDelegate | ( | WAbstractItemDelegate * | delegate | ) |

Sets the default item delegate.

The previous delegate is not deleted. This item delegate is for all columns for which no specific item delegate is set.

The default item delegate is a WItemDelegate.

See also:
  setItemDelegateForColumn()

void Wt::WAbstractItemView::setItemDelegateForColumn | ( | int | column,
|  | WAbstractItemDelegate * | delegate
| ) |  |

Sets the delegate for a column.

A delegate previously set (if any) is not deleted.

See also:
  setItemDelegate()

void Wt::WAbstractItemView::setModel | ( | WAbstractItemModel * | model | ) | `[virtual]`

Sets the model.

The View will display data of the given `model` and changes in the model are reflected by the View.

The initial model is `0`.

Ownership of the model is not transferred (and thus the previously set model is not deleted). A model may not be deleted as long as a view exists for it.

See also:
  setRootIndex()

Reimplemented in Wt::WTreeView, and Wt::WTableView.

void Wt::WAbstractItemView::setRootIndex | ( | const WModelIndex & | rootIndex | ) |

Sets the root index.

The root index is the model index that is considered the root node. This node itself is not rendered, but its children are.

The default value is an invalid model index, corresponding to the model's root node.

See also:
  setModel()

void Wt::WAbstractItemView::setRowHeaderCount | ( | int | count | ) | `[virtual]`

Configures the number of columns that are used as row headers.

An item view does not use the vertical header data from the model in any way, but instead you can configure data in the first column(s) to be used as a row headers.

These columns will not scroll horizontally together with the rest of the model.

The default value is 0.

Note:
  Currently, this property must be set before any other settings of the view and only a value of 0 or 1 is supported.

Reimplemented in Wt::WTreeView, and Wt::WTableView.

void Wt::WAbstractItemView::setRowHeight | ( | const WLength & | rowHeight | ) | `[virtual]`

Sets the row height.

The view renders all rows with a same height. This method configures this row height.

The default value is 20 pixels.

Note:
  The height must be specified in WLength::Pixel units.

See also:
  setColumnWidth()

Reimplemented in Wt::WTreeView, and Wt::WTableView.

void Wt::WAbstractItemView::setSelectedIndexes | ( | const WModelIndexSet & | indexes | ) |

Sets the selected items.

Replaces the current selection with `indexes`.

When selection operates on rows (SelectRows), it is sufficient to pass the first element in a row (column `0` ) to select the entire row.

See also:
  select(), selectionModel()

void Wt::WAbstractItemView::setSelectionBehavior | ( | SelectionBehavior | behavior | ) |

Changes the selection behaviour.

The selection behavior indicates whether whole rows or individual items can be selected. It is a property of the selectionModel().

By default, selection operates on rows (SelectRows), in which case model indexes will always be in the first column (column `0`).

Alternatively, you can allow selection for individual items (SelectItems).

See also:
  WItemSelectionModel::setSelectionBehavior(), setSelectionMode()

void Wt::WAbstractItemView::setSelectionMode | ( | SelectionMode | mode | ) |

Sets the selection mode.

By default selection is disabled (NoSelection ).

See also:
  setSelectionBehavior()

void Wt::WAbstractItemView::setSortingEnabled | ( | bool | enabled | ) |

Enables or disables sorting for all columns.

Enable or disable sorting by the user on all columns.

Sorting is enabled by default.

See also:
  WAbstractItemModel::sort()

void Wt::WAbstractItemView::setSortingEnabled | ( | int | column,
|  | bool | enabled
| ) |  |

Enables or disables sorting for a single column.

Enable or disable sorting by the user for a specific column.

Sorting is enabled by default.

See also:
  WAbstractItemModel::sort()

void Wt::WAbstractItemView::showColumn | ( | int | column | ) |

Shows a column.

See also:
  hideColumn(), setColumnHidden()

void Wt::WAbstractItemView::sortByColumn | ( | int | column,
|  | SortOrder | order
| ) |  |

Sorts the data according to a column.

Sorts the data according to data in column `column` and sort order `order`.

The default sorting column is -1: the model is unsorted.

See also:
  WAbstractItemModel::sort()

int Wt::WAbstractItemView::sortColumn | ( |  | ) | const

Returns the current sorting columm.

See also:
  sortByColumn(), sortOrder()

SortOrder Wt::WAbstractItemView::sortOrder | ( |  | ) | const

Returns the current sorting order.

See also:
  sortByColumn(), sortColumn()

WValidator::State Wt::WAbstractItemView::validateEditor | ( | const WModelIndex & | index | ) |

Validates the editor for the given index.

Validation is done by invoking WAbstractItemDelegate::validate().

WValidator::State Wt::WAbstractItemView::validateEditors | ( |  | ) |

Validates all editors.

See also:
  validateEditor().

AlignmentFlag Wt::WAbstractItemView::verticalHeaderAlignment | ( | int | column | ) | const

Returns the vertical header alignment for a column.

See also:
  setHeaderAlignment()

All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator