From d3921cce47f834dd37cf0bb4085ba242dbbe2412 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tor=20Arne=20Vestb=C3=B8?= Date: Mon, 15 Oct 2012 20:15:17 +0200 Subject: doc: Add a bunch of missing depends Change-Id: I32c3730f8181d73a7c8e36ef382c74b8da754269 --- src/widgets/doc/qtwidgets.qdocconf | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'src/widgets') diff --git a/src/widgets/doc/qtwidgets.qdocconf b/src/widgets/doc/qtwidgets.qdocconf index 5487d1ed08..b0eeaf9096 100644 --- a/src/widgets/doc/qtwidgets.qdocconf +++ b/src/widgets/doc/qtwidgets.qdocconf @@ -31,7 +31,7 @@ qhp.QtWidgets.subprojects.examples.selectors = fake:example tagfile = ../../../doc/qtwidgets/qtwidgets.tags -depends += qtcore qtgui +depends += qtcore qtgui qtdoc qtsql headerdirs += .. -- cgit v1.2.3 From 2b6edec5c205fa1162d8b9e91c45fa42bdbda634 Mon Sep 17 00:00:00 2001 From: Jan Arve Saether Date: Mon, 15 Oct 2012 15:40:28 +0200 Subject: Doc: Added landing-, examples- and C++ class list-page to qtwidgets It seems this is the pattern to follow: landing page: qtwidgets-index.html examples page: qtwidgets-examples.html class list page: qtwidgets-module.html Change-Id: I3e5459fe650178e0398cb43181b594c0f12a170e Reviewed-by: Jerome Pasion --- src/widgets/doc/images/widget-examples.png | Bin 0 -> 6128 bytes .../doc/snippets/widgets-tutorial/template.cpp | 2 +- src/widgets/doc/src/qtwidgets-examples.qdoc | 75 ++++++++++ src/widgets/doc/src/qtwidgets-index.qdoc | 161 +++++++++++++-------- src/widgets/doc/src/qtwidgets.qdoc | 2 +- .../doc/src/widgets-and-layouts/gallery.qdoc | 2 +- 6 files changed, 177 insertions(+), 65 deletions(-) create mode 100644 src/widgets/doc/images/widget-examples.png create mode 100644 src/widgets/doc/src/qtwidgets-examples.qdoc (limited to 'src/widgets') 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 Binary files /dev/null and b/src/widgets/doc/images/widget-examples.png differ 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 +#include // 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..9a6f97404c --- /dev/null +++ b/src/widgets/doc/src/qtwidgets-examples.qdoc @@ -0,0 +1,75 @@ +/**************************************************************************** +** +** 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. + + \list + \li \l{widgets/analogclock}{Analog Clock}\raisedaster + \li \l{widgets/calculator}{Calculator}\raisedaster + \li \l{widgets/calendarwidget}{Calendar Widget}\raisedaster + \li \l{widgets/charactermap}{Character Map}\raisedaster + \li \l{widgets/codeeditor}{Code Editor}\raisedaster + \li \l{widgets/digitalclock}{Digital Clock}\raisedaster + \li \l{widgets/groupbox}{Group Box}\raisedaster + \li \l{widgets/icons}{Icons}\raisedaster + \li \l{widgets/imageviewer}{Image Viewer}\raisedaster + \li \l{widgets/lineedits}{Line Edits}\raisedaster + \li \l{widgets/movie}{Movie} + \li \l{widgets/scribble}{Scribble}\raisedaster + \li \l{widgets/shapedclock}{Shaped Clock}\raisedaster + \li \l{widgets/sliders}{Sliders}\raisedaster + \li \l{widgets/softkeys}{Soft Keys} + \li \l{widgets/spinboxes}{Spin Boxes}\raisedaster + \li \l{widgets/styles}{Styles}\raisedaster + \li \l{widgets/stylesheet}{Style Sheet}\raisedaster + \li \l{widgets/tablet}{Tablet}\raisedaster + \li \l{widgets/tetrix}{Tetrix}\raisedaster + \li \l{widgets/tooltips}{Tooltips}\raisedaster + \li \l{widgets/validators}{Validators} + \li \l{widgets/wiggly}{Wiggly}\raisedaster + \li \l{widgets/windowflags}{Window Flags}\raisedaster + \endlist + + Examples marked with an asterisk (*) are fully documented. + +*/ \ 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 -- cgit v1.2.3 From 294dbc7bfd77ef0be439fc2157d057e6e100c5c5 Mon Sep 17 00:00:00 2001 From: Jan Arve Saether Date: Mon, 22 Oct 2012 13:39:07 +0200 Subject: Use \annotatedlist for list of examples instead of "manual links" Change-Id: Id945fd35f5eb6a6d11156d4a1356f99cc49405e2 Reviewed-by: Jerome Pasion --- src/widgets/doc/src/qtwidgets-examples.qdoc | 29 +---------------------------- 1 file changed, 1 insertion(+), 28 deletions(-) (limited to 'src/widgets') diff --git a/src/widgets/doc/src/qtwidgets-examples.qdoc b/src/widgets/doc/src/qtwidgets-examples.qdoc index 9a6f97404c..b199c97823 100644 --- a/src/widgets/doc/src/qtwidgets-examples.qdoc +++ b/src/widgets/doc/src/qtwidgets-examples.qdoc @@ -43,33 +43,6 @@ be used to change the appearance of standard widgets and appropriately written custom widgets. - \list - \li \l{widgets/analogclock}{Analog Clock}\raisedaster - \li \l{widgets/calculator}{Calculator}\raisedaster - \li \l{widgets/calendarwidget}{Calendar Widget}\raisedaster - \li \l{widgets/charactermap}{Character Map}\raisedaster - \li \l{widgets/codeeditor}{Code Editor}\raisedaster - \li \l{widgets/digitalclock}{Digital Clock}\raisedaster - \li \l{widgets/groupbox}{Group Box}\raisedaster - \li \l{widgets/icons}{Icons}\raisedaster - \li \l{widgets/imageviewer}{Image Viewer}\raisedaster - \li \l{widgets/lineedits}{Line Edits}\raisedaster - \li \l{widgets/movie}{Movie} - \li \l{widgets/scribble}{Scribble}\raisedaster - \li \l{widgets/shapedclock}{Shaped Clock}\raisedaster - \li \l{widgets/sliders}{Sliders}\raisedaster - \li \l{widgets/softkeys}{Soft Keys} - \li \l{widgets/spinboxes}{Spin Boxes}\raisedaster - \li \l{widgets/styles}{Styles}\raisedaster - \li \l{widgets/stylesheet}{Style Sheet}\raisedaster - \li \l{widgets/tablet}{Tablet}\raisedaster - \li \l{widgets/tetrix}{Tetrix}\raisedaster - \li \l{widgets/tooltips}{Tooltips}\raisedaster - \li \l{widgets/validators}{Validators} - \li \l{widgets/wiggly}{Wiggly}\raisedaster - \li \l{widgets/windowflags}{Window Flags}\raisedaster - \endlist - - Examples marked with an asterisk (*) are fully documented. + \annotatedlist examples-widgets */ \ No newline at end of file -- cgit v1.2.3 From e52f178b0d21b84a5cedcfce17646fbc1fb84867 Mon Sep 17 00:00:00 2001 From: Jerome Pasion Date: Fri, 26 Oct 2012 14:47:38 +0200 Subject: Doc: Removed the HTML template from the .qdocconf files -qt-module-defaults.qdocconf already contains the HTML template. Change-Id: I5757741166f0f688ce0e8a4e77ed45fd4d72f1c7 Reviewed-by: Martin Smith --- src/widgets/doc/qtwidgets.qdocconf | 1 - 1 file changed, 1 deletion(-) (limited to 'src/widgets') diff --git a/src/widgets/doc/qtwidgets.qdocconf b/src/widgets/doc/qtwidgets.qdocconf index b0eeaf9096..52946fee34 100644 --- a/src/widgets/doc/qtwidgets.qdocconf +++ b/src/widgets/doc/qtwidgets.qdocconf @@ -1,4 +1,3 @@ -include($QT_INSTALL_DOCS/global/qt-html-templates-offline.qdocconf) include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf) project = QtWidgets -- cgit v1.2.3 From b4a05fd2d845c0898aa628b94dc28c4c0e99cfba Mon Sep 17 00:00:00 2001 From: Jerome Pasion Date: Tue, 6 Nov 2012 18:53:23 +0100 Subject: Doc: Cleaning up QHP information in module configuration files. There is a common standard among all Qt modules. These changes affect the final .qch file for each module. Changes: 1)URL in qt-project.org is confirmed by DevNet maintainer url = http://qt-project.org/doc/ 2)Landing page title mapping indexTitle = landing page 3)"C++ Classes" as a child node. The list of C++ classes and the titles are specified in the wiki. 4)Removed extra subprojects. They are not needed for now. Each module may need additional nodes. Change-Id: I1825476c21fe9aaddc9d6b512ff74229f17271a0 Reviewed-by: Martin Smith --- src/widgets/doc/qtwidgets.qdocconf | 19 +++++++------------ 1 file changed, 7 insertions(+), 12 deletions(-) (limited to 'src/widgets') diff --git a/src/widgets/doc/qtwidgets.qdocconf b/src/widgets/doc/qtwidgets.qdocconf index 52946fee34..1bdc96a7fc 100644 --- a/src/widgets/doc/qtwidgets.qdocconf +++ b/src/widgets/doc/qtwidgets.qdocconf @@ -2,31 +2,26 @@ 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 -- cgit v1.2.3