summaryrefslogtreecommitdiffstats
path: root/doc/indices.doc
blob: bda7f0bc3f6848ce9a05afd86d8b46fea873e68e (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
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
/****************************************************************************
**
** Miscellaneous index pages
**
** Copyright (C) 1992-2008 Trolltech ASA.  All rights reserved.
**
** This file is part of the Qt GUI Toolkit.
**
** This file may be used under the terms of the GNU General
** Public License versions 2.0 or 3.0 as published by the Free
** Software Foundation and appearing in the files LICENSE.GPL2
** and LICENSE.GPL3 included in the packaging of this file.
** Alternatively you may (at your option) use any later version
** of the GNU General Public License if such license has been
** publicly approved by Trolltech ASA (or its successors, if any)
** and the KDE Free Qt Foundation.
**
** Please review the following information to ensure GNU General
** Public Licensing requirements will be met:
** http://trolltech.com/products/qt/licenses/licensing/opensource/.
** If you are unsure which license is appropriate for your use, please
** review the following information:
** http://trolltech.com/products/qt/licenses/licensing/licensingoverview
** or contact the sales department at sales@trolltech.com.
**
** This file may be used under the terms of the Q Public License as
** defined by Trolltech ASA and appearing in the file LICENSE.QPL
** included in the packaging of this file.  Licensees holding valid Qt
** Commercial licenses may use this file in accordance with the Qt
** Commercial License Agreement provided with the Software.
**
** This file is provided "AS IS" with NO WARRANTY OF ANY KIND,
** INCLUDING THE WARRANTIES OF DESIGN, MERCHANTABILITY AND FITNESS FOR
** A PARTICULAR PURPOSE. Trolltech reserves all rights not granted
** herein.
**
**********************************************************************/

/*! 

\page index.html
\if defined(commercial)
\title Qt Reference Documentation (Commercial Edition)
\endif
\if defined(noncommercial)
\title Qt Reference Documentation (Non-Commercial Edition)
\endif
\if !defined(commercial) && !defined(noncommercial)
\title Qt Reference Documentation (Open Source Edition)
\endif
<table cellpadding=2 cellspacing=1 border=0 width="100%" bgcolor="#e5e5e5">
\if !defined(commercial) && !defined(noncommercial)
<tr bgcolor="white"><td colspan=3 align="center"><b>Notice</b>: This edition is
for the development of \link opensourceedition.html Free and Open
Source\endlink software only; see \link commercialeditions.html
Commercial Editions\endlink.</td></tr>
\endif
\if defined(noncommercial)
<tr bgcolor="white"><td colspan=3 align="center"><b>Notice</b>: This
edition is for the development of non-commercial software in
accordance with the license you agreed to when you installed the
software from the CD; see also \link
commercialeditions.html Commercial Editions\endlink.</td></tr>
\endif
<tr>
<th bgcolor="#a2c511" width="33%">
Qt Community
</th>
<th bgcolor="#a2c511" width="33%">
Getting Started
</th>
<th bgcolor="#a2c511" width="33%">
General
</th>
</tr>
<tr>
<td valign="top">
\list
\i \link http://lists.trolltech.com Mailing lists\endlink
\i \link http://doc.trolltech.com/qq/index.html <i>Qt Quarterly</i> newsletter\endlink
\i \link http://www.trolltech.com/products/solutions/index.html Qt
Solutions\endlink
\i \link http://www.trolltech.com/freesoftware/index.html User contributed Qt additions\endlink
\i \link bughowto.html How to report a bug\endlink
\endlist
</td>
<td valign="top">
\list
\i \link how-to-learn-qt.html How to Learn Qt\endlink
\i \link http://www.trolltech.com/products/qt/readyforqt4.html Getting Ready for Qt 4\endlink
\i \link tutorial.html Tutorial #1\endlink, 
\link tutorial2.html Tutorial #2\endlink
\i \link examples.html Examples\endlink
\i \link http://www.trolltech.com/products/qt/whitepaper.html Whitepaper\endlink
\endlist
</td>
<td valign="top">
\list
\i \link aboutqt.html About Qt\endlink
\i \link commercialeditions.html Commercial Editions\endlink
\i \link opensourceedition.html Open Source Edition\endlink
\i \link troll.html About Trolltech\endlink
\endlist
</td>
</tr>
<tr>
<th bgcolor="#a2c511">
API Reference
</th>
<th bgcolor="#a2c511">
Modules
<th bgcolor="#a2c511">
Overviews
</tr>
<tr>
<td valign="top">
\list
\i \link classes.html All Classes\endlink
\i \link mainclasses.html Main Classes\endlink
\i \link groups.html Grouped Classes\endlink
\i \link annotated.html Annotated Classes\endlink
\i \link hierarchy.html Inheritance Hierarchy\endlink
\i \link classchart.html Class Chart (clickable image)\endlink
\i \link functions.html All Functions (long)\endlink
\i \link headers.html Header File Index\endlink
\i \link faq.html FAQs\endlink
\i \link http://www.trolltech.com/developer/changes/ Change History\endlink
\endlist
</td>
<td valign="top">
\list
\i \link modules.html All Modules\endlink
\i \link canvas.html Canvas\endlink
\i \link iconview.html Iconview\endlink
\i \link network.html Network\endlink
\i \link opengl.html OpenGL\endlink
\i \link sql.html SQL\endlink
\i \link table.html Table\endlink
\i \link workspace.html Workspace\endlink
\i \link xml.html XML\endlink
\endlist
</td>
<td valign="top">
\list
\i \link overviews-list.html All Overviews and HOWTOs\endlink
\i \link object.html Qt Object Model\endlink
\i \link signalsandslots.html Signals and Slots\endlink
\i \link geometry.html Window Geometry\endlink
\i \link eventsandfilters.html Events and Event Filters\endlink
\i \link i18n.html Internationalization (i18n)\endlink
\i \link debug.html Debugging Techniques\endlink
\i \link threads.html Thread Support in Qt\endlink
\i \link plugins-howto.html Qt Plugins\endlink
\i \link accelerators.html Standard Accelerators\endlink
\endlist
</tr>
<tr>
<th bgcolor="#a2c511">
Porting &amp; Platforms
</th>
<th bgcolor="#a2c511">
Tools
</th>
<th bgcolor="#a2c511">
Licenses &amp; Credits
</th>
</tr>
<tr>
<td valign="top">
\list
\i \link winsystem.html Window system specific notes\endlink
\i \link activeqt.html ActiveQt Framework\endlink
\i \link motif-extension.html Motif Extension\endlink
\i \link mac-differences.html Mac OS X development\endlink
\i \link porting.html Porting from Qt 2.x to Qt 3.x\endlink
\endlist
</td>
<td valign="top">
\list
\i \link tools-list.html All Tools\endlink
\i \link designer-manual.book Qt Designer\endlink
\i \link linguist-manual.book Qt Linguist\endlink
\i \link assistant.book Qt Assistant\endlink
\i \link qmake-manual.book qmake\endlink
\endlist
</td>
<td valign="top">
\list
\i \link license.html Q Public License\endlink
\i \link gpl.html GNU General Public License\endlink
\i \link 3rdparty.html Third Party Licenses used in Qt\endlink
\i \link licenses.html Other Licenses used in Qt\endlink
\i \link credits.html Credits\endlink
\endlist
</td>
</tr>
</table>
*/

/*! \page groups.html

\title Grouped Classes

This page provides a way of navigating Qt's classes by grouping
related classes together. Some classes may appear in more than one group.

\table
\header 
\i Group
\i Description

\row 
\i \link abstractwidgets.html   Abstract Widgets \endlink
\i Abstract widget classes usable through subclassing.

\row 
\i \link advanced.html   Advanced Widgets \endlink
\i Advanced GUI widgets such as listviews and progress bars.

\row 
\i \link basic.html   Basic Widgets \endlink
\i Basic GUI widgets such as buttons, comboboxes and scrollbars.

\omit
\row 
\i \link componentmodel.html   Component Model \endlink
\i Interfaces and helper classes for the Qt Component Model.
\endomit

\row
\i \link database.html Database\endlink
\i Database related classes, e.g. for SQL databases.

\row 
\i \link time.html   Date and Time \endlink
\i Classes for handling date and time.

\row 
\i \link draganddrop.html   Drag and Drop \endlink
\i Classes dealing with drag and drop and mime type
   encoding and decoding.

\row 
\i \link environment.html   Environment \endlink
\i Classes providing various global services such as
   event handling, access to system settings and internationalization.

\row
\i \link events.html Events\endlink
\i Classes used to create and handle events.

\row 
\i \link tools.html  Utility Classes \endlink
\i Collection classes such as list, queue, stack and string, along
with other classes that can be used without needing QApplication.

\row 
\i \link graphics.html   Graphics and Printing \endlink
\i Classes providing drawing (and printing) primitives, including
OpenGL. (See also \link images.html Image Processing\endlink and \link
multimedia.html Multimedia\endlink)

\row 
\i \link helpsystem.html   Help System \endlink
\i Classes used to provide online-help for applications.

\row 
\i \link images.html   Image Processing \endlink
\i Digital image encoding, decoding and manipulation.
(See also \link graphics.html Graphics and Printing\endlink and \link
multimedia.html Multimedia\endlink)

\row 
\i \link geomanagement.html   Layout Management \endlink
\i Classes handling automatic resizing and moving of widgets, for
        composing complex dialogs.

\row
\i \link shared.html	Implicitly and Explicitly Shared
Classes\endlink
\i Classes that use reference counting for fast copying.

\row 
\i \link io.html   Input/Output and Networking \endlink
\i Classes providing file input and output along with directory and
network handling.

\row 
\i \link application.html   MainWindow and Related Classes \endlink
\i Everything you need for a typical modern main application window,
including menus, toolbars, workspace, etc.

\row 
\i \link misc.html   Miscellaneous \endlink
\i Various other useful classes

\row
\i \link multimedia.html Multimedia\endlink
\i Classes that provide support for graphics, sound, animation, etc.
(See also \link graphics.html Graphics and Printing\endlink and \link
images.html Image Processing\endlink)

\row 
\i \link objectmodel.html   Object Model \endlink
\i The Qt GUI toolkit's underlying object model.

\row 
\i \link organizers.html   Organizers \endlink
\i User interface organizers such as splitters, tab bars, button groups, etc.

\row
\i \link plugins.html Plugin Classes\endlink
\i Plugin related classes.

\row 
\i \link dialogs.html   Standard Dialogs \endlink
\i Ready-made dialogs for file, font, color selection and more.

\row
\i \link qtl.html Template Library\endlink
\i Qt's template library container classes.

\row
\i \link text.html Text Related Classes\endlink 
\i Classes for text
processing. (See also \link xml-tools.html XML Classes\endlink.)

\row
\i \link thread.html Threading Classes\endlink
\i Classes that provide threading support.

\row 
\i \link appearance.html   Widget Appearance \endlink
\i Appearance customization with styles, fonts, colors etc.

\row
\i \link xml-tools.html XML Classes\endlink
\i Classes that support XML, via, for example DOM and SAX.

\endtable

*/

/*! \defgroup examples

\title Examples

Qt ships with lots of small and some medium-sized example programs
that teach you how to implement various tasks with Qt. Most of them will show how to
use a certain class or module, others aim at programming techniques
and Qt basics, and some of them simply want to show you what's possible.

Note that most of the examples assume that you have some experience with C++ 
and Qt and therefore are not commented extensively. If you are interested
in a line-by-line coverage please refer to the tutorials 
\link tutorial.html Tutorial #1\endlink, and 
\link tutorial2.html Tutorial #2\endlink, and also the
\link step-by-step-examples.html step-by-step examples \endlink.

\section1 Qt Base Classes: Assorted Examples

\list
\i \link qaction-examples.html QAction and QActionGroup \endlink
\i \link qfont-examples.html QFont, QFontMetrics, QFontInfo and QFontDatabase \endlink
\i \link qprocess-examples.html QProcess \endlink
\endlist

\section1 Qt Modules: Assorted Examples

\list
\i \link xml-examples.html XML examples \endlink
\i \link network-examples.html Network examples \endlink
\i \link opengl-examples.html OpenGL examples \endlink
\i \link table-examples.html Table examples \endlink
\i \link sql-examples.html SQL examples \endlink
\endlist

\section1 Qt Extensions: Assorted Examples

\list
\i \link activeqt-examples.html ActiveX support extension \endlink
\i \link motif-examples.html QMotif support extension \endlink
\omit \i \link xt-motif-examples.html Xt/Motif support extension \endlink \endomit
\i \link nsplugin-examples.html Qt-based plugins for web browsers \endlink
\endlist

\section1 Miscellaneous Examples

*/

/*! \defgroup qaction-examples 

\title QAction Examples 

The following example programs show how to use the 
QAction and QActionGroup classes.

*/

/*! \defgroup qfont-examples 

\title QFont Examples 

The following example programs show how to use the 
classes QFont, QFontMetrics, QFontInfo, and QFontDatabase. 

*/

/*! \defgroup qprocess-examples 

\title QProcess Examples 

The following example programs show how to use the 
QProcess class.

*/

/*! \defgroup network-examples 

\title Network Examples 

The following example programs demonstrate the use
of the Qt network module.

*/

/*! \defgroup opengl-examples 

\title OpenGL Examples 

The following example programs demonstrate the use
of the Qt OpenGL module.

*/

/*! \defgroup table-examples 

\title Table Examples 

The following example programs demonstrate the use
of the Qt table module.

*/

/*! \defgroup sql-examples 

\title Qt SQL Examples 

The following example programs show how to use the 
Qt SQL classes.

*/

/*! \defgroup xml-examples 

\title Qt XML Examples 

The following example programs show how to use the 
Qt XML classes.

*/

/*! \defgroup nsplugin-examples 

\title Netscape Plugin Examples

The following example programs show how to write plugins 
that can be used with web browsers supporting the LiveConnect
protocol.

For more information see the \link netscape-plugin.html Plugin Howto \endlink.
*/

/*! \defgroup motif-examples 

\title QMotif Support Extension

The following example programs illustrate the use of the QMotif Extension
assisting in the migration process of old Xt and Motif based code
to the more comfortable Qt toolkit.

For more information see the \link motif-extension.html QMotif
Support Extension documentation. \endlink
*/

/*
\defgroup xt-motif-examples 

\title Qt Xt/Motif Support Extension

The following example programs illustrate the use of the Qt Xt/Motif Extension
assisting in the migration process of old Xt and Motif based code
to the more comfortable Qt toolkit.

For more information see the \link xt.html Qt Xt/Motif Support
Extension documentation. \endlink
*/

/*! \defgroup step-by-step-examples

\title Step-by-step Examples

Step-by-step examples provide a careful explanation of
example code.

The covered example programs usually show how to use certain classes
or deal with programming techniques and Qt basics.

These examples are especially aimed at Qt novices and less experienced
programmers and try to make learning Qt as painless as possible.

*/

/*! \defgroup tools

\title Non-GUI Classes

The non-GUI classes are general-purpose collection and string classes
that may be used independently of the GUI classes.

In particular, these classes do not depend on QApplication at all,
and so can be used in non-GUI programs.

See also the \link collection.html introduction to the Qt collection
classes. \endlink 

*/

/*! \defgroup io

\title Input/Output and Networking 

These classes are used to handle input and output to and from external
devices, processes, files etc. as well as manipulating files and directories.

*/

/*! \defgroup basic

\title Basic Widgets

These basic controls (widgets) are designed for direct use.  There are
also some \link abstractwidgets.html abstract widget classes, \endlink
designed for subclassing, and some \link advanced.html more complex
widgets. \endlink

*/

/*! \defgroup advanced

\title Advanced Widgets

These classes provide more complex user interface controls (widgets).

*/

/*! \defgroup abstractwidgets

\title Abstract Widget Classes

These classes are abstract widgets; they are generally not usable in
themselves, but provide functionality that can be used by inheriting
these classes.

*/

/*! \defgroup objectmodel

\title Object Model

These classes form the basis of the \link object.html Qt Object Model \endlink.

*/

/* \defgroup componentmodel

\title Component Model

These classes and interfaces form the basis of the \link component.html Qt Component Model \endlink.

*/

/*! \defgroup plugins

\title Plugins

These classes deal with shared libraries, (e.g. .so and DLL files),
and with Qt plugins. 

See the \link plugins-howto.html plugins documentation\endlink.


See also the \link activeqt.html ActiveQt framework\endlink for
Windows.

*/

/*! \defgroup organizers

\title Organizers

These classes are used to organize and group GUI primitives into more
complex applications or dialogs.

*/


/*! \defgroup dialogs

\title Dialog Classes

These classes are complex widgets, composed of simpler widgets; dialog
boxes, generally.

*/

/*! \defgroup images

\title Image Processing Classes

These classes are used for manipulating images.

*/

/*! \defgroup graphics

\title Graphics Classes

These classes provide powerful graphics drawing primitives for both 2D
and (with OpenGL) 3D.

<p>See also this introduction to the \link coordsys.html Qt
coordinate system. \endlink

*/

/*! \defgroup draganddrop

\title Drag And Drop Classes

These classes deal with drag and drop and the necessary mime type
encoding and decoding. See also \link dnd.html Drag and Drop with
Qt. \endlink

*/

/*! \defgroup appearance

\title Widget Appearance and Style

These classes are used to customize an application's appearance and
style.

*/

/*! \defgroup shared

\title Implicitly and Explicitly Shared Classes

These classes are normally-heavy classes which in Qt have been
optimized by the use of reference counter and common data so they can
be passed around.

The only important effect is that the classes listed here \e can
be passed around as arguments efficiently, even though they may
seem heavyweight.

*/

/*! \defgroup time

\title Time and Date

These classes provide system-independent date and time abstractions.

<p>Also available: \link y2k.html Qt Year 2000 Compliance Statement \endlink.
*/


/*! \defgroup application

\title Main Window and Related Classes

These classes provide everything you need for a typical modern main
application window, like the main window itself, menu and tool bars,
a statusbar, etc.

*/


/*! \defgroup geomanagement

\title Layout Management

These classes provide automatic geometry (layout) management of widgets.

*/


/*! \defgroup helpsystem

\title Help System

\keyword help system

These classes provide for all forms of online-help in your application,
with three levels of detail:

\list 1
    \i Tool Tips and Status Bar message - flyweight help, extremely brief,
	entirely integrated in the user interface, requiring little
	or no user interaction to invoke.
    \i What's This? - lightweight, but can be
	a three-paragraph explanation.
    \i Online Help - can encompass any amount of information,
	but is typically slower to call up, somewhat separated
	from the user's work, and often users feel that using online
	help is a digression from their real task.
\endlist

*/


/*! \defgroup environment

\title Environment Classes

These classes providing various global services to your application such as
event handling, access to system settings, internationalization, etc.

*/

/*! \defgroup misc

\title Miscellaneous Classes

These classes are useful classes not fitting into any other category.

*/


/*! \defgroup events

\title Event Classes

These classes are used to create and handle events.

For more information see the \link object.html Object model\endlink
and \link signalsandslots.html Signals and Slots\endlink.
*/


/*! \defgroup multimedia

\title Multimedia Classes

These classes provide support for graphics, sound, animation etc.
*/

/*! \defgroup qtl

\title Qt Template Library Classes

The Qt Template Library (QTL) is a set of templates that provide
object containers. See the \link qt-template-lib.html Qt Template
Library\endlink.

*/


/*! \defgroup database

\title Database Classes

These classes provide access to SQL databases.
*/


/*! \defgroup thread

\title Threading

These classes are relevant to threaded applications.
*/


/*! \defgroup xml-tools

\title XML

These classes are relevant to XML users.
*/

/*! \defgroup qws

\title Qt/Embedded

These classes are relevant to Qt/Embedded users.
*/

/*! \defgroup text

\title Text Related Classes

These classes are relevant to text processing. See also the
\link xml.html XML classes \endlink.
*/