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 \wxheading{Virtual functions to override}
  11
  12 This class may be used as is, but
  13 \helpref{GetBitmap}{wxbitmapdataobjectgetbitmap} may be overridden to increase
  14 efficiency.
  15
  16 \wxheading{Derived from}
  17
  18 \helpref{wxDataObjectSimple}{wxdataobjectsimple}\\
  19 \helpref{wxDataObject}{wxdataobject}
  20
  21 \wxheading{Include files}
  22
  23 <wx/dataobj.h>
  24
  25 \wxheading{See also}
  26
  27 \helpref{Clipboard and drag and drop overview}{wxclipboardonfigoverview},
  28 \helpref{wxDataObject}{wxdataobject},
  29 \helpref{wxDataObjectSimple}{wxdataobjectsimple},
  30 \helpref{wxFileDataObject}{wxfiledataobject},
  31 \helpref{wxTextDataObject}{wxtextdataobject},
  32 \helpref{wxDataObject}{wxdataobject}
  33
  34 \func{}{wxBitmapDataObject}{\param{const wxBitmap\& }{bitmap = wxNullBitmap}}
  35
  36 Constructor, optionally passing a bitmap (otherwise use
  37 \helpref{SetBitmap}{wxbitmapdataobjectsetbitmap} later)
  38
  39 \membersection{wxBitmapDataObject::GetBitmap}\label{wxbitmapdataobjectgettext}
  40
  41 \constfunc{virtual wxBitmap}{GetBitmap}{\void}
  42
  43 Returns the bitmap associated with the data object. You may wish to override
  44 this method when offering data on-demand, but this is not required by
  45 wxWindows' internals. Use this method to get data in bitmap form from
  46 the \helpref{wxClipboard}{wxclipboard}.
  47
  48 \membersection{wxBitmapDataObject::SetBitmap}\label{wxbitmapdataobjectsetbitmap}
  49
  50 \func{virtual void}{SetBitmap}{\param{const wxBitmap\& }{bitmap}}
  51
  52 Sets the bitmap associated with the data object. This method is called when the
  53 data object receives data. Usually there will be no reason to override this
  54 function.
  55