Doc: Add example categories to Qt Widget examples

Added example categories and fixed some minor typos as well.

Task-number: QTBUG-116359
Pick-to: 6.5 6.6
Change-Id: I2e270a1919003f4cea233666b64437e4c2b77121
Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
This commit is contained in:
Mats Honkamaa 2023-08-23 11:29:16 +03:00
parent 0ce51dee0e
commit 7ef93cbf68
70 changed files with 81 additions and 8 deletions

View File

@ -4,6 +4,7 @@
/*!
\example desktop/systray
\title System Tray Icon Example
\examplecategory {Desktop}
\ingroup examples-widgets
\brief The System Tray Icon example shows how to add an icon with a menu
and popup messages to a desktop environment's system tray.

View File

@ -4,6 +4,7 @@
/*!
\example draganddrop/dropsite
\title Drop Site Example
\examplecategory {User Interface Components}
\brief The example shows how to distinguish the various MIME formats available
in a drag and drop operation.

View File

@ -4,6 +4,7 @@
/*!
\example itemviews/addressbook
\title Address Book
\examplecategory {User Interface Components}
\ingroup examples-itemviews
\brief The address book example shows how to use proxy models to display
different views onto data from a single model.

View File

@ -4,8 +4,9 @@
/*!
\example painting/affine
\title Affine Transformations
\examplecategory {Graphics & Multimedia}
\ingroup examples-painting
\brief Demonstrates how affine transformations in QPainter works.
\brief Demonstrates how affine transformations in QPainter work.
\brief In this example we show Qt's ability to perform affine transformations
on painting operations.

View File

@ -4,6 +4,7 @@
/*!
\example painting/basicdrawing
\title Basic Drawing Example
\examplecategory {Graphics & Multimedia}
\ingroup examples-painting
\brief The Basic Drawing example shows how to display basic
graphics primitives in a variety of styles using the QPainter

View File

@ -4,6 +4,7 @@
/*!
\example graphicsview/basicgraphicslayouts
\title Basic Graphics Layouts Example
\examplecategory {Graphics & Multimedia}
\ingroup examples-graphicsview-layout
\brief Demonstrates how to create basic graphics layout.

View File

@ -4,6 +4,7 @@
/*!
\example layouts/basiclayouts
\title Basic Layouts Example
\examplecategory {User Interface Components}
\brief Shows how to use the standard layout managers.
\e{Basic Layouts} shows how to use the standard layout managers that are

View File

@ -4,6 +4,7 @@
/*!
\example itemviews/basicsortfiltermodel
\title Basic Sort/Filter Model Example
\examplecategory {User Interface Components}
\ingroup examples-itemviews
\brief The Basic Sort/Filter Model example illustrates how to use
QSortFilterProxyModel to perform basic sorting and filtering.

View File

@ -4,6 +4,7 @@
/*!
\example widgets/calculator
\title Calculator Example
\examplecategory {User Interface Components}
\ingroup examples-widgets
\ingroup examples-layout
\brief The example shows how to use signals and slots to implement the

View File

@ -3,6 +3,7 @@
/*!
\title Calendar Widget Example
\examplecategory {Graphics & Multimedia}
\example widgets/calendarwidget
\ingroup examples-widgets
\ingroup examples-layout

View File

@ -4,6 +4,7 @@
/*!
\example graphicsview/chip
\title 40000 Chips
\examplecategory {Graphics & Multimedia}
\ingroup examples-graphicsview
\brief Visualizes a huge graphic view scene with 40000 chip items.

View File

@ -4,6 +4,7 @@
/*!
\example graphicsview/collidingmice
\title Colliding Mice Example
\examplecategory {Graphics & Multimedia}
\brief Demonstrates how to animate items on a graphics view.
\ingroup examples-graphicsview

View File

@ -4,6 +4,7 @@
/*!
\example itemviews/coloreditorfactory
\title Color Editor Factory Example
\examplecategory {User Interface Components}
\ingroup examples-itemviews
\brief This example shows how to create an editor that can be used by
a QItemDelegate.

View File

@ -4,6 +4,7 @@
/*!
\example itemviews/combowidgetmapper
\title Combo Widget Mapper Example
\examplecategory {User Interface Components}
\ingroup examples-itemviews
\brief The Combo Widget Mapper example shows how to use a custom delegate to
map information from a model to specific widgets on a form.

View File

@ -4,6 +4,7 @@
/*!
\example tools/completer
\title Completer Example
\examplecategory {User Interface Components}
\ingroup examples-widgets-tools
\brief The Completer example shows how to provide string-completion facilities
@ -45,7 +46,7 @@
\snippet tools/completer/fsmodel.cpp 0
As mentioned earlier, the \c data() function is reimplemented in order to
get it to return the entire file parth for the display role. For example,
get it to return the entire file path for the display role. For example,
with a QFileSystemModel, you will see "Program Files" in the view. However, with
\c FileSystemModel, you will see "C:\\Program Files".
@ -201,7 +202,7 @@
\snippet tools/completer/mainwindow.cpp 14
The \c changeMaxVisible() update the maximum number of visible items in
The \c changeMaxVisible() updates the maximum number of visible items in
the completer.
\snippet tools/completer/mainwindow.cpp 15

View File

@ -4,6 +4,7 @@
/*!
\example painting/composition
\title Composition Modes
\examplecategory {Graphics & Multimedia}
\ingroup examples-painting
\brief Demonstrates how Composition Modes work in QPainter.

View File

@ -4,6 +4,7 @@
/*!
\example painting/concentriccircles
\title Concentric Circles Example
\examplecategory {Graphics & Multimedia}
\ingroup examples-painting
\brief Demonstrates the improved quality that antialiasing and floating point precision gives.
@ -13,7 +14,7 @@
how to do simple animations.
The application's main window displays several widgets which are
drawn using the various combinations of precision and
drawn using various combinations of precision and
anti-aliasing.
\image concentriccircles-example.png

View File

@ -4,6 +4,7 @@
/*!
\example rhi/cuberhiwidget
\title Cube RHI Widget Example
\examplecategory {Graphics & Multimedia}
\ingroup examples-widgets
\brief Shows how to render a textured cube and integrate with QPainter and widgets, using QRhi Qt's 3D API and shading language abstraction layer.

View File

@ -4,6 +4,7 @@
/*!
\example itemviews/customsortfiltermodel
\title Custom Sort/Filter Model Example
\examplecategory {User Interface Components}
\ingroup examples-itemviews
\brief The Custom Sort/Filter Model example illustrates how to subclass
QSortFilterProxyModel to perform advanced sorting and filtering.

View File

@ -4,6 +4,7 @@
/*!
\example painting/deform
\title Vector Deformation
\examplecategory {Graphics & Multimedia}
\ingroup examples-painting
\brief Demonstrates how to manipulate the elements of a QPainterPath.

View File

@ -4,6 +4,7 @@
/*!
\example graphicsview/diagramscene
\title Diagram Scene Example
\examplecategory {Graphics & Multimedia}
\ingroup examples-graphicsview
\brief Demonstrate how to use the Graphics View framework.
@ -12,7 +13,7 @@
The Diagram Scene example is an application in which you can
create a flowchart diagram. It is possible to add flowchart shapes
and text and connect the shapes by arrows as shown in the image
above. The shapes, arrows, and text can be given different
above. The shapes, arrows, and text can be given different
colors, and it is possible to change the font, style, and
underline of the text.

View File

@ -4,6 +4,7 @@
/*!
\example graphicsview/dragdroprobot
\title Drag and Drop Robot Example
\examplecategory {Graphics & Multimedia}
\ingroup examples-graphicsview
\brief Demonstrates how to drag and drop items in a graphics view.

View File

@ -4,6 +4,7 @@
/*!
\example draganddrop/draggableicons
\title Draggable Icons Example
\examplecategory {User Interface Components}
\brief The Draggable Icons example shows how to drag and drop image data between widgets
in the same application, and between different applications.

View File

@ -4,6 +4,7 @@
/*!
\example draganddrop/draggabletext
\title Draggable Text Example
\examplecategory {User Interface Components}
\brief Illustrates how to drag and drop text between widgets.
\brief The Draggable Text example shows how to drag and drop textual data between widgets

View File

@ -4,6 +4,7 @@
/*!
\example animation/easing
\title Easing Curves Example
\examplecategory {Graphics & Multimedia}
\brief The Easing Curves example shows how to use easing curves to
control the speed of an animation.

View File

@ -4,6 +4,7 @@
/*!
\example tools/echoplugin
\title Echo Plugin Example
\examplecategory {Data Processing & I/O}
\ingroup examples-widgets-tools
\ingroup examples-layout

View File

@ -4,9 +4,10 @@
/*!
\example itemviews/editabletreemodel
\title Editable Tree Model Example
\examplecategory {User Interface Components}
\ingroup examples-itemviews
\brief This example shows how to implement a simple item-based tree model that can
be used with other classes the model/view framework.
be used with other classes in the model/view framework.
\image itemviews-editabletreemodel.png

View File

@ -4,6 +4,7 @@
/*!
\example graphicsview/elasticnodes
\title Elastic Nodes Example
\examplecategory {Graphics & Multimedia}
\ingroup examples-graphicsview
\brief Demonstrates how to interact with graphical items in a scene.

View File

@ -4,6 +4,7 @@
/*!
\example itemviews/fetchmore
\title Fetch More Example
\examplecategory {User Interface Components}
\ingroup examples-itemviews
\brief The Fetch More example shows how to add items to an item view
model on demand.

View File

@ -4,6 +4,7 @@
/*!
\example layouts/flowlayout
\title Flow Layout Example
\examplecategory {User Interface Components}
\ingroup examples-layout
\brief Shows how to arrange widgets for different window sizes.

View File

@ -4,6 +4,7 @@
/*!
\example itemviews/frozencolumn
\title Frozen Column Example
\examplecategory {User Interface Components}
\ingroup examples-itemviews
\brief This example demonstrates how to freeze a column within a QTableView.

View File

@ -5,6 +5,7 @@
\example gallery
\meta {tag} {gallery}
\title Widgets Gallery Example
\examplecategory {User Interface Components}
\ingroup examples-widgets
\brief The Widgets Gallery example shows widgets relevant for designing UIs.

View File

@ -4,6 +4,7 @@
/*!
\example painting/gradients
\title Gradients
\examplecategory {Graphics & Multimedia}
\ingroup examples-painting
\brief Shows how gradients can be used with QPainter.

View File

@ -4,6 +4,7 @@
/*!
\example graphicsview/simpleanchorlayout
\title Simple Anchor Layout Example
\examplecategory {Graphics & Multimedia}
\ingroup examples-graphicsview-layout
\brief Demonstrates anchor layout on a graphics view scene.

View File

@ -4,6 +4,7 @@
/*!
\example widgets/groupbox
\title Group Box Example
\examplecategory {User Interface Components}
\ingroup examples-widgets
\brief The Group Box example shows how to use the different kinds of group
boxes in Qt.

View File

@ -4,6 +4,7 @@
/*!
\example painting/imagecomposition
\title Image Composition Example
\examplecategory {Graphics & Multimedia}
\ingroup examples-painting
\ingroup examples-layout
\brief Shows how composition modes work in QPainter.

View File

@ -4,6 +4,7 @@
/*!
\example dialogs/licensewizard
\title License Wizard Example
\examplecategory {User Interface Components}
\ingroup examples-dialogs
\brief The License Wizard example shows how to implement complex wizards in

View File

@ -4,6 +4,7 @@
/*!
\example widgets/lineedits
\title Line Edits Example
\examplecateogry {User Interface Components}
\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

View File

@ -4,6 +4,7 @@
/*!
\example mainwindows/menus
\title Menus Example
\examplecategory {User Interface Components}
\ingroup examples-mainwindow
\ingroup examples-layout

View File

@ -4,6 +4,7 @@
/*!
\example richtext/orderform
\title Order Form Example
\examplecategory {User Interface Components}
\ingroup examples-richtext
\brief The Order Form example shows how to generate rich text
documents by combining a simple template with data input by the

View File

@ -4,6 +4,7 @@
/*!
\example painting/painterpaths
\title Painter Paths Example
\examplecategory {Graphics & Multimedia}
\ingroup examples-painting
\brief The Painter Paths example shows how painter paths can be
used to beuild complex shapes for rendering.

View File

@ -4,6 +4,7 @@
/*!
\example painting/pathstroke
\title Path Stroking
\examplecategory {Graphics & Multimedia}
\ingroup examples-painting
\brief The Path Stroking example shows various types of pens that
can be used with QPainter.

View File

@ -4,6 +4,7 @@
/*!
\example tools/regularexpression
\title QRegularExpression Example
\examplecategory {User Interface Components}
\ingroup examples-widgets-tools
\brief The QRegularExpression example shows how regular expressions in Qt are

View File

@ -4,6 +4,7 @@
/*!
\example desktop/screenshot
\title Taking a Screenshot
\examplecategory {Desktop}
\ingroup examples-desktop
\brief The Screenshot example shows how to take a screenshot of the
desktop.

View File

@ -4,6 +4,7 @@
/*!
\example widgets/scribble
\title Scribble Example
\examplecategory {User Interface Components}
\ingroup examples-widgets
\brief The Scribble example shows how to reimplement some of QWidget's
event handlers to receive the events generated for the

View File

@ -4,6 +4,7 @@
/*!
\example tools/settingseditor
\title Settings Editor Example
\examplecategory {User Interface Components}
\ingroup examples-widgets-tools
\brief The Settings Editor example shows how Qt's standard settings support is used in an

View File

@ -4,6 +4,7 @@
/*!
\example widgets/shapedclock
\title Translucent Background
\examplecategory {User Interface Components}
\ingroup examples-widgets
\brief The example shows how to make a round window with a translucent
background.

View File

@ -4,6 +4,7 @@
/*!
\example widgets/shortcuteditor
\title Shortcut Editor Example
\examplecategory {User Interface Components}
\ingroup examples-widgets
\brief The Shortcut Editor example shows how to create a basic, read-write
hierarchical model to use with Qt's standard view and QKeySequenceEdit

View File

@ -4,6 +4,7 @@
/*!
\example rhi/simplerhiwidget
\title Simple RHI Widget Example
\examplecategory {Graphics & Multimedia}
\ingroup examples-widgets
\brief Shows how to render a triangle using QRhi, Qt's 3D API and shading language abstraction layer.

View File

@ -4,6 +4,7 @@
/*!
\example itemviews/simpletreemodel
\title Simple Tree Model Example
\examplecategory {User Interface Components}
\ingroup examples-itemviews
\ingroup examples-layout
\brief The Simple Tree Model example shows how to use a hierarchical model

View File

@ -4,6 +4,7 @@
/*!
\example widgets/sliders
\title Sliders Example
\examplecategory {User Interface Components}
\ingroup examples-widgets
\brief The Sliders example shows how to use the different types of sliders
available in Qt: QSlider, QScrollBar and QDial.

View File

@ -4,6 +4,7 @@
/*!
\example itemviews/spinboxdelegate
\title Spin Box Delegate Example
\examplecategory {User Interface Components}
\ingroup examples-itemviews
\brief The Spin Box Delegate example shows how to create an editor for a custom delegate in
the model/view framework by reusing a standard Qt editor widget.

View File

@ -4,6 +4,7 @@
/*!
\example widgets/spinboxes
\title Spin Boxes Example
\examplecategory {User Interface Components}
\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

View File

@ -4,6 +4,7 @@
/*!
\example itemviews/spreadsheet
\title Spreadsheet
\examplecategory {User Interface Components}
\ingroup examples-itemviews
\brief The Spreadsheet example shows how to create a simple spreadsheet application.

View File

@ -4,6 +4,7 @@
/*!
\example dialogs/standarddialogs
\title Standard Dialogs Example
\examplecategory {User Interface Components}
\ingroup examples-dialogs
\brief The Standard Dialogs example shows the standard dialogs that are provided by Qt.

View File

@ -4,6 +4,7 @@
/*!
\example itemviews/stardelegate
\title Star Delegate Example
\examplecategory {User Interface Components}
\ingroup examples-itemviews
\brief The Star Delegate example shows how to create a delegate that
can paint itself and that supports editing.

View File

@ -4,6 +4,7 @@
/*!
\example tools/styleplugin
\title Style Plugin Example
\examplecategory {User Interface Components}
\ingroup examples-widgets-tools
\brief This example shows how to create a plugin that extends Qt with a new

View File

@ -4,6 +4,7 @@
/*!
\example richtext/syntaxhighlighter
\title Syntax Highlighter Example
\examplecategory {User Interface Components}
\ingroup examples-richtext
\brief The Syntax Highlighter example shows how to perform
simple syntax highlighting.

View File

@ -4,6 +4,7 @@
/*!
\example dialogs/tabdialog
\title Tab Dialog Example
\examplecategory {User Interface Components}
\ingroup examples-dialogs
\brief The Tab Dialog example shows how to construct a tab dialog using the

View File

@ -4,6 +4,7 @@
/*!
\example widgets/tablet
\title Tablet Example
\examplecategory {User Interface Components}
\ingroup examples-widgets
\brief This example shows how to use a Wacom tablet in Qt applications.
@ -13,7 +14,7 @@
generated. You need to reimplement the \l{QWidget::}{tabletEvent()} event
handler if you want to handle tablet events. Events are generated when the
tool (stylus) used for drawing enters and leaves the proximity of the
tablet (i.e., when it is close but not pressed down on it), when the tool
tablet (i.e., when it is closed but not pressed down on it), when the tool
is pressed down and released from it, when the tool is moved across the
tablet, and when one of the buttons on the tool is pressed or released.
@ -31,7 +32,7 @@
draw on the tablet as you use a pencil on paper. When you draw with the
airbrush you get a spray of virtual paint; the finger wheel is used to
change the density of the spray. When you draw with the art pen, you get a
a line whose width and endpoint angle depend on the rotation of the pen.
line whose width and endpoint angle depend on the rotation of the pen.
The pressure and tilt can also be assigned to change the alpha and
saturation values of the color and the width of the stroke.

View File

@ -4,6 +4,7 @@
/*!
\example widgets/tooltips
\title Tool Tips Example
\examplecategory {User Interface Components}
\ingroup examples-widgets
\brief The Tool Tips example shows how to provide static and dynamic tool
tips for an application's widgets.

View File

@ -4,6 +4,7 @@
/*!
\example painting/transformations
\title Transformations Example
\examplecategory {Graphics & Multimedia}
\ingroup examples-painting
\brief The Transformations example shows how transformations
influence the way that QPainter renders graphics primitives.

View File

@ -4,6 +4,7 @@
/*!
\example tools/treemodelcompleter
\title Tree Model Completer Example
\examplecategory {User Interface Components}
\ingroup examples-widgets-tools
\brief The Tree Model Completer example shows how to provide completion

View File

@ -4,6 +4,7 @@
/*!
\example dialogs/trivialwizard
\title Trivial Wizard Example
\examplecategory {User Interface Components}
\ingroup examples-dialogs
\brief The Trivial Wizard example illustrates how to create a linear three-page

View File

@ -4,6 +4,7 @@
/*!
\example tools/undoframework
\title Undo Framework Example
\examplecategory {Data Processing & I/O}
\ingroup examples-widgets-tools
\brief This example shows how to implement undo/redo functionality

View File

@ -4,6 +4,7 @@
/*!
\example widgets/windowflags
\title Window Flags Example
\examplecategory {User Interface Components}
\ingroup examples-widgets
\brief The Window Flags example shows how to use the window flags
available in Qt.

View File

@ -4,6 +4,7 @@
/*!
\example gestures/imagegestures
\title Image Gestures Example
\examplecategory {User Interface Components}
\brief Demonstrates the use of simple gestures in a widget.
This example shows how to enable gestures for a widget and use gesture input

View File

@ -4,6 +4,7 @@
/*!
\example touch/knobs
\title Touch Knobs Example
\examplecategory {User Interface Components}
\ingroup touchinputexamples
\brief Shows how to create custom controls that accept touch input.

View File

@ -4,6 +4,7 @@
/*!
\example tutorials/notepad
\title Getting Started Programming with Qt Widgets
\examplecategory {User Interface Components}
\brief A tutorial for Qt Widgets based notepad application.
In this topic, we teach basic Qt knowledge by implementing a simple

View File

@ -101,6 +101,7 @@
/*!
\example tutorials/widgets/toplevel
\title Widgets Tutorial - Creating a Window
\examplecategory {User Interface Components}
If a widget is created without a parent, it is treated as a window, or
\e{top-level widget}, when it is shown. Since it has no parent object to
@ -127,6 +128,7 @@
/*!
\example tutorials/widgets/childwidget
\title Widgets Tutorial - Child Widgets
\examplecategory {User Interface Components}
We can add a child widget to the window created in the previous example by
passing \c window as the parent to its constructor. In this case, we add a
@ -149,6 +151,7 @@
/*!
\example tutorials/widgets/windowlayout
\title Widgets Tutorial - Using Layouts
\examplecategory {User Interface Components}
Usually, child widgets are arranged inside a window using layout objects
rather than by specifying positions and sizes explicitly. Here, we
@ -183,6 +186,7 @@
/*!
\example tutorials/widgets/nestedlayouts
\title Widgets Tutorial - Nested Layouts
\examplecategory {User Interface Components}
Just as widgets can contain other widgets, layouts can be used to provide
different levels of grouping for widgets. Here, we want to display a