From 0bf1c3622e1277c83d323344bced2215f752a458 Mon Sep 17 00:00:00 2001 From: Jan Arve Saether Date: Fri, 23 Nov 2012 09:58:30 +0100 Subject: Doc: Be consistent, and put all widget classes in the same page. Change-Id: I152a39e798a152b5362db7fdc63ccd6b887ee13b Reviewed-by: Jerome Pasion --- src/widgets/doc/src/graphicsview.qdoc | 5 - src/widgets/doc/src/model-view-programming.qdoc | 6 - src/widgets/doc/src/qtwidgets-index.qdoc | 24 +--- .../doc/src/widgets-and-layouts/layout.qdoc | 6 - .../doc/src/widgets-and-layouts/styles.qdoc | 7 - .../doc/src/widgets-and-layouts/widgets.qdoc | 157 ++++++++------------- .../doc/src/windows-and-dialogs/mainwindow.qdoc | 6 - 7 files changed, 62 insertions(+), 149 deletions(-) (limited to 'src') diff --git a/src/widgets/doc/src/graphicsview.qdoc b/src/widgets/doc/src/graphicsview.qdoc index bde4be099a..56dd3ee88a 100644 --- a/src/widgets/doc/src/graphicsview.qdoc +++ b/src/widgets/doc/src/graphicsview.qdoc @@ -25,11 +25,6 @@ ** ****************************************************************************/ -/*! - \group graphicsview-api - \title Graphics View Classes -*/ - /*! \page graphicsview.html \title Graphics View Framework diff --git a/src/widgets/doc/src/model-view-programming.qdoc b/src/widgets/doc/src/model-view-programming.qdoc index 39f966948f..8c554eb9b0 100644 --- a/src/widgets/doc/src/model-view-programming.qdoc +++ b/src/widgets/doc/src/model-view-programming.qdoc @@ -24,12 +24,6 @@ ** $QT_END_LICENSE$ ** ****************************************************************************/ - -/*! - \group model-view - \title Model/View Classes -*/ - /*! \page model-view-programming.html \ingroup qt-basic-concepts diff --git a/src/widgets/doc/src/qtwidgets-index.qdoc b/src/widgets/doc/src/qtwidgets-index.qdoc index 82e6a0109f..20b5301ee5 100644 --- a/src/widgets/doc/src/qtwidgets-index.qdoc +++ b/src/widgets/doc/src/qtwidgets-index.qdoc @@ -141,7 +141,10 @@ interfaces \list \li \l{Qt Widgets C++ Classes} \list + \li \l{Basic Widget Classes} + \li \l{Advanced Widget Classes} \li \l{Abstract Widget Classes} + \li \l{Organizer Widget Classes} \li \l{Graphics View Classes} \li \l{Model/View Classes} \li \l{Main Window and Related Classes} @@ -151,25 +154,4 @@ interfaces \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/widgets-and-layouts/layout.qdoc b/src/widgets/doc/src/widgets-and-layouts/layout.qdoc index e79aca9ebe..7b88a3a63d 100644 --- a/src/widgets/doc/src/widgets-and-layouts/layout.qdoc +++ b/src/widgets/doc/src/widgets-and-layouts/layout.qdoc @@ -24,12 +24,6 @@ ** $QT_END_LICENSE$ ** ****************************************************************************/ - -/*! - \group geomanagement - \title Layout Classes -*/ - /*! \page layout.html \title Layout Management diff --git a/src/widgets/doc/src/widgets-and-layouts/styles.qdoc b/src/widgets/doc/src/widgets-and-layouts/styles.qdoc index 80b7eb9987..df2bb417e8 100644 --- a/src/widgets/doc/src/widgets-and-layouts/styles.qdoc +++ b/src/widgets/doc/src/widgets-and-layouts/styles.qdoc @@ -24,13 +24,6 @@ ** $QT_END_LICENSE$ ** ****************************************************************************/ - -/*! - \group appearance - \title Widget Appearance and Style-Related Classes - \brief Classes used for customizing UI appearance and style. -*/ - /*! \page style-reference.html \title Styles and Style Aware Widgets diff --git a/src/widgets/doc/src/widgets-and-layouts/widgets.qdoc b/src/widgets/doc/src/widgets-and-layouts/widgets.qdoc index 38e7eb6929..c8c16fdd54 100644 --- a/src/widgets/doc/src/widgets-and-layouts/widgets.qdoc +++ b/src/widgets/doc/src/widgets-and-layouts/widgets.qdoc @@ -26,137 +26,98 @@ ****************************************************************************/ /*! - \page widgets-and-layouts.html - \title Widgets and Layouts + \page widget-classes.html + \title Widgets Classes \ingroup qt-gui-concepts \brief The primary elements for designing user interfaces in Qt. - \section1 Widgets + \section1 The Widget Classes - 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}. + The following sections list the widget classes. See the \l{Qt Widget + Gallery} for some examples. - \image parent-child-widgets.png A parent widget containing various child widgets. + \section2 Basic Widget Classes - 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. + These basic widgets (controls), e.g. buttons, comboboxes and + scroll bars, are designed for direct use. - \section1 Layouts + \table + \row + \li \image windows-label.png + \li \image windowsvista-pushbutton.png + \li \image gtk-progressbar.png + \row + \li \image plastique-combobox.png + \li \image macintosh-radiobutton.png + \li \image cde-lineedit.png + \endtable - \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. + \annotatedlist basicwidgets - \table - \row - \li \image qgridlayout-with-5-children.png - \li \image qformlayout-with-6-children.png - \endtable + \table + \row + \li \image windowsvista-tabwidget.png + \li \image macintosh-groupbox.png + \endtable - Qt Designer is a powerful tool for interactively creating and - arranging widgets in layouts. - \section1 Widget Styles + \section2 Advanced Widget Classes - \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. + Advanced GUI widgets, e.g. tab widgets and progress bars, provide + more complex user interface controls. - \table - \row - \li \image windowsxp-tabwidget.png - \li \image plastique-tabwidget.png - \li \image macintosh-tabwidget.png - \endtable + \table + \row + \li \image windowsxp-treeview.png + \li \image gtk-calendarwidget.png + \li \image qundoview.png + \endtable - \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. + \annotatedlist advanced - \section1 The Widget Classes - The following sections list the widget classes. See the \l{Qt Widget - Gallery} for some examples. + \section2 Abstract Widget Classes - \section2 Basic Widgets + The abstract widget classes are base classes. They are not usable as + standalone classes but provide functionality when they are subclassed. - These basic widgets (controls), e.g. buttons, comboboxes and - scroll bars, are designed for direct use. + \annotatedlist abstractwidgets - \table - \row - \li \image windows-label.png - \li \image windowsvista-pushbutton.png - \li \image gtk-progressbar.png - \row - \li \image plastique-combobox.png - \li \image macintosh-radiobutton.png - \li \image cde-lineedit.png - \endtable - \annotatedlist basicwidgets + \section2 Organizer Widget Classes - \section2 Advanced Widgets + Classes like splitters, tab bars, button groups, etc are used for + organizing and grouping GUI primitives into more complex + applications and dialogs. - Advanced GUI widgets, e.g. tab widgets and progress bars, provide - more complex user interface controls. + \annotatedlist organizers - \table - \row - \li \image windowsxp-treeview.png - \li \image gtk-calendarwidget.png - \li \image qundoview.png - \endtable - \annotatedlist advanced + \section2 Graphics View Classes - \table - \row - \li \image windowsvista-tabwidget.png - \li \image macintosh-groupbox.png - \endtable + \annotatedlist graphicsview-api - \section2 Organizer Widgets - Classes like splitters, tab bars, button groups, etc are used for - organizing and grouping GUI primitives into more complex - applications and dialogs. + \section2 Model/View Classes - \annotatedlist organizers + \annotatedlist model-view - \section2 Abstract Widget Classes - The abstract widget classes are base classes. They are not usable as - standalone classes but provide functionality when they are subclassed. + \section2 Main Window and Related Classes - \annotatedlist abstractwidgets -*/ + \annotatedlist mainwindow-classes -/*! - \group advanced - \title Advanced Widgets -*/ -/*! - \group abstractwidgets - \title Abstract Widget Classes -*/ + \section2 Widget Appearance and Style-Related Classes + Classes used for customizing UI appearance and style. + + \annotatedlist appearance + + + \section2 Layout Classes + \annotatedlist geomanagement -/*! - \group basicwidgets - \title Basic Widgets -*/ -/*! - \group organizers - \title Organizers */ + + diff --git a/src/widgets/doc/src/windows-and-dialogs/mainwindow.qdoc b/src/widgets/doc/src/windows-and-dialogs/mainwindow.qdoc index c6e4836cd6..a42570058c 100644 --- a/src/widgets/doc/src/windows-and-dialogs/mainwindow.qdoc +++ b/src/widgets/doc/src/windows-and-dialogs/mainwindow.qdoc @@ -24,12 +24,6 @@ ** $QT_END_LICENSE$ ** ****************************************************************************/ - -/*! - \group mainwindow-classes - \title Main Window and Related Classes -*/ - /*! \page application-windows.html \title Window and Dialog Widgets -- cgit v1.2.3