wx.stc.StyledTextCtrl

Package wx :: Module stc :: Class StyledTextCtrl

Type StyledTextCtrl

object --+                
         |                
    Object --+            
             |            
    EvtHandler --+        
                 |        
            Window --+    
                     |    
               Control --+
                         |
                        StyledTextCtrl

Known Subclasses:: EditWindow, PyShellWindow

Proxy of C++ StyledTextCtrl class

Method Summary
Control	`__init__(self, parent, id, pos, size, style, validator, name)` Create a Control.
	`__repr__(self)`
	`AddRefDocument(self, docPointer)`
	`AddStyledText(self, data)`
	`AddText(self, text)`
	`Allocate(self, bytes)`
	`AppendText(self, length, text)`
bool	`AutoCompActive(self)`
	`AutoCompCancel(self)`
	`AutoCompComplete(self)`
bool	`AutoCompGetAutoHide(self)`
bool	`AutoCompGetCancelAtStart(self)`
bool	`AutoCompGetChooseSingle(self)`
int	`AutoCompGetCurrent(self)`
bool	`AutoCompGetDropRestOfWord(self)`
bool	`AutoCompGetIgnoreCase(self)`
int	`AutoCompGetSeparator(self)`
int	`AutoCompGetTypeSeparator(self)`
int	`AutoCompPosStart(self)`
	`AutoCompSelect(self, text)`
	`AutoCompSetAutoHide(self, autoHide)`
	`AutoCompSetCancelAtStart(self, cancel)`
	`AutoCompSetChooseSingle(self, chooseSingle)`
	`AutoCompSetDropRestOfWord(self, dropRestOfWord)`
	`AutoCompSetFillUps(self, characterSet)`
	`AutoCompSetIgnoreCase(self, ignoreCase)`
	`AutoCompSetSeparator(self, separatorCharacter)`
	`AutoCompSetTypeSeparator(self, separatorCharacter)`
	`AutoCompShow(self, lenEntered, itemList)`
	`AutoCompStops(self, characterSet)`
	`BackTab(self)`
	`BeginUndoAction(self)`
	`BraceBadLight(self, pos)`
	`BraceHighlight(self, pos1, pos2)`
int	`BraceMatch(self, pos)`
bool	`CallTipActive(self)`
	`CallTipCancel(self)`
int	`CallTipPosAtStart(self)`
	`CallTipSetBackground(self, back)`
	`CallTipSetForeground(self, fore)`
	`CallTipSetForegroundHighlight(self, fore)`
	`CallTipSetHighlight(self, start, end)`
	`CallTipShow(self, pos, definition)`
	`Cancel(self)`
bool	`CanPaste(self)`
bool	`CanRedo(self)`
bool	`CanUndo(self)`
	`CharLeft(self)`
	`CharLeftExtend(self)`
	`CharLeftRectExtend(self)`
	`CharRight(self)`
	`CharRightExtend(self)`
	`CharRightRectExtend(self)`
	`ChooseCaretX(self)`
	`Clear(self)`
	`ClearAll(self)`
	`ClearDocumentStyle(self)`
	`ClearRegisteredImages(self)`
	`CmdKeyAssign(self, key, modifiers, cmd)`
	`CmdKeyClear(self, key, modifiers)`
	`CmdKeyClearAll(self)`
	`CmdKeyExecute(self, cmd)`
	`Colourise(self, start, end)`
	`ConvertEOLs(self, eolMode)`
	`Copy(self)`
	`CopyRange(self, start, end)`
	`CopyText(self, length, text)`
bool	`Create(self, parent, id, pos, size, style, validator, name)` Do the 2nd phase and create the GUI control.
void	`CreateDocument(self)`
	`Cut(self)`
	`DeleteBack(self)`
	`DeleteBackNotLine(self)`
	`DelLineLeft(self)`
	`DelLineRight(self)`
	`DelWordLeft(self)`
	`DelWordRight(self)`
int	`DocLineFromVisible(self, lineDisplay)`
	`DocumentEnd(self)`
	`DocumentEndExtend(self)`
	`DocumentStart(self)`
	`DocumentStartExtend(self)`
int	`DoDragOver(self, x, y, def)`
bool	`DoDropText(self, x, y, data)`
	`EditToggleOvertype(self)`
	`EmptyUndoBuffer(self)`
	`EndUndoAction(self)`
	`EnsureCaretVisible(self)`
	`EnsureVisible(self, line)`
	`EnsureVisibleEnforcePolicy(self, line)`
int	`FindColumn(self, line, column)`
int	`FindText(self, minPos, maxPos, text, flags)`
int	`FormatRange(self, doDraw, startPos, endPos, draw, target, renderRect, pageRect)`
	`FormFeed(self)`
int	`GetAnchor(self)`
bool	`GetBackSpaceUnIndents(self)`
bool	`GetBufferedDraw(self)`
Colour	`GetCaretForeground(self)`
Colour	`GetCaretLineBack(self)`
bool	`GetCaretLineVisible(self)`
int	`GetCaretPeriod(self)`
int	`GetCaretWidth(self)`
int	`GetCharAt(self, pos)`
int	`GetCodePage(self)`
int	`GetColumn(self, pos)`
int	`GetControlCharSymbol(self)`
String	`GetCurLine(self, OUTPUT)`
int	`GetCurrentLine(self)`
int	`GetCurrentPos(self)`
void	`GetDocPointer(self)`
Colour	`GetEdgeColour(self)`
int	`GetEdgeColumn(self)`
int	`GetEdgeMode(self)`
int	`GetEndAtLastLine(self)`
int	`GetEndStyled(self)`
int	`GetEOLMode(self)`
int	`GetFirstVisibleLine(self)`
bool	`GetFoldExpanded(self, line)`
int	`GetFoldLevel(self, line)`
int	`GetFoldParent(self, line)`
int	`GetHighlightGuide(self)`
int	`GetIndent(self)`
bool	`GetIndentationGuides(self)`
int	`GetLastChild(self, line, level)`
bool	`GetLastKeydownProcessed(self)`
int	`GetLayoutCache(self)`
int	`GetLength(self)`
int	`GetLexer(self)`
String	`GetLine(self, line)`
int	`GetLineCount(self)`
int	`GetLineEndPosition(self, line)`
int	`GetLineIndentation(self, line)`
int	`GetLineIndentPosition(self, line)`
int	`GetLineSelEndPosition(self, line)`
int	`GetLineSelStartPosition(self, line)`
int	`GetLineState(self, line)`
bool	`GetLineVisible(self, line)`
int	`GetMarginLeft(self)`
int	`GetMarginMask(self, margin)`
int	`GetMarginRight(self)`
bool	`GetMarginSensitive(self, margin)`
int	`GetMarginType(self, margin)`
int	`GetMarginWidth(self, margin)`
int	`GetMaxLineState(self)`
int	`GetModEventMask(self)`
bool	`GetModify(self)`
bool	`GetMouseDownCaptures(self)`
int	`GetMouseDwellTime(self)`
bool	`GetOvertype(self)`
int	`GetPrintColourMode(self)`
int	`GetPrintMagnification(self)`
int	`GetPrintWrapMode(self)`
bool	`GetReadOnly(self)`
int	`GetScrollWidth(self)`
int	`GetSearchFlags(self)`
String	`GetSelectedText(self)`
	`GetSelection(self, OUTPUT, OUTPUT)`
int	`GetSelectionEnd(self)`
int	`GetSelectionMode(self)`
int	`GetSelectionStart(self)`
int	`GetStatus(self)`
int	`GetSTCCursor(self)`
bool	`GetSTCFocus(self)`
int	`GetStyleAt(self, pos)`
int	`GetStyleBits(self)`
wxMemoryBuffer	`GetStyledText(self, startPos, endPos)`
bool	`GetTabIndents(self)`
int	`GetTabWidth(self)`
int	`GetTargetEnd(self)`
int	`GetTargetStart(self)`
String	`GetText(self)`
int	`GetTextLength(self)`
String	`GetTextRange(self, startPos, endPos)`
bool	`GetTwoPhaseDraw(self)`
bool	`GetUndoCollection(self)`
bool	`GetUseAntiAliasing(self)`
bool	`GetUseHorizontalScrollBar(self)`
bool	`GetUseTabs(self)`
bool	`GetUseVerticalScrollBar(self)`
bool	`GetViewEOL(self)`
int	`GetViewWhiteSpace(self)`
int	`GetWrapMode(self)`
int	`GetWrapStartIndent(self)`
int	`GetWrapVisualFlags(self)`
int	`GetWrapVisualFlagsLocation(self)`
int	`GetXOffset(self)`
int	`GetZoom(self)`
	`GotoLine(self, line)`
	`GotoPos(self, pos)`
	`HideLines(self, lineStart, lineEnd)`
	`HideSelection(self, normal)`
	`Home(self)`
	`HomeDisplay(self)`
	`HomeDisplayExtend(self)`
	`HomeExtend(self)`
	`HomeRectExtend(self)`
	`HomeWrap(self)`
	`HomeWrapExtend(self)`
Colour	`IndicatorGetForeground(self, indic)`
int	`IndicatorGetStyle(self, indic)`
	`IndicatorSetForeground(self, indic, fore)`
	`IndicatorSetStyle(self, indic, style)`
	`InsertText(self, pos, text)`
	`LineCopy(self)`
	`LineCut(self)`
	`LineDelete(self)`
	`LineDown(self)` This is just a wrapper for ScrollLines(1).
	`LineDownExtend(self)`
	`LineDownRectExtend(self)`
	`LineDuplicate(self)`
	`LineEnd(self)`
	`LineEndDisplay(self)`
	`LineEndDisplayExtend(self)`
	`LineEndExtend(self)`
	`LineEndRectExtend(self)`
	`LineEndWrap(self)`
	`LineEndWrapExtend(self)`
int	`LineFromPosition(self, pos)`
int	`LineLength(self, line)`
	`LineScroll(self, columns, lines)`
	`LineScrollDown(self)`
	`LineScrollUp(self)`
	`LinesJoin(self)`
int	`LinesOnScreen(self)`
	`LinesSplit(self, pixelWidth)`
	`LineTranspose(self)`
	`LineUp(self)` This is just a wrapper for ScrollLines(-1).
	`LineUpExtend(self)`
	`LineUpRectExtend(self)`
bool	`LoadFile(self, filename)`
	`LowerCase(self)`
int	`MarkerAdd(self, line, markerNumber)`
	`MarkerDefine(self, markerNumber, markerSymbol, foreground, background)`
	`MarkerDefineBitmap(self, markerNumber, bmp)`
	`MarkerDelete(self, line, markerNumber)`
	`MarkerDeleteAll(self, markerNumber)`
	`MarkerDeleteHandle(self, handle)`
int	`MarkerGet(self, line)`
int	`MarkerLineFromHandle(self, handle)`
int	`MarkerNext(self, lineStart, markerMask)`
int	`MarkerPrevious(self, lineStart, markerMask)`
	`MarkerSetBackground(self, markerNumber, back)`
	`MarkerSetForeground(self, markerNumber, fore)`
	`MoveCaretInsideView(self)`
	`NewLine(self)`
	`PageDown(self)` This is just a wrapper for ScrollPages(1).
	`PageDownExtend(self)`
	`PageDownRectExtend(self)`
	`PageUp(self)` This is just a wrapper for ScrollPages(-1).
	`PageUpExtend(self)`
	`PageUpRectExtend(self)`
	`ParaDown(self)`
	`ParaDownExtend(self)`
	`ParaUp(self)`
	`ParaUpExtend(self)`
	`Paste(self)`
Point	`PointFromPosition(self, pos)`
int	`PositionAfter(self, pos)`
int	`PositionBefore(self, pos)`
int	`PositionFromLine(self, line)`
int	`PositionFromPoint(self, pt)`
int	`PositionFromPointClose(self, x, y)`
	`Redo(self)`
	`RegisterImage(self, type, bmp)`
	`ReleaseDocument(self, docPointer)`
	`ReplaceSelection(self, text)`
int	`ReplaceTarget(self, text)`
int	`ReplaceTargetRE(self, text)`
bool	`SaveFile(self, filename)`
	`ScrollToColumn(self, column)`
	`ScrollToLine(self, line)`
	`SearchAnchor(self)`
int	`SearchInTarget(self, text)`
int	`SearchNext(self, flags, text)`
int	`SearchPrev(self, flags, text)`
	`SelectAll(self)`
bool	`SelectionIsRectangle(self)`
long	`SendMsg(self, msg, wp, lp)`
	`SetAnchor(self, posAnchor)`
	`SetBackSpaceUnIndents(self, bsUnIndents)`
	`SetBufferedDraw(self, buffered)`
	`SetCaretForeground(self, fore)`
	`SetCaretLineBack(self, back)`
	`SetCaretLineVisible(self, show)`
	`SetCaretPeriod(self, periodMilliseconds)`
	`SetCaretWidth(self, pixelWidth)`
	`SetCharsDefault(self)`
	`SetCodePage(self, codePage)`
	`SetControlCharSymbol(self, symbol)`
	`SetCurrentPos(self, pos)`
	`SetDocPointer(self, docPointer)`
	`SetEdgeColour(self, edgeColour)`
	`SetEdgeColumn(self, column)`
	`SetEdgeMode(self, mode)`
	`SetEndAtLastLine(self, endAtLastLine)`
	`SetEOLMode(self, eolMode)`
	`SetFoldExpanded(self, line, expanded)`
	`SetFoldFlags(self, flags)`
	`SetFoldLevel(self, line, level)`
	`SetFoldMarginColour(self, useSetting, back)`
	`SetFoldMarginHiColour(self, useSetting, fore)`
	`SetHighlightGuide(self, column)`
	`SetHotspotActiveBackground(self, useSetting, back)`
	`SetHotspotActiveForeground(self, useSetting, fore)`
	`SetHotspotActiveUnderline(self, underline)`
	`SetHotspotSingleLine(self, singleLine)`
	`SetHScrollBar(self, bar)`
	`SetIndent(self, indentSize)`
	`SetIndentationGuides(self, show)`
	`SetKeyWords(self, keywordSet, keyWords)`
	`SetLastKeydownProcessed(self, val)`
	`SetLayoutCache(self, mode)`
	`SetLexer(self, lexer)`
	`SetLexerLanguage(self, language)`
	`SetLineIndentation(self, line, indentSize)`
	`SetLineState(self, line, state)`
	`SetMarginLeft(self, pixelWidth)`
	`SetMarginMask(self, margin, mask)`
	`SetMarginRight(self, pixelWidth)`
	`SetMargins(self, left, right)`
	`SetMarginSensitive(self, margin, sensitive)`
	`SetMarginType(self, margin, marginType)`
	`SetMarginWidth(self, margin, pixelWidth)`
	`SetModEventMask(self, mask)`
	`SetMouseDownCaptures(self, captures)`
	`SetMouseDwellTime(self, periodMilliseconds)`
	`SetOvertype(self, overtype)`
	`SetPrintColourMode(self, mode)`
	`SetPrintMagnification(self, magnification)`
	`SetPrintWrapMode(self, mode)`
	`SetProperty(self, key, value)`
	`SetReadOnly(self, readOnly)`
	`SetSavePoint(self)`
	`SetScrollWidth(self, pixelWidth)`
	`SetSearchFlags(self, flags)`
	`SetSelBackground(self, useSetting, back)`
	`SetSelection(self, start, end)`
	`SetSelectionEnd(self, pos)`
	`SetSelectionMode(self, mode)`
	`SetSelectionStart(self, pos)`
	`SetSelForeground(self, useSetting, fore)`
	`SetStatus(self, statusCode)`
	`SetSTCCursor(self, cursorType)`
	`SetSTCFocus(self, focus)`
	`SetStyleBits(self, bits)`
	`SetStyleBytes(self, length, styleBytes)`
	`SetStyling(self, length, style)`
	`SetTabIndents(self, tabIndents)`
	`SetTabWidth(self, tabWidth)`
	`SetTargetEnd(self, pos)`
	`SetTargetStart(self, pos)`
	`SetText(self, text)`
	`SetTwoPhaseDraw(self, twoPhase)`
	`SetUndoCollection(self, collectUndo)`
	`SetUseAntiAliasing(self, useAA)`
	`SetUseHorizontalScrollBar(self, show)`
	`SetUseTabs(self, useTabs)`
	`SetUseVerticalScrollBar(self, show)`
	`SetViewEOL(self, visible)`
	`SetViewWhiteSpace(self, viewWS)`
	`SetVisiblePolicy(self, visiblePolicy, visibleSlop)`
	`SetVScrollBar(self, bar)`
	`SetWhitespaceBackground(self, useSetting, back)`
	`SetWhitespaceChars(self, characters)`
	`SetWhitespaceForeground(self, useSetting, fore)`
	`SetWordChars(self, characters)`
	`SetWrapMode(self, mode)`
	`SetWrapStartIndent(self, indent)`
	`SetWrapVisualFlags(self, wrapVisualFlags)`
	`SetWrapVisualFlagsLocation(self, wrapVisualFlagsLocation)`
	`SetXCaretPolicy(self, caretPolicy, caretSlop)`
	`SetXOffset(self, newOffset)`
	`SetYCaretPolicy(self, caretPolicy, caretSlop)`
	`SetZoom(self, zoom)`
	`ShowLines(self, lineStart, lineEnd)`
	`StartRecord(self)`
	`StartStyling(self, pos, mask)`
	`StopRecord(self)`
	`StutteredPageDown(self)`
	`StutteredPageDownExtend(self)`
	`StutteredPageUp(self)`
	`StutteredPageUpExtend(self)`
	`StyleClearAll(self)`
	`StyleResetDefault(self)`
	`StyleSetBackground(self, style, back)`
	`StyleSetBold(self, style, bold)`
	`StyleSetCase(self, style, caseForce)`
	`StyleSetChangeable(self, style, changeable)`
	`StyleSetCharacterSet(self, style, characterSet)`
	`StyleSetEOLFilled(self, style, filled)`
	`StyleSetFaceName(self, style, fontName)`
	`StyleSetFont(self, styleNum, font)`
	`StyleSetFontAttr(self, styleNum, size, faceName, bold, italic, underline)`
	`StyleSetForeground(self, style, fore)`
	`StyleSetHotSpot(self, style, hotspot)`
	`StyleSetItalic(self, style, italic)`
	`StyleSetSize(self, style, sizePoints)`
	`StyleSetSpec(self, styleNum, spec)`
	`StyleSetUnderline(self, style, underline)`
	`StyleSetVisible(self, style, visible)`
	`Tab(self)`
	`TargetFromSelection(self)`
int	`TextHeight(self, line)`
int	`TextWidth(self, style, text)`
	`ToggleFold(self, line)`
	`Undo(self)`
	`UpperCase(self)`
	`UsePopUp(self, allowPopUp)`
	`UserListShow(self, listType, itemList)`
	`VCHome(self)`
	`VCHomeExtend(self)`
	`VCHomeRectExtend(self)`
	`VCHomeWrap(self)`
	`VCHomeWrapExtend(self)`
int	`VisibleFromDocLine(self, line)`
int	`WordEndPosition(self, pos, onlyWordCharacters)`
	`WordLeft(self)`
	`WordLeftEnd(self)`
	`WordLeftEndExtend(self)`
	`WordLeftExtend(self)`
	`WordPartLeft(self)`
	`WordPartLeftExtend(self)`
	`WordPartRight(self)`
	`WordPartRightExtend(self)`
	`WordRight(self)`
	`WordRightEnd(self)`
	`WordRightEndExtend(self)`
	`WordRightExtend(self)`
int	`WordStartPosition(self, pos, onlyWordCharacters)`
	`ZoomIn(self)`
	`ZoomOut(self)`

Instance Method Details

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

Create a Control. Normally you should only call this from a subclass' __init__ as a plain old wx.Control is not very useful.

Parameters:: parent
(type=Window); id
(type=int); pos
(type=Point); size
(type=Size); style
(type=long); validator
(type=Validator); name
(type=String)

Returns:: Control

Overrides:: wx.Control.__init__ (inherited documentation)

Create(self, parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=0, name=wxSTCNameStr)

Do the 2nd phase and create the GUI control.

Parameters:: parent
(type=Window); id
(type=int); pos
(type=Point); size
(type=Size); style
(type=long); validator
(type=Validator); name
(type=String)