X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/954b8ae60391d18b87a604e7919c87c0c6ae208b..d60156ac9d764d9ee6cf866a87084732d341abb9:/docs/latex/wx/fildatob.tex diff --git a/docs/latex/wx/fildatob.tex b/docs/latex/wx/fildatob.tex index 149bbb2c94..a647856b6c 100644 --- a/docs/latex/wx/fildatob.tex +++ b/docs/latex/wx/fildatob.tex @@ -1,9 +1,24 @@ \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 receive the files from another application, but +copying (or dragging) file(s) from a wxWidgets application is not currently +supported. PS: GTK2 should work as well. + +\wxheading{Virtual functions to override} + +None. \wxheading{Derived from} +\helpref{wxDataObjectSimple}{wxdataobjectsimple}\\ \helpref{wxDataObject}{wxdataobject} \wxheading{Include files} @@ -12,31 +27,29 @@ wxFileDataObject is a specialization of wxDataObject for file names. \wxheading{See also} +\helpref{wxDataObject}{wxdataobject}, +\helpref{wxDataObjectSimple}{wxdataobjectsimple}, +\helpref{wxTextDataObject}{wxtextdataobject}, +\helpref{wxBitmapDataObject}{wxbitmapdataobject}, \helpref{wxDataObject}{wxdataobject} \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxFileDataObject::wxFileDataObject}\label{wxfiledataobjectwxfiledataobject} +\membersection{wxFileDataObject}\label{wxfiledataobjectwxfiledataobject} \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}} -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.