diff --git a/src/widgets/doc/src/qtwidgets-index.qdoc b/src/widgets/doc/src/qtwidgets-index.qdoc new file mode 100644 index 0000000000..61f723ae7c --- /dev/null +++ b/src/widgets/doc/src/qtwidgets-index.qdoc @@ -0,0 +1,138 @@ +/**************************************************************************** +** +** 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-index.html +\title Qt Widgets +\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 + following directive: + + \snippet code/doc_src_qtwidgets.cpp 1 + + To link against the module, add this line to your \l qmake \c + .pro file: + + \snippet code/doc_src_qtwidgets.pro 0 + +\section1 Widgets + + Widgets are for building C++ user interfaces. They are customizable with + layouts and stylesheets. + + \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 + + \section2 Layouts + + 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. + + \list + \li \l{Widgets and Layouts} + \li \l{Qt Designer Integration} + \li \l{Layout Management} + \endlist + + \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. + + \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 + +\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. + +\section1 Model/View + + 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. + + \list + \li \l{Model/View Programming} + \li \l{Model/View Tutorial} + \endlist + +\section1 Reference + +\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} + \endlist +\li \l{Qt Style Sheets Reference} +\endlist + +*/ diff --git a/src/widgets/doc/src/qtwidgets.qdoc b/src/widgets/doc/src/qtwidgets.qdoc index 74410138be..f192c5114e 100644 --- a/src/widgets/doc/src/qtwidgets.qdoc +++ b/src/widgets/doc/src/qtwidgets.qdoc @@ -27,10 +27,10 @@ /*! \module QtWidgets - \title QtWidgets Module + \title Qt Widgets C++ API \ingroup modules - \brief The QtWidgets module extends QtGui with C++ widget functionality. + \brief The QtWidgets module extends Qt Gui with C++ widget functionality. To include the definitions of the module's classes, use the following directive: diff --git a/src/widgets/doc/src/widgets-and-layouts/styles.qdoc b/src/widgets/doc/src/widgets-and-layouts/styles.qdoc index 4755217c9f..56801bc1d9 100644 --- a/src/widgets/doc/src/widgets-and-layouts/styles.qdoc +++ b/src/widgets/doc/src/widgets-and-layouts/styles.qdoc @@ -27,7 +27,7 @@ /*! \group appearance - \title Widget Appearance and Style + \title Widget Appearance and Style-Related Classes \brief Classes used for customizing UI appearance and style. */ @@ -244,7 +244,7 @@ the PM_LayoutHorizontalSpacing and PM_LayoutVerticalSpacing, which is the way the java style does it (through QCommonStyle). Alternatively, you can implement QStyle::layoutSpacing() and - QStyle::layoutSpacingImplementation() if you need more control over + QStyle::layoutSpacingImplementation() if you need more control over this part of the layout. In these functions you can calculate the spacing based on control types (QSizePolicy::ControlType) for different size policies (QSizePolicy::Policy) and also the style @@ -253,7 +253,7 @@ \section2 Style Options The sub-classes of QStyleOption contain all information necessary - to style the individual elements. Style options are instantiated - + to style the individual elements. Style options are instantiated - usually on the stack - and filled out by the caller of the QStyle function. Depending on what is drawn the style will expect different a different style option class. For example, the @@ -538,7 +538,7 @@ details; most widgets follow the same structure as the check boxes. We have edited the QCommonStyle code somewhat to remove code that is not directly relevant for check box styling. - + We start with a look at how QCheckBox builds it style option, which is QStyleOptionButton for checkboxes: @@ -839,7 +839,7 @@ As mentioned, the style calculates the size of the widgets contents, which the widgets calculate their size hints from. In addition, complex controls also use the style to test which - sub-controls the mouse is over. + sub-controls the mouse is over. \section2 Widget Reference @@ -1800,7 +1800,7 @@ The setup of the style option for CE_MenuTearOff and CE_MenuScroller also uses QStyleOptionMenuItem; they only set the \c menuRect variable in addition to the common settings with - QStyleOption's \l{QStyleOption::}{initFrom()}. + QStyleOption's \l{QStyleOption::}{initFrom()}. \section3 Menu Bar @@ -1845,7 +1845,7 @@ QStyleOptionFrame is used for drawing the panel frame The \l{QStyleOptionFrame::}{lineWidth} is set to PM_MenuBarPanelWidth. The \l{QStyleOptionFrame::}{midLineWidth} is currently always set - to 0. + to 0. \section3 Item View Headers @@ -2048,7 +2048,7 @@ \li shape \li a QRubberBand::Shape enum value that holds the shape of the band (which is either a rectangle or a - line) + line) \endtable \section3 Dock Widgets @@ -2068,7 +2068,7 @@ from its main window (i.e., it is a top level window). If it is docked it draws the indicator dock widget resize handle. We show a dock widget in both docked and floating state in the plastique - style: + style: \image javastyle/dockwidgetimage.png diff --git a/src/widgets/doc/src/widgets-and-layouts/widgets.qdoc b/src/widgets/doc/src/widgets-and-layouts/widgets.qdoc index f7032fb81c..38e7eb6929 100644 --- a/src/widgets/doc/src/widgets-and-layouts/widgets.qdoc +++ b/src/widgets/doc/src/widgets-and-layouts/widgets.qdoc @@ -57,7 +57,7 @@ and the layout distributes the available space accordingly. \table - \row + \row \li \image qgridlayout-with-5-children.png \li \image qformlayout-with-6-children.png \endtable