fixed another return FALSE in a function returning a pointer (patch 545046)

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

diff --git a/docs/latex/wx/fildatob.tex b/docs/latex/wx/fildatob.tex
index a5e13667d73bf2ee99ace6d64bec8fca80fb042f..df7c1adbfacbce1c5fc95c425d392d7eaa9eed1c 100644 (file)
--- a/docs/latex/wx/fildatob.tex
+++ b/docs/latex/wx/fildatob.tex
@@ -1,38 +1,55 @@
 \section{\class{wxFileDataObject}}\label{wxfiledataobject}
 
 \section{\class{wxFileDataObject}}\label{wxfiledataobject}
 

-wxFileDataObject is a specialization of wxDataObject for file names.
+wxFileDataObject is a specialization of \helpref{wxDataObject}{wxdataobject} 
+for file names. The program works with it just as if it were a list of absolute file
+names, but internally it uses the same format as
+Explorer and other compatible programs under Windows or GNOME/KDE filemanager
+under Unix which makes it possible to receive files from them using this
+class.
+
+{\bf Warning:} Under all non-Windows platforms this class is currently
+"input-only", i.e. you can receieve the files from another application, but
+copying (or dragging) file(s) from a wxWindows application is not currently
+supported.
+
+\wxheading{Virtual functions to override}
+
+None.

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

+\helpref{wxDataObjectSimple}{wxdataobjectsimple}\\

 \helpref{wxDataObject}{wxdataobject}
 
 \helpref{wxDataObject}{wxdataobject}
 

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

 \wxheading{See also}
 
 \wxheading{See also}
 

+\helpref{wxDataObject}{wxdataobject}, 
+\helpref{wxDataObjectSimple}{wxdataobjectsimple}, 
+\helpref{wxTextDataObject}{wxtextdataobject}, 
+\helpref{wxBitmapDataObject}{wxbitmapdataobject}, 

 \helpref{wxDataObject}{wxdataobject}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \helpref{wxDataObject}{wxdataobject}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

-\membersection{wxFileDataObject::wxFileDataObject}\label{wxfiledataobjectwxfiledataobject}
+\membersection{wxFileDataObject}\label{wxfiledataobjectwxfiledataobject}

 
 \func{}{wxFileDataObject}{\void}
 
 Constructor.
 
 
 \func{}{wxFileDataObject}{\void}
 
 Constructor.
 

-\membersection{wxFileDataObject::GetFormat}\label{wxfiledataobjectgetformat}
-
-\constfunc{virtual wxDataFormat}{GetFormat}{\void}
-
-Returns wxDF\_FILENAME.
-

 \membersection{wxFileDataObject::AddFile}\label{wxfiledataobjectaddfile}
 
 \func{virtual void}{AddFile}{\param{const wxString\& }{file}}
 
 \membersection{wxFileDataObject::AddFile}\label{wxfiledataobjectaddfile}
 
 \func{virtual void}{AddFile}{\param{const wxString\& }{file}}
 

-Adds a filename to the data object.
+{\bf MSW only:} adds a file to the file list represented by this data object.

 
 

-\membersection{wxFileDataObject::GetFiles}\label{wxfiledataobjectgetfiles}
+\membersection{wxFileDataObject::GetFilenames}\label{wxfiledataobjectgetfilenames}

 
 

-\constfunc{virtual wxString}{GetFiles}{\void}
+\constfunc{const wxArrayString\& }{GetFilenames}{\void}

 
 

-Returns files as a zero-separated list.
+Returns the \helpref{array}{wxarraystring} of file names.