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

• 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 <#raw_variants >`_

• Text entry methods

• Text area methods

See also

wx.stc.StyledTextEvent

Class Hierarchy

Inheritance diagram for class StyledTextCtrl:

Methods Summary

__init__	Ctor.
AddRefDocument	Extend life of document.
AddSelection	Add a selection.
AddStyledText	Add array of cells to document.
AddTabStop	Add an explicit tab stop for a line.
AddText	Add text to the document at current position.
AddTextRaw	Add text to the document at current position.
AddUndoAction	Add a container action to the undo stack.
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.
AllocateSubStyles	Allocate a set of sub styles for a particular base style, returning start of range.
AnnotationClearAll	Clear the annotations from all lines.
AnnotationClearLine	Clear annotations from the given line.
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.
AppendText	Append a string to the end of the document without changing the selection.
AppendTextRaw	Append a string to the end of the document without changing the selection.
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.
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.
BackTab	Dedent the selected lines.
BeginUndoAction	Start a sequence of actions that is undone and redone as a unit.
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.
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.
CanCopy	Returns True if the selection can be copied to the clipboard.
CanCut	Returns True if the selection can be cut to the clipboard.
CanPaste	Will a paste succeed?
CanRedo	Are there any redoable actions in the undo history?
CanUndo	Are there any undoable actions in the undo history?
Cancel	Cancel any modes such as call tip or auto-completion list display.
ChangeInsertion	Change the text that is being inserted in response to wx.stc.STC_MOD_INSERTCHECK.
ChangeLexerState	Indicate that the internal state of a lexer has changed over a range and therefore there may be a need to redraw.
ChangeValue	Sets the new text control value.
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.
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.
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.
ChooseCaretX	Set the last x chosen value to be the caret x position.
Clear	Clear the selection.
ClearAll	Delete all text in the document.
ClearDocumentStyle	Set all style bytes to 0, remove all folding information.
ClearRegisteredImages	Clear all the registered images.
ClearRepresentation	Remove a character representation.
ClearSelections	Clear selections to a single empty stream selection.
ClearTabStops	Clear explicit tabstops on a line.
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.
CmdKeyExecute	Perform one of the operations defined by the STC_CMD_ constants.
Colourise	Colourise a segment of the document using the current lexing language.
ContractedFoldNext	Find the next line at or after lineStart that is a contracted fold header line.
ConvertEOLs	Convert all line endings in the document to one mode.
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.
CountCharacters	Count characters between two positions.
Create	Create the UI elements for a STC that was created with the default constructor.
CreateDocument	Create a new document object.
CreateLoader	Create an ILoader.
Cut	Cut the selection to the clipboard.
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.
DeleteRange	Delete a range of text in the document.
DescribeKeyWordSets	Retrieve a ‘\n’ separated list of descriptions of the keyword sets understood by the current lexer.
DescribeProperty	Describe a property.
DiscardEdits	Resets the internal modified flag as if the current changes had been saved.
DistanceToSecondaryStyles	Where styles are duplicated by a feature such as active/inactive code return the distance between the two types.
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.
DocLineFromVisible	Find the document line of a display line taking hidden lines into account.
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.
DropSelectionN	Drop one selection.
EditToggleOvertype	Switch from insert to overtype mode or the reverse.
EmptyUndoBuffer	Delete the undo history.
EndUndoAction	End a sequence of actions that is undone and redone as a unit.
EnsureCaretVisible	Ensure the caret is visible.
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.
FindColumn	Find the position of a column on a line taking into account tabs and multi-byte characters.
FindText	Find some text in the document.
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.
ForceUpper	Convert all text entered into the control to upper case.
FormFeed	Insert a Form Feed character.
FormatRange	On Windows, will draw the document into a display context such as a printer.
FreeSubStyles	Free allocated sub styles.
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.
GetAllLinesVisible	Are all lines visible?
GetAnchor	Returns the position of the opposite end of the selection to the caret.
GetAutomaticFold	Get automatic folding behaviours.
GetBackSpaceUnIndents	Does a backspace pressed when caret is within indentation unindent?
GetBufferedDraw	Is drawing done first into a buffer or direct to the screen?
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.
GetCharAt	Returns the character byte at the position.
GetCharacterPointer	Compact the document buffer and return a read-only memoryview
GetClassDefaultAttributes
GetCodePage	Get the code page used to interpret the bytes of the document as characters.
GetColumn	Retrieve the column number of a position, taking tab width into account.
GetControlCharSymbol	Get the way control characters are displayed.
GetCurLine	Retrieve the text of the line containing the caret.
GetCurLineRaw	Retrieve the text of the line containing the caret.
GetCurrentLine	Returns the line number of the line with the caret.
GetCurrentPos	Returns the position of the caret.
GetDefaultStyle	Returns the style currently used for the new text.
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.
GetDocPointer	Retrieve a pointer to the document object.
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.
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.
GetEndAtLastLine	Retrieve whether the maximum scroll position has the last line at the bottom of the view.
GetEndStyled	Retrieve the position of the last correctly styled character.
GetExtraAscent	Get extra ascent for each line.
GetExtraDescent	Get extra descent for each line.
GetFirstVisibleLine	Retrieve the display line at the top of the display.
GetFoldExpanded	Is a header line expanded?
GetFoldLevel	Retrieve the fold level of a line.
GetFoldParent	Find the parent line of a child line.
GetFontQuality	Retrieve the quality level for text.
GetGapPosition	Return a position which, to avoid performance costs, should not be within the range of a call to GetRangePointer.
GetHighlightGuide	Get the highlighted indentation guide column.
GetHint	Returns the current hint string.
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.
GetIMEInteraction	Is the IME displayed in a window or inline?
GetIdentifier	Get the identifier.
GetIdleStyling	Retrieve the limits to idle styling.
GetIndent	Retrieve indentation size.
GetIndentationGuides	Are the indentation guides visible?
GetIndicatorCurrent	Get the current indicator.
GetIndicatorValue	Get the current indicator value.
GetInsertionPoint	Returns the insertion point, or cursor, position.
GetLastChild	Find the last child line of a header line.
GetLastKeydownProcessed	Can be used to prevent the EVT_CHAR handler from adding the char.
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.
GetLayoutCache	Retrieve the degree of caching of layout information.
GetLength	Returns the number of bytes in the document.
GetLexer	Retrieve the lexing language of the document.
GetLexerLanguage	Retrieve the lexing language of the document.
GetLibraryVersionInfo	Returns the version of the Scintilla library used by this control.
GetLine	Retrieve the contents of a line.
GetLineCount	Returns the number of lines in the document.
GetLineEndPosition	Get the position after the last visible characters on a line.
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.
GetLineIndentPosition	Retrieve the position before the first non indentation character on a line.
GetLineIndentation	Retrieve the number of columns that a line is indented.
GetLineLength	Gets the length of the specified line, not including any trailing newline character(s).
GetLineRaw	Retrieve the contents of 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).
GetLineState	Retrieve the extra styling information for a line.
GetLineText	Returns the contents of a given line in the text control, not including any trailing newline character(s).
GetLineVisible	Is a line visible?
GetMainSelection	Which selection is the main selection.
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.
GetMargins	Returns the margins used by the control.
GetMarkerSymbolDefined	Which symbol was defined for markerNumber with MarkerDefine.
GetMaxLineState	Retrieve the last line number that has line state.
GetModEventMask	Get which document modification events are sent to the container.
GetModify	Is the document different from when it was last saved?
GetMouseDownCaptures	Get whether mouse gets captured.
GetMouseDwellTime	Retrieve the time the mouse must sit still to generate a mouse dwell event.
GetMouseSelectionRectangularSwitch	Whether switching to rectangular mode while selecting with the mouse is allowed.
GetMouseWheelCaptures	Get whether mouse wheel can be active outside the window.
GetMultiPaste	Retrieve the effect of pasting when there are multiple selections.
GetMultipleSelection	Whether multiple selections can be made.
GetNextTabStop	Find the next explicit tab stop position on a line after a position.
GetNumberOfLines	Returns the number of lines in the text control buffer.
GetOvertype	Returns True if overtype mode is active otherwise False is returned.
GetPasteConvertEndings	Get convert-on-paste setting.
GetPhasesDraw	How many phases is drawing done in?
GetPositionCacheSize	How many entries are allocated to the position cache?
GetPrimaryStyleFromStyle	For a secondary style, return the primary style, else return the argument.
GetPrintColourMode	Returns the print colour mode.
GetPrintMagnification	Returns the print magnification.
GetPrintWrapMode	Is printing line wrapped?
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.
GetPunctuationChars	Get the set of characters making up punctuation characters.
GetRange	Returns the string containing the text starting in the positions from and up to to in the control.
GetRangePointer	Return a read-only pointer to a range of characters in the
GetReadOnly	In read-only mode?
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.
GetRepresentation	Set the way a character is drawn.
GetSTCCursor	Get cursor type.
GetSTCFocus	Get internal focus flag.
GetScrollWidth	Retrieve the document width assumed for scrolling.
GetScrollWidthTracking	Retrieve whether the scroll width tracks wide lines.
GetSearchFlags	Get the search flags used by SearchInTarget.
GetSelAlpha	Get the alpha of the selection.
GetSelEOLFilled	Is the selection end of line filled?
GetSelectedText	Retrieve the selected text.
GetSelectedTextRaw	Retrieve the selected text.
GetSelection	Gets the current selection span.
GetSelectionEmpty	Is every selected range empty?
GetSelectionEnd	Returns the position at the end of the selection.
GetSelectionMode	Get the mode of the current selection.
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.
GetSelectionStart	Returns the position at the start of the selection.
GetSelections	How many selections are there?
GetStatus	Get error status.
GetStringSelection	Gets the text currently selected in the control.
GetStyle	This method is inherited from TextAreaBase but is not implemented in wx.stc.StyledTextCtrl.
GetStyleAt	Returns the style byte at the position.
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.
GetStyleFromSubStyle	For a sub style, return the base style, else return the argument.
GetStyledText	Retrieve a buffer of cells.
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.
GetTabDrawMode	Retrieve the current tab draw mode.
GetTabIndents	Does a tab pressed when caret is within indentation indent?
GetTabWidth	Retrieve the visible size of a tab.
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.
GetTargetTextRaw	Retrieve the target text.
GetTechnology	Get the tech.
GetText	Retrieve all the text in the document.
GetTextLength	Retrieve the number of characters in the document.
GetTextRange	Retrieve a range of text.
GetTextRangeRaw	Retrieve a range of text.
GetTextRaw	Retrieve all the text in the document.
GetTwoPhaseDraw	Is drawing done in two phases with backgrounds drawn before foregrounds?
GetUndoCollection	Is undo history being collected?
GetUseAntiAliasing	Returns the current UseAntiAliasing setting.
GetUseHorizontalScrollBar	Is the horizontal scroll bar visible?
GetUseTabs	Retrieve whether tabs will be used in indentation.
GetUseVerticalScrollBar	Is the vertical scroll bar visible?
GetValue	Gets the contents of the control.
GetViewEOL	Are the end of line characters visible?
GetViewWhiteSpace	Are white space characters currently visible? Returns one of STC_WS_ constants.
GetVirtualSpaceOptions	Return options for virtual space behaviour.
GetWhitespaceChars	Get the set of characters making up whitespace for when moving or selecting by word.
GetWhitespaceSize	Get the size of the dots used to mark space characters.
GetWordChars	Get the set of characters making up words for when moving or selecting by word.
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.
GetXOffset	Get the xOffset (ie, horizontal scroll position).
GetZoom	Retrieve the zoom level.
GotoLine	Set caret to start of a line and ensure it is visible.
GotoPos	Set caret to a position and ensure it is visible.
HideLines	Make a range of lines invisible.
HideSelection	Draw the selection in normal style or with selection highlighted.
HitTestPos	Finds the position of the character at the specified point.
HitTest	Finds the row and column of the character at the specified point.
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.
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?
InsertText	Insert string at a position.
InsertTextRaw	Insert string at a position.
IsEditable	Returns True if the controls contents may be edited by user (note that it always can be changed by the program).
IsEmpty	Returns True if the control is currently empty.
IsModified	Returns True if the text has been modified by user.
IsRangeWord	Is the range start..end considered a word?
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.
LineFromPosition	Retrieve the line containing a position.
LineLength	How many characters are on a line, including end of line characters?
LineScroll	Scroll horizontally and vertically.
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.
LinesJoin	Join the lines in the target.
LinesOnScreen	Retrieves the number of lines completely visible.
LinesSplit	Split the lines in the target into lines that are less wide than pixelWidth where possible.
LoadFile	Load the contents of filename into the editor.
LoadLexerLibrary	Load a lexer library (dll / so).
LowerCase	Transform the selection to lower case.
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.
MarkDirty	Mark text as modified (dirty).
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.
MarkerDefineBitmap	Define a marker with a wx.Bitmap.
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.
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.
MultiEdgeAddLine	Add a new vertical edge to the view.
MultiEdgeClearAll	Clear all vertical edges.
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.
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).
Paste	Paste the contents of the clipboard into the document replacing 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.
PositionToCoords	Converts given text position to client coordinates in pixels.
PositionToXY	Converts given position to a zero-based column, line number pair.
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.
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.
Redo	Redoes the next action on the undo history.
RegisterImage	Register an image for use in autocompletion lists.
RegisterRGBAImage	Register an RGBA image for use in autocompletion lists.
ReleaseAllExtendedStyles	Release all extended (>255) style numbers.
ReleaseDocument	Release a reference to the document, deleting document if it fades to black.
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.
ReplaceSelection	Replace the selected text with the argument text.
ReplaceSelectionRaw	Replace the current selection with text.
ReplaceTarget	Replace the target text with the argument text.
ReplaceTargetRE	Replace the target text with the argument text after \d processing.
ReplaceTargetRERaw	Replace the current target with text using regular expressions.
ReplaceTargetRaw	Replace the current target with text.
RotateSelection	Set the main selection to the next selection.
SaveFile	Write the contents of the editor to filename.
ScrollRange	Scroll the argument positions and the range between them into view giving priority to the primary position then the secondary position.
ScrollToColumn	Scroll enough to make the given column visible.
ScrollToEnd	Scroll to end of document.
ScrollToLine	Scroll enough to make the given line visible.
ScrollToStart	Scroll to start of document.
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.
SelectAll	Select all the text in the document.
SelectNone	Deselects selected text in the control.
SelectionDuplicate	Duplicate the selection.
SelectionIsRectangle	Is the selection rectangular? The alternative is the more common stream selection.
SendMsg	Scintilla API call.
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.
SetAnchor	Set the selection anchor to a position.
SetAutomaticFold	Set automatic folding behaviours.
SetBackSpaceUnIndents	Sets whether a backspace pressed when caret is within indentation unindents.
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.
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.
SetCharsDefault	Reset the set of characters for whitespace and word characters to the defaults.
SetCodePage	Set the code page used to interpret the bytes of the document as characters.
SetControlCharSymbol	Change the way control characters are displayed: If symbol is < 32, keep the drawn way, else, use the given character.
SetCurrentPos	Sets the position of the caret.
SetDefaultStyle	This method is inherited from TextAreaBase but is not implemented in wx.stc.StyledTextCtrl.
SetDocPointer	Change the document object used.
SetEOLMode	Set the current end of line mode.
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``).
SetEditable	Makes the text item editable or read-only, overriding the wx.TE_READONLY flag.
SetEmptySelection	Set caret to a position, while removing any existing selection.
SetEndAtLastLine	Sets the scroll range so that maximum scroll position has the last line at the bottom of the view (default).
SetExtraAscent	Set extra ascent for each line.
SetExtraDescent	Set extra descent for each line.
SetFirstVisibleLine	Scroll so that a display line is at the top of the display.
SetFoldExpanded	Show the children of a header line.
SetFoldFlags	Set some style options for folding.
SetFoldLevel	Set the fold level of a line.
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.
SetFontQuality	Choose the quality level for text.
SetHScrollBar	Set the horizontal scrollbar to use instead of the one that’s built-in.
SetHighlightGuide	Set the highlighted indentation guide column.
SetHint	Sets a hint shown in an empty unfocused text control.
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.
SetIMEInteraction	Choose to display the IME in a winow or inline.
SetIdentifier	Set the identifier reported as idFrom in notification messages.
SetIdentifiers	Set the identifiers that are shown in a particular style.
SetIdleStyling	Sets limits to idle styling.
SetIndent	Set the number of spaces used for one level of indentation.
SetIndentationGuides	Show or hide indentation guides.
SetIndicatorCurrent	Set the indicator used for IndicatorFillRange and IndicatorClearRange.
SetIndicatorValue	Set the value used for IndicatorFillRange.
SetInsertionPoint	Sets the insertion point at the given position.
SetInsertionPointEnd	Sets the insertion point at the end of the text control.
SetKeyWords	Set up the key words used by the lexer.
SetLastKeydownProcessed	Returns the line number of the line with the caret.
SetLayoutCache	Sets the degree of caching of layout information.
SetLexer	Set the lexing language of the document.
SetLexerLanguage	Set the lexing language of the document based on string name.
SetLineEndTypesAllowed	Set the line end types that the application wants to use.
SetLineIndentation	Change the indentation of a line to a number of columns.
SetLineState	Used to hold extra styling information for each line.
SetMainSelection	Set the main selection.
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.
SetMargins	Set the left and right margin in the edit area, measured in pixels.
SetMaxLength	This function sets the maximum number of characters the user can enter into the control.
SetModEventMask	Set which document modification events are sent to the container.
SetModified	Marks the control as being modified by the user or not.
SetMouseDownCaptures	Set whether the mouse is captured when its button is pressed.
SetMouseDwellTime	Sets the time the mouse must sit still to generate a mouse dwell event.
SetMouseSelectionRectangularSwitch	Set whether switching to rectangular mode while selecting with the mouse is allowed.
SetMouseWheelCaptures	Set whether the mouse wheel can be active outside the window.
SetMultiPaste	Change the effect of pasting when there are multiple selections.
SetMultipleSelection	Set whether multiple selections can be made.
SetOvertype	Set to overtype (True) or insert mode.
SetPasteConvertEndings	Enable/Disable convert-on-paste for line endings.
SetPhasesDraw	In one phase draw, text is drawn in a series of rectangular blocks with no overlap.
SetPositionCacheSize	Set number of entries in position cache.
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``).
SetProperty	Set up a value that may be used by a lexer for some optional feature.
SetPunctuationChars	Set the set of characters making up punctuation characters Should be called after SetWordChars.
SetReadOnly	Set to read only or read write.
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.
SetRepresentation	Set the way a character is drawn.
SetSTCCursor	Sets the cursor to one of the STC_CURSOR values.
SetSTCFocus	Change internal focus flag.
SetSavePoint	Remember the current position in the undo history as the position at which the document was saved.
SetScrollWidth	Sets the document width assumed for scrolling.
SetScrollWidthTracking	Sets whether the maximum width line displayed is used to set scroll width.
SetSearchFlags	Set the search flags used by SearchInTarget.
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.
SetSelection	Selects the text starting at the first position up to (but not including) the character at the last position.
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``).
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.
SetSelectionStart	Sets the position that starts the selection - this becomes the anchor.
SetStatus	Change error status - 0 = wx.OK.
SetStyle	This method is inherited from TextAreaBase but is not implemented in wx.stc.StyledTextCtrl.
SetStyleBits	Divide each styling byte into lexical class bits (default: 5) and indicator bits (default: 3).
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.
SetTabDrawMode	Set how tabs are drawn when visible.
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.
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.
SetTechnology	Set the technology used.
SetText	Replace the contents of the document with the argument text.
SetTextRaw	Replace the contents of the document with the argument text.
SetTwoPhaseDraw	In twoPhaseDraw mode, drawing is performed in two phases, first the background and then the foreground.
SetUndoCollection	Choose between collecting actions into the undo history and discarding them.
SetUseAntiAliasing	Specify whether anti-aliased fonts should be used.
SetUseHorizontalScrollBar	Show or hide the horizontal scroll bar.
SetUseTabs	Indentation will only use space characters if useTabs is False, otherwise it will use a combination of tabs and spaces.
SetUseVerticalScrollBar	Show or hide the vertical scroll bar.
SetVScrollBar	Set the vertical scrollbar to use instead of the one that’s built-in.
SetValue	Sets the new text control value.
SetViewEOL	Make the end of line characters visible or invisible.
SetViewWhiteSpace	Make white space characters invisible, always visible or visible outside indentation.
SetVirtualSpaceOptions	Set options for virtual space behaviour.
SetVisiblePolicy	Set the way the display area is determined when a particular line is to be moved to by Find, FindNext, GotoLine, etc.
SetWhitespaceBackground	Set the background colour of all whitespace and whether to use this setting.
SetWhitespaceChars	Set the set of characters making up whitespace for when moving or selecting by word.
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.
SetWordChars	Set the set of characters making up words for when moving or selecting by word.
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.
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.
SetZoom	Set the zoom level.
ShowLines	Make a range of lines visible.
ShowPosition	Makes the line containing the given position visible.
StartRecord	Start notifying the container of all key presses and commands.
StartStyling	Set the current styling position to start.
StopRecord	Stop notifying the container of all key presses and commands.
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.
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.
StyleGetFont	Get the font 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.
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.
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.
StyleSetSpec	Extract style settings from a spec-string which is composed of one or more of the following comma separated elements
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.
SwapMainAnchorCaret	Swap that caret and anchor of the main selection.
Tab	If selection is empty or all on one line replace the selection with a tab character.
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.
TextHeight	Retrieve the height of a particular line of text in pixels.
TextWidth	Measure the pixel width of some text in a particular style.
ToggleCaretSticky	Switch between sticky and non-sticky: meant to be bound to a key.
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.
Undo	Undo one action in the undo history.
UpperCase	Transform the selection to upper case.
UsePopUp	Set whether a pop up menu is displayed automatically when the user presses the wrong mouse button on certain areas.
UserListShow	Display a list of strings and send notification when user chooses one.
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.
VisibleFromDocLine	Find the display line of a document line taking hidden lines into account.
WordEndPosition	Get position of end of word.
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.
WordStartPosition	Get position of start of word.
WrapCount	The number of display lines needed to wrap a document line.
WriteText	Writes the text into the text control at the current insertion position.
XYToPosition	Converts the given zero based column and line number to a position.
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.
flush	NOP, for file-like compatibility.
write	Append text to the textctrl, for file-like compatibility.

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, id=ID_ANY, pos=DefaultPosition, size=DefaultSize,
               style=0, name=STCNameStr)

StyledTextCtrl()

A wxWidgets implementation of the Scintilla source code editing component.

Methods

__init__(self, *args, **kw)

Overloaded Implementations:

---

__init__ (self, parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=0, name=STCNameStr)

Ctor.

Parameters:

• parent (wx.Window) –

• id (wx.WindowID) –

• pos (wx.Point) –

• size (wx.Size) –

• style (long) –

• name (string) –

---

__init__ (self)

Default constructor.

---

---

AddRefDocument(self, docPointer)

Extend life of document.

Parameters:

docPointer –

---

AddSelection(self, caret, anchor)

Add a selection.

Parameters:

• caret (int) –

• anchor (int) –

Return type:

int

---

AddStyledText(self, data)

Add array of cells to document.

Parameters:

data (MemoryBuffer) –

---

AddTabStop(self, line, x)

Add an explicit tab stop for a line.

Parameters:

• line (int) –

• x (int) –

New in version 4.1/wxWidgets-3.1.0.

---

AddText(self, text)

Add text to the document at current position.

Parameters:

text (string) –

---

AddTextRaw(self, text, length=-1)

Add text to the document at current position.

Parameters:

• text (int) –

• length (int) –

---

AddUndoAction(self, token, flags)

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

---

Allocate(self, bytes)

Enlarge the document to a particular size of text bytes.

Parameters:

bytes (int) –

---

AllocateExtendedStyles(self, numberStyles)

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

Parameters:

numberStyles (int) –

Return type:

int

New in version 4.1/wxWidgets-3.1.0.

---

AllocateSubStyles(self, styleBase, numberStyles)

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

Parameters:

• styleBase (int) –

• numberStyles (int) –

Return type:

int

New in version 4.1/wxWidgets-3.1.0.

---

AnnotationClearAll(self)

Clear the annotations from all lines.

---

AnnotationClearLine(self, line)

Clear annotations from the given line.

Parameters:

line (int) –

---

AnnotationGetLines(self, line)

Get the number of annotation lines for a line.

Parameters:

line (int) –

Return type:

int

---

AnnotationGetStyle(self, line)

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)

Get the annotation styles for a line.

Parameters:

line (int) –

Return type:

string

---

AnnotationGetText(self, line)

Get the annotation text for a line.

Parameters:

line (int) –

Return type:

string

---

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, style)

Set the style number for the annotations for a line.

Parameters:

• line (int) –

• style (int) –

---

AnnotationSetStyleOffset(self, style)

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

Parameters:

style (int) –

---

AnnotationSetStyles(self, line, styles)

Set the annotation styles for a line.

Parameters:

• line (int) –

• styles (string) –

---

AnnotationSetText(self, line, text)

Set the annotation text for a line.

Parameters:

• line (int) –

• text (string) –

---

AnnotationSetVisible(self, visible)

Set the visibility for the annotations for a view.

The input should be one of the ``STC_ANNOTATION_* `` constants.

Parameters:

visible (int) –

---

AppendText(self, text)

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

Parameters:

text (string) –

---

AppendTextRaw(self, text, length=-1)

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

Parameters:

• text (int) –

• length (int) –

---

AutoCompActive(self)

Is there an auto-completion list visible?

Return type:

bool

---

AutoCompCancel(self)

Remove the auto-completion list from the screen.

---

AutoCompComplete(self)

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

---

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:

string

New 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

New 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

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

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

Parameters:

select (string) –

---

AutoCompSetAutoHide(self, autoHide)

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

Parameters:

autoHide (bool) –

---

AutoCompSetCancelAtStart(self, cancel)

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

Parameters:

cancel (bool) –

---

AutoCompSetCaseInsensitiveBehaviour(self, behaviour)

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

---

AutoCompSetChooseSingle(self, chooseSingle)

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

Parameters:

chooseSingle (bool) –

---

AutoCompSetDropRestOfWord(self, dropRestOfWord)

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

Parameters:

dropRestOfWord (bool) –

---

AutoCompSetFillUps(self, characterSet)

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

Parameters:

characterSet (string) –

---

AutoCompSetIgnoreCase(self, ignoreCase)

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

Parameters:

ignoreCase (bool) –

---

AutoCompSetMaxHeight(self, rowCount)

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

The default is 5 rows.

Parameters:

rowCount (int) –

---

AutoCompSetMaxWidth(self, characterCount)

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

---

AutoCompSetMulti(self, multi)

Change the effect of autocompleting when there are multiple selections.

The input should be one of the ``STC_MULTIAUTOC_* `` constants.

Parameters:

multi (int) –

New in version 4.1/wxWidgets-3.1.0.

---

AutoCompSetOrder(self, order)

Set the way autocompletion lists are ordered.

The input should be one of the ``STC_ORDER_* `` constants.

Parameters:

order (int) –

New in version 4.1/wxWidgets-3.1.0.

---

AutoCompSetSeparator(self, separatorCharacter)

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

---

AutoCompSetTypeSeparator(self, separatorCharacter)

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

---

AutoCompShow(self, lengthEntered, itemList)

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

---

AutoCompStops(self, characterSet)

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

Parameters:

characterSet (string) –

---

AutoComplete(self, *args, **kw)

Overloaded Implementations:

---

AutoComplete (self, choices)

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.

New in version 2.9.0.

See also

AutoCompleteFileNames

---

AutoComplete (self, completer)

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.

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

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

New in version 2.9.0.

See also

AutoComplete

---

BackTab(self)

Dedent the selected lines.

---

BeginUndoAction(self)

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

May be nested.

---

BraceBadLight(self, pos)

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

Parameters:

pos (int) –

---

BraceBadLightIndicator(self, useSetting, indicator)

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

Parameters:

• useSetting (bool) –

• indicator (int) –

---

BraceHighlight(self, posA, posB)

Highlight the characters at two positions.

Parameters:

• posA (int) –

• posB (int) –

---

BraceHighlightIndicator(self, useSetting, indicator)

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

Parameters:

• useSetting (bool) –

• indicator (int) –

---

BraceMatch(self, pos, maxReStyle=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.

---

CallTipPosAtStart(self)

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

Return type:

int

New in version 4.1/wxWidgets-3.1.0.

---

CallTipSetBackground(self, back)

Set the background colour for the call tip.

Parameters:

back (wx.Colour) –

---

CallTipSetForeground(self, fore)

Set the foreground colour for the call tip.

Parameters:

fore (wx.Colour) –

---

CallTipSetForegroundHighlight(self, fore)

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

Parameters:

fore (wx.Colour) –

---

CallTipSetHighlight(self, highlightStart, highlightEnd)

Highlight a segment of the definition.

Parameters:

• highlightStart (int) –

• highlightEnd (int) –

---

CallTipSetPosAtStart(self, posStart)

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

Parameters:

posStart (int) –

---

CallTipSetPosition(self, above)

Set position of calltip, above or below text.

Parameters:

above (bool) –

---

CallTipShow(self, pos, definition)

Show a call tip containing a definition near position pos.

Parameters:

• pos (int) –

• definition (string) –

---

CallTipUseStyle(self, tabSize)

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

Parameters:

tabSize (int) –

---

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.

---

ChangeInsertion(self, length, text)

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

Parameters:

• length (int) –

• text (string) –

New in version 4.1/wxWidgets-3.1.0.

---

ChangeLexerState(self, start, end)

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)

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.

New in version 2.7.1.

---

CharLeft(self)

Move caret left one character.

---

CharLeftExtend(self)

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

---

CharLeftRectExtend(self)

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

---

CharPositionFromPoint(self, x, y)

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

Parameters:

• x (int) –

• y (int) –

Return type:

int

---

CharPositionFromPointClose(self, x, y)

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.

---

CharRightExtend(self)

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

---

CharRightRectExtend(self)

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

---

ChooseCaretX(self)

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

---

Clear(self)

Clear the selection.

---

ClearAll(self)

Delete all text in the document.

---

ClearDocumentStyle(self)

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

---

ClearRegisteredImages(self)

Clear all the registered images.

---

ClearRepresentation(self, encodedCharacter)

Remove a character representation.

Parameters:

encodedCharacter (string) –

New in version 4.1/wxWidgets-3.1.0.

---

ClearSelections(self)

Clear selections to a single empty stream selection.

---

ClearTabStops(self, line)

Clear explicit tabstops on a line.

Parameters:

line (int) –

New in version 4.1/wxWidgets-3.1.0.

---

CmdKeyAssign(self, key, modifiers, cmd)

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

---

CmdKeyClear(self, key, modifiers)

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

---

CmdKeyClearAll(self)

Drop all key mappings.

---

CmdKeyExecute(self, cmd)

Perform one of the operations defined by the STC_CMD_ constants.

Parameters:

cmd (int) –

---

Colourise(self, start, end)

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

Parameters:

• start (int) –

• end (int) –

---

ContractedFoldNext(self, lineStart)

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)

Convert all line endings in the document to one mode.

Parameters:

eolMode (int) –

---

Copy(self)

Copy the selection to the clipboard.

---

CopyAllowLine(self)

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

---

CopyRange(self, start, end)

Copy a range of text to the clipboard.

Positions are clipped into the document.

Parameters:

• start (int) –

• end (int) –

---

CopyText(self, length, text)

Copy argument text to the clipboard.

Parameters:

• length (int) –

• text (string) –

---

CountCharacters(self, start, end)

Count characters between two positions.

Parameters:

• start (int) –

• end (int) –

Return type:

int

---

Create(self, parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=0, name=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.

---

CreateLoader(self, bytes)

Create an ILoader.

Parameters:

bytes (int) –

---

Cut(self)

Cut the selection to the clipboard.

---

DelLineLeft(self)

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

---

DelLineRight(self)

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

---

DelWordLeft(self)

Delete the word to the left of the caret.

---

DelWordRight(self)

Delete the word to the right of the caret.

---

DelWordRightEnd(self)

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

---

DeleteBack(self)

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

---

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.

---

DeleteRange(self, start, lengthDelete)

Delete a range of text in the document.

Parameters:

• start (int) –

• lengthDelete (int) –

---

DescribeKeyWordSets(self)

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

Return type:

string

---

DescribeProperty(self, name)

Describe a property.

Parameters:

name (string) –

Return type:

string

---

DiscardEdits(self)

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

---

DistanceToSecondaryStyles(self)

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

Return type:

int

New in version 4.1/wxWidgets-3.1.0.

---

DoDragEnter(self, x, y, defaultRes)

Allow for simulating a DnD DragEnter.

Parameters:

• x (int) –

• y (int) –

• defaultRes (DragResult) –

Return type:

wx.DragResult

New in version 4.1/wxWidgets-3.1.0.

---

DoDragLeave(self)

Allow for simulating a DnD DragLeave.

New in version 4.1/wxWidgets-3.1.0.

---

DoDragOver(self, x, y, defaultRes)

Allow for simulating a DnD DragOver.

Parameters:

• x (int) –

• y (int) –

• defaultRes (DragResult) –

Return type:

wx.DragResult

---

DoDropText(self, x, y, data)

Allow for simulating a DnD DropText.

Parameters:

• x (long) –

• y (long) –

• data (string) –

Return type:

bool

---

DocLineFromVisible(self, displayLine)

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.

---

DocumentEndExtend(self)

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

---

DocumentStart(self)

Move caret to first position in document.

---

DocumentStartExtend(self)

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

---

DropSelectionN(self, selection)

Drop one selection.

Parameters:

selection (int) –

New in version 4.1/wxWidgets-3.1.0.

---

EditToggleOvertype(self)

Switch from insert to overtype mode or the reverse.

---

EmptyUndoBuffer(self)

Delete the undo history.

---

EndUndoAction(self)

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

---

EnsureCaretVisible(self)

Ensure the caret is visible.

---

EnsureVisible(self, line)

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

Parameters:

line (int) –

---

EnsureVisibleEnforcePolicy(self, line)

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

---

ExpandChildren(self, line, level)

Expand a fold header and all children.

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

Parameters:

• line (int) –

• level (int) –

New in version 4.1/wxWidgets-3.1.0.

---

FindColumn(self, line, column)

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, maxPos, text, flags=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

Returns:

( int, findEnd )

Note

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

---

FoldAll(self, action)

Expand or contract all fold headers.

The input should be one of the ``STC_FOLDACTION_* `` constants.

Parameters:

action (int) –

New in version 4.1/wxWidgets-3.1.0.

---

FoldChildren(self, line, action)

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

New in version 4.1/wxWidgets-3.1.0.

---

FoldDisplayTextSetStyle(self, style)

Set the style of fold display text.

The input should be one of the ``STC_FOLDDISPLAYTEXT_* `` constants.

Parameters:

style (int) –

New in version 4.1/wxWidgets-3.1.1.

---

FoldLine(self, line, action)

Expand or contract a fold header.

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

Parameters:

• line (int) –

• action (int) –

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

New in version 4.1/wxWidgets-3.1.0.

---

FormFeed(self)

Insert a Form Feed character.

---

FormatRange(self, doDraw, startPos, endPos, draw, target, renderRect, pageRect)

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.

New 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

New 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

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

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:

PyObject

---

static GetClassDefaultAttributes(variant=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)

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

Returns:

( String , linePos )

---

GetCurLineRaw(self)

Retrieve the text of the line containing the caret.

Returns the index of the caret on the line.

Return type:

tuple

Returns:

( CharBuffer , linePos )

---

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.

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

New in version 4.1/wxWidgets-3.1.1.

---

GetDocPointer(self)

Retrieve a pointer to the document object.

---

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)

Is a header line expanded?

Parameters:

line (int) –

Return type:

bool

---

GetFoldLevel(self, line)

Retrieve the fold level of a line.

Parameters:

line (int) –

Return type:

int

---

GetFoldParent(self, line)

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

New 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:

string

New 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

New 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

New 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:

long

---

GetLastChild(self, line, level)

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:

long

---

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:

string

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

Retrieve the contents of a line.

Parameters:

line (int) –

Return type:

string

---

GetLineCount(self)

Returns the number of lines in the document.

There is always at least one.

Return type:

int

---

GetLineEndPosition(self, line)

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

New 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

New 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

New in version 4.1/wxWidgets-3.1.0.

---

GetLineIndentPosition(self, line)

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

Parameters:

line (int) –

Return type:

int

---

GetLineIndentation(self, line)

Retrieve the number of columns that a line is indented.

Parameters:

line (int) –

Return type:

int

---

GetLineLength(self, lineNo)

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)

Retrieve the contents of a line.

Parameters:

line (int) –

Return type:

CharBuffer

---

GetLineSelEndPosition(self, line)

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)

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)

Retrieve the extra styling information for a line.

Parameters:

line (int) –

Return type:

int

---

GetLineText(self, lineNo)

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:

string

Returns:

The contents of the line.

---

GetLineVisible(self, line)

Is a line visible?

Parameters:

line (int) –

Return type:

bool

---

GetMainSelection(self)

Which selection is the main selection.

Return type:

int

---

GetMarginBackground(self, margin)

Retrieve the background colour of a margin.

Parameters:

margin (int) –

Return type:

wx.Colour

New in version 4.1/wxWidgets-3.1.1.

---

GetMarginCount(self)

How many margins are there?.

Return type:

int

New in version 4.1/wxWidgets-3.1.1.

---

GetMarginCursor(self, margin)

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)

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)

Retrieve the mouse click sensitivity of a margin.

Parameters:

margin (int) –

Return type:

bool

---

GetMarginType(self, margin)

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)

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

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

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

New in version 4.1/wxWidgets-3.1.0.

---

GetMouseWheelCaptures(self)

Get whether mouse wheel can be active outside the window.

Return type:

bool

New 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, x)

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

Parameters:

• line (int) –

• x (int) –

Return type:

int

New 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

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

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

Parameters:

style (int) –

Return type:

int

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

Retrieve a “property” value previously set with SetProperty.

Parameters:

key (string) –

Return type:

string

---

GetPropertyExpanded(self, key)

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

Parameters:

key (string) –

Return type:

string

---

GetPropertyInt(self, key, defaultValue=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:

string

---

GetRange(self, from_, to_)

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:

string

---

GetRangePointer(self, position, rangeLength)

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:

PyObject

---

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)

Set the way a character is drawn.

Parameters:

encodedCharacter (string) –

Return type:

string

New 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:

string

---

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

---

GetSelectionEmpty(self)

Is every selected range empty?

Return type:

bool

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

Return the anchor position of the nth selection.

Parameters:

selection (int) –

Return type:

int

---

GetSelectionNAnchorVirtualSpace(self, selection)

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

Parameters:

selection (int) –

Return type:

int

---

GetSelectionNCaret(self, selection)

Return the caret position of the nth selection.

Parameters:

selection (int) –

Return type:

int

---

GetSelectionNCaretVirtualSpace(self, selection)

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

Parameters:

selection (int) –

Return type:

int

---

GetSelectionNEnd(self, selection)

Returns the position at the end of the selection.

Parameters:

selection (int) –

Return type:

int

---

GetSelectionNStart(self, selection)

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:

string

---

GetStyle(self, position, style)

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)

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)

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

Parameters:

subStyle (int) –

Return type:

int

New in version 4.1/wxWidgets-3.1.0.

---

GetStyledText(self, startPos, endPos)

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:

string

New in version 4.1/wxWidgets-3.1.0.

---

GetSubStylesLength(self, styleBase)

The number of sub styles associated with a base style.

Parameters:

styleBase (int) –

Return type:

int

New in version 4.1/wxWidgets-3.1.0.

---

GetSubStylesStart(self, styleBase)

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

Parameters:

styleBase (int) –

Return type:

int

New 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

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

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

Parameters:

tagNumber (int) –

Return type:

string

---

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:

string

New in version 4.1/wxWidgets-3.1.0.

---

GetTargetTextRaw(self)

Retrieve the target text.

Return type:

CharBuffer

New 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:

string

---

GetTextLength(self)

Retrieve the number of characters in the document.

Return type:

int

---

GetTextRange(self, startPos, endPos)

Retrieve a range of text.

Parameters:

• startPos (int) –

• endPos (int) –

Return type:

string

---

GetTextRangeRaw(self, startPos, endPos)

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:

string

---

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:

string

---

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:

string

---

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)

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

Parameters:

line (int) –

---

GotoPos(self, caret)

Set caret to a position and ensure it is visible.

Parameters:

caret (int) –

---

HideLines(self, lineStart, lineEnd)

Make a range of lines invisible.

Parameters:

• lineStart (int) –

• lineEnd (int) –

---

HideSelection(self, hide)

Draw the selection in normal style or with selection highlighted.

Parameters:

hide (bool) –

---

HitTestPos(self, pt)

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)

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.

---

HomeDisplay(self)

Move caret to first position on display line.

---

HomeDisplayExtend(self)

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

---

HomeExtend(self)

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

---

HomeRectExtend(self)

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

---

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.

---

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.

---

IndicatorAllOnFor(self, pos)

Are any indicators present at pos?

Parameters:

pos (int) –

Return type:

int

---

IndicatorClearRange(self, start, lengthClear)

Turn an indicator off over a range.

Parameters:

• start (int) –

• lengthClear (int) –

---

IndicatorEnd(self, indicator, pos)

Where does a particular indicator end?

Parameters:

• indicator (int) –

• pos (int) –

Return type:

int

---

IndicatorFillRange(self, start, lengthFill)

Turn an indicator on over a range.

Parameters:

• start (int) –

• lengthFill (int) –

---

IndicatorGetAlpha(self, indicator)

Get the alpha fill colour of the given indicator.

Parameters:

indicator (int) –

Return type:

int

---

IndicatorGetFlags(self, indicator)

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

New in version 4.1/wxWidgets-3.1.0.

---

IndicatorGetForeground(self, indicator)

Retrieve the foreground colour of an indicator.

Parameters:

indicator (int) –

Return type:

wx.Colour

---

IndicatorGetHoverForeground(self, indicator)

Retrieve the foreground hover colour of an indicator.

Parameters:

indicator (int) –

Return type:

wx.Colour

New in version 4.1/wxWidgets-3.1.0.

---

IndicatorGetHoverStyle(self, indicator)

Retrieve the hover style of an indicator.

Parameters:

indicator (int) –

Return type:

int

New in version 4.1/wxWidgets-3.1.0.

---

IndicatorGetOutlineAlpha(self, indicator)

Get the alpha outline colour of the given indicator.

Parameters:

indicator (int) –

Return type:

int

---

IndicatorGetStyle(self, indicator)

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)

Retrieve whether indicator drawn under or over text.

Parameters:

indicator (int) –

Return type:

bool

---

IndicatorSetAlpha(self, indicator, alpha)

Set the alpha fill colour of the given indicator.

Parameters:

• indicator (int) –

• alpha (int) –

---

IndicatorSetFlags(self, indicator, flags)

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

New in version 4.1/wxWidgets-3.1.0.

---

IndicatorSetForeground(self, indicator, fore)

Set the foreground colour of an indicator.

Parameters:

• indicator (int) –

• fore (wx.Colour) –

---

IndicatorSetHoverForeground(self, indicator, fore)

Set the foreground hover colour of an indicator.

Parameters:

• indicator (int) –

• fore (wx.Colour) –

New in version 4.1/wxWidgets-3.1.0.

---

IndicatorSetHoverStyle(self, indicator, indicatorStyle)

Set a hover indicator to plain, squiggle or TT.

Parameters:

• indicator (int) –

• indicatorStyle (int) –

New in version 4.1/wxWidgets-3.1.0.

---

IndicatorSetOutlineAlpha(self, indicator, alpha)

Set the alpha outline colour of the given indicator.

Parameters:

• indicator (int) –

• alpha (int) –

---

IndicatorSetStyle(self, indicator, indicatorStyle)

Set an indicator to plain, squiggle or TT.

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

Parameters:

• indicator (int) –

• indicatorStyle (int) –

---

IndicatorSetUnder(self, indicator, under)

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

Parameters:

• indicator (int) –

• under (bool) –

---

IndicatorStart(self, indicator, pos)

Where does a particular indicator start?

Parameters:

• indicator (int) –

• pos (int) –

Return type:

int

---

IndicatorValueAt(self, indicator, pos)

What value does a particular indicator have at a position?

Parameters:

• indicator (int) –

• pos (int) –

Return type:

int

---

InsertText(self, pos, text)

Insert string at a position.

Parameters:

• pos (int) –

• text (string) –

---

InsertTextRaw(self, pos, text)

Insert string at a position.

Parameters:

• pos (int) –

• text (int) –

---

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

New 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, end)

Is the range start..end considered a word?

Parameters:

• start (int) –

• end (int) –

Return type:

bool

New in version 4.1/wxWidgets-3.1.1.

---

LineCopy(self)

Copy the line containing the caret.

---

LineCut(self)

Cut the line containing the caret.

---

LineDelete(self)

Delete the line containing the caret.

---

LineDown(self)

Move caret down one line.

---

LineDownExtend(self)

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

---

LineDownRectExtend(self)

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

---

LineDuplicate(self)

Duplicate the current line.

---

LineEnd(self)

Move caret to last position on line.

---

LineEndDisplay(self)

Move caret to last position on display line.

---

LineEndDisplayExtend(self)

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

---

LineEndExtend(self)

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

---

LineEndRectExtend(self)

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

---

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.

---

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.

---

LineFromPosition(self, pos)

Retrieve the line containing a position.

Parameters:

pos (int) –

Return type:

int

---

LineLength(self, line)

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

Parameters:

line (int) –

Return type:

int

---

LineScroll(self, columns, lines)

Scroll horizontally and vertically.

Parameters:

• columns (int) –

• lines (int) –

---

LineScrollDown(self)

Scroll the document down, keeping the caret visible.

---

LineScrollUp(self)

Scroll the document up, keeping the caret visible.

---

LineTranspose(self)

Switch the current line with the previous.

---

LineUp(self)

Move caret up one line.

---

LineUpExtend(self)

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

---

LineUpRectExtend(self)

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

---

LinesJoin(self)

Join the lines in the target.

---

LinesOnScreen(self)

Retrieves the number of lines completely visible.

Return type:

int

---

LinesSplit(self, pixelWidth)

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

Parameters:

pixelWidth (int) –

---

LoadFile(self, filename)

Load the contents of filename into the editor.

Parameters:

filename (string) –

Return type:

bool

---

LoadLexerLibrary(self, path)

Load a lexer library (dll / so).

Parameters:

path (string) –

New in version 4.1/wxWidgets-3.1.1.

---

LowerCase(self)

Transform the selection to lower case.

---

MarginGetStyle(self, line)

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)

Get the styles in the text margin for a line.

Parameters:

line (int) –

Return type:

string

---

MarginGetText(self, line)

Get the text in the text margin for a line.

Parameters:

line (int) –

Return type:

string

---

MarginSetStyle(self, line, style)

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

Parameters:

• line (int) –

• style (int) –

---

MarginSetStyleOffset(self, style)

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

Parameters:

style (int) –

---

MarginSetStyles(self, line, styles)

Set the style in the text margin for a line.

Parameters:

• line (int) –

• styles (string) –

---

MarginSetText(self, line, text)

Set the text in the text margin for a line.

Parameters:

• line (int) –

• text (string) –

---

MarginTextClearAll(self)

Clear the margin text on all lines.

---

MarkDirty(self)

Mark text as modified (dirty).

See also

IsModified

---

MarkerAdd(self, line, markerNumber)

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, markerSet)

Add a set of markers to a line.

Parameters:

• line (int) –

• markerSet (int) –

---

MarkerDefine(self, markerNumber, markerSymbol, foreground=NullColour, background=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) –

---

MarkerDefineBitmap(self, markerNumber, bmp)

Define a marker with a wx.Bitmap.

Parameters:

• markerNumber (int) –

• bmp (wx.Bitmap) –

---

MarkerDefineRGBAImage(self, markerNumber, pixels)

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.

---

MarkerDelete(self, line, markerNumber)

Delete a marker from a line.

Parameters:

• line (int) –

• markerNumber (int) –

---

MarkerDeleteAll(self, markerNumber)

Delete all markers with a particular number from all lines.

Parameters:

markerNumber (int) –

---

MarkerDeleteHandle(self, markerHandle)

Delete a marker.

Parameters:

markerHandle (int) –

---

MarkerEnableHighlight(self, enabled)

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

Parameters:

enabled (bool) –

---

MarkerGet(self, line)

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

Parameters:

line (int) –

Return type:

int

---

MarkerLineFromHandle(self, markerHandle)

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

Parameters:

markerHandle (int) –

Return type:

int

---

MarkerNext(self, lineStart, markerMask)

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, markerMask)

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

Parameters:

• lineStart (int) –

• markerMask (int) –

Return type:

int

---

MarkerSetAlpha(self, markerNumber, alpha)

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

Parameters:

• markerNumber (int) –

• alpha (int) –

---

MarkerSetBackground(self, markerNumber, back)

Set the background colour used for a particular marker number.

Parameters:

• markerNumber (int) –

• back (wx.Colour) –

---

MarkerSetBackgroundSelected(self, markerNumber, back)

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

Parameters:

• markerNumber (int) –

• back (wx.Colour) –

---

MarkerSetForeground(self, markerNumber, fore)

Set the foreground colour used for a particular marker number.

Parameters:

• markerNumber (int) –

• fore (wx.Colour) –

---

MoveCaretInsideView(self)

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

---

MoveSelectedLinesDown(self)

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

---

MoveSelectedLinesUp(self)

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

---

MultiEdgeAddLine(self, column, edgeColour)

Add a new vertical edge to the view.

Parameters:

• column (int) –

• edgeColour (wx.Colour) –

New in version 4.1/wxWidgets-3.1.1.

---

MultiEdgeClearAll(self)

Clear all vertical edges.

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

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

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

---

PageDown(self)

Move caret one page down.

---

PageDownExtend(self)

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

---

PageDownRectExtend(self)

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

---

PageUp(self)

Move caret one page up.

---

PageUpExtend(self)

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

---

PageUpRectExtend(self)

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

---

ParaDown(self)

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

---

ParaDownExtend(self)

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

---

ParaUp(self)

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

---

ParaUpExtend(self)

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

---

Paste(self)

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

---

PointFromPosition(self, pos)

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

Parameters:

pos (int) –

Return type:

wx.Point

---

PositionAfter(self, pos)

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)

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)

Retrieve the position at the start of a line.

Parameters:

line (int) –

Return type:

int

---

PositionFromPoint(self, pt)

Find the position from a point within the window.

Parameters:

pt (wx.Point) –

Return type:

int

---

PositionFromPointClose(self, x, y)

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, relative)

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

New in version 4.1/wxWidgets-3.1.0.

---

PositionToCoords(self, pos)

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 .

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

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

Parameters:

pos (long) – Position.

Return type:

tuple

---

PrivateLexerCall(self, operation, pointer)

For private communication between an application and a known lexer.

Parameters:

• operation (int) –

• pointer –

---

PropertyNames(self)

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

Return type:

string

---

PropertyType(self, name)

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)

Set the height for future RGBA image data.

Parameters:

height (int) –

---

RGBAImageSetScale(self, scalePercent)

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

Parameters:

scalePercent (int) –

New in version 4.1/wxWidgets-3.1.0.

---

RGBAImageSetWidth(self, width)

Set the width for future RGBA image data.

Parameters:

width (int) –

---

Redo(self)

Redoes the next action on the undo history.

---

RegisterImage(self, type, bmp)

Register an image for use in autocompletion lists.

Parameters:

• type (int) –

• bmp (wx.Bitmap) –

---

RegisterRGBAImage(self, type, pixels)

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.

---

ReleaseAllExtendedStyles(self)

Release all extended (>255) style numbers.

New in version 4.1/wxWidgets-3.1.0.

---

ReleaseDocument(self, docPointer)

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

Parameters:

docPointer –

---

Remove(self, from_, to_)

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.

---

Replace(self, from_, to_, value)

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.

---

ReplaceSelection(self, text)

Replace the selected text with the argument text.

Parameters:

text (string) –

---

ReplaceSelectionRaw(self, text)

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.

New in version 4.1/wxWidgets-3.1.3.

---

ReplaceTarget(self, text)

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)

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, length=-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.

New in version 4.1/wxWidgets-3.1.3.

Note

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

See also

SearchInTarget

---

ReplaceTargetRaw(self, text, length=-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.

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

---

SaveFile(self, filename)

Write the contents of the editor to filename.

Parameters:

filename (string) –

Return type:

bool

---

ScrollRange(self, secondary, primary)

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

New in version 4.1/wxWidgets-3.1.0.

---

ScrollToColumn(self, column)

Scroll enough to make the given column visible.

Parameters:

column (int) –

---

ScrollToEnd(self)

Scroll to end of document.

---

ScrollToLine(self, line)

Scroll enough to make the given line visible.

Parameters:

line (int) –

---

ScrollToStart(self)

Scroll to start of document.

---

SearchAnchor(self)

Sets the current caret position to be the search anchor.

---

SearchInTarget(self, text)

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, text)

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, text)

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.

---

SelectNone(self)

Deselects selected text in the control.

New in version 2.9.5.

---

SelectionDuplicate(self)

Duplicate the selection.

If selection empty duplicate the line containing the caret.

---

SelectionIsRectangle(self)

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

Return type:

bool

---

SendMsg(self, msg, wp=0, lp=0)

Scintilla API call.

Parameters:

• msg (int) –

• wp (wx.UIntPtr) –

• lp (wx.IntPtr) –

Return type:

wx.IntPtr

---

SetAdditionalCaretForeground(self, fore)

Set the foreground colour of additional carets.

Parameters:

fore (wx.Colour) –

---

SetAdditionalCaretsBlink(self, additionalCaretsBlink)

Set whether additional carets will blink.

Parameters:

additionalCaretsBlink (bool) –

---

SetAdditionalCaretsVisible(self, additionalCaretsVisible)

Set whether additional carets are visible.

Parameters:

additionalCaretsVisible (bool) –

---

SetAdditionalSelAlpha(self, alpha)

Set the alpha of the selection.

Parameters:

alpha (int) –

---

SetAdditionalSelBackground(self, back)

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

---

SetAdditionalSelForeground(self, fore)

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

---

SetAdditionalSelectionTyping(self, additionalSelectionTyping)

Set whether typing can be performed into multiple selections.

Parameters:

additionalSelectionTyping (bool) –

---

SetAnchor(self, anchor)

Set the selection anchor to a position.

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

Parameters:

anchor (int) –

---

SetAutomaticFold(self, automaticFold)

Set automatic folding behaviours.

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

Parameters:

automaticFold (int) –

New in version 4.1/wxWidgets-3.1.0.

---

SetBackSpaceUnIndents(self, bsUnIndents)

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

Parameters:

bsUnIndents (bool) –

---

SetBufferedDraw(self, buffered)

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

---

SetCaretForeground(self, fore)

Set the foreground colour of the caret.

Parameters:

fore (wx.Colour) –

---

SetCaretLineBackAlpha(self, alpha)

Set background alpha of the caret line.

Parameters:

alpha (int) –

---

SetCaretLineBackground(self, back)

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

Parameters:

back (wx.Colour) –

---

SetCaretLineVisible(self, show)

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

Parameters:

show (bool) –

---

SetCaretLineVisibleAlways(self, alwaysVisible)

Sets the caret line to always visible.

Parameters:

alwaysVisible (bool) –

New in version 4.1/wxWidgets-3.1.0.

---

SetCaretPeriod(self, periodMilliseconds)

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

0 = steady on.

Parameters:

periodMilliseconds (int) –

---

SetCaretSticky(self, useCaretStickyBehaviour)

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

The input should be one of the ``STC_CARETSTICKY_* `` constants.

Parameters:

useCaretStickyBehaviour (int) –

---

SetCaretStyle(self, caretStyle)

Set the style of the caret to be drawn.

The input should be one of the ``STC_CARETSTYLE_* `` constants.

Parameters:

caretStyle (int) –

---

SetCaretWidth(self, pixelWidth)

Set the width of the insert mode caret.

Parameters:

pixelWidth (int) –

---

SetCharsDefault(self)

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

---

SetCodePage(self, codePage)

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

Parameters:

codePage (int) –

---

SetControlCharSymbol(self, symbol)

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

Parameters:

symbol (int) –

---

SetCurrentPos(self, caret)

Sets the position of the caret.

Parameters:

caret (int) –

---

SetDefaultStyle(self, style)

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

Parameters:

style (wx.TextAttr) –

Return type:

bool

---

SetDocPointer(self, docPointer)

Change the document object used.

Parameters:

docPointer –

---

SetEOLMode(self, eolMode)

Set the current end of line mode.

The input should be one of the ``STC_EOL_* `` constants.

Parameters:

eolMode (int) –

---

SetEdgeColour(self, edgeColour)

Change the colour used in edge indication.

Parameters:

edgeColour (wx.Colour) –

---

SetEdgeColumn(self, column)

Set the column number of the edge.

If text goes past the edge then it is highlighted.

Parameters:

column (int) –

---

SetEdgeMode(self, edgeMode)

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

---

SetEditable(self, editable)

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.

See also

IsEditable

---

SetEmptySelection(self, caret)

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

Parameters:

caret (int) –

---

SetEndAtLastLine(self, endAtLastLine)

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

---

SetExtraAscent(self, extraAscent)

Set extra ascent for each line.

Parameters:

extraAscent (int) –

---

SetExtraDescent(self, extraDescent)

Set extra descent for each line.

Parameters:

extraDescent (int) –

---

SetFirstVisibleLine(self, displayLine)

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

Parameters:

displayLine (int) –

---

SetFoldExpanded(self, line, expanded)

Show the children of a header line.

Parameters:

• line (int) –

• expanded (bool) –

---

SetFoldFlags(self, flags)

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

---

SetFoldLevel(self, line, level)

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

---

SetFoldMarginColour(self, useSetting, back)

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

Parameters:

• useSetting (bool) –

• back (wx.Colour) –

---

SetFoldMarginHiColour(self, useSetting, fore)

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

Parameters:

• useSetting (bool) –

• fore (wx.Colour) –

---

SetFontQuality(self, fontQuality)

Choose the quality level for text.

The input should be one of the ``STC_EFF_QUALITY_* `` constants.

Parameters:

fontQuality (int) –

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

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

Parameters:

bar (wx.ScrollBar) –

---

SetHighlightGuide(self, column)

Set the highlighted indentation guide column.

0 = no highlighted guide.

Parameters:

column (int) –

---

SetHint(self, hint)

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

New 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, back)

Set a back colour for active hotspots.

Parameters:

• useSetting (bool) –

• back (wx.Colour) –

---

SetHotspotActiveForeground(self, useSetting, fore)

Set a fore colour for active hotspots.

Parameters:

• useSetting (bool) –

• fore (wx.Colour) –

---

SetHotspotActiveUnderline(self, underline)

Enable / Disable underlining active hotspots.

Parameters:

underline (bool) –

---

SetHotspotSingleLine(self, singleLine)

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

Parameters:

singleLine (bool) –

---

SetIMEInteraction(self, imeInteraction)

Choose to display the IME in a winow or inline.

The input should be one of the ``STC_IME_* `` constants.

Parameters:

imeInteraction (int) –

New in version 4.1/wxWidgets-3.1.0.

---

SetIdentifier(self, identifier)

Set the identifier reported as idFrom in notification messages.

Parameters:

identifier (int) –

---

SetIdentifiers(self, style, identifiers)

Set the identifiers that are shown in a particular style.

Parameters:

• style (int) –

• identifiers (string) –

New in version 4.1/wxWidgets-3.1.0.

---

SetIdleStyling(self, idleStyling)

Sets limits to idle styling.

The input should be one of the ``STC_IDLESTYLING_* `` constants.

Parameters:

idleStyling (int) –

New in version 4.1/wxWidgets-3.1.1.

---

SetIndent(self, indentSize)

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

Parameters:

indentSize (int) –

---

SetIndentationGuides(self, indentView)

Show or hide indentation guides.

The input should be one of the ``STC_IV_* `` constants.

Parameters:

indentView (int) –

---

SetIndicatorCurrent(self, indicator)

Set the indicator used for IndicatorFillRange and IndicatorClearRange.

Parameters:

indicator (int) –

---

SetIndicatorValue(self, value)

Set the value used for IndicatorFillRange.

Parameters:

value (int) –

---

SetInsertionPoint(self, pos)

Sets the insertion point at the given position.

Parameters:

pos (long) – Position to set, in the range from 0 to GetLastPosition inclusive.

---

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.

---

SetKeyWords(self, keyWordSet, keyWords)

Set up the key words used by the lexer.

Parameters:

• keyWordSet (int) –

• keyWords (string) –

---

SetLastKeydownProcessed(self, val)

Returns the line number of the line with the caret.

Parameters:

val (bool) –

---

SetLayoutCache(self, cacheMode)

Sets the degree of caching of layout information.

The input should be one of the ``STC_CACHE_* `` constants.

Parameters:

cacheMode (int) –

---

SetLexer(self, lexer)

Set the lexing language of the document.

The input should be one of the ``STC_LEX_* `` constants.

Parameters:

lexer (int) –

---

SetLexerLanguage(self, language)

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

Parameters:

language (string) –

---

SetLineEndTypesAllowed(self, lineEndBitSet)

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

New in version 4.1/wxWidgets-3.1.0.

---

SetLineIndentation(self, line, indentation)

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

Parameters:

• line (int) –

• indentation (int) –

---

SetLineState(self, line, state)

Used to hold extra styling information for each line.

Parameters:

• line (int) –

• state (int) –

---

SetMainSelection(self, selection)

Set the main selection.

Parameters:

selection (int) –

---

SetMarginBackground(self, margin, back)

Set the background colour of a margin.

Only visible for wx.stc.STC_MARGIN_COLOUR.

Parameters:

• margin (int) –

• back (wx.Colour) –

New in version 4.1/wxWidgets-3.1.1.

---

SetMarginCount(self, margins)

Allocate a non-standard number of margins.

Parameters:

margins (int) –

New in version 4.1/wxWidgets-3.1.1.

---

SetMarginCursor(self, margin, cursor)

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

---

SetMarginLeft(self, pixelWidth)

Sets the size in pixels of the left margin.

Parameters:

pixelWidth (int) –

---

SetMarginMask(self, margin, mask)

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

Parameters:

• margin (int) –

• mask (int) –

---

SetMarginOptions(self, marginOptions)

Set the margin options.

The input should be one of the ``STC_MARGINOPTION_* `` constants.

Parameters:

marginOptions (int) –

---

SetMarginRight(self, pixelWidth)

Sets the size in pixels of the right margin.

Parameters:

pixelWidth (int) –

---

SetMarginSensitive(self, margin, sensitive)

Make a margin sensitive or insensitive to mouse clicks.

Parameters:

• margin (int) –

• sensitive (bool) –

---

SetMarginType(self, margin, marginType)

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

---

SetMarginWidth(self, margin, pixelWidth)

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

Parameters:

• margin (int) –

• pixelWidth (int) –

---

SetMargins(self, left, right)

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

Parameters:

• left (int) –

• right (int) –

---

SetMaxLength(self, len)

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

---

SetModEventMask(self, eventMask)

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

---

SetModified(self, modified)

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

Parameters:

modified (bool) –

See also

MarkDirty , DiscardEdits

---

SetMouseDownCaptures(self, captures)

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

Parameters:

captures (bool) –

---

SetMouseDwellTime(self, periodMilliseconds)

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

---

SetMouseSelectionRectangularSwitch(self, mouseSelectionRectangularSwitch)

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

Parameters:

mouseSelectionRectangularSwitch (bool) –

New in version 4.1/wxWidgets-3.1.0.

---

SetMouseWheelCaptures(self, captures)

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

Parameters:

captures (bool) –

New in version 4.1/wxWidgets-3.1.1.

---

SetMultiPaste(self, multiPaste)

Change the effect of pasting when there are multiple selections.

The input should be one of the ``STC_MULTIPASTE_* `` constants.

Parameters:

multiPaste (int) –

---

SetMultipleSelection(self, multipleSelection)

Set whether multiple selections can be made.

Parameters:

multipleSelection (bool) –

---

SetOvertype(self, overType)

Set to overtype (True) or insert mode.

Parameters:

overType (bool) –

---

SetPasteConvertEndings(self, convert)

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

Parameters:

convert (bool) –

---

SetPhasesDraw(self, phases)

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

New in version 4.1/wxWidgets-3.1.0.

---

SetPositionCacheSize(self, size)

Set number of entries in position cache.

Parameters:

size (int) –

---

SetPrintColourMode(self, mode)

Modify colours when printing for clearer printed text.

The input should be one of the ``STC_PRINT_* `` constants.

Parameters:

mode (int) –

---

SetPrintMagnification(self, magnification)

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

Parameters:

magnification (int) –

---

SetPrintWrapMode(self, wrapMode)

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

Parameters:

wrapMode (int) –

---

SetProperty(self, key, value)

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

Parameters:

• key (string) –

• value (string) –

---

SetPunctuationChars(self, characters)

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

Parameters:

characters (string) –

---

SetReadOnly(self, readOnly)

Set to read only or read write.

Parameters:

readOnly (bool) –

---

SetRectangularSelectionAnchor(self, anchor)

Set the anchor position of the rectangular selection.

Parameters:

anchor (int) –

---

SetRectangularSelectionAnchorVirtualSpace(self, space)

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

Parameters:

space (int) –

---

SetRectangularSelectionCaret(self, caret)

Set the caret position of the rectangular selection.

Parameters:

caret (int) –

---

SetRectangularSelectionCaretVirtualSpace(self, space)

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

Parameters:

space (int) –

---

SetRectangularSelectionModifier(self, modifier)

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

---

SetRepresentation(self, encodedCharacter, representation)

Set the way a character is drawn.

Parameters:

• encodedCharacter (string) –

• representation (string) –

New in version 4.1/wxWidgets-3.1.0.

---

SetSTCCursor(self, cursorType)

Sets the cursor to one of the STC_CURSOR values.

Parameters:

cursorType (int) –

---

SetSTCFocus(self, focus)

Change internal focus flag.

Parameters:

focus (bool) –

---

SetSavePoint(self)

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

---

SetScrollWidth(self, pixelWidth)

Sets the document width assumed for scrolling.

Parameters:

pixelWidth (int) –

---

SetScrollWidthTracking(self, tracking)

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

Parameters:

tracking (bool) –

---

SetSearchFlags(self, searchFlags)

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

---

SetSelAlpha(self, alpha)

Set the alpha of the selection.

Parameters:

alpha (int) –

---

SetSelBackground(self, useSetting, back)

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

Parameters:

• useSetting (bool) –

• back (wx.Colour) –

---

SetSelEOLFilled(self, filled)

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

Parameters:

filled (bool) –

---

SetSelForeground(self, useSetting, fore)

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

Parameters:

• useSetting (bool) –

• fore (wx.Colour) –

---

SetSelection(self, from_, to_)

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.

See also

SelectAll

---

SetSelectionEnd(self, caret)

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

Parameters:

caret (int) –

---

SetSelectionMode(self, selectionMode)

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

---

SetSelectionNAnchor(self, selection, anchor)

Set the anchor position of the nth selection.

Parameters:

• selection (int) –

• anchor (int) –

---

SetSelectionNAnchorVirtualSpace(self, selection, space)

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

Parameters:

• selection (int) –

• space (int) –

---

SetSelectionNCaret(self, selection, caret)

Set the caret position of the nth selection.

Parameters:

• selection (int) –

• caret (int) –

---

SetSelectionNCaretVirtualSpace(self, selection, space)

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

Parameters:

• selection (int) –

• space (int) –

---

SetSelectionNEnd(self, selection, caret)

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

Parameters:

• selection (int) –

• caret (int) –

---

SetSelectionNStart(self, selection, anchor)

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

Parameters:

• selection (int) –

• anchor (int) –

---

SetSelectionStart(self, anchor)

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

Parameters:

anchor (int) –

---

SetStatus(self, status)

Change error status - 0 = wx.OK.

The input should be one of the ``STC_STATUS_* `` constants.

Parameters:

status (int) –

---

SetStyle(self, start, end, style)

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)

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

---

SetStyleBytes(self, length, styleBytes)

Set the styles for a segment of the document.

Parameters:

• length (int) –

• styleBytes (int) –

---

SetStyling(self, length, style)

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

---

SetTabDrawMode(self, tabDrawMode)

Set how tabs are drawn when visible.

The input should be one of the ``STC_TD_* `` constants.

Parameters:

tabDrawMode (int) –

New in version 4.1/wxWidgets-3.1.1.

---

SetTabIndents(self, tabIndents)

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

Parameters:

tabIndents (bool) –

---

SetTabWidth(self, tabWidth)

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

Parameters:

tabWidth (int) –

---

SetTargetEnd(self, end)

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

Parameters:

end (int) –

---

SetTargetRange(self, start, end)

Sets both the start and end of the target in one call.

Parameters:

• start (int) –

• end (int) –

New in version 4.1/wxWidgets-3.1.0.

---

SetTargetStart(self, start)

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

Parameters:

start (int) –

---

SetTechnology(self, technology)

Set the technology used.

Parameters:

technology (int) –

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)

Replace the contents of the document with the argument text.

Parameters:

text (string) –

---

SetTextRaw(self, text)

Replace the contents of the document with the argument text.

Parameters:

text (int) –

---

SetTwoPhaseDraw(self, twoPhase)

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

---

SetUndoCollection(self, collectUndo)

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

Parameters:

collectUndo (bool) –

---

SetUseAntiAliasing(self, useAA)

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

---

SetUseHorizontalScrollBar(self, visible)

Show or hide the horizontal scroll bar.

Parameters:

visible (bool) –

---

SetUseTabs(self, useTabs)

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

Parameters:

useTabs (bool) –

---

SetUseVerticalScrollBar(self, visible)

Show or hide the vertical scroll bar.

Parameters:

visible (bool) –

---

SetVScrollBar(self, bar)

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

Parameters:

bar (wx.ScrollBar) –

---

SetValue(self, value)

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.

---

SetViewEOL(self, visible)

Make the end of line characters visible or invisible.

Parameters:

visible (bool) –

---

SetViewWhiteSpace(self, viewWS)

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

The input should be one of the ``STC_WS_* `` constants.

Parameters:

viewWS (int) –

---

SetVirtualSpaceOptions(self, virtualSpaceOptions)

Set options for virtual space behaviour.

The input should be one of the ``STC_VS_* `` constants.

Parameters:

virtualSpaceOptions (int) –

---

SetVisiblePolicy(self, visiblePolicy, visibleSlop)

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

---

SetWhitespaceBackground(self, useSetting, back)

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

Parameters:

• useSetting (bool) –

• back (wx.Colour) –

---

SetWhitespaceChars(self, characters)

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

Should be called after SetWordChars.

Parameters:

characters (string) –

---

SetWhitespaceForeground(self, useSetting, fore)

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

Parameters:

• useSetting (bool) –

• fore (wx.Colour) –

---

SetWhitespaceSize(self, size)

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

Parameters:

size (int) –

---

SetWordChars(self, characters)

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

First sets defaults like SetCharsDefault.

Parameters:

characters (string) –

---

SetWrapIndentMode(self, wrapIndentMode)

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

---

SetWrapMode(self, wrapMode)

Sets whether text is word wrapped.

The input should be one of the ``STC_WRAP_* `` constants.

Parameters:

wrapMode (int) –

---

SetWrapStartIndent(self, indent)

Set the start indent for wrapped lines.

Parameters:

indent (int) –

---

SetWrapVisualFlags(self, wrapVisualFlags)

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

---

SetWrapVisualFlagsLocation(self, wrapVisualFlagsLocation)

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

---

SetXCaretPolicy(self, caretPolicy, caretSlop)

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

---

SetXOffset(self, xOffset)

Set the xOffset (ie, horizontal scroll position).

Parameters:

xOffset (int) –

---

SetYCaretPolicy(self, caretPolicy, caretSlop)

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

---

SetZoom(self, zoomInPoints)

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

---

ShowLines(self, lineStart, lineEnd)

Make a range of lines visible.

Parameters:

• lineStart (int) –

• lineEnd (int) –

---

ShowPosition(self, pos)

Makes the line containing the given position visible.

Parameters:

pos (long) – The position that should be visible.

---

StartRecord(self)

Start notifying the container of all key presses and commands.

---

StartStyling(self, start)

Set the current styling position to start.

Parameters:

start (int) –

---

StopRecord(self)

Stop notifying the container of all key presses and commands.

---

StutteredPageDown(self)

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

---

StutteredPageDownExtend(self)

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

---

StutteredPageUp(self)

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

---

StutteredPageUpExtend(self)

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

---

StyleClearAll(self)

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

---

StyleGetBackground(self, style)

Get the background colour of a style.

Parameters:

style (int) –

Return type:

wx.Colour

---

StyleGetBold(self, style)

Get is a style bold or not.

Parameters:

style (int) –

Return type:

bool

---

StyleGetCase(self, style)

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)

Get is a style changeable or not (read only).

Experimental feature, currently buggy.

Parameters:

style (int) –

Return type:

bool

---

StyleGetCharacterSet(self, style)

Get the character get of the font in a style.

Parameters:

style (int) –

Return type:

int

---

StyleGetEOLFilled(self, style)

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

Parameters:

style (int) –

Return type:

bool

---

StyleGetFaceName(self, style)

Get the font facename of a style.

Parameters:

style (int) –

Return type:

string

---

StyleGetFont(self, style)

Get the font of a style.

Parameters:

style (int) –

Return type:

wx.Font

---

StyleGetForeground(self, style)

Get the foreground colour of a style.

Parameters:

style (int) –

Return type:

wx.Colour

---

StyleGetHotSpot(self, style)

Get is a style a hotspot or not.

Parameters:

style (int) –

Return type:

bool

---

StyleGetItalic(self, style)

Get is a style italic or not.

Parameters:

style (int) –

Return type:

bool

---

StyleGetSize(self, style)

Get the size of characters of a style.

Parameters:

style (int) –

Return type:

int

---

StyleGetSizeFractional(self, style)

Get the size of characters of a style in points multiplied by 100.

Parameters:

style (int) –

Return type:

int

---

StyleGetUnderline(self, style)

Get is a style underlined or not.

Parameters:

style (int) –

Return type:

bool

---

StyleGetVisible(self, style)

Get is a style visible or not.

Parameters:

style (int) –

Return type:

bool

---

StyleGetWeight(self, style)

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.

---

StyleSetBackground(self, style, back)

Set the background colour of a style.

Parameters:

• style (int) –

• back (wx.Colour) –

---

StyleSetBold(self, style, bold)

Set a style to be bold or not.

Parameters:

• style (int) –

• bold (bool) –

---

StyleSetCase(self, style, caseVisible)

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

---

StyleSetChangeable(self, style, changeable)

Set a style to be changeable or not (read only).

Experimental feature, currently buggy.

Parameters:

• style (int) –

• changeable (bool) –

---

StyleSetCharacterSet(self, style, characterSet)

Set the character set of the font in a style.

Converts the Scintilla character set values to a FontEncoding.

Parameters:

• style (int) –

• characterSet (int) –

---

StyleSetEOLFilled(self, style, eolFilled)

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

Parameters:

• style (int) –

• eolFilled (bool) –

---

StyleSetFaceName(self, style, fontName)

Set the font of a style.

Parameters:

• style (int) –

• fontName (string) –

---

StyleSetFont(self, styleNum, font)

Set style size, face, bold, italic, and underline attributes from a wx.Font’s attributes.

Parameters:

• styleNum (int) –

• font (wx.Font) –

---

StyleSetFontAttr(self, styleNum, size, faceName, bold, italic, underline, encoding=FONTENCODING_DEFAULT)

Set all font style attributes at once.

Parameters:

• styleNum (int) –

• size (int) –

• faceName (string) –

• bold (bool) –

• italic (bool) –

• underline (bool) –

• encoding (FontEncoding) –

---

StyleSetFontEncoding(self, style, encoding)

Set the font encoding to be used by a style.

Parameters:

• style (int) –

• encoding (FontEncoding) –

---

StyleSetForeground(self, style, fore)

Set the foreground colour of a style.

Parameters:

• style (int) –

• fore (wx.Colour) –

---

StyleSetHotSpot(self, style, hotspot)

Set a style to be a hotspot or not.

Parameters:

• style (int) –

• hotspot (bool) –

---

StyleSetItalic(self, style, italic)

Set a style to be italic or not.

Parameters:

• style (int) –

• italic (bool) –

---

StyleSetSize(self, style, sizePoints)

Set the size of characters of a style.

Parameters:

• style (int) –

• sizePoints (int) –

---

StyleSetSizeFractional(self, style, sizeHundredthPoints)

Set the size of characters of a style.

Size is in points multiplied by 100.

Parameters:

• style (int) –

• sizeHundredthPoints (int) –

---

StyleSetSpec(self, styleNum, spec)

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

---

StyleSetUnderline(self, style, underline)

Set a style to be underlined or not.

Parameters:

• style (int) –

• underline (bool) –

---

StyleSetVisible(self, style, visible)

Set a style to be visible or not.

Parameters:

• style (int) –

• visible (bool) –

---

StyleSetWeight(self, style, weight)

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

---

SwapMainAnchorCaret(self)

Swap that caret and anchor of the main selection.

---

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.

---

TargetFromSelection(self)

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

---

TargetWholeDocument(self)

Sets the target to the whole document.

New in version 4.1/wxWidgets-3.1.1.

---

TextHeight(self, line)

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

Parameters:

line (int) –

Return type:

int

---

TextWidth(self, style, text)

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.

---

ToggleFold(self, line)

Switch a header line between expanded and contracted.

Parameters:

line (int) –

---

ToggleFoldShowText(self, line, text)

Switch a header line between expanded and contracted and show some text after the line.

Parameters:

• line (int) –

• text (string) –

New in version 4.1/wxWidgets-3.1.1.

---

Undo(self)

Undo one action in the undo history.

---

UpperCase(self)

Transform the selection to upper case.

---

UsePopUp(self, popUpMode)

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

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, itemList)

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

Parameters:

• listType (int) –

• itemList (string) –

---

VCHome(self)

Move caret to before first visible character on line.

If already there move to first character on line.

---

VCHomeDisplay(self)

Move caret to before first visible character on display line.

If already there move to first character on display line.

New in version 4.1/wxWidgets-3.1.0.

---

VCHomeDisplayExtend(self)

Like VCHomeDisplay but extending selection to new caret position.

New in version 4.1/wxWidgets-3.1.0.

---

VCHomeExtend(self)

Like VCHome but extending selection to new caret position.

---

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.

---

VCHomeWrap(self)

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

---

VCHomeWrapExtend(self)

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

---

VerticalCentreCaret(self)

Centre current line in window.

---

VisibleFromDocLine(self, docLine)

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

Parameters:

docLine (int) –

Return type:

int

---

WordEndPosition(self, pos, onlyWordCharacters)

Get position of end of word.

Parameters:

• pos (int) –

• onlyWordCharacters (bool) –

Return type:

int

---

WordLeft(self)

Move caret left one word.

---

WordLeftEnd(self)

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

---

WordLeftEndExtend(self)

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

---

WordLeftExtend(self)

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

---

WordPartLeft(self)

Move to the previous change in capitalisation.

---

WordPartLeftExtend(self)

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

---

WordPartRight(self)

Move to the change next in capitalisation.

---

WordPartRightExtend(self)

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

---

WordRight(self)

Move caret right one word.

---

WordRightEnd(self)

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

---

WordRightEndExtend(self)

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

---

WordRightExtend(self)

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

---

WordStartPosition(self, pos, onlyWordCharacters)

Get position of start of word.

Parameters:

• pos (int) –

• onlyWordCharacters (bool) –

Return type:

int

---

WrapCount(self, docLine)

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

Parameters:

docLine (int) –

Return type:

int

---

WriteText(self, text)

Writes the text into the text control at the current insertion position.

Parameters:

text (string) – Text to write to the text control.

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, y)

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:

long

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.

---

ZoomOut(self)

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

---

flush(self)

NOP, for file-like compatibility.

---

write(self, text)

Append text to the textctrl, for file-like compatibility.

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