]> git.saurik.com Git - wxWidgets.git/blame - docs/latex/wx/dobjsmpl.tex
Changed version to 2.5.1
[wxWidgets.git] / docs / latex / wx / dobjsmpl.tex
CommitLineData
eb91c0be
VZ
1%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2%% Name: dobjsmpl.tex
3%% Purpose: wxDataObjectSimple documentation
4%% Author: Vadim Zeitlin
5%% Modified by:
6%% Created: 02.11.99
7%% RCS-ID: $Id$
8%% Copyright: (c) Vadim Zeitlin
f6bcfd97 9%% License: wxWindows license
eb91c0be
VZ
10%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
11
12\section{\class{wxDataObjectSimple}}\label{wxdataobjectsimple}
13
fa482912 14This is the simplest possible implementation of the
eb91c0be
VZ
15\helpref{wxDataObject}{wxdataobject} class. The data object of (a class derived
16from) this class only supports one format, so the number of virtual functions
17to be implemented is reduced.
18
19Notice that this is still an abstract base class and cannot be used but should
20be derived from.
21
b1462dfa
RD
22\pythonnote{If you wish to create a derived wxDataObjectSimple class in
23wxPython you should derive the class from wxPyDataObjectSimple
24in order to get Python-aware capabilities for the various virtual
25methods.}
26
d3f3e857
MB
27\perlnote{In wxPerl, you need to derive your data object class
28from Wx::PlDataObjectSimple.}
29
eb91c0be
VZ
30\wxheading{Virtual functions to override}
31
fa482912
JS
32The objects supporting rendering the data must override
33\helpref{GetDataSize}{wxdataobjectsimplegetdatasize} and
eb91c0be
VZ
34\helpref{GetDataHere}{wxdataobjectsimplegetdatahere} while the objects which
35may be set must override \helpref{SetData}{wxdataobjectsimplesetdata}. Of
2edb0bde 36course, the objects supporting both operations must override all three
eb91c0be
VZ
37methods.
38
39\wxheading{Derived from}
40
41\helpref{wxDataObject}{wxdataobject}
42
43\wxheading{Include files}
44
45<wx/dataobj.h>
46
47\wxheading{See also}
48
fa482912
JS
49\helpref{Clipboard and drag and drop overview}{wxdndoverview},
50\helpref{DnD sample}{samplednd},
51\helpref{wxFileDataObject}{wxfiledataobject},
52\helpref{wxTextDataObject}{wxtextdataobject},
eb91c0be
VZ
53\helpref{wxBitmapDataObject}{wxbitmapdataobject}
54
55\latexignore{\rtfignore{\wxheading{Members}}}
56
57\membersection{wxDataObjectSimple::wxDataObjectSimple}\label{wxdataobjectsimplewxdataobjectsimple}
58
59\func{}{wxDataObjectSimple}{\param{const wxDataFormat\&}{ format = wxFormatInvalid}}
60
61Constructor accepts the supported format (none by default) which may also be
62set later with \helpref{SetFormat}{wxdataobjectsimplesetformat}.
63
64\membersection{wxDataObjectSimple::GetFormat}\label{wxdataobjectsimplegetformat}
65
66\constfunc{const wxDataFormat\&}{GetFormat}{\void}
67
68Returns the (one and only one) format supported by this object. It is supposed
69that the format is supported in both directions.
70
71\membersection{wxDataObjectSimple::SetFormat}\label{wxdataobjectsimplesetformat}
72
73\func{void}{SetFormat}{\param{const wxDataFormat\&}{ format}}
74
75Sets the supported format.
76
77\membersection{wxDataObjectSimple::GetDataSize}\label{wxdataobjectsimplegetdatasize}
78
79\constfunc{virtual size\_t}{GetDataSize}{\void}
80
81Gets the size of our data. Must be implemented in the derived class if the
82object supports rendering its data.
83
84\membersection{wxDataObjectSimple::GetDataHere}\label{wxdataobjectsimplegetdatahere}
85
86\constfunc{virtual bool}{GetDataHere}{\param{void }{*buf}}
87
cc81d32f 88Copy the data to the buffer, return true on success. Must be implemented in the
eb91c0be
VZ
89derived class if the object supports rendering its data.
90
b1462dfa
RD
91\pythonnote{When implementing this method in wxPython, no additional
92parameters are required and the data should be returned from the
93method as a string.}
94
eb91c0be
VZ
95\membersection{wxDataObjectSimple::SetData}\label{wxdataobjectsimplesetdata}
96
97\func{virtual bool}{SetData}{\param{size\_t }{len}, \param{const void }{*buf}}
98
cc81d32f 99Copy the data from the buffer, return true on success. Must be implemented in
eb91c0be
VZ
100the derived class if the object supports setting its data.
101
b1462dfa
RD
102\pythonnote{When implementing this method in wxPython, the data comes
103as a single string parameter rather than the two shown here.}
104