document GetAnimation() (patch 1695722)

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

diff --git a/docs/latex/wx/dataform.tex b/docs/latex/wx/dataform.tex
index 62e0fdb5c7bec602297c10febf7962b4790a9d54..e4c7a565dc0027c183ea4ffb94ae88b58acc582f 100644 (file)
--- a/docs/latex/wx/dataform.tex
+++ b/docs/latex/wx/dataform.tex
@@ -6,7 +6,7 @@
 %% Created:     03.11.99
 %% RCS-ID:      $Id$
 %% Copyright:   (c) Vadim Zeitlin
 %% Created:     03.11.99
 %% RCS-ID:      $Id$
 %% Copyright:   (c) Vadim Zeitlin

-%% Licence:     wxWindows licence
+%% License:     wxWindows license

 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 \section{\class{wxDataFormat}}\label{wxdataformat}
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 \section{\class{wxDataFormat}}\label{wxdataformat}


@@ -29,6 +29,8 @@ functions taking a wxDataFormat argument sometimes}
 \twocolitem{wxDF\_BITMAP}{A bitmap (wxBitmap)}
 \twocolitem{wxDF\_METAFILE}{A metafile (wxMetafile, Windows only)}
 \twocolitem{wxDF\_FILENAME}{A list of filenames}
 \twocolitem{wxDF\_BITMAP}{A bitmap (wxBitmap)}
 \twocolitem{wxDF\_METAFILE}{A metafile (wxMetafile, Windows only)}
 \twocolitem{wxDF\_FILENAME}{A list of filenames}

+\twocolitem{wxDF\_HTML}{An HTML string. This is only valid when passed to wxSetClipboardData
+when compiled with Visual C++ in non-Unicode mode}

 \end{twocollist}
 
 As mentioned above, these standard formats may be passed to any function taking
 \end{twocollist}
 
 As mentioned above, these standard formats may be passed to any function taking


@@ -48,7 +50,7 @@ do clipboard format registration at this time will usually lead to a crash!
 
 \wxheading{Virtual functions to override}
 
 
 \wxheading{Virtual functions to override}
 

-None, this class doesn't have any.
+None

 
 \wxheading{Derived from}
 
 
 \wxheading{Derived from}
 


@@ -60,6 +62,10 @@ None
 \helpref{DnD sample}{samplednd}, 
 \helpref{wxDataObject}{wxdataobject}
 
 \helpref{DnD sample}{samplednd}, 
 \helpref{wxDataObject}{wxdataobject}
 

+\wxheading{Include files}
+
+<wx/dataobj.h>
+

 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxDataFormat::wxDataFormat}\label{wxdataformatwxdataformatdef}
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxDataFormat::wxDataFormat}\label{wxdataformatwxdataformatdef}


@@ -70,6 +76,8 @@ Constructs a data format object for one of the standard data formats or an
 empty data object (use \helpref{SetType}{wxdataformatsettype} or 
 \helpref{SetId}{wxdataformatsetid} later in this case)
 
 empty data object (use \helpref{SetType}{wxdataformatsettype} or 
 \helpref{SetId}{wxdataformatsetid} later in this case)
 

+\perlnote{In wxPerl this function is named {\tt newNative}.}
+

 \membersection{wxDataFormat::wxDataFormat}\label{wxdataformatwxdataformat}
 
 \func{}{wxDataFormat}{\param{const wxChar }{*format}}
 \membersection{wxDataFormat::wxDataFormat}\label{wxdataformatwxdataformat}
 
 \func{}{wxDataFormat}{\param{const wxChar }{*format}}


@@ -77,17 +85,19 @@ empty data object (use \helpref{SetType}{wxdataformatsettype} or
 Constructs a data format object for a custom format identified by its name 
 {\it format}.
 
 Constructs a data format object for a custom format identified by its name 
 {\it format}.
 

+\perlnote{In wxPerl this function is named {\tt newUser}.}
+

 \membersection{wxDataFormat::operator $==$}\label{wxdataformatoperatoreq}
 
 \constfunc{bool}{operator $==$}{\param{const wxDataFormat\&}{ format}}
 
 \membersection{wxDataFormat::operator $==$}\label{wxdataformatoperatoreq}
 
 \constfunc{bool}{operator $==$}{\param{const wxDataFormat\&}{ format}}
 

-Returns TRUE if the formats are equal.
+Returns true if the formats are equal.

 
 \membersection{wxDataFormat::operator $!=$}\label{wxdataformatoperatorneq}
 
 \constfunc{bool}{operator $!=$}{\param{const wxDataFormat\&}{ format}}
 
 
 \membersection{wxDataFormat::operator $!=$}\label{wxdataformatoperatorneq}
 
 \constfunc{bool}{operator $!=$}{\param{const wxDataFormat\&}{ format}}
 

-Returns TRUE if the formats are different.
+Returns true if the formats are different.

 
 \membersection{wxDataFormat::GetId}\label{wxdataformatgetid}
 
 
 \membersection{wxDataFormat::GetId}\label{wxdataformatgetid}