wx.stc.StyledTextCtrl¶

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.

wx.stc.StyledTextCtrl 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 wx.stc.StyledTextEvent for the documentation of all event types you can use with wx.stc.StyledTextCtrl.

Index of the member groups¶

Links for quick access to the various categories of wx.stc.StyledTextCtrl functions:

Constructors and Related Methods
Additional wxPython Methods
Text Retrieval and Modification
Searching and Replacing
Overtype
Cut Copy and Paste
Error Handling
Undo and Redo
Selection and Information
Multiple Selection and Virtual Space
Scrolling and Automatic Scrolling
White Space
Cursor
Mouse Capture
Line Endings
Words
Styling
Style Definition
Caret Selection and Hotspot Styles
Character Representations
Margins
Annotations
Other Settings
Brace Highlighting
Tabs and Indentation Guides
Markers
Indicators
Autocompletion
User Lists
Call Tips
Keyboard Commands
Key Bindings
Popup Edit Menu
Macro Recording
Printing
Direct Access
Multiple Views
Background Loading and Saving
Folding
Line Wrapping
Zooming
Long Lines
Lexer
Event Related Items
Deprecated Items
Additional wxStyledTextCtrl Methods
Raw Variants
Text Entry Methods
Text Area Methods

See also

wx.stc.StyledTextEvent

Class Hierarchy¶

Inheritance diagram for class StyledTextCtrl:

Methods Summary¶

Additional wxPython Methods¶

In addition to the standard Scintilla functions, wxPython includes the following methods to better integrate better with other features.

`AutoComplete`	Call this function to enable auto-completion of the text typed in a single-line text control using the given choices.
`AutoCompleteDirectories`	Call this function to enable auto-completion of the text using the file system directories.
`AutoCompleteFileNames`	Call this function to enable auto-completion of the text typed in a single-line text control using all valid file system paths.
`CanCopy`	Returns `True` if the selection can be copied to the clipboard.
`CanCut`	Returns `True` if the selection can be cut to the clipboard.
`ChangeValue`	Sets the new text control value.
`ForceUpper`	Convert all text entered into the control to upper case.
`GetClassDefaultAttributes`
`GetDefaultStyle`	Returns the style currently used for the new text.
`GetHint`	Returns the current hint string.
`GetMargins`	Returns the margins used by the control.
`GetRange`	Returns the string containing the text starting in the positions from and up to to in the control.
`GetStringSelection`	Gets the text currently selected in the control.
`GetValue`	Gets the contents of the control.
`HitTestPos`	Finds the position of the character at the specified point.
`IsEmpty`	Returns `True` if the control is currently empty.
`PositionToCoords`	Converts given text position to client coordinates in pixels.
`SetHint`	Sets a hint shown in an empty unfocused text control.
`SetInsertionPointEnd`	Sets the insertion point at the end of the text control.
`SetMaxLength`	This function sets the maximum number of characters the user can enter into the control.
`SetModified`	Marks the control as being modified by the user or not.
`SetValue`	Sets the new text control value.
`flush`	`NOP`, for file-like compatibility.
`write`	Append text to the textctrl, for file-like compatibility.

Text Retrieval and Modification¶

`AddStyledText`	Add array of cells to document.
`AddText`	Add text to the document at current position.
`Allocate`	Enlarge the document to a particular size of text bytes.
`AllocateExtendedStyles`	Allocate some extended (>255) style numbers and return the start of the range.
`AppendText`	Append a string to the end of the document without changing the selection.
`ChangeInsertion`	Change the text that is being inserted in response to `wx.stc.STC_MOD_INSERTCHECK`.
`ClearAll`	Delete all text in the document.
`ClearDocumentStyle`	Set all style bytes to 0, remove all folding information.
`DeleteRange`	Delete a range of text in the document.
`GetCharAt`	Returns the character byte at the position.
`GetLine`	Retrieve the contents of a line.
`GetReadOnly`	In read-only mode?
`GetStyleAt`	Returns the style byte at the position.
`GetStyledText`	Retrieve a buffer of cells.
`GetText`	Retrieve all the text in the document.
`GetTextRange`	Retrieve a range of text.
`InsertText`	Insert string at a position.
`ReleaseAllExtendedStyles`	Release all extended (>255) style numbers.
`ReplaceSelection`	Replace the selected text with the argument text.
`SetReadOnly`	Set to read only or read write.
`SetSavePoint`	Remember the current position in the undo history as the position at which the document was saved.
`SetText`	Replace the contents of the document with the argument text.

Searching and Replacing¶

`FindText`	Find some text in the document.
`GetSearchFlags`	Get the search flags used by SearchInTarget.
`GetTag`	Retrieve the value of a tag from a regular expression search.
`GetTargetEnd`	Get the position that ends the target.
`GetTargetStart`	Get the position that starts the target.
`GetTargetText`	Retrieve the text in the target.
`ReplaceTarget`	Replace the target text with the argument text.
`ReplaceTargetRE`	Replace the target text with the argument text after \d processing.
`SearchAnchor`	Sets the current caret position to be the search anchor.
`SearchInTarget`	Search for a counted string in the target and set the target to the found range.
`SearchNext`	Find some text starting at the search anchor.
`SearchPrev`	Find some text starting at the search anchor and moving backwards.
`SetSearchFlags`	Set the search flags used by SearchInTarget.
`SetTargetEnd`	Sets the position that ends the target which is used for updating the document without affecting the scroll position.
`SetTargetRange`	Sets both the start and end of the target in one call.
`SetTargetStart`	Sets the position that starts the target which is used for updating the document without affecting the scroll position.
`TargetFromSelection`	Make the target range start and end be the same as the selection range start and end.
`TargetWholeDocument`	Sets the target to the whole document.

Overtype¶

`GetOvertype`	Returns `True` if overtype mode is active otherwise `False` is returned.
`SetOvertype`	Set to overtype (`True`) or insert mode.

Cut Copy and Paste¶

`CanPaste`	Will a paste succeed?
`Clear`	Clear the selection.
`Copy`	Copy the selection to the clipboard.
`CopyAllowLine`	Copy the selection, if selection empty copy the line with the caret.
`CopyRange`	Copy a range of text to the clipboard.
`CopyText`	Copy argument text to the clipboard.
`Cut`	Cut the selection to the clipboard.
`GetPasteConvertEndings`	Get convert-on-paste setting.
`Paste`	Paste the contents of the clipboard into the document replacing the selection.
`SetPasteConvertEndings`	Enable/Disable convert-on-paste for line endings.

Error Handling¶

`GetStatus`	Get error status.
`SetStatus`	Change error status - 0 = `wx.OK`.

Undo and Redo¶

`AddUndoAction`	Add a container action to the undo stack.
`BeginUndoAction`	Start a sequence of actions that is undone and redone as a unit.
`CanRedo`	Are there any redoable actions in the undo history?
`CanUndo`	Are there any undoable actions in the undo history?
`EmptyUndoBuffer`	Delete the undo history.
`EndUndoAction`	End a sequence of actions that is undone and redone as a unit.
`GetUndoCollection`	Is undo history being collected?
`Redo`	Redoes the next action on the undo history.
`SetUndoCollection`	Choose between collecting actions into the undo history and discarding them.
`Undo`	Undo one action in the undo history.

Selection and Information¶

`CharPositionFromPoint`	Find the position of a character from a point within the window.
`CharPositionFromPointClose`	Find the position of a character from a point within the window.
`ChooseCaretX`	Set the last x chosen value to be the caret x position.
`CountCharacters`	Count characters between two positions.
`FindColumn`	Find the position of a column on a line taking into account tabs and multi-byte characters.
`GetAnchor`	Returns the position of the opposite end of the selection to the caret.
`GetColumn`	Retrieve the column number of a position, taking tab width into account.
`GetCurLine`	Retrieve the text of the line containing the caret.
`GetCurrentPos`	Returns the position of the caret.
`GetLength`	Returns the number of bytes in the document.
`GetLineCount`	Returns the number of lines in the document.
`GetLineEndPosition`	Get the position after the last visible characters on a line.
`GetLineSelEndPosition`	Retrieve the position of the end of the selection at the given line (wx``wx.stc.STC_INVALID_POSITION`` if no selection on this line).
`GetLineSelStartPosition`	Retrieve the position of the start of the selection at the given line (wx``wx.stc.STC_INVALID_POSITION`` if no selection on this line).
`GetModify`	Is the document different from when it was last saved?
`GetMouseSelectionRectangularSwitch`	Whether switching to rectangular mode while selecting with the mouse is allowed.
`GetSelectedText`	Retrieve the selected text.
`GetSelectionEnd`	Returns the position at the end of the selection.
`GetSelectionMode`	Get the mode of the current selection.
`GetSelectionStart`	Returns the position at the start of the selection.
`GetTextLength`	Retrieve the number of characters in the document.
`GotoLine`	Set caret to start of a line and ensure it is visible.
`GotoPos`	Set caret to a position and ensure it is visible.
`HideSelection`	Draw the selection in normal style or with selection highlighted.
`LineFromPosition`	Retrieve the line containing a position.
`LineLength`	How many characters are on a line, including end of line characters?
`LinesOnScreen`	Retrieves the number of lines completely visible.
`MoveCaretInsideView`	Move the caret inside current view if it’s not there already.
`MoveSelectedLinesDown`	Move the selected lines down one line, shifting the line below before the selection.
`MoveSelectedLinesUp`	Move the selected lines up one line, shifting the line above after the selection.
`PointFromPosition`	Retrieve the point in the window where a position is displayed.
`PositionAfter`	Given a valid document position, return the next position taking code page into account.
`PositionBefore`	Given a valid document position, return the previous position taking code page into account.
`PositionFromLine`	Retrieve the position at the start of a line.
`PositionFromPoint`	Find the position from a point within the window.
`PositionFromPointClose`	Find the position from a point within the window but return `wx.stc.STC_INVALID_POSITION` if not close to text.
`PositionRelative`	Given a valid document position, return a position that differs in a number of characters.
`SelectAll`	Select all the text in the document.
`SelectionIsRectangle`	Is the selection rectangular? The alternative is the more common stream selection.
`SetAnchor`	Set the selection anchor to a position.
`SetCurrentPos`	Sets the position of the caret.
`SetEmptySelection`	Set caret to a position, while removing any existing selection.
`SetMouseSelectionRectangularSwitch`	Set whether switching to rectangular mode while selecting with the mouse is allowed.
`SetSelectionEnd`	Sets the position that ends the selection - this becomes the caret.
`SetSelectionMode`	Set the selection mode to stream (wx``wx.stc.STC_SEL_STREAM``) or rectangular (wxSTC_SEL_RECTANGLE/wxSTC_SEL_THIN) or by lines (wx``wx.stc.STC_SEL_LINES``).
`SetSelectionStart`	Sets the position that starts the selection - this becomes the anchor.
`TextHeight`	Retrieve the height of a particular line of text in pixels.
`TextWidth`	Measure the pixel width of some text in a particular style.

Multiple Selection and Virtual Space¶

`AddSelection`	Add a selection.
`ClearSelections`	Clear selections to a single empty stream selection.
`DropSelectionN`	Drop one selection.
`GetAdditionalCaretForeground`	Get the foreground colour of additional carets.
`GetAdditionalCaretsBlink`	Whether additional carets will blink.
`GetAdditionalCaretsVisible`	Whether additional carets are visible.
`GetAdditionalSelAlpha`	Get the alpha of the selection.
`GetAdditionalSelectionTyping`	Whether typing can be performed into multiple selections.
`GetMainSelection`	Which selection is the main selection.
`GetMultiPaste`	Retrieve the effect of pasting when there are multiple selections.
`GetMultipleSelection`	Whether multiple selections can be made.
`GetRectangularSelectionAnchor`	Return the anchor position of the rectangular selection.
`GetRectangularSelectionAnchorVirtualSpace`	Return the virtual space of the anchor of the rectangular selection.
`GetRectangularSelectionCaret`	Return the caret position of the rectangular selection.
`GetRectangularSelectionCaretVirtualSpace`	Return the virtual space of the caret of the rectangular selection.
`GetRectangularSelectionModifier`	Get the modifier key used for rectangular selection.
`GetSelectionEmpty`	Is every selected range empty?
`GetSelectionNAnchor`	Return the anchor position of the nth selection.
`GetSelectionNAnchorVirtualSpace`	Return the virtual space of the anchor of the nth selection.
`GetSelectionNCaret`	Return the caret position of the nth selection.
`GetSelectionNCaretVirtualSpace`	Return the virtual space of the caret of the nth selection.
`GetSelectionNEnd`	Returns the position at the end of the selection.
`GetSelectionNStart`	Returns the position at the start of the selection.
`GetSelections`	How many selections are there?
`GetVirtualSpaceOptions`	Return options for virtual space behaviour.
`MultipleSelectAddEach`	Add each occurrence of the main selection in the target to the set of selections.
`MultipleSelectAddNext`	Add the next occurrence of the main selection to the set of selections as main.
`RotateSelection`	Set the main selection to the next selection.
`SetAdditionalCaretForeground`	Set the foreground colour of additional carets.
`SetAdditionalCaretsBlink`	Set whether additional carets will blink.
`SetAdditionalCaretsVisible`	Set whether additional carets are visible.
`SetAdditionalSelAlpha`	Set the alpha of the selection.
`SetAdditionalSelBackground`	Set the background colour of additional selections.
`SetAdditionalSelForeground`	Set the foreground colour of additional selections.
`SetAdditionalSelectionTyping`	Set whether typing can be performed into multiple selections.
`SetMainSelection`	Set the main selection.
`SetMultiPaste`	Change the effect of pasting when there are multiple selections.
`SetMultipleSelection`	Set whether multiple selections can be made.
`SetRectangularSelectionAnchor`	Set the anchor position of the rectangular selection.
`SetRectangularSelectionAnchorVirtualSpace`	Set the virtual space of the anchor of the rectangular selection.
`SetRectangularSelectionCaret`	Set the caret position of the rectangular selection.
`SetRectangularSelectionCaretVirtualSpace`	Set the virtual space of the caret of the rectangular selection.
`SetRectangularSelectionModifier`	On GTK+, allow selecting the modifier key to use for mouse-based rectangular selection.
`SetSelectionNAnchor`	Set the anchor position of the nth selection.
`SetSelectionNAnchorVirtualSpace`	Set the virtual space of the anchor of the nth selection.
`SetSelectionNCaret`	Set the caret position of the nth selection.
`SetSelectionNCaretVirtualSpace`	Set the virtual space of the caret of the nth selection.
`SetSelectionNEnd`	Sets the position that ends the selection - this becomes the currentPosition.
`SetSelectionNStart`	Sets the position that starts the selection - this becomes the anchor.
`SetVirtualSpaceOptions`	Set options for virtual space behaviour.
`SwapMainAnchorCaret`	Swap that caret and anchor of the main selection.

Scrolling and Automatic Scrolling¶

`EnsureCaretVisible`	Ensure the caret is visible.
`GetEndAtLastLine`	Retrieve whether the maximum scroll position has the last line at the bottom of the view.
`GetFirstVisibleLine`	Retrieve the display line at the top of the display.
`GetScrollWidth`	Retrieve the document width assumed for scrolling.
`GetScrollWidthTracking`	Retrieve whether the scroll width tracks wide lines.
`GetUseHorizontalScrollBar`	Is the horizontal scroll bar visible?
`GetUseVerticalScrollBar`	Is the vertical scroll bar visible?
`GetXOffset`	Get the xOffset (ie, horizontal scroll position).
`LineScroll`	Scroll horizontally and vertically.
`ScrollRange`	Scroll the argument positions and the range between them into view giving priority to the primary position then the secondary position.
`SetEndAtLastLine`	Sets the scroll range so that maximum scroll position has the last line at the bottom of the view (default).
`SetFirstVisibleLine`	Scroll so that a display line is at the top of the display.
`SetScrollWidth`	Sets the document width assumed for scrolling.
`SetScrollWidthTracking`	Sets whether the maximum width line displayed is used to set scroll width.
`SetUseHorizontalScrollBar`	Show or hide the horizontal scroll bar.
`SetUseVerticalScrollBar`	Show or hide the vertical scroll bar.
`SetVisiblePolicy`	Set the way the display area is determined when a particular line is to be moved to by Find, FindNext, GotoLine, etc.
`SetXCaretPolicy`	Set the way the caret is kept visible when going sideways.
`SetXOffset`	Set the xOffset (ie, horizontal scroll position).
`SetYCaretPolicy`	Set the way the line the caret is on is kept visible.

White Space¶

`GetExtraAscent`	Get extra ascent for each line.
`GetExtraDescent`	Get extra descent for each line.
`GetTabDrawMode`	Retrieve the current tab draw mode.
`GetViewWhiteSpace`	Are white space characters currently visible? Returns one of `STC_WS_` constants.
`GetWhitespaceSize`	Get the size of the dots used to mark space characters.
`SetExtraAscent`	Set extra ascent for each line.
`SetExtraDescent`	Set extra descent for each line.
`SetTabDrawMode`	Set how tabs are drawn when visible.
`SetViewWhiteSpace`	Make white space characters invisible, always visible or visible outside indentation.
`SetWhitespaceBackground`	Set the background colour of all whitespace and whether to use this setting.
`SetWhitespaceForeground`	Set the foreground colour of all whitespace and whether to use this setting.
`SetWhitespaceSize`	Set the size of the dots used to mark space characters.

Cursor¶

`GetSTCCursor`	Get cursor type.
`SetSTCCursor`	Sets the cursor to one of the `STC_CURSOR` values.

Mouse Capture¶

`GetMouseDownCaptures`	Get whether mouse gets captured.
`GetMouseWheelCaptures`	Get whether mouse wheel can be active outside the window.
`SetMouseDownCaptures`	Set whether the mouse is captured when its button is pressed.
`SetMouseWheelCaptures`	Set whether the mouse wheel can be active outside the window.

Line Endings¶

`ConvertEOLs`	Convert all line endings in the document to one mode.
`GetEOLMode`	Retrieve the current end of line mode - one of `wx.stc.STC_EOL_CRLF`, `wx.stc.STC_EOL_CR`, or `wx.stc.STC_EOL_LF`.
`GetLineEndTypesActive`	Get the line end types currently recognised.
`GetLineEndTypesAllowed`	Get the line end types currently allowed.
`GetLineEndTypesSupported`	Bit set of LineEndType enumertion for which line ends beyond the standard `LF`, `CR`, and `CRLF` are supported by the lexer.
`GetViewEOL`	Are the end of line characters visible?
`SetEOLMode`	Set the current end of line mode.
`SetLineEndTypesAllowed`	Set the line end types that the application wants to use.
`SetViewEOL`	Make the end of line characters visible or invisible.

Words¶

`GetPunctuationChars`	Get the set of characters making up punctuation characters.
`GetWhitespaceChars`	Get the set of characters making up whitespace for when moving or selecting by word.
`GetWordChars`	Get the set of characters making up words for when moving or selecting by word.
`IsRangeWord`	Is the range start..end considered a word?
`SetCharsDefault`	Reset the set of characters for whitespace and word characters to the defaults.
`SetPunctuationChars`	Set the set of characters making up punctuation characters Should be called after SetWordChars.
`SetWhitespaceChars`	Set the set of characters making up whitespace for when moving or selecting by word.
`SetWordChars`	Set the set of characters making up words for when moving or selecting by word.
`WordEndPosition`	Get position of end of word.
`WordStartPosition`	Get position of start of word.

Styling¶

`GetEndStyled`	Retrieve the position of the last correctly styled character.
`GetIdleStyling`	Retrieve the limits to idle styling.
`GetLineState`	Retrieve the extra styling information for a line.
`GetMaxLineState`	Retrieve the last line number that has line state.
`SetIdleStyling`	Sets limits to idle styling.
`SetLineState`	Used to hold extra styling information for each line.
`SetStyleBytes`	Set the styles for a segment of the document.
`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.
`StartStyling`	Set the current styling position to start.

Style Definition¶

`StyleClearAll`	Clear all the styles and make equivalent to the global default style.
`StyleGetBackground`	Get the background colour of a style.
`StyleGetBold`	Get is a style bold or not.
`StyleGetCase`	Get is a style mixed case, or to force upper or lower case.
`StyleGetChangeable`	Get is a style changeable or not (read only).
`StyleGetCharacterSet`	Get the character get of the font in a style.
`StyleGetEOLFilled`	Get is a style to have its end of line filled or not.
`StyleGetFaceName`	Get the font facename of a style.
`StyleGetForeground`	Get the foreground colour of a style.
`StyleGetHotSpot`	Get is a style a hotspot or not.
`StyleGetItalic`	Get is a style italic or not.
`StyleGetSize`	Get the size of characters of a style.
`StyleGetSizeFractional`	Get the size of characters of a style in points multiplied by 100.
`StyleGetUnderline`	Get is a style underlined or not.
`StyleGetVisible`	Get is a style visible or not.
`StyleGetWeight`	Get the weight of characters of a style.
`StyleResetDefault`	Reset the default style to its state at startup.
`StyleSetBackground`	Set the background colour of a style.
`StyleSetBold`	Set a style to be bold or not.
`StyleSetCase`	Set a style to be mixed case, or to force upper or lower case.
`StyleSetChangeable`	Set a style to be changeable or not (read only).
`StyleSetCharacterSet`	Set the character set of the font in a style.
`StyleSetEOLFilled`	Set a style to have its end of line filled or not.
`StyleSetFaceName`	Set the font of a style.
`StyleSetForeground`	Set the foreground colour of a style.
`StyleSetHotSpot`	Set a style to be a hotspot or not.
`StyleSetItalic`	Set a style to be italic or not.
`StyleSetSize`	Set the size of characters of a style.
`StyleSetSizeFractional`	Set the size of characters of a style.
`StyleSetUnderline`	Set a style to be underlined or not.
`StyleSetVisible`	Set a style to be visible or not.
`StyleSetWeight`	Set the weight of characters of a style.

Caret Selection and Hotspot Styles¶

`GetCaretForeground`	Get the foreground colour of the caret.
`GetCaretLineBackAlpha`	Get the background alpha of the caret line.
`GetCaretLineBackground`	Get the colour of the background of the line containing the caret.
`GetCaretLineVisible`	Is the background of the line containing the caret in a different colour?
`GetCaretLineVisibleAlways`	Is the caret line always visible?
`GetCaretPeriod`	Get the time in milliseconds that the caret is on and off.
`GetCaretSticky`	Can the caret preferred x position only be changed by explicit movement commands?
`GetCaretStyle`	Returns the current style of the caret.
`GetCaretWidth`	Returns the width of the insert mode caret.
`GetHotspotActiveBackground`	Get the back colour for active hotspots.
`GetHotspotActiveForeground`	Get the fore colour for active hotspots.
`GetHotspotActiveUnderline`	Get whether underlining for active hotspots.
`GetHotspotSingleLine`	Get the HotspotSingleLine property.
`GetSelAlpha`	Get the alpha of the selection.
`GetSelEOLFilled`	Is the selection end of line filled?
`SetCaretForeground`	Set the foreground colour of the caret.
`SetCaretLineBackAlpha`	Set background alpha of the caret line.
`SetCaretLineBackground`	Set the colour of the background of the line containing the caret.
`SetCaretLineVisible`	Display the background of the line containing the caret in a different colour.
`SetCaretLineVisibleAlways`	Sets the caret line to always visible.
`SetCaretPeriod`	Get the time in milliseconds that the caret is on and off.
`SetCaretSticky`	Stop the caret preferred x position changing when the user types.
`SetCaretStyle`	Set the style of the caret to be drawn.
`SetCaretWidth`	Set the width of the insert mode caret.
`SetHotspotActiveBackground`	Set a back colour for active hotspots.
`SetHotspotActiveForeground`	Set a fore colour for active hotspots.
`SetHotspotActiveUnderline`	Enable / Disable underlining active hotspots.
`SetHotspotSingleLine`	Limit hotspots to single line so hotspots on two lines don’t merge.
`SetSelAlpha`	Set the alpha of the selection.
`SetSelBackground`	Set the background colour of the main and additional selections and whether to use this setting.
`SetSelEOLFilled`	Set the selection to have its end of line filled or not.
`SetSelForeground`	Set the foreground colour of the main and additional selections and whether to use this setting.
`ToggleCaretSticky`	Switch between sticky and non-sticky: meant to be bound to a key.

Character Representations¶

`ClearRepresentation`	Remove a character representation.
`GetControlCharSymbol`	Get the way control characters are displayed.
`GetRepresentation`	Set the way a character is drawn.
`SetControlCharSymbol`	Change the way control characters are displayed: If symbol is < 32, keep the drawn way, else, use the given character.
`SetRepresentation`	Set the way a character is drawn.

Margins¶

`GetMarginBackground`	Retrieve the background colour of a margin.
`GetMarginCount`	How many margins are there?.
`GetMarginCursor`	Retrieve the cursor shown in a margin.
`GetMarginLeft`	Returns the size in pixels of the left margin.
`GetMarginMask`	Retrieve the marker mask of a margin.
`GetMarginOptions`	Get the margin options.
`GetMarginRight`	Returns the size in pixels of the right margin.
`GetMarginSensitive`	Retrieve the mouse click sensitivity of a margin.
`GetMarginType`	Retrieve the type of a margin.
`GetMarginWidth`	Retrieve the width of a margin in pixels.
`MarginGetStyle`	Get the style number for the text margin for a line.
`MarginGetStyleOffset`	Get the start of the range of style numbers used for margin text.
`MarginGetStyles`	Get the styles in the text margin for a line.
`MarginGetText`	Get the text in the text margin for a line.
`MarginSetStyle`	Set the style number for the text margin for a line.
`MarginSetStyleOffset`	Get the start of the range of style numbers used for margin text.
`MarginSetStyles`	Set the style in the text margin for a line.
`MarginSetText`	Set the text in the text margin for a line.
`MarginTextClearAll`	Clear the margin text on all lines.
`SetFoldMarginColour`	Set one of the colours used as a chequerboard pattern in the fold margin.
`SetFoldMarginHiColour`	Set the other colour used as a chequerboard pattern in the fold margin.
`SetMarginBackground`	Set the background colour of a margin.
`SetMarginCount`	Allocate a non-standard number of margins.
`SetMarginCursor`	Set the cursor shown when the mouse is inside a margin.
`SetMarginLeft`	Sets the size in pixels of the left margin.
`SetMarginMask`	Set a mask that determines which markers are displayed in a margin.
`SetMarginOptions`	Set the margin options.
`SetMarginRight`	Sets the size in pixels of the right margin.
`SetMarginSensitive`	Make a margin sensitive or insensitive to mouse clicks.
`SetMarginType`	Set a margin to be either numeric or symbolic.
`SetMarginWidth`	Set the width of a margin to a width expressed in pixels.

Annotations¶

`AnnotationClearAll`	Clear the annotations from all lines.
`AnnotationGetLines`	Get the number of annotation lines for a line.
`AnnotationGetStyle`	Get the style number for the annotations for a line.
`AnnotationGetStyleOffset`	Get the start of the range of style numbers used for annotations.
`AnnotationGetStyles`	Get the annotation styles for a line.
`AnnotationGetText`	Get the annotation text for a line.
`AnnotationGetVisible`	Get the visibility for the annotations for a view.
`AnnotationSetStyle`	Set the style number for the annotations for a line.
`AnnotationSetStyleOffset`	Get the start of the range of style numbers used for annotations.
`AnnotationSetStyles`	Set the annotation styles for a line.
`AnnotationSetText`	Set the annotation text for a line.
`AnnotationSetVisible`	Set the visibility for the annotations for a view.

Other Settings¶

`GetBufferedDraw`	Is drawing done first into a buffer or direct to the screen?
`GetCodePage`	Get the code page used to interpret the bytes of the document as characters.
`GetFontQuality`	Retrieve the quality level for text.
`GetIMEInteraction`	Is the `IME` displayed in a window or inline?
`GetPhasesDraw`	How many phases is drawing done in?
`GetSTCFocus`	Get internal focus flag.
`GetTechnology`	Get the tech.
`GetTwoPhaseDraw`	Is drawing done in two phases with backgrounds drawn before foregrounds?
`SetBufferedDraw`	If drawing is buffered then each line of text is drawn into a bitmap buffer before drawing it to the screen to avoid flicker.
`SetCodePage`	Set the code page used to interpret the bytes of the document as characters.
`SetFontQuality`	Choose the quality level for text.
`SetIMEInteraction`	Choose to display the `IME` in a winow or inline.
`SetLayoutCache`	Sets the degree of caching of layout information.
`SetPhasesDraw`	In one phase draw, text is drawn in a series of rectangular blocks with no overlap.
`SetSTCFocus`	Change internal focus flag.
`SetTechnology`	Set the technology used.
`SetTwoPhaseDraw`	In twoPhaseDraw mode, drawing is performed in two phases, first the background and then the foreground.

Brace Highlighting¶

`BraceBadLight`	Highlight the character at a position indicating there is no matching brace.
`BraceBadLightIndicator`	Use specified indicator to highlight non matching brace instead of changing its style.
`BraceHighlight`	Highlight the characters at two positions.
`BraceHighlightIndicator`	Use specified indicator to highlight matching braces instead of changing their style.
`BraceMatch`	Find the position of a matching brace or `wx.stc.STC_INVALID_POSITION` if no match.

Tabs and Indentation Guides¶

`AddTabStop`	Add an explicit tab stop for a line.
`ClearTabStops`	Clear explicit tabstops on a line.
`GetBackSpaceUnIndents`	Does a backspace pressed when caret is within indentation unindent?
`GetHighlightGuide`	Get the highlighted indentation guide column.
`GetIndent`	Retrieve indentation size.
`GetIndentationGuides`	Are the indentation guides visible?
`GetLineIndentPosition`	Retrieve the position before the first non indentation character on a line.
`GetLineIndentation`	Retrieve the number of columns that a line is indented.
`GetNextTabStop`	Find the next explicit tab stop position on a line after a position.
`GetTabIndents`	Does a tab pressed when caret is within indentation indent?
`GetTabWidth`	Retrieve the visible size of a tab.
`GetUseTabs`	Retrieve whether tabs will be used in indentation.
`SetBackSpaceUnIndents`	Sets whether a backspace pressed when caret is within indentation unindents.
`SetHighlightGuide`	Set the highlighted indentation guide column.
`SetIndent`	Set the number of spaces used for one level of indentation.
`SetIndentationGuides`	Show or hide indentation guides.
`SetLineIndentation`	Change the indentation of a line to a number of columns.
`SetTabIndents`	Sets whether a tab pressed when caret is within indentation indents.
`SetTabWidth`	Change the visible size of a tab to be a multiple of the width of a space character.
`SetUseTabs`	Indentation will only use space characters if useTabs is `False`, otherwise it will use a combination of tabs and spaces.

Markers¶

See also

MarkerDefineBitmap

`GetMarkerSymbolDefined`	Which symbol was defined for markerNumber with MarkerDefine.
`MarkerAdd`	Add a marker to a line, returning an `ID` which can be used to find or delete the marker.
`MarkerAddSet`	Add a set of markers to a line.
`MarkerDefine`	Set the symbol used for a particular marker number, and optionally the fore and background colours.
`MarkerDefineRGBAImage`	Define a marker from `RGBA` data.
`MarkerDelete`	Delete a marker from a line.
`MarkerDeleteAll`	Delete all markers with a particular number from all lines.
`MarkerDeleteHandle`	Delete a marker.
`MarkerEnableHighlight`	Enable/disable highlight for current folding block (smallest one that contains the caret)
`MarkerGet`	Get a bit mask of all the markers set on a line.
`MarkerLineFromHandle`	Retrieve the line number at which a particular marker is located.
`MarkerNext`	Find the next line at or after lineStart that includes a marker in mask.
`MarkerPrevious`	Find the previous line before lineStart that includes a marker in mask.
`MarkerSetAlpha`	Set the alpha used for a marker that is drawn in the text area, not the margin.
`MarkerSetBackground`	Set the background colour used for a particular marker number.
`MarkerSetBackgroundSelected`	Set the background colour used for a particular marker number when its folding block is selected.
`MarkerSetForeground`	Set the foreground colour used for a particular marker number.
`RGBAImageSetHeight`	Set the height for future `RGBA` image data.
`RGBAImageSetScale`	Set the scale factor in percent for future `RGBA` image data.
`RGBAImageSetWidth`	Set the width for future `RGBA` image data.

Indicators¶

`GetIndicatorCurrent`	Get the current indicator.
`GetIndicatorValue`	Get the current indicator value.
`IndicatorAllOnFor`	Are any indicators present at pos?
`IndicatorClearRange`	Turn an indicator off over a range.
`IndicatorEnd`	Where does a particular indicator end?
`IndicatorFillRange`	Turn an indicator on over a range.
`IndicatorGetAlpha`	Get the alpha fill colour of the given indicator.
`IndicatorGetFlags`	Retrieve the attributes of an indicator.
`IndicatorGetForeground`	Retrieve the foreground colour of an indicator.
`IndicatorGetHoverForeground`	Retrieve the foreground hover colour of an indicator.
`IndicatorGetHoverStyle`	Retrieve the hover style of an indicator.
`IndicatorGetOutlineAlpha`	Get the alpha outline colour of the given indicator.
`IndicatorGetStyle`	Retrieve the style of an indicator.
`IndicatorGetUnder`	Retrieve whether indicator drawn under or over text.
`IndicatorSetAlpha`	Set the alpha fill colour of the given indicator.
`IndicatorSetFlags`	Set the attributes of an indicator.
`IndicatorSetForeground`	Set the foreground colour of an indicator.
`IndicatorSetHoverForeground`	Set the foreground hover colour of an indicator.
`IndicatorSetHoverStyle`	Set a hover indicator to plain, squiggle or `TT`.
`IndicatorSetOutlineAlpha`	Set the alpha outline colour of the given indicator.
`IndicatorSetStyle`	Set an indicator to plain, squiggle or `TT`.
`IndicatorSetUnder`	Set an indicator to draw under text or over(default).
`IndicatorStart`	Where does a particular indicator start?
`IndicatorValueAt`	What value does a particular indicator have at a position?
`SetIndicatorCurrent`	Set the indicator used for IndicatorFillRange and IndicatorClearRange.
`SetIndicatorValue`	Set the value used for IndicatorFillRange.

Autocompletion¶

See also

RegisterImage

`AutoCompActive`	Is there an auto-completion list visible?
`AutoCompCancel`	Remove the auto-completion list from the screen.
`AutoCompComplete`	User has selected an item so remove the list and insert the selection.
`AutoCompGetAutoHide`	Retrieve whether or not autocompletion is hidden automatically when nothing matches.
`AutoCompGetCancelAtStart`	Retrieve whether auto-completion cancelled by backspacing before start.
`AutoCompGetCaseInsensitiveBehaviour`	Get auto-completion case insensitive behaviour.
`AutoCompGetChooseSingle`	Retrieve whether a single item auto-completion list automatically choose the item.
`AutoCompGetCurrent`	Get currently selected item position in the auto-completion list.
`AutoCompGetCurrentText`	Get currently selected item text in the auto-completion list.
`AutoCompGetDropRestOfWord`	Retrieve whether or not autocompletion deletes any word characters after the inserted text upon completion.
`AutoCompGetIgnoreCase`	Retrieve state of ignore case flag.
`AutoCompGetMaxHeight`	Set the maximum height, in rows, of auto-completion and user lists.
`AutoCompGetMaxWidth`	Get the maximum width, in characters, of auto-completion and user lists.
`AutoCompGetMulti`	Retrieve the effect of autocompleting when there are multiple selections.
`AutoCompGetOrder`	Get the way autocompletion lists are ordered.
`AutoCompGetSeparator`	Retrieve the auto-completion list separator character.
`AutoCompGetTypeSeparator`	Retrieve the auto-completion list type-separator character.
`AutoCompPosStart`	Retrieve the position of the caret when the auto-completion list was displayed.
`AutoCompSelect`	Select the item in the auto-completion list that starts with a string.
`AutoCompSetAutoHide`	Set whether or not autocompletion is hidden automatically when nothing matches.
`AutoCompSetCancelAtStart`	Should the auto-completion list be cancelled if the user backspaces to a position before where the box was created.
`AutoCompSetCaseInsensitiveBehaviour`	Set auto-completion case insensitive behaviour to either prefer case-sensitive matches or have no preference.
`AutoCompSetChooseSingle`	Should a single item auto-completion list automatically choose the item.
`AutoCompSetDropRestOfWord`	Set whether or not autocompletion deletes any word characters after the inserted text upon completion.
`AutoCompSetFillUps`	Define a set of characters that when typed will cause the autocompletion to choose the selected item.
`AutoCompSetIgnoreCase`	Set whether case is significant when performing auto-completion searches.
`AutoCompSetMaxHeight`	Set the maximum height, in rows, of auto-completion and user lists.
`AutoCompSetMaxWidth`	Set the maximum width, in characters, of auto-completion and user lists.
`AutoCompSetMulti`	Change the effect of autocompleting when there are multiple selections.
`AutoCompSetOrder`	Set the way autocompletion lists are ordered.
`AutoCompSetSeparator`	Change the separator character in the string setting up an auto-completion list.
`AutoCompSetTypeSeparator`	Change the type-separator character in the string setting up an auto-completion list.
`AutoCompShow`	Display an auto-completion list.
`AutoCompStops`	Define a set of character that when typed cancel the auto-completion list.
`ClearRegisteredImages`	Clear all the registered images.
`RegisterRGBAImage`	Register an `RGBA` image for use in autocompletion lists.

User Lists¶

UserListShow

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

Call Tips¶

`CallTipActive`	Is there an active call tip?
`CallTipCancel`	Remove the call tip from the screen.
`CallTipPosAtStart`	Retrieve the position where the caret was before displaying the call tip.
`CallTipSetBackground`	Set the background colour for the call tip.
`CallTipSetForeground`	Set the foreground colour for the call tip.
`CallTipSetForegroundHighlight`	Set the foreground colour for the highlighted part of the call tip.
`CallTipSetHighlight`	Highlight a segment of the definition.
`CallTipSetPosAtStart`	Set the start position in order to change when backspacing removes the calltip.
`CallTipSetPosition`	Set position of calltip, above or below text.
`CallTipShow`	Show a call tip containing a definition near position pos.
`CallTipUseStyle`	Enable use of `wx.stc.STC_STYLE_CALLTIP` and set call tip tab size in pixels.

Keyboard Commands¶

`BackTab`	Dedent the selected lines.
`Cancel`	Cancel any modes such as call tip or auto-completion list display.
`CharLeft`	Move caret left one character.
`CharLeftExtend`	Move caret left one character extending selection to new caret position.
`CharLeftRectExtend`	Move caret left one character, extending rectangular selection to new caret position.
`CharRight`	Move caret right one character.
`CharRightExtend`	Move caret right one character extending selection to new caret position.
`CharRightRectExtend`	Move caret right one character, extending rectangular selection to new caret position.
`DelLineLeft`	Delete back from the current position to the start of the line.
`DelLineRight`	Delete forwards from the current position to the end of the line.
`DelWordLeft`	Delete the word to the left of the caret.
`DelWordRight`	Delete the word to the right of the caret.
`DelWordRightEnd`	Delete the word to the right of the caret, but not the trailing non-word characters.
`DeleteBack`	Delete the selection or if no selection, the character before the caret.
`DeleteBackNotLine`	Delete the selection or if no selection, the character before the caret.
`DocumentEnd`	Move caret to last position in document.
`DocumentEndExtend`	Move caret to last position in document extending selection to new caret position.
`DocumentStart`	Move caret to first position in document.
`DocumentStartExtend`	Move caret to first position in document extending selection to new caret position.
`EditToggleOvertype`	Switch from insert to overtype mode or the reverse.
`FormFeed`	Insert a Form Feed character.
`Home`	Move caret to first position on line.
`HomeDisplay`	Move caret to first position on display line.
`HomeDisplayExtend`	Move caret to first position on display line extending selection to new caret position.
`HomeExtend`	Move caret to first position on line extending selection to new caret position.
`HomeRectExtend`	Move caret to first position on line, extending rectangular selection to new caret position.
`HomeWrap`	Like Home but when word-wrap is enabled goes first to start of display line HomeDisplay, then to start of document line Home.
`HomeWrapExtend`	Like HomeExtend but when word-wrap is enabled extends first to start of display line HomeDisplayExtend, then to start of document line HomeExtend.
`LineCopy`	Copy the line containing the caret.
`LineCut`	Cut the line containing the caret.
`LineDelete`	Delete the line containing the caret.
`LineDown`	Move caret down one line.
`LineDownExtend`	Move caret down one line extending selection to new caret position.
`LineDownRectExtend`	Move caret down one line, extending rectangular selection to new caret position.
`LineDuplicate`	Duplicate the current line.
`LineEnd`	Move caret to last position on line.
`LineEndDisplay`	Move caret to last position on display line.
`LineEndDisplayExtend`	Move caret to last position on display line extending selection to new caret position.
`LineEndExtend`	Move caret to last position on line extending selection to new caret position.
`LineEndRectExtend`	Move caret to last position on line, extending rectangular selection to new caret position.
`LineEndWrap`	Like LineEnd but when word-wrap is enabled goes first to end of display line LineEndDisplay, then to start of document line LineEnd.
`LineEndWrapExtend`	Like LineEndExtend but when word-wrap is enabled extends first to end of display line LineEndDisplayExtend, then to start of document line LineEndExtend.
`LineScrollDown`	Scroll the document down, keeping the caret visible.
`LineScrollUp`	Scroll the document up, keeping the caret visible.
`LineTranspose`	Switch the current line with the previous.
`LineUp`	Move caret up one line.
`LineUpExtend`	Move caret up one line extending selection to new caret position.
`LineUpRectExtend`	Move caret up one line, extending rectangular selection to new caret position.
`LowerCase`	Transform the selection to lower case.
`NewLine`	Insert a new line, may use a `CRLF`, `CR` or `LF` depending on `EOL` mode.
`PageDown`	Move caret one page down.
`PageDownExtend`	Move caret one page down extending selection to new caret position.
`PageDownRectExtend`	Move caret one page down, extending rectangular selection to new caret position.
`PageUp`	Move caret one page up.
`PageUpExtend`	Move caret one page up extending selection to new caret position.
`PageUpRectExtend`	Move caret one page up, extending rectangular selection to new caret position.
`ParaDown`	Move caret down one paragraph (delimited by empty lines).
`ParaDownExtend`	Extend selection down one paragraph (delimited by empty lines).
`ParaUp`	Move caret up one paragraph (delimited by empty lines).
`ParaUpExtend`	Extend selection up one paragraph (delimited by empty lines).
`ScrollToEnd`	Scroll to end of document.
`ScrollToStart`	Scroll to start of document.
`SelectionDuplicate`	Duplicate the selection.
`StutteredPageDown`	Move caret to bottom of page, or one page down if already at bottom of page.
`StutteredPageDownExtend`	Move caret to bottom of page, or one page down if already at bottom of page, extending selection to new caret position.
`StutteredPageUp`	Move caret to top of page, or one page up if already at top of page.
`StutteredPageUpExtend`	Move caret to top of page, or one page up if already at top of page, extending selection to new caret position.
`Tab`	If selection is empty or all on one line replace the selection with a tab character.
`UpperCase`	Transform the selection to upper case.
`VCHome`	Move caret to before first visible character on line.
`VCHomeDisplay`	Move caret to before first visible character on display line.
`VCHomeDisplayExtend`	Like VCHomeDisplay but extending selection to new caret position.
`VCHomeExtend`	Like VCHome but extending selection to new caret position.
`VCHomeRectExtend`	Move caret to before first visible character on line.
`VCHomeWrap`	Like VCHome but when word-wrap is enabled goes first to start of display line VCHomeDisplay, then behaves like VCHome.
`VCHomeWrapExtend`	Like VCHomeExtend but when word-wrap is enabled extends first to start of display line VCHomeDisplayExtend, then behaves like VCHomeExtend.
`VerticalCentreCaret`	Centre current line in window.
`WordLeft`	Move caret left one word.
`WordLeftEnd`	Move caret left one word, position cursor at end of word.
`WordLeftEndExtend`	Move caret left one word, position cursor at end of word, extending selection to new caret position.
`WordLeftExtend`	Move caret left one word extending selection to new caret position.
`WordPartLeft`	Move to the previous change in capitalisation.
`WordPartLeftExtend`	Move to the previous change in capitalisation extending selection to new caret position.
`WordPartRight`	Move to the change next in capitalisation.
`WordPartRightExtend`	Move to the next change in capitalisation extending selection to new caret position.
`WordRight`	Move caret right one word.
`WordRightEnd`	Move caret right one word, position cursor at end of word.
`WordRightEndExtend`	Move caret right one word, position cursor at end of word, extending selection to new caret position.
`WordRightExtend`	Move caret right one word extending selection to new caret position.

Key Bindings¶

`CmdKeyAssign`	When key+modifier combination keyDefinition is pressed perform sciCommand.
`CmdKeyClear`	When key+modifier combination keyDefinition is pressed do nothing.
`CmdKeyClearAll`	Drop all key mappings.

Macro Recording¶

`StartRecord`	Start notifying the container of all key presses and commands.
`StopRecord`	Stop notifying the container of all key presses and commands.

Printing¶

`FormatRange`	On Windows, will draw the document into a display context such as a printer.
`GetPrintColourMode`	Returns the print colour mode.
`GetPrintMagnification`	Returns the print magnification.
`GetPrintWrapMode`	Is printing line wrapped?
`SetPrintColourMode`	Modify colours when printing for clearer printed text.
`SetPrintMagnification`	Sets the print magnification added to the point size of each style for printing.
`SetPrintWrapMode`	Set printing to line wrapped (wx``wx.stc.STC_WRAP_WORD``) or not line wrapped (wx``wx.stc.STC_WRAP_NONE``).

Direct Access¶

`GetCharacterPointer`	Compact the document buffer and return a read-only memoryview
`GetDirectFunction`	Retrieve a pointer to a function that processes messages for this Scintilla.
`GetDirectPointer`	Retrieve a pointer value to use as the first argument when calling the function returned by GetDirectFunction.
`GetGapPosition`	Return a position which, to avoid performance costs, should not be within the range of a call to GetRangePointer.
`GetRangePointer`	Return a read-only pointer to a range of characters in the

Multiple Views¶

`AddRefDocument`	Extend life of document.
`CreateDocument`	Create a new document object.
`GetDocPointer`	Retrieve a pointer to the document object.
`ReleaseDocument`	Release a reference to the document, deleting document if it fades to black.
`SetDocPointer`	Change the document object used.

Background Loading and Saving¶

CreateLoader

Create an ILoader.

Folding¶

`ContractedFoldNext`	Find the next line at or after lineStart that is a contracted fold header line.
`DocLineFromVisible`	Find the document line of a display line taking hidden lines into account.
`EnsureVisible`	Ensure a particular line is visible by expanding any header line hiding it.
`EnsureVisibleEnforcePolicy`	Ensure a particular line is visible by expanding any header line hiding it.
`ExpandChildren`	Expand a fold header and all children.
`FoldAll`	Expand or contract all fold headers.
`FoldChildren`	Expand or contract a fold header and its children.
`FoldDisplayTextSetStyle`	Set the style of fold display text.
`FoldLine`	Expand or contract a fold header.
`GetAllLinesVisible`	Are all lines visible?
`GetAutomaticFold`	Get automatic folding behaviours.
`GetFoldExpanded`	Is a header line expanded?
`GetFoldLevel`	Retrieve the fold level of a line.
`GetFoldParent`	Find the parent line of a child line.
`GetLastChild`	Find the last child line of a header line.
`GetLineVisible`	Is a line visible?
`HideLines`	Make a range of lines invisible.
`SetAutomaticFold`	Set automatic folding behaviours.
`SetFoldExpanded`	Show the children of a header line.
`SetFoldFlags`	Set some style options for folding.
`SetFoldLevel`	Set the fold level of a line.
`ShowLines`	Make a range of lines visible.
`ToggleFold`	Switch a header line between expanded and contracted.
`ToggleFoldShowText`	Switch a header line between expanded and contracted and show some text after the line.
`VisibleFromDocLine`	Find the display line of a document line taking hidden lines into account.

Line Wrapping¶

`GetLayoutCache`	Retrieve the degree of caching of layout information.
`GetPositionCacheSize`	How many entries are allocated to the position cache?
`GetWrapIndentMode`	Retrieve how wrapped sublines are placed.
`GetWrapMode`	Retrieve whether text is word wrapped.
`GetWrapStartIndent`	Retrieve the start indent for wrapped lines.
`GetWrapVisualFlags`	Retrieve the display mode of visual flags for wrapped lines.
`GetWrapVisualFlagsLocation`	Retrieve the location of visual flags for wrapped lines.
`LinesJoin`	Join the lines in the target.
`LinesSplit`	Split the lines in the target into lines that are less wide than pixelWidth where possible.
`SetPositionCacheSize`	Set number of entries in position cache.
`SetWrapIndentMode`	Sets how wrapped sublines are placed.
`SetWrapMode`	Sets whether text is word wrapped.
`SetWrapStartIndent`	Set the start indent for wrapped lines.
`SetWrapVisualFlags`	Set the display mode of visual flags for wrapped lines.
`SetWrapVisualFlagsLocation`	Set the location of visual flags for wrapped lines.
`WrapCount`	The number of display lines needed to wrap a document line.

Zooming¶

`GetZoom`	Retrieve the zoom level.
`SetZoom`	Set the zoom level.
`ZoomIn`	Magnify the displayed text by increasing the sizes by 1 point.
`ZoomOut`	Make the displayed text smaller by decreasing the sizes by 1 point.

Long Lines¶

`GetEdgeColour`	Retrieve the colour used in edge indication.
`GetEdgeColumn`	Retrieve the column number which text should be kept within.
`GetEdgeMode`	Retrieve the edge highlight mode.
`MultiEdgeAddLine`	Add a new vertical edge to the view.
`MultiEdgeClearAll`	Clear all vertical edges.
`SetEdgeColour`	Change the colour used in edge indication.
`SetEdgeColumn`	Set the column number of the edge.
`SetEdgeMode`	The edge may be displayed by a line (wxSTC_EDGE_LINE/wxSTC_EDGE_MULTILINE) or by highlighting text that goes beyond it (wx``wx.stc.STC_EDGE_BACKGROUND``) or not displayed at all (wx``wx.stc.STC_EDGE_NONE``).

Lexer¶

`AllocateSubStyles`	Allocate a set of sub styles for a particular base style, returning start of range.
`ChangeLexerState`	Indicate that the internal state of a lexer has changed over a range and therefore there may be a need to redraw.
`Colourise`	Colourise a segment of the document using the current lexing language.
`DescribeKeyWordSets`	Retrieve a ‘\n’ separated list of descriptions of the keyword sets understood by the current lexer.
`DescribeProperty`	Describe a property.
`DistanceToSecondaryStyles`	Where styles are duplicated by a feature such as active/inactive code return the distance between the two types.
`FreeSubStyles`	Free allocated sub styles.
`GetLexer`	Retrieve the lexing language of the document.
`GetLexerLanguage`	Retrieve the lexing language of the document.
`GetPrimaryStyleFromStyle`	For a secondary style, return the primary style, else return the argument.
`GetProperty`	Retrieve a “property” value previously set with SetProperty.
`GetPropertyExpanded`	Retrieve a “property” value previously set with SetProperty, with “$()” variable replacement on returned buffer.
`GetPropertyInt`	Retrieve a “property” value previously set with SetProperty, interpreted as an int `AFTER` any “$()” variable replacement.
`GetStyleFromSubStyle`	For a sub style, return the base style, else return the argument.
`GetSubStyleBases`	Get the set of base styles that can be extended with sub styles.
`GetSubStylesLength`	The number of sub styles associated with a base style.
`GetSubStylesStart`	The starting style number for the sub styles associated with a base style.
`LoadLexerLibrary`	Load a lexer library (dll / so).
`PrivateLexerCall`	For private communication between an application and a known lexer.
`PropertyNames`	Retrieve a ‘\n’ separated list of properties understood by the current lexer.
`PropertyType`	Retrieve the type of a property.
`SetIdentifiers`	Set the identifiers that are shown in a particular style.
`SetKeyWords`	Set up the key words used by the lexer.
`SetLexer`	Set the lexing language of the document.
`SetLexerLanguage`	Set the lexing language of the document based on string name.
`SetProperty`	Set up a value that may be used by a lexer for some optional feature.

Deprecated Items¶

These methods should not be used in new code.

`GetStyleBits`	Retrieve number of bits in style bytes used to hold the lexical state.
`GetStyleBitsNeeded`	Retrieve the number of bits the current lexer needs for styling.
`SetStyleBits`	Divide each styling byte into lexical class bits (default: 5) and indicator bits (default: 3).

Additional wxStyledTextCtrl Methods¶

In addition to the standard Scintilla functions, wxStyledTextCtrl includes the following functions to simplify some tasks.

`AnnotationClearLine`	Clear annotations from the given line.
`CmdKeyExecute`	Perform one of the operations defined by the `STC_CMD_` constants.
`DoDragEnter`	Allow for simulating a DnD DragEnter.
`DoDragLeave`	Allow for simulating a DnD DragLeave.
`DoDragOver`	Allow for simulating a DnD DragOver.
`DoDropText`	Allow for simulating a DnD DropText.
`GetCurrentLine`	Returns the line number of the line with the caret.
`GetLastKeydownProcessed`	Can be used to prevent the `EVT_CHAR` handler from adding the char.
`GetUseAntiAliasing`	Returns the current UseAntiAliasing setting.
`LoadFile`	Load the contents of filename into the editor.
`MarkerDefineBitmap`	Define a marker with a wx.Bitmap.
`RegisterImage`	Register an image for use in autocompletion lists.
`SaveFile`	Write the contents of the editor to filename.
`ScrollToColumn`	Scroll enough to make the given column visible.
`ScrollToLine`	Scroll enough to make the given line visible.
`SendMsg`	Scintilla API call.
`SetHScrollBar`	Set the horizontal scrollbar to use instead of the one that’s built-in.
`SetLastKeydownProcessed`	Returns the line number of the line with the caret.
`SetMargins`	Set the left and right margin in the edit area, measured in pixels.
`SetUseAntiAliasing`	Specify whether anti-aliased fonts should be used.
`SetVScrollBar`	Set the vertical scrollbar to use instead of the one that’s built-in.
`StyleGetFont`	Get the font of a style.
`StyleSetFont`	Set style size, face, bold, italic, and underline attributes from a wx.Font’s attributes.
`StyleSetFontAttr`	Set all font style attributes at once.
`StyleSetFontEncoding`	Set the font encoding to be used by a style.
`StyleSetSpec`	Extract style settings from a spec-string which is composed of one or more of the following comma separated elements

Raw Variants¶

These methods allow data to be sent to or received from the control using character buffers instead of using a wxString.

`AddTextRaw`	Add text to the document at current position.
`AppendTextRaw`	Append a string to the end of the document without changing the selection.
`GetCurLineRaw`	Retrieve the text of the line containing the caret.
`GetLineRaw`	Retrieve the contents of a line.
`GetSelectedTextRaw`	Retrieve the selected text.
`GetTargetTextRaw`	Retrieve the target text.
`GetTextRangeRaw`	Retrieve a range of text.
`GetTextRaw`	Retrieve all the text in the document.
`InsertTextRaw`	Insert string at a position.
`ReplaceSelectionRaw`	Replace the current selection with text.
`ReplaceTargetRERaw`	Replace the current target with text using regular expressions.
`ReplaceTargetRaw`	Replace the current target with text.
`SetTextRaw`	Replace the contents of the document with the argument text.

Text Entry Methods¶

`GetInsertionPoint`	Returns the insertion point, or cursor, position.
`GetLastPosition`	Returns the zero based index of the last position in the text control, which is equal to the number of characters in the control.
`GetSelection`	Gets the current selection span.
`IsEditable`	Returns `True` if the controls contents may be edited by user (note that it always can be changed by the program).
`Remove`	Removes the text starting at the first given position up to (but not including) the character at the last position.
`Replace`	Replaces the text starting at the first position up to (but not including) the character at the last position with the given text.
`SelectNone`	Deselects selected text in the control.
`SetEditable`	Makes the text item editable or read-only, overriding the `wx.TE_READONLY` flag.
`SetInsertionPoint`	Sets the insertion point at the given position.
`SetSelection`	Selects the text starting at the first position up to (but not including) the character at the last position.
`WriteText`	Writes the text into the text control at the current insertion position.

Text Area Methods¶

`DiscardEdits`	Resets the internal modified flag as if the current changes had been saved.
`GetLibraryVersionInfo`	Returns the version of the Scintilla library used by this control.
`GetLineLength`	Gets the length of the specified line, not including any trailing newline character(s).
`GetLineText`	Returns the contents of a given line in the text control, not including any trailing newline character(s).
`GetNumberOfLines`	Returns the number of lines in the text control buffer.
`GetStyle`	This method is inherited from TextAreaBase but is not implemented in wx.stc.StyledTextCtrl.
`HitTest`	Finds the row and column of the character at the specified point.
`IsModified`	Returns `True` if the text has been modified by user.
`MarkDirty`	Mark text as modified (dirty).
`PositionToXY`	Converts given position to a zero-based column, line number pair.
`SetDefaultStyle`	This method is inherited from TextAreaBase but is not implemented in wx.stc.StyledTextCtrl.
`SetStyle`	This method is inherited from TextAreaBase but is not implemented in wx.stc.StyledTextCtrl.
`ShowPosition`	Makes the line containing the given position visible.
`XYToPosition`	Converts the given zero based column and line number to a position.

Properties Summary¶

`AdditionalCaretForeground`	See `GetAdditionalCaretForeground` and `SetAdditionalCaretForeground`
`AdditionalCaretsBlink`	See `GetAdditionalCaretsBlink` and `SetAdditionalCaretsBlink`
`AdditionalCaretsVisible`	See `GetAdditionalCaretsVisible` and `SetAdditionalCaretsVisible`
`AdditionalSelAlpha`	See `GetAdditionalSelAlpha` and `SetAdditionalSelAlpha`
`AdditionalSelectionTyping`	See `GetAdditionalSelectionTyping` and `SetAdditionalSelectionTyping`
`AllLinesVisible`	See `GetAllLinesVisible`
`Anchor`	See `GetAnchor` and `SetAnchor`
`AutomaticFold`	See `GetAutomaticFold` and `SetAutomaticFold`
`BackSpaceUnIndents`	See `GetBackSpaceUnIndents` and `SetBackSpaceUnIndents`
`BufferedDraw`	See `GetBufferedDraw` and `SetBufferedDraw`
`CaretForeground`	See `GetCaretForeground` and `SetCaretForeground`
`CaretLineBackAlpha`	See `GetCaretLineBackAlpha` and `SetCaretLineBackAlpha`
`CaretLineBackground`	See `GetCaretLineBackground` and `SetCaretLineBackground`
`CaretLineVisible`	See `GetCaretLineVisible` and `SetCaretLineVisible`
`CaretLineVisibleAlways`	See `GetCaretLineVisibleAlways` and `SetCaretLineVisibleAlways`
`CaretPeriod`	See `GetCaretPeriod` and `SetCaretPeriod`
`CaretSticky`	See `GetCaretSticky` and `SetCaretSticky`
`CaretStyle`	See `GetCaretStyle` and `SetCaretStyle`
`CaretWidth`	See `GetCaretWidth` and `SetCaretWidth`
`CharacterPointer`	See `GetCharacterPointer`
`CodePage`	See `GetCodePage` and `SetCodePage`
`ControlCharSymbol`	See `GetControlCharSymbol` and `SetControlCharSymbol`
`CurLine`	See `GetCurLine`
`CurLineRaw`	See `GetCurLineRaw`
`CurrentLine`	See `GetCurrentLine`
`CurrentPos`	See `GetCurrentPos` and `SetCurrentPos`
`DefaultStyle`	See `GetDefaultStyle` and `SetDefaultStyle`
`DirectFunction`	See `GetDirectFunction`
`DirectPointer`	See `GetDirectPointer`
`DocPointer`	See `GetDocPointer` and `SetDocPointer`
`EOLMode`	See `GetEOLMode` and `SetEOLMode`
`EdgeColour`	See `GetEdgeColour` and `SetEdgeColour`
`EdgeColumn`	See `GetEdgeColumn` and `SetEdgeColumn`
`EdgeMode`	See `GetEdgeMode` and `SetEdgeMode`
`EndAtLastLine`	See `GetEndAtLastLine` and `SetEndAtLastLine`
`EndStyled`	See `GetEndStyled`
`ExtraAscent`	See `GetExtraAscent` and `SetExtraAscent`
`ExtraDescent`	See `GetExtraDescent` and `SetExtraDescent`
`FirstVisibleLine`	See `GetFirstVisibleLine` and `SetFirstVisibleLine`
`FontQuality`	See `GetFontQuality` and `SetFontQuality`
`GapPosition`	See `GetGapPosition`
`HighlightGuide`	See `GetHighlightGuide` and `SetHighlightGuide`
`Hint`	See `GetHint` and `SetHint`
`HotspotActiveBackground`	See `GetHotspotActiveBackground`
`HotspotActiveForeground`	See `GetHotspotActiveForeground`
`HotspotActiveUnderline`	See `GetHotspotActiveUnderline` and `SetHotspotActiveUnderline`
`HotspotSingleLine`	See `GetHotspotSingleLine` and `SetHotspotSingleLine`
`IMEInteraction`	See `GetIMEInteraction` and `SetIMEInteraction`
`Identifier`	See `GetIdentifier` and `SetIdentifier`
`IdleStyling`	See `GetIdleStyling` and `SetIdleStyling`
`Indent`	See `GetIndent` and `SetIndent`
`IndentationGuides`	See `GetIndentationGuides` and `SetIndentationGuides`
`IndicatorCurrent`	See `GetIndicatorCurrent` and `SetIndicatorCurrent`
`IndicatorValue`	See `GetIndicatorValue` and `SetIndicatorValue`
`InsertionPoint`	See `GetInsertionPoint` and `SetInsertionPoint`
`LastKeydownProcessed`	See `GetLastKeydownProcessed` and `SetLastKeydownProcessed`
`LastPosition`	See `GetLastPosition`
`LayoutCache`	See `GetLayoutCache` and `SetLayoutCache`
`Length`	See `GetLength`
`Lexer`	See `GetLexer` and `SetLexer`
`LexerLanguage`	See `GetLexerLanguage` and `SetLexerLanguage`
`LineCount`	See `GetLineCount`
`LineEndTypesActive`	See `GetLineEndTypesActive`
`LineEndTypesAllowed`	See `GetLineEndTypesAllowed` and `SetLineEndTypesAllowed`
`LineEndTypesSupported`	See `GetLineEndTypesSupported`
`MainSelection`	See `GetMainSelection` and `SetMainSelection`
`MarginCount`	See `GetMarginCount` and `SetMarginCount`
`MarginLeft`	See `GetMarginLeft` and `SetMarginLeft`
`MarginOptions`	See `GetMarginOptions` and `SetMarginOptions`
`MarginRight`	See `GetMarginRight` and `SetMarginRight`
`Margins`	See `GetMargins`
`MaxLineState`	See `GetMaxLineState`
`ModEventMask`	See `GetModEventMask` and `SetModEventMask`
`Modify`	See `GetModify`
`MouseDownCaptures`	See `GetMouseDownCaptures` and `SetMouseDownCaptures`
`MouseDwellTime`	See `GetMouseDwellTime` and `SetMouseDwellTime`
`MouseSelectionRectangularSwitch`	See `GetMouseSelectionRectangularSwitch` and `SetMouseSelectionRectangularSwitch`
`MouseWheelCaptures`	See `GetMouseWheelCaptures` and `SetMouseWheelCaptures`
`MultiPaste`	See `GetMultiPaste` and `SetMultiPaste`
`MultipleSelection`	See `GetMultipleSelection` and `SetMultipleSelection`
`NumberOfLines`	See `GetNumberOfLines`
`Overtype`	See `GetOvertype` and `SetOvertype`
`PasteConvertEndings`	See `GetPasteConvertEndings` and `SetPasteConvertEndings`
`PhasesDraw`	See `GetPhasesDraw` and `SetPhasesDraw`
`PositionCacheSize`	See `GetPositionCacheSize` and `SetPositionCacheSize`
`PrintColourMode`	See `GetPrintColourMode` and `SetPrintColourMode`
`PrintMagnification`	See `GetPrintMagnification` and `SetPrintMagnification`
`PrintWrapMode`	See `GetPrintWrapMode` and `SetPrintWrapMode`
`PunctuationChars`	See `GetPunctuationChars` and `SetPunctuationChars`
`RangePointer`	See `GetRangePointer`
`ReadOnly`	See `GetReadOnly` and `SetReadOnly`
`RectangularSelectionAnchor`	See `GetRectangularSelectionAnchor` and `SetRectangularSelectionAnchor`
`RectangularSelectionAnchorVirtualSpace`	See `GetRectangularSelectionAnchorVirtualSpace` and `SetRectangularSelectionAnchorVirtualSpace`
`RectangularSelectionCaret`	See `GetRectangularSelectionCaret` and `SetRectangularSelectionCaret`
`RectangularSelectionCaretVirtualSpace`	See `GetRectangularSelectionCaretVirtualSpace` and `SetRectangularSelectionCaretVirtualSpace`
`RectangularSelectionModifier`	See `GetRectangularSelectionModifier` and `SetRectangularSelectionModifier`
`STCCursor`	See `GetSTCCursor` and `SetSTCCursor`
`STCFocus`	See `GetSTCFocus` and `SetSTCFocus`
`ScrollWidth`	See `GetScrollWidth` and `SetScrollWidth`
`ScrollWidthTracking`	See `GetScrollWidthTracking` and `SetScrollWidthTracking`
`SearchFlags`	See `GetSearchFlags` and `SetSearchFlags`
`SelAlpha`	See `GetSelAlpha` and `SetSelAlpha`
`SelEOLFilled`	See `GetSelEOLFilled` and `SetSelEOLFilled`
`SelectedText`	See `GetSelectedText`
`SelectedTextRaw`	See `GetSelectedTextRaw`
`SelectionEmpty`	See `GetSelectionEmpty`
`SelectionEnd`	See `GetSelectionEnd` and `SetSelectionEnd`
`SelectionMode`	See `GetSelectionMode` and `SetSelectionMode`
`SelectionStart`	See `GetSelectionStart` and `SetSelectionStart`
`Selections`	See `GetSelections`
`Status`	See `GetStatus` and `SetStatus`
`StringSelection`	See `GetStringSelection`
`StyleBits`	See `GetStyleBits` and `SetStyleBits`
`StyleBitsNeeded`	See `GetStyleBitsNeeded`
`SubStyleBases`	See `GetSubStyleBases`
`TabDrawMode`	See `GetTabDrawMode` and `SetTabDrawMode`
`TabIndents`	See `GetTabIndents` and `SetTabIndents`
`TabWidth`	See `GetTabWidth` and `SetTabWidth`
`TargetEnd`	See `GetTargetEnd` and `SetTargetEnd`
`TargetStart`	See `GetTargetStart` and `SetTargetStart`
`TargetText`	See `GetTargetText`
`TargetTextRaw`	See `GetTargetTextRaw`
`Technology`	See `GetTechnology` and `SetTechnology`
`Text`	See `GetText` and `SetText`
`TextLength`	See `GetTextLength`
`TextRaw`	See `GetTextRaw` and `SetTextRaw`
`TwoPhaseDraw`	See `GetTwoPhaseDraw` and `SetTwoPhaseDraw`
`UndoCollection`	See `GetUndoCollection` and `SetUndoCollection`
`UseAntiAliasing`	See `GetUseAntiAliasing` and `SetUseAntiAliasing`
`UseHorizontalScrollBar`	See `GetUseHorizontalScrollBar` and `SetUseHorizontalScrollBar`
`UseTabs`	See `GetUseTabs` and `SetUseTabs`
`UseVerticalScrollBar`	See `GetUseVerticalScrollBar` and `SetUseVerticalScrollBar`
`Value`	See `GetValue` and `SetValue`
`ViewEOL`	See `GetViewEOL` and `SetViewEOL`
`ViewWhiteSpace`	See `GetViewWhiteSpace` and `SetViewWhiteSpace`
`VirtualSpaceOptions`	See `GetVirtualSpaceOptions` and `SetVirtualSpaceOptions`
`WhitespaceChars`	See `GetWhitespaceChars` and `SetWhitespaceChars`
`WhitespaceSize`	See `GetWhitespaceSize` and `SetWhitespaceSize`
`WordChars`	See `GetWordChars` and `SetWordChars`
`WrapIndentMode`	See `GetWrapIndentMode` and `SetWrapIndentMode`
`WrapMode`	See `GetWrapMode` and `SetWrapMode`
`WrapStartIndent`	See `GetWrapStartIndent` and `SetWrapStartIndent`
`WrapVisualFlags`	See `GetWrapVisualFlags` and `SetWrapVisualFlags`
`WrapVisualFlagsLocation`	See `GetWrapVisualFlagsLocation` and `SetWrapVisualFlagsLocation`
`XOffset`	See `GetXOffset` and `SetXOffset`
`Zoom`	See `GetZoom` and `SetZoom`

Class API¶

class wx.stc.StyledTextCtrl(Control)¶

Possible constructors:

StyledTextCtrl(parent : Window, id: int=ID_ANY, pos:
               Point=DefaultPosition, size: Size=DefaultSize, style: int=0, name:
               str=STCNameStr) -> None

StyledTextCtrl() -> None

A wxWidgets implementation of the Scintilla source code editing component.

Methods¶

__init__(self, *args, **kw)¶

Overloaded Implementations:

__init__ (self, parent : Window, id: int=ID_ANY, pos: Point=DefaultPosition, size: Size=DefaultSize, style: int=0, name: str=STCNameStr)

Ctor.

Parameters:

parent (wx.Window)
id (wx.WindowID)
pos (wx.Point)
size (wx.Size)
style (long)
name (string)

Return type:

None

__init__ (self)

Default constructor.

Return type:: None

AddRefDocument(self, docPointer: Any)¶

Extend life of document.

Parameters:: docPointer
Return type:: None

AddSelection(self, caret: int, anchor: int)¶

Add a selection.

Parameters:

caret (int)
anchor (int)

Return type:

int

AddStyledText(self, data: MemoryBuffer)¶

Add array of cells to document.

Parameters:: data (MemoryBuffer)
Return type:: None

AddTabStop(self, line: int, x: int)¶

Add an explicit tab stop for a line.

Parameters:

line (int)
x (int)

Return type:

None

Added in version 4.1/wxWidgets-3.1.0.

AddText(self, text: str)¶

Add text to the document at current position.

Parameters:: text (string)
Return type:: None

AddTextRaw(self, text: str, length: int = -1)¶

Add text to the document at current position.

Parameters:

text (int)
length (int)

Return type:

None

AddUndoAction(self, token: int, flags: int)¶

Add a container action to the undo stack.

The flags argument can be either 0 or wx.stc.STC_UNDO_MAY_COALESCE.

Parameters:

token (int)
flags (int)

Return type:

None

Allocate(self, bytes: int)¶

Enlarge the document to a particular size of text bytes.

Parameters:: bytes (int)
Return type:: None

AllocateExtendedStyles(self, numberStyles: int)¶

Allocate some extended (>255) style numbers and return the start of the range.

Parameters:: numberStyles (int)
Return type:: int

Added in version 4.1/wxWidgets-3.1.0.

AllocateSubStyles(self, styleBase: int, numberStyles: int)¶

Allocate a set of sub styles for a particular base style, returning start of range.

Parameters:

styleBase (int)
numberStyles (int)

Return type:

int

Added in version 4.1/wxWidgets-3.1.0.

AnnotationClearAll(self)¶

Clear the annotations from all lines.

Return type:: None

AnnotationClearLine(self, line: int)¶

Clear annotations from the given line.

Parameters:: line (int)
Return type:: None

AnnotationGetLines(self, line: int)¶

Get the number of annotation lines for a line.

Parameters:: line (int)
Return type:: int

AnnotationGetStyle(self, line: int)¶

Get the style number for the annotations for a line.

Parameters:: line (int)
Return type:: int

AnnotationGetStyleOffset(self)¶

Get the start of the range of style numbers used for annotations.

Return type:: int

AnnotationGetStyles(self, line: int)¶

Get the annotation styles for a line.

Parameters:: line (int)
Return type:: str

AnnotationGetText(self, line: int)¶

Get the annotation text for a line.

Parameters:: line (int)
Return type:: str

AnnotationGetVisible(self)¶

Get the visibility for the annotations for a view.

The return value will be one of the STC_ANNOTATION_* constants.

Return type:: int

AnnotationSetStyle(self, line: int, style: int)¶

Set the style number for the annotations for a line.

Parameters:

line (int)
style (int)

Return type:

None

AnnotationSetStyleOffset(self, style: int)¶

Get the start of the range of style numbers used for annotations.

Parameters:: style (int)
Return type:: None

AnnotationSetStyles(self, line: int, styles: str)¶

Set the annotation styles for a line.

Parameters:

line (int)
styles (string)

Return type:

None

AnnotationSetText(self, line: int, text: str)¶

Set the annotation text for a line.

Parameters:

line (int)
text (string)

Return type:

None

AnnotationSetVisible(self, visible: int)¶

Set the visibility for the annotations for a view.

The input should be one of the STC_ANNOTATION_* constants.

Parameters:: visible (int)
Return type:: None

AppendText(self, text: str)¶

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

Parameters:: text (string)
Return type:: None

AppendTextRaw(self, text: str, length: int = -1)¶

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

Parameters:

text (int)
length (int)

Return type:

None

AutoCompActive(self)¶

Is there an auto-completion list visible?

Return type:: bool

AutoCompCancel(self)¶

Remove the auto-completion list from the screen.

Return type:: None

AutoCompComplete(self)¶

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

Return type:: None

AutoCompGetAutoHide(self)¶

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

Return type:: bool

AutoCompGetCancelAtStart(self)¶

Retrieve whether auto-completion cancelled by backspacing before start.

Return type:: bool

AutoCompGetCaseInsensitiveBehaviour(self)¶

Get auto-completion case insensitive behaviour.

The return value will be one of the STC_CASEINSENSITIVEBEHAVIOUR_* constants.

Return type:: int

AutoCompGetChooseSingle(self)¶

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

Return type:: bool

AutoCompGetCurrent(self)¶

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

Return type:: int

AutoCompGetCurrentText(self)¶

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

Return type:: str

Added in version 4.1/wxWidgets-3.1.1.

AutoCompGetDropRestOfWord(self)¶

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

Return type:: bool

AutoCompGetIgnoreCase(self)¶

Retrieve state of ignore case flag.

Return type:: bool

AutoCompGetMaxHeight(self)¶

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

Return type:: int

AutoCompGetMaxWidth(self)¶

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

Return type:: int

AutoCompGetMulti(self)¶

Retrieve the effect of autocompleting when there are multiple selections.

The return value will be one of the STC_MULTIAUTOC_* constants.

Return type:: int

Added in version 4.1/wxWidgets-3.1.0.

AutoCompGetOrder(self)¶

Get the way autocompletion lists are ordered.

The return value will be one of the STC_ORDER_* constants.

Return type:: int

Added in version 4.1/wxWidgets-3.1.0.

AutoCompGetSeparator(self)¶

Retrieve the auto-completion list separator character.

Return type:: int

AutoCompGetTypeSeparator(self)¶

Retrieve the auto-completion list type-separator character.

Return type:: int

AutoCompPosStart(self)¶

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

Return type:: int

AutoCompSelect(self, select: str)¶

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

Parameters:: select (string)
Return type:: None

AutoCompSetAutoHide(self, autoHide: bool)¶

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

Parameters:: autoHide (bool)
Return type:: None

AutoCompSetCancelAtStart(self, cancel: bool)¶

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

Parameters:: cancel (bool)
Return type:: None

AutoCompSetCaseInsensitiveBehaviour(self, behaviour: int)¶

Set auto-completion case insensitive behaviour to either prefer case-sensitive matches or have no preference.

The input should be one of the STC_CASEINSENSITIVEBEHAVIOUR_* constants.

Parameters:: behaviour (int)
Return type:: None

AutoCompSetChooseSingle(self, chooseSingle: bool)¶

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

Parameters:: chooseSingle (bool)
Return type:: None

AutoCompSetDropRestOfWord(self, dropRestOfWord: bool)¶

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

Parameters:: dropRestOfWord (bool)
Return type:: None

AutoCompSetFillUps(self, characterSet: str)¶

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

Parameters:: characterSet (string)
Return type:: None

AutoCompSetIgnoreCase(self, ignoreCase: bool)¶

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

Parameters:: ignoreCase (bool)
Return type:: None

AutoCompSetMaxHeight(self, rowCount: int)¶

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

The default is 5 rows.

Parameters:: rowCount (int)
Return type:: None

AutoCompSetMaxWidth(self, characterCount: int)¶

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.

Parameters:: characterCount (int)
Return type:: None

AutoCompSetMulti(self, multi: int)¶

Change the effect of autocompleting when there are multiple selections.

The input should be one of the STC_MULTIAUTOC_* constants.

Parameters:: multi (int)
Return type:: None

Added in version 4.1/wxWidgets-3.1.0.

AutoCompSetOrder(self, order: int)¶

Set the way autocompletion lists are ordered.

The input should be one of the STC_ORDER_* constants.

Parameters:: order (int)
Return type:: None

Added in version 4.1/wxWidgets-3.1.0.

AutoCompSetSeparator(self, separatorCharacter: int)¶

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

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

Parameters:: separatorCharacter (int)
Return type:: None

AutoCompSetTypeSeparator(self, separatorCharacter: int)¶

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

Default is ‘?’ but can be changed if items contain ‘?’.

Parameters:: separatorCharacter (int)
Return type:: None

AutoCompShow(self, lengthEntered: int, itemList: str)¶

Display an auto-completion list.

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

Parameters:

lengthEntered (int)
itemList (string)

Return type:

None

AutoCompStops(self, characterSet: str)¶

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

Parameters:: characterSet (string)
Return type:: None

AutoComplete(self, *args, **kw)¶

Overloaded Implementations:

AutoComplete (self, choices : List[str])

Call this function to enable auto-completion of the text typed in a single-line text control using the given choices.

Parameters:: choices (list of strings)
Return type:: bool
Returns:: True if the auto-completion was enabled or False if the operation failed, typically because auto-completion is not supported by the current platform.

Added in version 2.9.0.

See also

AutoCompleteFileNames

AutoComplete (self, completer : TextCompleter)

Enable auto-completion using the provided completer object.

This method should be used instead of AutoComplete overload taking the array of possible completions if the total number of strings is too big as it allows returning the completions dynamically, depending on the text already entered by user and so is more efficient.

The specified completer object will be used to retrieve the list of possible completions for the already entered text and will be deleted by wx.TextEntry itself when it’s not needed any longer.

Notice that you need to include /textcompleter.h in order to define your class inheriting from wx.TextCompleter.

Parameters:: completer (wx.TextCompleter) – The object to be used for generating completions if not None. If it is None, auto-completion is disabled. The wx.TextEntry object takes ownership of this pointer and will delete it in any case (i.e. even if this method returns False).
Return type:: bool
Returns:: True if the auto-completion was enabled or False if the operation failed, typically because auto-completion is not supported by the current platform.

Added in version 2.9.2.

See also

wx.TextCompleter

AutoCompleteDirectories(self)¶

Call this function to enable auto-completion of the text using the file system directories.

Unlike AutoCompleteFileNames which completes both file names and directories, this function only completes the directory names.

Notice that currently this function is only implemented in wxMSW port and does nothing under the other platforms.

Return type:: bool
Returns:: True if the auto-completion was enabled or False if the operation failed, typically because auto-completion is not supported by the current platform.

Added in version 2.9.3.

See also

AutoComplete

AutoCompleteFileNames(self)¶

Call this function to enable auto-completion of the text typed in a single-line text control using all valid file system paths.

Notice that currently this function is only implemented in wxMSW port and does nothing under the other platforms.

Return type:: bool
Returns:: True if the auto-completion was enabled or False if the operation failed, typically because auto-completion is not supported by the current platform.

Added in version 2.9.0.

See also

AutoComplete

BackTab(self)¶

Dedent the selected lines.

Return type:: None

BeginUndoAction(self)¶

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

May be nested.

Return type:: None

BraceBadLight(self, pos: int)¶

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

Parameters:: pos (int)
Return type:: None

BraceBadLightIndicator(self, useSetting: bool, indicator: int)¶

Use specified indicator to highlight non matching brace instead of changing its style.

Parameters:

useSetting (bool)
indicator (int)

Return type:

None

BraceHighlight(self, posA: int, posB: int)¶

Highlight the characters at two positions.

Parameters:

posA (int)
posB (int)

Return type:

None

BraceHighlightIndicator(self, useSetting: bool, indicator: int)¶

Use specified indicator to highlight matching braces instead of changing their style.

Parameters:

useSetting (bool)
indicator (int)

Return type:

None

BraceMatch(self, pos: int, maxReStyle: int = 0)¶

Find the position of a matching brace or wx.stc.STC_INVALID_POSITION if no match.

The maxReStyle must be 0 for now. It may be defined in a future release.

Parameters:

pos (int)
maxReStyle (int)

Return type:

int

CallTipActive(self)¶

Is there an active call tip?

Return type:: bool

CallTipCancel(self)¶

Remove the call tip from the screen.

Return type:: None

CallTipPosAtStart(self)¶

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

Return type:: int

Added in version 4.1/wxWidgets-3.1.0.

CallTipSetBackground(self, back: Colour)¶

Set the background colour for the call tip.

Parameters:: back (wx.Colour)
Return type:: None

CallTipSetForeground(self, fore: Colour)¶

Set the foreground colour for the call tip.

Parameters:: fore (wx.Colour)
Return type:: None

CallTipSetForegroundHighlight(self, fore: Colour)¶

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

Parameters:: fore (wx.Colour)
Return type:: None

CallTipSetHighlight(self, highlightStart: int, highlightEnd: int)¶

Highlight a segment of the definition.

Parameters:

highlightStart (int)
highlightEnd (int)

Return type:

None

CallTipSetPosAtStart(self, posStart: int)¶

Set the start position in order to change when backspacing removes the calltip.

Parameters:: posStart (int)
Return type:: None

CallTipSetPosition(self, above: bool)¶

Set position of calltip, above or below text.

Parameters:: above (bool)
Return type:: None

CallTipShow(self, pos: int, definition: str)¶

Show a call tip containing a definition near position pos.

Parameters:

pos (int)
definition (string)

Return type:

None

CallTipUseStyle(self, tabSize: int)¶

Enable use of wx.stc.STC_STYLE_CALLTIP and set call tip tab size in pixels.

Parameters:: tabSize (int)
Return type:: None

CanCopy(self)¶

Returns True if the selection can be copied to the clipboard.

Return type:: bool

CanCut(self)¶

Returns True if the selection can be cut to the clipboard.

Return type:: bool

CanPaste(self)¶

Will a paste succeed?

Return type:: bool

CanRedo(self)¶

Are there any redoable actions in the undo history?

Return type:: bool

CanUndo(self)¶

Are there any undoable actions in the undo history?

Return type:: bool

Cancel(self)¶

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

Return type:: None

ChangeInsertion(self, length: int, text: str)¶

Change the text that is being inserted in response to wx.stc.STC_MOD_INSERTCHECK.

Parameters:

length (int)
text (string)

Return type:

None

Added in version 4.1/wxWidgets-3.1.0.

ChangeLexerState(self, start: int, end: int)¶

Indicate that the internal state of a lexer has changed over a range and therefore there may be a need to redraw.

Parameters:

start (int)
end (int)

Return type:

int

ChangeValue(self, value: str)¶

Sets the new text control value.

It also marks the control as not-modified which means that IsModified() would return False immediately after the call to ChangeValue .

The insertion point is set to the start of the control (i.e. position 0) by this function.

This functions does not generate the wxEVT_TEXT event but otherwise is identical to SetValue .

See User Generated Events vs Programmatically Generated Events for more information.

Parameters:: value (string) – The new value to set. It may contain newline characters if the text control is multi-line.
Return type:: None

Added in version 2.7.1.

CharLeft(self)¶

Move caret left one character.

Return type:: None

CharLeftExtend(self)¶

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

Return type:: None

CharLeftRectExtend(self)¶

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

Return type:: None

CharPositionFromPoint(self, x: int, y: int)¶

Find the position of a character from a point within the window.

Parameters:

x (int)
y (int)

Return type:

int

CharPositionFromPointClose(self, x: int, y: int)¶

Find the position of a character from a point within the window.

Return wx.stc.STC_INVALID_POSITION if not close to text.

Parameters:

x (int)
y (int)

Return type:

int

CharRight(self)¶

Move caret right one character.

Return type:: None

CharRightExtend(self)¶

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

Return type:: None

CharRightRectExtend(self)¶

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

Return type:: None

ChooseCaretX(self)¶

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

Return type:: None

Clear(self)¶

Clear the selection.

Return type:: None

ClearAll(self)¶

Delete all text in the document.

Return type:: None

ClearDocumentStyle(self)¶

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

Return type:: None

ClearRegisteredImages(self)¶

Clear all the registered images.

Return type:: None

ClearRepresentation(self, encodedCharacter: str)¶

Remove a character representation.

Parameters:: encodedCharacter (string)
Return type:: None

Added in version 4.1/wxWidgets-3.1.0.

ClearSelections(self)¶

Clear selections to a single empty stream selection.

Return type:: None

ClearTabStops(self, line: int)¶

Clear explicit tabstops on a line.

Parameters:: line (int)
Return type:: None

Added in version 4.1/wxWidgets-3.1.0.

CmdKeyAssign(self, key: int, modifiers: int, cmd: int)¶

When key+modifier combination keyDefinition is pressed perform sciCommand.

The second argument should be a bit list containing one or more of the STC_KEYMOD_* constants and the third argument should be one of the STC_CMD_* constants.

Parameters:

key (int)
modifiers (int)
cmd (int)

Return type:

None

CmdKeyClear(self, key: int, modifiers: int)¶

When key+modifier combination keyDefinition is pressed do nothing.

The second argument should be a bit list containing one or more of the STC_KEYMOD_* constants.

Parameters:

key (int)
modifiers (int)

Return type:

None

CmdKeyClearAll(self)¶

Drop all key mappings.

Return type:: None

CmdKeyExecute(self, cmd: int)¶

Perform one of the operations defined by the STC_CMD_ constants.

Parameters:: cmd (int)
Return type:: None

Colourise(self, start: int, end: int)¶

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

Parameters:

start (int)
end (int)

Return type:

None

ContractedFoldNext(self, lineStart: int)¶

Find the next line at or after lineStart that is a contracted fold header line.

Return -1 when no more lines.

Parameters:: lineStart (int)
Return type:: int

ConvertEOLs(self, eolMode: int)¶

Convert all line endings in the document to one mode.

Parameters:: eolMode (int)
Return type:: None

Copy(self)¶

Copy the selection to the clipboard.

Return type:: None

CopyAllowLine(self)¶

Copy the selection, if selection empty copy the line with the caret.

Return type:: None

CopyRange(self, start: int, end: int)¶

Copy a range of text to the clipboard.

Positions are clipped into the document.

Parameters:

start (int)
end (int)

Return type:

None

CopyText(self, length: int, text: str)¶

Copy argument text to the clipboard.

Parameters:

length (int)
text (string)

Return type:

None

CountCharacters(self, start: int, end: int)¶

Count characters between two positions.

Parameters:

start (int)
end (int)

Return type:

int

Create(self, parent: Window, id: int = ID_ANY, pos: Point = DefaultPosition, size: Size = DefaultSize, style: int = 0, name: str = STCNameStr)¶

Create the UI elements for a STC that was created with the default constructor.

(For 2-phase create.)

Parameters:

parent (wx.Window)
id (wx.WindowID)
pos (wx.Point)
size (wx.Size)
style (long)
name (string)

Return type:

bool

CreateDocument(self)¶

Create a new document object.

Starts with reference count of 1 and not selected into editor.

Return type:: Any

CreateLoader(self, bytes: int)¶

Create an ILoader.

Parameters:: bytes (int)
Return type:: Any

Cut(self)¶

Cut the selection to the clipboard.

Return type:: None

DelLineLeft(self)¶

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

Return type:: None

DelLineRight(self)¶

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

Return type:: None

DelWordLeft(self)¶

Delete the word to the left of the caret.

Return type:: None

DelWordRight(self)¶

Delete the word to the right of the caret.

Return type:: None

DelWordRightEnd(self)¶

Delete the word to the right of the caret, but not the trailing non-word characters.

Return type:: None

DeleteBack(self)¶

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

Return type:: None

DeleteBackNotLine(self)¶

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

Will not delete the character before at the start of a line.

Return type:: None

DeleteRange(self, start: int, lengthDelete: int)¶

Delete a range of text in the document.

Parameters:

start (int)
lengthDelete (int)

Return type:

None

DescribeKeyWordSets(self)¶

Retrieve a ‘\n’ separated list of descriptions of the keyword sets understood by the current lexer.

Return type:: str

DescribeProperty(self, name: str)¶

Describe a property.

Parameters:: name (string)
Return type:: str

DiscardEdits(self)¶

Resets the internal modified flag as if the current changes had been saved.

Return type:: None

DistanceToSecondaryStyles(self)¶

Where styles are duplicated by a feature such as active/inactive code return the distance between the two types.

Return type:: int

Added in version 4.1/wxWidgets-3.1.0.

DoDragEnter(self, x: int, y: int, defaultRes: DragResult)¶

Allow for simulating a DnD DragEnter.

Parameters:

x (int)
y (int)
defaultRes (DragResult)

Return type:

wx.DragResult

Added in version 4.1/wxWidgets-3.1.0.

DoDragLeave(self)¶

Allow for simulating a DnD DragLeave.

Return type:: None

Added in version 4.1/wxWidgets-3.1.0.

DoDragOver(self, x: int, y: int, defaultRes: DragResult)¶

Allow for simulating a DnD DragOver.

Parameters:

x (int)
y (int)
defaultRes (DragResult)

Return type:

wx.DragResult

DoDropText(self, x: int, y: int, data: str)¶

Allow for simulating a DnD DropText.

Parameters:

x (long)
y (long)
data (string)

Return type:

bool

DocLineFromVisible(self, displayLine: int)¶

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

Parameters:: displayLine (int)
Return type:: int

DocumentEnd(self)¶

Move caret to last position in document.

Return type:: None

DocumentEndExtend(self)¶

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

Return type:: None

DocumentStart(self)¶

Move caret to first position in document.

Return type:: None

DocumentStartExtend(self)¶

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

Return type:: None

DropSelectionN(self, selection: int)¶

Drop one selection.

Parameters:: selection (int)
Return type:: None

Added in version 4.1/wxWidgets-3.1.0.

EditToggleOvertype(self)¶

Switch from insert to overtype mode or the reverse.

Return type:: None

EmptyUndoBuffer(self)¶

Delete the undo history.

Return type:: None

EndUndoAction(self)¶

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

Return type:: None

EnsureCaretVisible(self)¶

Ensure the caret is visible.

Return type:: None

EnsureVisible(self, line: int)¶

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

Parameters:: line (int)
Return type:: None

EnsureVisibleEnforcePolicy(self, line: int)¶

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.

Parameters:: line (int)
Return type:: None

ExpandChildren(self, line: int, level: int)¶

Expand a fold header and all children.

Use the level argument instead of the line’s current level.

Parameters:

line (int)
level (int)

Return type:

None

Added in version 4.1/wxWidgets-3.1.0.

FindColumn(self, line: int, column: int)¶

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.

Parameters:

line (int)
column (int)

Return type:

int

FindText(self, minPos: int, maxPos: int, text: str, flags: int = 0)¶

Find some text in the document.

Parameters:

minPos (int) – The position (starting from zero) in the document at which to begin the search
maxPos (int) – The last position (starting from zero) in the document to which the search will be restricted.
text (string) – The text to search for.
flags (int) – (Optional) The search flags. This should be a bit list containing one or more of the STC_FIND_* constants.

Return type:

Tuple[int, int]

Returns:

The position (starting from zero) in the document at which the text was found or wx.stc.STC_INVALID_POSITION if the search fails.

Note

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

FoldAll(self, action: int)¶

Expand or contract all fold headers.

The input should be one of the STC_FOLDACTION_* constants.

Parameters:: action (int)
Return type:: None

Added in version 4.1/wxWidgets-3.1.0.

FoldChildren(self, line: int, action: int)¶

Expand or contract a fold header and its children.

The second argument should be one of the STC_FOLDACTION_* constants.

Parameters:

line (int)
action (int)

Return type:

None

Added in version 4.1/wxWidgets-3.1.0.

FoldDisplayTextSetStyle(self, style: int)¶

Set the style of fold display text.

The input should be one of the STC_FOLDDISPLAYTEXT_* constants.

Parameters:: style (int)
Return type:: None

Added in version 4.1/wxWidgets-3.1.1.

FoldLine(self, line: int, action: int)¶

Expand or contract a fold header.

The second argument should be one of the STC_FOLDACTION_* constants.

Parameters:

line (int)
action (int)

Return type:

None

Added in version 4.1/wxWidgets-3.1.0.

ForceUpper(self)¶

Convert all text entered into the control to upper case.

Call this method to ensure that all text entered into the control is converted on the fly to upper case. If the control is not empty, its existing contents is also converted to upper case.

Return type:: None

Added in version 4.1/wxWidgets-3.1.0.

FormFeed(self)¶

Insert a Form Feed character.

Return type:: None

FormatRange(self, doDraw: bool, startPos: int, endPos: int, draw: DC, target: DC, renderRect: Rect, pageRect: Rect)¶

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

Parameters:

doDraw (bool)
startPos (int)
endPos (int)
draw (wx.DC)
target (wx.DC)
renderRect (wx.Rect)
pageRect (wx.Rect)

Return type:

int

FreeSubStyles(self)¶

Free allocated sub styles.

Return type:: None

Added in version 4.1/wxWidgets-3.1.0.

GetAdditionalCaretForeground(self)¶

Get the foreground colour of additional carets.

Return type:: wx.Colour

GetAdditionalCaretsBlink(self)¶

Whether additional carets will blink.

Return type:: bool

GetAdditionalCaretsVisible(self)¶

Whether additional carets are visible.

Return type:: bool

GetAdditionalSelAlpha(self)¶

Get the alpha of the selection.

Return type:: int

GetAdditionalSelectionTyping(self)¶

Whether typing can be performed into multiple selections.

Return type:: bool

GetAllLinesVisible(self)¶

Are all lines visible?

Return type:: bool

GetAnchor(self)¶

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

Return type:: int

GetAutomaticFold(self)¶

Get automatic folding behaviours.

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

Return type:: int

Added in version 4.1/wxWidgets-3.1.0.

GetBackSpaceUnIndents(self)¶

Does a backspace pressed when caret is within indentation unindent?

Return type:: bool

GetBufferedDraw(self)¶

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

Return type:: bool

GetCaretForeground(self)¶

Get the foreground colour of the caret.

Return type:: wx.Colour

GetCaretLineBackAlpha(self)¶

Get the background alpha of the caret line.

Return type:: int

GetCaretLineBackground(self)¶

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

Return type:: wx.Colour

GetCaretLineVisible(self)¶

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

Return type:: bool

GetCaretLineVisibleAlways(self)¶

Is the caret line always visible?

Return type:: bool

Added in version 4.1/wxWidgets-3.1.0.

GetCaretPeriod(self)¶

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

Return type:: int

GetCaretSticky(self)¶

Can the caret preferred x position only be changed by explicit movement commands?

The return value will be one of the STC_CARETSTICKY_* constants.

Return type:: int

GetCaretStyle(self)¶

Returns the current style of the caret.

The return value will be one of the STC_CARETSTYLE_* constants.

Return type:: int

GetCaretWidth(self)¶

Returns the width of the insert mode caret.

Return type:: int

GetCharAt(self, pos: int)¶

Returns the character byte at the position.

Parameters:: pos (int)
Return type:: int

GetCharacterPointer(self)¶

Compact the document buffer and return a read-only memoryview object of the characters in the document.

Return type:: Any

static GetClassDefaultAttributes(variant: WindowVariant = WINDOW_VARIANT_NORMAL)¶

Parameters:: variant (WindowVariant)
Return type:: wx.VisualAttributes

GetCodePage(self)¶

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

Return type:: int

GetColumn(self, pos: int)¶

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

Parameters:: pos (int)
Return type:: int

GetControlCharSymbol(self)¶

Get the way control characters are displayed.

Return type:: int

GetCurLine(self)¶

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.

Return type:: Tuple[str, int]

GetCurLineRaw(self)¶

Retrieve the text of the line containing the caret.

Returns the index of the caret on the line.

Return type:: Tuple[CharBuffer, int]

GetCurrentLine(self)¶

Returns the line number of the line with the caret.

Return type:: int

GetCurrentPos(self)¶

Returns the position of the caret.

Return type:: int

GetDefaultStyle(self)¶

Returns the style currently used for the new text.

Return type:: wx.TextAttr

See also

SetDefaultStyle

GetDirectFunction(self)¶

Retrieve a pointer to a function that processes messages for this Scintilla.

Return type:: Any

Added in version 4.1/wxWidgets-3.1.1.

GetDirectPointer(self)¶

Retrieve a pointer value to use as the first argument when calling the function returned by GetDirectFunction.

Return type:: Any

Added in version 4.1/wxWidgets-3.1.1.

GetDocPointer(self)¶

Retrieve a pointer to the document object.

Return type:: Any

GetEOLMode(self)¶

Retrieve the current end of line mode - one of wx.stc.STC_EOL_CRLF, wx.stc.STC_EOL_CR, or wx.stc.STC_EOL_LF.

Return type:: int

GetEdgeColour(self)¶

Retrieve the colour used in edge indication.

Return type:: wx.Colour

GetEdgeColumn(self)¶

Retrieve the column number which text should be kept within.

Return type:: int

GetEdgeMode(self)¶

Retrieve the edge highlight mode.

The return value will be one of the STC_EDGE_* constants.

Return type:: int

GetEndAtLastLine(self)¶

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

Return type:: bool

GetEndStyled(self)¶

Retrieve the position of the last correctly styled character.

Return type:: int

GetExtraAscent(self)¶

Get extra ascent for each line.

Return type:: int

GetExtraDescent(self)¶

Get extra descent for each line.

Return type:: int

GetFirstVisibleLine(self)¶

Retrieve the display line at the top of the display.

Return type:: int

GetFoldExpanded(self, line: int)¶

Is a header line expanded?

Parameters:: line (int)
Return type:: bool

GetFoldLevel(self, line: int)¶

Retrieve the fold level of a line.

Parameters:: line (int)
Return type:: int

GetFoldParent(self, line: int)¶

Find the parent line of a child line.

Parameters:: line (int)
Return type:: int

GetFontQuality(self)¶

Retrieve the quality level for text.

The return value will be one of the STC_EFF_QUALITY_* constants.

Return type:: int

Added in version 4.1/wxWidgets-3.1.1.

GetGapPosition(self)¶

Return a position which, to avoid performance costs, should not be within the range of a call to GetRangePointer.

Return type:: int

GetHighlightGuide(self)¶

Get the highlighted indentation guide column.

Return type:: int

GetHint(self)¶

Returns the current hint string.

See SetHint for more information about hints.

Return type:: str

Added in version 2.9.0.

GetHotspotActiveBackground(self)¶

Get the back colour for active hotspots.

Return type:: wx.Colour

GetHotspotActiveForeground(self)¶

Get the fore colour for active hotspots.

Return type:: wx.Colour

GetHotspotActiveUnderline(self)¶

Get whether underlining for active hotspots.

Return type:: bool

GetHotspotSingleLine(self)¶

Get the HotspotSingleLine property.

Return type:: bool

GetIMEInteraction(self)¶

Is the IME displayed in a window or inline?

The return value will be one of the STC_IME_* constants.

Return type:: int

Added in version 4.1/wxWidgets-3.1.0.

GetIdentifier(self)¶

Get the identifier.

Return type:: int

GetIdleStyling(self)¶

Retrieve the limits to idle styling.

The return value will be one of the STC_IDLESTYLING_* constants.

Return type:: int

Added in version 4.1/wxWidgets-3.1.1.

GetIndent(self)¶

Retrieve indentation size.

Return type:: int

GetIndentationGuides(self)¶

Are the indentation guides visible?

The return value will be one of the STC_IV_* constants.

Return type:: int

GetIndicatorCurrent(self)¶

Get the current indicator.

Return type:: int

GetIndicatorValue(self)¶

Get the current indicator value.

Return type:: int

GetInsertionPoint(self)¶

Returns the insertion point, or cursor, position.

This is defined as the zero based index of the character position to the right of the insertion point. For example, if the insertion point is at the end of the single-line text control, it is equal to GetLastPosition .

Notice that insertion position is, in general, different from the index of the character the cursor position at in the string returned by GetValue . While this is always the case for the single line controls, multi-line controls can use two characters "\\r\\n" as line separator (this is notably the case under MSW) meaning that indices in the control and its string value are offset by 1 for every line.

Hence to correctly get the character at the current cursor position, taking into account that there can be none if the cursor is at the end of the string, you could do the following:

def GetCurrentChar(self, text_ctrl):

    pos = text_ctrl.GetInsertionPoint()
    if pos == text_ctrl.GetLastPosition():
        return ''

    return text_ctrl.GetRange(pos, pos + 1)

Return type:: int

GetLastChild(self, line: int, level: int)¶

Find the last child line of a header line.

Parameters:

line (int)
level (int)

Return type:

int

GetLastKeydownProcessed(self)¶

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

Return type:: bool

GetLastPosition(self)¶

Returns the zero based index of the last position in the text control, which is equal to the number of characters in the control.

Return type:: int

GetLayoutCache(self)¶

Retrieve the degree of caching of layout information.

The return value will be one of the STC_CACHE_* constants.

Return type:: int

GetLength(self)¶

Returns the number of bytes in the document.

Return type:: int

GetLexer(self)¶

Retrieve the lexing language of the document.

The return value will be one of the STC_LEX_* constants.

Return type:: int

GetLexerLanguage(self)¶

Retrieve the lexing language of the document.

Return type:: str

Added in version 4.1/wxWidgets-3.1.1.

static GetLibraryVersionInfo()¶

Returns the version of the Scintilla library used by this control.

Return type:: wx.VersionInfo

GetLine(self, line: int)¶

Retrieve the contents of a line.

Parameters:: line (int)
Return type:: str

GetLineCount(self)¶

Returns the number of lines in the document.

There is always at least one.

Return type:: int

GetLineEndPosition(self, line: int)¶

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

Parameters:: line (int)
Return type:: int

GetLineEndTypesActive(self)¶

Get the line end types currently recognised.

May be a subset of the allowed types due to lexer limitation.

The return value will be one of the STC_LINE_END_TYPE_* constants.

Return type:: int

Added in version 4.1/wxWidgets-3.1.0.

GetLineEndTypesAllowed(self)¶

Get the line end types currently allowed.

The return value will be one of the STC_LINE_END_TYPE_* constants.

Return type:: int

Added in version 4.1/wxWidgets-3.1.0.

GetLineEndTypesSupported(self)¶

Bit set of LineEndType enumertion for which line ends beyond the standard LF, CR, and CRLF are supported by the lexer.

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

Return type:: int

Added in version 4.1/wxWidgets-3.1.0.

GetLineIndentPosition(self, line: int)¶

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

Parameters:: line (int)
Return type:: int

GetLineIndentation(self, line: int)¶

Retrieve the number of columns that a line is indented.

Parameters:: line (int)
Return type:: int

GetLineLength(self, lineNo: int)¶

Gets the length of the specified line, not including any trailing newline character(s).

Parameters:: lineNo (long) – Line number (starting from zero).
Return type:: int
Returns:: The length of the line, or -1 if lineNo was invalid.

GetLineRaw(self, line: int)¶

Retrieve the contents of a line.

Parameters:: line (int)
Return type:: CharBuffer

GetLineSelEndPosition(self, line: int)¶

Retrieve the position of the end of the selection at the given line (wx``wx.stc.STC_INVALID_POSITION`` if no selection on this line).

Parameters:: line (int)
Return type:: int

GetLineSelStartPosition(self, line: int)¶

Retrieve the position of the start of the selection at the given line (wx``wx.stc.STC_INVALID_POSITION`` if no selection on this line).

Parameters:: line (int)
Return type:: int

GetLineState(self, line: int)¶

Retrieve the extra styling information for a line.

Parameters:: line (int)
Return type:: int

GetLineText(self, lineNo: int)¶

Returns the contents of a given line in the text control, not including any trailing newline character(s).

Parameters:: lineNo (long) – The line number, starting from zero.
Return type:: str
Returns:: The contents of the line.

GetLineVisible(self, line: int)¶

Is a line visible?

Parameters:: line (int)
Return type:: bool

GetMainSelection(self)¶

Which selection is the main selection.

Return type:: int

GetMarginBackground(self, margin: int)¶

Retrieve the background colour of a margin.

Parameters:: margin (int)
Return type:: wx.Colour

Added in version 4.1/wxWidgets-3.1.1.

GetMarginCount(self)¶

How many margins are there?.

Return type:: int

Added in version 4.1/wxWidgets-3.1.1.

GetMarginCursor(self, margin: int)¶

Retrieve the cursor shown in a margin.

The return value will be one of the STC_CURSOR* constants.

Parameters:: margin (int)
Return type:: int

GetMarginLeft(self)¶

Returns the size in pixels of the left margin.

Return type:: int

GetMarginMask(self, margin: int)¶

Retrieve the marker mask of a margin.

Parameters:: margin (int)
Return type:: int

GetMarginOptions(self)¶

Get the margin options.

The return value will be one of the STC_MARGINOPTION_* constants.

Return type:: int

GetMarginRight(self)¶

Returns the size in pixels of the right margin.

Return type:: int

GetMarginSensitive(self, margin: int)¶

Retrieve the mouse click sensitivity of a margin.

Parameters:: margin (int)
Return type:: bool

GetMarginType(self, margin: int)¶

Retrieve the type of a margin.

The return value will be one of the STC_MARGIN_* constants.

Parameters:: margin (int)
Return type:: int

GetMarginWidth(self, margin: int)¶

Retrieve the width of a margin in pixels.

Parameters:: margin (int)
Return type:: int

GetMargins(self)¶

Returns the margins used by the control.

The x field of the returned point is the horizontal margin and the y field is the vertical one.

Return type:: wx.Point

Added in version 2.9.1.

Note

If given margin cannot be accurately determined, its value will be set to -1. On some platforms you cannot obtain valid margin values until you have called SetMargins .

See also

SetMargins

GetMarkerSymbolDefined(self, markerNumber: int)¶

Which symbol was defined for markerNumber with MarkerDefine.

The return value will be one of the STC_MARK_* constants.

Parameters:: markerNumber (int)
Return type:: int

GetMaxLineState(self)¶

Retrieve the last line number that has line state.

Return type:: int

GetModEventMask(self)¶

Get which document modification events are sent to the container.

The return value will wx.stc.STC_MODEVENTMASKALL if all changes generate events. Otherwise it will be a bit list containing one or more of the STC_MOD_* constants, the STC_PERFORMED_* constants, wx.stc.STC_STARTACTION, wx.stc.STC_MULTILINEUNDOREDO, wx.stc.STC_MULTISTEPUNDOREDO, and wx.stc.STC_LASTSTEPINUNDOREDO.

Return type:: int

GetModify(self)¶

Is the document different from when it was last saved?

Return type:: bool

GetMouseDownCaptures(self)¶

Get whether mouse gets captured.

Return type:: bool

GetMouseDwellTime(self)¶

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

The return value will be a time in milliseconds or wx.stc.STC_TIME_FOREVER.

Return type:: int

GetMouseSelectionRectangularSwitch(self)¶

Whether switching to rectangular mode while selecting with the mouse is allowed.

Return type:: bool

Added in version 4.1/wxWidgets-3.1.0.

GetMouseWheelCaptures(self)¶

Get whether mouse wheel can be active outside the window.

Return type:: bool

Added in version 4.1/wxWidgets-3.1.1.

GetMultiPaste(self)¶

Retrieve the effect of pasting when there are multiple selections.

The return value will be one of the STC_MULTIPASTE_* constants.

Return type:: int

GetMultipleSelection(self)¶

Whether multiple selections can be made.

Return type:: bool

GetNextTabStop(self, line: int, x: int)¶

Find the next explicit tab stop position on a line after a position.

Parameters:

line (int)
x (int)

Return type:

int

Added in version 4.1/wxWidgets-3.1.0.

GetNumberOfLines(self)¶

Returns the number of lines in the text control buffer.

The returned number is the number of logical lines, i.e. just the count of the number of newline characters in the control + 1, for wxGTK and OSX/Cocoa ports while it is the number of physical lines, i.e. the count of lines actually shown in the control, in wxMSW. Because of this discrepancy, it is not recommended to use this function.

Return type:: int

Note

Note that even empty text controls have one line (where the insertion point is), so GetNumberOfLines never returns 0.

GetOvertype(self)¶

Returns True if overtype mode is active otherwise False is returned.

Return type:: bool

GetPasteConvertEndings(self)¶

Get convert-on-paste setting.

Return type:: bool

GetPhasesDraw(self)¶

How many phases is drawing done in?

The return value will be one of the STC_PHASES_* constants.

Return type:: int

Added in version 4.1/wxWidgets-3.1.0.

GetPositionCacheSize(self)¶

How many entries are allocated to the position cache?

Return type:: int

GetPrimaryStyleFromStyle(self, style: int)¶

For a secondary style, return the primary style, else return the argument.

Parameters:: style (int)
Return type:: int

Added in version 4.1/wxWidgets-3.1.0.

GetPrintColourMode(self)¶

Returns the print colour mode.

The return value will be one of the STC_PRINT_* constants.

Return type:: int

GetPrintMagnification(self)¶

Returns the print magnification.

Return type:: int

GetPrintWrapMode(self)¶

Is printing line wrapped?

The return value will be one of the STC_WRAP_* constants.

Return type:: int

GetProperty(self, key: str)¶

Retrieve a “property” value previously set with SetProperty.

Parameters:: key (string)
Return type:: str

GetPropertyExpanded(self, key: str)¶

Retrieve a “property” value previously set with SetProperty, with “$()” variable replacement on returned buffer.

Parameters:: key (string)
Return type:: str

GetPropertyInt(self, key: str, defaultValue: int = 0)¶

Retrieve a “property” value previously set with SetProperty, interpreted as an int AFTER any “$()” variable replacement.

Parameters:

key (string)
defaultValue (int)

Return type:

int

GetPunctuationChars(self)¶

Get the set of characters making up punctuation characters.

Return type:: str

GetRange(self, from_: int, to_: int)¶

Returns the string containing the text starting in the positions from and up to to in the control.

The positions must have been returned by another wx.TextCtrl method. Please note that the positions in a multiline wx.TextCtrl do not correspond to the indices in the string returned by GetValue because of the different new line representations ( CR or CR LF) and so this method should be used to obtain the correct results instead of extracting parts of the entire value. It may also be more efficient, especially if the control contains a lot of data.

Parameters:

from_ (long)
to_ (long)

Return type:

str

GetRangePointer(self, position: int, rangeLength: int)¶

Return a read-only pointer to a range of characters in the document. May move the gap so that the range is contiguous, but will only move up to rangeLength bytes.

Return type:: Any

GetReadOnly(self)¶

In read-only mode?

Return type:: bool

GetRectangularSelectionAnchor(self)¶

Return the anchor position of the rectangular selection.

Return type:: int

GetRectangularSelectionAnchorVirtualSpace(self)¶

Return the virtual space of the anchor of the rectangular selection.

Return type:: int

GetRectangularSelectionCaret(self)¶

Return the caret position of the rectangular selection.

Return type:: int

GetRectangularSelectionCaretVirtualSpace(self)¶

Return the virtual space of the caret of the rectangular selection.

Return type:: int

GetRectangularSelectionModifier(self)¶

Get the modifier key used for rectangular selection.

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

Return type:: int

GetRepresentation(self, encodedCharacter: str)¶

Set the way a character is drawn.

Parameters:: encodedCharacter (string)
Return type:: str

Added in version 4.1/wxWidgets-3.1.0.

GetSTCCursor(self)¶

Get cursor type.

The return value will be one of the STC_CURSOR* constants.

Return type:: int

GetSTCFocus(self)¶

Get internal focus flag.

Return type:: bool

GetScrollWidth(self)¶

Retrieve the document width assumed for scrolling.

Return type:: int

GetScrollWidthTracking(self)¶

Retrieve whether the scroll width tracks wide lines.

Return type:: bool

GetSearchFlags(self)¶

Get the search flags used by SearchInTarget.

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

Return type:: int

GetSelAlpha(self)¶

Get the alpha of the selection.

Return type:: int

GetSelEOLFilled(self)¶

Is the selection end of line filled?

Return type:: bool

GetSelectedText(self)¶

Retrieve the selected text.

Return type:: str

GetSelectedTextRaw(self)¶

Retrieve the selected text.

Return type:: CharBuffer

GetSelection(self)¶

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 wx.TextCtrl methods but don’t necessarily represent the correct indices into the string returned by GetValue for multiline controls under Windows (at least,) you should use GetStringSelection to get the selected text.

The returned first position.

The returned last position.

Return type:: Tuple[int, int]

GetSelectionEmpty(self)¶

Is every selected range empty?

Return type:: bool

Added in version 4.1/wxWidgets-3.1.0.

GetSelectionEnd(self)¶

Returns the position at the end of the selection.

Return type:: int

GetSelectionMode(self)¶

Get the mode of the current selection.

The return value will be one of the STC_SEL_* constants.

Return type:: int

GetSelectionNAnchor(self, selection: int)¶

Return the anchor position of the nth selection.

Parameters:: selection (int)
Return type:: int

GetSelectionNAnchorVirtualSpace(self, selection: int)¶

Return the virtual space of the anchor of the nth selection.

Parameters:: selection (int)
Return type:: int

GetSelectionNCaret(self, selection: int)¶

Return the caret position of the nth selection.

Parameters:: selection (int)
Return type:: int

GetSelectionNCaretVirtualSpace(self, selection: int)¶

Return the virtual space of the caret of the nth selection.

Parameters:: selection (int)
Return type:: int

GetSelectionNEnd(self, selection: int)¶

Returns the position at the end of the selection.

Parameters:: selection (int)
Return type:: int

GetSelectionNStart(self, selection: int)¶

Returns the position at the start of the selection.

Parameters:: selection (int)
Return type:: int

GetSelectionStart(self)¶

Returns the position at the start of the selection.

Return type:: int

GetSelections(self)¶

How many selections are there?

Return type:: int

GetStatus(self)¶

Get error status.

The return value will be one of the STC_STATUS_* constants.

Return type:: int

GetStringSelection(self)¶

Gets the text currently selected in the control.

If there is no selection, the returned string is empty.

Return type:: str

GetStyle(self, position: int, style: TextAttr)¶

This method is inherited from TextAreaBase but is not implemented in wx.stc.StyledTextCtrl.

Parameters:

position (long)
style (wx.TextAttr)

Return type:

bool

GetStyleAt(self, pos: int)¶

Returns the style byte at the position.

Parameters:: pos (int)
Return type:: int

GetStyleBits(self)¶

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

Return type:: int

GetStyleBitsNeeded(self)¶

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

Return type:: int

GetStyleFromSubStyle(self, subStyle: int)¶

For a sub style, return the base style, else return the argument.

Parameters:: subStyle (int)
Return type:: int

Added in version 4.1/wxWidgets-3.1.0.

GetStyledText(self, startPos: int, endPos: int)¶

Retrieve a buffer of cells.

Parameters:

startPos (int)
endPos (int)

Return type:

MemoryBuffer

GetSubStyleBases(self)¶

Get the set of base styles that can be extended with sub styles.

Return type:: str

Added in version 4.1/wxWidgets-3.1.0.

GetSubStylesLength(self, styleBase: int)¶

The number of sub styles associated with a base style.

Parameters:: styleBase (int)
Return type:: int

Added in version 4.1/wxWidgets-3.1.0.

GetSubStylesStart(self, styleBase: int)¶

The starting style number for the sub styles associated with a base style.

Parameters:: styleBase (int)
Return type:: int

Added in version 4.1/wxWidgets-3.1.0.

GetTabDrawMode(self)¶

Retrieve the current tab draw mode.

Returns one of STC_TD_ constants.

Return type:: int

Added in version 4.1/wxWidgets-3.1.1.

GetTabIndents(self)¶

Does a tab pressed when caret is within indentation indent?

Return type:: bool

GetTabWidth(self)¶

Retrieve the visible size of a tab.

Return type:: int

GetTag(self, tagNumber: int)¶

Retrieve the value of a tag from a regular expression search.

Parameters:: tagNumber (int)
Return type:: str

GetTargetEnd(self)¶

Get the position that ends the target.

Return type:: int

GetTargetStart(self)¶

Get the position that starts the target.

Return type:: int

GetTargetText(self)¶

Retrieve the text in the target.

Return type:: str

Added in version 4.1/wxWidgets-3.1.0.

GetTargetTextRaw(self)¶

Retrieve the target text.

Return type:: CharBuffer

Added in version 4.1/wxWidgets-3.1.1.

GetTechnology(self)¶

Get the tech.

The return value will be one of the STC_TECHNOLOGY_* constants.

Return type:: int

GetText(self)¶

Retrieve all the text in the document.

Return type:: str

GetTextLength(self)¶

Retrieve the number of characters in the document.

Return type:: int

GetTextRange(self, startPos: int, endPos: int)¶

Retrieve a range of text.

Parameters:

startPos (int)
endPos (int)

Return type:

str

GetTextRangeRaw(self, startPos: int, endPos: int)¶

Retrieve a range of text.

Parameters:

startPos (int)
endPos (int)

Return type:

CharBuffer

GetTextRaw(self)¶

Retrieve all the text in the document.

Return type:: CharBuffer

GetTwoPhaseDraw(self)¶

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

Return type:: bool

GetUndoCollection(self)¶

Is undo history being collected?

Return type:: bool

GetUseAntiAliasing(self)¶

Returns the current UseAntiAliasing setting.

Return type:: bool

GetUseHorizontalScrollBar(self)¶

Is the horizontal scroll bar visible?

Return type:: bool

GetUseTabs(self)¶

Retrieve whether tabs will be used in indentation.

Return type:: bool

GetUseVerticalScrollBar(self)¶

Is the vertical scroll bar visible?

Return type:: bool

GetValue(self)¶

Gets the contents of the control.

Notice that for a multiline text control, the lines will be separated by (Unix-style) \n characters, even under Windows where they are separated by a \r\n sequence in the native control.

Return type:: str

GetViewEOL(self)¶

Are the end of line characters visible?

Return type:: bool

GetViewWhiteSpace(self)¶

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

Return type:: int

GetVirtualSpaceOptions(self)¶

Return options for virtual space behaviour.

The return value will be one of the STC_VS_* constants.

Return type:: int

GetWhitespaceChars(self)¶

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

Return type:: str

GetWhitespaceSize(self)¶

Get the size of the dots used to mark space characters.

Return type:: int

GetWordChars(self)¶

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

Return type:: str

GetWrapIndentMode(self)¶

Retrieve how wrapped sublines are placed.

Default is wx.stc.STC_WRAPINDENT_FIXED.

The return value will be one of the STC_WRAPINDENT_* constants.

Return type:: int

GetWrapMode(self)¶

Retrieve whether text is word wrapped.

The return value will be one of the STC_WRAP_* constants.

Return type:: int

GetWrapStartIndent(self)¶

Retrieve the start indent for wrapped lines.

Return type:: int

GetWrapVisualFlags(self)¶

Retrieve the display mode of visual flags for wrapped lines.

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

Return type:: int

GetWrapVisualFlagsLocation(self)¶

Retrieve the location of visual flags for wrapped lines.

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

Return type:: int

GetXOffset(self)¶

Get the xOffset (ie, horizontal scroll position).

Return type:: int

GetZoom(self)¶

Retrieve the zoom level.

Return type:: int

GotoLine(self, line: int)¶

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

Parameters:: line (int)
Return type:: None

GotoPos(self, caret: int)¶

Set caret to a position and ensure it is visible.

Parameters:: caret (int)
Return type:: None

HideLines(self, lineStart: int, lineEnd: int)¶

Make a range of lines invisible.

Parameters:

lineStart (int)
lineEnd (int)

Return type:

None

HideSelection(self, hide: bool)¶

Draw the selection in normal style or with selection highlighted.

Parameters:: hide (bool)
Return type:: None

HitTestPos(self, pt: Point)¶

Finds the position of the character at the specified point.

If the return code is not TE_HT_UNKNOWN the row and column of the character closest to this position are returned, otherwise the output parameters are not modified.

Please note that this function is currently only implemented in Univ, wxMSW and wxGTK2 ports and always returns TE_HT_UNKNOWN in the other ports.

HitTest(self, pt: Point)¶

Finds the row and column of the character at the specified point.

If the return code is not TE_HT_UNKNOWN the row and column of the character closest to this position are returned, otherwise the output parameters are not modified.

Please note that this function is currently only implemented in Univ, wxMSW and wxGTK2 ports and always returns TE_HT_UNKNOWN in the other ports.

Home(self)¶

Move caret to first position on line.

Return type:: None

HomeDisplay(self)¶

Move caret to first position on display line.

Return type:: None

HomeDisplayExtend(self)¶

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

Return type:: None

HomeExtend(self)¶

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

Return type:: None

HomeRectExtend(self)¶

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

Return type:: None

HomeWrap(self)¶

Like Home but when word-wrap is enabled goes first to start of display line HomeDisplay, then to start of document line Home.

Return type:: None

HomeWrapExtend(self)¶

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

Return type:: None

IndicatorAllOnFor(self, pos: int)¶

Are any indicators present at pos?

Parameters:: pos (int)
Return type:: int

IndicatorClearRange(self, start: int, lengthClear: int)¶

Turn an indicator off over a range.

Parameters:

start (int)
lengthClear (int)

Return type:

None

IndicatorEnd(self, indicator: int, pos: int)¶

Where does a particular indicator end?

Parameters:

indicator (int)
pos (int)

Return type:

int

IndicatorFillRange(self, start: int, lengthFill: int)¶

Turn an indicator on over a range.

Parameters:

start (int)
lengthFill (int)

Return type:

None

IndicatorGetAlpha(self, indicator: int)¶

Get the alpha fill colour of the given indicator.

Parameters:: indicator (int)
Return type:: int

IndicatorGetFlags(self, indicator: int)¶

Retrieve the attributes of an indicator.

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

Parameters:: indicator (int)
Return type:: int

Added in version 4.1/wxWidgets-3.1.0.

IndicatorGetForeground(self, indicator: int)¶

Retrieve the foreground colour of an indicator.

Parameters:: indicator (int)
Return type:: wx.Colour

IndicatorGetHoverForeground(self, indicator: int)¶

Retrieve the foreground hover colour of an indicator.

Parameters:: indicator (int)
Return type:: wx.Colour

Added in version 4.1/wxWidgets-3.1.0.

IndicatorGetHoverStyle(self, indicator: int)¶

Retrieve the hover style of an indicator.

Parameters:: indicator (int)
Return type:: int

Added in version 4.1/wxWidgets-3.1.0.

IndicatorGetOutlineAlpha(self, indicator: int)¶

Get the alpha outline colour of the given indicator.

Parameters:: indicator (int)
Return type:: int

IndicatorGetStyle(self, indicator: int)¶

Retrieve the style of an indicator.

The return value will be one of the STC_INDIC_* constants.

Parameters:: indicator (int)
Return type:: int

IndicatorGetUnder(self, indicator: int)¶

Retrieve whether indicator drawn under or over text.

Parameters:: indicator (int)
Return type:: bool

IndicatorSetAlpha(self, indicator: int, alpha: int)¶

Set the alpha fill colour of the given indicator.

Parameters:

indicator (int)
alpha (int)

Return type:

None

IndicatorSetFlags(self, indicator: int, flags: int)¶

Set the attributes of an indicator.

The second argument should be a bit list containing one or more of the STC_INDICFLAG_* constants.

Parameters:

indicator (int)
flags (int)

Return type:

None

Added in version 4.1/wxWidgets-3.1.0.

IndicatorSetForeground(self, indicator: int, fore: Colour)¶

Set the foreground colour of an indicator.

Parameters:

indicator (int)
fore (wx.Colour)

Return type:

None

IndicatorSetHoverForeground(self, indicator: int, fore: Colour)¶

Set the foreground hover colour of an indicator.

Parameters:

indicator (int)
fore (wx.Colour)

Return type:

None

Added in version 4.1/wxWidgets-3.1.0.

IndicatorSetHoverStyle(self, indicator: int, indicatorStyle: int)¶

Set a hover indicator to plain, squiggle or TT.

Parameters:

indicator (int)
indicatorStyle (int)

Return type:

None

Added in version 4.1/wxWidgets-3.1.0.

IndicatorSetOutlineAlpha(self, indicator: int, alpha: int)¶

Set the alpha outline colour of the given indicator.

Parameters:

indicator (int)
alpha (int)

Return type:

None

IndicatorSetStyle(self, indicator: int, indicatorStyle: int)¶

Set an indicator to plain, squiggle or TT.

The second argument should be one of the STC_INDIC_* constants.

Parameters:

indicator (int)
indicatorStyle (int)

Return type:

None

IndicatorSetUnder(self, indicator: int, under: bool)¶

Set an indicator to draw under text or over(default).

Parameters:

indicator (int)
under (bool)

Return type:

None

IndicatorStart(self, indicator: int, pos: int)¶

Where does a particular indicator start?

Parameters:

indicator (int)
pos (int)

Return type:

int

IndicatorValueAt(self, indicator: int, pos: int)¶

What value does a particular indicator have at a position?

Parameters:

indicator (int)
pos (int)

Return type:

int

InsertText(self, pos: int, text: str)¶

Insert string at a position.

Parameters:

pos (int)
text (string)

Return type:

None

InsertTextRaw(self, pos: int, text: str)¶

Insert string at a position.

Parameters:

pos (int)
text (int)

Return type:

None

IsEditable(self)¶

Returns True if the controls contents may be edited by user (note that it always can be changed by the program).

In other words, this functions returns True if the control hasn’t been put in read-only mode by a previous call to SetEditable .

Return type:: bool

IsEmpty(self)¶

Returns True if the control is currently empty.

This is the same as GetValue .empty() but can be much more efficient for the multiline controls containing big amounts of text.

Return type:: bool

Added in version 2.7.1.

IsModified(self)¶

Returns True if the text has been modified by user.

Note that calling SetValue doesn’t make the control modified.

Return type:: bool

See also

MarkDirty

IsRangeWord(self, start: int, end: int)¶

Is the range start..end considered a word?

Parameters:

start (int)
end (int)

Return type:

bool

Added in version 4.1/wxWidgets-3.1.1.

LineCopy(self)¶

Copy the line containing the caret.

Return type:: None

LineCut(self)¶

Cut the line containing the caret.

Return type:: None

LineDelete(self)¶

Delete the line containing the caret.

Return type:: None

LineDown(self)¶

Move caret down one line.

Return type:: None

LineDownExtend(self)¶

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

Return type:: None

LineDownRectExtend(self)¶

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

Return type:: None

LineDuplicate(self)¶

Duplicate the current line.

Return type:: None

LineEnd(self)¶

Move caret to last position on line.

Return type:: None

LineEndDisplay(self)¶

Move caret to last position on display line.

Return type:: None

LineEndDisplayExtend(self)¶

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

Return type:: None

LineEndExtend(self)¶

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

Return type:: None

LineEndRectExtend(self)¶

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

Return type:: None

LineEndWrap(self)¶

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

Return type:: None

LineEndWrapExtend(self)¶

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

Return type:: None

LineFromPosition(self, pos: int)¶

Retrieve the line containing a position.

Parameters:: pos (int)
Return type:: int

LineLength(self, line: int)¶

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

Parameters:: line (int)
Return type:: int

LineScroll(self, columns: int, lines: int)¶

Scroll horizontally and vertically.

Parameters:

columns (int)
lines (int)

Return type:

None

LineScrollDown(self)¶

Scroll the document down, keeping the caret visible.

Return type:: None

LineScrollUp(self)¶

Scroll the document up, keeping the caret visible.

Return type:: None

LineTranspose(self)¶

Switch the current line with the previous.

Return type:: None

LineUp(self)¶

Move caret up one line.

Return type:: None

LineUpExtend(self)¶

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

Return type:: None

LineUpRectExtend(self)¶

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

Return type:: None

LinesJoin(self)¶

Join the lines in the target.

Return type:: None

LinesOnScreen(self)¶

Retrieves the number of lines completely visible.

Return type:: int

LinesSplit(self, pixelWidth: int)¶

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

Parameters:: pixelWidth (int)
Return type:: None

LoadFile(self, filename: str)¶

Load the contents of filename into the editor.

Parameters:: filename (string)
Return type:: bool

LoadLexerLibrary(self, path: str)¶

Load a lexer library (dll / so).

Parameters:: path (string)
Return type:: None

Added in version 4.1/wxWidgets-3.1.1.

LowerCase(self)¶

Transform the selection to lower case.

Return type:: None

MarginGetStyle(self, line: int)¶

Get the style number for the text margin for a line.

Parameters:: line (int)
Return type:: int

MarginGetStyleOffset(self)¶

Get the start of the range of style numbers used for margin text.

Return type:: int

MarginGetStyles(self, line: int)¶

Get the styles in the text margin for a line.

Parameters:: line (int)
Return type:: str

MarginGetText(self, line: int)¶

Get the text in the text margin for a line.

Parameters:: line (int)
Return type:: str

MarginSetStyle(self, line: int, style: int)¶

Set the style number for the text margin for a line.

Parameters:

line (int)
style (int)

Return type:

None

MarginSetStyleOffset(self, style: int)¶

Get the start of the range of style numbers used for margin text.

Parameters:: style (int)
Return type:: None

MarginSetStyles(self, line: int, styles: str)¶

Set the style in the text margin for a line.

Parameters:

line (int)
styles (string)

Return type:

None

MarginSetText(self, line: int, text: str)¶

Set the text in the text margin for a line.

Parameters:

line (int)
text (string)

Return type:

None

MarginTextClearAll(self)¶

Clear the margin text on all lines.

Return type:: None

MarkDirty(self)¶

Mark text as modified (dirty).

Return type:: None

See also

IsModified

MarkerAdd(self, line: int, markerNumber: int)¶

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

Parameters:

line (int)
markerNumber (int)

Return type:

int

MarkerAddSet(self, line: int, markerSet: int)¶

Add a set of markers to a line.

Parameters:

line (int)
markerSet (int)

Return type:

None

MarkerDefine(self, markerNumber: int, markerSymbol: int, foreground: Colour = NullColour, background: Colour = NullColour)¶

Set the symbol used for a particular marker number, and optionally the fore and background colours.

The second argument should be one of the STC_MARK_* constants.

Parameters:

markerNumber (int)
markerSymbol (int)
foreground (wx.Colour)
background (wx.Colour)

Return type:

None

MarkerDefineBitmap(self, markerNumber: int, bmp: Bitmap)¶

Define a marker with a wx.Bitmap.

Parameters:

markerNumber (int)
bmp (wx.Bitmap)

Return type:

None

MarkerDefineRGBAImage(self, markerNumber: int, pixels: PyBuffer)¶

Define a marker from RGBA data.

It has the width and height from RGBAImageSetWidth/Height. You must ensure that the buffer is at least widthheight4 bytes long.

Return type:: None

MarkerDelete(self, line: int, markerNumber: int)¶

Delete a marker from a line.

Parameters:

line (int)
markerNumber (int)

Return type:

None

MarkerDeleteAll(self, markerNumber: int)¶

Delete all markers with a particular number from all lines.

Parameters:: markerNumber (int)
Return type:: None

MarkerDeleteHandle(self, markerHandle: int)¶

Delete a marker.

Parameters:: markerHandle (int)
Return type:: None

MarkerEnableHighlight(self, enabled: bool)¶

Enable/disable highlight for current folding block (smallest one that contains the caret)

Parameters:: enabled (bool)
Return type:: None

MarkerGet(self, line: int)¶

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

Parameters:: line (int)
Return type:: int

MarkerLineFromHandle(self, markerHandle: int)¶

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

Parameters:: markerHandle (int)
Return type:: int

MarkerNext(self, lineStart: int, markerMask: int)¶

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

Return -1 when no more lines.

Parameters:

lineStart (int)
markerMask (int)

Return type:

int

MarkerPrevious(self, lineStart: int, markerMask: int)¶

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

Parameters:

lineStart (int)
markerMask (int)

Return type:

int

MarkerSetAlpha(self, markerNumber: int, alpha: int)¶

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

Parameters:

markerNumber (int)
alpha (int)

Return type:

None

MarkerSetBackground(self, markerNumber: int, back: Colour)¶

Set the background colour used for a particular marker number.

Parameters:

markerNumber (int)
back (wx.Colour)

Return type:

None

MarkerSetBackgroundSelected(self, markerNumber: int, back: Colour)¶

Set the background colour used for a particular marker number when its folding block is selected.

Parameters:

markerNumber (int)
back (wx.Colour)

Return type:

None

MarkerSetForeground(self, markerNumber: int, fore: Colour)¶

Set the foreground colour used for a particular marker number.

Parameters:

markerNumber (int)
fore (wx.Colour)

Return type:

None

MoveCaretInsideView(self)¶

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

Return type:: None

MoveSelectedLinesDown(self)¶

Move the selected lines down one line, shifting the line below before the selection.

Return type:: None

MoveSelectedLinesUp(self)¶

Move the selected lines up one line, shifting the line above after the selection.

Return type:: None

MultiEdgeAddLine(self, column: int, edgeColour: Colour)¶

Add a new vertical edge to the view.

Parameters:

column (int)
edgeColour (wx.Colour)

Return type:

None

Added in version 4.1/wxWidgets-3.1.1.

MultiEdgeClearAll(self)¶

Clear all vertical edges.

Return type:: None

Added in version 4.1/wxWidgets-3.1.1.

MultipleSelectAddEach(self)¶

Add each occurrence of the main selection in the target to the set of selections.

If the current selection is empty then select word around caret.

Return type:: None

Added in version 4.1/wxWidgets-3.1.1.

MultipleSelectAddNext(self)¶

Add the next occurrence of the main selection to the set of selections as main.

If the current selection is empty then select word around caret.

Return type:: None

Added in version 4.1/wxWidgets-3.1.1.

NewLine(self)¶

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

Return type:: None

PageDown(self)¶

Move caret one page down.

Return type:: None

PageDownExtend(self)¶

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

Return type:: None

PageDownRectExtend(self)¶

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

Return type:: None

PageUp(self)¶

Move caret one page up.

Return type:: None

PageUpExtend(self)¶

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

Return type:: None

PageUpRectExtend(self)¶

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

Return type:: None

ParaDown(self)¶

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

Return type:: None

ParaDownExtend(self)¶

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

Return type:: None

ParaUp(self)¶

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

Return type:: None

ParaUpExtend(self)¶

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

Return type:: None

Paste(self)¶

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

Return type:: None

PointFromPosition(self, pos: int)¶

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

Parameters:: pos (int)
Return type:: wx.Point

PositionAfter(self, pos: int)¶

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

Maximum value returned is the last position in the document.

Parameters:: pos (int)
Return type:: int

PositionBefore(self, pos: int)¶

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

Returns 0 if passed 0.

Parameters:: pos (int)
Return type:: int

PositionFromLine(self, line: int)¶

Retrieve the position at the start of a line.

Parameters:: line (int)
Return type:: int

PositionFromPoint(self, pt: Point)¶

Find the position from a point within the window.

Parameters:: pt (wx.Point)
Return type:: int

PositionFromPointClose(self, x: int, y: int)¶

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

Parameters:

x (int)
y (int)

Return type:

int

PositionRelative(self, pos: int, relative: int)¶

Given a valid document position, return a position that differs in a number of characters.

Returned value is always between 0 and last position in document.

Parameters:

pos (int)
relative (int)

Return type:

int

Added in version 4.1/wxWidgets-3.1.0.

PositionToCoords(self, pos: int)¶

Converts given text position to client coordinates in pixels.

This function allows finding where is the character at the given position displayed in the text control.

Parameters:: pos (long) – Text position in 0 to GetLastPosition range (inclusive).
Return type:: wx.Point
Returns:: On success returns a wx.Point which contains client coordinates for the given position in pixels, otherwise returns wx.DefaultPosition .

Added in version 2.9.3.

Availability

Only available for MSW, GTK . Additionally, wxGTK only implements this method for multiline controls and wx.DefaultPosition is always returned for the single line ones.

See also

XYToPosition , PositionToXY

PositionToXY(self, pos: int)¶

Converts given position to a zero-based column, line number pair.

Parameters:: pos (long) – Position.
Return type:: Tuple[bool, int, int]

PrivateLexerCall(self, operation: int, pointer: Any)¶

For private communication between an application and a known lexer.

Parameters:

operation (int)
pointer

Return type:

Any

PropertyNames(self)¶

Retrieve a ‘\n’ separated list of properties understood by the current lexer.

Return type:: str

PropertyType(self, name: str)¶

Retrieve the type of a property.

The return value will be one of the STC_TYPE_* constants.

Parameters:: name (string)
Return type:: int

RGBAImageSetHeight(self, height: int)¶

Set the height for future RGBA image data.

Parameters:: height (int)
Return type:: None

RGBAImageSetScale(self, scalePercent: int)¶

Set the scale factor in percent for future RGBA image data.

Parameters:: scalePercent (int)
Return type:: None

Added in version 4.1/wxWidgets-3.1.0.

RGBAImageSetWidth(self, width: int)¶

Set the width for future RGBA image data.

Parameters:: width (int)
Return type:: None

Redo(self)¶

Redoes the next action on the undo history.

Return type:: None

RegisterImage(self, type: int, bmp: Bitmap)¶

Register an image for use in autocompletion lists.

Parameters:

type (int)
bmp (wx.Bitmap)

Return type:

None

RegisterRGBAImage(self, type: int, pixels: PyBuffer)¶

Register an RGBA image for use in autocompletion lists.

It has the width and height from RGBAImageSetWidth/Height. You must ensure that the buffer is at least widthheight4 bytes long.

Return type:: None

ReleaseAllExtendedStyles(self)¶

Release all extended (>255) style numbers.

Return type:: None

Added in version 4.1/wxWidgets-3.1.0.

ReleaseDocument(self, docPointer: Any)¶

Release a reference to the document, deleting document if it fades to black.

Parameters:: docPointer
Return type:: None

Remove(self, from_: int, to_: int)¶

Removes the text starting at the first given position up to (but not including) the character at the last position.

This function puts the current insertion point position at to as a side effect.

Parameters:

from_ (long)
to_ (long)

The first position.

The last position.

Return type:: None

Replace(self, from_: int, to_: int, value: str)¶

Replaces the text starting at the first position up to (but not including) the character at the last position with the given text.

This function puts the current insertion point position at to as a side effect.

Parameters:

from_ (long)
to_ (long)
value (string) – The value to replace the existing text with.

The first position.

The last position.

Return type:: None

ReplaceSelection(self, text: str)¶

Replace the selected text with the argument text.

Parameters:: text (string)
Return type:: None

ReplaceSelectionRaw(self, text: str)¶

Replace the current selection with text.

If there is no current selection, text is inserted at the current caret position.

Parameters:: text (int) – The null terminated string used for the replacement.
Return type:: None

Added in version 4.1/wxWidgets-3.1.3.

ReplaceTarget(self, text: str)¶

Replace the target text with the argument text.

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

Parameters:: text (string)
Return type:: int

ReplaceTargetRE(self, text: str)¶

Replace the target text with the argument text after \d processing.

Text is counted so it can contain NULs. Looks for \d where d is between 1 and 9 and replaces these with the strings matched in the last search operation which were surrounded by $ and $. Returns the length of the replacement text including any change caused by processing the \d patterns.

Parameters:: text (string)
Return type:: int

ReplaceTargetRERaw(self, text: str, length: int = -1)¶

Replace the current target with text using regular expressions.

The replacement string will be formed from text with any occurrences ‘\1’ through ‘\9’ replaced by tagged matches from the most recent regular expression search. In addition, any occurrences of ‘\0’ will be replaced with all the matched text from the most recent search. After replacement, the target range refers to the replacement text.

Parameters:

text (int)
length (int)

Return type:

int

Returns:

The return value is the length of the replacement string.

Added in version 4.1/wxWidgets-3.1.3.

Note

If length=-1, text must be null terminated.

See also

SearchInTarget

ReplaceTargetRaw(self, text: str, length: int = -1)¶

Replace the current target with text.

Parameters:

text (int)
length (int)

Return type:

int

Returns:

The return value is the length of the replacement string.

Added in version 4.1/wxWidgets-3.1.3.

Note

If length=-1, text must be null terminated.

RotateSelection(self)¶

Set the main selection to the next selection.

Return type:: None

SaveFile(self, filename: str)¶

Write the contents of the editor to filename.

Parameters:: filename (string)
Return type:: bool

ScrollRange(self, secondary: int, primary: int)¶

Scroll the argument positions and the range between them into view giving priority to the primary position then the secondary position.

This may be used to make a search match visible.

Parameters:

secondary (int)
primary (int)

Return type:

None

Added in version 4.1/wxWidgets-3.1.0.

ScrollToColumn(self, column: int)¶

Scroll enough to make the given column visible.

Parameters:: column (int)
Return type:: None

ScrollToEnd(self)¶

Scroll to end of document.

Return type:: None

ScrollToLine(self, line: int)¶

Scroll enough to make the given line visible.

Parameters:: line (int)
Return type:: None

ScrollToStart(self)¶

Scroll to start of document.

Return type:: None

SearchAnchor(self)¶

Sets the current caret position to be the search anchor.

Return type:: None

SearchInTarget(self, text: str)¶

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.

Parameters:: text (string)
Return type:: int

SearchNext(self, searchFlags: int, text: str)¶

Find some text starting at the search anchor.

Does not ensure the selection is visible.

Parameters:

searchFlags (int)
text (string)

Return type:

int

SearchPrev(self, searchFlags: int, text: str)¶

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

Does not ensure the selection is visible.

Parameters:

searchFlags (int)
text (string)

Return type:

int

SelectAll(self)¶

Select all the text in the document.

Return type:: None

SelectNone(self)¶

Deselects selected text in the control.

Return type:: None

Added in version 2.9.5.

SelectionDuplicate(self)¶

Duplicate the selection.

If selection empty duplicate the line containing the caret.

Return type:: None

SelectionIsRectangle(self)¶

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

Return type:: bool

SendMsg(self, msg: int, wp: UIntPtr = 0, lp: IntPtr = 0)¶

Scintilla API call.

Parameters:

msg (int)
wp (wx.UIntPtr)
lp (wx.IntPtr)

Return type:

wx.IntPtr

SetAdditionalCaretForeground(self, fore: Colour)¶

Set the foreground colour of additional carets.

Parameters:: fore (wx.Colour)
Return type:: None

SetAdditionalCaretsBlink(self, additionalCaretsBlink: bool)¶

Set whether additional carets will blink.

Parameters:: additionalCaretsBlink (bool)
Return type:: None

SetAdditionalCaretsVisible(self, additionalCaretsVisible: bool)¶

Set whether additional carets are visible.

Parameters:: additionalCaretsVisible (bool)
Return type:: None

SetAdditionalSelAlpha(self, alpha: int)¶

Set the alpha of the selection.

Parameters:: alpha (int)
Return type:: None

SetAdditionalSelBackground(self, back: Colour)¶

Set the background colour of additional selections.

Must have previously called SetSelBack with non-zero first argument for this to have an effect.

Parameters:: back (wx.Colour)
Return type:: None

SetAdditionalSelForeground(self, fore: Colour)¶

Set the foreground colour of additional selections.

Must have previously called SetSelFore with non-zero first argument for this to have an effect.

Parameters:: fore (wx.Colour)
Return type:: None

SetAdditionalSelectionTyping(self, additionalSelectionTyping: bool)¶

Set whether typing can be performed into multiple selections.

Parameters:: additionalSelectionTyping (bool)
Return type:: None

SetAnchor(self, anchor: int)¶

Set the selection anchor to a position.

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

Parameters:: anchor (int)
Return type:: None

SetAutomaticFold(self, automaticFold: int)¶

Set automatic folding behaviours.

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

Parameters:: automaticFold (int)
Return type:: None

Added in version 4.1/wxWidgets-3.1.0.

SetBackSpaceUnIndents(self, bsUnIndents: bool)¶

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

Parameters:: bsUnIndents (bool)
Return type:: None

SetBufferedDraw(self, buffered: bool)¶

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

Parameters:: buffered (bool)
Return type:: None

SetCaretForeground(self, fore: Colour)¶

Set the foreground colour of the caret.

Parameters:: fore (wx.Colour)
Return type:: None

SetCaretLineBackAlpha(self, alpha: int)¶

Set background alpha of the caret line.

Parameters:: alpha (int)
Return type:: None

SetCaretLineBackground(self, back: Colour)¶

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

Parameters:: back (wx.Colour)
Return type:: None

SetCaretLineVisible(self, show: bool)¶

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

Parameters:: show (bool)
Return type:: None

SetCaretLineVisibleAlways(self, alwaysVisible: bool)¶

Sets the caret line to always visible.

Parameters:: alwaysVisible (bool)
Return type:: None

Added in version 4.1/wxWidgets-3.1.0.

SetCaretPeriod(self, periodMilliseconds: int)¶

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

0 = steady on.

Parameters:: periodMilliseconds (int)
Return type:: None

SetCaretSticky(self, useCaretStickyBehaviour: int)¶

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

The input should be one of the STC_CARETSTICKY_* constants.

Parameters:: useCaretStickyBehaviour (int)
Return type:: None

SetCaretStyle(self, caretStyle: int)¶

Set the style of the caret to be drawn.

The input should be one of the STC_CARETSTYLE_* constants.

Parameters:: caretStyle (int)
Return type:: None

SetCaretWidth(self, pixelWidth: int)¶

Set the width of the insert mode caret.

Parameters:: pixelWidth (int)
Return type:: None

SetCharsDefault(self)¶

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

Return type:: None

SetCodePage(self, codePage: int)¶

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

Parameters:: codePage (int)
Return type:: None

SetControlCharSymbol(self, symbol: int)¶

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

Parameters:: symbol (int)
Return type:: None

SetCurrentPos(self, caret: int)¶

Sets the position of the caret.

Parameters:: caret (int)
Return type:: None

SetDefaultStyle(self, style: TextAttr)¶

This method is inherited from TextAreaBase but is not implemented in wx.stc.StyledTextCtrl.

Parameters:: style (wx.TextAttr)
Return type:: bool

SetDocPointer(self, docPointer: Any)¶

Change the document object used.

Parameters:: docPointer
Return type:: None

SetEOLMode(self, eolMode: int)¶

Set the current end of line mode.

The input should be one of the STC_EOL_* constants.

Parameters:: eolMode (int)
Return type:: None

SetEdgeColour(self, edgeColour: Colour)¶

Change the colour used in edge indication.

Parameters:: edgeColour (wx.Colour)
Return type:: None

SetEdgeColumn(self, column: int)¶

Set the column number of the edge.

If text goes past the edge then it is highlighted.

Parameters:: column (int)
Return type:: None

SetEdgeMode(self, edgeMode: int)¶

The edge may be displayed by a line (wxSTC_EDGE_LINE/wxSTC_EDGE_MULTILINE) or by highlighting text that goes beyond it (wx``wx.stc.STC_EDGE_BACKGROUND``) or not displayed at all (wx``wx.stc.STC_EDGE_NONE``).

The input should be one of the STC_EDGE_* constants.

Parameters:: edgeMode (int)
Return type:: None

SetEditable(self, editable: bool)¶

Makes the text item editable or read-only, overriding the wx.TE_READONLY flag.

Parameters:: editable (bool) – If True, the control is editable. If False, the control is read-only.
Return type:: None

See also

IsEditable

SetEmptySelection(self, caret: int)¶

Set caret to a position, while removing any existing selection.

Parameters:: caret (int)
Return type:: None

SetEndAtLastLine(self, endAtLastLine: bool)¶

Sets the scroll range so that maximum scroll position has the last line at the bottom of the view (default).

Setting this to False allows scrolling one page below the last line.

Parameters:: endAtLastLine (bool)
Return type:: None

SetExtraAscent(self, extraAscent: int)¶

Set extra ascent for each line.

Parameters:: extraAscent (int)
Return type:: None

SetExtraDescent(self, extraDescent: int)¶

Set extra descent for each line.

Parameters:: extraDescent (int)
Return type:: None

SetFirstVisibleLine(self, displayLine: int)¶

Scroll so that a display line is at the top of the display.

Parameters:: displayLine (int)
Return type:: None

SetFoldExpanded(self, line: int, expanded: bool)¶

Show the children of a header line.

Parameters:

line (int)
expanded (bool)

Return type:

None

SetFoldFlags(self, flags: int)¶

Set some style options for folding.

The second argument should be a bit list containing one or more of the STC_FOLDFLAG_* constants.

Parameters:: flags (int)
Return type:: None

SetFoldLevel(self, line: int, level: int)¶

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.

Parameters:

line (int)
level (int)

Return type:

None

SetFoldMarginColour(self, useSetting: bool, back: Colour)¶

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

Parameters:

useSetting (bool)
back (wx.Colour)

Return type:

None

SetFoldMarginHiColour(self, useSetting: bool, fore: Colour)¶

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

Parameters:

useSetting (bool)
fore (wx.Colour)

Return type:

None

SetFontQuality(self, fontQuality: int)¶

Choose the quality level for text.

The input should be one of the STC_EFF_QUALITY_* constants.

Parameters:: fontQuality (int)
Return type:: None

Added in version 4.1/wxWidgets-3.1.1.

Note

This method only has any effect with the wxMSW port and when technology has been set to wx.stc.STC_TECHNOLOGY_DIRECTWRITE.

SetHScrollBar(self, bar: ScrollBar)¶

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

Parameters:: bar (wx.ScrollBar)
Return type:: None

SetHighlightGuide(self, column: int)¶

Set the highlighted indentation guide column.

0 = no highlighted guide.

Parameters:: column (int)
Return type:: None

SetHint(self, hint: str)¶

Sets a hint shown in an empty unfocused text control.

The hints are usually used to indicate to the user what is supposed to be entered into the given entry field, e.g. a common use of them is to show an explanation of what can be entered in a wx.SearchCtrl.

The hint is shown (usually greyed out) for an empty control until it gets focus and is shown again if the control loses it and remains empty. It won’t be shown once the control has a non-empty value, although it will be shown again if the control contents is cleared. Because of this, it generally only makes sense to use hints with the controls which are initially empty.

Notice that hints are known as cue banners under MSW or placeholder strings under macOS.

For the platforms without native hints support, the implementation has several known limitations. Notably, the hint display will not be properly updated if you change wx.TextEntry contents programmatically when the hint is displayed using methods other than SetValue or ChangeValue or others which use them internally (e.g. Clear ). In other words, currently you should avoid calling methods such as WriteText or Replace when using hints and the text control is empty. If you bind to the control’s focus and wxEVT_TEXT events, you must call wx.Event.Skip on them so that the generic implementation works correctly.

Another limitation is that hints are ignored for the controls with TE_PASSWORD style.

Parameters:: hint (string)
Return type:: bool

Added in version 2.9.0.

Note

Currently implemented natively on Windows (Vista and later only), macOS and GTK+ (3.2 and later).

Note

Hints can be used for single line text controls under all platforms, but only MSW and GTK+ 2 support them for multi-line text controls, they are ignored for them under the other platforms.

SetHotspotActiveBackground(self, useSetting: bool, back: Colour)¶

Set a back colour for active hotspots.

Parameters:

useSetting (bool)
back (wx.Colour)

Return type:

None

SetHotspotActiveForeground(self, useSetting: bool, fore: Colour)¶

Set a fore colour for active hotspots.

Parameters:

useSetting (bool)
fore (wx.Colour)

Return type:

None

SetHotspotActiveUnderline(self, underline: bool)¶

Enable / Disable underlining active hotspots.

Parameters:: underline (bool)
Return type:: None

SetHotspotSingleLine(self, singleLine: bool)¶

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

Parameters:: singleLine (bool)
Return type:: None

SetIMEInteraction(self, imeInteraction: int)¶

Choose to display the IME in a winow or inline.

The input should be one of the STC_IME_* constants.

Parameters:: imeInteraction (int)
Return type:: None

Added in version 4.1/wxWidgets-3.1.0.

SetIdentifier(self, identifier: int)¶

Set the identifier reported as idFrom in notification messages.

Parameters:: identifier (int)
Return type:: None

SetIdentifiers(self, style: int, identifiers: str)¶

Set the identifiers that are shown in a particular style.

Parameters:

style (int)
identifiers (string)

Return type:

None

Added in version 4.1/wxWidgets-3.1.0.

SetIdleStyling(self, idleStyling: int)¶

Sets limits to idle styling.

The input should be one of the STC_IDLESTYLING_* constants.

Parameters:: idleStyling (int)
Return type:: None

Added in version 4.1/wxWidgets-3.1.1.

SetIndent(self, indentSize: int)¶

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

Parameters:: indentSize (int)
Return type:: None

SetIndentationGuides(self, indentView: int)¶

Show or hide indentation guides.

The input should be one of the STC_IV_* constants.

Parameters:: indentView (int)
Return type:: None

SetIndicatorCurrent(self, indicator: int)¶

Set the indicator used for IndicatorFillRange and IndicatorClearRange.

Parameters:: indicator (int)
Return type:: None

SetIndicatorValue(self, value: int)¶

Set the value used for IndicatorFillRange.

Parameters:: value (int)
Return type:: None

SetInsertionPoint(self, pos: int)¶

Sets the insertion point at the given position.

Parameters:: pos (long) – Position to set, in the range from 0 to GetLastPosition inclusive.
Return type:: None

SetInsertionPointEnd(self)¶

Sets the insertion point at the end of the text control.

This is equivalent to calling wx.TextCtrl.SetInsertionPoint with wx.TextCtrl.GetLastPosition argument.

Return type:: None

SetKeyWords(self, keyWordSet: int, keyWords: str)¶

Set up the key words used by the lexer.

Parameters:

keyWordSet (int)
keyWords (string)

Return type:

None

SetLastKeydownProcessed(self, val: bool)¶

Returns the line number of the line with the caret.

Parameters:: val (bool)
Return type:: None

SetLayoutCache(self, cacheMode: int)¶

Sets the degree of caching of layout information.

The input should be one of the STC_CACHE_* constants.

Parameters:: cacheMode (int)
Return type:: None

SetLexer(self, lexer: int)¶

Set the lexing language of the document.

The input should be one of the STC_LEX_* constants.

Parameters:: lexer (int)
Return type:: None

SetLexerLanguage(self, language: str)¶

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

Parameters:: language (string)
Return type:: None

SetLineEndTypesAllowed(self, lineEndBitSet: int)¶

Set the line end types that the application wants to use.

May not be used if incompatible with lexer or encoding.

The input should be one of the STC_LINE_END_TYPE_* constants.

Parameters:: lineEndBitSet (int)
Return type:: None

Added in version 4.1/wxWidgets-3.1.0.

SetLineIndentation(self, line: int, indentation: int)¶

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

Parameters:

line (int)
indentation (int)

Return type:

None

SetLineState(self, line: int, state: int)¶

Used to hold extra styling information for each line.

Parameters:

line (int)
state (int)

Return type:

None

SetMainSelection(self, selection: int)¶

Set the main selection.

Parameters:: selection (int)
Return type:: None

SetMarginBackground(self, margin: int, back: Colour)¶

Set the background colour of a margin.

Only visible for wx.stc.STC_MARGIN_COLOUR.

Parameters:

margin (int)
back (wx.Colour)

Return type:

None

Added in version 4.1/wxWidgets-3.1.1.

SetMarginCount(self, margins: int)¶

Allocate a non-standard number of margins.

Parameters:: margins (int)
Return type:: None

Added in version 4.1/wxWidgets-3.1.1.

SetMarginCursor(self, margin: int, cursor: int)¶

Set the cursor shown when the mouse is inside a margin.

The second argument should be one of the STC_CURSOR* constants.

Parameters:

margin (int)
cursor (int)

Return type:

None

SetMarginLeft(self, pixelWidth: int)¶

Sets the size in pixels of the left margin.

Parameters:: pixelWidth (int)
Return type:: None

SetMarginMask(self, margin: int, mask: int)¶

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

Parameters:

margin (int)
mask (int)

Return type:

None

SetMarginOptions(self, marginOptions: int)¶

Set the margin options.

The input should be one of the STC_MARGINOPTION_* constants.

Parameters:: marginOptions (int)
Return type:: None

SetMarginRight(self, pixelWidth: int)¶

Sets the size in pixels of the right margin.

Parameters:: pixelWidth (int)
Return type:: None

SetMarginSensitive(self, margin: int, sensitive: bool)¶

Make a margin sensitive or insensitive to mouse clicks.

Parameters:

margin (int)
sensitive (bool)

Return type:

None

SetMarginType(self, margin: int, marginType: int)¶

Set a margin to be either numeric or symbolic.

The second argument should be one of the STC_MARGIN_* constants.

Parameters:

margin (int)
marginType (int)

Return type:

None

SetMarginWidth(self, margin: int, pixelWidth: int)¶

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

Parameters:

margin (int)
pixelWidth (int)

Return type:

None

SetMargins(self, left: int, right: int)¶

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

Parameters:

left (int)
right (int)

Return type:

None

SetMaxLength(self, len: int)¶

This function sets the maximum number of characters the user can enter into the control.

In other words, it allows limiting the text value length to len not counting the terminating NUL character.

If len is 0, the previously set max length limit, if any, is discarded and the user may enter as much text as the underlying native text control widget supports (typically at least 32Kb). If the user tries to enter more characters into the text control when it already is filled up to the maximal length, a wxEVT_TEXT_MAXLEN event is sent to notify the program about it (giving it the possibility to show an explanatory message, for example) and the extra input is discarded.

Note that in wxGTK this function may only be used with single line text controls.

Parameters:: len (long)
Return type:: None

SetModEventMask(self, eventMask: int)¶

Set which document modification events are sent to the container.

The input should be a bit list containing one or more of the STC_MOD_* constants, the STC_PERFORMED_* constants, wx.stc.STC_STARTACTION, wx.stc.STC_MULTILINEUNDOREDO, wx.stc.STC_MULTISTEPUNDOREDO, and wx.stc.STC_LASTSTEPINUNDOREDO. The input can also be wx.stc.STC_MODEVENTMASKALL to indicate that all changes should generate events.

Parameters:: eventMask (int)
Return type:: None

SetModified(self, modified: bool)¶

Marks the control as being modified by the user or not.

Parameters:: modified (bool)
Return type:: None

See also

MarkDirty , DiscardEdits

SetMouseDownCaptures(self, captures: bool)¶

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

Parameters:: captures (bool)
Return type:: None

SetMouseDwellTime(self, periodMilliseconds: int)¶

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

The input should be a time in milliseconds or wx.stc.STC_TIME_FOREVER.

Parameters:: periodMilliseconds (int)
Return type:: None

SetMouseSelectionRectangularSwitch(self, mouseSelectionRectangularSwitch: bool)¶

Set whether switching to rectangular mode while selecting with the mouse is allowed.

Parameters:: mouseSelectionRectangularSwitch (bool)
Return type:: None

Added in version 4.1/wxWidgets-3.1.0.

SetMouseWheelCaptures(self, captures: bool)¶

Set whether the mouse wheel can be active outside the window.

Parameters:: captures (bool)
Return type:: None

Added in version 4.1/wxWidgets-3.1.1.

SetMultiPaste(self, multiPaste: int)¶

Change the effect of pasting when there are multiple selections.

The input should be one of the STC_MULTIPASTE_* constants.

Parameters:: multiPaste (int)
Return type:: None

SetMultipleSelection(self, multipleSelection: bool)¶

Set whether multiple selections can be made.

Parameters:: multipleSelection (bool)
Return type:: None

SetOvertype(self, overType: bool)¶

Set to overtype (True) or insert mode.

Parameters:: overType (bool)
Return type:: None

SetPasteConvertEndings(self, convert: bool)¶

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

Parameters:: convert (bool)
Return type:: None

SetPhasesDraw(self, phases: int)¶

In one phase draw, text is drawn in a series of rectangular blocks with no overlap.

In two phase draw, text is drawn in a series of lines allowing runs to overlap horizontally. In multiple phase draw, each element is drawn over the whole drawing area, allowing text to overlap from one line to the next.

The input should be one of the STC_PHASES_* constants.

Parameters:: phases (int)
Return type:: None

Added in version 4.1/wxWidgets-3.1.0.

SetPositionCacheSize(self, size: int)¶

Set number of entries in position cache.

Parameters:: size (int)
Return type:: None

SetPrintColourMode(self, mode: int)¶

Modify colours when printing for clearer printed text.

The input should be one of the STC_PRINT_* constants.

Parameters:: mode (int)
Return type:: None

SetPrintMagnification(self, magnification: int)¶

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

Parameters:: magnification (int)
Return type:: None

SetPrintWrapMode(self, wrapMode: int)¶

Set printing to line wrapped (wx``wx.stc.STC_WRAP_WORD``) or not line wrapped (wx``wx.stc.STC_WRAP_NONE``).

Parameters:: wrapMode (int)
Return type:: None

SetProperty(self, key: str, value: str)¶

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

Parameters:

key (string)
value (string)

Return type:

None

SetPunctuationChars(self, characters: str)¶

Set the set of characters making up punctuation characters Should be called after SetWordChars.

Parameters:: characters (string)
Return type:: None

SetReadOnly(self, readOnly: bool)¶

Set to read only or read write.

Parameters:: readOnly (bool)
Return type:: None

SetRectangularSelectionAnchor(self, anchor: int)¶

Set the anchor position of the rectangular selection.

Parameters:: anchor (int)
Return type:: None

SetRectangularSelectionAnchorVirtualSpace(self, space: int)¶

Set the virtual space of the anchor of the rectangular selection.

Parameters:: space (int)
Return type:: None

SetRectangularSelectionCaret(self, caret: int)¶

Set the caret position of the rectangular selection.

Parameters:: caret (int)
Return type:: None

SetRectangularSelectionCaretVirtualSpace(self, space: int)¶

Set the virtual space of the caret of the rectangular selection.

Parameters:: space (int)
Return type:: None

SetRectangularSelectionModifier(self, modifier: int)¶

On GTK+, allow selecting the modifier key to use for mouse-based rectangular selection.

Often the window manager requires Alt+Mouse Drag for moving windows. Valid values are wx.stc.STC_KEYMOD_CTRL (default), wx.stc.STC_KEYMOD_ALT, or wx.stc.STC_KEYMOD_SUPER.

Parameters:: modifier (int)
Return type:: None

SetRepresentation(self, encodedCharacter: str, representation: str)¶

Set the way a character is drawn.

Parameters:

encodedCharacter (string)
representation (string)

Return type:

None

Added in version 4.1/wxWidgets-3.1.0.

SetSTCCursor(self, cursorType: int)¶

Sets the cursor to one of the STC_CURSOR values.

Parameters:: cursorType (int)
Return type:: None

SetSTCFocus(self, focus: bool)¶

Change internal focus flag.

Parameters:: focus (bool)
Return type:: None

SetSavePoint(self)¶

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

Return type:: None

SetScrollWidth(self, pixelWidth: int)¶

Sets the document width assumed for scrolling.

Parameters:: pixelWidth (int)
Return type:: None

SetScrollWidthTracking(self, tracking: bool)¶

Sets whether the maximum width line displayed is used to set scroll width.

Parameters:: tracking (bool)
Return type:: None

SetSearchFlags(self, searchFlags: int)¶

Set the search flags used by SearchInTarget.

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

Parameters:: searchFlags (int)
Return type:: None

SetSelAlpha(self, alpha: int)¶

Set the alpha of the selection.

Parameters:: alpha (int)
Return type:: None

SetSelBackground(self, useSetting: bool, back: Colour)¶

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

Parameters:

useSetting (bool)
back (wx.Colour)

Return type:

None

SetSelEOLFilled(self, filled: bool)¶

Set the selection to have its end of line filled or not.

Parameters:: filled (bool)
Return type:: None

SetSelForeground(self, useSetting: bool, fore: Colour)¶

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

Parameters:

useSetting (bool)
fore (wx.Colour)

Return type:

None

SetSelection(self, from_: int, to_: int)¶

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.

Parameters:

from_ (long)
to_ (long)

The first position.

The last position.

Return type:: None

See also

SelectAll

SetSelectionEnd(self, caret: int)¶

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

Parameters:: caret (int)
Return type:: None

SetSelectionMode(self, selectionMode: int)¶

Set the selection mode to stream (wx``wx.stc.STC_SEL_STREAM``) or rectangular (wxSTC_SEL_RECTANGLE/wxSTC_SEL_THIN) or by lines (wx``wx.stc.STC_SEL_LINES``).

Parameters:: selectionMode (int)
Return type:: None

SetSelectionNAnchor(self, selection: int, anchor: int)¶

Set the anchor position of the nth selection.

Parameters:

selection (int)
anchor (int)

Return type:

None

SetSelectionNAnchorVirtualSpace(self, selection: int, space: int)¶

Set the virtual space of the anchor of the nth selection.

Parameters:

selection (int)
space (int)

Return type:

None

SetSelectionNCaret(self, selection: int, caret: int)¶

Set the caret position of the nth selection.

Parameters:

selection (int)
caret (int)

Return type:

None

SetSelectionNCaretVirtualSpace(self, selection: int, space: int)¶

Set the virtual space of the caret of the nth selection.

Parameters:

selection (int)
space (int)

Return type:

None

SetSelectionNEnd(self, selection: int, caret: int)¶

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

Parameters:

selection (int)
caret (int)

Return type:

None

SetSelectionNStart(self, selection: int, anchor: int)¶

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

Parameters:

selection (int)
anchor (int)

Return type:

None

SetSelectionStart(self, anchor: int)¶

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

Parameters:: anchor (int)
Return type:: None

SetStatus(self, status: int)¶

Change error status - 0 = wx.OK.

The input should be one of the STC_STATUS_* constants.

Parameters:: status (int)
Return type:: None

SetStyle(self, start: int, end: int, style: TextAttr)¶

This method is inherited from TextAreaBase but is not implemented in wx.stc.StyledTextCtrl.

Parameters:

start (long)
end (long)
style (wx.TextAttr)

Return type:

bool

SetStyleBits(self, bits: int)¶

Divide each styling byte into lexical class bits (default: 5) and indicator bits (default: 3).

If a lexer requires more than 32 lexical states, then this is used to expand the possible states.

Parameters:: bits (int)
Return type:: None

SetStyleBytes(self, length: int, styleBytes: str)¶

Set the styles for a segment of the document.

Parameters:

length (int)
styleBytes (int)

Return type:

None

SetStyling(self, length: int, style: int)¶

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

Parameters:

length (int)
style (int)

Return type:

None

SetTabDrawMode(self, tabDrawMode: int)¶

Set how tabs are drawn when visible.

The input should be one of the STC_TD_* constants.

Parameters:: tabDrawMode (int)
Return type:: None

Added in version 4.1/wxWidgets-3.1.1.

SetTabIndents(self, tabIndents: bool)¶

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

Parameters:: tabIndents (bool)
Return type:: None

SetTabWidth(self, tabWidth: int)¶

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

Parameters:: tabWidth (int)
Return type:: None

SetTargetEnd(self, end: int)¶

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

Parameters:: end (int)
Return type:: None

SetTargetRange(self, start: int, end: int)¶

Sets both the start and end of the target in one call.

Parameters:

start (int)
end (int)

Return type:

None

Added in version 4.1/wxWidgets-3.1.0.

SetTargetStart(self, start: int)¶

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

Parameters:: start (int)
Return type:: None

SetTechnology(self, technology: int)¶

Set the technology used.

Parameters:: technology (int)
Return type:: None

Note

For the wxMSW port, the input can be either wx.stc.STC_TECHNOLOGY_DEFAULT or wx.stc.STC_TECHNOLOGY_DIRECTWRITE. With other ports, this method has no effect.

SetText(self, text: str)¶

Replace the contents of the document with the argument text.

Parameters:: text (string)
Return type:: None

SetTextRaw(self, text: str)¶

Replace the contents of the document with the argument text.

Parameters:: text (int)
Return type:: None

SetTwoPhaseDraw(self, twoPhase: bool)¶

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.

Parameters:: twoPhase (bool)
Return type:: None

SetUndoCollection(self, collectUndo: bool)¶

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

Parameters:: collectUndo (bool)
Return type:: None

SetUseAntiAliasing(self, useAA: bool)¶

Specify whether anti-aliased fonts should be used.

This will have no effect on some platforms, but on some (wxMac for example) can greatly improve performance.

Parameters:: useAA (bool)
Return type:: None

SetUseHorizontalScrollBar(self, visible: bool)¶

Show or hide the horizontal scroll bar.

Parameters:: visible (bool)
Return type:: None

SetUseTabs(self, useTabs: bool)¶

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

Parameters:: useTabs (bool)
Return type:: None

SetUseVerticalScrollBar(self, visible: bool)¶

Show or hide the vertical scroll bar.

Parameters:: visible (bool)
Return type:: None

SetVScrollBar(self, bar: ScrollBar)¶

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

Parameters:: bar (wx.ScrollBar)
Return type:: None

SetValue(self, value: str)¶

Sets the new text control value.

It also marks the control as not-modified which means that IsModified() would return False immediately after the call to SetValue .

The insertion point is set to the start of the control (i.e. position 0) by this function unless the control value doesn’t change at all, in which case the insertion point is left at its original position.

Note that, unlike most other functions changing the controls values, this function generates a wxEVT_TEXT event. To avoid this you can use ChangeValue instead.

Parameters:: value (string) – The new value to set. It may contain newline characters if the text control is multi-line.
Return type:: None

SetViewEOL(self, visible: bool)¶

Make the end of line characters visible or invisible.

Parameters:: visible (bool)
Return type:: None

SetViewWhiteSpace(self, viewWS: int)¶

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

The input should be one of the STC_WS_* constants.

Parameters:: viewWS (int)
Return type:: None

SetVirtualSpaceOptions(self, virtualSpaceOptions: int)¶

Set options for virtual space behaviour.

The input should be one of the STC_VS_* constants.

Parameters:: virtualSpaceOptions (int)
Return type:: None

SetVisiblePolicy(self, visiblePolicy: int, visibleSlop: int)¶

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 STC_VISIBLE_* constants.

Parameters:

visiblePolicy (int)
visibleSlop (int)

Return type:

None

SetWhitespaceBackground(self, useSetting: bool, back: Colour)¶

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

Parameters:

useSetting (bool)
back (wx.Colour)

Return type:

None

SetWhitespaceChars(self, characters: str)¶

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

Should be called after SetWordChars.

Parameters:: characters (string)
Return type:: None

SetWhitespaceForeground(self, useSetting: bool, fore: Colour)¶

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

Parameters:

useSetting (bool)
fore (wx.Colour)

Return type:

None

SetWhitespaceSize(self, size: int)¶

Set the size of the dots used to mark space characters.

Parameters:: size (int)
Return type:: None

SetWordChars(self, characters: str)¶

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

First sets defaults like SetCharsDefault.

Parameters:: characters (string)
Return type:: None

SetWrapIndentMode(self, wrapIndentMode: int)¶

Sets how wrapped sublines are placed.

Default is wx.stc.STC_WRAPINDENT_FIXED.

The input should be one of the STC_WRAPINDENT_* constants.

Parameters:: wrapIndentMode (int)
Return type:: None

SetWrapMode(self, wrapMode: int)¶

Sets whether text is word wrapped.

The input should be one of the STC_WRAP_* constants.

Parameters:: wrapMode (int)
Return type:: None

SetWrapStartIndent(self, indent: int)¶

Set the start indent for wrapped lines.

Parameters:: indent (int)
Return type:: None

SetWrapVisualFlags(self, wrapVisualFlags: int)¶

Set the display mode of visual flags for wrapped lines.

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

Parameters:: wrapVisualFlags (int)
Return type:: None

SetWrapVisualFlagsLocation(self, wrapVisualFlagsLocation: int)¶

Set the location of visual flags for wrapped lines.

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

Parameters:: wrapVisualFlagsLocation (int)
Return type:: None

SetXCaretPolicy(self, caretPolicy: int, caretSlop: int)¶

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 STC_CARET_* constants.

Parameters:

caretPolicy (int)
caretSlop (int)

Return type:

None

SetXOffset(self, xOffset: int)¶

Set the xOffset (ie, horizontal scroll position).

Parameters:: xOffset (int)
Return type:: None

SetYCaretPolicy(self, caretPolicy: int, caretSlop: int)¶

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 STC_CARET_* constants.

Parameters:

caretPolicy (int)
caretSlop (int)

Return type:

None

SetZoom(self, zoomInPoints: int)¶

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.

Parameters:: zoomInPoints (int)
Return type:: None

ShowLines(self, lineStart: int, lineEnd: int)¶

Make a range of lines visible.

Parameters:

lineStart (int)
lineEnd (int)

Return type:

None

ShowPosition(self, pos: int)¶

Makes the line containing the given position visible.

Parameters:: pos (long) – The position that should be visible.
Return type:: None

StartRecord(self)¶

Start notifying the container of all key presses and commands.

Return type:: None

StartStyling(self, start: int)¶

Set the current styling position to start.

Parameters:: start (int)
Return type:: None

StopRecord(self)¶

Stop notifying the container of all key presses and commands.

Return type:: None

StutteredPageDown(self)¶

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

Return type:: None

StutteredPageDownExtend(self)¶

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

Return type:: None

StutteredPageUp(self)¶

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

Return type:: None

StutteredPageUpExtend(self)¶

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

Return type:: None

StyleClearAll(self)¶

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

Return type:: None

StyleGetBackground(self, style: int)¶

Get the background colour of a style.

Parameters:: style (int)
Return type:: wx.Colour

StyleGetBold(self, style: int)¶

Get is a style bold or not.

Parameters:: style (int)
Return type:: bool

StyleGetCase(self, style: int)¶

Get is a style mixed case, or to force upper or lower case.

The return value will be one of the STC_CASE_* constants.

Parameters:: style (int)
Return type:: int

StyleGetChangeable(self, style: int)¶

Get is a style changeable or not (read only).

Experimental feature, currently buggy.

Parameters:: style (int)
Return type:: bool

StyleGetCharacterSet(self, style: int)¶

Get the character get of the font in a style.

Parameters:: style (int)
Return type:: int

StyleGetEOLFilled(self, style: int)¶

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

Parameters:: style (int)
Return type:: bool

StyleGetFaceName(self, style: int)¶

Get the font facename of a style.

Parameters:: style (int)
Return type:: str

StyleGetFont(self, style: int)¶

Get the font of a style.

Parameters:: style (int)
Return type:: wx.Font

StyleGetForeground(self, style: int)¶

Get the foreground colour of a style.

Parameters:: style (int)
Return type:: wx.Colour

StyleGetHotSpot(self, style: int)¶

Get is a style a hotspot or not.

Parameters:: style (int)
Return type:: bool

StyleGetItalic(self, style: int)¶

Get is a style italic or not.

Parameters:: style (int)
Return type:: bool

StyleGetSize(self, style: int)¶

Get the size of characters of a style.

Parameters:: style (int)
Return type:: int

StyleGetSizeFractional(self, style: int)¶

Get the size of characters of a style in points multiplied by 100.

Parameters:: style (int)
Return type:: int

StyleGetUnderline(self, style: int)¶

Get is a style underlined or not.

Parameters:: style (int)
Return type:: bool

StyleGetVisible(self, style: int)¶

Get is a style visible or not.

Parameters:: style (int)
Return type:: bool

StyleGetWeight(self, style: int)¶

Get the weight of characters of a style.

The return value will be an integer that is possibly one of the STC_WEIGHT_* constants.

Parameters:: style (int)
Return type:: int

StyleResetDefault(self)¶

Reset the default style to its state at startup.

Return type:: None

StyleSetBackground(self, style: int, back: Colour)¶

Set the background colour of a style.

Parameters:

style (int)
back (wx.Colour)

Return type:

None

StyleSetBold(self, style: int, bold: bool)¶

Set a style to be bold or not.

Parameters:

style (int)
bold (bool)

Return type:

None

StyleSetCase(self, style: int, caseVisible: int)¶

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

The second argument should be one of the STC_CASE_* constants.

Parameters:

style (int)
caseVisible (int)

Return type:

None

StyleSetChangeable(self, style: int, changeable: bool)¶

Set a style to be changeable or not (read only).

Experimental feature, currently buggy.

Parameters:

style (int)
changeable (bool)

Return type:

None

StyleSetCharacterSet(self, style: int, characterSet: int)¶

Set the character set of the font in a style.

Converts the Scintilla character set values to a FontEncoding.

Parameters:

style (int)
characterSet (int)

Return type:

None

StyleSetEOLFilled(self, style: int, eolFilled: bool)¶

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

Parameters:

style (int)
eolFilled (bool)

Return type:

None

StyleSetFaceName(self, style: int, fontName: str)¶

Set the font of a style.

Parameters:

style (int)
fontName (string)

Return type:

None

StyleSetFont(self, styleNum: int, font: Font)¶

Set style size, face, bold, italic, and underline attributes from a wx.Font’s attributes.

Parameters:

styleNum (int)
font (wx.Font)

Return type:

None

StyleSetFontAttr(self, styleNum: int, size: int, faceName: str, bold: bool, italic: bool, underline: bool, encoding: FontEncoding = FONTENCODING_DEFAULT)¶

Set all font style attributes at once.

Parameters:

styleNum (int)
size (int)
faceName (string)
bold (bool)
italic (bool)
underline (bool)
encoding (FontEncoding)

Return type:

None

StyleSetFontEncoding(self, style: int, encoding: FontEncoding)¶

Set the font encoding to be used by a style.

Parameters:

style (int)
encoding (FontEncoding)

Return type:

None

StyleSetForeground(self, style: int, fore: Colour)¶

Set the foreground colour of a style.

Parameters:

style (int)
fore (wx.Colour)

Return type:

None

StyleSetHotSpot(self, style: int, hotspot: bool)¶

Set a style to be a hotspot or not.

Parameters:

style (int)
hotspot (bool)

Return type:

None

StyleSetItalic(self, style: int, italic: bool)¶

Set a style to be italic or not.

Parameters:

style (int)
italic (bool)

Return type:

None

StyleSetSize(self, style: int, sizePoints: int)¶

Set the size of characters of a style.

Parameters:

style (int)
sizePoints (int)

Return type:

None

StyleSetSizeFractional(self, style: int, sizeHundredthPoints: int)¶

Set the size of characters of a style.

Size is in points multiplied by 100.

Parameters:

style (int)
sizeHundredthPoints (int)

Return type:

None

StyleSetSpec(self, styleNum: int, spec: str)¶

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

Parameters:

styleNum (int)
spec (string)

Return type:

None

StyleSetUnderline(self, style: int, underline: bool)¶

Set a style to be underlined or not.

Parameters:

style (int)
underline (bool)

Return type:

None

StyleSetVisible(self, style: int, visible: bool)¶

Set a style to be visible or not.

Parameters:

style (int)
visible (bool)

Return type:

None

StyleSetWeight(self, style: int, weight: int)¶

Set the weight of characters of a style.

The second argument can be an integer or one of the STC_WEIGHT_* constants.

Parameters:

style (int)
weight (int)

Return type:

None

SwapMainAnchorCaret(self)¶

Swap that caret and anchor of the main selection.

Return type:: None

Tab(self)¶

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.

Return type:: None

TargetFromSelection(self)¶

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

Return type:: None

TargetWholeDocument(self)¶

Sets the target to the whole document.

Return type:: None

Added in version 4.1/wxWidgets-3.1.1.

TextHeight(self, line: int)¶

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

Parameters:: line (int)
Return type:: int

TextWidth(self, style: int, text: str)¶

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

Does not handle tab or control characters.

Parameters:

style (int)
text (string)

Return type:

int

ToggleCaretSticky(self)¶

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

Return type:: None

ToggleFold(self, line: int)¶

Switch a header line between expanded and contracted.

Parameters:: line (int)
Return type:: None

ToggleFoldShowText(self, line: int, text: str)¶

Switch a header line between expanded and contracted and show some text after the line.

Parameters:

line (int)
text (string)

Return type:

None

Added in version 4.1/wxWidgets-3.1.1.

Undo(self)¶

Undo one action in the undo history.

Return type:: None

UpperCase(self)¶

Transform the selection to upper case.

Return type:: None

UsePopUp(self, popUpMode: int)¶

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 STC_POPUP_* constants.

Parameters:: popUpMode (int)
Return type:: None

Note

When wx.ContextMenuEvent is used to create a custom popup menu, this function should be called with wx.stc.STC_POPUP_NEVER. Otherwise the default menu will be shown instead of the custom one.

UserListShow(self, listType: int, itemList: str)¶

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

Parameters:

listType (int)
itemList (string)

Return type:

None

VCHome(self)¶

Move caret to before first visible character on line.

If already there move to first character on line.

Return type:: None

VCHomeDisplay(self)¶

Move caret to before first visible character on display line.

If already there move to first character on display line.

Return type:: None

Added in version 4.1/wxWidgets-3.1.0.

VCHomeDisplayExtend(self)¶

Like VCHomeDisplay but extending selection to new caret position.

Return type:: None

Added in version 4.1/wxWidgets-3.1.0.

VCHomeExtend(self)¶

Like VCHome but extending selection to new caret position.

Return type:: None

VCHomeRectExtend(self)¶

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.

Return type:: None

VCHomeWrap(self)¶

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

Return type:: None

VCHomeWrapExtend(self)¶

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

Return type:: None

VerticalCentreCaret(self)¶

Centre current line in window.

Return type:: None

VisibleFromDocLine(self, docLine: int)¶

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

Parameters:: docLine (int)
Return type:: int

WordEndPosition(self, pos: int, onlyWordCharacters: bool)¶

Get position of end of word.

Parameters:

pos (int)
onlyWordCharacters (bool)

Return type:

int

WordLeft(self)¶

Move caret left one word.

Return type:: None

WordLeftEnd(self)¶

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

Return type:: None

WordLeftEndExtend(self)¶

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

Return type:: None

WordLeftExtend(self)¶

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

Return type:: None

WordPartLeft(self)¶

Move to the previous change in capitalisation.

Return type:: None

WordPartLeftExtend(self)¶

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

Return type:: None

WordPartRight(self)¶

Move to the change next in capitalisation.

Return type:: None

WordPartRightExtend(self)¶

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

Return type:: None

WordRight(self)¶

Move caret right one word.

Return type:: None

WordRightEnd(self)¶

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

Return type:: None

WordRightEndExtend(self)¶

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

Return type:: None

WordRightExtend(self)¶

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

Return type:: None

WordStartPosition(self, pos: int, onlyWordCharacters: bool)¶

Get position of start of word.

Parameters:

pos (int)
onlyWordCharacters (bool)

Return type:

int

WrapCount(self, docLine: int)¶

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

Parameters:: docLine (int)
Return type:: int

WriteText(self, text: str)¶

Writes the text into the text control at the current insertion position.

Parameters:: text (string) – Text to write to the text control.
Return type:: None

Note

Newlines in the text string are the only control characters allowed, and they will cause appropriate line breaks. See operator<<() and AppendText for more convenient ways of writing to the window. After the write operation, the insertion point will be at the end of the inserted text, so subsequent write operations will be appended. To append text after the user may have interacted with the control, call wx.TextCtrl.SetInsertionPointEnd before writing.

XYToPosition(self, x: int, y: int)¶

Converts the given zero based column and line number to a position.

Parameters:

x (long) – The column number.
y (long) – The line number.

Return type:

int

Returns:

The position value, or -1 if x or y was invalid.

ZoomIn(self)¶

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

Return type:: None

ZoomOut(self)¶

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

Return type:: None

flush(self)¶

NOP, for file-like compatibility.

Return type:: None

write(self, text: str)¶

Append text to the textctrl, for file-like compatibility.

Return type:: None

Properties¶

AdditionalCaretForeground¶: See GetAdditionalCaretForeground and SetAdditionalCaretForeground

AdditionalCaretsBlink¶: See GetAdditionalCaretsBlink and SetAdditionalCaretsBlink

AdditionalCaretsVisible¶: See GetAdditionalCaretsVisible and SetAdditionalCaretsVisible

AdditionalSelAlpha¶: See GetAdditionalSelAlpha and SetAdditionalSelAlpha

AdditionalSelectionTyping¶: See GetAdditionalSelectionTyping and SetAdditionalSelectionTyping

AllLinesVisible¶: See GetAllLinesVisible

Anchor¶: See GetAnchor and SetAnchor

AutomaticFold¶: See GetAutomaticFold and SetAutomaticFold

BackSpaceUnIndents¶: See GetBackSpaceUnIndents and SetBackSpaceUnIndents

BufferedDraw¶: See GetBufferedDraw and SetBufferedDraw

CaretForeground¶: See GetCaretForeground and SetCaretForeground

CaretLineBackAlpha¶: See GetCaretLineBackAlpha and SetCaretLineBackAlpha

CaretLineBackground¶: See GetCaretLineBackground and SetCaretLineBackground

CaretLineVisible¶: See GetCaretLineVisible and SetCaretLineVisible

CaretLineVisibleAlways¶: See GetCaretLineVisibleAlways and SetCaretLineVisibleAlways

CaretPeriod¶: See GetCaretPeriod and SetCaretPeriod

CaretSticky¶: See GetCaretSticky and SetCaretSticky

CaretStyle¶: See GetCaretStyle and SetCaretStyle

CaretWidth¶: See GetCaretWidth and SetCaretWidth

CharacterPointer¶: See GetCharacterPointer

CodePage¶: See GetCodePage and SetCodePage

ControlCharSymbol¶: See GetControlCharSymbol and SetControlCharSymbol

CurLine¶: See GetCurLine

CurLineRaw¶: See GetCurLineRaw

CurrentLine¶: See GetCurrentLine

CurrentPos¶: See GetCurrentPos and SetCurrentPos

DefaultStyle¶: See GetDefaultStyle and SetDefaultStyle

DirectFunction¶: See GetDirectFunction

DirectPointer¶: See GetDirectPointer

DocPointer¶: See GetDocPointer and SetDocPointer

EOLMode¶: See GetEOLMode and SetEOLMode

EdgeColour¶: See GetEdgeColour and SetEdgeColour

EdgeColumn¶: See GetEdgeColumn and SetEdgeColumn

EdgeMode¶: See GetEdgeMode and SetEdgeMode

EndAtLastLine¶: See GetEndAtLastLine and SetEndAtLastLine

EndStyled¶: See GetEndStyled

ExtraAscent¶: See GetExtraAscent and SetExtraAscent

ExtraDescent¶: See GetExtraDescent and SetExtraDescent

FirstVisibleLine¶: See GetFirstVisibleLine and SetFirstVisibleLine

FontQuality¶: See GetFontQuality and SetFontQuality

GapPosition¶: See GetGapPosition

HighlightGuide¶: See GetHighlightGuide and SetHighlightGuide

Hint¶: See GetHint and SetHint

HotspotActiveBackground¶: See GetHotspotActiveBackground

HotspotActiveForeground¶: See GetHotspotActiveForeground

HotspotActiveUnderline¶: See GetHotspotActiveUnderline and SetHotspotActiveUnderline

HotspotSingleLine¶: See GetHotspotSingleLine and SetHotspotSingleLine

IMEInteraction¶: See GetIMEInteraction and SetIMEInteraction

Identifier¶: See GetIdentifier and SetIdentifier

IdleStyling¶: See GetIdleStyling and SetIdleStyling

Indent¶: See GetIndent and SetIndent

IndentationGuides¶: See GetIndentationGuides and SetIndentationGuides

IndicatorCurrent¶: See GetIndicatorCurrent and SetIndicatorCurrent

IndicatorValue¶: See GetIndicatorValue and SetIndicatorValue

InsertionPoint¶: See GetInsertionPoint and SetInsertionPoint

LastKeydownProcessed¶: See GetLastKeydownProcessed and SetLastKeydownProcessed

LastPosition¶: See GetLastPosition

LayoutCache¶: See GetLayoutCache and SetLayoutCache

Length¶: See GetLength

Lexer¶: See GetLexer and SetLexer

LexerLanguage¶: See GetLexerLanguage and SetLexerLanguage

LineCount¶: See GetLineCount

LineEndTypesActive¶: See GetLineEndTypesActive

LineEndTypesAllowed¶: See GetLineEndTypesAllowed and SetLineEndTypesAllowed

LineEndTypesSupported¶: See GetLineEndTypesSupported

MainSelection¶: See GetMainSelection and SetMainSelection

MarginCount¶: See GetMarginCount and SetMarginCount

MarginLeft¶: See GetMarginLeft and SetMarginLeft

MarginOptions¶: See GetMarginOptions and SetMarginOptions

MarginRight¶: See GetMarginRight and SetMarginRight

Margins¶: See GetMargins

MaxLineState¶: See GetMaxLineState

ModEventMask¶: See GetModEventMask and SetModEventMask

Modify¶: See GetModify

MouseDownCaptures¶: See GetMouseDownCaptures and SetMouseDownCaptures

MouseDwellTime¶: See GetMouseDwellTime and SetMouseDwellTime

MouseSelectionRectangularSwitch¶: See GetMouseSelectionRectangularSwitch and SetMouseSelectionRectangularSwitch

MouseWheelCaptures¶: See GetMouseWheelCaptures and SetMouseWheelCaptures

MultiPaste¶: See GetMultiPaste and SetMultiPaste

MultipleSelection¶: See GetMultipleSelection and SetMultipleSelection

NumberOfLines¶: See GetNumberOfLines

Overtype¶: See GetOvertype and SetOvertype

PasteConvertEndings¶: See GetPasteConvertEndings and SetPasteConvertEndings

PhasesDraw¶: See GetPhasesDraw and SetPhasesDraw

PositionCacheSize¶: See GetPositionCacheSize and SetPositionCacheSize

PrintColourMode¶: See GetPrintColourMode and SetPrintColourMode

PrintMagnification¶: See GetPrintMagnification and SetPrintMagnification

PrintWrapMode¶: See GetPrintWrapMode and SetPrintWrapMode

PunctuationChars¶: See GetPunctuationChars and SetPunctuationChars

RangePointer¶: See GetRangePointer

ReadOnly¶: See GetReadOnly and SetReadOnly

RectangularSelectionAnchor¶: See GetRectangularSelectionAnchor and SetRectangularSelectionAnchor

RectangularSelectionAnchorVirtualSpace¶: See GetRectangularSelectionAnchorVirtualSpace and SetRectangularSelectionAnchorVirtualSpace

RectangularSelectionCaret¶: See GetRectangularSelectionCaret and SetRectangularSelectionCaret

RectangularSelectionCaretVirtualSpace¶: See GetRectangularSelectionCaretVirtualSpace and SetRectangularSelectionCaretVirtualSpace

RectangularSelectionModifier¶: See GetRectangularSelectionModifier and SetRectangularSelectionModifier

STCCursor¶: See GetSTCCursor and SetSTCCursor

STCFocus¶: See GetSTCFocus and SetSTCFocus

ScrollWidth¶: See GetScrollWidth and SetScrollWidth

ScrollWidthTracking¶: See GetScrollWidthTracking and SetScrollWidthTracking

SearchFlags¶: See GetSearchFlags and SetSearchFlags

SelAlpha¶: See GetSelAlpha and SetSelAlpha

SelEOLFilled¶: See GetSelEOLFilled and SetSelEOLFilled

SelectedText¶: See GetSelectedText

SelectedTextRaw¶: See GetSelectedTextRaw

SelectionEmpty¶: See GetSelectionEmpty

SelectionEnd¶: See GetSelectionEnd and SetSelectionEnd

SelectionMode¶: See GetSelectionMode and SetSelectionMode

SelectionStart¶: See GetSelectionStart and SetSelectionStart

Selections¶: See GetSelections

Status¶: See GetStatus and SetStatus

StringSelection¶: See GetStringSelection

StyleBits¶: See GetStyleBits and SetStyleBits

StyleBitsNeeded¶: See GetStyleBitsNeeded

SubStyleBases¶: See GetSubStyleBases

TabDrawMode¶: See GetTabDrawMode and SetTabDrawMode

TabIndents¶: See GetTabIndents and SetTabIndents

TabWidth¶: See GetTabWidth and SetTabWidth

TargetEnd¶: See GetTargetEnd and SetTargetEnd

TargetStart¶: See GetTargetStart and SetTargetStart

TargetText¶: See GetTargetText

TargetTextRaw¶: See GetTargetTextRaw

Technology¶: See GetTechnology and SetTechnology

Text¶: See GetText and SetText

TextLength¶: See GetTextLength

TextRaw¶: See GetTextRaw and SetTextRaw

TwoPhaseDraw¶: See GetTwoPhaseDraw and SetTwoPhaseDraw

UndoCollection¶: See GetUndoCollection and SetUndoCollection

UseAntiAliasing¶: See GetUseAntiAliasing and SetUseAntiAliasing

UseHorizontalScrollBar¶: See GetUseHorizontalScrollBar and SetUseHorizontalScrollBar

UseTabs¶: See GetUseTabs and SetUseTabs

UseVerticalScrollBar¶: See GetUseVerticalScrollBar and SetUseVerticalScrollBar

Value¶: See GetValue and SetValue

ViewEOL¶: See GetViewEOL and SetViewEOL

ViewWhiteSpace¶: See GetViewWhiteSpace and SetViewWhiteSpace

VirtualSpaceOptions¶: See GetVirtualSpaceOptions and SetVirtualSpaceOptions

WhitespaceChars¶: See GetWhitespaceChars and SetWhitespaceChars

WhitespaceSize¶: See GetWhitespaceSize and SetWhitespaceSize

WordChars¶: See GetWordChars and SetWordChars

WrapIndentMode¶: See GetWrapIndentMode and SetWrapIndentMode

WrapMode¶: See GetWrapMode and SetWrapMode

WrapStartIndent¶: See GetWrapStartIndent and SetWrapStartIndent

WrapVisualFlags¶: See GetWrapVisualFlags and SetWrapVisualFlags

WrapVisualFlagsLocation¶: See GetWrapVisualFlagsLocation and SetWrapVisualFlagsLocation

XOffset¶: See GetXOffset and SetXOffset

Zoom¶: See GetZoom and SetZoom

`__init__`
`Create`	Create the UI elements for a `STC` that was created with the default constructor.

`GetIdentifier`	Get the identifier.
`GetModEventMask`	Get which document modification events are sent to the container.
`GetMouseDwellTime`	Retrieve the time the mouse must sit still to generate a mouse dwell event.
`SetIdentifier`	Set the identifier reported as idFrom in notification messages.
`SetModEventMask`	Set which document modification events are sent to the container.
`SetMouseDwellTime`	Sets the time the mouse must sit still to generate a mouse dwell event.

Navigation

wx.stc.StyledTextCtrl¶

Index of the member groups¶

Class Hierarchy¶

Methods Summary¶

Constructors and Related Methods¶

Additional wxPython Methods¶

Text Retrieval and Modification¶

Searching and Replacing¶

Overtype¶

Cut Copy and Paste¶

Error Handling¶

Undo and Redo¶

Selection and Information¶

Multiple Selection and Virtual Space¶

Scrolling and Automatic Scrolling¶

White Space¶

Cursor¶

Mouse Capture¶

Line Endings¶

Words¶

Styling¶

Style Definition¶

Caret Selection and Hotspot Styles¶

Character Representations¶

Margins¶

Annotations¶

Other Settings¶

Brace Highlighting¶

Tabs and Indentation Guides¶

Markers¶

Indicators¶

Autocompletion¶

User Lists¶

Call Tips¶

Keyboard Commands¶

Key Bindings¶

Popup Edit Menu¶

Macro Recording¶

Printing¶

Direct Access¶

Multiple Views¶

Background Loading and Saving¶

Folding¶

Line Wrapping¶

Zooming¶

Long Lines¶

Lexer¶

Event Related Items¶

Deprecated Items¶

Additional wxStyledTextCtrl Methods¶

Raw Variants¶

Text Entry Methods¶

Text Area Methods¶

Properties Summary¶

Class API¶

Methods¶

Properties¶