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{Include files}
  13
  14 <wx/dataobj.h>
  15
  16 \wxheading{See also}
  17
  18 \helpref{wxDataObject}{wxdataobject}
  19
  20 \latexignore{\rtfignore{\wxheading{Members}}}
  21
  22 \membersection{wxPrivateDataObject::wxPrivateDataObject}\label{wxprivatedataobjectwxprivatedataobject}
  23
  24 \func{}{wxPrivateDataObject}{\void}
  25
  26 \membersection{wxPrivateDataObject::\destruct{wxPrivateDataObject}}\label{wxprivatedataobjectdtor}
  27
  28 \func{}{\destruct{wxPrivateDataObject}}{\void}
  29
  30 \membersection{wxPrivateDataObject::SetId}\label{wxprivatedataobjectsetid}
  31
  32 \func{virtual void}{SetId}{\param{const wxString\& }{id}}
  33
  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
  36 to the clipboard - the latter with the Id "application/word".
  37
  38 \membersection{wxPrivateDataObject::GetId}\label{wxprivatedataobjectgetid}
  39
  40 \constfunc{virtual wxString}{GetId}{\void}
  41
  42 Returns the ID of the clipboard or DnD data format.
  43
  44 \membersection{wxPrivateDataObject::SetData}\label{wxprivatedataobjectsetdata}
  45
  46 \func{virtual void}{SetData}{\param{const char }{*data}, \param{size\_t }{size}}
  47
  48 Set the data. The data object will make an internal copy.
  49
  50 \membersection{wxPrivateDataObject::GetSize}\label{wxprivatedataobjectgetsize}
  51
  52 \constfunc{virtual size\_t}{GetDataSize}{\void}
  53
  54 Returns the data size.
  55
  56 \membersection{wxPrivateDataObject::GetData}\label{wxprivatedataobjectgetdata}
  57
  58 \func{virtual char*}{GetData}{\void}
  59
  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}.
  79