1wxStyledTextCtrl(3) Erlang Module Definition wxStyledTextCtrl(3)
2
6 wxStyledTextCtrl - Functions for wxStyledTextCtrl class
7
9 A wxWidgets implementation of the Scintilla source code editing compo‐
10 nent.
11 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 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 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 Please see wxStyledTextEvent for the documentation of all event types
28 you can use with wxStyledTextCtrl.
29 Index of the member groups
31 Links for quick access to the various categories of wxStyledTextCtrl
33 functions:
34 See: wxStyledTextEvent
36 This class is derived (and can use functions) from: wxControl wxWindow
38 wxEvtHandler
39 wxWidgets docs: wxStyledTextCtrl
41
43 wxStyledTextCtrl() = wx:wx_object()
44
46 new() -> wxStyledTextCtrl()
47 Default ctor.
49 new(Parent) -> wxStyledTextCtrl()
51 Types:
53 Parent = wxWindow:wxWindow()
55 new(Parent, Options :: [Option]) -> wxStyledTextCtrl()
57 Types:
59 Parent = wxWindow:wxWindow()
61 Option =
62 {id, integer()} |
63 {pos, {X :: integer(), Y :: integer()}} |
64 {size, {W :: integer(), H :: integer()}} |
65 {style, integer()}
66 Ctor.
68 destroy(This :: wxStyledTextCtrl()) -> ok
70 Destructor.
72 create(This, Parent) -> boolean()
74 Types:
76 This = wxStyledTextCtrl()
78 Parent = wxWindow:wxWindow()
79 create(This, Parent, Options :: [Option]) -> boolean()
81 Types:
83 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 Create the UI elements for a STC that was created with the de‐
93 fault ctor.
94 (For 2-phase create.)
96 addText(This, Text) -> ok
98 Types:
100 This = wxStyledTextCtrl()
102 Text = unicode:chardata()
103 Add text to the document at current position.
105 insertText(This, Pos, Text) -> ok
107 Types:
109 This = wxStyledTextCtrl()
111 Pos = integer()
112 Text = unicode:chardata()
113 Insert string at a position.
115 clearAll(This) -> ok
117 Types:
119 This = wxStyledTextCtrl()
121 Delete all text in the document.
123 clearDocumentStyle(This) -> ok
125 Types:
127 This = wxStyledTextCtrl()
129 Set all style bytes to 0, remove all folding information.
131 getLength(This) -> integer()
133 Types:
135 This = wxStyledTextCtrl()
137 Returns the number of bytes in the document.
139 getCharAt(This, Pos) -> integer()
141 Types:
143 This = wxStyledTextCtrl()
145 Pos = integer()
146 Returns the character byte at the position.
148 getCurrentPos(This) -> integer()
150 Types:
152 This = wxStyledTextCtrl()
154 Returns the position of the caret.
156 getAnchor(This) -> integer()
158 Types:
160 This = wxStyledTextCtrl()
162 Returns the position of the opposite end of the selection to the
164 caret.
165 getStyleAt(This, Pos) -> integer()
167 Types:
169 This = wxStyledTextCtrl()
171 Pos = integer()
172 Returns the style byte at the position.
174 redo(This) -> ok
176 Types:
178 This = wxStyledTextCtrl()
180 Redoes the next action on the undo history.
182 setUndoCollection(This, CollectUndo) -> ok
184 Types:
186 This = wxStyledTextCtrl()
188 CollectUndo = boolean()
189 Choose between collecting actions into the undo history and dis‐
191 carding them.
192 selectAll(This) -> ok
194 Types:
196 This = wxStyledTextCtrl()
198 Select all the text in the document.
200 setSavePoint(This) -> ok
202 Types:
204 This = wxStyledTextCtrl()
206 Remember the current position in the undo history as the posi‐
208 tion at which the document was saved.
209 canRedo(This) -> boolean()
211 Types:
213 This = wxStyledTextCtrl()
215 Are there any redoable actions in the undo history?
217 markerLineFromHandle(This, MarkerHandle) -> integer()
219 Types:
221 This = wxStyledTextCtrl()
223 MarkerHandle = integer()
224 Retrieve the line number at which a particular marker is lo‐
226 cated.
227 markerDeleteHandle(This, MarkerHandle) -> ok
229 Types:
231 This = wxStyledTextCtrl()
233 MarkerHandle = integer()
234 Delete a marker.
236 getUndoCollection(This) -> boolean()
238 Types:
240 This = wxStyledTextCtrl()
242 Is undo history being collected?
244 getViewWhiteSpace(This) -> integer()
246 Types:
248 This = wxStyledTextCtrl()
250 Are white space characters currently visible? Returns one of
252 wxSTC_WS_* constants.
253 setViewWhiteSpace(This, ViewWS) -> ok
255 Types:
257 This = wxStyledTextCtrl()
259 ViewWS = integer()
260 Make white space characters invisible, always visible or visible
262 outside indentation.
263 The input should be one of the ?wxSTC_WS_* constants.
265 positionFromPoint(This, Pt) -> integer()
267 Types:
269 This = wxStyledTextCtrl()
271 Pt = {X :: integer(), Y :: integer()}
272 Find the position from a point within the window.
274 positionFromPointClose(This, X, Y) -> integer()
276 Types:
278 This = wxStyledTextCtrl()
280 X = Y = integer()
281 Find the position from a point within the window but return
283 wxSTC_INVALID_POSITION if not close to text.
284 gotoLine(This, Line) -> ok
286 Types:
288 This = wxStyledTextCtrl()
290 Line = integer()
291 Set caret to start of a line and ensure it is visible.
293 gotoPos(This, Caret) -> ok
295 Types:
297 This = wxStyledTextCtrl()
299 Caret = integer()
300 Set caret to a position and ensure it is visible.
302 setAnchor(This, Anchor) -> ok
304 Types:
306 This = wxStyledTextCtrl()
308 Anchor = integer()
309 Set the selection anchor to a position.
311 The anchor is the opposite end of the selection from the caret.
313 getCurLine(This) -> Result
315 Types:
317 Result = {Res :: unicode:charlist(), LinePos :: integer()}
319 This = wxStyledTextCtrl()
320 Retrieve the text of the line containing the caret.
322 linePos can optionally be passed in to receive the index of the
324 caret on the line.
325 getEndStyled(This) -> integer()
327 Types:
329 This = wxStyledTextCtrl()
331 Retrieve the position of the last correctly styled character.
333 convertEOLs(This, EolMode) -> ok
335 Types:
337 This = wxStyledTextCtrl()
339 EolMode = integer()
340 Convert all line endings in the document to one mode.
342 getEOLMode(This) -> integer()
344 Types:
346 This = wxStyledTextCtrl()
348 Retrieve the current end of line mode - one of wxSTC_EOL_CRLF,
350 wxSTC_EOL_CR, or wxSTC_EOL_LF.
351 setEOLMode(This, EolMode) -> ok
353 Types:
355 This = wxStyledTextCtrl()
357 EolMode = integer()
358 Set the current end of line mode.
360 The input should be one of the ?wxSTC_EOL_* constants.
362 startStyling(This, Start) -> ok
364 Types:
366 This = wxStyledTextCtrl()
368 Start = integer()
369 Set the current styling position to start.
371 setStyling(This, Length, Style) -> ok
373 Types:
375 This = wxStyledTextCtrl()
377 Length = Style = integer()
378 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 getBufferedDraw(This) -> boolean()
384 Types:
386 This = wxStyledTextCtrl()
388 Is drawing done first into a buffer or direct to the screen?
390 setBufferedDraw(This, Buffered) -> ok
392 Types:
394 This = wxStyledTextCtrl()
396 Buffered = boolean()
397 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 setTabWidth(This, TabWidth) -> ok
402 Types:
404 This = wxStyledTextCtrl()
406 TabWidth = integer()
407 Change the visible size of a tab to be a multiple of the width
409 of a space character.
410 getTabWidth(This) -> integer()
412 Types:
414 This = wxStyledTextCtrl()
416 Retrieve the visible size of a tab.
418 setCodePage(This, CodePage) -> ok
420 Types:
422 This = wxStyledTextCtrl()
424 CodePage = integer()
425 Set the code page used to interpret the bytes of the document as
427 characters.
428 markerDefine(This, MarkerNumber, MarkerSymbol) -> ok
430 Types:
432 This = wxStyledTextCtrl()
434 MarkerNumber = MarkerSymbol = integer()
435 markerDefine(This, MarkerNumber, MarkerSymbol,
437 Options :: [Option]) ->
438 ok
439 Types:
441 This = wxStyledTextCtrl()
443 MarkerNumber = MarkerSymbol = integer()
444 Option =
445 {foreground, wx:wx_colour()} | {background,
446 wx:wx_colour()}
447 Set the symbol used for a particular marker number, and option‐
449 ally the fore and background colours.
450 The second argument should be one of the ?wxSTC_MARK_* con‐
452 stants.
453 markerSetForeground(This, MarkerNumber, Fore) -> ok
455 Types:
457 This = wxStyledTextCtrl()
459 MarkerNumber = integer()
460 Fore = wx:wx_colour()
461 Set the foreground colour used for a particular marker number.
463 markerSetBackground(This, MarkerNumber, Back) -> ok
465 Types:
467 This = wxStyledTextCtrl()
469 MarkerNumber = integer()
470 Back = wx:wx_colour()
471 Set the background colour used for a particular marker number.
473 markerAdd(This, Line, MarkerNumber) -> integer()
475 Types:
477 This = wxStyledTextCtrl()
479 Line = MarkerNumber = integer()
480 Add a marker to a line, returning an ID which can be used to
482 find or delete the marker.
483 markerDelete(This, Line, MarkerNumber) -> ok
485 Types:
487 This = wxStyledTextCtrl()
489 Line = MarkerNumber = integer()
490 Delete a marker from a line.
492 markerDeleteAll(This, MarkerNumber) -> ok
494 Types:
496 This = wxStyledTextCtrl()
498 MarkerNumber = integer()
499 Delete all markers with a particular number from all lines.
501 markerGet(This, Line) -> integer()
503 Types:
505 This = wxStyledTextCtrl()
507 Line = integer()
508 Get a bit mask of all the markers set on a line.
510 markerNext(This, LineStart, MarkerMask) -> integer()
512 Types:
514 This = wxStyledTextCtrl()
516 LineStart = MarkerMask = integer()
517 Find the next line at or after lineStart that includes a marker
519 in mask.
520 Return -1 when no more lines.
522 markerPrevious(This, LineStart, MarkerMask) -> integer()
524 Types:
526 This = wxStyledTextCtrl()
528 LineStart = MarkerMask = integer()
529 Find the previous line before lineStart that includes a marker
531 in mask.
532 markerDefineBitmap(This, MarkerNumber, Bmp) -> ok
534 Types:
536 This = wxStyledTextCtrl()
538 MarkerNumber = integer()
539 Bmp = wxBitmap:wxBitmap()
540 Define a marker with a wxBitmap.
542 markerAddSet(This, Line, MarkerSet) -> ok
544 Types:
546 This = wxStyledTextCtrl()
548 Line = MarkerSet = integer()
549 Add a set of markers to a line.
551 markerSetAlpha(This, MarkerNumber, Alpha) -> ok
553 Types:
555 This = wxStyledTextCtrl()
557 MarkerNumber = Alpha = integer()
558 Set the alpha used for a marker that is drawn in the text area,
560 not the margin.
561 setMarginType(This, Margin, MarginType) -> ok
563 Types:
565 This = wxStyledTextCtrl()
567 Margin = MarginType = integer()
568 Set a margin to be either numeric or symbolic.
570 The second argument should be one of the ?wxSTC_MARGIN_* con‐
572 stants.
573 getMarginType(This, Margin) -> integer()
575 Types:
577 This = wxStyledTextCtrl()
579 Margin = integer()
580 Retrieve the type of a margin.
582 The return value will be one of the ?wxSTC_MARGIN_* constants.
584 setMarginWidth(This, Margin, PixelWidth) -> ok
586 Types:
588 This = wxStyledTextCtrl()
590 Margin = PixelWidth = integer()
591 Set the width of a margin to a width expressed in pixels.
593 getMarginWidth(This, Margin) -> integer()
595 Types:
597 This = wxStyledTextCtrl()
599 Margin = integer()
600 Retrieve the width of a margin in pixels.
602 setMarginMask(This, Margin, Mask) -> ok
604 Types:
606 This = wxStyledTextCtrl()
608 Margin = Mask = integer()
609 Set a mask that determines which markers are displayed in a mar‐
611 gin.
612 getMarginMask(This, Margin) -> integer()
614 Types:
616 This = wxStyledTextCtrl()
618 Margin = integer()
619 Retrieve the marker mask of a margin.
621 setMarginSensitive(This, Margin, Sensitive) -> ok
623 Types:
625 This = wxStyledTextCtrl()
627 Margin = integer()
628 Sensitive = boolean()
629 Make a margin sensitive or insensitive to mouse clicks.
631 getMarginSensitive(This, Margin) -> boolean()
633 Types:
635 This = wxStyledTextCtrl()
637 Margin = integer()
638 Retrieve the mouse click sensitivity of a margin.
640 styleClearAll(This) -> ok
642 Types:
644 This = wxStyledTextCtrl()
646 Clear all the styles and make equivalent to the global default
648 style.
649 styleSetForeground(This, Style, Fore) -> ok
651 Types:
653 This = wxStyledTextCtrl()
655 Style = integer()
656 Fore = wx:wx_colour()
657 Set the foreground colour of a style.
659 styleSetBackground(This, Style, Back) -> ok
661 Types:
663 This = wxStyledTextCtrl()
665 Style = integer()
666 Back = wx:wx_colour()
667 Set the background colour of a style.
669 styleSetBold(This, Style, Bold) -> ok
671 Types:
673 This = wxStyledTextCtrl()
675 Style = integer()
676 Bold = boolean()
677 Set a style to be bold or not.
679 styleSetItalic(This, Style, Italic) -> ok
681 Types:
683 This = wxStyledTextCtrl()
685 Style = integer()
686 Italic = boolean()
687 Set a style to be italic or not.
689 styleSetSize(This, Style, SizePoints) -> ok
691 Types:
693 This = wxStyledTextCtrl()
695 Style = SizePoints = integer()
696 Set the size of characters of a style.
698 styleSetFaceName(This, Style, FontName) -> ok
700 Types:
702 This = wxStyledTextCtrl()
704 Style = integer()
705 FontName = unicode:chardata()
706 Set the font of a style.
708 styleSetEOLFilled(This, Style, EolFilled) -> ok
710 Types:
712 This = wxStyledTextCtrl()
714 Style = integer()
715 EolFilled = boolean()
716 Set a style to have its end of line filled or not.
718 styleResetDefault(This) -> ok
720 Types:
722 This = wxStyledTextCtrl()
724 Reset the default style to its state at startup.
726 styleSetUnderline(This, Style, Underline) -> ok
728 Types:
730 This = wxStyledTextCtrl()
732 Style = integer()
733 Underline = boolean()
734 Set a style to be underlined or not.
736 styleSetCase(This, Style, CaseVisible) -> ok
738 Types:
740 This = wxStyledTextCtrl()
742 Style = CaseVisible = integer()
743 Set a style to be mixed case, or to force upper or lower case.
745 The second argument should be one of the ?wxSTC_CASE_* con‐
747 stants.
748 styleSetHotSpot(This, Style, Hotspot) -> ok
750 Types:
752 This = wxStyledTextCtrl()
754 Style = integer()
755 Hotspot = boolean()
756 Set a style to be a hotspot or not.
758 setSelForeground(This, UseSetting, Fore) -> ok
760 Types:
762 This = wxStyledTextCtrl()
764 UseSetting = boolean()
765 Fore = wx:wx_colour()
766 Set the foreground colour of the main and additional selections
768 and whether to use this setting.
769 setSelBackground(This, UseSetting, Back) -> ok
771 Types:
773 This = wxStyledTextCtrl()
775 UseSetting = boolean()
776 Back = wx:wx_colour()
777 Set the background colour of the main and additional selections
779 and whether to use this setting.
780 getSelAlpha(This) -> integer()
782 Types:
784 This = wxStyledTextCtrl()
786 Get the alpha of the selection.
788 setSelAlpha(This, Alpha) -> ok
790 Types:
792 This = wxStyledTextCtrl()
794 Alpha = integer()
795 Set the alpha of the selection.
797 setCaretForeground(This, Fore) -> ok
799 Types:
801 This = wxStyledTextCtrl()
803 Fore = wx:wx_colour()
804 Set the foreground colour of the caret.
806 cmdKeyAssign(This, Key, Modifiers, Cmd) -> ok
808 Types:
810 This = wxStyledTextCtrl()
812 Key = Modifiers = Cmd = integer()
813 When key+modifier combination keyDefinition is pressed perform
815 sciCommand.
816 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 cmdKeyClear(This, Key, Modifiers) -> ok
822 Types:
824 This = wxStyledTextCtrl()
826 Key = Modifiers = integer()
827 When key+modifier combination keyDefinition is pressed do noth‐
829 ing.
830 The second argument should be a bit list containing one or more
832 of the ?wxSTC_KEYMOD_* constants.
833 cmdKeyClearAll(This) -> ok
835 Types:
837 This = wxStyledTextCtrl()
839 Drop all key mappings.
841 setStyleBytes(This, Length) -> integer()
843 Types:
845 This = wxStyledTextCtrl()
847 Length = integer()
848 Set the styles for a segment of the document.
850 styleSetVisible(This, Style, Visible) -> ok
852 Types:
854 This = wxStyledTextCtrl()
856 Style = integer()
857 Visible = boolean()
858 Set a style to be visible or not.
860 getCaretPeriod(This) -> integer()
862 Types:
864 This = wxStyledTextCtrl()
866 Get the time in milliseconds that the caret is on and off.
868 setCaretPeriod(This, PeriodMilliseconds) -> ok
870 Types:
872 This = wxStyledTextCtrl()
874 PeriodMilliseconds = integer()
875 Get the time in milliseconds that the caret is on and off.
877 0 = steady on.
879 setWordChars(This, Characters) -> ok
881 Types:
883 This = wxStyledTextCtrl()
885 Characters = unicode:chardata()
886 Set the set of characters making up words for when moving or se‐
888 lecting by word.
889 First sets defaults like SetCharsDefault.
891 beginUndoAction(This) -> ok
893 Types:
895 This = wxStyledTextCtrl()
897 Start a sequence of actions that is undone and redone as a unit.
899 May be nested.
901 endUndoAction(This) -> ok
903 Types:
905 This = wxStyledTextCtrl()
907 End a sequence of actions that is undone and redone as a unit.
909 indicatorSetStyle(This, Indicator, IndicatorStyle) -> ok
911 Types:
913 This = wxStyledTextCtrl()
915 Indicator = IndicatorStyle = integer()
916 Set an indicator to plain, squiggle or TT.
918 The second argument should be one of the ?wxSTC_INDIC_* con‐
920 stants.
921 indicatorGetStyle(This, Indicator) -> integer()
923 Types:
925 This = wxStyledTextCtrl()
927 Indicator = integer()
928 Retrieve the style of an indicator.
930 The return value will be one of the ?wxSTC_INDIC_* constants.
932 indicatorSetForeground(This, Indicator, Fore) -> ok
934 Types:
936 This = wxStyledTextCtrl()
938 Indicator = integer()
939 Fore = wx:wx_colour()
940 Set the foreground colour of an indicator.
942 indicatorGetForeground(This, Indicator) -> wx:wx_colour4()
944 Types:
946 This = wxStyledTextCtrl()
948 Indicator = integer()
949 Retrieve the foreground colour of an indicator.
951 setWhitespaceForeground(This, UseSetting, Fore) -> ok
953 Types:
955 This = wxStyledTextCtrl()
957 UseSetting = boolean()
958 Fore = wx:wx_colour()
959 Set the foreground colour of all whitespace and whether to use
961 this setting.
962 setWhitespaceBackground(This, UseSetting, Back) -> ok
964 Types:
966 This = wxStyledTextCtrl()
968 UseSetting = boolean()
969 Back = wx:wx_colour()
970 Set the background colour of all whitespace and whether to use
972 this setting.
973 getStyleBits(This) -> integer()
975 Types:
977 This = wxStyledTextCtrl()
979 Retrieve number of bits in style bytes used to hold the lexical
981 state.
982 Deprecated:
984 setLineState(This, Line, State) -> ok
986 Types:
988 This = wxStyledTextCtrl()
990 Line = State = integer()
991 Used to hold extra styling information for each line.
993 getLineState(This, Line) -> integer()
995 Types:
997 This = wxStyledTextCtrl()
999 Line = integer()
1000 Retrieve the extra styling information for a line.
1002 getMaxLineState(This) -> integer()
1004 Types:
1006 This = wxStyledTextCtrl()
1008 Retrieve the last line number that has line state.
1010 getCaretLineVisible(This) -> boolean()
1012 Types:
1014 This = wxStyledTextCtrl()
1016 Is the background of the line containing the caret in a differ‐
1018 ent colour?
1019 setCaretLineVisible(This, Show) -> ok
1021 Types:
1023 This = wxStyledTextCtrl()
1025 Show = boolean()
1026 Display the background of the line containing the caret in a
1028 different colour.
1029 getCaretLineBackground(This) -> wx:wx_colour4()
1031 Types:
1033 This = wxStyledTextCtrl()
1035 Get the colour of the background of the line containing the
1037 caret.
1038 setCaretLineBackground(This, Back) -> ok
1040 Types:
1042 This = wxStyledTextCtrl()
1044 Back = wx:wx_colour()
1045 Set the colour of the background of the line containing the
1047 caret.
1048 autoCompShow(This, LengthEntered, ItemList) -> ok
1050 Types:
1052 This = wxStyledTextCtrl()
1054 LengthEntered = integer()
1055 ItemList = unicode:chardata()
1056 Display a auto-completion list.
1058 The lengthEntered parameter indicates how many characters before
1060 the caret should be used to provide context.
1061 autoCompCancel(This) -> ok
1063 Types:
1065 This = wxStyledTextCtrl()
1067 Remove the auto-completion list from the screen.
1069 autoCompActive(This) -> boolean()
1071 Types:
1073 This = wxStyledTextCtrl()
1075 Is there an auto-completion list visible?
1077 autoCompPosStart(This) -> integer()
1079 Types:
1081 This = wxStyledTextCtrl()
1083 Retrieve the position of the caret when the auto-completion list
1085 was displayed.
1086 autoCompComplete(This) -> ok
1088 Types:
1090 This = wxStyledTextCtrl()
1092 User has selected an item so remove the list and insert the se‐
1094 lection.
1095 autoCompStops(This, CharacterSet) -> ok
1097 Types:
1099 This = wxStyledTextCtrl()
1101 CharacterSet = unicode:chardata()
1102 Define a set of character that when typed cancel the auto-com‐
1104 pletion list.
1105 autoCompSetSeparator(This, SeparatorCharacter) -> ok
1107 Types:
1109 This = wxStyledTextCtrl()
1111 SeparatorCharacter = integer()
1112 Change the separator character in the string setting up an auto-
1114 completion list.
1115 Default is space but can be changed if items contain space.
1117 autoCompGetSeparator(This) -> integer()
1119 Types:
1121 This = wxStyledTextCtrl()
1123 Retrieve the auto-completion list separator character.
1125 autoCompSelect(This, Select) -> ok
1127 Types:
1129 This = wxStyledTextCtrl()
1131 Select = unicode:chardata()
1132 Select the item in the auto-completion list that starts with a
1134 string.
1135 autoCompSetCancelAtStart(This, Cancel) -> ok
1137 Types:
1139 This = wxStyledTextCtrl()
1141 Cancel = boolean()
1142 Should the auto-completion list be cancelled if the user
1144 backspaces to a position before where the box was created.
1145 autoCompGetCancelAtStart(This) -> boolean()
1147 Types:
1149 This = wxStyledTextCtrl()
1151 Retrieve whether auto-completion cancelled by backspacing before
1153 start.
1154 autoCompSetFillUps(This, CharacterSet) -> ok
1156 Types:
1158 This = wxStyledTextCtrl()
1160 CharacterSet = unicode:chardata()
1161 Define a set of characters that when typed will cause the auto‐
1163 completion to choose the selected item.
1164 autoCompSetChooseSingle(This, ChooseSingle) -> ok
1166 Types:
1168 This = wxStyledTextCtrl()
1170 ChooseSingle = boolean()
1171 Should a single item auto-completion list automatically choose
1173 the item.
1174 autoCompGetChooseSingle(This) -> boolean()
1176 Types:
1178 This = wxStyledTextCtrl()
1180 Retrieve whether a single item auto-completion list automati‐
1182 cally choose the item.
1183 autoCompSetIgnoreCase(This, IgnoreCase) -> ok
1185 Types:
1187 This = wxStyledTextCtrl()
1189 IgnoreCase = boolean()
1190 Set whether case is significant when performing auto-completion
1192 searches.
1193 autoCompGetIgnoreCase(This) -> boolean()
1195 Types:
1197 This = wxStyledTextCtrl()
1199 Retrieve state of ignore case flag.
1201 userListShow(This, ListType, ItemList) -> ok
1203 Types:
1205 This = wxStyledTextCtrl()
1207 ListType = integer()
1208 ItemList = unicode:chardata()
1209 Display a list of strings and send notification when user
1211 chooses one.
1212 autoCompSetAutoHide(This, AutoHide) -> ok
1214 Types:
1216 This = wxStyledTextCtrl()
1218 AutoHide = boolean()
1219 Set whether or not autocompletion is hidden automatically when
1221 nothing matches.
1222 autoCompGetAutoHide(This) -> boolean()
1224 Types:
1226 This = wxStyledTextCtrl()
1228 Retrieve whether or not autocompletion is hidden automatically
1230 when nothing matches.
1231 autoCompSetDropRestOfWord(This, DropRestOfWord) -> ok
1233 Types:
1235 This = wxStyledTextCtrl()
1237 DropRestOfWord = boolean()
1238 Set whether or not autocompletion deletes any word characters
1240 after the inserted text upon completion.
1241 autoCompGetDropRestOfWord(This) -> boolean()
1243 Types:
1245 This = wxStyledTextCtrl()
1247 Retrieve whether or not autocompletion deletes any word charac‐
1249 ters after the inserted text upon completion.
1250 registerImage(This, Type, Bmp) -> ok
1252 Types:
1254 This = wxStyledTextCtrl()
1256 Type = integer()
1257 Bmp = wxBitmap:wxBitmap()
1258 Register an image for use in autocompletion lists.
1260 clearRegisteredImages(This) -> ok
1262 Types:
1264 This = wxStyledTextCtrl()
1266 Clear all the registered images.
1268 autoCompGetTypeSeparator(This) -> integer()
1270 Types:
1272 This = wxStyledTextCtrl()
1274 Retrieve the auto-completion list type-separator character.
1276 autoCompSetTypeSeparator(This, SeparatorCharacter) -> ok
1278 Types:
1280 This = wxStyledTextCtrl()
1282 SeparatorCharacter = integer()
1283 Change the type-separator character in the string setting up an
1285 auto-completion list.
1286 Default is '?' but can be changed if items contain '?'.
1288 autoCompSetMaxWidth(This, CharacterCount) -> ok
1290 Types:
1292 This = wxStyledTextCtrl()
1294 CharacterCount = integer()
1295 Set the maximum width, in characters, of auto-completion and
1297 user lists.
1298 Set to 0 to autosize to fit longest item, which is the default.
1300 autoCompGetMaxWidth(This) -> integer()
1302 Types:
1304 This = wxStyledTextCtrl()
1306 Get the maximum width, in characters, of auto-completion and
1308 user lists.
1309 autoCompSetMaxHeight(This, RowCount) -> ok
1311 Types:
1313 This = wxStyledTextCtrl()
1315 RowCount = integer()
1316 Set the maximum height, in rows, of auto-completion and user
1318 lists.
1319 The default is 5 rows.
1321 autoCompGetMaxHeight(This) -> integer()
1323 Types:
1325 This = wxStyledTextCtrl()
1327 Set the maximum height, in rows, of auto-completion and user
1329 lists.
1330 setIndent(This, IndentSize) -> ok
1332 Types:
1334 This = wxStyledTextCtrl()
1336 IndentSize = integer()
1337 Set the number of spaces used for one level of indentation.
1339 getIndent(This) -> integer()
1341 Types:
1343 This = wxStyledTextCtrl()
1345 Retrieve indentation size.
1347 setUseTabs(This, UseTabs) -> ok
1349 Types:
1351 This = wxStyledTextCtrl()
1353 UseTabs = boolean()
1354 Indentation will only use space characters if useTabs is false,
1356 otherwise it will use a combination of tabs and spaces.
1357 getUseTabs(This) -> boolean()
1359 Types:
1361 This = wxStyledTextCtrl()
1363 Retrieve whether tabs will be used in indentation.
1365 setLineIndentation(This, Line, Indentation) -> ok
1367 Types:
1369 This = wxStyledTextCtrl()
1371 Line = Indentation = integer()
1372 Change the indentation of a line to a number of columns.
1374 getLineIndentation(This, Line) -> integer()
1376 Types:
1378 This = wxStyledTextCtrl()
1380 Line = integer()
1381 Retrieve the number of columns that a line is indented.
1383 getLineIndentPosition(This, Line) -> integer()
1385 Types:
1387 This = wxStyledTextCtrl()
1389 Line = integer()
1390 Retrieve the position before the first non indentation character
1392 on a line.
1393 getColumn(This, Pos) -> integer()
1395 Types:
1397 This = wxStyledTextCtrl()
1399 Pos = integer()
1400 Retrieve the column number of a position, taking tab width into
1402 account.
1403 setUseHorizontalScrollBar(This, Visible) -> ok
1405 Types:
1407 This = wxStyledTextCtrl()
1409 Visible = boolean()
1410 Show or hide the horizontal scroll bar.
1412 getUseHorizontalScrollBar(This) -> boolean()
1414 Types:
1416 This = wxStyledTextCtrl()
1418 Is the horizontal scroll bar visible?
1420 setIndentationGuides(This, IndentView) -> ok
1422 Types:
1424 This = wxStyledTextCtrl()
1426 IndentView = integer()
1427 Show or hide indentation guides.
1429 The input should be one of the ?wxSTC_IV_* constants.
1431 getIndentationGuides(This) -> integer()
1433 Types:
1435 This = wxStyledTextCtrl()
1437 Are the indentation guides visible?
1439 The return value will be one of the ?wxSTC_IV_* constants.
1441 setHighlightGuide(This, Column) -> ok
1443 Types:
1445 This = wxStyledTextCtrl()
1447 Column = integer()
1448 Set the highlighted indentation guide column.
1450 0 = no highlighted guide.
1452 getHighlightGuide(This) -> integer()
1454 Types:
1456 This = wxStyledTextCtrl()
1458 Get the highlighted indentation guide column.
1460 getLineEndPosition(This, Line) -> integer()
1462 Types:
1464 This = wxStyledTextCtrl()
1466 Line = integer()
1467 Get the position after the last visible characters on a line.
1469 getCodePage(This) -> integer()
1471 Types:
1473 This = wxStyledTextCtrl()
1475 Get the code page used to interpret the bytes of the document as
1477 characters.
1478 getCaretForeground(This) -> wx:wx_colour4()
1480 Types:
1482 This = wxStyledTextCtrl()
1484 Get the foreground colour of the caret.
1486 getReadOnly(This) -> boolean()
1488 Types:
1490 This = wxStyledTextCtrl()
1492 In read-only mode?
1494 setCurrentPos(This, Caret) -> ok
1496 Types:
1498 This = wxStyledTextCtrl()
1500 Caret = integer()
1501 Sets the position of the caret.
1503 setSelectionStart(This, Anchor) -> ok
1505 Types:
1507 This = wxStyledTextCtrl()
1509 Anchor = integer()
1510 Sets the position that starts the selection - this becomes the
1512 anchor.
1513 getSelectionStart(This) -> integer()
1515 Types:
1517 This = wxStyledTextCtrl()
1519 Returns the position at the start of the selection.
1521 setSelectionEnd(This, Caret) -> ok
1523 Types:
1525 This = wxStyledTextCtrl()
1527 Caret = integer()
1528 Sets the position that ends the selection - this becomes the
1530 caret.
1531 getSelectionEnd(This) -> integer()
1533 Types:
1535 This = wxStyledTextCtrl()
1537 Returns the position at the end of the selection.
1539 setPrintMagnification(This, Magnification) -> ok
1541 Types:
1543 This = wxStyledTextCtrl()
1545 Magnification = integer()
1546 Sets the print magnification added to the point size of each
1548 style for printing.
1549 getPrintMagnification(This) -> integer()
1551 Types:
1553 This = wxStyledTextCtrl()
1555 Returns the print magnification.
1557 setPrintColourMode(This, Mode) -> ok
1559 Types:
1561 This = wxStyledTextCtrl()
1563 Mode = integer()
1564 Modify colours when printing for clearer printed text.
1566 The input should be one of the ?wxSTC_PRINT_* constants.
1568 getPrintColourMode(This) -> integer()
1570 Types:
1572 This = wxStyledTextCtrl()
1574 Returns the print colour mode.
1576 The return value will be one of the ?wxSTC_PRINT_* constants.
1578 findText(This, MinPos, MaxPos, Text) -> integer()
1580 Types:
1582 This = wxStyledTextCtrl()
1584 MinPos = MaxPos = integer()
1585 Text = unicode:chardata()
1586 findText(This, MinPos, MaxPos, Text, Options :: [Option]) ->
1588 integer()
1589 Types:
1591 This = wxStyledTextCtrl()
1593 MinPos = MaxPos = integer()
1594 Text = unicode:chardata()
1595 Option = {flags, integer()}
1596 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 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 Remark: A backwards search can be performed by setting minPos to
1611 be greater than maxPos.
1612 formatRange(This, DoDraw, StartPos, EndPos, Draw, Target,
1614 RenderRect, PageRect) ->
1615 integer()
1616 Types:
1618 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 On Windows, will draw the document into a display context such
1630 as a printer.
1631 getFirstVisibleLine(This) -> integer()
1633 Types:
1635 This = wxStyledTextCtrl()
1637 Retrieve the display line at the top of the display.
1639 getLine(This, Line) -> unicode:charlist()
1641 Types:
1643 This = wxStyledTextCtrl()
1645 Line = integer()
1646 Retrieve the contents of a line.
1648 getLineCount(This) -> integer()
1650 Types:
1652 This = wxStyledTextCtrl()
1654 Returns the number of lines in the document.
1656 There is always at least one.
1658 setMarginLeft(This, PixelWidth) -> ok
1660 Types:
1662 This = wxStyledTextCtrl()
1664 PixelWidth = integer()
1665 Sets the size in pixels of the left margin.
1667 getMarginLeft(This) -> integer()
1669 Types:
1671 This = wxStyledTextCtrl()
1673 Returns the size in pixels of the left margin.
1675 setMarginRight(This, PixelWidth) -> ok
1677 Types:
1679 This = wxStyledTextCtrl()
1681 PixelWidth = integer()
1682 Sets the size in pixels of the right margin.
1684 getMarginRight(This) -> integer()
1686 Types:
1688 This = wxStyledTextCtrl()
1690 Returns the size in pixels of the right margin.
1692 getModify(This) -> boolean()
1694 Types:
1696 This = wxStyledTextCtrl()
1698 Is the document different from when it was last saved?
1700 setSelection(This, From, To) -> ok
1702 Types:
1704 This = wxStyledTextCtrl()
1706 From = To = integer()
1707 Selects the text starting at the first position up to (but not
1709 including) the character at the last position.
1710 If both parameters are equal to -1 all text in the control is
1712 selected.
1713 Notice that the insertion point will be moved to from by this
1715 function.
1716 See: selectAll/1
1718 getSelectedText(This) -> unicode:charlist()
1720 Types:
1722 This = wxStyledTextCtrl()
1724 Retrieve the selected text.
1726 getTextRange(This, StartPos, EndPos) -> unicode:charlist()
1728 Types:
1730 This = wxStyledTextCtrl()
1732 StartPos = EndPos = integer()
1733 Retrieve a range of text.
1735 hideSelection(This, Hide) -> ok
1737 Types:
1739 This = wxStyledTextCtrl()
1741 Hide = boolean()
1742 Draw the selection in normal style or with selection high‐
1744 lighted.
1745 lineFromPosition(This, Pos) -> integer()
1747 Types:
1749 This = wxStyledTextCtrl()
1751 Pos = integer()
1752 Retrieve the line containing a position.
1754 positionFromLine(This, Line) -> integer()
1756 Types:
1758 This = wxStyledTextCtrl()
1760 Line = integer()
1761 Retrieve the position at the start of a line.
1763 lineScroll(This, Columns, Lines) -> ok
1765 Types:
1767 This = wxStyledTextCtrl()
1769 Columns = Lines = integer()
1770 Scroll horizontally and vertically.
1772 ensureCaretVisible(This) -> ok
1774 Types:
1776 This = wxStyledTextCtrl()
1778 Ensure the caret is visible.
1780 replaceSelection(This, Text) -> ok
1782 Types:
1784 This = wxStyledTextCtrl()
1786 Text = unicode:chardata()
1787 Replace the selected text with the argument text.
1789 setReadOnly(This, ReadOnly) -> ok
1791 Types:
1793 This = wxStyledTextCtrl()
1795 ReadOnly = boolean()
1796 Set to read only or read write.
1798 canPaste(This) -> boolean()
1800 Types:
1802 This = wxStyledTextCtrl()
1804 Will a paste succeed?
1806 canUndo(This) -> boolean()
1808 Types:
1810 This = wxStyledTextCtrl()
1812 Are there any undoable actions in the undo history?
1814 emptyUndoBuffer(This) -> ok
1816 Types:
1818 This = wxStyledTextCtrl()
1820 Delete the undo history.
1822 undo(This) -> ok
1824 Types:
1826 This = wxStyledTextCtrl()
1828 Undo one action in the undo history.
1830 cut(This) -> ok
1832 Types:
1834 This = wxStyledTextCtrl()
1836 Cut the selection to the clipboard.
1838 copy(This) -> ok
1840 Types:
1842 This = wxStyledTextCtrl()
1844 Copy the selection to the clipboard.
1846 paste(This) -> ok
1848 Types:
1850 This = wxStyledTextCtrl()
1852 Paste the contents of the clipboard into the document replacing
1854 the selection.
1855 clear(This) -> ok
1857 Types:
1859 This = wxStyledTextCtrl()
1861 Clear the selection.
1863 setText(This, Text) -> ok
1865 Types:
1867 This = wxStyledTextCtrl()
1869 Text = unicode:chardata()
1870 Replace the contents of the document with the argument text.
1872 getText(This) -> unicode:charlist()
1874 Types:
1876 This = wxStyledTextCtrl()
1878 Retrieve all the text in the document.
1880 getTextLength(This) -> integer()
1882 Types:
1884 This = wxStyledTextCtrl()
1886 Retrieve the number of characters in the document.
1888 getOvertype(This) -> boolean()
1890 Types:
1892 This = wxStyledTextCtrl()
1894 Returns true if overtype mode is active otherwise false is re‐
1896 turned.
1897 setCaretWidth(This, PixelWidth) -> ok
1899 Types:
1901 This = wxStyledTextCtrl()
1903 PixelWidth = integer()
1904 Set the width of the insert mode caret.
1906 getCaretWidth(This) -> integer()
1908 Types:
1910 This = wxStyledTextCtrl()
1912 Returns the width of the insert mode caret.
1914 setTargetStart(This, Start) -> ok
1916 Types:
1918 This = wxStyledTextCtrl()
1920 Start = integer()
1921 Sets the position that starts the target which is used for up‐
1923 dating the document without affecting the scroll position.
1924 getTargetStart(This) -> integer()
1926 Types:
1928 This = wxStyledTextCtrl()
1930 Get the position that starts the target.
1932 setTargetEnd(This, End) -> ok
1934 Types:
1936 This = wxStyledTextCtrl()
1938 End = integer()
1939 Sets the position that ends the target which is used for updat‐
1941 ing the document without affecting the scroll position.
1942 getTargetEnd(This) -> integer()
1944 Types:
1946 This = wxStyledTextCtrl()
1948 Get the position that ends the target.
1950 replaceTarget(This, Text) -> integer()
1952 Types:
1954 This = wxStyledTextCtrl()
1956 Text = unicode:chardata()
1957 Replace the target text with the argument text.
1959 Text is counted so it can contain NULs. Returns the length of
1961 the replacement text.
1962 searchInTarget(This, Text) -> integer()
1964 Types:
1966 This = wxStyledTextCtrl()
1968 Text = unicode:chardata()
1969 Search for a counted string in the target and set the target to
1971 the found range.
1972 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 setSearchFlags(This, SearchFlags) -> ok
1977 Types:
1979 This = wxStyledTextCtrl()
1981 SearchFlags = integer()
1982 Set the search flags used by SearchInTarget.
1984 The input should be a bit list containing one or more of the
1986 ?wxSTC_FIND_* constants.
1987 getSearchFlags(This) -> integer()
1989 Types:
1991 This = wxStyledTextCtrl()
1993 Get the search flags used by SearchInTarget.
1995 The return value will be a bit list containing one or more of
1997 the ?wxSTC_FIND_* constants.
1998 callTipShow(This, Pos, Definition) -> ok
2000 Types:
2002 This = wxStyledTextCtrl()
2004 Pos = integer()
2005 Definition = unicode:chardata()
2006 Show a call tip containing a definition near position pos.
2008 callTipCancel(This) -> ok
2010 Types:
2012 This = wxStyledTextCtrl()
2014 Remove the call tip from the screen.
2016 callTipActive(This) -> boolean()
2018 Types:
2020 This = wxStyledTextCtrl()
2022 Is there an active call tip?
2024 callTipPosAtStart(This) -> integer()
2026 Types:
2028 This = wxStyledTextCtrl()
2030 Retrieve the position where the caret was before displaying the
2032 call tip.
2033 Since: 3.1.0
2035 callTipSetHighlight(This, HighlightStart, HighlightEnd) -> ok
2037 Types:
2039 This = wxStyledTextCtrl()
2041 HighlightStart = HighlightEnd = integer()
2042 Highlight a segment of the definition.
2044 callTipSetBackground(This, Back) -> ok
2046 Types:
2048 This = wxStyledTextCtrl()
2050 Back = wx:wx_colour()
2051 Set the background colour for the call tip.
2053 callTipSetForeground(This, Fore) -> ok
2055 Types:
2057 This = wxStyledTextCtrl()
2059 Fore = wx:wx_colour()
2060 Set the foreground colour for the call tip.
2062 callTipSetForegroundHighlight(This, Fore) -> ok
2064 Types:
2066 This = wxStyledTextCtrl()
2068 Fore = wx:wx_colour()
2069 Set the foreground colour for the highlighted part of the call
2071 tip.
2072 callTipUseStyle(This, TabSize) -> ok
2074 Types:
2076 This = wxStyledTextCtrl()
2078 TabSize = integer()
2079 Enable use of wxSTC_STYLE_CALLTIP and set call tip tab size in
2081 pixels.
2082 visibleFromDocLine(This, DocLine) -> integer()
2084 Types:
2086 This = wxStyledTextCtrl()
2088 DocLine = integer()
2089 Find the display line of a document line taking hidden lines
2091 into account.
2092 docLineFromVisible(This, DisplayLine) -> integer()
2094 Types:
2096 This = wxStyledTextCtrl()
2098 DisplayLine = integer()
2099 Find the document line of a display line taking hidden lines
2101 into account.
2102 wrapCount(This, DocLine) -> integer()
2104 Types:
2106 This = wxStyledTextCtrl()
2108 DocLine = integer()
2109 The number of display lines needed to wrap a document line.
2111 setFoldLevel(This, Line, Level) -> ok
2113 Types:
2115 This = wxStyledTextCtrl()
2117 Line = Level = integer()
2118 Set the fold level of a line.
2120 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 getFoldLevel(This, Line) -> integer()
2126 Types:
2128 This = wxStyledTextCtrl()
2130 Line = integer()
2131 Retrieve the fold level of a line.
2133 getLastChild(This, Line, Level) -> integer()
2135 Types:
2137 This = wxStyledTextCtrl()
2139 Line = Level = integer()
2140 Find the last child line of a header line.
2142 getFoldParent(This, Line) -> integer()
2144 Types:
2146 This = wxStyledTextCtrl()
2148 Line = integer()
2149 Find the parent line of a child line.
2151 showLines(This, LineStart, LineEnd) -> ok
2153 Types:
2155 This = wxStyledTextCtrl()
2157 LineStart = LineEnd = integer()
2158 Make a range of lines visible.
2160 hideLines(This, LineStart, LineEnd) -> ok
2162 Types:
2164 This = wxStyledTextCtrl()
2166 LineStart = LineEnd = integer()
2167 Make a range of lines invisible.
2169 getLineVisible(This, Line) -> boolean()
2171 Types:
2173 This = wxStyledTextCtrl()
2175 Line = integer()
2176 Is a line visible?
2178 setFoldExpanded(This, Line, Expanded) -> ok
2180 Types:
2182 This = wxStyledTextCtrl()
2184 Line = integer()
2185 Expanded = boolean()
2186 Show the children of a header line.
2188 getFoldExpanded(This, Line) -> boolean()
2190 Types:
2192 This = wxStyledTextCtrl()
2194 Line = integer()
2195 Is a header line expanded?
2197 toggleFold(This, Line) -> ok
2199 Types:
2201 This = wxStyledTextCtrl()
2203 Line = integer()
2204 Switch a header line between expanded and contracted.
2206 ensureVisible(This, Line) -> ok
2208 Types:
2210 This = wxStyledTextCtrl()
2212 Line = integer()
2213 Ensure a particular line is visible by expanding any header line
2215 hiding it.
2216 setFoldFlags(This, Flags) -> ok
2218 Types:
2220 This = wxStyledTextCtrl()
2222 Flags = integer()
2223 Set some style options for folding.
2225 The second argument should be a bit list containing one or more
2227 of the ?wxSTC_FOLDFLAG_* constants.
2228 ensureVisibleEnforcePolicy(This, Line) -> ok
2230 Types:
2232 This = wxStyledTextCtrl()
2234 Line = integer()
2235 Ensure a particular line is visible by expanding any header line
2237 hiding it.
2238 Use the currently set visibility policy to determine which range
2240 to display.
2241 setTabIndents(This, TabIndents) -> ok
2243 Types:
2245 This = wxStyledTextCtrl()
2247 TabIndents = boolean()
2248 Sets whether a tab pressed when caret is within indentation in‐
2250 dents.
2251 getTabIndents(This) -> boolean()
2253 Types:
2255 This = wxStyledTextCtrl()
2257 Does a tab pressed when caret is within indentation indent?
2259 setBackSpaceUnIndents(This, BsUnIndents) -> ok
2261 Types:
2263 This = wxStyledTextCtrl()
2265 BsUnIndents = boolean()
2266 Sets whether a backspace pressed when caret is within indenta‐
2268 tion unindents.
2269 getBackSpaceUnIndents(This) -> boolean()
2271 Types:
2273 This = wxStyledTextCtrl()
2275 Does a backspace pressed when caret is within indentation unin‐
2277 dent?
2278 setMouseDwellTime(This, PeriodMilliseconds) -> ok
2280 Types:
2282 This = wxStyledTextCtrl()
2284 PeriodMilliseconds = integer()
2285 Sets the time the mouse must sit still to generate a mouse dwell
2287 event.
2288 The input should be a time in milliseconds or wxSTC_TIME_FOR‐
2290 EVER.
2291 getMouseDwellTime(This) -> integer()
2293 Types:
2295 This = wxStyledTextCtrl()
2297 Retrieve the time the mouse must sit still to generate a mouse
2299 dwell event.
2300 The return value will be a time in milliseconds or
2302 wxSTC_TIME_FOREVER.
2303 wordStartPosition(This, Pos, OnlyWordCharacters) -> integer()
2305 Types:
2307 This = wxStyledTextCtrl()
2309 Pos = integer()
2310 OnlyWordCharacters = boolean()
2311 Get position of start of word.
2313 wordEndPosition(This, Pos, OnlyWordCharacters) -> integer()
2315 Types:
2317 This = wxStyledTextCtrl()
2319 Pos = integer()
2320 OnlyWordCharacters = boolean()
2321 Get position of end of word.
2323 setWrapMode(This, WrapMode) -> ok
2325 Types:
2327 This = wxStyledTextCtrl()
2329 WrapMode = integer()
2330 Sets whether text is word wrapped.
2332 The input should be one of the ?wxSTC_WRAP_* constants.
2334 getWrapMode(This) -> integer()
2336 Types:
2338 This = wxStyledTextCtrl()
2340 Retrieve whether text is word wrapped.
2342 The return value will be one of the ?wxSTC_WRAP_* constants.
2344 setWrapVisualFlags(This, WrapVisualFlags) -> ok
2346 Types:
2348 This = wxStyledTextCtrl()
2350 WrapVisualFlags = integer()
2351 Set the display mode of visual flags for wrapped lines.
2353 The input should be a bit list containing one or more of the
2355 ?wxSTC_WRAPVISUALFLAG_* constants.
2356 getWrapVisualFlags(This) -> integer()
2358 Types:
2360 This = wxStyledTextCtrl()
2362 Retrieve the display mode of visual flags for wrapped lines.
2364 The return value will be a bit list containing one or more of
2366 the ?wxSTC_WRAPVISUALFLAG_* constants.
2367 setWrapVisualFlagsLocation(This, WrapVisualFlagsLocation) -> ok
2369 Types:
2371 This = wxStyledTextCtrl()
2373 WrapVisualFlagsLocation = integer()
2374 Set the location of visual flags for wrapped lines.
2376 The input should be a bit list containing one or more of the
2378 ?wxSTC_WRAPVISUALFLAGLOC_* constants.
2379 getWrapVisualFlagsLocation(This) -> integer()
2381 Types:
2383 This = wxStyledTextCtrl()
2385 Retrieve the location of visual flags for wrapped lines.
2387 The return value will be a bit list containing one or more of
2389 the ?wxSTC_WRAPVISUALFLAGLOC_* constants.
2390 setWrapStartIndent(This, Indent) -> ok
2392 Types:
2394 This = wxStyledTextCtrl()
2396 Indent = integer()
2397 Set the start indent for wrapped lines.
2399 getWrapStartIndent(This) -> integer()
2401 Types:
2403 This = wxStyledTextCtrl()
2405 Retrieve the start indent for wrapped lines.
2407 setLayoutCache(This, CacheMode) -> ok
2409 Types:
2411 This = wxStyledTextCtrl()
2413 CacheMode = integer()
2414 Sets the degree of caching of layout information.
2416 The input should be one of the ?wxSTC_CACHE_* constants.
2418 getLayoutCache(This) -> integer()
2420 Types:
2422 This = wxStyledTextCtrl()
2424 Retrieve the degree of caching of layout information.
2426 The return value will be one of the ?wxSTC_CACHE_* constants.
2428 setScrollWidth(This, PixelWidth) -> ok
2430 Types:
2432 This = wxStyledTextCtrl()
2434 PixelWidth = integer()
2435 Sets the document width assumed for scrolling.
2437 getScrollWidth(This) -> integer()
2439 Types:
2441 This = wxStyledTextCtrl()
2443 Retrieve the document width assumed for scrolling.
2445 textWidth(This, Style, Text) -> integer()
2447 Types:
2449 This = wxStyledTextCtrl()
2451 Style = integer()
2452 Text = unicode:chardata()
2453 Measure the pixel width of some text in a particular style.
2455 Does not handle tab or control characters.
2457 getEndAtLastLine(This) -> boolean()
2459 Types:
2461 This = wxStyledTextCtrl()
2463 Retrieve whether the maximum scroll position has the last line
2465 at the bottom of the view.
2466 textHeight(This, Line) -> integer()
2468 Types:
2470 This = wxStyledTextCtrl()
2472 Line = integer()
2473 Retrieve the height of a particular line of text in pixels.
2475 setUseVerticalScrollBar(This, Visible) -> ok
2477 Types:
2479 This = wxStyledTextCtrl()
2481 Visible = boolean()
2482 Show or hide the vertical scroll bar.
2484 getUseVerticalScrollBar(This) -> boolean()
2486 Types:
2488 This = wxStyledTextCtrl()
2490 Is the vertical scroll bar visible?
2492 appendText(This, Text) -> ok
2494 Types:
2496 This = wxStyledTextCtrl()
2498 Text = unicode:chardata()
2499 Append a string to the end of the document without changing the
2501 selection.
2502 getTwoPhaseDraw(This) -> boolean()
2504 Types:
2506 This = wxStyledTextCtrl()
2508 Is drawing done in two phases with backgrounds drawn before
2510 foregrounds?
2511 setTwoPhaseDraw(This, TwoPhase) -> ok
2513 Types:
2515 This = wxStyledTextCtrl()
2517 TwoPhase = boolean()
2518 In twoPhaseDraw mode, drawing is performed in two phases, first
2520 the background and then the foreground.
2521 This avoids chopping off characters that overlap the next run.
2523 targetFromSelection(This) -> ok
2525 Types:
2527 This = wxStyledTextCtrl()
2529 Make the target range start and end be the same as the selection
2531 range start and end.
2532 linesJoin(This) -> ok
2534 Types:
2536 This = wxStyledTextCtrl()
2538 Join the lines in the target.
2540 linesSplit(This, PixelWidth) -> ok
2542 Types:
2544 This = wxStyledTextCtrl()
2546 PixelWidth = integer()
2547 Split the lines in the target into lines that are less wide than
2549 pixelWidth where possible.
2550 setFoldMarginColour(This, UseSetting, Back) -> ok
2552 Types:
2554 This = wxStyledTextCtrl()
2556 UseSetting = boolean()
2557 Back = wx:wx_colour()
2558 Set one of the colours used as a chequerboard pattern in the
2560 fold margin.
2561 setFoldMarginHiColour(This, UseSetting, Fore) -> ok
2563 Types:
2565 This = wxStyledTextCtrl()
2567 UseSetting = boolean()
2568 Fore = wx:wx_colour()
2569 Set the other colour used as a chequerboard pattern in the fold
2571 margin.
2572 lineDown(This) -> ok
2574 Types:
2576 This = wxStyledTextCtrl()
2578 Move caret down one line.
2580 lineDownExtend(This) -> ok
2582 Types:
2584 This = wxStyledTextCtrl()
2586 Move caret down one line extending selection to new caret posi‐
2588 tion.
2589 lineUp(This) -> ok
2591 Types:
2593 This = wxStyledTextCtrl()
2595 Move caret up one line.
2597 lineUpExtend(This) -> ok
2599 Types:
2601 This = wxStyledTextCtrl()
2603 Move caret up one line extending selection to new caret posi‐
2605 tion.
2606 charLeft(This) -> ok
2608 Types:
2610 This = wxStyledTextCtrl()
2612 Move caret left one character.
2614 charLeftExtend(This) -> ok
2616 Types:
2618 This = wxStyledTextCtrl()
2620 Move caret left one character extending selection to new caret
2622 position.
2623 charRight(This) -> ok
2625 Types:
2627 This = wxStyledTextCtrl()
2629 Move caret right one character.
2631 charRightExtend(This) -> ok
2633 Types:
2635 This = wxStyledTextCtrl()
2637 Move caret right one character extending selection to new caret
2639 position.
2640 wordLeft(This) -> ok
2642 Types:
2644 This = wxStyledTextCtrl()
2646 Move caret left one word.
2648 wordLeftExtend(This) -> ok
2650 Types:
2652 This = wxStyledTextCtrl()
2654 Move caret left one word extending selection to new caret posi‐
2656 tion.
2657 wordRight(This) -> ok
2659 Types:
2661 This = wxStyledTextCtrl()
2663 Move caret right one word.
2665 wordRightExtend(This) -> ok
2667 Types:
2669 This = wxStyledTextCtrl()
2671 Move caret right one word extending selection to new caret posi‐
2673 tion.
2674 home(This) -> ok
2676 Types:
2678 This = wxStyledTextCtrl()
2680 Move caret to first position on line.
2682 homeExtend(This) -> ok
2684 Types:
2686 This = wxStyledTextCtrl()
2688 Move caret to first position on line extending selection to new
2690 caret position.
2691 lineEnd(This) -> ok
2693 Types:
2695 This = wxStyledTextCtrl()
2697 Move caret to last position on line.
2699 lineEndExtend(This) -> ok
2701 Types:
2703 This = wxStyledTextCtrl()
2705 Move caret to last position on line extending selection to new
2707 caret position.
2708 documentStart(This) -> ok
2710 Types:
2712 This = wxStyledTextCtrl()
2714 Move caret to first position in document.
2716 documentStartExtend(This) -> ok
2718 Types:
2720 This = wxStyledTextCtrl()
2722 Move caret to first position in document extending selection to
2724 new caret position.
2725 documentEnd(This) -> ok
2727 Types:
2729 This = wxStyledTextCtrl()
2731 Move caret to last position in document.
2733 documentEndExtend(This) -> ok
2735 Types:
2737 This = wxStyledTextCtrl()
2739 Move caret to last position in document extending selection to
2741 new caret position.
2742 pageUp(This) -> ok
2744 Types:
2746 This = wxStyledTextCtrl()
2748 Move caret one page up.
2750 pageUpExtend(This) -> ok
2752 Types:
2754 This = wxStyledTextCtrl()
2756 Move caret one page up extending selection to new caret posi‐
2758 tion.
2759 pageDown(This) -> ok
2761 Types:
2763 This = wxStyledTextCtrl()
2765 Move caret one page down.
2767 pageDownExtend(This) -> ok
2769 Types:
2771 This = wxStyledTextCtrl()
2773 Move caret one page down extending selection to new caret posi‐
2775 tion.
2776 editToggleOvertype(This) -> ok
2778 Types:
2780 This = wxStyledTextCtrl()
2782 Switch from insert to overtype mode or the reverse.
2784 cancel(This) -> ok
2786 Types:
2788 This = wxStyledTextCtrl()
2790 Cancel any modes such as call tip or auto-completion list dis‐
2792 play.
2793 deleteBack(This) -> ok
2795 Types:
2797 This = wxStyledTextCtrl()
2799 Delete the selection or if no selection, the character before
2801 the caret.
2802 tab(This) -> ok
2804 Types:
2806 This = wxStyledTextCtrl()
2808 If selection is empty or all on one line replace the selection
2810 with a tab character.
2811 If more than one line selected, indent the lines.
2813 backTab(This) -> ok
2815 Types:
2817 This = wxStyledTextCtrl()
2819 Dedent the selected lines.
2821 newLine(This) -> ok
2823 Types:
2825 This = wxStyledTextCtrl()
2827 Insert a new line, may use a CRLF, CR or LF depending on EOL
2829 mode.
2830 formFeed(This) -> ok
2832 Types:
2834 This = wxStyledTextCtrl()
2836 Insert a Form Feed character.
2838 vCHome(This) -> ok
2840 Types:
2842 This = wxStyledTextCtrl()
2844 Move caret to before first visible character on line.
2846 If already there move to first character on line.
2848 vCHomeExtend(This) -> ok
2850 Types:
2852 This = wxStyledTextCtrl()
2854 Like VCHome but extending selection to new caret position.
2856 zoomIn(This) -> ok
2858 Types:
2860 This = wxStyledTextCtrl()
2862 Magnify the displayed text by increasing the sizes by 1 point.
2864 zoomOut(This) -> ok
2866 Types:
2868 This = wxStyledTextCtrl()
2870 Make the displayed text smaller by decreasing the sizes by 1
2872 point.
2873 delWordLeft(This) -> ok
2875 Types:
2877 This = wxStyledTextCtrl()
2879 Delete the word to the left of the caret.
2881 delWordRight(This) -> ok
2883 Types:
2885 This = wxStyledTextCtrl()
2887 Delete the word to the right of the caret.
2889 lineCut(This) -> ok
2891 Types:
2893 This = wxStyledTextCtrl()
2895 Cut the line containing the caret.
2897 lineDelete(This) -> ok
2899 Types:
2901 This = wxStyledTextCtrl()
2903 Delete the line containing the caret.
2905 lineTranspose(This) -> ok
2907 Types:
2909 This = wxStyledTextCtrl()
2911 Switch the current line with the previous.
2913 lineDuplicate(This) -> ok
2915 Types:
2917 This = wxStyledTextCtrl()
2919 Duplicate the current line.
2921 lowerCase(This) -> ok
2923 Types:
2925 This = wxStyledTextCtrl()
2927 Transform the selection to lower case.
2929 upperCase(This) -> ok
2931 Types:
2933 This = wxStyledTextCtrl()
2935 Transform the selection to upper case.
2937 lineScrollDown(This) -> ok
2939 Types:
2941 This = wxStyledTextCtrl()
2943 Scroll the document down, keeping the caret visible.
2945 lineScrollUp(This) -> ok
2947 Types:
2949 This = wxStyledTextCtrl()
2951 Scroll the document up, keeping the caret visible.
2953 deleteBackNotLine(This) -> ok
2955 Types:
2957 This = wxStyledTextCtrl()
2959 Delete the selection or if no selection, the character before
2961 the caret.
2962 Will not delete the character before at the start of a line.
2964 homeDisplay(This) -> ok
2966 Types:
2968 This = wxStyledTextCtrl()
2970 Move caret to first position on display line.
2972 homeDisplayExtend(This) -> ok
2974 Types:
2976 This = wxStyledTextCtrl()
2978 Move caret to first position on display line extending selection
2980 to new caret position.
2981 lineEndDisplay(This) -> ok
2983 Types:
2985 This = wxStyledTextCtrl()
2987 Move caret to last position on display line.
2989 lineEndDisplayExtend(This) -> ok
2991 Types:
2993 This = wxStyledTextCtrl()
2995 Move caret to last position on display line extending selection
2997 to new caret position.
2998 homeWrapExtend(This) -> ok
3000 Types:
3002 This = wxStyledTextCtrl()
3004 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 lineEndWrap(This) -> ok
3010 Types:
3012 This = wxStyledTextCtrl()
3014 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 lineEndWrapExtend(This) -> ok
3020 Types:
3022 This = wxStyledTextCtrl()
3024 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 vCHomeWrap(This) -> ok
3030 Types:
3032 This = wxStyledTextCtrl()
3034 Like VCHome but when word-wrap is enabled goes first to start of
3036 display line VCHomeDisplay, then behaves like VCHome.
3037 vCHomeWrapExtend(This) -> ok
3039 Types:
3041 This = wxStyledTextCtrl()
3043 Like VCHomeExtend but when word-wrap is enabled extends first to
3045 start of display line VCHomeDisplayExtend, then behaves like
3046 VCHomeExtend.
3047 lineCopy(This) -> ok
3049 Types:
3051 This = wxStyledTextCtrl()
3053 Copy the line containing the caret.
3055 moveCaretInsideView(This) -> ok
3057 Types:
3059 This = wxStyledTextCtrl()
3061 Move the caret inside current view if it's not there already.
3063 lineLength(This, Line) -> integer()
3065 Types:
3067 This = wxStyledTextCtrl()
3069 Line = integer()
3070 How many characters are on a line, including end of line charac‐
3072 ters?
3073 braceHighlight(This, PosA, PosB) -> ok
3075 Types:
3077 This = wxStyledTextCtrl()
3079 PosA = PosB = integer()
3080 Highlight the characters at two positions.
3082 braceBadLight(This, Pos) -> ok
3084 Types:
3086 This = wxStyledTextCtrl()
3088 Pos = integer()
3089 Highlight the character at a position indicating there is no
3091 matching brace.
3092 braceMatch(This, Pos) -> integer()
3094 Types:
3096 This = wxStyledTextCtrl()
3098 Pos = integer()
3099 Find the position of a matching brace or wxSTC_INVALID_POSITION
3101 if no match.
3102 getViewEOL(This) -> boolean()
3104 Types:
3106 This = wxStyledTextCtrl()
3108 Are the end of line characters visible?
3110 setViewEOL(This, Visible) -> ok
3112 Types:
3114 This = wxStyledTextCtrl()
3116 Visible = boolean()
3117 Make the end of line characters visible or invisible.
3119 setModEventMask(This, EventMask) -> ok
3121 Types:
3123 This = wxStyledTextCtrl()
3125 EventMask = integer()
3126 Set which document modification events are sent to the con‐
3128 tainer.
3129 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 getEdgeColumn(This) -> integer()
3138 Types:
3140 This = wxStyledTextCtrl()
3142 Retrieve the column number which text should be kept within.
3144 setEdgeColumn(This, Column) -> ok
3146 Types:
3148 This = wxStyledTextCtrl()
3150 Column = integer()
3151 Set the column number of the edge.
3153 If text goes past the edge then it is highlighted.
3155 setEdgeMode(This, EdgeMode) -> ok
3157 Types:
3159 This = wxStyledTextCtrl()
3161 EdgeMode = integer()
3162 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 The input should be one of the ?wxSTC_EDGE_* constants.
3169 getEdgeMode(This) -> integer()
3171 Types:
3173 This = wxStyledTextCtrl()
3175 Retrieve the edge highlight mode.
3177 The return value will be one of the ?wxSTC_EDGE_* constants.
3179 getEdgeColour(This) -> wx:wx_colour4()
3181 Types:
3183 This = wxStyledTextCtrl()
3185 Retrieve the colour used in edge indication.
3187 setEdgeColour(This, EdgeColour) -> ok
3189 Types:
3191 This = wxStyledTextCtrl()
3193 EdgeColour = wx:wx_colour()
3194 Change the colour used in edge indication.
3196 searchAnchor(This) -> ok
3198 Types:
3200 This = wxStyledTextCtrl()
3202 Sets the current caret position to be the search anchor.
3204 searchNext(This, SearchFlags, Text) -> integer()
3206 Types:
3208 This = wxStyledTextCtrl()
3210 SearchFlags = integer()
3211 Text = unicode:chardata()
3212 Find some text starting at the search anchor.
3214 Does not ensure the selection is visible.
3216 searchPrev(This, SearchFlags, Text) -> integer()
3218 Types:
3220 This = wxStyledTextCtrl()
3222 SearchFlags = integer()
3223 Text = unicode:chardata()
3224 Find some text starting at the search anchor and moving back‐
3226 wards.
3227 Does not ensure the selection is visible.
3229 linesOnScreen(This) -> integer()
3231 Types:
3233 This = wxStyledTextCtrl()
3235 Retrieves the number of lines completely visible.
3237 usePopUp(This, PopUpMode) -> ok
3239 Types:
3241 This = wxStyledTextCtrl()
3243 PopUpMode = integer()
3244 Set whether a pop up menu is displayed automatically when the
3246 user presses the wrong mouse button on certain areas.
3247 The input should be one of the ?wxSTC_POPUP_* constants.
3249 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 selectionIsRectangle(This) -> boolean()
3256 Types:
3258 This = wxStyledTextCtrl()
3260 Is the selection rectangular? The alternative is the more common
3262 stream selection.
3263 setZoom(This, ZoomInPoints) -> ok
3265 Types:
3267 This = wxStyledTextCtrl()
3269 ZoomInPoints = integer()
3270 Set the zoom level.
3272 This number of points is added to the size of all fonts. It may
3274 be positive to magnify or negative to reduce.
3275 getZoom(This) -> integer()
3277 Types:
3279 This = wxStyledTextCtrl()
3281 Retrieve the zoom level.
3283 getModEventMask(This) -> integer()
3285 Types:
3287 This = wxStyledTextCtrl()
3289 Get which document modification events are sent to the con‐
3291 tainer.
3292 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 setSTCFocus(This, Focus) -> ok
3300 Types:
3302 This = wxStyledTextCtrl()
3304 Focus = boolean()
3305 Change internal focus flag.
3307 getSTCFocus(This) -> boolean()
3309 Types:
3311 This = wxStyledTextCtrl()
3313 Get internal focus flag.
3315 setStatus(This, Status) -> ok
3317 Types:
3319 This = wxStyledTextCtrl()
3321 Status = integer()
3322 Change error status - 0 = OK.
3324 The input should be one of the ?wxSTC_STATUS_* constants.
3326 getStatus(This) -> integer()
3328 Types:
3330 This = wxStyledTextCtrl()
3332 Get error status.
3334 The return value will be one of the ?wxSTC_STATUS_* constants.
3336 setMouseDownCaptures(This, Captures) -> ok
3338 Types:
3340 This = wxStyledTextCtrl()
3342 Captures = boolean()
3343 Set whether the mouse is captured when its button is pressed.
3345 getMouseDownCaptures(This) -> boolean()
3347 Types:
3349 This = wxStyledTextCtrl()
3351 Get whether mouse gets captured.
3353 setSTCCursor(This, CursorType) -> ok
3355 Types:
3357 This = wxStyledTextCtrl()
3359 CursorType = integer()
3360 Sets the cursor to one of the wxSTC_CURSOR* values.
3362 getSTCCursor(This) -> integer()
3364 Types:
3366 This = wxStyledTextCtrl()
3368 Get cursor type.
3370 The return value will be one of the ?wxSTC_CURSOR* constants.
3372 setControlCharSymbol(This, Symbol) -> ok
3374 Types:
3376 This = wxStyledTextCtrl()
3378 Symbol = integer()
3379 Change the way control characters are displayed: If symbol is <
3381 32, keep the drawn way, else, use the given character.
3382 getControlCharSymbol(This) -> integer()
3384 Types:
3386 This = wxStyledTextCtrl()
3388 Get the way control characters are displayed.
3390 wordPartLeft(This) -> ok
3392 Types:
3394 This = wxStyledTextCtrl()
3396 Move to the previous change in capitalisation.
3398 wordPartLeftExtend(This) -> ok
3400 Types:
3402 This = wxStyledTextCtrl()
3404 Move to the previous change in capitalisation extending selec‐
3406 tion to new caret position.
3407 wordPartRight(This) -> ok
3409 Types:
3411 This = wxStyledTextCtrl()
3413 Move to the change next in capitalisation.
3415 wordPartRightExtend(This) -> ok
3417 Types:
3419 This = wxStyledTextCtrl()
3421 Move to the next change in capitalisation extending selection to
3423 new caret position.
3424 setVisiblePolicy(This, VisiblePolicy, VisibleSlop) -> ok
3426 Types:
3428 This = wxStyledTextCtrl()
3430 VisiblePolicy = VisibleSlop = integer()
3431 Set the way the display area is determined when a particular
3433 line is to be moved to by Find, FindNext, GotoLine, etc.
3434 The first argument should be a bit list containing one or more
3436 of the ?wxSTC_VISIBLE_* constants.
3437 delLineLeft(This) -> ok
3439 Types:
3441 This = wxStyledTextCtrl()
3443 Delete back from the current position to the start of the line.
3445 delLineRight(This) -> ok
3447 Types:
3449 This = wxStyledTextCtrl()
3451 Delete forwards from the current position to the end of the
3453 line.
3454 getXOffset(This) -> integer()
3456 Types:
3458 This = wxStyledTextCtrl()
3460 Get the xOffset (ie, horizontal scroll position).
3462 chooseCaretX(This) -> ok
3464 Types:
3466 This = wxStyledTextCtrl()
3468 Set the last x chosen value to be the caret x position.
3470 setXCaretPolicy(This, CaretPolicy, CaretSlop) -> ok
3472 Types:
3474 This = wxStyledTextCtrl()
3476 CaretPolicy = CaretSlop = integer()
3477 Set the way the caret is kept visible when going sideways.
3479 The exclusion zone is given in pixels.
3481 The first argument should be a bit list containing one or more
3483 of the ?wxSTC_CARET_* constants.
3484 setYCaretPolicy(This, CaretPolicy, CaretSlop) -> ok
3486 Types:
3488 This = wxStyledTextCtrl()
3490 CaretPolicy = CaretSlop = integer()
3491 Set the way the line the caret is on is kept visible.
3493 The exclusion zone is given in lines.
3495 The first argument should be a bit list containing one or more
3497 of the ?wxSTC_CARET_* constants.
3498 getPrintWrapMode(This) -> integer()
3500 Types:
3502 This = wxStyledTextCtrl()
3504 Is printing line wrapped?
3506 The return value will be one of the ?wxSTC_WRAP_* constants.
3508 setHotspotActiveForeground(This, UseSetting, Fore) -> ok
3510 Types:
3512 This = wxStyledTextCtrl()
3514 UseSetting = boolean()
3515 Fore = wx:wx_colour()
3516 Set a fore colour for active hotspots.
3518 setHotspotActiveBackground(This, UseSetting, Back) -> ok
3520 Types:
3522 This = wxStyledTextCtrl()
3524 UseSetting = boolean()
3525 Back = wx:wx_colour()
3526 Set a back colour for active hotspots.
3528 setHotspotActiveUnderline(This, Underline) -> ok
3530 Types:
3532 This = wxStyledTextCtrl()
3534 Underline = boolean()
3535 Enable / Disable underlining active hotspots.
3537 setHotspotSingleLine(This, SingleLine) -> ok
3539 Types:
3541 This = wxStyledTextCtrl()
3543 SingleLine = boolean()
3544 Limit hotspots to single line so hotspots on two lines don't
3546 merge.
3547 paraDownExtend(This) -> ok
3549 Types:
3551 This = wxStyledTextCtrl()
3553 Extend selection down one paragraph (delimited by empty lines).
3555 paraUp(This) -> ok
3557 Types:
3559 This = wxStyledTextCtrl()
3561 Move caret up one paragraph (delimited by empty lines).
3563 paraUpExtend(This) -> ok
3565 Types:
3567 This = wxStyledTextCtrl()
3569 Extend selection up one paragraph (delimited by empty lines).
3571 positionBefore(This, Pos) -> integer()
3573 Types:
3575 This = wxStyledTextCtrl()
3577 Pos = integer()
3578 Given a valid document position, return the previous position
3580 taking code page into account.
3581 Returns 0 if passed 0.
3583 positionAfter(This, Pos) -> integer()
3585 Types:
3587 This = wxStyledTextCtrl()
3589 Pos = integer()
3590 Given a valid document position, return the next position taking
3592 code page into account.
3593 Maximum value returned is the last position in the document.
3595 copyRange(This, Start, End) -> ok
3597 Types:
3599 This = wxStyledTextCtrl()
3601 Start = End = integer()
3602 Copy a range of text to the clipboard.
3604 Positions are clipped into the document.
3606 copyText(This, Length, Text) -> ok
3608 Types:
3610 This = wxStyledTextCtrl()
3612 Length = integer()
3613 Text = unicode:chardata()
3614 Copy argument text to the clipboard.
3616 setSelectionMode(This, SelectionMode) -> ok
3618 Types:
3620 This = wxStyledTextCtrl()
3622 SelectionMode = integer()
3623 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 getSelectionMode(This) -> integer()
3629 Types:
3631 This = wxStyledTextCtrl()
3633 Get the mode of the current selection.
3635 The return value will be one of the ?wxSTC_SEL_* constants.
3637 lineDownRectExtend(This) -> ok
3639 Types:
3641 This = wxStyledTextCtrl()
3643 Move caret down one line, extending rectangular selection to new
3645 caret position.
3646 lineUpRectExtend(This) -> ok
3648 Types:
3650 This = wxStyledTextCtrl()
3652 Move caret up one line, extending rectangular selection to new
3654 caret position.
3655 charLeftRectExtend(This) -> ok
3657 Types:
3659 This = wxStyledTextCtrl()
3661 Move caret left one character, extending rectangular selection
3663 to new caret position.
3664 charRightRectExtend(This) -> ok
3666 Types:
3668 This = wxStyledTextCtrl()
3670 Move caret right one character, extending rectangular selection
3672 to new caret position.
3673 homeRectExtend(This) -> ok
3675 Types:
3677 This = wxStyledTextCtrl()
3679 Move caret to first position on line, extending rectangular se‐
3681 lection to new caret position.
3682 vCHomeRectExtend(This) -> ok
3684 Types:
3686 This = wxStyledTextCtrl()
3688 Move caret to before first visible character on line.
3690 If already there move to first character on line. In either
3692 case, extend rectangular selection to new caret position.
3693 lineEndRectExtend(This) -> ok
3695 Types:
3697 This = wxStyledTextCtrl()
3699 Move caret to last position on line, extending rectangular se‐
3701 lection to new caret position.
3702 pageUpRectExtend(This) -> ok
3704 Types:
3706 This = wxStyledTextCtrl()
3708 Move caret one page up, extending rectangular selection to new
3710 caret position.
3711 pageDownRectExtend(This) -> ok
3713 Types:
3715 This = wxStyledTextCtrl()
3717 Move caret one page down, extending rectangular selection to new
3719 caret position.
3720 stutteredPageUp(This) -> ok
3722 Types:
3724 This = wxStyledTextCtrl()
3726 Move caret to top of page, or one page up if already at top of
3728 page.
3729 stutteredPageUpExtend(This) -> ok
3731 Types:
3733 This = wxStyledTextCtrl()
3735 Move caret to top of page, or one page up if already at top of
3737 page, extending selection to new caret position.
3738 stutteredPageDown(This) -> ok
3740 Types:
3742 This = wxStyledTextCtrl()
3744 Move caret to bottom of page, or one page down if already at
3746 bottom of page.
3747 stutteredPageDownExtend(This) -> ok
3749 Types:
3751 This = wxStyledTextCtrl()
3753 Move caret to bottom of page, or one page down if already at
3755 bottom of page, extending selection to new caret position.
3756 wordLeftEnd(This) -> ok
3758 Types:
3760 This = wxStyledTextCtrl()
3762 Move caret left one word, position cursor at end of word.
3764 wordLeftEndExtend(This) -> ok
3766 Types:
3768 This = wxStyledTextCtrl()
3770 Move caret left one word, position cursor at end of word, ex‐
3772 tending selection to new caret position.
3773 wordRightEnd(This) -> ok
3775 Types:
3777 This = wxStyledTextCtrl()
3779 Move caret right one word, position cursor at end of word.
3781 wordRightEndExtend(This) -> ok
3783 Types:
3785 This = wxStyledTextCtrl()
3787 Move caret right one word, position cursor at end of word, ex‐
3789 tending selection to new caret position.
3790 setWhitespaceChars(This, Characters) -> ok
3792 Types:
3794 This = wxStyledTextCtrl()
3796 Characters = unicode:chardata()
3797 Set the set of characters making up whitespace for when moving
3799 or selecting by word.
3800 Should be called after SetWordChars.
3802 setCharsDefault(This) -> ok
3804 Types:
3806 This = wxStyledTextCtrl()
3808 Reset the set of characters for whitespace and word characters
3810 to the defaults.
3811 autoCompGetCurrent(This) -> integer()
3813 Types:
3815 This = wxStyledTextCtrl()
3817 Get currently selected item position in the auto-completion
3819 list.
3820 allocate(This, Bytes) -> ok
3822 Types:
3824 This = wxStyledTextCtrl()
3826 Bytes = integer()
3827 Enlarge the document to a particular size of text bytes.
3829 findColumn(This, Line, Column) -> integer()
3831 Types:
3833 This = wxStyledTextCtrl()
3835 Line = Column = integer()
3836 Find the position of a column on a line taking into account tabs
3838 and multi-byte characters.
3839 If beyond end of line, return line end position.
3841 getCaretSticky(This) -> integer()
3843 Types:
3845 This = wxStyledTextCtrl()
3847 Can the caret preferred x position only be changed by explicit
3849 movement commands?
3850 The return value will be one of the ?wxSTC_CARETSTICKY_* con‐
3852 stants.
3853 setCaretSticky(This, UseCaretStickyBehaviour) -> ok
3855 Types:
3857 This = wxStyledTextCtrl()
3859 UseCaretStickyBehaviour = integer()
3860 Stop the caret preferred x position changing when the user
3862 types.
3863 The input should be one of the ?wxSTC_CARETSTICKY_* constants.
3865 toggleCaretSticky(This) -> ok
3867 Types:
3869 This = wxStyledTextCtrl()
3871 Switch between sticky and non-sticky: meant to be bound to a
3873 key.
3874 setPasteConvertEndings(This, Convert) -> ok
3876 Types:
3878 This = wxStyledTextCtrl()
3880 Convert = boolean()
3881 Enable/Disable convert-on-paste for line endings.
3883 getPasteConvertEndings(This) -> boolean()
3885 Types:
3887 This = wxStyledTextCtrl()
3889 Get convert-on-paste setting.
3891 selectionDuplicate(This) -> ok
3893 Types:
3895 This = wxStyledTextCtrl()
3897 Duplicate the selection.
3899 If selection empty duplicate the line containing the caret.
3901 setCaretLineBackAlpha(This, Alpha) -> ok
3903 Types:
3905 This = wxStyledTextCtrl()
3907 Alpha = integer()
3908 Set background alpha of the caret line.
3910 getCaretLineBackAlpha(This) -> integer()
3912 Types:
3914 This = wxStyledTextCtrl()
3916 Get the background alpha of the caret line.
3918 startRecord(This) -> ok
3920 Types:
3922 This = wxStyledTextCtrl()
3924 Start notifying the container of all key presses and commands.
3926 stopRecord(This) -> ok
3928 Types:
3930 This = wxStyledTextCtrl()
3932 Stop notifying the container of all key presses and commands.
3934 setLexer(This, Lexer) -> ok
3936 Types:
3938 This = wxStyledTextCtrl()
3940 Lexer = integer()
3941 Set the lexing language of the document.
3943 The input should be one of the ?wxSTC_LEX_* constants.
3945 getLexer(This) -> integer()
3947 Types:
3949 This = wxStyledTextCtrl()
3951 Retrieve the lexing language of the document.
3953 The return value will be one of the ?wxSTC_LEX_* constants.
3955 colourise(This, Start, End) -> ok
3957 Types:
3959 This = wxStyledTextCtrl()
3961 Start = End = integer()
3962 Colourise a segment of the document using the current lexing
3964 language.
3965 setProperty(This, Key, Value) -> ok
3967 Types:
3969 This = wxStyledTextCtrl()
3971 Key = Value = unicode:chardata()
3972 Set up a value that may be used by a lexer for some optional
3974 feature.
3975 setKeyWords(This, KeyWordSet, KeyWords) -> ok
3977 Types:
3979 This = wxStyledTextCtrl()
3981 KeyWordSet = integer()
3982 KeyWords = unicode:chardata()
3983 Set up the key words used by the lexer.
3985 setLexerLanguage(This, Language) -> ok
3987 Types:
3989 This = wxStyledTextCtrl()
3991 Language = unicode:chardata()
3992 Set the lexing language of the document based on string name.
3994 getProperty(This, Key) -> unicode:charlist()
3996 Types:
3998 This = wxStyledTextCtrl()
4000 Key = unicode:chardata()
4001 Retrieve a "property" value previously set with SetProperty.
4003 getStyleBitsNeeded(This) -> integer()
4005 Types:
4007 This = wxStyledTextCtrl()
4009 Retrieve the number of bits the current lexer needs for styling.
4011 Deprecated:
4013 getCurrentLine(This) -> integer()
4015 Types:
4017 This = wxStyledTextCtrl()
4019 Returns the line number of the line with the caret.
4021 styleSetSpec(This, StyleNum, Spec) -> ok
4023 Types:
4025 This = wxStyledTextCtrl()
4027 StyleNum = integer()
4028 Spec = unicode:chardata()
4029 Extract style settings from a spec-string which is composed of
4031 one or more of the following comma separated elements:
4032 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 styleSetFont(This, StyleNum, Font) -> ok
4040 Types:
4042 This = wxStyledTextCtrl()
4044 StyleNum = integer()
4045 Font = wxFont:wxFont()
4046 Set style size, face, bold, italic, and underline attributes
4048 from a wxFont's attributes.
4049 styleSetFontAttr(This, StyleNum, Size, FaceName, Bold, Italic,
4051 Underline) ->
4052 ok
4053 Types:
4055 This = wxStyledTextCtrl()
4057 StyleNum = Size = integer()
4058 FaceName = unicode:chardata()
4059 Bold = Italic = Underline = boolean()
4060 styleSetFontAttr(This, StyleNum, Size, FaceName, Bold, Italic,
4062 Underline,
4063 Options :: [Option]) ->
4064 ok
4065 Types:
4067 This = wxStyledTextCtrl()
4069 StyleNum = Size = integer()
4070 FaceName = unicode:chardata()
4071 Bold = Italic = Underline = boolean()
4072 Option = {encoding, wx:wx_enum()}
4073 Set all font style attributes at once.
4075 styleSetCharacterSet(This, Style, CharacterSet) -> ok
4077 Types:
4079 This = wxStyledTextCtrl()
4081 Style = CharacterSet = integer()
4082 Set the character set of the font in a style.
4084 Converts the Scintilla character set values to a wxFontEncoding.
4086 styleSetFontEncoding(This, Style, Encoding) -> ok
4088 Types:
4090 This = wxStyledTextCtrl()
4092 Style = integer()
4093 Encoding = wx:wx_enum()
4094 Set the font encoding to be used by a style.
4096 cmdKeyExecute(This, Cmd) -> ok
4098 Types:
4100 This = wxStyledTextCtrl()
4102 Cmd = integer()
4103 Perform one of the operations defined by the wxSTC_CMD_* con‐
4105 stants.
4106 setMargins(This, Left, Right) -> ok
4108 Types:
4110 This = wxStyledTextCtrl()
4112 Left = Right = integer()
4113 Set the left and right margin in the edit area, measured in pix‐
4115 els.
4116 getSelection(This) -> {From :: integer(), To :: integer()}
4118 Types:
4120 This = wxStyledTextCtrl()
4122 Gets the current selection span.
4124 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 pointFromPosition(This, Pos) -> {X :: integer(), Y :: integer()}
4133 Types:
4135 This = wxStyledTextCtrl()
4137 Pos = integer()
4138 Retrieve the point in the window where a position is displayed.
4140 scrollToLine(This, Line) -> ok
4142 Types:
4144 This = wxStyledTextCtrl()
4146 Line = integer()
4147 Scroll enough to make the given line visible.
4149 scrollToColumn(This, Column) -> ok
4151 Types:
4153 This = wxStyledTextCtrl()
4155 Column = integer()
4156 Scroll enough to make the given column visible.
4158 setVScrollBar(This, Bar) -> ok
4160 Types:
4162 This = wxStyledTextCtrl()
4164 Bar = wxScrollBar:wxScrollBar()
4165 Set the vertical scrollbar to use instead of the one that's
4167 built-in.
4168 setHScrollBar(This, Bar) -> ok
4170 Types:
4172 This = wxStyledTextCtrl()
4174 Bar = wxScrollBar:wxScrollBar()
4175 Set the horizontal scrollbar to use instead of the one that's
4177 built-in.
4178 getLastKeydownProcessed(This) -> boolean()
4180 Types:
4182 This = wxStyledTextCtrl()
4184 Can be used to prevent the EVT_CHAR handler from adding the
4186 char.
4187 setLastKeydownProcessed(This, Val) -> ok
4189 Types:
4191 This = wxStyledTextCtrl()
4193 Val = boolean()
4194 Returns the line number of the line with the caret.
4196 saveFile(This, Filename) -> boolean()
4198 Types:
4200 This = wxStyledTextCtrl()
4202 Filename = unicode:chardata()
4203 Write the contents of the editor to filename.
4205 loadFile(This, Filename) -> boolean()
4207 Types:
4209 This = wxStyledTextCtrl()
4211 Filename = unicode:chardata()
4212 Load the contents of filename into the editor.
4214 doDragOver(This, X, Y, DefaultRes) -> wx:wx_enum()
4216 Types:
4218 This = wxStyledTextCtrl()
4220 X = Y = integer()
4221 DefaultRes = wx:wx_enum()
4222 Allow for simulating a DnD DragOver.
4224 doDropText(This, X, Y, Data) -> boolean()
4226 Types:
4228 This = wxStyledTextCtrl()
4230 X = Y = integer()
4231 Data = unicode:chardata()
4232 Allow for simulating a DnD DropText.
4234 getUseAntiAliasing(This) -> boolean()
4236 Types:
4238 This = wxStyledTextCtrl()
4240 Returns the current UseAntiAliasing setting.
4242 addTextRaw(This, Text) -> ok
4244 Types:
4246 This = wxStyledTextCtrl()
4248 Text = binary()
4249 addTextRaw(This, Text, Options :: [Option]) -> ok
4251 Types:
4253 This = wxStyledTextCtrl()
4255 Text = binary()
4256 Option = {length, integer()}
4257 Add text to the document at current position.
4259 insertTextRaw(This, Pos, Text) -> ok
4261 Types:
4263 This = wxStyledTextCtrl()
4265 Pos = integer()
4266 Text = binary()
4267 Insert string at a position.
4269 getCurLineRaw(This) -> Result
4271 Types:
4273 Result = {Res :: binary(), LinePos :: integer()}
4275 This = wxStyledTextCtrl()
4276 Retrieve the text of the line containing the caret.
4278 Returns the index of the caret on the line.
4280 getLineRaw(This, Line) -> binary()
4282 Types:
4284 This = wxStyledTextCtrl()
4286 Line = integer()
4287 Retrieve the contents of a line.
4289 getSelectedTextRaw(This) -> binary()
4291 Types:
4293 This = wxStyledTextCtrl()
4295 Retrieve the selected text.
4297 getTextRangeRaw(This, StartPos, EndPos) -> binary()
4299 Types:
4301 This = wxStyledTextCtrl()
4303 StartPos = EndPos = integer()
4304 Retrieve a range of text.
4306 setTextRaw(This, Text) -> ok
4308 Types:
4310 This = wxStyledTextCtrl()
4312 Text = binary()
4313 Replace the contents of the document with the argument text.
4315 getTextRaw(This) -> binary()
4317 Types:
4319 This = wxStyledTextCtrl()
4321 Retrieve all the text in the document.
4323 appendTextRaw(This, Text) -> ok
4325 Types:
4327 This = wxStyledTextCtrl()
4329 Text = binary()
4330 appendTextRaw(This, Text, Options :: [Option]) -> ok
4332 Types:
4334 This = wxStyledTextCtrl()
4336 Text = binary()
4337 Option = {length, integer()}
4338 Append a string to the end of the document without changing the
4340 selection.
4341wxWidgets team. wx 2.1 wxStyledTextCtrl(3)