summaryrefslogtreecommitdiffstats
path: root/doc/src/widgets-and-layouts/widgets.qdoc
blob: 0697b9480443ff1832f25b142687180106c4dd39 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
/****************************************************************************
**
** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** This file is part of the documentation of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** No Commercial Usage
** This file contains pre-release code and may not be distributed.
** You may use this file in accordance with the terms and conditions
** contained in the either Technology Preview License Agreement or the
** Beta Release License Agreement.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain
** additional rights. These rights are described in the Nokia Qt LGPL
** Exception version 1.0, included in the file LGPL_EXCEPTION.txt in this
** package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU General Public License version 3.0 requirements will be
** met: http://www.gnu.org/copyleft/gpl.html.
**
** If you are unsure which license is appropriate for your use, please
** contact the sales department at http://qt.nokia.com/contact.
** $QT_END_LICENSE$
**
****************************************************************************/

/*!
    \page widgets-and-layouts.html
    \title Widgets and Layouts

    \ingroup frameworks-technologies

    \nextpage Widget Classes

    The primary elements for designing user interfaces in Qt are widgets and layouts.
    
    \section1 Widgets

    \l{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{Application Windows and Dialogs}{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.

    \section1 Layouts

    \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.

    \table
    \row    
    \o \image qgridlayout-with-5-children.png
    \o \image qformlayout-with-6-children.png
    \endtable

    \l{Qt Designer Manual}{\QD} is a powerful tool for interactively creating and
    arranging widgets in layouts.

    \section1 Widget Styles

    \l{Implementing 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.
    
    \table
    \row
    \o \image windowsxp-tabwidget.png
    \o \image plastique-tabwidget.png
    \o \image macintosh-tabwidget.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.
*/

/*!
    \page widget-classes.html
    \title Widget Classes

    \contentspage Widgets and Layouts
    \nextpage Layout Management

    Below you find a list of all widget classes in Qt. You can also browse the
    widget classes Qt provides in the various supported styles in the
    \l{Qt Widget Gallery}.

    \tableofcontents

    \section1 Basic Widgets

    These basic widgets (controls), such as buttons, comboboxes and scroll bars, are
    designed for direct use.

    \table
    \row
    \o \image windows-label.png
    \o \image windowsvista-pushbutton.png
    \o \image gtk-progressbar.png
    \row
    \o \image plastique-combobox.png
    \o \image macintosh-radiobutton.png
    \o \image cde-lineedit.png
    \endtable

    \annotatedlist basicwidgets

    \section1 Advanced Widgets

    Advanced GUI widgets such as tab widgets and progress bars provide more
    complex user interface controls.

    \table
    \row
    \o \image windowsxp-treeview.png
    \o \image gtk-calendarwidget.png
    \o \image qundoview.png
    \endtable

    \annotatedlist advanced

    \table
    \row
    \o \image windowsvista-tabwidget.png 
    \o \image macintosh-groupbox.png
    \endtable

    \section1 Organizer Widgets

    Classes like splitters, tab bars, button groups, etc are used to
    organize and group GUI primitives into more complex applications or
    dialogs.

    \annotatedlist organizers

    \section1 Abstract Widget Classes

    Abstract widget classes usable through subclassing. They are generally
    not usable in themselves, but provide functionality that can be used
    by inheriting these classes.

    \annotatedlist abstractwidgets
*/

/*!
    \group advanced
    \title Advanced Widgets
*/

/*!
    \group abstractwidgets
    \title Abstract Widget Classes
*/

/*!
    \group basicwidgets
    \title Basic Widgets
*/

/*!
    \group organizers
    \title Organizers
*/