diff options
author | Caroline Chao <caroline.chao@digia.com> | 2013-06-01 17:16:10 +0200 |
---|---|---|
committer | The Qt Project <gerrit-noreply@qt-project.org> | 2013-06-03 14:54:05 +0200 |
commit | 3eee91908e8bd0c5f3c3ebe59ef1e179c8d1eb68 (patch) | |
tree | 360aa93d59792ca3ca439328982ed5e8ce348232 /src/styles/doc/src/qtquickcontrolsstyles-index.qdoc | |
parent | ea2de46b77aa42f857d79cf0b23113c57e02c759 (diff) | |
download | qtquickcontrols-3eee91908e8bd0c5f3c3ebe59ef1e179c8d1eb68.tar.gz |
Doc: Add doc structure for Styles
And:
- Add an index page for the Styles
- Add missing documentation for some properties (Component)
- Fix unexpected curly brackets in a couple of code snippets
Change-Id: Ib7265d1cd011a81012eb4b7f69738b84fba5b531
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Diffstat (limited to 'src/styles/doc/src/qtquickcontrolsstyles-index.qdoc')
-rw-r--r-- | src/styles/doc/src/qtquickcontrolsstyles-index.qdoc | 98 |
1 files changed, 98 insertions, 0 deletions
diff --git a/src/styles/doc/src/qtquickcontrolsstyles-index.qdoc b/src/styles/doc/src/qtquickcontrolsstyles-index.qdoc new file mode 100644 index 00000000..b2205bfc --- /dev/null +++ b/src/styles/doc/src/qtquickcontrolsstyles-index.qdoc @@ -0,0 +1,98 @@ +/**************************************************************************** +** +** 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 + + \section2 QML Types + \list + \li \l{Qt Quick Controls Styles QML Types} + \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. + +*/ |