]> git.saurik.com Git - wxWidgets.git/blame - docs/latex/wx/bmpdatob.tex
don't crash when setting tooltip for a picker without text control
[wxWidgets.git] / docs / latex / wx / bmpdatob.tex
CommitLineData
dface61c
JS
1\section{\class{wxBitmapDataObject}}\label{wxbitmapdataobject}
2
717a57c2 3wxBitmapDataObject is a specialization of wxDataObject for bitmap data. It can
fa482912 4be used without change to paste data into the
717a57c2
VZ
5\helpref{wxClipboard}{wxclipboard} or a \helpref{wxDropSource}{wxdropsource}. A
6user may wish to derive a new class from this class for providing a bitmap
7on-demand in order to minimize memory consumption when offering data in several
8formats, such as a bitmap and GIF.
ab272c0b 9
b1462dfa
RD
10\pythonnote{If you wish to create a derived wxBitmapDataObject class in
11wxPython you should derive the class from wxPyBitmapDataObject
12in order to get Python-aware capabilities for the various virtual
13methods.}
14
717a57c2
VZ
15\wxheading{Virtual functions to override}
16
fa482912 17This class may be used as is, but
717a57c2
VZ
18\helpref{GetBitmap}{wxbitmapdataobjectgetbitmap} may be overridden to increase
19efficiency.
dface61c
JS
20
21\wxheading{Derived from}
22
407f3681 23\helpref{wxDataObjectSimple}{wxdataobjectsimple}\\
dface61c
JS
24\helpref{wxDataObject}{wxdataobject}
25
954b8ae6
JS
26\wxheading{Include files}
27
28<wx/dataobj.h>
29
dface61c
JS
30\wxheading{See also}
31
fa482912
JS
32\helpref{Clipboard and drag and drop overview}{wxdndoverview},
33\helpref{wxDataObject}{wxdataobject},
34\helpref{wxDataObjectSimple}{wxdataobjectsimple},
35\helpref{wxFileDataObject}{wxfiledataobject},
36\helpref{wxTextDataObject}{wxtextdataobject},
ab272c0b 37\helpref{wxDataObject}{wxdataobject}
dface61c 38
717a57c2 39\func{}{wxBitmapDataObject}{\param{const wxBitmap\& }{bitmap = wxNullBitmap}}
ab272c0b 40
fa482912
JS
41Constructor, optionally passing a bitmap (otherwise use
42\helpref{SetBitmap}{wxbitmapdataobjectsetbitmap} later).
ab272c0b 43
1fb3eae5 44\membersection{wxBitmapDataObject::GetBitmap}\label{wxbitmapdataobjectgetbitmap}
dface61c
JS
45
46\constfunc{virtual wxBitmap}{GetBitmap}{\void}
47
ab272c0b
RR
48Returns the bitmap associated with the data object. You may wish to override
49this method when offering data on-demand, but this is not required by
fc2171bd 50wxWidgets' internals. Use this method to get data in bitmap form from
ab272c0b
RR
51the \helpref{wxClipboard}{wxclipboard}.
52
03ab016d 53\membersection{wxBitmapDataObject::SetBitmap}\label{wxbitmapdataobjectsetbitmap}
ab272c0b
RR
54
55\func{virtual void}{SetBitmap}{\param{const wxBitmap\& }{bitmap}}
56
717a57c2
VZ
57Sets the bitmap associated with the data object. This method is called when the
58data object receives data. Usually there will be no reason to override this
59function.
ab272c0b 60