summaryrefslogtreecommitdiff
path: root/src/controls/doc
diff options
context:
space:
mode:
authorCaroline Chao <caroline.chao@digia.com>2013-07-31 13:38:35 +0200
committerThe Qt Project <gerrit-noreply@qt-project.org>2013-08-16 17:32:06 +0200
commit5483ccd3547dcb3edbe4c50d70e6921ee5c5cb7a (patch)
tree634db3b0a47cf54e68fe232d5664cbde2dd8579a /src/controls/doc
parent2b308e33bec09c8a792b37282f6172a59dc3d543 (diff)
downloadqtquickcontrols-5483ccd3547dcb3edbe4c50d70e6921ee5c5cb7a.tar.gz
Move Styles and Private under controls
Register the C++ private API from the controls plugin. The private plugin is not needed anymore. The Controls "submodules" Styles and Private are moved to the controls subfolder in the sources tree. Change-Id: I98358227c945b6cd1a8dbff9d07e6cad4f044277 Reviewed-by: J-P Nurmi <jpnurmi@digia.com>
Diffstat (limited to 'src/controls/doc')
-rw-r--r--src/controls/doc/qtquickcontrols.qdocconf43
-rw-r--r--src/controls/doc/src/qtquickcontrols.qdoc2
-rw-r--r--src/controls/doc/src/qtquickcontrolsstyles-index.qdoc113
3 files changed, 142 insertions, 16 deletions
diff --git a/src/controls/doc/qtquickcontrols.qdocconf b/src/controls/doc/qtquickcontrols.qdocconf
index fe7770aa..3a566248 100644
--- a/src/controls/doc/qtquickcontrols.qdocconf
+++ b/src/controls/doc/qtquickcontrols.qdocconf
@@ -18,30 +18,41 @@ qhp.QtQuickControls.filterAttributes = qtquickcontrols $QT_VERSION qtrefdoc
qhp.QtQuickControls.customFilters.Qt.name = QtQuickControls $QT_VERSION
qhp.QtQuickControls.customFilters.Qt.filterAttributes = qtquickcontrols $QT_VERSION
-qhp.QtQuickControls.subprojects = qtquickcontrolsqmltypes
-qhp.QtQuickControls.subprojects.qtquickcontrolsqmltypes.title = QML Types
+qhp.QtQuickControls.subprojects = qtquickcontrolsqmltypes qtquickcontrolsstyles
+
+qhp.QtQuickControls.subprojects.qtquickcontrolsqmltypes.title = Controls QML Types
qhp.QtQuickControls.subprojects.qtquickcontrolsqmltypes.indexTitle = Qt Quick Controls QML Types
-qhp.QtQuickControls.subprojects.qtquickcontrolsqmltypes.selectors = class fake:qmlclass
-qhp.QtQuickControls.subprojects.qtquickcontrolsqmltypes.sortPages = true
+qhp.QtQuickControls.subprojects.qtquickcontrolsqmltypes.selectors = fake:qmlclass # cannot choose qmltypes from a specific group QTBUG-32985
+qhp.QtQuickControls.subprojects.qtquickcontrolsqmltypes.sortPages = true
+
+qhp.QtQuickControls.subprojects.qtquickcontrolsstyles.title = Qt Quick Controls Styles Structure
+qhp.QtQuickControls.subprojects.qtquickcontrolsstyles.indexTitle = Qt Quick Controls Styles Structure
+qhp.QtQuickControls.subprojects.qtquickcontrolsstyles.type = manual
-depends = qtqml qtquick qtwidgets qtdoc qtquicklayouts qtquickcontrolsstyles
+depends = qtqml qtquick qtwidgets qtdoc qtquicklayouts
exampledirs += ../../../examples/quick
# Specify the install path under QT_INSTALL_EXAMPLES
examplesinstallpath = quick/controls
-headerdirs += ../
-
-sourcedirs += ../
-
-sources += ../../private/AbstractCheckable.qml \
- ../../private/BasicButton.qml \
- ../../private/FocusFrame.qml \
- ../../private/ModalPopupBehavior.qml \
- ../../private/ScrollBar.qml \
- ../../private/TabBar.qml \
- ../../private/Control.qml \
+headerdirs += ../ \
+ Styles/Base
+
+sourcedirs += ../ \
+ Styles/Base
+
+sources += ../Private/AbstractCheckable.qml \
+ ../Private/BasicButton.qml \
+ ../Private/FocusFrame.qml \
+ ../Private/ModalPopupBehavior.qml \
+ ../Private/ScrollBar.qml \
+ ../Private/TabBar.qml \
+ ../Private/Control.qml \
+ ../Private/qquickstyleitem.cpp \
+ ../Private/Style.qml \
+ ../Private/qquickabstractstyle.h \
+ ../Private/qquickabstractstyle.cpp
imagedirs += images
diff --git a/src/controls/doc/src/qtquickcontrols.qdoc b/src/controls/doc/src/qtquickcontrols.qdoc
index 73138086..746d7873 100644
--- a/src/controls/doc/src/qtquickcontrols.qdoc
+++ b/src/controls/doc/src/qtquickcontrols.qdoc
@@ -35,6 +35,8 @@
interfaces. These QML types work in conjunction with \l{Qt Quick} and
\l{Qt Quick Layouts}.
+ Controls can be styled using the \l{Qt Quick Controls Styles QML Types}{Styles QML Types}.
+
The QML types can be imported into your application using the
following import statement in your .qml file.
diff --git a/src/controls/doc/src/qtquickcontrolsstyles-index.qdoc b/src/controls/doc/src/qtquickcontrolsstyles-index.qdoc
new file mode 100644
index 00000000..e035ddba
--- /dev/null
+++ b/src/controls/doc/src/qtquickcontrolsstyles-index.qdoc
@@ -0,0 +1,113 @@
+/****************************************************************************
+**
+** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/legal
+**
+** 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 Digia. For licensing terms and
+** conditions see http://qt.digia.com/licensing. For further information
+** use the contact form at http://qt.digia.com/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$
+**
+****************************************************************************/
+
+
+
+/*!
+ \group applicationwindowstyling
+ \title Styling Application Window
+ \internal
+*/
+
+/*!
+ \group viewsstyling
+ \title Styling Views
+*/
+
+/*!
+ \group controlsstyling
+ \title Styling Controls
+*/
+
+/*!
+ \group menusstyling
+ \title Styling Menus
+ \internal
+*/
+
+
+/*!
+ \page qtquickcontrolsstyles-index.html
+ \title Qt Quick Controls Styles
+ \brief The Qt Quick Controls Styles submodule provides custom styles for Qt Quick Controls.
+
+ The Qt Quick Controls Styles submodule allows custom styling for \l {Qt Quick Controls}.
+
+ The submodule is new in Qt 5.1 and requires \l{Qt Quick} 2.1.
+
+ \section1 Getting started
+
+ The QML types can be imported into your application using the following import statement in your \c {.qml} file.
+
+ \code
+ import QtQuick.Controls.Styles 1.0
+ \endcode
+
+ \section1 Styling Views
+ \annotatedlist viewsstyling
+
+ \section1 Styling Controls
+ \annotatedlist controlsstyling
+
+ \section1 Related information
+
+ \list
+ \li \l{Qt Quick}
+ \li \l{Qt Quick Controls}
+ \li \l{Qt Quick Controls Styles QML Types}
+ \endlist
+
+*/
+
+/*!
+ \page qtquickcontrolsstyles-structure.html
+ \title Qt Quick Controls Styles Structure
+ \list
+ \li \l{Qt Quick Controls Styles}
+ \list
+ \li \l{Qt Quick Controls Styles QML Types}{Styles QMl Types}
+ \endlist
+ \endlist
+*/
+
+/*!
+ \qmlmodule QtQuick.Controls.Styles 1
+ \title Qt Quick Controls Styles QML Types
+ \ingroup qmlmodules
+ \brief Provides QML types for Qt Quick Controls styles.
+
+ The \l{Qt Quick Controls} module provides a set of QML types for handling
+ styles.
+
+ Some of the controls allow custom styling similar to widget style sheets.
+ A styling object is usually a collection of properties that control behavior and simple delegates
+ that can be replaced with custom QML snippets.
+
+ \code
+ import QtQuick.Controls.Styles 1.0
+ \endcode
+*/