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

NAME

6       wxStyledTextCtrl - Functions for wxStyledTextCtrl class
7

DESCRIPTION

9       A  wxWidgets implementation of the Scintilla source code editing compo‐
10       nent.
11
12       As well as features found in standard text  editing  components,  Scin‐
13       tilla  includes  features  especially useful when editing and debugging
14       source code. These include support for syntax  styling,  error  indica‐
15       tors, code completion and call tips.
16
17       The  selection  margin can contain markers like those used in debuggers
18       to indicate breakpoints and the current line. Styling choices are  more
19       open  than  with  many editors, allowing the use of proportional fonts,
20       bold and italics, multiple foreground and background colours and multi‐
21       ple fonts.
22
23       wxStyledTextCtrl  is  a  1  to  1 mapping of "raw" scintilla interface,
24       whose  documentation  can   be   found   in   the   Scintilla   website
25       (http://www.scintilla.org/).
26
27       Please  see  wxStyledTextEvent for the documentation of all event types
28       you can use with wxStyledTextCtrl.
29
30       Index of the member groups
31
32       Links for quick access to the various  categories  of  wxStyledTextCtrl
33       functions:
34
35       See: wxStyledTextEvent
36
37       This  class is derived (and can use functions) from: wxControl wxWindow
38       wxEvtHandler
39
40       wxWidgets docs: wxStyledTextCtrl
41

DATA TYPES

43       wxStyledTextCtrl() = wx:wx_object()
44

EXPORTS

46       new() -> wxStyledTextCtrl()
47
48              Default ctor.
49
50       new(Parent) -> wxStyledTextCtrl()
51
52              Types:
53
54                 Parent = wxWindow:wxWindow()
55
56       new(Parent, Options :: [Option]) -> wxStyledTextCtrl()
57
58              Types:
59
60                 Parent = wxWindow:wxWindow()
61                 Option =
62                     {id, integer()} |
63                     {pos, {X :: integer(), Y :: integer()}} |
64                     {size, {W :: integer(), H :: integer()}} |
65                     {style, integer()}
66
67              Ctor.
68
69       destroy(This :: wxStyledTextCtrl()) -> ok
70
71              Destructor.
72
73       create(This, Parent) -> boolean()
74
75              Types:
76
77                 This = wxStyledTextCtrl()
78                 Parent = wxWindow:wxWindow()
79
80       create(This, Parent, Options :: [Option]) -> boolean()
81
82              Types:
83
84                 This = wxStyledTextCtrl()
85                 Parent = wxWindow:wxWindow()
86                 Option =
87                     {id, integer()} |
88                     {pos, {X :: integer(), Y :: integer()}} |
89                     {size, {W :: integer(), H :: integer()}} |
90                     {style, integer()}
91
92              Create the UI elements for a STC that was created with  the  de‐
93              fault ctor.
94
95              (For 2-phase create.)
96
97       addText(This, Text) -> ok
98
99              Types:
100
101                 This = wxStyledTextCtrl()
102                 Text = unicode:chardata()
103
104              Add text to the document at current position.
105
106       insertText(This, Pos, Text) -> ok
107
108              Types:
109
110                 This = wxStyledTextCtrl()
111                 Pos = integer()
112                 Text = unicode:chardata()
113
114              Insert string at a position.
115
116       clearAll(This) -> ok
117
118              Types:
119
120                 This = wxStyledTextCtrl()
121
122              Delete all text in the document.
123
124       clearDocumentStyle(This) -> ok
125
126              Types:
127
128                 This = wxStyledTextCtrl()
129
130              Set all style bytes to 0, remove all folding information.
131
132       getLength(This) -> integer()
133
134              Types:
135
136                 This = wxStyledTextCtrl()
137
138              Returns the number of bytes in the document.
139
140       getCharAt(This, Pos) -> integer()
141
142              Types:
143
144                 This = wxStyledTextCtrl()
145                 Pos = integer()
146
147              Returns the character byte at the position.
148
149       getCurrentPos(This) -> integer()
150
151              Types:
152
153                 This = wxStyledTextCtrl()
154
155              Returns the position of the caret.
156
157       getAnchor(This) -> integer()
158
159              Types:
160
161                 This = wxStyledTextCtrl()
162
163              Returns the position of the opposite end of the selection to the
164              caret.
165
166       getStyleAt(This, Pos) -> integer()
167
168              Types:
169
170                 This = wxStyledTextCtrl()
171                 Pos = integer()
172
173              Returns the style byte at the position.
174
175       redo(This) -> ok
176
177              Types:
178
179                 This = wxStyledTextCtrl()
180
181              Redoes the next action on the undo history.
182
183       setUndoCollection(This, CollectUndo) -> ok
184
185              Types:
186
187                 This = wxStyledTextCtrl()
188                 CollectUndo = boolean()
189
190              Choose between collecting actions into the undo history and dis‐
191              carding them.
192
193       selectAll(This) -> ok
194
195              Types:
196
197                 This = wxStyledTextCtrl()
198
199              Select all the text in the document.
200
201       setSavePoint(This) -> ok
202
203              Types:
204
205                 This = wxStyledTextCtrl()
206
207              Remember  the  current position in the undo history as the posi‐
208              tion at which the document was saved.
209
210       canRedo(This) -> boolean()
211
212              Types:
213
214                 This = wxStyledTextCtrl()
215
216              Are there any redoable actions in the undo history?
217
218       markerLineFromHandle(This, MarkerHandle) -> integer()
219
220              Types:
221
222                 This = wxStyledTextCtrl()
223                 MarkerHandle = integer()
224
225              Retrieve the line number at which a  particular  marker  is  lo‐
226              cated.
227
228       markerDeleteHandle(This, MarkerHandle) -> ok
229
230              Types:
231
232                 This = wxStyledTextCtrl()
233                 MarkerHandle = integer()
234
235              Delete a marker.
236
237       getUndoCollection(This) -> boolean()
238
239              Types:
240
241                 This = wxStyledTextCtrl()
242
243              Is undo history being collected?
244
245       getViewWhiteSpace(This) -> integer()
246
247              Types:
248
249                 This = wxStyledTextCtrl()
250
251              Are  white  space  characters  currently visible? Returns one of
252              wxSTC_WS_* constants.
253
254       setViewWhiteSpace(This, ViewWS) -> ok
255
256              Types:
257
258                 This = wxStyledTextCtrl()
259                 ViewWS = integer()
260
261              Make white space characters invisible, always visible or visible
262              outside indentation.
263
264              The input should be one of the ?wxSTC_WS_* constants.
265
266       positionFromPoint(This, Pt) -> integer()
267
268              Types:
269
270                 This = wxStyledTextCtrl()
271                 Pt = {X :: integer(), Y :: integer()}
272
273              Find the position from a point within the window.
274
275       positionFromPointClose(This, X, Y) -> integer()
276
277              Types:
278
279                 This = wxStyledTextCtrl()
280                 X = Y = integer()
281
282              Find  the  position  from  a  point within the window but return
283              wxSTC_INVALID_POSITION if not close to text.
284
285       gotoLine(This, Line) -> ok
286
287              Types:
288
289                 This = wxStyledTextCtrl()
290                 Line = integer()
291
292              Set caret to start of a line and ensure it is visible.
293
294       gotoPos(This, Caret) -> ok
295
296              Types:
297
298                 This = wxStyledTextCtrl()
299                 Caret = integer()
300
301              Set caret to a position and ensure it is visible.
302
303       setAnchor(This, Anchor) -> ok
304
305              Types:
306
307                 This = wxStyledTextCtrl()
308                 Anchor = integer()
309
310              Set the selection anchor to a position.
311
312              The anchor is the opposite end of the selection from the caret.
313
314       getCurLine(This) -> Result
315
316              Types:
317
318                 Result = {Res :: unicode:charlist(), LinePos :: integer()}
319                 This = wxStyledTextCtrl()
320
321              Retrieve the text of the line containing the caret.
322
323              linePos can optionally be passed in to receive the index of  the
324              caret on the line.
325
326       getEndStyled(This) -> integer()
327
328              Types:
329
330                 This = wxStyledTextCtrl()
331
332              Retrieve the position of the last correctly styled character.
333
334       convertEOLs(This, EolMode) -> ok
335
336              Types:
337
338                 This = wxStyledTextCtrl()
339                 EolMode = integer()
340
341              Convert all line endings in the document to one mode.
342
343       getEOLMode(This) -> integer()
344
345              Types:
346
347                 This = wxStyledTextCtrl()
348
349              Retrieve  the  current end of line mode - one of wxSTC_EOL_CRLF,
350              wxSTC_EOL_CR, or wxSTC_EOL_LF.
351
352       setEOLMode(This, EolMode) -> ok
353
354              Types:
355
356                 This = wxStyledTextCtrl()
357                 EolMode = integer()
358
359              Set the current end of line mode.
360
361              The input should be one of the ?wxSTC_EOL_* constants.
362
363       startStyling(This, Start) -> ok
364
365              Types:
366
367                 This = wxStyledTextCtrl()
368                 Start = integer()
369
370              Set the current styling position to start.
371
372       setStyling(This, Length, Style) -> ok
373
374              Types:
375
376                 This = wxStyledTextCtrl()
377                 Length = Style = integer()
378
379              Change style from current styling position for length characters
380              to  a  style and move the current styling position to after this
381              newly styled segment.
382
383       getBufferedDraw(This) -> boolean()
384
385              Types:
386
387                 This = wxStyledTextCtrl()
388
389              Is drawing done first into a buffer or direct to the screen?
390
391       setBufferedDraw(This, Buffered) -> ok
392
393              Types:
394
395                 This = wxStyledTextCtrl()
396                 Buffered = boolean()
397
398              If drawing is buffered then each line of text is  drawn  into  a
399              bitmap buffer before drawing it to the screen to avoid flicker.
400
401       setTabWidth(This, TabWidth) -> ok
402
403              Types:
404
405                 This = wxStyledTextCtrl()
406                 TabWidth = integer()
407
408              Change  the  visible size of a tab to be a multiple of the width
409              of a space character.
410
411       getTabWidth(This) -> integer()
412
413              Types:
414
415                 This = wxStyledTextCtrl()
416
417              Retrieve the visible size of a tab.
418
419       setCodePage(This, CodePage) -> ok
420
421              Types:
422
423                 This = wxStyledTextCtrl()
424                 CodePage = integer()
425
426              Set the code page used to interpret the bytes of the document as
427              characters.
428
429       markerDefine(This, MarkerNumber, MarkerSymbol) -> ok
430
431              Types:
432
433                 This = wxStyledTextCtrl()
434                 MarkerNumber = MarkerSymbol = integer()
435
436       markerDefine(This, MarkerNumber, MarkerSymbol,
437                    Options :: [Option]) ->
438                       ok
439
440              Types:
441
442                 This = wxStyledTextCtrl()
443                 MarkerNumber = MarkerSymbol = integer()
444                 Option =
445                     {foreground,      wx:wx_colour()}      |     {background,
446                 wx:wx_colour()}
447
448              Set the symbol used for a particular marker number, and  option‐
449              ally the fore and background colours.
450
451              The  second  argument  should  be  one of the ?wxSTC_MARK_* con‐
452              stants.
453
454       markerSetForeground(This, MarkerNumber, Fore) -> ok
455
456              Types:
457
458                 This = wxStyledTextCtrl()
459                 MarkerNumber = integer()
460                 Fore = wx:wx_colour()
461
462              Set the foreground colour used for a particular marker number.
463
464       markerSetBackground(This, MarkerNumber, Back) -> ok
465
466              Types:
467
468                 This = wxStyledTextCtrl()
469                 MarkerNumber = integer()
470                 Back = wx:wx_colour()
471
472              Set the background colour used for a particular marker number.
473
474       markerAdd(This, Line, MarkerNumber) -> integer()
475
476              Types:
477
478                 This = wxStyledTextCtrl()
479                 Line = MarkerNumber = integer()
480
481              Add a marker to a line, returning an ID which  can  be  used  to
482              find or delete the marker.
483
484       markerDelete(This, Line, MarkerNumber) -> ok
485
486              Types:
487
488                 This = wxStyledTextCtrl()
489                 Line = MarkerNumber = integer()
490
491              Delete a marker from a line.
492
493       markerDeleteAll(This, MarkerNumber) -> ok
494
495              Types:
496
497                 This = wxStyledTextCtrl()
498                 MarkerNumber = integer()
499
500              Delete all markers with a particular number from all lines.
501
502       markerGet(This, Line) -> integer()
503
504              Types:
505
506                 This = wxStyledTextCtrl()
507                 Line = integer()
508
509              Get a bit mask of all the markers set on a line.
510
511       markerNext(This, LineStart, MarkerMask) -> integer()
512
513              Types:
514
515                 This = wxStyledTextCtrl()
516                 LineStart = MarkerMask = integer()
517
518              Find  the next line at or after lineStart that includes a marker
519              in mask.
520
521              Return -1 when no more lines.
522
523       markerPrevious(This, LineStart, MarkerMask) -> integer()
524
525              Types:
526
527                 This = wxStyledTextCtrl()
528                 LineStart = MarkerMask = integer()
529
530              Find the previous line before lineStart that includes  a  marker
531              in mask.
532
533       markerDefineBitmap(This, MarkerNumber, Bmp) -> ok
534
535              Types:
536
537                 This = wxStyledTextCtrl()
538                 MarkerNumber = integer()
539                 Bmp = wxBitmap:wxBitmap()
540
541              Define a marker with a wxBitmap.
542
543       markerAddSet(This, Line, MarkerSet) -> ok
544
545              Types:
546
547                 This = wxStyledTextCtrl()
548                 Line = MarkerSet = integer()
549
550              Add a set of markers to a line.
551
552       markerSetAlpha(This, MarkerNumber, Alpha) -> ok
553
554              Types:
555
556                 This = wxStyledTextCtrl()
557                 MarkerNumber = Alpha = integer()
558
559              Set  the alpha used for a marker that is drawn in the text area,
560              not the margin.
561
562       setMarginType(This, Margin, MarginType) -> ok
563
564              Types:
565
566                 This = wxStyledTextCtrl()
567                 Margin = MarginType = integer()
568
569              Set a margin to be either numeric or symbolic.
570
571              The second argument should be one of  the  ?wxSTC_MARGIN_*  con‐
572              stants.
573
574       getMarginType(This, Margin) -> integer()
575
576              Types:
577
578                 This = wxStyledTextCtrl()
579                 Margin = integer()
580
581              Retrieve the type of a margin.
582
583              The return value will be one of the ?wxSTC_MARGIN_* constants.
584
585       setMarginWidth(This, Margin, PixelWidth) -> ok
586
587              Types:
588
589                 This = wxStyledTextCtrl()
590                 Margin = PixelWidth = integer()
591
592              Set the width of a margin to a width expressed in pixels.
593
594       getMarginWidth(This, Margin) -> integer()
595
596              Types:
597
598                 This = wxStyledTextCtrl()
599                 Margin = integer()
600
601              Retrieve the width of a margin in pixels.
602
603       setMarginMask(This, Margin, Mask) -> ok
604
605              Types:
606
607                 This = wxStyledTextCtrl()
608                 Margin = Mask = integer()
609
610              Set a mask that determines which markers are displayed in a mar‐
611              gin.
612
613       getMarginMask(This, Margin) -> integer()
614
615              Types:
616
617                 This = wxStyledTextCtrl()
618                 Margin = integer()
619
620              Retrieve the marker mask of a margin.
621
622       setMarginSensitive(This, Margin, Sensitive) -> ok
623
624              Types:
625
626                 This = wxStyledTextCtrl()
627                 Margin = integer()
628                 Sensitive = boolean()
629
630              Make a margin sensitive or insensitive to mouse clicks.
631
632       getMarginSensitive(This, Margin) -> boolean()
633
634              Types:
635
636                 This = wxStyledTextCtrl()
637                 Margin = integer()
638
639              Retrieve the mouse click sensitivity of a margin.
640
641       styleClearAll(This) -> ok
642
643              Types:
644
645                 This = wxStyledTextCtrl()
646
647              Clear all the styles and make equivalent to the  global  default
648              style.
649
650       styleSetForeground(This, Style, Fore) -> ok
651
652              Types:
653
654                 This = wxStyledTextCtrl()
655                 Style = integer()
656                 Fore = wx:wx_colour()
657
658              Set the foreground colour of a style.
659
660       styleSetBackground(This, Style, Back) -> ok
661
662              Types:
663
664                 This = wxStyledTextCtrl()
665                 Style = integer()
666                 Back = wx:wx_colour()
667
668              Set the background colour of a style.
669
670       styleSetBold(This, Style, Bold) -> ok
671
672              Types:
673
674                 This = wxStyledTextCtrl()
675                 Style = integer()
676                 Bold = boolean()
677
678              Set a style to be bold or not.
679
680       styleSetItalic(This, Style, Italic) -> ok
681
682              Types:
683
684                 This = wxStyledTextCtrl()
685                 Style = integer()
686                 Italic = boolean()
687
688              Set a style to be italic or not.
689
690       styleSetSize(This, Style, SizePoints) -> ok
691
692              Types:
693
694                 This = wxStyledTextCtrl()
695                 Style = SizePoints = integer()
696
697              Set the size of characters of a style.
698
699       styleSetFaceName(This, Style, FontName) -> ok
700
701              Types:
702
703                 This = wxStyledTextCtrl()
704                 Style = integer()
705                 FontName = unicode:chardata()
706
707              Set the font of a style.
708
709       styleSetEOLFilled(This, Style, EolFilled) -> ok
710
711              Types:
712
713                 This = wxStyledTextCtrl()
714                 Style = integer()
715                 EolFilled = boolean()
716
717              Set a style to have its end of line filled or not.
718
719       styleResetDefault(This) -> ok
720
721              Types:
722
723                 This = wxStyledTextCtrl()
724
725              Reset the default style to its state at startup.
726
727       styleSetUnderline(This, Style, Underline) -> ok
728
729              Types:
730
731                 This = wxStyledTextCtrl()
732                 Style = integer()
733                 Underline = boolean()
734
735              Set a style to be underlined or not.
736
737       styleSetCase(This, Style, CaseVisible) -> ok
738
739              Types:
740
741                 This = wxStyledTextCtrl()
742                 Style = CaseVisible = integer()
743
744              Set a style to be mixed case, or to force upper or lower case.
745
746              The  second  argument  should  be  one of the ?wxSTC_CASE_* con‐
747              stants.
748
749       styleSetHotSpot(This, Style, Hotspot) -> ok
750
751              Types:
752
753                 This = wxStyledTextCtrl()
754                 Style = integer()
755                 Hotspot = boolean()
756
757              Set a style to be a hotspot or not.
758
759       setSelForeground(This, UseSetting, Fore) -> ok
760
761              Types:
762
763                 This = wxStyledTextCtrl()
764                 UseSetting = boolean()
765                 Fore = wx:wx_colour()
766
767              Set the foreground colour of the main and additional  selections
768              and whether to use this setting.
769
770       setSelBackground(This, UseSetting, Back) -> ok
771
772              Types:
773
774                 This = wxStyledTextCtrl()
775                 UseSetting = boolean()
776                 Back = wx:wx_colour()
777
778              Set  the background colour of the main and additional selections
779              and whether to use this setting.
780
781       getSelAlpha(This) -> integer()
782
783              Types:
784
785                 This = wxStyledTextCtrl()
786
787              Get the alpha of the selection.
788
789       setSelAlpha(This, Alpha) -> ok
790
791              Types:
792
793                 This = wxStyledTextCtrl()
794                 Alpha = integer()
795
796              Set the alpha of the selection.
797
798       setCaretForeground(This, Fore) -> ok
799
800              Types:
801
802                 This = wxStyledTextCtrl()
803                 Fore = wx:wx_colour()
804
805              Set the foreground colour of the caret.
806
807       cmdKeyAssign(This, Key, Modifiers, Cmd) -> ok
808
809              Types:
810
811                 This = wxStyledTextCtrl()
812                 Key = Modifiers = Cmd = integer()
813
814              When key+modifier combination keyDefinition is  pressed  perform
815              sciCommand.
816
817              The  second argument should be a bit list containing one or more
818              of the ?wxSTC_KEYMOD_* constants and the third  argument  should
819              be one of the ?wxSTC_CMD_* constants.
820
821       cmdKeyClear(This, Key, Modifiers) -> ok
822
823              Types:
824
825                 This = wxStyledTextCtrl()
826                 Key = Modifiers = integer()
827
828              When  key+modifier combination keyDefinition is pressed do noth‐
829              ing.
830
831              The second argument should be a bit list containing one or  more
832              of the ?wxSTC_KEYMOD_* constants.
833
834       cmdKeyClearAll(This) -> ok
835
836              Types:
837
838                 This = wxStyledTextCtrl()
839
840              Drop all key mappings.
841
842       setStyleBytes(This, Length) -> integer()
843
844              Types:
845
846                 This = wxStyledTextCtrl()
847                 Length = integer()
848
849              Set the styles for a segment of the document.
850
851       styleSetVisible(This, Style, Visible) -> ok
852
853              Types:
854
855                 This = wxStyledTextCtrl()
856                 Style = integer()
857                 Visible = boolean()
858
859              Set a style to be visible or not.
860
861       getCaretPeriod(This) -> integer()
862
863              Types:
864
865                 This = wxStyledTextCtrl()
866
867              Get the time in milliseconds that the caret is on and off.
868
869       setCaretPeriod(This, PeriodMilliseconds) -> ok
870
871              Types:
872
873                 This = wxStyledTextCtrl()
874                 PeriodMilliseconds = integer()
875
876              Get the time in milliseconds that the caret is on and off.
877
878              0 = steady on.
879
880       setWordChars(This, Characters) -> ok
881
882              Types:
883
884                 This = wxStyledTextCtrl()
885                 Characters = unicode:chardata()
886
887              Set the set of characters making up words for when moving or se‐
888              lecting by word.
889
890              First sets defaults like SetCharsDefault.
891
892       beginUndoAction(This) -> ok
893
894              Types:
895
896                 This = wxStyledTextCtrl()
897
898              Start a sequence of actions that is undone and redone as a unit.
899
900              May be nested.
901
902       endUndoAction(This) -> ok
903
904              Types:
905
906                 This = wxStyledTextCtrl()
907
908              End a sequence of actions that is undone and redone as a unit.
909
910       indicatorSetStyle(This, Indicator, IndicatorStyle) -> ok
911
912              Types:
913
914                 This = wxStyledTextCtrl()
915                 Indicator = IndicatorStyle = integer()
916
917              Set an indicator to plain, squiggle or TT.
918
919              The second argument should be one  of  the  ?wxSTC_INDIC_*  con‐
920              stants.
921
922       indicatorGetStyle(This, Indicator) -> integer()
923
924              Types:
925
926                 This = wxStyledTextCtrl()
927                 Indicator = integer()
928
929              Retrieve the style of an indicator.
930
931              The return value will be one of the ?wxSTC_INDIC_* constants.
932
933       indicatorSetForeground(This, Indicator, Fore) -> ok
934
935              Types:
936
937                 This = wxStyledTextCtrl()
938                 Indicator = integer()
939                 Fore = wx:wx_colour()
940
941              Set the foreground colour of an indicator.
942
943       indicatorGetForeground(This, Indicator) -> wx:wx_colour4()
944
945              Types:
946
947                 This = wxStyledTextCtrl()
948                 Indicator = integer()
949
950              Retrieve the foreground colour of an indicator.
951
952       setWhitespaceForeground(This, UseSetting, Fore) -> ok
953
954              Types:
955
956                 This = wxStyledTextCtrl()
957                 UseSetting = boolean()
958                 Fore = wx:wx_colour()
959
960              Set  the  foreground colour of all whitespace and whether to use
961              this setting.
962
963       setWhitespaceBackground(This, UseSetting, Back) -> ok
964
965              Types:
966
967                 This = wxStyledTextCtrl()
968                 UseSetting = boolean()
969                 Back = wx:wx_colour()
970
971              Set the background colour of all whitespace and whether  to  use
972              this setting.
973
974       getStyleBits(This) -> integer()
975
976              Types:
977
978                 This = wxStyledTextCtrl()
979
980              Retrieve  number of bits in style bytes used to hold the lexical
981              state.
982
983              Deprecated:
984
985       setLineState(This, Line, State) -> ok
986
987              Types:
988
989                 This = wxStyledTextCtrl()
990                 Line = State = integer()
991
992              Used to hold extra styling information for each line.
993
994       getLineState(This, Line) -> integer()
995
996              Types:
997
998                 This = wxStyledTextCtrl()
999                 Line = integer()
1000
1001              Retrieve the extra styling information for a line.
1002
1003       getMaxLineState(This) -> integer()
1004
1005              Types:
1006
1007                 This = wxStyledTextCtrl()
1008
1009              Retrieve the last line number that has line state.
1010
1011       getCaretLineVisible(This) -> boolean()
1012
1013              Types:
1014
1015                 This = wxStyledTextCtrl()
1016
1017              Is the background of the line containing the caret in a  differ‐
1018              ent colour?
1019
1020       setCaretLineVisible(This, Show) -> ok
1021
1022              Types:
1023
1024                 This = wxStyledTextCtrl()
1025                 Show = boolean()
1026
1027              Display  the  background  of  the line containing the caret in a
1028              different colour.
1029
1030       getCaretLineBackground(This) -> wx:wx_colour4()
1031
1032              Types:
1033
1034                 This = wxStyledTextCtrl()
1035
1036              Get the colour of the background  of  the  line  containing  the
1037              caret.
1038
1039       setCaretLineBackground(This, Back) -> ok
1040
1041              Types:
1042
1043                 This = wxStyledTextCtrl()
1044                 Back = wx:wx_colour()
1045
1046              Set  the  colour  of  the  background of the line containing the
1047              caret.
1048
1049       autoCompShow(This, LengthEntered, ItemList) -> ok
1050
1051              Types:
1052
1053                 This = wxStyledTextCtrl()
1054                 LengthEntered = integer()
1055                 ItemList = unicode:chardata()
1056
1057              Display a auto-completion list.
1058
1059              The lengthEntered parameter indicates how many characters before
1060              the caret should be used to provide context.
1061
1062       autoCompCancel(This) -> ok
1063
1064              Types:
1065
1066                 This = wxStyledTextCtrl()
1067
1068              Remove the auto-completion list from the screen.
1069
1070       autoCompActive(This) -> boolean()
1071
1072              Types:
1073
1074                 This = wxStyledTextCtrl()
1075
1076              Is there an auto-completion list visible?
1077
1078       autoCompPosStart(This) -> integer()
1079
1080              Types:
1081
1082                 This = wxStyledTextCtrl()
1083
1084              Retrieve the position of the caret when the auto-completion list
1085              was displayed.
1086
1087       autoCompComplete(This) -> ok
1088
1089              Types:
1090
1091                 This = wxStyledTextCtrl()
1092
1093              User has selected an item so remove the list and insert the  se‐
1094              lection.
1095
1096       autoCompStops(This, CharacterSet) -> ok
1097
1098              Types:
1099
1100                 This = wxStyledTextCtrl()
1101                 CharacterSet = unicode:chardata()
1102
1103              Define  a  set of character that when typed cancel the auto-com‐
1104              pletion list.
1105
1106       autoCompSetSeparator(This, SeparatorCharacter) -> ok
1107
1108              Types:
1109
1110                 This = wxStyledTextCtrl()
1111                 SeparatorCharacter = integer()
1112
1113              Change the separator character in the string setting up an auto-
1114              completion list.
1115
1116              Default is space but can be changed if items contain space.
1117
1118       autoCompGetSeparator(This) -> integer()
1119
1120              Types:
1121
1122                 This = wxStyledTextCtrl()
1123
1124              Retrieve the auto-completion list separator character.
1125
1126       autoCompSelect(This, Select) -> ok
1127
1128              Types:
1129
1130                 This = wxStyledTextCtrl()
1131                 Select = unicode:chardata()
1132
1133              Select  the  item in the auto-completion list that starts with a
1134              string.
1135
1136       autoCompSetCancelAtStart(This, Cancel) -> ok
1137
1138              Types:
1139
1140                 This = wxStyledTextCtrl()
1141                 Cancel = boolean()
1142
1143              Should  the  auto-completion  list  be  cancelled  if  the  user
1144              backspaces to a position before where the box was created.
1145
1146       autoCompGetCancelAtStart(This) -> boolean()
1147
1148              Types:
1149
1150                 This = wxStyledTextCtrl()
1151
1152              Retrieve whether auto-completion cancelled by backspacing before
1153              start.
1154
1155       autoCompSetFillUps(This, CharacterSet) -> ok
1156
1157              Types:
1158
1159                 This = wxStyledTextCtrl()
1160                 CharacterSet = unicode:chardata()
1161
1162              Define a set of characters that when typed will cause the  auto‐
1163              completion to choose the selected item.
1164
1165       autoCompSetChooseSingle(This, ChooseSingle) -> ok
1166
1167              Types:
1168
1169                 This = wxStyledTextCtrl()
1170                 ChooseSingle = boolean()
1171
1172              Should  a  single item auto-completion list automatically choose
1173              the item.
1174
1175       autoCompGetChooseSingle(This) -> boolean()
1176
1177              Types:
1178
1179                 This = wxStyledTextCtrl()
1180
1181              Retrieve whether a single item  auto-completion  list  automati‐
1182              cally choose the item.
1183
1184       autoCompSetIgnoreCase(This, IgnoreCase) -> ok
1185
1186              Types:
1187
1188                 This = wxStyledTextCtrl()
1189                 IgnoreCase = boolean()
1190
1191              Set  whether case is significant when performing auto-completion
1192              searches.
1193
1194       autoCompGetIgnoreCase(This) -> boolean()
1195
1196              Types:
1197
1198                 This = wxStyledTextCtrl()
1199
1200              Retrieve state of ignore case flag.
1201
1202       userListShow(This, ListType, ItemList) -> ok
1203
1204              Types:
1205
1206                 This = wxStyledTextCtrl()
1207                 ListType = integer()
1208                 ItemList = unicode:chardata()
1209
1210              Display a list  of  strings  and  send  notification  when  user
1211              chooses one.
1212
1213       autoCompSetAutoHide(This, AutoHide) -> ok
1214
1215              Types:
1216
1217                 This = wxStyledTextCtrl()
1218                 AutoHide = boolean()
1219
1220              Set  whether  or not autocompletion is hidden automatically when
1221              nothing matches.
1222
1223       autoCompGetAutoHide(This) -> boolean()
1224
1225              Types:
1226
1227                 This = wxStyledTextCtrl()
1228
1229              Retrieve whether or not autocompletion is  hidden  automatically
1230              when nothing matches.
1231
1232       autoCompSetDropRestOfWord(This, DropRestOfWord) -> ok
1233
1234              Types:
1235
1236                 This = wxStyledTextCtrl()
1237                 DropRestOfWord = boolean()
1238
1239              Set  whether  or  not autocompletion deletes any word characters
1240              after the inserted text upon completion.
1241
1242       autoCompGetDropRestOfWord(This) -> boolean()
1243
1244              Types:
1245
1246                 This = wxStyledTextCtrl()
1247
1248              Retrieve whether or not autocompletion deletes any word  charac‐
1249              ters after the inserted text upon completion.
1250
1251       registerImage(This, Type, Bmp) -> ok
1252
1253              Types:
1254
1255                 This = wxStyledTextCtrl()
1256                 Type = integer()
1257                 Bmp = wxBitmap:wxBitmap()
1258
1259              Register an image for use in autocompletion lists.
1260
1261       clearRegisteredImages(This) -> ok
1262
1263              Types:
1264
1265                 This = wxStyledTextCtrl()
1266
1267              Clear all the registered images.
1268
1269       autoCompGetTypeSeparator(This) -> integer()
1270
1271              Types:
1272
1273                 This = wxStyledTextCtrl()
1274
1275              Retrieve the auto-completion list type-separator character.
1276
1277       autoCompSetTypeSeparator(This, SeparatorCharacter) -> ok
1278
1279              Types:
1280
1281                 This = wxStyledTextCtrl()
1282                 SeparatorCharacter = integer()
1283
1284              Change  the type-separator character in the string setting up an
1285              auto-completion list.
1286
1287              Default is '?' but can be changed if items contain '?'.
1288
1289       autoCompSetMaxWidth(This, CharacterCount) -> ok
1290
1291              Types:
1292
1293                 This = wxStyledTextCtrl()
1294                 CharacterCount = integer()
1295
1296              Set the maximum width, in  characters,  of  auto-completion  and
1297              user lists.
1298
1299              Set to 0 to autosize to fit longest item, which is the default.
1300
1301       autoCompGetMaxWidth(This) -> integer()
1302
1303              Types:
1304
1305                 This = wxStyledTextCtrl()
1306
1307              Get  the  maximum  width,  in characters, of auto-completion and
1308              user lists.
1309
1310       autoCompSetMaxHeight(This, RowCount) -> ok
1311
1312              Types:
1313
1314                 This = wxStyledTextCtrl()
1315                 RowCount = integer()
1316
1317              Set the maximum height, in rows,  of  auto-completion  and  user
1318              lists.
1319
1320              The default is 5 rows.
1321
1322       autoCompGetMaxHeight(This) -> integer()
1323
1324              Types:
1325
1326                 This = wxStyledTextCtrl()
1327
1328              Set  the  maximum  height,  in rows, of auto-completion and user
1329              lists.
1330
1331       setIndent(This, IndentSize) -> ok
1332
1333              Types:
1334
1335                 This = wxStyledTextCtrl()
1336                 IndentSize = integer()
1337
1338              Set the number of spaces used for one level of indentation.
1339
1340       getIndent(This) -> integer()
1341
1342              Types:
1343
1344                 This = wxStyledTextCtrl()
1345
1346              Retrieve indentation size.
1347
1348       setUseTabs(This, UseTabs) -> ok
1349
1350              Types:
1351
1352                 This = wxStyledTextCtrl()
1353                 UseTabs = boolean()
1354
1355              Indentation will only use space characters if useTabs is  false,
1356              otherwise it will use a combination of tabs and spaces.
1357
1358       getUseTabs(This) -> boolean()
1359
1360              Types:
1361
1362                 This = wxStyledTextCtrl()
1363
1364              Retrieve whether tabs will be used in indentation.
1365
1366       setLineIndentation(This, Line, Indentation) -> ok
1367
1368              Types:
1369
1370                 This = wxStyledTextCtrl()
1371                 Line = Indentation = integer()
1372
1373              Change the indentation of a line to a number of columns.
1374
1375       getLineIndentation(This, Line) -> integer()
1376
1377              Types:
1378
1379                 This = wxStyledTextCtrl()
1380                 Line = integer()
1381
1382              Retrieve the number of columns that a line is indented.
1383
1384       getLineIndentPosition(This, Line) -> integer()
1385
1386              Types:
1387
1388                 This = wxStyledTextCtrl()
1389                 Line = integer()
1390
1391              Retrieve the position before the first non indentation character
1392              on a line.
1393
1394       getColumn(This, Pos) -> integer()
1395
1396              Types:
1397
1398                 This = wxStyledTextCtrl()
1399                 Pos = integer()
1400
1401              Retrieve the column number of a position, taking tab width  into
1402              account.
1403
1404       setUseHorizontalScrollBar(This, Visible) -> ok
1405
1406              Types:
1407
1408                 This = wxStyledTextCtrl()
1409                 Visible = boolean()
1410
1411              Show or hide the horizontal scroll bar.
1412
1413       getUseHorizontalScrollBar(This) -> boolean()
1414
1415              Types:
1416
1417                 This = wxStyledTextCtrl()
1418
1419              Is the horizontal scroll bar visible?
1420
1421       setIndentationGuides(This, IndentView) -> ok
1422
1423              Types:
1424
1425                 This = wxStyledTextCtrl()
1426                 IndentView = integer()
1427
1428              Show or hide indentation guides.
1429
1430              The input should be one of the ?wxSTC_IV_* constants.
1431
1432       getIndentationGuides(This) -> integer()
1433
1434              Types:
1435
1436                 This = wxStyledTextCtrl()
1437
1438              Are the indentation guides visible?
1439
1440              The return value will be one of the ?wxSTC_IV_* constants.
1441
1442       setHighlightGuide(This, Column) -> ok
1443
1444              Types:
1445
1446                 This = wxStyledTextCtrl()
1447                 Column = integer()
1448
1449              Set the highlighted indentation guide column.
1450
1451              0 = no highlighted guide.
1452
1453       getHighlightGuide(This) -> integer()
1454
1455              Types:
1456
1457                 This = wxStyledTextCtrl()
1458
1459              Get the highlighted indentation guide column.
1460
1461       getLineEndPosition(This, Line) -> integer()
1462
1463              Types:
1464
1465                 This = wxStyledTextCtrl()
1466                 Line = integer()
1467
1468              Get the position after the last visible characters on a line.
1469
1470       getCodePage(This) -> integer()
1471
1472              Types:
1473
1474                 This = wxStyledTextCtrl()
1475
1476              Get the code page used to interpret the bytes of the document as
1477              characters.
1478
1479       getCaretForeground(This) -> wx:wx_colour4()
1480
1481              Types:
1482
1483                 This = wxStyledTextCtrl()
1484
1485              Get the foreground colour of the caret.
1486
1487       getReadOnly(This) -> boolean()
1488
1489              Types:
1490
1491                 This = wxStyledTextCtrl()
1492
1493              In read-only mode?
1494
1495       setCurrentPos(This, Caret) -> ok
1496
1497              Types:
1498
1499                 This = wxStyledTextCtrl()
1500                 Caret = integer()
1501
1502              Sets the position of the caret.
1503
1504       setSelectionStart(This, Anchor) -> ok
1505
1506              Types:
1507
1508                 This = wxStyledTextCtrl()
1509                 Anchor = integer()
1510
1511              Sets the position that starts the selection - this  becomes  the
1512              anchor.
1513
1514       getSelectionStart(This) -> integer()
1515
1516              Types:
1517
1518                 This = wxStyledTextCtrl()
1519
1520              Returns the position at the start of the selection.
1521
1522       setSelectionEnd(This, Caret) -> ok
1523
1524              Types:
1525
1526                 This = wxStyledTextCtrl()
1527                 Caret = integer()
1528
1529              Sets  the  position  that  ends the selection - this becomes the
1530              caret.
1531
1532       getSelectionEnd(This) -> integer()
1533
1534              Types:
1535
1536                 This = wxStyledTextCtrl()
1537
1538              Returns the position at the end of the selection.
1539
1540       setPrintMagnification(This, Magnification) -> ok
1541
1542              Types:
1543
1544                 This = wxStyledTextCtrl()
1545                 Magnification = integer()
1546
1547              Sets the print magnification added to the  point  size  of  each
1548              style for printing.
1549
1550       getPrintMagnification(This) -> integer()
1551
1552              Types:
1553
1554                 This = wxStyledTextCtrl()
1555
1556              Returns the print magnification.
1557
1558       setPrintColourMode(This, Mode) -> ok
1559
1560              Types:
1561
1562                 This = wxStyledTextCtrl()
1563                 Mode = integer()
1564
1565              Modify colours when printing for clearer printed text.
1566
1567              The input should be one of the ?wxSTC_PRINT_* constants.
1568
1569       getPrintColourMode(This) -> integer()
1570
1571              Types:
1572
1573                 This = wxStyledTextCtrl()
1574
1575              Returns the print colour mode.
1576
1577              The return value will be one of the ?wxSTC_PRINT_* constants.
1578
1579       findText(This, MinPos, MaxPos, Text) -> integer()
1580
1581              Types:
1582
1583                 This = wxStyledTextCtrl()
1584                 MinPos = MaxPos = integer()
1585                 Text = unicode:chardata()
1586
1587       findText(This, MinPos, MaxPos, Text, Options :: [Option]) ->
1588                   integer()
1589
1590              Types:
1591
1592                 This = wxStyledTextCtrl()
1593                 MinPos = MaxPos = integer()
1594                 Text = unicode:chardata()
1595                 Option = {flags, integer()}
1596
1597               Find  some  text  in  the  document. @param minPos The position
1598              (starting from zero) in the  document  at  which  to  begin  the
1599              search  @param  maxPos The last position (starting from zero) in
1600              the document to which the search will be restricted. @param text
1601              The  text  to  search  for.  @param  flags (Optional) The search
1602              flags. This should be a bit list containing one or more  of  the
1603              @link     wxStyledTextCtrl::wxSTC_FIND_WHOLEWORD    wxSTC_FIND_*
1604              @endlink constants.
1605
1606              Return: The position (starting from zero)  in  the  document  at
1607              which the text was found or wxSTC_INVALID_POSITION if the search
1608              fails.
1609
1610              Remark: A backwards search can be performed by setting minPos to
1611              be greater than maxPos.
1612
1613       formatRange(This, DoDraw, StartPos, EndPos, Draw, Target,
1614                   RenderRect, PageRect) ->
1615                      integer()
1616
1617              Types:
1618
1619                 This = wxStyledTextCtrl()
1620                 DoDraw = boolean()
1621                 StartPos = EndPos = integer()
1622                 Draw = Target = wxDC:wxDC()
1623                 RenderRect = PageRect =
1624                     {X :: integer(),
1625                      Y :: integer(),
1626                      W :: integer(),
1627                      H :: integer()}
1628
1629              On  Windows,  will draw the document into a display context such
1630              as a printer.
1631
1632       getFirstVisibleLine(This) -> integer()
1633
1634              Types:
1635
1636                 This = wxStyledTextCtrl()
1637
1638              Retrieve the display line at the top of the display.
1639
1640       getLine(This, Line) -> unicode:charlist()
1641
1642              Types:
1643
1644                 This = wxStyledTextCtrl()
1645                 Line = integer()
1646
1647              Retrieve the contents of a line.
1648
1649       getLineCount(This) -> integer()
1650
1651              Types:
1652
1653                 This = wxStyledTextCtrl()
1654
1655              Returns the number of lines in the document.
1656
1657              There is always at least one.
1658
1659       setMarginLeft(This, PixelWidth) -> ok
1660
1661              Types:
1662
1663                 This = wxStyledTextCtrl()
1664                 PixelWidth = integer()
1665
1666              Sets the size in pixels of the left margin.
1667
1668       getMarginLeft(This) -> integer()
1669
1670              Types:
1671
1672                 This = wxStyledTextCtrl()
1673
1674              Returns the size in pixels of the left margin.
1675
1676       setMarginRight(This, PixelWidth) -> ok
1677
1678              Types:
1679
1680                 This = wxStyledTextCtrl()
1681                 PixelWidth = integer()
1682
1683              Sets the size in pixels of the right margin.
1684
1685       getMarginRight(This) -> integer()
1686
1687              Types:
1688
1689                 This = wxStyledTextCtrl()
1690
1691              Returns the size in pixels of the right margin.
1692
1693       getModify(This) -> boolean()
1694
1695              Types:
1696
1697                 This = wxStyledTextCtrl()
1698
1699              Is the document different from when it was last saved?
1700
1701       setSelection(This, From, To) -> ok
1702
1703              Types:
1704
1705                 This = wxStyledTextCtrl()
1706                 From = To = integer()
1707
1708              Selects the text starting at the first position up to  (but  not
1709              including) the character at the last position.
1710
1711              If  both  parameters  are equal to -1 all text in the control is
1712              selected.
1713
1714              Notice that the insertion point will be moved to  from  by  this
1715              function.
1716
1717              See: selectAll/1
1718
1719       getSelectedText(This) -> unicode:charlist()
1720
1721              Types:
1722
1723                 This = wxStyledTextCtrl()
1724
1725              Retrieve the selected text.
1726
1727       getTextRange(This, StartPos, EndPos) -> unicode:charlist()
1728
1729              Types:
1730
1731                 This = wxStyledTextCtrl()
1732                 StartPos = EndPos = integer()
1733
1734              Retrieve a range of text.
1735
1736       hideSelection(This, Hide) -> ok
1737
1738              Types:
1739
1740                 This = wxStyledTextCtrl()
1741                 Hide = boolean()
1742
1743              Draw  the  selection  in  normal  style  or with selection high‐
1744              lighted.
1745
1746       lineFromPosition(This, Pos) -> integer()
1747
1748              Types:
1749
1750                 This = wxStyledTextCtrl()
1751                 Pos = integer()
1752
1753              Retrieve the line containing a position.
1754
1755       positionFromLine(This, Line) -> integer()
1756
1757              Types:
1758
1759                 This = wxStyledTextCtrl()
1760                 Line = integer()
1761
1762              Retrieve the position at the start of a line.
1763
1764       lineScroll(This, Columns, Lines) -> ok
1765
1766              Types:
1767
1768                 This = wxStyledTextCtrl()
1769                 Columns = Lines = integer()
1770
1771              Scroll horizontally and vertically.
1772
1773       ensureCaretVisible(This) -> ok
1774
1775              Types:
1776
1777                 This = wxStyledTextCtrl()
1778
1779              Ensure the caret is visible.
1780
1781       replaceSelection(This, Text) -> ok
1782
1783              Types:
1784
1785                 This = wxStyledTextCtrl()
1786                 Text = unicode:chardata()
1787
1788              Replace the selected text with the argument text.
1789
1790       setReadOnly(This, ReadOnly) -> ok
1791
1792              Types:
1793
1794                 This = wxStyledTextCtrl()
1795                 ReadOnly = boolean()
1796
1797              Set to read only or read write.
1798
1799       canPaste(This) -> boolean()
1800
1801              Types:
1802
1803                 This = wxStyledTextCtrl()
1804
1805              Will a paste succeed?
1806
1807       canUndo(This) -> boolean()
1808
1809              Types:
1810
1811                 This = wxStyledTextCtrl()
1812
1813              Are there any undoable actions in the undo history?
1814
1815       emptyUndoBuffer(This) -> ok
1816
1817              Types:
1818
1819                 This = wxStyledTextCtrl()
1820
1821              Delete the undo history.
1822
1823       undo(This) -> ok
1824
1825              Types:
1826
1827                 This = wxStyledTextCtrl()
1828
1829              Undo one action in the undo history.
1830
1831       cut(This) -> ok
1832
1833              Types:
1834
1835                 This = wxStyledTextCtrl()
1836
1837              Cut the selection to the clipboard.
1838
1839       copy(This) -> ok
1840
1841              Types:
1842
1843                 This = wxStyledTextCtrl()
1844
1845              Copy the selection to the clipboard.
1846
1847       paste(This) -> ok
1848
1849              Types:
1850
1851                 This = wxStyledTextCtrl()
1852
1853              Paste the contents of the clipboard into the document  replacing
1854              the selection.
1855
1856       clear(This) -> ok
1857
1858              Types:
1859
1860                 This = wxStyledTextCtrl()
1861
1862              Clear the selection.
1863
1864       setText(This, Text) -> ok
1865
1866              Types:
1867
1868                 This = wxStyledTextCtrl()
1869                 Text = unicode:chardata()
1870
1871              Replace the contents of the document with the argument text.
1872
1873       getText(This) -> unicode:charlist()
1874
1875              Types:
1876
1877                 This = wxStyledTextCtrl()
1878
1879              Retrieve all the text in the document.
1880
1881       getTextLength(This) -> integer()
1882
1883              Types:
1884
1885                 This = wxStyledTextCtrl()
1886
1887              Retrieve the number of characters in the document.
1888
1889       getOvertype(This) -> boolean()
1890
1891              Types:
1892
1893                 This = wxStyledTextCtrl()
1894
1895              Returns  true  if overtype mode is active otherwise false is re‐
1896              turned.
1897
1898       setCaretWidth(This, PixelWidth) -> ok
1899
1900              Types:
1901
1902                 This = wxStyledTextCtrl()
1903                 PixelWidth = integer()
1904
1905              Set the width of the insert mode caret.
1906
1907       getCaretWidth(This) -> integer()
1908
1909              Types:
1910
1911                 This = wxStyledTextCtrl()
1912
1913              Returns the width of the insert mode caret.
1914
1915       setTargetStart(This, Start) -> ok
1916
1917              Types:
1918
1919                 This = wxStyledTextCtrl()
1920                 Start = integer()
1921
1922              Sets the position that starts the target which is used  for  up‐
1923              dating the document without affecting the scroll position.
1924
1925       getTargetStart(This) -> integer()
1926
1927              Types:
1928
1929                 This = wxStyledTextCtrl()
1930
1931              Get the position that starts the target.
1932
1933       setTargetEnd(This, End) -> ok
1934
1935              Types:
1936
1937                 This = wxStyledTextCtrl()
1938                 End = integer()
1939
1940              Sets  the position that ends the target which is used for updat‐
1941              ing the document without affecting the scroll position.
1942
1943       getTargetEnd(This) -> integer()
1944
1945              Types:
1946
1947                 This = wxStyledTextCtrl()
1948
1949              Get the position that ends the target.
1950
1951       replaceTarget(This, Text) -> integer()
1952
1953              Types:
1954
1955                 This = wxStyledTextCtrl()
1956                 Text = unicode:chardata()
1957
1958              Replace the target text with the argument text.
1959
1960              Text is counted so it can contain NULs. Returns  the  length  of
1961              the replacement text.
1962
1963       searchInTarget(This, Text) -> integer()
1964
1965              Types:
1966
1967                 This = wxStyledTextCtrl()
1968                 Text = unicode:chardata()
1969
1970              Search  for a counted string in the target and set the target to
1971              the found range.
1972
1973              Text is counted so it can contain NULs. Returns length of  range
1974              or -1 for failure in which case target is not moved.
1975
1976       setSearchFlags(This, SearchFlags) -> ok
1977
1978              Types:
1979
1980                 This = wxStyledTextCtrl()
1981                 SearchFlags = integer()
1982
1983              Set the search flags used by SearchInTarget.
1984
1985              The  input  should  be  a bit list containing one or more of the
1986              ?wxSTC_FIND_* constants.
1987
1988       getSearchFlags(This) -> integer()
1989
1990              Types:
1991
1992                 This = wxStyledTextCtrl()
1993
1994              Get the search flags used by SearchInTarget.
1995
1996              The return value will be a bit list containing one  or  more  of
1997              the ?wxSTC_FIND_* constants.
1998
1999       callTipShow(This, Pos, Definition) -> ok
2000
2001              Types:
2002
2003                 This = wxStyledTextCtrl()
2004                 Pos = integer()
2005                 Definition = unicode:chardata()
2006
2007              Show a call tip containing a definition near position pos.
2008
2009       callTipCancel(This) -> ok
2010
2011              Types:
2012
2013                 This = wxStyledTextCtrl()
2014
2015              Remove the call tip from the screen.
2016
2017       callTipActive(This) -> boolean()
2018
2019              Types:
2020
2021                 This = wxStyledTextCtrl()
2022
2023              Is there an active call tip?
2024
2025       callTipPosAtStart(This) -> integer()
2026
2027              Types:
2028
2029                 This = wxStyledTextCtrl()
2030
2031              Retrieve  the position where the caret was before displaying the
2032              call tip.
2033
2034              Since: 3.1.0
2035
2036       callTipSetHighlight(This, HighlightStart, HighlightEnd) -> ok
2037
2038              Types:
2039
2040                 This = wxStyledTextCtrl()
2041                 HighlightStart = HighlightEnd = integer()
2042
2043              Highlight a segment of the definition.
2044
2045       callTipSetBackground(This, Back) -> ok
2046
2047              Types:
2048
2049                 This = wxStyledTextCtrl()
2050                 Back = wx:wx_colour()
2051
2052              Set the background colour for the call tip.
2053
2054       callTipSetForeground(This, Fore) -> ok
2055
2056              Types:
2057
2058                 This = wxStyledTextCtrl()
2059                 Fore = wx:wx_colour()
2060
2061              Set the foreground colour for the call tip.
2062
2063       callTipSetForegroundHighlight(This, Fore) -> ok
2064
2065              Types:
2066
2067                 This = wxStyledTextCtrl()
2068                 Fore = wx:wx_colour()
2069
2070              Set the foreground colour for the highlighted part of  the  call
2071              tip.
2072
2073       callTipUseStyle(This, TabSize) -> ok
2074
2075              Types:
2076
2077                 This = wxStyledTextCtrl()
2078                 TabSize = integer()
2079
2080              Enable  use  of wxSTC_STYLE_CALLTIP and set call tip tab size in
2081              pixels.
2082
2083       visibleFromDocLine(This, DocLine) -> integer()
2084
2085              Types:
2086
2087                 This = wxStyledTextCtrl()
2088                 DocLine = integer()
2089
2090              Find the display line of a document  line  taking  hidden  lines
2091              into account.
2092
2093       docLineFromVisible(This, DisplayLine) -> integer()
2094
2095              Types:
2096
2097                 This = wxStyledTextCtrl()
2098                 DisplayLine = integer()
2099
2100              Find  the  document  line  of a display line taking hidden lines
2101              into account.
2102
2103       wrapCount(This, DocLine) -> integer()
2104
2105              Types:
2106
2107                 This = wxStyledTextCtrl()
2108                 DocLine = integer()
2109
2110              The number of display lines needed to wrap a document line.
2111
2112       setFoldLevel(This, Line, Level) -> ok
2113
2114              Types:
2115
2116                 This = wxStyledTextCtrl()
2117                 Line = Level = integer()
2118
2119              Set the fold level of a line.
2120
2121              This encodes  an  integer  level  along  with  flags  indicating
2122              whether the line is a header and whether it is effectively white
2123              space.
2124
2125       getFoldLevel(This, Line) -> integer()
2126
2127              Types:
2128
2129                 This = wxStyledTextCtrl()
2130                 Line = integer()
2131
2132              Retrieve the fold level of a line.
2133
2134       getLastChild(This, Line, Level) -> integer()
2135
2136              Types:
2137
2138                 This = wxStyledTextCtrl()
2139                 Line = Level = integer()
2140
2141              Find the last child line of a header line.
2142
2143       getFoldParent(This, Line) -> integer()
2144
2145              Types:
2146
2147                 This = wxStyledTextCtrl()
2148                 Line = integer()
2149
2150              Find the parent line of a child line.
2151
2152       showLines(This, LineStart, LineEnd) -> ok
2153
2154              Types:
2155
2156                 This = wxStyledTextCtrl()
2157                 LineStart = LineEnd = integer()
2158
2159              Make a range of lines visible.
2160
2161       hideLines(This, LineStart, LineEnd) -> ok
2162
2163              Types:
2164
2165                 This = wxStyledTextCtrl()
2166                 LineStart = LineEnd = integer()
2167
2168              Make a range of lines invisible.
2169
2170       getLineVisible(This, Line) -> boolean()
2171
2172              Types:
2173
2174                 This = wxStyledTextCtrl()
2175                 Line = integer()
2176
2177              Is a line visible?
2178
2179       setFoldExpanded(This, Line, Expanded) -> ok
2180
2181              Types:
2182
2183                 This = wxStyledTextCtrl()
2184                 Line = integer()
2185                 Expanded = boolean()
2186
2187              Show the children of a header line.
2188
2189       getFoldExpanded(This, Line) -> boolean()
2190
2191              Types:
2192
2193                 This = wxStyledTextCtrl()
2194                 Line = integer()
2195
2196              Is a header line expanded?
2197
2198       toggleFold(This, Line) -> ok
2199
2200              Types:
2201
2202                 This = wxStyledTextCtrl()
2203                 Line = integer()
2204
2205              Switch a header line between expanded and contracted.
2206
2207       ensureVisible(This, Line) -> ok
2208
2209              Types:
2210
2211                 This = wxStyledTextCtrl()
2212                 Line = integer()
2213
2214              Ensure a particular line is visible by expanding any header line
2215              hiding it.
2216
2217       setFoldFlags(This, Flags) -> ok
2218
2219              Types:
2220
2221                 This = wxStyledTextCtrl()
2222                 Flags = integer()
2223
2224              Set some style options for folding.
2225
2226              The  second argument should be a bit list containing one or more
2227              of the ?wxSTC_FOLDFLAG_* constants.
2228
2229       ensureVisibleEnforcePolicy(This, Line) -> ok
2230
2231              Types:
2232
2233                 This = wxStyledTextCtrl()
2234                 Line = integer()
2235
2236              Ensure a particular line is visible by expanding any header line
2237              hiding it.
2238
2239              Use the currently set visibility policy to determine which range
2240              to display.
2241
2242       setTabIndents(This, TabIndents) -> ok
2243
2244              Types:
2245
2246                 This = wxStyledTextCtrl()
2247                 TabIndents = boolean()
2248
2249              Sets whether a tab pressed when caret is within indentation  in‐
2250              dents.
2251
2252       getTabIndents(This) -> boolean()
2253
2254              Types:
2255
2256                 This = wxStyledTextCtrl()
2257
2258              Does a tab pressed when caret is within indentation indent?
2259
2260       setBackSpaceUnIndents(This, BsUnIndents) -> ok
2261
2262              Types:
2263
2264                 This = wxStyledTextCtrl()
2265                 BsUnIndents = boolean()
2266
2267              Sets  whether  a backspace pressed when caret is within indenta‐
2268              tion unindents.
2269
2270       getBackSpaceUnIndents(This) -> boolean()
2271
2272              Types:
2273
2274                 This = wxStyledTextCtrl()
2275
2276              Does a backspace pressed when caret is within indentation  unin‐
2277              dent?
2278
2279       setMouseDwellTime(This, PeriodMilliseconds) -> ok
2280
2281              Types:
2282
2283                 This = wxStyledTextCtrl()
2284                 PeriodMilliseconds = integer()
2285
2286              Sets the time the mouse must sit still to generate a mouse dwell
2287              event.
2288
2289              The input should be a time in  milliseconds  or  wxSTC_TIME_FOR‐
2290              EVER.
2291
2292       getMouseDwellTime(This) -> integer()
2293
2294              Types:
2295
2296                 This = wxStyledTextCtrl()
2297
2298              Retrieve  the  time the mouse must sit still to generate a mouse
2299              dwell event.
2300
2301              The  return  value  will  be   a   time   in   milliseconds   or
2302              wxSTC_TIME_FOREVER.
2303
2304       wordStartPosition(This, Pos, OnlyWordCharacters) -> integer()
2305
2306              Types:
2307
2308                 This = wxStyledTextCtrl()
2309                 Pos = integer()
2310                 OnlyWordCharacters = boolean()
2311
2312              Get position of start of word.
2313
2314       wordEndPosition(This, Pos, OnlyWordCharacters) -> integer()
2315
2316              Types:
2317
2318                 This = wxStyledTextCtrl()
2319                 Pos = integer()
2320                 OnlyWordCharacters = boolean()
2321
2322              Get position of end of word.
2323
2324       setWrapMode(This, WrapMode) -> ok
2325
2326              Types:
2327
2328                 This = wxStyledTextCtrl()
2329                 WrapMode = integer()
2330
2331              Sets whether text is word wrapped.
2332
2333              The input should be one of the ?wxSTC_WRAP_* constants.
2334
2335       getWrapMode(This) -> integer()
2336
2337              Types:
2338
2339                 This = wxStyledTextCtrl()
2340
2341              Retrieve whether text is word wrapped.
2342
2343              The return value will be one of the ?wxSTC_WRAP_* constants.
2344
2345       setWrapVisualFlags(This, WrapVisualFlags) -> ok
2346
2347              Types:
2348
2349                 This = wxStyledTextCtrl()
2350                 WrapVisualFlags = integer()
2351
2352              Set the display mode of visual flags for wrapped lines.
2353
2354              The  input  should  be  a bit list containing one or more of the
2355              ?wxSTC_WRAPVISUALFLAG_* constants.
2356
2357       getWrapVisualFlags(This) -> integer()
2358
2359              Types:
2360
2361                 This = wxStyledTextCtrl()
2362
2363              Retrieve the display mode of visual flags for wrapped lines.
2364
2365              The return value will be a bit list containing one  or  more  of
2366              the ?wxSTC_WRAPVISUALFLAG_* constants.
2367
2368       setWrapVisualFlagsLocation(This, WrapVisualFlagsLocation) -> ok
2369
2370              Types:
2371
2372                 This = wxStyledTextCtrl()
2373                 WrapVisualFlagsLocation = integer()
2374
2375              Set the location of visual flags for wrapped lines.
2376
2377              The  input  should  be  a bit list containing one or more of the
2378              ?wxSTC_WRAPVISUALFLAGLOC_* constants.
2379
2380       getWrapVisualFlagsLocation(This) -> integer()
2381
2382              Types:
2383
2384                 This = wxStyledTextCtrl()
2385
2386              Retrieve the location of visual flags for wrapped lines.
2387
2388              The return value will be a bit list containing one  or  more  of
2389              the ?wxSTC_WRAPVISUALFLAGLOC_* constants.
2390
2391       setWrapStartIndent(This, Indent) -> ok
2392
2393              Types:
2394
2395                 This = wxStyledTextCtrl()
2396                 Indent = integer()
2397
2398              Set the start indent for wrapped lines.
2399
2400       getWrapStartIndent(This) -> integer()
2401
2402              Types:
2403
2404                 This = wxStyledTextCtrl()
2405
2406              Retrieve the start indent for wrapped lines.
2407
2408       setLayoutCache(This, CacheMode) -> ok
2409
2410              Types:
2411
2412                 This = wxStyledTextCtrl()
2413                 CacheMode = integer()
2414
2415              Sets the degree of caching of layout information.
2416
2417              The input should be one of the ?wxSTC_CACHE_* constants.
2418
2419       getLayoutCache(This) -> integer()
2420
2421              Types:
2422
2423                 This = wxStyledTextCtrl()
2424
2425              Retrieve the degree of caching of layout information.
2426
2427              The return value will be one of the ?wxSTC_CACHE_* constants.
2428
2429       setScrollWidth(This, PixelWidth) -> ok
2430
2431              Types:
2432
2433                 This = wxStyledTextCtrl()
2434                 PixelWidth = integer()
2435
2436              Sets the document width assumed for scrolling.
2437
2438       getScrollWidth(This) -> integer()
2439
2440              Types:
2441
2442                 This = wxStyledTextCtrl()
2443
2444              Retrieve the document width assumed for scrolling.
2445
2446       textWidth(This, Style, Text) -> integer()
2447
2448              Types:
2449
2450                 This = wxStyledTextCtrl()
2451                 Style = integer()
2452                 Text = unicode:chardata()
2453
2454              Measure the pixel width of some text in a particular style.
2455
2456              Does not handle tab or control characters.
2457
2458       getEndAtLastLine(This) -> boolean()
2459
2460              Types:
2461
2462                 This = wxStyledTextCtrl()
2463
2464              Retrieve  whether  the maximum scroll position has the last line
2465              at the bottom of the view.
2466
2467       textHeight(This, Line) -> integer()
2468
2469              Types:
2470
2471                 This = wxStyledTextCtrl()
2472                 Line = integer()
2473
2474              Retrieve the height of a particular line of text in pixels.
2475
2476       setUseVerticalScrollBar(This, Visible) -> ok
2477
2478              Types:
2479
2480                 This = wxStyledTextCtrl()
2481                 Visible = boolean()
2482
2483              Show or hide the vertical scroll bar.
2484
2485       getUseVerticalScrollBar(This) -> boolean()
2486
2487              Types:
2488
2489                 This = wxStyledTextCtrl()
2490
2491              Is the vertical scroll bar visible?
2492
2493       appendText(This, Text) -> ok
2494
2495              Types:
2496
2497                 This = wxStyledTextCtrl()
2498                 Text = unicode:chardata()
2499
2500              Append a string to the end of the document without changing  the
2501              selection.
2502
2503       getTwoPhaseDraw(This) -> boolean()
2504
2505              Types:
2506
2507                 This = wxStyledTextCtrl()
2508
2509              Is  drawing  done  in  two  phases with backgrounds drawn before
2510              foregrounds?
2511
2512       setTwoPhaseDraw(This, TwoPhase) -> ok
2513
2514              Types:
2515
2516                 This = wxStyledTextCtrl()
2517                 TwoPhase = boolean()
2518
2519              In twoPhaseDraw mode, drawing is performed in two phases,  first
2520              the background and then the foreground.
2521
2522              This avoids chopping off characters that overlap the next run.
2523
2524       targetFromSelection(This) -> ok
2525
2526              Types:
2527
2528                 This = wxStyledTextCtrl()
2529
2530              Make the target range start and end be the same as the selection
2531              range start and end.
2532
2533       linesJoin(This) -> ok
2534
2535              Types:
2536
2537                 This = wxStyledTextCtrl()
2538
2539              Join the lines in the target.
2540
2541       linesSplit(This, PixelWidth) -> ok
2542
2543              Types:
2544
2545                 This = wxStyledTextCtrl()
2546                 PixelWidth = integer()
2547
2548              Split the lines in the target into lines that are less wide than
2549              pixelWidth where possible.
2550
2551       setFoldMarginColour(This, UseSetting, Back) -> ok
2552
2553              Types:
2554
2555                 This = wxStyledTextCtrl()
2556                 UseSetting = boolean()
2557                 Back = wx:wx_colour()
2558
2559              Set  one  of  the  colours used as a chequerboard pattern in the
2560              fold margin.
2561
2562       setFoldMarginHiColour(This, UseSetting, Fore) -> ok
2563
2564              Types:
2565
2566                 This = wxStyledTextCtrl()
2567                 UseSetting = boolean()
2568                 Fore = wx:wx_colour()
2569
2570              Set the other colour used as a chequerboard pattern in the  fold
2571              margin.
2572
2573       lineDown(This) -> ok
2574
2575              Types:
2576
2577                 This = wxStyledTextCtrl()
2578
2579              Move caret down one line.
2580
2581       lineDownExtend(This) -> ok
2582
2583              Types:
2584
2585                 This = wxStyledTextCtrl()
2586
2587              Move  caret down one line extending selection to new caret posi‐
2588              tion.
2589
2590       lineUp(This) -> ok
2591
2592              Types:
2593
2594                 This = wxStyledTextCtrl()
2595
2596              Move caret up one line.
2597
2598       lineUpExtend(This) -> ok
2599
2600              Types:
2601
2602                 This = wxStyledTextCtrl()
2603
2604              Move caret up one line extending selection to  new  caret  posi‐
2605              tion.
2606
2607       charLeft(This) -> ok
2608
2609              Types:
2610
2611                 This = wxStyledTextCtrl()
2612
2613              Move caret left one character.
2614
2615       charLeftExtend(This) -> ok
2616
2617              Types:
2618
2619                 This = wxStyledTextCtrl()
2620
2621              Move  caret  left one character extending selection to new caret
2622              position.
2623
2624       charRight(This) -> ok
2625
2626              Types:
2627
2628                 This = wxStyledTextCtrl()
2629
2630              Move caret right one character.
2631
2632       charRightExtend(This) -> ok
2633
2634              Types:
2635
2636                 This = wxStyledTextCtrl()
2637
2638              Move caret right one character extending selection to new  caret
2639              position.
2640
2641       wordLeft(This) -> ok
2642
2643              Types:
2644
2645                 This = wxStyledTextCtrl()
2646
2647              Move caret left one word.
2648
2649       wordLeftExtend(This) -> ok
2650
2651              Types:
2652
2653                 This = wxStyledTextCtrl()
2654
2655              Move  caret left one word extending selection to new caret posi‐
2656              tion.
2657
2658       wordRight(This) -> ok
2659
2660              Types:
2661
2662                 This = wxStyledTextCtrl()
2663
2664              Move caret right one word.
2665
2666       wordRightExtend(This) -> ok
2667
2668              Types:
2669
2670                 This = wxStyledTextCtrl()
2671
2672              Move caret right one word extending selection to new caret posi‐
2673              tion.
2674
2675       home(This) -> ok
2676
2677              Types:
2678
2679                 This = wxStyledTextCtrl()
2680
2681              Move caret to first position on line.
2682
2683       homeExtend(This) -> ok
2684
2685              Types:
2686
2687                 This = wxStyledTextCtrl()
2688
2689              Move  caret to first position on line extending selection to new
2690              caret position.
2691
2692       lineEnd(This) -> ok
2693
2694              Types:
2695
2696                 This = wxStyledTextCtrl()
2697
2698              Move caret to last position on line.
2699
2700       lineEndExtend(This) -> ok
2701
2702              Types:
2703
2704                 This = wxStyledTextCtrl()
2705
2706              Move caret to last position on line extending selection  to  new
2707              caret position.
2708
2709       documentStart(This) -> ok
2710
2711              Types:
2712
2713                 This = wxStyledTextCtrl()
2714
2715              Move caret to first position in document.
2716
2717       documentStartExtend(This) -> ok
2718
2719              Types:
2720
2721                 This = wxStyledTextCtrl()
2722
2723              Move  caret to first position in document extending selection to
2724              new caret position.
2725
2726       documentEnd(This) -> ok
2727
2728              Types:
2729
2730                 This = wxStyledTextCtrl()
2731
2732              Move caret to last position in document.
2733
2734       documentEndExtend(This) -> ok
2735
2736              Types:
2737
2738                 This = wxStyledTextCtrl()
2739
2740              Move caret to last position in document extending  selection  to
2741              new caret position.
2742
2743       pageUp(This) -> ok
2744
2745              Types:
2746
2747                 This = wxStyledTextCtrl()
2748
2749              Move caret one page up.
2750
2751       pageUpExtend(This) -> ok
2752
2753              Types:
2754
2755                 This = wxStyledTextCtrl()
2756
2757              Move  caret  one  page up extending selection to new caret posi‐
2758              tion.
2759
2760       pageDown(This) -> ok
2761
2762              Types:
2763
2764                 This = wxStyledTextCtrl()
2765
2766              Move caret one page down.
2767
2768       pageDownExtend(This) -> ok
2769
2770              Types:
2771
2772                 This = wxStyledTextCtrl()
2773
2774              Move caret one page down extending selection to new caret  posi‐
2775              tion.
2776
2777       editToggleOvertype(This) -> ok
2778
2779              Types:
2780
2781                 This = wxStyledTextCtrl()
2782
2783              Switch from insert to overtype mode or the reverse.
2784
2785       cancel(This) -> ok
2786
2787              Types:
2788
2789                 This = wxStyledTextCtrl()
2790
2791              Cancel  any  modes such as call tip or auto-completion list dis‐
2792              play.
2793
2794       deleteBack(This) -> ok
2795
2796              Types:
2797
2798                 This = wxStyledTextCtrl()
2799
2800              Delete the selection or if no selection,  the  character  before
2801              the caret.
2802
2803       tab(This) -> ok
2804
2805              Types:
2806
2807                 This = wxStyledTextCtrl()
2808
2809              If  selection  is empty or all on one line replace the selection
2810              with a tab character.
2811
2812              If more than one line selected, indent the lines.
2813
2814       backTab(This) -> ok
2815
2816              Types:
2817
2818                 This = wxStyledTextCtrl()
2819
2820              Dedent the selected lines.
2821
2822       newLine(This) -> ok
2823
2824              Types:
2825
2826                 This = wxStyledTextCtrl()
2827
2828              Insert a new line, may use a CRLF, CR or  LF  depending  on  EOL
2829              mode.
2830
2831       formFeed(This) -> ok
2832
2833              Types:
2834
2835                 This = wxStyledTextCtrl()
2836
2837              Insert a Form Feed character.
2838
2839       vCHome(This) -> ok
2840
2841              Types:
2842
2843                 This = wxStyledTextCtrl()
2844
2845              Move caret to before first visible character on line.
2846
2847              If already there move to first character on line.
2848
2849       vCHomeExtend(This) -> ok
2850
2851              Types:
2852
2853                 This = wxStyledTextCtrl()
2854
2855              Like VCHome but extending selection to new caret position.
2856
2857       zoomIn(This) -> ok
2858
2859              Types:
2860
2861                 This = wxStyledTextCtrl()
2862
2863              Magnify the displayed text by increasing the sizes by 1 point.
2864
2865       zoomOut(This) -> ok
2866
2867              Types:
2868
2869                 This = wxStyledTextCtrl()
2870
2871              Make  the  displayed  text  smaller by decreasing the sizes by 1
2872              point.
2873
2874       delWordLeft(This) -> ok
2875
2876              Types:
2877
2878                 This = wxStyledTextCtrl()
2879
2880              Delete the word to the left of the caret.
2881
2882       delWordRight(This) -> ok
2883
2884              Types:
2885
2886                 This = wxStyledTextCtrl()
2887
2888              Delete the word to the right of the caret.
2889
2890       lineCut(This) -> ok
2891
2892              Types:
2893
2894                 This = wxStyledTextCtrl()
2895
2896              Cut the line containing the caret.
2897
2898       lineDelete(This) -> ok
2899
2900              Types:
2901
2902                 This = wxStyledTextCtrl()
2903
2904              Delete the line containing the caret.
2905
2906       lineTranspose(This) -> ok
2907
2908              Types:
2909
2910                 This = wxStyledTextCtrl()
2911
2912              Switch the current line with the previous.
2913
2914       lineDuplicate(This) -> ok
2915
2916              Types:
2917
2918                 This = wxStyledTextCtrl()
2919
2920              Duplicate the current line.
2921
2922       lowerCase(This) -> ok
2923
2924              Types:
2925
2926                 This = wxStyledTextCtrl()
2927
2928              Transform the selection to lower case.
2929
2930       upperCase(This) -> ok
2931
2932              Types:
2933
2934                 This = wxStyledTextCtrl()
2935
2936              Transform the selection to upper case.
2937
2938       lineScrollDown(This) -> ok
2939
2940              Types:
2941
2942                 This = wxStyledTextCtrl()
2943
2944              Scroll the document down, keeping the caret visible.
2945
2946       lineScrollUp(This) -> ok
2947
2948              Types:
2949
2950                 This = wxStyledTextCtrl()
2951
2952              Scroll the document up, keeping the caret visible.
2953
2954       deleteBackNotLine(This) -> ok
2955
2956              Types:
2957
2958                 This = wxStyledTextCtrl()
2959
2960              Delete the selection or if no selection,  the  character  before
2961              the caret.
2962
2963              Will not delete the character before at the start of a line.
2964
2965       homeDisplay(This) -> ok
2966
2967              Types:
2968
2969                 This = wxStyledTextCtrl()
2970
2971              Move caret to first position on display line.
2972
2973       homeDisplayExtend(This) -> ok
2974
2975              Types:
2976
2977                 This = wxStyledTextCtrl()
2978
2979              Move caret to first position on display line extending selection
2980              to new caret position.
2981
2982       lineEndDisplay(This) -> ok
2983
2984              Types:
2985
2986                 This = wxStyledTextCtrl()
2987
2988              Move caret to last position on display line.
2989
2990       lineEndDisplayExtend(This) -> ok
2991
2992              Types:
2993
2994                 This = wxStyledTextCtrl()
2995
2996              Move caret to last position on display line extending  selection
2997              to new caret position.
2998
2999       homeWrapExtend(This) -> ok
3000
3001              Types:
3002
3003                 This = wxStyledTextCtrl()
3004
3005              Like  HomeExtend  but when word-wrap is enabled extends first to
3006              start of display line HomeDisplayExtend, then to start of  docu‐
3007              ment line HomeExtend.
3008
3009       lineEndWrap(This) -> ok
3010
3011              Types:
3012
3013                 This = wxStyledTextCtrl()
3014
3015              Like  LineEnd but when word-wrap is enabled goes first to end of
3016              display line LineEndDisplay, then to start of document line  Li‐
3017              neEnd.
3018
3019       lineEndWrapExtend(This) -> ok
3020
3021              Types:
3022
3023                 This = wxStyledTextCtrl()
3024
3025              Like  LineEndExtend  but when word-wrap is enabled extends first
3026              to end of display line LineEndDisplayExtend, then  to  start  of
3027              document line LineEndExtend.
3028
3029       vCHomeWrap(This) -> ok
3030
3031              Types:
3032
3033                 This = wxStyledTextCtrl()
3034
3035              Like VCHome but when word-wrap is enabled goes first to start of
3036              display line VCHomeDisplay, then behaves like VCHome.
3037
3038       vCHomeWrapExtend(This) -> ok
3039
3040              Types:
3041
3042                 This = wxStyledTextCtrl()
3043
3044              Like VCHomeExtend but when word-wrap is enabled extends first to
3045              start  of  display  line  VCHomeDisplayExtend, then behaves like
3046              VCHomeExtend.
3047
3048       lineCopy(This) -> ok
3049
3050              Types:
3051
3052                 This = wxStyledTextCtrl()
3053
3054              Copy the line containing the caret.
3055
3056       moveCaretInsideView(This) -> ok
3057
3058              Types:
3059
3060                 This = wxStyledTextCtrl()
3061
3062              Move the caret inside current view if it's not there already.
3063
3064       lineLength(This, Line) -> integer()
3065
3066              Types:
3067
3068                 This = wxStyledTextCtrl()
3069                 Line = integer()
3070
3071              How many characters are on a line, including end of line charac‐
3072              ters?
3073
3074       braceHighlight(This, PosA, PosB) -> ok
3075
3076              Types:
3077
3078                 This = wxStyledTextCtrl()
3079                 PosA = PosB = integer()
3080
3081              Highlight the characters at two positions.
3082
3083       braceBadLight(This, Pos) -> ok
3084
3085              Types:
3086
3087                 This = wxStyledTextCtrl()
3088                 Pos = integer()
3089
3090              Highlight  the  character  at  a position indicating there is no
3091              matching brace.
3092
3093       braceMatch(This, Pos) -> integer()
3094
3095              Types:
3096
3097                 This = wxStyledTextCtrl()
3098                 Pos = integer()
3099
3100              Find the position of a matching brace or  wxSTC_INVALID_POSITION
3101              if no match.
3102
3103       getViewEOL(This) -> boolean()
3104
3105              Types:
3106
3107                 This = wxStyledTextCtrl()
3108
3109              Are the end of line characters visible?
3110
3111       setViewEOL(This, Visible) -> ok
3112
3113              Types:
3114
3115                 This = wxStyledTextCtrl()
3116                 Visible = boolean()
3117
3118              Make the end of line characters visible or invisible.
3119
3120       setModEventMask(This, EventMask) -> ok
3121
3122              Types:
3123
3124                 This = wxStyledTextCtrl()
3125                 EventMask = integer()
3126
3127              Set  which  document  modification  events  are sent to the con‐
3128              tainer.
3129
3130              The input should be a bit list containing one  or  more  of  the
3131              ?wxSTC_MOD_*   constants,   the   ?wxSTC_PERFORMED_*  constants,
3132              wxSTC_STARTACTION,  wxSTC_MULTILINEUNDOREDO,  wxSTC_MULTISTEPUN‐
3133              DOREDO,  and  wxSTC_LASTSTEPINUNDOREDO.  The  input  can also be
3134              wxSTC_MODEVENTMASKALL to indicate that all changes should gener‐
3135              ate events.
3136
3137       getEdgeColumn(This) -> integer()
3138
3139              Types:
3140
3141                 This = wxStyledTextCtrl()
3142
3143              Retrieve the column number which text should be kept within.
3144
3145       setEdgeColumn(This, Column) -> ok
3146
3147              Types:
3148
3149                 This = wxStyledTextCtrl()
3150                 Column = integer()
3151
3152              Set the column number of the edge.
3153
3154              If text goes past the edge then it is highlighted.
3155
3156       setEdgeMode(This, EdgeMode) -> ok
3157
3158              Types:
3159
3160                 This = wxStyledTextCtrl()
3161                 EdgeMode = integer()
3162
3163              The      edge     may     be     displayed     by     a     line
3164              (wxSTC_EDGE_LINE/wxSTC_EDGE_MULTILINE) or by  highlighting  text
3165              that  goes beyond it (wxSTC_EDGE_BACKGROUND) or not displayed at
3166              all (wxSTC_EDGE_NONE).
3167
3168              The input should be one of the ?wxSTC_EDGE_* constants.
3169
3170       getEdgeMode(This) -> integer()
3171
3172              Types:
3173
3174                 This = wxStyledTextCtrl()
3175
3176              Retrieve the edge highlight mode.
3177
3178              The return value will be one of the ?wxSTC_EDGE_* constants.
3179
3180       getEdgeColour(This) -> wx:wx_colour4()
3181
3182              Types:
3183
3184                 This = wxStyledTextCtrl()
3185
3186              Retrieve the colour used in edge indication.
3187
3188       setEdgeColour(This, EdgeColour) -> ok
3189
3190              Types:
3191
3192                 This = wxStyledTextCtrl()
3193                 EdgeColour = wx:wx_colour()
3194
3195              Change the colour used in edge indication.
3196
3197       searchAnchor(This) -> ok
3198
3199              Types:
3200
3201                 This = wxStyledTextCtrl()
3202
3203              Sets the current caret position to be the search anchor.
3204
3205       searchNext(This, SearchFlags, Text) -> integer()
3206
3207              Types:
3208
3209                 This = wxStyledTextCtrl()
3210                 SearchFlags = integer()
3211                 Text = unicode:chardata()
3212
3213              Find some text starting at the search anchor.
3214
3215              Does not ensure the selection is visible.
3216
3217       searchPrev(This, SearchFlags, Text) -> integer()
3218
3219              Types:
3220
3221                 This = wxStyledTextCtrl()
3222                 SearchFlags = integer()
3223                 Text = unicode:chardata()
3224
3225              Find some text starting at the search anchor  and  moving  back‐
3226              wards.
3227
3228              Does not ensure the selection is visible.
3229
3230       linesOnScreen(This) -> integer()
3231
3232              Types:
3233
3234                 This = wxStyledTextCtrl()
3235
3236              Retrieves the number of lines completely visible.
3237
3238       usePopUp(This, PopUpMode) -> ok
3239
3240              Types:
3241
3242                 This = wxStyledTextCtrl()
3243                 PopUpMode = integer()
3244
3245              Set  whether  a  pop up menu is displayed automatically when the
3246              user presses the wrong mouse button on certain areas.
3247
3248              The input should be one of the ?wxSTC_POPUP_* constants.
3249
3250              Remark: When wxContextMenuEvent is used to create a custom popup
3251              menu,  this  function  should  be called with wxSTC_POPUP_NEVER.
3252              Otherwise the default menu will be shown instead of  the  custom
3253              one.
3254
3255       selectionIsRectangle(This) -> boolean()
3256
3257              Types:
3258
3259                 This = wxStyledTextCtrl()
3260
3261              Is the selection rectangular? The alternative is the more common
3262              stream selection.
3263
3264       setZoom(This, ZoomInPoints) -> ok
3265
3266              Types:
3267
3268                 This = wxStyledTextCtrl()
3269                 ZoomInPoints = integer()
3270
3271              Set the zoom level.
3272
3273              This number of points is added to the size of all fonts. It  may
3274              be positive to magnify or negative to reduce.
3275
3276       getZoom(This) -> integer()
3277
3278              Types:
3279
3280                 This = wxStyledTextCtrl()
3281
3282              Retrieve the zoom level.
3283
3284       getModEventMask(This) -> integer()
3285
3286              Types:
3287
3288                 This = wxStyledTextCtrl()
3289
3290              Get  which  document  modification  events  are sent to the con‐
3291              tainer.
3292
3293              The return value will wxSTC_MODEVENTMASKALL if all changes  gen‐
3294              erate  events. Otherwise it will be a bit list containing one or
3295              more of the ?wxSTC_MOD_* constants, the ?wxSTC_PERFORMED_*  con‐
3296              stants, wxSTC_STARTACTION, wxSTC_MULTILINEUNDOREDO, wxSTC_MULTI‐
3297              STEPUNDOREDO, and wxSTC_LASTSTEPINUNDOREDO.
3298
3299       setSTCFocus(This, Focus) -> ok
3300
3301              Types:
3302
3303                 This = wxStyledTextCtrl()
3304                 Focus = boolean()
3305
3306              Change internal focus flag.
3307
3308       getSTCFocus(This) -> boolean()
3309
3310              Types:
3311
3312                 This = wxStyledTextCtrl()
3313
3314              Get internal focus flag.
3315
3316       setStatus(This, Status) -> ok
3317
3318              Types:
3319
3320                 This = wxStyledTextCtrl()
3321                 Status = integer()
3322
3323              Change error status - 0 = OK.
3324
3325              The input should be one of the ?wxSTC_STATUS_* constants.
3326
3327       getStatus(This) -> integer()
3328
3329              Types:
3330
3331                 This = wxStyledTextCtrl()
3332
3333              Get error status.
3334
3335              The return value will be one of the ?wxSTC_STATUS_* constants.
3336
3337       setMouseDownCaptures(This, Captures) -> ok
3338
3339              Types:
3340
3341                 This = wxStyledTextCtrl()
3342                 Captures = boolean()
3343
3344              Set whether the mouse is captured when its button is pressed.
3345
3346       getMouseDownCaptures(This) -> boolean()
3347
3348              Types:
3349
3350                 This = wxStyledTextCtrl()
3351
3352              Get whether mouse gets captured.
3353
3354       setSTCCursor(This, CursorType) -> ok
3355
3356              Types:
3357
3358                 This = wxStyledTextCtrl()
3359                 CursorType = integer()
3360
3361              Sets the cursor to one of the wxSTC_CURSOR* values.
3362
3363       getSTCCursor(This) -> integer()
3364
3365              Types:
3366
3367                 This = wxStyledTextCtrl()
3368
3369              Get cursor type.
3370
3371              The return value will be one of the ?wxSTC_CURSOR* constants.
3372
3373       setControlCharSymbol(This, Symbol) -> ok
3374
3375              Types:
3376
3377                 This = wxStyledTextCtrl()
3378                 Symbol = integer()
3379
3380              Change the way control characters are displayed: If symbol is  <
3381              32, keep the drawn way, else, use the given character.
3382
3383       getControlCharSymbol(This) -> integer()
3384
3385              Types:
3386
3387                 This = wxStyledTextCtrl()
3388
3389              Get the way control characters are displayed.
3390
3391       wordPartLeft(This) -> ok
3392
3393              Types:
3394
3395                 This = wxStyledTextCtrl()
3396
3397              Move to the previous change in capitalisation.
3398
3399       wordPartLeftExtend(This) -> ok
3400
3401              Types:
3402
3403                 This = wxStyledTextCtrl()
3404
3405              Move  to  the previous change in capitalisation extending selec‐
3406              tion to new caret position.
3407
3408       wordPartRight(This) -> ok
3409
3410              Types:
3411
3412                 This = wxStyledTextCtrl()
3413
3414              Move to the change next in capitalisation.
3415
3416       wordPartRightExtend(This) -> ok
3417
3418              Types:
3419
3420                 This = wxStyledTextCtrl()
3421
3422              Move to the next change in capitalisation extending selection to
3423              new caret position.
3424
3425       setVisiblePolicy(This, VisiblePolicy, VisibleSlop) -> ok
3426
3427              Types:
3428
3429                 This = wxStyledTextCtrl()
3430                 VisiblePolicy = VisibleSlop = integer()
3431
3432              Set  the  way  the  display area is determined when a particular
3433              line is to be moved to by Find, FindNext, GotoLine, etc.
3434
3435              The first argument should be a bit list containing one  or  more
3436              of the ?wxSTC_VISIBLE_* constants.
3437
3438       delLineLeft(This) -> ok
3439
3440              Types:
3441
3442                 This = wxStyledTextCtrl()
3443
3444              Delete back from the current position to the start of the line.
3445
3446       delLineRight(This) -> ok
3447
3448              Types:
3449
3450                 This = wxStyledTextCtrl()
3451
3452              Delete  forwards  from  the  current  position to the end of the
3453              line.
3454
3455       getXOffset(This) -> integer()
3456
3457              Types:
3458
3459                 This = wxStyledTextCtrl()
3460
3461              Get the xOffset (ie, horizontal scroll position).
3462
3463       chooseCaretX(This) -> ok
3464
3465              Types:
3466
3467                 This = wxStyledTextCtrl()
3468
3469              Set the last x chosen value to be the caret x position.
3470
3471       setXCaretPolicy(This, CaretPolicy, CaretSlop) -> ok
3472
3473              Types:
3474
3475                 This = wxStyledTextCtrl()
3476                 CaretPolicy = CaretSlop = integer()
3477
3478              Set the way the caret is kept visible when going sideways.
3479
3480              The exclusion zone is given in pixels.
3481
3482              The first argument should be a bit list containing one  or  more
3483              of the ?wxSTC_CARET_* constants.
3484
3485       setYCaretPolicy(This, CaretPolicy, CaretSlop) -> ok
3486
3487              Types:
3488
3489                 This = wxStyledTextCtrl()
3490                 CaretPolicy = CaretSlop = integer()
3491
3492              Set the way the line the caret is on is kept visible.
3493
3494              The exclusion zone is given in lines.
3495
3496              The  first  argument should be a bit list containing one or more
3497              of the ?wxSTC_CARET_* constants.
3498
3499       getPrintWrapMode(This) -> integer()
3500
3501              Types:
3502
3503                 This = wxStyledTextCtrl()
3504
3505              Is printing line wrapped?
3506
3507              The return value will be one of the ?wxSTC_WRAP_* constants.
3508
3509       setHotspotActiveForeground(This, UseSetting, Fore) -> ok
3510
3511              Types:
3512
3513                 This = wxStyledTextCtrl()
3514                 UseSetting = boolean()
3515                 Fore = wx:wx_colour()
3516
3517              Set a fore colour for active hotspots.
3518
3519       setHotspotActiveBackground(This, UseSetting, Back) -> ok
3520
3521              Types:
3522
3523                 This = wxStyledTextCtrl()
3524                 UseSetting = boolean()
3525                 Back = wx:wx_colour()
3526
3527              Set a back colour for active hotspots.
3528
3529       setHotspotActiveUnderline(This, Underline) -> ok
3530
3531              Types:
3532
3533                 This = wxStyledTextCtrl()
3534                 Underline = boolean()
3535
3536              Enable / Disable underlining active hotspots.
3537
3538       setHotspotSingleLine(This, SingleLine) -> ok
3539
3540              Types:
3541
3542                 This = wxStyledTextCtrl()
3543                 SingleLine = boolean()
3544
3545              Limit hotspots to single line so hotspots  on  two  lines  don't
3546              merge.
3547
3548       paraDownExtend(This) -> ok
3549
3550              Types:
3551
3552                 This = wxStyledTextCtrl()
3553
3554              Extend selection down one paragraph (delimited by empty lines).
3555
3556       paraUp(This) -> ok
3557
3558              Types:
3559
3560                 This = wxStyledTextCtrl()
3561
3562              Move caret up one paragraph (delimited by empty lines).
3563
3564       paraUpExtend(This) -> ok
3565
3566              Types:
3567
3568                 This = wxStyledTextCtrl()
3569
3570              Extend selection up one paragraph (delimited by empty lines).
3571
3572       positionBefore(This, Pos) -> integer()
3573
3574              Types:
3575
3576                 This = wxStyledTextCtrl()
3577                 Pos = integer()
3578
3579              Given  a  valid  document position, return the previous position
3580              taking code page into account.
3581
3582              Returns 0 if passed 0.
3583
3584       positionAfter(This, Pos) -> integer()
3585
3586              Types:
3587
3588                 This = wxStyledTextCtrl()
3589                 Pos = integer()
3590
3591              Given a valid document position, return the next position taking
3592              code page into account.
3593
3594              Maximum value returned is the last position in the document.
3595
3596       copyRange(This, Start, End) -> ok
3597
3598              Types:
3599
3600                 This = wxStyledTextCtrl()
3601                 Start = End = integer()
3602
3603              Copy a range of text to the clipboard.
3604
3605              Positions are clipped into the document.
3606
3607       copyText(This, Length, Text) -> ok
3608
3609              Types:
3610
3611                 This = wxStyledTextCtrl()
3612                 Length = integer()
3613                 Text = unicode:chardata()
3614
3615              Copy argument text to the clipboard.
3616
3617       setSelectionMode(This, SelectionMode) -> ok
3618
3619              Types:
3620
3621                 This = wxStyledTextCtrl()
3622                 SelectionMode = integer()
3623
3624              Set the selection mode to stream (wxSTC_SEL_STREAM) or rectangu‐
3625              lar    (wxSTC_SEL_RECTANGLE/wxSTC_SEL_THIN)    or    by    lines
3626              (wxSTC_SEL_LINES).
3627
3628       getSelectionMode(This) -> integer()
3629
3630              Types:
3631
3632                 This = wxStyledTextCtrl()
3633
3634              Get the mode of the current selection.
3635
3636              The return value will be one of the ?wxSTC_SEL_* constants.
3637
3638       lineDownRectExtend(This) -> ok
3639
3640              Types:
3641
3642                 This = wxStyledTextCtrl()
3643
3644              Move caret down one line, extending rectangular selection to new
3645              caret position.
3646
3647       lineUpRectExtend(This) -> ok
3648
3649              Types:
3650
3651                 This = wxStyledTextCtrl()
3652
3653              Move caret up one line, extending rectangular selection  to  new
3654              caret position.
3655
3656       charLeftRectExtend(This) -> ok
3657
3658              Types:
3659
3660                 This = wxStyledTextCtrl()
3661
3662              Move  caret  left one character, extending rectangular selection
3663              to new caret position.
3664
3665       charRightRectExtend(This) -> ok
3666
3667              Types:
3668
3669                 This = wxStyledTextCtrl()
3670
3671              Move caret right one character, extending rectangular  selection
3672              to new caret position.
3673
3674       homeRectExtend(This) -> ok
3675
3676              Types:
3677
3678                 This = wxStyledTextCtrl()
3679
3680              Move  caret to first position on line, extending rectangular se‐
3681              lection to new caret position.
3682
3683       vCHomeRectExtend(This) -> ok
3684
3685              Types:
3686
3687                 This = wxStyledTextCtrl()
3688
3689              Move caret to before first visible character on line.
3690
3691              If already there move to first  character  on  line.  In  either
3692              case, extend rectangular selection to new caret position.
3693
3694       lineEndRectExtend(This) -> ok
3695
3696              Types:
3697
3698                 This = wxStyledTextCtrl()
3699
3700              Move  caret  to last position on line, extending rectangular se‐
3701              lection to new caret position.
3702
3703       pageUpRectExtend(This) -> ok
3704
3705              Types:
3706
3707                 This = wxStyledTextCtrl()
3708
3709              Move caret one page up, extending rectangular selection  to  new
3710              caret position.
3711
3712       pageDownRectExtend(This) -> ok
3713
3714              Types:
3715
3716                 This = wxStyledTextCtrl()
3717
3718              Move caret one page down, extending rectangular selection to new
3719              caret position.
3720
3721       stutteredPageUp(This) -> ok
3722
3723              Types:
3724
3725                 This = wxStyledTextCtrl()
3726
3727              Move caret to top of page, or one page up if already at  top  of
3728              page.
3729
3730       stutteredPageUpExtend(This) -> ok
3731
3732              Types:
3733
3734                 This = wxStyledTextCtrl()
3735
3736              Move  caret  to top of page, or one page up if already at top of
3737              page, extending selection to new caret position.
3738
3739       stutteredPageDown(This) -> ok
3740
3741              Types:
3742
3743                 This = wxStyledTextCtrl()
3744
3745              Move caret to bottom of page, or one page  down  if  already  at
3746              bottom of page.
3747
3748       stutteredPageDownExtend(This) -> ok
3749
3750              Types:
3751
3752                 This = wxStyledTextCtrl()
3753
3754              Move  caret  to  bottom  of page, or one page down if already at
3755              bottom of page, extending selection to new caret position.
3756
3757       wordLeftEnd(This) -> ok
3758
3759              Types:
3760
3761                 This = wxStyledTextCtrl()
3762
3763              Move caret left one word, position cursor at end of word.
3764
3765       wordLeftEndExtend(This) -> ok
3766
3767              Types:
3768
3769                 This = wxStyledTextCtrl()
3770
3771              Move caret left one word, position cursor at end  of  word,  ex‐
3772              tending selection to new caret position.
3773
3774       wordRightEnd(This) -> ok
3775
3776              Types:
3777
3778                 This = wxStyledTextCtrl()
3779
3780              Move caret right one word, position cursor at end of word.
3781
3782       wordRightEndExtend(This) -> ok
3783
3784              Types:
3785
3786                 This = wxStyledTextCtrl()
3787
3788              Move  caret  right one word, position cursor at end of word, ex‐
3789              tending selection to new caret position.
3790
3791       setWhitespaceChars(This, Characters) -> ok
3792
3793              Types:
3794
3795                 This = wxStyledTextCtrl()
3796                 Characters = unicode:chardata()
3797
3798              Set the set of characters making up whitespace for  when  moving
3799              or selecting by word.
3800
3801              Should be called after SetWordChars.
3802
3803       setCharsDefault(This) -> ok
3804
3805              Types:
3806
3807                 This = wxStyledTextCtrl()
3808
3809              Reset  the  set of characters for whitespace and word characters
3810              to the defaults.
3811
3812       autoCompGetCurrent(This) -> integer()
3813
3814              Types:
3815
3816                 This = wxStyledTextCtrl()
3817
3818              Get currently selected  item  position  in  the  auto-completion
3819              list.
3820
3821       allocate(This, Bytes) -> ok
3822
3823              Types:
3824
3825                 This = wxStyledTextCtrl()
3826                 Bytes = integer()
3827
3828              Enlarge the document to a particular size of text bytes.
3829
3830       findColumn(This, Line, Column) -> integer()
3831
3832              Types:
3833
3834                 This = wxStyledTextCtrl()
3835                 Line = Column = integer()
3836
3837              Find the position of a column on a line taking into account tabs
3838              and multi-byte characters.
3839
3840              If beyond end of line, return line end position.
3841
3842       getCaretSticky(This) -> integer()
3843
3844              Types:
3845
3846                 This = wxStyledTextCtrl()
3847
3848              Can the caret preferred x position only be changed  by  explicit
3849              movement commands?
3850
3851              The  return  value  will be one of the ?wxSTC_CARETSTICKY_* con‐
3852              stants.
3853
3854       setCaretSticky(This, UseCaretStickyBehaviour) -> ok
3855
3856              Types:
3857
3858                 This = wxStyledTextCtrl()
3859                 UseCaretStickyBehaviour = integer()
3860
3861              Stop the caret preferred  x  position  changing  when  the  user
3862              types.
3863
3864              The input should be one of the ?wxSTC_CARETSTICKY_* constants.
3865
3866       toggleCaretSticky(This) -> ok
3867
3868              Types:
3869
3870                 This = wxStyledTextCtrl()
3871
3872              Switch  between  sticky  and  non-sticky: meant to be bound to a
3873              key.
3874
3875       setPasteConvertEndings(This, Convert) -> ok
3876
3877              Types:
3878
3879                 This = wxStyledTextCtrl()
3880                 Convert = boolean()
3881
3882              Enable/Disable convert-on-paste for line endings.
3883
3884       getPasteConvertEndings(This) -> boolean()
3885
3886              Types:
3887
3888                 This = wxStyledTextCtrl()
3889
3890              Get convert-on-paste setting.
3891
3892       selectionDuplicate(This) -> ok
3893
3894              Types:
3895
3896                 This = wxStyledTextCtrl()
3897
3898              Duplicate the selection.
3899
3900              If selection empty duplicate the line containing the caret.
3901
3902       setCaretLineBackAlpha(This, Alpha) -> ok
3903
3904              Types:
3905
3906                 This = wxStyledTextCtrl()
3907                 Alpha = integer()
3908
3909              Set background alpha of the caret line.
3910
3911       getCaretLineBackAlpha(This) -> integer()
3912
3913              Types:
3914
3915                 This = wxStyledTextCtrl()
3916
3917              Get the background alpha of the caret line.
3918
3919       startRecord(This) -> ok
3920
3921              Types:
3922
3923                 This = wxStyledTextCtrl()
3924
3925              Start notifying the container of all key presses and commands.
3926
3927       stopRecord(This) -> ok
3928
3929              Types:
3930
3931                 This = wxStyledTextCtrl()
3932
3933              Stop notifying the container of all key presses and commands.
3934
3935       setLexer(This, Lexer) -> ok
3936
3937              Types:
3938
3939                 This = wxStyledTextCtrl()
3940                 Lexer = integer()
3941
3942              Set the lexing language of the document.
3943
3944              The input should be one of the ?wxSTC_LEX_* constants.
3945
3946       getLexer(This) -> integer()
3947
3948              Types:
3949
3950                 This = wxStyledTextCtrl()
3951
3952              Retrieve the lexing language of the document.
3953
3954              The return value will be one of the ?wxSTC_LEX_* constants.
3955
3956       colourise(This, Start, End) -> ok
3957
3958              Types:
3959
3960                 This = wxStyledTextCtrl()
3961                 Start = End = integer()
3962
3963              Colourise a segment of the document  using  the  current  lexing
3964              language.
3965
3966       setProperty(This, Key, Value) -> ok
3967
3968              Types:
3969
3970                 This = wxStyledTextCtrl()
3971                 Key = Value = unicode:chardata()
3972
3973              Set  up  a  value  that may be used by a lexer for some optional
3974              feature.
3975
3976       setKeyWords(This, KeyWordSet, KeyWords) -> ok
3977
3978              Types:
3979
3980                 This = wxStyledTextCtrl()
3981                 KeyWordSet = integer()
3982                 KeyWords = unicode:chardata()
3983
3984              Set up the key words used by the lexer.
3985
3986       setLexerLanguage(This, Language) -> ok
3987
3988              Types:
3989
3990                 This = wxStyledTextCtrl()
3991                 Language = unicode:chardata()
3992
3993              Set the lexing language of the document based on string name.
3994
3995       getProperty(This, Key) -> unicode:charlist()
3996
3997              Types:
3998
3999                 This = wxStyledTextCtrl()
4000                 Key = unicode:chardata()
4001
4002              Retrieve a "property" value previously set with SetProperty.
4003
4004       getStyleBitsNeeded(This) -> integer()
4005
4006              Types:
4007
4008                 This = wxStyledTextCtrl()
4009
4010              Retrieve the number of bits the current lexer needs for styling.
4011
4012              Deprecated:
4013
4014       getCurrentLine(This) -> integer()
4015
4016              Types:
4017
4018                 This = wxStyledTextCtrl()
4019
4020              Returns the line number of the line with the caret.
4021
4022       styleSetSpec(This, StyleNum, Spec) -> ok
4023
4024              Types:
4025
4026                 This = wxStyledTextCtrl()
4027                 StyleNum = integer()
4028                 Spec = unicode:chardata()
4029
4030              Extract style settings from a spec-string which is  composed  of
4031              one or more of the following comma separated elements:
4032
4033              bold  turns  on  bold  italic  turns  on  italics  fore:[name or
4034              #RRGGBB] sets the foreground colour back:[name or #RRGGBB]  sets
4035              the background colour face:[facename] sets the font face name to
4036              use size:[num] sets the font size in points  eol  turns  on  eol
4037              filling underline turns on underlining
4038
4039       styleSetFont(This, StyleNum, Font) -> ok
4040
4041              Types:
4042
4043                 This = wxStyledTextCtrl()
4044                 StyleNum = integer()
4045                 Font = wxFont:wxFont()
4046
4047              Set  style  size,  face,  bold, italic, and underline attributes
4048              from a wxFont's attributes.
4049
4050       styleSetFontAttr(This, StyleNum, Size, FaceName, Bold, Italic,
4051                        Underline) ->
4052                           ok
4053
4054              Types:
4055
4056                 This = wxStyledTextCtrl()
4057                 StyleNum = Size = integer()
4058                 FaceName = unicode:chardata()
4059                 Bold = Italic = Underline = boolean()
4060
4061       styleSetFontAttr(This, StyleNum, Size, FaceName, Bold, Italic,
4062                        Underline,
4063                        Options :: [Option]) ->
4064                           ok
4065
4066              Types:
4067
4068                 This = wxStyledTextCtrl()
4069                 StyleNum = Size = integer()
4070                 FaceName = unicode:chardata()
4071                 Bold = Italic = Underline = boolean()
4072                 Option = {encoding, wx:wx_enum()}
4073
4074              Set all font style attributes at once.
4075
4076       styleSetCharacterSet(This, Style, CharacterSet) -> ok
4077
4078              Types:
4079
4080                 This = wxStyledTextCtrl()
4081                 Style = CharacterSet = integer()
4082
4083              Set the character set of the font in a style.
4084
4085              Converts the Scintilla character set values to a wxFontEncoding.
4086
4087       styleSetFontEncoding(This, Style, Encoding) -> ok
4088
4089              Types:
4090
4091                 This = wxStyledTextCtrl()
4092                 Style = integer()
4093                 Encoding = wx:wx_enum()
4094
4095              Set the font encoding to be used by a style.
4096
4097       cmdKeyExecute(This, Cmd) -> ok
4098
4099              Types:
4100
4101                 This = wxStyledTextCtrl()
4102                 Cmd = integer()
4103
4104              Perform one of the operations defined by  the  wxSTC_CMD_*  con‐
4105              stants.
4106
4107       setMargins(This, Left, Right) -> ok
4108
4109              Types:
4110
4111                 This = wxStyledTextCtrl()
4112                 Left = Right = integer()
4113
4114              Set the left and right margin in the edit area, measured in pix‐
4115              els.
4116
4117       getSelection(This) -> {From :: integer(), To :: integer()}
4118
4119              Types:
4120
4121                 This = wxStyledTextCtrl()
4122
4123              Gets the current selection span.
4124
4125              If the returned values are equal, there was no selection. Please
4126              note  that  the  indices returned may be used with the other wx‐
4127              TextCtrl methods but don't necessarily represent the correct in‐
4128              dices into the string returned by wxComboBox:getValue/1 for mul‐
4129              tiline controls under Windows (at least,)  you  should  use  wx‐
4130              TextCtrl:getStringSelection/1 to get the selected text.
4131
4132       pointFromPosition(This, Pos) -> {X :: integer(), Y :: integer()}
4133
4134              Types:
4135
4136                 This = wxStyledTextCtrl()
4137                 Pos = integer()
4138
4139              Retrieve the point in the window where a position is displayed.
4140
4141       scrollToLine(This, Line) -> ok
4142
4143              Types:
4144
4145                 This = wxStyledTextCtrl()
4146                 Line = integer()
4147
4148              Scroll enough to make the given line visible.
4149
4150       scrollToColumn(This, Column) -> ok
4151
4152              Types:
4153
4154                 This = wxStyledTextCtrl()
4155                 Column = integer()
4156
4157              Scroll enough to make the given column visible.
4158
4159       setVScrollBar(This, Bar) -> ok
4160
4161              Types:
4162
4163                 This = wxStyledTextCtrl()
4164                 Bar = wxScrollBar:wxScrollBar()
4165
4166              Set  the  vertical  scrollbar  to  use instead of the one that's
4167              built-in.
4168
4169       setHScrollBar(This, Bar) -> ok
4170
4171              Types:
4172
4173                 This = wxStyledTextCtrl()
4174                 Bar = wxScrollBar:wxScrollBar()
4175
4176              Set the horizontal scrollbar to use instead of  the  one  that's
4177              built-in.
4178
4179       getLastKeydownProcessed(This) -> boolean()
4180
4181              Types:
4182
4183                 This = wxStyledTextCtrl()
4184
4185              Can  be  used  to  prevent  the EVT_CHAR handler from adding the
4186              char.
4187
4188       setLastKeydownProcessed(This, Val) -> ok
4189
4190              Types:
4191
4192                 This = wxStyledTextCtrl()
4193                 Val = boolean()
4194
4195              Returns the line number of the line with the caret.
4196
4197       saveFile(This, Filename) -> boolean()
4198
4199              Types:
4200
4201                 This = wxStyledTextCtrl()
4202                 Filename = unicode:chardata()
4203
4204              Write the contents of the editor to filename.
4205
4206       loadFile(This, Filename) -> boolean()
4207
4208              Types:
4209
4210                 This = wxStyledTextCtrl()
4211                 Filename = unicode:chardata()
4212
4213              Load the contents of filename into the editor.
4214
4215       doDragOver(This, X, Y, DefaultRes) -> wx:wx_enum()
4216
4217              Types:
4218
4219                 This = wxStyledTextCtrl()
4220                 X = Y = integer()
4221                 DefaultRes = wx:wx_enum()
4222
4223              Allow for simulating a DnD DragOver.
4224
4225       doDropText(This, X, Y, Data) -> boolean()
4226
4227              Types:
4228
4229                 This = wxStyledTextCtrl()
4230                 X = Y = integer()
4231                 Data = unicode:chardata()
4232
4233              Allow for simulating a DnD DropText.
4234
4235       getUseAntiAliasing(This) -> boolean()
4236
4237              Types:
4238
4239                 This = wxStyledTextCtrl()
4240
4241              Returns the current UseAntiAliasing setting.
4242
4243       addTextRaw(This, Text) -> ok
4244
4245              Types:
4246
4247                 This = wxStyledTextCtrl()
4248                 Text = binary()
4249
4250       addTextRaw(This, Text, Options :: [Option]) -> ok
4251
4252              Types:
4253
4254                 This = wxStyledTextCtrl()
4255                 Text = binary()
4256                 Option = {length, integer()}
4257
4258              Add text to the document at current position.
4259
4260       insertTextRaw(This, Pos, Text) -> ok
4261
4262              Types:
4263
4264                 This = wxStyledTextCtrl()
4265                 Pos = integer()
4266                 Text = binary()
4267
4268              Insert string at a position.
4269
4270       getCurLineRaw(This) -> Result
4271
4272              Types:
4273
4274                 Result = {Res :: binary(), LinePos :: integer()}
4275                 This = wxStyledTextCtrl()
4276
4277              Retrieve the text of the line containing the caret.
4278
4279              Returns the index of the caret on the line.
4280
4281       getLineRaw(This, Line) -> binary()
4282
4283              Types:
4284
4285                 This = wxStyledTextCtrl()
4286                 Line = integer()
4287
4288              Retrieve the contents of a line.
4289
4290       getSelectedTextRaw(This) -> binary()
4291
4292              Types:
4293
4294                 This = wxStyledTextCtrl()
4295
4296              Retrieve the selected text.
4297
4298       getTextRangeRaw(This, StartPos, EndPos) -> binary()
4299
4300              Types:
4301
4302                 This = wxStyledTextCtrl()
4303                 StartPos = EndPos = integer()
4304
4305              Retrieve a range of text.
4306
4307       setTextRaw(This, Text) -> ok
4308
4309              Types:
4310
4311                 This = wxStyledTextCtrl()
4312                 Text = binary()
4313
4314              Replace the contents of the document with the argument text.
4315
4316       getTextRaw(This) -> binary()
4317
4318              Types:
4319
4320                 This = wxStyledTextCtrl()
4321
4322              Retrieve all the text in the document.
4323
4324       appendTextRaw(This, Text) -> ok
4325
4326              Types:
4327
4328                 This = wxStyledTextCtrl()
4329                 Text = binary()
4330
4331       appendTextRaw(This, Text, Options :: [Option]) -> ok
4332
4333              Types:
4334
4335                 This = wxStyledTextCtrl()
4336                 Text = binary()
4337                 Option = {length, integer()}
4338
4339              Append a string to the end of the document without changing  the
4340              selection.
4341
4342
4343
4344wxWidgets team.                     wx 2.1                 wxStyledTextCtrl(3)
Impressum