954b8ae603
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@1698 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
80 lines
2.7 KiB
TeX
80 lines
2.7 KiB
TeX
\section{\class{wxPrivateDataObject}}\label{wxprivatedataobject}
|
|
|
|
wxPrivateDataObject is a specialization of wxDataObject for application-specific or standard
|
|
format data. The format of the data contained in an instance of this class must be identified
|
|
with a string literal corresponding to the mime-type of the data. Typically this would be
|
|
"image/png" or "text/html" or "application/word".
|
|
|
|
\wxheading{Derived from}
|
|
|
|
\helpref{wxDataObject}{wxdataobject}
|
|
|
|
\wxheading{Include files}
|
|
|
|
<wx/dataobj.h>
|
|
|
|
\wxheading{See also}
|
|
|
|
\helpref{wxDataObject}{wxdataobject}
|
|
|
|
\latexignore{\rtfignore{\wxheading{Members}}}
|
|
|
|
\membersection{wxPrivateDataObject::wxPrivateDataObject}\label{wxprivatedataobjectwxprivatedataobject}
|
|
|
|
\func{}{wxPrivateDataObject}{\void}
|
|
|
|
\membersection{wxPrivateDataObject::\destruct{wxPrivateDataObject}}\label{wxprivatedataobjectdtor}
|
|
|
|
\func{}{\destruct{wxPrivateDataObject}}{\void}
|
|
|
|
\membersection{wxPrivateDataObject::SetId}\label{wxprivatedataobjectsetid}
|
|
|
|
\func{virtual void}{SetId}{\param{const wxString\& }{id}}
|
|
|
|
The string ID identifies the format of clipboard or DnD data. A word
|
|
processor would e.g. add a wxTextDataObject and a wxPrivateDataObject
|
|
to the clipboard - the latter with the Id "application/word".
|
|
|
|
\membersection{wxPrivateDataObject::GetId}\label{wxprivatedataobjectgetid}
|
|
|
|
\constfunc{virtual wxString}{GetId}{\void}
|
|
|
|
Returns the ID of the clipboard or DnD data format.
|
|
|
|
\membersection{wxPrivateDataObject::SetData}\label{wxprivatedataobjectsetdata}
|
|
|
|
\func{virtual void}{SetData}{\param{const char }{*data}, \param{size\_t }{size}}
|
|
|
|
Set the data. The data object will make an internal copy.
|
|
|
|
\membersection{wxPrivateDataObject::GetSize}\label{wxprivatedataobjectgetsize}
|
|
|
|
\constfunc{virtual size\_t}{GetDataSize}{\void}
|
|
|
|
Returns the data size.
|
|
|
|
\membersection{wxPrivateDataObject::GetData}\label{wxprivatedataobjectgetdata}
|
|
|
|
\func{virtual char*}{GetData}{\void}
|
|
|
|
Returns a pointer to the data.
|
|
|
|
\membersection{wxPrivateDataObject::WriteData}\label{wxprivatedataobjectwritedata}
|
|
|
|
\constfunc{virtual void}{WriteData}{\param{void}{*dest} }
|
|
|
|
Write the data owned by this class to {\it dest}. By default, this
|
|
calls \helpref{WriteData}{wxprivatedataobjectwritedata2} with data
|
|
set using \helpref{SetData}{wxprivatedataobjectsetdata}.
|
|
This can be overridden to provide data on-demand; in this case
|
|
\helpref{WriteData(data,dest)}{wxprivatedataobjectwritedata2} (see below) must be called from
|
|
within the overriding WriteData() method.
|
|
|
|
\membersection{wxPrivateDataObject::WriteData}\label{wxprivatedataobjectwritedata2}
|
|
|
|
\constfunc{void}{WriteData}{\param{const char* }{data}, \param{void}{*dest} }
|
|
|
|
Writes the data {\it data} to {\it dest}. This method must be called
|
|
from \helpref{WriteData}{wxprivatedataobjectwritedata}.
|
|
|