diff options
author | Gabriel de Dietrich <gabriel.dedietrich@theqtcompany.com> | 2015-04-16 16:00:33 +0200 |
---|---|---|
committer | Gabriel de Dietrich <gabriel.dedietrich@theqtcompany.com> | 2015-04-20 10:01:48 +0000 |
commit | 734cef951b9f93a930c02dcfecd03d51b17c41f9 (patch) | |
tree | e38728c2c0262762515351906457da8bc5106c4b /src/controls/doc | |
parent | 58f9d467c22f7333f8a4e9f726655882c9c331a0 (diff) | |
download | qtquickcontrols-734cef951b9f93a930c02dcfecd03d51b17c41f9.tar.gz |
Doc: Refactor TableViewStyle, TreeViewStyle
Change-Id: I9099073bc4095d6060162689ca17c4999124f254
Reviewed-by: Caroline Chao <caroline.chao@theqtcompany.com>
Diffstat (limited to 'src/controls/doc')
3 files changed, 151 insertions, 5 deletions
diff --git a/src/controls/doc/qtquickcontrols.qdocconf b/src/controls/doc/qtquickcontrols.qdocconf index e9e5cacf..e8aa0422 100644 --- a/src/controls/doc/qtquickcontrols.qdocconf +++ b/src/controls/doc/qtquickcontrols.qdocconf @@ -37,11 +37,9 @@ exampledirs += ../../../examples/quick/controls \ snippets examplesinstallpath = quick/controls -headerdirs += ../ \ - Styles/Base +headerdirs += .. -sourcedirs += ../ \ - Styles/Base +sourcedirs += .. sources += ../Private/AbstractCheckable.qml \ ../Private/BasicButton.qml \ @@ -55,7 +53,14 @@ sources += ../Private/AbstractCheckable.qml \ ../Private/qquickabstractstyle.h \ ../Private/qquickabstractstyle.cpp -excludefiles += ../TableView.qml ../TreeView.qml +excludefiles += ../TableView.qml \ + ../TreeView.qml \ + ../Styles/Base/TableViewStyle.qml \ + ../Styles/Base/TreeViewStyle.qml + +excludedirs += ../Styles/Desktop \ + ../Styles/Android \ + ../Styles/iOS imagedirs += images \ ../../extras/doc/images diff --git a/src/controls/doc/src/qtquickcontrolsstyles-tableviewstyle.qdoc b/src/controls/doc/src/qtquickcontrolsstyles-tableviewstyle.qdoc new file mode 100644 index 00000000..0b5012f1 --- /dev/null +++ b/src/controls/doc/src/qtquickcontrolsstyles-tableviewstyle.qdoc @@ -0,0 +1,59 @@ +/**************************************************************************** +** +** Copyright (C) 2015 The Qt Company Ltd. +** Contact: http://www.qt.io/licensing/ +** +** This file is part of the documentation of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:FDL$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see http://www.qt.io/terms-conditions. For further +** information use the contact form at http://www.qt.io/contact-us. +** +** GNU Free Documentation License Usage +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of +** this file. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: http://www.gnu.org/copyleft/fdl.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \qmltype TableViewStyle + \inqmlmodule QtQuick.Controls.Styles + \inherits BasicTableViewStyle + \since 5.1 + \ingroup viewsstyling + \brief Provides custom styling for TableView +*/ + +/*! + \qmlproperty TableView TableViewStyle::control + The \l TableView this style is attached to. +*/ + +/*! + \qmlproperty Component TableViewStyle::headerDelegate + + Delegate for header. This delegate is described in \l {TableView}{TableView.headerDelegate}. +*/ + +/*! + \qmlproperty Component TableViewStyle::rowDelegate + + Delegate for row. This delegate is described in \l {TableView}{TableView.rowDelegate}. +*/ + +/*! + \qmlproperty Component TableViewStyle::itemDelegate + + Delegate for item. This delegate is described in \l {TableView}{TableView.itemDelegate}. +*/ + diff --git a/src/controls/doc/src/qtquickcontrolsstyles-treeviewstyle.qdoc b/src/controls/doc/src/qtquickcontrolsstyles-treeviewstyle.qdoc new file mode 100644 index 00000000..3f4508f4 --- /dev/null +++ b/src/controls/doc/src/qtquickcontrolsstyles-treeviewstyle.qdoc @@ -0,0 +1,82 @@ +/**************************************************************************** +** +** Copyright (C) 2015 The Qt Company Ltd. +** Contact: http://www.qt.io/licensing/ +** +** This file is part of the documentation of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:FDL$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see http://www.qt.io/terms-conditions. For further +** information use the contact form at http://www.qt.io/contact-us. +** +** GNU Free Documentation License Usage +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of +** this file. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: http://www.gnu.org/copyleft/fdl.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \qmltype TreeViewStyle + \inqmlmodule QtQuick.Controls.Styles + \inherits BasicTableViewStyle + \since 5.5 + \ingroup viewsstyling + \brief Provides custom styling for TreeView +*/ + +/*! + \qmlproperty TreeView TreeViewStyle::control + The \l TreeView this style is attached to. +*/ + +/*! + \qmlproperty int TreeViewStyle::indentation + The amount each level is indented relatively to its parent level. +*/ + +/*! + \qmlproperty Component TreeViewStyle::branchDelegate + + This property defines a delegate to draw the branch indicator. + + In the branch delegate you have access to the following special properties: + \list + \li styleData.row - the index of the view row + \li styleData.column - the index of the view column. Will always be 0 + \li styleData.selected - if the item is currently selected + \li styleData.textColor - the default text color for an item + \li styleData.index - the QModelIndex of the current item in the model + \li styleData.depth - the depth of the current item in the tree model + \li styleData.isExpanded - true when the item is expanded + \li styleData.hasChildren - true if the model index of the current item has children + \li styleData.hasSibling - true if the model index of the current item has sibling + \endlist +*/ + +/*! + \qmlproperty Component TreeViewStyle::headerDelegate + + Delegate for header. This delegate is described in \l {TreeView}{TreeView.headerDelegate}. +*/ + +/*! + \qmlproperty Component TreeViewStyle::rowDelegate + + Delegate for row. This delegate is described in \l {TreeView}{TreeView.rowDelegate}. +*/ + +/*! + \qmlproperty Component TreeViewStyle::itemDelegate + + Delegate for item. This delegate is described in \l {TreeView}{TreeView.itemDelegate}. +*/ |