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

NAME

6       wxPickerBase - Functions for wxPickerBase class
7

DESCRIPTION

9       Base  abstract  class  for  all pickers which support an auxiliary text
10       control.
11
12       This class handles all positioning and sizing of the text control  like
13       a  an horizontal wxBoxSizer would do, with the text control on the left
14       of the picker button.
15
16       The proportion (see wxSizer documentation for more info  about  propor‐
17       tion  values)  of  the  picker control defaults to 1 when there isn't a
18       text control associated (see wxPB_USE_TEXTCTRL style) and to  0  other‐
19       wise.
20
21       Styles
22
23       This class supports the following styles:
24
25       See: wxColourPickerCtrl
26
27       This  class is derived (and can use functions) from: wxControl wxWindow
28       wxEvtHandler
29
30       wxWidgets docs: wxPickerBase
31

DATA TYPES

33       wxPickerBase() = wx:wx_object()
34

EXPORTS

36       setInternalMargin(This, Margin) -> ok
37
38              Types:
39
40                 This = wxPickerBase()
41                 Margin = integer()
42
43              Sets the margin (in pixel) between the picker and the text  con‐
44              trol.
45
46              This function can be used only when hasTextCtrl/1 returns true.
47
48       getInternalMargin(This) -> integer()
49
50              Types:
51
52                 This = wxPickerBase()
53
54              Returns  the  margin  (in pixel) between the picker and the text
55              control.
56
57              This function can be used only when hasTextCtrl/1 returns true.
58
59       setTextCtrlProportion(This, Prop) -> ok
60
61              Types:
62
63                 This = wxPickerBase()
64                 Prop = integer()
65
66              Sets the proportion value of the text control.
67
68              Look at the detailed description of wxPickerBase for more info.
69
70              This function can be used only when hasTextCtrl/1 returns true.
71
72       setPickerCtrlProportion(This, Prop) -> ok
73
74              Types:
75
76                 This = wxPickerBase()
77                 Prop = integer()
78
79              Sets the proportion value of the picker.
80
81              Look at the detailed description of wxPickerBase for more info.
82
83       getTextCtrlProportion(This) -> integer()
84
85              Types:
86
87                 This = wxPickerBase()
88
89              Returns the proportion value of the text control.
90
91              This function can be used only when hasTextCtrl/1 returns true.
92
93       getPickerCtrlProportion(This) -> integer()
94
95              Types:
96
97                 This = wxPickerBase()
98
99              Returns the proportion value of the picker.
100
101       hasTextCtrl(This) -> boolean()
102
103              Types:
104
105                 This = wxPickerBase()
106
107              Returns true if this window has a valid text  control  (i.e.  if
108              the  wxPB_USE_TEXTCTRL  style  was given when creating this con‐
109              trol).
110
111       getTextCtrl(This) -> wxTextCtrl:wxTextCtrl()
112
113              Types:
114
115                 This = wxPickerBase()
116
117              Returns a pointer to the text control handled by this window  or
118              NULL  if the wxPB_USE_TEXTCTRL style was not specified when this
119              control was created.
120
121              Remark: The contents of the text control  could  be  an  invalid
122              representation  of  the  entity  which can be chosen through the
123              picker (e.g. when the user enters an invalid colour  syntax  be‐
124              cause of a typo). Thus you should never parse the content of the
125              textctrl to get the user's input; rather use  the  derived-class
126              getter   (e.g.   wxColourPickerCtrl:getColour/1,  wxFilePickerC‐
127              trl:getPath/1, etc).
128
129       isTextCtrlGrowable(This) -> boolean()
130
131              Types:
132
133                 This = wxPickerBase()
134
135              Returns true if the text control is growable.
136
137              This function can be used only when hasTextCtrl/1 returns true.
138
139       setPickerCtrlGrowable(This) -> ok
140
141              Types:
142
143                 This = wxPickerBase()
144
145       setPickerCtrlGrowable(This, Options :: [Option]) -> ok
146
147              Types:
148
149                 This = wxPickerBase()
150                 Option = {grow, boolean()}
151
152              Sets the picker control as growable when grow is true.
153
154       setTextCtrlGrowable(This) -> ok
155
156              Types:
157
158                 This = wxPickerBase()
159
160       setTextCtrlGrowable(This, Options :: [Option]) -> ok
161
162              Types:
163
164                 This = wxPickerBase()
165                 Option = {grow, boolean()}
166
167              Sets the text control as growable when grow is true.
168
169              This function can be used only when hasTextCtrl/1 returns true.
170
171       isPickerCtrlGrowable(This) -> boolean()
172
173              Types:
174
175                 This = wxPickerBase()
176
177              Returns true if the picker control is growable.
178
179
180
181wxWidgets team.                    wx 2.3.1                    wxPickerBase(3)