wxStyledTextCtrl(3)
💅 wxStyledTextCtrl(3) 💅
okay so bestie, gather round, because this is the wxStyledTextCtrl page from the Erlang module definitions in the manual, and it's a whole journey. buckle up. 🎀
✨ NAME ✨
wxStyledTextCtrl — a wxWidgets implementation of the Scintilla source code editing component. she's an editor widget, she's iconic, she's the vibe. 👑
🌸 DESCRIPTION 🌸
So like, on top of all the stuff you'd expect from a normal text editing component, Scintilla comes with features that are lowkey made for editing and debugging source code. we're talking support for syntax styling, error indicators, code completion and call tips. 😌
The selection margin can hold markers, like the ones debuggers use to show breakpoints and the current line. and the styling choices are wayyy more open than what a lot of editors give you — proportional fonts? bold and italics? multiple foreground and background colours? multiple fonts? all of it. slay. 💅
wxStyledTextCtrl is a 1 to 1 mapping of the "raw" scintilla interface, and you can find that documentation over on the Scintilla website: http://www.scintilla.org/.
btw, for the documentation of all the event types you can use with wxStyledTextCtrl, go look at wxStyledTextEvent. that's where that lives. 🫶
This class is derived, and can use functions, from:
wxControlwxWindowwxEvtHandler
wxWidgets docs: wxStyledTextCtrl
🦋 DATA TYPES 🦋
wxStyledTextCtrl() :: wx:wx_object().
⭐ FUNCTIONS ⭐
💖 addText
addText(This, Text) -> ok
when
This :: wxStyledTextCtrl(),
Text :: unicode:chardata().Add text to the document at the current position. that's it, that's the whole thing. ✨
💖 addTextRaw
addTextRaw(This, Text, [Option]) -> ok
when
This :: wxStyledTextCtrl(),
Text :: binary(),
Option :: {length, integer()}.Add text to the document at the current position. (the raw one — she takes a binary() and has that {length, integer()} option riding along. 🌈)
💖 allocate
allocate(This, Bytes) -> ok
when This :: wxStyledTextCtrl(), Bytes :: integer().Enlarge the document to a particular size of text bytes. giving her room to grow. 🎀
💖 appendText
appendText(This, Text) -> ok
when
This :: wxStyledTextCtrl(),
Text :: unicode:chardata().Append a string to the end of the document without changing the selection. the selection stays exactly where it was, no cap. 💯
💖 appendTextRaw
appendTextRaw(This, Text, [Option]) -> ok
when
This :: wxStyledTextCtrl(),
Text :: binary(),
Option :: {length, integer()}.Append a string to the end of the document without changing the selection. raw flavour, binary() in, {length, integer()} optional. 🍓
💖 autoCompActive
autoCompActive(This) -> boolean()
when This :: wxStyledTextCtrl().Is there an auto-completion list visible? yes or no bestie, boolean(). 👀
💖 autoCompCancel
autoCompCancel(This) -> ok
when This :: wxStyledTextCtrl().Remove the auto-completion list from the screen. bye bye. 🫡
💖 autoCompComplete
autoCompComplete(This) -> ok
when This :: wxStyledTextCtrl().The user has selected an item, so: remove the list and insert the selection. done deal. 💅
💖 autoCompGetAutoHide
autoCompGetAutoHide(This) -> boolean()
when This :: wxStyledTextCtrl().Retrieve whether or not autocompletion is hidden automatically when nothing matches.
💖 autoCompGetCancelAtStart
autoCompGetCancelAtStart(This) -> boolean()
when This :: wxStyledTextCtrl().Retrieve whether auto-completion gets cancelled by backspacing before the start.
💖 autoCompGetChooseSingle
autoCompGetChooseSingle(This) -> boolean()
when This :: wxStyledTextCtrl().Retrieve whether a single item auto-completion list automatically chooses the item.
💖 autoCompGetCurrent
autoCompGetCurrent(This) -> integer()
when This :: wxStyledTextCtrl().Get the currently selected item position in the auto-completion list. it's an integer(). 🔢
💖 autoCompGetDropRestOfWord
autoCompGetDropRestOfWord(This) -> boolean()
when This :: wxStyledTextCtrl().Retrieve whether or not autocompletion deletes any word characters after the inserted text upon completion.
💖 autoCompGetIgnoreCase
autoCompGetIgnoreCase(This) -> boolean()
when This :: wxStyledTextCtrl().Retrieve the state of the ignore case flag.
💖 autoCompGetMaxHeight
autoCompGetMaxHeight(This) -> integer()
when This :: wxStyledTextCtrl().Set the maximum height, in rows, of auto-completion and user lists. (yes it says "Set" on the getter, that's just how she is, iykyk — either way, integer() comes back. 😭)
💖 autoCompGetMaxWidth
autoCompGetMaxWidth(This) -> integer()
when This :: wxStyledTextCtrl().Get the maximum width, in characters, of auto-completion and user lists.
💖 autoCompGetSeparator
autoCompGetSeparator(This) -> integer()
when This :: wxStyledTextCtrl().Retrieve the auto-completion list separator character. 🔤
💖 autoCompGetTypeSeparator
autoCompGetTypeSeparator(This) -> integer()
when This :: wxStyledTextCtrl().Retrieve the auto-completion list type-separator character. ✨
💖 autoCompPosStart
autoCompPosStart(This) -> integer()
when This :: wxStyledTextCtrl().Retrieve the position of the caret when the auto-completion list was displayed. 📍
💖 autoCompSelect
autoCompSelect(This, Select) -> ok
when
This :: wxStyledTextCtrl(),
Select :: unicode:chardata().Select the item in the auto-completion list that starts with a string. yes, starts with, that's the rule. 🎯
💖 autoCompSetAutoHide
autoCompSetAutoHide(This, AutoHide) -> ok
when
This :: wxStyledTextCtrl(),
AutoHide :: boolean().Set whether or not autocompletion is hidden automatically when nothing matches.
💖 autoCompSetCancelAtStart
autoCompSetCancelAtStart(This, Cancel) -> ok
when
This :: wxStyledTextCtrl(),
Cancel :: boolean().Should the auto-completion list be cancelled if the user backspaces to a position before where the box was created?
💖 autoCompSetChooseSingle
autoCompSetChooseSingle(This, ChooseSingle) -> ok
when
This :: wxStyledTextCtrl(),
ChooseSingle :: boolean().Should a single item auto-completion list automatically choose the item.
💖 autoCompSetDropRestOfWord
autoCompSetDropRestOfWord(This, DropRestOfWord) -> ok
when
This :: wxStyledTextCtrl(),
DropRestOfWord :: boolean().Set whether or not autocompletion deletes any word characters after the inserted text upon completion.
💖 autoCompSetFillUps
autoCompSetFillUps(This, CharacterSet) -> ok
when
This :: wxStyledTextCtrl(),
CharacterSet :: unicode:chardata().Define a set of characters that, when typed, will cause the autocompletion to choose the selected item. 🧚
💖 autoCompSetIgnoreCase
autoCompSetIgnoreCase(This, IgnoreCase) -> ok
when
This :: wxStyledTextCtrl(),
IgnoreCase :: boolean().Set whether case is significant when performing auto-completion searches.
💖 autoCompSetMaxHeight
autoCompSetMaxHeight(This, RowCount) -> ok
when
This :: wxStyledTextCtrl(),
RowCount :: integer().Set the maximum height, in rows, of auto-completion and user lists.
The default is 5 rows. 🖐️
💖 autoCompSetMaxWidth
autoCompSetMaxWidth(This, CharacterCount) -> ok
when
This :: wxStyledTextCtrl(),
CharacterCount :: integer().Set the maximum width, in characters, of auto-completion and user lists.
Set to 0 to autosize to fit the longest item, which is the default. 🌈
💖 autoCompSetSeparator
autoCompSetSeparator(This, SeparatorCharacter) -> ok
when
This :: wxStyledTextCtrl(),
SeparatorCharacter :: integer().Change the separator character in the string setting up an auto-completion list.
Default is space, but it can be changed if items contain space. 🫶
💖 autoCompSetTypeSeparator
autoCompSetTypeSeparator(This, SeparatorCharacter) -> ok
when
This :: wxStyledTextCtrl(),
SeparatorCharacter :: integer().Change the type-separator character in the string setting up an auto-completion list.
Default is'?', but it can be changed if items contain'?'. ❓
💖 autoCompShow
autoCompShow(This, LengthEntered, ItemList) -> ok
when
This :: wxStyledTextCtrl(),
LengthEntered :: integer(),
ItemList :: unicode:chardata().Display an auto-completion list. ✨
The lengthEntered parameter indicates how many characters before the caret should be used to provide context.
💖 autoCompStops
autoCompStops(This, CharacterSet) -> ok
when
This :: wxStyledTextCtrl(),
CharacterSet :: unicode:chardata().Define a set of characters that, when typed, cancel the auto-completion list. 🛑
💖 backTab
backTab(This) -> ok
when This :: wxStyledTextCtrl().Dedent the selected lines. un-indent, bestie, we're going back. ⬅️
💖 beginUndoAction
beginUndoAction(This) -> ok
when This :: wxStyledTextCtrl().Start a sequence of actions that gets undone and redone as a single unit.
May be nested. 🪆
💖 braceBadLight
braceBadLight(This, Pos) -> ok
when This :: wxStyledTextCtrl(), Pos :: integer().Highlight the character at a position, indicating there is no matching brace. 😭 that lonely unmatched brace.
💖 braceHighlight
braceHighlight(This, PosA, PosB) -> ok
when
This :: wxStyledTextCtrl(),
PosA :: integer(),
PosB :: integer().Highlight the characters at two positions. the matched brace duo, both of them, glowing. 🔥
💖 braceMatch
braceMatch(This, Pos) -> integer()
when This :: wxStyledTextCtrl(), Pos :: integer().Find the position of a matching brace, or wxSTC_INVALID_POSITION if there's no match. 📍
💖 callTipActive
callTipActive(This) -> boolean()
when This :: wxStyledTextCtrl().Is there an active call tip? boolean(), tell me everything. 👀
💖 callTipCancel
callTipCancel(This) -> ok
when This :: wxStyledTextCtrl().Remove the call tip from the screen. poof. 💨
💖 callTipPosAtStart
callTipPosAtStart(This) -> integer()
when This :: wxStyledTextCtrl().Retrieve the position where the caret was before displaying the call tip. 📌
Since: 3.1.0 ✨
callTipSetBackground
callTipSetBackground(This, Back) -> ok
when
This :: wxStyledTextCtrl(),
Back :: wx:wx_colour().ok bestie, this sets the background colour for the call tip. 💖
callTipSetForeground
callTipSetForeground(This, Fore) -> ok
when
This :: wxStyledTextCtrl(),
Fore :: wx:wx_colour().sets the foreground colour for the call tip. ✨
callTipSetForegroundHighlight
callTipSetForegroundHighlight(This, Fore) -> ok
when
This :: wxStyledTextCtrl(),
Fore :: wx:wx_colour().sets the foreground colour for the highlighted part of the call tip. 🎀
callTipSetHighlight
callTipSetHighlight(This, HighlightStart, HighlightEnd) -> ok
when
This :: wxStyledTextCtrl(),
HighlightStart :: integer(),
HighlightEnd :: integer().highlight a segment of the definition. iconic for making call tips pop. 💅
callTipShow
callTipShow(This, Pos, Definition) -> ok
when
This :: wxStyledTextCtrl(),
Pos :: integer(),
Definition :: unicode:chardata().show a call tip containing a definition near position pos. 🔥
callTipUseStyle
callTipUseStyle(This, TabSize) -> ok
when
This :: wxStyledTextCtrl(),
TabSize :: integer().enable use of wxSTC_STYLE_CALLTIP and set call tip tab size in pixels. 🦋
canPaste
canPaste(This) -> boolean() when This :: wxStyledTextCtrl().will a paste succeed? boolean vibes only. 💭
canRedo
canRedo(This) -> boolean() when This :: wxStyledTextCtrl().are there any redoable actions in the undo history? check it. 🔁
canUndo
canUndo(This) -> boolean() when This :: wxStyledTextCtrl().are there any undoable actions in the undo history? bestie check. ↩️
cancel
cancel(This) -> ok when This :: wxStyledTextCtrl().cancel any modes such as call tip or auto-completion list display. bye bye popups. 👋
charLeft
charLeft(This) -> ok when This :: wxStyledTextCtrl().move caret left one character. scoot. ⬅️
charLeftExtend
charLeftExtend(This) -> ok when This :: wxStyledTextCtrl().move caret left one character extending selection to new caret position. selection glow up. ✨
charLeftRectExtend
charLeftRectExtend(This) -> ok when This :: wxStyledTextCtrl().move caret left one character, extending rectangular selection to new caret position. 🟪
charRight
charRight(This) -> ok when This :: wxStyledTextCtrl().move caret right one character. scoot but right. ➡️
charRightExtend
charRightExtend(This) -> ok when This :: wxStyledTextCtrl().move caret right one character extending selection to new caret position. selection moment. 💖
charRightRectExtend
charRightRectExtend(This) -> ok when This :: wxStyledTextCtrl().move caret right one character, extending rectangular selection to new caret position. 🟪
chooseCaretX
chooseCaretX(This) -> ok when This :: wxStyledTextCtrl().set the last x chosen value to be the caret x position. x marks the spot. 📍
clear
clear(This) -> ok when This :: wxStyledTextCtrl().clear the selection. poof. 💨
clearAll
clearAll(This) -> ok when This :: wxStyledTextCtrl().delete all text in the document. nuclear option bestie. 💀
clearDocumentStyle
clearDocumentStyle(This) -> ok when This :: wxStyledTextCtrl().set all style bytes to 0, remove all folding information. reset the drip. 🧹
clearRegisteredImages
clearRegisteredImages(This) -> ok when This :: wxStyledTextCtrl().clear all the registered images. image purge. 🖼️
cmdKeyAssign
cmdKeyAssign(This, Key, Modifiers, Cmd) -> ok
when
This :: wxStyledTextCtrl(),
Key :: integer(),
Modifiers :: integer(),
Cmd :: integer().when key+modifier combination keyDefinition is pressed perform sciCommand.
the second argument should be a bit list containing one or more of the ?wxSTC_KEYMOD_* constants and the third argument should be one of the ?wxSTC_CMD_* constants. keyboard shortcuts go brrr. ⌨️
cmdKeyClear
cmdKeyClear(This, Key, Modifiers) -> ok
when
This :: wxStyledTextCtrl(),
Key :: integer(),
Modifiers :: integer().when key+modifier combination keyDefinition is pressed do nothing.
the second argument should be a bit list containing one or more of the ?wxSTC_KEYMOD_* constants. unassign that key. 🚫
cmdKeyClearAll
cmdKeyClearAll(This) -> ok when This :: wxStyledTextCtrl().drop all key mappings. clean slate. 🧼
cmdKeyExecute
cmdKeyExecute(This, Cmd) -> ok
when This :: wxStyledTextCtrl(), Cmd ::
integer().perform one of the operations defined by the wxSTC_CMD_* constants. do the thing. ⚡
colourise
colourise(This, Start, End) -> ok
when
This :: wxStyledTextCtrl(),
Start :: integer(),
End :: integer().colourise a segment of the document using the current lexing language. aesthetic. 🌈
convertEOLs
convertEOLs(This, EolMode) -> ok
when
This :: wxStyledTextCtrl(),
EolMode :: integer().convert all line endings in the document to one mode. unify those EOLs. 🫶
copy
copy(This) -> ok when This :: wxStyledTextCtrl().copy the selection to the clipboard. clipboard said slay. 📋
copyRange
copyRange(This, Start, End) -> ok
when
This :: wxStyledTextCtrl(),
Start :: integer(),
End :: integer().copy a range of text to the clipboard.
positions are clipped into the document. boundaries handled. ✂️
copyText
copyText(This, Length, Text) -> ok
when
This :: wxStyledTextCtrl(),
Length :: integer(),
Text :: unicode:chardata().copy argument text to the clipboard. direct clipboard drop. 💌
create
create(This, Parent, [Option]) -> boolean()
when
This :: wxStyledTextCtrl(),
Parent :: wxWindow:wxWindow(),
Option ::
{id, integer()} |
{pos, {X :: integer(), Y :: integer()}} |
{size, {W :: integer(), H :: integer()}} |
{style, integer()}.create the UI elements for a STC that was created with the default ctor.
(for 2-phase create.) phase 2 unlocked. 🛠️
cut
cut(This) -> ok when This :: wxStyledTextCtrl().cut the selection to the clipboard. snip snip. ✂️
delLineLeft
delLineLeft(This) -> ok when This :: wxStyledTextCtrl().delete back from the current position to the start of the line. left delete energy. ⬅️
delLineRight
delLineRight(This) -> ok when This :: wxStyledTextCtrl().delete forwards from the current position to the end of the line. right delete energy. ➡️
delWordLeft
delWordLeft(This) -> ok when This :: wxStyledTextCtrl().delete the word to the left of the caret. word gone left. 🗑️
delWordRight
delWordRight(This) -> ok when This :: wxStyledTextCtrl().delete the word to the right of the caret. word gone right. 🗑️
deleteBack
deleteBack(This) -> ok when This :: wxStyledTextCtrl().delete the selection or if no selection, the character before the caret. backspace behavior. ⌫
deleteBackNotLine
deleteBackNotLine(This) -> ok when This :: wxStyledTextCtrl().delete the selection or if no selection, the character before the caret.
will not delete the character before at the start of a line. boundary respected. 🚧
destroy
destroy(This :: wxStyledTextCtrl()) -> ok.destroys the object. bye bye. 💀
doDragOver
doDragOver(This, X, Y, DefaultRes) -> wx:wx_enum()
when
This :: wxStyledTextCtrl(),
X :: integer(),
Y :: integer(),
DefaultRes :: wx:wx_enum().allow for simulating a DnD DragOver. fake drag go. 🖱️
doDropText
doDropText(This, X, Y, Data) -> boolean()
when
This :: wxStyledTextCtrl(),
X :: integer(),
Y :: integer(),
Data :: unicode:chardata().allow for simulating a DnD DropText. fake drop go. 📥
docLineFromVisible
docLineFromVisible(This, DisplayLine) -> integer()
when
This :: wxStyledTextCtrl(),
DisplayLine :: integer().find the document line of a display line taking hidden lines into account. hidden line math. 🧮
documentEnd
documentEnd(This) -> ok when This :: wxStyledTextCtrl().move caret to last position in document. to the end. 🔚
documentEndExtend
documentEndExtend(This) -> ok when This :: wxStyledTextCtrl().move caret to last position in document extending selection to new caret position. select to the end. 🔚
documentStart
documentStart(This) -> ok when This :: wxStyledTextCtrl().move caret to first position in document. to the start. 🔜
documentStartExtend
documentStartExtend(This) -> ok when This :: wxStyledTextCtrl().move caret to first position in document extending selection to new caret position. select to the start. 🔜
editToggleOvertype
editToggleOvertype(This) -> ok when This :: wxStyledTextCtrl().switch from insert to overtype mode or the reverse. mode flip. 🔄
emptyUndoBuffer
emptyUndoBuffer(This) -> ok when This :: wxStyledTextCtrl().delete the undo history. no takebacks. 🗑️
endUndoAction
endUndoAction(This) -> ok when This :: wxStyledTextCtrl().end a sequence of actions that is undone and redone as a unit. undo group closed. 🔒
ensureCaretVisible
ensureCaretVisible(This) -> ok when This :: wxStyledTextCtrl().ensure the caret is visible. come into view bestie. 👀
ensureVisible
ensureVisible(This, Line) -> ok
when
This :: wxStyledTextCtrl(), Line ::
integer().ensure a particular line is visible by expanding any header line hiding it. reveal that line. 📖
ensureVisibleEnforcePolicy
ensureVisibleEnforcePolicy(This, Line) -> ok
when
This :: wxStyledTextCtrl(),
Line :: integer().ensure a particular line is visible by expanding any header line hiding it.
use the currently set visibility policy to determine which range to display. policy checked. 📜
findColumn
findColumn(This, Line, Column) -> integer()
when
This :: wxStyledTextCtrl(),
Line :: integer(),
Column :: integer().find the position of a column on a line taking into account tabs and multi-byte characters.
if beyond end of line, return line end position. column found. 🧭
findText(This, MinPos, MaxPos, Text, [Option]) -> integer()— the search function, and she EATS 💅
when
This :: wxStyledTextCtrl(),
MinPos :: integer(),
MaxPos :: integer(),
Text :: unicode:chardata(),
Option :: {flags, integer()}.Finds some text in the document, no cap 🔍 MinPos is the position (starting from zero) in the document where the search begins. MaxPos is the last position (also starting from zero) in the document that the search is restricted to. Text is the text you're searching for. Option is optional and holds {flags, integer()} — the search flags, which should be a bit list containing one or more of the wxSTC_FIND_WHOLEWORD / wxSTC_FIND_* constants.
It returns the position (starting from zero, bestie, always zero) in the document where the text was found, or wxSTC_INVALID_POSITION if the search fails 😭.
Remark that is lowkey iconic: you can do a backwards search by settingMinPosto be greater thanMaxPos. periodt. 🦋
formFeed(This) -> ok when This :: wxStyledTextCtrl().— inserts a Form Feed character. that's it, that's the whole job 🌸formatRange(This, DoDraw, StartPos, EndPos, Draw, Target, RenderRect, PageRect) -> integer()— the printer girlie 🖨️
when
This :: wxStyledTextCtrl(),
DoDraw :: boolean(),
StartPos :: integer(),
EndPos :: integer(),
Draw :: wxDC:wxDC(),
Target :: wxDC:wxDC(),
RenderRect ::
{X :: integer(),
Y :: integer(),
W :: integer(),
H :: integer()},
PageRect ::
{X :: integer(),
Y :: integer(),
W :: integer(),
H :: integer()}.On Windows, this will draw the document into a display context such as a printer. only on Windows, so don't come for me if it's giving nothing elsewhere 🙈
getAnchor(This) -> integer() when This :: wxStyledTextCtrl().— returns the position of the opposite end of the selection to the caret. the other end of the vibe check 💖getBackSpaceUnIndents(This) -> boolean() when This :: wxStyledTextCtrl().— does a backspace pressed when the caret is within indentation unindent? yes/no bestie ⌨️getBufferedDraw(This) -> boolean() when This :: wxStyledTextCtrl().— is drawing done first into a buffer, or straight to the screen? 🎀getCaretForeground(This) -> wx:wx_colour4() when This :: wxStyledTextCtrl().— get the foreground colour of the caret ✨getCaretLineBackAlpha(This) -> integer() when This :: wxStyledTextCtrl().— get the background alpha of the caret line 🌈getCaretLineBackground(This) -> wx:wx_colour4() when This :: wxStyledTextCtrl().— get the colour of the background of the line containing the caret 🎨getCaretLineVisible(This) -> boolean() when This :: wxStyledTextCtrl().— is the background of the line containing the caret in a different colour? 👀getCaretPeriod(This) -> integer() when This :: wxStyledTextCtrl().— get the time in milliseconds that the caret is on and off. blink blink, no cap ⏱️getCaretSticky(This) -> integer() when This :: wxStyledTextCtrl().— can the caret preferred x position only be changed by explicit movement commands? the return value will be one of the?wxSTC_CARETSTICKY_*constants 🫶getCaretWidth(This) -> integer() when This :: wxStyledTextCtrl().— returns the width of the insert mode caret ✏️getCharAt(This, Pos) -> integer() when This :: wxStyledTextCtrl(), Pos :: integer().— returns the character byte at the position 🔤getCodePage(This) -> integer() when This :: wxStyledTextCtrl().— get the code page used to interpret the bytes of the document as characters 🌐getColumn(This, Pos) -> integer() when This :: wxStyledTextCtrl(), Pos :: integer().— retrieve the column number of a position, taking tab width into account 📐getControlCharSymbol(This) -> integer() when This :: wxStyledTextCtrl().— get the way control characters are displayed 💀getCurLine(This) -> Result— retrieve the text of the line containing the caret, she's a whole tuple 🧚
when
Result ::
{Res :: unicode:charlist(),
LinePos :: integer()},
This :: wxStyledTextCtrl().linePos can optionally be passed in to receive the index of the caret on the line. cute, right? 💜
getCurLineRaw(This) -> Result— retrieve the text of the line containing the caret, but raw this time 🍓
when
Result ::
{Res :: binary(), LinePos :: integer()},
This :: wxStyledTextCtrl().Returns the index of the caret on the line.
getCurrentLine(This) -> integer() when This :: wxStyledTextCtrl().— returns the line number of the line with the caret 🔢getCurrentPos(This) -> integer() when This :: wxStyledTextCtrl().— returns the position of the caret 📍getEOLMode(This) -> integer() when This :: wxStyledTextCtrl().— retrieve the current end of line mode, which is one ofwxSTC_EOL_CRLF,wxSTC_EOL_CR, orwxSTC_EOL_LF. pick your line-ending princess 👑getEdgeColour(This) -> wx:wx_colour4() when This :: wxStyledTextCtrl().— retrieve the colour used in edge indication 🌸getEdgeColumn(This) -> integer() when This :: wxStyledTextCtrl().— retrieve the column number which text should be kept within 🚧getEdgeMode(This) -> integer() when This :: wxStyledTextCtrl().— retrieve the edge highlight mode. the return value will be one of the?wxSTC_EDGE_*constants ✨getEndAtLastLine(This) -> boolean() when This :: wxStyledTextCtrl().— retrieve whether the maximum scroll position has the last line at the bottom of the view 📜getEndStyled(This) -> integer() when This :: wxStyledTextCtrl().— retrieve the position of the last correctly styled character 💅getFirstVisibleLine(This) -> integer() when This :: wxStyledTextCtrl().— retrieve the display line at the top of the display 👁️getFoldExpanded(This, Line) -> boolean() when This :: wxStyledTextCtrl(), Line :: integer().— is a header line expanded? 📂getFoldLevel(This, Line) -> integer() when This :: wxStyledTextCtrl(), Line :: integer().— retrieve the fold level of a line 🪜getFoldParent(This, Line) -> integer() when This :: wxStyledTextCtrl(), Line :: integer().— find the parent line of a child line. family reunion fr fr 👨👩👧getHighlightGuide(This) -> integer() when This :: wxStyledTextCtrl().— get the highlighted indentation guide column 🎯getIndent(This) -> integer() when This :: wxStyledTextCtrl().— retrieve indentation size 📏getIndentationGuides(This) -> integer() when This :: wxStyledTextCtrl().— are the indentation guides visible? the return value will be one of the?wxSTC_IV_*constants 👀getLastChild(This, Line, Level) -> integer() when This :: wxStyledTextCtrl(), Line :: integer(), Level :: integer().— find the last child line of a header line 🧬getLastKeydownProcessed(This) -> boolean() when This :: wxStyledTextCtrl().— can be used to prevent theEVT_CHARhandler from adding the char 🚫getLayoutCache(This) -> integer() when This :: wxStyledTextCtrl().— retrieve the degree of caching of layout information. the return value will be one of the?wxSTC_CACHE_*constants 🗂️getLength(This) -> integer() when This :: wxStyledTextCtrl().— returns the number of bytes in the document 📊getLexer(This) -> integer() when This :: wxStyledTextCtrl().— retrieve the lexing language of the document. the return value will be one of the?wxSTC_LEX_*constants 🗣️getLine(This, Line) -> unicode:charlist() when This :: wxStyledTextCtrl(), Line :: integer().— retrieve the contents of a line 📄getLineCount(This) -> integer() when This :: wxStyledTextCtrl().— returns the number of lines in the document. there is always at least one, bestie, even when it's empty 🫶getLineEndPosition(This, Line) -> integer() when This :: wxStyledTextCtrl(), Line :: integer().— get the position after the last visible characters on a line 🏁getLineIndentPosition(This, Line) -> integer() when This :: wxStyledTextCtrl(), Line :: integer().— retrieve the position before the first non indentation character on a line ↩️getLineIndentation(This, Line) -> integer() when This :: wxStyledTextCtrl(), Line :: integer().— retrieve the number of columns that a line is indented 📐getLineRaw(This, Line) -> binary() when This :: wxStyledTextCtrl(), Line :: integer().— retrieve the contents of a line, raw edition 🍓getLineState(This, Line) -> integer() when This :: wxStyledTextCtrl(), Line :: integer().— retrieve the extra styling information for a line 🎀getLineVisible(This, Line) -> boolean() when This :: wxStyledTextCtrl(), Line :: integer().— is a line visible? 👁️getMarginLeft(This) -> integer() when This :: wxStyledTextCtrl().— returns the size in pixels of the left margin 📏getMarginMask(This, Margin) -> integer()— the deets keep rolling in the next breath, hold on 🫶
when
This :: wxStyledTextCtrl(),
Margin :: integer().Returns the marker mask of a margin, bestie. Simple as that. 🎀
getMarginRight(This) -> integer() when This :: wxStyledTextCtrl().getMarginRight(This)— hands you the size in pixels of the right margin. 💅
getMarginSensitive(This, Margin) -> boolean()
when
This :: wxStyledTextCtrl(),
Margin :: integer().getMarginSensitive(This, Margin)— tells you if margin is sensitive to mouse clicks. is it that girl? click-able or nah? 🖱️
getMarginType(This, Margin) -> integer()
when
This :: wxStyledTextCtrl(),
Margin :: integer().getMarginType(This, Margin)— what type of margin are we dealing with, hmm? the return value will be one of the?wxSTC_MARGIN_*constants. ✨
getMarginWidth(This, Margin) -> integer()
when
This :: wxStyledTextCtrl(),
Margin :: integer().getMarginWidth(This, Margin)— gives you the width of margin in pixels, no cap. 📏
getMaxLineState(This) -> integer() when This :: wxStyledTextCtrl().getMaxLineState(This)— retrieve the last line number that has line state. iykyk. 🧚
getModEventMask(This) -> integer() when This :: wxStyledTextCtrl().getModEventMask(This)— which document modification events are actually getting sent to the container? 👀
The return value will be wxSTC_MODEVENTMASKALL if all changes generate events. Otherwise it's a bit list containing one or more of the ?wxSTC_MOD_* constants, the ?wxSTC_PERFORMED_* constants, and also wxSTC_STARTACTION, wxSTC_MULTILINEUNDOREDO, wxSTC_MULTISTEPUNDOREDO, and wxSTC_LASTSTEPINUNDOREDO. literally the whole squad. 💜
getModify(This) -> boolean() when This :: wxStyledTextCtrl().getModify(This)— is the document different from when it was last saved? the moment of truth fr fr 😭
getMouseDownCaptures(This) -> boolean()
when This :: wxStyledTextCtrl().getMouseDownCaptures(This)— get whether the mouse gets captured. gotcha! 🐭
getMouseDwellTime(This) -> integer()
when This :: wxStyledTextCtrl().getMouseDwellTime(This)— how long does the mouse have to sit still before it generates a mouse dwell event? the patience test.
The return value is a time in milliseconds or wxSTC_TIME_FOREVER. ⏳
getOvertype(This) -> boolean() when This :: wxStyledTextCtrl().getOvertype(This)— returnstrueif overtype mode is active, otherwisefalsegets returned. typing-over-your-own-words energy.
getPasteConvertEndings(This) -> boolean()
when This :: wxStyledTextCtrl().getPasteConvertEndings(This)— get the convert-on-paste setting. line endings doing a lil glow-up on paste. ✨
getPrintColourMode(This) -> integer()
when This :: wxStyledTextCtrl().getPrintColourMode(This)— returns the print colour mode. the return value will be one of the?wxSTC_PRINT_*constants. 🖨️
getPrintMagnification(This) -> integer()
when This :: wxStyledTextCtrl().getPrintMagnification(This)— returns the print magnification. zoom zoom but for the printer. 🔍
getPrintWrapMode(This) -> integer()
when This :: wxStyledTextCtrl().getPrintWrapMode(This)— is printing line wrapped? the return value will be one of the?wxSTC_WRAP_*constants. 📄
getProperty(This, Key) -> unicode:charlist()
when
This :: wxStyledTextCtrl(),
Key :: unicode:chardata().getProperty(This, Key)— retrieve a"property"value that was previously set withSetProperty. the receipts, bestie. 🧾
getReadOnly(This) -> boolean() when This :: wxStyledTextCtrl().getReadOnly(This)— in read-only mode? just look, don't touch. 🙈
getSTCCursor(This) -> integer() when This :: wxStyledTextCtrl().getSTCCursor(This)— get the cursor type. the return value will be one of the?wxSTC_CURSOR*constants. 👑✨
getSTCFocus(This) -> boolean() when This :: wxStyledTextCtrl().getSTCFocus(This)— get the internal focus flag. main character energy check. 💅
getScrollWidth(This) -> integer() when This :: wxStyledTextCtrl().getScrollWidth(This)— retrieve the document width assumed for scrolling. 📐
getSearchFlags(This) -> integer() when This :: wxStyledTextCtrl().getSearchFlags(This)— get the search flags used bySearchInTarget. the return value will be a bit list containing one or more of the?wxSTC_FIND_*constants. 🔎
getSelAlpha(This) -> integer() when This :: wxStyledTextCtrl().getSelAlpha(This)— get the alpha of the selection. it's giving translucent. 🦋
getSelectedText(This) -> unicode:charlist()
when This :: wxStyledTextCtrl().getSelectedText(This)— retrieve the selected text. the chosen ones. 🫶
getSelectedTextRaw(This) -> binary()
when This :: wxStyledTextCtrl().getSelectedTextRaw(This)— retrieve the selected text. again! but raw this time, as a binary. 🌈
getSelection(This) -> {From :: integer(), To :: integer()}
when This :: wxStyledTextCtrl().getSelection(This)— gets the current selection span. 📍
If the returned values are equal, there was no selection. and heads up bestie: please note that the indices returned may be used with the other wxTextCtrl methods, but they don't necessarily represent the correct indices into the string returned by wxComboBox:getValue/1 for multiline controls under Windows (at least,) so you should use wxTextCtrl:getStringSelection/1 to get the selected text. fr fr, heed the warning. ⚠️
getSelectionEnd(This) -> integer() when This :: wxStyledTextCtrl().getSelectionEnd(This)— returns the position at the end of the selection. 🎯
getSelectionMode(This) -> integer()
when This :: wxStyledTextCtrl().getSelectionMode(This)— get the mode of the current selection. the return value will be one of the?wxSTC_SEL_*constants. ✨
getSelectionStart(This) -> integer()
when This :: wxStyledTextCtrl().getSelectionStart(This)— returns the position at the start of the selection. 🎯
getStatus(This) -> integer() when This :: wxStyledTextCtrl().getStatus(This)— get error status. the return value will be one of the?wxSTC_STATUS_*constants. 💀 (hopefully not an error tho)
getStyleAt(This, Pos) -> integer()
when This :: wxStyledTextCtrl(), Pos :: integer().getStyleAt(This, Pos)— returns the style byte at the position. 🎨
getStyleBits(This) -> integer() when This :: wxStyledTextCtrl().getStyleBits(This)— retrieve the number of bits in style bytes used to hold the lexical state.
Deprecated: ⚠️ okay so this one's deprecated, don't build your whole personality around it bestie.
getStyleBitsNeeded(This) -> integer()
when This :: wxStyledTextCtrl().getStyleBitsNeeded(This)— retrieve the number of bits the current lexer needs for styling.
Deprecated: ⚠️ also deprecated. we moved on, and that's okay. 💅
getTabIndents(This) -> boolean() when This :: wxStyledTextCtrl().getTabIndents(This)— does a tab pressed when the caret is within indentation actually indent? 🤔
getTabWidth(This) -> integer() when This :: wxStyledTextCtrl().getTabWidth(This)— retrieve the visible size of a tab. how thicc is that tab. 📏
getTargetEnd(This) -> integer() when This :: wxStyledTextCtrl().getTargetEnd(This)— get the position that ends the target. 🏁
getTargetStart(This) -> integer() when This :: wxStyledTextCtrl().getTargetStart(This)— get the position that starts the target. 🚩
getText(This) -> unicode:charlist()
when This :: wxStyledTextCtrl().getText(This)— retrieve all the text in the document. the whole thing. every word. 👑
getTextLength(This) -> integer() when This :: wxStyledTextCtrl().getTextLength(This)— retrieve the number of characters in the document. count 'em. 🔢
getTextRange(This, StartPos, EndPos) -> unicode:charlist()
when
This :: wxStyledTextCtrl(),
StartPos :: integer(),
EndPos :: integer().getTextRange(This, StartPos, EndPos)— retrieve a range of text. the slice. 🍰
getTextRangeRaw(This, StartPos, EndPos) -> binary()
when
This :: wxStyledTextCtrl(),
StartPos :: integer(),
EndPos :: integer().getTextRangeRaw(This, StartPos, EndPos)— retrieve a range of text. but raw, bestie, so it's a binary. 🦋
getTextRaw(This) -> binary() when This :: wxStyledTextCtrl().getTextRaw(This)— retrieve all the text in the document, in raw binary form. 🌈
getTwoPhaseDraw(This) -> boolean() when This :: wxStyledTextCtrl().getTwoPhaseDraw(This)— is drawing done in two phases with backgrounds drawn before foregrounds? the layering order check. 🎨
getUndoCollection(This) -> boolean()
when This :: wxStyledTextCtrl().getUndoCollection(This)— is undo history being collected? are we keeping the receipts? 🧾
getUseAntiAliasing(This) -> boolean()
when This :: wxStyledTextCtrl().getUseAntiAliasing(This)— returns the currentUseAntiAliasingsetting. smooth like butter. 🧈✨
getUseHorizontalScrollBar(This) -> boolean()
when This :: wxStyledTextCtrl().getUseHorizontalScrollBar(This)— is the horizontal scroll bar visible? 👀
getUseTabs(This) -> boolean() when This :: wxStyledTextCtrl().getUseTabs(This)— retrieve whether tabs will be used in indentation. tabs girlies rise. 🎀
getUseVerticalScrollBar(This) -> boolean()
when This :: wxStyledTextCtrl().getUseVerticalScrollBar(This)— is the vertical scroll bar visible? 👀
getViewEOL(This) -> boolean() when This :: wxStyledTextCtrl().getViewEOL(This)— are the end of line characters visible? do we see the\n? 🌸
getViewWhiteSpace(This) -> integer()
when This :: wxStyledTextCtrl().getViewWhiteSpace(This)— are white space characters currently visible? returns one of thewxSTC_WS_*constants. 🫧
getWrapMode(This) -> integer() when This :: wxStyledTextCtrl().getWrapMode(This)— retrieve whether text is word wrapped. the return value will be one of the?wxSTC_WRAP_*constants. 🎁
getWrapStartIndent(This) -> integer()
when This :: wxStyledTextCtrl().getWrapStartIndent(This)— retrieve the start indent for wrapped lines. 📐
getWrapVisualFlags(This) -> integer()
when This :: wxStyledTextCtrl().getWrapVisualFlags(This)— retrieve the display mode of visual flags for wrapped lines. the return value will be a bit list containing one or more of the?wxSTC_WRAPVISUALFLAG_*constants. 🚩
getWrapVisualFlagsLocation(This) -> integer()
when This :: wxStyledTextCtrl().getWrapVisualFlagsLocation(This)— retrieve the location of visual flags for wrapped lines. the return value will be a bit list containing one or more of the?wxSTC_WRAPVISUALFLAGLOC_*constants. 📍
getXOffset(This) -> integer() when This :: wxStyledTextCtrl().getXOffset(This)— get thexOffset(ie, the horizontal scroll position). sliding to the side. ➡️
getZoom(This) -> integer() when This :: wxStyledTextCtrl().getZoom(This)— retrieve the zoom level. how zoomed in are we feeling today. 🔍
gotoLine(This, Line) -> ok
when This :: wxStyledTextCtrl(), Line :: integer().gotoLine(This, Line)— set the caret to the start of a line and make sure it's visible. teleport, but make it text. ✨
gotoPos(This, Caret) -> ok
when This :: wxStyledTextCtrl(), Caret :: integer().gotoPos(This, Caret)— set the caret to a position and ensure it's visible. 🎯
hideLines(This, LineStart, LineEnd) -> ok
when
This :: wxStyledTextCtrl(),
LineStart :: integer(),
LineEnd :: integer().hideLines(This, LineStart, LineEnd)— make a range of lines invisible. poof, gone (but not deleted, bestie, just hidden). 🙈
hideSelection(This, Hide) -> ok
when
This :: wxStyledTextCtrl(), Hide :: boolean().hideSelection(This, Hide)— draw the selection in normal style, or with the selection highlighted. do we show off the highlight or keep it lowkey. 💅
home(This) -> ok when This :: wxStyledTextCtrl().home(This)— takes you home. 🏠home(This) -> ok— bestie, this one yeets the caret all the way back to the first position on the line 🏠💨homeDisplay(This) -> ok— same energy but it goes to the first position on the display line instead (word-wrap girlies know the difference) ✨homeDisplayExtend(This) -> ok— jumps to the start of the display line and stretches the selection out to where the caret lands 🫶homeExtend(This) -> ok— first position on the line, and the selection gets extended to the new caret spot too 💅homeRectExtend(This) -> ok— first position on the line, but now we're extending a rectangular selection. block-select icon behaviour, we love to see it 🔥homeWrapExtend(This) -> ok— it's giving HomeExtend but with a plot twist: when word-wrap is on, it goes first to the start of the display line (HomeDisplayExtend), and then to the start of the document line (HomeExtend) 🌀indicatorGetForeground— grab the foreground colour of an indicator 🎨
indicatorGetForeground(This, Indicator) -> wx:wx_colour4()
when
This :: wxStyledTextCtrl(),
Indicator :: integer().indicatorGetStyle— pull the style of an indicator. the return value will be one of the?wxSTC_INDIC_*constants, no cap ✨
indicatorGetStyle(This, Indicator) -> integer()
when
This :: wxStyledTextCtrl(),
Indicator :: integer().indicatorSetForeground(This, Indicator, Fore) -> ok— set the foreground colour of an indicator. glow-up time 🖌️indicatorSetStyle— set an indicator to plain, squiggle or TT. the second argument should be one of the?wxSTC_INDIC_*constants 💖
indicatorSetStyle(This, Indicator, IndicatorStyle) -> ok
when
This :: wxStyledTextCtrl(),
Indicator :: integer(),
IndicatorStyle :: integer().insertText— drop a string in at a position. get in there 🫶
insertText(This, Pos, Text) -> ok
when
This :: wxStyledTextCtrl(),
Pos :: integer(),
Text :: unicode:chardata().insertTextRaw— insert a string at a position, but the raw binary-flavoured version 📦
insertTextRaw(This, Pos, Text) -> ok
when
This :: wxStyledTextCtrl(),
Pos :: integer(),
Text :: binary().lineCopy(This) -> ok— copy the whole line the caret is sitting on 📋lineCut(This) -> ok— ✂️ cut the line containing the caretlineDelete(This) -> ok— delete the line containing the caret. gone. reduced to atoms 💀lineDown(This) -> ok— move the caret down one line ⬇️lineDownExtend(This) -> ok— caret down one line and the selection extends to the new caret position 🌸lineDownRectExtend(This) -> ok— caret down one line, extending the rectangular selection to the new caret position 🎀lineDuplicate(This) -> ok— duplicate the current line. twin moment 👯lineEnd(This) -> ok— move the caret to the last position on the line 🏁lineEndDisplay(This) -> ok— move the caret to the last position on the display line 👑lineEndDisplayExtend(This) -> ok— last position on the display line, with the selection extended to the new caret position 💜lineEndExtend(This) -> ok— last position on the line, extending the selection to the new caret position ⭐lineEndRectExtend(This) -> ok— last position on the line, extending a rectangular selection to the new caret position 🌈lineEndWrap(This) -> ok— likeLineEndbut when word-wrap is enabled it goes first to the end of the display line (LineEndDisplay), then to the start of the document line (LineEnd). yes, start. that's what it says, bestie 🌀lineEndWrapExtend(This) -> ok— same deal asLineEndExtend, but with word-wrap on it extends first to the end of the display line (LineEndDisplayExtend), then to the start of the document line (LineEndExtend) 🫧lineFromPosition— figure out which line contains a position 📍
lineFromPosition(This, Pos) -> integer()
when
This :: wxStyledTextCtrl(),
Pos :: integer().lineLength— how many characters are on a line, including end of line characters? yes, including them, don't come for me 📏
lineLength(This, Line) -> integer()
when This :: wxStyledTextCtrl(), Line :: integer().lineScroll— scroll horizontally and vertically in one go 🛝
lineScroll(This, Columns, Lines) -> ok
when
This :: wxStyledTextCtrl(),
Columns :: integer(),
Lines :: integer().lineScrollDown(This) -> ok— scroll the document down while keeping the caret visible. caret stays the main character 👑⬇️lineScrollUp(This) -> ok— scroll the document up, caret still visible, still iconic ⬆️✨lineTranspose(This) -> ok— swap the current line with the previous one 🔄lineUp(This) -> ok— move the caret up one line ⬆️lineUpExtend(This) -> ok— caret up one line, selection extended to the new caret position 💫lineUpRectExtend(This) -> ok— caret up one line, extending the rectangular selection to the new caret position 🧊linesJoin(This) -> ok— join the lines in the target. conga line 🔗linesOnScreen(This) -> integer()— retrieves the number of lines completely visible. fully on screen or it doesn't count 👀linesSplit— split the lines in the target into lines that are less wide than pixelWidth where possible 🪓
linesSplit(This, PixelWidth) -> ok
when
This :: wxStyledTextCtrl(),
PixelWidth :: integer().loadFile— load the contents of filename into the editor 📂
loadFile(This, Filename) -> boolean()
when
This :: wxStyledTextCtrl(),
Filename :: unicode:chardata().lowerCase(This) -> ok— transform the selection to lower case. quiet, lowercase, demure 🔡markerAdd— add a marker to a line and get back an ID you can use to find or delete that marker 🏷️
markerAdd(This, Line, MarkerNumber) -> integer()
when
This :: wxStyledTextCtrl(),
Line :: integer(),
MarkerNumber :: integer().markerAddSet(This, Line, MarkerSet) -> ok— add a whole set of markers to a line. bundle deal 🎁markerDefine— set the symbol used for a particular marker number, and optionally the fore and background colours. the second argument should be one of the?wxSTC_MARK_*constants 🎨
markerDefine(This, MarkerNumber, MarkerSymbol, [Option]) -> ok
when
This :: wxStyledTextCtrl(),
MarkerNumber :: integer(),
MarkerSymbol :: integer(),
Option ::
{foreground, wx:wx_colour()} |
{background, wx:wx_colour()}.markerDefineBitmap(This, MarkerNumber, Bmp) -> ok— define a marker using awxBitmap🖼️markerDelete(This, Line, MarkerNumber) -> ok— delete a marker from a line 🗑️markerDeleteAll(This, MarkerNumber) -> ok— nuke every marker with that particular number across all lines 💥markerDeleteHandle(This, MarkerHandle) -> ok— delete a marker by its handle 🔪markerGet(This, Line) -> integer()— get a bit mask of every marker set on a line 🎭markerLineFromHandle— retrieve the line number where a particular marker is hanging out 🔎
markerLineFromHandle(This, MarkerHandle) -> integer()
when
This :: wxStyledTextCtrl(),
MarkerHandle :: integer().markerNext— find the next line at or after lineStart that includes a marker in mask. returns-1when there are no more lines ➡️
markerNext(This, LineStart, MarkerMask) -> integer()
when
This :: wxStyledTextCtrl(),
LineStart :: integer(),
MarkerMask :: integer().markerPrevious— find the previous line before lineStart that includes a marker in mask ⬅️
markerPrevious(This, LineStart, MarkerMask) -> integer()
when
This :: wxStyledTextCtrl(),
LineStart :: integer(),
MarkerMask :: integer().markerSetAlpha— here's the signature this part of the page hands us 💅
markerSetAlpha(This, MarkerNumber, Alpha) -> ok
when
This :: wxStyledTextCtrl(),
MarkerNumber :: integer(),
Alpha :: integer().Set the alpha used for a marker that is drawn in the text area, not the margin. iykyk, margins are their own little kingdom 💅
markerSetBackground(This, MarkerNumber, Back) -> ok
markerSetBackground(This, MarkerNumber, Back) -> ok
when
This :: wxStyledTextCtrl(),
MarkerNumber :: integer(),
Back :: wx:wx_colour().Sets the background colour for one specific marker number. One number, one colour, no sharing bestie 🌸
markerSetForeground(This, MarkerNumber, Fore) -> ok
markerSetForeground(This, MarkerNumber, Fore) -> ok
when
This :: wxStyledTextCtrl(),
MarkerNumber :: integer(),
Fore :: wx:wx_colour().And this is the foreground colour for that same marker number. Foreground and background are two different fits and both are iconic ✨
moveCaretInsideView(This) -> ok
moveCaretInsideView(This) -> ok when This :: wxStyledTextCtrl().If the caret has wandered off the visible area, this drags it back inside the current view. No caret left behind, periodt 🎀
new() -> wxStyledTextCtrl()
new() -> wxStyledTextCtrl().The default ctor. Bare bones, no parent, no options, just vibes. 🦋
new(Parent, [Option]) -> wxStyledTextCtrl()
new(Parent, [Option]) -> wxStyledTextCtrl()
when
Parent :: wxWindow:wxWindow(),
Option ::
{id, integer()} |
{pos, {X :: integer(), Y :: integer()}} |
{size, {W :: integer(), H :: integer()}} |
{style, integer()}.The ctor with a parent and a lil list of options. You got {id, integer()}, {pos, {X :: integer(), Y :: integer()}}, {size, {W :: integer(), H :: integer()}}, and {style, integer()}. Pick your faves 💖
newLine(This) -> ok
newLine(This) -> ok when This :: wxStyledTextCtrl().Drops in a new line. Whether that's a CRLF, CR or LF depends on the EOL mode — it's giving "I match the room I'm in" 🧚
pageDown(This) -> ok
pageDown(This) -> ok when This :: wxStyledTextCtrl().Caret moves one page down. Simple, elegant, ate 💅
pageDownExtend(This) -> ok
pageDownExtend(This) -> ok when This :: wxStyledTextCtrl().One page down and the selection stretches all the way to the new caret position. Selecting while you scroll, main character energy 👑
pageDownRectExtend(This) -> ok
pageDownRectExtend(This) -> ok when This :: wxStyledTextCtrl().Same page-down move, except it extends a rectangular selection to the new caret position. Block select girlies rise 🌈
pageUp(This) -> ok
pageUp(This) -> ok when This :: wxStyledTextCtrl().Caret goes one page up. The reverse of the above, no notes 🎀
pageUpExtend(This) -> ok
pageUpExtend(This) -> ok when This :: wxStyledTextCtrl().One page up, selection extended to the new caret position. 💖
pageUpRectExtend(This) -> ok
pageUpRectExtend(This) -> ok when This :: wxStyledTextCtrl().One page up, rectangular selection extended to the new caret position. Yes queen, block select upward too 🦋
paraDownExtend(This) -> ok
paraDownExtend(This) -> ok when This :: wxStyledTextCtrl().Extends the selection down one paragraph — and paragraphs are delimited by empty lines, no cap 📝
paraUp(This) -> ok
paraUp(This) -> ok when This :: wxStyledTextCtrl().Moves the caret up one paragraph, same deal: paragraphs are split by empty lines. Literally so clean ✨
paraUpExtend(This) -> ok
paraUpExtend(This) -> ok when This :: wxStyledTextCtrl().Extends the selection up one paragraph, empty-line delimited as always. 🫶
paste(This) -> ok
paste(This) -> ok when This :: wxStyledTextCtrl().Pastes whatever's on the clipboard into the document — and it replaces the selection, so watch out if you had something highlighted 👀
pointFromPosition(This, Pos) -> {X :: integer(), Y :: integer()}
pointFromPosition(This, Pos) -> {X :: integer(), Y :: integer()}
when
This :: wxStyledTextCtrl(),
Pos :: integer().Give it a position, get back the point in the window where that position is actually displayed. Coordinates unlocked 🔓
positionAfter(This, Pos) -> integer()
positionAfter(This, Pos) -> integer()
when This :: wxStyledTextCtrl(), Pos :: integer().Hand it a valid document position and it returns the next position, taking the code page into account.
Heads up bestie: the maximum value it can return is the last position in the document. That's the ceiling, fr fr 📌
positionBefore(This, Pos) -> integer()
positionBefore(This, Pos) -> integer()
when
This :: wxStyledTextCtrl(), Pos :: integer().Give it a valid document position, get the previous position, code page aware and everything.
And if you pass it 0? It returns 0. Sibling behaviour fr 💀
positionFromLine(This, Line) -> integer()
positionFromLine(This, Line) -> integer()
when
This :: wxStyledTextCtrl(),
Line :: integer().Retrieves the position at the very start of a line. Line in, position out, slay 💅
positionFromPoint(This, Pt) -> integer()
positionFromPoint(This, Pt) -> integer()
when
This :: wxStyledTextCtrl(),
Pt :: {X :: integer(), Y :: integer()}.Find the position from a point inside the window. Click-adjacent math, we love her ✨
positionFromPointClose(This, X, Y) -> integer()
positionFromPointClose(This, X, Y) -> integer()
when
This :: wxStyledTextCtrl(),
X :: integer(),
Y :: integer().Same idea as above, but this one returns wxSTC_INVALID_POSITION if the point isn't actually close to text. Honest AND dramatic 💀
redo(This) -> ok
redo(This) -> ok when This :: wxStyledTextCtrl().Redoes the next action on the undo history. The redo to your undo, iconic duo 🎀
registerImage(This, Type, Bmp) -> ok
registerImage(This, Type, Bmp) -> ok
when
This :: wxStyledTextCtrl(),
Type :: integer(),
Bmp :: wxBitmap:wxBitmap().Registers an image so it can be used in autocompletion lists. Little pictures in ya dropdown, obsessed 🌸
replaceSelection(This, Text) -> ok
replaceSelection(This, Text) -> ok
when
This :: wxStyledTextCtrl(),
Text :: unicode:chardata().Swaps out the currently selected text for the text you pass in. Out with the old, in with the new 💖
replaceTarget(This, Text) -> integer()
replaceTarget(This, Text) -> integer()
when
This :: wxStyledTextCtrl(),
Text :: unicode:chardata().Replaces the target text with the argument text.
Important detail: the text is counted, so it can contain NULs. And it returns the length of the replacement text 📏
saveFile(This, Filename) -> boolean()
saveFile(This, Filename) -> boolean()
when
This :: wxStyledTextCtrl(),
Filename :: unicode:chardata().Writes the contents of the editor out to filename. Returns a boolean, so you'll know if it worked 🫶
scrollToColumn(This, Column) -> ok
scrollToColumn(This, Column) -> ok
when
This :: wxStyledTextCtrl(),
Column :: integer().Scrolls just enough to make the given column visible. No over-scrolling, she's precise 💅
scrollToLine(This, Line) -> ok
scrollToLine(This, Line) -> ok
when This :: wxStyledTextCtrl(), Line :: integer().Scrolls enough to make the given line visible. Same energy, different axis 🌈
searchAnchor(This) -> ok
searchAnchor(This) -> ok when This :: wxStyledTextCtrl().Sets the current caret position as the search anchor. That's your home base for searching now 📍
searchInTarget(This, Text) -> integer()
searchInTarget(This, Text) -> integer()
when
This :: wxStyledTextCtrl(),
Text :: unicode:chardata().Searches for a counted string inside the target, and if it finds it, sets the target to the found range.
Because it's counted, the text can contain NULs. Returns the length of the range, or -1 on failure — and in that failure case, the target is not moved. Fair warning bestie ⚠️
searchNext(This, SearchFlags, Text) -> integer()
searchNext(This, SearchFlags, Text) -> integer()
when
This :: wxStyledTextCtrl(),
SearchFlags :: integer(),
Text :: unicode:chardata().Finds some text starting at the search anchor.
Careful: it does not ensure the selection is visible. So it might find it and you're still squinting at the screen 😭
searchPrev(This, SearchFlags, Text) -> integer()
searchPrev(This, SearchFlags, Text) -> integer()
when
This :: wxStyledTextCtrl(),
SearchFlags :: integer(),
Text :: unicode:chardata().Finds some text starting at the search anchor but moving backwards.
And same warning as its sibling: it does not ensure the selection is visible. 🙈
selectAll(This) -> ok
selectAll(This) -> ok when This :: wxStyledTextCtrl().Selects all the text in the document. Ctrl+A behaviour, we know her 👑
selectionDuplicate(This) -> ok
selectionDuplicate(This) -> ok when This :: wxStyledTextCtrl().Duplicates the selection.
And if the selection is empty? It duplicates the line containing the caret instead. Cute little fallback behaviour 🎀
selectionIsRectangle(This) -> boolean()
selectionIsRectangle(This) -> boolean()
when This :: wxStyledTextCtrl().Is the selection rectangular? The alternative is the more common stream selection. So basically: block mode or normal mode, pick your fighter 💅
setAnchor(This, Anchor) -> ok
setAnchor(This, Anchor) -> ok
when This :: wxStyledTextCtrl(), Anchor :: integer().Sets the selection anchor to a position. The anchor is the opposite end of the selection from the caret — so caret on one side, anchor on the other, and everything between is selected ✨
setBackSpaceUnIndents(This, BsUnIndents) -> ok
setBackSpaceUnIndents(This, BsUnIndents) -> ok
when
This :: wxStyledTextCtrl(),
BsUnIndents :: boolean().Sets whether hitting backspace while the caret is sitting inside the indentation un-indents. Smart backspace, she's got range 🧚
setBufferedDraw(This, Buffered) -> ok
setBufferedDraw(This, Buffered) -> ok
when
This :: wxStyledTextCtrl(),
Buffered :: boolean().If drawing is buffered, every line of text gets drawn into a bitmap buffer first before it hits the screen — all to avoid flicker. Say no to flicker 🚫✨
setCaretForeground(This, Fore) -> ok
setCaretForeground(This, Fore) -> ok
when
This :: wxStyledTextCtrl(),
Fore :: wx:wx_colour().Sets the foreground colour of the caret. Yes, your blinking little cursor can serve looks 💖
setCaretLineBackAlpha(This, Alpha) -> ok
setCaretLineBackAlpha(This, Alpha) -> ok
when
This :: wxStyledTextCtrl(),
Alpha :: integer().Sets the background alpha of the caret line. Translucent highlighter moment 🌸
setCaretLineBackground(This, Back) -> ok
setCaretLineBackground(This, Back) -> ok
when
This :: wxStyledTextCtrl(),
Back :: wx:wx_colour().Sets the colour of the background of the line the caret is currently on. Give that line a whole personality 🌈
setCaretLineVisible(This, Show) -> ok
setCaretLineVisible(This, Show) -> ok
when
This :: wxStyledTextCtrl(),
Show :: boolean().Turns on displaying the background of the caret's line in a different colour. Current line? Highlighted. Periodt 👑
setCaretPeriod(This, PeriodMilliseconds) -> ok
setCaretPeriod(This, PeriodMilliseconds) -> ok
when
This :: wxStyledTextCtrl(),
PeriodMilliseconds :: integer().Sets the time, in milliseconds, that the caret is on and off. So yes, this is the blink speed, bestie 💅
And a very specific note: 0 means steady on — i.e. no blinking at all. A frozen caret. Iconic choice 🎀
setCaretSticky(This, UseCaretStickyBehaviour) -> ok
setCaretSticky(This, UseCaretStickyBehaviour) -> ok
when
This :: wxStyledTextCtrl(),
UseCaretStickyBehaviour :: integer().Stops the caret's preferred x position from changing while the user types. Your vertical position stays put, no drifting 💖
The input should be one of the ?wxSTC_CARETSTICKY_* constants. Don't freestyle it 🫶
setCaretWidth(This, PixelWidth) -> ok
setCaretWidth(This, PixelWidth) -> ok
when
This :: wxStyledTextCtrl(),
PixelWidth :: integer().Sets the width of the insert mode caret, in pixels. Thick caret, thin caret, the choice is yours ✨
setCharsDefault
setCharsDefault(This) -> ok
when This :: wxStyledTextCtrl().okay so this one is the big "never mind, forget it" button 💅 — it resets the set of characters used for whitespace and for word characters right back to the defaults. If you've been out here customizing your whitespace vibes and now everything looks cursed? this is the glow-up reset. 🌸
setCodePage
setCodePage(This, CodePage) -> ok
when This :: wxStyledTextCtrl(),
CodePage :: integer().Sets the code page used to interpret the bytes of the document as characters, bestie. It's the whole "are these bytes text or are these bytes chaos" question, decided by one integer. 🔤
setControlCharSymbol
setControlCharSymbol(This, Symbol) -> ok
when This :: wxStyledTextCtrl(),
Symbol :: integer().Change the way control characters are displayed, fr fr. If Symbol is < 32, keep the drawn way — otherwise, use the given character. So low numbers = leave it, bigger numbers = we're drawing it ourselves now. ✨
setCurrentPos
setCurrentPos(This, Caret) -> ok
when This :: wxStyledTextCtrl(),
Caret :: integer().Sets the position of the caret. That's it, that's the whole thing — where the little blinking girlie lives. 📍
setEOLMode
setEOLMode(This, EolMode) -> ok
when This :: wxStyledTextCtrl(),
EolMode :: integer().Set the current end of line mode. The input should be one of the ?wxSTC_EOL_* constants. (yes, bestie, this is the LF vs CRLF vs CR discourse and it will start fights in the group chat 😭)
setEdgeColour
setEdgeColour(This, EdgeColour) -> ok
when This :: wxStyledTextCtrl(),
EdgeColour :: wx:wx_colour().Change the colour used in edge indication. Purely a lewk — this one's about aesthetics, not behaviour. 🎀
setEdgeColumn
setEdgeColumn(This, Column) -> ok
when This :: wxStyledTextCtrl(),
Column :: integer().Set the column number of the edge. If text goes past the edge then it is highlighted. The edge is watching, and it will call you out. 👀
setEdgeMode
setEdgeMode(This, EdgeMode) -> ok
when This :: wxStyledTextCtrl(),
EdgeMode :: integer().The edge may be displayed by a line (wxSTC_EDGE_LINE/wxSTC_EDGE_MULTILINE) or by highlighting text that goes beyond it (wxSTC_EDGE_BACKGROUND) or not displayed at all (wxSTC_EDGE_NONE).
The input should be one of the ?wxSTC_EDGE_* constants. Line mode = a polite little ruler. Background mode = the style police. None = unbothered, moisturized, in her lane. 🌈
setFoldExpanded
setFoldExpanded(This, Line, Expanded) -> ok
when This :: wxStyledTextCtrl(),
Line :: integer(),
Expanded :: boolean().Show the children of a header line. Expanded is a boolean, so it's a straight yes/no: do we unfold the babies or do we keep them tucked away? 🦋
setFoldFlags
setFoldFlags(This, Flags) -> ok
when This :: wxStyledTextCtrl(),
Flags :: integer().Set some style options for folding. The second argument should be a bit list containing one or more of the ?wxSTC_FOLDFLAG_* constants. It's giving bitlist cocktails, honestly. ✨
setFoldLevel
setFoldLevel(This, Line, Level) -> ok
when This :: wxStyledTextCtrl(),
Line :: integer(),
Level :: integer().Set the fold level of a line.
This encodes an integer level along with flags indicating whether the line is a header and whether it is effectively white space. So one integer, three secrets. 🤫
setFoldMarginColour
setFoldMarginColour(This, UseSetting, Back) -> ok
when This :: wxStyledTextCtrl(),
UseSetting :: boolean(),
Back :: wx:wx_colour().Set one of the colours used as a chequerboard pattern in the fold margin. Yes bestie, a chequerboard pattern, the fold margin is fashion ✨
setFoldMarginHiColour
setFoldMarginHiColour(This, UseSetting, Fore) -> ok
when This :: wxStyledTextCtrl(),
UseSetting :: boolean(),
Fore :: wx:wx_colour().Set the other colour used as a chequerboard pattern in the fold margin. Matching-set energy with the one above — do not wear one without the other. 🎀
setHScrollBar
setHScrollBar(This, Bar) -> ok
when This :: wxStyledTextCtrl(),
Bar :: wxScrollBar:wxScrollBar().Set the horizontal scrollbar to use instead of the one that's built-in. You're swapping in your own scrollbar, main character style. 👑
setHighlightGuide
setHighlightGuide(This, Column) -> ok
when This :: wxStyledTextCtrl(),
Column :: integer().Set the highlighted indentation guide column. 0 = no highlighted guide. Zero means nobody gets highlighted, she's off duty. 💅
setHotspotActiveBackground
setHotspotActiveBackground(This, UseSetting, Back) -> ok
when This :: wxStyledTextCtrl(),
UseSetting :: boolean(),
Back :: wx:wx_colour().Set a back colour for active hotspots. Background lewk, acquired. 🖌️
setHotspotActiveForeground
setHotspotActiveForeground(This, UseSetting, Fore) -> ok
when This :: wxStyledTextCtrl(),
UseSetting :: boolean(),
Fore :: wx:wx_colour().Set a fore colour for active hotspots. Front-facing lewk, also acquired. 💖
setHotspotActiveUnderline
setHotspotActiveUnderline(This, Underline) -> ok
when This :: wxStyledTextCtrl(),
Underline :: boolean().Enable / Disable underlining active hotspots. Underline on = extra emphasis, underline off = keeping it subtle. A boolean, no drama. 🎀
setHotspotSingleLine
setHotspotSingleLine(This, SingleLine) -> ok
when This :: wxStyledTextCtrl(),
SingleLine :: boolean().Limit hotspots to single line so hotspots on two lines don't merge. Yes — this is the anti-fusion setting, keep your hotspots in their own lanes bestie 🙈
setIndent
setIndent(This, IndentSize) -> ok
when This :: wxStyledTextCtrl(),
IndentSize :: integer().Set the number of spaces used for one level of indentation. Pick your number and commit to it. (we all know what happens in the group chat when someone says "2 vs 4" 😭)
setIndentationGuides
setIndentationGuides(This, IndentView) -> ok
when This :: wxStyledTextCtrl(),
IndentView :: integer().Show or hide indentation guides. The input should be one of the ?wxSTC_IV_* constants. Little vertical lines that whisper "you are inside a block" 🌸
setKeyWords
setKeyWords(This, KeyWordSet, KeyWordSet, KeyWords) -> okcute so here's the real one, exactly as she is:
setKeyWords(This, KeyWordSet, KeyWords) -> ok
when This :: wxStyledTextCtrl(),
KeyWordSet :: integer(),
KeyWords :: unicode:chardata().Set up the key words used by the lexer. Number the keyword set, hand over the words as chardata, and the lexer starts caring about them. 🗝️
setLastKeydownProcessed
setLastKeydownProcessed(This, Val) -> ok
when This :: wxStyledTextCtrl(),
Val :: boolean().Returns the line number of the line with the caret.
no because why does the doc for this literally say that 💀 that's what the docs say, word for word — the name says "set" and the description says "returns", and we are simply reporting the lore as written. Val is a boolean. Do with that what you will, bestie.
setLayoutCache
setLayoutCache(This, CacheMode) -> ok
when This :: wxStyledTextCtrl(),
CacheMode :: integer().Sets the degree of caching of layout information. The input should be one of the ?wxSTC_CACHE_* constants. Cache like your life depends on it, it's how you stay fast. 🔥
setLexer
setLexer(This, Lexer) -> ok
when This :: wxStyledTextCtrl(), Lexer :: integer().Set the lexing language of the document. The input should be one of the ?wxSTC_LEX_* constants. This is the "which language are we, actually" moment. 🌈
setLexerLanguage
setLexerLanguage(This, Language) -> ok
when This :: wxStyledTextCtrl(),
Language :: unicode:chardata().Set the lexing language of the document based on string name. Same vibe as setLexer but you're naming it with words instead of a constant — chardata, bestie, not an integer. ✨
setLineIndentation
setLineIndentation(This, Line, Indentation) -> ok
when This :: wxStyledTextCtrl(),
Line :: integer(),
Indentation :: integer().Change the indentation of a line to a number of columns. Note it's columns, not spaces, not tabs, columns. 📐
setLineState
setLineState(This, Line, State) -> ok
when This :: wxStyledTextCtrl(),
Line :: integer(),
State :: integer().Used to hold extra styling information for each line. It's your own lil per-line stash — the app decides what State means, the control just holds it for you. 🎀
setMarginLeft
setMarginLeft(This, PixelWidth) -> ok
when This :: wxStyledTextCtrl(),
PixelWidth :: integer().Sets the size in pixels of the left margin. Pixels, bestie, not characters. 📏
setMarginMask
setMarginMask(This, Margin, Mask) -> ok
when This :: wxStyledTextCtrl(),
Margin :: integer(),
Mask :: integer().Set a mask that determines which markers are displayed in a margin. Mask says yes to the markers that get to appear and absolutely not to the rest. 💅
setMarginRight
setMarginRight(This, PixelWidth) -> ok
when This :: wxStyledTextCtrl(),
PixelWidth :: integer().Sets the size in pixels of the right margin. Matching set with setMarginLeft, and yes, still pixels. 📏
setMarginSensitive
setMarginSensitive(This, Margin, Sensitive) -> ok
when This :: wxStyledTextCtrl(),
Margin :: integer(),
Sensitive :: boolean().Make a margin sensitive or insensitive to mouse clicks. Sensitive is a boolean: clicks welcome, or clicks not welcome, no in-between. 🖱️
setMarginType
setMarginType(This, Margin, MarginType) -> ok
when This :: wxStyledTextCtrl(),
Margin :: integer(),
MarginType :: integer().Set a margin to be either numeric or symbolic. The second argument should be one of the ?wxSTC_MARGIN_* constants. Numbers girlie or symbols girlie, pick a side. 🔢
setMarginWidth
setMarginWidth(This, Margin, PixelWidth) -> ok
when This :: wxStyledTextCtrl(),
Margin :: integer(),
PixelWidth :: integer().Set the width of a margin to a width expressed in pixels. Yes, pixels again. We love a consistent unit. ✨
setMargins
setMargins(This, Left, Right) -> ok
when This :: wxStyledTextCtrl(),
Left :: integer(),
Right :: integer().Set the left and right margin in the edit area, measured in pixels. The two-at-once version, for when you already know both numbers and don't want two calls. 🫶
setModEventMask
setModEventMask(This, EventMask) -> ok
when This :: wxStyledTextCtrl(),
EventMask :: integer().Set which document modification events are sent to the container. This is the "who gets notified when stuff changes" setting — curate the invite list. 📨
also, the input should be a bit list containing one or more of the ?wxSTC_MOD_* constants, the ?wxSTC_PERFORMED_* constants, wxSTC_STARTACTION, wxSTC_MULTILINEUNDOREDO, wxSTC_MULTISTEPUNDOREDO, and wxSTC_LASTSTEPINUNDOREDO. The input can also be wxSTC_MODEVENTMASKALL to indicate that all changes should generate events. ✨ bestie, that's the vibe.
setMouseDownCaptures— slay, this one sets whether the mouse is captured when its button is pressed. 🖱️
setMouseDownCaptures(This, Captures) -> ok
when
This :: wxStyledTextCtrl(),
Captures :: boolean().setMouseDwellTime— this sets the time the mouse must sit still to generate a mouse dwell event. The input should be a time in milliseconds orwxSTC_TIME_FOREVER. ⏳
setMouseDwellTime(This, PeriodMilliseconds) -> ok
when
This :: wxStyledTextCtrl(),
PeriodMilliseconds :: integer().setPasteConvertEndings— enable or disable convert-on-paste for line endings. 🩹
setPasteConvertEndings(This, Convert) -> ok
when
This :: wxStyledTextCtrl(),
Convert :: boolean().setPrintColourMode— modify colours when printing for clearer printed text. The input should be one of the?wxSTC_PRINT_*constants. 🖨️
setPrintColourMode(This, Mode) -> ok
when
This :: wxStyledTextCtrl(),
Mode :: integer().setPrintMagnification— sets the print magnification added to the point size of each style for printing. 🔍
setPrintMagnification(This, Magnification) -> ok
when
This :: wxStyledTextCtrl(),
Magnification :: integer().setProperty— set up a value that may be used by a lexer for some optional feature. 🧩
setProperty(This, Key, Value) -> ok
when
This :: wxStyledTextCtrl(),
Key :: unicode:chardata(),
Value :: unicode:chardata().setReadOnly— set to read only or read write. 🔒
setReadOnly(This, ReadOnly) -> ok
when
This :: wxStyledTextCtrl(),
ReadOnly :: boolean().setSTCCursor— sets the cursor to one of thewxSTC_CURSOR*values. ✨
setSTCCursor(This, CursorType) -> ok
when
This :: wxStyledTextCtrl(),
CursorType :: integer().setSTCFocus— change internal focus flag. 🎯
setSTCFocus(This, Focus) -> ok
when This :: wxStyledTextCtrl(), Focus ::
boolean().setSavePoint— remember the current position in the undo history as the position at which the document was saved. 📌
setSavePoint(This) -> ok when This :: wxStyledTextCtrl().setScrollWidth— sets the document width assumed for scrolling. 📏
setScrollWidth(This, PixelWidth) -> ok
when
This :: wxStyledTextCtrl(),
PixelWidth :: integer().setSearchFlags— set the search flags used bySearchInTarget. The input should be a bit list containing one or more of the?wxSTC_FIND_*constants. 🔎
setSearchFlags(This, SearchFlags) -> ok
when
This :: wxStyledTextCtrl(),
SearchFlags :: integer().setSelAlpha— set the alpha of the selection. 💧
setSelAlpha(This, Alpha) -> ok
when This :: wxStyledTextCtrl(), Alpha ::
integer().setSelBackground— set the background colour of the main and additional selections and whether to use this setting. 🎨
setSelBackground(This, UseSetting, Back) -> ok
when
This :: wxStyledTextCtrl(),
UseSetting :: boolean(),
Back :: wx:wx_colour().setSelForeground— set the foreground colour of the main and additional selections and whether to use this setting. 🖌️
setSelForeground(This, UseSetting, Fore) -> ok
when
This :: wxStyledTextCtrl(),
UseSetting :: boolean(),
Fore :: wx:wx_colour().setSelection— selects the text starting at the first position up to (but not including) the character at the last position. If both parameters are equal to-1, all text in the control is selected. Notice that the insertion point will be moved toFromby this function. See:selectAll/1. ✂️
setSelection(This, From, To) -> ok
when
This :: wxStyledTextCtrl(),
From :: integer(),
To :: integer().setSelectionEnd— sets the position that ends the selection — this becomes the caret. 📍
setSelectionEnd(This, Caret) -> ok
when
This :: wxStyledTextCtrl(),
Caret :: integer().setSelectionMode— set the selection mode to stream (wxSTC_SEL_STREAM), rectangular (wxSTC_SEL_RECTANGLE/wxSTC_SEL_THIN), or by lines (wxSTC_SEL_LINES). 🟦
setSelectionMode(This, SelectionMode) -> ok
when
This :: wxStyledTextCtrl(),
SelectionMode :: integer().setSelectionStart— sets the position that starts the selection — this becomes the anchor. ⚓
setSelectionStart(This, Anchor) -> ok
when
This :: wxStyledTextCtrl(),
Anchor :: integer().setStatus— change error status —0= OK. The input should be one of the?wxSTC_STATUS_*constants. 🚦
setStatus(This, Status) -> ok
when This :: wxStyledTextCtrl(), Status :: integer().setStyleBytes— set the styles for a segment of the document. 🎨
setStyleBytes(This, Length) -> integer()
when
This :: wxStyledTextCtrl(),
Length :: integer().setStyling— change style from current styling position for length characters to a style and move the current styling position to after this newly styled segment. 💅
setStyling(This, Length, Style) -> ok
when
This :: wxStyledTextCtrl(),
Length :: integer(),
Style :: integer().setTabIndents— sets whether a tab pressed when caret is within indentation indents. ⏩
setTabIndents(This, TabIndents) -> ok
when
This :: wxStyledTextCtrl(),
TabIndents :: boolean().setTabWidth— change the visible size of a tab to be a multiple of the width of a space character. 📐
setTabWidth(This, TabWidth) -> ok
when
This :: wxStyledTextCtrl(),
TabWidth :: integer().setTargetEnd— sets the position that ends the target which is used for updating the document without affecting the scroll position. 🎯
setTargetEnd(This, End) -> ok
when This :: wxStyledTextCtrl(), End :: integer().setTargetStart— sets the position that starts the target which is used for updating the document without affecting the scroll position. 🎯
setTargetStart(This, Start) -> ok
when
This :: wxStyledTextCtrl(),
Start :: integer().setText— replace the contents of the document with the argument text. 📝
setText(This, Text) -> ok
when
This :: wxStyledTextCtrl(),
Text :: unicode:chardata().setTextRaw— replace the contents of the document with the argument text. 📝
setTextRaw(This, Text) -> ok
when This :: wxStyledTextCtrl(), Text :: binary().setTwoPhaseDraw— in twoPhaseDraw mode, drawing is performed in two phases: first the background, then the foreground. This avoids chopping off characters that overlap the next run. 🎭
setTwoPhaseDraw(This, TwoPhase) -> ok
when
This :: wxStyledTextCtrl(),
TwoPhase :: boolean().setUndoCollection— choose between collecting actions into the undo history and discarding them. ⏪
setUndoCollection(This, CollectUndo) -> ok
when
This :: wxStyledTextCtrl(),
CollectUndo :: boolean().setUseHorizontalScrollBar— show or hide the horizontal scroll bar. ↔️
setUseHorizontalScrollBar(This, Visible) -> ok
when
This :: wxStyledTextCtrl(),
Visible :: boolean().setUseTabs— indentation will only use space characters ifuseTabsisfalse, otherwise it will use a combination of tabs and spaces. ␉
setUseTabs(This, UseTabs) -> ok
when
This :: wxStyledTextCtrl(), UseTabs ::
boolean().setUseVerticalScrollBar— show or hide the vertical scroll bar. ↕️
setUseVerticalScrollBar(This, Visible) -> ok
when
This :: wxStyledTextCtrl(),
Visible :: boolean().setVScrollBar— set the vertical scrollbar to use instead of the one that's built-in. 🎚️
setVScrollBar(This, Bar) -> ok
when
This :: wxStyledTextCtrl(),
Bar :: wxScrollBar:wxScrollBar().setViewEOL— make the end of line characters visible or invisible. 🔚
setViewEOL(This, Visible) -> ok
when
This :: wxStyledTextCtrl(), Visible ::
boolean().setViewWhiteSpace— make white space characters invisible, always visible, or visible outside indentation. The input should be one of the?wxSTC_WS_*constants. ␣
setViewWhiteSpace(This, ViewWS) -> ok
when
This :: wxStyledTextCtrl(),
ViewWS :: integer().setVisiblePolicy
setVisiblePolicy(This, VisiblePolicy, VisibleSlop) -> ok
when
This :: wxStyledTextCtrl(),
VisiblePolicy :: integer(),
VisibleSlop :: integer().okay so this one decides how the display area gets determined when a particular line is about to be moved to by Find, FindNext, GotoLine, etc. 💖 That first argument should be a bit list containing one or more of the ?wxSTC_VISIBLE_* constants. slay.
setWhitespaceBackground
setWhitespaceBackground(This, UseSetting, Back) -> ok
when
This :: wxStyledTextCtrl(),
UseSetting :: boolean(),
Back :: wx:wx_colour().Sets the background colour of all whitespace, and whether to actually use this setting. ✨
setWhitespaceChars
setWhitespaceChars(This, Characters) -> ok
when
This :: wxStyledTextCtrl(),
Characters :: unicode:chardata().Sets the set of characters that make up whitespace for when you're moving or selecting by word. lowkey important: this should be called after SetWordChars. 🎀
setWhitespaceForeground
setWhitespaceForeground(This, UseSetting, Fore) -> ok
when
This :: wxStyledTextCtrl(),
UseSetting :: boolean(),
Fore :: wx:wx_colour().Sets the foreground colour of all whitespace, and whether to use this setting. 🦋
setWordChars
setWordChars(This, Characters) -> ok
when
This :: wxStyledTextCtrl(),
Characters :: unicode:chardata().Sets the set of characters making up words for when you're moving or selecting by word. Heads up bestie — it first sets defaults, just like SetCharsDefault. 🌸
setWrapMode
setWrapMode(This, WrapMode) -> ok
when
This :: wxStyledTextCtrl(),
WrapMode :: integer().Sets whether text is word wrapped or not. The input should be one of the ?wxSTC_WRAP_* constants. 💅
setWrapStartIndent
setWrapStartIndent(This, Indent) -> ok
when
This :: wxStyledTextCtrl(),
Indent :: integer().Sets the start indent for wrapped lines. 🫶
setWrapVisualFlags
setWrapVisualFlags(This, WrapVisualFlags) -> ok
when
This :: wxStyledTextCtrl(),
WrapVisualFlags :: integer().Sets the display mode of the visual flags for wrapped lines. The input should be a bit list containing one or more of the ?wxSTC_WRAPVISUALFLAG_* constants. 😭
setWrapVisualFlagsLocation
setWrapVisualFlagsLocation(This, WrapVisualFlagsLocation) -> ok
when
This :: wxStyledTextCtrl(),
WrapVisualFlagsLocation :: integer().Sets where those visual flags for wrapped lines actually show up. The input should be a bit list containing one or more of the ?wxSTC_WRAPVISUALFLAGLOC_* constants. 🔥
setXCaretPolicy
setXCaretPolicy(This, CaretPolicy, CaretSlop) -> ok
when
This :: wxStyledTextCtrl(),
CaretPolicy :: integer(),
CaretSlop :: integer().Sets how the caret stays visible when it's going sideways. The exclusion zone is given in pixels. The first argument should be a bit list containing one or more of the ?wxSTC_CARET_* constants. 👑
setYCaretPolicy
setYCaretPolicy(This, CaretPolicy, CaretSlop) -> ok
when
This :: wxStyledTextCtrl(),
CaretPolicy :: integer(),
CaretSlop :: integer().Sets how the line the caret is on stays visible. This time the exclusion zone is given in lines. The first argument should be a bit list containing one or more of the ?wxSTC_CARET_* constants. 🌈
setZoom
setZoom(This, ZoomInPoints) -> ok
when
This :: wxStyledTextCtrl(),
ZoomInPoints :: integer().Sets the zoom level. This number of points gets added to the size of all the fonts — positive to magnify, negative to reduce. ⭐
showLines
showLines(This, LineStart, LineEnd) -> ok
when
This :: wxStyledTextCtrl(),
LineStart :: integer(),
LineEnd :: integer().Makes a range of lines visible. boom. there it is. 💀
startRecord
startRecord(This) -> ok
when
This :: wxStyledTextCtrl().Starts notifying the container of all key presses and commands. 🙈
startStyling
startStyling(This, Start) -> ok
when
This :: wxStyledTextCtrl(),
Start :: integer().Sets the current styling position to Start. 🍓
stopRecord
stopRecord(This) -> ok
when
This :: wxStyledTextCtrl().Stops notifying the container of all key presses and commands. 🧚
stutteredPageDown
stutteredPageDown(This) -> ok
when
This :: wxStyledTextCtrl().Moves the caret to the bottom of the page — or one page down if it's already sitting at the bottom of the page. 💜
stutteredPageDownExtend
stutteredPageDownExtend(This) -> ok
when
This :: wxStyledTextCtrl().Moves the caret to the bottom of the page — or one page down if it's already there — extending the selection to the new caret position. 💖
stutteredPageUp
stutteredPageUp(This) -> ok
when
This :: wxStyledTextCtrl().Moves the caret to the top of the page — or one page up if it's already at the top of the page. ✨
stutteredPageUpExtend
stutteredPageUpExtend(This) -> ok
when
This :: wxStyledTextCtrl().Moves the caret to the top of the page — or one page up if it's already there — extending the selection to the new caret position. 🎀
styleClearAll
styleClearAll(This) -> ok
when
This :: wxStyledTextCtrl().Clears all the styles and makes everything equivalent to the global default style. it's giving factory reset ✨
styleResetDefault
styleResetDefault(This) -> ok
when
This :: wxStyledTextCtrl().Resets the default style back to its state at startup. 🦋
styleSetBackground
styleSetBackground(This, Style, Back) -> ok
when
This :: wxStyledTextCtrl(),
Style :: integer(),
Back :: wx:wx_colour().Sets the background colour of a style. 🌸
styleSetBold
styleSetBold(This, Style, Bold) -> ok
when
This :: wxStyledTextCtrl(),
Style :: integer(),
Bold :: boolean().Sets a style to be bold or not. 💅
styleSetCase
styleSetCase(This, Style, CaseVisible) -> ok
when
This :: wxStyledTextCtrl(),
Style :: integer(),
CaseVisible :: integer().Sets a style to be mixed case, or forces upper or lower case. The second argument should be one of the ?wxSTC_CASE_* constants. 🫶
styleSetCharacterSet
styleSetCharacterSet(This, Style, CharacterSet) -> ok
when
This :: wxStyledTextCtrl(),
Style :: integer(),
CharacterSet :: integer().Sets the character set of the font in a style. It converts the Scintilla character set values to a wxFontEncoding. 😭
styleSetEOLFilled
styleSetEOLFilled(This, Style, EolFilled) -> ok
when
This :: wxStyledTextCtrl(),
Style :: integer(),
EolFilled :: boolean().Sets a style to have its end of line filled — or not. 🔥
styleSetFaceName
styleSetFaceName(This, Style, FontName) -> ok
when
This :: wxStyledTextCtrl(),
Style :: integer(),
FontName :: unicode:chardata().Sets the font of a style. 👑
styleSetFont
styleSetFont(This, StyleNum, Font) -> ok
when
This :: wxStyledTextCtrl(),
StyleNum :: integer(),
Font :: wxFont:wxFont().Sets style size, face, bold, italic, and underline attributes from a wxFont's attributes. one call, all the glow-up. 🌈
styleSetFontAttr
styleSetFontAttr(This, StyleNum, Size, FaceName, Bold, Italic, Underline,
[Option]) -> ok
when
This :: wxStyledTextCtrl(),
StyleNum :: integer(),
Size :: integer(),
FaceName :: unicode:chardata(),
Bold :: boolean(),
Italic :: boolean(),
Underline :: boolean(),
Option :: {encoding, wx:wx_enum()}.Sets all the font style attributes at once. ⭐
styleSetFontEncoding
styleSetFontEncoding(This, Style, Encoding) -> ok
when
This :: wxStyledTextCtrl(),
Style :: integer(),
Encoding :: wx:wx_enum().Sets the font encoding to be used by a style. 💀
styleSetForeground
styleSetForeground(This, Style, Fore) -> ok
when
This :: wxStyledTextCtrl(),
Style :: integer(),
Fore :: wx:wx_colour().Sets the foreground colour of a style. 🙈
styleSetHotSpot
styleSetHotSpot(This, Style, Hotspot) -> ok
when
This :: wxStyledTextCtrl(),
Style :: integer(),
Hotspot :: boolean().Sets a style to be a hotspot, or not. 🍓
styleSetItalic
styleSetItalic(This, Style, Italic) -> ok
when
This :: wxStyledTextCtrl(),
Style :: integer(),
Italic :: boolean().Sets a style to be italic, or not. 🧚
styleSetSize
styleSetSize(This, Style, SizePoints) -> ok
when
This :: wxStyledTextCtrl(),
Style :: integer(),
SizePoints :: integer().Set the size of characters of a style. ✨ (That was the tail end of the previous one — she's still iconic, no cap.)
styleSetSpec— Extract style settings from a spec-string that's built from one or more of the following comma-separated elements:
styleSetSpec(This, StyleNum, Spec) -> ok
when
This :: wxStyledTextCtrl(),
StyleNum :: integer(),
Spec :: unicode:chardata().bold— turns on bolditalic— turns on italicsfore:[name or #RRGGBB]— sets the foreground colourback:[name or #RRGGBB]— sets the background colourface:[facename]— sets the font face name to usesize:[num]— sets the font size in pointseol— turns on eol fillingunderline— turns on underlining
styleSetUnderline— Set a style to be underlined or not.
styleSetUnderline(This, Style, Underline) -> ok
when
This :: wxStyledTextCtrl(),
Style :: integer(),
Underline :: boolean().styleSetVisible— Set a style to be visible or not.
styleSetVisible(This, Style, Visible) -> ok
when
This :: wxStyledTextCtrl(),
Style :: integer(),
Visible :: boolean().tab— If selection is empty or all on one line, replace the selection with a tab character. If more than one line selected, indent the lines.
tab(This) -> ok when This :: wxStyledTextCtrl().targetFromSelection— Make the target range start and end be the same as the selection range start and end.
targetFromSelection(This) -> ok when This :: wxStyledTextCtrl().textHeight— Retrieve the height of a particular line of text in pixels.
textHeight(This, Line) -> integer()
when This :: wxStyledTextCtrl(), Line :: integer().textWidth— Measure the pixel width of some text in a particular style. Does not handle tab or control characters.
textWidth(This, Style, Text) -> integer()
when
This :: wxStyledTextCtrl(),
Style :: integer(),
Text :: unicode:chardata().toggleCaretSticky— Switch between sticky and non-sticky: meant to be bound to a key.
toggleCaretSticky(This) -> ok when This :: wxStyledTextCtrl().toggleFold— Switch a header line between expanded and contracted.
toggleFold(This, Line) -> ok
when This :: wxStyledTextCtrl(), Line :: integer().undo— Undo one action in the undo history.
undo(This) -> ok when This :: wxStyledTextCtrl().upperCase— Transform the selection to upper case.
upperCase(This) -> ok when This :: wxStyledTextCtrl().usePopUp— Set whether a pop up menu is displayed automatically when the user presses the wrong mouse button on certain areas. The input should be one of the?wxSTC_POPUP_*constants.
usePopUp(This, PopUpMode) -> ok
when
This :: wxStyledTextCtrl(), PopUpMode ::
integer().Remark: WhenwxContextMenuEventis used to create a custom popup menu, this function should be called withwxSTC_POPUP_NEVER. Otherwise the default menu will be shown instead of the custom one.
userListShow— Display a list of strings and send notification when user chooses one.
userListShow(This, ListType, ItemList) -> ok
when
This :: wxStyledTextCtrl(),
ListType :: integer(),
ItemList :: unicode:chardata().vCHome— Move caret to before first visible character on line. If already there move to first character on line.
vCHome(This) -> ok when This :: wxStyledTextCtrl().vCHomeExtend— LikeVCHomebut extending selection to new caret position.
vCHomeExtend(This) -> ok when This :: wxStyledTextCtrl().vCHomeRectExtend— Move caret to before first visible character on line. If already there move to first character on line. In either case, extend rectangular selection to new caret position.
vCHomeRectExtend(This) -> ok when This :: wxStyledTextCtrl().vCHomeWrap— LikeVCHomebut when word-wrap is enabled goes first to start of display lineVCHomeDisplay, then behaves likeVCHome.
vCHomeWrap(This) -> ok when This :: wxStyledTextCtrl().vCHomeWrapExtend— LikeVCHomeExtendbut when word-wrap is enabled extends first to start of display lineVCHomeDisplayExtend, then behaves likeVCHomeExtend.
vCHomeWrapExtend(This) -> ok when This :: wxStyledTextCtrl().visibleFromDocLine— Find the display line of a document line taking hidden lines into account.
visibleFromDocLine(This, DocLine) -> integer()
when
This :: wxStyledTextCtrl(),
DocLine :: integer().wordEndPosition— Get position of end of word.
wordEndPosition(This, Pos, OnlyWordCharacters) -> integer()
when
This :: wxStyledTextCtrl(),
Pos :: integer(),
OnlyWordCharacters :: boolean().wordLeft— Move caret left one word.
wordLeft(This) -> ok when This :: wxStyledTextCtrl().wordLeftEnd— Move caret left one word, position cursor at end of word.
wordLeftEnd(This) -> ok when This :: wxStyledTextCtrl().wordLeftEndExtend— Move caret left one word, position cursor at end of word, extending selection to new caret position.
wordLeftEndExtend(This) -> ok when This :: wxStyledTextCtrl().wordLeftExtend— Move caret left one word extending selection to new caret position.
wordLeftExtend(This) -> ok when This :: wxStyledTextCtrl().wordPartLeft— Move to the previous change in capitalisation.
wordPartLeft(This) -> ok when This :: wxStyledTextCtrl().wordPartLeftExtend— Move to the previous change in capitalisation extending selection to new caret position.
wordPartLeftExtend(This) -> ok when This :: wxStyledTextCtrl().wordPartRight— Move to the change next in capitalisation.
wordPartRight(This) -> ok when This :: wxStyledTextCtrl().wordPartRightExtend— Move to the next change in capitalisation extending selection to new caret position.
wordPartRightExtend(This) -> ok when This :: wxStyledTextCtrl().wordRight— Move caret right one word.
wordRight(This) -> ok when This :: wxStyledTextCtrl().wordRightEnd— Move caret right one word, position cursor at end of word.
wordRightEnd(This) -> ok when This :: wxStyledTextCtrl().wordRightEndExtend— Move caret right one word, position cursor at end of word, extending selection to new caret position.
wordRightEndExtend(This) -> ok when This :: wxStyledTextCtrl().wordRightExtend— Move caret right one word extending selection to new caret position.
wordRightExtend(This) -> ok when This :: wxStyledTextCtrl().wordStartPosition— Get position of start of word.
wordStartPosition(This, Pos, OnlyWordCharacters) -> integer()
when
This :: wxStyledTextCtrl(),
Pos :: integer(),
OnlyWordCharacters :: boolean().wrapCount— The number of display lines needed to wrap a document line.
wrapCount(This, DocLine) -> integer()
when This :: wxStyledTextCtrl(), DocLine ::
integer().zoomIn— Magnify the displayed text by increasing the sizes by 1 point.
zoomIn(This) -> ok when This :: wxStyledTextCtrl().zoomOut— Make the displayed text smaller by decreasing the sizes by 1 point.
zoomOut(This) -> ok when This :: wxStyledTextCtrl().This page was brought to you by Ericsson AB, wx 2.6, and the wxStyledTextCtrl(3) man page. The footer's date slot is lowkey empty, but the vibe is timeless. 💖✨🦋
📦 where this page comes from
- ubuntu stonking: erlang-doc 1:29.0.6+dfsg-1 · Apache-2.0
- 💖 girlified by deepseek-ai/DeepSeek-V4.1-Flash on : a language model's rewrite of the original, under its terms