]> git.saurik.com Git - wxWidgets.git/blob - docs/latex/wx/prvdatob.tex
a bit more docs
[wxWidgets.git] / docs / latex / wx / prvdatob.tex
1 \section{\class{wxPrivateDataObject}}\label{wxprivatedataobject}
2
3 wxPrivateDataObject is a specialization of wxDataObject for application-specific data.
4
5 \wxheading{Derived from}
6
7 \helpref{wxDataObject}{wxdataobject}
8
9 \wxheading{See also}
10
11 \helpref{wxDataObject}{wxdataobject}
12
13 \latexignore{\rtfignore{\wxheading{Members}}}
14
15 \membersection{wxPrivateDataObject::wxPrivateDataObject}\label{wxprivatedataobjectwxprivatedataobject}
16
17 \func{}{wxPrivateDataObject}{\void}
18
19 \membersection{wxPrivateDataObject::\destruct{wxPrivateDataObject}}\label{wxprivatedataobjectdtor}
20
21 \func{}{\destruct{wxPrivateDataObject}}{\void}
22
23 \membersection{wxPrivateDataObject::GetFormat}\label{wxprivatedataobjectgetformat}
24
25 \constfunc{virtual wxDataFormat}{GetFormat}{\void}
26
27 \membersection{wxPrivateDataObject::SetId}\label{wxprivatedataobjectsetid}
28
29 \func{virtual void}{SetId}{\param{const wxString\& }{id}}
30
31 The string ID identifies the format of clipboard or DnD data. A word
32 processor would e.g. add a wxTextDataObject and a wxPrivateDataObject
33 to the clipboard - the latter with the Id "WXWORD\_FORMAT".
34
35 \membersection{wxPrivateDataObject::GetId}\label{wxprivatedataobjectgetid}
36
37 \constfunc{virtual wxString}{GetId}{\void}
38
39 Returns the ID of the clipboard or DnD data format.
40
41 \membersection{wxPrivateDataObject::SetData}\label{wxprivatedataobjectsetdata}
42
43 \func{virtual void}{SetData}{\param{const char }{*data}, \param{size\_t }{size}}
44
45 Set the data. The data object will make internal copy.
46
47 \membersection{wxPrivateDataObject::GetDataSize}\label{wxprivatedataobjectgetdatasize}
48
49 \constfunc{virtual size\_t}{GetDataSize}{\void}
50
51 Returns the data size.
52
53 \membersection{wxPrivateDataObject::GetData}\label{wxprivatedataobjectgetdata}
54
55 \func{virtual char*}{GetData}{\void}
56
57 Returns the data.
58