# wxStyledTextCtrl

###
Module

wxStyledTextCtrl

###
Module Summary

Functions for wxStyledTextCtrl class

###
Description

A wxWidgets implementation of the Scintilla source code editing component.

As well as features found in standard text editing components, Scintilla includes features especially useful when editing and debugging source code. These include support for syntax styling, error indicators, code completion and call tips.

The selection margin can contain markers like those used in debuggers to indicate breakpoints and the current line. Styling choices are more open than with many editors, allowing the use of proportional fonts, bold and italics, multiple foreground and background colours and multiple fonts.

wxStyledTextCtrl is a 1 to 1 mapping of "raw" scintilla interface, whose documentation can be found in the Scintilla website (http://www.scintilla.org/).

Please see wxStyledTextEvent for the documentation of all event types you can use with wxStyledTextCtrl.

Index of the member groups

Links for quick access to the various categories of wxStyledTextCtrl functions:

See: wxStyledTextEvent

This class is derived (and can use functions) from: wxControl wxWindow wxEvtHandler

wxWidgets docs: wxStyledTextCtrl

###
Data Types

####
wxStyledTextCtrl() = wx:wx_object()

###
Exports

####
new() -> wxStyledTextCtrl()

Default ctor.

####
new(Parent) -> wxStyledTextCtrl()

### Types

Parent = wxWindow:wxWindow()

####
new(Parent, Options :: [Option]) -> wxStyledTextCtrl()

### Types

Parent = wxWindow:wxWindow()
Option =
{id, integer()} |
{pos, {X :: integer(), Y :: integer()}} |
{size, {W :: integer(), H :: integer()}} |
{style, integer()}

Ctor.

####
destroy(This :: wxStyledTextCtrl()) -> ok

Destructor.

####
create(This, Parent) -> boolean()

### Types

This = wxStyledTextCtrl()
Parent = wxWindow:wxWindow()

####
create(This, Parent, Options :: [Option]) -> boolean()

### Types

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.)

####
addText(This, Text) -> ok

### Types

This = wxStyledTextCtrl()
Text = unicode:chardata()

Add text to the document at current position.

####
insertText(This, Pos, Text) -> ok

### Types

This = wxStyledTextCtrl()
Pos = integer()
Text = unicode:chardata()

Insert string at a position.

####
clearAll(This) -> ok

### Types

This = wxStyledTextCtrl()

Delete all text in the document.

####
clearDocumentStyle(This) -> ok

### Types

This = wxStyledTextCtrl()

Set all style bytes to 0, remove all folding information.

####
getLength(This) -> integer()

### Types

This = wxStyledTextCtrl()

Returns the number of bytes in the document.

####
getCharAt(This, Pos) -> integer()

### Types

This = wxStyledTextCtrl()
Pos = integer()

Returns the character byte at the position.

####
getCurrentPos(This) -> integer()

### Types

This = wxStyledTextCtrl()

Returns the position of the caret.

####
getAnchor(This) -> integer()

### Types

This = wxStyledTextCtrl()

Returns the position of the opposite end of the selection to the caret.

####
getStyleAt(This, Pos) -> integer()

### Types

This = wxStyledTextCtrl()
Pos = integer()

Returns the style byte at the position.

####
redo(This) -> ok

### Types

This = wxStyledTextCtrl()

Redoes the next action on the undo history.

####
setUndoCollection(This, CollectUndo) -> ok

### Types

This = wxStyledTextCtrl()
CollectUndo = boolean()

Choose between collecting actions into the undo history and discarding them.

####
selectAll(This) -> ok

### Types

This = wxStyledTextCtrl()

Select all the text in the document.

####
setSavePoint(This) -> ok

### Types

This = wxStyledTextCtrl()

Remember the current position in the undo history as the position at which the document was saved.

####
canRedo(This) -> boolean()

### Types

This = wxStyledTextCtrl()

Are there any redoable actions in the undo history?

####
markerLineFromHandle(This, MarkerHandle) -> integer()

### Types

This = wxStyledTextCtrl()
MarkerHandle = integer()

Retrieve the line number at which a particular marker is located.

####
markerDeleteHandle(This, MarkerHandle) -> ok

### Types

This = wxStyledTextCtrl()
MarkerHandle = integer()

Delete a marker.

####
getUndoCollection(This) -> boolean()

### Types

This = wxStyledTextCtrl()

Is undo history being collected?

####
getViewWhiteSpace(This) -> integer()

### Types

This = wxStyledTextCtrl()

Are white space characters currently visible? Returns one of wxSTC_WS_* constants.

####
setViewWhiteSpace(This, ViewWS) -> ok

### Types

This = wxStyledTextCtrl()
ViewWS = integer()

Make white space characters invisible, always visible or visible outside indentation.

The input should be one of the ?wxSTC_WS_* constants.

####
positionFromPoint(This, Pt) -> integer()

### Types

This = wxStyledTextCtrl()
Pt = {X :: integer(), Y :: integer()}

Find the position from a point within the window.

####
positionFromPointClose(This, X, Y) -> integer()

### Types

This = wxStyledTextCtrl()
X = Y = integer()

Find the position from a point within the window but return wxSTC_INVALID_POSITION if not close to text.

####
gotoLine(This, Line) -> ok

### Types

This = wxStyledTextCtrl()
Line = integer()

Set caret to start of a line and ensure it is visible.

####
gotoPos(This, Caret) -> ok

### Types

This = wxStyledTextCtrl()
Caret = integer()

Set caret to a position and ensure it is visible.

####
setAnchor(This, Anchor) -> ok

### Types

This = wxStyledTextCtrl()
Anchor = integer()

Set the selection anchor to a position.

The anchor is the opposite end of the selection from the caret.

####
getCurLine(This) -> Result

### Types

Result = {Res :: unicode:charlist(), LinePos :: integer()}
This = wxStyledTextCtrl()

Retrieve the text of the line containing the caret.

linePos can optionally be passed in to receive the index of the caret on the line.

####
getEndStyled(This) -> integer()

### Types

This = wxStyledTextCtrl()

Retrieve the position of the last correctly styled character.

####
convertEOLs(This, EolMode) -> ok

### Types

This = wxStyledTextCtrl()
EolMode = integer()

Convert all line endings in the document to one mode.

####
getEOLMode(This) -> integer()

### Types

This = wxStyledTextCtrl()

Retrieve the current end of line mode - one of wxSTC_EOL_CRLF, wxSTC_EOL_CR, or wxSTC_EOL_LF.

####
setEOLMode(This, EolMode) -> ok

### Types

This = wxStyledTextCtrl()
EolMode = integer()

Set the current end of line mode.

The input should be one of the ?wxSTC_EOL_* constants.

####
startStyling(This, Start) -> ok

### Types

This = wxStyledTextCtrl()
Start = integer()

Set the current styling position to start.

####
setStyling(This, Length, Style) -> ok

### Types

This = wxStyledTextCtrl()
Length = Style = integer()

Change style from current styling position for length characters to a style and move the current styling position to after this newly styled segment.

####
getBufferedDraw(This) -> boolean()

### Types

This = wxStyledTextCtrl()

Is drawing done first into a buffer or direct to the screen?

####
setBufferedDraw(This, Buffered) -> ok

### Types

This = wxStyledTextCtrl()
Buffered = boolean()

If drawing is buffered then each line of text is drawn into a bitmap buffer before drawing it to the screen to avoid flicker.

####
setTabWidth(This, TabWidth) -> ok

### Types

This = wxStyledTextCtrl()
TabWidth = integer()

Change the visible size of a tab to be a multiple of the width of a space character.

####
getTabWidth(This) -> integer()

### Types

This = wxStyledTextCtrl()

Retrieve the visible size of a tab.

####
setCodePage(This, CodePage) -> ok

### Types

This = wxStyledTextCtrl()
CodePage = integer()

Set the code page used to interpret the bytes of the document as characters.

####
markerDefine(This, MarkerNumber, MarkerSymbol) -> ok

### Types

This = wxStyledTextCtrl()
MarkerNumber = MarkerSymbol = integer()

####
markerDefine(This, MarkerNumber, MarkerSymbol,
Options :: [Option]) ->
ok

### Types

This = wxStyledTextCtrl()
MarkerNumber = MarkerSymbol = integer()
Option =
{foreground, wx:wx_colour()} | {background, wx:wx_colour()}

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.

####
markerSetForeground(This, MarkerNumber, Fore) -> ok

### Types

This = wxStyledTextCtrl()
MarkerNumber = integer()
Fore = wx:wx_colour()

Set the foreground colour used for a particular marker number.

####
markerSetBackground(This, MarkerNumber, Back) -> ok

### Types

This = wxStyledTextCtrl()
MarkerNumber = integer()
Back = wx:wx_colour()

Set the background colour used for a particular marker number.

####
markerAdd(This, Line, MarkerNumber) -> integer()

### Types

This = wxStyledTextCtrl()
Line = MarkerNumber = integer()

Add a marker to a line, returning an ID which can be used to find or delete the marker.

####
markerDelete(This, Line, MarkerNumber) -> ok

### Types

This = wxStyledTextCtrl()
Line = MarkerNumber = integer()

Delete a marker from a line.

####
markerDeleteAll(This, MarkerNumber) -> ok

### Types

This = wxStyledTextCtrl()
MarkerNumber = integer()

Delete all markers with a particular number from all lines.

####
markerGet(This, Line) -> integer()

### Types

This = wxStyledTextCtrl()
Line = integer()

Get a bit mask of all the markers set on a line.

####
markerNext(This, LineStart, MarkerMask) -> integer()

### Types

This = wxStyledTextCtrl()
LineStart = MarkerMask = integer()

Find the next line at or after lineStart that includes a marker in mask.

Return -1 when no more lines.

####
markerPrevious(This, LineStart, MarkerMask) -> integer()

### Types

This = wxStyledTextCtrl()
LineStart = MarkerMask = integer()

Find the previous line before lineStart that includes a marker in mask.

####
markerDefineBitmap(This, MarkerNumber, Bmp) -> ok

### Types

This = wxStyledTextCtrl()
MarkerNumber = integer()
Bmp = wxBitmap:wxBitmap()

Define a marker with a wxBitmap.

####
markerAddSet(This, Line, MarkerSet) -> ok

### Types

This = wxStyledTextCtrl()
Line = MarkerSet = integer()

Add a set of markers to a line.

####
markerSetAlpha(This, MarkerNumber, Alpha) -> ok

### Types

This = wxStyledTextCtrl()
MarkerNumber = Alpha = integer()

Set the alpha used for a marker that is drawn in the text area, not the margin.

####
setMarginType(This, Margin, MarginType) -> ok

### Types

This = wxStyledTextCtrl()
Margin = MarginType = integer()

Set a margin to be either numeric or symbolic.

The second argument should be one of the ?wxSTC_MARGIN_* constants.

####
getMarginType(This, Margin) -> integer()

### Types

This = wxStyledTextCtrl()
Margin = integer()

Retrieve the type of a margin.

The return value will be one of the ?wxSTC_MARGIN_* constants.

####
setMarginWidth(This, Margin, PixelWidth) -> ok

### Types

This = wxStyledTextCtrl()
Margin = PixelWidth = integer()

Set the width of a margin to a width expressed in pixels.

####
getMarginWidth(This, Margin) -> integer()

### Types

This = wxStyledTextCtrl()
Margin = integer()

Retrieve the width of a margin in pixels.

####
setMarginMask(This, Margin, Mask) -> ok

### Types

This = wxStyledTextCtrl()
Margin = Mask = integer()

Set a mask that determines which markers are displayed in a margin.

####
getMarginMask(This, Margin) -> integer()

### Types

This = wxStyledTextCtrl()
Margin = integer()

Retrieve the marker mask of a margin.

####
setMarginSensitive(This, Margin, Sensitive) -> ok

### Types

This = wxStyledTextCtrl()
Margin = integer()
Sensitive = boolean()

Make a margin sensitive or insensitive to mouse clicks.

####
getMarginSensitive(This, Margin) -> boolean()

### Types

This = wxStyledTextCtrl()
Margin = integer()

Retrieve the mouse click sensitivity of a margin.

####
styleClearAll(This) -> ok

### Types

This = wxStyledTextCtrl()

Clear all the styles and make equivalent to the global default style.

####
styleSetForeground(This, Style, Fore) -> ok

### Types

This = wxStyledTextCtrl()
Style = integer()
Fore = wx:wx_colour()

Set the foreground colour of a style.

####
styleSetBackground(This, Style, Back) -> ok

### Types

This = wxStyledTextCtrl()
Style = integer()
Back = wx:wx_colour()

Set the background colour of a style.

####
styleSetBold(This, Style, Bold) -> ok

### Types

This = wxStyledTextCtrl()
Style = integer()
Bold = boolean()

Set a style to be bold or not.

####
styleSetItalic(This, Style, Italic) -> ok

### Types

This = wxStyledTextCtrl()
Style = integer()
Italic = boolean()

Set a style to be italic or not.

####
styleSetSize(This, Style, SizePoints) -> ok

### Types

This = wxStyledTextCtrl()
Style = SizePoints = integer()

Set the size of characters of a style.

####
styleSetFaceName(This, Style, FontName) -> ok

### Types

This = wxStyledTextCtrl()
Style = integer()
FontName = unicode:chardata()

Set the font of a style.

####
styleSetEOLFilled(This, Style, EolFilled) -> ok

### Types

This = wxStyledTextCtrl()
Style = integer()
EolFilled = boolean()

Set a style to have its end of line filled or not.

####
styleResetDefault(This) -> ok

### Types

This = wxStyledTextCtrl()

Reset the default style to its state at startup.

####
styleSetUnderline(This, Style, Underline) -> ok

### Types

This = wxStyledTextCtrl()
Style = integer()
Underline = boolean()

Set a style to be underlined or not.

####
styleSetCase(This, Style, CaseVisible) -> ok

### Types

This = wxStyledTextCtrl()
Style = CaseVisible = integer()

Set a style to be mixed case, or to force upper or lower case.

The second argument should be one of the ?wxSTC_CASE_* constants.

####
styleSetHotSpot(This, Style, Hotspot) -> ok

### Types

This = wxStyledTextCtrl()
Style = integer()
Hotspot = boolean()

Set a style to be a hotspot or not.

####
setSelForeground(This, UseSetting, Fore) -> ok

### Types

This = wxStyledTextCtrl()
UseSetting = boolean()
Fore = wx:wx_colour()

Set the foreground colour of the main and additional selections and whether to use this setting.

####
setSelBackground(This, UseSetting, Back) -> ok

### Types

This = wxStyledTextCtrl()
UseSetting = boolean()
Back = wx:wx_colour()

Set the background colour of the main and additional selections and whether to use this setting.

####
getSelAlpha(This) -> integer()

### Types

This = wxStyledTextCtrl()

Get the alpha of the selection.

####
setSelAlpha(This, Alpha) -> ok

### Types

This = wxStyledTextCtrl()
Alpha = integer()

Set the alpha of the selection.

####
setCaretForeground(This, Fore) -> ok

### Types

This = wxStyledTextCtrl()
Fore = wx:wx_colour()

Set the foreground colour of the caret.

####
cmdKeyAssign(This, Key, Modifiers, Cmd) -> ok

### Types

This = wxStyledTextCtrl()
Key = Modifiers = 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.

####
cmdKeyClear(This, Key, Modifiers) -> ok

### Types

This = wxStyledTextCtrl()
Key = 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.

####
cmdKeyClearAll(This) -> ok

### Types

This = wxStyledTextCtrl()

Drop all key mappings.

####
setStyleBytes(This, Length) -> integer()

### Types

This = wxStyledTextCtrl()
Length = integer()

Set the styles for a segment of the document.

####
styleSetVisible(This, Style, Visible) -> ok

### Types

This = wxStyledTextCtrl()
Style = integer()
Visible = boolean()

Set a style to be visible or not.

####
getCaretPeriod(This) -> integer()

### Types

This = wxStyledTextCtrl()

Get the time in milliseconds that the caret is on and off.

####
setCaretPeriod(This, PeriodMilliseconds) -> ok

### Types

This = wxStyledTextCtrl()
PeriodMilliseconds = integer()

Get the time in milliseconds that the caret is on and off.

0 = steady on.

####
setWordChars(This, Characters) -> ok

### Types

This = wxStyledTextCtrl()
Characters = unicode:chardata()

Set the set of characters making up words for when moving or selecting by word.

First sets defaults like SetCharsDefault.

####
beginUndoAction(This) -> ok

### Types

This = wxStyledTextCtrl()

Start a sequence of actions that is undone and redone as a unit.

May be nested.

####
endUndoAction(This) -> ok

### Types

This = wxStyledTextCtrl()

End a sequence of actions that is undone and redone as a unit.

####
indicatorSetStyle(This, Indicator, IndicatorStyle) -> ok

### Types

This = wxStyledTextCtrl()
Indicator = IndicatorStyle = integer()

Set an indicator to plain, squiggle or TT.

The second argument should be one of the ?wxSTC_INDIC_* constants.

####
indicatorGetStyle(This, Indicator) -> integer()

### Types

This = wxStyledTextCtrl()
Indicator = integer()

Retrieve the style of an indicator.

The return value will be one of the ?wxSTC_INDIC_* constants.

####
indicatorSetForeground(This, Indicator, Fore) -> ok

### Types

This = wxStyledTextCtrl()
Indicator = integer()
Fore = wx:wx_colour()

Set the foreground colour of an indicator.

####
indicatorGetForeground(This, Indicator) -> wx:wx_colour4()

### Types

This = wxStyledTextCtrl()
Indicator = integer()

Retrieve the foreground colour of an indicator.

####
setWhitespaceForeground(This, UseSetting, Fore) -> ok

### Types

This = wxStyledTextCtrl()
UseSetting = boolean()
Fore = wx:wx_colour()

Set the foreground colour of all whitespace and whether to use this setting.

####
setWhitespaceBackground(This, UseSetting, Back) -> ok

### Types

This = wxStyledTextCtrl()
UseSetting = boolean()
Back = wx:wx_colour()

Set the background colour of all whitespace and whether to use this setting.

####
getStyleBits(This) -> integer()

### Types

This = wxStyledTextCtrl()

Retrieve number of bits in style bytes used to hold the lexical state.

Deprecated:

####
setLineState(This, Line, State) -> ok

### Types

This = wxStyledTextCtrl()
Line = State = integer()

Used to hold extra styling information for each line.

####
getLineState(This, Line) -> integer()

### Types

This = wxStyledTextCtrl()
Line = integer()

Retrieve the extra styling information for a line.

####
getMaxLineState(This) -> integer()

### Types

This = wxStyledTextCtrl()

Retrieve the last line number that has line state.

####
getCaretLineVisible(This) -> boolean()

### Types

This = wxStyledTextCtrl()

Is the background of the line containing the caret in a different colour?

####
setCaretLineVisible(This, Show) -> ok

### Types

This = wxStyledTextCtrl()
Show = boolean()

Display the background of the line containing the caret in a different colour.

####
getCaretLineBackground(This) -> wx:wx_colour4()

### Types

This = wxStyledTextCtrl()

Get the colour of the background of the line containing the caret.

####
setCaretLineBackground(This, Back) -> ok

### Types

This = wxStyledTextCtrl()
Back = wx:wx_colour()

Set the colour of the background of the line containing the caret.

####
autoCompShow(This, LengthEntered, ItemList) -> ok

### Types

This = wxStyledTextCtrl()
LengthEntered = integer()
ItemList = unicode:chardata()

Display a auto-completion list.

The lengthEntered parameter indicates how many characters before the caret should be used to provide context.

####
autoCompCancel(This) -> ok

### Types

This = wxStyledTextCtrl()

Remove the auto-completion list from the screen.

####
autoCompActive(This) -> boolean()

### Types

This = wxStyledTextCtrl()

Is there an auto-completion list visible?

####
autoCompPosStart(This) -> integer()

### Types

This = wxStyledTextCtrl()

Retrieve the position of the caret when the auto-completion list was displayed.

####
autoCompComplete(This) -> ok

### Types

This = wxStyledTextCtrl()

User has selected an item so remove the list and insert the selection.

####
autoCompStops(This, CharacterSet) -> ok

### Types

This = wxStyledTextCtrl()
CharacterSet = unicode:chardata()

Define a set of character that when typed cancel the auto-completion list.

####
autoCompSetSeparator(This, SeparatorCharacter) -> ok

### Types

This = wxStyledTextCtrl()
SeparatorCharacter = integer()

Change the separator character in the string setting up an auto-completion list.

Default is space but can be changed if items contain space.

####
autoCompGetSeparator(This) -> integer()

### Types

This = wxStyledTextCtrl()

Retrieve the auto-completion list separator character.

####
autoCompSelect(This, Select) -> ok

### Types

This = wxStyledTextCtrl()
Select = unicode:chardata()

Select the item in the auto-completion list that starts with a string.

####
autoCompSetCancelAtStart(This, Cancel) -> ok

### Types

This = wxStyledTextCtrl()
Cancel = boolean()

Should the auto-completion list be cancelled if the user backspaces to a position before where the box was created.

####
autoCompGetCancelAtStart(This) -> boolean()

### Types

This = wxStyledTextCtrl()

Retrieve whether auto-completion cancelled by backspacing before start.

####
autoCompSetFillUps(This, CharacterSet) -> ok

### Types

This = wxStyledTextCtrl()
CharacterSet = unicode:chardata()

Define a set of characters that when typed will cause the autocompletion to choose the selected item.

####
autoCompSetChooseSingle(This, ChooseSingle) -> ok

### Types

This = wxStyledTextCtrl()
ChooseSingle = boolean()

Should a single item auto-completion list automatically choose the item.

####
autoCompGetChooseSingle(This) -> boolean()

### Types

This = wxStyledTextCtrl()

Retrieve whether a single item auto-completion list automatically choose the item.

####
autoCompSetIgnoreCase(This, IgnoreCase) -> ok

### Types

This = wxStyledTextCtrl()
IgnoreCase = boolean()

Set whether case is significant when performing auto-completion searches.

####
autoCompGetIgnoreCase(This) -> boolean()

### Types

This = wxStyledTextCtrl()

Retrieve state of ignore case flag.

####
userListShow(This, ListType, ItemList) -> ok

### Types

This = wxStyledTextCtrl()
ListType = integer()
ItemList = unicode:chardata()

Display a list of strings and send notification when user chooses one.

####
autoCompSetAutoHide(This, AutoHide) -> ok

### Types

This = wxStyledTextCtrl()
AutoHide = boolean()

Set whether or not autocompletion is hidden automatically when nothing matches.

####
autoCompGetAutoHide(This) -> boolean()

### Types

This = wxStyledTextCtrl()

Retrieve whether or not autocompletion is hidden automatically when nothing matches.

####
autoCompSetDropRestOfWord(This, DropRestOfWord) -> ok

### Types

This = wxStyledTextCtrl()
DropRestOfWord = boolean()

Set whether or not autocompletion deletes any word characters after the inserted text upon completion.

####
autoCompGetDropRestOfWord(This) -> boolean()

### Types

This = wxStyledTextCtrl()

Retrieve whether or not autocompletion deletes any word characters after the inserted text upon completion.

####
registerImage(This, Type, Bmp) -> ok

### Types

This = wxStyledTextCtrl()
Type = integer()
Bmp = wxBitmap:wxBitmap()

Register an image for use in autocompletion lists.

####
clearRegisteredImages(This) -> ok

### Types

This = wxStyledTextCtrl()

Clear all the registered images.

####
autoCompGetTypeSeparator(This) -> integer()

### Types

This = wxStyledTextCtrl()

Retrieve the auto-completion list type-separator character.

####
autoCompSetTypeSeparator(This, SeparatorCharacter) -> ok

### Types

This = wxStyledTextCtrl()
SeparatorCharacter = integer()

Change the type-separator character in the string setting up an auto-completion list.

Default is '?' but can be changed if items contain '?'.

####
autoCompSetMaxWidth(This, CharacterCount) -> ok

### Types

This = wxStyledTextCtrl()
CharacterCount = integer()

Set the maximum width, in characters, of auto-completion and user lists.

Set to 0 to autosize to fit longest item, which is the default.

####
autoCompGetMaxWidth(This) -> integer()

### Types

This = wxStyledTextCtrl()

Get the maximum width, in characters, of auto-completion and user lists.

####
autoCompSetMaxHeight(This, RowCount) -> ok

### Types

This = wxStyledTextCtrl()
RowCount = integer()

Set the maximum height, in rows, of auto-completion and user lists.

The default is 5 rows.

####
autoCompGetMaxHeight(This) -> integer()

### Types

This = wxStyledTextCtrl()

Set the maximum height, in rows, of auto-completion and user lists.

####
setIndent(This, IndentSize) -> ok

### Types

This = wxStyledTextCtrl()
IndentSize = integer()

Set the number of spaces used for one level of indentation.

####
getIndent(This) -> integer()

### Types

This = wxStyledTextCtrl()

Retrieve indentation size.

####
setUseTabs(This, UseTabs) -> ok

### Types

This = wxStyledTextCtrl()
UseTabs = boolean()

Indentation will only use space characters if useTabs is false, otherwise it will use a combination of tabs and spaces.

####
getUseTabs(This) -> boolean()

### Types

This = wxStyledTextCtrl()

Retrieve whether tabs will be used in indentation.

####
setLineIndentation(This, Line, Indentation) -> ok

### Types

This = wxStyledTextCtrl()
Line = Indentation = integer()

Change the indentation of a line to a number of columns.

####
getLineIndentation(This, Line) -> integer()

### Types

This = wxStyledTextCtrl()
Line = integer()

Retrieve the number of columns that a line is indented.

####
getLineIndentPosition(This, Line) -> integer()

### Types

This = wxStyledTextCtrl()
Line = integer()

Retrieve the position before the first non indentation character on a line.

####
getColumn(This, Pos) -> integer()

### Types

This = wxStyledTextCtrl()
Pos = integer()

Retrieve the column number of a position, taking tab width into account.

####
setUseHorizontalScrollBar(This, Visible) -> ok

### Types

This = wxStyledTextCtrl()
Visible = boolean()

Show or hide the horizontal scroll bar.

####
getUseHorizontalScrollBar(This) -> boolean()

### Types

This = wxStyledTextCtrl()

Is the horizontal scroll bar visible?

####
setIndentationGuides(This, IndentView) -> ok

### Types

This = wxStyledTextCtrl()
IndentView = integer()

Show or hide indentation guides.

The input should be one of the ?wxSTC_IV_* constants.

####
getIndentationGuides(This) -> integer()

### Types

This = wxStyledTextCtrl()

Are the indentation guides visible?

The return value will be one of the ?wxSTC_IV_* constants.

####
setHighlightGuide(This, Column) -> ok

### Types

This = wxStyledTextCtrl()
Column = integer()

Set the highlighted indentation guide column.

0 = no highlighted guide.

####
getHighlightGuide(This) -> integer()

### Types

This = wxStyledTextCtrl()

Get the highlighted indentation guide column.

####
getLineEndPosition(This, Line) -> integer()

### Types

This = wxStyledTextCtrl()
Line = integer()

Get the position after the last visible characters on a line.

####
getCodePage(This) -> integer()

### Types

This = wxStyledTextCtrl()

Get the code page used to interpret the bytes of the document as characters.

####
getCaretForeground(This) -> wx:wx_colour4()

### Types

This = wxStyledTextCtrl()

Get the foreground colour of the caret.

####
getReadOnly(This) -> boolean()

### Types

This = wxStyledTextCtrl()

In read-only mode?

####
setCurrentPos(This, Caret) -> ok

### Types

This = wxStyledTextCtrl()
Caret = integer()

Sets the position of the caret.

####
setSelectionStart(This, Anchor) -> ok

### Types

This = wxStyledTextCtrl()
Anchor = integer()

Sets the position that starts the selection - this becomes the anchor.

####
getSelectionStart(This) -> integer()

### Types

This = wxStyledTextCtrl()

Returns the position at the start of the selection.

####
setSelectionEnd(This, Caret) -> ok

### Types

This = wxStyledTextCtrl()
Caret = integer()

Sets the position that ends the selection - this becomes the caret.

####
getSelectionEnd(This) -> integer()

### Types

This = wxStyledTextCtrl()

Returns the position at the end of the selection.

####
setPrintMagnification(This, Magnification) -> ok

### Types

This = wxStyledTextCtrl()
Magnification = integer()

Sets the print magnification added to the point size of each style for printing.

####
getPrintMagnification(This) -> integer()

### Types

This = wxStyledTextCtrl()

Returns the print magnification.

####
setPrintColourMode(This, Mode) -> ok

### Types

This = wxStyledTextCtrl()
Mode = integer()

Modify colours when printing for clearer printed text.

The input should be one of the ?wxSTC_PRINT_* constants.

####
getPrintColourMode(This) -> integer()

### Types

This = wxStyledTextCtrl()

Returns the print colour mode.

The return value will be one of the ?wxSTC_PRINT_* constants.

####
findText(This, MinPos, MaxPos, Text) -> integer()

### Types

This = wxStyledTextCtrl()
MinPos = MaxPos = integer()
Text = unicode:chardata()

####
findText(This, MinPos, MaxPos, Text, Options :: [Option]) ->
integer()

### Types

This = wxStyledTextCtrl()
MinPos = MaxPos = integer()
Text = unicode:chardata()
Option = {flags, integer()}

Find some text in the document. @param minPos The position (starting from zero) in the document at which to begin the search @param maxPos The last position (starting from zero) in the document to which the search will be restricted. @param text The text to search for. @param flags (Optional) The search flags. This should be a bit list containing one or more of the @link wxStyledTextCtrl::wxSTC_FIND_WHOLEWORD wxSTC_FIND_* @endlink constants.

Return: The position (starting from zero) in the document at which the text was found or wxSTC_INVALID_POSITION if the search fails.

Remark: A backwards search can be performed by setting minPos to be greater than maxPos.

####
formatRange(This, DoDraw, StartPos, EndPos, Draw, Target,
RenderRect, PageRect) ->
integer()

### Types

This = wxStyledTextCtrl()
DoDraw = boolean()
StartPos = EndPos = integer()
Draw = Target = wxDC:wxDC()
RenderRect = PageRect =
{X :: integer(),
Y :: integer(),
W :: integer(),
H :: integer()}

On Windows, will draw the document into a display context such as a printer.

####
getFirstVisibleLine(This) -> integer()

### Types

This = wxStyledTextCtrl()

Retrieve the display line at the top of the display.

####
getLine(This, Line) -> unicode:charlist()

### Types

This = wxStyledTextCtrl()
Line = integer()

Retrieve the contents of a line.

####
getLineCount(This) -> integer()

### Types

This = wxStyledTextCtrl()

Returns the number of lines in the document.

There is always at least one.

####
setMarginLeft(This, PixelWidth) -> ok

### Types

This = wxStyledTextCtrl()
PixelWidth = integer()

Sets the size in pixels of the left margin.

####
getMarginLeft(This) -> integer()

### Types

This = wxStyledTextCtrl()

Returns the size in pixels of the left margin.

####
setMarginRight(This, PixelWidth) -> ok

### Types

This = wxStyledTextCtrl()
PixelWidth = integer()

Sets the size in pixels of the right margin.

####
getMarginRight(This) -> integer()

### Types

This = wxStyledTextCtrl()

Returns the size in pixels of the right margin.

####
getModify(This) -> boolean()

### Types

This = wxStyledTextCtrl()

Is the document different from when it was last saved?

####
setSelection(This, From, To) -> ok

### Types

This = wxStyledTextCtrl()
From = To = integer()

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 to from by this function.

See: selectAll/1

####
getSelectedText(This) -> unicode:charlist()

### Types

This = wxStyledTextCtrl()

Retrieve the selected text.

####
getTextRange(This, StartPos, EndPos) -> unicode:charlist()

### Types

This = wxStyledTextCtrl()
StartPos = EndPos = integer()

Retrieve a range of text.

####
hideSelection(This, Hide) -> ok

### Types

This = wxStyledTextCtrl()
Hide = boolean()

Draw the selection in normal style or with selection highlighted.

####
lineFromPosition(This, Pos) -> integer()

### Types

This = wxStyledTextCtrl()
Pos = integer()

Retrieve the line containing a position.

####
positionFromLine(This, Line) -> integer()

### Types

This = wxStyledTextCtrl()
Line = integer()

Retrieve the position at the start of a line.

####
lineScroll(This, Columns, Lines) -> ok

### Types

This = wxStyledTextCtrl()
Columns = Lines = integer()

Scroll horizontally and vertically.

####
ensureCaretVisible(This) -> ok

### Types

This = wxStyledTextCtrl()

Ensure the caret is visible.

####
replaceSelection(This, Text) -> ok

### Types

This = wxStyledTextCtrl()
Text = unicode:chardata()

Replace the selected text with the argument text.

####
setReadOnly(This, ReadOnly) -> ok

### Types

This = wxStyledTextCtrl()
ReadOnly = boolean()

Set to read only or read write.

####
canPaste(This) -> boolean()

### Types

This = wxStyledTextCtrl()

Will a paste succeed?

####
canUndo(This) -> boolean()

### Types

This = wxStyledTextCtrl()

Are there any undoable actions in the undo history?

####
emptyUndoBuffer(This) -> ok

### Types

This = wxStyledTextCtrl()

Delete the undo history.

####
undo(This) -> ok

### Types

This = wxStyledTextCtrl()

Undo one action in the undo history.

####
cut(This) -> ok

### Types

This = wxStyledTextCtrl()

Cut the selection to the clipboard.

####
copy(This) -> ok

### Types

This = wxStyledTextCtrl()

Copy the selection to the clipboard.

####
paste(This) -> ok

### Types

This = wxStyledTextCtrl()

Paste the contents of the clipboard into the document replacing the selection.

####
clear(This) -> ok

### Types

This = wxStyledTextCtrl()

Clear the selection.

####
setText(This, Text) -> ok

### Types

This = wxStyledTextCtrl()
Text = unicode:chardata()

Replace the contents of the document with the argument text.

####
getText(This) -> unicode:charlist()

### Types

This = wxStyledTextCtrl()

Retrieve all the text in the document.

####
getTextLength(This) -> integer()

### Types

This = wxStyledTextCtrl()

Retrieve the number of characters in the document.

####
getOvertype(This) -> boolean()

### Types

This = wxStyledTextCtrl()

Returns true if overtype mode is active otherwise false is returned.

####
setCaretWidth(This, PixelWidth) -> ok

### Types

This = wxStyledTextCtrl()
PixelWidth = integer()

Set the width of the insert mode caret.

####
getCaretWidth(This) -> integer()

### Types

This = wxStyledTextCtrl()

Returns the width of the insert mode caret.

####
setTargetStart(This, Start) -> ok

### Types

This = wxStyledTextCtrl()
Start = integer()

Sets the position that starts the target which is used for updating the document without affecting the scroll position.

####
getTargetStart(This) -> integer()

### Types

This = wxStyledTextCtrl()

Get the position that starts the target.

####
setTargetEnd(This, End) -> ok

### Types

This = wxStyledTextCtrl()
End = integer()

Sets the position that ends the target which is used for updating the document without affecting the scroll position.

####
getTargetEnd(This) -> integer()

### Types

This = wxStyledTextCtrl()

Get the position that ends the target.

####
replaceTarget(This, Text) -> integer()

### Types

This = wxStyledTextCtrl()
Text = unicode:chardata()

Replace the target text with the argument text.

Text is counted so it can contain NULs. Returns the length of the replacement text.

####
searchInTarget(This, Text) -> integer()

### Types

This = wxStyledTextCtrl()
Text = unicode:chardata()

Search for a counted string in the target and set the target to the found range.

Text is counted so it can contain NULs. Returns length of range or -1 for failure in which case target is not moved.

####
setSearchFlags(This, SearchFlags) -> ok

### Types

This = wxStyledTextCtrl()
SearchFlags = integer()

Set the search flags used by SearchInTarget.

The input should be a bit list containing one or more of the ?wxSTC_FIND_* constants.

####
getSearchFlags(This) -> integer()

### Types

This = wxStyledTextCtrl()

Get the search flags used by SearchInTarget.

The return value will be a bit list containing one or more of the ?wxSTC_FIND_* constants.

####
callTipShow(This, Pos, Definition) -> ok

### Types

This = wxStyledTextCtrl()
Pos = integer()
Definition = unicode:chardata()

Show a call tip containing a definition near position pos.

####
callTipCancel(This) -> ok

### Types

This = wxStyledTextCtrl()

Remove the call tip from the screen.

####
callTipActive(This) -> boolean()

### Types

This = wxStyledTextCtrl()

Is there an active call tip?

####
callTipPosAtStart(This) -> integer()

### Types

This = wxStyledTextCtrl()

Retrieve the position where the caret was before displaying the call tip.

Since: 3.1.0

####
callTipSetHighlight(This, HighlightStart, HighlightEnd) -> ok

### Types

This = wxStyledTextCtrl()
HighlightStart = HighlightEnd = integer()

Highlight a segment of the definition.

####
callTipSetBackground(This, Back) -> ok

### Types

This = wxStyledTextCtrl()
Back = wx:wx_colour()

Set the background colour for the call tip.

####
callTipSetForeground(This, Fore) -> ok

### Types

This = wxStyledTextCtrl()
Fore = wx:wx_colour()

Set the foreground colour for the call tip.

####
callTipSetForegroundHighlight(This, Fore) -> ok

### Types

This = wxStyledTextCtrl()
Fore = wx:wx_colour()

Set the foreground colour for the highlighted part of the call tip.

####
callTipUseStyle(This, TabSize) -> ok

### Types

This = wxStyledTextCtrl()
TabSize = integer()

Enable use of wxSTC_STYLE_CALLTIP and set call tip tab size in pixels.

####
visibleFromDocLine(This, DocLine) -> integer()

### Types

This = wxStyledTextCtrl()
DocLine = integer()

Find the display line of a document line taking hidden lines into account.

####
docLineFromVisible(This, DisplayLine) -> integer()

### Types

This = wxStyledTextCtrl()
DisplayLine = integer()

Find the document line of a display line taking hidden lines into account.

####
wrapCount(This, DocLine) -> integer()

### Types

This = wxStyledTextCtrl()
DocLine = integer()

The number of display lines needed to wrap a document line.

####
setFoldLevel(This, Line, Level) -> ok

### Types

This = wxStyledTextCtrl()
Line = 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.

####
getFoldLevel(This, Line) -> integer()

### Types

This = wxStyledTextCtrl()
Line = integer()

Retrieve the fold level of a line.

####
getLastChild(This, Line, Level) -> integer()

### Types

This = wxStyledTextCtrl()
Line = Level = integer()

Find the last child line of a header line.

####
getFoldParent(This, Line) -> integer()

### Types

This = wxStyledTextCtrl()
Line = integer()

Find the parent line of a child line.

####
showLines(This, LineStart, LineEnd) -> ok

### Types

This = wxStyledTextCtrl()
LineStart = LineEnd = integer()

Make a range of lines visible.

####
hideLines(This, LineStart, LineEnd) -> ok

### Types

This = wxStyledTextCtrl()
LineStart = LineEnd = integer()

Make a range of lines invisible.

####
getLineVisible(This, Line) -> boolean()

### Types

This = wxStyledTextCtrl()
Line = integer()

Is a line visible?

####
setFoldExpanded(This, Line, Expanded) -> ok

### Types

This = wxStyledTextCtrl()
Line = integer()
Expanded = boolean()

Show the children of a header line.

####
getFoldExpanded(This, Line) -> boolean()

### Types

This = wxStyledTextCtrl()
Line = integer()

Is a header line expanded?

####
toggleFold(This, Line) -> ok

### Types

This = wxStyledTextCtrl()
Line = integer()

Switch a header line between expanded and contracted.

####
ensureVisible(This, Line) -> ok

### Types

This = wxStyledTextCtrl()
Line = integer()

Ensure a particular line is visible by expanding any header line hiding it.

####
setFoldFlags(This, Flags) -> ok

### Types

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.

####
ensureVisibleEnforcePolicy(This, Line) -> ok

### Types

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.

####
setTabIndents(This, TabIndents) -> ok

### Types

This = wxStyledTextCtrl()
TabIndents = boolean()

Sets whether a tab pressed when caret is within indentation indents.

####
getTabIndents(This) -> boolean()

### Types

This = wxStyledTextCtrl()

Does a tab pressed when caret is within indentation indent?

####
setBackSpaceUnIndents(This, BsUnIndents) -> ok

### Types

This = wxStyledTextCtrl()
BsUnIndents = boolean()

Sets whether a backspace pressed when caret is within indentation unindents.

####
getBackSpaceUnIndents(This) -> boolean()

### Types

This = wxStyledTextCtrl()

Does a backspace pressed when caret is within indentation unindent?

####
setMouseDwellTime(This, PeriodMilliseconds) -> ok

### Types

This = wxStyledTextCtrl()
PeriodMilliseconds = integer()

Sets the time the mouse must sit still to generate a mouse dwell event.

The input should be a time in milliseconds or wxSTC_TIME_FOREVER.

####
getMouseDwellTime(This) -> integer()

### Types

This = wxStyledTextCtrl()

Retrieve the time the mouse must sit still to generate a mouse dwell event.

The return value will be a time in milliseconds or wxSTC_TIME_FOREVER.

####
wordStartPosition(This, Pos, OnlyWordCharacters) -> integer()

### Types

This = wxStyledTextCtrl()
Pos = integer()
OnlyWordCharacters = boolean()

Get position of start of word.

####
wordEndPosition(This, Pos, OnlyWordCharacters) -> integer()

### Types

This = wxStyledTextCtrl()
Pos = integer()
OnlyWordCharacters = boolean()

Get position of end of word.

####
setWrapMode(This, WrapMode) -> ok

### Types

This = wxStyledTextCtrl()
WrapMode = integer()

Sets whether text is word wrapped.

The input should be one of the ?wxSTC_WRAP_* constants.

####
getWrapMode(This) -> integer()

### Types

This = wxStyledTextCtrl()

Retrieve whether text is word wrapped.

The return value will be one of the ?wxSTC_WRAP_* constants.

####
setWrapVisualFlags(This, WrapVisualFlags) -> ok

### Types

This = wxStyledTextCtrl()
WrapVisualFlags = integer()

Set the display mode of visual flags for wrapped lines.

The input should be a bit list containing one or more of the ?wxSTC_WRAPVISUALFLAG_* constants.

####
getWrapVisualFlags(This) -> integer()

### Types

This = wxStyledTextCtrl()

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.

####
setWrapVisualFlagsLocation(This, WrapVisualFlagsLocation) -> ok

### Types

This = wxStyledTextCtrl()
WrapVisualFlagsLocation = integer()

Set the location of visual flags for wrapped lines.

The input should be a bit list containing one or more of the ?wxSTC_WRAPVISUALFLAGLOC_* constants.

####
getWrapVisualFlagsLocation(This) -> integer()

### Types

This = wxStyledTextCtrl()

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.

####
setWrapStartIndent(This, Indent) -> ok

### Types

This = wxStyledTextCtrl()
Indent = integer()

Set the start indent for wrapped lines.

####
getWrapStartIndent(This) -> integer()

### Types

This = wxStyledTextCtrl()

Retrieve the start indent for wrapped lines.

####
setLayoutCache(This, CacheMode) -> ok

### Types

This = wxStyledTextCtrl()
CacheMode = integer()

Sets the degree of caching of layout information.

The input should be one of the ?wxSTC_CACHE_* constants.

####
getLayoutCache(This) -> integer()

### Types

This = wxStyledTextCtrl()

Retrieve the degree of caching of layout information.

The return value will be one of the ?wxSTC_CACHE_* constants.

####
setScrollWidth(This, PixelWidth) -> ok

### Types

This = wxStyledTextCtrl()
PixelWidth = integer()

Sets the document width assumed for scrolling.

####
getScrollWidth(This) -> integer()

### Types

This = wxStyledTextCtrl()

Retrieve the document width assumed for scrolling.

####
textWidth(This, Style, Text) -> integer()

### Types

This = wxStyledTextCtrl()
Style = integer()
Text = unicode:chardata()

Measure the pixel width of some text in a particular style.

Does not handle tab or control characters.

####
getEndAtLastLine(This) -> boolean()

### Types

This = wxStyledTextCtrl()

Retrieve whether the maximum scroll position has the last line at the bottom of the view.

####
textHeight(This, Line) -> integer()

### Types

This = wxStyledTextCtrl()
Line = integer()

Retrieve the height of a particular line of text in pixels.

####
setUseVerticalScrollBar(This, Visible) -> ok

### Types

This = wxStyledTextCtrl()
Visible = boolean()

Show or hide the vertical scroll bar.

####
getUseVerticalScrollBar(This) -> boolean()

### Types

This = wxStyledTextCtrl()

Is the vertical scroll bar visible?

####
appendText(This, Text) -> ok

### Types

This = wxStyledTextCtrl()
Text = unicode:chardata()

Append a string to the end of the document without changing the selection.

####
getTwoPhaseDraw(This) -> boolean()

### Types

This = wxStyledTextCtrl()

Is drawing done in two phases with backgrounds drawn before foregrounds?

####
setTwoPhaseDraw(This, TwoPhase) -> ok

### Types

This = wxStyledTextCtrl()
TwoPhase = boolean()

In twoPhaseDraw mode, drawing is performed in two phases, first the background and then the foreground.

This avoids chopping off characters that overlap the next run.

####
targetFromSelection(This) -> ok

### Types

This = wxStyledTextCtrl()

Make the target range start and end be the same as the selection range start and end.

####
linesJoin(This) -> ok

### Types

This = wxStyledTextCtrl()

Join the lines in the target.

####
linesSplit(This, PixelWidth) -> ok

### Types

This = wxStyledTextCtrl()
PixelWidth = integer()

Split the lines in the target into lines that are less wide than pixelWidth where possible.

####
setFoldMarginColour(This, UseSetting, Back) -> ok

### Types

This = wxStyledTextCtrl()
UseSetting = boolean()
Back = wx:wx_colour()

Set one of the colours used as a chequerboard pattern in the fold margin.

####
setFoldMarginHiColour(This, UseSetting, Fore) -> ok

### Types

This = wxStyledTextCtrl()
UseSetting = boolean()
Fore = wx:wx_colour()

Set the other colour used as a chequerboard pattern in the fold margin.

####
lineDown(This) -> ok

### Types

This = wxStyledTextCtrl()

Move caret down one line.

####
lineDownExtend(This) -> ok

### Types

This = wxStyledTextCtrl()

Move caret down one line extending selection to new caret position.

####
lineUp(This) -> ok

### Types

This = wxStyledTextCtrl()

Move caret up one line.

####
lineUpExtend(This) -> ok

### Types

This = wxStyledTextCtrl()

Move caret up one line extending selection to new caret position.

####
charLeft(This) -> ok

### Types

This = wxStyledTextCtrl()

Move caret left one character.

####
charLeftExtend(This) -> ok

### Types

This = wxStyledTextCtrl()

Move caret left one character extending selection to new caret position.

####
charRight(This) -> ok

### Types

This = wxStyledTextCtrl()

Move caret right one character.

####
charRightExtend(This) -> ok

### Types

This = wxStyledTextCtrl()

Move caret right one character extending selection to new caret position.

####
wordLeft(This) -> ok

### Types

This = wxStyledTextCtrl()

Move caret left one word.

####
wordLeftExtend(This) -> ok

### Types

This = wxStyledTextCtrl()

Move caret left one word extending selection to new caret position.

####
wordRight(This) -> ok

### Types

This = wxStyledTextCtrl()

Move caret right one word.

####
wordRightExtend(This) -> ok

### Types

This = wxStyledTextCtrl()

Move caret right one word extending selection to new caret position.

####
home(This) -> ok

### Types

This = wxStyledTextCtrl()

Move caret to first position on line.

####
homeExtend(This) -> ok

### Types

This = wxStyledTextCtrl()

Move caret to first position on line extending selection to new caret position.

####
lineEnd(This) -> ok

### Types

This = wxStyledTextCtrl()

Move caret to last position on line.

####
lineEndExtend(This) -> ok

### Types

This = wxStyledTextCtrl()

Move caret to last position on line extending selection to new caret position.

####
documentStart(This) -> ok

### Types

This = wxStyledTextCtrl()

Move caret to first position in document.

####
documentStartExtend(This) -> ok

### Types

This = wxStyledTextCtrl()

Move caret to first position in document extending selection to new caret position.

####
documentEnd(This) -> ok

### Types

This = wxStyledTextCtrl()

Move caret to last position in document.

####
documentEndExtend(This) -> ok

### Types

This = wxStyledTextCtrl()

Move caret to last position in document extending selection to new caret position.

####
pageUp(This) -> ok

### Types

This = wxStyledTextCtrl()

Move caret one page up.

####
pageUpExtend(This) -> ok

### Types

This = wxStyledTextCtrl()

Move caret one page up extending selection to new caret position.

####
pageDown(This) -> ok

### Types

This = wxStyledTextCtrl()

Move caret one page down.

####
pageDownExtend(This) -> ok

### Types

This = wxStyledTextCtrl()

Move caret one page down extending selection to new caret position.

####
editToggleOvertype(This) -> ok

### Types

This = wxStyledTextCtrl()

Switch from insert to overtype mode or the reverse.

####
cancel(This) -> ok

### Types

This = wxStyledTextCtrl()

Cancel any modes such as call tip or auto-completion list display.

####
deleteBack(This) -> ok

### Types

This = wxStyledTextCtrl()

Delete the selection or if no selection, the character before the caret.

####
tab(This) -> ok

### Types

This = wxStyledTextCtrl()

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.

####
backTab(This) -> ok

### Types

This = wxStyledTextCtrl()

Dedent the selected lines.

####
newLine(This) -> ok

### Types

This = wxStyledTextCtrl()

Insert a new line, may use a CRLF, CR or LF depending on EOL mode.

####
formFeed(This) -> ok

### Types

This = wxStyledTextCtrl()

Insert a Form Feed character.

####
vCHome(This) -> ok

### Types

This = wxStyledTextCtrl()

Move caret to before first visible character on line.

If already there move to first character on line.

####
vCHomeExtend(This) -> ok

### Types

This = wxStyledTextCtrl()

Like VCHome but extending selection to new caret position.

####
zoomIn(This) -> ok

### Types

This = wxStyledTextCtrl()

Magnify the displayed text by increasing the sizes by 1 point.

####
zoomOut(This) -> ok

### Types

This = wxStyledTextCtrl()

Make the displayed text smaller by decreasing the sizes by 1 point.

####
delWordLeft(This) -> ok

### Types

This = wxStyledTextCtrl()

Delete the word to the left of the caret.

####
delWordRight(This) -> ok

### Types

This = wxStyledTextCtrl()

Delete the word to the right of the caret.

####
lineCut(This) -> ok

### Types

This = wxStyledTextCtrl()

Cut the line containing the caret.

####
lineDelete(This) -> ok

### Types

This = wxStyledTextCtrl()

Delete the line containing the caret.

####
lineTranspose(This) -> ok

### Types

This = wxStyledTextCtrl()

Switch the current line with the previous.

####
lineDuplicate(This) -> ok

### Types

This = wxStyledTextCtrl()

Duplicate the current line.

####
lowerCase(This) -> ok

### Types

This = wxStyledTextCtrl()

Transform the selection to lower case.

####
upperCase(This) -> ok

### Types

This = wxStyledTextCtrl()

Transform the selection to upper case.

####
lineScrollDown(This) -> ok

### Types

This = wxStyledTextCtrl()

Scroll the document down, keeping the caret visible.

####
lineScrollUp(This) -> ok

### Types

This = wxStyledTextCtrl()

Scroll the document up, keeping the caret visible.

####
deleteBackNotLine(This) -> ok

### Types

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.

####
homeDisplay(This) -> ok

### Types

This = wxStyledTextCtrl()

Move caret to first position on display line.

####
homeDisplayExtend(This) -> ok

### Types

This = wxStyledTextCtrl()

Move caret to first position on display line extending selection to new caret position.

####
lineEndDisplay(This) -> ok

### Types

This = wxStyledTextCtrl()

Move caret to last position on display line.

####
lineEndDisplayExtend(This) -> ok

### Types

This = wxStyledTextCtrl()

Move caret to last position on display line extending selection to new caret position.

####
homeWrapExtend(This) -> ok

### Types

This = wxStyledTextCtrl()

Like HomeExtend but when word-wrap is enabled extends first to start of display line HomeDisplayExtend, then to start of document line HomeExtend.

####
lineEndWrap(This) -> ok

### Types

This = wxStyledTextCtrl()

Like LineEnd but when word-wrap is enabled goes first to end of display line LineEndDisplay, then to start of document line LineEnd.

####
lineEndWrapExtend(This) -> ok

### Types

This = wxStyledTextCtrl()

Like LineEndExtend but when word-wrap is enabled extends first to end of display line LineEndDisplayExtend, then to start of document line LineEndExtend.

####
vCHomeWrap(This) -> ok

### Types

This = wxStyledTextCtrl()

Like VCHome but when word-wrap is enabled goes first to start of display line VCHomeDisplay, then behaves like VCHome.

####
vCHomeWrapExtend(This) -> ok

### Types

This = wxStyledTextCtrl()

Like VCHomeExtend but when word-wrap is enabled extends first to start of display line VCHomeDisplayExtend, then behaves like VCHomeExtend.

####
lineCopy(This) -> ok

### Types

This = wxStyledTextCtrl()

Copy the line containing the caret.

####
moveCaretInsideView(This) -> ok

### Types

This = wxStyledTextCtrl()

Move the caret inside current view if it's not there already.

####
lineLength(This, Line) -> integer()

### Types

This = wxStyledTextCtrl()
Line = integer()

How many characters are on a line, including end of line characters?

####
braceHighlight(This, PosA, PosB) -> ok

### Types

This = wxStyledTextCtrl()
PosA = PosB = integer()

Highlight the characters at two positions.

####
braceBadLight(This, Pos) -> ok

### Types

This = wxStyledTextCtrl()
Pos = integer()

Highlight the character at a position indicating there is no matching brace.

####
braceMatch(This, Pos) -> integer()

### Types

This = wxStyledTextCtrl()
Pos = integer()

Find the position of a matching brace or wxSTC_INVALID_POSITION if no match.

####
getViewEOL(This) -> boolean()

### Types

This = wxStyledTextCtrl()

Are the end of line characters visible?

####
setViewEOL(This, Visible) -> ok

### Types

This = wxStyledTextCtrl()
Visible = boolean()

Make the end of line characters visible or invisible.

####
setModEventMask(This, EventMask) -> ok

### Types

This = wxStyledTextCtrl()
EventMask = integer()

Set which document modification events are sent to the container.

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.

####
getEdgeColumn(This) -> integer()

### Types

This = wxStyledTextCtrl()

Retrieve the column number which text should be kept within.

####
setEdgeColumn(This, Column) -> ok

### Types

This = wxStyledTextCtrl()
Column = integer()

Set the column number of the edge.

If text goes past the edge then it is highlighted.

####
setEdgeMode(This, EdgeMode) -> ok

### Types

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.

####
getEdgeMode(This) -> integer()

### Types

This = wxStyledTextCtrl()

Retrieve the edge highlight mode.

The return value will be one of the ?wxSTC_EDGE_* constants.

####
getEdgeColour(This) -> wx:wx_colour4()

### Types

This = wxStyledTextCtrl()

Retrieve the colour used in edge indication.

####
setEdgeColour(This, EdgeColour) -> ok

### Types

This = wxStyledTextCtrl()
EdgeColour = wx:wx_colour()

Change the colour used in edge indication.

####
searchAnchor(This) -> ok

### Types

This = wxStyledTextCtrl()

Sets the current caret position to be the search anchor.

####
searchNext(This, SearchFlags, Text) -> integer()

### Types

This = wxStyledTextCtrl()
SearchFlags = integer()
Text = unicode:chardata()

Find some text starting at the search anchor.

Does not ensure the selection is visible.

####
searchPrev(This, SearchFlags, Text) -> integer()

### Types

This = wxStyledTextCtrl()
SearchFlags = integer()
Text = unicode:chardata()

Find some text starting at the search anchor and moving backwards.

Does not ensure the selection is visible.

####
linesOnScreen(This) -> integer()

### Types

This = wxStyledTextCtrl()

Retrieves the number of lines completely visible.

####
usePopUp(This, PopUpMode) -> ok

### Types

This = wxStyledTextCtrl()
PopUpMode = integer()

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.

Remark: When wxContextMenuEvent is used to create a custom popup menu, this function should be called with wxSTC_POPUP_NEVER. Otherwise the default menu will be shown instead of the custom one.

####
selectionIsRectangle(This) -> boolean()

### Types

This = wxStyledTextCtrl()

Is the selection rectangular? The alternative is the more common stream selection.

####
setZoom(This, ZoomInPoints) -> ok

### Types

This = wxStyledTextCtrl()
ZoomInPoints = integer()

Set the zoom level.

This number of points is added to the size of all fonts. It may be positive to magnify or negative to reduce.

####
getZoom(This) -> integer()

### Types

This = wxStyledTextCtrl()

Retrieve the zoom level.

####
getModEventMask(This) -> integer()

### Types

This = wxStyledTextCtrl()

Get which document modification events are sent to the container.

The return value will wxSTC_MODEVENTMASKALL if all changes generate events. Otherwise it will 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.

####
setSTCFocus(This, Focus) -> ok

### Types

This = wxStyledTextCtrl()
Focus = boolean()

Change internal focus flag.

####
getSTCFocus(This) -> boolean()

### Types

This = wxStyledTextCtrl()

Get internal focus flag.

####
setStatus(This, Status) -> ok

### Types

This = wxStyledTextCtrl()
Status = integer()

Change error status - 0 = OK.

The input should be one of the ?wxSTC_STATUS_* constants.

####
getStatus(This) -> integer()

### Types

This = wxStyledTextCtrl()

Get error status.

The return value will be one of the ?wxSTC_STATUS_* constants.

####
setMouseDownCaptures(This, Captures) -> ok

### Types

This = wxStyledTextCtrl()
Captures = boolean()

Set whether the mouse is captured when its button is pressed.

####
getMouseDownCaptures(This) -> boolean()

### Types

This = wxStyledTextCtrl()

Get whether mouse gets captured.

####
setSTCCursor(This, CursorType) -> ok

### Types

This = wxStyledTextCtrl()
CursorType = integer()

Sets the cursor to one of the wxSTC_CURSOR* values.

####
getSTCCursor(This) -> integer()

### Types

This = wxStyledTextCtrl()

Get cursor type.

The return value will be one of the ?wxSTC_CURSOR* constants.

####
setControlCharSymbol(This, Symbol) -> ok

### Types

This = wxStyledTextCtrl()
Symbol = integer()

Change the way control characters are displayed: If symbol is < 32, keep the drawn way, else, use the given character.

####
getControlCharSymbol(This) -> integer()

### Types

This = wxStyledTextCtrl()

Get the way control characters are displayed.

####
wordPartLeft(This) -> ok

### Types

This = wxStyledTextCtrl()

Move to the previous change in capitalisation.

####
wordPartLeftExtend(This) -> ok

### Types

This = wxStyledTextCtrl()

Move to the previous change in capitalisation extending selection to new caret position.

####
wordPartRight(This) -> ok

### Types

This = wxStyledTextCtrl()

Move to the change next in capitalisation.

####
wordPartRightExtend(This) -> ok

### Types

This = wxStyledTextCtrl()

Move to the next change in capitalisation extending selection to new caret position.

####
setVisiblePolicy(This, VisiblePolicy, VisibleSlop) -> ok

### Types

This = wxStyledTextCtrl()
VisiblePolicy = VisibleSlop = integer()

Set the way the display area is determined when a particular line is to be moved to by Find, FindNext, GotoLine, etc.

The first argument should be a bit list containing one or more of the ?wxSTC_VISIBLE_* constants.

####
delLineLeft(This) -> ok

### Types

This = wxStyledTextCtrl()

Delete back from the current position to the start of the line.

####
delLineRight(This) -> ok

### Types

This = wxStyledTextCtrl()

Delete forwards from the current position to the end of the line.

####
getXOffset(This) -> integer()

### Types

This = wxStyledTextCtrl()

Get the xOffset (ie, horizontal scroll position).

####
chooseCaretX(This) -> ok

### Types

This = wxStyledTextCtrl()

Set the last x chosen value to be the caret x position.

####
setXCaretPolicy(This, CaretPolicy, CaretSlop) -> ok

### Types

This = wxStyledTextCtrl()
CaretPolicy = CaretSlop = integer()

Set the way the caret is kept visible when 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(This, CaretPolicy, CaretSlop) -> ok

### Types

This = wxStyledTextCtrl()
CaretPolicy = CaretSlop = integer()

Set the way the line the caret is on is kept visible.

The exclusion zone is given in lines.

The first argument should be a bit list containing one or more of the ?wxSTC_CARET_* constants.

####
getPrintWrapMode(This) -> integer()

### Types

This = wxStyledTextCtrl()

Is printing line wrapped?

The return value will be one of the ?wxSTC_WRAP_* constants.

####
setHotspotActiveForeground(This, UseSetting, Fore) -> ok

### Types

This = wxStyledTextCtrl()
UseSetting = boolean()
Fore = wx:wx_colour()

Set a fore colour for active hotspots.

####
setHotspotActiveBackground(This, UseSetting, Back) -> ok

### Types

This = wxStyledTextCtrl()
UseSetting = boolean()
Back = wx:wx_colour()

Set a back colour for active hotspots.

####
setHotspotActiveUnderline(This, Underline) -> ok

### Types

This = wxStyledTextCtrl()
Underline = boolean()

Enable / Disable underlining active hotspots.

####
setHotspotSingleLine(This, SingleLine) -> ok

### Types

This = wxStyledTextCtrl()
SingleLine = boolean()

Limit hotspots to single line so hotspots on two lines don't merge.

####
paraDownExtend(This) -> ok

### Types

This = wxStyledTextCtrl()

Extend selection down one paragraph (delimited by empty lines).

####
paraUp(This) -> ok

### Types

This = wxStyledTextCtrl()

Move caret up one paragraph (delimited by empty lines).

####
paraUpExtend(This) -> ok

### Types

This = wxStyledTextCtrl()

Extend selection up one paragraph (delimited by empty lines).

####
positionBefore(This, Pos) -> integer()

### Types

This = wxStyledTextCtrl()
Pos = integer()

Given a valid document position, return the previous position taking code page into account.

Returns 0 if passed 0.

####
positionAfter(This, Pos) -> integer()

### Types

This = wxStyledTextCtrl()
Pos = integer()

Given a valid document position, return the next position taking code page into account.

Maximum value returned is the last position in the document.

####
copyRange(This, Start, End) -> ok

### Types

This = wxStyledTextCtrl()
Start = End = integer()

Copy a range of text to the clipboard.

Positions are clipped into the document.

####
copyText(This, Length, Text) -> ok

### Types

This = wxStyledTextCtrl()
Length = integer()
Text = unicode:chardata()

Copy argument text to the clipboard.

####
setSelectionMode(This, SelectionMode) -> ok

### Types

This = wxStyledTextCtrl()
SelectionMode = integer()

Set the selection mode to stream (wxSTC_SEL_STREAM) or rectangular (wxSTC_SEL_RECTANGLE/wxSTC_SEL_THIN) or by lines (wxSTC_SEL_LINES).

####
getSelectionMode(This) -> integer()

### Types

This = wxStyledTextCtrl()

Get the mode of the current selection.

The return value will be one of the ?wxSTC_SEL_* constants.

####
lineDownRectExtend(This) -> ok

### Types

This = wxStyledTextCtrl()

Move caret down one line, extending rectangular selection to new caret position.

####
lineUpRectExtend(This) -> ok

### Types

This = wxStyledTextCtrl()

Move caret up one line, extending rectangular selection to new caret position.

####
charLeftRectExtend(This) -> ok

### Types

This = wxStyledTextCtrl()

Move caret left one character, extending rectangular selection to new caret position.

####
charRightRectExtend(This) -> ok

### Types

This = wxStyledTextCtrl()

Move caret right one character, extending rectangular selection to new caret position.

####
homeRectExtend(This) -> ok

### Types

This = wxStyledTextCtrl()

Move caret to first position on line, extending rectangular selection to new caret position.

####
vCHomeRectExtend(This) -> ok

### Types

This = wxStyledTextCtrl()

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.

####
lineEndRectExtend(This) -> ok

### Types

This = wxStyledTextCtrl()

Move caret to last position on line, extending rectangular selection to new caret position.

####
pageUpRectExtend(This) -> ok

### Types

This = wxStyledTextCtrl()

Move caret one page up, extending rectangular selection to new caret position.

####
pageDownRectExtend(This) -> ok

### Types

This = wxStyledTextCtrl()

Move caret one page down, extending rectangular selection to new caret position.

####
stutteredPageUp(This) -> ok

### Types

This = wxStyledTextCtrl()

Move caret to top of page, or one page up if already at top of page.

####
stutteredPageUpExtend(This) -> ok

### Types

This = wxStyledTextCtrl()

Move caret to top of page, or one page up if already at top of page, extending selection to new caret position.

####
stutteredPageDown(This) -> ok

### Types

This = wxStyledTextCtrl()

Move caret to bottom of page, or one page down if already at bottom of page.

####
stutteredPageDownExtend(This) -> ok

### Types

This = wxStyledTextCtrl()

Move caret to bottom of page, or one page down if already at bottom of page, extending selection to new caret position.

####
wordLeftEnd(This) -> ok

### Types

This = wxStyledTextCtrl()

Move caret left one word, position cursor at end of word.

####
wordLeftEndExtend(This) -> ok

### Types

This = wxStyledTextCtrl()

Move caret left one word, position cursor at end of word, extending selection to new caret position.

####
wordRightEnd(This) -> ok

### Types

This = wxStyledTextCtrl()

Move caret right one word, position cursor at end of word.

####
wordRightEndExtend(This) -> ok

### Types

This = wxStyledTextCtrl()

Move caret right one word, position cursor at end of word, extending selection to new caret position.

####
setWhitespaceChars(This, Characters) -> ok

### Types

This = wxStyledTextCtrl()
Characters = unicode:chardata()

Set the set of characters making up whitespace for when moving or selecting by word.

Should be called after SetWordChars.

####
setCharsDefault(This) -> ok

### Types

This = wxStyledTextCtrl()

Reset the set of characters for whitespace and word characters to the defaults.

####
autoCompGetCurrent(This) -> integer()

### Types

This = wxStyledTextCtrl()

Get currently selected item position in the auto-completion list.

####
allocate(This, Bytes) -> ok

### Types

This = wxStyledTextCtrl()
Bytes = integer()

Enlarge the document to a particular size of text bytes.

####
findColumn(This, Line, Column) -> integer()

### Types

This = wxStyledTextCtrl()
Line = 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.

####
getCaretSticky(This) -> integer()

### Types

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.

####
setCaretSticky(This, UseCaretStickyBehaviour) -> ok

### Types

This = wxStyledTextCtrl()
UseCaretStickyBehaviour = integer()

Stop the caret preferred x position changing when the user types.

The input should be one of the ?wxSTC_CARETSTICKY_* constants.

####
toggleCaretSticky(This) -> ok

### Types

This = wxStyledTextCtrl()

Switch between sticky and non-sticky: meant to be bound to a key.

####
setPasteConvertEndings(This, Convert) -> ok

### Types

This = wxStyledTextCtrl()
Convert = boolean()

Enable/Disable convert-on-paste for line endings.

####
getPasteConvertEndings(This) -> boolean()

### Types

This = wxStyledTextCtrl()

Get convert-on-paste setting.

####
selectionDuplicate(This) -> ok

### Types

This = wxStyledTextCtrl()

Duplicate the selection.

If selection empty duplicate the line containing the caret.

####
setCaretLineBackAlpha(This, Alpha) -> ok

### Types

This = wxStyledTextCtrl()
Alpha = integer()

Set background alpha of the caret line.

####
getCaretLineBackAlpha(This) -> integer()

### Types

This = wxStyledTextCtrl()

Get the background alpha of the caret line.

####
startRecord(This) -> ok

### Types

This = wxStyledTextCtrl()

Start notifying the container of all key presses and commands.

####
stopRecord(This) -> ok

### Types

This = wxStyledTextCtrl()

Stop notifying the container of all key presses and commands.

####
setLexer(This, Lexer) -> ok

### Types

This = wxStyledTextCtrl()
Lexer = integer()

Set the lexing language of the document.

The input should be one of the ?wxSTC_LEX_* constants.

####
getLexer(This) -> integer()

### Types

This = wxStyledTextCtrl()

Retrieve the lexing language of the document.

The return value will be one of the ?wxSTC_LEX_* constants.

####
colourise(This, Start, End) -> ok

### Types

This = wxStyledTextCtrl()
Start = End = integer()

Colourise a segment of the document using the current lexing language.

####
setProperty(This, Key, Value) -> ok

### Types

This = wxStyledTextCtrl()
Key = Value = unicode:chardata()

Set up a value that may be used by a lexer for some optional feature.

####
setKeyWords(This, KeyWordSet, KeyWords) -> ok

### Types

This = wxStyledTextCtrl()
KeyWordSet = integer()
KeyWords = unicode:chardata()

Set up the key words used by the lexer.

####
setLexerLanguage(This, Language) -> ok

### Types

This = wxStyledTextCtrl()
Language = unicode:chardata()

Set the lexing language of the document based on string name.

####
getProperty(This, Key) -> unicode:charlist()

### Types

This = wxStyledTextCtrl()
Key = unicode:chardata()

Retrieve a "property" value previously set with SetProperty.

####
getStyleBitsNeeded(This) -> integer()

### Types

This = wxStyledTextCtrl()

Retrieve the number of bits the current lexer needs for styling.

Deprecated:

####
getCurrentLine(This) -> integer()

### Types

This = wxStyledTextCtrl()

Returns the line number of the line with the caret.

####
styleSetSpec(This, StyleNum, Spec) -> ok

### Types

This = wxStyledTextCtrl()
StyleNum = integer()
Spec = unicode:chardata()

Extract style settings from a spec-string which is composed of one or more of the following comma separated elements:

bold turns on bold italic turns on italics fore:[name or #RRGGBB] sets the foreground colour back:[name or #RRGGBB] sets the background colour face:[facename] sets the font face name to use size:[num] sets the font size in points eol turns on eol filling underline turns on underlining

####
styleSetFont(This, StyleNum, Font) -> ok

### Types

This = wxStyledTextCtrl()
StyleNum = integer()
Font = wxFont:wxFont()

Set style size, face, bold, italic, and underline attributes from a wxFont's attributes.

####
styleSetFontAttr(This, StyleNum, Size, FaceName, Bold, Italic,
Underline) ->
ok

### Types

This = wxStyledTextCtrl()
StyleNum = Size = integer()
FaceName = unicode:chardata()
Bold = Italic = Underline = boolean()

####
styleSetFontAttr(This, StyleNum, Size, FaceName, Bold, Italic,
Underline,
Options :: [Option]) ->
ok

### Types

This = wxStyledTextCtrl()
StyleNum = Size = integer()
FaceName = unicode:chardata()
Bold = Italic = Underline = boolean()
Option = {encoding, wx:wx_enum()}

Set all font style attributes at once.

####
styleSetCharacterSet(This, Style, CharacterSet) -> ok

### Types

This = wxStyledTextCtrl()
Style = CharacterSet = integer()

Set the character set of the font in a style.

Converts the Scintilla character set values to a wxFontEncoding.

####
styleSetFontEncoding(This, Style, Encoding) -> ok

### Types

This = wxStyledTextCtrl()
Style = integer()
Encoding = wx:wx_enum()

Set the font encoding to be used by a style.

####
cmdKeyExecute(This, Cmd) -> ok

### Types

This = wxStyledTextCtrl()
Cmd = integer()

Perform one of the operations defined by the wxSTC_CMD_* constants.

####
setMargins(This, Left, Right) -> ok

### Types

This = wxStyledTextCtrl()
Left = Right = integer()

Set the left and right margin in the edit area, measured in pixels.

####
getSelection(This) -> {From :: integer(), To :: integer()}

### Types

This = wxStyledTextCtrl()

Gets the current selection span.

If the returned values are equal, there was no selection. Please note that the indices returned may be used with the other wxTextCtrl methods but don't necessarily represent the correct indices into the string returned by wxComboBox:getValue/1 for multiline controls under Windows (at least,) you should use wxTextCtrl:getStringSelection/1 to get the selected text.

####
pointFromPosition(This, Pos) -> {X :: integer(), Y :: integer()}

### Types

This = wxStyledTextCtrl()
Pos = integer()

Retrieve the point in the window where a position is displayed.

####
scrollToLine(This, Line) -> ok

### Types

This = wxStyledTextCtrl()
Line = integer()

Scroll enough to make the given line visible.

####
scrollToColumn(This, Column) -> ok

### Types

This = wxStyledTextCtrl()
Column = integer()

Scroll enough to make the given column visible.

####
setVScrollBar(This, Bar) -> ok

### Types

This = wxStyledTextCtrl()
Bar = wxScrollBar:wxScrollBar()

Set the vertical scrollbar to use instead of the one that's built-in.

####
setHScrollBar(This, Bar) -> ok

### Types

This = wxStyledTextCtrl()
Bar = wxScrollBar:wxScrollBar()

Set the horizontal scrollbar to use instead of the one that's built-in.

####
getLastKeydownProcessed(This) -> boolean()

### Types

This = wxStyledTextCtrl()

Can be used to prevent the EVT_CHAR handler from adding the char.

####
setLastKeydownProcessed(This, Val) -> ok

### Types

This = wxStyledTextCtrl()
Val = boolean()

Returns the line number of the line with the caret.

####
saveFile(This, Filename) -> boolean()

### Types

This = wxStyledTextCtrl()
Filename = unicode:chardata()

Write the contents of the editor to filename.

####
loadFile(This, Filename) -> boolean()

### Types

This = wxStyledTextCtrl()
Filename = unicode:chardata()

Load the contents of filename into the editor.

####
doDragOver(This, X, Y, DefaultRes) -> wx:wx_enum()

### Types

This = wxStyledTextCtrl()
X = Y = integer()
DefaultRes = wx:wx_enum()

Allow for simulating a DnD DragOver.

####
doDropText(This, X, Y, Data) -> boolean()

### Types

This = wxStyledTextCtrl()
X = Y = integer()
Data = unicode:chardata()

Allow for simulating a DnD DropText.

####
getUseAntiAliasing(This) -> boolean()

### Types

This = wxStyledTextCtrl()

Returns the current UseAntiAliasing setting.

####
addTextRaw(This, Text) -> ok

### Types

This = wxStyledTextCtrl()
Text = binary()

####
addTextRaw(This, Text, Options :: [Option]) -> ok

### Types

This = wxStyledTextCtrl()
Text = binary()
Option = {length, integer()}

Add text to the document at current position.

####
insertTextRaw(This, Pos, Text) -> ok

### Types

This = wxStyledTextCtrl()
Pos = integer()
Text = binary()

Insert string at a position.

####
getCurLineRaw(This) -> Result

### Types

Result = {Res :: binary(), LinePos :: integer()}
This = wxStyledTextCtrl()

Retrieve the text of the line containing the caret.

Returns the index of the caret on the line.

####
getLineRaw(This, Line) -> binary()

### Types

This = wxStyledTextCtrl()
Line = integer()

Retrieve the contents of a line.

####
getSelectedTextRaw(This) -> binary()

### Types

This = wxStyledTextCtrl()

Retrieve the selected text.

####
getTextRangeRaw(This, StartPos, EndPos) -> binary()

### Types

This = wxStyledTextCtrl()
StartPos = EndPos = integer()

Retrieve a range of text.

####
setTextRaw(This, Text) -> ok

### Types

This = wxStyledTextCtrl()
Text = binary()

Replace the contents of the document with the argument text.

####
getTextRaw(This) -> binary()

### Types

This = wxStyledTextCtrl()

Retrieve all the text in the document.

####
appendTextRaw(This, Text) -> ok

### Types

This = wxStyledTextCtrl()
Text = binary()

####
appendTextRaw(This, Text, Options :: [Option]) -> ok

### Types

This = wxStyledTextCtrl()
Text = binary()
Option = {length, integer()}

Append a string to the end of the document without changing the selection.