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 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273
|
/****************************************************************************
** $Id$
**
** Miscellaneous documentation that doesn't fit anywhere else
**
** Copyright (C) 1992-2002 Trolltech AS. All rights reserved.
**
** This file is part of the Qt GUI Toolkit.
**
** This file may be distributed under the terms of the Q Public License
** as defined by Trolltech AS of Norway and appearing in the file
** LICENSE.QPL included in the packaging of this file.
**
** This file may be distributed and/or modified under the terms of the
** GNU General Public License version 2 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file.
**
** Licensees holding valid Qt Enterprise Edition or Qt Professional Edition
** 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
** WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
**
** See http://www.trolltech.com/pricing.html or email sales@trolltech.com for
** information about Qt Commercial License Agreements.
** See http://www.trolltech.com/qpl/ for QPL licensing information.
** See http://www.trolltech.com/gpl/ for GPL licensing information.
**
** Contact info@trolltech.com if any conditions of this licensing are
** not clear to you.
**
**********************************************************************/
/*! \page aboutqt.html
\title About Qt
Qt is a cross-platform C++ GUI application framework. It provides
application developers with all the functionality needed to build
state-of-the-art graphical user interfaces. Qt is fully
object-oriented, easily extensible, and allows true component
programming.
Since its commercial introduction in early
1996, Qt has formed the basis of many thousands of successful
applications worldwide. Qt is also the basis of the popular
\link http://www.kde.org/ KDE \endlink Linux
desktop environment, a standard component of all major Linux distributions.
Qt is supported on the following platforms:
\list
\i <b>MS/Windows</b> - 95, 98, NT 4.0, ME, and 2000
\i <b>Unix/X11</b> - Linux, Sun Solaris, HP-UX, Compaq Tru64 UNIX,
IBM AIX, SGI IRIX and a wide range of others
\i <b>Macintosh</b> - Mac OS X
\i <b>Embedded</b> - Linux platforms with framebuffer support.
\endlist
Qt is a product of \link troll.html Trolltech\endlink.
Qt is released in different \link editions.html editions\endlink:
<dl>
<dd><b>Qt Enterprise \link editions.html Edition\endlink</b> and <b>Qt Professional \link editions.html Edition\endlink</b>
provide for commercial software development.
They permits traditional commercial software
distribution and includes free upgrades and Technical Support
Service. For the latest prices, please see the Trolltech web site,
\link http://www.trolltech.com/pricing.html Pricing and Availability\endlink
page, or contact \link mailto:sales@trolltech.com sales@trolltech.com\endlink.
The Enterprise Edition offers \link modules.html extended modules
\endlink over the Professional Edition.
<dd><b>Qt Free \link editions.html Edition\endlink</b> is the Unix/X11 version of Qt
available for development of \e {Free and Open Source software}
only. It is provided free of charge under the terms of both the
\link license.html Q Public License\endlink and the
\link gpl.html GNU General Public License\endlink.
The latest version is available for
\link http://www.trolltech.com/dl/qtfree-dl.html download\endlink.
<dd><b>Qt/Embedded Free \link editions.html Edition\endlink</b> is the Embedded version of Qt
available for development of \e {Free software}
only. It is provided free of charge under the terms of the
\link gpl.html GNU General Public License\endlink.
</dl>
*/
/*! \page commonproblems.html
\title FAQs
This document describes how to use more than one Qt version on one
machine and how to use Qt on X11 without a window manager. In addition
it explains the most common source of link errors with Qt.
Other frequently asked questions can be found in the
\link http://www.trolltech.com/developer/faqs/ FAQ index\endlink and
in the \link http://www.trolltech.com/developer/faqs/technical.html Technical FAQ\endlink.
\list
\i \link #linkerror Link error, complaining about a lack of \c vtbl, \c _vtbl, \c __vtbl or similar\endlink
\i \link #diffver Using different versions of Qt on the same
machine\endlink
\list
\i \link #qtbin Developers building for a single version of Qt on Unix - Qt binary packages\endlink
\i \link #qtsrc Developers building for two versions of Qt on Unix - Qt sources\endlink
\endlist
\i \link #nowinman Using Qt on X11 without a window manager\endlink
\endlist
\target linkerror
\section1 Link error, complaining about a lack of \c vtbl, \c _vtbl, \c __vtbl or similar
This indicates that you've included the Q_OBJECT macro in a class
declaration and probably also run the moc, but forgot to link the
moc-generated object code into your executable. See \link moc.html
Using the Meta Object Compiler\endlink for details on how to use moc.
\target diffver
\section1 Using different versions of Qt on the same machine
Qt programs need the following components of a Qt distribution:
<dl>
<dt>Header files - Compile time
<dd>Programmers need to include the Qt header files. The Qt header files
are usually located in the \c include subdirectory of Qt distributions.
Care must be taken to include the header files of the relevant release of
Qt. Those with a command-line compiler will typically use options such as
\c{/I%QTDIR%\include} or \c{-I"$QTDIR"/include} provided \c QTDIR specifies
the relevant release of Qt.
<dt>Meta Object Compiler and other tools - Compile time
<dd>Programmers need to run \e moc and other tools such as \e uic. These
tools are usually located in the \c bin subdirectory of Qt distributions.
Either run \c "$QTDIR"/bin/moc and \c "$QTDIR"/bin/uic or add \c "$QTDIR"/bin
to your \c PATH and run \c moc and \c uic. If you use \c qmake the
appropriate lines will be added to your Makefiles so that \e uic and
\e moc will be executed as required.
<dt>Static or shared libraries - Link time
<dd>Programmers need to link with the Qt static or shared libraries. The Qt
libraries are usually located in the \c lib subdirectory of Qt distributions.
Care must be taken to link with the libraries of the relevant release of
Qt. Those with a command-line compiler will typically use options such as
\c{/L%QTDIR%\lib\qt.lib} or \c{-L"$QTDIR"/lib} \c -lqt provided \c QTDIR
specifies the relevant release of Qt.
<dt>Shared libraries - Run time
<dd>Users of programs linked with shared Qt libraries need these same
shared libraries to run these programs. The Qt libraries are usually
located in the \c lib subdirectory of Qt distributions. Shared libraries
are made available to programs in places such as \c{C:\windows\system} on
Windows platforms, directories listed in file \c /etc/ld.so.conf on Linux,
standard \c lib directories on Unix, or directories listed in environment
variables \c LD_LIBRARY_PATH, \c SHLIB_PATH, or \c LIBPATH on various Unix
flavours. Make the relevant Qt libraries available using one of these
mechanisms.
</dl>
Qt distributions consist of different files needed at compile time,
link time, or run time. Trolltech distributes Qt in the form of a
source package that contain all these files once they have been built.
Other vendors distribute Qt in the form of binary packages. Binary packages
usually consist of two parts:
\list
\i shared libraries in the run time package, usually called \c qt3.
\i header files, static libraries, the moc and other tools in the developers'
kit, usually called \c qt3-dev.
\endlist
Depending on how you are using Qt, you need to make specific parts of
the Qt distribution available to your programs. Typical situations are
described below.
\target qtbin
\section2 Developers building for a single version of Qt on Unix - Qt binary packages
You build programs with a single version of Qt, but you still need
to run programs linked with another version of Qt. You are typically
a Linux developer who builds programs for Qt 3.x on a KDE desktop based
on Qt 2.x. Qt packages are usually split into a shared library
package with a name like \c qt and a developer package with a name
like \c qt-dev. You will need the appropriate packages:
\list
\i To build programs you will need the header files, the libraries,
the moc and other tools from Qt 3.x. They are included in the developer
package of Qt 3.x (\c qt3-dev or similar).
\i To run programs you will need the shared libraries of Qt 3.x and
Qt 2.x. They are included in the regular packages of Qt 3.x (\c qt3
or similar) and Qt 2.x (\c qt2 or similar).
\endlist
Just install the packages, \c qt2, \c qt3, and \c qt3-dev. You may
need to set the environment variable \c QTDIR to point to Qt 3.x.
\target qtsrc
\section2 Developers building for two versions of Qt on Unix - Qt sources
You build and run programs for Qt 2.x and Qt 3.x. You will need:
\list
\i the header files, the libraries, the moc and other tools from Qt 3.x
and Qt 2.x to build programs,
\i the shared libraries of Qt 3.x and Qt 2.x to run programs.
\endlist
Get the source distributions of both Qt 2.x and Qt 3.x.
\list 1
\i Install and build Qt 2.x and Qt 3.x, usually in \c /opt or
\c /usr/local. In the case of \c /opt:
\code
$ cd /opt
$ gunzip -c \c qt-x11-2.3.1.tar.gz | tar xf -
$ cd qt-2.3.1
$ setenv QTDIR /opt/qt-2.3.1
$ configure [options]
$ make
$ cd /opt
$ gunzip -c qt-x11-free-3.0.0.tar.gz | tar xf -
$ cd qt-3.0.0
$ setenv QTDIR /opt/qt-3.0.0
$ configure [options]
$ make
\endcode
\i Make shared libraries available to programs at run time. Either
add both \c /opt/qt-2.3.1/lib and \c /opt/qt-3.0.0/lib to your environment
variable \c LD_LIBRARY_PATH or file \c /etc/ld.so.conf or whataver mechanism
you're using, or make links to the libraries in a standard directory like
\c /usr/local/lib:
\code
cd /usr/local/lib
ln -s /opt/qt-2.3.1/lib/libqt.so.2 .
ln -s /opt/qt-2.3.1/lib/libqt-mt.so.2 .
ln -s /opt/qt-2.3.1/lib/libqutil.so.1 .
ln -s /opt/qt-3.0.0/lib/libqt.so.3 .
ln -s /opt/qt-3.0.0/lib/libqui.so.1 .
\endcode
\endlist
To develop with Qt 2.x use:
\code
setenv QTDIR /opt/qt-2.3.1
setenv PATH ${QTDIR}/bin:${PATH}
\endcode
To develop with Qt 3.x use:
\code
setenv QTDIR /opt/qt-3.0.0
setenv PATH ${QTDIR}/bin:${PATH}
\endcode
Setting \c QTDIR ensures that the proper resources are used, such as the
documentation appropriate to the version of Qt you're using. Also
your Makfiles may refer to \c "$QTDIR"/include and \c "$QTDIR"/lib to
include the proper header files and link with the proper libraries.
Setting the \c PATH ensures that the proper version of moc and other
tools is being used.
\target nowinman
\section1 Using Qt on X11 without a window manager
When using Qt without a window manager on Unix/X11, you will most
likely experience focus problems. Without a window manager, there is
no focus handling on X11, and no concept of an active window
either. If you want your application to work in such an environment,
you have to explicitly mark a window as active \e after showing it:
\code
yourWindow->show();
yourWindow->setActiveWindow();
\endcode
Note that setActiveWindow() won't work if the widget does not become
physically visible during this event cycle. However, without a window
manager running, this is guaranteed to happen. For the curious reader:
setActiveWindow() emulates a window manager by explicitly setting the
X Input Focus to a widget's top level window.
*/
/*! \page bughowto.html
\title How to Report A Bug
If you think you have found a bug in Qt, we would like to hear
about it so we can fix it.
Before reporting a bug, please check the
\link http://www.trolltech.com/developer/faqs/ FAQs\endlink and
\link http://www.trolltech.com/platforms/ Platform Notes\endlink
on our web site to see if the issue is already known.
Always include the following information in your bug report:
\list 1
\i The name and version number of your compiler
\i The name and version number of your operating system
\i The version of Qt you are using, and what configure options it was
compiled with.
\endlist
If the problem you are reporting is only at visible run-time, try to
create a small test program that shows the problem when run. Often,
such a program can be created with some minor changes to one
of the many example programs in the \c{qt/examples} directory.
Please send the bug report to
\link mailto:qt-bugs@trolltech.com qt-bugs@trolltech.com\endlink.
*/
/*! \page buyhowto.html
\title How to Buy Qt
You can order the Qt Enterprise Edition and Qt Professional Edition
by printing out the
\link http://www.trolltech.com/purchase/orderform.html order
form\endlink and faxing it to <strong><nobr>+47 21 60 48 01</nobr></strong>. For
prices, please see the
\link http://www.trolltech.com/pricing.html Pricing and
Availability page.\endlink
We accept payment by:
\list
\i Credit card (VISA, American Express, Mastercard, JCB)
\i Cheque (US or international)
\i SWIFT international bank transfer (see details on the
\link http://www.trolltech.com/purchase/orderform.html order form\endlink)
\endlist
<small>(Due to restrictions imposed by the credit card companies,
we cannot accept credit card orders via the web or e-mail; we must
receive the signed order form.)</small>
Cheques and order forms can also be sent by ordinary mail to:
<strong>
<blockquote>
Trolltech AS<br>
Waldemar Thranes gate 98<br>
N-0175 Oslo<br>
NORWAY<br>
</blockquote>
</strong>
For questions regarding purchase and pricing, please contact us at
\link mailto:sales@trolltech.com sales@trolltech.com\endlink or phone
<nobr><b>+47 21 60 48 00</b></nobr>.
*/
/*! \page license.html
\title Qt Free Edition License Agreement
The Qt Free Edition is distributed under the Q Public License (QPL).
It allows free use of Qt Free Edition for running software developed by
others, and free use of Qt Free Edition for development of free/Open Source
software. There is \link http://www.trolltech.com/qpl/ more information
about the QPL\endlink at the Trolltech web site.
Note that the Qt/Embedded Free Edition is <b>not</b> distributed
under the QPL, but under the \link gpl.html GNU General Public
License (GPL)\endlink.
For development non-free/proprietary software, the Qt Professional
Edition is available. It has a normal commercial library license, with
none of the special restrictions of the QPL or the GPL.
<hr>
<center>
<h2>
THE Q PUBLIC LICENSE
version 1.0
</h2>
<b>
Copyright (C) 1999-2000 Trolltech AS, Norway.<br>
Everyone is permitted to copy and distribute this license document.
</b>
</center>
The intent of this license is to establish freedom to share and change the
software regulated by this license under the open source model.
This license applies to any software containing a notice placed by the
copyright holder saying that it may be distributed under the terms of
the Q Public License version 1.0. Such software is herein referred to as
the Software. This license covers modification and distribution of the
Software, use of third-party application programs based on the Software,
and development of free software which uses the Software.
<h3 align=center>
Granted Rights
</h3>
1. You are granted the non-exclusive rights set forth in this license
provided you agree to and comply with any and all conditions in this
license. Whole or partial distribution of the Software, or software
items that link with the Software, in any form signifies acceptance of
this license.
2. You may copy and distribute the Software in unmodified form provided
that the entire package, including - but not restricted to - copyright,
trademark notices and disclaimers, as released by the initial developer
of the Software, is distributed.
3. You may make modifications to the Software and distribute your
modifications, in a form that is separate from the Software, such as
patches. The following restrictions apply to modifications:
<blockquote>
a. Modifications must not alter or remove any copyright notices in
the Software.
b. When modifications to the Software are released under this
license, a non-exclusive royalty-free right is granted to the
initial developer of the Software to distribute your modification
in future versions of the Software provided such versions remain
available under these terms in addition to any other license(s) of
the initial developer.
</blockquote>
4. You may distribute machine-executable forms of the Software or
machine-executable forms of modified versions of the Software, provided
that you meet these restrictions:
<blockquote>
a. You must include this license document in the distribution.
b. You must ensure that all recipients of the machine-executable forms
are also able to receive the complete machine-readable source code
to the distributed Software, including all modifications, without
any charge beyond the costs of data transfer, and place prominent
notices in the distribution explaining this.
c. You must ensure that all modifications included in the
machine-executable forms are available under the terms of this
license.
</blockquote>
5. You may use the original or modified versions of the Software to
compile, link and run application programs legally developed by you
or by others.
6. You may develop application programs, reusable components and other
software items that link with the original or modified versions of the
Software. These items, when distributed, are subject to the following
requirements:
<blockquote>
a. You must ensure that all recipients of machine-executable forms of
these items are also able to receive and use the complete
machine-readable source code to the items without any charge
beyond the costs of data transfer.
b. You must explicitly license all recipients of your items to use
and re-distribute original and modified versions of the items in
both machine-executable and source code forms. The recipients must
be able to do so without any charges whatsoever, and they must be
able to re-distribute to anyone they choose.
c. If the items are not available to the general public, and the
initial developer of the Software requests a copy of the items,
then you must supply one.
</blockquote>
<h3 align=center>
Limitations of Liability
</h3>
In no event shall the initial developers or copyright holders be liable
for any damages whatsoever, including - but not restricted to - lost
revenue or profits or other direct, indirect, special, incidental or
consequential damages, even if they have been advised of the possibility
of such damages, except to the extent invariable law, if any, provides
otherwise.
<h3 align=center>
No Warranty
</h3>
The Software and this license document are provided AS IS with NO WARRANTY
OF ANY KIND, INCLUDING THE WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS
FOR A PARTICULAR PURPOSE.
<h3 align=center>
Choice of Law
</h3>
This license is governed by the Laws of Norway. Disputes shall be settled
by Oslo City Court.
*/
/*! \page gpl.html
\title GNU General Public License
The Qt GUI Toolkit is Copyright (C) 1994-2002 Trolltech AS.
The Qt Free Edition and the Qt/Embedded Free Edition are available
under the GPL. The Qt Free Edition (for Unix/X11) is also available
under the \link license.html QPL\endlink.
\code
You may use, distribute and copy the Qt GUI Toolkit under the terms of
GNU General Public License version 2, which is displayed below.
GNU GENERAL PUBLIC LICENSE
Version 2, June 1991
Copyright (C) 1989, 1991 Free Software Foundation, Inc.
675 Mass Ave, Cambridge, MA 02139, USA
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The licenses for most software are designed to take away your
freedom to share and change it. By contrast, the GNU General Public
License is intended to guarantee your freedom to share and change free
software--to make sure the software is free for all its users. This
General Public License applies to most of the Free Software
Foundation's software and to any other program whose authors commit to
using it. (Some other Free Software Foundation software is covered by
the GNU Library General Public License instead.) You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
this service if you wish), that you receive source code or can get it
if you want it, that you can change the software or use pieces of it
in new free programs; and that you know you can do these things.
To protect your rights, we need to make restrictions that forbid
anyone to deny you these rights or to ask you to surrender the rights.
These restrictions translate to certain responsibilities for you if you
distribute copies of the software, or if you modify it.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must give the recipients all the rights that
you have. You must make sure that they, too, receive or can get the
source code. And you must show them these terms so they know their
rights.
We protect your rights with two steps: (1) copyright the software, and
(2) offer you this license which gives you legal permission to copy,
distribute and/or modify the software.
Also, for each author's protection and ours, we want to make certain
that everyone understands that there is no warranty for this free
software. If the software is modified by someone else and passed on, we
want its recipients to know that what they have is not the original, so
that any problems introduced by others will not reflect on the original
authors' reputations.
Finally, any free program is threatened constantly by software
patents. We wish to avoid the danger that redistributors of a free
program will individually obtain patent licenses, in effect making the
program proprietary. To prevent this, we have made it clear that any
patent must be licensed for everyone's free use or not licensed at all.
The precise terms and conditions for copying, distribution and
modification follow.
GNU GENERAL PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
0. This License applies to any program or other work which contains
a notice placed by the copyright holder saying it may be distributed
under the terms of this General Public License. The "Program", below,
refers to any such program or work, and a "work based on the Program"
means either the Program or any derivative work under copyright law:
that is to say, a work containing the Program or a portion of it,
either verbatim or with modifications and/or translated into another
language. (Hereinafter, translation is included without limitation in
the term "modification".) Each licensee is addressed as "you".
Activities other than copying, distribution and modification are not
covered by this License; they are outside its scope. The act of
running the Program is not restricted, and the output from the Program
is covered only if its contents constitute a work based on the
Program (independent of having been made by running the Program).
Whether that is true depends on what the Program does.
1. You may copy and distribute verbatim copies of the Program's
source code as you receive it, in any medium, provided that you
conspicuously and appropriately publish on each copy an appropriate
copyright notice and disclaimer of warranty; keep intact all the
notices that refer to this License and to the absence of any warranty;
and give any other recipients of the Program a copy of this License
along with the Program.
You may charge a fee for the physical act of transferring a copy, and
you may at your option offer warranty protection in exchange for a fee.
2. You may modify your copy or copies of the Program or any portion
of it, thus forming a work based on the Program, and copy and
distribute such modifications or work under the terms of Section 1
above, provided that you also meet all of these conditions:
a) You must cause the modified files to carry prominent notices
stating that you changed the files and the date of any change.
b) You must cause any work that you distribute or publish, that in
whole or in part contains or is derived from the Program or any
part thereof, to be licensed as a whole at no charge to all third
parties under the terms of this License.
c) If the modified program normally reads commands interactively
when run, you must cause it, when started running for such
interactive use in the most ordinary way, to print or display an
announcement including an appropriate copyright notice and a
notice that there is no warranty (or else, saying that you provide
a warranty) and that users may redistribute the program under
these conditions, and telling the user how to view a copy of this
License. (Exception: if the Program itself is interactive but
does not normally print such an announcement, your work based on
the Program is not required to print an announcement.)
These requirements apply to the modified work as a whole. If
identifiable sections of that work are not derived from the Program,
and can be reasonably considered independent and separate works in
themselves, then this License, and its terms, do not apply to those
sections when you distribute them as separate works. But when you
distribute the same sections as part of a whole which is a work based
on the Program, the distribution of the whole must be on the terms of
this License, whose permissions for other licensees extend to the
entire whole, and thus to each and every part regardless of who wrote it.
Thus, it is not the intent of this section to claim rights or contest
your rights to work written entirely by you; rather, the intent is to
exercise the right to control the distribution of derivative or
collective works based on the Program.
In addition, mere aggregation of another work not based on the Program
with the Program (or with a work based on the Program) on a volume of
a storage or distribution medium does not bring the other work under
the scope of this License.
3. You may copy and distribute the Program (or a work based on it,
under Section 2) in object code or executable form under the terms of
Sections 1 and 2 above provided that you also do one of the following:
a) Accompany it with the complete corresponding machine-readable
source code, which must be distributed under the terms of Sections
1 and 2 above on a medium customarily used for software interchange; or,
b) Accompany it with a written offer, valid for at least three
years, to give any third party, for a charge no more than your
cost of physically performing source distribution, a complete
machine-readable copy of the corresponding source code, to be
distributed under the terms of Sections 1 and 2 above on a medium
customarily used for software interchange; or,
c) Accompany it with the information you received as to the offer
to distribute corresponding source code. (This alternative is
allowed only for noncommercial distribution and only if you
received the program in object code or executable form with such
an offer, in accord with Subsection b above.)
The source code for a work means the preferred form of the work for
making modifications to it. For an executable work, complete source
code means all the source code for all modules it contains, plus any
associated interface definition files, plus the scripts used to
control compilation and installation of the executable. However, as a
special exception, the source code distributed need not include
anything that is normally distributed (in either source or binary
form) with the major components (compiler, kernel, and so on) of the
operating system on which the executable runs, unless that component
itself accompanies the executable.
If distribution of executable or object code is made by offering
access to copy from a designated place, then offering equivalent
access to copy the source code from the same place counts as
distribution of the source code, even though third parties are not
compelled to copy the source along with the object code.
4. You may not copy, modify, sublicense, or distribute the Program
except as expressly provided under this License. Any attempt
otherwise to copy, modify, sublicense or distribute the Program is
void, and will automatically terminate your rights under this License.
However, parties who have received copies, or rights, from you under
this License will not have their licenses terminated so long as such
parties remain in full compliance.
5. You are not required to accept this License, since you have not
signed it. However, nothing else grants you permission to modify or
distribute the Program or its derivative works. These actions are
prohibited by law if you do not accept this License. Therefore, by
modifying or distributing the Program (or any work based on the
Program), you indicate your acceptance of this License to do so, and
all its terms and conditions for copying, distributing or modifying
the Program or works based on it.
6. Each time you redistribute the Program (or any work based on the
Program), the recipient automatically receives a license from the
original licensor to copy, distribute or modify the Program subject to
these terms and conditions. You may not impose any further
restrictions on the recipients' exercise of the rights granted herein.
You are not responsible for enforcing compliance by third parties to
this License.
7. If, as a consequence of a court judgment or allegation of patent
infringement or for any other reason (not limited to patent issues),
conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot
distribute so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you
may not distribute the Program at all. For example, if a patent
license would not permit royalty-free redistribution of the Program by
all those who receive copies directly or indirectly through you, then
the only way you could satisfy both it and this License would be to
refrain entirely from distribution of the Program.
If any portion of this section is held invalid or unenforceable under
any particular circumstance, the balance of the section is intended to
apply and the section as a whole is intended to apply in other
circumstances.
It is not the purpose of this section to induce you to infringe any
patents or other property right claims or to contest validity of any
such claims; this section has the sole purpose of protecting the
integrity of the free software distribution system, which is
implemented by public license practices. Many people have made
generous contributions to the wide range of software distributed
through that system in reliance on consistent application of that
system; it is up to the author/donor to decide if he or she is willing
to distribute software through any other system and a licensee cannot
impose that choice.
This section is intended to make thoroughly clear what is believed to
be a consequence of the rest of this License.
8. If the distribution and/or use of the Program is restricted in
certain countries either by patents or by copyrighted interfaces, the
original copyright holder who places the Program under this License
may add an explicit geographical distribution limitation excluding
those countries, so that distribution is permitted only in or among
countries not thus excluded. In such case, this License incorporates
the limitation as if written in the body of this License.
9. The Free Software Foundation may publish revised and/or new versions
of the General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the Program
specifies a version number of this License which applies to it and "any
later version", you have the option of following the terms and conditions
either of that version or of any later version published by the Free
Software Foundation. If the Program does not specify a version number of
this License, you may choose any version ever published by the Free Software
Foundation.
10. If you wish to incorporate parts of the Program into other free
programs whose distribution conditions are different, write to the author
to ask for permission. For software which is copyrighted by the Free
Software Foundation, write to the Free Software Foundation; we sometimes
make exceptions for this. Our decision will be guided by the two goals
of preserving the free status of all derivatives of our free software and
of promoting the sharing and reuse of software generally.
NO WARRANTY
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
REPAIR OR CORRECTION.
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGES.
END OF TERMS AND CONDITIONS
Appendix: How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
convey the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) 19yy <name of author>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
Also add information on how to contact you by electronic and paper mail.
If the program is interactive, make it output a short notice like this
when it starts in an interactive mode:
Gnomovision version 69, Copyright (C) 19yy name of author
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, the commands you use may
be called something other than `show w' and `show c'; they could even be
mouse-clicks or menu items--whatever suits your program.
You should also get your employer (if you work as a programmer) or your
school, if any, to sign a "copyright disclaimer" for the program, if
necessary. Here is a sample; alter the names:
Yoyodyne, Inc., hereby disclaims all copyright interest in the program
`Gnomovision' (which makes passes at compilers) written by James Hacker.
<signature of Ty Coon>, 1 April 1989
Ty Coon, President of Vice
This General Public License does not permit incorporating your program into
proprietary programs. If your program is a subroutine library, you may
consider it more useful to permit linking proprietary applications with the
library. If this is what you want to do, use the GNU Library General
Public License instead of this License.
\endcode
*/
/*! \page troll.html
\title Company Information
Trolltech AS is a computer software company. We provide software
development tools and libraries, as well as expert consultancy
services.
Our flagship product is
\link http://www.trolltech.com/products/qt.html Qt\endlink, the
multi-platform, C++ Graphical User Interfaces toolkit. Qt enables you
to build professional, efficient, portable and maintainable GUI
applications quickly and easily.
\section1 Software that makes Sense
Our motto expresses the vision behind our products. We design our
products to give our customers the feeling of "this is the way
that things were always meant to be".
We know that it is crucial for our customers to have good tools for
making good software. Therefore, we do not compromise our demands for
superior design and technical quality when we develop our
products.
Trolltech is also known for providing top quality technical support
to our customers. At Trolltech, support inquiries are handled by the
most qualified developers and designers themselves.
\section1 History
Trolltech was founded in 1994. The core team of designers at
Trolltech started developing Qt in 1992, and since then Qt has
steadily expanded and improved. The first commercial version of Qt
was in 1995. Since then, Trolltech has experienced rapid growth, and
Qt is currently used in hundreds of successful software development
projects world wide.
\section1 Contact Information
<br clear="all">
<table cellpadding=3 cellspacing=0 border="0" bgcolor=#E5E5E5>
<tr><th colspan=6 valign=top bgcolor=#A2C511>Email</th></tr>
<tr>
<td rowspan=4><br></td>
<td colspan=2>\link mailto:info@trolltech.com <strong>info@trolltech.com</strong>\endlink
<td colspan=2>\link mailto:sales@trolltech.com <strong>sales@trolltech.com</strong>\endlink
<td rowspan=4><br></td>
<tr>
<td ><br></td>
<td valign="top"> General inquiries and questions. Please check the
\link http://www.trolltech.com/faq/ FAQ\endlink to see if your question is already answered there.</td>
<td ><br></td>
<td valign="top"> Inquires related to purchasing, pricing and availability of
Trolltech products</td></tr>
<tr>
<td colspan=2>\link mailto:www@trolltech.com <strong>www@trolltech.com</strong>\endlink
<td colspan=2>\link mailto:qt-bugs@trolltech.com <strong>qt-bugs@trolltech.com</strong>\endlink
<tr>
<td ><br></td>
<td valign="top"> Comments about our web pages</td>
<td ><br></td>
<td valign="top"> For bug reports. Please check the \link http://www.trolltech.com/platforms/ Platform Notes\endlink and
\link http://www.trolltech.com/faq/ FAQ\endlink to
see if the issue is already solved.
</td></tr>
<tr><td ><br></td>
<td colspan=4 valign=top>Note that Trolltech uses the
\link http://mail-abuse.org/rbl/ RBL\endlink and
\link http://work-rss.mail-abuse.org/rss/ RSS\endlink databases to cut down on
spam. If your mail server is listed, you will regrettably not be able to
send us mail. The \link http://www.mail-abuse.org/tsi/ MAPS TSI\endlink
pages provide information about how to secure your server.
</td><td ><br></td></tr>
<tr bgcolor="#ffffff"><td bgcolor="#ffffff" cellspan="6"><br></td></tr>
<tr><th colspan=6 valign=top bgcolor=#A2C511>Norway Office</th></tr>
</tr>
<tr>
<td rowspan=4><br></td>
<td colspan=2><strong>Telephone</strong>
<td colspan=2><strong>Street/Mail Address</strong>
<td rowspan=4><br></td>
<tr>
<td ><br></td>
<td valign="top"> General inquiries: +47 21 60 48 00</td>
<td rowspan=3><br></td>
<td valign="top" rowspan=3> Waldemar Thranes gate 98<br> N-0175 Oslo<br> Norway</td></tr>
<tr>
<td colspan=2><strong>Telefax</strong></td>
<tr>
<td ><br></td>
<td valign="top"> All inquiries: +47 21 60 48 01</td>
<tr bgcolor="#ffffff"><td bgcolor="#ffffff" cellspan="6"><br></td></tr>
<tr><th colspan=6 valign=top bgcolor=#A2C511>USA Office</th></tr>
</tr>
<tr>
<td rowspan=4><br></td>
<td colspan=2><strong>Telephone</strong>
<td colspan=2><strong>Street/Mail Address</strong>
<td rowspan=4><br></td>
<tr>
<td ><br></td>
<td valign="top"> General inquiries: +1 408 567 0212</td>
<td rowspan=3><br></td>
<td valign="top" rowspan=3> 3350 Scott Blvd.<br> Building 55, Suite 2<br> Santa Clara<br> CA 95054<br> USA</td></tr>
<tr>
<td colspan=2><strong>Telefax</strong></td>
<tr>
<td ><br></td>
<td valign="top"> All inquiries: +1 408 567 0264</td>
</table>
*/
/*! \page mailinglists.html
\title Mailing Lists
Trolltech operates two mailing lists for Qt users:
\c qt-announce and \c qt-interest.
\section1 qt-announce
The subscribers to this mailing list receives all official Trolltech
announcements when new versions of Qt and other Trolltech products
are released, and other Trolltech announcements of general interest.
To subscribe to the \c qt-announce mailing list, simply press
the button below.
<center>
<form enctype="text/plain" action="mailto:qt-announce-request@trolltech.com">
<input type=hidden name="magic" value="subscribe">
<input type=submit value="Subscribe to Qt Announcement Mailing List"></form>
</center>
You can also subscribe by sending an email containing just the word
\c{subscribe} or <tt>subscribe <em>your@email.address</em></tt> to
\link mailto:qt-announce-request@trolltech.com
qt-announce-request@trolltech.com\endlink.
To unsubscribe yourself from the \c qt-announce mailing
list, similarly send an email containing just the word
\c{unsubscribe} or
<tt>unsubscribe <em>your@email.address</em></tt> to
\link mailto:qt-announce-request@trolltech.com
qt-announce-request@trolltech.com\endlink.
\section1 qt-interest
This mailing list is a discussion forum for Qt users. Typical traffic
is 10 to 20 messages per day.
An archive of the messages from qt-interest is available on the Trolltech
web site:
\link http://www.trolltech.com/qt-interest/ Qt Mailing List Archive\endlink.
To subscribe to the \c qt-interest mailing list, send an
email containing just the word \c{subscribe} or <tt>subscribe
<em>your@email.address</em></tt> to \link
mailto:qt-interest-request@trolltech.com
qt-interest-request@trolltech.com\endlink.
To unsubscribe yourself from the \c qt-interest mailing
list, similarly send an email containing just the word
\c{unsubscribe} or
<tt>unsubscribe <em>your@email.address</em></tt> to
\link mailto:qt-interest-request@trolltech.com
qt-interest-request@trolltech.com\endlink.
\section1 snapshot-users
There is a special mailing list, \c{snapshot-users@trolltech.com}, for
discussion of Qt snapshot-related issues. To subscribe, send a message
containing just the word "subscribe" (without the quotes) to
\link mailto:snapshot-users-request@trolltech.com
snapshot-users-request@trolltech.com\endlink. We encourage you to use
this mailing list instead of \c{qt-interest} for snapshot-specific issues.
<small>Trolltech does not sell or in any way redistribute the
addresses on our mailing lists. We also employ active filtering to
ensure the mailing lists are virtually free from spam.</small>
*/
/*! \page guibooks.html
\title Books about GUI
This is not a comprehensive list of books, there are many other
books worth buying. This is just a few GUI/UI books that don't gather
dust in our shelves.
<b>Programming with Qt</b> by Kalle Dalheimer, ISBN 1-56592-588-2
is a simple introduction to programming with Qt. For those wanting
something more than our short tutorial, this is it.
\link http://www.amazon.com/exec/obidos/ASIN/1565925882/trolltech/t
(Read more or buy it.)\endlink
<b>The Design of Everyday Things</b> by Donald Norman,
ISBN 0-38526774-6, is one of the classics of human interface design.
Norman shows how badly something as simple as a kitchen stove can be
designed, and everyone should read it who will design a dialog box,
write an error message, or design just about anything else humans are
supposed to use.
\link http://www.amazon.com/exec/obidos/ASIN/0385267746/trolltech/t
(Read more or buy it.)\endlink
\target fowler
<b>GUI Design Handbook</b> by Susan Fowler, ISBN 0-07-059274-8, is an
alphabetical dictionary of widgets and other user interface elements,
with comprehensive coverage of each. Each chapter covers one widget
or other element, contains the most important recommendation from the
Macintosh, Windows and Motif style guides, notes about common
problems, comparison with other widgets that can serve some of the
same roles as this one, etc.
\link http://www.amazon.com/exec/obidos/ASIN/0070592748/trolltech/t
(Read more or buy it.)\endlink
<b>Macintosh Human Interface Guidelines</b>, second edition, ISBN
0-201-62216-5, is worth buying for the \e {don't}s alone. Even
though you're not writing Macintosh software, avoiding most of what it
advises against will produce more easily comprehensible software.
Doing what it tells you to \e do helps, too.
\link http://www.amazon.com/exec/obidos/ASIN/0201622165/trolltech/t
(Read more or buy it.)\endlink
This book is now available
\link http://developer.apple.com/techpubs/mac/HIGuidelines/HIGuidelines-2.html
on the web\endlink and there is a
\link http://developer.apple.com/techpubs/mac/HIGOS8Guide/thig-2.html Mac
OS 8 addendum.\endlink
<b>The Microsoft Windows User Experience</b>, ISBN 1-55615-679-0,
is Microsoft's look and feel Bible. Indispensable for everyone who
has customers that worship Microsoft, and it's quite good, too.
\link http://www.amazon.com/exec/obidos/ASIN/0735605661/trolltech/t
(Read more or buy it.)\endlink
Microsoft's guidelines are often available on the web, but have
occasionally been hidden in an impenetrable maze of javascript.
\link http://msdn.microsoft.com/developer/userexperience/ Try and see.\endlink
<b>The Icon Book</b> by William Horton, ISBN 0-471-59900-X, is a
perhaps the only thorough coverage of icons and icon use in software.
In order for icons to be successful, people must be able to do four
things with them: decode, recognize, find and activate them. This
book explains these goals from scratch and how to reach them, both
with single icons and icon families. Some 500 examples are scattered
throughout the text, generally in groups of four or five.
\link http://www.amazon.com/exec/obidos/ASIN/047159900X/trolltech/t
(Read more or buy it.)\endlink
\section1 <nobr>Buying these books from</nobr>
\link http://www.amazon.com/text/ Amazon.com.\endlink
These books are made available in association with Amazon.com, our
favorite on-line bookstore. Here is more information about
\link http://www.amazon.com/exec/obidos/subst/help/shipping-policy.html/t
Amazon.com's shipping options\endlink and its
\link http://www.amazon.com/exec/obidos/subst/help/desk.html/t
customer service.\endlink When you buy a book by following one of these
links, Amazon.com gives about 15% of the purchase price to
\link http://www.amnesty.org Amnesty International.\endlink
*/
/*! \page licenses.html
\title Licenses for Code Used in Qt
Qt contains a little code that is not under the \link license.html
QPL\endlink, the \link gpl.html GPL\endlink, or the Qt Commercial
License Agreement, but rather under specific highly permissive
license from the original authors. This page lists the licenses used
for that code, names the authors, and links to the points where it is
used.
Trolltech gratefully acknowledges these and others contribution to
Qt. We recommend that all programs that use Qt also acknowledge these
contributions, and quote all these license statements in an appendix
to the documentation.
\legaleselist
*/
/*! \page geometry.html
\title Window Geometry
\section1 Overview
QWidget provides several functions that deal with a widget's
geometry. Some of these functions operate on the pure client area
(i.e. the window excluding the window frame), others include the
window frame. The differentiation is done in a way that covers the
most common usage transparently.
<dl>
<dt><strong>Including the window frame:</strong>
<dd>x(), y(), frameGeometry(), pos() and move()
<dt><strong>Excluding the window frame:</strong>
<dd> geometry(), width(), height(), rect() and size()
</dl>
Note that the distinction only matters for decorated top-level
widgets. For all child widgets, the frame geometry is equal to the
widget's client geometry.
This diagram shows most of the functions in use:
\img geometry.png Geometry diagram
\section1 Unix/X11 peculiarities
On Unix/X11, a window does not have a frame until the window manager
decorates it. This happens asynchronously at some point in time after
calling show() and the first paint event the window receives - or it
does not happen at all. Bear in mind that X11 is policy-free (others
call it flexible). Thus you cannot make any safe assumption about the
decoration frame your window will get. Basic rule: there's always one
user who uses a window manager that breaks your assumption, and who
will complain to you.
Furthermore, a toolkit cannot simply place windows on the screen. All
Qt can do is to send certain hints to the window manager. The window
manager, a separate process, may either obey, ignore or misunderstand
them. Due to the partially unclear Inter-Client Communication
Conventions Manual (ICCCM), window placement is handled quite
differently in existing window managers.
X11 provides no standard or easy way to get the frame geometry once
the window is decorated. Qt solves this problem with nifty heuristics
and clever code that works on a wide range of window managers that
exist today. Don't be surprised if you find one where frameGeometry()
returns bogus results though.
X11 also does not provide a way to maximize a window. The
showMaximized() function in Qt therefore has to emulate the
feature. Its result depends totally on the result of frameGeometry()
and the capability of the window manager to do proper window
placement, both of which cannot be guaranteed.
\section1 Restoring a Window's Geometry
A common task in modern applications is to restore a window's geometry
in a later session. On Windows, this is basically storing the result
of geometry() and calling setGeometry() in the next session before
doing show(). On X11, this won't work because an invisible window
doesn't have a frame yet. The window manager would decorate the window
later. When this happens, the window shifts towards the bottom/right
corner of the screen depending on the size of the decoration frame. X
theoretically provides a way to avoid this shift. Our tests have
shown, though, that almost all window managers fail to implement this
feature.
A workaround is to call setGeometry() after show(). This has the
two disadvantages that the widget appears at a wrong place for a
millisecond (results in flashing) and that currently only every
second window manager gets it right. A safer solution is to store
both pos() and size() and to restore the geometry using resize() and
move() before calling show(), as demonstrated in the following
example:
\code
MyWidget* widget = new MyWidget
...
QPoint p = widget->pos(); // store position
QSize s = widget->size(); // store size
...
widget = new MyWidget;
widget->resize( s ); // restore size
widget->move( p ); // restore position
widget->show(); // show widget
\endcode
This method works on both MS-Windows and most existing X11 window
managers.
*/
|