1wxBitmapButton(3)          Erlang Module Definition          wxBitmapButton(3)
2
3
4

NAME

6       wxBitmapButton - Functions for wxBitmapButton class
7

DESCRIPTION

9       A bitmap button is a control that contains a bitmap.
10
11       Notice  that  since  wxWidgets 2.9.1 bitmap display is supported by the
12       base wxButton class itself and the only tiny advantage  of  using  this
13       class  is  that it allows specifying the bitmap in its constructor, un‐
14       like wxButton. Please see the base class documentation for more  infor‐
15       mation about images support in wxButton.
16
17       Styles
18
19       This class supports the following styles:
20
21       See: wxButton
22
23       This  class is derived (and can use functions) from: wxButton wxControl
24       wxWindow wxEvtHandler
25
26       wxWidgets docs: wxBitmapButton
27

EVENTS

29       Event types emitted from this class: command_button_clicked
30

DATA TYPES

32       wxBitmapButton() = wx:wx_object()
33

EXPORTS

35       new() -> wxBitmapButton()
36
37              Default ctor.
38
39       new(Parent, Id, Bitmap) -> wxBitmapButton()
40
41              Types:
42
43                 Parent = wxWindow:wxWindow()
44                 Id = integer()
45                 Bitmap = wxBitmap:wxBitmap()
46
47       new(Parent, Id, Bitmap, Options :: [Option]) -> wxBitmapButton()
48
49              Types:
50
51                 Parent = wxWindow:wxWindow()
52                 Id = integer()
53                 Bitmap = wxBitmap:wxBitmap()
54                 Option =
55                     {pos, {X :: integer(), Y :: integer()}} |
56                     {size, {W :: integer(), H :: integer()}} |
57                     {style, integer()} |
58                     {validator, wx:wx_object()}
59
60              Constructor, creating and showing a button.
61
62              Remark: The bitmap parameter is normally  the  only  bitmap  you
63              need to provide, and wxWidgets will draw the button correctly in
64              its different states. If you want more control, call any of  the
65              functions  SetBitmapPressed()  (not  implemented  in wx), wxBut‐
66              ton:setBitmapFocus/2, wxButton:setBitmapDisabled/2.
67
68              See: create/5, wxValidator (not implemented in wx)
69
70       create(This, Parent, Id, Bitmap) -> boolean()
71
72              Types:
73
74                 This = wxBitmapButton()
75                 Parent = wxWindow:wxWindow()
76                 Id = integer()
77                 Bitmap = wxBitmap:wxBitmap()
78
79       create(This, Parent, Id, Bitmap, Options :: [Option]) -> boolean()
80
81              Types:
82
83                 This = wxBitmapButton()
84                 Parent = wxWindow:wxWindow()
85                 Id = integer()
86                 Bitmap = wxBitmap:wxBitmap()
87                 Option =
88                     {pos, {X :: integer(), Y :: integer()}} |
89                     {size, {W :: integer(), H :: integer()}} |
90                     {style, integer()} |
91                     {validator, wx:wx_object()}
92
93              Button creation function for two-step creation.
94
95              For more details, see new/4.
96
97       newCloseButton(Parent, Winid) -> wxBitmapButton()
98
99              Types:
100
101                 Parent = wxWindow:wxWindow()
102                 Winid = integer()
103
104              Helper function creating a standard-looking "Close" button.
105
106              To get the best results, platform-specific code may need  to  be
107              used  to  create  a  small,  title bar-like "Close" button. This
108              function is provided to avoid the need to test for  the  current
109              platform and creates the button with as native look as possible.
110
111              Return: The new button.
112
113              Since: 2.9.5
114
115       destroy(This :: wxBitmapButton()) -> ok
116
117              Destroys the object.
118
119
120
121wxWidgets team.                    wx 2.3.1                  wxBitmapButton(3)