]> git.saurik.com Git - wxWidgets.git/blame - docs/latex/wx/manual.tex
cleanup (mainly wrapping lines to be < 80 chars); added IsExpanded()
[wxWidgets.git] / docs / latex / wx / manual.tex
CommitLineData
b8de493f 1\documentstyle[a4,11pt,makeidx,verbatim,texhelp,fancyheadings,palatino]{report}
f6bcfd97 2% JACS: doesn't make it through Tex2RTF, sorry. I will put it into texhelp.sty
81d66cf3 3% since Tex2RTF doesn't parse it.
b8de493f 4% BTW, style MUST be report for it to work for Tex2RTF.
e14dccff 5%KB:
81d66cf3
JS
6%\addtolength{\textwidth}{1in}
7%\addtolength{\oddsidemargin}{-0.5in}
8%\addtolength{\topmargin}{-0.5in}
9%\addtolength{\textheight}{1in}
10%\sloppy
e14dccff 11%end of my changes
a660d684
KB
12\newcommand{\indexit}[1]{#1\index{#1}}%
13\newcommand{\pipe}[0]{$\|$\ }%
14\definecolour{black}{0}{0}{0}%
15\definecolour{cyan}{0}{255}{255}%
16\definecolour{green}{0}{255}{0}%
17\definecolour{magenta}{255}{0}{255}%
18\definecolour{red}{255}{0}{0}%
19\definecolour{blue}{0}{0}{200}%
20\definecolour{yellow}{255}{255}{0}%
21\definecolour{white}{255}{255}{255}%
22%
23\input psbox.tex
7af3ca16 24\input ltx.tex
a660d684
KB
25% Remove this for processing with dvi2ps instead of dvips
26%\special{!/@scaleunit 1 def}
27\parskip=10pt
28\parindent=0pt
f1e3914f 29\title{wxWidgets 2.7.1: A portable C++ and Python GUI toolkit}
750b78ba 30\winhelponly{\author{by Julian Smart et al
a660d684
KB
31%\winhelponly{\\$$\image{1cm;0cm}{wxwin.wmf}$$}
32}}
b32c6ff0
RD
33\winhelpignore{\author{Julian Smart, Robert Roebling, Vadim Zeitlin,
34Robin Dunn, et al}
f1e3914f 35\date{October, 2006}
a660d684
KB
36}
37\makeindex
38\begin{document}
39\maketitle
40\pagestyle{fancyplain}
41\bibliographystyle{plain}
42\setheader{{\it CONTENTS}}{}{}{}{}{{\it CONTENTS}}
43\setfooter{\thepage}{}{}{}{}{\thepage}%
44\pagenumbering{roman}
45\tableofcontents
46
47% A special table of contents for the WinHelp manual
48\begin{comment}
49\winhelponly{
fc2171bd 50\chapter{wxWidgets class library reference}\label{winhelpcontents}
a660d684 51
7af3ca16 52\centerline{
a660d684
KB
53%\image{}{wxwin.wmf}
54}%
55
56\sethotspotcolour{off}%
57\sethotspotunderline{on}%
58\large{
17bcb998 59\helpref{Alphabetical class reference}{classref}
a660d684 60
17bcb998 61\helpref{Classes by category}{classesbycat}
a660d684 62
17bcb998 63\helpref{Topic overviews}{overviews}
a660d684 64
17bcb998 65\helpref{Guide to wxWidgets}{wxwinchapters}
a660d684
KB
66}
67\sethotspotcolour{on}%
68\sethotspotunderline{on}%
69
fc2171bd 70\chapter*{Overview of wxWidgets}\label{wxwinchapters}
a660d684
KB
71
72\helpref{Introduction}{introduction}\\
73%\helpref{Resource guide}{resguide}\\
74%\helpref{Comparison with other GUI models}{comparison}\\
fc2171bd 75%\helpref{Multi-platform development with wxWidgets}{multiplat}\\
a660d684 76%\helpref{Tutorial}{tutorial}\\
fc2171bd 77\helpref{The wxWidgets resource system}{resourceformats}\\
a660d684
KB
78\helpref{Utilities}{utilities}\\
79\helpref{Programming strategies}{strategies}\\
80\helpref{Bugs and future directions}{bugs}\\
81\helpref{References}{bibliography}
82}
83\end{comment}
84
569ef72a 85\chapter{Copyright notice}\label{copyrightnotice}
a660d684
KB
86\setheader{{\it COPYRIGHT}}{}{}{}{}{{\it COPYRIGHT}}%
87\setfooter{\thepage}{}{}{}{}{\thepage}%
88
89\begin{center}
e027bfd9 90Copyright (c) 1992-2006 Julian Smart, Robert Roebling, Vadim Zeitlin and other
fc2171bd 91members of the wxWidgets team\\
154f22b3 92Portions (c) 1996 Artificial Intelligence Applications Institute\\
a660d684
KB
93\end{center}
94
8795498c 95Please also see the wxWindows license files (preamble.txt, lgpl.txt, gpl.txt, licence.txt,
62448488 96licendoc.txt) for conditions of software and documentation use.
c4839ccf
JS
97Note that we use the old name wxWindows in the license, pending
98recognition of the new name by OSI.
a660d684 99
d98c97a3 100\section*{wxWindows Library License, Version 3.1}\label{wxlicense}
605d715d 101
de279b54
VS
102% !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
103%
104% NB: this is exact copy of docs/licence.txt file. DO NOT modify this
105% section, it MUST be identical to docs/licence.txt!
106%
107% !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
108
d98c97a3 109Copyright (c) 1998-2005 Julian Smart, Robert Roebling et al
ccaaf5b0 110
457e6c54 111Everyone is permitted to copy and distribute verbatim copies
de279b54 112of this licence document, but changing it is not allowed.
605d715d
VS
113
114\begin{center}
de279b54
VS
115WXWINDOWS LIBRARY LICENCE \\
116TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
605d715d
VS
117\end{center}
118
de279b54
VS
119This library is free software; you can redistribute it and/or modify it
120under the terms of the GNU Library General Public Licence as published by
121the Free Software Foundation; either version 2 of the Licence, or (at
122your option) any later version.
457e6c54 123
de279b54
VS
124This library is distributed in the hope that it will be useful, but
125WITHOUT ANY WARRANTY; without even the implied warranty of
126MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library
127General Public Licence for more details.
457e6c54 128
de279b54
VS
129You should have received a copy of the GNU Library General Public Licence
130along with this software, usually in a file named COPYING.LIB. If not,
457e6c54 131write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
de279b54
VS
132Boston, MA 02111-1307 USA.
133
134EXCEPTION NOTICE
135
1361. As a special exception, the copyright holders of this library give
137permission for additional uses of the text contained in this release of
138the library as licenced under the wxWindows Library Licence, applying
d98c97a3
JS
139either version 3.1 of the Licence, or (at your option) any later version of
140the Licence as published by the copyright holders of version 3.1 of the
de279b54
VS
141Licence document.
142
1432. The exception is that you may use, copy, link, modify and distribute
d98c97a3 144under your own terms, binary object code versions of works based
de279b54
VS
145on the Library.
146
1473. If you copy code from files distributed under the terms of the GNU
148General Public Licence or the GNU Library General Public Licence into a
149copy of this library, as this licence permits, the exception does not
150apply to the code that you add in this way. To avoid misleading anyone as
151to the status of such modified files, you must delete this exception
457e6c54 152notice from such code and/or adjust the licensing conditions notice
de279b54 153accordingly.
457e6c54 154
de279b54 1554. If you write modifications of your own for this library, it is your
457e6c54 156choice whether to permit this exception to apply to your modifications.
de279b54
VS
157If you do not wish that, you must delete the exception notice from such
158code and/or adjust the licensing conditions notice accordingly.
159
ccaaf5b0 160
569ef72a 161\section*{GNU Library General Public License, Version 2}\label{gnulicense}
ccaaf5b0 162
457e6c54
JS
163Copyright (C) 1991 Free Software Foundation, Inc.
164675 Mass Ave, Cambridge, MA 02139, USA
605d715d 165
457e6c54
JS
166Everyone is permitted to copy and distribute verbatim copies
167of this license document, but changing it is not allowed.
ccaaf5b0 168
457e6c54
JS
169[This is the first released version of the library GPL. It is
170numbered 2 because it goes with version 2 of the ordinary GPL.]
ccaaf5b0 171
605d715d 172\wxheading{Preamble}
ccaaf5b0 173
457e6c54 174The licenses for most software are designed to take away your
605d715d 175freedom to share and change it. By contrast, the GNU General Public
ccaaf5b0 176Licenses are intended to guarantee your freedom to share and change
605d715d 177free software -- to make sure the software is free for all its users.
ccaaf5b0 178
457e6c54 179This license, the Library General Public License, applies to some
ccaaf5b0 180specially designated Free Software Foundation software, and to any
457e6c54 181other libraries whose authors decide to use it. You can use it for
ccaaf5b0
RR
182your libraries, too.
183
457e6c54
JS
184When we speak of free software, we are referring to freedom, not
185price. Our General Public Licenses are designed to make sure that you
ccaaf5b0
RR
186have the freedom to distribute copies of free software (and charge for
187this service if you wish), that you receive source code or can get it
188if you want it, that you can change the software or use pieces of it
189in new free programs; and that you know you can do these things.
190
457e6c54 191To protect your rights, we need to make restrictions that forbid
ccaaf5b0
RR
192anyone to deny you these rights or to ask you to surrender the rights.
193These restrictions translate to certain responsibilities for you if
194you distribute copies of the library, or if you modify it.
195
457e6c54 196For example, if you distribute copies of the library, whether gratis
ccaaf5b0 197or for a fee, you must give the recipients all the rights that we gave
457e6c54
JS
198you. You must make sure that they, too, receive or can get the source
199code. If you link a program with the library, you must provide
ccaaf5b0
RR
200complete object files to the recipients so that they can relink them
201with the library, after making changes to the library and recompiling
457e6c54 202it. And you must show them these terms so they know their rights.
ccaaf5b0 203
457e6c54 204Our method of protecting your rights has two steps: (1) copyright
ccaaf5b0
RR
205the library, and (2) offer you this license which gives you legal
206permission to copy, distribute and/or modify the library.
207
457e6c54 208Also, for each distributor's protection, we want to make certain
ccaaf5b0 209that everyone understands that there is no warranty for this free
457e6c54 210library. If the library is modified by someone else and passed on, we
ccaaf5b0
RR
211want its recipients to know that what they have is not the original
212version, so that any problems introduced by others will not reflect on
213the original authors' reputations.
214
457e6c54
JS
215Finally, any free program is threatened constantly by software
216patents. We wish to avoid the danger that companies distributing free
ccaaf5b0 217software will individually obtain patent licenses, thus in effect
457e6c54 218transforming the program into proprietary software. To prevent this,
ccaaf5b0
RR
219we have made it clear that any patent must be licensed for everyone's
220free use or not licensed at all.
221
457e6c54
JS
222Most GNU software, including some libraries, is covered by the ordinary
223GNU General Public License, which was designed for utility programs. This
ccaaf5b0 224license, the GNU Library General Public License, applies to certain
457e6c54 225designated libraries. This license is quite different from the ordinary
ccaaf5b0
RR
226one; be sure to read it in full, and don't assume that anything in it is
227the same as in the ordinary license.
228
457e6c54 229The reason we have a separate public license for some libraries is that
ccaaf5b0 230they blur the distinction we usually make between modifying or adding to a
457e6c54 231program and simply using it. Linking a program with a library, without
ccaaf5b0 232changing the library, is in some sense simply using the library, and is
457e6c54 233analogous to running a utility program or application program. However, in
ccaaf5b0
RR
234a textual and legal sense, the linked executable is a combined work, a
235derivative of the original library, and the ordinary General Public License
236treats it as such.
237
457e6c54 238Because of this blurred distinction, using the ordinary General
ccaaf5b0 239Public License for libraries did not effectively promote software
457e6c54 240sharing, because most developers did not use the libraries. We
ccaaf5b0
RR
241concluded that weaker conditions might promote sharing better.
242
457e6c54 243However, unrestricted linking of non-free programs would deprive the
ccaaf5b0 244users of those programs of all benefit from the free status of the
457e6c54 245libraries themselves. This Library General Public License is intended to
ccaaf5b0
RR
246permit developers of non-free programs to use free libraries, while
247preserving your freedom as a user of such programs to change the free
457e6c54 248libraries that are incorporated in them. (We have not seen how to achieve
ccaaf5b0 249this as regards changes in header files, but we have achieved it as regards
457e6c54 250changes in the actual functions of the Library.) The hope is that this
ccaaf5b0
RR
251will lead to faster development of free libraries.
252
457e6c54
JS
253The precise terms and conditions for copying, distribution and
254modification follow. Pay close attention to the difference between a
255"work based on the library" and a "work that uses the library". The
ccaaf5b0
RR
256former contains code derived from the library, while the latter only
257works together with the library.
258
457e6c54 259Note that it is possible for a library to be covered by the ordinary
ccaaf5b0
RR
260General Public License rather than by this special one.
261
605d715d 262\begin{center}
457e6c54
JS
263 GNU LIBRARY GENERAL PUBLIC LICENSE\\
264 TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
605d715d 265\end{center}
ccaaf5b0 266
457e6c54 2670. This License Agreement applies to any software library which
ccaaf5b0
RR
268contains a notice placed by the copyright holder or other authorized
269party saying it may be distributed under the terms of this Library
457e6c54 270General Public License (also called "this License"). Each licensee is
ccaaf5b0
RR
271addressed as "you".
272
457e6c54 273A "library" means a collection of software functions and/or data
ccaaf5b0
RR
274prepared so as to be conveniently linked with application programs
275(which use some of those functions and data) to form executables.
276
457e6c54
JS
277The "Library", below, refers to any such software library or work
278which has been distributed under these terms. A "work based on the
ccaaf5b0
RR
279Library" means either the Library or any derivative work under
280copyright law: that is to say, a work containing the Library or a
281portion of it, either verbatim or with modifications and/or translated
457e6c54 282straightforwardly into another language. (Hereinafter, translation is
ccaaf5b0
RR
283included without limitation in the term "modification".)
284
457e6c54
JS
285"Source code" for a work means the preferred form of the work for
286making modifications to it. For a library, complete source code means
ccaaf5b0
RR
287all the source code for all modules it contains, plus any associated
288interface definition files, plus the scripts used to control compilation
289and installation of the library.
290
457e6c54
JS
291Activities other than copying, distribution and modification are not
292covered by this License; they are outside its scope. The act of
ccaaf5b0
RR
293running a program using the Library is not restricted, and output from
294such a program is covered only if its contents constitute a work based
295on the Library (independent of the use of the Library in a tool for
457e6c54 296writing it). Whether that is true depends on what the Library does
ccaaf5b0 297and what the program that uses the Library does.
457e6c54
JS
298
2991. You may copy and distribute verbatim copies of the Library's
ccaaf5b0
RR
300complete source code as you receive it, in any medium, provided that
301you conspicuously and appropriately publish on each copy an
302appropriate copyright notice and disclaimer of warranty; keep intact
303all the notices that refer to this License and to the absence of any
304warranty; and distribute a copy of this License along with the
305Library.
306
457e6c54 307You may charge a fee for the physical act of transferring a copy,
ccaaf5b0
RR
308and you may at your option offer warranty protection in exchange for a
309fee.
310
457e6c54 3112. You may modify your copy or copies of the Library or any portion
ccaaf5b0
RR
312of it, thus forming a work based on the Library, and copy and
313distribute such modifications or work under the terms of Section 1
314above, provided that you also meet all of these conditions:
315
605d715d 316\begin{indented}{1cm}
457e6c54
JS
317a) The modified work must itself be a software library.
318
319b) You must cause the files modified to carry prominent notices
320stating that you changed the files and the date of any change.
321
322c) You must cause the whole of the work to be licensed at no
323charge to all third parties under the terms of this License.
324
325d) If a facility in the modified Library refers to a function or a
326table of data to be supplied by an application program that uses
327the facility, other than as an argument passed when the facility
328is invoked, then you must make a good faith effort to ensure that,
329in the event an application does not supply such function or
330table, the facility still operates, and performs whatever part of
331its purpose remains meaningful.
332
333(For example, a function in a library to compute square roots has
334a purpose that is entirely well-defined independent of the
335application. Therefore, Subsection 2d requires that any
336application-supplied function or table used by this function must
337be optional: if the application does not supply it, the square
338root function must still compute square roots.)
605d715d 339\end{indented}
ccaaf5b0 340
457e6c54 341These requirements apply to the modified work as a whole. If
ccaaf5b0
RR
342identifiable sections of that work are not derived from the Library,
343and can be reasonably considered independent and separate works in
344themselves, then this License, and its terms, do not apply to those
457e6c54 345sections when you distribute them as separate works. But when you
ccaaf5b0
RR
346distribute the same sections as part of a whole which is a work based
347on the Library, the distribution of the whole must be on the terms of
348this License, whose permissions for other licensees extend to the
349entire whole, and thus to each and every part regardless of who wrote
350it.
351
352Thus, it is not the intent of this section to claim rights or contest
353your rights to work written entirely by you; rather, the intent is to
354exercise the right to control the distribution of derivative or
355collective works based on the Library.
356
357In addition, mere aggregation of another work not based on the Library
358with the Library (or with a work based on the Library) on a volume of
359a storage or distribution medium does not bring the other work under
360the scope of this License.
361
457e6c54
JS
3623. You may opt to apply the terms of the ordinary GNU General Public
363License instead of this License to a given copy of the Library. To do
ccaaf5b0
RR
364this, you must alter all the notices that refer to this License, so
365that they refer to the ordinary GNU General Public License, version 2,
457e6c54 366instead of to this License. (If a newer version than version 2 of the
ccaaf5b0 367ordinary GNU General Public License has appeared, then you can specify
457e6c54 368that version instead if you wish.) Do not make any other change in
ccaaf5b0
RR
369these notices.
370
457e6c54 371Once this change is made in a given copy, it is irreversible for
ccaaf5b0
RR
372that copy, so the ordinary GNU General Public License applies to all
373subsequent copies and derivative works made from that copy.
374
457e6c54 375This option is useful when you wish to copy part of the code of
ccaaf5b0
RR
376the Library into a program that is not a library.
377
457e6c54 3784. You may copy and distribute the Library (or a portion or
ccaaf5b0
RR
379derivative of it, under Section 2) in object code or executable form
380under the terms of Sections 1 and 2 above provided that you accompany
381it with the complete corresponding machine-readable source code, which
382must be distributed under the terms of Sections 1 and 2 above on a
383medium customarily used for software interchange.
384
457e6c54 385If distribution of object code is made by offering access to copy
ccaaf5b0
RR
386from a designated place, then offering equivalent access to copy the
387source code from the same place satisfies the requirement to
388distribute the source code, even though third parties are not
389compelled to copy the source along with the object code.
390
457e6c54 3915. A program that contains no derivative of any portion of the
ccaaf5b0 392Library, but is designed to work with the Library by being compiled or
457e6c54 393linked with it, is called a "work that uses the Library". Such a
ccaaf5b0
RR
394work, in isolation, is not a derivative work of the Library, and
395therefore falls outside the scope of this License.
396
457e6c54 397However, linking a "work that uses the Library" with the Library
ccaaf5b0
RR
398creates an executable that is a derivative of the Library (because it
399contains portions of the Library), rather than a "work that uses the
457e6c54 400library". The executable is therefore covered by this License.
ccaaf5b0
RR
401Section 6 states terms for distribution of such executables.
402
457e6c54 403When a "work that uses the Library" uses material from a header file
ccaaf5b0
RR
404that is part of the Library, the object code for the work may be a
405derivative work of the Library even though the source code is not.
406Whether this is true is especially significant if the work can be
457e6c54 407linked without the Library, or if the work is itself a library. The
ccaaf5b0
RR
408threshold for this to be true is not precisely defined by law.
409
457e6c54 410If such an object file uses only numerical parameters, data
ccaaf5b0
RR
411structure layouts and accessors, and small macros and small inline
412functions (ten lines or less in length), then the use of the object
413file is unrestricted, regardless of whether it is legally a derivative
457e6c54 414work. (Executables containing this object code plus portions of the
ccaaf5b0
RR
415Library will still fall under Section 6.)
416
457e6c54 417Otherwise, if the work is a derivative of the Library, you may
ccaaf5b0
RR
418distribute the object code for the work under the terms of Section 6.
419Any executables containing that work also fall under Section 6,
420whether or not they are linked directly with the Library itself.
421
457e6c54 4226. As an exception to the Sections above, you may also compile or
ccaaf5b0
RR
423link a "work that uses the Library" with the Library to produce a
424work containing portions of the Library, and distribute that work
425under terms of your choice, provided that the terms permit
426modification of the work for the customer's own use and reverse
427engineering for debugging such modifications.
428
457e6c54 429You must give prominent notice with each copy of the work that the
ccaaf5b0 430Library is used in it and that the Library and its use are covered by
457e6c54 431this License. You must supply a copy of this License. If the work
ccaaf5b0
RR
432during execution displays copyright notices, you must include the
433copyright notice for the Library among them, as well as a reference
457e6c54 434directing the user to the copy of this License. Also, you must do one
ccaaf5b0
RR
435of these things:
436
605d715d 437\begin{indented}{1cm}
457e6c54
JS
438a) Accompany the work with the complete corresponding
439machine-readable source code for the Library including whatever
440changes were used in the work (which must be distributed under
441Sections 1 and 2 above); and, if the work is an executable linked
442with the Library, with the complete machine-readable "work that
443uses the Library", as object code and/or source code, so that the
444user can modify the Library and then relink to produce a modified
445executable containing the modified Library. (It is understood
446that the user who changes the contents of definitions files in the
447Library will not necessarily be able to recompile the application
448to use the modified definitions.)
449
450b) Accompany the work with a written offer, valid for at
451least three years, to give the same user the materials
452specified in Subsection 6a, above, for a charge no more
453than the cost of performing this distribution.
454
455c) If distribution of the work is made by offering access to copy
456from a designated place, offer equivalent access to copy the above
457specified materials from the same place.
458
459d) Verify that the user has already received a copy of these
460materials or that you have already sent this user a copy.
605d715d 461\end{indented}
ccaaf5b0 462
457e6c54 463For an executable, the required form of the "work that uses the
ccaaf5b0 464Library" must include any data and utility programs needed for
457e6c54 465reproducing the executable from it. However, as a special exception,
ccaaf5b0
RR
466the source code distributed need not include anything that is normally
467distributed (in either source or binary form) with the major
468components (compiler, kernel, and so on) of the operating system on
469which the executable runs, unless that component itself accompanies
470the executable.
471
457e6c54 472It may happen that this requirement contradicts the license
ccaaf5b0 473restrictions of other proprietary libraries that do not normally
457e6c54 474accompany the operating system. Such a contradiction means you cannot
ccaaf5b0
RR
475use both them and the Library together in an executable that you
476distribute.
477
457e6c54 4787. You may place library facilities that are a work based on the
ccaaf5b0
RR
479Library side-by-side in a single library together with other library
480facilities not covered by this License, and distribute such a combined
481library, provided that the separate distribution of the work based on
482the Library and of the other library facilities is otherwise
483permitted, and provided that you do these two things:
484
605d715d 485\begin{indented}{1cm}
457e6c54
JS
486a) Accompany the combined library with a copy of the same work
487based on the Library, uncombined with any other library
488facilities. This must be distributed under the terms of the
489Sections above.
490
491b) Give prominent notice with the combined library of the fact
492that part of it is a work based on the Library, and explaining
493where to find the accompanying uncombined form of the same work.
605d715d 494\end{indented}
ccaaf5b0 495
457e6c54
JS
4968. You may not copy, modify, sublicense, link with, or distribute
497the Library except as expressly provided under this License. Any
ccaaf5b0
RR
498attempt otherwise to copy, modify, sublicense, link with, or
499distribute the Library is void, and will automatically terminate your
457e6c54 500rights under this License. However, parties who have received copies,
ccaaf5b0
RR
501or rights, from you under this License will not have their licenses
502terminated so long as such parties remain in full compliance.
503
457e6c54
JS
5049. You are not required to accept this License, since you have not
505signed it. However, nothing else grants you permission to modify or
506distribute the Library or its derivative works. These actions are
507prohibited by law if you do not accept this License. Therefore, by
ccaaf5b0
RR
508modifying or distributing the Library (or any work based on the
509Library), you indicate your acceptance of this License to do so, and
510all its terms and conditions for copying, distributing or modifying
511the Library or works based on it.
512
457e6c54 51310. Each time you redistribute the Library (or any work based on the
ccaaf5b0
RR
514Library), the recipient automatically receives a license from the
515original licensor to copy, distribute, link with or modify the Library
457e6c54 516subject to these terms and conditions. You may not impose any further
ccaaf5b0
RR
517restrictions on the recipients' exercise of the rights granted herein.
518You are not responsible for enforcing compliance by third parties to
519this License.
520
457e6c54 52111. If, as a consequence of a court judgment or allegation of patent
ccaaf5b0
RR
522infringement or for any other reason (not limited to patent issues),
523conditions are imposed on you (whether by court order, agreement or
524otherwise) that contradict the conditions of this License, they do not
457e6c54 525excuse you from the conditions of this License. If you cannot
ccaaf5b0
RR
526distribute so as to satisfy simultaneously your obligations under this
527License and any other pertinent obligations, then as a consequence you
457e6c54 528may not distribute the Library at all. For example, if a patent
ccaaf5b0
RR
529license would not permit royalty-free redistribution of the Library by
530all those who receive copies directly or indirectly through you, then
531the only way you could satisfy both it and this License would be to
532refrain entirely from distribution of the Library.
533
534If any portion of this section is held invalid or unenforceable under any
535particular circumstance, the balance of the section is intended to apply,
536and the section as a whole is intended to apply in other circumstances.
537
538It is not the purpose of this section to induce you to infringe any
539patents or other property right claims or to contest validity of any
540such claims; this section has the sole purpose of protecting the
541integrity of the free software distribution system which is
457e6c54 542implemented by public license practices. Many people have made
ccaaf5b0
RR
543generous contributions to the wide range of software distributed
544through that system in reliance on consistent application of that
545system; it is up to the author/donor to decide if he or she is willing
546to distribute software through any other system and a licensee cannot
547impose that choice.
548
549This section is intended to make thoroughly clear what is believed to
550be a consequence of the rest of this License.
551
457e6c54 55212. If the distribution and/or use of the Library is restricted in
ccaaf5b0
RR
553certain countries either by patents or by copyrighted interfaces, the
554original copyright holder who places the Library under this License may add
555an explicit geographical distribution limitation excluding those countries,
556so that distribution is permitted only in or among countries not thus
457e6c54 557excluded. In such case, this License incorporates the limitation as if
ccaaf5b0
RR
558written in the body of this License.
559
457e6c54 56013. The Free Software Foundation may publish revised and/or new
ccaaf5b0
RR
561versions of the Library General Public License from time to time.
562Such new versions will be similar in spirit to the present version,
563but may differ in detail to address new problems or concerns.
564
457e6c54 565Each version is given a distinguishing version number. If the Library
ccaaf5b0
RR
566specifies a version number of this License which applies to it and
567"any later version", you have the option of following the terms and
568conditions either of that version or of any later version published by
457e6c54 569the Free Software Foundation. If the Library does not specify a
ccaaf5b0
RR
570license version number, you may choose any version ever published by
571the Free Software Foundation.
572
457e6c54 57314. If you wish to incorporate parts of the Library into other free
ccaaf5b0 574programs whose distribution conditions are incompatible with these,
457e6c54 575write to the author to ask for permission. For software which is
ccaaf5b0 576copyrighted by the Free Software Foundation, write to the Free
457e6c54 577Software Foundation; we sometimes make exceptions for this. Our
ccaaf5b0
RR
578decision will be guided by the two goals of preserving the free status
579of all derivatives of our free software and of promoting the sharing
580and reuse of software generally.
581
605d715d 582\begin{center}
457e6c54 583NO WARRANTY
605d715d 584\end{center}
ccaaf5b0 585
457e6c54 58615. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO
ccaaf5b0
RR
587WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW.
588EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
589OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY
590KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
591IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
457e6c54
JS
592PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
593LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME
ccaaf5b0
RR
594THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
595
457e6c54 59616. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
ccaaf5b0
RR
597WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
598AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU
599FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
600CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
601LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
602RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
603FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
604SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
605DAMAGES.
606
605d715d
VS
607
608\begin{center}
457e6c54 609END OF TERMS AND CONDITIONS
605d715d 610\end{center}
ccaaf5b0 611
605d715d 612\wxheading{Appendix: How to Apply These Terms to Your New Libraries}
ccaaf5b0 613
457e6c54 614If you develop a new library, and you want it to be of the greatest
ccaaf5b0 615possible use to the public, we recommend making it free software that
457e6c54 616everyone can redistribute and change. You can do so by permitting
ccaaf5b0
RR
617redistribution under these terms (or, alternatively, under the terms of the
618ordinary General Public License).
619
457e6c54 620To apply these terms, attach the following notices to the library. It is
ccaaf5b0
RR
621safest to attach them to the start of each source file to most effectively
622convey the exclusion of warranty; and each file should have at least the
623"copyright" line and a pointer to where the full notice is found.
624
605d715d
VS
625\footnotesize{
626\begin{verbatim}
627<one line to give the library's name and a brief idea of what it does.>
457e6c54 628Copyright (C) <year> <name of author>
605d715d
VS
629
630This library is free software; you can redistribute it and/or
631modify it under the terms of the GNU Library General Public
632License as published by the Free Software Foundation; either
633version 2 of the License, or (at your option) any later version.
634
635This library is distributed in the hope that it will be useful,
636but WITHOUT ANY WARRANTY; without even the implied warranty of
457e6c54 637MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
605d715d
VS
638Library General Public License for more details.
639
640You should have received a copy of the GNU Library General Public
641License along with this library; if not, write to the Free
642Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
643\end{verbatim}
d2c2afc9 644}%
ccaaf5b0 645
ccaaf5b0
RR
646Also add information on how to contact you by electronic and paper mail.
647
648You should also get your employer (if you work as a programmer) or your
649school, if any, to sign a "copyright disclaimer" for the library, if
457e6c54 650necessary. Here is a sample; alter the names:
ccaaf5b0 651
605d715d
VS
652\footnotesize{
653\begin{verbatim}
654Yoyodyne, Inc., hereby disclaims all copyright interest in the
655library `Frob' (a library for tweaking knobs) written by James Random Hacker.
656
657<signature of Ty Coon>, 1 April 1990
658Ty Coon, President of Vice
659\end{verbatim}
d2c2afc9 660}%
ccaaf5b0 661
ccaaf5b0
RR
662That's all there is to it!
663
ab246904 664\input body.tex
8a7fd2e3 665\input libs.tex
ab246904 666\input classes.tex
9cc02d04 667\input function.tex
ab246904
VZ
668\input constant.tex
669\input category.tex
670\input topics.tex
671\input portnote.tex
bd330a69 672% Deprecated classes
ab246904 673%\input proplist.tex
a660d684 674
bd0df01f 675\begin{comment}
a660d684
KB
676\newpage
677
678% Puts books in the bibliography without needing to cite them in the
679% text
680\nocite{helpbook}%
681\nocite{wong93}%
682\nocite{pree94}%
683\nocite{gamma95}%
684\nocite{smart95a}%
685\nocite{smart95b}%
686
687\bibliography{refs}
688\addcontentsline{toc}{chapter}{Bibliography}
689\setheader{{\it REFERENCES}}{}{}{}{}{{\it REFERENCES}}%
690\setfooter{\thepage}{}{}{}{}{\thepage}%
d958c9bd 691\end{comment}
a660d684
KB
692
693\newpage
d958c9bd 694
62448488
JS
695% Note: In RTF, the \printindex must come before the
696% change of header/footer, since the \printindex inserts
697% the RTF \sect command which divides one chapter from
698% the next.
699\rtfonly{\printindex
a660d684
KB
700\addcontentsline{toc}{chapter}{Index}
701\setheader{{\it INDEX}}{}{}{}{}{{\it INDEX}}%
62448488
JS
702\setfooter{\thepage}{}{}{}{}{\thepage}
703}
704% In Latex, it must be this way around (I think)
705\latexonly{\addcontentsline{toc}{chapter}{Index}
706\setheader{{\it INDEX}}{}{}{}{}{{\it INDEX}}%
707\setfooter{\thepage}{}{}{}{}{\thepage}
a660d684 708\printindex
62448488
JS
709}
710
a660d684 711\end{document}