]> git.saurik.com Git - wxWidgets.git/blob - docs/latex/wx/fildatob.tex
added null pointer check and assert
[wxWidgets.git] / docs / latex / wx / fildatob.tex
1 \section{\class{wxFileDataObject}}\label{wxfiledataobject}
2
3 wxFileDataObject is a specialization of \helpref{wxDataObject}{wxdataobject}
4 for file names. The program works with it just as if it were a list of absolute file
5 names, but internally it uses the same format as
6 Explorer and other compatible programs under Windows or GNOME/KDE filemanager
7 under Unix which makes it possible to receive files from them using this
8 class.
9
10 {\bf Warning:} Under all non-Windows platforms this class is currently
11 "input-only", i.e. you can receive the files from another application, but
12 copying (or dragging) file(s) from a wxWidgets application is not currently
13 supported. PS: GTK2 should work as well.
14
15 \wxheading{Virtual functions to override}
16
17 None.
18
19 \wxheading{Derived from}
20
21 \helpref{wxDataObjectSimple}{wxdataobjectsimple}\\
22 \helpref{wxDataObject}{wxdataobject}
23
24 \wxheading{Include files}
25
26 <wx/dataobj.h>
27
28 \wxheading{Library}
29
30 \helpref{wxCore}{librarieslist}
31
32 \wxheading{See also}
33
34 \helpref{wxDataObject}{wxdataobject},
35 \helpref{wxDataObjectSimple}{wxdataobjectsimple},
36 \helpref{wxTextDataObject}{wxtextdataobject},
37 \helpref{wxBitmapDataObject}{wxbitmapdataobject},
38 \helpref{wxDataObject}{wxdataobject}
39
40 \latexignore{\rtfignore{\wxheading{Members}}}
41
42 \membersection{wxFileDataObject}\label{wxfiledataobjectwxfiledataobject}
43
44 \func{}{wxFileDataObject}{\void}
45
46 Constructor.
47
48 \membersection{wxFileDataObject::AddFile}\label{wxfiledataobjectaddfile}
49
50 \func{virtual void}{AddFile}{\param{const wxString\& }{file}}
51
52 {\bf MSW only:} adds a file to the file list represented by this data object.
53
54 \membersection{wxFileDataObject::GetFilenames}\label{wxfiledataobjectgetfilenames}
55
56 \constfunc{const wxArrayString\& }{GetFilenames}{\void}
57
58 Returns the \helpref{array}{wxarraystring} of file names.
59