]> git.saurik.com Git - wxWidgets.git/blame - docs/latex/wx/dataobj.tex
Split up wxStream doc files; added wxTCP... files; added wxBusyCursor;
[wxWidgets.git] / docs / latex / wx / dataobj.tex
CommitLineData
dface61c
JS
1\section{\class{wxDataObject}}\label{wxdataobject}
2
3A wxDataObject represents data that can be copied to or from the clipboard, or
4dragged and dropped.
5
6There are several predefined data object classes, such as \helpref{wxFileDataObject}{wxfiledataobject},
7\helpref{wxTextDataObject}{wxtextdataobject}, and \helpref{wxBitmapDataObject}{wxbitmapdataobject}.
8
9You may also derive your own data object classes for user-defined types.
10
11TODO: how do user-defined types work?
12
13\wxheading{Derived from}
14
15\helpref{wxObject}{wxobject}
16
17\wxheading{Types}
18
19\index{wxDataFormat}The following symbols are interchangable with the
20Windows equivalents.
21
22\begin{verbatim}
23enum wxDataFormat
24{
25 wxDF_TEXT = 1, /* CF_TEXT */
26 wxDF_BITMAP = 2, /* CF_BITMAP */
27 wxDF_METAFILE = 3, /* CF_METAFILEPICT */
28 wxDF_DIB = 8, /* CF_DIB */
29 wxDF_OEMTEXT = 7, /* CF_OEMTEXT */
30 wxDF_FILENAME = 15, /* CF_HDROP */
31 wxDF_PRIVATE = 20
32};
33\end{verbatim}
34
35\wxheading{See also}
36
37\helpref{wxFileDataObject}{wxfiledataobject},
38\helpref{wxTextDataObject}{wxtextdataobject},
39\helpref{wxBitmapDataObject}{wxbitmapdataobject},
40\helpref{Drag and drop overview}{wxdndoverview}, \helpref{wxDropTarget}{wxdroptarget},
41\helpref{wxDropSource}{wxdropsource},
42\helpref{wxTextDropTarget}{wxtextdroptarget}, \helpref{wxFileDropTarget}{wxfiledroptarget}
43
44\latexignore{\rtfignore{\wxheading{Members}}}
45
46\membersection{wxDataObject::wxDataObject}\label{wxdataobjectwxdataobject}
47
48\func{}{wxDataObject}{\void}
49
50Constructor.
51
52\membersection{wxDataObject::\destruct{wxDataObject}}\label{wxdataobjectdtor}
53
54\func{}{\destruct{wxDataObject}}{\void}
55
56Destructor.
57
58\membersection{wxDataObject::GetFormat}\label{wxdataobjectgetformat}
59
60\constfunc{virtual wxDataFormat}{GetFormat}{\void}
61
62Returns the format of the object. See \helpref{Types}{wxdataobject}.
63