Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
wxBitmapDataObject(3)	   Erlang Module Definition	 wxBitmapDataObject(3)

NAME
       wxBitmapDataObject - Functions for wxBitmapDataObject class

DESCRIPTION
       wxBitmapDataObject is a specialization of wxDataObject for bitmap data.
       It can be used without change to	paste data into	the wxClipboard	 or  a
       wxDropSource  (not  implemented in wx). A user may wish to derive a new
       class from this class for providing a bitmap on-demand in order to min-
       imize memory consumption	when offering data in several formats, such as
       a bitmap	and GIF.

       This class may be used as is, but getBitmap/1 may be overridden to  in-
       crease efficiency.

       See: Overview dnd, wxDataObject,	wxDataObjectSimple (not	implemented in
       wx), wxFileDataObject, wxTextDataObject,	wxDataObject

       This class is derived (and can use functions) from: wxDataObject

       wxWidgets docs: wxBitmapDataObject

DATA TYPES
       wxBitmapDataObject() = wx:wx_object()

EXPORTS
       new() ->	wxBitmapDataObject()

       new(Options :: [Option])	-> wxBitmapDataObject()

       new(Bitmap) -> wxBitmapDataObject()

	      Types:

		 Bitmap	= wxBitmap:wxBitmap()

	      Constructor, optionally passing a	 bitmap	 (otherwise  use  set-
	      Bitmap/2 later).

       getBitmap(This) -> wxBitmap:wxBitmap()

	      Types:

		 This =	wxBitmapDataObject()

	      Returns the bitmap associated with the data object.

	      You  may	wish to	override this method when offering data	on-de-
	      mand, but	this is	not required by	wxWidgets' internals. Use this
	      method to	get data in bitmap form	from the wxClipboard.

       setBitmap(This, Bitmap) -> ok

	      Types:

		 This =	wxBitmapDataObject()
		 Bitmap	= wxBitmap:wxBitmap()

	      Sets the bitmap associated with the data object.

	      This  method  is called when the data object receives data. Usu-
	      ally there will be no reason to override this function.

       destroy(This :: wxBitmapDataObject()) ->	ok

	      Destroys the object.

wxWidgets team.			   wx 2.1.1		 wxBitmapDataObject(3)

NAME | DESCRIPTION | DATA TYPES | EXPORTS

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=wxBitmapDataObject&sektion=3&manpath=FreeBSD+13.1-RELEASE+and+Ports>

home | help