diff options
Diffstat (limited to 'examples')
23 files changed, 92 insertions, 48 deletions
diff --git a/examples/widgets/doc/src/analogclock.qdoc b/examples/widgets/doc/src/analogclock.qdoc index e882ccd3c1..68c2ce92b4 100644 --- a/examples/widgets/doc/src/analogclock.qdoc +++ b/examples/widgets/doc/src/analogclock.qdoc @@ -28,9 +28,9 @@ /*! \example widgets/analogclock \title Analog Clock Example - - The Analog Clock example shows how to draw the contents of a custom - widget. + \ingroup examples-widgets + \brief The Analog Clock example shows how to draw the contents of a + custom widget. \image analogclock-example.png Screenshot of the Analog Clock example diff --git a/examples/widgets/doc/src/calculator.qdoc b/examples/widgets/doc/src/calculator.qdoc index 1e6f9617fe..ee5df0e226 100644 --- a/examples/widgets/doc/src/calculator.qdoc +++ b/examples/widgets/doc/src/calculator.qdoc @@ -28,8 +28,8 @@ /*! \example widgets/calculator \title Calculator Example - - The example shows how to use signals and slots to implement the + \ingroup examples-widgets + \brief The example shows how to use signals and slots to implement the functionality of a calculator widget, and how to use QGridLayout to place child widgets in a grid. diff --git a/examples/widgets/doc/src/calendarwidget.qdoc b/examples/widgets/doc/src/calendarwidget.qdoc index d5a54d3c52..027da90df2 100644 --- a/examples/widgets/doc/src/calendarwidget.qdoc +++ b/examples/widgets/doc/src/calendarwidget.qdoc @@ -28,8 +28,8 @@ /*! \title Calendar Widget Example \example widgets/calendarwidget - - The Calendar Widget example shows use of \c QCalendarWidget. + \ingroup examples-widgets + \brief The Calendar Widget example shows use of \c QCalendarWidget. \image calendarwidgetexample.png diff --git a/examples/widgets/doc/src/charactermap.qdoc b/examples/widgets/doc/src/charactermap.qdoc index 4eb51ca678..8b980bc630 100644 --- a/examples/widgets/doc/src/charactermap.qdoc +++ b/examples/widgets/doc/src/charactermap.qdoc @@ -28,8 +28,8 @@ /*! \example widgets/charactermap \title Character Map Example - -The Character Map example shows how to create a custom widget that can +\ingroup examples-widgets +\brief The Character Map example shows how to create a custom widget that can both display its own content and respond to user input. The example displays an array of characters which the user can click on diff --git a/examples/widgets/doc/src/codeeditor.qdoc b/examples/widgets/doc/src/codeeditor.qdoc index ba7aa8135a..95b75cc82b 100644 --- a/examples/widgets/doc/src/codeeditor.qdoc +++ b/examples/widgets/doc/src/codeeditor.qdoc @@ -28,8 +28,8 @@ /*! \example widgets/codeeditor \title Code Editor Example - - The Code Editor example shows how to create a simple editor that + \ingroup examples-widgets + \brief The Code Editor example shows how to create a simple editor that has line numbers and that highlights the current line. \image codeeditor-example.png diff --git a/examples/widgets/doc/src/digitalclock.qdoc b/examples/widgets/doc/src/digitalclock.qdoc index 39bb270981..e628bf80de 100644 --- a/examples/widgets/doc/src/digitalclock.qdoc +++ b/examples/widgets/doc/src/digitalclock.qdoc @@ -28,8 +28,8 @@ /*! \example widgets/digitalclock \title Digital Clock Example - - The Digital Clock example shows how to use QLCDNumber to display a + \ingroup examples-widgets + \brief The Digital Clock example shows how to use QLCDNumber to display a number with LCD-like digits. \image digitalclock-example.png Screenshot of the Digital Clock example diff --git a/examples/widgets/doc/src/groupbox.qdoc b/examples/widgets/doc/src/groupbox.qdoc index c9ba733523..cf55672ad8 100644 --- a/examples/widgets/doc/src/groupbox.qdoc +++ b/examples/widgets/doc/src/groupbox.qdoc @@ -28,8 +28,8 @@ /*! \example widgets/groupbox \title Group Box Example - - The Group Box example shows how to use the different kinds of group + \ingroup examples-widgets + \brief The Group Box example shows how to use the different kinds of group boxes in Qt. Group boxes are container widgets that organize buttons into groups, diff --git a/examples/widgets/doc/src/icons.qdoc b/examples/widgets/doc/src/icons.qdoc index d39f104bf1..0ba18d4a26 100644 --- a/examples/widgets/doc/src/icons.qdoc +++ b/examples/widgets/doc/src/icons.qdoc @@ -28,11 +28,13 @@ /*! \example widgets/icons \title Icons Example + \ingroup examples-widgets + \brief The Icons example shows how QIcon can generate pixmaps reflecting + an icon's state, mode and size. - The Icons example shows how QIcon can generate pixmaps reflecting - an icon's state, mode and size. These pixmaps are generated from - the set of pixmaps made available to the icon, and are used by Qt - widgets to show an icon representing a particular action. + These pixmaps are generated from the set of pixmaps made available to the + icon, and are used by Qt widgets to show an icon representing a particular + action. \image icons-example.png Screenshot of the Icons example diff --git a/examples/widgets/doc/src/imageviewer.qdoc b/examples/widgets/doc/src/imageviewer.qdoc index 8b49a7b56d..4bcb5bc2e3 100644 --- a/examples/widgets/doc/src/imageviewer.qdoc +++ b/examples/widgets/doc/src/imageviewer.qdoc @@ -28,9 +28,11 @@ /*! \example widgets/imageviewer \title Image Viewer Example + \ingroup examples-widgets + \brief The example shows how to combine QLabel and QScrollArea to + display an image. - The example shows how to combine QLabel and QScrollArea to - display an image. QLabel is typically used for displaying text, + QLabel is typically used for displaying text, but it can also display an image. QScrollArea provides a scrolling view around another widget. If the child widget exceeds the size of the frame, QScrollArea automatically provides scroll diff --git a/examples/widgets/doc/src/lineedits.qdoc b/examples/widgets/doc/src/lineedits.qdoc index bc3a8f5c67..42d5005c23 100644 --- a/examples/widgets/doc/src/lineedits.qdoc +++ b/examples/widgets/doc/src/lineedits.qdoc @@ -28,10 +28,11 @@ /*! \example widgets/lineedits \title Line Edits Example + \ingroup examples-widgets + \brief The Line Edits example demonstrates the many ways that QLineEdit + can be used, and shows the effects of various properties and validators + on the input and output supplied by the user. - The Line Edits example demonstrates the many ways that QLineEdit can be used, and - shows the effects of various properties and validators on the input and output - supplied by the user. \image lineedits-example.png diff --git a/examples/widgets/doc/src/movie.qdoc b/examples/widgets/doc/src/movie.qdoc index 7b63425f4f..4990ce6603 100644 --- a/examples/widgets/doc/src/movie.qdoc +++ b/examples/widgets/doc/src/movie.qdoc @@ -28,9 +28,11 @@ /*! \example widgets/movie \title Movie Example + \ingroup examples-widgets + \brief The Movie example demonstrates how to use QMovie and QLabel to + display animations. - The Movie example demonstrates how to use QMovie and QLabel to - display animations. QMovie is mostly useful if one wants to play + QMovie is mostly useful if one wants to play a simple animation without the added complexity of a multimedia framework to install and deploy. diff --git a/examples/widgets/doc/src/scribble.qdoc b/examples/widgets/doc/src/scribble.qdoc index 8798197e56..2d96c6b770 100644 --- a/examples/widgets/doc/src/scribble.qdoc +++ b/examples/widgets/doc/src/scribble.qdoc @@ -28,8 +28,8 @@ /*! \example widgets/scribble \title Scribble Example - - The Scribble example shows how to reimplement some of QWidget's + \ingroup examples-widgets + \brief The Scribble example shows how to reimplement some of QWidget's event handlers to receive the events generated for the application's widgets. diff --git a/examples/widgets/doc/src/shapedclock.qdoc b/examples/widgets/doc/src/shapedclock.qdoc index 09dfd100b7..25485569b6 100644 --- a/examples/widgets/doc/src/shapedclock.qdoc +++ b/examples/widgets/doc/src/shapedclock.qdoc @@ -28,8 +28,8 @@ /*! \example widgets/shapedclock \title Shaped Clock Example - - The Shaped Clock example shows how to apply a widget mask to a top-level + \ingroup examples-widgets + \brief The Shaped Clock example shows how to apply a widget mask to a top-level widget to produce a shaped window. \image shapedclock-example.png diff --git a/examples/widgets/doc/src/sliders.qdoc b/examples/widgets/doc/src/sliders.qdoc index 6f944ea866..5ed3a9adb3 100644 --- a/examples/widgets/doc/src/sliders.qdoc +++ b/examples/widgets/doc/src/sliders.qdoc @@ -28,6 +28,9 @@ /*! \example widgets/sliders \title Sliders Example + \ingroup examples-widgets + \brief The Sliders example shows how to use the different types of sliders + available in Qt: QSlider, QScrollBar and QDial. Qt provides three types of slider-like widgets: QSlider, QScrollBar and QDial. They all inherit most of their diff --git a/examples/widgets/doc/src/spinboxes.qdoc b/examples/widgets/doc/src/spinboxes.qdoc index 460fad746a..4bd450ce4e 100644 --- a/examples/widgets/doc/src/spinboxes.qdoc +++ b/examples/widgets/doc/src/spinboxes.qdoc @@ -28,10 +28,10 @@ /*! \example widgets/spinboxes \title Spin Boxes Example - - The Spin Boxes example shows how to use the many different types of spin boxes - available in Qt, from a simple QSpinBox widget to more complex editors like - the QDateTimeEdit widget. + \ingroup examples-widgets + \brief The Spin Boxes example shows how to use the many different types of + spin boxes available in Qt, from a simple QSpinBox widget to more complex + editors like the QDateTimeEdit widget. \image spinboxes-example.png diff --git a/examples/widgets/doc/src/styles.qdoc b/examples/widgets/doc/src/styles.qdoc index 773c7a7677..c654a9b958 100644 --- a/examples/widgets/doc/src/styles.qdoc +++ b/examples/widgets/doc/src/styles.qdoc @@ -28,8 +28,8 @@ /*! \example widgets/styles \title Styles Example - - The Styles example illustrates how to create custom widget + \ingroup examples-widgets + \brief The Styles example illustrates how to create custom widget drawing styles using Qt, and demonstrates Qt's predefined styles. \image styles-enabledwood.png Screenshot of the Styles example diff --git a/examples/widgets/doc/src/stylesheet.qdoc b/examples/widgets/doc/src/stylesheet.qdoc index 5f44fd0ce8..451bc2778b 100644 --- a/examples/widgets/doc/src/stylesheet.qdoc +++ b/examples/widgets/doc/src/stylesheet.qdoc @@ -28,8 +28,8 @@ /*! \example widgets/stylesheet \title Style Sheet Example - - The Style Sheet Example shows how to use style sheets. + \ingroup examples-widgets + \brief The Style Sheet Example shows how to use style sheets. \image stylesheet-pagefold.png Screen Shot of the Pagefold style sheet */ diff --git a/examples/widgets/doc/src/tablet.qdoc b/examples/widgets/doc/src/tablet.qdoc index b8742604ed..41edf8e757 100644 --- a/examples/widgets/doc/src/tablet.qdoc +++ b/examples/widgets/doc/src/tablet.qdoc @@ -28,8 +28,8 @@ /*! \example widgets/tablet \title Tablet Example - - This example shows how to use a Wacom tablet in Qt applications. + \ingroup examples-widgets + \brief This example shows how to use a Wacom tablet in Qt applications. \image tabletexample.png diff --git a/examples/widgets/doc/src/tetrix.qdoc b/examples/widgets/doc/src/tetrix.qdoc index 769501d48e..0a0690b0b7 100644 --- a/examples/widgets/doc/src/tetrix.qdoc +++ b/examples/widgets/doc/src/tetrix.qdoc @@ -28,8 +28,8 @@ /*! \example widgets/tetrix \title Tetrix Example - - The Tetrix example is a Qt version of the classic Tetrix game. + \ingroup examples-widgets + \brief The Tetrix example is a Qt version of the classic Tetrix game. \image tetrix-example.png diff --git a/examples/widgets/doc/src/tooltips.qdoc b/examples/widgets/doc/src/tooltips.qdoc index e88f11908e..5e59e24dd5 100644 --- a/examples/widgets/doc/src/tooltips.qdoc +++ b/examples/widgets/doc/src/tooltips.qdoc @@ -28,8 +28,8 @@ /*! \example widgets/tooltips \title Tool Tips Example - - The Tool Tips example shows how to provide static and dynamic tool + \ingroup examples-widgets + \brief The Tool Tips example shows how to provide static and dynamic tool tips for an application's widgets. The simplest and most common way to set a widget's tool tip is by diff --git a/examples/widgets/doc/src/validators.qdoc b/examples/widgets/doc/src/validators.qdoc new file mode 100644 index 0000000000..e461b87891 --- /dev/null +++ b/examples/widgets/doc/src/validators.qdoc @@ -0,0 +1,34 @@ +/**************************************************************************** +** +** 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$ +** +****************************************************************************/ + +/*! + \example widgets/validators + \title Validators Example + \ingroup examples-widgets + \brief The Validators example shows the signal emission behavior of input + validators. +*/ diff --git a/examples/widgets/doc/src/wiggly.qdoc b/examples/widgets/doc/src/wiggly.qdoc index 29ab759ab0..1840641046 100644 --- a/examples/widgets/doc/src/wiggly.qdoc +++ b/examples/widgets/doc/src/wiggly.qdoc @@ -28,8 +28,8 @@ /*! \example widgets/wiggly \title Wiggly Example - - The Wiggly example shows how to animate a widget using + \ingroup examples-widgets + \brief The Wiggly example shows how to animate a widget using QBasicTimer and \l{QObject::timerEvent()}{timerEvent()}. In addition, the example demonstrates how to use QFontMetrics to determine the size of text on screen. diff --git a/examples/widgets/doc/src/windowflags.qdoc b/examples/widgets/doc/src/windowflags.qdoc index 40a0c6ae8d..3864729b46 100644 --- a/examples/widgets/doc/src/windowflags.qdoc +++ b/examples/widgets/doc/src/windowflags.qdoc @@ -28,8 +28,8 @@ /*! \example widgets/windowflags \title Window Flags Example - - The Window Flags example shows how to use the window flags + \ingroup examples-widgets + \brief The Window Flags example shows how to use the window flags available in Qt. A window flag is either a type or a hint. A type is used to |