projects / wxWidgets.git / blame
| Commit | Line | Data |
|---|---|---|
| dface61c JS |
1 | \section{\class{wxPrivateDataObject}}\label{wxprivatedataobject} |
| 2 | ||
| 5aa5e35a RR |
3 | wxPrivateDataObject is a specialization of wxDataObject for application-specific or standard |
| 4 | format data. The format of the data contained in an instance of this class must be identified | |
| 5 | with a string literal corresponding to the mime-type of the data. Typically this would be | |
| 6 | "image/png" or "text/html" or "application/word". | |
| dface61c JS |
7 | |
| 8 | \wxheading{Derived from} | |
| 9 | ||
| 10 | \helpref{wxDataObject}{wxdataobject} | |
| 11 | ||
| 954b8ae6 JS |
12 | \wxheading{Include files} |
| 13 | ||
| 14 | <wx/dataobj.h> | |
| 15 | ||
| 130f49d7 JS |
16 | \wxheading{See also} |
| 17 | ||
| 18 | \helpref{wxDataObject}{wxdataobject} | |
| dface61c JS |
19 | |
| 20 | \latexignore{\rtfignore{\wxheading{Members}}} | |
| 21 | ||
| 22 | \membersection{wxPrivateDataObject::wxPrivateDataObject}\label{wxprivatedataobjectwxprivatedataobject} | |
| 23 | ||
| 130f49d7 | 24 | \func{}{wxPrivateDataObject}{\void} |
| dface61c JS |
25 | |
| 26 | \membersection{wxPrivateDataObject::\destruct{wxPrivateDataObject}}\label{wxprivatedataobjectdtor} | |
| 27 | ||
| 130f49d7 | 28 | \func{}{\destruct{wxPrivateDataObject}}{\void} |
| dface61c | 29 | |
| dface61c JS |
30 | \membersection{wxPrivateDataObject::SetId}\label{wxprivatedataobjectsetid} |
| 31 | ||
| 130f49d7 | 32 | \func{virtual void}{SetId}{\param{const wxString\& }{id}} |
| dface61c | 33 | |
| 130f49d7 JS |
34 | The string ID identifies the format of clipboard or DnD data. A word |
| 35 | processor would e.g. add a wxTextDataObject and a wxPrivateDataObject | |
| 5aa5e35a | 36 | to the clipboard - the latter with the Id "application/word". |
| dface61c JS |
37 | |
| 38 | \membersection{wxPrivateDataObject::GetId}\label{wxprivatedataobjectgetid} | |
| 39 | ||
| 40 | \constfunc{virtual wxString}{GetId}{\void} | |
| 41 | ||
| 130f49d7 JS |
42 | Returns the ID of the clipboard or DnD data format. |
| 43 | ||
| dface61c JS |
44 | \membersection{wxPrivateDataObject::SetData}\label{wxprivatedataobjectsetdata} |
| 45 | ||
| 130f49d7 | 46 | \func{virtual void}{SetData}{\param{const char }{*data}, \param{size\_t }{size}} |
| dface61c | 47 | |
| 5aa5e35a | 48 | Set the data. The data object will make an internal copy. |
| dface61c | 49 | |
| 5aa5e35a | 50 | \membersection{wxPrivateDataObject::GetSize}\label{wxprivatedataobjectgetsize} |
| dface61c JS |
51 | |
| 52 | \constfunc{virtual size\_t}{GetDataSize}{\void} | |
| 53 | ||
| 130f49d7 JS |
54 | Returns the data size. |
| 55 | ||
| dface61c JS |
56 | \membersection{wxPrivateDataObject::GetData}\label{wxprivatedataobjectgetdata} |
| 57 | ||
| 130f49d7 JS |
58 | \func{virtual char*}{GetData}{\void} |
| 59 | ||
| 5aa5e35a RR |
60 | Returns a pointer to the data. |
| 61 | ||
| 62 | \membersection{wxPrivateDataObject::WriteData}\label{wxprivatedataobjectwritedata} | |
| 63 | ||
| 64 | \constfunc{virtual void}{WriteData}{\param{void}{*dest} } | |
| 65 | ||
| 66 | Write the data owned by this class to {\it dest}. By default, this | |
| 67 | calls \helpref{WriteData}{wxprivatedataobjectwritedata2} with data | |
| 68 | set using \helpref{SetData}{wxprivatedataobjectsetdata}. | |
| 69 | This can be overridden to provide data on-demand; in this case | |
| 70 | \helpref{WriteData(data,dest)}{wxprivatedataobjectwritedata2} (see below) must be called from | |
| 71 | within the overriding WriteData() method. | |
| 72 | ||
| 73 | \membersection{wxPrivateDataObject::WriteData}\label{wxprivatedataobjectwritedata2} | |
| 74 | ||
| 75 | \constfunc{void}{WriteData}{\param{const char* }{data}, \param{void}{*dest} } | |
| 76 | ||
| 77 | Writes the data {\it data} to {\it dest}. This method must be called | |
| 78 | from \helpref{WriteData}{wxprivatedataobjectwritedata}. | |
| dface61c | 79 |