docs/latex/wx/prvdatob.tex

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