TableView.qml 28.32 KiB
/****************************************************************************
**
** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the Qt Quick Controls module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:BSD$
** You may use this file under the terms of the BSD license as follows:
** "Redistribution and use in source and binary forms, with or without
** modification, are permitted provided that the following conditions are
** met:
**   * Redistributions of source code must retain the above copyright
**     notice, this list of conditions and the following disclaimer.
**   * Redistributions in binary form must reproduce the above copyright
**     notice, this list of conditions and the following disclaimer in
**     the documentation and/or other materials provided with the
**     distribution.
**   * Neither the name of Digia Plc and its Subsidiary(-ies) nor the names
**     of its contributors may be used to endorse or promote products derived
**     from this software without specific prior written permission.
** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
** $QT_END_LICENSE$
****************************************************************************/
import QtQuick 2.1
import QtQuick.Controls 1.0
import QtQuick.Controls.Private 1.0
import QtQuick.Controls.Styles 1.0
/*!
   \qmltype TableView
   \inqmlmodule QtQuick.Controls 1.0
   \since QtQuick.Controls 1.0
   \ingroup views
   \brief Provides a list view with scroll bars, styling and header sections.
   \image tableview.png
   A TableView is similar to \l ListView, and adds scroll bars, selection, and
   resizable header sections. As with \l ListView, data for each row is provided through a \l model:
 \code
 ListModel {
    id: libraryModel
    ListElement{ title: "A Masterpiece" ; author: "Gabriel" }
    ListElement{ title: "Brilliance"    ; author: "Jens" }
    ListElement{ title: "Outstanding"   ; author: "Frederik" }
 \endcode
   You provide title and size of a column header
   by adding a \l TableViewColumn to the default \l header property
   as demonstrated below.
 \code
7172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140
TableView { TableViewColumn{ role: "title" ; title: "Title" ; width: 100 } TableViewColumn{ role: "author" ; title: "Author" ; width: 200 } model: libraryModel } \endcode The header sections are attached to values in the \l model by defining the model role they attach to. Each property in the model will then be shown in their corresponding column. You can customize the look by overriding the \l itemDelegate, \l rowDelegate, or \l headerDelegate properties. The view itself does not provide sorting. This has to be done on the model itself. However you can provide sorting on the model, and enable sort indicators on headers. \list \li int sortIndicatorColumn - The index of the current sort column \li bool sortIndicatorVisible - Whether the sort indicator should be enabled \li enum sortIndicatorOrder - Qt.AscendingOrder or Qt.DescendingOrder depending on state \endlist */ ScrollView { id: root /*! \qmlproperty model TableView::model This property holds the model providing data for the table view. The model provides the set of data that is used to create the items in the view. Models can be created directly in QML using ListModel, XmlListModel or VisualItemModel, or provided by C++ model classes. \sa ListView::model Example model: \code model: ListModel { ListElement{ column1: "value 1" ; column2: "value 2" } ListElement{ column1: "value 3" ; column2: "value 4" } } \endcode \sa {qml-data-models}{Data Models} */ property var model /*! This property is set to \c true if the view alternates the row color. The default value is \c true. */ property bool alternatingRowColors: true /*! This property determines if the header is visible. The default value is \c true. */ property bool headerVisible: true /*! This property defines a delegate to draw a specific cell. In the item delegate you have access to the following special properties: \list \li styleData.selected - if the item is currently selected \li styleData.value - the value or text for this item \li styleData.textColor - the default text color for an item \li styleData.row - the index of the row \li styleData.column - the index of the column \li styleData.elideMode - the elide mode of the column \li styleData.textAlignment - the horizontal text alignment of the column \endlist Example:
141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210
\code itemDelegate: Item { Text { anchors.verticalCenter: parent.verticalCenter color: styleData.textColor elide: styleData.elideMode text: styleData.value } } \endcode */ property Component itemDelegate: __style ? __style.itemDelegate : null /*! This property defines a delegate to draw a row. In the row delegate you have access to the following special properties: \list \li styleData.alternate - true when the row uses the alternate background color \li styleData.selected - true when the row is currently selected \li styleData.row - the index of the row \endlist */ property Component rowDelegate: __style ? __style.rowDelegate : null /*! \qmlproperty color TableView::backgroundColor This property sets the background color of the viewport. The default value is the base color of the SystemPalette. */ property alias backgroundColor: colorRect.color /*! This property defines a delegate to draw a header. In the header delegate you have access to the following special properties: \list \li styleData.value - the value or text for this item \li styleData.column - the index of the column \li styleData.pressed - true when the column is being pressed \li styleData.containsMouse - true when the column is under the mouse \endlist */ property Component headerDelegate: __style ? __style.headerDelegate : null /*! Index of the current sort column. The default value is \c {0}. */ property int sortIndicatorColumn /*! This property shows or hides the sort indicator The default value is \c false. \note The view itself does not sort the data. */ property bool sortIndicatorVisible: false /*! \qmlproperty enumeration TableView::sortIndicatorOrder This sets the sorting order of the sort indicator The allowed values are: \list \li Qt.AscendingOrder - the default \li Qt.DescendingOrder \endlist */ property int sortIndicatorOrder: Qt.AscendingOrder /*! \qmlproperty list<TableViewColumn> TableView::columns This property contains the TableViewColumn items */ default property alias columns: listView.columnheader /*! \qmlproperty Component TableView::contentHeader This is the content header of the TableView */ property alias contentHeader: listView.header
211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280
/*! \qmlproperty Component TableView::contentFooter This is the content footer of the TableView */ property alias contentFooter: listView.footer /*! \qmlproperty int TableView::rowCount The current number of rows */ readonly property alias rowCount: listView.count /*! The current number of columns */ readonly property int columnCount: columns.length /*! \qmlproperty string TableView::section.property \qmlproperty enumeration TableView::section.criteria \qmlproperty Component TableView::section.delegate \qmlproperty enumeration TableView::section.labelPositioning These properties determine the section labels. \sa ListView::section */ property alias section: listView.section /*! \qmlproperty int TableView::currentRow The current row index of the view. The default value is \c -1 to indicate that no row is selected. */ property alias currentRow: listView.currentIndex /*! \internal */ property alias __currentRowItem: listView.currentItem /*! \qmlsignal TableView::activated() Emitted when the user activates an item by single or double-clicking (depending on the platform). */ signal activated /*! \qmlmethod TableView::positionViewAtRow( int row, PositionMode mode ) Positions the view such that the specified \a row is at the position defined by \a mode: \list \li ListView.Beginning - position item at the top of the view. \li ListView.Center - position item in the center of the view. \li ListView.End - position item at bottom of the view. \li ListView.Visible - if any part of the item is visible then take no action, otherwise bring the item into view. \li ListView.Contain - ensure the entire item is visible. If the item is larger than the view the item is positioned at the top of the view. \endlist If positioning the \a row creates an empty space at the beginning or end of the view, then the view is positioned at the boundary. For example, to position the view at the end at startup: \code Component.onCompleted: table.positionViewAtRow(rowCount -1, ListView.Contain) \endcode Depending on how the model is populated, the model may not be ready when TableView Component.onCompleted is called. In that case you may need to delay the call to positionViewAtRow by using a \l {Timer}. \note This method should only be called after the component has completed. */ function positionViewAtRow(row, mode) { listView.positionViewAtRow(row, mode) } /*! \qmlmethod int TableView::rowAt( int x, int y ) Returns the index of the visible row at the point \a x, \a y in content
281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350
coordinates. If there is no visible row at the point specified, \c -1 is returned. \note This method should only be called after the component has completed. */ function rowAt(x, y) { var obj = root.mapToItem(listView.contentItem, x, y) return listView.indexAt(obj.x, obj.y) } style: Qt.createComponent(Settings.style + "/TableViewStyle.qml", root) Accessible.role: Accessible.Table width: 200 height: 200 frameVisible: true __scrollBarTopMargin: Qt.platform.os === "mac" ? headerrow.height : 0 __viewTopMargin: headerrow.height /*! \internal */ property bool __activateItemOnSingleClick: __style ? __style.activateItemOnSingleClick : false /*! \internal */ function __decrementCurrentIndex() { __scroller.blockUpdates = true; listView.decrementCurrentIndex(); __scroller.blockUpdates = false; } /*! \internal */ function __incrementCurrentIndex() { __scroller.blockUpdates = true; listView.incrementCurrentIndex(); __scroller.blockUpdates = false; } ListView { id: listView focus: true activeFocusOnTab: true anchors.topMargin: tableHeader.height anchors.fill: parent currentIndex: -1 visible: columnCount > 0 interactive: false SystemPalette { id: palette colorGroup: enabled ? SystemPalette.Active : SystemPalette.Disabled } Rectangle { id: colorRect parent: viewport anchors.fill: parent color: palette.base z: -1 } MouseArea { id: mousearea anchors.fill: listView propagateComposedEvents: true property bool autoincrement: false