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

FreeBSD Manual Pages

  
 
  

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

NAME
       wxBitmapButton -	Functions for wxBitmapButton class

DESCRIPTION
       A bitmap	button is a control that contains a bitmap.

       Notice  that  since  wxWidgets 2.9.1 bitmap display is supported	by the
       base wxButton class itself and the only tiny advantage  of  using  this
       class  is  that it allows specifying the	bitmap in its constructor, un-
       like wxButton. Please see the base class	documentation for more	infor-
       mation about images support in wxButton.

       Styles

       This class supports the following styles:

       See: wxButton

       This  class is derived (and can use functions) from: wxButton wxControl
       wxWindow	wxEvtHandler

       wxWidgets docs: wxBitmapButton

EVENTS
       Event types emitted from	this class: command_button_clicked

DATA TYPES
       wxBitmapButton()	= wx:wx_object()

EXPORTS
       new() ->	wxBitmapButton()

	      Default ctor.

       new(Parent, Id, Bitmap) -> wxBitmapButton()

	      Types:

		 Parent	= wxWindow:wxWindow()
		 Id = integer()
		 Bitmap	= wxBitmap:wxBitmap()

       new(Parent, Id, Bitmap, Options :: [Option]) -> wxBitmapButton()

	      Types:

		 Parent	= wxWindow:wxWindow()
		 Id = integer()
		 Bitmap	= wxBitmap:wxBitmap()
		 Option	=
		     {pos, {X :: integer(), Y :: integer()}} |
		     {size, {W :: integer(), H :: integer()}} |
		     {style, integer()}	|
		     {validator, wx:wx_object()}

	      Constructor, creating and	showing	a button.

	      Remark: The bitmap parameter is normally	the  only  bitmap  you
	      need to provide, and wxWidgets will draw the button correctly in
	      its different states. If you want	more control, call any of  the
	      functions	 SetBitmapPressed()  (not  implemented	in wx),	wxBut-
	      ton:setBitmapFocus/2, wxButton:setBitmapDisabled/2.

	      See: create/5, wxValidator (not implemented in wx)

       create(This, Parent, Id,	Bitmap)	-> boolean()

	      Types:

		 This =	wxBitmapButton()
		 Parent	= wxWindow:wxWindow()
		 Id = integer()
		 Bitmap	= wxBitmap:wxBitmap()

       create(This, Parent, Id,	Bitmap,	Options	:: [Option]) ->	boolean()

	      Types:

		 This =	wxBitmapButton()
		 Parent	= wxWindow:wxWindow()
		 Id = integer()
		 Bitmap	= wxBitmap:wxBitmap()
		 Option	=
		     {pos, {X :: integer(), Y :: integer()}} |
		     {size, {W :: integer(), H :: integer()}} |
		     {style, integer()}	|
		     {validator, wx:wx_object()}

	      Button creation function for two-step creation.

	      For more details,	see new/4.

       newCloseButton(Parent, Winid) ->	wxBitmapButton()

	      Types:

		 Parent	= wxWindow:wxWindow()
		 Winid = integer()

	      Helper function creating a standard-looking "Close" button.

	      To get the best results, platform-specific code may need	to  be
	      used  to	create	a  small,  title bar-like "Close" button. This
	      function is provided to avoid the	need to	test for  the  current
	      platform and creates the button with as native look as possible.

	      Return: The new button.

	      Since: 2.9.5

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

	      Destroys the object.

wxWidgets team.			   wx 2.1.1		     wxBitmapButton(3)
NAME | DESCRIPTION | EVENTS | DATA TYPES | EXPORTS

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

home | help