document GetAnimation() (patch 1695722)

[wxWidgets.git] / docs / latex / wx / manual.tex

diff --git a/docs/latex/wx/manual.tex b/docs/latex/wx/manual.tex
index 6722730bc5445896df8925c696a3b17600171103..8cacaba33086704195a4777672ac60e178fd6d7d 100644 (file)
--- a/docs/latex/wx/manual.tex
+++ b/docs/latex/wx/manual.tex
@@ -21,17 +21,18 @@
 \definecolour{white}{255}{255}{255}%
 %
 \input psbox.tex
 \definecolour{white}{255}{255}{255}%
 %
 \input psbox.tex

+\input ltx.tex

 % Remove this for processing with dvi2ps instead of dvips
 %\special{!/@scaleunit 1 def}
 \parskip=10pt
 \parindent=0pt
 % Remove this for processing with dvi2ps instead of dvips
 %\special{!/@scaleunit 1 def}
 \parskip=10pt
 \parindent=0pt

-\title{wxWindows 2.3: A portable C++ and Python GUI toolkit}
+\title{wxWidgets 2.9.0: A portable C++ and Python GUI toolkit}

 \winhelponly{\author{by Julian Smart et al
 %\winhelponly{\\$$\image{1cm;0cm}{wxwin.wmf}$$}
 }}
 \winhelpignore{\author{Julian Smart, Robert Roebling, Vadim Zeitlin,
 Robin Dunn, et al}
 \winhelponly{\author{by Julian Smart et al
 %\winhelponly{\\$$\image{1cm;0cm}{wxwin.wmf}$$}
 }}
 \winhelpignore{\author{Julian Smart, Robert Roebling, Vadim Zeitlin,
 Robin Dunn, et al}

-\date{June 11th 2001}
+\date{January, 2007}

 }
 \makeindex
 \begin{document}
 }
 \makeindex
 \begin{document}


@@ -46,34 +47,34 @@ Robin Dunn, et al}
 % A special table of contents for the WinHelp manual
 \begin{comment}
 \winhelponly{
 % A special table of contents for the WinHelp manual
 \begin{comment}
 \winhelponly{

-\chapter{wxWindows class library reference}\label{winhelpcontents}
+\chapter{wxWidgets class library reference}\label{winhelpcontents}

 
 

-\center{
+\centerline{

 %\image{}{wxwin.wmf}
 }%
 
 \sethotspotcolour{off}%
 \sethotspotunderline{on}%
 \large{
 %\image{}{wxwin.wmf}
 }%
 
 \sethotspotcolour{off}%
 \sethotspotunderline{on}%
 \large{

-\image{}{cpp.bmp} \helpref{Alphabetical class reference}{classref}
+\helpref{Alphabetical class reference}{classref}

 
 

-\image{}{shelves.bmp} \helpref{Classes by category}{classesbycat}
+\helpref{Classes by category}{classesbycat}

 
 

-\image{}{book1.bmp} \helpref{Topic overviews}{overviews}
+\helpref{Topic overviews}{overviews}

 
 

-\image{}{hand1.bmp} \helpref{Guide to wxWindows}{wxwinchapters}
+\helpref{Guide to wxWidgets}{wxwinchapters}

 }
 \sethotspotcolour{on}%
 \sethotspotunderline{on}%
 
 }
 \sethotspotcolour{on}%
 \sethotspotunderline{on}%
 

-\chapter*{Overview of wxWindows}\label{wxwinchapters}
+\chapter*{Overview of wxWidgets}\label{wxwinchapters}

 
 \helpref{Introduction}{introduction}\\
 %\helpref{Resource guide}{resguide}\\
 %\helpref{Comparison with other GUI models}{comparison}\\
 
 \helpref{Introduction}{introduction}\\
 %\helpref{Resource guide}{resguide}\\
 %\helpref{Comparison with other GUI models}{comparison}\\

-%\helpref{Multi-platform development with wxWindows}{multiplat}\\
+%\helpref{Multi-platform development with wxWidgets}{multiplat}\\

 %\helpref{Tutorial}{tutorial}\\
 %\helpref{Tutorial}{tutorial}\\

-\helpref{The wxWindows resource system}{resourceformats}\\
+\helpref{The wxWidgets resource system}{resourceformats}\\

 \helpref{Utilities}{utilities}\\
 \helpref{Programming strategies}{strategies}\\
 \helpref{Bugs and future directions}{bugs}\\
 \helpref{Utilities}{utilities}\\
 \helpref{Programming strategies}{strategies}\\
 \helpref{Bugs and future directions}{bugs}\\


@@ -81,74 +82,83 @@ Robin Dunn, et al}
 }
 \end{comment}
 
 }
 \end{comment}
 

-\chapter{Copyright notice}
+\chapter{Copyright notice}\label{copyrightnotice}

 \setheader{{\it COPYRIGHT}}{}{}{}{}{{\it COPYRIGHT}}%
 \setfooter{\thepage}{}{}{}{}{\thepage}%
 
 \begin{center}
 \setheader{{\it COPYRIGHT}}{}{}{}{}{{\it COPYRIGHT}}%
 \setfooter{\thepage}{}{}{}{}{\thepage}%
 
 \begin{center}

-(c)  1999 Julian Smart, Robert Roebling, Vadim Zeitlin and other
-members of the wxWindows team\\
+Copyright (c) 1992-2006 Julian Smart, Robert Roebling, Vadim Zeitlin and other
+members of the wxWidgets team\\

 Portions (c) 1996 Artificial Intelligence Applications Institute\\
 \end{center}
 
 Portions (c) 1996 Artificial Intelligence Applications Institute\\
 \end{center}
 

-Please also see the wxWindows license files (preamble.txt, lgpl.txt, gpl.txt, license.txt,
+Please also see the wxWindows license files (preamble.txt, lgpl.txt, gpl.txt, licence.txt,

 licendoc.txt) for conditions of software and documentation use.
 licendoc.txt) for conditions of software and documentation use.

+Note that we use the old name wxWindows in the license, pending
+recognition of the new name by OSI.

 
 

-\section*{wxWindows Library License, Version 3}
+\section*{wxWindows Library License, Version 3.1}\label{wxlicense}

 
 

-Copyright (C) 1998 Julian Smart, Robert Roebling, Vadim Zeitlin et al. 
+% !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+%
+% NB: this is exact copy of docs/licence.txt file. DO NOT modify this
+%     section, it MUST be identical to docs/licence.txt!
+%
+% !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+Copyright (c) 1998-2005 Julian Smart, Robert Roebling et al

 
 Everyone is permitted to copy and distribute verbatim copies
 
 Everyone is permitted to copy and distribute verbatim copies

-of this license document, but changing it is not allowed. 
+of this licence document, but changing it is not allowed.

 
 \begin{center}
 
 \begin{center}

-WXWINDOWS LIBRARY LICENSE\\
-TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 
+WXWINDOWS LIBRARY LICENCE \\
+TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION

 \end{center}
 
 \end{center}
 

-This library is free software; you can redistribute it and/or modify it 
-under the terms of the GNU Library General Public License as published by 
-the Free Software Foundation; either version 2 of the License, or (at 
-your option) any later version. 
+This library is free software; you can redistribute it and/or modify it
+under the terms of the GNU Library General Public Licence as published by
+the Free Software Foundation; either version 2 of the Licence, or (at
+your option) any later version.

 
 

-This library 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 Library 
-General Public License for more details. 
+This library 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 Library
+General Public Licence for more details.

 
 

-You should have received a copy of the GNU Library General Public License 
-along with this software, usually in a file named COPYING.LIB. If not, 
+You should have received a copy of the GNU Library General Public Licence
+along with this software, usually in a file named COPYING.LIB.  If not,

 write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
 write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,

-Boston, MA~02111-1307 USA. 
-
-EXCEPTION NOTICE 
-
-1. As a special exception, the copyright holders of this library give 
-permission for additional uses of the text contained in this release of 
-the library as licensed under the wxWindows Library License, applying 
-either version 3 of the License, or (at your option) any later version of 
-the License as published by the copyright holders of version 3 of the 
-License document. 
-
-2. The exception is that you may create binary object code versions of any 
-works using this library or based on this library, and use, copy, modify, 
-link and distribute such binary object code files unrestricted under terms 
-of your choice. 
-
-3. If you copy code from files distributed under the terms of the GNU 
-General Public License or the GNU Library General Public License into a 
-copy of this library, as this license permits, the exception does not 
-apply to the code that you add in this way. To avoid misleading anyone as 
-to the status of such modified files, you must delete this exception 
+Boston, MA 02111-1307 USA.
+
+EXCEPTION NOTICE
+
+1. As a special exception, the copyright holders of this library give
+permission for additional uses of the text contained in this release of
+the library as licenced under the wxWindows Library Licence, applying
+either version 3.1 of the Licence, or (at your option) any later version of
+the Licence as published by the copyright holders of version 3.1 of the
+Licence document.
+
+2. The exception is that you may use, copy, link, modify and distribute
+under your own terms, binary object code versions of works based
+on the Library.
+
+3. If you copy code from files distributed under the terms of the GNU
+General Public Licence or the GNU Library General Public Licence into a
+copy of this library, as this licence permits, the exception does not
+apply to the code that you add in this way.  To avoid misleading anyone as
+to the status of such modified files, you must delete this exception

 notice from such code and/or adjust the licensing conditions notice
 notice from such code and/or adjust the licensing conditions notice

-accordingly. 
+accordingly.

 
 

-4. If you write modifications of your own for this library, it is your 
+4. If you write modifications of your own for this library, it is your

 choice whether to permit this exception to apply to your modifications. 
 choice whether to permit this exception to apply to your modifications. 

-If you do not wish that, you must delete the exception notice from such 
-code and/or adjust the licensing conditions notice accordingly. 
+If you do not wish that, you must delete the exception notice from such
+code and/or adjust the licensing conditions notice accordingly.

 
 

-\section*{GNU Library General Public License, Version 2}
+
+\section*{GNU Library General Public License, Version 2}\label{gnulicense}

 
 Copyright (C) 1991 Free Software Foundation, Inc.
 675 Mass Ave, Cambridge, MA 02139, USA
 
 Copyright (C) 1991 Free Software Foundation, Inc.
 675 Mass Ave, Cambridge, MA 02139, USA


@@ -631,7 +641,7 @@ You should have received a copy of the GNU Library General Public
 License along with this library; if not, write to the Free
 Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 \end{verbatim}
 License along with this library; if not, write to the Free
 Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 \end{verbatim}

-}
+}%

 
 Also add information on how to contact you by electronic and paper mail.
 
 
 Also add information on how to contact you by electronic and paper mail.
 


@@ -647,18 +657,21 @@ library `Frob' (a library for tweaking knobs) written by James Random Hacker.
 <signature of Ty Coon>, 1 April 1990
 Ty Coon, President of Vice
 \end{verbatim} 
 <signature of Ty Coon>, 1 April 1990
 Ty Coon, President of Vice
 \end{verbatim} 

-}
+}%

 
 That's all there is to it!
 
 
 That's all there is to it!
 

-\input{body.tex}
-\input{classes.tex}
-\input{category.tex}
-\input{topics.tex}
-\input{wxhtml.tex}
-\input{proplist.tex}
-\input{wxPython.tex}
-\input{porting.tex}
+\input body.tex
+\input libs.tex
+\input classes.tex
+\input function.tex
+\input constant.tex
+\input category.tex
+\input topics.tex
+\input topics2.tex
+\input portnote.tex
+% Deprecated classes
+%\input proplist.tex

 
 \begin{comment}
 \newpage
 
 \begin{comment}
 \newpage


@@ -672,14 +685,14 @@ That's all there is to it!
 \nocite{smart95a}%
 \nocite{smart95b}%
 
 \nocite{smart95a}%
 \nocite{smart95b}%
 

-\end{comment}
-

 \bibliography{refs}
 \addcontentsline{toc}{chapter}{Bibliography}
 \setheader{{\it REFERENCES}}{}{}{}{}{{\it REFERENCES}}%
 \setfooter{\thepage}{}{}{}{}{\thepage}%
 \bibliography{refs}
 \addcontentsline{toc}{chapter}{Bibliography}
 \setheader{{\it REFERENCES}}{}{}{}{}{{\it REFERENCES}}%
 \setfooter{\thepage}{}{}{}{}{\thepage}%

+\end{comment}

 
 \newpage
 
 \newpage

+

 % Note: In RTF, the \printindex must come before the
 % change of header/footer, since the \printindex inserts
 % the RTF \sect command which divides one chapter from
 % Note: In RTF, the \printindex must come before the
 % change of header/footer, since the \printindex inserts
 % the RTF \sect command which divides one chapter from