docs/latex/wx/bmpdatob.tex

   1 \section{\class{wxBitmapDataObject}}\label{wxbitmapdataobject}
   2
   3 wxBitmapDataObject is a specialization of wxDataObject for bitmap data. It can
   4 be used without change to paste data into the
   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.
   9
  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
  15 \wxheading{Virtual functions to override}
  16
  17 This class may be used as is, but
  18 \helpref{GetBitmap}{wxbitmapdataobjectgetbitmap} may be overridden to increase
  19 efficiency.
  20
  21 \wxheading{Derived from}
  22
  23 \helpref{wxDataObjectSimple}{wxdataobjectsimple}\\
  24 \helpref{wxDataObject}{wxdataobject}
  25
  26 \wxheading{Include files}
  27
  28 <wx/dataobj.h>
  29
  30 \wxheading{See also}
  31
  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},
  37 \helpref{wxDataObject}{wxdataobject}
  38
  39 \func{}{wxBitmapDataObject}{\param{const wxBitmap\& }{bitmap = wxNullBitmap}}
  40
  41 Constructor, optionally passing a bitmap (otherwise use
  42 \helpref{SetBitmap}{wxbitmapdataobjectsetbitmap} later).
  43
  44 \membersection{wxBitmapDataObject::GetBitmap}\label{wxbitmapdataobjectgetbitmap}
  45
  46 \constfunc{virtual wxBitmap}{GetBitmap}{\void}
  47
  48 Returns the bitmap associated with the data object. You may wish to override
  49 this method when offering data on-demand, but this is not required by
  50 wxWidgets' internals. Use this method to get data in bitmap form from
  51 the \helpref{wxClipboard}{wxclipboard}.
  52
  53 \membersection{wxBitmapDataObject::SetBitmap}\label{wxbitmapdataobjectsetbitmap}
  54
  55 \func{virtual void}{SetBitmap}{\param{const wxBitmap\& }{bitmap}}
  56
  57 Sets the bitmap associated with the data object. This method is called when the
  58 data object receives data. Usually there will be no reason to override this
  59 function.
  60