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

NAME

6       wxStyledTextEvent - Functions for wxStyledTextEvent class
7

DESCRIPTION

9       The type of events sent from wxStyledTextCtrl.
10
11       This  class is derived (and can use functions) from: wxCommandEvent wx‐
12       Event
13
14       wxWidgets docs: wxStyledTextEvent
15

EVENTS

17       Use wxEvtHandler:connect/3 with wxStyledTextEventType to  subscribe  to
18       events of this type.
19

DATA TYPES

21       wxStyledTextEvent() = wx:wx_object()
22
23       wxStyledText() =
24           #wxStyledText{type =
25                             wxStyledTextEvent:wxStyledTextEventType(),
26                         position = integer(),
27                         key = integer(),
28                         modifiers = integer(),
29                         modificationType = integer(),
30                         text = unicode:chardata(),
31                         length = integer(),
32                         linesAdded = integer(),
33                         line = integer(),
34                         foldLevelNow = integer(),
35                         foldLevelPrev = integer(),
36                         margin = integer(),
37                         message = integer(),
38                         wParam = integer(),
39                         lParam = integer(),
40                         listType = integer(),
41                         x = integer(),
42                         y = integer(),
43                         dragText = unicode:chardata(),
44                         dragAllowMove = boolean(),
45                         dragResult = wx:wx_enum()}
46
47       wxStyledTextEventType() =
48           stc_autocomp_cancelled | stc_autocomp_char_deleted |
49           stc_autocomp_selection | stc_calltip_click | stc_change |
50           stc_charadded | stc_do_drop | stc_doubleclick |
51           stc_drag_over | stc_dwellend | stc_dwellstart |
52           stc_hotspot_click | stc_hotspot_dclick |
53           stc_hotspot_release_click | stc_indicator_click |
54           stc_indicator_release | stc_macrorecord | stc_marginclick |
55           stc_modified | stc_needshown | stc_painted |
56           stc_romodifyattempt | stc_savepointleft |
57           stc_savepointreached | stc_start_drag | stc_styleneeded |
58           stc_updateui | stc_userlistselection | stc_zoom
59

EXPORTS

61       getPosition(This) -> integer()
62
63              Types:
64
65                 This = wxStyledTextEvent()
66
67              Returns the zero-based text position associated this event.
68
69              This method is valid for the following event types:
70
71       getKey(This) -> integer()
72
73              Types:
74
75                 This = wxStyledTextEvent()
76
77              Returns the key code of the key that generated this event.
78
79              This method is valid for the following event types:
80
81       getModifiers(This) -> integer()
82
83              Types:
84
85                 This = wxStyledTextEvent()
86
87              Returns  the  modifiers of the key press or mouse click for this
88              event.
89
90              The returned value is a bit list that may contain one or more of
91              the following values:
92
93              In  addition,  the  value  can  be  checked  for  equality  with
94              ?wxSTC_KEYMOD_NORM to test if no modifiers are present.
95
96              This method is valid for the following event types:
97
98       getModificationType(This) -> integer()
99
100              Types:
101
102                 This = wxStyledTextEvent()
103
104              Returns the modification type for this event.
105
106              The modification type is a bit list that  describes  the  change
107              that  generated  this  event.  It may contain one or more of the
108              following values:
109
110              This method is valid for wxEVT_STC_MODIFIED events.
111
112       getText(This) -> unicode:charlist()
113
114              Types:
115
116                 This = wxStyledTextEvent()
117
118              Deprecated: Use wxCommandEvent:getString/1 instead.
119
120       getLength(This) -> integer()
121
122              Types:
123
124                 This = wxStyledTextEvent()
125
126              Returns the length (number of characters) of this event.
127
128              This method is valid for wxEVT_STC_MODIFIED and  wxEVT_STC_NEED‐
129              SHOWN events.
130
131       getLinesAdded(This) -> integer()
132
133              Types:
134
135                 This = wxStyledTextEvent()
136
137              Returns the number of lines added or deleted with this event.
138
139              This  method is valid for wxEVT_STC_MODIFIED events when the re‐
140              sult of getModificationType/1 includes ?wxSTC_MOD_INSERTTEXT  or
141              ?wxSTC_MOD_DELETETEXT.
142
143       getLine(This) -> integer()
144
145              Types:
146
147                 This = wxStyledTextEvent()
148
149              Returns zero-based line number for this event.
150
151              This   method   is   valid  for  wxEVT_STC_DOUBLECLICK  and  wx‐
152              EVT_STC_MODIFIED events.
153
154       getFoldLevelNow(This) -> integer()
155
156              Types:
157
158                 This = wxStyledTextEvent()
159
160              Returns the current fold level for the line.
161
162              This method is valid for wxEVT_STC_MODIFIED events when the  re‐
163              sult of getModificationType/1 includes ?wxSTC_MOD_CHANGEFOLD.
164
165       getFoldLevelPrev(This) -> integer()
166
167              Types:
168
169                 This = wxStyledTextEvent()
170
171              Returns previous fold level for the line.
172
173              This  method is valid for wxEVT_STC_MODIFIED events when the re‐
174              sult of getModificationType/1 includes ?wxSTC_MOD_CHANGEFOLD.
175
176       getMargin(This) -> integer()
177
178              Types:
179
180                 This = wxStyledTextEvent()
181
182              Returns the zero-based index of the margin that  generated  this
183              event.
184
185              This   method   is   valid  for  wxEVT_STC_MARGINCLICK  and  wx‐
186              EVT_STC_MARGIN_RIGHT_CLICK events.
187
188       getMessage(This) -> integer()
189
190              Types:
191
192                 This = wxStyledTextEvent()
193
194              Returns a message number while a macro is being recorded.
195
196              Many of the  wxStyledTextCtrl  methods  such  as  wxStyledTextC‐
197              trl:insertText/3 and wxStyledTextCtrl:paste/1 have an event num‐
198              ber associated with them. This method returns that number  while
199              a  macro  is being recorded so that the macro can be played back
200              later.
201
202              This method is valid for wxEVT_STC_MACRORECORD events.
203
204       getWParam(This) -> integer()
205
206              Types:
207
208                 This = wxStyledTextEvent()
209
210              Returns value of the WParam field for this event.
211
212              This method is valid for wxEVT_STC_MACRORECORD events.
213
214       getLParam(This) -> integer()
215
216              Types:
217
218                 This = wxStyledTextEvent()
219
220              Returns the value of the LParam field for this event.
221
222              This method is valid for wxEVT_STC_MACRORECORD events.
223
224       getListType(This) -> integer()
225
226              Types:
227
228                 This = wxStyledTextEvent()
229
230              Returns the list type for this event.
231
232              The list type is an integer passed to a list when it is  created
233              with  the wxStyledTextCtrl:userListShow/3 method and can be used
234              to distinguish lists if more than one is used.
235
236              This method is valid for wxEVT_STC_AUTOCOMP_SELECTION_CHANGE and
237              wxEVT_STC_USERLISTSELECTION events.
238
239       getX(This) -> integer()
240
241              Types:
242
243                 This = wxStyledTextEvent()
244
245              Returns the X coordinate of the mouse for this event.
246
247              This method is valid for the following event types:
248
249       getY(This) -> integer()
250
251              Types:
252
253                 This = wxStyledTextEvent()
254
255              Returns the Y coordinate of the mouse for this event.
256
257              This method is valid for the following event types:
258
259       getDragText(This) -> unicode:charlist()
260
261              Types:
262
263                 This = wxStyledTextEvent()
264
265              Deprecated: Use wxCommandEvent:getString/1 instead.
266
267       getDragAllowMove(This) -> boolean()
268
269              Types:
270
271                 This = wxStyledTextEvent()
272
273       getDragResult(This) -> wx:wx_enum()
274
275              Types:
276
277                 This = wxStyledTextEvent()
278
279              Returns drag result for this event.
280
281              This   method   is   valid   for   wxEVT_STC_DRAG_OVER  and  wx‐
282              EVT_STC_DO_DROP events.
283
284       getShift(This) -> boolean()
285
286              Types:
287
288                 This = wxStyledTextEvent()
289
290              Returns true if the Shift key is pressed.
291
292              This method is valid for the following event types:
293
294       getControl(This) -> boolean()
295
296              Types:
297
298                 This = wxStyledTextEvent()
299
300              Returns true if the Control key is pressed.
301
302              This method is valid for the following event types:
303
304       getAlt(This) -> boolean()
305
306              Types:
307
308                 This = wxStyledTextEvent()
309
310              Returns true if the Alt key is pressed.
311
312              This method is valid for the following event types:
313
314
315
316wxWidgets team.                     wx 2.1                wxStyledTextEvent(3)