wx.stc.StyledTextCtrl
Proxy of C++ StyledTextCtrl class
AddRefDocument(args, kwargs)
AddRefDocument(self, void docPointer)
Extend life of document.
AddStyledText(args, kwargs)
AddStyledText(self, wxMemoryBuffer data)
Add array of cells to document.
AddText(args, kwargs)
AddText(self, String text)
Add text to the document at current position.
AddTextRaw(args, kwargs)
AddTextRaw(self, char text)
Add text to the document at current position. The text should be
utf-8 encoded on unicode builds of wxPython, or can be any 8-bit text
in ansi builds.
AddTextUTF8(self, text, u)
Add UTF8 encoded text to the document at the current position.
Works 'natively' in a unicode build of wxPython, and will also work
in an ansi build if the UTF8 text is compatible with the current
encoding.
Allocate(args, kwargs)
Allocate(self, int bytes)
Enlarge the document to a particular size of text bytes.
AppendText(args, kwargs)
AppendText(self, String text)
Append a string to the end of the document without changing the selection.
AppendTextRaw(args, kwargs)
AppendTextRaw(self, char text)
Append a string to the end of the document without changing the
selection. The text should be utf-8 encoded on unicode builds of
wxPython, or can be any 8-bit text in ansi builds.
AppendTextUTF8(self, text, u)
Append a UTF8 string to the end of the document without changing
the selection. Works 'natively' in a unicode build of wxPython,
and will also work in an ansi build if the UTF8 text is compatible
with the current encoding.
AutoCompActive(args, kwargs)
AutoCompActive(self) -> bool
Is there an auto-completion list visible?
AutoCompCancel(args, kwargs)
AutoCompCancel(self)
Remove the auto-completion list from the screen.
AutoCompComplete(args, kwargs)
AutoCompComplete(self)
User has selected an item so remove the list and insert the selection.
AutoCompGetAutoHide(args, kwargs)
AutoCompGetAutoHide(self) -> bool
Retrieve whether or not autocompletion is hidden automatically when nothing matches.
AutoCompGetCancelAtStart(args, kwargs)
AutoCompGetCancelAtStart(self) -> bool
Retrieve whether auto-completion cancelled by backspacing before start.
AutoCompGetChooseSingle(args, kwargs)
AutoCompGetChooseSingle(self) -> bool
Retrieve whether a single item auto-completion list automatically choose the item.
AutoCompGetCurrent(args, kwargs)
AutoCompGetCurrent(self) -> int
Get currently selected item position in the auto-completion list
AutoCompGetDropRestOfWord(args, kwargs)
AutoCompGetDropRestOfWord(self) -> bool
Retrieve whether or not autocompletion deletes any word characters
after the inserted text upon completion.
AutoCompGetIgnoreCase(args, kwargs)
AutoCompGetIgnoreCase(self) -> bool
Retrieve state of ignore case flag.
AutoCompGetSeparator(args, kwargs)
AutoCompGetSeparator(self) -> int
Retrieve the auto-completion list separator character.
AutoCompGetTypeSeparator(args, kwargs)
AutoCompGetTypeSeparator(self) -> int
Retrieve the auto-completion list type-separator character.
AutoCompPosStart(args, kwargs)
AutoCompPosStart(self) -> int
Retrieve the position of the caret when the auto-completion list was displayed.
AutoCompSelect(args, kwargs)
AutoCompSelect(self, String text)
Select the item in the auto-completion list that starts with a string.
AutoCompSetAutoHide(args, kwargs)
AutoCompSetAutoHide(self, bool autoHide)
Set whether or not autocompletion is hidden automatically when nothing matches.
AutoCompSetCancelAtStart(args, kwargs)
AutoCompSetCancelAtStart(self, bool cancel)
Should the auto-completion list be cancelled if the user backspaces to a
position before where the box was created.
AutoCompSetChooseSingle(args, kwargs)
AutoCompSetChooseSingle(self, bool chooseSingle)
Should a single item auto-completion list automatically choose the item.
AutoCompSetDropRestOfWord(args, kwargs)
AutoCompSetDropRestOfWord(self, bool dropRestOfWord)
Set whether or not autocompletion deletes any word characters
after the inserted text upon completion.
AutoCompSetFillUps(args, kwargs)
AutoCompSetFillUps(self, String characterSet)
Define a set of characters that when typed will cause the autocompletion to
choose the selected item.
AutoCompSetIgnoreCase(args, kwargs)
AutoCompSetIgnoreCase(self, bool ignoreCase)
Set whether case is significant when performing auto-completion searches.
AutoCompSetSeparator(args, kwargs)
AutoCompSetSeparator(self, int 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.
AutoCompSetTypeSeparator(args, kwargs)
AutoCompSetTypeSeparator(self, int separatorCharacter)
Change the type-separator character in the string setting up an auto-completion list.
Default is '?' but can be changed if items contain '?'.
AutoCompShow(args, kwargs)
AutoCompShow(self, int lenEntered, String itemList)
Display a auto-completion list.
The lenEntered parameter indicates how many characters before
the caret should be used to provide context.
AutoCompStops(args, kwargs)
AutoCompStops(self, String characterSet)
Define a set of character that when typed cancel the auto-completion list.
BackTab(args, kwargs)
BackTab(self)
Dedent the selected lines.
BeginUndoAction(args, kwargs)
BeginUndoAction(self)
Start a sequence of actions that is undone and redone as a unit.
May be nested.
BraceBadLight(args, kwargs)
BraceBadLight(self, int pos)
Highlight the character at a position indicating there is no matching brace.
BraceHighlight(args, kwargs)
BraceHighlight(self, int pos1, int pos2)
Highlight the characters at two positions.
BraceMatch(args, kwargs)
BraceMatch(self, int pos) -> int
Find the position of a matching brace or INVALID_POSITION if no match.
CallTipActive(args, kwargs)
CallTipActive(self) -> bool
Is there an active call tip?
CallTipCancel(args, kwargs)
CallTipCancel(self)
Remove the call tip from the screen.
CallTipPosAtStart(args, kwargs)
CallTipPosAtStart(self) -> int
Retrieve the position where the caret was before displaying the call tip.
CallTipSetBackground(args, kwargs)
CallTipSetBackground(self, Colour back)
Set the background colour for the call tip.
CallTipSetForeground(args, kwargs)
CallTipSetForeground(self, Colour fore)
Set the foreground colour for the call tip.
CallTipSetForegroundHighlight(args, kwargs)
CallTipSetForegroundHighlight(self, Colour fore)
Set the foreground colour for the highlighted part of the call tip.
CallTipSetHighlight(args, kwargs)
CallTipSetHighlight(self, int start, int end)
Highlight a segment of the definition.
CallTipShow(args, kwargs)
CallTipShow(self, int pos, String definition)
Show a call tip containing a definition near position pos.
CanPaste(args, kwargs)
CanPaste(self) -> bool
Will a paste succeed?
CanRedo(args, kwargs)
CanRedo(self) -> bool
Are there any redoable actions in the undo history?
CanUndo(args, kwargs)
CanUndo(self) -> bool
Are there any undoable actions in the undo history?
Cancel(args, kwargs)
Cancel(self)
Cancel any modes such as call tip or auto-completion list display.
CharLeft(args, kwargs)
CharLeft(self)
Move caret left one character.
CharLeftExtend(args, kwargs)
CharLeftExtend(self)
Move caret left one character extending selection to new caret position.
CharLeftRectExtend(args, kwargs)
CharLeftRectExtend(self)
Move caret left one character, extending rectangular selection to new caret position.
CharRight(args, kwargs)
CharRight(self)
Move caret right one character.
CharRightExtend(args, kwargs)
CharRightExtend(self)
Move caret right one character extending selection to new caret position.
CharRightRectExtend(args, kwargs)
CharRightRectExtend(self)
Move caret right one character, extending rectangular selection to new caret position.
ChooseCaretX(args, kwargs)
ChooseCaretX(self)
Set the last x chosen value to be the caret x position.
Clear(args, kwargs)
Clear(self)
Clear the selection.
ClearAll(args, kwargs)
ClearAll(self)
Delete all text in the document.
ClearDocumentStyle(args, kwargs)
ClearDocumentStyle(self)
Set all style bytes to 0, remove all folding information.
ClearRegisteredImages(args, kwargs)
ClearRegisteredImages(self)
Clear all the registered images.
CmdKeyAssign(args, kwargs)
CmdKeyAssign(self, int key, int modifiers, int cmd)
When key+modifier combination km is pressed perform msg.
CmdKeyClear(args, kwargs)
CmdKeyClear(self, int key, int modifiers)
When key+modifier combination km is pressed do nothing.
CmdKeyClearAll(args, kwargs)
CmdKeyClearAll(self)
Drop all key mappings.
CmdKeyExecute(args, kwargs)
CmdKeyExecute(self, int cmd)
Perform one of the operations defined by the wx.stc.STC_CMD_* constants.
Colourise(args, kwargs)
Colourise(self, int start, int end)
Colourise a segment of the document using the current lexing language.
ConvertEOLs(args, kwargs)
ConvertEOLs(self, int eolMode)
Convert all line endings in the document to one mode.
Copy(args, kwargs)
Copy(self)
Copy the selection to the clipboard.
CopyRange(args, kwargs)
CopyRange(self, int start, int end)
Copy a range of text to the clipboard. Positions are clipped into the document.
CopyText(args, kwargs)
CopyText(self, int length, String text)
Copy argument text to the clipboard.
Create(args, kwargs)
Create(self, Window parent, int id=ID_ANY, Point pos=DefaultPosition,
Size size=DefaultSize, long style=0, String name=wxSTCNameStr) -> bool
CreateDocument(args, kwargs)
CreateDocument(self) -> void
Create a new document object.
Starts with reference count of 1 and not selected into editor.
Cut(args, kwargs)
Cut(self)
Cut the selection to the clipboard.
DelLineLeft(args, kwargs)
DelLineLeft(self)
Delete back from the current position to the start of the line.
DelLineRight(args, kwargs)
DelLineRight(self)
Delete forwards from the current position to the end of the line.
DelWordLeft(args, kwargs)
DelWordLeft(self)
Delete the word to the left of the caret.
DelWordRight(args, kwargs)
DelWordRight(self)
Delete the word to the right of the caret.
DeleteBack(args, kwargs)
DeleteBack(self)
Delete the selection or if no selection, the character before the caret.
DeleteBackNotLine(args, kwargs)
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.
DoDragOver(args, kwargs)
DoDragOver(self, int x, int y, int def) -> int
Allow for simulating a DnD DragOver.
DoDropText(args, kwargs)
DoDropText(self, long x, long y, String data) -> bool
Allow for simulating a DnD DropText.
DocLineFromVisible(args, kwargs)
DocLineFromVisible(self, int lineDisplay) -> int
Find the document line of a display line taking hidden lines into account.
DocumentEnd(args, kwargs)
DocumentEnd(self)
Move caret to last position in document.
DocumentEndExtend(args, kwargs)
DocumentEndExtend(self)
Move caret to last position in document extending selection to new caret position.
DocumentStart(args, kwargs)
DocumentStart(self)
Move caret to first position in document.
DocumentStartExtend(args, kwargs)
DocumentStartExtend(self)
Move caret to first position in document extending selection to new caret position.
EditToggleOvertype(args, kwargs)
EditToggleOvertype(self)
Switch from insert to overtype mode or the reverse.
EmptyUndoBuffer(args, kwargs)
EmptyUndoBuffer(self)
Delete the undo history.
EndUndoAction(args, kwargs)
EndUndoAction(self)
End a sequence of actions that is undone and redone as a unit.
EnsureCaretVisible(args, kwargs)
EnsureCaretVisible(self)
Ensure the caret is visible.
EnsureVisible(args, kwargs)
EnsureVisible(self, int line)
Ensure a particular line is visible by expanding any header line hiding it.
EnsureVisibleEnforcePolicy(args, kwargs)
EnsureVisibleEnforcePolicy(self, int 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.
FindColumn(args, kwargs)
FindColumn(self, int line, int column) -> int
Find the position of a column on a line taking into account tabs and
multi-byte characters. If beyond end of line, return line end position.
FindText(args, kwargs)
FindText(self, int minPos, int maxPos, String text, int flags=0) -> int
Find some text in the document.
FormFeed(args, kwargs)
FormFeed(self)
Insert a Form Feed character.
FormatRange(args, kwargs)
FormatRange(self, bool doDraw, int startPos, int endPos, DC draw, DC target,
Rect renderRect, Rect pageRect) -> int
On Windows, will draw the document into a display context such as a printer.
GetAnchor(args, kwargs)
GetAnchor(self) -> int
Returns the position of the opposite end of the selection to the caret.
GetBackSpaceUnIndents(args, kwargs)
GetBackSpaceUnIndents(self) -> bool
Does a backspace pressed when caret is within indentation unindent?
GetBufferedDraw(args, kwargs)
GetBufferedDraw(self) -> bool
Is drawing done first into a buffer or direct to the screen?
GetCaretForeground(args, kwargs)
GetCaretForeground(self) -> Colour
Get the foreground colour of the caret.
GetCaretLineBack(args, kwargs)
GetCaretLineBack(self) -> Colour
Get the colour of the background of the line containing the caret.
GetCaretLineVisible(args, kwargs)
GetCaretLineVisible(self) -> bool
Is the background of the line containing the caret in a different colour?
GetCaretPeriod(args, kwargs)
GetCaretPeriod(self) -> int
Get the time in milliseconds that the caret is on and off.
GetCaretWidth(args, kwargs)
GetCaretWidth(self) -> int
Returns the width of the insert mode caret.
GetCharAt(args, kwargs)
GetCharAt(self, int pos) -> int
Returns the character byte at the position.
GetCodePage(args, kwargs)
GetCodePage(self) -> int
Get the code page used to interpret the bytes of the document as characters.
GetColumn(args, kwargs)
GetColumn(self, int pos) -> int
Retrieve the column number of a position, taking tab width into account.
GetControlCharSymbol(args, kwargs)
GetControlCharSymbol(self) -> int
Get the way control characters are displayed.
GetCurLine(args, kwargs)
GetCurLine(self) -> (text, pos)
Retrieve the text of the line containing the caret, and also theindex
of the caret on the line.
GetCurLineRaw(args, kwargs)
GetCurLineRaw() -> (text, index)
Retrieve the text of the line containing the caret, and also the index
of the caret on the line. The returned value is a utf-8 encoded
string in unicode builds of wxPython, or raw 8-bit text otherwise.
GetCurLineUTF8(self, text, u, pos)
Retrieve the UTF8 text of the line containing the caret, and also
the index of the caret on the line. In an ansi build of wxPython
the text retrieved from the document is assumed to be in the
current default encoding.
GetCurrentLine(args, kwargs)
GetCurrentLine(self) -> int
Returns the line number of the line with the caret.
GetCurrentPos(args, kwargs)
GetCurrentPos(self) -> int
Returns the position of the caret.
GetDocPointer(args, kwargs)
GetDocPointer(self) -> void
Retrieve a pointer to the document object.
GetEOLMode(args, kwargs)
GetEOLMode(self) -> int
Retrieve the current end of line mode - one of CRLF, CR, or LF.
GetEdgeColour(args, kwargs)
GetEdgeColour(self) -> Colour
Retrieve the colour used in edge indication.
GetEdgeColumn(args, kwargs)
GetEdgeColumn(self) -> int
Retrieve the column number which text should be kept within.
GetEdgeMode(args, kwargs)
GetEdgeMode(self) -> int
Retrieve the edge highlight mode.
GetEndAtLastLine(args, kwargs)
GetEndAtLastLine(self) -> int
Retrieve whether the maximum scroll position has the last
line at the bottom of the view.
GetEndStyled(args, kwargs)
GetEndStyled(self) -> int
Retrieve the position of the last correctly styled character.
GetFirstVisibleLine(args, kwargs)
GetFirstVisibleLine(self) -> int
Retrieve the display line at the top of the display.
GetFoldExpanded(args, kwargs)
GetFoldExpanded(self, int line) -> bool
Is a header line expanded?
GetFoldLevel(args, kwargs)
GetFoldLevel(self, int line) -> int
Retrieve the fold level of a line.
GetFoldParent(args, kwargs)
GetFoldParent(self, int line) -> int
Find the parent line of a child line.
GetHighlightGuide(args, kwargs)
GetHighlightGuide(self) -> int
Get the highlighted indentation guide column.
GetIndent(args, kwargs)
GetIndent(self) -> int
Retrieve indentation size.
GetIndentationGuides(args, kwargs)
GetIndentationGuides(self) -> bool
Are the indentation guides visible?
GetLastChild(args, kwargs)
GetLastChild(self, int line, int level) -> int
Find the last child line of a header line.
GetLastKeydownProcessed(args, kwargs)
GetLastKeydownProcessed(self) -> bool
GetLayoutCache(args, kwargs)
GetLayoutCache(self) -> int
Retrieve the degree of caching of layout information.
GetLength(args, kwargs)
GetLength(self) -> int
Returns the number of characters in the document.
GetLexer(args, kwargs)
GetLexer(self) -> int
Retrieve the lexing language of the document.
GetLine(args, kwargs)
GetLine(self, int line) -> String
Retrieve the contents of a line.
GetLineCount(args, kwargs)
GetLineCount(self) -> int
Returns the number of lines in the document. There is always at least one.
GetLineEndPosition(args, kwargs)
GetLineEndPosition(self, int line) -> int
Get the position after the last visible characters on a line.
GetLineIndentPosition(args, kwargs)
GetLineIndentPosition(self, int line) -> int
Retrieve the position before the first non indentation character on a line.
GetLineIndentation(args, kwargs)
GetLineIndentation(self, int line) -> int
Retrieve the number of columns that a line is indented.
GetLineRaw(args, kwargs)
GetLineRaw(self, int line) -> wxCharBuffer
Retrieve the contents of a line. The returned value is a utf-8
encoded string in unicode builds of wxPython, or raw 8-bit text
otherwise.
GetLineSelEndPosition(args, kwargs)
GetLineSelEndPosition(self, int line) -> int
Retrieve the position of the end of the selection at the given line (INVALID_POSITION if no selection on this line).
GetLineSelStartPosition(args, kwargs)
GetLineSelStartPosition(self, int line) -> int
Retrieve the position of the start of the selection at the given line (INVALID_POSITION if no selection on this line).
GetLineState(args, kwargs)
GetLineState(self, int line) -> int
Retrieve the extra styling information for a line.
GetLineUTF8(self, line, text, u)
Retrieve the contents of a line as UTF8. In an ansi build of wxPython
the text retrieved from the document is assumed to be in the
current default encoding.
GetLineVisible(args, kwargs)
GetLineVisible(self, int line) -> bool
Is a line visible?
GetMarginLeft(args, kwargs)
GetMarginLeft(self) -> int
Returns the size in pixels of the left margin.
GetMarginMask(args, kwargs)
GetMarginMask(self, int margin) -> int
Retrieve the marker mask of a margin.
GetMarginRight(args, kwargs)
GetMarginRight(self) -> int
Returns the size in pixels of the right margin.
GetMarginSensitive(args, kwargs)
GetMarginSensitive(self, int margin) -> bool
Retrieve the mouse click sensitivity of a margin.
GetMarginType(args, kwargs)
GetMarginType(self, int margin) -> int
Retrieve the type of a margin.
GetMarginWidth(args, kwargs)
GetMarginWidth(self, int margin) -> int
Retrieve the width of a margin in pixels.
GetMaxLineState(args, kwargs)
GetMaxLineState(self) -> int
Retrieve the last line number that has line state.
GetModEventMask(args, kwargs)
GetModEventMask(self) -> int
Get which document modification events are sent to the container.
GetModify(args, kwargs)
GetModify(self) -> bool
Is the document different from when it was last saved?
GetMouseDownCaptures(args, kwargs)
GetMouseDownCaptures(self) -> bool
Get whether mouse gets captured.
GetMouseDwellTime(args, kwargs)
GetMouseDwellTime(self) -> int
Retrieve the time the mouse must sit still to generate a mouse dwell event.
GetOvertype(args, kwargs)
GetOvertype(self) -> bool
Returns true if overtype mode is active otherwise false is returned.
GetPrintColourMode(args, kwargs)
GetPrintColourMode(self) -> int
Returns the print colour mode.
GetPrintMagnification(args, kwargs)
GetPrintMagnification(self) -> int
Returns the print magnification.
GetPrintWrapMode(args, kwargs)
GetPrintWrapMode(self) -> int
Is printing line wrapped?
GetReadOnly(args, kwargs)
GetReadOnly(self) -> bool
In read-only mode?
GetSTCCursor(args, kwargs)
GetSTCCursor(self) -> int
Get cursor type.
GetSTCFocus(args, kwargs)
GetSTCFocus(self) -> bool
Get internal focus flag.
GetScrollWidth(args, kwargs)
GetScrollWidth(self) -> int
Retrieve the document width assumed for scrolling.
GetSearchFlags(args, kwargs)
GetSearchFlags(self) -> int
Get the search flags used by SearchInTarget.
GetSelectedText(args, kwargs)
GetSelectedText(self) -> String
Retrieve the selected text.
GetSelectedTextRaw(args, kwargs)
GetSelectedTextRaw(self) -> wxCharBuffer
Retrieve the selected text. The returned value is a utf-8 encoded
string in unicode builds of wxPython, or raw 8-bit text otherwise.
GetSelectedTextUTF8(self, text, u)
Retrieve the selected text as UTF8. In an ansi build of wxPython
the text retrieved from the document is assumed to be in the
current default encoding.
GetSelection(args, kwargs)
GetSelection(self) -> (startPos, endPos)
Retrieve the start and end positions of the current selection.
GetSelectionEnd(args, kwargs)
GetSelectionEnd(self) -> int
Returns the position at the end of the selection.
GetSelectionMode(args, kwargs)
GetSelectionMode(self) -> int
Get the mode of the current selection.
GetSelectionStart(args, kwargs)
GetSelectionStart(self) -> int
Returns the position at the start of the selection.
GetStatus(args, kwargs)
GetStatus(self) -> int
Get error status.
GetStyleAt(args, kwargs)
GetStyleAt(self, int pos) -> int
Returns the style byte at the position.
GetStyleBits(args, kwargs)
GetStyleBits(self) -> int
Retrieve number of bits in style bytes used to hold the lexical state.
GetStyledText(args, kwargs)
GetStyledText(self, int startPos, int endPos) -> wxMemoryBuffer
Retrieve a buffer of cells.
GetTabIndents(args, kwargs)
GetTabIndents(self) -> bool
Does a tab pressed when caret is within indentation indent?
GetTabWidth(args, kwargs)
GetTabWidth(self) -> int
Retrieve the visible size of a tab.
GetTargetEnd(args, kwargs)
GetTargetEnd(self) -> int
Get the position that ends the target.
GetTargetStart(args, kwargs)
GetTargetStart(self) -> int
Get the position that starts the target.
GetText(args, kwargs)
GetText(self) -> String
Retrieve all the text in the document.
GetTextLength(args, kwargs)
GetTextLength(self) -> int
Retrieve the number of characters in the document.
GetTextRange(args, kwargs)
GetTextRange(self, int startPos, int endPos) -> String
Retrieve a range of text.
GetTextRangeRaw(args, kwargs)
GetTextRangeRaw(self, int startPos, int endPos) -> wxCharBuffer
Retrieve a range of text. The returned value is a utf-8 encoded
string in unicode builds of wxPython, or raw 8-bit text otherwise.
GetTextRangeUTF8(self, startPos, endPos, text, u)
Retrieve a range of text as UTF8. In an ansi build of wxPython
the text retrieved from the document is assumed to be in the
current default encoding.
GetTextRaw(args, kwargs)
GetTextRaw(self) -> wxCharBuffer
Retrieve all the text in the document. The returned value is a utf-8
encoded string in unicode builds of wxPython, or raw 8-bit text
otherwise.
GetTextUTF8(self, text, u)
Retrieve all the text in the document as UTF8. In an ansi build
of wxPython the text retrieved from the document is assumed to be
in the current default encoding.
GetTwoPhaseDraw(args, kwargs)
GetTwoPhaseDraw(self) -> bool
Is drawing done in two phases with backgrounds drawn before foregrounds?
GetUndoCollection(args, kwargs)
GetUndoCollection(self) -> bool
Is undo history being collected?
GetUseAntiAliasing(args, kwargs)
GetUseAntiAliasing(self) -> bool
Returns the current UseAntiAliasing setting.
GetUseHorizontalScrollBar(args, kwargs)
GetUseHorizontalScrollBar(self) -> bool
Is the horizontal scroll bar visible?
GetUseTabs(args, kwargs)
GetUseTabs(self) -> bool
Retrieve whether tabs will be used in indentation.
GetUseVerticalScrollBar(args, kwargs)
GetUseVerticalScrollBar(self) -> bool
Is the vertical scroll bar visible?
GetViewEOL(args, kwargs)
GetViewEOL(self) -> bool
Are the end of line characters visible?
GetViewWhiteSpace(args, kwargs)
GetViewWhiteSpace(self) -> int
Are white space characters currently visible?
Returns one of SCWS_* constants.
GetWrapMode(args, kwargs)
GetWrapMode(self) -> int
Retrieve whether text is word wrapped.
GetWrapStartIndent(args, kwargs)
GetWrapStartIndent(self) -> int
Retrive the start indent for wrapped lines.
GetWrapVisualFlags(args, kwargs)
GetWrapVisualFlags(self) -> int
Retrive the display mode of visual flags for wrapped lines.
GetWrapVisualFlagsLocation(args, kwargs)
GetWrapVisualFlagsLocation(self) -> int
Retrive the location of visual flags for wrapped lines.
GetXOffset(args, kwargs)
GetXOffset(self) -> int
GetZoom(args, kwargs)
GetZoom(self) -> int
Retrieve the zoom level.
GotoLine(args, kwargs)
GotoLine(self, int line)
Set caret to start of a line and ensure it is visible.
GotoPos(args, kwargs)
GotoPos(self, int pos)
Set caret to a position and ensure it is visible.
HideLines(args, kwargs)
HideLines(self, int lineStart, int lineEnd)
Make a range of lines invisible.
HideSelection(args, kwargs)
HideSelection(self, bool normal)
Draw the selection in normal style or with selection highlighted.
Home(args, kwargs)
Home(self)
Move caret to first position on line.
HomeDisplay(args, kwargs)
HomeDisplay(self)
Move caret to first position on display line.
HomeDisplayExtend(args, kwargs)
HomeDisplayExtend(self)
Move caret to first position on display line extending selection to
new caret position.
HomeExtend(args, kwargs)
HomeExtend(self)
Move caret to first position on line extending selection to new caret position.
HomeRectExtend(args, kwargs)
HomeRectExtend(self)
Move caret to first position on line, extending rectangular selection to new caret position.
HomeWrap(args, kwargs)
HomeWrap(self)
These are like their namesakes Home(Extend)?, LineEnd(Extend)?, VCHome(Extend)?
except they behave differently when word-wrap is enabled:
They go first to the start / end of the display line, like (Home|LineEnd)Display
The difference is that, the cursor is already at the point, it goes on to the start
or end of the document line, as appropriate for (Home|LineEnd|VCHome)(Extend)?.
HomeWrapExtend(args, kwargs)
HomeWrapExtend(self)
IndicatorGetForeground(args, kwargs)
IndicatorGetForeground(self, int indic) -> Colour
Retrieve the foreground colour of an indicator.
IndicatorGetStyle(args, kwargs)
IndicatorGetStyle(self, int indic) -> int
Retrieve the style of an indicator.
IndicatorSetForeground(args, kwargs)
IndicatorSetForeground(self, int indic, Colour fore)
Set the foreground colour of an indicator.
IndicatorSetStyle(args, kwargs)
IndicatorSetStyle(self, int indic, int style)
Set an indicator to plain, squiggle or TT.
InsertText(args, kwargs)
InsertText(self, int pos, String text)
Insert string at a position.
InsertTextRaw(args, kwargs)
InsertTextRaw(self, int pos, char text)
Insert string at a position. The text should be utf-8 encoded on
unicode builds of wxPython, or can be any 8-bit text in ansi builds.
InsertTextUTF8(self, pos, text, u)
Insert UTF8 encoded text at a position. Works 'natively' in a
unicode build of wxPython, and will also work in an ansi build if
the UTF8 text is compatible with the current encoding.
LineCopy(args, kwargs)
LineCopy(self)
Copy the line containing the caret.
LineCut(args, kwargs)
LineCut(self)
Cut the line containing the caret.
LineDelete(args, kwargs)
LineDelete(self)
Delete the line containing the caret.
LineDown(args, kwargs)
LineDown(self)
Move caret down one line.
LineDownExtend(args, kwargs)
LineDownExtend(self)
Move caret down one line extending selection to new caret position.
LineDownRectExtend(args, kwargs)
LineDownRectExtend(self)
Move caret down one line, extending rectangular selection to new caret position.
LineDuplicate(args, kwargs)
LineDuplicate(self)
Duplicate the current line.
LineEnd(args, kwargs)
LineEnd(self)
Move caret to last position on line.
LineEndDisplay(args, kwargs)
LineEndDisplay(self)
Move caret to last position on display line.
LineEndDisplayExtend(args, kwargs)
LineEndDisplayExtend(self)
Move caret to last position on display line extending selection to new
caret position.
LineEndExtend(args, kwargs)
LineEndExtend(self)
Move caret to last position on line extending selection to new caret position.
LineEndRectExtend(args, kwargs)
LineEndRectExtend(self)
Move caret to last position on line, extending rectangular selection to new caret position.
LineEndWrap(args, kwargs)
LineEndWrap(self)
LineEndWrapExtend(args, kwargs)
LineEndWrapExtend(self)
LineFromPosition(args, kwargs)
LineFromPosition(self, int pos) -> int
Retrieve the line containing a position.
LineLength(args, kwargs)
LineLength(self, int line) -> int
How many characters are on a line, not including end of line characters?
LineScroll(args, kwargs)
LineScroll(self, int columns, int lines)
Scroll horizontally and vertically.
LineScrollDown(args, kwargs)
LineScrollDown(self)
Scroll the document down, keeping the caret visible.
LineScrollUp(args, kwargs)
LineScrollUp(self)
Scroll the document up, keeping the caret visible.
LineTranspose(args, kwargs)
LineTranspose(self)
Switch the current line with the previous.
LineUp(args, kwargs)
LineUp(self)
Move caret up one line.
LineUpExtend(args, kwargs)
LineUpExtend(self)
Move caret up one line extending selection to new caret position.
LineUpRectExtend(args, kwargs)
LineUpRectExtend(self)
Move caret up one line, extending rectangular selection to new caret position.
LinesJoin(args, kwargs)
LinesJoin(self)
Join the lines in the target.
LinesOnScreen(args, kwargs)
LinesOnScreen(self) -> int
Retrieves the number of lines completely visible.
LinesSplit(args, kwargs)
LinesSplit(self, int pixelWidth)
Split the lines in the target into lines that are less wide than pixelWidth
where possible.
LoadFile(args, kwargs)
LoadFile(self, String filename) -> bool
Load the contents of filename into the editor
LowerCase(args, kwargs)
LowerCase(self)
Transform the selection to lower case.
MarkerAdd(args, kwargs)
MarkerAdd(self, int line, int markerNumber) -> int
Add a marker to a line, returning an ID which can be used to find or delete the marker.
MarkerDefine(args, kwargs)
MarkerDefine(self, int markerNumber, int markerSymbol, Colour foreground=wxNullColour,
Colour background=wxNullColour)
Set the symbol used for a particular marker number,
and optionally the fore and background colours.
MarkerDefineBitmap(args, kwargs)
MarkerDefineBitmap(self, int markerNumber, Bitmap bmp)
Define a marker from a bitmap
MarkerDelete(args, kwargs)
MarkerDelete(self, int line, int markerNumber)
Delete a marker from a line.
MarkerDeleteAll(args, kwargs)
MarkerDeleteAll(self, int markerNumber)
Delete all markers with a particular number from all lines.
MarkerDeleteHandle(args, kwargs)
MarkerDeleteHandle(self, int handle)
Delete a marker.
MarkerGet(args, kwargs)
MarkerGet(self, int line) -> int
Get a bit mask of all the markers set on a line.
MarkerLineFromHandle(args, kwargs)
MarkerLineFromHandle(self, int handle) -> int
Retrieve the line number at which a particular marker is located.
MarkerNext(args, kwargs)
MarkerNext(self, int lineStart, int markerMask) -> int
Find the next line after lineStart that includes a marker in mask.
MarkerPrevious(args, kwargs)
MarkerPrevious(self, int lineStart, int markerMask) -> int
Find the previous line before lineStart that includes a marker in mask.
MarkerSetBackground(args, kwargs)
MarkerSetBackground(self, int markerNumber, Colour back)
Set the background colour used for a particular marker number.
MarkerSetForeground(args, kwargs)
MarkerSetForeground(self, int markerNumber, Colour fore)
Set the foreground colour used for a particular marker number.
MoveCaretInsideView(args, kwargs)
MoveCaretInsideView(self)
Move the caret inside current view if it's not there already.
NewLine(args, kwargs)
NewLine(self)
Insert a new line, may use a CRLF, CR or LF depending on EOL mode.
PageDown(args, kwargs)
PageDown(self)
Move caret one page down.
PageDownExtend(args, kwargs)
PageDownExtend(self)
Move caret one page down extending selection to new caret position.
PageDownRectExtend(args, kwargs)
PageDownRectExtend(self)
Move caret one page down, extending rectangular selection to new caret position.
PageUp(args, kwargs)
PageUp(self)
Move caret one page up.
PageUpExtend(args, kwargs)
PageUpExtend(self)
Move caret one page up extending selection to new caret position.
PageUpRectExtend(args, kwargs)
PageUpRectExtend(self)
Move caret one page up, extending rectangular selection to new caret position.
ParaDown(args, kwargs)
ParaDown(self)
Move caret between paragraphs (delimited by empty lines).
ParaDownExtend(args, kwargs)
ParaDownExtend(self)
ParaUp(args, kwargs)
ParaUp(self)
ParaUpExtend(args, kwargs)
ParaUpExtend(self)
Paste(args, kwargs)
Paste(self)
Paste the contents of the clipboard into the document replacing the selection.
PointFromPosition(args, kwargs)
PointFromPosition(self, int pos) -> Point
Retrieve the point in the window where a position is displayed.
PositionAfter(args, kwargs)
PositionAfter(self, int pos) -> int
Given a valid document position, return the next position taking code
page into account. Maximum value returned is the last position in the document.
PositionBefore(args, kwargs)
PositionBefore(self, int pos) -> int
Given a valid document position, return the previous position taking code
page into account. Returns 0 if passed 0.
PositionFromLine(args, kwargs)
PositionFromLine(self, int line) -> int
Retrieve the position at the start of a line.
PositionFromPoint(args, kwargs)
PositionFromPoint(self, Point pt) -> int
Find the position from a point within the window.
PositionFromPointClose(args, kwargs)
PositionFromPointClose(self, int x, int y) -> int
Find the position from a point within the window but return
INVALID_POSITION if not close to text.
Redo(args, kwargs)
Redo(self)
Redoes the next action on the undo history.
RegisterImage(args, kwargs)
RegisterImage(self, int type, Bitmap bmp)
Register an image for use in autocompletion lists.
ReleaseDocument(args, kwargs)
ReleaseDocument(self, void docPointer)
Release a reference to the document, deleting document if it fades to black.
ReplaceSelection(args, kwargs)
ReplaceSelection(self, String text)
Replace the selected text with the argument text.
ReplaceTarget(args, kwargs)
ReplaceTarget(self, String text) -> int
Replace the target text with the argument text.
Text is counted so it can contain NULs.
Returns the length of the replacement text.
ReplaceTargetRE(args, kwargs)
ReplaceTargetRE(self, String text) -> int
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.
SaveFile(args, kwargs)
SaveFile(self, String filename) -> bool
Write the contents of the editor to filename
ScrollToColumn(args, kwargs)
ScrollToColumn(self, int column)
Scroll enough to make the given column visible
ScrollToLine(args, kwargs)
ScrollToLine(self, int line)
Scroll enough to make the given line visible.
SearchAnchor(args, kwargs)
SearchAnchor(self)
Sets the current caret position to be the search anchor.
SearchInTarget(args, kwargs)
SearchInTarget(self, String text) -> int
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.
SearchNext(args, kwargs)
SearchNext(self, int flags, String text) -> int
Find some text starting at the search anchor.
Does not ensure the selection is visible.
SearchPrev(args, kwargs)
SearchPrev(self, int flags, String text) -> int
Find some text starting at the search anchor and moving backwards.
Does not ensure the selection is visible.
SelectAll(args, kwargs)
SelectAll(self)
Select all the text in the document.
SelectionIsRectangle(args, kwargs)
SelectionIsRectangle(self) -> bool
Is the selection rectangular? The alternative is the more common stream selection.
SendMsg(args, kwargs)
SendMsg(self, int msg, long wp=0, long lp=0) -> long
Send a message to Scintilla.
SetAnchor(args, kwargs)
SetAnchor(self, int posAnchor)
Set the selection anchor to a position. The anchor is the opposite
end of the selection from the caret.
SetBackSpaceUnIndents(args, kwargs)
SetBackSpaceUnIndents(self, bool bsUnIndents)
Sets whether a backspace pressed when caret is within indentation unindents.
SetBufferedDraw(args, kwargs)
SetBufferedDraw(self, bool 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.
SetCaretForeground(args, kwargs)
SetCaretForeground(self, Colour fore)
Set the foreground colour of the caret.
SetCaretLineBack(args, kwargs)
SetCaretLineBack(self, Colour back)
Set the colour of the background of the line containing the caret.
SetCaretLineVisible(args, kwargs)
SetCaretLineVisible(self, bool show)
Display the background of the line containing the caret in a different colour.
SetCaretPeriod(args, kwargs)
SetCaretPeriod(self, int periodMilliseconds)
Get the time in milliseconds that the caret is on and off. 0 = steady on.
SetCaretWidth(args, kwargs)
SetCaretWidth(self, int pixelWidth)
Set the width of the insert mode caret.
SetCharsDefault(args, kwargs)
SetCharsDefault(self)
Reset the set of characters for whitespace and word characters to the defaults.
SetCodePage(args, kwargs)
SetCodePage(self, int codePage)
Set the code page used to interpret the bytes of the document as characters.
SetControlCharSymbol(args, kwargs)
SetControlCharSymbol(self, int symbol)
Change the way control characters are displayed:
If symbol is < 32, keep the drawn way, else, use the given character.
SetCurrentPos(args, kwargs)
SetCurrentPos(self, int pos)
Sets the position of the caret.
SetDocPointer(args, kwargs)
SetDocPointer(self, void docPointer)
Change the document object used.
SetEOLMode(args, kwargs)
SetEOLMode(self, int eolMode)
Set the current end of line mode.
SetEdgeColour(args, kwargs)
SetEdgeColour(self, Colour edgeColour)
Change the colour used in edge indication.
SetEdgeColumn(args, kwargs)
SetEdgeColumn(self, int column)
Set the column number of the edge.
If text goes past the edge then it is highlighted.
SetEdgeMode(args, kwargs)
SetEdgeMode(self, int mode)
The edge may be displayed by a line (EDGE_LINE) or by highlighting text that
goes beyond it (EDGE_BACKGROUND) or not displayed at all (EDGE_NONE).
SetEndAtLastLine(args, kwargs)
SetEndAtLastLine(self, bool 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.
SetFoldExpanded(args, kwargs)
SetFoldExpanded(self, int line, bool expanded)
Show the children of a header line.
SetFoldFlags(args, kwargs)
SetFoldFlags(self, int flags)
Set some style options for folding.
SetFoldLevel(args, kwargs)
SetFoldLevel(self, int line, int 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.
SetFoldMarginColour(args, kwargs)
SetFoldMarginColour(self, bool useSetting, Colour back)
Set the colours used as a chequerboard pattern in the fold margin
SetFoldMarginHiColour(args, kwargs)
SetFoldMarginHiColour(self, bool useSetting, Colour fore)
SetHScrollBar(args, kwargs)
SetHScrollBar(self, wxScrollBar bar)
Set the horizontal scrollbar to use instead of the ont that's built-in.
SetHighlightGuide(args, kwargs)
SetHighlightGuide(self, int column)
Set the highlighted indentation guide column.
0 = no highlighted guide.
SetHotspotActiveBackground(args, kwargs)
SetHotspotActiveBackground(self, bool useSetting, Colour back)
Set a back colour for active hotspots.
SetHotspotActiveForeground(args, kwargs)
SetHotspotActiveForeground(self, bool useSetting, Colour fore)
Set a fore colour for active hotspots.
SetHotspotActiveUnderline(args, kwargs)
SetHotspotActiveUnderline(self, bool underline)
Enable / Disable underlining active hotspots.
SetHotspotSingleLine(args, kwargs)
SetHotspotSingleLine(self, bool singleLine)
Limit hotspots to single line so hotspots on two lines don't merge.
SetIndent(args, kwargs)
SetIndent(self, int indentSize)
Set the number of spaces used for one level of indentation.
SetIndentationGuides(args, kwargs)
SetIndentationGuides(self, bool show)
Show or hide indentation guides.
SetKeyWords(args, kwargs)
SetKeyWords(self, int keywordSet, String keyWords)
Set up the key words used by the lexer.
SetLastKeydownProcessed(args, kwargs)
SetLastKeydownProcessed(self, bool val)
SetLayoutCache(args, kwargs)
SetLayoutCache(self, int mode)
Sets the degree of caching of layout information.
SetLexer(args, kwargs)
SetLexer(self, int lexer)
Set the lexing language of the document.
SetLexerLanguage(args, kwargs)
SetLexerLanguage(self, String language)
Set the lexing language of the document based on string name.
SetLineIndentation(args, kwargs)
SetLineIndentation(self, int line, int indentSize)
Change the indentation of a line to a number of columns.
SetLineState(args, kwargs)
SetLineState(self, int line, int state)
Used to hold extra styling information for each line.
SetMarginLeft(args, kwargs)
SetMarginLeft(self, int pixelWidth)
Sets the size in pixels of the left margin.
SetMarginMask(args, kwargs)
SetMarginMask(self, int margin, int mask)
Set a mask that determines which markers are displayed in a margin.
SetMarginRight(args, kwargs)
SetMarginRight(self, int pixelWidth)
Sets the size in pixels of the right margin.
SetMarginSensitive(args, kwargs)
SetMarginSensitive(self, int margin, bool sensitive)
Make a margin sensitive or insensitive to mouse clicks.
SetMarginType(args, kwargs)
SetMarginType(self, int margin, int marginType)
Set a margin to be either numeric or symbolic.
SetMarginWidth(args, kwargs)
SetMarginWidth(self, int margin, int pixelWidth)
Set the width of a margin to a width expressed in pixels.
SetMargins(args, kwargs)
SetMargins(self, int left, int right)
Set the left and right margin in the edit area, measured in pixels.
SetModEventMask(args, kwargs)
SetModEventMask(self, int mask)
Set which document modification events are sent to the container.
SetMouseDownCaptures(args, kwargs)
SetMouseDownCaptures(self, bool captures)
Set whether the mouse is captured when its button is pressed.
SetMouseDwellTime(args, kwargs)
SetMouseDwellTime(self, int periodMilliseconds)
Sets the time the mouse must sit still to generate a mouse dwell event.
SetOvertype(args, kwargs)
SetOvertype(self, bool overtype)
Set to overtype (true) or insert mode.
SetPrintColourMode(args, kwargs)
SetPrintColourMode(self, int mode)
Modify colours when printing for clearer printed text.
SetPrintMagnification(args, kwargs)
SetPrintMagnification(self, int magnification)
Sets the print magnification added to the point size of each style for printing.
SetPrintWrapMode(args, kwargs)
SetPrintWrapMode(self, int mode)
Set printing to line wrapped (SC_WRAP_WORD) or not line wrapped (SC_WRAP_NONE).
SetProperty(args, kwargs)
SetProperty(self, String key, String value)
Set up a value that may be used by a lexer for some optional feature.
SetReadOnly(args, kwargs)
SetReadOnly(self, bool readOnly)
Set to read only or read write.
SetSTCCursor(args, kwargs)
SetSTCCursor(self, int cursorType)
Sets the cursor to one of the SC_CURSOR* values.
SetSTCFocus(args, kwargs)
SetSTCFocus(self, bool focus)
Change internal focus flag.
SetSavePoint(args, kwargs)
SetSavePoint(self)
Remember the current position in the undo history as the position
at which the document was saved.
SetScrollWidth(args, kwargs)
SetScrollWidth(self, int pixelWidth)
Sets the document width assumed for scrolling.
SetSearchFlags(args, kwargs)
SetSearchFlags(self, int flags)
Set the search flags used by SearchInTarget.
SetSelBackground(args, kwargs)
SetSelBackground(self, bool useSetting, Colour back)
Set the background colour of the selection and whether to use this setting.
SetSelForeground(args, kwargs)
SetSelForeground(self, bool useSetting, Colour fore)
Set the foreground colour of the selection and whether to use this setting.
SetSelection(args, kwargs)
SetSelection(self, int start, int end)
Select a range of text.
SetSelectionEnd(args, kwargs)
SetSelectionEnd(self, int pos)
Sets the position that ends the selection - this becomes the currentPosition.
SetSelectionMode(args, kwargs)
SetSelectionMode(self, int mode)
Set the selection mode to stream (SC_SEL_STREAM) or rectangular (SC_SEL_RECTANGLE) or
by lines (SC_SEL_LINES).
SetSelectionStart(args, kwargs)
SetSelectionStart(self, int pos)
Sets the position that starts the selection - this becomes the anchor.
SetStatus(args, kwargs)
SetStatus(self, int statusCode)
Change error status - 0 = OK.
SetStyleBits(args, kwargs)
SetStyleBits(self, int 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.
SetStyleBytes(args, kwargs)
SetStyleBytes(self, int length, char styleBytes)
Set the styles for a segment of the document.
SetStyling(args, kwargs)
SetStyling(self, int length, int 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.
SetTabIndents(args, kwargs)
SetTabIndents(self, bool tabIndents)
Sets whether a tab pressed when caret is within indentation indents.
SetTabWidth(args, kwargs)
SetTabWidth(self, int tabWidth)
Change the visible size of a tab to be a multiple of the width of a space character.
SetTargetEnd(args, kwargs)
SetTargetEnd(self, int pos)
Sets the position that ends the target which is used for updating the
document without affecting the scroll position.
SetTargetStart(args, kwargs)
SetTargetStart(self, int pos)
Sets the position that starts the target which is used for updating the
document without affecting the scroll position.
SetText(args, kwargs)
SetText(self, String text)
Replace the contents of the document with the argument text.
SetTextRaw(args, kwargs)
SetTextRaw(self, char text)
Replace the contents of the document with the argument text. The text
should be utf-8 encoded on unicode builds of wxPython, or can be any
8-bit text in ansi builds.
SetTextUTF8(self, text, u)
Replace the contents of the document with the UTF8 text given.
Works 'natively' in a unicode build of wxPython, and will also
work in an ansi build if the UTF8 text is compatible with the
current encoding.
SetTwoPhaseDraw(args, kwargs)
SetTwoPhaseDraw(self, bool 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.
SetUndoCollection(args, kwargs)
SetUndoCollection(self, bool collectUndo)
Choose between collecting actions into the undo
history and discarding them.
SetUseAntiAliasing(args, kwargs)
SetUseAntiAliasing(self, bool useAA)
Specify whether anti-aliased fonts should be used. Will have no
effect on some platforms, but on some (wxMac for example) can greatly
improve performance.
SetUseHorizontalScrollBar(args, kwargs)
SetUseHorizontalScrollBar(self, bool show)
Show or hide the horizontal scroll bar.
SetUseTabs(args, kwargs)
SetUseTabs(self, bool useTabs)
Indentation will only use space characters if useTabs is false, otherwise
it will use a combination of tabs and spaces.
SetUseVerticalScrollBar(args, kwargs)
SetUseVerticalScrollBar(self, bool show)
Show or hide the vertical scroll bar.
SetVScrollBar(args, kwargs)
SetVScrollBar(self, wxScrollBar bar)
Set the vertical scrollbar to use instead of the one that's built-in.
SetViewEOL(args, kwargs)
SetViewEOL(self, bool visible)
Make the end of line characters visible or invisible.
SetViewWhiteSpace(args, kwargs)
SetViewWhiteSpace(self, int viewWS)
Make white space characters invisible, always visible or visible outside indentation.
SetVisiblePolicy(args, kwargs)
SetVisiblePolicy(self, int visiblePolicy, int visibleSlop)
Set the way the display area is determined when a particular line
is to be moved to by Find, FindNext, GotoLine, etc.
SetWhitespaceBackground(args, kwargs)
SetWhitespaceBackground(self, bool useSetting, Colour back)
Set the background colour of all whitespace and whether to use this setting.
SetWhitespaceChars(args, kwargs)
SetWhitespaceChars(self, String characters)
Set the set of characters making up whitespace for when moving or selecting by word.
Should be called after SetWordChars.
SetWhitespaceForeground(args, kwargs)
SetWhitespaceForeground(self, bool useSetting, Colour fore)
Set the foreground colour of all whitespace and whether to use this setting.
SetWordChars(args, kwargs)
SetWordChars(self, String characters)
Set the set of characters making up words for when moving or selecting by word.
First sets deaults like SetCharsDefault.
SetWrapMode(args, kwargs)
SetWrapMode(self, int mode)
Sets whether text is word wrapped.
SetWrapStartIndent(args, kwargs)
SetWrapStartIndent(self, int indent)
Set the start indent for wrapped lines.
SetWrapVisualFlags(args, kwargs)
SetWrapVisualFlags(self, int wrapVisualFlags)
Set the display mode of visual flags for wrapped lines.
SetWrapVisualFlagsLocation(args, kwargs)
SetWrapVisualFlagsLocation(self, int wrapVisualFlagsLocation)
Set the location of visual flags for wrapped lines.
SetXCaretPolicy(args, kwargs)
SetXCaretPolicy(self, int caretPolicy, int caretSlop)
Set the way the caret is kept visible when going sideway.
The exclusion zone is given in pixels.
SetXOffset(args, kwargs)
SetXOffset(self, int newOffset)
Get and Set the xOffset (ie, horizonal scroll position).
SetYCaretPolicy(args, kwargs)
SetYCaretPolicy(self, int caretPolicy, int caretSlop)
Set the way the line the caret is on is kept visible.
The exclusion zone is given in lines.
SetZoom(args, kwargs)
SetZoom(self, int zoom)
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.
ShowLines(args, kwargs)
ShowLines(self, int lineStart, int lineEnd)
Make a range of lines visible.
StartRecord(args, kwargs)
StartRecord(self)
Start notifying the container of all key presses and commands.
StartStyling(args, kwargs)
StartStyling(self, int pos, int mask)
Set the current styling position to pos and the styling mask to mask.
The styling mask can be used to protect some bits in each styling byte from modification.
StopRecord(args, kwargs)
StopRecord(self)
Stop notifying the container of all key presses and commands.
StutteredPageDown(args, kwargs)
StutteredPageDown(self)
Move caret to bottom of page, or one page down if already at bottom of page.
StutteredPageDownExtend(args, kwargs)
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(args, kwargs)
StutteredPageUp(self)
Move caret to top of page, or one page up if already at top of page.
StutteredPageUpExtend(args, kwargs)
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(args, kwargs)
StyleClearAll(self)
Clear all the styles and make equivalent to the global default style.
StyleResetDefault(args, kwargs)
StyleResetDefault(self)
Reset the default style to its state at startup
StyleSetBackground(args, kwargs)
StyleSetBackground(self, int style, Colour back)
Set the background colour of a style.
StyleSetBold(args, kwargs)
StyleSetBold(self, int style, bool bold)
Set a style to be bold or not.
StyleSetCase(args, kwargs)
StyleSetCase(self, int style, int caseForce)
Set a style to be mixed case, or to force upper or lower case.
StyleSetChangeable(args, kwargs)
StyleSetChangeable(self, int style, bool changeable)
Set a style to be changeable or not (read only).
Experimental feature, currently buggy.
StyleSetCharacterSet(args, kwargs)
StyleSetCharacterSet(self, int style, int characterSet)
Set the character set of the font in a style. Converts the Scintilla
wx.stc.STC_CHARSET_* set values to a wxFontEncoding.
StyleSetEOLFilled(args, kwargs)
StyleSetEOLFilled(self, int style, bool filled)
Set a style to have its end of line filled or not.
StyleSetFaceName(args, kwargs)
StyleSetFaceName(self, int style, String fontName)
Set the font of a style.
StyleSetFont(args, kwargs)
StyleSetFont(self, int styleNum, Font font)
Set style size, face, bold, italic, and underline attributes from the
attributes of a `wx.Font`.
StyleSetFontAttr(args, kwargs)
StyleSetFontAttr(self, int styleNum, int size, String faceName, bool bold,
bool italic, bool underline, int encoding=wxFONTENCODING_DEFAULT)
Set all font style attributes at once.
StyleSetFontEncoding(args, kwargs)
StyleSetFontEncoding(self, int style, int encoding)
Set the font encoding to be used by a style.
StyleSetForeground(args, kwargs)
StyleSetForeground(self, int style, Colour fore)
Set the foreground colour of a style.
StyleSetHotSpot(args, kwargs)
StyleSetHotSpot(self, int style, bool hotspot)
Set a style to be a hotspot or not.
StyleSetItalic(args, kwargs)
StyleSetItalic(self, int style, bool italic)
Set a style to be italic or not.
StyleSetSize(args, kwargs)
StyleSetSize(self, int style, int sizePoints)
Set the size of characters of a style.
StyleSetSpec(args, kwargs)
StyleSetSpec(self, int styleNum, String 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
StyleSetUnderline(args, kwargs)
StyleSetUnderline(self, int style, bool underline)
Set a style to be underlined or not.
StyleSetVisible(args, kwargs)
StyleSetVisible(self, int style, bool visible)
Set a style to be visible or not.
Tab(args, kwargs)
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(args, kwargs)
TargetFromSelection(self)
Make the target range start and end be the same as the selection range start and end.
TextHeight(args, kwargs)
TextHeight(self, int line) -> int
Retrieve the height of a particular line of text in pixels.
TextWidth(args, kwargs)
TextWidth(self, int style, String text) -> int
Measure the pixel width of some text in a particular style.
NUL terminated text argument.
Does not handle tab or control characters.
ToggleFold(args, kwargs)
ToggleFold(self, int line)
Switch a header line between expanded and contracted.
Undo(args, kwargs)
Undo(self)
Undo one action in the undo history.
UpperCase(args, kwargs)
UpperCase(self)
Transform the selection to upper case.
UsePopUp(args, kwargs)
UsePopUp(self, bool allowPopUp)
Set whether a pop up menu is displayed automatically when the user presses
the wrong mouse button.
UserListShow(args, kwargs)
UserListShow(self, int listType, String itemList)
Display a list of strings and send notification when user chooses one.
VCHome(args, kwargs)
VCHome(self)
Move caret to before first visible character on line.
If already there move to first character on line.
VCHomeExtend(args, kwargs)
VCHomeExtend(self)
Like VCHome but extending selection to new caret position.
VCHomeRectExtend(args, kwargs)
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(args, kwargs)
VCHomeWrap(self)
VCHomeWrapExtend(args, kwargs)
VCHomeWrapExtend(self)
VisibleFromDocLine(args, kwargs)
VisibleFromDocLine(self, int line) -> int
Find the display line of a document line taking hidden lines into account.
WordEndPosition(args, kwargs)
WordEndPosition(self, int pos, bool onlyWordCharacters) -> int
Get position of end of word.
WordLeft(args, kwargs)
WordLeft(self)
Move caret left one word.
WordLeftEnd(args, kwargs)
WordLeftEnd(self)
Move caret left one word, position cursor at end of word.
WordLeftEndExtend(args, kwargs)
WordLeftEndExtend(self)
Move caret left one word, position cursor at end of word, extending selection to new caret position.
WordLeftExtend(args, kwargs)
WordLeftExtend(self)
Move caret left one word extending selection to new caret position.
WordPartLeft(args, kwargs)
WordPartLeft(self)
Move to the previous change in capitalisation.
WordPartLeftExtend(args, kwargs)
WordPartLeftExtend(self)
Move to the previous change in capitalisation extending selection
to new caret position.
WordPartRight(args, kwargs)
WordPartRight(self)
Move to the change next in capitalisation.
WordPartRightExtend(args, kwargs)
WordPartRightExtend(self)
Move to the next change in capitalisation extending selection
to new caret position.
WordRight(args, kwargs)
WordRight(self)
Move caret right one word.
WordRightEnd(args, kwargs)
WordRightEnd(self)
Move caret right one word, position cursor at end of word.
WordRightEndExtend(args, kwargs)
WordRightEndExtend(self)
Move caret right one word, position cursor at end of word, extending selection to new caret position.
WordRightExtend(args, kwargs)
WordRightExtend(self)
Move caret right one word extending selection to new caret position.
WordStartPosition(args, kwargs)
WordStartPosition(self, int pos, bool onlyWordCharacters) -> int
Get position of start of word.
ZoomIn(args, kwargs)
ZoomIn(self)
Magnify the displayed text by increasing the sizes by 1 point.
ZoomOut(args, kwargs)
ZoomOut(self)
Make the displayed text smaller by decreasing the sizes by 1 point.
[constructor]
Usage: classname(arguments)
[member '__doc__']
Documentation for this class
[member '__module__']
The module that this class belongs to
[operator 'repr']
Usage: repr(a)