]>
Commit | Line | Data |
---|---|---|
dface61c JS |
1 | \section{\class{wxBitmapDataObject}}\label{wxbitmapdataobject} |
2 | ||
717a57c2 | 3 | wxBitmapDataObject is a specialization of wxDataObject for bitmap data. It can |
fa482912 | 4 | be used without change to paste data into the |
717a57c2 VZ |
5 | \helpref{wxClipboard}{wxclipboard} or a \helpref{wxDropSource}{wxdropsource}. A |
6 | user may wish to derive a new class from this class for providing a bitmap | |
7 | on-demand in order to minimize memory consumption when offering data in several | |
8 | formats, such as a bitmap and GIF. | |
ab272c0b | 9 | |
b1462dfa RD |
10 | \pythonnote{If you wish to create a derived wxBitmapDataObject class in |
11 | wxPython you should derive the class from wxPyBitmapDataObject | |
12 | in order to get Python-aware capabilities for the various virtual | |
13 | methods.} | |
14 | ||
717a57c2 VZ |
15 | \wxheading{Virtual functions to override} |
16 | ||
fa482912 | 17 | This class may be used as is, but |
717a57c2 VZ |
18 | \helpref{GetBitmap}{wxbitmapdataobjectgetbitmap} may be overridden to increase |
19 | efficiency. | |
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 | ||
a7af285d VZ |
30 | \wxheading{Library} |
31 | ||
32 | \helpref{wxCore}{librarieslist} | |
33 | ||
dface61c JS |
34 | \wxheading{See also} |
35 | ||
fa482912 JS |
36 | \helpref{Clipboard and drag and drop overview}{wxdndoverview}, |
37 | \helpref{wxDataObject}{wxdataobject}, | |
38 | \helpref{wxDataObjectSimple}{wxdataobjectsimple}, | |
39 | \helpref{wxFileDataObject}{wxfiledataobject}, | |
40 | \helpref{wxTextDataObject}{wxtextdataobject}, | |
ab272c0b | 41 | \helpref{wxDataObject}{wxdataobject} |
dface61c | 42 | |
717a57c2 | 43 | \func{}{wxBitmapDataObject}{\param{const wxBitmap\& }{bitmap = wxNullBitmap}} |
ab272c0b | 44 | |
fa482912 JS |
45 | Constructor, optionally passing a bitmap (otherwise use |
46 | \helpref{SetBitmap}{wxbitmapdataobjectsetbitmap} later). | |
ab272c0b | 47 | |
1fb3eae5 | 48 | \membersection{wxBitmapDataObject::GetBitmap}\label{wxbitmapdataobjectgetbitmap} |
dface61c JS |
49 | |
50 | \constfunc{virtual wxBitmap}{GetBitmap}{\void} | |
51 | ||
ab272c0b RR |
52 | Returns the bitmap associated with the data object. You may wish to override |
53 | this method when offering data on-demand, but this is not required by | |
fc2171bd | 54 | wxWidgets' internals. Use this method to get data in bitmap form from |
ab272c0b RR |
55 | the \helpref{wxClipboard}{wxclipboard}. |
56 | ||
03ab016d | 57 | \membersection{wxBitmapDataObject::SetBitmap}\label{wxbitmapdataobjectsetbitmap} |
ab272c0b RR |
58 | |
59 | \func{virtual void}{SetBitmap}{\param{const wxBitmap\& }{bitmap}} | |
60 | ||
717a57c2 VZ |
61 | Sets the bitmap associated with the data object. This method is called when the |
62 | data object receives data. Usually there will be no reason to override this | |
63 | function. | |
ab272c0b | 64 |