summaryrefslogtreecommitdiffstats
path: root/src/widgets
diff options
context:
space:
mode:
authorEskil Abrahamsen Blomfeldt <eskil.abrahamsen-blomfeldt@nokia.com>2012-11-20 10:08:29 +0100
committerEskil Abrahamsen Blomfeldt <eskil.abrahamsen-blomfeldt@nokia.com>2012-11-20 10:12:44 +0100
commit0dc61c4216697a2c4066d4735b4be941e869e514 (patch)
tree8a3876897fc5144cc2f9b28223ff9548944a8775 /src/widgets
parentb98b11fa036ea301d1483df6f533ec55be727d9d (diff)
parenta769a212e0c22283fc05d3f49c252f8e2a62ba3f (diff)
Merge branch 'newdocs'
Added prepare_docs to qt_build_config.prf (it was added directly in configure in the source branch) Conflicts: configure tools/configure/configureapp.cpp Change-Id: I1337c69fc62b1c934e3e39b4409e4857440c9db8
Diffstat (limited to 'src/widgets')
-rw-r--r--src/widgets/doc/images/widget-examples.pngbin0 -> 6128 bytes
-rw-r--r--src/widgets/doc/qtwidgets.qdocconf22
-rw-r--r--src/widgets/doc/snippets/widgets-tutorial/template.cpp2
-rw-r--r--src/widgets/doc/src/qtwidgets-examples.qdoc48
-rw-r--r--src/widgets/doc/src/qtwidgets-index.qdoc161
-rw-r--r--src/widgets/doc/src/qtwidgets.qdoc2
-rw-r--r--src/widgets/doc/src/widgets-and-layouts/gallery.qdoc2
7 files changed, 158 insertions, 79 deletions
diff --git a/src/widgets/doc/images/widget-examples.png b/src/widgets/doc/images/widget-examples.png
new file mode 100644
index 0000000000..1e4e97c34f
--- /dev/null
+++ b/src/widgets/doc/images/widget-examples.png
Binary files differ
diff --git a/src/widgets/doc/qtwidgets.qdocconf b/src/widgets/doc/qtwidgets.qdocconf
index 5487d1ed08..1bdc96a7fc 100644
--- a/src/widgets/doc/qtwidgets.qdocconf
+++ b/src/widgets/doc/qtwidgets.qdocconf
@@ -1,37 +1,31 @@
-include($QT_INSTALL_DOCS/global/qt-html-templates-offline.qdocconf)
include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf)
project = QtWidgets
description = Qt Widgets Reference Documentation
-url = http://qt-project.org/doc/qt-5.0/qtwidgets
+url = http://qt-project.org/doc/qtwidgets
version = 5.0.0
qhp.projects = QtWidgets
qhp.QtWidgets.file = qtwidgets.qhp
qhp.QtWidgets.namespace = org.qt-project.qtwidgets.500
-qhp.QtWidgets.virtualFolder = qdoc
-qhp.QtWidgets.indexTitle = Qt Widgets Reference Documentation
+qhp.QtWidgets.virtualFolder = qtwidgets
+qhp.QtWidgets.indexTitle = Qt Widgets
qhp.QtWidgets.indexRoot =
qhp.QtWidgets.filterAttributes = qtwidgets 5.0.0 qtrefdoc
qhp.QtWidgets.customFilters.Qt.name = QtWidgets 5.0.0
qhp.QtWidgets.customFilters.Qt.filterAttributes = qtwidgets 5.0.0
-qhp.QtWidgets.subprojects = classes overviews examples
-qhp.QtWidgets.subprojects.classes.title = Classes
-qhp.QtWidgets.subprojects.classes.indexTitle = Qt Widgets' Classes
+
+qhp.QtWidgets.subprojects = classes
+qhp.QtWidgets.subprojects.classes.title = C++ Classes
+qhp.QtWidgets.subprojects.classes.indexTitle = Qt Widgets C++ Classes
qhp.QtWidgets.subprojects.classes.selectors = class fake:headerfile
qhp.QtWidgets.subprojects.classes.sortPages = true
-qhp.QtWidgets.subprojects.overviews.title = Overviews
-qhp.QtWidgets.subprojects.overviews.indexTitle = All Overviews and HOWTOs
-qhp.QtWidgets.subprojects.overviews.selectors = fake:page,group,module
-qhp.QtWidgets.subprojects.examples.title = Qt Widgets Examples
-qhp.QtWidgets.subprojects.examples.indexTitle = Qt Widgets Examples
-qhp.QtWidgets.subprojects.examples.selectors = fake:example
tagfile = ../../../doc/qtwidgets/qtwidgets.tags
-depends += qtcore qtgui
+depends += qtcore qtgui qtdoc qtsql
headerdirs += ..
diff --git a/src/widgets/doc/snippets/widgets-tutorial/template.cpp b/src/widgets/doc/snippets/widgets-tutorial/template.cpp
index 189578ef1b..c67ce374c0 100644
--- a/src/widgets/doc/snippets/widgets-tutorial/template.cpp
+++ b/src/widgets/doc/snippets/widgets-tutorial/template.cpp
@@ -39,7 +39,7 @@
****************************************************************************/
//! [main.cpp body]
-#include <QtGui>
+#include <QtWidgets>
// Include header files for application components.
// ...
diff --git a/src/widgets/doc/src/qtwidgets-examples.qdoc b/src/widgets/doc/src/qtwidgets-examples.qdoc
new file mode 100644
index 0000000000..b199c97823
--- /dev/null
+++ b/src/widgets/doc/src/qtwidgets-examples.qdoc
@@ -0,0 +1,48 @@
+/****************************************************************************
+**
+** 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$
+**
+****************************************************************************/
+
+/*!
+ \page qtwidgets-examples.html
+ \title Qt Widgets Examples
+ \brief Lots of examples of how to use different kinds of widgets.
+ \ingroup all-examples
+
+ \image widget-examples.png
+
+ Qt comes with a large range of standard widgets that users of modern
+ applications have come to expect.
+
+ You can also develop your own custom widgets and controls, and use them
+ alongside standard widgets.
+
+ It is even possible to provide custom styles and themes for widgets that can
+ be used to change the appearance of standard widgets and appropriately
+ written custom widgets.
+
+ \annotatedlist examples-widgets
+
+*/ \ No newline at end of file
diff --git a/src/widgets/doc/src/qtwidgets-index.qdoc b/src/widgets/doc/src/qtwidgets-index.qdoc
index 61f723ae7c..82e6a0109f 100644
--- a/src/widgets/doc/src/qtwidgets-index.qdoc
+++ b/src/widgets/doc/src/qtwidgets-index.qdoc
@@ -31,9 +31,6 @@
\brief A module which provides a set of C++ technologies for building user
interfaces
-Qt Widgets is a module which provides primary elements for building user
-interfaces in C++.
-
\section1 Getting Started
To include the definitions of the module's classes, use the
@@ -46,93 +43,133 @@ interfaces in C++.
\snippet code/doc_src_qtwidgets.pro 0
-\section1 Widgets
- Widgets are for building C++ user interfaces. They are customizable with
- layouts and stylesheets.
+
+
+ \section1 Widgets
+
+ Widgets are the primary elements for creating user interfaces in Qt.
+ \l{The Widget Classes}{Widgets} can display data and status information,
+ receive user input, and provide a container for other widgets that
+ should be grouped together. A widget that is not embedded in a
+ parent widget is called a \l{Window and Dialog Widgets} {window}.
+
+ \image parent-child-widgets.png A parent widget containing various child widgets.
+
+ The QWidget class provides the basic capability to render to the
+ screen, and to handle user input events. All UI elements that Qt
+ provides are either subclasses of QWidget, or are used in connection
+ with a QWidget subclass. Creating custom widgets is done by
+ subclassing QWidget or a suitable subclass and reimplementing the
+ virtual event handlers.
\list
- \li \l{Basic Widgets}
- \li \l{Advanced Widgets}
- \li \l{Organizers}
- \li \l{Widgets Tutorial}
\li \l{Window and Dialog Widgets}
\li \l{Application Main Window}
- \li \l{Standard Dialogs}
\li \l{Dialog Windows}
\endlist
- Qt's support for widget styles and themes enables your application to fit in
- with the native desktop environment. Below, you can find links to the
- various widget styles that are supplied with Qt Widgets.
- \list
- \li \l{Qt Widget Gallery}
- \li \l{Plastique Style Widget Gallery}
- \li \l{Cleanlooks Style Widget Gallery}
- \li \l{Windows XP Style Widget Gallery}
- \li \l{Windows Vista Style Widget Gallery}
- \li \l{GTK Style Widget Gallery}
- \li \l{Macintosh Style Widget Gallery}
- \endlist
+ \section1 Styles
- \section2 Layouts
+ \l{Styles and Style Aware Widgets}{Styles} draw on behalf of
+ widgets and encapsulate the look and feel of a GUI. Qt's built-in
+ widgets use the QStyle class to perform nearly all of their drawing,
+ ensuring that they look exactly like the equivalent native widgets.
- Widgets may use to automatically arrange child widgets within their
- container. Each widget reports its size requirements to the layout and the
- layout distributes the available space accordingly.
+ \table
+ \row
+ \li \image windowsxp-tabwidget.png
+ \li \image plastique-tabwidget.png
+ \li \image macintosh-tabwidget.png
+ \endtable
- \list
- \liĀ \l{Widgets and Layouts}
- \li \l{Qt Designer Integration}
- \li \l{Layout Management}
- \endlist
+ \l{Qt Style Sheets} are a powerful mechanism that allows you to customize the
+ appearance of widgets, in addition to what is already possible by subclassing QStyle.
- \section2 Style Sheets
- \l{Qt Style Sheets} are a powerful mechanism that allows for customization
- of the appearance of widgets. The concepts, terminology, and syntax of Qt
- Style Sheets are heavily inspired by HTML Cascading Style Sheets (CSS) but
- adapted to the world of widgets.
+ \section1 Layouts
- \list
- \li \l{Customizing Qt Widgets Using Style Sheets}
- \li \l{Qt Style Sheets}
- \li \l{The Style Sheet Syntax}
- \li \l{Styles and Style Aware Widgets}
- \li \l{Qt Style Sheets Examples}
- \endlist
+ \l{Layout Management}{Layouts} are an elegant and flexible way to
+ automatically arrange child widgets within their container. Each
+ widget reports its size requirements to the layout through the
+ \l{QWidget::}{sizeHint} and \l{QWidget::}{sizePolicy} properties,
+ and the layout distributes the available space accordingly.
-\section1 Graphics View
+ \table
+ \row
+ \li \image qgridlayout-with-5-children.png
+ \li \image qformlayout-with-6-children.png
+ \endtable
- The \l{Graphics View Framework} is for managing and interacting with a large
- number of custom-made 2D graphical items, and a view widget for visualizing
- the items, with support for zooming and rotation.
+ \l {Qt Designer} is a powerful tool for interactively creating and
+ arranging widgets in layouts.
-\section1 Model/View
+
+
+ \section1 Model/View Classes
The \l{Model/View Programming}{model/view} architecture provides classes
that manage the way data is presented to the user. Data-driven applications
which use lists and tables are structured to separate the data and view
using models, views, and delegates.
+ \image windowsxp-treeview.png
+
+ \section1 Graphics View
+
+ The \l{Graphics View Framework} is for managing and interacting with a large
+ number of custom-made 2D graphical items, and a view widget for visualizing
+ the items, with support for zooming and rotation.
+
+ \image graphicsview-items.png
+
+ \section1 Related Information
+
+ \section2 Tutorials
\list
- \li \l{Model/View Programming}
- \li \l{Model/View Tutorial}
+ \li \l{Widgets Tutorial}
+ \li \l{Model/View Tutorial}
\endlist
-\section1 Reference
+ \section2 Examples
+ \list
+ \li \l{Qt Widgets Examples}
+ \endlist
+ \section2 API Reference
+ These are links to the API reference materials.
-\list
-\li \l{Qt Widgets C++ API}
\list
- \li \l{Abstract Widget Classes}
- \li \l{Graphics View Classes}
- \li \l{Model/View Classes}
- \li \l{Main Window and Related Classes}
- \li \l{Widget Appearance and Style Related Classes}
- \li \l{Layout Classes}
+ \li \l{Qt Widgets C++ Classes}
+ \list
+ \li \l{Abstract Widget Classes}
+ \li \l{Graphics View Classes}
+ \li \l{Model/View Classes}
+ \li \l{Main Window and Related Classes}
+ \li \l{Widget Appearance and Style Related Classes}
+ \li \l{Layout Classes}
+ \endlist
+ \li \l{Qt Style Sheets Reference}
\endlist
-\li \l{Qt Style Sheets Reference}
-\endlist
+
*/
+
+ /*!
+ \group advanced
+ \title Advanced Widgets
+ */
+
+ /*!
+ \group abstractwidgets
+ \title Abstract Widget Classes
+ */
+
+ /*!
+ \group basicwidgets
+ \title Basic Widgets
+ */
+
+ /*!
+ \group organizers
+ \title Organizers
+ */
diff --git a/src/widgets/doc/src/qtwidgets.qdoc b/src/widgets/doc/src/qtwidgets.qdoc
index f192c5114e..5638e7b4d4 100644
--- a/src/widgets/doc/src/qtwidgets.qdoc
+++ b/src/widgets/doc/src/qtwidgets.qdoc
@@ -27,7 +27,7 @@
/*!
\module QtWidgets
- \title Qt Widgets C++ API
+ \title Qt Widgets C++ Classes
\ingroup modules
\brief The QtWidgets module extends Qt Gui with C++ widget functionality.
diff --git a/src/widgets/doc/src/widgets-and-layouts/gallery.qdoc b/src/widgets/doc/src/widgets-and-layouts/gallery.qdoc
index 64bdd3ab9a..9acacc24e7 100644
--- a/src/widgets/doc/src/widgets-and-layouts/gallery.qdoc
+++ b/src/widgets/doc/src/widgets-and-layouts/gallery.qdoc
@@ -32,7 +32,7 @@
Qt's support for widget styles and themes enables your application to fit in
with the native desktop environment. Below, you can find links to the various
- widget styles that are supplied with Qt 4.
+ widget styles that are supplied with Qt.
\table
\row