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

#include <Wt/WAbstractItemView>

Inheritance diagram for Wt::WAbstractItemView:

[legend]

Public Types
Public Types inherited from Wt::WObject
typedef void(WObject::*	Method) ()
	Typedef for a WObject method without arguments.

Public Member Functions
virtual void	setModel (WAbstractItemModel *model)
	Sets the model. More...

WAbstractItemModel *	model () const
	Returns the model. More...

void	setRootIndex (const WModelIndex &rootIndex)
	Sets the root index. More...

const WModelIndex &	rootIndex () const
	Returns the root index. More...

void	setItemDelegate (WAbstractItemDelegate *delegate)
	Sets the default item delegate. More...

WAbstractItemDelegate *	itemDelegate () const
	Returns the default item delegate. More...

void	setItemDelegateForColumn (int column, WAbstractItemDelegate *delegate)
	Sets the delegate for a column. More...

WAbstractItemDelegate *	itemDelegateForColumn (int column) const
	Returns the delegate that was set for a column. More...

WAbstractItemDelegate *	itemDelegate (const WModelIndex &index) const
	Returns the delegate for rendering an item. More...

WAbstractItemDelegate *	itemDelegate (int column) const
	Returns the delegate for a column. More...

virtual WWidget *	itemWidget (const WModelIndex &index) const =0
	Returns the widget that renders an item. More...

void	setHeaderItemDelegate (WAbstractItemDelegate *delegate)
	Sets the header item delegate. More...

WAbstractItemDelegate *	headerItemDelegate () const
	Returns the header item delegate. More...

virtual void	setColumnAlignment (int column, AlignmentFlag alignment)
	Sets the content alignment for a column. More...

virtual AlignmentFlag	columnAlignment (int column) const
	Returns the content alignment for a column. More...

virtual void	setHeaderAlignment (int column, WFlags< AlignmentFlag > alignment)
	Sets the header alignment for a column. More...

AlignmentFlag	headerAlignment (int column) const
	Returns the horizontal header alignment for a column (deprecated). More...

AlignmentFlag	horizontalHeaderAlignment (int column) const
	Returns the horizontal header alignment for a column. More...

AlignmentFlag	verticalHeaderAlignment (int column) const
	Returns the vertical header alignment for a column. More...

void	setHeaderWordWrap (int column, bool enabled)
	Configures header text wrapping. More...

virtual void	setAlternatingRowColors (bool enable)
	Sets if alternating row colors are to be used. More...

virtual bool	alternatingRowColors () const
	Returns whether alternating row colors are used. More...

void	sortByColumn (int column, SortOrder order)
	Sorts the data according to a column. More...

int	sortColumn () const
	Returns the current sorting columm. More...

SortOrder	sortOrder () const
	Returns the current sorting order. More...

void	setSortingEnabled (bool enabled)
	Enables or disables sorting for all columns. More...

void	setSortingEnabled (int column, bool enabled)
	Enables or disables sorting for a single column. More...

bool	isSortingEnabled () const
	Returns whether sorting is enabled. More...

bool	isSortingEnabled (int column) const
	Returns whether sorting is enabled for a single column. More...

void	setColumnResizeEnabled (bool enabled)
	Enables interactive column resizing. More...

bool	isColumnResizeEnabled () const
	Returns whether column resizing is enabled. More...

void	setSelectionBehavior (SelectionBehavior behavior)
	Changes the selection behaviour. More...

SelectionBehavior	selectionBehavior () const
	Returns the selection behaviour. More...

void	setSelectionMode (SelectionMode mode)
	Sets the selection mode. More...

SelectionMode	selectionMode () const
	Returns the selection mode. More...

WItemSelectionModel *	selectionModel () const
	Returns the selection model. More...

void	setSelectedIndexes (const WModelIndexSet &indexes)
	Sets the selected items. More...

void	clearSelection ()
	Clears the selection. More...

void	select (const WModelIndex &index, SelectionFlag option=Select)
	Selects a single item. More...

bool	isSelected (const WModelIndex &index) const
	Returns wheter an item is selected. More...

WModelIndexSet	selectedIndexes () const
	Returns the set of selected items. More...

void	setDragEnabled (bool enable)
	Enables the selection to be dragged (drag & drop). More...

void	setDropsEnabled (bool enable)
	Enables drop operations (drag & drop). More...

virtual void	setRowHeight (const WLength &rowHeight)
	Sets the row height. More...

const WLength &	rowHeight () const
	Returns the row height.

virtual void	setColumnWidth (int column, const WLength &width)=0
	Sets the column width. More...

WLength	columnWidth (int column) const
	Returns the column width. More...

virtual void	setColumnHidden (int column, bool hide)
	Changes the visibility of a column. More...

bool	isColumnHidden (int column) const
	Returns if a column is hidden. More...

void	hideColumn (int column)
	Hides a column. More...

void	showColumn (int column)
	Shows a column. More...

virtual void	setColumnBorder (const WColor &color)
	Sets the column border color (deprecated) More...

virtual void	setHeaderHeight (const WLength &height)
	Sets the header height. More...

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

const WLength &	headerHeight () const
	Returns the header height. More...

virtual int	pageCount () const =0
	Returns the number of pages. More...

virtual int	pageSize () const =0
	Returns the page size. More...

virtual int	currentPage () const =0
	Returns the current page. More...

virtual void	setCurrentPage (int page)=0
	Sets the current page. More...

virtual void	scrollTo (const WModelIndex &index, ScrollHint hint=EnsureVisible)=0
	Scrolls the view to an item. More...

void	setEditTriggers (WFlags< EditTrigger > editTriggers)
	Configures what actions should trigger editing. More...

WFlags< EditTrigger >	editTriggers () const
	Returns the editing triggers. More...

void	setEditOptions (WFlags< EditOption > options)
	Configures editing options. More...

WFlags< EditOption >	editOptions () const
	Returns the editing options. More...

void	edit (const WModelIndex &index)
	Opens an editor for the given index. More...

void	closeEditor (const WModelIndex &index, bool saveData=true)
	Closes the editor for the given index. More...

void	closeEditors (bool saveData=true)
	Closes all open editors. More...

WValidator::State	validateEditor (const WModelIndex &index)
	Validates the editor for the given index. More...

WValidator::State	validateEditors ()
	Validates all editors. More...

bool	isEditing (const WModelIndex &index) const
	Returns whether an editor is open for a given index. More...

bool	isValid (const WModelIndex &index) const
	Returns whether an editor's state is valid.

Signal< WModelIndex, WMouseEvent > &	clicked ()
	Signal emitted when clicked. More...

Signal< WModelIndex, WMouseEvent > &	doubleClicked ()
	Signal emitted when double clicked. More...

Signal< WModelIndex, WMouseEvent > &	mouseWentDown ()
	Signal emitted when a mouse button is pressed down. More...

Signal< WModelIndex, WMouseEvent > &	mouseWentUp ()
	Signal emitted when the mouse button is released. More...

Signal< WModelIndex, WTouchEvent > &	touchStart ()
	Signal emitted when a finger is placed on the screen. More...

Signal &	selectionChanged ()
	Signal emitted when the selection is changed. More...

Signal &	pageChanged ()
	Signal emitted when page information was updated. More...

Signal< int, WLength > &	columnResized ()
	Returns the signal emitted when a column is resized by the user. More...

bool	sortEnabled ()
	Returns whether the view is sortable. More...

void	setHeaderClickSortEnabled (bool enabled)
	Alow to sort. More...

Signal< int, WMouseEvent > &	headerClicked ()
	Signal emitted when a header item is clicked. More...

Signal< int, WMouseEvent > &	headerDoubleClicked ()
	Signal emitted when a header item is double clicked. More...

Signal< int, WMouseEvent > &	headerMouseWentDown ()
	Signal emitted when a mouse button is pressed on a header item More...

Signal< int, WMouseEvent > &	headerMouseWentUp ()
	Signal emitted when a mouse button is released on a header item More...

virtual EventSignal< WScrollEvent > &	scrolled ()=0
	Signal emitted when scrolling. More...

virtual void	setRowHeaderCount (int count)
	Configures the number of columns that are used as row headers. More...

int	rowHeaderCount () const
	Returns the number of columns that are used as row headers. More...

void	setColumn1Fixed (bool enable)
	Configures whether horizontal scrolling includes the first column (deprecated) More...

bool	column1Fixed () const
	Returns whether horizontal scrolling includes the first column. (deprecated) More...

virtual void	setObjectName (const std::string &name)
	Sets an object name. More...

EventSignal< WKeyEvent > &	keyWentDown ()
	Event signal emitted when a keyboard key is pushed down. More...

EventSignal< WKeyEvent > &	keyPressed ()
	Event signal emitted when a "character" was entered. More...

EventSignal< WKeyEvent > &	keyWentUp ()
	Event signal emitted when a keyboard key is released. More...

Public Member Functions inherited from Wt::WCompositeWidget
	WCompositeWidget (WContainerWidget *parent=0)
	Creates a WCompositeWidget. More...

	WCompositeWidget (WWidget implementation, WContainerWidget parent)
	Creates a WCompositeWidget with given implementation. More...

virtual std::string	objectName () const
	Returns the object name. More...

virtual const std::string	id () const
	Returns the (unique) identifier for this object. More...

virtual void	setPositionScheme (PositionScheme scheme)
	Sets the CSS position scheme. More...

virtual PositionScheme	positionScheme () const
	Returns the CSS position scheme. More...

virtual void	setOffsets (const WLength &offset, WFlags< Side > sides=All)
	Sets CSS offsets for a non-statically positioned widget. More...

virtual WLength	offset (Side s) const
	Returns a CSS offset. More...

virtual void	resize (const WLength &width, const WLength &height)
	Resizes the widget. More...

virtual WLength	width () const
	Returns the width. More...

virtual WLength	height () const
	Returns the height. More...

virtual void	setMinimumSize (const WLength &width, const WLength &height)
	Sets a minimum size. More...

virtual WLength	minimumWidth () const
	Returns the minimum width. More...

virtual WLength	minimumHeight () const
	Returns the minimum height. More...

virtual void	setMaximumSize (const WLength &width, const WLength &height)
	Sets a maximum size. More...

virtual WLength	maximumWidth () const
	Returns the maximum width. More...

virtual WLength	maximumHeight () const
	Returns the maximum height. More...

virtual void	setLineHeight (const WLength &height)
	Sets the CSS line height for contained text.

virtual WLength	lineHeight () const
	Returns the CSS line height for contained text. More...

virtual void	setFloatSide (Side s)
	Specifies a CSS float side. More...

virtual Side	floatSide () const
	Returns the CSS float side. More...

virtual void	setClearSides (WFlags< Side > sides)
	Sets the sides that should be cleared of floats. More...

virtual WFlags< Side >	clearSides () const
	Returns the sides that should remain empty. More...

virtual void	setMargin (const WLength &margin, WFlags< Side > sides=All)
	Sets CSS margins around the widget. More...

virtual WLength	margin (Side side) const
	Returns a CSS margin set. More...

virtual void	setHiddenKeepsGeometry (bool enabled)
	Sets whether the widget keeps its geometry when hidden. More...

virtual bool	hiddenKeepsGeometry () const
	Returns whether the widget keeps its geometry when hidden. More...

virtual void	setHidden (bool hidden, const WAnimation &animation=WAnimation())
	Hides or shows the widget. More...

virtual bool	isHidden () const
	Returns whether the widget is set hidden. More...

virtual bool	isVisible () const
	Returns whether the widget is visible. More...

virtual void	setDisabled (bool disabled)
	Sets whether the widget is disabled. More...

virtual bool	isDisabled () const
	Returns whether the widget is set disabled. More...

virtual bool	isEnabled () const
	Returns whether the widget is enabled. More...

virtual void	setPopup (bool popup)
	Lets the widget overlay over other sibling widgets. More...

virtual bool	isPopup () const
	Returns whether the widget is overlayed. More...

virtual void	setInline (bool isInline)
	Sets whether the widget is displayed inline or as a block. More...

virtual bool	isInline () const
	Returns whether the widget is displayed inline or as block. More...

virtual void	setDecorationStyle (const WCssDecorationStyle &style)
	Sets a CSS decoration style. More...

virtual WCssDecorationStyle &	decorationStyle ()
	Returns the decoration style of this widget. More...

virtual void	setStyleClass (const WString &styleClass)
	Sets (one or more) CSS style classes. More...

virtual WString	styleClass () const
	Returns the CSS style class. More...

virtual void	addStyleClass (const WString &styleClass, bool force=false)
	Adds a CSS style class. More...

virtual void	removeStyleClass (const WString &styleClass, bool force=false)
	Removes a CSS style class. More...

virtual bool	hasStyleClass (const WString &styleClass) const
	Returns whether the widget has a style class.

virtual void	setVerticalAlignment (AlignmentFlag alignment, const WLength &length=WLength::Auto)
	Sets the vertical alignment. More...

virtual AlignmentFlag	verticalAlignment () const
	Returns the vertical alignment. More...

virtual WLength	verticalAlignmentLength () const
	Returns the fixed vertical alignment that was set. More...

virtual void	setToolTip (const WString &text, TextFormat textFormat=PlainText)
	Sets a tooltip. More...

virtual WString	toolTip () const
	Returns the tooltip.

virtual void	setDeferredToolTip (bool enable, TextFormat textFormat=PlainText)
	Enable deferred tooltip. More...

virtual void	refresh ()
	Refresh the widget. More...

virtual void	setAttributeValue (const std::string &name, const WString &value)
	Sets an attribute value. More...

virtual WString	attributeValue (const std::string &name) const
	Returns an attribute value. More...

virtual void	setJavaScriptMember (const std::string &name, const std::string &value)
	Sets a JavaScript member. More...

virtual std::string	javaScriptMember (const std::string &name) const
	Returns the value of a JavaScript member. More...

virtual void	callJavaScriptMember (const std::string &name, const std::string &args)
	Calls a JavaScript member. More...

virtual void	load ()
	Loads content just before the widget is used. More...

virtual bool	loaded () const
	Returns whether this widget has been loaded. More...

virtual void	setCanReceiveFocus (bool enabled)
	Sets whether the widget can receive focus. More...

virtual bool	canReceiveFocus () const
	Returns whether the widget can receive focus. More...

virtual void	setFocus (bool focus)
	Sets focus. More...

virtual bool	setFirstFocus ()
	Set focus on the widget's first descendant. More...

virtual bool	hasFocus () const
	Returns whether the widget currently has the focus.

virtual void	setTabIndex (int index)
	Sets the tab index. More...

virtual int	tabIndex () const
	Returns the tab index. More...

virtual void	setId (const std::string &id)
	Sets the CSS Id. More...

virtual WWidget *	find (const std::string &name)
	Finds a descendent widget by name. More...

virtual WWidget *	findById (const std::string &name)
	Finds a descendent widget by id.

virtual void	setSelectable (bool selectable)
	Sets as selectable. More...

virtual void	doJavaScript (const std::string &js)
	Executes the given JavaScript statements when the widget is rendered or updated. More...

virtual void	propagateSetEnabled (bool enabled)
	Propagates that a widget was enabled or disabled through children. More...

virtual bool	scrollVisibilityEnabled () const WT_CXX11ONLY(finaloverride)
	Returns whether scroll visibility detection is enabled for this widget. More...

virtual void	setScrollVisibilityEnabled (bool enabled) WT_CXX11ONLY(finaloverride)
	Sets whether scroll visibility detection is enabled for this widget. More...

virtual int	scrollVisibilityMargin () const WT_CXX11ONLY(finaloverride)
	Returns the margin around the viewport within which the widget is considered visible. More...

virtual void	setScrollVisibilityMargin (int margin) WT_CXX11ONLY(finaloverride)
	Sets the margin around the viewport within which the widget is considered visible. More...

virtual Signal< bool > &	scrollVisibilityChanged () WT_CXX11ONLY(finaloverride)
	Signal triggered when the scroll visibility of this widget changes. More...

virtual bool	isScrollVisible () const WT_CXX11ONLY(finaloverride)
	Returns whether this widget is currently considered scroll visible. More...

virtual void	setThemeStyleEnabled (bool enabled)
	Sets whether theme styling for a widget is enabled or disabled. More...

virtual bool	isThemeStyleEnabled () const
	Returns whether this widget is currently styled by the chosen theme. More...

Public Member Functions inherited from Wt::WWidget
virtual	~WWidget ()
	Destructor. More...

WWidget *	parent () const
	Returns the parent widget. More...

virtual void	removeChild (WObject *child)
	Removes a child object. More...

void	setWidth (const WLength &width)
	Sets the width. More...

void	setHeight (const WLength &height)
	Sets the height. More...

virtual void	positionAt (const WWidget *widget, Orientation orientation=Vertical)
	Positions a widget next to another widget. More...

virtual void	toggleStyleClass (const WString &styleClass, bool add, bool force=false)
	Toggles a CSS style class.

std::string	jsRef () const
	Returns a JavaScript expression to the corresponding DOM node. More...

void	setFocus ()
	Sets focus. More...

virtual void	acceptDrops (const std::string &mimeType, const WString &hoverStyleClass=WString())
	Sets a mime type to be accepted for dropping. More...

virtual void	stopAcceptDrops (const std::string &mimeType)
	Indicates that a mime type is no longer accepted for dropping. More...

virtual void	htmlText (std::ostream &out)
	Streams the (X)HTML representation. More...

bool	isRendered () const
	Returns whether the widget is rendered. More...

void	hide ()
	Hides the widget. More...

void	animateHide (const WAnimation &animation)
	Hides the widget using an animation. More...

void	show ()
	Shows the widget. More...

void	animateShow (const WAnimation &animation)
	Shows the widget using an animation. More...

void	enable ()
	Enables the widget. More...

void	disable ()
	Disable thes widget. More...

bool	layoutSizeAware () const
	Returns whether the widget is layout size aware. More...

Public Member Functions inherited from Wt::WObject
	WObject (WObject *parent=0)
	Create a WObject with a given parent object. More...

virtual	~WObject ()
	Destructor. More...

void	resetLearnedSlots ()
	Resets learned stateless slot implementations. More...

template<class T >
void	resetLearnedSlot (void(T::*method)())
	Resets a learned stateless slot implementation. More...

template<class T >
WStatelessSlot *	implementStateless (void(T::*method)())
	Declares a slot to be stateless and learn client-side behaviour on first invocation. More...

template<class T >
WStatelessSlot *	implementStateless (void(T::method)(), void(T::undoMethod)())
	Declares a slot to be stateless and learn client-side behaviour in advance. More...

void	isNotStateless ()
	Marks the current function as not stateless. More...

template<class T >
WStatelessSlot *	implementJavaScript (void(T::*method)(), const std::string &jsCode)
	Provides a JavaScript implementation for a method. More...

void	addChild (WObject *child)
	Adds a child object. More...

const std::vector< WObject * > &	children () const
	Returns the children.

WObject *	parent () const
	Returns the parent object.

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

virtual WWidget *	createExtraHeaderWidget (int column)
	Create an extra widget in the header. More...

WWidget *	extraHeaderWidget (int column)
	Returns the extra header widget. More...

virtual WWidget *	createPageNavigationBar ()
	Returns a page navigation widget. More...

virtual void	handleClick (const WModelIndex &index, const WMouseEvent &event)
	Handles a click event. More...

virtual void	handleDoubleClick (const WModelIndex &index, const WMouseEvent &event)
	Handles a double click event. More...

virtual void	handleMouseDown (const WModelIndex &index, const WMouseEvent &event)
	Handles a mouse down event. More...

virtual void	handleMouseUp (const WModelIndex &index, const WMouseEvent &event)
	Handles a mouse up event. More...

virtual void	handleTouchStart (const std::vector< WModelIndex > &indices, const WTouchEvent &event)
	Handles a touch started event.

Protected Member Functions inherited from Wt::WCompositeWidget
virtual void	enableAjax ()
	Progresses to an Ajax-enabled widget. More...

void	setImplementation (WWidget *widget)
	Set the implementation widget. More...

WWidget *	implementation ()
	Get the implementation widget. More...

virtual int	boxPadding (Orientation orientation) const
	Returns the widget's built-in padding. More...

virtual int	boxBorder (Orientation orientation) const
	Returns the widget's built-in border width. More...

virtual void	render (WFlags< RenderFlag > flags)
	Renders the widget. More...

Protected Member Functions inherited from Wt::WWidget
void	setLayoutSizeAware (bool sizeAware)
	Sets the widget to be aware of its size set by a layout manager. More...

virtual void	layoutSizeChanged (int width, int height)
	Virtual method that indicates a size change. More...

	WWidget (WContainerWidget *parent=0)
	Creates a widget. More...

virtual void	dropEvent (WDropEvent dropEvent)
	Handles a drop event. More...

void	scheduleRender (WFlags< RepaintFlag > flags=0)
	Schedules rerendering of the widget. More...

virtual WStatelessSlot *	getStateless (Method method)
	On-demand stateless slot implementation. More...

Additional Inherited Members
Static Public Member Functions inherited from Wt::WWidget
static WString	tr (const char *key)
	Short hand for WString::tr() More...

Static Protected Member Functions inherited from Wt::WObject
static WObject *	sender ()
	Returns the sender of the current slot call. More...

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: 슫 First
Wt.WAbstractItemView.PageBar.Previous: &#xe280b9; Previous
Wt.WAbstractItemView.PageBar.Next: Next &#xe280ba;
Wt.WAbstractItemView.PageBar.Last: Last 슻

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

void Wt::WAbstractItemView::clearSelection ( )

Clears the selection.

See also: setSelectedIndexes()

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 )

protectedvirtual

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

protectedvirtual

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
	)

protectedvirtual

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
	)

protectedvirtual

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
	)

protectedvirtual

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
	)

protectedvirtual

Handles a mouse down event.

This emits the mouseWentDown() signal.

void Wt::WAbstractItemView::handleMouseUp	(	const WModelIndex &	index,
		const WMouseEvent &	event
	)

protectedvirtual

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.

Signal<int, WMouseEvent>& Wt::WAbstractItemView::headerClicked ( )

Signal emitted when a header item is clicked.

The argument that is passed is the column number.

See also: clicked(), headerDblClicked()

Signal<int, WMouseEvent>& Wt::WAbstractItemView::headerDoubleClicked ( )

Signal emitted when a header item is double clicked.

The argument that is passed is the column number.

See also: doubleClicked(), headerClicked()

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

Signal<int, WMouseEvent>& Wt::WAbstractItemView::headerMouseWentDown ( )

Signal emitted when a mouse button is pressed on a header item

The argument that is passed is the column number.

See also: headerMouseWentDownUp()

Signal<int, WMouseEvent>& Wt::WAbstractItemView::headerMouseWentUp ( )

Signal emitted when a mouse button is released on a header item

The argument that is passed is the column number.

See also: headerMouseWentDown()

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.

EventSignal< WKeyEvent > & Wt::WAbstractItemView::keyPressed ( )

Event signal emitted when a "character" was entered.

The keyPressed signal is emitted when a key is pressed, and a character is entered. Unlike keyWentDown(), it is emitted only for key presses that result in a character being entered, and thus not for modifier keys or keyboard navigation keys.

See also: keyWentDown()

EventSignal< WKeyEvent > & Wt::WAbstractItemView::keyWentDown ( )

Event signal emitted when a keyboard key is pushed down.

The keyWentDown signal is the first signal emitted when a key is pressed (before the keyPressed signal). Unlike keyPressed() however it is also emitted for modifier keys (such as "shift", "control", ...) or keyboard navigation keys that do not have a corresponding character.

See also: keyPressed(), keyWentUp()

EventSignal< WKeyEvent > & Wt::WAbstractItemView::keyWentUp ( )

Event signal emitted when a keyboard key is released.

This is the counter-part of the keyWentDown() event. Every key-down has its corresponding key-up.

See also: keyWentDown()

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.

This signal is emitted only when 'over' an item (the model index is passed as first argument is never invalid).

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 EventSignal<WScrollEvent>& Wt::WAbstractItemView::scrolled ( )

pure virtual

Signal emitted when scrolling.

Note: Works only if ajax is available.

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

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.

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

void Wt::WAbstractItemView::setColumnBorder ( const WColor & color )

virtual

Sets the column border color (deprecated)

This method has no effect. The border color should be set using CSS.

Deprecated:

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 width must be specified in WLength::Pixel units.; 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::setHeaderClickSortEnabled ( bool enabled )

Alow to sort.

When enabeld the view can be sorted by clicking on the header.

void Wt::WAbstractItemView::setHeaderHeight ( const WLength & height )

virtual

Sets the header height.

The default value is 20 pixels.

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

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::setObjectName ( const std::string & name )

virtual

Sets an object name.

The object name can be used to easily identify a type of object in the DOM, and does not need to be unique. It will usually reflect the widget type or role. The object name is prepended to the auto-generated object id().

The default object name is empty.

Note: Only letters ([A-Za-z]), digits ([0-9]), hyphens ("-"), underscores ("_"), colons (":"), and periods (".") are allowed in the id.

See also: id()

Reimplemented from Wt::WCompositeWidget.

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

bool Wt::WAbstractItemView::sortEnabled ( )

Returns whether the view is sortable.

When enabeld the view can be sorted by clicking on the header.

SortOrder Wt::WAbstractItemView::sortOrder ( ) const

Returns the current sorting order.

See also: sortByColumn(), sortColumn()

Signal<WModelIndex, WTouchEvent>& Wt::WAbstractItemView::touchStart ( )

Signal emitted when a finger is placed on the screen.

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

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

Public Types

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

i18n

Member Enumeration Documentation

Member Function Documentation