pyMez.Code.FrontEnds.StyledTextCtrlPanel module
#Boa:FramePanel:StyledTextCtrlPanel import wx import wx.stc [wxID_STYLEDTEXTCTRLPANEL, wxID_STYLEDTEXTCTRLPANELSTYLEDTEXTCTRL1, ] = [wx.NewId() for _init_ctrls in range(2)] import keyword import wx import wx.stc as stc #import images #I don't where this module really is. I have just replaced the ref #---------------------------------------------------------------------- demoText = """\ ## This version of the editor has been set up to edit Python source ## code. Here is a copy of wxPython/demo/Main.py to play with. """ #---------------------------------------------------------------------- if wx.Platform == '__WXMSW__': faces = { 'times': 'Times New Roman', 'mono' : 'Courier New', 'helv' : 'Arial', 'other': 'Comic Sans MS', 'size' : 10, 'size2': 8, } elif wx.Platform == '__WXMAC__': faces = { 'times': 'Times New Roman', 'mono' : 'Monaco', 'helv' : 'Arial', 'other': 'Comic Sans MS', 'size' : 12, 'size2': 10, } else: faces = { 'times': 'Times', 'mono' : 'Courier', 'helv' : 'Helvetica', 'other': 'new century schoolbook', 'size' : 12, 'size2': 10, } #---------------------------------------------------------------------- class PythonSTC(stc.StyledTextCtrl): fold_symbols = 2 def __init__(self, parent, id, pos=wx.DefaultPosition, size=wx.DefaultSize, style=0,name=None): stc.StyledTextCtrl.__init__(self, parent, id, pos, size, style,name) self.CmdKeyAssign(ord('B'), stc.STC_SCMOD_CTRL, stc.STC_CMD_ZOOMIN) self.CmdKeyAssign(ord('N'), stc.STC_SCMOD_CTRL, stc.STC_CMD_ZOOMOUT) self.SetLexer(stc.STC_LEX_PYTHON) self.SetKeyWords(0, " ".join(keyword.kwlist)) self.SetProperty("fold", "1") self.SetProperty("tab.timmy.whinge.level", "1") self.SetMargins(0,0) self.SetViewWhiteSpace(False) #self.SetBufferedDraw(False) #self.SetViewEOL(True) #self.SetEOLMode(stc.STC_EOL_CRLF) #self.SetUseAntiAliasing(True) self.SetEdgeMode(stc.STC_EDGE_BACKGROUND) self.SetEdgeColumn(78) # Setup a margin to hold fold markers self.SetFoldFlags(16) ### WHAT IS THIS VALUE? WHAT ARE THE OTHER FLAGS? DOES IT MATTER? self.SetMarginType(2, stc.STC_MARGIN_SYMBOL) self.SetMarginMask(2, stc.STC_MASK_FOLDERS) self.SetMarginSensitive(2, True) self.SetMarginWidth(2, 12) if self.fold_symbols == 0: # Arrow pointing right for contracted folders, arrow pointing down for expanded self.MarkerDefine(stc.STC_MARKNUM_FOLDEROPEN, stc.STC_MARK_ARROWDOWN, "black", "black") self.MarkerDefine(stc.STC_MARKNUM_FOLDER, stc.STC_MARK_ARROW, "black", "black") self.MarkerDefine(stc.STC_MARKNUM_FOLDERSUB, stc.STC_MARK_EMPTY, "black", "black") self.MarkerDefine(stc.STC_MARKNUM_FOLDERTAIL, stc.STC_MARK_EMPTY, "black", "black") self.MarkerDefine(stc.STC_MARKNUM_FOLDEREND, stc.STC_MARK_EMPTY, "white", "black") self.MarkerDefine(stc.STC_MARKNUM_FOLDEROPENMID, stc.STC_MARK_EMPTY, "white", "black") self.MarkerDefine(stc.STC_MARKNUM_FOLDERMIDTAIL, stc.STC_MARK_EMPTY, "white", "black") elif self.fold_symbols == 1: # Plus for contracted folders, minus for expanded self.MarkerDefine(stc.STC_MARKNUM_FOLDEROPEN, stc.STC_MARK_MINUS, "white", "black") self.MarkerDefine(stc.STC_MARKNUM_FOLDER, stc.STC_MARK_PLUS, "white", "black") self.MarkerDefine(stc.STC_MARKNUM_FOLDERSUB, stc.STC_MARK_EMPTY, "white", "black") self.MarkerDefine(stc.STC_MARKNUM_FOLDERTAIL, stc.STC_MARK_EMPTY, "white", "black") self.MarkerDefine(stc.STC_MARKNUM_FOLDEREND, stc.STC_MARK_EMPTY, "white", "black") self.MarkerDefine(stc.STC_MARKNUM_FOLDEROPENMID, stc.STC_MARK_EMPTY, "white", "black") self.MarkerDefine(stc.STC_MARKNUM_FOLDERMIDTAIL, stc.STC_MARK_EMPTY, "white", "black") elif self.fold_symbols == 2: # Like a flattened tree control using circular headers and curved joins self.MarkerDefine(stc.STC_MARKNUM_FOLDEROPEN, stc.STC_MARK_CIRCLEMINUS, "white", "#404040") self.MarkerDefine(stc.STC_MARKNUM_FOLDER, stc.STC_MARK_CIRCLEPLUS, "white", "#404040") self.MarkerDefine(stc.STC_MARKNUM_FOLDERSUB, stc.STC_MARK_VLINE, "white", "#404040") self.MarkerDefine(stc.STC_MARKNUM_FOLDERTAIL, stc.STC_MARK_LCORNERCURVE, "white", "#404040") self.MarkerDefine(stc.STC_MARKNUM_FOLDEREND, stc.STC_MARK_CIRCLEPLUSCONNECTED, "white", "#404040") self.MarkerDefine(stc.STC_MARKNUM_FOLDEROPENMID, stc.STC_MARK_CIRCLEMINUSCONNECTED, "white", "#404040") self.MarkerDefine(stc.STC_MARKNUM_FOLDERMIDTAIL, stc.STC_MARK_TCORNERCURVE, "white", "#404040") elif self.fold_symbols == 3: # Like a flattened tree control using square headers self.MarkerDefine(stc.STC_MARKNUM_FOLDEROPEN, stc.STC_MARK_BOXMINUS, "white", "#808080") self.MarkerDefine(stc.STC_MARKNUM_FOLDER, stc.STC_MARK_BOXPLUS, "white", "#808080") self.MarkerDefine(stc.STC_MARKNUM_FOLDERSUB, stc.STC_MARK_VLINE, "white", "#808080") self.MarkerDefine(stc.STC_MARKNUM_FOLDERTAIL, stc.STC_MARK_LCORNER, "white", "#808080") self.MarkerDefine(stc.STC_MARKNUM_FOLDEREND, stc.STC_MARK_BOXPLUSCONNECTED, "white", "#808080") self.MarkerDefine(stc.STC_MARKNUM_FOLDEROPENMID, stc.STC_MARK_BOXMINUSCONNECTED, "white", "#808080") self.MarkerDefine(stc.STC_MARKNUM_FOLDERMIDTAIL, stc.STC_MARK_TCORNER, "white", "#808080") self.Bind(stc.EVT_STC_UPDATEUI, self.OnUpdateUI) self.Bind(stc.EVT_STC_MARGINCLICK, self.OnMarginClick) self.Bind(wx.EVT_KEY_DOWN, self.OnKeyPressed) # Make some styles, The lexer defines what each style is used for, we # just have to define what each style looks like. This set is adapted from # Scintilla sample property files. # Global default styles for all languages self.StyleSetSpec(stc.STC_STYLE_DEFAULT, "face:%(helv)s,size:%(size)d" % faces) self.StyleClearAll() # Reset all to be like the default # Global default styles for all languages self.StyleSetSpec(stc.STC_STYLE_DEFAULT, "face:%(helv)s,size:%(size)d" % faces) self.StyleSetSpec(stc.STC_STYLE_LINENUMBER, "back:#C0C0C0,face:%(helv)s,size:%(size2)d" % faces) self.StyleSetSpec(stc.STC_STYLE_CONTROLCHAR, "face:%(other)s" % faces) self.StyleSetSpec(stc.STC_STYLE_BRACELIGHT, "fore:#FFFFFF,back:#0000FF,bold") self.StyleSetSpec(stc.STC_STYLE_BRACEBAD, "fore:#000000,back:#FF0000,bold") # Python styles # Default self.StyleSetSpec(stc.STC_P_DEFAULT, "fore:#000000,face:%(helv)s,size:%(size)d" % faces) # Comments self.StyleSetSpec(stc.STC_P_COMMENTLINE, "fore:#007F00,face:%(other)s,size:%(size)d" % faces) # Number self.StyleSetSpec(stc.STC_P_NUMBER, "fore:#007F7F,size:%(size)d" % faces) # String self.StyleSetSpec(stc.STC_P_STRING, "fore:#7F007F,face:%(helv)s,size:%(size)d" % faces) # Single quoted string self.StyleSetSpec(stc.STC_P_CHARACTER, "fore:#7F007F,face:%(helv)s,size:%(size)d" % faces) # Keyword self.StyleSetSpec(stc.STC_P_WORD, "fore:#00007F,bold,size:%(size)d" % faces) # Triple quotes self.StyleSetSpec(stc.STC_P_TRIPLE, "fore:#7F0000,size:%(size)d" % faces) # Triple double quotes self.StyleSetSpec(stc.STC_P_TRIPLEDOUBLE, "fore:#7F0000,size:%(size)d" % faces) # Class name definition self.StyleSetSpec(stc.STC_P_CLASSNAME, "fore:#0000FF,bold,underline,size:%(size)d" % faces) # Function or method name definition self.StyleSetSpec(stc.STC_P_DEFNAME, "fore:#007F7F,bold,size:%(size)d" % faces) # Operators self.StyleSetSpec(stc.STC_P_OPERATOR, "bold,size:%(size)d" % faces) # Identifiers self.StyleSetSpec(stc.STC_P_IDENTIFIER, "fore:#000000,face:%(helv)s,size:%(size)d" % faces) # Comment-blocks self.StyleSetSpec(stc.STC_P_COMMENTBLOCK, "fore:#7F7F7F,size:%(size)d" % faces) # End of line where string is not closed #self.StyleSetSpec(stc.STC_P_STRINGEOL, "fore:#000000,face:%(mono)s,back:#E0C0E0,eol,size:%(size)d" % faces) self.SetCaretForeground("BLUE") # register some images for use in the AutoComplete box. self.RegisterImage(1, wx.ArtProvider.GetBitmap(wx.ART_NEW, size=(16,16))) self.RegisterImage(2, wx.ArtProvider.GetBitmap(wx.ART_NEW, size=(16,16))) self.RegisterImage(3, wx.ArtProvider.GetBitmap(wx.ART_COPY, size=(16,16))) def OnKeyPressed(self, event): if self.CallTipActive(): self.CallTipCancel() key = event.GetKeyCode() if key == 32 and event.ControlDown(): pos = self.GetCurrentPos() # Tips if event.ShiftDown(): self.CallTipSetBackground("yellow") self.CallTipShow(pos, 'lots of of text: blah, blah, blah\n\n' 'show some suff, maybe parameters..\n\n' 'fubar(param1, param2)') # Code completion else: #lst = [] #for x in range(50000): # lst.append('%05d' % x) #st = " ".join(lst) #print len(st) #self.AutoCompShow(0, st) kw = keyword.kwlist[:] kw.append("zzzzzz?2") kw.append("aaaaa?2") kw.append("__init__?3") kw.append("zzaaaaa?2") kw.append("zzbaaaa?2") kw.append("this_is_a_longer_value") #kw.append("this_is_a_much_much_much_much_much_much_much_longer_value") kw.sort() # Python sorts are case sensitive self.AutoCompSetIgnoreCase(False) # so this needs to match # Images are specified with a appended "?type" for i in range(len(kw)): if kw[i] in keyword.kwlist: kw[i] = kw[i] + "?1" self.AutoCompShow(0, " ".join(kw)) else: event.Skip() def OnUpdateUI(self, evt): # check for matching braces braceAtCaret = -1 braceOpposite = -1 charBefore = None caretPos = self.GetCurrentPos() if caretPos > 0: charBefore = self.GetCharAt(caretPos - 1) styleBefore = self.GetStyleAt(caretPos - 1) # check before if charBefore and chr(charBefore) in "[]{}()" and styleBefore == stc.STC_P_OPERATOR: braceAtCaret = caretPos - 1 # check after if braceAtCaret < 0: charAfter = self.GetCharAt(caretPos) styleAfter = self.GetStyleAt(caretPos) if charAfter and chr(charAfter) in "[]{}()" and styleAfter == stc.STC_P_OPERATOR: braceAtCaret = caretPos if braceAtCaret >= 0: braceOpposite = self.BraceMatch(braceAtCaret) if braceAtCaret != -1 and braceOpposite == -1: self.BraceBadLight(braceAtCaret) else: self.BraceHighlight(braceAtCaret, braceOpposite) #pt = self.PointFromPosition(braceOpposite) #self.Refresh(True, wxRect(pt.x, pt.y, 5,5)) #print pt #self.Refresh(False) def OnMarginClick(self, evt): # fold and unfold as needed if evt.GetMargin() == 2: if evt.GetShift() and evt.GetControl(): self.FoldAll() else: lineClicked = self.LineFromPosition(evt.GetPosition()) if self.GetFoldLevel(lineClicked) & stc.STC_FOLDLEVELHEADERFLAG: if evt.GetShift(): self.SetFoldExpanded(lineClicked, True) self.Expand(lineClicked, True, True, 1) elif evt.GetControl(): if self.GetFoldExpanded(lineClicked): self.SetFoldExpanded(lineClicked, False) self.Expand(lineClicked, False, True, 0) else: self.SetFoldExpanded(lineClicked, True) self.Expand(lineClicked, True, True, 100) else: self.ToggleFold(lineClicked) def FoldAll(self): lineCount = self.GetLineCount() expanding = True # find out if we are folding or unfolding for lineNum in range(lineCount): if self.GetFoldLevel(lineNum) & stc.STC_FOLDLEVELHEADERFLAG: expanding = not self.GetFoldExpanded(lineNum) break lineNum = 0 while lineNum < lineCount: level = self.GetFoldLevel(lineNum) if level & stc.STC_FOLDLEVELHEADERFLAG and \ (level & stc.STC_FOLDLEVELNUMBERMASK) == stc.STC_FOLDLEVELBASE: if expanding: self.SetFoldExpanded(lineNum, True) lineNum = self.Expand(lineNum, True) lineNum = lineNum - 1 else: lastChild = self.GetLastChild(lineNum, -1) self.SetFoldExpanded(lineNum, False) if lastChild > lineNum: self.HideLines(lineNum+1, lastChild) lineNum = lineNum + 1 def Expand(self, line, doExpand, force=False, visLevels=0, level=-1): lastChild = self.GetLastChild(line, level) line = line + 1 while line <= lastChild: if force: if visLevels > 0: self.ShowLines(line, line) else: self.HideLines(line, line) else: if doExpand: self.ShowLines(line, line) if level == -1: level = self.GetFoldLevel(line) if level & stc.STC_FOLDLEVELHEADERFLAG: if force: if visLevels > 1: self.SetFoldExpanded(line, True) else: self.SetFoldExpanded(line, False) line = self.Expand(line, doExpand, force, visLevels-1) else: if doExpand and self.GetFoldExpanded(line): line = self.Expand(line, True, force, visLevels-1) else: line = self.Expand(line, False, force, visLevels-1) else: line = line + 1 return line #---------------------------------------------------------------------- _USE_PANEL = 1 def runTest(frame, nb, log): if not _USE_PANEL: ed = p = PythonSTC(nb, -1) else: p = wx.Panel(nb, -1, style = wx.NO_FULL_REPAINT_ON_RESIZE) ed = PythonSTC(p, -1) s = wx.BoxSizer(wx.HORIZONTAL) s.Add(ed, 1, wx.EXPAND) p.SetSizer(s) p.SetAutoLayout(True) ed.SetText(demoText + open('Main.py').read()) ed.EmptyUndoBuffer() ed.Colourise(0, -1) # line numbers in the margin ed.SetMarginType(1, stc.STC_MARGIN_NUMBER) ed.SetMarginWidth(1, 25) return p #---------------------------------------------------------------------- overview = """\ <html><body> Once again, no docs yet. <b>Sorry.</b> But <a href="data/stc.h.html">this</a> and <a href="http://www.scintilla.org/ScintillaDoc.html">this</a> should be helpful. </body><html> """ class XMLSTC(stc.StyledTextCtrl): """ This is a modified StyledTextCtrl for xml. It has weirdness because it was adpated from a Python STC in wx examples.""" fold_symbols = 2 def __init__(self, parent, id, pos=wx.DefaultPosition, size=wx.DefaultSize, style=0,name=None): stc.StyledTextCtrl.__init__(self, parent, id, pos, size, style,name) self.CmdKeyAssign(ord('B'), stc.STC_SCMOD_CTRL, stc.STC_CMD_ZOOMIN) self.CmdKeyAssign(ord('N'), stc.STC_SCMOD_CTRL, stc.STC_CMD_ZOOMOUT) self.SetLexer(stc.STC_LEX_XML) #self.SetKeyWords(0, " ".join(keyword.kwlist)) self.SetProperty("fold", "1") self.SetProperty("tab.timmy.whinge.level", "1") self.SetMargins(0,0) #self.SetViewWhiteSpace(False) #self.SetBufferedDraw(False) #self.SetViewEOL(True) #self.SetEOLMode(stc.STC_EOL_CRLF) #self.SetUseAntiAliasing(True) self.SetEdgeMode(stc.STC_EDGE_BACKGROUND) self.SetEdgeColumn(78) # Setup a margin to hold fold markers self.SetFoldFlags(16) ### WHAT IS THIS VALUE? WHAT ARE THE OTHER FLAGS? DOES IT MATTER? self.SetMarginType(2, stc.STC_MARGIN_SYMBOL) self.SetMarginMask(2, stc.STC_MASK_FOLDERS) self.SetMarginSensitive(2, True) self.SetMarginWidth(2, 12) if self.fold_symbols == 0: # Arrow pointing right for contracted folders, arrow pointing down for expanded self.MarkerDefine(stc.STC_MARKNUM_FOLDEROPEN, stc.STC_MARK_ARROWDOWN, "black", "black") self.MarkerDefine(stc.STC_MARKNUM_FOLDER, stc.STC_MARK_ARROW, "black", "black") self.MarkerDefine(stc.STC_MARKNUM_FOLDERSUB, stc.STC_MARK_EMPTY, "black", "black") self.MarkerDefine(stc.STC_MARKNUM_FOLDERTAIL, stc.STC_MARK_EMPTY, "black", "black") self.MarkerDefine(stc.STC_MARKNUM_FOLDEREND, stc.STC_MARK_EMPTY, "white", "black") self.MarkerDefine(stc.STC_MARKNUM_FOLDEROPENMID, stc.STC_MARK_EMPTY, "white", "black") self.MarkerDefine(stc.STC_MARKNUM_FOLDERMIDTAIL, stc.STC_MARK_EMPTY, "white", "black") elif self.fold_symbols == 1: # Plus for contracted folders, minus for expanded self.MarkerDefine(stc.STC_MARKNUM_FOLDEROPEN, stc.STC_MARK_MINUS, "white", "black") self.MarkerDefine(stc.STC_MARKNUM_FOLDER, stc.STC_MARK_PLUS, "white", "black") self.MarkerDefine(stc.STC_MARKNUM_FOLDERSUB, stc.STC_MARK_EMPTY, "white", "black") self.MarkerDefine(stc.STC_MARKNUM_FOLDERTAIL, stc.STC_MARK_EMPTY, "white", "black") self.MarkerDefine(stc.STC_MARKNUM_FOLDEREND, stc.STC_MARK_EMPTY, "white", "black") self.MarkerDefine(stc.STC_MARKNUM_FOLDEROPENMID, stc.STC_MARK_EMPTY, "white", "black") self.MarkerDefine(stc.STC_MARKNUM_FOLDERMIDTAIL, stc.STC_MARK_EMPTY, "white", "black") elif self.fold_symbols == 2: # Like a flattened tree control using circular headers and curved joins self.MarkerDefine(stc.STC_MARKNUM_FOLDEROPEN, stc.STC_MARK_CIRCLEMINUS, "white", "#404040") self.MarkerDefine(stc.STC_MARKNUM_FOLDER, stc.STC_MARK_CIRCLEPLUS, "white", "#404040") self.MarkerDefine(stc.STC_MARKNUM_FOLDERSUB, stc.STC_MARK_VLINE, "white", "#404040") self.MarkerDefine(stc.STC_MARKNUM_FOLDERTAIL, stc.STC_MARK_LCORNERCURVE, "white", "#404040") self.MarkerDefine(stc.STC_MARKNUM_FOLDEREND, stc.STC_MARK_CIRCLEPLUSCONNECTED, "white", "#404040") self.MarkerDefine(stc.STC_MARKNUM_FOLDEROPENMID, stc.STC_MARK_CIRCLEMINUSCONNECTED, "white", "#404040") self.MarkerDefine(stc.STC_MARKNUM_FOLDERMIDTAIL, stc.STC_MARK_TCORNERCURVE, "white", "#404040") elif self.fold_symbols == 3: # Like a flattened tree control using square headers self.MarkerDefine(stc.STC_MARKNUM_FOLDEROPEN, stc.STC_MARK_BOXMINUS, "white", "#808080") self.MarkerDefine(stc.STC_MARKNUM_FOLDER, stc.STC_MARK_BOXPLUS, "white", "#808080") self.MarkerDefine(stc.STC_MARKNUM_FOLDERSUB, stc.STC_MARK_VLINE, "white", "#808080") self.MarkerDefine(stc.STC_MARKNUM_FOLDERTAIL, stc.STC_MARK_LCORNER, "white", "#808080") self.MarkerDefine(stc.STC_MARKNUM_FOLDEREND, stc.STC_MARK_BOXPLUSCONNECTED, "white", "#808080") self.MarkerDefine(stc.STC_MARKNUM_FOLDEROPENMID, stc.STC_MARK_BOXMINUSCONNECTED, "white", "#808080") self.MarkerDefine(stc.STC_MARKNUM_FOLDERMIDTAIL, stc.STC_MARK_TCORNER, "white", "#808080") self.Bind(stc.EVT_STC_UPDATEUI, self.OnUpdateUI) self.Bind(stc.EVT_STC_MARGINCLICK, self.OnMarginClick) self.Bind(wx.EVT_KEY_DOWN, self.OnKeyPressed) # Make some styles, The lexer defines what each style is used for, we # just have to define what each style looks like. This set is adapted from # Scintilla sample property files. # Global default styles for all languages self.StyleSetSpec(stc.STC_STYLE_DEFAULT, "face:%(helv)s,size:%(size)d" % faces) self.StyleClearAll() # Reset all to be like the default # Global default styles for all languages self.StyleSetSpec(stc.STC_STYLE_DEFAULT, "face:%(helv)s,size:%(size)d" % faces) self.StyleSetSpec(stc.STC_STYLE_LINENUMBER, "back:#C0C0C0,face:%(helv)s,size:%(size2)d" % faces) self.StyleSetSpec(stc.STC_STYLE_CONTROLCHAR, "face:%(other)s" % faces) #self.StyleSetSpec(stc.STC_STYLE_BRACELIGHT, "fore:#FFFFFF,back:#0000FF,bold") #self.StyleSetSpec(stc.STC_STYLE_BRACEBAD, "fore:#000000,back:#FF0000,bold") #styleidnames={wx.stc.STC_H_DEFAULT: 'Default', wx.stc.STC_H_TAG: 'Tag', wx.stc.STC_H_TAGUNKNOWN: 'Tag unknown', wx.stc.STC_H_ATTRIBUTE: 'Attribute', wx.stc.STC_H_NUMBER: 'Number', wx.stc.STC_H_DOUBLESTRING: 'Double quoted string', wx.stc.STC_H_SINGLESTRING:'Single quoted string', wx.stc.STC_H_OTHER: 'Other inside tag', wx.stc.STC_H_COMMENT: 'Comment', wx.stc.STC_H_ENTITY: 'Entity', wx.stc.STC_H_TAGEND: 'Tag end', wx.stc.STC_H_XMLSTART: 'XML start', wx.stc.STC_H_XMLEND: 'XML End'} ##TOD:This is the section I have to define the styles for in order to work # styles=['STC_H_ASP', 'STC_H_ASPAT', 'STC_H_ATTRIBUTE', 'STC_H_ATTRIBUTEUNKNOWN', # 'STC_H_CDATA', 'STC_H_COMMENT', 'STC_H_DEFAULT', 'STC_H_DOUBLESTRING', 'STC_H_ENTITY', # 'STC_H_NUMBER', 'STC_H_OTHER', 'STC_H_QUESTION', 'STC_H_SCRIPT', 'STC_H_SGML_1ST_PARAM', # 'STC_H_SGML_1ST_PARAM_COMMENT', 'STC_H_SGML_BLOCK_DEFAULT', 'STC_H_SGML_COMMAND', #'STC_H_SGML_COMMENT', 'STC_H_SGML_DEFAULT', 'STC_H_SGML_DOUBLESTRING', 'STC_H_SGML_ENTITY', #'STC_H_SGML_ERROR', 'STC_H_SGML_SIMPLESTRING', 'STC_H_SGML_SPECIAL', #'STC_H_SINGLESTRING', 'STC_H_TAG', 'STC_H_TAGEND', 'STC_H_TAGUNKNOWN', #'STC_H_VALUE', 'STC_H_XCCOMMENT', 'STC_H_XMLEND', 'STC_H_XMLSTART'] # XML styles, just taken from the above python sample # XML styles Mostly HTML styles # Default self.StyleSetSpec(stc.STC_H_DEFAULT, "fore:#000000,face:%(helv)s,size:%(size)d" % faces) # Comments self.StyleSetSpec(stc.STC_H_XCCOMMENT, "fore:#007F00,face:%(other)s,size:%(size)d" % faces) # Number self.StyleSetSpec(stc.STC_H_NUMBER, "fore:#007F7F,size:%(size)d" % faces) # String self.StyleSetSpec(stc.STC_H_ATTRIBUTE, "fore:#7F007F,face:%(helv)s,size:%(size)d" % faces) # Single quoted string self.StyleSetSpec(stc.STC_H_QUESTION, "fore:#7F007F,face:%(helv)s,size:%(size)d" % faces) # Keyword self.StyleSetSpec(stc.STC_H_ATTRIBUTEUNKNOWN, "fore:#00007F,bold,size:%(size)d" % faces) # Single quotes self.StyleSetSpec(stc.STC_H_SINGLESTRING, "fore:#7F0000,size:%(size)d" % faces) # double quotes self.StyleSetSpec(stc.STC_H_DOUBLESTRING, "fore:#7F0000,size:%(size)d" % faces) # Tag name definition self.StyleSetSpec(stc.STC_H_TAG, "fore:#0000FF,bold,size:%(size)d" % faces) # UnknownTag definition self.StyleSetSpec(stc.STC_H_TAGUNKNOWN, "fore:#007F7F,bold,size:%(size)d" % faces) # Operators self.StyleSetSpec(stc.STC_H_XMLSTART, "bold,size:%(size)d" % faces) # Identifiers self.StyleSetSpec(stc.STC_H_CDATA, "fore:#000000,face:%(helv)s,size:%(size)d" % faces) # Comment-blocks self.StyleSetSpec(stc.STC_H_COMMENT, "fore:#7F007F,underline,size:%(size)d" % faces) # End of line where string is not closed #self.StyleSetSpec(stc.STC_H_XMLEND, "fore:#000000,face:%(mono)s,size:%(size)d" % faces) self.SetCaretForeground("BLUE") self.SetCaretForeground("BLUE") # register some images for use in the AutoComplete box. self.RegisterImage(1, wx.ArtProvider.GetBitmap(wx.ART_NEW, size=(16,16))) self.RegisterImage(2, wx.ArtProvider.GetBitmap(wx.ART_NEW, size=(16,16))) self.RegisterImage(3, wx.ArtProvider.GetBitmap(wx.ART_COPY, size=(16,16))) def OnKeyPressed(self, event): if self.CallTipActive(): self.CallTipCancel() key = event.GetKeyCode() if key == 32 and event.ControlDown(): pos = self.GetCurrentPos() # Tips if event.ShiftDown(): self.CallTipSetBackground("yellow") self.CallTipShow(pos, 'lots of of text: blah, blah, blah\n\n' 'show some suff, maybe parameters..\n\n' 'fubar(param1, param2)') # Code completion else: #lst = [] #for x in range(50000): # lst.append('%05d' % x) #st = " ".join(lst) #print len(st) #self.AutoCompShow(0, st) kw = keyword.kwlist[:] kw.append("zzzzzz?2") kw.append("aaaaa?2") kw.append("__init__?3") kw.append("zzaaaaa?2") kw.append("zzbaaaa?2") kw.append("this_is_a_longer_value") #kw.append("this_is_a_much_much_much_much_much_much_much_longer_value") kw.sort() # Python sorts are case sensitive self.AutoCompSetIgnoreCase(False) # so this needs to match # Images are specified with a appended "?type" for i in range(len(kw)): if kw[i] in keyword.kwlist: kw[i] = kw[i] + "?1" self.AutoCompShow(0, " ".join(kw)) else: event.Skip() def OnUpdateUI(self, evt): # check for matching braces braceAtCaret = -1 braceOpposite = -1 charBefore = None caretPos = self.GetCurrentPos() if caretPos > 0: charBefore = self.GetCharAt(caretPos - 1) styleBefore = self.GetStyleAt(caretPos - 1) # check before if charBefore and chr(charBefore) in "[]{}()<>" and styleBefore == stc.STC_H_XMLSTART: braceAtCaret = caretPos - 1 # check after if braceAtCaret < 0: charAfter = self.GetCharAt(caretPos) styleAfter = self.GetStyleAt(caretPos) if charAfter and chr(charAfter) in "[]{}()<>" and styleAfter == stc.STC_H_XMLEND: braceAtCaret = caretPos if braceAtCaret >= 0: braceOpposite = self.BraceMatch(braceAtCaret) if braceAtCaret != -1 and braceOpposite == -1: self.BraceBadLight(braceAtCaret) else: self.BraceHighlight(braceAtCaret, braceOpposite) #pt = self.PointFromPosition(braceOpposite) #self.Refresh(True, wxRect(pt.x, pt.y, 5,5)) #print pt #self.Refresh(False) def OnMarginClick(self, evt): # fold and unfold as needed if evt.GetMargin() == 2: if evt.GetShift() and evt.GetControl(): self.FoldAll() else: lineClicked = self.LineFromPosition(evt.GetPosition()) if self.GetFoldLevel(lineClicked) & stc.STC_FOLDLEVELHEADERFLAG: if evt.GetShift(): self.SetFoldExpanded(lineClicked, True) self.Expand(lineClicked, True, True, 1) elif evt.GetControl(): if self.GetFoldExpanded(lineClicked): self.SetFoldExpanded(lineClicked, False) self.Expand(lineClicked, False, True, 0) else: self.SetFoldExpanded(lineClicked, True) self.Expand(lineClicked, True, True, 100) else: self.ToggleFold(lineClicked) def FoldAll(self): lineCount = self.GetLineCount() expanding = True # find out if we are folding or unfolding for lineNum in range(lineCount): if self.GetFoldLevel(lineNum) & stc.STC_FOLDLEVELHEADERFLAG: expanding = not self.GetFoldExpanded(lineNum) break lineNum = 0 while lineNum < lineCount: level = self.GetFoldLevel(lineNum) if level & stc.STC_FOLDLEVELHEADERFLAG and \ (level & stc.STC_FOLDLEVELNUMBERMASK) == stc.STC_FOLDLEVELBASE: if expanding: self.SetFoldExpanded(lineNum, True) lineNum = self.Expand(lineNum, True) lineNum = lineNum - 1 else: lastChild = self.GetLastChild(lineNum, -1) self.SetFoldExpanded(lineNum, False) if lastChild > lineNum: self.HideLines(lineNum+1, lastChild) lineNum = lineNum + 1 def Expand(self, line, doExpand, force=False, visLevels=0, level=-1): lastChild = self.GetLastChild(line, level) line = line + 1 while line <= lastChild: if force: if visLevels > 0: self.ShowLines(line, line) else: self.HideLines(line, line) else: if doExpand: self.ShowLines(line, line) if level == -1: level = self.GetFoldLevel(line) if level & stc.STC_FOLDLEVELHEADERFLAG: if force: if visLevels > 1: self.SetFoldExpanded(line, True) else: self.SetFoldExpanded(line, False) line = self.Expand(line, doExpand, force, visLevels-1) else: if doExpand and self.GetFoldExpanded(line): line = self.Expand(line, True, force, visLevels-1) else: line = self.Expand(line, False, force, visLevels-1) else: line = line + 1 return line #---------------------------------------------------------------------- #---------------------------------------------------------------------- #---------------------------------------------------------------------- class StyledTextCtrlPanel(wx.Panel): _custom_classes = {'wx.stc.StyledTextCtrl': ['PythonSTC','XMLSTC']} def _init_coll_boxSizer1_Items(self, parent): # generated method, don't edit parent.Add(self.styledTextCtrl1, 1, border=2, flag=wx.EXPAND) def _init_sizers(self): # generated method, don't edit self.boxSizer1 = wx.BoxSizer(orient=wx.VERTICAL) self._init_coll_boxSizer1_Items(self.boxSizer1) self.SetSizer(self.boxSizer1) def _init_ctrls(self, prnt): # generated method, don't edit wx.Panel.__init__(self, id=wxID_STYLEDTEXTCTRLPANEL, name='StyledTextCtrlPanel', parent=prnt, pos=wx.Point(519, 269), size=wx.Size(589, 342), style=wx.TAB_TRAVERSAL) self.SetClientSize(wx.Size(573, 304)) self.styledTextCtrl1 = XMLSTC(id=wxID_STYLEDTEXTCTRLPANELSTYLEDTEXTCTRL1, name='styledTextCtrl1', parent=self, pos=wx.Point(0, 0), size=wx.Size(573, 304), style=0) self._init_sizers() def __init__(self, parent, id, pos, size, style, name): self._init_ctrls(parent) def test_StyledTextCtrlPanel(): app = wx.PySimpleApp() frame = wx.Frame(None,size=wx.Size(900, 800)) panel=StyledTextCtrlPanel(id=1, name='IV Panel', parent=frame, pos=wx.Point(350, 204), size=wx.Size(200, 800), style=wx.TAB_TRAVERSAL) panel.styledTextCtrl1.SetText(demoText ) #+ open('WaferName.xml').read() panel.styledTextCtrl1.EmptyUndoBuffer() panel.styledTextCtrl1.Colourise(0, -1) # line numbers in the margin panel.styledTextCtrl1.SetMarginType(1, stc.STC_MARGIN_NUMBER) panel.styledTextCtrl1.SetMarginWidth(1, 25) sizer=wx.BoxSizer() sizer.Add(panel,1,wx.EXPAND,2) frame.SetSizerAndFit(sizer) frame.SetSize(wx.Size(800, 600)) frame.Show() app.MainLoop() if __name__ == '__main__': test_StyledTextCtrlPanel()
Functions
def runTest(
frame, nb, log)
def runTest(frame, nb, log): if not _USE_PANEL: ed = p = PythonSTC(nb, -1) else: p = wx.Panel(nb, -1, style = wx.NO_FULL_REPAINT_ON_RESIZE) ed = PythonSTC(p, -1) s = wx.BoxSizer(wx.HORIZONTAL) s.Add(ed, 1, wx.EXPAND) p.SetSizer(s) p.SetAutoLayout(True) ed.SetText(demoText + open('Main.py').read()) ed.EmptyUndoBuffer() ed.Colourise(0, -1) # line numbers in the margin ed.SetMarginType(1, stc.STC_MARGIN_NUMBER) ed.SetMarginWidth(1, 25) return p
def test_StyledTextCtrlPanel(
)
def test_StyledTextCtrlPanel(): app = wx.PySimpleApp() frame = wx.Frame(None,size=wx.Size(900, 800)) panel=StyledTextCtrlPanel(id=1, name='IV Panel', parent=frame, pos=wx.Point(350, 204), size=wx.Size(200, 800), style=wx.TAB_TRAVERSAL) panel.styledTextCtrl1.SetText(demoText ) #+ open('WaferName.xml').read() panel.styledTextCtrl1.EmptyUndoBuffer() panel.styledTextCtrl1.Colourise(0, -1) # line numbers in the margin panel.styledTextCtrl1.SetMarginType(1, stc.STC_MARGIN_NUMBER) panel.styledTextCtrl1.SetMarginWidth(1, 25) sizer=wx.BoxSizer() sizer.Add(panel,1,wx.EXPAND,2) frame.SetSizerAndFit(sizer) frame.SetSize(wx.Size(800, 600)) frame.Show() app.MainLoop()
Classes
class PythonSTC
class PythonSTC(stc.StyledTextCtrl): fold_symbols = 2 def __init__(self, parent, id, pos=wx.DefaultPosition, size=wx.DefaultSize, style=0,name=None): stc.StyledTextCtrl.__init__(self, parent, id, pos, size, style,name) self.CmdKeyAssign(ord('B'), stc.STC_SCMOD_CTRL, stc.STC_CMD_ZOOMIN) self.CmdKeyAssign(ord('N'), stc.STC_SCMOD_CTRL, stc.STC_CMD_ZOOMOUT) self.SetLexer(stc.STC_LEX_PYTHON) self.SetKeyWords(0, " ".join(keyword.kwlist)) self.SetProperty("fold", "1") self.SetProperty("tab.timmy.whinge.level", "1") self.SetMargins(0,0) self.SetViewWhiteSpace(False) #self.SetBufferedDraw(False) #self.SetViewEOL(True) #self.SetEOLMode(stc.STC_EOL_CRLF) #self.SetUseAntiAliasing(True) self.SetEdgeMode(stc.STC_EDGE_BACKGROUND) self.SetEdgeColumn(78) # Setup a margin to hold fold markers self.SetFoldFlags(16) ### WHAT IS THIS VALUE? WHAT ARE THE OTHER FLAGS? DOES IT MATTER? self.SetMarginType(2, stc.STC_MARGIN_SYMBOL) self.SetMarginMask(2, stc.STC_MASK_FOLDERS) self.SetMarginSensitive(2, True) self.SetMarginWidth(2, 12) if self.fold_symbols == 0: # Arrow pointing right for contracted folders, arrow pointing down for expanded self.MarkerDefine(stc.STC_MARKNUM_FOLDEROPEN, stc.STC_MARK_ARROWDOWN, "black", "black") self.MarkerDefine(stc.STC_MARKNUM_FOLDER, stc.STC_MARK_ARROW, "black", "black") self.MarkerDefine(stc.STC_MARKNUM_FOLDERSUB, stc.STC_MARK_EMPTY, "black", "black") self.MarkerDefine(stc.STC_MARKNUM_FOLDERTAIL, stc.STC_MARK_EMPTY, "black", "black") self.MarkerDefine(stc.STC_MARKNUM_FOLDEREND, stc.STC_MARK_EMPTY, "white", "black") self.MarkerDefine(stc.STC_MARKNUM_FOLDEROPENMID, stc.STC_MARK_EMPTY, "white", "black") self.MarkerDefine(stc.STC_MARKNUM_FOLDERMIDTAIL, stc.STC_MARK_EMPTY, "white", "black") elif self.fold_symbols == 1: # Plus for contracted folders, minus for expanded self.MarkerDefine(stc.STC_MARKNUM_FOLDEROPEN, stc.STC_MARK_MINUS, "white", "black") self.MarkerDefine(stc.STC_MARKNUM_FOLDER, stc.STC_MARK_PLUS, "white", "black") self.MarkerDefine(stc.STC_MARKNUM_FOLDERSUB, stc.STC_MARK_EMPTY, "white", "black") self.MarkerDefine(stc.STC_MARKNUM_FOLDERTAIL, stc.STC_MARK_EMPTY, "white", "black") self.MarkerDefine(stc.STC_MARKNUM_FOLDEREND, stc.STC_MARK_EMPTY, "white", "black") self.MarkerDefine(stc.STC_MARKNUM_FOLDEROPENMID, stc.STC_MARK_EMPTY, "white", "black") self.MarkerDefine(stc.STC_MARKNUM_FOLDERMIDTAIL, stc.STC_MARK_EMPTY, "white", "black") elif self.fold_symbols == 2: # Like a flattened tree control using circular headers and curved joins self.MarkerDefine(stc.STC_MARKNUM_FOLDEROPEN, stc.STC_MARK_CIRCLEMINUS, "white", "#404040") self.MarkerDefine(stc.STC_MARKNUM_FOLDER, stc.STC_MARK_CIRCLEPLUS, "white", "#404040") self.MarkerDefine(stc.STC_MARKNUM_FOLDERSUB, stc.STC_MARK_VLINE, "white", "#404040") self.MarkerDefine(stc.STC_MARKNUM_FOLDERTAIL, stc.STC_MARK_LCORNERCURVE, "white", "#404040") self.MarkerDefine(stc.STC_MARKNUM_FOLDEREND, stc.STC_MARK_CIRCLEPLUSCONNECTED, "white", "#404040") self.MarkerDefine(stc.STC_MARKNUM_FOLDEROPENMID, stc.STC_MARK_CIRCLEMINUSCONNECTED, "white", "#404040") self.MarkerDefine(stc.STC_MARKNUM_FOLDERMIDTAIL, stc.STC_MARK_TCORNERCURVE, "white", "#404040") elif self.fold_symbols == 3: # Like a flattened tree control using square headers self.MarkerDefine(stc.STC_MARKNUM_FOLDEROPEN, stc.STC_MARK_BOXMINUS, "white", "#808080") self.MarkerDefine(stc.STC_MARKNUM_FOLDER, stc.STC_MARK_BOXPLUS, "white", "#808080") self.MarkerDefine(stc.STC_MARKNUM_FOLDERSUB, stc.STC_MARK_VLINE, "white", "#808080") self.MarkerDefine(stc.STC_MARKNUM_FOLDERTAIL, stc.STC_MARK_LCORNER, "white", "#808080") self.MarkerDefine(stc.STC_MARKNUM_FOLDEREND, stc.STC_MARK_BOXPLUSCONNECTED, "white", "#808080") self.MarkerDefine(stc.STC_MARKNUM_FOLDEROPENMID, stc.STC_MARK_BOXMINUSCONNECTED, "white", "#808080") self.MarkerDefine(stc.STC_MARKNUM_FOLDERMIDTAIL, stc.STC_MARK_TCORNER, "white", "#808080") self.Bind(stc.EVT_STC_UPDATEUI, self.OnUpdateUI) self.Bind(stc.EVT_STC_MARGINCLICK, self.OnMarginClick) self.Bind(wx.EVT_KEY_DOWN, self.OnKeyPressed) # Make some styles, The lexer defines what each style is used for, we # just have to define what each style looks like. This set is adapted from # Scintilla sample property files. # Global default styles for all languages self.StyleSetSpec(stc.STC_STYLE_DEFAULT, "face:%(helv)s,size:%(size)d" % faces) self.StyleClearAll() # Reset all to be like the default # Global default styles for all languages self.StyleSetSpec(stc.STC_STYLE_DEFAULT, "face:%(helv)s,size:%(size)d" % faces) self.StyleSetSpec(stc.STC_STYLE_LINENUMBER, "back:#C0C0C0,face:%(helv)s,size:%(size2)d" % faces) self.StyleSetSpec(stc.STC_STYLE_CONTROLCHAR, "face:%(other)s" % faces) self.StyleSetSpec(stc.STC_STYLE_BRACELIGHT, "fore:#FFFFFF,back:#0000FF,bold") self.StyleSetSpec(stc.STC_STYLE_BRACEBAD, "fore:#000000,back:#FF0000,bold") # Python styles # Default self.StyleSetSpec(stc.STC_P_DEFAULT, "fore:#000000,face:%(helv)s,size:%(size)d" % faces) # Comments self.StyleSetSpec(stc.STC_P_COMMENTLINE, "fore:#007F00,face:%(other)s,size:%(size)d" % faces) # Number self.StyleSetSpec(stc.STC_P_NUMBER, "fore:#007F7F,size:%(size)d" % faces) # String self.StyleSetSpec(stc.STC_P_STRING, "fore:#7F007F,face:%(helv)s,size:%(size)d" % faces) # Single quoted string self.StyleSetSpec(stc.STC_P_CHARACTER, "fore:#7F007F,face:%(helv)s,size:%(size)d" % faces) # Keyword self.StyleSetSpec(stc.STC_P_WORD, "fore:#00007F,bold,size:%(size)d" % faces) # Triple quotes self.StyleSetSpec(stc.STC_P_TRIPLE, "fore:#7F0000,size:%(size)d" % faces) # Triple double quotes self.StyleSetSpec(stc.STC_P_TRIPLEDOUBLE, "fore:#7F0000,size:%(size)d" % faces) # Class name definition self.StyleSetSpec(stc.STC_P_CLASSNAME, "fore:#0000FF,bold,underline,size:%(size)d" % faces) # Function or method name definition self.StyleSetSpec(stc.STC_P_DEFNAME, "fore:#007F7F,bold,size:%(size)d" % faces) # Operators self.StyleSetSpec(stc.STC_P_OPERATOR, "bold,size:%(size)d" % faces) # Identifiers self.StyleSetSpec(stc.STC_P_IDENTIFIER, "fore:#000000,face:%(helv)s,size:%(size)d" % faces) # Comment-blocks self.StyleSetSpec(stc.STC_P_COMMENTBLOCK, "fore:#7F7F7F,size:%(size)d" % faces) # End of line where string is not closed #self.StyleSetSpec(stc.STC_P_STRINGEOL, "fore:#000000,face:%(mono)s,back:#E0C0E0,eol,size:%(size)d" % faces) self.SetCaretForeground("BLUE") # register some images for use in the AutoComplete box. self.RegisterImage(1, wx.ArtProvider.GetBitmap(wx.ART_NEW, size=(16,16))) self.RegisterImage(2, wx.ArtProvider.GetBitmap(wx.ART_NEW, size=(16,16))) self.RegisterImage(3, wx.ArtProvider.GetBitmap(wx.ART_COPY, size=(16,16))) def OnKeyPressed(self, event): if self.CallTipActive(): self.CallTipCancel() key = event.GetKeyCode() if key == 32 and event.ControlDown(): pos = self.GetCurrentPos() # Tips if event.ShiftDown(): self.CallTipSetBackground("yellow") self.CallTipShow(pos, 'lots of of text: blah, blah, blah\n\n' 'show some suff, maybe parameters..\n\n' 'fubar(param1, param2)') # Code completion else: #lst = [] #for x in range(50000): # lst.append('%05d' % x) #st = " ".join(lst) #print len(st) #self.AutoCompShow(0, st) kw = keyword.kwlist[:] kw.append("zzzzzz?2") kw.append("aaaaa?2") kw.append("__init__?3") kw.append("zzaaaaa?2") kw.append("zzbaaaa?2") kw.append("this_is_a_longer_value") #kw.append("this_is_a_much_much_much_much_much_much_much_longer_value") kw.sort() # Python sorts are case sensitive self.AutoCompSetIgnoreCase(False) # so this needs to match # Images are specified with a appended "?type" for i in range(len(kw)): if kw[i] in keyword.kwlist: kw[i] = kw[i] + "?1" self.AutoCompShow(0, " ".join(kw)) else: event.Skip() def OnUpdateUI(self, evt): # check for matching braces braceAtCaret = -1 braceOpposite = -1 charBefore = None caretPos = self.GetCurrentPos() if caretPos > 0: charBefore = self.GetCharAt(caretPos - 1) styleBefore = self.GetStyleAt(caretPos - 1) # check before if charBefore and chr(charBefore) in "[]{}()" and styleBefore == stc.STC_P_OPERATOR: braceAtCaret = caretPos - 1 # check after if braceAtCaret < 0: charAfter = self.GetCharAt(caretPos) styleAfter = self.GetStyleAt(caretPos) if charAfter and chr(charAfter) in "[]{}()" and styleAfter == stc.STC_P_OPERATOR: braceAtCaret = caretPos if braceAtCaret >= 0: braceOpposite = self.BraceMatch(braceAtCaret) if braceAtCaret != -1 and braceOpposite == -1: self.BraceBadLight(braceAtCaret) else: self.BraceHighlight(braceAtCaret, braceOpposite) #pt = self.PointFromPosition(braceOpposite) #self.Refresh(True, wxRect(pt.x, pt.y, 5,5)) #print pt #self.Refresh(False) def OnMarginClick(self, evt): # fold and unfold as needed if evt.GetMargin() == 2: if evt.GetShift() and evt.GetControl(): self.FoldAll() else: lineClicked = self.LineFromPosition(evt.GetPosition()) if self.GetFoldLevel(lineClicked) & stc.STC_FOLDLEVELHEADERFLAG: if evt.GetShift(): self.SetFoldExpanded(lineClicked, True) self.Expand(lineClicked, True, True, 1) elif evt.GetControl(): if self.GetFoldExpanded(lineClicked): self.SetFoldExpanded(lineClicked, False) self.Expand(lineClicked, False, True, 0) else: self.SetFoldExpanded(lineClicked, True) self.Expand(lineClicked, True, True, 100) else: self.ToggleFold(lineClicked) def FoldAll(self): lineCount = self.GetLineCount() expanding = True # find out if we are folding or unfolding for lineNum in range(lineCount): if self.GetFoldLevel(lineNum) & stc.STC_FOLDLEVELHEADERFLAG: expanding = not self.GetFoldExpanded(lineNum) break lineNum = 0 while lineNum < lineCount: level = self.GetFoldLevel(lineNum) if level & stc.STC_FOLDLEVELHEADERFLAG and \ (level & stc.STC_FOLDLEVELNUMBERMASK) == stc.STC_FOLDLEVELBASE: if expanding: self.SetFoldExpanded(lineNum, True) lineNum = self.Expand(lineNum, True) lineNum = lineNum - 1 else: lastChild = self.GetLastChild(lineNum, -1) self.SetFoldExpanded(lineNum, False) if lastChild > lineNum: self.HideLines(lineNum+1, lastChild) lineNum = lineNum + 1 def Expand(self, line, doExpand, force=False, visLevels=0, level=-1): lastChild = self.GetLastChild(line, level) line = line + 1 while line <= lastChild: if force: if visLevels > 0: self.ShowLines(line, line) else: self.HideLines(line, line) else: if doExpand: self.ShowLines(line, line) if level == -1: level = self.GetFoldLevel(line) if level & stc.STC_FOLDLEVELHEADERFLAG: if force: if visLevels > 1: self.SetFoldExpanded(line, True) else: self.SetFoldExpanded(line, False) line = self.Expand(line, doExpand, force, visLevels-1) else: if doExpand and self.GetFoldExpanded(line): line = self.Expand(line, True, force, visLevels-1) else: line = self.Expand(line, False, force, visLevels-1) else: line = line + 1 return line
Ancestors (in MRO)
- PythonSTC
- wx.stc.StyledTextCtrl
- wx._core.Control
- wx._core.Window
- wx._core.EvtHandler
- wx._core.Object
- wx._core.TextCtrlIface
- wx._core.TextAreaBase
- wx._core.TextEntryBase
- __builtin__.object
Class variables
var fold_symbols
Static methods
def Ellipsize(
*args, **kwargs)
Ellipsize(String label, DC dc, int mode, int maxWidth, int flags=ELLIPSIZE_FLAGS_DEFAULT) -> String
def Ellipsize(*args, **kwargs): """Ellipsize(String label, DC dc, int mode, int maxWidth, int flags=ELLIPSIZE_FLAGS_DEFAULT) -> String""" return _core_.Control_Ellipsize(*args, **kwargs)
def EscapeMnemonics(
*args, **kwargs)
EscapeMnemonics(String str) -> String
escapes (by doubling them) the mnemonics
def EscapeMnemonics(*args, **kwargs): """ EscapeMnemonics(String str) -> String escapes (by doubling them) the mnemonics """ return _core_.Control_EscapeMnemonics(*args, **kwargs)
def FindAccelIndex(
*args, **kwargs)
FindAccelIndex(String label) -> int
Return the accel index in the string or -1 if none.
def FindAccelIndex(*args, **kwargs): """ FindAccelIndex(String label) -> int Return the accel index in the string or -1 if none. """ return _core_.Control_FindAccelIndex(*args, **kwargs)
def FindFocus(
*args, **kwargs)
FindFocus() -> Window
Returns the window or control that currently has the keyboard focus, or None.
def FindFocus(*args, **kwargs): """ FindFocus() -> Window Returns the window or control that currently has the keyboard focus, or None. """ return _core_.Window_FindFocus(*args, **kwargs)
def GetCapture(
*args, **kwargs)
GetCapture() -> Window
Returns the window which currently captures the mouse or None
def GetCapture(*args, **kwargs): """ GetCapture() -> Window Returns the window which currently captures the mouse or None """ return _core_.Window_GetCapture(*args, **kwargs)
def GetClassDefaultAttributes(
*args, **kwargs)
GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
Get the default attributes for this class. This is useful if you want to use the same font or colour in your own control as in a standard control -- which is a much better idea than hard coding specific colours or fonts which might look completely out of place on the user's system, especially if it uses themes.
The variant parameter is only relevant under Mac currently and is
ignore under other platforms. Under Mac, it will change the size of
the returned font. See wx.Window.SetWindowVariant for more about
this.
def GetClassDefaultAttributes(*args, **kwargs): """ GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes Get the default attributes for this class. This is useful if you want to use the same font or colour in your own control as in a standard control -- which is a much better idea than hard coding specific colours or fonts which might look completely out of place on the user's system, especially if it uses themes. The variant parameter is only relevant under Mac currently and is ignore under other platforms. Under Mac, it will change the size of the returned font. See `wx.Window.SetWindowVariant` for more about this. """ return _core_.Control_GetClassDefaultAttributes(*args, **kwargs)
def GetCompositeControlsDefaultAttributes(
*args, **kwargs)
GetCompositeControlsDefaultAttributes(int variant) -> VisualAttributes
def GetCompositeControlsDefaultAttributes(*args, **kwargs): """GetCompositeControlsDefaultAttributes(int variant) -> VisualAttributes""" return _core_.Control_GetCompositeControlsDefaultAttributes(*args, **kwargs)
def GetLibraryVersionInfo(
*args, **kwargs)
GetLibraryVersionInfo() -> VersionInfo
def GetLibraryVersionInfo(*args, **kwargs): """GetLibraryVersionInfo() -> VersionInfo""" return _stc.StyledTextCtrl_GetLibraryVersionInfo(*args, **kwargs)
def NewControlId(
*args, **kwargs)
NewControlId(int count=1) -> int
Generate a unique id (or count of them consecutively), returns a valid id in the auto-id range or wxID_NONE if failed. If using autoid management, it will mark the id as reserved until it is used (by assigning it to a wxWindowIDRef) or unreserved.
def NewControlId(*args, **kwargs): """ NewControlId(int count=1) -> int Generate a unique id (or count of them consecutively), returns a valid id in the auto-id range or wxID_NONE if failed. If using autoid management, it will mark the id as reserved until it is used (by assigning it to a wxWindowIDRef) or unreserved. """ return _core_.Window_NewControlId(*args, **kwargs)
def ReleaseControlId(
id)
def ReleaseControlId(id): UnreserveControlId(id)
def RemoveMnemonics(
*args, **kwargs)
RemoveMnemonics(String str) -> String
removes the mnemonics characters
def RemoveMnemonics(*args, **kwargs): """ RemoveMnemonics(String str) -> String removes the mnemonics characters """ return _core_.Control_RemoveMnemonics(*args, **kwargs)
def UnreserveControlId(
*args, **kwargs)
UnreserveControlId(int id, int count=1)
If an ID generated from NewControlId is not assigned to a wxWindowIDRef, it must be unreserved.
def UnreserveControlId(*args, **kwargs): """ UnreserveControlId(int id, int count=1) If an ID generated from NewControlId is not assigned to a wxWindowIDRef, it must be unreserved. """ return _core_.Window_UnreserveControlId(*args, **kwargs)
Instance variables
var AcceleratorTable
See GetAcceleratorTable and SetAcceleratorTable
var Alignment
See GetAlignment
var Anchor
GetAnchor(self) -> int
Returns the position of the opposite end of the selection to the caret.
var AutoLayout
See GetAutoLayout and SetAutoLayout
var BackSpaceUnIndents
GetBackSpaceUnIndents(self) -> bool
Does a backspace pressed when caret is within indentation unindent?
var BackgroundColour
See GetBackgroundColour and SetBackgroundColour
var BackgroundStyle
See GetBackgroundStyle and SetBackgroundStyle
var BestSize
See GetBestSize
var BestVirtualSize
See GetBestVirtualSize
var Border
See GetBorder
var BufferedDraw
GetBufferedDraw(self) -> bool
Is drawing done first into a buffer or direct to the screen?
var Caret
See GetCaret and SetCaret
var CaretForeground
GetCaretForeground(self) -> Colour
Get the foreground colour of the caret.
var CaretLineBack
GetCaretLineBackground(self) -> Colour
Get the colour of the background of the line containing the caret.
var CaretLineBackAlpha
GetCaretLineBackAlpha(self) -> int
Get the background alpha of the caret line.
var CaretLineBackground
GetCaretLineBackground(self) -> Colour
Get the colour of the background of the line containing the caret.
var CaretLineVisible
GetCaretLineVisible(self) -> bool
Is the background of the line containing the caret in a different colour?
var CaretPeriod
GetCaretPeriod(self) -> int
Get the time in milliseconds that the caret is on and off.
var CaretSticky
GetCaretSticky(self) -> int
Can the caret preferred x position only be changed by explicit movement commands?
var CaretStyle
GetCaretStyle(self) -> int
Returns the current style of the caret.
var CaretWidth
GetCaretWidth(self) -> int
Returns the width of the insert mode caret.
var CharHeight
See GetCharHeight
var CharWidth
See GetCharWidth
var Children
See GetChildren
var ClassName
See GetClassName
var ClientAreaOrigin
See GetClientAreaOrigin
var ClientRect
See GetClientRect and SetClientRect
var ClientSize
See GetClientSize and SetClientSize
var CodePage
GetCodePage(self) -> int
Get the code page used to interpret the bytes of the document as characters.
var Constraints
See GetConstraints and SetConstraints
var ContainingSizer
See GetContainingSizer and SetContainingSizer
var ControlCharSymbol
GetControlCharSymbol(self) -> int
Get the way control characters are displayed.
var CurLine
GetCurLine(self) -> (text, pos)
Retrieve the text of the line containing the caret, and also theindex of the caret on the line.
var CurLineRaw
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.
var CurLineUTF8
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.
var CurrentLine
GetCurrentLine(self) -> int
Returns the line number of the line with the caret.
var CurrentPos
GetCurrentPos(self) -> int
Returns the position of the caret.
var Cursor
See GetCursor and SetCursor
var DefaultAttributes
See GetDefaultAttributes
var DefaultStyle
GetDefaultStyle(self) -> wxTextAttr
var DocPointer
GetDocPointer(self) -> void
Retrieve a pointer to the document object.
var DropTarget
See GetDropTarget and SetDropTarget
var EOLMode
GetEOLMode(self) -> int
Retrieve the current end of line mode - one of CRLF, CR, or LF.
var EdgeColour
GetEdgeColour(self) -> Colour
Retrieve the colour used in edge indication.
var EdgeColumn
GetEdgeColumn(self) -> int
Retrieve the column number which text should be kept within.
var EdgeMode
GetEdgeMode(self) -> int
Retrieve the edge highlight mode.
var EffectiveMinSize
See GetEffectiveMinSize
var Enabled
See IsEnabled and Enable
var EndAtLastLine
GetEndAtLastLine(self) -> bool
Retrieve whether the maximum scroll position has the last line at the bottom of the view.
var EndStyled
GetEndStyled(self) -> int
Retrieve the position of the last correctly styled character.
var EventHandler
See GetEventHandler and SetEventHandler
var EvtHandlerEnabled
See GetEvtHandlerEnabled and SetEvtHandlerEnabled
var ExtraStyle
See GetExtraStyle and SetExtraStyle
var FirstVisibleLine
GetFirstVisibleLine(self) -> int
Retrieve the display line at the top of the display.
var Font
See GetFont and SetFont
var ForegroundColour
See GetForegroundColour and SetForegroundColour
var GrandParent
See GetGrandParent
var GtkWidget
GetGtkWidget(self) -> long
On wxGTK returns a pointer to the GtkWidget for this window as a long integer. On the other platforms this method returns zero.
var Handle
See GetHandle
var HelpText
See GetHelpText and SetHelpText
var HighlightGuide
GetHighlightGuide(self) -> int
Get the highlighted indentation guide column.
var HotspotActiveBackground
GetHotspotActiveBackground(self) -> Colour
Get the back colour for active hotspots.
var HotspotActiveForeground
GetHotspotActiveForeground(self) -> Colour
Get the fore colour for active hotspots.
var HotspotActiveUnderline
GetHotspotActiveUnderline(self) -> bool
Get whether underlining for active hotspots.
var HotspotSingleLine
GetHotspotSingleLine(self) -> bool
Get the HotspotSingleLine property
var Id
See GetId and SetId
var Indent
GetIndent(self) -> int
Retrieve indentation size.
var IndentationGuides
GetIndentationGuides(self) -> int
Are the indentation guides visible?
var IndicatorCurrent
GetIndicatorCurrent(self) -> int
Get the current indicator
var IndicatorValue
GetIndicatorValue(self) -> int
Get the current indicator vaue
var InsertionPoint
GetInsertionPoint(self) -> long
Returns the insertion point for the combobox's text field.
var Label
See GetLabel and SetLabel
var LabelText
See GetLabelText
var LastKeydownProcessed
GetLastKeydownProcessed(self) -> bool
var LastPosition
GetLastPosition(self) -> long
Returns the last position in the combobox text field.
var LayoutCache
GetLayoutCache(self) -> int
Retrieve the degree of caching of layout information.
var LayoutDirection
See GetLayoutDirection and SetLayoutDirection
var Length
GetLength(self) -> int
Returns the number of bytes in the document.
var Lexer
GetLexer(self) -> int
Retrieve the lexing language of the document.
var LineCount
GetLineCount(self) -> int
Returns the number of lines in the document. There is always at least one.
var MarginLeft
GetMarginLeft(self) -> int
Returns the size in pixels of the left margin.
var MarginRight
GetMarginRight(self) -> int
Returns the size in pixels of the right margin.
var MaxClientSize
GetMaxClientSize(self) -> Size
var MaxHeight
See GetMaxHeight
var MaxLineState
GetMaxLineState(self) -> int
Retrieve the last line number that has line state.
var MaxSize
See GetMaxSize and SetMaxSize
var MaxWidth
See GetMaxWidth
var MinClientSize
GetMinClientSize(self) -> Size
var MinHeight
See GetMinHeight
var MinSize
See GetMinSize and SetMinSize
var MinWidth
See GetMinWidth
var ModEventMask
GetModEventMask(self) -> int
Get which document modification events are sent to the container.
var Modify
GetModify(self) -> bool
Is the document different from when it was last saved?
var MouseDownCaptures
GetMouseDownCaptures(self) -> bool
Get whether mouse gets captured.
var MouseDwellTime
GetMouseDwellTime(self) -> int
Retrieve the time the mouse must sit still to generate a mouse dwell event.
var Name
See GetName and SetName
var NextHandler
See GetNextHandler and SetNextHandler
var NumberOfLines
GetNumberOfLines(self) -> int
var Overtype
GetOvertype(self) -> bool
Returns true if overtype mode is active otherwise false is returned.
var Parent
See GetParent
var PasteConvertEndings
GetPasteConvertEndings(self) -> bool
Get convert-on-paste setting
var Position
See GetPosition and SetPosition
var PositionCacheSize
GetPositionCacheSize(self) -> int
How many entries are allocated to the position cache?
var PreviousHandler
See GetPreviousHandler and SetPreviousHandler
var PrintColourMode
GetPrintColourMode(self) -> int
Returns the print colour mode.
var PrintMagnification
GetPrintMagnification(self) -> int
Returns the print magnification.
var PrintWrapMode
GetPrintWrapMode(self) -> int
Is printing line wrapped?
var ReadOnly
GetReadOnly(self) -> bool
In read-only mode?
var Rect
See GetRect and SetRect
var STCCursor
GetSTCCursor(self) -> int
Get cursor type.
var STCFocus
GetSTCFocus(self) -> bool
Get internal focus flag.
var ScreenPosition
See GetScreenPosition
var ScreenRect
See GetScreenRect
var ScrollWidth
GetScrollWidth(self) -> int
Retrieve the document width assumed for scrolling.
var ScrollWidthTracking
GetScrollWidthTracking(self) -> bool
Retrieve whether the scroll width tracks wide lines.
var SearchFlags
GetSearchFlags(self) -> int
Get the search flags used by SearchInTarget.
var SelAlpha
GetSelAlpha(self) -> int
Get the alpha of the selection.
var SelEOLFilled
GetSelEOLFilled(self) -> bool
Is the selection end of line filled?
var SelectedText
GetSelectedText(self) -> String
Retrieve the selected text.
var SelectedTextRaw
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.
var SelectedTextUTF8
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.
var Selection
GetSelection() -> (from, to)
If the return values from and to are the same, there is no selection.
var SelectionEnd
GetSelectionEnd(self) -> int
Returns the position at the end of the selection.
var SelectionMode
GetSelectionMode(self) -> int
Get the mode of the current selection.
var SelectionStart
GetSelectionStart(self) -> int
Returns the position at the start of the selection.
var Shown
See IsShown and Show
var Size
See GetSize and SetSize
var Sizer
See GetSizer and SetSizer
var Status
GetStatus(self) -> int
Get error status.
var StyleBits
GetStyleBits(self) -> int
Retrieve number of bits in style bytes used to hold the lexical state.
var StyleBitsNeeded
GetStyleBitsNeeded(self) -> int
Retrieve the number of bits the current lexer needs for styling.
var TabIndents
GetTabIndents(self) -> bool
Does a tab pressed when caret is within indentation indent?
var TabWidth
GetTabWidth(self) -> int
Retrieve the visible size of a tab.
var TargetEnd
GetTargetEnd(self) -> int
Get the position that ends the target.
var TargetStart
GetTargetStart(self) -> int
Get the position that starts the target.
var Text
GetText(self) -> String
Retrieve all the text in the document.
var TextLength
GetTextLength(self) -> int
Retrieve the number of characters in the document.
var TextRaw
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.
var TextUTF8
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.
var ThemeEnabled
See GetThemeEnabled and SetThemeEnabled
var ToolTip
See GetToolTip and SetToolTip
var ToolTipString
var TopLevel
See IsTopLevel
var TopLevelParent
See GetTopLevelParent
var TwoPhaseDraw
GetTwoPhaseDraw(self) -> bool
Is drawing done in two phases with backgrounds drawn before foregrounds?
var UndoCollection
GetUndoCollection(self) -> bool
Is undo history being collected?
var UpdateClientRect
See GetUpdateClientRect
var UpdateRegion
See GetUpdateRegion
var UseAntiAliasing
GetUseAntiAliasing(self) -> bool
Returns the current UseAntiAliasing setting.
var UseHorizontalScrollBar
GetUseHorizontalScrollBar(self) -> bool
Is the horizontal scroll bar visible?
var UseTabs
GetUseTabs(self) -> bool
Retrieve whether tabs will be used in indentation.
var UseVerticalScrollBar
GetUseVerticalScrollBar(self) -> bool
Is the vertical scroll bar visible?
var Validator
See GetValidator and SetValidator
var Value
GetValue(self) -> String
Returns the current value in the text field.
var ViewEOL
GetViewEOL(self) -> bool
Are the end of line characters visible?
var ViewWhiteSpace
GetViewWhiteSpace(self) -> int
Are white space characters currently visible? Returns one of SCWS_* constants.
var VirtualSize
See GetVirtualSize and SetVirtualSize
var WindowStyle
See GetWindowStyle and SetWindowStyle
var WindowStyleFlag
See GetWindowStyleFlag and SetWindowStyleFlag
var WindowVariant
See GetWindowVariant and SetWindowVariant
var WrapMode
GetWrapMode(self) -> int
Retrieve whether text is word wrapped.
var WrapStartIndent
GetWrapStartIndent(self) -> int
Retrive the start indent for wrapped lines.
var WrapVisualFlags
GetWrapVisualFlags(self) -> int
Retrive the display mode of visual flags for wrapped lines.
var WrapVisualFlagsLocation
GetWrapVisualFlagsLocation(self) -> int
Retrive the location of visual flags for wrapped lines.
var XOffset
GetXOffset(self) -> int
var Zoom
GetZoom(self) -> int
Retrieve the zoom level.
var thisown
The membership flag
Methods
def __init__(
self, parent, id, pos=wx.Point(-1, -1), size=wx.Size(-1, -1), style=0, name=None)
def __init__(self, parent, id, pos=wx.DefaultPosition, size=wx.DefaultSize, style=0,name=None): stc.StyledTextCtrl.__init__(self, parent, id, pos, size, style,name) self.CmdKeyAssign(ord('B'), stc.STC_SCMOD_CTRL, stc.STC_CMD_ZOOMIN) self.CmdKeyAssign(ord('N'), stc.STC_SCMOD_CTRL, stc.STC_CMD_ZOOMOUT) self.SetLexer(stc.STC_LEX_PYTHON) self.SetKeyWords(0, " ".join(keyword.kwlist)) self.SetProperty("fold", "1") self.SetProperty("tab.timmy.whinge.level", "1") self.SetMargins(0,0) self.SetViewWhiteSpace(False) #self.SetBufferedDraw(False) #self.SetViewEOL(True) #self.SetEOLMode(stc.STC_EOL_CRLF) #self.SetUseAntiAliasing(True) self.SetEdgeMode(stc.STC_EDGE_BACKGROUND) self.SetEdgeColumn(78) # Setup a margin to hold fold markers self.SetFoldFlags(16) ### WHAT IS THIS VALUE? WHAT ARE THE OTHER FLAGS? DOES IT MATTER? self.SetMarginType(2, stc.STC_MARGIN_SYMBOL) self.SetMarginMask(2, stc.STC_MASK_FOLDERS) self.SetMarginSensitive(2, True) self.SetMarginWidth(2, 12) if self.fold_symbols == 0: # Arrow pointing right for contracted folders, arrow pointing down for expanded self.MarkerDefine(stc.STC_MARKNUM_FOLDEROPEN, stc.STC_MARK_ARROWDOWN, "black", "black") self.MarkerDefine(stc.STC_MARKNUM_FOLDER, stc.STC_MARK_ARROW, "black", "black") self.MarkerDefine(stc.STC_MARKNUM_FOLDERSUB, stc.STC_MARK_EMPTY, "black", "black") self.MarkerDefine(stc.STC_MARKNUM_FOLDERTAIL, stc.STC_MARK_EMPTY, "black", "black") self.MarkerDefine(stc.STC_MARKNUM_FOLDEREND, stc.STC_MARK_EMPTY, "white", "black") self.MarkerDefine(stc.STC_MARKNUM_FOLDEROPENMID, stc.STC_MARK_EMPTY, "white", "black") self.MarkerDefine(stc.STC_MARKNUM_FOLDERMIDTAIL, stc.STC_MARK_EMPTY, "white", "black") elif self.fold_symbols == 1: # Plus for contracted folders, minus for expanded self.MarkerDefine(stc.STC_MARKNUM_FOLDEROPEN, stc.STC_MARK_MINUS, "white", "black") self.MarkerDefine(stc.STC_MARKNUM_FOLDER, stc.STC_MARK_PLUS, "white", "black") self.MarkerDefine(stc.STC_MARKNUM_FOLDERSUB, stc.STC_MARK_EMPTY, "white", "black") self.MarkerDefine(stc.STC_MARKNUM_FOLDERTAIL, stc.STC_MARK_EMPTY, "white", "black") self.MarkerDefine(stc.STC_MARKNUM_FOLDEREND, stc.STC_MARK_EMPTY, "white", "black") self.MarkerDefine(stc.STC_MARKNUM_FOLDEROPENMID, stc.STC_MARK_EMPTY, "white", "black") self.MarkerDefine(stc.STC_MARKNUM_FOLDERMIDTAIL, stc.STC_MARK_EMPTY, "white", "black") elif self.fold_symbols == 2: # Like a flattened tree control using circular headers and curved joins self.MarkerDefine(stc.STC_MARKNUM_FOLDEROPEN, stc.STC_MARK_CIRCLEMINUS, "white", "#404040") self.MarkerDefine(stc.STC_MARKNUM_FOLDER, stc.STC_MARK_CIRCLEPLUS, "white", "#404040") self.MarkerDefine(stc.STC_MARKNUM_FOLDERSUB, stc.STC_MARK_VLINE, "white", "#404040") self.MarkerDefine(stc.STC_MARKNUM_FOLDERTAIL, stc.STC_MARK_LCORNERCURVE, "white", "#404040") self.MarkerDefine(stc.STC_MARKNUM_FOLDEREND, stc.STC_MARK_CIRCLEPLUSCONNECTED, "white", "#404040") self.MarkerDefine(stc.STC_MARKNUM_FOLDEROPENMID, stc.STC_MARK_CIRCLEMINUSCONNECTED, "white", "#404040") self.MarkerDefine(stc.STC_MARKNUM_FOLDERMIDTAIL, stc.STC_MARK_TCORNERCURVE, "white", "#404040") elif self.fold_symbols == 3: # Like a flattened tree control using square headers self.MarkerDefine(stc.STC_MARKNUM_FOLDEROPEN, stc.STC_MARK_BOXMINUS, "white", "#808080") self.MarkerDefine(stc.STC_MARKNUM_FOLDER, stc.STC_MARK_BOXPLUS, "white", "#808080") self.MarkerDefine(stc.STC_MARKNUM_FOLDERSUB, stc.STC_MARK_VLINE, "white", "#808080") self.MarkerDefine(stc.STC_MARKNUM_FOLDERTAIL, stc.STC_MARK_LCORNER, "white", "#808080") self.MarkerDefine(stc.STC_MARKNUM_FOLDEREND, stc.STC_MARK_BOXPLUSCONNECTED, "white", "#808080") self.MarkerDefine(stc.STC_MARKNUM_FOLDEROPENMID, stc.STC_MARK_BOXMINUSCONNECTED, "white", "#808080") self.MarkerDefine(stc.STC_MARKNUM_FOLDERMIDTAIL, stc.STC_MARK_TCORNER, "white", "#808080") self.Bind(stc.EVT_STC_UPDATEUI, self.OnUpdateUI) self.Bind(stc.EVT_STC_MARGINCLICK, self.OnMarginClick) self.Bind(wx.EVT_KEY_DOWN, self.OnKeyPressed) # Make some styles, The lexer defines what each style is used for, we # just have to define what each style looks like. This set is adapted from # Scintilla sample property files. # Global default styles for all languages self.StyleSetSpec(stc.STC_STYLE_DEFAULT, "face:%(helv)s,size:%(size)d" % faces) self.StyleClearAll() # Reset all to be like the default # Global default styles for all languages self.StyleSetSpec(stc.STC_STYLE_DEFAULT, "face:%(helv)s,size:%(size)d" % faces) self.StyleSetSpec(stc.STC_STYLE_LINENUMBER, "back:#C0C0C0,face:%(helv)s,size:%(size2)d" % faces) self.StyleSetSpec(stc.STC_STYLE_CONTROLCHAR, "face:%(other)s" % faces) self.StyleSetSpec(stc.STC_STYLE_BRACELIGHT, "fore:#FFFFFF,back:#0000FF,bold") self.StyleSetSpec(stc.STC_STYLE_BRACEBAD, "fore:#000000,back:#FF0000,bold") # Python styles # Default self.StyleSetSpec(stc.STC_P_DEFAULT, "fore:#000000,face:%(helv)s,size:%(size)d" % faces) # Comments self.StyleSetSpec(stc.STC_P_COMMENTLINE, "fore:#007F00,face:%(other)s,size:%(size)d" % faces) # Number self.StyleSetSpec(stc.STC_P_NUMBER, "fore:#007F7F,size:%(size)d" % faces) # String self.StyleSetSpec(stc.STC_P_STRING, "fore:#7F007F,face:%(helv)s,size:%(size)d" % faces) # Single quoted string self.StyleSetSpec(stc.STC_P_CHARACTER, "fore:#7F007F,face:%(helv)s,size:%(size)d" % faces) # Keyword self.StyleSetSpec(stc.STC_P_WORD, "fore:#00007F,bold,size:%(size)d" % faces) # Triple quotes self.StyleSetSpec(stc.STC_P_TRIPLE, "fore:#7F0000,size:%(size)d" % faces) # Triple double quotes self.StyleSetSpec(stc.STC_P_TRIPLEDOUBLE, "fore:#7F0000,size:%(size)d" % faces) # Class name definition self.StyleSetSpec(stc.STC_P_CLASSNAME, "fore:#0000FF,bold,underline,size:%(size)d" % faces) # Function or method name definition self.StyleSetSpec(stc.STC_P_DEFNAME, "fore:#007F7F,bold,size:%(size)d" % faces) # Operators self.StyleSetSpec(stc.STC_P_OPERATOR, "bold,size:%(size)d" % faces) # Identifiers self.StyleSetSpec(stc.STC_P_IDENTIFIER, "fore:#000000,face:%(helv)s,size:%(size)d" % faces) # Comment-blocks self.StyleSetSpec(stc.STC_P_COMMENTBLOCK, "fore:#7F7F7F,size:%(size)d" % faces) # End of line where string is not closed #self.StyleSetSpec(stc.STC_P_STRINGEOL, "fore:#000000,face:%(mono)s,back:#E0C0E0,eol,size:%(size)d" % faces) self.SetCaretForeground("BLUE") # register some images for use in the AutoComplete box. self.RegisterImage(1, wx.ArtProvider.GetBitmap(wx.ART_NEW, size=(16,16))) self.RegisterImage(2, wx.ArtProvider.GetBitmap(wx.ART_NEW, size=(16,16))) self.RegisterImage(3, wx.ArtProvider.GetBitmap(wx.ART_COPY, size=(16,16)))
def AcceptsFocus(
*args, **kwargs)
AcceptsFocus(self) -> bool
Can this window have focus?
def AcceptsFocus(*args, **kwargs): """ AcceptsFocus(self) -> bool Can this window have focus? """ return _core_.Window_AcceptsFocus(*args, **kwargs)
def AcceptsFocusFromKeyboard(
*args, **kwargs)
AcceptsFocusFromKeyboard(self) -> bool
Can this window be given focus by keyboard navigation? if not, the only way to give it focus (provided it accepts it at all) is to click it.
def AcceptsFocusFromKeyboard(*args, **kwargs): """ AcceptsFocusFromKeyboard(self) -> bool Can this window be given focus by keyboard navigation? if not, the only way to give it focus (provided it accepts it at all) is to click it. """ return _core_.Window_AcceptsFocusFromKeyboard(*args, **kwargs)
def AddChild(
*args, **kwargs)
AddChild(self, Window child)
Adds a child window. This is called automatically by window creation functions so should not be required by the application programmer.
def AddChild(*args, **kwargs): """ AddChild(self, Window child) Adds a child window. This is called automatically by window creation functions so should not be required by the application programmer. """ return _core_.Window_AddChild(*args, **kwargs)
def AddPendingEvent(
*args, **kwargs)
AddPendingEvent(self, Event event)
def AddPendingEvent(*args, **kwargs): """AddPendingEvent(self, Event event)""" return _core_.EvtHandler_AddPendingEvent(*args, **kwargs)
def AddRefDocument(
*args, **kwargs)
AddRefDocument(self, void docPointer)
Extend life of document.
def AddRefDocument(*args, **kwargs): """ AddRefDocument(self, void docPointer) Extend life of document. """ return _stc.StyledTextCtrl_AddRefDocument(*args, **kwargs)
def AddSelection(
*args, **kwargs)
AddSelection(self, int caret, int anchor) -> int
Add a selection
def AddSelection(*args, **kwargs): """ AddSelection(self, int caret, int anchor) -> int Add a selection """ return _stc.StyledTextCtrl_AddSelection(*args, **kwargs)
def AddStyledText(
*args, **kwargs)
AddStyledText(self, wxMemoryBuffer data)
Add array of cells to document.
def AddStyledText(*args, **kwargs): """ AddStyledText(self, wxMemoryBuffer data) Add array of cells to document. """ return _stc.StyledTextCtrl_AddStyledText(*args, **kwargs)
def AddText(
*args, **kwargs)
AddText(self, String text)
Add text to the document at current position.
def AddText(*args, **kwargs): """ AddText(self, String text) Add text to the document at current position. """ return _stc.StyledTextCtrl_AddText(*args, **kwargs)
def AddTextRaw(
*args, **kwargs)
AddTextRaw(self, char text, int length=-1)
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.
def AddTextRaw(*args, **kwargs): """ AddTextRaw(self, char text, int length=-1) 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. """ return _stc.StyledTextCtrl_AddTextRaw(*args, **kwargs)
def AddTextUTF8(
self, text)
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.
def AddTextUTF8(self, text): """ 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. """ if not wx.USE_UNICODE: u = text.decode('utf-8') text = u.encode(wx.GetDefaultPyEncoding()) self.AddTextRaw(text)
def AddUndoAction(
*args, **kwargs)
AddUndoAction(self, int token, int flags)
Add a container action to the undo stack
def AddUndoAction(*args, **kwargs): """ AddUndoAction(self, int token, int flags) Add a container action to the undo stack """ return _stc.StyledTextCtrl_AddUndoAction(*args, **kwargs)
def AdjustForLayoutDirection(
*args, **kwargs)
AdjustForLayoutDirection(self, int x, int width, int widthTotal) -> int
Mirror coordinates for RTL layout if this window uses it and if the mirroring is not done automatically like Win32.
def AdjustForLayoutDirection(*args, **kwargs): """ AdjustForLayoutDirection(self, int x, int width, int widthTotal) -> int Mirror coordinates for RTL layout if this window uses it and if the mirroring is not done automatically like Win32. """ return _core_.Window_AdjustForLayoutDirection(*args, **kwargs)
def Allocate(
*args, **kwargs)
Allocate(self, int bytes)
Enlarge the document to a particular size of text bytes.
def Allocate(*args, **kwargs): """ Allocate(self, int bytes) Enlarge the document to a particular size of text bytes. """ return _stc.StyledTextCtrl_Allocate(*args, **kwargs)
def AlwaysShowScrollbars(
*args, **kwargs)
AlwaysShowScrollbars(self, bool horz=True, bool vert=True)
def AlwaysShowScrollbars(*args, **kwargs): """AlwaysShowScrollbars(self, bool horz=True, bool vert=True)""" return _core_.Window_AlwaysShowScrollbars(*args, **kwargs)
def AnnotationClearAll(
*args, **kwargs)
AnnotationClearAll(self)
Clear the annotations from all lines
def AnnotationClearAll(*args, **kwargs): """ AnnotationClearAll(self) Clear the annotations from all lines """ return _stc.StyledTextCtrl_AnnotationClearAll(*args, **kwargs)
def AnnotationClearLine(
*args, **kwargs)
AnnotationClearLine(self, int line)
def AnnotationClearLine(*args, **kwargs): """AnnotationClearLine(self, int line)""" return _stc.StyledTextCtrl_AnnotationClearLine(*args, **kwargs)
def AnnotationGetLines(
*args, **kwargs)
AnnotationGetLines(self, int line) -> int
Get the number of annotation lines for a line
def AnnotationGetLines(*args, **kwargs): """ AnnotationGetLines(self, int line) -> int Get the number of annotation lines for a line """ return _stc.StyledTextCtrl_AnnotationGetLines(*args, **kwargs)
def AnnotationGetStyle(
*args, **kwargs)
AnnotationGetStyle(self, int line) -> int
Get the style number for the annotations for a line
def AnnotationGetStyle(*args, **kwargs): """ AnnotationGetStyle(self, int line) -> int Get the style number for the annotations for a line """ return _stc.StyledTextCtrl_AnnotationGetStyle(*args, **kwargs)
def AnnotationGetStyleOffset(
*args, **kwargs)
AnnotationGetStyleOffset(self) -> int
Get the start of the range of style numbers used for annotations
def AnnotationGetStyleOffset(*args, **kwargs): """ AnnotationGetStyleOffset(self) -> int Get the start of the range of style numbers used for annotations """ return _stc.StyledTextCtrl_AnnotationGetStyleOffset(*args, **kwargs)
def AnnotationGetStyles(
*args, **kwargs)
AnnotationGetStyles(self, int line) -> String
Get the annotation styles for a line
def AnnotationGetStyles(*args, **kwargs): """ AnnotationGetStyles(self, int line) -> String Get the annotation styles for a line """ return _stc.StyledTextCtrl_AnnotationGetStyles(*args, **kwargs)
def AnnotationGetText(
*args, **kwargs)
AnnotationGetText(self, int line) -> String
Get the annotation text for a line
def AnnotationGetText(*args, **kwargs): """ AnnotationGetText(self, int line) -> String Get the annotation text for a line """ return _stc.StyledTextCtrl_AnnotationGetText(*args, **kwargs)
def AnnotationGetVisible(
*args, **kwargs)
AnnotationGetVisible(self) -> int
Get the visibility for the annotations for a view
def AnnotationGetVisible(*args, **kwargs): """ AnnotationGetVisible(self) -> int Get the visibility for the annotations for a view """ return _stc.StyledTextCtrl_AnnotationGetVisible(*args, **kwargs)
def AnnotationSetStyle(
*args, **kwargs)
AnnotationSetStyle(self, int line, int style)
Set the style number for the annotations for a line
def AnnotationSetStyle(*args, **kwargs): """ AnnotationSetStyle(self, int line, int style) Set the style number for the annotations for a line """ return _stc.StyledTextCtrl_AnnotationSetStyle(*args, **kwargs)
def AnnotationSetStyleOffset(
*args, **kwargs)
AnnotationSetStyleOffset(self, int style)
Get the start of the range of style numbers used for annotations
def AnnotationSetStyleOffset(*args, **kwargs): """ AnnotationSetStyleOffset(self, int style) Get the start of the range of style numbers used for annotations """ return _stc.StyledTextCtrl_AnnotationSetStyleOffset(*args, **kwargs)
def AnnotationSetStyles(
*args, **kwargs)
AnnotationSetStyles(self, int line, String styles)
Set the annotation styles for a line
def AnnotationSetStyles(*args, **kwargs): """ AnnotationSetStyles(self, int line, String styles) Set the annotation styles for a line """ return _stc.StyledTextCtrl_AnnotationSetStyles(*args, **kwargs)
def AnnotationSetText(
*args, **kwargs)
AnnotationSetText(self, int line, String text)
Set the annotation text for a line
def AnnotationSetText(*args, **kwargs): """ AnnotationSetText(self, int line, String text) Set the annotation text for a line """ return _stc.StyledTextCtrl_AnnotationSetText(*args, **kwargs)
def AnnotationSetVisible(
*args, **kwargs)
AnnotationSetVisible(self, int visible)
Set the visibility for the annotations for a view
def AnnotationSetVisible(*args, **kwargs): """ AnnotationSetVisible(self, int visible) Set the visibility for the annotations for a view """ return _stc.StyledTextCtrl_AnnotationSetVisible(*args, **kwargs)
def AppendText(
*args, **kwargs)
AppendText(self, String text)
Add text to the end of the text field, without removing any existing text. Will reset the selection if any.
def AppendText(*args, **kwargs): """ AppendText(self, String text) Add text to the end of the text field, without removing any existing text. Will reset the selection if any. """ return _core_.TextEntryBase_AppendText(*args, **kwargs)
def AppendTextRaw(
*args, **kwargs)
AppendTextRaw(self, char text, int length=-1)
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.
def AppendTextRaw(*args, **kwargs): """ AppendTextRaw(self, char text, int length=-1) 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. """ return _stc.StyledTextCtrl_AppendTextRaw(*args, **kwargs)
def AppendTextUTF8(
self, text)
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.
def AppendTextUTF8(self, text): """ 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. """ if not wx.USE_UNICODE: u = text.decode('utf-8') text = u.encode(wx.GetDefaultPyEncoding()) self.AppendTextRaw(text)
def AssociateHandle(
*args, **kwargs)
AssociateHandle(self, long handle)
Associate the window with a new native handle
def AssociateHandle(*args, **kwargs): """ AssociateHandle(self, long handle) Associate the window with a new native handle """ return _core_.Window_AssociateHandle(*args, **kwargs)
def AutoCompActive(
*args, **kwargs)
AutoCompActive(self) -> bool
Is there an auto-completion list visible?
def AutoCompActive(*args, **kwargs): """ AutoCompActive(self) -> bool Is there an auto-completion list visible? """ return _stc.StyledTextCtrl_AutoCompActive(*args, **kwargs)
def AutoCompCancel(
*args, **kwargs)
AutoCompCancel(self)
Remove the auto-completion list from the screen.
def AutoCompCancel(*args, **kwargs): """ AutoCompCancel(self) Remove the auto-completion list from the screen. """ return _stc.StyledTextCtrl_AutoCompCancel(*args, **kwargs)
def AutoCompComplete(
*args, **kwargs)
AutoCompComplete(self)
User has selected an item so remove the list and insert the selection.
def AutoCompComplete(*args, **kwargs): """ AutoCompComplete(self) User has selected an item so remove the list and insert the selection. """ return _stc.StyledTextCtrl_AutoCompComplete(*args, **kwargs)
def AutoCompGetAutoHide(
*args, **kwargs)
AutoCompGetAutoHide(self) -> bool
Retrieve whether or not autocompletion is hidden automatically when nothing matches.
def AutoCompGetAutoHide(*args, **kwargs): """ AutoCompGetAutoHide(self) -> bool Retrieve whether or not autocompletion is hidden automatically when nothing matches. """ return _stc.StyledTextCtrl_AutoCompGetAutoHide(*args, **kwargs)
def AutoCompGetCancelAtStart(
*args, **kwargs)
AutoCompGetCancelAtStart(self) -> bool
Retrieve whether auto-completion cancelled by backspacing before start.
def AutoCompGetCancelAtStart(*args, **kwargs): """ AutoCompGetCancelAtStart(self) -> bool Retrieve whether auto-completion cancelled by backspacing before start. """ return _stc.StyledTextCtrl_AutoCompGetCancelAtStart(*args, **kwargs)
def AutoCompGetCaseInsensitiveBehaviour(
*args, **kwargs)
AutoCompGetCaseInsensitiveBehaviour(self) -> int
def AutoCompGetCaseInsensitiveBehaviour(*args, **kwargs): """AutoCompGetCaseInsensitiveBehaviour(self) -> int""" return _stc.StyledTextCtrl_AutoCompGetCaseInsensitiveBehaviour(*args, **kwargs)
def AutoCompGetChooseSingle(
*args, **kwargs)
AutoCompGetChooseSingle(self) -> bool
Retrieve whether a single item auto-completion list automatically choose the item.
def AutoCompGetChooseSingle(*args, **kwargs): """ AutoCompGetChooseSingle(self) -> bool Retrieve whether a single item auto-completion list automatically choose the item. """ return _stc.StyledTextCtrl_AutoCompGetChooseSingle(*args, **kwargs)
def AutoCompGetCurrent(
*args, **kwargs)
AutoCompGetCurrent(self) -> int
Get currently selected item position in the auto-completion list
def AutoCompGetCurrent(*args, **kwargs): """ AutoCompGetCurrent(self) -> int Get currently selected item position in the auto-completion list """ return _stc.StyledTextCtrl_AutoCompGetCurrent(*args, **kwargs)
def AutoCompGetDropRestOfWord(
*args, **kwargs)
AutoCompGetDropRestOfWord(self) -> bool
Retrieve whether or not autocompletion deletes any word characters after the inserted text upon completion.
def AutoCompGetDropRestOfWord(*args, **kwargs): """ AutoCompGetDropRestOfWord(self) -> bool Retrieve whether or not autocompletion deletes any word characters after the inserted text upon completion. """ return _stc.StyledTextCtrl_AutoCompGetDropRestOfWord(*args, **kwargs)
def AutoCompGetIgnoreCase(
*args, **kwargs)
AutoCompGetIgnoreCase(self) -> bool
Retrieve state of ignore case flag.
def AutoCompGetIgnoreCase(*args, **kwargs): """ AutoCompGetIgnoreCase(self) -> bool Retrieve state of ignore case flag. """ return _stc.StyledTextCtrl_AutoCompGetIgnoreCase(*args, **kwargs)
def AutoCompGetMaxHeight(
*args, **kwargs)
AutoCompGetMaxHeight(self) -> int
Set the maximum height, in rows, of auto-completion and user lists.
def AutoCompGetMaxHeight(*args, **kwargs): """ AutoCompGetMaxHeight(self) -> int Set the maximum height, in rows, of auto-completion and user lists. """ return _stc.StyledTextCtrl_AutoCompGetMaxHeight(*args, **kwargs)
def AutoCompGetMaxWidth(
*args, **kwargs)
AutoCompGetMaxWidth(self) -> int
Get the maximum width, in characters, of auto-completion and user lists.
def AutoCompGetMaxWidth(*args, **kwargs): """ AutoCompGetMaxWidth(self) -> int Get the maximum width, in characters, of auto-completion and user lists. """ return _stc.StyledTextCtrl_AutoCompGetMaxWidth(*args, **kwargs)
def AutoCompGetSeparator(
*args, **kwargs)
AutoCompGetSeparator(self) -> int
Retrieve the auto-completion list separator character.
def AutoCompGetSeparator(*args, **kwargs): """ AutoCompGetSeparator(self) -> int Retrieve the auto-completion list separator character. """ return _stc.StyledTextCtrl_AutoCompGetSeparator(*args, **kwargs)
def AutoCompGetTypeSeparator(
*args, **kwargs)
AutoCompGetTypeSeparator(self) -> int
Retrieve the auto-completion list type-separator character.
def AutoCompGetTypeSeparator(*args, **kwargs): """ AutoCompGetTypeSeparator(self) -> int Retrieve the auto-completion list type-separator character. """ return _stc.StyledTextCtrl_AutoCompGetTypeSeparator(*args, **kwargs)
def AutoCompPosStart(
*args, **kwargs)
AutoCompPosStart(self) -> int
Retrieve the position of the caret when the auto-completion list was displayed.
def AutoCompPosStart(*args, **kwargs): """ AutoCompPosStart(self) -> int Retrieve the position of the caret when the auto-completion list was displayed. """ return _stc.StyledTextCtrl_AutoCompPosStart(*args, **kwargs)
def AutoCompSelect(
*args, **kwargs)
AutoCompSelect(self, String text)
Select the item in the auto-completion list that starts with a string.
def AutoCompSelect(*args, **kwargs): """ AutoCompSelect(self, String text) Select the item in the auto-completion list that starts with a string. """ return _stc.StyledTextCtrl_AutoCompSelect(*args, **kwargs)
def AutoCompSetAutoHide(
*args, **kwargs)
AutoCompSetAutoHide(self, bool autoHide)
Set whether or not autocompletion is hidden automatically when nothing matches.
def AutoCompSetAutoHide(*args, **kwargs): """ AutoCompSetAutoHide(self, bool autoHide) Set whether or not autocompletion is hidden automatically when nothing matches. """ return _stc.StyledTextCtrl_AutoCompSetAutoHide(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_AutoCompSetCancelAtStart(*args, **kwargs)
def AutoCompSetCaseInsensitiveBehaviour(
*args, **kwargs)
AutoCompSetCaseInsensitiveBehaviour(self, int behaviour)
def AutoCompSetCaseInsensitiveBehaviour(*args, **kwargs): """AutoCompSetCaseInsensitiveBehaviour(self, int behaviour)""" return _stc.StyledTextCtrl_AutoCompSetCaseInsensitiveBehaviour(*args, **kwargs)
def AutoCompSetChooseSingle(
*args, **kwargs)
AutoCompSetChooseSingle(self, bool chooseSingle)
Should a single item auto-completion list automatically choose the item.
def AutoCompSetChooseSingle(*args, **kwargs): """ AutoCompSetChooseSingle(self, bool chooseSingle) Should a single item auto-completion list automatically choose the item. """ return _stc.StyledTextCtrl_AutoCompSetChooseSingle(*args, **kwargs)
def AutoCompSetDropRestOfWord(
*args, **kwargs)
AutoCompSetDropRestOfWord(self, bool dropRestOfWord)
Set whether or not autocompletion deletes any word characters after the inserted text upon completion.
def AutoCompSetDropRestOfWord(*args, **kwargs): """ AutoCompSetDropRestOfWord(self, bool dropRestOfWord) Set whether or not autocompletion deletes any word characters after the inserted text upon completion. """ return _stc.StyledTextCtrl_AutoCompSetDropRestOfWord(*args, **kwargs)
def AutoCompSetFillUps(
*args, **kwargs)
AutoCompSetFillUps(self, String characterSet)
Define a set of characters that when typed will cause the autocompletion to choose the selected item.
def AutoCompSetFillUps(*args, **kwargs): """ AutoCompSetFillUps(self, String characterSet) Define a set of characters that when typed will cause the autocompletion to choose the selected item. """ return _stc.StyledTextCtrl_AutoCompSetFillUps(*args, **kwargs)
def AutoCompSetIgnoreCase(
*args, **kwargs)
AutoCompSetIgnoreCase(self, bool ignoreCase)
Set whether case is significant when performing auto-completion searches.
def AutoCompSetIgnoreCase(*args, **kwargs): """ AutoCompSetIgnoreCase(self, bool ignoreCase) Set whether case is significant when performing auto-completion searches. """ return _stc.StyledTextCtrl_AutoCompSetIgnoreCase(*args, **kwargs)
def AutoCompSetMaxHeight(
*args, **kwargs)
AutoCompSetMaxHeight(self, int rowCount)
Set the maximum height, in rows, of auto-completion and user lists. The default is 5 rows.
def AutoCompSetMaxHeight(*args, **kwargs): """ AutoCompSetMaxHeight(self, int rowCount) Set the maximum height, in rows, of auto-completion and user lists. The default is 5 rows. """ return _stc.StyledTextCtrl_AutoCompSetMaxHeight(*args, **kwargs)
def AutoCompSetMaxWidth(
*args, **kwargs)
AutoCompSetMaxWidth(self, int 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.
def AutoCompSetMaxWidth(*args, **kwargs): """ AutoCompSetMaxWidth(self, int 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. """ return _stc.StyledTextCtrl_AutoCompSetMaxWidth(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_AutoCompSetSeparator(*args, **kwargs)
def 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 '?'.
def 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 '?'. """ return _stc.StyledTextCtrl_AutoCompSetTypeSeparator(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_AutoCompShow(*args, **kwargs)
def AutoCompStops(
*args, **kwargs)
AutoCompStops(self, String characterSet)
Define a set of character that when typed cancel the auto-completion list.
def AutoCompStops(*args, **kwargs): """ AutoCompStops(self, String characterSet) Define a set of character that when typed cancel the auto-completion list. """ return _stc.StyledTextCtrl_AutoCompStops(*args, **kwargs)
def AutoComplete(
*args, **kwargs)
AutoComplete(self, wxArrayString choices) -> bool
def AutoComplete(*args, **kwargs): """AutoComplete(self, wxArrayString choices) -> bool""" return _core_.TextEntryBase_AutoComplete(*args, **kwargs)
def AutoCompleteDirectories(
*args, **kwargs)
AutoCompleteDirectories(self) -> bool
def AutoCompleteDirectories(*args, **kwargs): """AutoCompleteDirectories(self) -> bool""" return _core_.TextEntryBase_AutoCompleteDirectories(*args, **kwargs)
def AutoCompleteFileNames(
*args, **kwargs)
AutoCompleteFileNames(self) -> bool
def AutoCompleteFileNames(*args, **kwargs): """AutoCompleteFileNames(self) -> bool""" return _core_.TextEntryBase_AutoCompleteFileNames(*args, **kwargs)
def BackTab(
*args, **kwargs)
BackTab(self)
Dedent the selected lines.
def BackTab(*args, **kwargs): """ BackTab(self) Dedent the selected lines. """ return _stc.StyledTextCtrl_BackTab(*args, **kwargs)
def BeginUndoAction(
*args, **kwargs)
BeginUndoAction(self)
Start a sequence of actions that is undone and redone as a unit. May be nested.
def BeginUndoAction(*args, **kwargs): """ BeginUndoAction(self) Start a sequence of actions that is undone and redone as a unit. May be nested. """ return _stc.StyledTextCtrl_BeginUndoAction(*args, **kwargs)
def Bind(
self, event, handler, source=None, id=-1, id2=-1)
Bind an event to an event handler.
:param event: One of the EVT_* objects that specifies the type of event to bind,
:param handler: A callable object to be invoked when the event is delivered to self. Pass None to disconnect an event handler.
:param source: Sometimes the event originates from a different window than self, but you still want to catch it in self. (For example, a button event delivered to a frame.) By passing the source of the event, the event handling system is able to differentiate between the same event type from different controls.
:param id: Used to spcify the event source by ID instead of instance.
:param id2: Used when it is desirable to bind a handler to a range of IDs, such as with EVT_MENU_RANGE.
def Bind(self, event, handler, source=None, id=wx.ID_ANY, id2=wx.ID_ANY): """ Bind an event to an event handler. :param event: One of the EVT_* objects that specifies the type of event to bind, :param handler: A callable object to be invoked when the event is delivered to self. Pass None to disconnect an event handler. :param source: Sometimes the event originates from a different window than self, but you still want to catch it in self. (For example, a button event delivered to a frame.) By passing the source of the event, the event handling system is able to differentiate between the same event type from different controls. :param id: Used to spcify the event source by ID instead of instance. :param id2: Used when it is desirable to bind a handler to a range of IDs, such as with EVT_MENU_RANGE. """ assert isinstance(event, wx.PyEventBinder) assert handler is None or callable(handler) assert source is None or hasattr(source, 'GetId') if source is not None: id = source.GetId() event.Bind(self, id, id2, handler)
def BraceBadLight(
*args, **kwargs)
BraceBadLight(self, int pos)
Highlight the character at a position indicating there is no matching brace.
def BraceBadLight(*args, **kwargs): """ BraceBadLight(self, int pos) Highlight the character at a position indicating there is no matching brace. """ return _stc.StyledTextCtrl_BraceBadLight(*args, **kwargs)
def BraceBadLightIndicator(
*args, **kwargs)
BraceBadLightIndicator(self, bool useBraceBadLightIndicator, int indicator)
def BraceBadLightIndicator(*args, **kwargs): """BraceBadLightIndicator(self, bool useBraceBadLightIndicator, int indicator)""" return _stc.StyledTextCtrl_BraceBadLightIndicator(*args, **kwargs)
def BraceHighlight(
*args, **kwargs)
BraceHighlight(self, int pos1, int pos2)
Highlight the characters at two positions.
def BraceHighlight(*args, **kwargs): """ BraceHighlight(self, int pos1, int pos2) Highlight the characters at two positions. """ return _stc.StyledTextCtrl_BraceHighlight(*args, **kwargs)
def BraceHighlightIndicator(
*args, **kwargs)
BraceHighlightIndicator(self, bool useBraceHighlightIndicator, int indicator)
def BraceHighlightIndicator(*args, **kwargs): """BraceHighlightIndicator(self, bool useBraceHighlightIndicator, int indicator)""" return _stc.StyledTextCtrl_BraceHighlightIndicator(*args, **kwargs)
def BraceMatch(
*args, **kwargs)
BraceMatch(self, int pos) -> int
Find the position of a matching brace or INVALID_POSITION if no match.
def BraceMatch(*args, **kwargs): """ BraceMatch(self, int pos) -> int Find the position of a matching brace or INVALID_POSITION if no match. """ return _stc.StyledTextCtrl_BraceMatch(*args, **kwargs)
def CacheBestSize(
*args, **kwargs)
CacheBestSize(self, Size size)
Cache the best size so it doesn't need to be calculated again, (at least until some properties of the window change.)
def CacheBestSize(*args, **kwargs): """ CacheBestSize(self, Size size) Cache the best size so it doesn't need to be calculated again, (at least until some properties of the window change.) """ return _core_.Window_CacheBestSize(*args, **kwargs)
def CallTipActive(
*args, **kwargs)
CallTipActive(self) -> bool
Is there an active call tip?
def CallTipActive(*args, **kwargs): """ CallTipActive(self) -> bool Is there an active call tip? """ return _stc.StyledTextCtrl_CallTipActive(*args, **kwargs)
def CallTipCancel(
*args, **kwargs)
CallTipCancel(self)
Remove the call tip from the screen.
def CallTipCancel(*args, **kwargs): """ CallTipCancel(self) Remove the call tip from the screen. """ return _stc.StyledTextCtrl_CallTipCancel(*args, **kwargs)
def CallTipPosAtStart(
*args, **kwargs)
CallTipPosAtStart(self) -> int
Retrieve the position where the caret was before displaying the call tip.
def CallTipPosAtStart(*args, **kwargs): """ CallTipPosAtStart(self) -> int Retrieve the position where the caret was before displaying the call tip. """ return _stc.StyledTextCtrl_CallTipPosAtStart(*args, **kwargs)
def CallTipSetBackground(
*args, **kwargs)
CallTipSetBackground(self, Colour back)
Set the background colour for the call tip.
def CallTipSetBackground(*args, **kwargs): """ CallTipSetBackground(self, Colour back) Set the background colour for the call tip. """ return _stc.StyledTextCtrl_CallTipSetBackground(*args, **kwargs)
def CallTipSetForeground(
*args, **kwargs)
CallTipSetForeground(self, Colour fore)
Set the foreground colour for the call tip.
def CallTipSetForeground(*args, **kwargs): """ CallTipSetForeground(self, Colour fore) Set the foreground colour for the call tip. """ return _stc.StyledTextCtrl_CallTipSetForeground(*args, **kwargs)
def CallTipSetForegroundHighlight(
*args, **kwargs)
CallTipSetForegroundHighlight(self, Colour fore)
Set the foreground colour for the highlighted part of the call tip.
def CallTipSetForegroundHighlight(*args, **kwargs): """ CallTipSetForegroundHighlight(self, Colour fore) Set the foreground colour for the highlighted part of the call tip. """ return _stc.StyledTextCtrl_CallTipSetForegroundHighlight(*args, **kwargs)
def CallTipSetHighlight(
*args, **kwargs)
CallTipSetHighlight(self, int start, int end)
Highlight a segment of the definition.
def CallTipSetHighlight(*args, **kwargs): """ CallTipSetHighlight(self, int start, int end) Highlight a segment of the definition. """ return _stc.StyledTextCtrl_CallTipSetHighlight(*args, **kwargs)
def CallTipSetPosition(
*args, **kwargs)
CallTipSetPosition(self, bool above)
def CallTipSetPosition(*args, **kwargs): """CallTipSetPosition(self, bool above)""" return _stc.StyledTextCtrl_CallTipSetPosition(*args, **kwargs)
def CallTipShow(
*args, **kwargs)
CallTipShow(self, int pos, String definition)
Show a call tip containing a definition near position pos.
def CallTipShow(*args, **kwargs): """ CallTipShow(self, int pos, String definition) Show a call tip containing a definition near position pos. """ return _stc.StyledTextCtrl_CallTipShow(*args, **kwargs)
def CallTipUseStyle(
*args, **kwargs)
CallTipUseStyle(self, int tabSize)
Enable use of STYLE_CALLTIP and set call tip tab size in pixels.
def CallTipUseStyle(*args, **kwargs): """ CallTipUseStyle(self, int tabSize) Enable use of STYLE_CALLTIP and set call tip tab size in pixels. """ return _stc.StyledTextCtrl_CallTipUseStyle(*args, **kwargs)
def CanAcceptFocus(
*args, **kwargs)
CanAcceptFocus(self) -> bool
Can this window have focus right now?
def CanAcceptFocus(*args, **kwargs): """ CanAcceptFocus(self) -> bool Can this window have focus right now? """ return _core_.Window_CanAcceptFocus(*args, **kwargs)
def CanAcceptFocusFromKeyboard(
*args, **kwargs)
CanAcceptFocusFromKeyboard(self) -> bool
Can this window be assigned focus from keyboard right now?
def CanAcceptFocusFromKeyboard(*args, **kwargs): """ CanAcceptFocusFromKeyboard(self) -> bool Can this window be assigned focus from keyboard right now? """ return _core_.Window_CanAcceptFocusFromKeyboard(*args, **kwargs)
def CanApplyThemeBorder(
*args, **kwargs)
CanApplyThemeBorder(self) -> bool
def CanApplyThemeBorder(*args, **kwargs): """CanApplyThemeBorder(self) -> bool""" return _core_.Window_CanApplyThemeBorder(*args, **kwargs)
def CanBeOutsideClientArea(
*args, **kwargs)
CanBeOutsideClientArea(self) -> bool
def CanBeOutsideClientArea(*args, **kwargs): """CanBeOutsideClientArea(self) -> bool""" return _core_.Window_CanBeOutsideClientArea(*args, **kwargs)
def CanCopy(
*args, **kwargs)
CanCopy(self) -> bool
Returns True if the text field has a text selection to copy to the clipboard.
def CanCopy(*args, **kwargs): """ CanCopy(self) -> bool Returns True if the text field has a text selection to copy to the clipboard. """ return _core_.TextEntryBase_CanCopy(*args, **kwargs)
def CanCut(
*args, **kwargs)
CanCut(self) -> bool
Returns True if the text field is editable and there is a text selection to copy to the clipboard.
def CanCut(*args, **kwargs): """ CanCut(self) -> bool Returns True if the text field is editable and there is a text selection to copy to the clipboard. """ return _core_.TextEntryBase_CanCut(*args, **kwargs)
def CanPaste(
*args, **kwargs)
CanPaste(self) -> bool
Returns True if the text field is editable and there is text on the clipboard that can be pasted into the text field.
def CanPaste(*args, **kwargs): """ CanPaste(self) -> bool Returns True if the text field is editable and there is text on the clipboard that can be pasted into the text field. """ return _core_.TextEntryBase_CanPaste(*args, **kwargs)
def CanRedo(
*args, **kwargs)
CanRedo(self) -> bool
Returns True if the text field is editable and the last undo can be redone.
def CanRedo(*args, **kwargs): """ CanRedo(self) -> bool Returns True if the text field is editable and the last undo can be redone. """ return _core_.TextEntryBase_CanRedo(*args, **kwargs)
def CanScroll(
*args, **kwargs)
CanScroll(self, int orient) -> bool
Can the window have the scrollbar in this orientation?
def CanScroll(*args, **kwargs): """ CanScroll(self, int orient) -> bool Can the window have the scrollbar in this orientation? """ return _core_.Window_CanScroll(*args, **kwargs)
def CanSetTransparent(
*args, **kwargs)
CanSetTransparent(self) -> bool
Returns True if the platform supports setting the transparency for
this window. Note that this method will err on the side of caution,
so it is possible that this will return False when it is in fact
possible to set the transparency.
NOTE: On X-windows systems the X server must have the composite extension loaded, and there must be a composite manager program (such as xcompmgr) running.
def CanSetTransparent(*args, **kwargs): """ CanSetTransparent(self) -> bool Returns ``True`` if the platform supports setting the transparency for this window. Note that this method will err on the side of caution, so it is possible that this will return ``False`` when it is in fact possible to set the transparency. NOTE: On X-windows systems the X server must have the composite extension loaded, and there must be a composite manager program (such as xcompmgr) running. """ return _core_.Window_CanSetTransparent(*args, **kwargs)
def CanUndo(
*args, **kwargs)
CanUndo(self) -> bool
Returns True if the text field is editable and the last edit can be undone.
def CanUndo(*args, **kwargs): """ CanUndo(self) -> bool Returns True if the text field is editable and the last edit can be undone. """ return _core_.TextEntryBase_CanUndo(*args, **kwargs)
def Cancel(
*args, **kwargs)
Cancel(self)
Cancel any modes such as call tip or auto-completion list display.
def Cancel(*args, **kwargs): """ Cancel(self) Cancel any modes such as call tip or auto-completion list display. """ return _stc.StyledTextCtrl_Cancel(*args, **kwargs)
def CaptureMouse(
*args, **kwargs)
CaptureMouse(self)
Directs all mouse input to this window. Call wx.Window.ReleaseMouse to release the capture.
Note that wxWindows maintains the stack of windows having captured the
mouse and when the mouse is released the capture returns to the window
which had had captured it previously and it is only really released if
there were no previous window. In particular, this means that you must
release the mouse as many times as you capture it, unless the window
receives the wx.MouseCaptureLostEvent event.
Any application which captures the mouse in the beginning of some
operation must handle wx.MouseCaptureLostEvent and cancel this
operation when it receives the event. The event handler must not
recapture mouse.
def CaptureMouse(*args, **kwargs): """ CaptureMouse(self) Directs all mouse input to this window. Call wx.Window.ReleaseMouse to release the capture. Note that wxWindows maintains the stack of windows having captured the mouse and when the mouse is released the capture returns to the window which had had captured it previously and it is only really released if there were no previous window. In particular, this means that you must release the mouse as many times as you capture it, unless the window receives the `wx.MouseCaptureLostEvent` event. Any application which captures the mouse in the beginning of some operation *must* handle `wx.MouseCaptureLostEvent` and cancel this operation when it receives the event. The event handler must not recapture mouse. """ return _core_.Window_CaptureMouse(*args, **kwargs)
def Center(
*args, **kwargs)
Center(self, int direction=BOTH)
Centers the window. The parameter specifies the direction for centering, and may be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. It may also include wx.CENTER_ON_SCREEN flag if you want to center the window on the entire screen and not on its parent window. If it is a top-level window and has no parent then it will always be centered relative to the screen.
def Center(*args, **kwargs): """ Center(self, int direction=BOTH) Centers the window. The parameter specifies the direction for centering, and may be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. It may also include wx.CENTER_ON_SCREEN flag if you want to center the window on the entire screen and not on its parent window. If it is a top-level window and has no parent then it will always be centered relative to the screen. """ return _core_.Window_Center(*args, **kwargs)
def CenterOnParent(
*args, **kwargs)
CenterOnParent(self, int dir=BOTH)
Center with respect to the the parent window
def CenterOnParent(*args, **kwargs): """ CenterOnParent(self, int dir=BOTH) Center with respect to the the parent window """ return _core_.Window_CenterOnParent(*args, **kwargs)
def Centre(
*args, **kwargs)
Center(self, int direction=BOTH)
Centers the window. The parameter specifies the direction for centering, and may be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. It may also include wx.CENTER_ON_SCREEN flag if you want to center the window on the entire screen and not on its parent window. If it is a top-level window and has no parent then it will always be centered relative to the screen.
def Center(*args, **kwargs): """ Center(self, int direction=BOTH) Centers the window. The parameter specifies the direction for centering, and may be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. It may also include wx.CENTER_ON_SCREEN flag if you want to center the window on the entire screen and not on its parent window. If it is a top-level window and has no parent then it will always be centered relative to the screen. """ return _core_.Window_Center(*args, **kwargs)
def CentreOnParent(
*args, **kwargs)
CenterOnParent(self, int dir=BOTH)
Center with respect to the the parent window
def CenterOnParent(*args, **kwargs): """ CenterOnParent(self, int dir=BOTH) Center with respect to the the parent window """ return _core_.Window_CenterOnParent(*args, **kwargs)
def ChangeLexerState(
*args, **kwargs)
ChangeLexerState(self, int start, int end) -> int
def ChangeLexerState(*args, **kwargs): """ChangeLexerState(self, int start, int end) -> int""" return _stc.StyledTextCtrl_ChangeLexerState(*args, **kwargs)
def ChangeValue(
*args, **kwargs)
ChangeValue(self, String value)
Set the value in the text entry field. Does not generate a text change event.
def ChangeValue(*args, **kwargs): """ ChangeValue(self, String value) Set the value in the text entry field. Does not generate a text change event. """ return _core_.TextEntryBase_ChangeValue(*args, **kwargs)
def CharLeft(
*args, **kwargs)
CharLeft(self)
Move caret left one character.
def CharLeft(*args, **kwargs): """ CharLeft(self) Move caret left one character. """ return _stc.StyledTextCtrl_CharLeft(*args, **kwargs)
def CharLeftExtend(
*args, **kwargs)
CharLeftExtend(self)
Move caret left one character extending selection to new caret position.
def CharLeftExtend(*args, **kwargs): """ CharLeftExtend(self) Move caret left one character extending selection to new caret position. """ return _stc.StyledTextCtrl_CharLeftExtend(*args, **kwargs)
def CharLeftRectExtend(
*args, **kwargs)
CharLeftRectExtend(self)
Move caret left one character, extending rectangular selection to new caret position.
def CharLeftRectExtend(*args, **kwargs): """ CharLeftRectExtend(self) Move caret left one character, extending rectangular selection to new caret position. """ return _stc.StyledTextCtrl_CharLeftRectExtend(*args, **kwargs)
def CharPositionFromPoint(
*args, **kwargs)
CharPositionFromPoint(self, int x, int y) -> int
Find the position of a character from a point within the window.
def CharPositionFromPoint(*args, **kwargs): """ CharPositionFromPoint(self, int x, int y) -> int Find the position of a character from a point within the window. """ return _stc.StyledTextCtrl_CharPositionFromPoint(*args, **kwargs)
def CharPositionFromPointClose(
*args, **kwargs)
CharPositionFromPointClose(self, int x, int y) -> int
Find the position of a character from a point within the window. Return INVALID_POSITION if not close to text.
def CharPositionFromPointClose(*args, **kwargs): """ CharPositionFromPointClose(self, int x, int y) -> int Find the position of a character from a point within the window. Return INVALID_POSITION if not close to text. """ return _stc.StyledTextCtrl_CharPositionFromPointClose(*args, **kwargs)
def CharRight(
*args, **kwargs)
CharRight(self)
Move caret right one character.
def CharRight(*args, **kwargs): """ CharRight(self) Move caret right one character. """ return _stc.StyledTextCtrl_CharRight(*args, **kwargs)
def CharRightExtend(
*args, **kwargs)
CharRightExtend(self)
Move caret right one character extending selection to new caret position.
def CharRightExtend(*args, **kwargs): """ CharRightExtend(self) Move caret right one character extending selection to new caret position. """ return _stc.StyledTextCtrl_CharRightExtend(*args, **kwargs)
def CharRightRectExtend(
*args, **kwargs)
CharRightRectExtend(self)
Move caret right one character, extending rectangular selection to new caret position.
def CharRightRectExtend(*args, **kwargs): """ CharRightRectExtend(self) Move caret right one character, extending rectangular selection to new caret position. """ return _stc.StyledTextCtrl_CharRightRectExtend(*args, **kwargs)
def ChooseCaretX(
*args, **kwargs)
ChooseCaretX(self)
Set the last x chosen value to be the caret x position.
def ChooseCaretX(*args, **kwargs): """ ChooseCaretX(self) Set the last x chosen value to be the caret x position. """ return _stc.StyledTextCtrl_ChooseCaretX(*args, **kwargs)
def Clear(
*args, **kwargs)
Clear(self)
Clear all text from the text field
def Clear(*args, **kwargs): """ Clear(self) Clear all text from the text field """ return _core_.TextEntryBase_Clear(*args, **kwargs)
def ClearAll(
*args, **kwargs)
ClearAll(self)
Delete all text in the document.
def ClearAll(*args, **kwargs): """ ClearAll(self) Delete all text in the document. """ return _stc.StyledTextCtrl_ClearAll(*args, **kwargs)
def ClearBackground(
*args, **kwargs)
ClearBackground(self)
Clears the window by filling it with the current background colour. Does not cause an erase background event to be generated.
def ClearBackground(*args, **kwargs): """ ClearBackground(self) Clears the window by filling it with the current background colour. Does not cause an erase background event to be generated. """ return _core_.Window_ClearBackground(*args, **kwargs)
def ClearDocumentStyle(
*args, **kwargs)
ClearDocumentStyle(self)
Set all style bytes to 0, remove all folding information.
def ClearDocumentStyle(*args, **kwargs): """ ClearDocumentStyle(self) Set all style bytes to 0, remove all folding information. """ return _stc.StyledTextCtrl_ClearDocumentStyle(*args, **kwargs)
def ClearRegisteredImages(
*args, **kwargs)
ClearRegisteredImages(self)
Clear all the registered images.
def ClearRegisteredImages(*args, **kwargs): """ ClearRegisteredImages(self) Clear all the registered images. """ return _stc.StyledTextCtrl_ClearRegisteredImages(*args, **kwargs)
def ClearSelections(
*args, **kwargs)
ClearSelections(self)
Clear selections to a single empty stream selection
def ClearSelections(*args, **kwargs): """ ClearSelections(self) Clear selections to a single empty stream selection """ return _stc.StyledTextCtrl_ClearSelections(*args, **kwargs)
def ClientToScreen(
*args, **kwargs)
ClientToScreen(self, Point pt) -> Point
Converts to screen coordinates from coordinates relative to this window.
def ClientToScreen(*args, **kwargs): """ ClientToScreen(self, Point pt) -> Point Converts to screen coordinates from coordinates relative to this window. """ return _core_.Window_ClientToScreen(*args, **kwargs)
def ClientToScreenXY(
*args, **kwargs)
ClientToScreenXY(int x, int y) -> (x,y)
Converts to screen coordinates from coordinates relative to this window.
def ClientToScreenXY(*args, **kwargs): """ ClientToScreenXY(int x, int y) -> (x,y) Converts to screen coordinates from coordinates relative to this window. """ return _core_.Window_ClientToScreenXY(*args, **kwargs)
def ClientToWindowSize(
*args, **kwargs)
ClientToWindowSize(self, Size size) -> Size
Converts client area size size to corresponding window size. In
other words, the returned value is what `GetSize` would return if this
window had client area of given size. Components withwx.DefaultCoord`` (-1) value are left unchanged.
Note that the conversion is not always exact, it assumes that non-client area doesn't change and so doesn't take into account things like menu bar (un)wrapping or (dis)appearance of the scrollbars.
def ClientToWindowSize(*args, **kwargs): """ ClientToWindowSize(self, Size size) -> Size Converts client area size ``size to corresponding window size. In other words, the returned value is what `GetSize` would return if this window had client area of given size. Components with ``wx.DefaultCoord`` (-1) value are left unchanged. Note that the conversion is not always exact, it assumes that non-client area doesn't change and so doesn't take into account things like menu bar (un)wrapping or (dis)appearance of the scrollbars. """ return _core_.Window_ClientToWindowSize(*args, **kwargs)
def Close(
*args, **kwargs)
Close(self, bool force=False) -> bool
This function simply generates a EVT_CLOSE event whose handler usually tries to close the window. It doesn't close the window itself, however. If force is False (the default) then the window's close handler will be allowed to veto the destruction of the window.
def Close(*args, **kwargs): """ Close(self, bool force=False) -> bool This function simply generates a EVT_CLOSE event whose handler usually tries to close the window. It doesn't close the window itself, however. If force is False (the default) then the window's close handler will be allowed to veto the destruction of the window. """ return _core_.Window_Close(*args, **kwargs)
def CmdKeyAssign(
*args, **kwargs)
CmdKeyAssign(self, int key, int modifiers, int cmd)
When key+modifier combination km is pressed perform msg.
def CmdKeyAssign(*args, **kwargs): """ CmdKeyAssign(self, int key, int modifiers, int cmd) When key+modifier combination km is pressed perform msg. """ return _stc.StyledTextCtrl_CmdKeyAssign(*args, **kwargs)
def CmdKeyClear(
*args, **kwargs)
CmdKeyClear(self, int key, int modifiers)
When key+modifier combination km is pressed do nothing.
def CmdKeyClear(*args, **kwargs): """ CmdKeyClear(self, int key, int modifiers) When key+modifier combination km is pressed do nothing. """ return _stc.StyledTextCtrl_CmdKeyClear(*args, **kwargs)
def CmdKeyClearAll(
*args, **kwargs)
CmdKeyClearAll(self)
Drop all key mappings.
def CmdKeyClearAll(*args, **kwargs): """ CmdKeyClearAll(self) Drop all key mappings. """ return _stc.StyledTextCtrl_CmdKeyClearAll(*args, **kwargs)
def CmdKeyExecute(
*args, **kwargs)
CmdKeyExecute(self, int cmd)
Perform one of the operations defined by the wx.stc.STC_CMD_* constants.
def CmdKeyExecute(*args, **kwargs): """ CmdKeyExecute(self, int cmd) Perform one of the operations defined by the wx.stc.STC_CMD_* constants. """ return _stc.StyledTextCtrl_CmdKeyExecute(*args, **kwargs)
def Colourise(
*args, **kwargs)
Colourise(self, int start, int end)
Colourise a segment of the document using the current lexing language.
def Colourise(*args, **kwargs): """ Colourise(self, int start, int end) Colourise a segment of the document using the current lexing language. """ return _stc.StyledTextCtrl_Colourise(*args, **kwargs)
def Command(
*args, **kwargs)
Command(self, CommandEvent event)
Simulates the effect of the user issuing a command to the item.
:see: wx.CommandEvent
def Command(*args, **kwargs): """ Command(self, CommandEvent event) Simulates the effect of the user issuing a command to the item. :see: `wx.CommandEvent` """ return _core_.Control_Command(*args, **kwargs)
def Connect(
*args, **kwargs)
Connect(self, int id, int lastId, EventType eventType, PyObject func)
def Connect(*args, **kwargs): """Connect(self, int id, int lastId, EventType eventType, PyObject func)""" return _core_.EvtHandler_Connect(*args, **kwargs)
def ContractedFoldNext(
*args, **kwargs)
ContractedFoldNext(self, int lineStart) -> int
def ContractedFoldNext(*args, **kwargs): """ContractedFoldNext(self, int lineStart) -> int""" return _stc.StyledTextCtrl_ContractedFoldNext(*args, **kwargs)
def ConvertDialogPointToPixels(
*args, **kwargs)
ConvertDialogPointToPixels(self, Point pt) -> Point
Converts a point or size from dialog units to pixels. Dialog units are used for maintaining a dialog's proportions even if the font changes. For the x dimension, the dialog units are multiplied by the average character width and then divided by 4. For the y dimension, the dialog units are multiplied by the average character height and then divided by 8.
def ConvertDialogPointToPixels(*args, **kwargs): """ ConvertDialogPointToPixels(self, Point pt) -> Point Converts a point or size from dialog units to pixels. Dialog units are used for maintaining a dialog's proportions even if the font changes. For the x dimension, the dialog units are multiplied by the average character width and then divided by 4. For the y dimension, the dialog units are multiplied by the average character height and then divided by 8. """ return _core_.Window_ConvertDialogPointToPixels(*args, **kwargs)
def ConvertDialogSizeToPixels(
*args, **kwargs)
ConvertDialogSizeToPixels(self, Size sz) -> Size
Converts a point or size from dialog units to pixels. Dialog units are used for maintaining a dialog's proportions even if the font changes. For the x dimension, the dialog units are multiplied by the average character width and then divided by 4. For the y dimension, the dialog units are multiplied by the average character height and then divided by 8.
def ConvertDialogSizeToPixels(*args, **kwargs): """ ConvertDialogSizeToPixels(self, Size sz) -> Size Converts a point or size from dialog units to pixels. Dialog units are used for maintaining a dialog's proportions even if the font changes. For the x dimension, the dialog units are multiplied by the average character width and then divided by 4. For the y dimension, the dialog units are multiplied by the average character height and then divided by 8. """ return _core_.Window_ConvertDialogSizeToPixels(*args, **kwargs)
def ConvertEOLs(
*args, **kwargs)
ConvertEOLs(self, int eolMode)
Convert all line endings in the document to one mode.
def ConvertEOLs(*args, **kwargs): """ ConvertEOLs(self, int eolMode) Convert all line endings in the document to one mode. """ return _stc.StyledTextCtrl_ConvertEOLs(*args, **kwargs)
def ConvertPixelPointToDialog(
*args, **kwargs)
ConvertPixelPointToDialog(self, Point pt) -> Point
def ConvertPixelPointToDialog(*args, **kwargs): """ConvertPixelPointToDialog(self, Point pt) -> Point""" return _core_.Window_ConvertPixelPointToDialog(*args, **kwargs)
def ConvertPixelSizeToDialog(
*args, **kwargs)
ConvertPixelSizeToDialog(self, Size sz) -> Size
def ConvertPixelSizeToDialog(*args, **kwargs): """ConvertPixelSizeToDialog(self, Size sz) -> Size""" return _core_.Window_ConvertPixelSizeToDialog(*args, **kwargs)
def Copy(
*args, **kwargs)
Copy(self)
Copies the selected text to the clipboard.
def Copy(*args, **kwargs): """ Copy(self) Copies the selected text to the clipboard. """ return _core_.TextEntryBase_Copy(*args, **kwargs)
def CopyAllowLine(
*args, **kwargs)
CopyAllowLine(self)
Copy the selection, if selection empty copy the line with the caret
def CopyAllowLine(*args, **kwargs): """ CopyAllowLine(self) Copy the selection, if selection empty copy the line with the caret """ return _stc.StyledTextCtrl_CopyAllowLine(*args, **kwargs)
def CopyRange(
*args, **kwargs)
CopyRange(self, int start, int end)
Copy a range of text to the clipboard. Positions are clipped into the document.
def CopyRange(*args, **kwargs): """ CopyRange(self, int start, int end) Copy a range of text to the clipboard. Positions are clipped into the document. """ return _stc.StyledTextCtrl_CopyRange(*args, **kwargs)
def CopyText(
*args, **kwargs)
CopyText(self, int length, String text)
Copy argument text to the clipboard.
def CopyText(*args, **kwargs): """ CopyText(self, int length, String text) Copy argument text to the clipboard. """ return _stc.StyledTextCtrl_CopyText(*args, **kwargs)
def CountCharacters(
*args, **kwargs)
CountCharacters(self, int startPos, int endPos) -> int
def CountCharacters(*args, **kwargs): """CountCharacters(self, int startPos, int endPos) -> int""" return _stc.StyledTextCtrl_CountCharacters(*args, **kwargs)
def Create(
*args, **kwargs)
Create(self, Window parent, int id=ID_ANY, Point pos=DefaultPosition, Size size=DefaultSize, long style=0, String name=wxSTCNameStr) -> bool
def Create(*args, **kwargs): """ Create(self, Window parent, int id=ID_ANY, Point pos=DefaultPosition, Size size=DefaultSize, long style=0, String name=wxSTCNameStr) -> bool """ return _stc.StyledTextCtrl_Create(*args, **kwargs)
def CreateDocument(
*args, **kwargs)
CreateDocument(self) -> void
Create a new document object. Starts with reference count of 1 and not selected into editor.
def CreateDocument(*args, **kwargs): """ CreateDocument(self) -> void Create a new document object. Starts with reference count of 1 and not selected into editor. """ return _stc.StyledTextCtrl_CreateDocument(*args, **kwargs)
def CreateLoader(
*args, **kwargs)
CreateLoader(self, int bytes) -> void
def CreateLoader(*args, **kwargs): """CreateLoader(self, int bytes) -> void""" return _stc.StyledTextCtrl_CreateLoader(*args, **kwargs)
def Cut(
*args, **kwargs)
Cut(self)
Copies the selected text to the clipboard and removes the selection.
def Cut(*args, **kwargs): """ Cut(self) Copies the selected text to the clipboard and removes the selection. """ return _core_.TextEntryBase_Cut(*args, **kwargs)
def DLG_PNT(
*args, **kwargs)
DLG_PNT(self, Point pt) -> Point
Converts a point or size from dialog units to pixels. Dialog units are used for maintaining a dialog's proportions even if the font changes. For the x dimension, the dialog units are multiplied by the average character width and then divided by 4. For the y dimension, the dialog units are multiplied by the average character height and then divided by 8.
def DLG_PNT(*args, **kwargs): """ DLG_PNT(self, Point pt) -> Point Converts a point or size from dialog units to pixels. Dialog units are used for maintaining a dialog's proportions even if the font changes. For the x dimension, the dialog units are multiplied by the average character width and then divided by 4. For the y dimension, the dialog units are multiplied by the average character height and then divided by 8. """ return _core_.Window_DLG_PNT(*args, **kwargs)
def DLG_SZE(
*args, **kwargs)
DLG_SZE(self, Size sz) -> Size
Converts a point or size from dialog units to pixels. Dialog units are used for maintaining a dialog's proportions even if the font changes. For the x dimension, the dialog units are multiplied by the average character width and then divided by 4. For the y dimension, the dialog units are multiplied by the average character height and then divided by 8.
def DLG_SZE(*args, **kwargs): """ DLG_SZE(self, Size sz) -> Size Converts a point or size from dialog units to pixels. Dialog units are used for maintaining a dialog's proportions even if the font changes. For the x dimension, the dialog units are multiplied by the average character width and then divided by 4. For the y dimension, the dialog units are multiplied by the average character height and then divided by 8. """ return _core_.Window_DLG_SZE(*args, **kwargs)
def DelLineLeft(
*args, **kwargs)
DelLineLeft(self)
Delete back from the current position to the start of the line.
def DelLineLeft(*args, **kwargs): """ DelLineLeft(self) Delete back from the current position to the start of the line. """ return _stc.StyledTextCtrl_DelLineLeft(*args, **kwargs)
def DelLineRight(
*args, **kwargs)
DelLineRight(self)
Delete forwards from the current position to the end of the line.
def DelLineRight(*args, **kwargs): """ DelLineRight(self) Delete forwards from the current position to the end of the line. """ return _stc.StyledTextCtrl_DelLineRight(*args, **kwargs)
def DelWordLeft(
*args, **kwargs)
DelWordLeft(self)
Delete the word to the left of the caret.
def DelWordLeft(*args, **kwargs): """ DelWordLeft(self) Delete the word to the left of the caret. """ return _stc.StyledTextCtrl_DelWordLeft(*args, **kwargs)
def DelWordRight(
*args, **kwargs)
DelWordRight(self)
Delete the word to the right of the caret.
def DelWordRight(*args, **kwargs): """ DelWordRight(self) Delete the word to the right of the caret. """ return _stc.StyledTextCtrl_DelWordRight(*args, **kwargs)
def DelWordRightEnd(
*args, **kwargs)
DelWordRightEnd(self)
Delete the word to the right of the caret, but not the trailing non-word characters.
def DelWordRightEnd(*args, **kwargs): """ DelWordRightEnd(self) Delete the word to the right of the caret, but not the trailing non-word characters. """ return _stc.StyledTextCtrl_DelWordRightEnd(*args, **kwargs)
def DeleteBack(
*args, **kwargs)
DeleteBack(self)
Delete the selection or if no selection, the character before the caret.
def DeleteBack(*args, **kwargs): """ DeleteBack(self) Delete the selection or if no selection, the character before the caret. """ return _stc.StyledTextCtrl_DeleteBack(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_DeleteBackNotLine(*args, **kwargs)
def DeletePendingEvents(
*args, **kwargs)
DeletePendingEvents(self)
def DeletePendingEvents(*args, **kwargs): """DeletePendingEvents(self)""" return _core_.EvtHandler_DeletePendingEvents(*args, **kwargs)
def DeleteRange(
*args, **kwargs)
DeleteRange(self, int pos, int deleteLength)
def DeleteRange(*args, **kwargs): """DeleteRange(self, int pos, int deleteLength)""" return _stc.StyledTextCtrl_DeleteRange(*args, **kwargs)
def DescribeKeyWordSets(
*args, **kwargs)
DescribeKeyWordSets(self) -> String
def DescribeKeyWordSets(*args, **kwargs): """DescribeKeyWordSets(self) -> String""" return _stc.StyledTextCtrl_DescribeKeyWordSets(*args, **kwargs)
def DescribeProperty(
*args, **kwargs)
DescribeProperty(self, String name) -> String
def DescribeProperty(*args, **kwargs): """DescribeProperty(self, String name) -> String""" return _stc.StyledTextCtrl_DescribeProperty(*args, **kwargs)
def Destroy(
*args, **kwargs)
Destroy(self) -> bool
Destroys the window safely. Frames and dialogs are not destroyed immediately when this function is called -- they are added to a list of windows to be deleted on idle time, when all the window's events have been processed. This prevents problems with events being sent to non-existent windows.
Returns True if the window has either been successfully deleted, or it has been added to the list of windows pending real deletion.
def Destroy(*args, **kwargs): """ Destroy(self) -> bool Destroys the window safely. Frames and dialogs are not destroyed immediately when this function is called -- they are added to a list of windows to be deleted on idle time, when all the window's events have been processed. This prevents problems with events being sent to non-existent windows. Returns True if the window has either been successfully deleted, or it has been added to the list of windows pending real deletion. """ args[0].this.own(False) return _core_.Window_Destroy(*args, **kwargs)
def DestroyChildren(
*args, **kwargs)
DestroyChildren(self) -> bool
Destroys all children of a window. Called automatically by the destructor.
def DestroyChildren(*args, **kwargs): """ DestroyChildren(self) -> bool Destroys all children of a window. Called automatically by the destructor. """ return _core_.Window_DestroyChildren(*args, **kwargs)
def Disable(
*args, **kwargs)
Disable(self) -> bool
Disables the window, same as Enable(false).
def Disable(*args, **kwargs): """ Disable(self) -> bool Disables the window, same as Enable(false). """ return _core_.Window_Disable(*args, **kwargs)
def DiscardEdits(
*args, **kwargs)
DiscardEdits(self)
def DiscardEdits(*args, **kwargs): """DiscardEdits(self)""" return _core_.TextAreaBase_DiscardEdits(*args, **kwargs)
def Disconnect(
*args, **kwargs)
Disconnect(self, int id, int lastId=-1, EventType eventType=wxEVT_NULL, PyObject func=None) -> bool
def Disconnect(*args, **kwargs): """ Disconnect(self, int id, int lastId=-1, EventType eventType=wxEVT_NULL, PyObject func=None) -> bool """ return _core_.EvtHandler_Disconnect(*args, **kwargs)
def DissociateHandle(
*args, **kwargs)
DissociateHandle(self)
Dissociate the current native handle from the window
def DissociateHandle(*args, **kwargs): """ DissociateHandle(self) Dissociate the current native handle from the window """ return _core_.Window_DissociateHandle(*args, **kwargs)
def DoDragOver(
*args, **kwargs)
DoDragOver(self, int x, int y, int def) -> int
Allow for simulating a DnD DragOver.
def DoDragOver(*args, **kwargs): """ DoDragOver(self, int x, int y, int def) -> int Allow for simulating a DnD DragOver. """ return _stc.StyledTextCtrl_DoDragOver(*args, **kwargs)
def DoDropText(
*args, **kwargs)
DoDropText(self, long x, long y, String data) -> bool
Allow for simulating a DnD DropText.
def DoDropText(*args, **kwargs): """ DoDropText(self, long x, long y, String data) -> bool Allow for simulating a DnD DropText. """ return _stc.StyledTextCtrl_DoDropText(*args, **kwargs)
def DocLineFromVisible(
*args, **kwargs)
DocLineFromVisible(self, int lineDisplay) -> int
Find the document line of a display line taking hidden lines into account.
def DocLineFromVisible(*args, **kwargs): """ DocLineFromVisible(self, int lineDisplay) -> int Find the document line of a display line taking hidden lines into account. """ return _stc.StyledTextCtrl_DocLineFromVisible(*args, **kwargs)
def DocumentEnd(
*args, **kwargs)
DocumentEnd(self)
Move caret to last position in document.
def DocumentEnd(*args, **kwargs): """ DocumentEnd(self) Move caret to last position in document. """ return _stc.StyledTextCtrl_DocumentEnd(*args, **kwargs)
def DocumentEndExtend(
*args, **kwargs)
DocumentEndExtend(self)
Move caret to last position in document extending selection to new caret position.
def DocumentEndExtend(*args, **kwargs): """ DocumentEndExtend(self) Move caret to last position in document extending selection to new caret position. """ return _stc.StyledTextCtrl_DocumentEndExtend(*args, **kwargs)
def DocumentStart(
*args, **kwargs)
DocumentStart(self)
Move caret to first position in document.
def DocumentStart(*args, **kwargs): """ DocumentStart(self) Move caret to first position in document. """ return _stc.StyledTextCtrl_DocumentStart(*args, **kwargs)
def DocumentStartExtend(
*args, **kwargs)
DocumentStartExtend(self)
Move caret to first position in document extending selection to new caret position.
def DocumentStartExtend(*args, **kwargs): """ DocumentStartExtend(self) Move caret to first position in document extending selection to new caret position. """ return _stc.StyledTextCtrl_DocumentStartExtend(*args, **kwargs)
def DragAcceptFiles(
*args, **kwargs)
DragAcceptFiles(self, bool accept)
Enables or disables eligibility for drop file events, EVT_DROP_FILES.
def DragAcceptFiles(*args, **kwargs): """ DragAcceptFiles(self, bool accept) Enables or disables eligibility for drop file events, EVT_DROP_FILES. """ return _core_.Window_DragAcceptFiles(*args, **kwargs)
def EditToggleOvertype(
*args, **kwargs)
EditToggleOvertype(self)
Switch from insert to overtype mode or the reverse.
def EditToggleOvertype(*args, **kwargs): """ EditToggleOvertype(self) Switch from insert to overtype mode or the reverse. """ return _stc.StyledTextCtrl_EditToggleOvertype(*args, **kwargs)
def EmptyUndoBuffer(
*args, **kwargs)
EmptyUndoBuffer(self)
Delete the undo history.
def EmptyUndoBuffer(*args, **kwargs): """ EmptyUndoBuffer(self) Delete the undo history. """ return _stc.StyledTextCtrl_EmptyUndoBuffer(*args, **kwargs)
def Enable(
*args, **kwargs)
Enable(self, bool enable=True) -> bool
Enable or disable the window for user input. Note that when a parent window is disabled, all of its children are disabled as well and they are reenabled again when the parent is. Returns true if the window has been enabled or disabled, false if nothing was done, i.e. if the window had already been in the specified state.
def Enable(*args, **kwargs): """ Enable(self, bool enable=True) -> bool Enable or disable the window for user input. Note that when a parent window is disabled, all of its children are disabled as well and they are reenabled again when the parent is. Returns true if the window has been enabled or disabled, false if nothing was done, i.e. if the window had already been in the specified state. """ return _core_.Window_Enable(*args, **kwargs)
def EndUndoAction(
*args, **kwargs)
EndUndoAction(self)
End a sequence of actions that is undone and redone as a unit.
def EndUndoAction(*args, **kwargs): """ EndUndoAction(self) End a sequence of actions that is undone and redone as a unit. """ return _stc.StyledTextCtrl_EndUndoAction(*args, **kwargs)
def EnsureCaretVisible(
*args, **kwargs)
EnsureCaretVisible(self)
Ensure the caret is visible.
def EnsureCaretVisible(*args, **kwargs): """ EnsureCaretVisible(self) Ensure the caret is visible. """ return _stc.StyledTextCtrl_EnsureCaretVisible(*args, **kwargs)
def EnsureVisible(
*args, **kwargs)
EnsureVisible(self, int line)
Ensure a particular line is visible by expanding any header line hiding it.
def EnsureVisible(*args, **kwargs): """ EnsureVisible(self, int line) Ensure a particular line is visible by expanding any header line hiding it. """ return _stc.StyledTextCtrl_EnsureVisible(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_EnsureVisibleEnforcePolicy(*args, **kwargs)
def Expand(
self, line, doExpand, force=False, visLevels=0, level=-1)
def Expand(self, line, doExpand, force=False, visLevels=0, level=-1): lastChild = self.GetLastChild(line, level) line = line + 1 while line <= lastChild: if force: if visLevels > 0: self.ShowLines(line, line) else: self.HideLines(line, line) else: if doExpand: self.ShowLines(line, line) if level == -1: level = self.GetFoldLevel(line) if level & stc.STC_FOLDLEVELHEADERFLAG: if force: if visLevels > 1: self.SetFoldExpanded(line, True) else: self.SetFoldExpanded(line, False) line = self.Expand(line, doExpand, force, visLevels-1) else: if doExpand and self.GetFoldExpanded(line): line = self.Expand(line, True, force, visLevels-1) else: line = self.Expand(line, False, force, visLevels-1) else: line = line + 1 return line
def 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.
def 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. """ return _stc.StyledTextCtrl_FindColumn(*args, **kwargs)
def FindText(
*args, **kwargs)
FindText(self, int minPos, int maxPos, String text, int flags=0) -> int
Find some text in the document.
def FindText(*args, **kwargs): """ FindText(self, int minPos, int maxPos, String text, int flags=0) -> int Find some text in the document. """ return _stc.StyledTextCtrl_FindText(*args, **kwargs)
def FindWindowById(
*args, **kwargs)
FindWindowById(self, long winid) -> Window
Find a child of this window by window ID
def FindWindowById(*args, **kwargs): """ FindWindowById(self, long winid) -> Window Find a child of this window by window ID """ return _core_.Window_FindWindowById(*args, **kwargs)
def FindWindowByLabel(
*args, **kwargs)
FindWindowByLabel(self, String label) -> Window
Find a child of this window by label
def FindWindowByLabel(*args, **kwargs): """ FindWindowByLabel(self, String label) -> Window Find a child of this window by label """ return _core_.Window_FindWindowByLabel(*args, **kwargs)
def FindWindowByName(
*args, **kwargs)
FindWindowByName(self, String name) -> Window
Find a child of this window by name
def FindWindowByName(*args, **kwargs): """ FindWindowByName(self, String name) -> Window Find a child of this window by name """ return _core_.Window_FindWindowByName(*args, **kwargs)
def Fit(
*args, **kwargs)
Fit(self)
Sizes the window so that it fits around its subwindows. This function won't do anything if there are no subwindows and will only really work correctly if sizers are used for the subwindows layout. Also, if the window has exactly one subwindow it is better (faster and the result is more precise as Fit adds some margin to account for fuzziness of its calculations) to call window.SetClientSize(child.GetSize()) instead of calling Fit.
def Fit(*args, **kwargs): """ Fit(self) Sizes the window so that it fits around its subwindows. This function won't do anything if there are no subwindows and will only really work correctly if sizers are used for the subwindows layout. Also, if the window has exactly one subwindow it is better (faster and the result is more precise as Fit adds some margin to account for fuzziness of its calculations) to call window.SetClientSize(child.GetSize()) instead of calling Fit. """ return _core_.Window_Fit(*args, **kwargs)
def FitInside(
*args, **kwargs)
FitInside(self)
Similar to Fit, but sizes the interior (virtual) size of a window. Mainly useful with scrolled windows to reset scrollbars after sizing changes that do not trigger a size event, and/or scrolled windows without an interior sizer. This function similarly won't do anything if there are no subwindows.
def FitInside(*args, **kwargs): """ FitInside(self) Similar to Fit, but sizes the interior (virtual) size of a window. Mainly useful with scrolled windows to reset scrollbars after sizing changes that do not trigger a size event, and/or scrolled windows without an interior sizer. This function similarly won't do anything if there are no subwindows. """ return _core_.Window_FitInside(*args, **kwargs)
def FoldAll(
self)
def FoldAll(self): lineCount = self.GetLineCount() expanding = True # find out if we are folding or unfolding for lineNum in range(lineCount): if self.GetFoldLevel(lineNum) & stc.STC_FOLDLEVELHEADERFLAG: expanding = not self.GetFoldExpanded(lineNum) break lineNum = 0 while lineNum < lineCount: level = self.GetFoldLevel(lineNum) if level & stc.STC_FOLDLEVELHEADERFLAG and \ (level & stc.STC_FOLDLEVELNUMBERMASK) == stc.STC_FOLDLEVELBASE: if expanding: self.SetFoldExpanded(lineNum, True) lineNum = self.Expand(lineNum, True) lineNum = lineNum - 1 else: lastChild = self.GetLastChild(lineNum, -1) self.SetFoldExpanded(lineNum, False) if lastChild > lineNum: self.HideLines(lineNum+1, lastChild) lineNum = lineNum + 1
def FormFeed(
*args, **kwargs)
FormFeed(self)
Insert a Form Feed character.
def FormFeed(*args, **kwargs): """ FormFeed(self) Insert a Form Feed character. """ return _stc.StyledTextCtrl_FormFeed(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_FormatRange(*args, **kwargs)
def Freeze(
*args, **kwargs)
Freeze(self)
Freezes the window or, in other words, prevents any updates from taking place on screen, the window is not redrawn at all. Thaw must be called to reenable window redrawing. Calls to Freeze/Thaw may be nested, with the actual Thaw being delayed until all the nesting has been undone.
This method is useful for visual appearance optimization (for example, it is a good idea to use it before inserting large amount of text into a wxTextCtrl under wxGTK) but is not implemented on all platforms nor for all controls so it is mostly just a hint to wxWindows and not a mandatory directive.
def Freeze(*args, **kwargs): """ Freeze(self) Freezes the window or, in other words, prevents any updates from taking place on screen, the window is not redrawn at all. Thaw must be called to reenable window redrawing. Calls to Freeze/Thaw may be nested, with the actual Thaw being delayed until all the nesting has been undone. This method is useful for visual appearance optimization (for example, it is a good idea to use it before inserting large amount of text into a wxTextCtrl under wxGTK) but is not implemented on all platforms nor for all controls so it is mostly just a hint to wxWindows and not a mandatory directive. """ return _core_.Window_Freeze(*args, **kwargs)
def GetAcceleratorTable(
*args, **kwargs)
GetAcceleratorTable(self) -> AcceleratorTable
Gets the accelerator table for this window.
def GetAcceleratorTable(*args, **kwargs): """ GetAcceleratorTable(self) -> AcceleratorTable Gets the accelerator table for this window. """ return _core_.Window_GetAcceleratorTable(*args, **kwargs)
def GetAdditionalCaretForeground(
*args, **kwargs)
GetAdditionalCaretForeground(self) -> Colour
Get the foreground colour of additional carets.
def GetAdditionalCaretForeground(*args, **kwargs): """ GetAdditionalCaretForeground(self) -> Colour Get the foreground colour of additional carets. """ return _stc.StyledTextCtrl_GetAdditionalCaretForeground(*args, **kwargs)
def GetAdditionalCaretsBlink(
*args, **kwargs)
GetAdditionalCaretsBlink(self) -> bool
Whether additional carets will blink
def GetAdditionalCaretsBlink(*args, **kwargs): """ GetAdditionalCaretsBlink(self) -> bool Whether additional carets will blink """ return _stc.StyledTextCtrl_GetAdditionalCaretsBlink(*args, **kwargs)
def GetAdditionalCaretsVisible(
*args, **kwargs)
GetAdditionalCaretsVisible(self) -> bool
Whether additional carets are visible
def GetAdditionalCaretsVisible(*args, **kwargs): """ GetAdditionalCaretsVisible(self) -> bool Whether additional carets are visible """ return _stc.StyledTextCtrl_GetAdditionalCaretsVisible(*args, **kwargs)
def GetAdditionalSelAlpha(
*args, **kwargs)
GetAdditionalSelAlpha(self) -> int
Get the alpha of the selection.
def GetAdditionalSelAlpha(*args, **kwargs): """ GetAdditionalSelAlpha(self) -> int Get the alpha of the selection. """ return _stc.StyledTextCtrl_GetAdditionalSelAlpha(*args, **kwargs)
def GetAdditionalSelectionTyping(
*args, **kwargs)
GetAdditionalSelectionTyping(self) -> bool
Whether typing can be performed into multiple selections
def GetAdditionalSelectionTyping(*args, **kwargs): """ GetAdditionalSelectionTyping(self) -> bool Whether typing can be performed into multiple selections """ return _stc.StyledTextCtrl_GetAdditionalSelectionTyping(*args, **kwargs)
def GetAdjustedBestSize(
*args, **kw)
def deprecated_func(*args, **kw): warnings.warn("Call to deprecated item. %s" % msg, wxPyDeprecationWarning, stacklevel=2) return item(*args, **kw)
def GetAlignment(
*args, **kwargs)
GetAlignment(self) -> int
Get the control alignment (left/right/centre, top/bottom/centre)
def GetAlignment(*args, **kwargs): """ GetAlignment(self) -> int Get the control alignment (left/right/centre, top/bottom/centre) """ return _core_.Control_GetAlignment(*args, **kwargs)
def GetAllLinesVisible(
*args, **kwargs)
GetAllLinesVisible(self) -> bool
def GetAllLinesVisible(*args, **kwargs): """GetAllLinesVisible(self) -> bool""" return _stc.StyledTextCtrl_GetAllLinesVisible(*args, **kwargs)
def GetAnchor(
*args, **kwargs)
GetAnchor(self) -> int
Returns the position of the opposite end of the selection to the caret.
def GetAnchor(*args, **kwargs): """ GetAnchor(self) -> int Returns the position of the opposite end of the selection to the caret. """ return _stc.StyledTextCtrl_GetAnchor(*args, **kwargs)
def GetAutoLayout(
*args, **kwargs)
GetAutoLayout(self) -> bool
Returns the current autoLayout setting
def GetAutoLayout(*args, **kwargs): """ GetAutoLayout(self) -> bool Returns the current autoLayout setting """ return _core_.Window_GetAutoLayout(*args, **kwargs)
def GetBackSpaceUnIndents(
*args, **kwargs)
GetBackSpaceUnIndents(self) -> bool
Does a backspace pressed when caret is within indentation unindent?
def GetBackSpaceUnIndents(*args, **kwargs): """ GetBackSpaceUnIndents(self) -> bool Does a backspace pressed when caret is within indentation unindent? """ return _stc.StyledTextCtrl_GetBackSpaceUnIndents(*args, **kwargs)
def GetBackgroundColour(
*args, **kwargs)
GetBackgroundColour(self) -> Colour
Returns the background colour of the window.
def GetBackgroundColour(*args, **kwargs): """ GetBackgroundColour(self) -> Colour Returns the background colour of the window. """ return _core_.Window_GetBackgroundColour(*args, **kwargs)
def GetBackgroundStyle(
*args, **kwargs)
GetBackgroundStyle(self) -> int
Returns the background style of the window.
:see: SetBackgroundStyle
def GetBackgroundStyle(*args, **kwargs): """ GetBackgroundStyle(self) -> int Returns the background style of the window. :see: `SetBackgroundStyle` """ return _core_.Window_GetBackgroundStyle(*args, **kwargs)
def GetBestFittingSize(
*args, **kw)
GetEffectiveMinSize(self) -> Size
This function will merge the window's best size into the window's minimum size, giving priority to the min size components, and returns the results.
def deprecated_func(*args, **kw): warnings.warn("Call to deprecated item. %s" % msg, wxPyDeprecationWarning, stacklevel=2) return item(*args, **kw)
def GetBestSize(
*args, **kwargs)
GetBestSize(self) -> Size
This function returns the best acceptable minimal size for the window, if applicable. For example, for a static text control, it will be the minimal size such that the control label is not truncated. For windows containing subwindows (such as wx.Panel), the size returned by this function will be the same as the size the window would have had after calling Fit.
def GetBestSize(*args, **kwargs): """ GetBestSize(self) -> Size This function returns the best acceptable minimal size for the window, if applicable. For example, for a static text control, it will be the minimal size such that the control label is not truncated. For windows containing subwindows (such as wx.Panel), the size returned by this function will be the same as the size the window would have had after calling Fit. """ return _core_.Window_GetBestSize(*args, **kwargs)
def GetBestSizeTuple(
*args, **kwargs)
GetBestSizeTuple() -> (width, height)
This function returns the best acceptable minimal size for the window, if applicable. For example, for a static text control, it will be the minimal size such that the control label is not truncated. For windows containing subwindows (such as wx.Panel), the size returned by this function will be the same as the size the window would have had after calling Fit.
def GetBestSizeTuple(*args, **kwargs): """ GetBestSizeTuple() -> (width, height) This function returns the best acceptable minimal size for the window, if applicable. For example, for a static text control, it will be the minimal size such that the control label is not truncated. For windows containing subwindows (such as wx.Panel), the size returned by this function will be the same as the size the window would have had after calling Fit. """ return _core_.Window_GetBestSizeTuple(*args, **kwargs)
def GetBestVirtualSize(
*args, **kwargs)
GetBestVirtualSize(self) -> Size
Return the largest of ClientSize and BestSize (as determined by a sizer, interior children, or other means)
def GetBestVirtualSize(*args, **kwargs): """ GetBestVirtualSize(self) -> Size Return the largest of ClientSize and BestSize (as determined by a sizer, interior children, or other means) """ return _core_.Window_GetBestVirtualSize(*args, **kwargs)
def GetBorder(
*args)
GetBorder(self, long flags) -> int GetBorder(self) -> int
Get border for the flags of this window
def GetBorder(*args): """ GetBorder(self, long flags) -> int GetBorder(self) -> int Get border for the flags of this window """ return _core_.Window_GetBorder(*args)
def GetBufferedDraw(
*args, **kwargs)
GetBufferedDraw(self) -> bool
Is drawing done first into a buffer or direct to the screen?
def GetBufferedDraw(*args, **kwargs): """ GetBufferedDraw(self) -> bool Is drawing done first into a buffer or direct to the screen? """ return _stc.StyledTextCtrl_GetBufferedDraw(*args, **kwargs)
def GetCaret(
*args, **kwargs)
GetCaret(self) -> Caret
Returns the caret associated with the window.
def GetCaret(*args, **kwargs): """ GetCaret(self) -> Caret Returns the caret associated with the window. """ return _core_.Window_GetCaret(*args, **kwargs)
def GetCaretForeground(
*args, **kwargs)
GetCaretForeground(self) -> Colour
Get the foreground colour of the caret.
def GetCaretForeground(*args, **kwargs): """ GetCaretForeground(self) -> Colour Get the foreground colour of the caret. """ return _stc.StyledTextCtrl_GetCaretForeground(*args, **kwargs)
def GetCaretLineBack(
*args, **kwargs)
GetCaretLineBackground(self) -> Colour
Get the colour of the background of the line containing the caret.
def GetCaretLineBackground(*args, **kwargs): """ GetCaretLineBackground(self) -> Colour Get the colour of the background of the line containing the caret. """ return _stc.StyledTextCtrl_GetCaretLineBackground(*args, **kwargs)
def GetCaretLineBackAlpha(
*args, **kwargs)
GetCaretLineBackAlpha(self) -> int
Get the background alpha of the caret line.
def GetCaretLineBackAlpha(*args, **kwargs): """ GetCaretLineBackAlpha(self) -> int Get the background alpha of the caret line. """ return _stc.StyledTextCtrl_GetCaretLineBackAlpha(*args, **kwargs)
def GetCaretLineBackground(
*args, **kwargs)
GetCaretLineBackground(self) -> Colour
Get the colour of the background of the line containing the caret.
def GetCaretLineBackground(*args, **kwargs): """ GetCaretLineBackground(self) -> Colour Get the colour of the background of the line containing the caret. """ return _stc.StyledTextCtrl_GetCaretLineBackground(*args, **kwargs)
def GetCaretLineVisible(
*args, **kwargs)
GetCaretLineVisible(self) -> bool
Is the background of the line containing the caret in a different colour?
def GetCaretLineVisible(*args, **kwargs): """ GetCaretLineVisible(self) -> bool Is the background of the line containing the caret in a different colour? """ return _stc.StyledTextCtrl_GetCaretLineVisible(*args, **kwargs)
def GetCaretPeriod(
*args, **kwargs)
GetCaretPeriod(self) -> int
Get the time in milliseconds that the caret is on and off.
def GetCaretPeriod(*args, **kwargs): """ GetCaretPeriod(self) -> int Get the time in milliseconds that the caret is on and off. """ return _stc.StyledTextCtrl_GetCaretPeriod(*args, **kwargs)
def GetCaretSticky(
*args, **kwargs)
GetCaretSticky(self) -> int
Can the caret preferred x position only be changed by explicit movement commands?
def GetCaretSticky(*args, **kwargs): """ GetCaretSticky(self) -> int Can the caret preferred x position only be changed by explicit movement commands? """ return _stc.StyledTextCtrl_GetCaretSticky(*args, **kwargs)
def GetCaretStyle(
*args, **kwargs)
GetCaretStyle(self) -> int
Returns the current style of the caret.
def GetCaretStyle(*args, **kwargs): """ GetCaretStyle(self) -> int Returns the current style of the caret. """ return _stc.StyledTextCtrl_GetCaretStyle(*args, **kwargs)
def GetCaretWidth(
*args, **kwargs)
GetCaretWidth(self) -> int
Returns the width of the insert mode caret.
def GetCaretWidth(*args, **kwargs): """ GetCaretWidth(self) -> int Returns the width of the insert mode caret. """ return _stc.StyledTextCtrl_GetCaretWidth(*args, **kwargs)
def GetCharAt(
*args, **kwargs)
GetCharAt(self, int pos) -> int
Returns the character byte at the position.
def GetCharAt(*args, **kwargs): """ GetCharAt(self, int pos) -> int Returns the character byte at the position. """ return _stc.StyledTextCtrl_GetCharAt(*args, **kwargs)
def GetCharHeight(
*args, **kwargs)
GetCharHeight(self) -> int
Get the (average) character size for the current font.
def GetCharHeight(*args, **kwargs): """ GetCharHeight(self) -> int Get the (average) character size for the current font. """ return _core_.Window_GetCharHeight(*args, **kwargs)
def GetCharWidth(
*args, **kwargs)
GetCharWidth(self) -> int
Get the (average) character size for the current font.
def GetCharWidth(*args, **kwargs): """ GetCharWidth(self) -> int Get the (average) character size for the current font. """ return _core_.Window_GetCharWidth(*args, **kwargs)
def GetChildren(
*args, **kwargs)
GetChildren(self) -> WindowList
Returns an object containing a list of the window's children. The object provides a Python sequence-like interface over the internal list maintained by the window..
def GetChildren(*args, **kwargs): """ GetChildren(self) -> WindowList Returns an object containing a list of the window's children. The object provides a Python sequence-like interface over the internal list maintained by the window.. """ return _core_.Window_GetChildren(*args, **kwargs)
def GetClassName(
*args, **kwargs)
GetClassName(self) -> String
Returns the class name of the C++ class using wxRTTI.
def GetClassName(*args, **kwargs): """ GetClassName(self) -> String Returns the class name of the C++ class using wxRTTI. """ return _core_.Object_GetClassName(*args, **kwargs)
def GetClientAreaOrigin(
*args, **kwargs)
GetClientAreaOrigin(self) -> Point
Get the origin of the client area of the window relative to the window's top left corner (the client area may be shifted because of the borders, scrollbars, other decorations...)
def GetClientAreaOrigin(*args, **kwargs): """ GetClientAreaOrigin(self) -> Point Get the origin of the client area of the window relative to the window's top left corner (the client area may be shifted because of the borders, scrollbars, other decorations...) """ return _core_.Window_GetClientAreaOrigin(*args, **kwargs)
def GetClientRect(
*args, **kwargs)
GetClientRect(self) -> Rect
Get the client area position and size as a wx.Rect object.
def GetClientRect(*args, **kwargs): """ GetClientRect(self) -> Rect Get the client area position and size as a `wx.Rect` object. """ return _core_.Window_GetClientRect(*args, **kwargs)
def GetClientSize(
*args, **kwargs)
GetClientSize(self) -> Size
This gets the size of the window's 'client area' in pixels. The client area is the area which may be drawn on by the programmer, excluding title bar, border, scrollbars, etc.
def GetClientSize(*args, **kwargs): """ GetClientSize(self) -> Size This gets the size of the window's 'client area' in pixels. The client area is the area which may be drawn on by the programmer, excluding title bar, border, scrollbars, etc. """ return _core_.Window_GetClientSize(*args, **kwargs)
def GetClientSizeTuple(
*args, **kwargs)
GetClientSizeTuple() -> (width, height)
This gets the size of the window's 'client area' in pixels. The client area is the area which may be drawn on by the programmer, excluding title bar, border, scrollbars, etc.
def GetClientSizeTuple(*args, **kwargs): """ GetClientSizeTuple() -> (width, height) This gets the size of the window's 'client area' in pixels. The client area is the area which may be drawn on by the programmer, excluding title bar, border, scrollbars, etc. """ return _core_.Window_GetClientSizeTuple(*args, **kwargs)
def GetCodePage(
*args, **kwargs)
GetCodePage(self) -> int
Get the code page used to interpret the bytes of the document as characters.
def GetCodePage(*args, **kwargs): """ GetCodePage(self) -> int Get the code page used to interpret the bytes of the document as characters. """ return _stc.StyledTextCtrl_GetCodePage(*args, **kwargs)
def GetColumn(
*args, **kwargs)
GetColumn(self, int pos) -> int
Retrieve the column number of a position, taking tab width into account.
def GetColumn(*args, **kwargs): """ GetColumn(self, int pos) -> int Retrieve the column number of a position, taking tab width into account. """ return _stc.StyledTextCtrl_GetColumn(*args, **kwargs)
def GetConstraints(
*args, **kwargs)
GetConstraints(self) -> LayoutConstraints
Returns a pointer to the window's layout constraints, or None if there are none.
def GetConstraints(*args, **kwargs): """ GetConstraints(self) -> LayoutConstraints Returns a pointer to the window's layout constraints, or None if there are none. """ return _core_.Window_GetConstraints(*args, **kwargs)
def GetContainingSizer(
*args, **kwargs)
GetContainingSizer(self) -> Sizer
Return the sizer that this window is a member of, if any, otherwise None.
def GetContainingSizer(*args, **kwargs): """ GetContainingSizer(self) -> Sizer Return the sizer that this window is a member of, if any, otherwise None. """ return _core_.Window_GetContainingSizer(*args, **kwargs)
def GetControlCharSymbol(
*args, **kwargs)
GetControlCharSymbol(self) -> int
Get the way control characters are displayed.
def GetControlCharSymbol(*args, **kwargs): """ GetControlCharSymbol(self) -> int Get the way control characters are displayed. """ return _stc.StyledTextCtrl_GetControlCharSymbol(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_GetCurLine(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_GetCurLineRaw(*args, **kwargs)
def GetCurLineUTF8(
self)
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.
def GetCurLineUTF8(self): """ 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. """ text, pos = self.GetCurLineRaw() if not wx.USE_UNICODE: u = text.decode(wx.GetDefaultPyEncoding()) text = u.encode('utf-8') return text, pos
def GetCurrentLine(
*args, **kwargs)
GetCurrentLine(self) -> int
Returns the line number of the line with the caret.
def GetCurrentLine(*args, **kwargs): """ GetCurrentLine(self) -> int Returns the line number of the line with the caret. """ return _stc.StyledTextCtrl_GetCurrentLine(*args, **kwargs)
def GetCurrentPos(
*args, **kwargs)
GetCurrentPos(self) -> int
Returns the position of the caret.
def GetCurrentPos(*args, **kwargs): """ GetCurrentPos(self) -> int Returns the position of the caret. """ return _stc.StyledTextCtrl_GetCurrentPos(*args, **kwargs)
def GetCursor(
*args, **kwargs)
GetCursor(self) -> Cursor
Return the cursor associated with this window.
def GetCursor(*args, **kwargs): """ GetCursor(self) -> Cursor Return the cursor associated with this window. """ return _core_.Window_GetCursor(*args, **kwargs)
def GetDefaultAttributes(
*args, **kwargs)
GetDefaultAttributes(self) -> VisualAttributes
Get the default attributes for an instance of this class. This is useful if you want to use the same font or colour in your own control as in a standard control -- which is a much better idea than hard coding specific colours or fonts which might look completely out of place on the user's system, especially if it uses themes.
def GetDefaultAttributes(*args, **kwargs): """ GetDefaultAttributes(self) -> VisualAttributes Get the default attributes for an instance of this class. This is useful if you want to use the same font or colour in your own control as in a standard control -- which is a much better idea than hard coding specific colours or fonts which might look completely out of place on the user's system, especially if it uses themes. """ return _core_.Window_GetDefaultAttributes(*args, **kwargs)
def GetDefaultStyle(
*args, **kwargs)
GetDefaultStyle(self) -> wxTextAttr
def GetDefaultStyle(*args, **kwargs): """GetDefaultStyle(self) -> wxTextAttr""" return _core_.TextAreaBase_GetDefaultStyle(*args, **kwargs)
def GetDocPointer(
*args, **kwargs)
GetDocPointer(self) -> void
Retrieve a pointer to the document object.
def GetDocPointer(*args, **kwargs): """ GetDocPointer(self) -> void Retrieve a pointer to the document object. """ return _stc.StyledTextCtrl_GetDocPointer(*args, **kwargs)
def GetDropTarget(
*args, **kwargs)
GetDropTarget(self) -> DropTarget
Returns the associated drop target, which may be None.
def GetDropTarget(*args, **kwargs): """ GetDropTarget(self) -> DropTarget Returns the associated drop target, which may be None. """ return _core_.Window_GetDropTarget(*args, **kwargs)
def GetEOLMode(
*args, **kwargs)
GetEOLMode(self) -> int
Retrieve the current end of line mode - one of CRLF, CR, or LF.
def GetEOLMode(*args, **kwargs): """ GetEOLMode(self) -> int Retrieve the current end of line mode - one of CRLF, CR, or LF. """ return _stc.StyledTextCtrl_GetEOLMode(*args, **kwargs)
def GetEdgeColour(
*args, **kwargs)
GetEdgeColour(self) -> Colour
Retrieve the colour used in edge indication.
def GetEdgeColour(*args, **kwargs): """ GetEdgeColour(self) -> Colour Retrieve the colour used in edge indication. """ return _stc.StyledTextCtrl_GetEdgeColour(*args, **kwargs)
def GetEdgeColumn(
*args, **kwargs)
GetEdgeColumn(self) -> int
Retrieve the column number which text should be kept within.
def GetEdgeColumn(*args, **kwargs): """ GetEdgeColumn(self) -> int Retrieve the column number which text should be kept within. """ return _stc.StyledTextCtrl_GetEdgeColumn(*args, **kwargs)
def GetEdgeMode(
*args, **kwargs)
GetEdgeMode(self) -> int
Retrieve the edge highlight mode.
def GetEdgeMode(*args, **kwargs): """ GetEdgeMode(self) -> int Retrieve the edge highlight mode. """ return _stc.StyledTextCtrl_GetEdgeMode(*args, **kwargs)
def GetEffectiveMinSize(
*args, **kwargs)
GetEffectiveMinSize(self) -> Size
This function will merge the window's best size into the window's minimum size, giving priority to the min size components, and returns the results.
def GetEffectiveMinSize(*args, **kwargs): """ GetEffectiveMinSize(self) -> Size This function will merge the window's best size into the window's minimum size, giving priority to the min size components, and returns the results. """ return _core_.Window_GetEffectiveMinSize(*args, **kwargs)
def GetEndAtLastLine(
*args, **kwargs)
GetEndAtLastLine(self) -> bool
Retrieve whether the maximum scroll position has the last line at the bottom of the view.
def GetEndAtLastLine(*args, **kwargs): """ GetEndAtLastLine(self) -> bool Retrieve whether the maximum scroll position has the last line at the bottom of the view. """ return _stc.StyledTextCtrl_GetEndAtLastLine(*args, **kwargs)
def GetEndStyled(
*args, **kwargs)
GetEndStyled(self) -> int
Retrieve the position of the last correctly styled character.
def GetEndStyled(*args, **kwargs): """ GetEndStyled(self) -> int Retrieve the position of the last correctly styled character. """ return _stc.StyledTextCtrl_GetEndStyled(*args, **kwargs)
def GetEventHandler(
*args, **kwargs)
GetEventHandler(self) -> EvtHandler
Returns the event handler for this window. By default, the window is its own event handler.
def GetEventHandler(*args, **kwargs): """ GetEventHandler(self) -> EvtHandler Returns the event handler for this window. By default, the window is its own event handler. """ return _core_.Window_GetEventHandler(*args, **kwargs)
def GetEvtHandlerEnabled(
*args, **kwargs)
GetEvtHandlerEnabled(self) -> bool
def GetEvtHandlerEnabled(*args, **kwargs): """GetEvtHandlerEnabled(self) -> bool""" return _core_.EvtHandler_GetEvtHandlerEnabled(*args, **kwargs)
def GetExtraAscent(
*args, **kwargs)
GetExtraAscent(self) -> int
Get extra ascent for each line
def GetExtraAscent(*args, **kwargs): """ GetExtraAscent(self) -> int Get extra ascent for each line """ return _stc.StyledTextCtrl_GetExtraAscent(*args, **kwargs)
def GetExtraDescent(
*args, **kwargs)
GetExtraDescent(self) -> int
Get extra descent for each line
def GetExtraDescent(*args, **kwargs): """ GetExtraDescent(self) -> int Get extra descent for each line """ return _stc.StyledTextCtrl_GetExtraDescent(*args, **kwargs)
def GetExtraStyle(
*args, **kwargs)
GetExtraStyle(self) -> long
Returns the extra style bits for the window.
def GetExtraStyle(*args, **kwargs): """ GetExtraStyle(self) -> long Returns the extra style bits for the window. """ return _core_.Window_GetExtraStyle(*args, **kwargs)
def GetFirstVisibleLine(
*args, **kwargs)
GetFirstVisibleLine(self) -> int
Retrieve the display line at the top of the display.
def GetFirstVisibleLine(*args, **kwargs): """ GetFirstVisibleLine(self) -> int Retrieve the display line at the top of the display. """ return _stc.StyledTextCtrl_GetFirstVisibleLine(*args, **kwargs)
def GetFoldExpanded(
*args, **kwargs)
GetFoldExpanded(self, int line) -> bool
Is a header line expanded?
def GetFoldExpanded(*args, **kwargs): """ GetFoldExpanded(self, int line) -> bool Is a header line expanded? """ return _stc.StyledTextCtrl_GetFoldExpanded(*args, **kwargs)
def GetFoldLevel(
*args, **kwargs)
GetFoldLevel(self, int line) -> int
Retrieve the fold level of a line.
def GetFoldLevel(*args, **kwargs): """ GetFoldLevel(self, int line) -> int Retrieve the fold level of a line. """ return _stc.StyledTextCtrl_GetFoldLevel(*args, **kwargs)
def GetFoldParent(
*args, **kwargs)
GetFoldParent(self, int line) -> int
Find the parent line of a child line.
def GetFoldParent(*args, **kwargs): """ GetFoldParent(self, int line) -> int Find the parent line of a child line. """ return _stc.StyledTextCtrl_GetFoldParent(*args, **kwargs)
def GetFont(
*args, **kwargs)
GetFont(self) -> Font
Returns the default font used for this window.
def GetFont(*args, **kwargs): """ GetFont(self) -> Font Returns the default font used for this window. """ return _core_.Window_GetFont(*args, **kwargs)
def GetForegroundColour(
*args, **kwargs)
GetForegroundColour(self) -> Colour
Returns the foreground colour of the window. The interpretation of foreground colour is dependent on the window class; it may be the text colour or other colour, or it may not be used at all.
def GetForegroundColour(*args, **kwargs): """ GetForegroundColour(self) -> Colour Returns the foreground colour of the window. The interpretation of foreground colour is dependent on the window class; it may be the text colour or other colour, or it may not be used at all. """ return _core_.Window_GetForegroundColour(*args, **kwargs)
def GetFullTextExtent(
*args, **kwargs)
GetFullTextExtent(String string, Font font=None) -> (width, height, descent, externalLeading)
Get the width, height, decent and leading of the text using the current or specified font.
def GetFullTextExtent(*args, **kwargs): """ GetFullTextExtent(String string, Font font=None) -> (width, height, descent, externalLeading) Get the width, height, decent and leading of the text using the current or specified font. """ return _core_.Window_GetFullTextExtent(*args, **kwargs)
def GetGapPosition(
*args, **kwargs)
GetGapPosition(self) -> int
def GetGapPosition(*args, **kwargs): """GetGapPosition(self) -> int""" return _stc.StyledTextCtrl_GetGapPosition(*args, **kwargs)
def GetGrandParent(
*args, **kwargs)
GetGrandParent(self) -> Window
Returns the parent of the parent of this window, or None if there isn't one.
def GetGrandParent(*args, **kwargs): """ GetGrandParent(self) -> Window Returns the parent of the parent of this window, or None if there isn't one. """ return _core_.Window_GetGrandParent(*args, **kwargs)
def GetGtkWidget(
*args, **kwargs)
GetGtkWidget(self) -> long
On wxGTK returns a pointer to the GtkWidget for this window as a long integer. On the other platforms this method returns zero.
def GetGtkWidget(*args, **kwargs): """ GetGtkWidget(self) -> long On wxGTK returns a pointer to the GtkWidget for this window as a long integer. On the other platforms this method returns zero. """ return _core_.Window_GetGtkWidget(*args, **kwargs)
def GetHandle(
*args, **kwargs)
GetHandle(self) -> long
Returns the platform-specific handle (as a long integer) of the physical window. On wxMSW this is the win32 window handle, on wxGTK it is the XWindow ID, and on wxMac it is the ControlRef.
def GetHandle(*args, **kwargs): """ GetHandle(self) -> long Returns the platform-specific handle (as a long integer) of the physical window. On wxMSW this is the win32 window handle, on wxGTK it is the XWindow ID, and on wxMac it is the ControlRef. """ return _core_.Window_GetHandle(*args, **kwargs)
def GetHelpText(
*args, **kwargs)
GetHelpText(self) -> String
Gets the help text to be used as context-sensitive help for this
window. Note that the text is actually stored by the current
wx.HelpProvider implementation, and not in the window object itself.
def GetHelpText(*args, **kwargs): """ GetHelpText(self) -> String Gets the help text to be used as context-sensitive help for this window. Note that the text is actually stored by the current `wx.HelpProvider` implementation, and not in the window object itself. """ return _core_.Window_GetHelpText(*args, **kwargs)
def GetHelpTextAtPoint(
*args, **kwargs)
GetHelpTextAtPoint(self, Point pt, wxHelpEvent::Origin origin) -> String
Get the help string associated with the given position in this window.
Notice that pt may be invalid if event origin is keyboard or unknown and this method should return the global window help text then
def GetHelpTextAtPoint(*args, **kwargs): """ GetHelpTextAtPoint(self, Point pt, wxHelpEvent::Origin origin) -> String Get the help string associated with the given position in this window. Notice that pt may be invalid if event origin is keyboard or unknown and this method should return the global window help text then """ return _core_.Window_GetHelpTextAtPoint(*args, **kwargs)
def GetHighlightGuide(
*args, **kwargs)
GetHighlightGuide(self) -> int
Get the highlighted indentation guide column.
def GetHighlightGuide(*args, **kwargs): """ GetHighlightGuide(self) -> int Get the highlighted indentation guide column. """ return _stc.StyledTextCtrl_GetHighlightGuide(*args, **kwargs)
def GetHint(
*args, **kwargs)
GetHint(self) -> String
def GetHint(*args, **kwargs): """GetHint(self) -> String""" return _core_.TextEntryBase_GetHint(*args, **kwargs)
def GetHotspotActiveBackground(
*args, **kwargs)
GetHotspotActiveBackground(self) -> Colour
Get the back colour for active hotspots.
def GetHotspotActiveBackground(*args, **kwargs): """ GetHotspotActiveBackground(self) -> Colour Get the back colour for active hotspots. """ return _stc.StyledTextCtrl_GetHotspotActiveBackground(*args, **kwargs)
def GetHotspotActiveForeground(
*args, **kwargs)
GetHotspotActiveForeground(self) -> Colour
Get the fore colour for active hotspots.
def GetHotspotActiveForeground(*args, **kwargs): """ GetHotspotActiveForeground(self) -> Colour Get the fore colour for active hotspots. """ return _stc.StyledTextCtrl_GetHotspotActiveForeground(*args, **kwargs)
def GetHotspotActiveUnderline(
*args, **kwargs)
GetHotspotActiveUnderline(self) -> bool
Get whether underlining for active hotspots.
def GetHotspotActiveUnderline(*args, **kwargs): """ GetHotspotActiveUnderline(self) -> bool Get whether underlining for active hotspots. """ return _stc.StyledTextCtrl_GetHotspotActiveUnderline(*args, **kwargs)
def GetHotspotSingleLine(
*args, **kwargs)
GetHotspotSingleLine(self) -> bool
Get the HotspotSingleLine property
def GetHotspotSingleLine(*args, **kwargs): """ GetHotspotSingleLine(self) -> bool Get the HotspotSingleLine property """ return _stc.StyledTextCtrl_GetHotspotSingleLine(*args, **kwargs)
def GetId(
*args, **kwargs)
GetId(self) -> int
Returns the identifier of the window. Each window has an integer identifier. If the application has not provided one (or the default Id -1 is used) then an unique identifier with a negative value will be generated.
def GetId(*args, **kwargs): """ GetId(self) -> int Returns the identifier of the window. Each window has an integer identifier. If the application has not provided one (or the default Id -1 is used) then an unique identifier with a negative value will be generated. """ return _core_.Window_GetId(*args, **kwargs)
def GetIdentifier(
*args, **kwargs)
GetIdentifier(self) -> int
def GetIdentifier(*args, **kwargs): """GetIdentifier(self) -> int""" return _stc.StyledTextCtrl_GetIdentifier(*args, **kwargs)
def GetIndent(
*args, **kwargs)
GetIndent(self) -> int
Retrieve indentation size.
def GetIndent(*args, **kwargs): """ GetIndent(self) -> int Retrieve indentation size. """ return _stc.StyledTextCtrl_GetIndent(*args, **kwargs)
def GetIndentationGuides(
*args, **kwargs)
GetIndentationGuides(self) -> int
Are the indentation guides visible?
def GetIndentationGuides(*args, **kwargs): """ GetIndentationGuides(self) -> int Are the indentation guides visible? """ return _stc.StyledTextCtrl_GetIndentationGuides(*args, **kwargs)
def GetIndicatorCurrent(
*args, **kwargs)
GetIndicatorCurrent(self) -> int
Get the current indicator
def GetIndicatorCurrent(*args, **kwargs): """ GetIndicatorCurrent(self) -> int Get the current indicator """ return _stc.StyledTextCtrl_GetIndicatorCurrent(*args, **kwargs)
def GetIndicatorValue(
*args, **kwargs)
GetIndicatorValue(self) -> int
Get the current indicator vaue
def GetIndicatorValue(*args, **kwargs): """ GetIndicatorValue(self) -> int Get the current indicator vaue """ return _stc.StyledTextCtrl_GetIndicatorValue(*args, **kwargs)
def GetInsertionPoint(
*args, **kwargs)
GetInsertionPoint(self) -> long
Returns the insertion point for the combobox's text field.
def GetInsertionPoint(*args, **kwargs): """ GetInsertionPoint(self) -> long Returns the insertion point for the combobox's text field. """ return _core_.TextEntryBase_GetInsertionPoint(*args, **kwargs)
def GetKeysUnicode(
*args, **kwargs)
GetKeysUnicode(self) -> bool
Are keys always interpreted as Unicode?
def GetKeysUnicode(*args, **kwargs): """ GetKeysUnicode(self) -> bool Are keys always interpreted as Unicode? """ return _stc.StyledTextCtrl_GetKeysUnicode(*args, **kwargs)
def GetLabel(
*args, **kwargs)
GetLabel(self) -> String
Generic way of getting a label from any window, for identification purposes. The interpretation of this function differs from class to class. For frames and dialogs, the value returned is the title. For buttons or static text controls, it is the button text. This function can be useful for meta-programs such as testing tools or special-needs access programs)which need to identify windows by name.
def GetLabel(*args, **kwargs): """ GetLabel(self) -> String Generic way of getting a label from any window, for identification purposes. The interpretation of this function differs from class to class. For frames and dialogs, the value returned is the title. For buttons or static text controls, it is the button text. This function can be useful for meta-programs such as testing tools or special-needs access programs)which need to identify windows by name. """ return _core_.Window_GetLabel(*args, **kwargs)
def GetLabelText(
*args, **kwargs)
GetLabelText(self) -> String
Get just the text of the label, without mnemonic characters ('&')
def GetLabelText(*args, **kwargs): """ GetLabelText(self) -> String Get just the text of the label, without mnemonic characters ('&') """ return _core_.Control_GetLabelText(*args, **kwargs)
def GetLastChild(
*args, **kwargs)
GetLastChild(self, int line, int level) -> int
Find the last child line of a header line.
def GetLastChild(*args, **kwargs): """ GetLastChild(self, int line, int level) -> int Find the last child line of a header line. """ return _stc.StyledTextCtrl_GetLastChild(*args, **kwargs)
def GetLastKeydownProcessed(
*args, **kwargs)
GetLastKeydownProcessed(self) -> bool
def GetLastKeydownProcessed(*args, **kwargs): """GetLastKeydownProcessed(self) -> bool""" return _stc.StyledTextCtrl_GetLastKeydownProcessed(*args, **kwargs)
def GetLastPosition(
*args, **kwargs)
GetLastPosition(self) -> long
Returns the last position in the combobox text field.
def GetLastPosition(*args, **kwargs): """ GetLastPosition(self) -> long Returns the last position in the combobox text field. """ return _core_.TextEntryBase_GetLastPosition(*args, **kwargs)
def GetLayoutCache(
*args, **kwargs)
GetLayoutCache(self) -> int
Retrieve the degree of caching of layout information.
def GetLayoutCache(*args, **kwargs): """ GetLayoutCache(self) -> int Retrieve the degree of caching of layout information. """ return _stc.StyledTextCtrl_GetLayoutCache(*args, **kwargs)
def GetLayoutDirection(
*args, **kwargs)
GetLayoutDirection(self) -> int
Get the layout direction (LTR or RTL) for this window. Returns
wx.Layout_Default if layout direction is not supported.
def GetLayoutDirection(*args, **kwargs): """ GetLayoutDirection(self) -> int Get the layout direction (LTR or RTL) for this window. Returns ``wx.Layout_Default`` if layout direction is not supported. """ return _core_.Window_GetLayoutDirection(*args, **kwargs)
def GetLength(
*args, **kwargs)
GetLength(self) -> int
Returns the number of bytes in the document.
def GetLength(*args, **kwargs): """ GetLength(self) -> int Returns the number of bytes in the document. """ return _stc.StyledTextCtrl_GetLength(*args, **kwargs)
def GetLexer(
*args, **kwargs)
GetLexer(self) -> int
Retrieve the lexing language of the document.
def GetLexer(*args, **kwargs): """ GetLexer(self) -> int Retrieve the lexing language of the document. """ return _stc.StyledTextCtrl_GetLexer(*args, **kwargs)
def GetLine(
*args, **kwargs)
GetLine(self, int line) -> String
Retrieve the contents of a line.
def GetLine(*args, **kwargs): """ GetLine(self, int line) -> String Retrieve the contents of a line. """ return _stc.StyledTextCtrl_GetLine(*args, **kwargs)
def GetLineCount(
*args, **kwargs)
GetLineCount(self) -> int
Returns the number of lines in the document. There is always at least one.
def GetLineCount(*args, **kwargs): """ GetLineCount(self) -> int Returns the number of lines in the document. There is always at least one. """ return _stc.StyledTextCtrl_GetLineCount(*args, **kwargs)
def GetLineEndPosition(
*args, **kwargs)
GetLineEndPosition(self, int line) -> int
Get the position after the last visible characters on a line.
def GetLineEndPosition(*args, **kwargs): """ GetLineEndPosition(self, int line) -> int Get the position after the last visible characters on a line. """ return _stc.StyledTextCtrl_GetLineEndPosition(*args, **kwargs)
def GetLineIndentPosition(
*args, **kwargs)
GetLineIndentPosition(self, int line) -> int
Retrieve the position before the first non indentation character on a line.
def GetLineIndentPosition(*args, **kwargs): """ GetLineIndentPosition(self, int line) -> int Retrieve the position before the first non indentation character on a line. """ return _stc.StyledTextCtrl_GetLineIndentPosition(*args, **kwargs)
def GetLineIndentation(
*args, **kwargs)
GetLineIndentation(self, int line) -> int
Retrieve the number of columns that a line is indented.
def GetLineIndentation(*args, **kwargs): """ GetLineIndentation(self, int line) -> int Retrieve the number of columns that a line is indented. """ return _stc.StyledTextCtrl_GetLineIndentation(*args, **kwargs)
def GetLineLength(
*args, **kwargs)
GetLineLength(self, long lineNo) -> int
def GetLineLength(*args, **kwargs): """GetLineLength(self, long lineNo) -> int""" return _core_.TextAreaBase_GetLineLength(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_GetLineRaw(*args, **kwargs)
def 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).
def 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). """ return _stc.StyledTextCtrl_GetLineSelEndPosition(*args, **kwargs)
def 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).
def 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). """ return _stc.StyledTextCtrl_GetLineSelStartPosition(*args, **kwargs)
def GetLineState(
*args, **kwargs)
GetLineState(self, int line) -> int
Retrieve the extra styling information for a line.
def GetLineState(*args, **kwargs): """ GetLineState(self, int line) -> int Retrieve the extra styling information for a line. """ return _stc.StyledTextCtrl_GetLineState(*args, **kwargs)
def GetLineText(
*args, **kwargs)
GetLineText(self, long lineNo) -> String
def GetLineText(*args, **kwargs): """GetLineText(self, long lineNo) -> String""" return _core_.TextAreaBase_GetLineText(*args, **kwargs)
def GetLineUTF8(
self, line)
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.
def GetLineUTF8(self, line): """ 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. """ text = self.GetLineRaw(line) if not wx.USE_UNICODE: u = text.decode(wx.GetDefaultPyEncoding()) text = u.encode('utf-8') return text
def GetLineVisible(
*args, **kwargs)
GetLineVisible(self, int line) -> bool
Is a line visible?
def GetLineVisible(*args, **kwargs): """ GetLineVisible(self, int line) -> bool Is a line visible? """ return _stc.StyledTextCtrl_GetLineVisible(*args, **kwargs)
def GetMainSelection(
*args, **kwargs)
GetMainSelection(self) -> int
Which selection is the main selection
def GetMainSelection(*args, **kwargs): """ GetMainSelection(self) -> int Which selection is the main selection """ return _stc.StyledTextCtrl_GetMainSelection(*args, **kwargs)
def GetMainWindowOfCompositeControl(
*args, **kwargs)
GetMainWindowOfCompositeControl(self) -> Window
def GetMainWindowOfCompositeControl(*args, **kwargs): """GetMainWindowOfCompositeControl(self) -> Window""" return _core_.Window_GetMainWindowOfCompositeControl(*args, **kwargs)
def GetMarginCursor(
*args, **kwargs)
GetMarginCursor(self, int margin) -> int
def GetMarginCursor(*args, **kwargs): """GetMarginCursor(self, int margin) -> int""" return _stc.StyledTextCtrl_GetMarginCursor(*args, **kwargs)
def GetMarginLeft(
*args, **kwargs)
GetMarginLeft(self) -> int
Returns the size in pixels of the left margin.
def GetMarginLeft(*args, **kwargs): """ GetMarginLeft(self) -> int Returns the size in pixels of the left margin. """ return _stc.StyledTextCtrl_GetMarginLeft(*args, **kwargs)
def GetMarginMask(
*args, **kwargs)
GetMarginMask(self, int margin) -> int
Retrieve the marker mask of a margin.
def GetMarginMask(*args, **kwargs): """ GetMarginMask(self, int margin) -> int Retrieve the marker mask of a margin. """ return _stc.StyledTextCtrl_GetMarginMask(*args, **kwargs)
def GetMarginOptions(
*args, **kwargs)
GetMarginOptions(self) -> int
def GetMarginOptions(*args, **kwargs): """GetMarginOptions(self) -> int""" return _stc.StyledTextCtrl_GetMarginOptions(*args, **kwargs)
def GetMarginRight(
*args, **kwargs)
GetMarginRight(self) -> int
Returns the size in pixels of the right margin.
def GetMarginRight(*args, **kwargs): """ GetMarginRight(self) -> int Returns the size in pixels of the right margin. """ return _stc.StyledTextCtrl_GetMarginRight(*args, **kwargs)
def GetMarginSensitive(
*args, **kwargs)
GetMarginSensitive(self, int margin) -> bool
Retrieve the mouse click sensitivity of a margin.
def GetMarginSensitive(*args, **kwargs): """ GetMarginSensitive(self, int margin) -> bool Retrieve the mouse click sensitivity of a margin. """ return _stc.StyledTextCtrl_GetMarginSensitive(*args, **kwargs)
def GetMarginType(
*args, **kwargs)
GetMarginType(self, int margin) -> int
Retrieve the type of a margin.
def GetMarginType(*args, **kwargs): """ GetMarginType(self, int margin) -> int Retrieve the type of a margin. """ return _stc.StyledTextCtrl_GetMarginType(*args, **kwargs)
def GetMarginWidth(
*args, **kwargs)
GetMarginWidth(self, int margin) -> int
Retrieve the width of a margin in pixels.
def GetMarginWidth(*args, **kwargs): """ GetMarginWidth(self, int margin) -> int Retrieve the width of a margin in pixels. """ return _stc.StyledTextCtrl_GetMarginWidth(*args, **kwargs)
def GetMargins(
*args, **kwargs)
GetMargins(self) -> Point
def GetMargins(*args, **kwargs): """GetMargins(self) -> Point""" return _core_.TextEntryBase_GetMargins(*args, **kwargs)
def GetMarkerSymbolDefined(
*args, **kwargs)
GetMarkerSymbolDefined(self, int markerNumber) -> int
Which symbol was defined for markerNumber with MarkerDefine
def GetMarkerSymbolDefined(*args, **kwargs): """ GetMarkerSymbolDefined(self, int markerNumber) -> int Which symbol was defined for markerNumber with MarkerDefine """ return _stc.StyledTextCtrl_GetMarkerSymbolDefined(*args, **kwargs)
def GetMaxClientSize(
*args, **kwargs)
GetMaxClientSize(self) -> Size
def GetMaxClientSize(*args, **kwargs): """GetMaxClientSize(self) -> Size""" return _core_.Window_GetMaxClientSize(*args, **kwargs)
def GetMaxHeight(
*args, **kwargs)
GetMaxHeight(self) -> int
def GetMaxHeight(*args, **kwargs): """GetMaxHeight(self) -> int""" return _core_.Window_GetMaxHeight(*args, **kwargs)
def GetMaxLineState(
*args, **kwargs)
GetMaxLineState(self) -> int
Retrieve the last line number that has line state.
def GetMaxLineState(*args, **kwargs): """ GetMaxLineState(self) -> int Retrieve the last line number that has line state. """ return _stc.StyledTextCtrl_GetMaxLineState(*args, **kwargs)
def GetMaxSize(
*args, **kwargs)
GetMaxSize(self) -> Size
def GetMaxSize(*args, **kwargs): """GetMaxSize(self) -> Size""" return _core_.Window_GetMaxSize(*args, **kwargs)
def GetMaxWidth(
*args, **kwargs)
GetMaxWidth(self) -> int
def GetMaxWidth(*args, **kwargs): """GetMaxWidth(self) -> int""" return _core_.Window_GetMaxWidth(*args, **kwargs)
def GetMinClientSize(
*args, **kwargs)
GetMinClientSize(self) -> Size
def GetMinClientSize(*args, **kwargs): """GetMinClientSize(self) -> Size""" return _core_.Window_GetMinClientSize(*args, **kwargs)
def GetMinHeight(
*args, **kwargs)
GetMinHeight(self) -> int
def GetMinHeight(*args, **kwargs): """GetMinHeight(self) -> int""" return _core_.Window_GetMinHeight(*args, **kwargs)
def GetMinSize(
*args, **kwargs)
GetMinSize(self) -> Size
def GetMinSize(*args, **kwargs): """GetMinSize(self) -> Size""" return _core_.Window_GetMinSize(*args, **kwargs)
def GetMinWidth(
*args, **kwargs)
GetMinWidth(self) -> int
def GetMinWidth(*args, **kwargs): """GetMinWidth(self) -> int""" return _core_.Window_GetMinWidth(*args, **kwargs)
def GetModEventMask(
*args, **kwargs)
GetModEventMask(self) -> int
Get which document modification events are sent to the container.
def GetModEventMask(*args, **kwargs): """ GetModEventMask(self) -> int Get which document modification events are sent to the container. """ return _stc.StyledTextCtrl_GetModEventMask(*args, **kwargs)
def GetModify(
*args, **kwargs)
GetModify(self) -> bool
Is the document different from when it was last saved?
def GetModify(*args, **kwargs): """ GetModify(self) -> bool Is the document different from when it was last saved? """ return _stc.StyledTextCtrl_GetModify(*args, **kwargs)
def GetMouseDownCaptures(
*args, **kwargs)
GetMouseDownCaptures(self) -> bool
Get whether mouse gets captured.
def GetMouseDownCaptures(*args, **kwargs): """ GetMouseDownCaptures(self) -> bool Get whether mouse gets captured. """ return _stc.StyledTextCtrl_GetMouseDownCaptures(*args, **kwargs)
def GetMouseDwellTime(
*args, **kwargs)
GetMouseDwellTime(self) -> int
Retrieve the time the mouse must sit still to generate a mouse dwell event.
def GetMouseDwellTime(*args, **kwargs): """ GetMouseDwellTime(self) -> int Retrieve the time the mouse must sit still to generate a mouse dwell event. """ return _stc.StyledTextCtrl_GetMouseDwellTime(*args, **kwargs)
def GetMultiPaste(
*args, **kwargs)
GetMultiPaste(self) -> int
def GetMultiPaste(*args, **kwargs): """GetMultiPaste(self) -> int""" return _stc.StyledTextCtrl_GetMultiPaste(*args, **kwargs)
def GetMultipleSelection(
*args, **kwargs)
GetMultipleSelection(self) -> bool
Whether multiple selections can be made
def GetMultipleSelection(*args, **kwargs): """ GetMultipleSelection(self) -> bool Whether multiple selections can be made """ return _stc.StyledTextCtrl_GetMultipleSelection(*args, **kwargs)
def GetName(
*args, **kwargs)
GetName(self) -> String
Returns the windows name. This name is not guaranteed to be unique; it is up to the programmer to supply an appropriate name in the window constructor or via wx.Window.SetName.
def GetName(*args, **kwargs): """ GetName(self) -> String Returns the windows name. This name is not guaranteed to be unique; it is up to the programmer to supply an appropriate name in the window constructor or via wx.Window.SetName. """ return _core_.Window_GetName(*args, **kwargs)
def GetNextHandler(
*args, **kwargs)
GetNextHandler(self) -> EvtHandler
def GetNextHandler(*args, **kwargs): """GetNextHandler(self) -> EvtHandler""" return _core_.EvtHandler_GetNextHandler(*args, **kwargs)
def GetNextSibling(
*args, **kwargs)
GetNextSibling(self) -> Window
def GetNextSibling(*args, **kwargs): """GetNextSibling(self) -> Window""" return _core_.Window_GetNextSibling(*args, **kwargs)
def GetNumberOfLines(
*args, **kwargs)
GetNumberOfLines(self) -> int
def GetNumberOfLines(*args, **kwargs): """GetNumberOfLines(self) -> int""" return _core_.TextAreaBase_GetNumberOfLines(*args, **kwargs)
def GetOvertype(
*args, **kwargs)
GetOvertype(self) -> bool
Returns true if overtype mode is active otherwise false is returned.
def GetOvertype(*args, **kwargs): """ GetOvertype(self) -> bool Returns true if overtype mode is active otherwise false is returned. """ return _stc.StyledTextCtrl_GetOvertype(*args, **kwargs)
def GetParent(
*args, **kwargs)
GetParent(self) -> Window
Returns the parent window of this window, or None if there isn't one.
def GetParent(*args, **kwargs): """ GetParent(self) -> Window Returns the parent window of this window, or None if there isn't one. """ return _core_.Window_GetParent(*args, **kwargs)
def GetPasteConvertEndings(
*args, **kwargs)
GetPasteConvertEndings(self) -> bool
Get convert-on-paste setting
def GetPasteConvertEndings(*args, **kwargs): """ GetPasteConvertEndings(self) -> bool Get convert-on-paste setting """ return _stc.StyledTextCtrl_GetPasteConvertEndings(*args, **kwargs)
def GetPopupMenuSelectionFromUser(
*args, **kwargs)
GetPopupMenuSelectionFromUser(self, Menu menu, Point pos=DefaultPosition) -> int
Simply return the id of the selected item or wxID_NONE without generating any events.
def GetPopupMenuSelectionFromUser(*args, **kwargs): """ GetPopupMenuSelectionFromUser(self, Menu menu, Point pos=DefaultPosition) -> int Simply return the id of the selected item or wxID_NONE without generating any events. """ return _core_.Window_GetPopupMenuSelectionFromUser(*args, **kwargs)
def GetPosition(
*args, **kwargs)
GetPosition(self) -> Point
Get the window's position. Notice that the position is in client
coordinates for child windows and screen coordinates for the top level
ones, use GetScreenPosition if you need screen coordinates for all
kinds of windows.
def GetPosition(*args, **kwargs): """ GetPosition(self) -> Point Get the window's position. Notice that the position is in client coordinates for child windows and screen coordinates for the top level ones, use `GetScreenPosition` if you need screen coordinates for all kinds of windows. """ return _core_.Window_GetPosition(*args, **kwargs)
def GetPositionCacheSize(
*args, **kwargs)
GetPositionCacheSize(self) -> int
How many entries are allocated to the position cache?
def GetPositionCacheSize(*args, **kwargs): """ GetPositionCacheSize(self) -> int How many entries are allocated to the position cache? """ return _stc.StyledTextCtrl_GetPositionCacheSize(*args, **kwargs)
def GetPositionTuple(
*args, **kwargs)
GetPositionTuple() -> (x,y)
Get the window's position. Notice that the position is in client
coordinates for child windows and screen coordinates for the top level
ones, use GetScreenPosition if you need screen coordinates for all
kinds of windows.
def GetPositionTuple(*args, **kwargs): """ GetPositionTuple() -> (x,y) Get the window's position. Notice that the position is in client coordinates for child windows and screen coordinates for the top level ones, use `GetScreenPosition` if you need screen coordinates for all kinds of windows. """ return _core_.Window_GetPositionTuple(*args, **kwargs)
def GetPrevSibling(
*args, **kwargs)
GetPrevSibling(self) -> Window
def GetPrevSibling(*args, **kwargs): """GetPrevSibling(self) -> Window""" return _core_.Window_GetPrevSibling(*args, **kwargs)
def GetPreviousHandler(
*args, **kwargs)
GetPreviousHandler(self) -> EvtHandler
def GetPreviousHandler(*args, **kwargs): """GetPreviousHandler(self) -> EvtHandler""" return _core_.EvtHandler_GetPreviousHandler(*args, **kwargs)
def GetPrintColourMode(
*args, **kwargs)
GetPrintColourMode(self) -> int
Returns the print colour mode.
def GetPrintColourMode(*args, **kwargs): """ GetPrintColourMode(self) -> int Returns the print colour mode. """ return _stc.StyledTextCtrl_GetPrintColourMode(*args, **kwargs)
def GetPrintMagnification(
*args, **kwargs)
GetPrintMagnification(self) -> int
Returns the print magnification.
def GetPrintMagnification(*args, **kwargs): """ GetPrintMagnification(self) -> int Returns the print magnification. """ return _stc.StyledTextCtrl_GetPrintMagnification(*args, **kwargs)
def GetPrintWrapMode(
*args, **kwargs)
GetPrintWrapMode(self) -> int
Is printing line wrapped?
def GetPrintWrapMode(*args, **kwargs): """ GetPrintWrapMode(self) -> int Is printing line wrapped? """ return _stc.StyledTextCtrl_GetPrintWrapMode(*args, **kwargs)
def GetProperty(
*args, **kwargs)
GetProperty(self, String key) -> String
Retrieve a 'property' value previously set with SetProperty.
def GetProperty(*args, **kwargs): """ GetProperty(self, String key) -> String Retrieve a 'property' value previously set with SetProperty. """ return _stc.StyledTextCtrl_GetProperty(*args, **kwargs)
def GetPropertyExpanded(
*args, **kwargs)
GetPropertyExpanded(self, String key) -> String
Retrieve a 'property' value previously set with SetProperty, with '$()' variable replacement on returned buffer.
def GetPropertyExpanded(*args, **kwargs): """ GetPropertyExpanded(self, String key) -> String Retrieve a 'property' value previously set with SetProperty, with '$()' variable replacement on returned buffer. """ return _stc.StyledTextCtrl_GetPropertyExpanded(*args, **kwargs)
def GetPropertyInt(
*args, **kwargs)
GetPropertyInt(self, String key) -> int
Retrieve a 'property' value previously set with SetProperty, interpreted as an int AFTER any '$()' variable replacement.
def GetPropertyInt(*args, **kwargs): """ GetPropertyInt(self, String key) -> int Retrieve a 'property' value previously set with SetProperty, interpreted as an int AFTER any '$()' variable replacement. """ return _stc.StyledTextCtrl_GetPropertyInt(*args, **kwargs)
def GetPunctuationChars(
*args, **kwargs)
GetPunctuationChars(self) -> String
def GetPunctuationChars(*args, **kwargs): """GetPunctuationChars(self) -> String""" return _stc.StyledTextCtrl_GetPunctuationChars(*args, **kwargs)
def GetRange(
*args, **kwargs)
GetRange(self, long from, long to) -> String
Returns a subset of the value in the text field.
def GetRange(*args, **kwargs): """ GetRange(self, long from, long to) -> String Returns a subset of the value in the text field. """ return _core_.TextEntryBase_GetRange(*args, **kwargs)
def GetRangePointer(
*args, **kwargs)
GetRangePointer(self, int position, int rangeLength) -> char
def GetRangePointer(*args, **kwargs): """GetRangePointer(self, int position, int rangeLength) -> char""" return _stc.StyledTextCtrl_GetRangePointer(*args, **kwargs)
def GetReadOnly(
*args, **kwargs)
GetReadOnly(self) -> bool
In read-only mode?
def GetReadOnly(*args, **kwargs): """ GetReadOnly(self) -> bool In read-only mode? """ return _stc.StyledTextCtrl_GetReadOnly(*args, **kwargs)
def GetRect(
*args, **kwargs)
GetRect(self) -> Rect
Returns the size and position of the window as a wx.Rect object.
def GetRect(*args, **kwargs): """ GetRect(self) -> Rect Returns the size and position of the window as a `wx.Rect` object. """ return _core_.Window_GetRect(*args, **kwargs)
def GetRectangularSelectionAnchor(
*args, **kwargs)
GetRectangularSelectionAnchor(self) -> int
def GetRectangularSelectionAnchor(*args, **kwargs): """GetRectangularSelectionAnchor(self) -> int""" return _stc.StyledTextCtrl_GetRectangularSelectionAnchor(*args, **kwargs)
def GetRectangularSelectionAnchorVirtualSpace(
*args, **kwargs)
GetRectangularSelectionAnchorVirtualSpace(self) -> int
def GetRectangularSelectionAnchorVirtualSpace(*args, **kwargs): """GetRectangularSelectionAnchorVirtualSpace(self) -> int""" return _stc.StyledTextCtrl_GetRectangularSelectionAnchorVirtualSpace(*args, **kwargs)
def GetRectangularSelectionCaret(
*args, **kwargs)
GetRectangularSelectionCaret(self) -> int
def GetRectangularSelectionCaret(*args, **kwargs): """GetRectangularSelectionCaret(self) -> int""" return _stc.StyledTextCtrl_GetRectangularSelectionCaret(*args, **kwargs)
def GetRectangularSelectionCaretVirtualSpace(
*args, **kwargs)
GetRectangularSelectionCaretVirtualSpace(self) -> int
def GetRectangularSelectionCaretVirtualSpace(*args, **kwargs): """GetRectangularSelectionCaretVirtualSpace(self) -> int""" return _stc.StyledTextCtrl_GetRectangularSelectionCaretVirtualSpace(*args, **kwargs)
def GetRectangularSelectionModifier(
*args, **kwargs)
GetRectangularSelectionModifier(self) -> int
Get the modifier key used for rectangular selection.
def GetRectangularSelectionModifier(*args, **kwargs): """ GetRectangularSelectionModifier(self) -> int Get the modifier key used for rectangular selection. """ return _stc.StyledTextCtrl_GetRectangularSelectionModifier(*args, **kwargs)
def GetSTCCursor(
*args, **kwargs)
GetSTCCursor(self) -> int
Get cursor type.
def GetSTCCursor(*args, **kwargs): """ GetSTCCursor(self) -> int Get cursor type. """ return _stc.StyledTextCtrl_GetSTCCursor(*args, **kwargs)
def GetSTCFocus(
*args, **kwargs)
GetSTCFocus(self) -> bool
Get internal focus flag.
def GetSTCFocus(*args, **kwargs): """ GetSTCFocus(self) -> bool Get internal focus flag. """ return _stc.StyledTextCtrl_GetSTCFocus(*args, **kwargs)
def GetScreenPosition(
*args, **kwargs)
GetScreenPosition(self) -> Point
Get the position of the window in screen coordinantes.
def GetScreenPosition(*args, **kwargs): """ GetScreenPosition(self) -> Point Get the position of the window in screen coordinantes. """ return _core_.Window_GetScreenPosition(*args, **kwargs)
def GetScreenPositionTuple(
*args, **kwargs)
GetScreenPositionTuple() -> (x,y)
Get the position of the window in screen coordinantes.
def GetScreenPositionTuple(*args, **kwargs): """ GetScreenPositionTuple() -> (x,y) Get the position of the window in screen coordinantes. """ return _core_.Window_GetScreenPositionTuple(*args, **kwargs)
def GetScreenRect(
*args, **kwargs)
GetScreenRect(self) -> Rect
Returns the size and position of the window in screen coordinantes as
a wx.Rect object.
def GetScreenRect(*args, **kwargs): """ GetScreenRect(self) -> Rect Returns the size and position of the window in screen coordinantes as a `wx.Rect` object. """ return _core_.Window_GetScreenRect(*args, **kwargs)
def GetScrollPos(
*args, **kwargs)
GetScrollPos(self, int orientation) -> int
Returns the built-in scrollbar position.
def GetScrollPos(*args, **kwargs): """ GetScrollPos(self, int orientation) -> int Returns the built-in scrollbar position. """ return _core_.Window_GetScrollPos(*args, **kwargs)
def GetScrollRange(
*args, **kwargs)
GetScrollRange(self, int orientation) -> int
Returns the built-in scrollbar range.
def GetScrollRange(*args, **kwargs): """ GetScrollRange(self, int orientation) -> int Returns the built-in scrollbar range. """ return _core_.Window_GetScrollRange(*args, **kwargs)
def GetScrollThumb(
*args, **kwargs)
GetScrollThumb(self, int orientation) -> int
Returns the built-in scrollbar thumb size.
def GetScrollThumb(*args, **kwargs): """ GetScrollThumb(self, int orientation) -> int Returns the built-in scrollbar thumb size. """ return _core_.Window_GetScrollThumb(*args, **kwargs)
def GetScrollWidth(
*args, **kwargs)
GetScrollWidth(self) -> int
Retrieve the document width assumed for scrolling.
def GetScrollWidth(*args, **kwargs): """ GetScrollWidth(self) -> int Retrieve the document width assumed for scrolling. """ return _stc.StyledTextCtrl_GetScrollWidth(*args, **kwargs)
def GetScrollWidthTracking(
*args, **kwargs)
GetScrollWidthTracking(self) -> bool
Retrieve whether the scroll width tracks wide lines.
def GetScrollWidthTracking(*args, **kwargs): """ GetScrollWidthTracking(self) -> bool Retrieve whether the scroll width tracks wide lines. """ return _stc.StyledTextCtrl_GetScrollWidthTracking(*args, **kwargs)
def GetSearchFlags(
*args, **kwargs)
GetSearchFlags(self) -> int
Get the search flags used by SearchInTarget.
def GetSearchFlags(*args, **kwargs): """ GetSearchFlags(self) -> int Get the search flags used by SearchInTarget. """ return _stc.StyledTextCtrl_GetSearchFlags(*args, **kwargs)
def GetSelAlpha(
*args, **kwargs)
GetSelAlpha(self) -> int
Get the alpha of the selection.
def GetSelAlpha(*args, **kwargs): """ GetSelAlpha(self) -> int Get the alpha of the selection. """ return _stc.StyledTextCtrl_GetSelAlpha(*args, **kwargs)
def GetSelEOLFilled(
*args, **kwargs)
GetSelEOLFilled(self) -> bool
Is the selection end of line filled?
def GetSelEOLFilled(*args, **kwargs): """ GetSelEOLFilled(self) -> bool Is the selection end of line filled? """ return _stc.StyledTextCtrl_GetSelEOLFilled(*args, **kwargs)
def GetSelectedText(
*args, **kwargs)
GetSelectedText(self) -> String
Retrieve the selected text.
def GetSelectedText(*args, **kwargs): """ GetSelectedText(self) -> String Retrieve the selected text. """ return _stc.StyledTextCtrl_GetSelectedText(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_GetSelectedTextRaw(*args, **kwargs)
def GetSelectedTextUTF8(
self)
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.
def GetSelectedTextUTF8(self): """ 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. """ text = self.GetSelectedTextRaw() if not wx.USE_UNICODE: u = text.decode(wx.GetDefaultPyEncoding()) text = u.encode('utf-8') return text
def GetSelection(
*args, **kwargs)
GetSelection() -> (from, to)
If the return values from and to are the same, there is no selection.
def GetSelection(*args, **kwargs): """ GetSelection() -> (from, to) If the return values from and to are the same, there is no selection. """ return _core_.TextEntryBase_GetSelection(*args, **kwargs)
def GetSelectionEnd(
*args, **kwargs)
GetSelectionEnd(self) -> int
Returns the position at the end of the selection.
def GetSelectionEnd(*args, **kwargs): """ GetSelectionEnd(self) -> int Returns the position at the end of the selection. """ return _stc.StyledTextCtrl_GetSelectionEnd(*args, **kwargs)
def GetSelectionMode(
*args, **kwargs)
GetSelectionMode(self) -> int
Get the mode of the current selection.
def GetSelectionMode(*args, **kwargs): """ GetSelectionMode(self) -> int Get the mode of the current selection. """ return _stc.StyledTextCtrl_GetSelectionMode(*args, **kwargs)
def GetSelectionNAnchor(
*args, **kwargs)
GetSelectionNAnchor(self, int selection) -> int
def GetSelectionNAnchor(*args, **kwargs): """GetSelectionNAnchor(self, int selection) -> int""" return _stc.StyledTextCtrl_GetSelectionNAnchor(*args, **kwargs)
def GetSelectionNAnchorVirtualSpace(
*args, **kwargs)
GetSelectionNAnchorVirtualSpace(self, int selection) -> int
def GetSelectionNAnchorVirtualSpace(*args, **kwargs): """GetSelectionNAnchorVirtualSpace(self, int selection) -> int""" return _stc.StyledTextCtrl_GetSelectionNAnchorVirtualSpace(*args, **kwargs)
def GetSelectionNCaret(
*args, **kwargs)
GetSelectionNCaret(self, int selection) -> int
def GetSelectionNCaret(*args, **kwargs): """GetSelectionNCaret(self, int selection) -> int""" return _stc.StyledTextCtrl_GetSelectionNCaret(*args, **kwargs)
def GetSelectionNCaretVirtualSpace(
*args, **kwargs)
GetSelectionNCaretVirtualSpace(self, int selection) -> int
def GetSelectionNCaretVirtualSpace(*args, **kwargs): """GetSelectionNCaretVirtualSpace(self, int selection) -> int""" return _stc.StyledTextCtrl_GetSelectionNCaretVirtualSpace(*args, **kwargs)
def GetSelectionNEnd(
*args, **kwargs)
GetSelectionNEnd(self, int selection) -> int
Returns the position at the end of the selection.
def GetSelectionNEnd(*args, **kwargs): """ GetSelectionNEnd(self, int selection) -> int Returns the position at the end of the selection. """ return _stc.StyledTextCtrl_GetSelectionNEnd(*args, **kwargs)
def GetSelectionNStart(
*args, **kwargs)
GetSelectionNStart(self, int selection) -> int
Returns the position at the start of the selection.
def GetSelectionNStart(*args, **kwargs): """ GetSelectionNStart(self, int selection) -> int Returns the position at the start of the selection. """ return _stc.StyledTextCtrl_GetSelectionNStart(*args, **kwargs)
def GetSelectionStart(
*args, **kwargs)
GetSelectionStart(self) -> int
Returns the position at the start of the selection.
def GetSelectionStart(*args, **kwargs): """ GetSelectionStart(self) -> int Returns the position at the start of the selection. """ return _stc.StyledTextCtrl_GetSelectionStart(*args, **kwargs)
def GetSelections(
*args, **kwargs)
GetSelections(self) -> int
How many selections are there?
def GetSelections(*args, **kwargs): """ GetSelections(self) -> int How many selections are there? """ return _stc.StyledTextCtrl_GetSelections(*args, **kwargs)
def GetSize(
*args, **kwargs)
GetSize(self) -> Size
Get the window size.
def GetSize(*args, **kwargs): """ GetSize(self) -> Size Get the window size. """ return _core_.Window_GetSize(*args, **kwargs)
def GetSizeTuple(
*args, **kwargs)
GetSizeTuple() -> (width, height)
Get the window size.
def GetSizeTuple(*args, **kwargs): """ GetSizeTuple() -> (width, height) Get the window size. """ return _core_.Window_GetSizeTuple(*args, **kwargs)
def GetSizer(
*args, **kwargs)
GetSizer(self) -> Sizer
Return the sizer associated with the window by a previous call to SetSizer or None if there isn't one.
def GetSizer(*args, **kwargs): """ GetSizer(self) -> Sizer Return the sizer associated with the window by a previous call to SetSizer or None if there isn't one. """ return _core_.Window_GetSizer(*args, **kwargs)
def GetStatus(
*args, **kwargs)
GetStatus(self) -> int
Get error status.
def GetStatus(*args, **kwargs): """ GetStatus(self) -> int Get error status. """ return _stc.StyledTextCtrl_GetStatus(*args, **kwargs)
def GetString(
*args, **kw)
GetRange(self, long from, long to) -> String
Returns a subset of the value in the text field.
def deprecated_func(*args, **kw): warnings.warn("Call to deprecated item. %s" % msg, wxPyDeprecationWarning, stacklevel=2) return item(*args, **kw)
def GetStringSelection(
*args, **kwargs)
GetStringSelection(self) -> String
Returns the selected text.
def GetStringSelection(*args, **kwargs): """ GetStringSelection(self) -> String Returns the selected text. """ return _core_.TextEntryBase_GetStringSelection(*args, **kwargs)
def GetStyle(
*args, **kwargs)
GetStyle(self, long position, wxTextAttr style) -> bool
def GetStyle(*args, **kwargs): """GetStyle(self, long position, wxTextAttr style) -> bool""" return _core_.TextAreaBase_GetStyle(*args, **kwargs)
def GetStyleAt(
*args, **kwargs)
GetStyleAt(self, int pos) -> int
Returns the style byte at the position.
def GetStyleAt(*args, **kwargs): """ GetStyleAt(self, int pos) -> int Returns the style byte at the position. """ return _stc.StyledTextCtrl_GetStyleAt(*args, **kwargs)
def GetStyleBits(
*args, **kwargs)
GetStyleBits(self) -> int
Retrieve number of bits in style bytes used to hold the lexical state.
def GetStyleBits(*args, **kwargs): """ GetStyleBits(self) -> int Retrieve number of bits in style bytes used to hold the lexical state. """ return _stc.StyledTextCtrl_GetStyleBits(*args, **kwargs)
def GetStyleBitsNeeded(
*args, **kwargs)
GetStyleBitsNeeded(self) -> int
Retrieve the number of bits the current lexer needs for styling.
def GetStyleBitsNeeded(*args, **kwargs): """ GetStyleBitsNeeded(self) -> int Retrieve the number of bits the current lexer needs for styling. """ return _stc.StyledTextCtrl_GetStyleBitsNeeded(*args, **kwargs)
def GetStyledText(
*args, **kwargs)
GetStyledText(self, int startPos, int endPos) -> wxMemoryBuffer
Retrieve a buffer of cells.
def GetStyledText(*args, **kwargs): """ GetStyledText(self, int startPos, int endPos) -> wxMemoryBuffer Retrieve a buffer of cells. """ return _stc.StyledTextCtrl_GetStyledText(*args, **kwargs)
def GetTabIndents(
*args, **kwargs)
GetTabIndents(self) -> bool
Does a tab pressed when caret is within indentation indent?
def GetTabIndents(*args, **kwargs): """ GetTabIndents(self) -> bool Does a tab pressed when caret is within indentation indent? """ return _stc.StyledTextCtrl_GetTabIndents(*args, **kwargs)
def GetTabWidth(
*args, **kwargs)
GetTabWidth(self) -> int
Retrieve the visible size of a tab.
def GetTabWidth(*args, **kwargs): """ GetTabWidth(self) -> int Retrieve the visible size of a tab. """ return _stc.StyledTextCtrl_GetTabWidth(*args, **kwargs)
def GetTag(
*args, **kwargs)
GetTag(self, int tagNumber) -> String
def GetTag(*args, **kwargs): """GetTag(self, int tagNumber) -> String""" return _stc.StyledTextCtrl_GetTag(*args, **kwargs)
def GetTargetEnd(
*args, **kwargs)
GetTargetEnd(self) -> int
Get the position that ends the target.
def GetTargetEnd(*args, **kwargs): """ GetTargetEnd(self) -> int Get the position that ends the target. """ return _stc.StyledTextCtrl_GetTargetEnd(*args, **kwargs)
def GetTargetStart(
*args, **kwargs)
GetTargetStart(self) -> int
Get the position that starts the target.
def GetTargetStart(*args, **kwargs): """ GetTargetStart(self) -> int Get the position that starts the target. """ return _stc.StyledTextCtrl_GetTargetStart(*args, **kwargs)
def GetTechnology(
*args, **kwargs)
GetTechnology(self) -> int
def GetTechnology(*args, **kwargs): """GetTechnology(self) -> int""" return _stc.StyledTextCtrl_GetTechnology(*args, **kwargs)
def GetText(
*args, **kwargs)
GetText(self) -> String
Retrieve all the text in the document.
def GetText(*args, **kwargs): """ GetText(self) -> String Retrieve all the text in the document. """ return _stc.StyledTextCtrl_GetText(*args, **kwargs)
def GetTextExtent(
*args, **kwargs)
GetTextExtent(String string) -> (width, height)
Get the width and height of the text using the current font.
def GetTextExtent(*args, **kwargs): """ GetTextExtent(String string) -> (width, height) Get the width and height of the text using the current font. """ return _core_.Window_GetTextExtent(*args, **kwargs)
def GetTextLength(
*args, **kwargs)
GetTextLength(self) -> int
Retrieve the number of characters in the document.
def GetTextLength(*args, **kwargs): """ GetTextLength(self) -> int Retrieve the number of characters in the document. """ return _stc.StyledTextCtrl_GetTextLength(*args, **kwargs)
def GetTextRange(
*args, **kwargs)
GetTextRange(self, int startPos, int endPos) -> String
Retrieve a range of text.
def GetTextRange(*args, **kwargs): """ GetTextRange(self, int startPos, int endPos) -> String Retrieve a range of text. """ return _stc.StyledTextCtrl_GetTextRange(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_GetTextRangeRaw(*args, **kwargs)
def GetTextRangeUTF8(
self, startPos, endPos)
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.
def GetTextRangeUTF8(self, startPos, endPos): """ 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. """ text = self.GetTextRangeRaw(startPos, endPos) if not wx.USE_UNICODE: u = text.decode(wx.GetDefaultPyEncoding()) text = u.encode('utf-8') return text
def 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.
def 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. """ return _stc.StyledTextCtrl_GetTextRaw(*args, **kwargs)
def GetTextUTF8(
self)
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.
def GetTextUTF8(self): """ 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. """ text = self.GetTextRaw() if not wx.USE_UNICODE: u = text.decode(wx.GetDefaultPyEncoding()) text = u.encode('utf-8') return text
def GetThemeEnabled(
*args, **kwargs)
GetThemeEnabled(self) -> bool
Return the themeEnabled flag.
def GetThemeEnabled(*args, **kwargs): """ GetThemeEnabled(self) -> bool Return the themeEnabled flag. """ return _core_.Window_GetThemeEnabled(*args, **kwargs)
def GetToolTip(
*args, **kwargs)
GetToolTip(self) -> ToolTip
get the associated tooltip or None if none
def GetToolTip(*args, **kwargs): """ GetToolTip(self) -> ToolTip get the associated tooltip or None if none """ return _core_.Window_GetToolTip(*args, **kwargs)
def GetToolTipString(
self)
def GetToolTipString(self): tip = self.GetToolTip() if tip: return tip.GetTip() else: return None
def GetTopLevelParent(
*args, **kwargs)
GetTopLevelParent(self) -> Window
Returns the first frame or dialog in this window's parental hierarchy.
def GetTopLevelParent(*args, **kwargs): """ GetTopLevelParent(self) -> Window Returns the first frame or dialog in this window's parental hierarchy. """ return _core_.Window_GetTopLevelParent(*args, **kwargs)
def GetTwoPhaseDraw(
*args, **kwargs)
GetTwoPhaseDraw(self) -> bool
Is drawing done in two phases with backgrounds drawn before foregrounds?
def GetTwoPhaseDraw(*args, **kwargs): """ GetTwoPhaseDraw(self) -> bool Is drawing done in two phases with backgrounds drawn before foregrounds? """ return _stc.StyledTextCtrl_GetTwoPhaseDraw(*args, **kwargs)
def GetUndoCollection(
*args, **kwargs)
GetUndoCollection(self) -> bool
Is undo history being collected?
def GetUndoCollection(*args, **kwargs): """ GetUndoCollection(self) -> bool Is undo history being collected? """ return _stc.StyledTextCtrl_GetUndoCollection(*args, **kwargs)
def GetUpdateClientRect(
*args, **kwargs)
GetUpdateClientRect(self) -> Rect
Get the update rectangle region bounding box in client coords.
def GetUpdateClientRect(*args, **kwargs): """ GetUpdateClientRect(self) -> Rect Get the update rectangle region bounding box in client coords. """ return _core_.Window_GetUpdateClientRect(*args, **kwargs)
def GetUpdateRegion(
*args, **kwargs)
GetUpdateRegion(self) -> Region
Returns the region specifying which parts of the window have been damaged. Should only be called within an EVT_PAINT handler.
def GetUpdateRegion(*args, **kwargs): """ GetUpdateRegion(self) -> Region Returns the region specifying which parts of the window have been damaged. Should only be called within an EVT_PAINT handler. """ return _core_.Window_GetUpdateRegion(*args, **kwargs)
def GetUseAntiAliasing(
*args, **kwargs)
GetUseAntiAliasing(self) -> bool
Returns the current UseAntiAliasing setting.
def GetUseAntiAliasing(*args, **kwargs): """ GetUseAntiAliasing(self) -> bool Returns the current UseAntiAliasing setting. """ return _stc.StyledTextCtrl_GetUseAntiAliasing(*args, **kwargs)
def GetUseHorizontalScrollBar(
*args, **kwargs)
GetUseHorizontalScrollBar(self) -> bool
Is the horizontal scroll bar visible?
def GetUseHorizontalScrollBar(*args, **kwargs): """ GetUseHorizontalScrollBar(self) -> bool Is the horizontal scroll bar visible? """ return _stc.StyledTextCtrl_GetUseHorizontalScrollBar(*args, **kwargs)
def GetUseTabs(
*args, **kwargs)
GetUseTabs(self) -> bool
Retrieve whether tabs will be used in indentation.
def GetUseTabs(*args, **kwargs): """ GetUseTabs(self) -> bool Retrieve whether tabs will be used in indentation. """ return _stc.StyledTextCtrl_GetUseTabs(*args, **kwargs)
def GetUseVerticalScrollBar(
*args, **kwargs)
GetUseVerticalScrollBar(self) -> bool
Is the vertical scroll bar visible?
def GetUseVerticalScrollBar(*args, **kwargs): """ GetUseVerticalScrollBar(self) -> bool Is the vertical scroll bar visible? """ return _stc.StyledTextCtrl_GetUseVerticalScrollBar(*args, **kwargs)
def GetValidator(
*args, **kwargs)
GetValidator(self) -> Validator
Returns a pointer to the current validator for the window, or None if there is none.
def GetValidator(*args, **kwargs): """ GetValidator(self) -> Validator Returns a pointer to the current validator for the window, or None if there is none. """ return _core_.Window_GetValidator(*args, **kwargs)
def GetValue(
*args, **kwargs)
GetValue(self) -> String
Returns the current value in the text field.
def GetValue(*args, **kwargs): """ GetValue(self) -> String Returns the current value in the text field. """ return _core_.TextEntryBase_GetValue(*args, **kwargs)
def GetViewEOL(
*args, **kwargs)
GetViewEOL(self) -> bool
Are the end of line characters visible?
def GetViewEOL(*args, **kwargs): """ GetViewEOL(self) -> bool Are the end of line characters visible? """ return _stc.StyledTextCtrl_GetViewEOL(*args, **kwargs)
def GetViewWhiteSpace(
*args, **kwargs)
GetViewWhiteSpace(self) -> int
Are white space characters currently visible? Returns one of SCWS_* constants.
def GetViewWhiteSpace(*args, **kwargs): """ GetViewWhiteSpace(self) -> int Are white space characters currently visible? Returns one of SCWS_* constants. """ return _stc.StyledTextCtrl_GetViewWhiteSpace(*args, **kwargs)
def GetVirtualSize(
*args, **kwargs)
GetVirtualSize(self) -> Size
Get the the virtual size of the window in pixels. For most windows this is just the client area of the window, but for some like scrolled windows it is more or less independent of the screen window size.
def GetVirtualSize(*args, **kwargs): """ GetVirtualSize(self) -> Size Get the the virtual size of the window in pixels. For most windows this is just the client area of the window, but for some like scrolled windows it is more or less independent of the screen window size. """ return _core_.Window_GetVirtualSize(*args, **kwargs)
def GetVirtualSizeTuple(
*args, **kwargs)
GetVirtualSizeTuple() -> (width, height)
Get the the virtual size of the window in pixels. For most windows this is just the client area of the window, but for some like scrolled windows it is more or less independent of the screen window size.
def GetVirtualSizeTuple(*args, **kwargs): """ GetVirtualSizeTuple() -> (width, height) Get the the virtual size of the window in pixels. For most windows this is just the client area of the window, but for some like scrolled windows it is more or less independent of the screen window size. """ return _core_.Window_GetVirtualSizeTuple(*args, **kwargs)
def GetVirtualSpaceOptions(
*args, **kwargs)
GetVirtualSpaceOptions(self) -> int
def GetVirtualSpaceOptions(*args, **kwargs): """GetVirtualSpaceOptions(self) -> int""" return _stc.StyledTextCtrl_GetVirtualSpaceOptions(*args, **kwargs)
def GetWhitespaceChars(
*args, **kwargs)
GetWhitespaceChars(self) -> String
def GetWhitespaceChars(*args, **kwargs): """GetWhitespaceChars(self) -> String""" return _stc.StyledTextCtrl_GetWhitespaceChars(*args, **kwargs)
def GetWhitespaceSize(
*args, **kwargs)
GetWhitespaceSize(self) -> int
Get the size of the dots used to mark space characters.
def GetWhitespaceSize(*args, **kwargs): """ GetWhitespaceSize(self) -> int Get the size of the dots used to mark space characters. """ return _stc.StyledTextCtrl_GetWhitespaceSize(*args, **kwargs)
def GetWindowBorderSize(
*args, **kwargs)
GetWindowBorderSize(self) -> Size
Return the size of the left/right and top/bottom borders.
def GetWindowBorderSize(*args, **kwargs): """ GetWindowBorderSize(self) -> Size Return the size of the left/right and top/bottom borders. """ return _core_.Window_GetWindowBorderSize(*args, **kwargs)
def GetWindowStyle(
*args, **kwargs)
GetWindowStyleFlag(self) -> long
Gets the window style that was passed to the constructor or Create method.
def GetWindowStyleFlag(*args, **kwargs): """ GetWindowStyleFlag(self) -> long Gets the window style that was passed to the constructor or Create method. """ return _core_.Window_GetWindowStyleFlag(*args, **kwargs)
def GetWindowStyleFlag(
*args, **kwargs)
GetWindowStyleFlag(self) -> long
Gets the window style that was passed to the constructor or Create method.
def GetWindowStyleFlag(*args, **kwargs): """ GetWindowStyleFlag(self) -> long Gets the window style that was passed to the constructor or Create method. """ return _core_.Window_GetWindowStyleFlag(*args, **kwargs)
def GetWindowVariant(
*args, **kwargs)
GetWindowVariant(self) -> int
def GetWindowVariant(*args, **kwargs): """GetWindowVariant(self) -> int""" return _core_.Window_GetWindowVariant(*args, **kwargs)
def GetWordChars(
*args, **kwargs)
GetWordChars(self) -> String
def GetWordChars(*args, **kwargs): """GetWordChars(self) -> String""" return _stc.StyledTextCtrl_GetWordChars(*args, **kwargs)
def GetWrapIndentMode(
*args, **kwargs)
GetWrapIndentMode(self) -> int
Retrieve how wrapped sublines are placed. Default is fixed.
def GetWrapIndentMode(*args, **kwargs): """ GetWrapIndentMode(self) -> int Retrieve how wrapped sublines are placed. Default is fixed. """ return _stc.StyledTextCtrl_GetWrapIndentMode(*args, **kwargs)
def GetWrapMode(
*args, **kwargs)
GetWrapMode(self) -> int
Retrieve whether text is word wrapped.
def GetWrapMode(*args, **kwargs): """ GetWrapMode(self) -> int Retrieve whether text is word wrapped. """ return _stc.StyledTextCtrl_GetWrapMode(*args, **kwargs)
def GetWrapStartIndent(
*args, **kwargs)
GetWrapStartIndent(self) -> int
Retrive the start indent for wrapped lines.
def GetWrapStartIndent(*args, **kwargs): """ GetWrapStartIndent(self) -> int Retrive the start indent for wrapped lines. """ return _stc.StyledTextCtrl_GetWrapStartIndent(*args, **kwargs)
def GetWrapVisualFlags(
*args, **kwargs)
GetWrapVisualFlags(self) -> int
Retrive the display mode of visual flags for wrapped lines.
def GetWrapVisualFlags(*args, **kwargs): """ GetWrapVisualFlags(self) -> int Retrive the display mode of visual flags for wrapped lines. """ return _stc.StyledTextCtrl_GetWrapVisualFlags(*args, **kwargs)
def GetWrapVisualFlagsLocation(
*args, **kwargs)
GetWrapVisualFlagsLocation(self) -> int
Retrive the location of visual flags for wrapped lines.
def GetWrapVisualFlagsLocation(*args, **kwargs): """ GetWrapVisualFlagsLocation(self) -> int Retrive the location of visual flags for wrapped lines. """ return _stc.StyledTextCtrl_GetWrapVisualFlagsLocation(*args, **kwargs)
def GetXOffset(
*args, **kwargs)
GetXOffset(self) -> int
def GetXOffset(*args, **kwargs): """GetXOffset(self) -> int""" return _stc.StyledTextCtrl_GetXOffset(*args, **kwargs)
def GetZoom(
*args, **kwargs)
GetZoom(self) -> int
Retrieve the zoom level.
def GetZoom(*args, **kwargs): """ GetZoom(self) -> int Retrieve the zoom level. """ return _stc.StyledTextCtrl_GetZoom(*args, **kwargs)
def GotoLine(
*args, **kwargs)
GotoLine(self, int line)
Set caret to start of a line and ensure it is visible.
def GotoLine(*args, **kwargs): """ GotoLine(self, int line) Set caret to start of a line and ensure it is visible. """ return _stc.StyledTextCtrl_GotoLine(*args, **kwargs)
def GotoPos(
*args, **kwargs)
GotoPos(self, int pos)
Set caret to a position and ensure it is visible.
def GotoPos(*args, **kwargs): """ GotoPos(self, int pos) Set caret to a position and ensure it is visible. """ return _stc.StyledTextCtrl_GotoPos(*args, **kwargs)
HandleAsNavigationKey(self, KeyEvent event) -> bool
This function will generate the appropriate call to Navigate if the
key event is one normally used for keyboard navigation. Returns
True if the key pressed was for navigation and was handled,
False otherwise.
def HandleWindowEvent(
*args, **kwargs)
HandleWindowEvent(self, Event event) -> bool
Process an event by calling GetEventHandler()->ProcessEvent() and handling any exceptions thrown by event handlers. It's mostly useful when processing wx events when called from C code (e.g. in GTK+ callback) when the exception wouldn't correctly propagate to wx.EventLoop.
def HandleWindowEvent(*args, **kwargs): """ HandleWindowEvent(self, Event event) -> bool Process an event by calling GetEventHandler()->ProcessEvent() and handling any exceptions thrown by event handlers. It's mostly useful when processing wx events when called from C code (e.g. in GTK+ callback) when the exception wouldn't correctly propagate to wx.EventLoop. """ return _core_.Window_HandleWindowEvent(*args, **kwargs)
def HasCapture(
*args, **kwargs)
HasCapture(self) -> bool
Returns true if this window has the current mouse capture.
def HasCapture(*args, **kwargs): """ HasCapture(self) -> bool Returns true if this window has the current mouse capture. """ return _core_.Window_HasCapture(*args, **kwargs)
def HasExtraStyle(
*args, **kwargs)
HasExtraStyle(self, int exFlag) -> bool
Returns True if the given extra flag is set.
def HasExtraStyle(*args, **kwargs): """ HasExtraStyle(self, int exFlag) -> bool Returns ``True`` if the given extra flag is set. """ return _core_.Window_HasExtraStyle(*args, **kwargs)
def HasFlag(
*args, **kwargs)
HasFlag(self, int flag) -> bool
Test if the given style is set for this window.
def HasFlag(*args, **kwargs): """ HasFlag(self, int flag) -> bool Test if the given style is set for this window. """ return _core_.Window_HasFlag(*args, **kwargs)
def HasFocus(
*args, **kwargs)
HasFocus(self) -> bool
Returns True if the window has the keyboard focus.
def HasFocus(*args, **kwargs): """ HasFocus(self) -> bool Returns ``True`` if the window has the keyboard focus. """ return _core_.Window_HasFocus(*args, **kwargs)
def HasMultiplePages(
*args, **kwargs)
HasMultiplePages(self) -> bool
def HasMultiplePages(*args, **kwargs): """HasMultiplePages(self) -> bool""" return _core_.Window_HasMultiplePages(*args, **kwargs)
def HasScrollbar(
*args, **kwargs)
HasScrollbar(self, int orient) -> bool
Does the window have the scrollbar for this orientation?
def HasScrollbar(*args, **kwargs): """ HasScrollbar(self, int orient) -> bool Does the window have the scrollbar for this orientation? """ return _core_.Window_HasScrollbar(*args, **kwargs)
def HasSelection(
*args, **kwargs)
HasSelection(self) -> bool
Returns True if there is a non-empty selection in the text field.
def HasSelection(*args, **kwargs): """ HasSelection(self) -> bool Returns True if there is a non-empty selection in the text field. """ return _core_.TextEntryBase_HasSelection(*args, **kwargs)
def HasTransparentBackground(
*args, **kwargs)
HasTransparentBackground(self) -> bool
Returns True if this window's background is transparent (as, for
example, for wx.StaticText) and should show the parent window's
background.
This method is mostly used internally by the library itself and you normally shouldn't have to call it. You may, however, have to override it in your custom control classes to ensure that background is painted correctly.
def HasTransparentBackground(*args, **kwargs): """ HasTransparentBackground(self) -> bool Returns True if this window's background is transparent (as, for example, for `wx.StaticText`) and should show the parent window's background. This method is mostly used internally by the library itself and you normally shouldn't have to call it. You may, however, have to override it in your custom control classes to ensure that background is painted correctly. """ return _core_.Window_HasTransparentBackground(*args, **kwargs)
def Hide(
*args, **kwargs)
Hide(self) -> bool
Equivalent to calling Show(False).
def Hide(*args, **kwargs): """ Hide(self) -> bool Equivalent to calling Show(False). """ return _core_.Window_Hide(*args, **kwargs)
def HideLines(
*args, **kwargs)
HideLines(self, int lineStart, int lineEnd)
Make a range of lines invisible.
def HideLines(*args, **kwargs): """ HideLines(self, int lineStart, int lineEnd) Make a range of lines invisible. """ return _stc.StyledTextCtrl_HideLines(*args, **kwargs)
def HideSelection(
*args, **kwargs)
HideSelection(self, bool normal)
Draw the selection in normal style or with selection highlighted.
def HideSelection(*args, **kwargs): """ HideSelection(self, bool normal) Draw the selection in normal style or with selection highlighted. """ return _stc.StyledTextCtrl_HideSelection(*args, **kwargs)
def HideWithEffect(
*args, **kwargs)
HideWithEffect(self, int effect, unsigned int timeout=0) -> bool
Hide the window with a special effect, not implemented on most platforms (where it is the same as Hide())
Timeout specifies how long the animation should take, in ms, the default value of 0 means to use the default (system-dependent) value.
def HideWithEffect(*args, **kwargs): """ HideWithEffect(self, int effect, unsigned int timeout=0) -> bool Hide the window with a special effect, not implemented on most platforms (where it is the same as Hide()) Timeout specifies how long the animation should take, in ms, the default value of 0 means to use the default (system-dependent) value. """ return _core_.Window_HideWithEffect(*args, **kwargs)
def HitTest(
*args, **kwargs)
HitTest(self, Point pt) -> int
Test where the given (in client coords) point lies
def HitTest(*args, **kwargs): """ HitTest(self, Point pt) -> int Test where the given (in client coords) point lies """ return _core_.Window_HitTest(*args, **kwargs)
def HitTestPos(
*args, **kwargs)
HitTestPos(Point pt) -> (result, position)
Find the character position in the text coresponding to the point given in pixels. NB: pt is in device coords but is not adjusted for the client area origin nor scrolling.
def HitTestPos(*args, **kwargs): """ HitTestPos(Point pt) -> (result, position) Find the character position in the text coresponding to the point given in pixels. NB: pt is in device coords but is not adjusted for the client area origin nor scrolling. """ return _core_.TextAreaBase_HitTestPos(*args, **kwargs)
def HitTestXY(
*args, **kwargs)
HitTestXY(self, int x, int y) -> int
Test where the given (in client coords) point lies
def HitTestXY(*args, **kwargs): """ HitTestXY(self, int x, int y) -> int Test where the given (in client coords) point lies """ return _core_.Window_HitTestXY(*args, **kwargs)
def Home(
*args, **kwargs)
Home(self)
Move caret to first position on line.
def Home(*args, **kwargs): """ Home(self) Move caret to first position on line. """ return _stc.StyledTextCtrl_Home(*args, **kwargs)
def HomeDisplay(
*args, **kwargs)
HomeDisplay(self)
Move caret to first position on display line.
def HomeDisplay(*args, **kwargs): """ HomeDisplay(self) Move caret to first position on display line. """ return _stc.StyledTextCtrl_HomeDisplay(*args, **kwargs)
def HomeDisplayExtend(
*args, **kwargs)
HomeDisplayExtend(self)
Move caret to first position on display line extending selection to new caret position.
def HomeDisplayExtend(*args, **kwargs): """ HomeDisplayExtend(self) Move caret to first position on display line extending selection to new caret position. """ return _stc.StyledTextCtrl_HomeDisplayExtend(*args, **kwargs)
def HomeExtend(
*args, **kwargs)
HomeExtend(self)
Move caret to first position on line extending selection to new caret position.
def HomeExtend(*args, **kwargs): """ HomeExtend(self) Move caret to first position on line extending selection to new caret position. """ return _stc.StyledTextCtrl_HomeExtend(*args, **kwargs)
def HomeRectExtend(
*args, **kwargs)
HomeRectExtend(self)
Move caret to first position on line, extending rectangular selection to new caret position.
def HomeRectExtend(*args, **kwargs): """ HomeRectExtend(self) Move caret to first position on line, extending rectangular selection to new caret position. """ return _stc.StyledTextCtrl_HomeRectExtend(*args, **kwargs)
def 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)?.
def 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)?. """ return _stc.StyledTextCtrl_HomeWrap(*args, **kwargs)
def HomeWrapExtend(
*args, **kwargs)
HomeWrapExtend(self)
def HomeWrapExtend(*args, **kwargs): """HomeWrapExtend(self)""" return _stc.StyledTextCtrl_HomeWrapExtend(*args, **kwargs)
def IndicatorAllOnFor(
*args, **kwargs)
IndicatorAllOnFor(self, int position) -> int
Are any indicators present at position?
def IndicatorAllOnFor(*args, **kwargs): """ IndicatorAllOnFor(self, int position) -> int Are any indicators present at position? """ return _stc.StyledTextCtrl_IndicatorAllOnFor(*args, **kwargs)
def IndicatorClearRange(
*args, **kwargs)
IndicatorClearRange(self, int position, int clearLength)
Turn a indicator off over a range.
def IndicatorClearRange(*args, **kwargs): """ IndicatorClearRange(self, int position, int clearLength) Turn a indicator off over a range. """ return _stc.StyledTextCtrl_IndicatorClearRange(*args, **kwargs)
def IndicatorEnd(
*args, **kwargs)
IndicatorEnd(self, int indicator, int position) -> int
Where does a particular indicator end?
def IndicatorEnd(*args, **kwargs): """ IndicatorEnd(self, int indicator, int position) -> int Where does a particular indicator end? """ return _stc.StyledTextCtrl_IndicatorEnd(*args, **kwargs)
def IndicatorFillRange(
*args, **kwargs)
IndicatorFillRange(self, int position, int fillLength)
Turn a indicator on over a range.
def IndicatorFillRange(*args, **kwargs): """ IndicatorFillRange(self, int position, int fillLength) Turn a indicator on over a range. """ return _stc.StyledTextCtrl_IndicatorFillRange(*args, **kwargs)
def IndicatorGetAlpha(
*args, **kwargs)
IndicatorGetAlpha(self, int indicator) -> int
Get the alpha fill colour of the given indicator.
def IndicatorGetAlpha(*args, **kwargs): """ IndicatorGetAlpha(self, int indicator) -> int Get the alpha fill colour of the given indicator. """ return _stc.StyledTextCtrl_IndicatorGetAlpha(*args, **kwargs)
def IndicatorGetForeground(
*args, **kwargs)
IndicatorGetForeground(self, int indic) -> Colour
Retrieve the foreground colour of an indicator.
def IndicatorGetForeground(*args, **kwargs): """ IndicatorGetForeground(self, int indic) -> Colour Retrieve the foreground colour of an indicator. """ return _stc.StyledTextCtrl_IndicatorGetForeground(*args, **kwargs)
def IndicatorGetOutlineAlpha(
*args, **kwargs)
IndicatorGetOutlineAlpha(self, int indicator) -> int
def IndicatorGetOutlineAlpha(*args, **kwargs): """IndicatorGetOutlineAlpha(self, int indicator) -> int""" return _stc.StyledTextCtrl_IndicatorGetOutlineAlpha(*args, **kwargs)
def IndicatorGetStyle(
*args, **kwargs)
IndicatorGetStyle(self, int indic) -> int
Retrieve the style of an indicator.
def IndicatorGetStyle(*args, **kwargs): """ IndicatorGetStyle(self, int indic) -> int Retrieve the style of an indicator. """ return _stc.StyledTextCtrl_IndicatorGetStyle(*args, **kwargs)
def IndicatorGetUnder(
*args, **kwargs)
IndicatorGetUnder(self, int indic) -> bool
Retrieve whether indicator drawn under or over text.
def IndicatorGetUnder(*args, **kwargs): """ IndicatorGetUnder(self, int indic) -> bool Retrieve whether indicator drawn under or over text. """ return _stc.StyledTextCtrl_IndicatorGetUnder(*args, **kwargs)
def IndicatorSetAlpha(
*args, **kwargs)
IndicatorSetAlpha(self, int indicator, int alpha)
Set the alpha fill colour of the given indicator.
def IndicatorSetAlpha(*args, **kwargs): """ IndicatorSetAlpha(self, int indicator, int alpha) Set the alpha fill colour of the given indicator. """ return _stc.StyledTextCtrl_IndicatorSetAlpha(*args, **kwargs)
def IndicatorSetForeground(
*args, **kwargs)
IndicatorSetForeground(self, int indic, Colour fore)
Set the foreground colour of an indicator.
def IndicatorSetForeground(*args, **kwargs): """ IndicatorSetForeground(self, int indic, Colour fore) Set the foreground colour of an indicator. """ return _stc.StyledTextCtrl_IndicatorSetForeground(*args, **kwargs)
def IndicatorSetOutlineAlpha(
*args, **kwargs)
IndicatorSetOutlineAlpha(self, int indicator, int alpha)
def IndicatorSetOutlineAlpha(*args, **kwargs): """IndicatorSetOutlineAlpha(self, int indicator, int alpha)""" return _stc.StyledTextCtrl_IndicatorSetOutlineAlpha(*args, **kwargs)
def IndicatorSetStyle(
*args, **kwargs)
IndicatorSetStyle(self, int indic, int style)
Set an indicator to plain, squiggle or TT.
def IndicatorSetStyle(*args, **kwargs): """ IndicatorSetStyle(self, int indic, int style) Set an indicator to plain, squiggle or TT. """ return _stc.StyledTextCtrl_IndicatorSetStyle(*args, **kwargs)
def IndicatorSetUnder(
*args, **kwargs)
IndicatorSetUnder(self, int indic, bool under)
Set an indicator to draw under text or over(default).
def IndicatorSetUnder(*args, **kwargs): """ IndicatorSetUnder(self, int indic, bool under) Set an indicator to draw under text or over(default). """ return _stc.StyledTextCtrl_IndicatorSetUnder(*args, **kwargs)
def IndicatorStart(
*args, **kwargs)
IndicatorStart(self, int indicator, int position) -> int
Where does a particular indicator start?
def IndicatorStart(*args, **kwargs): """ IndicatorStart(self, int indicator, int position) -> int Where does a particular indicator start? """ return _stc.StyledTextCtrl_IndicatorStart(*args, **kwargs)
def IndicatorValueAt(
*args, **kwargs)
IndicatorValueAt(self, int indicator, int position) -> int
What value does a particular indicator have at at a position?
def IndicatorValueAt(*args, **kwargs): """ IndicatorValueAt(self, int indicator, int position) -> int What value does a particular indicator have at at a position? """ return _stc.StyledTextCtrl_IndicatorValueAt(*args, **kwargs)
def InformFirstDirection(
*args, **kwargs)
InformFirstDirection(self, int direction, int size, int availableOtherDir) -> bool
wxSizer and friends use this to give a chance to a component to recalc its min size once one of the final size components is known. Override this function when that is useful (such as for wxStaticText which can stretch over several lines). Parameter availableOtherDir tells the item how much more space there is available in the opposite direction (-1 if unknown).
def InformFirstDirection(*args, **kwargs): """ InformFirstDirection(self, int direction, int size, int availableOtherDir) -> bool wxSizer and friends use this to give a chance to a component to recalc its min size once one of the final size components is known. Override this function when that is useful (such as for wxStaticText which can stretch over several lines). Parameter availableOtherDir tells the item how much more space there is available in the opposite direction (-1 if unknown). """ return _core_.Window_InformFirstDirection(*args, **kwargs)
def InheritAttributes(
*args, **kwargs)
InheritAttributes(self)
This function is (or should be, in case of custom controls) called during window creation to intelligently set up the window visual attributes, that is the font and the foreground and background colours.
By 'intelligently' the following is meant: by default, all windows use their own default attributes. However if some of the parent's attributes are explicitly changed (that is, using SetFont and not SetOwnFont) and if the corresponding attribute hadn't been explicitly set for this window itself, then this window takes the same value as used by the parent. In addition, if the window overrides ShouldInheritColours to return false, the colours will not be changed no matter what and only the font might.
This rather complicated logic is necessary in order to accommodate the different usage scenarios. The most common one is when all default attributes are used and in this case, nothing should be inherited as in modern GUIs different controls use different fonts (and colours) than their siblings so they can't inherit the same value from the parent. However it was also deemed desirable to allow to simply change the attributes of all children at once by just changing the font or colour of their common parent, hence in this case we do inherit the parents attributes.
def InheritAttributes(*args, **kwargs): """ InheritAttributes(self) This function is (or should be, in case of custom controls) called during window creation to intelligently set up the window visual attributes, that is the font and the foreground and background colours. By 'intelligently' the following is meant: by default, all windows use their own default attributes. However if some of the parent's attributes are explicitly changed (that is, using SetFont and not SetOwnFont) and if the corresponding attribute hadn't been explicitly set for this window itself, then this window takes the same value as used by the parent. In addition, if the window overrides ShouldInheritColours to return false, the colours will not be changed no matter what and only the font might. This rather complicated logic is necessary in order to accommodate the different usage scenarios. The most common one is when all default attributes are used and in this case, nothing should be inherited as in modern GUIs different controls use different fonts (and colours) than their siblings so they can't inherit the same value from the parent. However it was also deemed desirable to allow to simply change the attributes of all children at once by just changing the font or colour of their common parent, hence in this case we do inherit the parents attributes. """ return _core_.Window_InheritAttributes(*args, **kwargs)
def InheritsBackgroundColour(
*args, **kwargs)
InheritsBackgroundColour(self) -> bool
def InheritsBackgroundColour(*args, **kwargs): """InheritsBackgroundColour(self) -> bool""" return _core_.Window_InheritsBackgroundColour(*args, **kwargs)
def InitDialog(
*args, **kwargs)
InitDialog(self)
Sends an EVT_INIT_DIALOG event, whose handler usually transfers data to the dialog via validators.
def InitDialog(*args, **kwargs): """ InitDialog(self) Sends an EVT_INIT_DIALOG event, whose handler usually transfers data to the dialog via validators. """ return _core_.Window_InitDialog(*args, **kwargs)
def InsertText(
*args, **kwargs)
InsertText(self, int pos, String text)
Insert string at a position.
def InsertText(*args, **kwargs): """ InsertText(self, int pos, String text) Insert string at a position. """ return _stc.StyledTextCtrl_InsertText(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_InsertTextRaw(*args, **kwargs)
def InsertTextUTF8(
self, pos, text)
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.
def InsertTextUTF8(self, pos, text): """ 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. """ if not wx.USE_UNICODE: u = text.decode('utf-8') text = u.encode(wx.GetDefaultPyEncoding()) self.InsertTextRaw(pos, text)
def InvalidateBestSize(
*args, **kwargs)
InvalidateBestSize(self)
Reset the cached best size value so it will be recalculated the next time it is needed.
def InvalidateBestSize(*args, **kwargs): """ InvalidateBestSize(self) Reset the cached best size value so it will be recalculated the next time it is needed. """ return _core_.Window_InvalidateBestSize(*args, **kwargs)
def IsBeingDeleted(
*args, **kwargs)
IsBeingDeleted(self) -> bool
Is the window in the process of being deleted?
def IsBeingDeleted(*args, **kwargs): """ IsBeingDeleted(self) -> bool Is the window in the process of being deleted? """ return _core_.Window_IsBeingDeleted(*args, **kwargs)
def IsDoubleBuffered(
*args, **kwargs)
IsDoubleBuffered(self) -> bool
Returns True if the window contents is double-buffered by the
system, i.e. if any drawing done on the window is really done on a
temporary backing surface and transferred to the screen all at once
later.
def IsDoubleBuffered(*args, **kwargs): """ IsDoubleBuffered(self) -> bool Returns ``True`` if the window contents is double-buffered by the system, i.e. if any drawing done on the window is really done on a temporary backing surface and transferred to the screen all at once later. """ return _core_.Window_IsDoubleBuffered(*args, **kwargs)
def IsEditable(
*args, **kwargs)
IsEditable(self) -> bool
def IsEditable(*args, **kwargs): """IsEditable(self) -> bool""" return _core_.TextEntryBase_IsEditable(*args, **kwargs)
def IsEmpty(
*args, **kwargs)
IsEmpty(self) -> bool
Returns True if the value in the text field is empty.
def IsEmpty(*args, **kwargs): """ IsEmpty(self) -> bool Returns True if the value in the text field is empty. """ return _core_.TextEntryBase_IsEmpty(*args, **kwargs)
def IsEnabled(
*args, **kwargs)
IsEnabled(self) -> bool
Returns true if the window is enabled for input, false otherwise. This method takes into account the enabled state of parent windows up to the top-level window.
def IsEnabled(*args, **kwargs): """ IsEnabled(self) -> bool Returns true if the window is enabled for input, false otherwise. This method takes into account the enabled state of parent windows up to the top-level window. """ return _core_.Window_IsEnabled(*args, **kwargs)
def IsExposed(
*args, **kwargs)
IsExposed(self, int x, int y, int w=1, int h=1) -> bool
Returns true if the given point or rectangle area has been exposed since the last repaint. Call this in an paint event handler to optimize redrawing by only redrawing those areas, which have been exposed.
def IsExposed(*args, **kwargs): """ IsExposed(self, int x, int y, int w=1, int h=1) -> bool Returns true if the given point or rectangle area has been exposed since the last repaint. Call this in an paint event handler to optimize redrawing by only redrawing those areas, which have been exposed. """ return _core_.Window_IsExposed(*args, **kwargs)
def IsExposedPoint(
*args, **kwargs)
IsExposedPoint(self, Point pt) -> bool
Returns true if the given point or rectangle area has been exposed since the last repaint. Call this in an paint event handler to optimize redrawing by only redrawing those areas, which have been exposed.
def IsExposedPoint(*args, **kwargs): """ IsExposedPoint(self, Point pt) -> bool Returns true if the given point or rectangle area has been exposed since the last repaint. Call this in an paint event handler to optimize redrawing by only redrawing those areas, which have been exposed. """ return _core_.Window_IsExposedPoint(*args, **kwargs)
def IsExposedRect(
*args, **kwargs)
IsExposedRect(self, Rect rect) -> bool
Returns true if the given point or rectangle area has been exposed since the last repaint. Call this in an paint event handler to optimize redrawing by only redrawing those areas, which have been exposed.
def IsExposedRect(*args, **kwargs): """ IsExposedRect(self, Rect rect) -> bool Returns true if the given point or rectangle area has been exposed since the last repaint. Call this in an paint event handler to optimize redrawing by only redrawing those areas, which have been exposed. """ return _core_.Window_IsExposedRect(*args, **kwargs)
def IsFrozen(
*args, **kwargs)
IsFrozen(self) -> bool
Returns True if the window has been frozen and not thawed yet.
:see: Freeze and Thaw
def IsFrozen(*args, **kwargs): """ IsFrozen(self) -> bool Returns ``True`` if the window has been frozen and not thawed yet. :see: `Freeze` and `Thaw` """ return _core_.Window_IsFrozen(*args, **kwargs)
def IsModified(
*args, **kwargs)
IsModified(self) -> bool
def IsModified(*args, **kwargs): """IsModified(self) -> bool""" return _core_.TextAreaBase_IsModified(*args, **kwargs)
def IsRetained(
*args, **kwargs)
IsRetained(self) -> bool
Returns true if the window is retained, false otherwise. Retained windows are only available on X platforms.
def IsRetained(*args, **kwargs): """ IsRetained(self) -> bool Returns true if the window is retained, false otherwise. Retained windows are only available on X platforms. """ return _core_.Window_IsRetained(*args, **kwargs)
def IsSameAs(
*args, **kwargs)
IsSameAs(self, Object p) -> bool
For wx.Objects that use C++ reference counting internally, this method can be used to determine if two objects are referencing the same data object.
def IsSameAs(*args, **kwargs): """ IsSameAs(self, Object p) -> bool For wx.Objects that use C++ reference counting internally, this method can be used to determine if two objects are referencing the same data object. """ return _core_.Object_IsSameAs(*args, **kwargs)
def IsScrollbarAlwaysShown(
*args, **kwargs)
IsScrollbarAlwaysShown(self, int orient) -> bool
def IsScrollbarAlwaysShown(*args, **kwargs): """IsScrollbarAlwaysShown(self, int orient) -> bool""" return _core_.Window_IsScrollbarAlwaysShown(*args, **kwargs)
def IsShown(
*args, **kwargs)
IsShown(self) -> bool
Returns true if the window is shown, false if it has been hidden.
def IsShown(*args, **kwargs): """ IsShown(self) -> bool Returns true if the window is shown, false if it has been hidden. """ return _core_.Window_IsShown(*args, **kwargs)
def IsShownOnScreen(
*args, **kwargs)
IsShownOnScreen(self) -> bool
Returns True if the window is physically visible on the screen,
i.e. it is shown and all its parents up to the toplevel window are
shown as well.
def IsShownOnScreen(*args, **kwargs): """ IsShownOnScreen(self) -> bool Returns ``True`` if the window is physically visible on the screen, i.e. it is shown and all its parents up to the toplevel window are shown as well. """ return _core_.Window_IsShownOnScreen(*args, **kwargs)
def IsThisEnabled(
*args, **kwargs)
IsThisEnabled(self) -> bool
Returns the internal enabled state independent of the parent(s) state,
i.e. the state in which the window would be if all of its parents are
enabled. Use IsEnabled to get the effective window state.
def IsThisEnabled(*args, **kwargs): """ IsThisEnabled(self) -> bool Returns the internal enabled state independent of the parent(s) state, i.e. the state in which the window would be if all of its parents are enabled. Use `IsEnabled` to get the effective window state. """ return _core_.Window_IsThisEnabled(*args, **kwargs)
def IsTopLevel(
*args, **kwargs)
IsTopLevel(self) -> bool
Returns true if the given window is a top-level one. Currently all frames and dialogs are always considered to be top-level windows (even if they have a parent window).
def IsTopLevel(*args, **kwargs): """ IsTopLevel(self) -> bool Returns true if the given window is a top-level one. Currently all frames and dialogs are always considered to be top-level windows (even if they have a parent window). """ return _core_.Window_IsTopLevel(*args, **kwargs)
def IsUnlinked(
*args, **kwargs)
IsUnlinked(self) -> bool
def IsUnlinked(*args, **kwargs): """IsUnlinked(self) -> bool""" return _core_.EvtHandler_IsUnlinked(*args, **kwargs)
def Layout(
*args, **kwargs)
Layout(self) -> bool
Invokes the constraint-based layout algorithm or the sizer-based algorithm for this window. See SetAutoLayout: when auto layout is on, this function gets called automatically by the default EVT_SIZE handler when the window is resized.
def Layout(*args, **kwargs): """ Layout(self) -> bool Invokes the constraint-based layout algorithm or the sizer-based algorithm for this window. See SetAutoLayout: when auto layout is on, this function gets called automatically by the default EVT_SIZE handler when the window is resized. """ return _core_.Window_Layout(*args, **kwargs)
def LineCopy(
*args, **kwargs)
LineCopy(self)
Copy the line containing the caret.
def LineCopy(*args, **kwargs): """ LineCopy(self) Copy the line containing the caret. """ return _stc.StyledTextCtrl_LineCopy(*args, **kwargs)
def LineCut(
*args, **kwargs)
LineCut(self)
Cut the line containing the caret.
def LineCut(*args, **kwargs): """ LineCut(self) Cut the line containing the caret. """ return _stc.StyledTextCtrl_LineCut(*args, **kwargs)
def LineDelete(
*args, **kwargs)
LineDelete(self)
Delete the line containing the caret.
def LineDelete(*args, **kwargs): """ LineDelete(self) Delete the line containing the caret. """ return _stc.StyledTextCtrl_LineDelete(*args, **kwargs)
def LineDown(
*args, **kwargs)
LineDown(self)
Move caret down one line.
def LineDown(*args, **kwargs): """ LineDown(self) Move caret down one line. """ return _stc.StyledTextCtrl_LineDown(*args, **kwargs)
def LineDownExtend(
*args, **kwargs)
LineDownExtend(self)
Move caret down one line extending selection to new caret position.
def LineDownExtend(*args, **kwargs): """ LineDownExtend(self) Move caret down one line extending selection to new caret position. """ return _stc.StyledTextCtrl_LineDownExtend(*args, **kwargs)
def LineDownRectExtend(
*args, **kwargs)
LineDownRectExtend(self)
Move caret down one line, extending rectangular selection to new caret position.
def LineDownRectExtend(*args, **kwargs): """ LineDownRectExtend(self) Move caret down one line, extending rectangular selection to new caret position. """ return _stc.StyledTextCtrl_LineDownRectExtend(*args, **kwargs)
def LineDuplicate(
*args, **kwargs)
LineDuplicate(self)
Duplicate the current line.
def LineDuplicate(*args, **kwargs): """ LineDuplicate(self) Duplicate the current line. """ return _stc.StyledTextCtrl_LineDuplicate(*args, **kwargs)
def LineEnd(
*args, **kwargs)
LineEnd(self)
Move caret to last position on line.
def LineEnd(*args, **kwargs): """ LineEnd(self) Move caret to last position on line. """ return _stc.StyledTextCtrl_LineEnd(*args, **kwargs)
def LineEndDisplay(
*args, **kwargs)
LineEndDisplay(self)
Move caret to last position on display line.
def LineEndDisplay(*args, **kwargs): """ LineEndDisplay(self) Move caret to last position on display line. """ return _stc.StyledTextCtrl_LineEndDisplay(*args, **kwargs)
def LineEndDisplayExtend(
*args, **kwargs)
LineEndDisplayExtend(self)
Move caret to last position on display line extending selection to new caret position.
def LineEndDisplayExtend(*args, **kwargs): """ LineEndDisplayExtend(self) Move caret to last position on display line extending selection to new caret position. """ return _stc.StyledTextCtrl_LineEndDisplayExtend(*args, **kwargs)
def LineEndExtend(
*args, **kwargs)
LineEndExtend(self)
Move caret to last position on line extending selection to new caret position.
def LineEndExtend(*args, **kwargs): """ LineEndExtend(self) Move caret to last position on line extending selection to new caret position. """ return _stc.StyledTextCtrl_LineEndExtend(*args, **kwargs)
def LineEndRectExtend(
*args, **kwargs)
LineEndRectExtend(self)
Move caret to last position on line, extending rectangular selection to new caret position.
def LineEndRectExtend(*args, **kwargs): """ LineEndRectExtend(self) Move caret to last position on line, extending rectangular selection to new caret position. """ return _stc.StyledTextCtrl_LineEndRectExtend(*args, **kwargs)
def LineEndWrap(
*args, **kwargs)
LineEndWrap(self)
def LineEndWrap(*args, **kwargs): """LineEndWrap(self)""" return _stc.StyledTextCtrl_LineEndWrap(*args, **kwargs)
def LineEndWrapExtend(
*args, **kwargs)
LineEndWrapExtend(self)
def LineEndWrapExtend(*args, **kwargs): """LineEndWrapExtend(self)""" return _stc.StyledTextCtrl_LineEndWrapExtend(*args, **kwargs)
def LineFromPosition(
*args, **kwargs)
LineFromPosition(self, int pos) -> int
Retrieve the line containing a position.
def LineFromPosition(*args, **kwargs): """ LineFromPosition(self, int pos) -> int Retrieve the line containing a position. """ return _stc.StyledTextCtrl_LineFromPosition(*args, **kwargs)
def LineLength(
*args, **kwargs)
LineLength(self, int line) -> int
How many characters are on a line, including end of line characters?
def LineLength(*args, **kwargs): """ LineLength(self, int line) -> int How many characters are on a line, including end of line characters? """ return _stc.StyledTextCtrl_LineLength(*args, **kwargs)
def LineScroll(
*args, **kwargs)
LineScroll(self, int columns, int lines)
Scroll horizontally and vertically.
def LineScroll(*args, **kwargs): """ LineScroll(self, int columns, int lines) Scroll horizontally and vertically. """ return _stc.StyledTextCtrl_LineScroll(*args, **kwargs)
def LineScrollDown(
*args, **kwargs)
LineScrollDown(self)
Scroll the document down, keeping the caret visible.
def LineScrollDown(*args, **kwargs): """ LineScrollDown(self) Scroll the document down, keeping the caret visible. """ return _stc.StyledTextCtrl_LineScrollDown(*args, **kwargs)
def LineScrollUp(
*args, **kwargs)
LineScrollUp(self)
Scroll the document up, keeping the caret visible.
def LineScrollUp(*args, **kwargs): """ LineScrollUp(self) Scroll the document up, keeping the caret visible. """ return _stc.StyledTextCtrl_LineScrollUp(*args, **kwargs)
def LineTranspose(
*args, **kwargs)
LineTranspose(self)
Switch the current line with the previous.
def LineTranspose(*args, **kwargs): """ LineTranspose(self) Switch the current line with the previous. """ return _stc.StyledTextCtrl_LineTranspose(*args, **kwargs)
def LineUp(
*args, **kwargs)
LineUp(self)
Move caret up one line.
def LineUp(*args, **kwargs): """ LineUp(self) Move caret up one line. """ return _stc.StyledTextCtrl_LineUp(*args, **kwargs)
def LineUpExtend(
*args, **kwargs)
LineUpExtend(self)
Move caret up one line extending selection to new caret position.
def LineUpExtend(*args, **kwargs): """ LineUpExtend(self) Move caret up one line extending selection to new caret position. """ return _stc.StyledTextCtrl_LineUpExtend(*args, **kwargs)
def LineUpRectExtend(
*args, **kwargs)
LineUpRectExtend(self)
Move caret up one line, extending rectangular selection to new caret position.
def LineUpRectExtend(*args, **kwargs): """ LineUpRectExtend(self) Move caret up one line, extending rectangular selection to new caret position. """ return _stc.StyledTextCtrl_LineUpRectExtend(*args, **kwargs)
def LinesJoin(
*args, **kwargs)
LinesJoin(self)
Join the lines in the target.
def LinesJoin(*args, **kwargs): """ LinesJoin(self) Join the lines in the target. """ return _stc.StyledTextCtrl_LinesJoin(*args, **kwargs)
def LinesOnScreen(
*args, **kwargs)
LinesOnScreen(self) -> int
Retrieves the number of lines completely visible.
def LinesOnScreen(*args, **kwargs): """ LinesOnScreen(self) -> int Retrieves the number of lines completely visible. """ return _stc.StyledTextCtrl_LinesOnScreen(*args, **kwargs)
def LinesSplit(
*args, **kwargs)
LinesSplit(self, int pixelWidth)
Split the lines in the target into lines that are less wide than pixelWidth where possible.
def LinesSplit(*args, **kwargs): """ LinesSplit(self, int pixelWidth) Split the lines in the target into lines that are less wide than pixelWidth where possible. """ return _stc.StyledTextCtrl_LinesSplit(*args, **kwargs)
def LoadFile(
*args, **kwargs)
LoadFile(self, String file, int fileType=wxTEXT_TYPE_ANY) -> bool
def LoadFile(*args, **kwargs): """LoadFile(self, String file, int fileType=wxTEXT_TYPE_ANY) -> bool""" return _core_.TextAreaBase_LoadFile(*args, **kwargs)
def Lower(
*args, **kwargs)
Lower(self)
Lowers the window to the bottom of the window hierarchy. In current version of wxWidgets this works both for managed and child windows.
def Lower(*args, **kwargs): """ Lower(self) Lowers the window to the bottom of the window hierarchy. In current version of wxWidgets this works both for managed and child windows. """ return _core_.Window_Lower(*args, **kwargs)
def LowerCase(
*args, **kwargs)
LowerCase(self)
Transform the selection to lower case.
def LowerCase(*args, **kwargs): """ LowerCase(self) Transform the selection to lower case. """ return _stc.StyledTextCtrl_LowerCase(*args, **kwargs)
def MakeModal(
*args, **kwargs)
MakeModal(self, bool modal=True)
Disables all other windows in the application so that the user can only interact with this window. Passing False will reverse this effect.
def MakeModal(*args, **kwargs): """ MakeModal(self, bool modal=True) Disables all other windows in the application so that the user can only interact with this window. Passing False will reverse this effect. """ return _core_.Window_MakeModal(*args, **kwargs)
def MarginGetStyle(
*args, **kwargs)
MarginGetStyle(self, int line) -> int
Get the style number for the text margin for a line
def MarginGetStyle(*args, **kwargs): """ MarginGetStyle(self, int line) -> int Get the style number for the text margin for a line """ return _stc.StyledTextCtrl_MarginGetStyle(*args, **kwargs)
def MarginGetStyleOffset(
*args, **kwargs)
MarginGetStyleOffset(self) -> int
Get the start of the range of style numbers used for margin text
def MarginGetStyleOffset(*args, **kwargs): """ MarginGetStyleOffset(self) -> int Get the start of the range of style numbers used for margin text """ return _stc.StyledTextCtrl_MarginGetStyleOffset(*args, **kwargs)
def MarginGetStyles(
*args, **kwargs)
MarginGetStyles(self, int line) -> String
Get the styles in the text margin for a line
def MarginGetStyles(*args, **kwargs): """ MarginGetStyles(self, int line) -> String Get the styles in the text margin for a line """ return _stc.StyledTextCtrl_MarginGetStyles(*args, **kwargs)
def MarginGetText(
*args, **kwargs)
MarginGetText(self, int line) -> String
Get the text in the text margin for a line
def MarginGetText(*args, **kwargs): """ MarginGetText(self, int line) -> String Get the text in the text margin for a line """ return _stc.StyledTextCtrl_MarginGetText(*args, **kwargs)
def MarginSetStyle(
*args, **kwargs)
MarginSetStyle(self, int line, int style)
Set the style number for the text margin for a line
def MarginSetStyle(*args, **kwargs): """ MarginSetStyle(self, int line, int style) Set the style number for the text margin for a line """ return _stc.StyledTextCtrl_MarginSetStyle(*args, **kwargs)
def MarginSetStyleOffset(
*args, **kwargs)
MarginSetStyleOffset(self, int style)
Get the start of the range of style numbers used for margin text
def MarginSetStyleOffset(*args, **kwargs): """ MarginSetStyleOffset(self, int style) Get the start of the range of style numbers used for margin text """ return _stc.StyledTextCtrl_MarginSetStyleOffset(*args, **kwargs)
def MarginSetStyles(
*args, **kwargs)
MarginSetStyles(self, int line, String styles)
Set the style in the text margin for a line
def MarginSetStyles(*args, **kwargs): """ MarginSetStyles(self, int line, String styles) Set the style in the text margin for a line """ return _stc.StyledTextCtrl_MarginSetStyles(*args, **kwargs)
def MarginSetText(
*args, **kwargs)
MarginSetText(self, int line, String text)
Set the text in the text margin for a line
def MarginSetText(*args, **kwargs): """ MarginSetText(self, int line, String text) Set the text in the text margin for a line """ return _stc.StyledTextCtrl_MarginSetText(*args, **kwargs)
def MarginTextClearAll(
*args, **kwargs)
MarginTextClearAll(self)
Clear the margin text on all lines
def MarginTextClearAll(*args, **kwargs): """ MarginTextClearAll(self) Clear the margin text on all lines """ return _stc.StyledTextCtrl_MarginTextClearAll(*args, **kwargs)
def MarkDirty(
*args, **kwargs)
MarkDirty(self)
def MarkDirty(*args, **kwargs): """MarkDirty(self)""" return _core_.TextAreaBase_MarkDirty(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_MarkerAdd(*args, **kwargs)
def MarkerAddSet(
*args, **kwargs)
MarkerAddSet(self, int line, int set)
Add a set of markers to a line.
def MarkerAddSet(*args, **kwargs): """ MarkerAddSet(self, int line, int set) Add a set of markers to a line. """ return _stc.StyledTextCtrl_MarkerAddSet(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_MarkerDefine(*args, **kwargs)
def MarkerDefineBitmap(
*args, **kwargs)
MarkerDefineBitmap(self, int markerNumber, Bitmap bmp)
Define a marker from a bitmap
def MarkerDefineBitmap(*args, **kwargs): """ MarkerDefineBitmap(self, int markerNumber, Bitmap bmp) Define a marker from a bitmap """ return _stc.StyledTextCtrl_MarkerDefineBitmap(*args, **kwargs)
def MarkerDefineRGBAImage(
*args, **kwargs)
MarkerDefineRGBAImage(self, int markerNumber, unsigned char pixels)
def MarkerDefineRGBAImage(*args, **kwargs): """MarkerDefineRGBAImage(self, int markerNumber, unsigned char pixels)""" return _stc.StyledTextCtrl_MarkerDefineRGBAImage(*args, **kwargs)
def MarkerDelete(
*args, **kwargs)
MarkerDelete(self, int line, int markerNumber)
Delete a marker from a line.
def MarkerDelete(*args, **kwargs): """ MarkerDelete(self, int line, int markerNumber) Delete a marker from a line. """ return _stc.StyledTextCtrl_MarkerDelete(*args, **kwargs)
def MarkerDeleteAll(
*args, **kwargs)
MarkerDeleteAll(self, int markerNumber)
Delete all markers with a particular number from all lines.
def MarkerDeleteAll(*args, **kwargs): """ MarkerDeleteAll(self, int markerNumber) Delete all markers with a particular number from all lines. """ return _stc.StyledTextCtrl_MarkerDeleteAll(*args, **kwargs)
def MarkerDeleteHandle(
*args, **kwargs)
MarkerDeleteHandle(self, int handle)
Delete a marker.
def MarkerDeleteHandle(*args, **kwargs): """ MarkerDeleteHandle(self, int handle) Delete a marker. """ return _stc.StyledTextCtrl_MarkerDeleteHandle(*args, **kwargs)
def MarkerEnableHighlight(
*args, **kwargs)
MarkerEnableHighlight(self, bool enabled)
def MarkerEnableHighlight(*args, **kwargs): """MarkerEnableHighlight(self, bool enabled)""" return _stc.StyledTextCtrl_MarkerEnableHighlight(*args, **kwargs)
def MarkerGet(
*args, **kwargs)
MarkerGet(self, int line) -> int
Get a bit mask of all the markers set on a line.
def MarkerGet(*args, **kwargs): """ MarkerGet(self, int line) -> int Get a bit mask of all the markers set on a line. """ return _stc.StyledTextCtrl_MarkerGet(*args, **kwargs)
def MarkerLineFromHandle(
*args, **kwargs)
MarkerLineFromHandle(self, int handle) -> int
Retrieve the line number at which a particular marker is located.
def MarkerLineFromHandle(*args, **kwargs): """ MarkerLineFromHandle(self, int handle) -> int Retrieve the line number at which a particular marker is located. """ return _stc.StyledTextCtrl_MarkerLineFromHandle(*args, **kwargs)
def MarkerNext(
*args, **kwargs)
MarkerNext(self, int lineStart, int markerMask) -> int
Find the next line after lineStart that includes a marker in mask.
def MarkerNext(*args, **kwargs): """ MarkerNext(self, int lineStart, int markerMask) -> int Find the next line after lineStart that includes a marker in mask. """ return _stc.StyledTextCtrl_MarkerNext(*args, **kwargs)
def MarkerPrevious(
*args, **kwargs)
MarkerPrevious(self, int lineStart, int markerMask) -> int
Find the previous line before lineStart that includes a marker in mask.
def MarkerPrevious(*args, **kwargs): """ MarkerPrevious(self, int lineStart, int markerMask) -> int Find the previous line before lineStart that includes a marker in mask. """ return _stc.StyledTextCtrl_MarkerPrevious(*args, **kwargs)
def MarkerSetAlpha(
*args, **kwargs)
MarkerSetAlpha(self, int markerNumber, int alpha)
Set the alpha used for a marker that is drawn in the text area, not the margin.
def MarkerSetAlpha(*args, **kwargs): """ MarkerSetAlpha(self, int markerNumber, int alpha) Set the alpha used for a marker that is drawn in the text area, not the margin. """ return _stc.StyledTextCtrl_MarkerSetAlpha(*args, **kwargs)
def MarkerSetBackground(
*args, **kwargs)
MarkerSetBackground(self, int markerNumber, Colour back)
Set the background colour used for a particular marker number.
def MarkerSetBackground(*args, **kwargs): """ MarkerSetBackground(self, int markerNumber, Colour back) Set the background colour used for a particular marker number. """ return _stc.StyledTextCtrl_MarkerSetBackground(*args, **kwargs)
def MarkerSetBackgroundSelected(
*args, **kwargs)
MarkerSetBackgroundSelected(self, int markerNumber, Colour back)
def MarkerSetBackgroundSelected(*args, **kwargs): """MarkerSetBackgroundSelected(self, int markerNumber, Colour back)""" return _stc.StyledTextCtrl_MarkerSetBackgroundSelected(*args, **kwargs)
def MarkerSetForeground(
*args, **kwargs)
MarkerSetForeground(self, int markerNumber, Colour fore)
Set the foreground colour used for a particular marker number.
def MarkerSetForeground(*args, **kwargs): """ MarkerSetForeground(self, int markerNumber, Colour fore) Set the foreground colour used for a particular marker number. """ return _stc.StyledTextCtrl_MarkerSetForeground(*args, **kwargs)
def Move(
*args, **kwargs)
Move(self, Point pt, int flags=SIZE_USE_EXISTING)
Moves the window to the given position.
def Move(*args, **kwargs): """ Move(self, Point pt, int flags=SIZE_USE_EXISTING) Moves the window to the given position. """ return _core_.Window_Move(*args, **kwargs)
def MoveAfterInTabOrder(
*args, **kwargs)
MoveAfterInTabOrder(self, Window win)
Moves this window in the tab navigation order after the specified sibling window. This means that when the user presses the TAB key on that other window, the focus switches to this window.
The default tab order is the same as creation order. This function
and MoveBeforeInTabOrder allow to change it after creating all the
windows.
def MoveAfterInTabOrder(*args, **kwargs): """ MoveAfterInTabOrder(self, Window win) Moves this window in the tab navigation order after the specified sibling window. This means that when the user presses the TAB key on that other window, the focus switches to this window. The default tab order is the same as creation order. This function and `MoveBeforeInTabOrder` allow to change it after creating all the windows. """ return _core_.Window_MoveAfterInTabOrder(*args, **kwargs)
def MoveBeforeInTabOrder(
*args, **kwargs)
MoveBeforeInTabOrder(self, Window win)
Same as MoveAfterInTabOrder except that it inserts this window just
before win instead of putting it right after it.
def MoveBeforeInTabOrder(*args, **kwargs): """ MoveBeforeInTabOrder(self, Window win) Same as `MoveAfterInTabOrder` except that it inserts this window just before win instead of putting it right after it. """ return _core_.Window_MoveBeforeInTabOrder(*args, **kwargs)
def MoveCaretInsideView(
*args, **kwargs)
MoveCaretInsideView(self)
Move the caret inside current view if it's not there already.
def MoveCaretInsideView(*args, **kwargs): """ MoveCaretInsideView(self) Move the caret inside current view if it's not there already. """ return _stc.StyledTextCtrl_MoveCaretInsideView(*args, **kwargs)
def MoveSelectedLinesDown(
*args, **kwargs)
MoveSelectedLinesDown(self)
def MoveSelectedLinesDown(*args, **kwargs): """MoveSelectedLinesDown(self)""" return _stc.StyledTextCtrl_MoveSelectedLinesDown(*args, **kwargs)
def MoveSelectedLinesUp(
*args, **kwargs)
MoveSelectedLinesUp(self)
def MoveSelectedLinesUp(*args, **kwargs): """MoveSelectedLinesUp(self)""" return _stc.StyledTextCtrl_MoveSelectedLinesUp(*args, **kwargs)
def MoveXY(
*args, **kwargs)
MoveXY(self, int x, int y, int flags=SIZE_USE_EXISTING)
Moves the window to the given position.
def MoveXY(*args, **kwargs): """ MoveXY(self, int x, int y, int flags=SIZE_USE_EXISTING) Moves the window to the given position. """ return _core_.Window_MoveXY(*args, **kwargs)
Navigate(self, int flags=NavigationKeyEvent.IsForward) -> bool
Does keyboard navigation starting from this window to another. This is equivalient to self.GetParent().NavigateIn().
NavigateIn(self, int flags=NavigationKeyEvent.IsForward) -> bool
Navigates inside this window.
def NewLine(
*args, **kwargs)
NewLine(self)
Insert a new line, may use a CRLF, CR or LF depending on EOL mode.
def NewLine(*args, **kwargs): """ NewLine(self) Insert a new line, may use a CRLF, CR or LF depending on EOL mode. """ return _stc.StyledTextCtrl_NewLine(*args, **kwargs)
def OnKeyPressed(
self, event)
def OnKeyPressed(self, event): if self.CallTipActive(): self.CallTipCancel() key = event.GetKeyCode() if key == 32 and event.ControlDown(): pos = self.GetCurrentPos() # Tips if event.ShiftDown(): self.CallTipSetBackground("yellow") self.CallTipShow(pos, 'lots of of text: blah, blah, blah\n\n' 'show some suff, maybe parameters..\n\n' 'fubar(param1, param2)') # Code completion else: #lst = [] #for x in range(50000): # lst.append('%05d' % x) #st = " ".join(lst) #print len(st) #self.AutoCompShow(0, st) kw = keyword.kwlist[:] kw.append("zzzzzz?2") kw.append("aaaaa?2") kw.append("__init__?3") kw.append("zzaaaaa?2") kw.append("zzbaaaa?2") kw.append("this_is_a_longer_value") #kw.append("this_is_a_much_much_much_much_much_much_much_longer_value") kw.sort() # Python sorts are case sensitive self.AutoCompSetIgnoreCase(False) # so this needs to match # Images are specified with a appended "?type" for i in range(len(kw)): if kw[i] in keyword.kwlist: kw[i] = kw[i] + "?1" self.AutoCompShow(0, " ".join(kw)) else: event.Skip()
def OnMarginClick(
self, evt)
def OnMarginClick(self, evt): # fold and unfold as needed if evt.GetMargin() == 2: if evt.GetShift() and evt.GetControl(): self.FoldAll() else: lineClicked = self.LineFromPosition(evt.GetPosition()) if self.GetFoldLevel(lineClicked) & stc.STC_FOLDLEVELHEADERFLAG: if evt.GetShift(): self.SetFoldExpanded(lineClicked, True) self.Expand(lineClicked, True, True, 1) elif evt.GetControl(): if self.GetFoldExpanded(lineClicked): self.SetFoldExpanded(lineClicked, False) self.Expand(lineClicked, False, True, 0) else: self.SetFoldExpanded(lineClicked, True) self.Expand(lineClicked, True, True, 100) else: self.ToggleFold(lineClicked)
def OnPaint(
*args, **kwargs)
OnPaint(self, PaintEvent event)
def OnPaint(*args, **kwargs): """OnPaint(self, PaintEvent event)""" return _core_.Window_OnPaint(*args, **kwargs)
def OnUpdateUI(
self, evt)
def OnUpdateUI(self, evt): # check for matching braces braceAtCaret = -1 braceOpposite = -1 charBefore = None caretPos = self.GetCurrentPos() if caretPos > 0: charBefore = self.GetCharAt(caretPos - 1) styleBefore = self.GetStyleAt(caretPos - 1) # check before if charBefore and chr(charBefore) in "[]{}()" and styleBefore == stc.STC_P_OPERATOR: braceAtCaret = caretPos - 1 # check after if braceAtCaret < 0: charAfter = self.GetCharAt(caretPos) styleAfter = self.GetStyleAt(caretPos) if charAfter and chr(charAfter) in "[]{}()" and styleAfter == stc.STC_P_OPERATOR: braceAtCaret = caretPos if braceAtCaret >= 0: braceOpposite = self.BraceMatch(braceAtCaret) if braceAtCaret != -1 and braceOpposite == -1: self.BraceBadLight(braceAtCaret) else: self.BraceHighlight(braceAtCaret, braceOpposite)
def PageDown(
*args, **kwargs)
PageDown(self)
Move caret one page down.
def PageDown(*args, **kwargs): """ PageDown(self) Move caret one page down. """ return _stc.StyledTextCtrl_PageDown(*args, **kwargs)
def PageDownExtend(
*args, **kwargs)
PageDownExtend(self)
Move caret one page down extending selection to new caret position.
def PageDownExtend(*args, **kwargs): """ PageDownExtend(self) Move caret one page down extending selection to new caret position. """ return _stc.StyledTextCtrl_PageDownExtend(*args, **kwargs)
def PageDownRectExtend(
*args, **kwargs)
PageDownRectExtend(self)
Move caret one page down, extending rectangular selection to new caret position.
def PageDownRectExtend(*args, **kwargs): """ PageDownRectExtend(self) Move caret one page down, extending rectangular selection to new caret position. """ return _stc.StyledTextCtrl_PageDownRectExtend(*args, **kwargs)
def PageUp(
*args, **kwargs)
PageUp(self)
Move caret one page up.
def PageUp(*args, **kwargs): """ PageUp(self) Move caret one page up. """ return _stc.StyledTextCtrl_PageUp(*args, **kwargs)
def PageUpExtend(
*args, **kwargs)
PageUpExtend(self)
Move caret one page up extending selection to new caret position.
def PageUpExtend(*args, **kwargs): """ PageUpExtend(self) Move caret one page up extending selection to new caret position. """ return _stc.StyledTextCtrl_PageUpExtend(*args, **kwargs)
def PageUpRectExtend(
*args, **kwargs)
PageUpRectExtend(self)
Move caret one page up, extending rectangular selection to new caret position.
def PageUpRectExtend(*args, **kwargs): """ PageUpRectExtend(self) Move caret one page up, extending rectangular selection to new caret position. """ return _stc.StyledTextCtrl_PageUpRectExtend(*args, **kwargs)
def ParaDown(
*args, **kwargs)
ParaDown(self)
Move caret between paragraphs (delimited by empty lines).
def ParaDown(*args, **kwargs): """ ParaDown(self) Move caret between paragraphs (delimited by empty lines). """ return _stc.StyledTextCtrl_ParaDown(*args, **kwargs)
def ParaDownExtend(
*args, **kwargs)
ParaDownExtend(self)
def ParaDownExtend(*args, **kwargs): """ParaDownExtend(self)""" return _stc.StyledTextCtrl_ParaDownExtend(*args, **kwargs)
def ParaUp(
*args, **kwargs)
ParaUp(self)
def ParaUp(*args, **kwargs): """ParaUp(self)""" return _stc.StyledTextCtrl_ParaUp(*args, **kwargs)
def ParaUpExtend(
*args, **kwargs)
ParaUpExtend(self)
def ParaUpExtend(*args, **kwargs): """ParaUpExtend(self)""" return _stc.StyledTextCtrl_ParaUpExtend(*args, **kwargs)
def Paste(
*args, **kwargs)
Paste(self)
Pastes text from the clipboard to the text field.
def Paste(*args, **kwargs): """ Paste(self) Pastes text from the clipboard to the text field. """ return _core_.TextEntryBase_Paste(*args, **kwargs)
def PointFromPosition(
*args, **kwargs)
PointFromPosition(self, int pos) -> Point
Retrieve the point in the window where a position is displayed.
def PointFromPosition(*args, **kwargs): """ PointFromPosition(self, int pos) -> Point Retrieve the point in the window where a position is displayed. """ return _stc.StyledTextCtrl_PointFromPosition(*args, **kwargs)
def PopEventHandler(
*args, **kwargs)
PopEventHandler(self, bool deleteHandler=False) -> EvtHandler
Removes and returns the top-most event handler on the event handler
stack. If deleteHandler is True then the wx.EvtHandler object will be
destroyed after it is popped, and None will be returned instead.
def PopEventHandler(*args, **kwargs): """ PopEventHandler(self, bool deleteHandler=False) -> EvtHandler Removes and returns the top-most event handler on the event handler stack. If deleteHandler is True then the wx.EvtHandler object will be destroyed after it is popped, and ``None`` will be returned instead. """ return _core_.Window_PopEventHandler(*args, **kwargs)
def PopupMenu(
*args, **kwargs)
PopupMenu(self, Menu menu, Point pos=DefaultPosition) -> bool
Pops up the given menu at the specified coordinates, relative to this window, and returns control when the user has dismissed the menu. If a menu item is selected, the corresponding menu event is generated and will be processed as usual. If the default position is given then the current position of the mouse cursor will be used.
def PopupMenu(*args, **kwargs): """ PopupMenu(self, Menu menu, Point pos=DefaultPosition) -> bool Pops up the given menu at the specified coordinates, relative to this window, and returns control when the user has dismissed the menu. If a menu item is selected, the corresponding menu event is generated and will be processed as usual. If the default position is given then the current position of the mouse cursor will be used. """ return _core_.Window_PopupMenu(*args, **kwargs)
def PopupMenuXY(
*args, **kwargs)
PopupMenuXY(self, Menu menu, int x=-1, int y=-1) -> bool
Pops up the given menu at the specified coordinates, relative to this window, and returns control when the user has dismissed the menu. If a menu item is selected, the corresponding menu event is generated and will be processed as usual. If the default position is given then the current position of the mouse cursor will be used.
def PopupMenuXY(*args, **kwargs): """ PopupMenuXY(self, Menu menu, int x=-1, int y=-1) -> bool Pops up the given menu at the specified coordinates, relative to this window, and returns control when the user has dismissed the menu. If a menu item is selected, the corresponding menu event is generated and will be processed as usual. If the default position is given then the current position of the mouse cursor will be used. """ return _core_.Window_PopupMenuXY(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_PositionAfter(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_PositionBefore(*args, **kwargs)
def PositionFromLine(
*args, **kwargs)
PositionFromLine(self, int line) -> int
Retrieve the position at the start of a line.
def PositionFromLine(*args, **kwargs): """ PositionFromLine(self, int line) -> int Retrieve the position at the start of a line. """ return _stc.StyledTextCtrl_PositionFromLine(*args, **kwargs)
def PositionFromPoint(
*args, **kwargs)
PositionFromPoint(self, Point pt) -> int
Find the position from a point within the window.
def PositionFromPoint(*args, **kwargs): """ PositionFromPoint(self, Point pt) -> int Find the position from a point within the window. """ return _stc.StyledTextCtrl_PositionFromPoint(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_PositionFromPointClose(*args, **kwargs)
def PositionToCoords(
*args, **kwargs)
PositionToCoords(self, long pos) -> Point
def PositionToCoords(*args, **kwargs): """PositionToCoords(self, long pos) -> Point""" return _core_.TextAreaBase_PositionToCoords(*args, **kwargs)
def PositionToXY(
*args, **kwargs)
PositionToXY(long pos) -> (x, y)
def PositionToXY(*args, **kwargs): """PositionToXY(long pos) -> (x, y)""" return _stc.StyledTextCtrl_PositionToXY(*args, **kwargs)
def PostCreate(
self, pre)
Phase 3 of the 2-phase create
def PostCreate(self, pre): """ Phase 3 of the 2-phase create <wink!> Call this method after precreating the window with the 2-phase create method. """ self.this = pre.this self.thisown = pre.thisown pre.thisown = 0 if hasattr(self, '_setOORInfo'): try: self._setOORInfo(self) except TypeError: pass if hasattr(self, '_setCallbackInfo'): try: self._setCallbackInfo(self, pre.__class__) except TypeError: pass
def PostSizeEvent(
*args, **kwargs)
PostSizeEvent(self)
This is a more readable synonym for SendSizeEvent(wx.SEND_EVENT_POST)
def PostSizeEvent(*args, **kwargs): """ PostSizeEvent(self) This is a more readable synonym for SendSizeEvent(wx.SEND_EVENT_POST) """ return _core_.Window_PostSizeEvent(*args, **kwargs)
def PostSizeEventToParent(
*args, **kwargs)
PostSizeEventToParent(self)
This is the same as SendSizeEventToParent() but using PostSizeEvent()
def PostSizeEventToParent(*args, **kwargs): """ PostSizeEventToParent(self) This is the same as SendSizeEventToParent() but using PostSizeEvent() """ return _core_.Window_PostSizeEventToParent(*args, **kwargs)
def PrivateLexerCall(
*args, **kwargs)
PrivateLexerCall(self, int operation, void pointer) -> void
def PrivateLexerCall(*args, **kwargs): """PrivateLexerCall(self, int operation, void pointer) -> void""" return _stc.StyledTextCtrl_PrivateLexerCall(*args, **kwargs)
def ProcessEvent(
*args, **kwargs)
ProcessEvent(self, Event event) -> bool
def ProcessEvent(*args, **kwargs): """ProcessEvent(self, Event event) -> bool""" return _core_.EvtHandler_ProcessEvent(*args, **kwargs)
def ProcessEventLocally(
*args, **kwargs)
ProcessEventLocally(self, Event event) -> bool
def ProcessEventLocally(*args, **kwargs): """ProcessEventLocally(self, Event event) -> bool""" return _core_.EvtHandler_ProcessEventLocally(*args, **kwargs)
def ProcessPendingEvents(
*args, **kwargs)
ProcessPendingEvents(self)
def ProcessPendingEvents(*args, **kwargs): """ProcessPendingEvents(self)""" return _core_.EvtHandler_ProcessPendingEvents(*args, **kwargs)
def ProcessWindowEvent(
*args, **kwargs)
ProcessWindowEvent(self, Event event) -> bool
Process an event by calling GetEventHandler().ProcessEvent(): this is a straightforward replacement for ProcessEvent() itself which shouldn't be used directly with windows as it doesn't take into account any event handlers associated with the window
def ProcessWindowEvent(*args, **kwargs): """ ProcessWindowEvent(self, Event event) -> bool Process an event by calling GetEventHandler().ProcessEvent(): this is a straightforward replacement for ProcessEvent() itself which shouldn't be used directly with windows as it doesn't take into account any event handlers associated with the window """ return _core_.Window_ProcessWindowEvent(*args, **kwargs)
def PropertyNames(
*args, **kwargs)
PropertyNames(self) -> String
def PropertyNames(*args, **kwargs): """PropertyNames(self) -> String""" return _stc.StyledTextCtrl_PropertyNames(*args, **kwargs)
def PropertyType(
*args, **kwargs)
PropertyType(self, String name) -> int
def PropertyType(*args, **kwargs): """PropertyType(self, String name) -> int""" return _stc.StyledTextCtrl_PropertyType(*args, **kwargs)
def PushEventHandler(
*args, **kwargs)
PushEventHandler(self, EvtHandler handler)
Pushes this event handler onto the event handler stack for the window. An event handler is an object that is capable of processing the events sent to a window. (In other words, is able to dispatch the events to a handler function.) By default, the window is its own event handler, but an application may wish to substitute another, for example to allow central implementation of event-handling for a variety of different window classes.
wx.Window.PushEventHandler allows an application to set up a chain of
event handlers, where an event not handled by one event handler is
handed to the next one in the chain. Use wx.Window.PopEventHandler
to remove the event handler. Ownership of the handler is not given
to the window, so you should be sure to pop the handler before the
window is destroyed and either let PopEventHandler destroy it, or call
its Destroy method yourself.
def PushEventHandler(*args, **kwargs): """ PushEventHandler(self, EvtHandler handler) Pushes this event handler onto the event handler stack for the window. An event handler is an object that is capable of processing the events sent to a window. (In other words, is able to dispatch the events to a handler function.) By default, the window is its own event handler, but an application may wish to substitute another, for example to allow central implementation of event-handling for a variety of different window classes. wx.Window.PushEventHandler allows an application to set up a chain of event handlers, where an event not handled by one event handler is handed to the next one in the chain. Use `wx.Window.PopEventHandler` to remove the event handler. Ownership of the handler is *not* given to the window, so you should be sure to pop the handler before the window is destroyed and either let PopEventHandler destroy it, or call its Destroy method yourself. """ return _core_.Window_PushEventHandler(*args, **kwargs)
def QueueEvent(
*args, **kwargs)
QueueEvent(self, Event event)
def QueueEvent(*args, **kwargs): """QueueEvent(self, Event event)""" return _core_.EvtHandler_QueueEvent(*args, **kwargs)
def RGBAImageSetHeight(
*args, **kwargs)
RGBAImageSetHeight(self, int height)
def RGBAImageSetHeight(*args, **kwargs): """RGBAImageSetHeight(self, int height)""" return _stc.StyledTextCtrl_RGBAImageSetHeight(*args, **kwargs)
def RGBAImageSetWidth(
*args, **kwargs)
RGBAImageSetWidth(self, int width)
def RGBAImageSetWidth(*args, **kwargs): """RGBAImageSetWidth(self, int width)""" return _stc.StyledTextCtrl_RGBAImageSetWidth(*args, **kwargs)
def Raise(
*args, **kwargs)
Raise(self)
Raises the window to the top of the window hierarchy. In current version of wxWidgets this works both for managed and child windows.
def Raise(*args, **kwargs): """ Raise(self) Raises the window to the top of the window hierarchy. In current version of wxWidgets this works both for managed and child windows. """ return _core_.Window_Raise(*args, **kwargs)
def Redo(
*args, **kwargs)
Redo(self)
Redoes the last undo in the text field
def Redo(*args, **kwargs): """ Redo(self) Redoes the last undo in the text field """ return _core_.TextEntryBase_Redo(*args, **kwargs)
def Refresh(
*args, **kwargs)
Refresh(self, bool eraseBackground=True, Rect rect=None)
Mark the specified rectangle (or the whole window) as "dirty" so it will be repainted. Causes an EVT_PAINT event to be generated and sent to the window.
def Refresh(*args, **kwargs): """ Refresh(self, bool eraseBackground=True, Rect rect=None) Mark the specified rectangle (or the whole window) as "dirty" so it will be repainted. Causes an EVT_PAINT event to be generated and sent to the window. """ return _core_.Window_Refresh(*args, **kwargs)
def RefreshRect(
*args, **kwargs)
RefreshRect(self, Rect rect, bool eraseBackground=True)
Redraws the contents of the given rectangle: the area inside it will be repainted. This is the same as Refresh but has a nicer syntax.
def RefreshRect(*args, **kwargs): """ RefreshRect(self, Rect rect, bool eraseBackground=True) Redraws the contents of the given rectangle: the area inside it will be repainted. This is the same as Refresh but has a nicer syntax. """ return _core_.Window_RefreshRect(*args, **kwargs)
def RegisterHotKey(
*args, **kwargs)
RegisterHotKey(self, int hotkeyId, int modifiers, int keycode) -> bool
Registers a system wide hotkey. Every time the user presses the hotkey registered here, this window will receive a hotkey event. It will receive the event even if the application is in the background and does not have the input focus because the user is working with some other application. To bind an event handler function to this hotkey use EVT_HOTKEY with an id equal to hotkeyId. Returns True if the hotkey was registered successfully.
def RegisterHotKey(*args, **kwargs): """ RegisterHotKey(self, int hotkeyId, int modifiers, int keycode) -> bool Registers a system wide hotkey. Every time the user presses the hotkey registered here, this window will receive a hotkey event. It will receive the event even if the application is in the background and does not have the input focus because the user is working with some other application. To bind an event handler function to this hotkey use EVT_HOTKEY with an id equal to hotkeyId. Returns True if the hotkey was registered successfully. """ return _core_.Window_RegisterHotKey(*args, **kwargs)
def RegisterImage(
*args, **kwargs)
RegisterImage(self, int type, Bitmap bmp)
Register an image for use in autocompletion lists.
def RegisterImage(*args, **kwargs): """ RegisterImage(self, int type, Bitmap bmp) Register an image for use in autocompletion lists. """ return _stc.StyledTextCtrl_RegisterImage(*args, **kwargs)
def RegisterRGBAImage(
*args, **kwargs)
RegisterRGBAImage(self, int type, unsigned char pixels)
def RegisterRGBAImage(*args, **kwargs): """RegisterRGBAImage(self, int type, unsigned char pixels)""" return _stc.StyledTextCtrl_RegisterRGBAImage(*args, **kwargs)
def ReleaseDocument(
*args, **kwargs)
ReleaseDocument(self, void docPointer)
Release a reference to the document, deleting document if it fades to black.
def ReleaseDocument(*args, **kwargs): """ ReleaseDocument(self, void docPointer) Release a reference to the document, deleting document if it fades to black. """ return _stc.StyledTextCtrl_ReleaseDocument(*args, **kwargs)
def ReleaseMouse(
*args, **kwargs)
ReleaseMouse(self)
Releases mouse input captured with wx.Window.CaptureMouse.
def ReleaseMouse(*args, **kwargs): """ ReleaseMouse(self) Releases mouse input captured with wx.Window.CaptureMouse. """ return _core_.Window_ReleaseMouse(*args, **kwargs)
def Remove(
*args, **kwargs)
Remove(self, long from, long to)
Removes the text between two positions in the text field
def Remove(*args, **kwargs): """ Remove(self, long from, long to) Removes the text between two positions in the text field """ return _core_.TextEntryBase_Remove(*args, **kwargs)
def RemoveChild(
*args, **kwargs)
RemoveChild(self, Window child)
Removes a child window. This is called automatically by window deletion functions so should not be required by the application programmer.
def RemoveChild(*args, **kwargs): """ RemoveChild(self, Window child) Removes a child window. This is called automatically by window deletion functions so should not be required by the application programmer. """ return _core_.Window_RemoveChild(*args, **kwargs)
def RemoveEventHandler(
*args, **kwargs)
RemoveEventHandler(self, EvtHandler handler) -> bool
Find the given handler in the event handler chain and remove (but not delete) it from the event handler chain, returns True if it was found and False otherwise (this also results in an assert failure so this function should only be called when the handler is supposed to be there.)
def RemoveEventHandler(*args, **kwargs): """ RemoveEventHandler(self, EvtHandler handler) -> bool Find the given handler in the event handler chain and remove (but not delete) it from the event handler chain, returns True if it was found and False otherwise (this also results in an assert failure so this function should only be called when the handler is supposed to be there.) """ return _core_.Window_RemoveEventHandler(*args, **kwargs)
def RemoveSelection(
*args, **kwargs)
RemoveSelection(self)
def RemoveSelection(*args, **kwargs): """RemoveSelection(self)""" return _core_.TextEntryBase_RemoveSelection(*args, **kwargs)
def Reparent(
*args, **kwargs)
Reparent(self, Window newParent) -> bool
Reparents the window, i.e the window will be removed from its current parent window (e.g. a non-standard toolbar in a wxFrame) and then re-inserted into another. Available on Windows and GTK. Returns True if the parent was changed, False otherwise (error or newParent == oldParent)
def Reparent(*args, **kwargs): """ Reparent(self, Window newParent) -> bool Reparents the window, i.e the window will be removed from its current parent window (e.g. a non-standard toolbar in a wxFrame) and then re-inserted into another. Available on Windows and GTK. Returns True if the parent was changed, False otherwise (error or newParent == oldParent) """ return _core_.Window_Reparent(*args, **kwargs)
def Replace(
*args, **kwargs)
Replace(self, long from, long to, String value)
Replaces the text between two positions with the given text.
def Replace(*args, **kwargs): """ Replace(self, long from, long to, String value) Replaces the text between two positions with the given text. """ return _core_.TextEntryBase_Replace(*args, **kwargs)
def ReplaceSelection(
*args, **kwargs)
ReplaceSelection(self, String text)
Replace the selected text with the argument text.
def ReplaceSelection(*args, **kwargs): """ ReplaceSelection(self, String text) Replace the selected text with the argument text. """ return _stc.StyledTextCtrl_ReplaceSelection(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_ReplaceTarget(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_ReplaceTargetRE(*args, **kwargs)
def RotateSelection(
*args, **kwargs)
RotateSelection(self)
Set the main selection to the next selection.
def RotateSelection(*args, **kwargs): """ RotateSelection(self) Set the main selection to the next selection. """ return _stc.StyledTextCtrl_RotateSelection(*args, **kwargs)
def SafelyProcessEvent(
*args, **kwargs)
SafelyProcessEvent(self, Event event) -> bool
def SafelyProcessEvent(*args, **kwargs): """SafelyProcessEvent(self, Event event) -> bool""" return _core_.EvtHandler_SafelyProcessEvent(*args, **kwargs)
def SaveFile(
*args, **kwargs)
SaveFile(self, String file=wxEmptyString, int fileType=wxTEXT_TYPE_ANY) -> bool
def SaveFile(*args, **kwargs): """SaveFile(self, String file=wxEmptyString, int fileType=wxTEXT_TYPE_ANY) -> bool""" return _core_.TextAreaBase_SaveFile(*args, **kwargs)
def ScreenToClient(
*args, **kwargs)
ScreenToClient(self, Point pt) -> Point
Converts from screen to client window coordinates.
def ScreenToClient(*args, **kwargs): """ ScreenToClient(self, Point pt) -> Point Converts from screen to client window coordinates. """ return _core_.Window_ScreenToClient(*args, **kwargs)
def ScreenToClientXY(
*args, **kwargs)
ScreenToClientXY(int x, int y) -> (x,y)
Converts from screen to client window coordinates.
def ScreenToClientXY(*args, **kwargs): """ ScreenToClientXY(int x, int y) -> (x,y) Converts from screen to client window coordinates. """ return _core_.Window_ScreenToClientXY(*args, **kwargs)
def ScrollLines(
*args, **kwargs)
ScrollLines(self, int lines) -> bool
If the platform and window class supports it, scrolls the window by the given number of lines down, if lines is positive, or up if lines is negative. Returns True if the window was scrolled, False if it was already on top/bottom and nothing was done.
def ScrollLines(*args, **kwargs): """ ScrollLines(self, int lines) -> bool If the platform and window class supports it, scrolls the window by the given number of lines down, if lines is positive, or up if lines is negative. Returns True if the window was scrolled, False if it was already on top/bottom and nothing was done. """ return _core_.Window_ScrollLines(*args, **kwargs)
def ScrollPages(
*args, **kwargs)
ScrollPages(self, int pages) -> bool
If the platform and window class supports it, scrolls the window by the given number of pages down, if pages is positive, or up if pages is negative. Returns True if the window was scrolled, False if it was already on top/bottom and nothing was done.
def ScrollPages(*args, **kwargs): """ ScrollPages(self, int pages) -> bool If the platform and window class supports it, scrolls the window by the given number of pages down, if pages is positive, or up if pages is negative. Returns True if the window was scrolled, False if it was already on top/bottom and nothing was done. """ return _core_.Window_ScrollPages(*args, **kwargs)
def ScrollToColumn(
*args, **kwargs)
ScrollToColumn(self, int column)
Scroll enough to make the given column visible
def ScrollToColumn(*args, **kwargs): """ ScrollToColumn(self, int column) Scroll enough to make the given column visible """ return _stc.StyledTextCtrl_ScrollToColumn(*args, **kwargs)
def ScrollToEnd(
*args, **kwargs)
ScrollToEnd(self)
def ScrollToEnd(*args, **kwargs): """ScrollToEnd(self)""" return _stc.StyledTextCtrl_ScrollToEnd(*args, **kwargs)
def ScrollToLine(
*args, **kwargs)
ScrollToLine(self, int line)
Scroll enough to make the given line visible.
def ScrollToLine(*args, **kwargs): """ ScrollToLine(self, int line) Scroll enough to make the given line visible. """ return _stc.StyledTextCtrl_ScrollToLine(*args, **kwargs)
def ScrollToStart(
*args, **kwargs)
ScrollToStart(self)
def ScrollToStart(*args, **kwargs): """ScrollToStart(self)""" return _stc.StyledTextCtrl_ScrollToStart(*args, **kwargs)
def ScrollWindow(
*args, **kwargs)
ScrollWindow(self, int dx, int dy, Rect rect=None)
Physically scrolls the pixels in the window and move child windows accordingly. Use this function to optimise your scrolling implementations, to minimise the area that must be redrawn. Note that it is rarely required to call this function from a user program.
def ScrollWindow(*args, **kwargs): """ ScrollWindow(self, int dx, int dy, Rect rect=None) Physically scrolls the pixels in the window and move child windows accordingly. Use this function to optimise your scrolling implementations, to minimise the area that must be redrawn. Note that it is rarely required to call this function from a user program. """ return _core_.Window_ScrollWindow(*args, **kwargs)
def SearchAnchor(
*args, **kwargs)
SearchAnchor(self)
Sets the current caret position to be the search anchor.
def SearchAnchor(*args, **kwargs): """ SearchAnchor(self) Sets the current caret position to be the search anchor. """ return _stc.StyledTextCtrl_SearchAnchor(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_SearchInTarget(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_SearchNext(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_SearchPrev(*args, **kwargs)
def SelectAll(
*args, **kwargs)
SelectAll(self)
Select all text in the text field.
def SelectAll(*args, **kwargs): """ SelectAll(self) Select all text in the text field. """ return _core_.TextEntryBase_SelectAll(*args, **kwargs)
def SelectNone(
*args, **kwargs)
SelectNone(self)
def SelectNone(*args, **kwargs): """SelectNone(self)""" return _stc.StyledTextCtrl_SelectNone(*args, **kwargs)
def SelectionDuplicate(
*args, **kwargs)
SelectionDuplicate(self)
Duplicate the selection. If selection empty duplicate the line containing the caret.
def SelectionDuplicate(*args, **kwargs): """ SelectionDuplicate(self) Duplicate the selection. If selection empty duplicate the line containing the caret. """ return _stc.StyledTextCtrl_SelectionDuplicate(*args, **kwargs)
def SelectionIsRectangle(
*args, **kwargs)
SelectionIsRectangle(self) -> bool
Is the selection rectangular? The alternative is the more common stream selection.
def SelectionIsRectangle(*args, **kwargs): """ SelectionIsRectangle(self) -> bool Is the selection rectangular? The alternative is the more common stream selection. """ return _stc.StyledTextCtrl_SelectionIsRectangle(*args, **kwargs)
def SendIdleEvents(
*args, **kwargs)
SendIdleEvents(self, IdleEvent event) -> bool
Send idle event to window and all subwindows. Returns True if more idle time is requested.
def SendIdleEvents(*args, **kwargs): """ SendIdleEvents(self, IdleEvent event) -> bool Send idle event to window and all subwindows. Returns True if more idle time is requested. """ return _core_.Window_SendIdleEvents(*args, **kwargs)
def SendMsg(
*args, **kwargs)
SendMsg(self, int msg, UIntPtr wp=0, wxIntPtr lp=0) -> wxIntPtr
Send a message to Scintilla.
def SendMsg(*args, **kwargs): """ SendMsg(self, int msg, UIntPtr wp=0, wxIntPtr lp=0) -> wxIntPtr Send a message to Scintilla. """ return _stc.StyledTextCtrl_SendMsg(*args, **kwargs)
def SendSizeEvent(
*args, **kwargs)
SendSizeEvent(self, int flags=0)
Sends a size event to the window using its current size -- this has an effect of refreshing the window layout.
By default the event is sent, i.e. processed immediately, but if flags value includes wxSEND_EVENT_POST then it's posted, i.e. only schedule for later processing.
def SendSizeEvent(*args, **kwargs): """ SendSizeEvent(self, int flags=0) Sends a size event to the window using its current size -- this has an effect of refreshing the window layout. By default the event is sent, i.e. processed immediately, but if flags value includes wxSEND_EVENT_POST then it's posted, i.e. only schedule for later processing. """ return _core_.Window_SendSizeEvent(*args, **kwargs)
def SendSizeEventToParent(
*args, **kwargs)
SendSizeEventToParent(self, int flags=0)
This is a safe wrapper for GetParent().SendSizeEvent(): it checks that we have a parent window and it's not in process of being deleted.
def SendSizeEventToParent(*args, **kwargs): """ SendSizeEventToParent(self, int flags=0) This is a safe wrapper for GetParent().SendSizeEvent(): it checks that we have a parent window and it's not in process of being deleted. """ return _core_.Window_SendSizeEventToParent(*args, **kwargs)
def SetAcceleratorTable(
*args, **kwargs)
SetAcceleratorTable(self, AcceleratorTable accel)
Sets the accelerator table for this window.
def SetAcceleratorTable(*args, **kwargs): """ SetAcceleratorTable(self, AcceleratorTable accel) Sets the accelerator table for this window. """ return _core_.Window_SetAcceleratorTable(*args, **kwargs)
def SetAdditionalCaretForeground(
*args, **kwargs)
SetAdditionalCaretForeground(self, Colour fore)
Set the foreground colour of additional carets.
def SetAdditionalCaretForeground(*args, **kwargs): """ SetAdditionalCaretForeground(self, Colour fore) Set the foreground colour of additional carets. """ return _stc.StyledTextCtrl_SetAdditionalCaretForeground(*args, **kwargs)
def SetAdditionalCaretsBlink(
*args, **kwargs)
SetAdditionalCaretsBlink(self, bool additionalCaretsBlink)
Set whether additional carets will blink
def SetAdditionalCaretsBlink(*args, **kwargs): """ SetAdditionalCaretsBlink(self, bool additionalCaretsBlink) Set whether additional carets will blink """ return _stc.StyledTextCtrl_SetAdditionalCaretsBlink(*args, **kwargs)
def SetAdditionalCaretsVisible(
*args, **kwargs)
SetAdditionalCaretsVisible(self, bool additionalCaretsBlink)
Set whether additional carets are visible
def SetAdditionalCaretsVisible(*args, **kwargs): """ SetAdditionalCaretsVisible(self, bool additionalCaretsBlink) Set whether additional carets are visible """ return _stc.StyledTextCtrl_SetAdditionalCaretsVisible(*args, **kwargs)
def SetAdditionalSelAlpha(
*args, **kwargs)
SetAdditionalSelAlpha(self, int alpha)
Set the alpha of the selection.
def SetAdditionalSelAlpha(*args, **kwargs): """ SetAdditionalSelAlpha(self, int alpha) Set the alpha of the selection. """ return _stc.StyledTextCtrl_SetAdditionalSelAlpha(*args, **kwargs)
def SetAdditionalSelBackground(
*args, **kwargs)
SetAdditionalSelBackground(self, Colour back)
Set the background colour of additional selections. Must have previously called SetSelBack with non-zero first argument for this to have an effect.
def SetAdditionalSelBackground(*args, **kwargs): """ SetAdditionalSelBackground(self, Colour back) Set the background colour of additional selections. Must have previously called SetSelBack with non-zero first argument for this to have an effect. """ return _stc.StyledTextCtrl_SetAdditionalSelBackground(*args, **kwargs)
def SetAdditionalSelForeground(
*args, **kwargs)
SetAdditionalSelForeground(self, Colour fore)
Set the foreground colour of additional selections. Must have previously called SetSelFore with non-zero first argument for this to have an effect.
def SetAdditionalSelForeground(*args, **kwargs): """ SetAdditionalSelForeground(self, Colour fore) Set the foreground colour of additional selections. Must have previously called SetSelFore with non-zero first argument for this to have an effect. """ return _stc.StyledTextCtrl_SetAdditionalSelForeground(*args, **kwargs)
def SetAdditionalSelectionTyping(
*args, **kwargs)
SetAdditionalSelectionTyping(self, bool additionalSelectionTyping)
Set whether typing can be performed into multiple selections
def SetAdditionalSelectionTyping(*args, **kwargs): """ SetAdditionalSelectionTyping(self, bool additionalSelectionTyping) Set whether typing can be performed into multiple selections """ return _stc.StyledTextCtrl_SetAdditionalSelectionTyping(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_SetAnchor(*args, **kwargs)
def SetAutoLayout(
*args, **kwargs)
SetAutoLayout(self, bool autoLayout)
Determines whether the Layout function will be called automatically
when the window is resized. lease note that this only happens for the
windows usually used to contain children, namely wx.Panel and
wx.TopLevelWindow (and the classes deriving from them).
This method is called implicitly by SetSizer but if you use
SetConstraints you should call it manually or otherwise the window
layout won't be correctly updated when its size changes.
def SetAutoLayout(*args, **kwargs): """ SetAutoLayout(self, bool autoLayout) Determines whether the Layout function will be called automatically when the window is resized. lease note that this only happens for the windows usually used to contain children, namely `wx.Panel` and `wx.TopLevelWindow` (and the classes deriving from them). This method is called implicitly by `SetSizer` but if you use `SetConstraints` you should call it manually or otherwise the window layout won't be correctly updated when its size changes. """ return _core_.Window_SetAutoLayout(*args, **kwargs)
def SetBackSpaceUnIndents(
*args, **kwargs)
SetBackSpaceUnIndents(self, bool bsUnIndents)
Sets whether a backspace pressed when caret is within indentation unindents.
def SetBackSpaceUnIndents(*args, **kwargs): """ SetBackSpaceUnIndents(self, bool bsUnIndents) Sets whether a backspace pressed when caret is within indentation unindents. """ return _stc.StyledTextCtrl_SetBackSpaceUnIndents(*args, **kwargs)
def SetBackgroundColour(
*args, **kwargs)
SetBackgroundColour(self, Colour colour) -> bool
Sets the background colour of the window. Returns True if the colour
was changed. The background colour is usually painted by the default
EVT_ERASE_BACKGROUND event handler function under Windows and
automatically under GTK. Using wx.NullColour will reset the window
to the default background colour.
Note that setting the background colour may not cause an immediate
refresh, so you may wish to call ClearBackground or Refresh after
calling this function.
Using this function will disable attempts to use themes for this window, if the system supports them. Use with care since usually the themes represent the appearance chosen by the user to be used for all applications on the system.
def SetBackgroundColour(*args, **kwargs): """ SetBackgroundColour(self, Colour colour) -> bool Sets the background colour of the window. Returns True if the colour was changed. The background colour is usually painted by the default EVT_ERASE_BACKGROUND event handler function under Windows and automatically under GTK. Using `wx.NullColour` will reset the window to the default background colour. Note that setting the background colour may not cause an immediate refresh, so you may wish to call `ClearBackground` or `Refresh` after calling this function. Using this function will disable attempts to use themes for this window, if the system supports them. Use with care since usually the themes represent the appearance chosen by the user to be used for all applications on the system. """ return _core_.Window_SetBackgroundColour(*args, **kwargs)
def SetBackgroundStyle(
*args, **kwargs)
SetBackgroundStyle(self, int style) -> bool
Returns the background style of the window. The background style indicates how the background of the window is drawn.
====================== ========================================
wx.BG_STYLE_SYSTEM The background colour or pattern should
be determined by the system
wx.BG_STYLE_COLOUR The background should be a solid colour
wx.BG_STYLE_CUSTOM The background will be implemented by the
application.
====================== ========================================
On GTK+, use of wx.BG_STYLE_CUSTOM allows the flicker-free drawing of a custom background, such as a tiled bitmap. Currently the style has no effect on other platforms.
:see: GetBackgroundStyle, SetBackgroundColour
def SetBackgroundStyle(*args, **kwargs): """ SetBackgroundStyle(self, int style) -> bool Returns the background style of the window. The background style indicates how the background of the window is drawn. ====================== ======================================== wx.BG_STYLE_SYSTEM The background colour or pattern should be determined by the system wx.BG_STYLE_COLOUR The background should be a solid colour wx.BG_STYLE_CUSTOM The background will be implemented by the application. ====================== ======================================== On GTK+, use of wx.BG_STYLE_CUSTOM allows the flicker-free drawing of a custom background, such as a tiled bitmap. Currently the style has no effect on other platforms. :see: `GetBackgroundStyle`, `SetBackgroundColour` """ return _core_.Window_SetBackgroundStyle(*args, **kwargs)
def SetBestFittingSize(
*args, **kw)
SetInitialSize(self, Size size=DefaultSize)
A 'Smart' SetSize that will fill in default size components with the window's best size values. Also set's the minsize for use with sizers.
def deprecated_func(*args, **kw): warnings.warn("Call to deprecated item. %s" % msg, wxPyDeprecationWarning, stacklevel=2) return item(*args, **kw)
def 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.
def 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. """ return _stc.StyledTextCtrl_SetBufferedDraw(*args, **kwargs)
def SetCanFocus(
*args, **kwargs)
SetCanFocus(self, bool canFocus)
def SetCanFocus(*args, **kwargs): """SetCanFocus(self, bool canFocus)""" return _core_.Window_SetCanFocus(*args, **kwargs)
def SetCaret(
*args, **kwargs)
SetCaret(self, Caret caret)
Sets the caret associated with the window.
def SetCaret(*args, **kwargs): """ SetCaret(self, Caret caret) Sets the caret associated with the window. """ return _core_.Window_SetCaret(*args, **kwargs)
def SetCaretForeground(
*args, **kwargs)
SetCaretForeground(self, Colour fore)
Set the foreground colour of the caret.
def SetCaretForeground(*args, **kwargs): """ SetCaretForeground(self, Colour fore) Set the foreground colour of the caret. """ return _stc.StyledTextCtrl_SetCaretForeground(*args, **kwargs)
def SetCaretLineBack(
*args, **kwargs)
SetCaretLineBackground(self, Colour back)
Set the colour of the background of the line containing the caret.
def SetCaretLineBackground(*args, **kwargs): """ SetCaretLineBackground(self, Colour back) Set the colour of the background of the line containing the caret. """ return _stc.StyledTextCtrl_SetCaretLineBackground(*args, **kwargs)
def SetCaretLineBackAlpha(
*args, **kwargs)
SetCaretLineBackAlpha(self, int alpha)
Set background alpha of the caret line.
def SetCaretLineBackAlpha(*args, **kwargs): """ SetCaretLineBackAlpha(self, int alpha) Set background alpha of the caret line. """ return _stc.StyledTextCtrl_SetCaretLineBackAlpha(*args, **kwargs)
def SetCaretLineBackground(
*args, **kwargs)
SetCaretLineBackground(self, Colour back)
Set the colour of the background of the line containing the caret.
def SetCaretLineBackground(*args, **kwargs): """ SetCaretLineBackground(self, Colour back) Set the colour of the background of the line containing the caret. """ return _stc.StyledTextCtrl_SetCaretLineBackground(*args, **kwargs)
def SetCaretLineVisible(
*args, **kwargs)
SetCaretLineVisible(self, bool show)
Display the background of the line containing the caret in a different colour.
def SetCaretLineVisible(*args, **kwargs): """ SetCaretLineVisible(self, bool show) Display the background of the line containing the caret in a different colour. """ return _stc.StyledTextCtrl_SetCaretLineVisible(*args, **kwargs)
def SetCaretPeriod(
*args, **kwargs)
SetCaretPeriod(self, int periodMilliseconds)
Get the time in milliseconds that the caret is on and off. 0 = steady on.
def SetCaretPeriod(*args, **kwargs): """ SetCaretPeriod(self, int periodMilliseconds) Get the time in milliseconds that the caret is on and off. 0 = steady on. """ return _stc.StyledTextCtrl_SetCaretPeriod(*args, **kwargs)
def SetCaretSticky(
*args, **kwargs)
SetCaretSticky(self, int useCaretStickyBehaviour)
Stop the caret preferred x position changing when the user types.
def SetCaretSticky(*args, **kwargs): """ SetCaretSticky(self, int useCaretStickyBehaviour) Stop the caret preferred x position changing when the user types. """ return _stc.StyledTextCtrl_SetCaretSticky(*args, **kwargs)
def SetCaretStyle(
*args, **kwargs)
SetCaretStyle(self, int caretStyle)
Set the style of the caret to be drawn.
def SetCaretStyle(*args, **kwargs): """ SetCaretStyle(self, int caretStyle) Set the style of the caret to be drawn. """ return _stc.StyledTextCtrl_SetCaretStyle(*args, **kwargs)
def SetCaretWidth(
*args, **kwargs)
SetCaretWidth(self, int pixelWidth)
Set the width of the insert mode caret.
def SetCaretWidth(*args, **kwargs): """ SetCaretWidth(self, int pixelWidth) Set the width of the insert mode caret. """ return _stc.StyledTextCtrl_SetCaretWidth(*args, **kwargs)
def SetCharsDefault(
*args, **kwargs)
SetCharsDefault(self)
Reset the set of characters for whitespace and word characters to the defaults.
def SetCharsDefault(*args, **kwargs): """ SetCharsDefault(self) Reset the set of characters for whitespace and word characters to the defaults. """ return _stc.StyledTextCtrl_SetCharsDefault(*args, **kwargs)
def SetClientRect(
*args, **kwargs)
SetClientRect(self, Rect rect)
This sets the size of the window client area in pixels. Using this function to size a window tends to be more device-independent than wx.Window.SetSize, since the application need not worry about what dimensions the border or title bar have when trying to fit the window around panel items, for example.
def SetClientRect(*args, **kwargs): """ SetClientRect(self, Rect rect) This sets the size of the window client area in pixels. Using this function to size a window tends to be more device-independent than wx.Window.SetSize, since the application need not worry about what dimensions the border or title bar have when trying to fit the window around panel items, for example. """ return _core_.Window_SetClientRect(*args, **kwargs)
def SetClientSize(
*args, **kwargs)
SetClientSize(self, Size size)
This sets the size of the window client area in pixels. Using this function to size a window tends to be more device-independent than wx.Window.SetSize, since the application need not worry about what dimensions the border or title bar have when trying to fit the window around panel items, for example.
def SetClientSize(*args, **kwargs): """ SetClientSize(self, Size size) This sets the size of the window client area in pixels. Using this function to size a window tends to be more device-independent than wx.Window.SetSize, since the application need not worry about what dimensions the border or title bar have when trying to fit the window around panel items, for example. """ return _core_.Window_SetClientSize(*args, **kwargs)
def SetClientSizeWH(
*args, **kwargs)
SetClientSizeWH(self, int width, int height)
This sets the size of the window client area in pixels. Using this function to size a window tends to be more device-independent than wx.Window.SetSize, since the application need not worry about what dimensions the border or title bar have when trying to fit the window around panel items, for example.
def SetClientSizeWH(*args, **kwargs): """ SetClientSizeWH(self, int width, int height) This sets the size of the window client area in pixels. Using this function to size a window tends to be more device-independent than wx.Window.SetSize, since the application need not worry about what dimensions the border or title bar have when trying to fit the window around panel items, for example. """ return _core_.Window_SetClientSizeWH(*args, **kwargs)
def SetCodePage(
*args, **kwargs)
SetCodePage(self, int codePage)
Set the code page used to interpret the bytes of the document as characters.
def SetCodePage(*args, **kwargs): """ SetCodePage(self, int codePage) Set the code page used to interpret the bytes of the document as characters. """ return _stc.StyledTextCtrl_SetCodePage(*args, **kwargs)
def SetConstraints(
*args, **kwargs)
SetConstraints(self, LayoutConstraints constraints)
Sets the window to have the given layout constraints. If an existing layout constraints object is already owned by the window, it will be deleted. Pass None to disassociate and delete the window's current constraints.
You must call SetAutoLayout to tell a window to use the constraints automatically in its default EVT_SIZE handler; otherwise, you must handle EVT_SIZE yourself and call Layout() explicitly. When setting both a wx.LayoutConstraints and a wx.Sizer, only the sizer will have effect.
def SetConstraints(*args, **kwargs): """ SetConstraints(self, LayoutConstraints constraints) Sets the window to have the given layout constraints. If an existing layout constraints object is already owned by the window, it will be deleted. Pass None to disassociate and delete the window's current constraints. You must call SetAutoLayout to tell a window to use the constraints automatically in its default EVT_SIZE handler; otherwise, you must handle EVT_SIZE yourself and call Layout() explicitly. When setting both a wx.LayoutConstraints and a wx.Sizer, only the sizer will have effect. """ return _core_.Window_SetConstraints(*args, **kwargs)
def SetContainingSizer(
*args, **kwargs)
SetContainingSizer(self, Sizer sizer)
This normally does not need to be called by application code. It is called internally when a window is added to a sizer, and is used so the window can remove itself from the sizer when it is destroyed.
def SetContainingSizer(*args, **kwargs): """ SetContainingSizer(self, Sizer sizer) This normally does not need to be called by application code. It is called internally when a window is added to a sizer, and is used so the window can remove itself from the sizer when it is destroyed. """ return _core_.Window_SetContainingSizer(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_SetControlCharSymbol(*args, **kwargs)
def SetCurrentPos(
*args, **kwargs)
SetCurrentPos(self, int pos)
Sets the position of the caret.
def SetCurrentPos(*args, **kwargs): """ SetCurrentPos(self, int pos) Sets the position of the caret. """ return _stc.StyledTextCtrl_SetCurrentPos(*args, **kwargs)
def SetCursor(
*args, **kwargs)
SetCursor(self, Cursor cursor) -> bool
Sets the window's cursor. Notice that the window cursor also sets it for the children of the window implicitly.
The cursor may be wx.NullCursor in which case the window cursor will be reset back to default.
def SetCursor(*args, **kwargs): """ SetCursor(self, Cursor cursor) -> bool Sets the window's cursor. Notice that the window cursor also sets it for the children of the window implicitly. The cursor may be wx.NullCursor in which case the window cursor will be reset back to default. """ return _core_.Window_SetCursor(*args, **kwargs)
def SetDefaultStyle(
*args, **kwargs)
SetDefaultStyle(self, wxTextAttr style) -> bool
def SetDefaultStyle(*args, **kwargs): """SetDefaultStyle(self, wxTextAttr style) -> bool""" return _core_.TextAreaBase_SetDefaultStyle(*args, **kwargs)
def SetDimensions(
*args, **kwargs)
SetDimensions(self, int x, int y, int width, int height, int sizeFlags=SIZE_AUTO)
Sets the position and size of the window in pixels. The sizeFlags parameter indicates the interpretation of the other params if they are equal to -1.
======================== ======================================
wx.SIZE_AUTO A -1 indicates that a class-specific
default should be used.
wx.SIZE_USE_EXISTING Existing dimensions should be used if
-1 values are supplied.
wxSIZE_ALLOW_MINUS_ONE Allow dimensions of -1 and less to be
interpreted as real dimensions, not
default values.
======================== ======================================
def SetDimensions(*args, **kwargs): """ SetDimensions(self, int x, int y, int width, int height, int sizeFlags=SIZE_AUTO) Sets the position and size of the window in pixels. The sizeFlags parameter indicates the interpretation of the other params if they are equal to -1. ======================== ====================================== wx.SIZE_AUTO A -1 indicates that a class-specific default should be used. wx.SIZE_USE_EXISTING Existing dimensions should be used if -1 values are supplied. wxSIZE_ALLOW_MINUS_ONE Allow dimensions of -1 and less to be interpreted as real dimensions, not default values. ======================== ====================================== """ return _core_.Window_SetDimensions(*args, **kwargs)
def SetDocPointer(
*args, **kwargs)
SetDocPointer(self, void docPointer)
Change the document object used.
def SetDocPointer(*args, **kwargs): """ SetDocPointer(self, void docPointer) Change the document object used. """ return _stc.StyledTextCtrl_SetDocPointer(*args, **kwargs)
def SetDoubleBuffered(
*args, **kwargs)
SetDoubleBuffered(self, bool on)
Put the native window into double buffered or composited mode.
def SetDoubleBuffered(*args, **kwargs): """ SetDoubleBuffered(self, bool on) Put the native window into double buffered or composited mode. """ return _core_.Window_SetDoubleBuffered(*args, **kwargs)
def SetDropTarget(
*args, **kwargs)
SetDropTarget(self, DropTarget dropTarget)
Associates a drop target with this window. If the window already has a drop target, it is deleted.
def SetDropTarget(*args, **kwargs): """ SetDropTarget(self, DropTarget dropTarget) Associates a drop target with this window. If the window already has a drop target, it is deleted. """ return _core_.Window_SetDropTarget(*args, **kwargs)
def SetEOLMode(
*args, **kwargs)
SetEOLMode(self, int eolMode)
Set the current end of line mode.
def SetEOLMode(*args, **kwargs): """ SetEOLMode(self, int eolMode) Set the current end of line mode. """ return _stc.StyledTextCtrl_SetEOLMode(*args, **kwargs)
def SetEdgeColour(
*args, **kwargs)
SetEdgeColour(self, Colour edgeColour)
Change the colour used in edge indication.
def SetEdgeColour(*args, **kwargs): """ SetEdgeColour(self, Colour edgeColour) Change the colour used in edge indication. """ return _stc.StyledTextCtrl_SetEdgeColour(*args, **kwargs)
def SetEdgeColumn(
*args, **kwargs)
SetEdgeColumn(self, int column)
Set the column number of the edge. If text goes past the edge then it is highlighted.
def SetEdgeColumn(*args, **kwargs): """ SetEdgeColumn(self, int column) Set the column number of the edge. If text goes past the edge then it is highlighted. """ return _stc.StyledTextCtrl_SetEdgeColumn(*args, **kwargs)
def 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).
def 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). """ return _stc.StyledTextCtrl_SetEdgeMode(*args, **kwargs)
def SetEditable(
*args, **kwargs)
SetEditable(self, bool editable)
def SetEditable(*args, **kwargs): """SetEditable(self, bool editable)""" return _core_.TextEntryBase_SetEditable(*args, **kwargs)
def SetEmptySelection(
*args, **kwargs)
SetEmptySelection(self, int pos)
def SetEmptySelection(*args, **kwargs): """SetEmptySelection(self, int pos)""" return _stc.StyledTextCtrl_SetEmptySelection(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_SetEndAtLastLine(*args, **kwargs)
def SetEventHandler(
*args, **kwargs)
SetEventHandler(self, EvtHandler handler)
Sets the event handler for this window. An event handler is an object that is capable of processing the events sent to a window. (In other words, is able to dispatch the events to handler function.) By default, the window is its own event handler, but an application may wish to substitute another, for example to allow central implementation of event-handling for a variety of different window classes.
It is usually better to use wx.Window.PushEventHandler since this sets
up a chain of event handlers, where an event not handled by one event
handler is handed off to the next one in the chain.
def SetEventHandler(*args, **kwargs): """ SetEventHandler(self, EvtHandler handler) Sets the event handler for this window. An event handler is an object that is capable of processing the events sent to a window. (In other words, is able to dispatch the events to handler function.) By default, the window is its own event handler, but an application may wish to substitute another, for example to allow central implementation of event-handling for a variety of different window classes. It is usually better to use `wx.Window.PushEventHandler` since this sets up a chain of event handlers, where an event not handled by one event handler is handed off to the next one in the chain. """ return _core_.Window_SetEventHandler(*args, **kwargs)
def SetEvtHandlerEnabled(
*args, **kwargs)
SetEvtHandlerEnabled(self, bool enabled)
def SetEvtHandlerEnabled(*args, **kwargs): """SetEvtHandlerEnabled(self, bool enabled)""" return _core_.EvtHandler_SetEvtHandlerEnabled(*args, **kwargs)
def SetExtraAscent(
*args, **kwargs)
SetExtraAscent(self, int extraAscent)
Set extra ascent for each line
def SetExtraAscent(*args, **kwargs): """ SetExtraAscent(self, int extraAscent) Set extra ascent for each line """ return _stc.StyledTextCtrl_SetExtraAscent(*args, **kwargs)
def SetExtraDescent(
*args, **kwargs)
SetExtraDescent(self, int extraDescent)
Set extra descent for each line
def SetExtraDescent(*args, **kwargs): """ SetExtraDescent(self, int extraDescent) Set extra descent for each line """ return _stc.StyledTextCtrl_SetExtraDescent(*args, **kwargs)
def SetExtraStyle(
*args, **kwargs)
SetExtraStyle(self, long exStyle)
Sets the extra style bits for the window. Extra styles are the less often used style bits which can't be set with the constructor or with SetWindowStyleFlag()
def SetExtraStyle(*args, **kwargs): """ SetExtraStyle(self, long exStyle) Sets the extra style bits for the window. Extra styles are the less often used style bits which can't be set with the constructor or with SetWindowStyleFlag() """ return _core_.Window_SetExtraStyle(*args, **kwargs)
def SetFirstVisibleLine(
*args, **kwargs)
SetFirstVisibleLine(self, int lineDisplay)
Scroll so that a display line is at the top of the display.
def SetFirstVisibleLine(*args, **kwargs): """ SetFirstVisibleLine(self, int lineDisplay) Scroll so that a display line is at the top of the display. """ return _stc.StyledTextCtrl_SetFirstVisibleLine(*args, **kwargs)
def SetFocus(
*args, **kwargs)
SetFocus(self)
Set's the focus to this window, allowing it to receive keyboard input.
def SetFocus(*args, **kwargs): """ SetFocus(self) Set's the focus to this window, allowing it to receive keyboard input. """ return _core_.Window_SetFocus(*args, **kwargs)
def SetFocusFromKbd(
*args, **kwargs)
SetFocusFromKbd(self)
Set focus to this window as the result of a keyboard action. Normally only called internally.
def SetFocusFromKbd(*args, **kwargs): """ SetFocusFromKbd(self) Set focus to this window as the result of a keyboard action. Normally only called internally. """ return _core_.Window_SetFocusFromKbd(*args, **kwargs)
def SetFoldExpanded(
*args, **kwargs)
SetFoldExpanded(self, int line, bool expanded)
Show the children of a header line.
def SetFoldExpanded(*args, **kwargs): """ SetFoldExpanded(self, int line, bool expanded) Show the children of a header line. """ return _stc.StyledTextCtrl_SetFoldExpanded(*args, **kwargs)
def SetFoldFlags(
*args, **kwargs)
SetFoldFlags(self, int flags)
Set some style options for folding.
def SetFoldFlags(*args, **kwargs): """ SetFoldFlags(self, int flags) Set some style options for folding. """ return _stc.StyledTextCtrl_SetFoldFlags(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_SetFoldLevel(*args, **kwargs)
def SetFoldMarginColour(
*args, **kwargs)
SetFoldMarginColour(self, bool useSetting, Colour back)
Set the colours used as a chequerboard pattern in the fold margin
def SetFoldMarginColour(*args, **kwargs): """ SetFoldMarginColour(self, bool useSetting, Colour back) Set the colours used as a chequerboard pattern in the fold margin """ return _stc.StyledTextCtrl_SetFoldMarginColour(*args, **kwargs)
def SetFoldMarginHiColour(
*args, **kwargs)
SetFoldMarginHiColour(self, bool useSetting, Colour fore)
def SetFoldMarginHiColour(*args, **kwargs): """SetFoldMarginHiColour(self, bool useSetting, Colour fore)""" return _stc.StyledTextCtrl_SetFoldMarginHiColour(*args, **kwargs)
def SetFont(
*args, **kwargs)
SetFont(self, Font font) -> bool
Sets the font for this window.
def SetFont(*args, **kwargs): """ SetFont(self, Font font) -> bool Sets the font for this window. """ return _core_.Window_SetFont(*args, **kwargs)
def SetForegroundColour(
*args, **kwargs)
SetForegroundColour(self, Colour colour) -> bool
Sets the foreground colour of the window. Returns True is the colour was changed. The interpretation of foreground colour is dependent on the window class; it may be the text colour or other colour, or it may not be used at all.
def SetForegroundColour(*args, **kwargs): """ SetForegroundColour(self, Colour colour) -> bool Sets the foreground colour of the window. Returns True is the colour was changed. The interpretation of foreground colour is dependent on the window class; it may be the text colour or other colour, or it may not be used at all. """ return _core_.Window_SetForegroundColour(*args, **kwargs)
def SetHScrollBar(
*args, **kwargs)
SetHScrollBar(self, ScrollBar bar)
Set the horizontal scrollbar to use instead of the ont that's built-in.
def SetHScrollBar(*args, **kwargs): """ SetHScrollBar(self, ScrollBar bar) Set the horizontal scrollbar to use instead of the ont that's built-in. """ return _stc.StyledTextCtrl_SetHScrollBar(*args, **kwargs)
def SetHelpText(
*args, **kwargs)
SetHelpText(self, String text)
Sets the help text to be used as context-sensitive help for this
window. Note that the text is actually stored by the current
wx.HelpProvider implementation, and not in the window object itself.
def SetHelpText(*args, **kwargs): """ SetHelpText(self, String text) Sets the help text to be used as context-sensitive help for this window. Note that the text is actually stored by the current `wx.HelpProvider` implementation, and not in the window object itself. """ return _core_.Window_SetHelpText(*args, **kwargs)
def SetHelpTextForId(
*args, **kw)
SetHelpTextForId(self, String text)
Associate this help text with all windows with the same id as this one.
def deprecated_func(*args, **kw): warnings.warn("Call to deprecated item. %s" % msg, wxPyDeprecationWarning, stacklevel=2) return item(*args, **kw)
def SetHighlightGuide(
*args, **kwargs)
SetHighlightGuide(self, int column)
Set the highlighted indentation guide column. 0 = no highlighted guide.
def SetHighlightGuide(*args, **kwargs): """ SetHighlightGuide(self, int column) Set the highlighted indentation guide column. 0 = no highlighted guide. """ return _stc.StyledTextCtrl_SetHighlightGuide(*args, **kwargs)
def SetHint(
*args, **kwargs)
SetHint(self, String hint) -> bool
def SetHint(*args, **kwargs): """SetHint(self, String hint) -> bool""" return _core_.TextEntryBase_SetHint(*args, **kwargs)
def SetHotspotActiveBackground(
*args, **kwargs)
SetHotspotActiveBackground(self, bool useSetting, Colour back)
Set a back colour for active hotspots.
def SetHotspotActiveBackground(*args, **kwargs): """ SetHotspotActiveBackground(self, bool useSetting, Colour back) Set a back colour for active hotspots. """ return _stc.StyledTextCtrl_SetHotspotActiveBackground(*args, **kwargs)
def SetHotspotActiveForeground(
*args, **kwargs)
SetHotspotActiveForeground(self, bool useSetting, Colour fore)
Set a fore colour for active hotspots.
def SetHotspotActiveForeground(*args, **kwargs): """ SetHotspotActiveForeground(self, bool useSetting, Colour fore) Set a fore colour for active hotspots. """ return _stc.StyledTextCtrl_SetHotspotActiveForeground(*args, **kwargs)
def SetHotspotActiveUnderline(
*args, **kwargs)
SetHotspotActiveUnderline(self, bool underline)
Enable / Disable underlining active hotspots.
def SetHotspotActiveUnderline(*args, **kwargs): """ SetHotspotActiveUnderline(self, bool underline) Enable / Disable underlining active hotspots. """ return _stc.StyledTextCtrl_SetHotspotActiveUnderline(*args, **kwargs)
def SetHotspotSingleLine(
*args, **kwargs)
SetHotspotSingleLine(self, bool singleLine)
Limit hotspots to single line so hotspots on two lines don't merge.
def SetHotspotSingleLine(*args, **kwargs): """ SetHotspotSingleLine(self, bool singleLine) Limit hotspots to single line so hotspots on two lines don't merge. """ return _stc.StyledTextCtrl_SetHotspotSingleLine(*args, **kwargs)
def SetId(
*args, **kwargs)
SetId(self, int winid)
Sets the identifier of the window. Each window has an integer identifier. If the application has not provided one, an identifier will be generated. Normally, the identifier should be provided on creation and should not be modified subsequently.
def SetId(*args, **kwargs): """ SetId(self, int winid) Sets the identifier of the window. Each window has an integer identifier. If the application has not provided one, an identifier will be generated. Normally, the identifier should be provided on creation and should not be modified subsequently. """ return _core_.Window_SetId(*args, **kwargs)
def SetIdentifier(
*args, **kwargs)
SetIdentifier(self, int identifier)
def SetIdentifier(*args, **kwargs): """SetIdentifier(self, int identifier)""" return _stc.StyledTextCtrl_SetIdentifier(*args, **kwargs)
def SetIndent(
*args, **kwargs)
SetIndent(self, int indentSize)
Set the number of spaces used for one level of indentation.
def SetIndent(*args, **kwargs): """ SetIndent(self, int indentSize) Set the number of spaces used for one level of indentation. """ return _stc.StyledTextCtrl_SetIndent(*args, **kwargs)
def SetIndentationGuides(
*args, **kwargs)
SetIndentationGuides(self, int indentView)
Show or hide indentation guides.
def SetIndentationGuides(*args, **kwargs): """ SetIndentationGuides(self, int indentView) Show or hide indentation guides. """ return _stc.StyledTextCtrl_SetIndentationGuides(*args, **kwargs)
def SetIndicatorCurrent(
*args, **kwargs)
SetIndicatorCurrent(self, int indicator)
Set the indicator used for IndicatorFillRange and IndicatorClearRange
def SetIndicatorCurrent(*args, **kwargs): """ SetIndicatorCurrent(self, int indicator) Set the indicator used for IndicatorFillRange and IndicatorClearRange """ return _stc.StyledTextCtrl_SetIndicatorCurrent(*args, **kwargs)
def SetIndicatorValue(
*args, **kwargs)
SetIndicatorValue(self, int value)
Set the value used for IndicatorFillRange
def SetIndicatorValue(*args, **kwargs): """ SetIndicatorValue(self, int value) Set the value used for IndicatorFillRange """ return _stc.StyledTextCtrl_SetIndicatorValue(*args, **kwargs)
def SetInitialSize(
*args, **kwargs)
SetInitialSize(self, Size size=DefaultSize)
A 'Smart' SetSize that will fill in default size components with the window's best size values. Also set's the minsize for use with sizers.
def SetInitialSize(*args, **kwargs): """ SetInitialSize(self, Size size=DefaultSize) A 'Smart' SetSize that will fill in default size components with the window's *best size* values. Also set's the minsize for use with sizers. """ return _core_.Window_SetInitialSize(*args, **kwargs)
def SetInsertionPoint(
*args, **kwargs)
SetInsertionPoint(self, long pos)
Sets the insertion point in the combobox text field.
def SetInsertionPoint(*args, **kwargs): """ SetInsertionPoint(self, long pos) Sets the insertion point in the combobox text field. """ return _core_.TextEntryBase_SetInsertionPoint(*args, **kwargs)
def SetInsertionPointEnd(
*args, **kwargs)
SetInsertionPointEnd(self)
Move the insertion point to the end of the current value.
def SetInsertionPointEnd(*args, **kwargs): """ SetInsertionPointEnd(self) Move the insertion point to the end of the current value. """ return _core_.TextEntryBase_SetInsertionPointEnd(*args, **kwargs)
def SetKeyWords(
*args, **kwargs)
SetKeyWords(self, int keywordSet, String keyWords)
Set up the key words used by the lexer.
def SetKeyWords(*args, **kwargs): """ SetKeyWords(self, int keywordSet, String keyWords) Set up the key words used by the lexer. """ return _stc.StyledTextCtrl_SetKeyWords(*args, **kwargs)
def SetKeysUnicode(
*args, **kwargs)
SetKeysUnicode(self, bool keysUnicode)
Always interpret keyboard input as Unicode
def SetKeysUnicode(*args, **kwargs): """ SetKeysUnicode(self, bool keysUnicode) Always interpret keyboard input as Unicode """ return _stc.StyledTextCtrl_SetKeysUnicode(*args, **kwargs)
def SetLabel(
*args, **kwargs)
SetLabel(self, String label)
Set the text which the window shows in its label if applicable.
def SetLabel(*args, **kwargs): """ SetLabel(self, String label) Set the text which the window shows in its label if applicable. """ return _core_.Window_SetLabel(*args, **kwargs)
def SetLabelMarkup(
*args, **kwargs)
SetLabelMarkup(self, String markup) -> bool
def SetLabelMarkup(*args, **kwargs): """SetLabelMarkup(self, String markup) -> bool""" return _core_.Control_SetLabelMarkup(*args, **kwargs)
def SetLabelText(
*args, **kwargs)
SetLabelText(self, String text)
def SetLabelText(*args, **kwargs): """SetLabelText(self, String text)""" return _core_.Control_SetLabelText(*args, **kwargs)
def SetLastKeydownProcessed(
*args, **kwargs)
SetLastKeydownProcessed(self, bool val)
def SetLastKeydownProcessed(*args, **kwargs): """SetLastKeydownProcessed(self, bool val)""" return _stc.StyledTextCtrl_SetLastKeydownProcessed(*args, **kwargs)
def SetLayoutCache(
*args, **kwargs)
SetLayoutCache(self, int mode)
Sets the degree of caching of layout information.
def SetLayoutCache(*args, **kwargs): """ SetLayoutCache(self, int mode) Sets the degree of caching of layout information. """ return _stc.StyledTextCtrl_SetLayoutCache(*args, **kwargs)
def SetLayoutDirection(
*args, **kwargs)
SetLayoutDirection(self, int dir)
Set the layout direction (LTR or RTL) for this window.
def SetLayoutDirection(*args, **kwargs): """ SetLayoutDirection(self, int dir) Set the layout direction (LTR or RTL) for this window. """ return _core_.Window_SetLayoutDirection(*args, **kwargs)
def SetLexer(
*args, **kwargs)
SetLexer(self, int lexer)
Set the lexing language of the document.
def SetLexer(*args, **kwargs): """ SetLexer(self, int lexer) Set the lexing language of the document. """ return _stc.StyledTextCtrl_SetLexer(*args, **kwargs)
def SetLexerLanguage(
*args, **kwargs)
SetLexerLanguage(self, String language)
Set the lexing language of the document based on string name.
def SetLexerLanguage(*args, **kwargs): """ SetLexerLanguage(self, String language) Set the lexing language of the document based on string name. """ return _stc.StyledTextCtrl_SetLexerLanguage(*args, **kwargs)
def SetLineIndentation(
*args, **kwargs)
SetLineIndentation(self, int line, int indentSize)
Change the indentation of a line to a number of columns.
def SetLineIndentation(*args, **kwargs): """ SetLineIndentation(self, int line, int indentSize) Change the indentation of a line to a number of columns. """ return _stc.StyledTextCtrl_SetLineIndentation(*args, **kwargs)
def SetLineState(
*args, **kwargs)
SetLineState(self, int line, int state)
Used to hold extra styling information for each line.
def SetLineState(*args, **kwargs): """ SetLineState(self, int line, int state) Used to hold extra styling information for each line. """ return _stc.StyledTextCtrl_SetLineState(*args, **kwargs)
def SetMainSelection(
*args, **kwargs)
SetMainSelection(self, int selection)
Set the main selection
def SetMainSelection(*args, **kwargs): """ SetMainSelection(self, int selection) Set the main selection """ return _stc.StyledTextCtrl_SetMainSelection(*args, **kwargs)
def SetMarginCursor(
*args, **kwargs)
SetMarginCursor(self, int margin, int cursor)
def SetMarginCursor(*args, **kwargs): """SetMarginCursor(self, int margin, int cursor)""" return _stc.StyledTextCtrl_SetMarginCursor(*args, **kwargs)
def SetMarginLeft(
*args, **kwargs)
SetMarginLeft(self, int pixelWidth)
Sets the size in pixels of the left margin.
def SetMarginLeft(*args, **kwargs): """ SetMarginLeft(self, int pixelWidth) Sets the size in pixels of the left margin. """ return _stc.StyledTextCtrl_SetMarginLeft(*args, **kwargs)
def SetMarginMask(
*args, **kwargs)
SetMarginMask(self, int margin, int mask)
Set a mask that determines which markers are displayed in a margin.
def SetMarginMask(*args, **kwargs): """ SetMarginMask(self, int margin, int mask) Set a mask that determines which markers are displayed in a margin. """ return _stc.StyledTextCtrl_SetMarginMask(*args, **kwargs)
def SetMarginOptions(
*args, **kwargs)
SetMarginOptions(self, int marginOptions)
def SetMarginOptions(*args, **kwargs): """SetMarginOptions(self, int marginOptions)""" return _stc.StyledTextCtrl_SetMarginOptions(*args, **kwargs)
def SetMarginRight(
*args, **kwargs)
SetMarginRight(self, int pixelWidth)
Sets the size in pixels of the right margin.
def SetMarginRight(*args, **kwargs): """ SetMarginRight(self, int pixelWidth) Sets the size in pixels of the right margin. """ return _stc.StyledTextCtrl_SetMarginRight(*args, **kwargs)
def SetMarginSensitive(
*args, **kwargs)
SetMarginSensitive(self, int margin, bool sensitive)
Make a margin sensitive or insensitive to mouse clicks.
def SetMarginSensitive(*args, **kwargs): """ SetMarginSensitive(self, int margin, bool sensitive) Make a margin sensitive or insensitive to mouse clicks. """ return _stc.StyledTextCtrl_SetMarginSensitive(*args, **kwargs)
def SetMarginType(
*args, **kwargs)
SetMarginType(self, int margin, int marginType)
Set a margin to be either numeric or symbolic.
def SetMarginType(*args, **kwargs): """ SetMarginType(self, int margin, int marginType) Set a margin to be either numeric or symbolic. """ return _stc.StyledTextCtrl_SetMarginType(*args, **kwargs)
def SetMarginWidth(
*args, **kwargs)
SetMarginWidth(self, int margin, int pixelWidth)
Set the width of a margin to a width expressed in pixels.
def SetMarginWidth(*args, **kwargs): """ SetMarginWidth(self, int margin, int pixelWidth) Set the width of a margin to a width expressed in pixels. """ return _stc.StyledTextCtrl_SetMarginWidth(*args, **kwargs)
def SetMargins(
*args, **kwargs)
SetMargins(self, int left, int right)
Set the left and right margin in the edit area, measured in pixels.
def SetMargins(*args, **kwargs): """ SetMargins(self, int left, int right) Set the left and right margin in the edit area, measured in pixels. """ return _stc.StyledTextCtrl_SetMargins(*args, **kwargs)
def SetMaxClientSize(
*args, **kwargs)
SetMaxClientSize(self, Size size)
def SetMaxClientSize(*args, **kwargs): """SetMaxClientSize(self, Size size)""" return _core_.Window_SetMaxClientSize(*args, **kwargs)
def SetMaxLength(
*args, **kwargs)
SetMaxLength(self, long len)
Set the max number of characters which may be entered in a single line text control.
def SetMaxLength(*args, **kwargs): """ SetMaxLength(self, long len) Set the max number of characters which may be entered in a single line text control. """ return _core_.TextEntryBase_SetMaxLength(*args, **kwargs)
def SetMaxSize(
*args, **kwargs)
SetMaxSize(self, Size maxSize)
A more convenient method than SetSizeHints for setting just the
max size.
def SetMaxSize(*args, **kwargs): """ SetMaxSize(self, Size maxSize) A more convenient method than `SetSizeHints` for setting just the max size. """ return _core_.Window_SetMaxSize(*args, **kwargs)
def SetMinClientSize(
*args, **kwargs)
SetMinClientSize(self, Size size)
def SetMinClientSize(*args, **kwargs): """SetMinClientSize(self, Size size)""" return _core_.Window_SetMinClientSize(*args, **kwargs)
def SetMinSize(
*args, **kwargs)
SetMinSize(self, Size minSize)
A more convenient method than SetSizeHints for setting just the
min size.
def SetMinSize(*args, **kwargs): """ SetMinSize(self, Size minSize) A more convenient method than `SetSizeHints` for setting just the min size. """ return _core_.Window_SetMinSize(*args, **kwargs)
def SetModEventMask(
*args, **kwargs)
SetModEventMask(self, int mask)
Set which document modification events are sent to the container.
def SetModEventMask(*args, **kwargs): """ SetModEventMask(self, int mask) Set which document modification events are sent to the container. """ return _stc.StyledTextCtrl_SetModEventMask(*args, **kwargs)
def SetModified(
*args, **kwargs)
SetModified(self, bool modified)
def SetModified(*args, **kwargs): """SetModified(self, bool modified)""" return _core_.TextAreaBase_SetModified(*args, **kwargs)
def SetMouseDownCaptures(
*args, **kwargs)
SetMouseDownCaptures(self, bool captures)
Set whether the mouse is captured when its button is pressed.
def SetMouseDownCaptures(*args, **kwargs): """ SetMouseDownCaptures(self, bool captures) Set whether the mouse is captured when its button is pressed. """ return _stc.StyledTextCtrl_SetMouseDownCaptures(*args, **kwargs)
def SetMouseDwellTime(
*args, **kwargs)
SetMouseDwellTime(self, int periodMilliseconds)
Sets the time the mouse must sit still to generate a mouse dwell event.
def SetMouseDwellTime(*args, **kwargs): """ SetMouseDwellTime(self, int periodMilliseconds) Sets the time the mouse must sit still to generate a mouse dwell event. """ return _stc.StyledTextCtrl_SetMouseDwellTime(*args, **kwargs)
def SetMultiPaste(
*args, **kwargs)
SetMultiPaste(self, int multiPaste)
def SetMultiPaste(*args, **kwargs): """SetMultiPaste(self, int multiPaste)""" return _stc.StyledTextCtrl_SetMultiPaste(*args, **kwargs)
def SetMultipleSelection(
*args, **kwargs)
SetMultipleSelection(self, bool multipleSelection)
Set whether multiple selections can be made
def SetMultipleSelection(*args, **kwargs): """ SetMultipleSelection(self, bool multipleSelection) Set whether multiple selections can be made """ return _stc.StyledTextCtrl_SetMultipleSelection(*args, **kwargs)
def SetName(
*args, **kwargs)
SetName(self, String name)
Sets the window's name. The window name is used for ressource setting in X, it is not the same as the window title/label
def SetName(*args, **kwargs): """ SetName(self, String name) Sets the window's name. The window name is used for ressource setting in X, it is not the same as the window title/label """ return _core_.Window_SetName(*args, **kwargs)
def SetNextHandler(
*args, **kwargs)
SetNextHandler(self, EvtHandler handler)
def SetNextHandler(*args, **kwargs): """SetNextHandler(self, EvtHandler handler)""" return _core_.EvtHandler_SetNextHandler(*args, **kwargs)
def SetOvertype(
*args, **kwargs)
SetOvertype(self, bool overtype)
Set to overtype (true) or insert mode.
def SetOvertype(*args, **kwargs): """ SetOvertype(self, bool overtype) Set to overtype (true) or insert mode. """ return _stc.StyledTextCtrl_SetOvertype(*args, **kwargs)
def SetOwnBackgroundColour(
*args, **kwargs)
SetOwnBackgroundColour(self, Colour colour)
def SetOwnBackgroundColour(*args, **kwargs): """SetOwnBackgroundColour(self, Colour colour)""" return _core_.Window_SetOwnBackgroundColour(*args, **kwargs)
def SetOwnFont(
*args, **kwargs)
SetOwnFont(self, Font font)
def SetOwnFont(*args, **kwargs): """SetOwnFont(self, Font font)""" return _core_.Window_SetOwnFont(*args, **kwargs)
def SetOwnForegroundColour(
*args, **kwargs)
SetOwnForegroundColour(self, Colour colour)
def SetOwnForegroundColour(*args, **kwargs): """SetOwnForegroundColour(self, Colour colour)""" return _core_.Window_SetOwnForegroundColour(*args, **kwargs)
def SetPasteConvertEndings(
*args, **kwargs)
SetPasteConvertEndings(self, bool convert)
Enable/Disable convert-on-paste for line endings
def SetPasteConvertEndings(*args, **kwargs): """ SetPasteConvertEndings(self, bool convert) Enable/Disable convert-on-paste for line endings """ return _stc.StyledTextCtrl_SetPasteConvertEndings(*args, **kwargs)
def SetPosition(
*args, **kwargs)
Move(self, Point pt, int flags=SIZE_USE_EXISTING)
Moves the window to the given position.
def Move(*args, **kwargs): """ Move(self, Point pt, int flags=SIZE_USE_EXISTING) Moves the window to the given position. """ return _core_.Window_Move(*args, **kwargs)
def SetPositionCacheSize(
*args, **kwargs)
SetPositionCacheSize(self, int size)
Set number of entries in position cache
def SetPositionCacheSize(*args, **kwargs): """ SetPositionCacheSize(self, int size) Set number of entries in position cache """ return _stc.StyledTextCtrl_SetPositionCacheSize(*args, **kwargs)
def SetPreviousHandler(
*args, **kwargs)
SetPreviousHandler(self, EvtHandler handler)
def SetPreviousHandler(*args, **kwargs): """SetPreviousHandler(self, EvtHandler handler)""" return _core_.EvtHandler_SetPreviousHandler(*args, **kwargs)
def SetPrintColourMode(
*args, **kwargs)
SetPrintColourMode(self, int mode)
Modify colours when printing for clearer printed text.
def SetPrintColourMode(*args, **kwargs): """ SetPrintColourMode(self, int mode) Modify colours when printing for clearer printed text. """ return _stc.StyledTextCtrl_SetPrintColourMode(*args, **kwargs)
def SetPrintMagnification(
*args, **kwargs)
SetPrintMagnification(self, int magnification)
Sets the print magnification added to the point size of each style for printing.
def SetPrintMagnification(*args, **kwargs): """ SetPrintMagnification(self, int magnification) Sets the print magnification added to the point size of each style for printing. """ return _stc.StyledTextCtrl_SetPrintMagnification(*args, **kwargs)
def SetPrintWrapMode(
*args, **kwargs)
SetPrintWrapMode(self, int mode)
Set printing to line wrapped (SC_WRAP_WORD) or not line wrapped (SC_WRAP_NONE).
def SetPrintWrapMode(*args, **kwargs): """ SetPrintWrapMode(self, int mode) Set printing to line wrapped (SC_WRAP_WORD) or not line wrapped (SC_WRAP_NONE). """ return _stc.StyledTextCtrl_SetPrintWrapMode(*args, **kwargs)
def SetProperty(
*args, **kwargs)
SetProperty(self, String key, String value)
Set up a value that may be used by a lexer for some optional feature.
def SetProperty(*args, **kwargs): """ SetProperty(self, String key, String value) Set up a value that may be used by a lexer for some optional feature. """ return _stc.StyledTextCtrl_SetProperty(*args, **kwargs)
def SetPunctuationChars(
*args, **kwargs)
SetPunctuationChars(self, String characters)
def SetPunctuationChars(*args, **kwargs): """SetPunctuationChars(self, String characters)""" return _stc.StyledTextCtrl_SetPunctuationChars(*args, **kwargs)
def SetReadOnly(
*args, **kwargs)
SetReadOnly(self, bool readOnly)
Set to read only or read write.
def SetReadOnly(*args, **kwargs): """ SetReadOnly(self, bool readOnly) Set to read only or read write. """ return _stc.StyledTextCtrl_SetReadOnly(*args, **kwargs)
def SetRect(
*args, **kwargs)
SetRect(self, Rect rect, int sizeFlags=SIZE_AUTO)
Sets the position and size of the window in pixels using a wx.Rect.
def SetRect(*args, **kwargs): """ SetRect(self, Rect rect, int sizeFlags=SIZE_AUTO) Sets the position and size of the window in pixels using a wx.Rect. """ return _core_.Window_SetRect(*args, **kwargs)
def SetRectangularSelectionAnchor(
*args, **kwargs)
SetRectangularSelectionAnchor(self, int posAnchor)
def SetRectangularSelectionAnchor(*args, **kwargs): """SetRectangularSelectionAnchor(self, int posAnchor)""" return _stc.StyledTextCtrl_SetRectangularSelectionAnchor(*args, **kwargs)
def SetRectangularSelectionAnchorVirtualSpace(
*args, **kwargs)
SetRectangularSelectionAnchorVirtualSpace(self, int space)
def SetRectangularSelectionAnchorVirtualSpace(*args, **kwargs): """SetRectangularSelectionAnchorVirtualSpace(self, int space)""" return _stc.StyledTextCtrl_SetRectangularSelectionAnchorVirtualSpace(*args, **kwargs)
def SetRectangularSelectionCaret(
*args, **kwargs)
SetRectangularSelectionCaret(self, int pos)
def SetRectangularSelectionCaret(*args, **kwargs): """SetRectangularSelectionCaret(self, int pos)""" return _stc.StyledTextCtrl_SetRectangularSelectionCaret(*args, **kwargs)
def SetRectangularSelectionCaretVirtualSpace(
*args, **kwargs)
SetRectangularSelectionCaretVirtualSpace(self, int space)
def SetRectangularSelectionCaretVirtualSpace(*args, **kwargs): """SetRectangularSelectionCaretVirtualSpace(self, int space)""" return _stc.StyledTextCtrl_SetRectangularSelectionCaretVirtualSpace(*args, **kwargs)
def SetRectangularSelectionModifier(
*args, **kwargs)
SetRectangularSelectionModifier(self, int 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 SCMOD_CTRL(default), SCMOD_ALT, or SCMOD_SUPER.
def SetRectangularSelectionModifier(*args, **kwargs): """ SetRectangularSelectionModifier(self, int 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 SCMOD_CTRL(default), SCMOD_ALT, or SCMOD_SUPER. """ return _stc.StyledTextCtrl_SetRectangularSelectionModifier(*args, **kwargs)
def SetSTCCursor(
*args, **kwargs)
SetSTCCursor(self, int cursorType)
Sets the cursor to one of the SC_CURSOR* values.
def SetSTCCursor(*args, **kwargs): """ SetSTCCursor(self, int cursorType) Sets the cursor to one of the SC_CURSOR* values. """ return _stc.StyledTextCtrl_SetSTCCursor(*args, **kwargs)
def SetSTCFocus(
*args, **kwargs)
SetSTCFocus(self, bool focus)
Change internal focus flag.
def SetSTCFocus(*args, **kwargs): """ SetSTCFocus(self, bool focus) Change internal focus flag. """ return _stc.StyledTextCtrl_SetSTCFocus(*args, **kwargs)
def SetSavePoint(
*args, **kwargs)
SetSavePoint(self)
Remember the current position in the undo history as the position at which the document was saved.
def SetSavePoint(*args, **kwargs): """ SetSavePoint(self) Remember the current position in the undo history as the position at which the document was saved. """ return _stc.StyledTextCtrl_SetSavePoint(*args, **kwargs)
def SetScrollPos(
*args, **kwargs)
SetScrollPos(self, int orientation, int pos, bool refresh=True)
Sets the position of one of the built-in scrollbars.
def SetScrollPos(*args, **kwargs): """ SetScrollPos(self, int orientation, int pos, bool refresh=True) Sets the position of one of the built-in scrollbars. """ return _core_.Window_SetScrollPos(*args, **kwargs)
def SetScrollWidth(
*args, **kwargs)
SetScrollWidth(self, int pixelWidth)
Sets the document width assumed for scrolling.
def SetScrollWidth(*args, **kwargs): """ SetScrollWidth(self, int pixelWidth) Sets the document width assumed for scrolling. """ return _stc.StyledTextCtrl_SetScrollWidth(*args, **kwargs)
def SetScrollWidthTracking(
*args, **kwargs)
SetScrollWidthTracking(self, bool tracking)
Sets whether the maximum width line displayed is used to set scroll width.
def SetScrollWidthTracking(*args, **kwargs): """ SetScrollWidthTracking(self, bool tracking) Sets whether the maximum width line displayed is used to set scroll width. """ return _stc.StyledTextCtrl_SetScrollWidthTracking(*args, **kwargs)
def SetScrollbar(
*args, **kwargs)
SetScrollbar(self, int orientation, int position, int thumbSize, int range, bool refresh=True)
Sets the scrollbar properties of a built-in scrollbar.
def SetScrollbar(*args, **kwargs): """ SetScrollbar(self, int orientation, int position, int thumbSize, int range, bool refresh=True) Sets the scrollbar properties of a built-in scrollbar. """ return _core_.Window_SetScrollbar(*args, **kwargs)
def SetSearchFlags(
*args, **kwargs)
SetSearchFlags(self, int flags)
Set the search flags used by SearchInTarget.
def SetSearchFlags(*args, **kwargs): """ SetSearchFlags(self, int flags) Set the search flags used by SearchInTarget. """ return _stc.StyledTextCtrl_SetSearchFlags(*args, **kwargs)
def SetSelAlpha(
*args, **kwargs)
SetSelAlpha(self, int alpha)
Set the alpha of the selection.
def SetSelAlpha(*args, **kwargs): """ SetSelAlpha(self, int alpha) Set the alpha of the selection. """ return _stc.StyledTextCtrl_SetSelAlpha(*args, **kwargs)
def SetSelBackground(
*args, **kwargs)
SetSelBackground(self, bool useSetting, Colour back)
Set the background colour of the main and additional selections and whether to use this setting.
def SetSelBackground(*args, **kwargs): """ SetSelBackground(self, bool useSetting, Colour back) Set the background colour of the main and additional selections and whether to use this setting. """ return _stc.StyledTextCtrl_SetSelBackground(*args, **kwargs)
def SetSelEOLFilled(
*args, **kwargs)
SetSelEOLFilled(self, bool filled)
Set the selection to have its end of line filled or not.
def SetSelEOLFilled(*args, **kwargs): """ SetSelEOLFilled(self, bool filled) Set the selection to have its end of line filled or not. """ return _stc.StyledTextCtrl_SetSelEOLFilled(*args, **kwargs)
def SetSelForeground(
*args, **kwargs)
SetSelForeground(self, bool useSetting, Colour fore)
Set the foreground colour of the main and additional selections and whether to use this setting.
def SetSelForeground(*args, **kwargs): """ SetSelForeground(self, bool useSetting, Colour fore) Set the foreground colour of the main and additional selections and whether to use this setting. """ return _stc.StyledTextCtrl_SetSelForeground(*args, **kwargs)
def SetSelection(
*args, **kwargs)
SetSelection(self, long from, long to)
Selects the text starting at the first position up to (but not including) the character at the last position. If both parameters are -1 then all text in the control is selected.
def SetSelection(*args, **kwargs): """ SetSelection(self, long from, long to) Selects the text starting at the first position up to (but not including) the character at the last position. If both parameters are -1 then all text in the control is selected. """ return _core_.TextEntryBase_SetSelection(*args, **kwargs)
def SetSelectionEnd(
*args, **kwargs)
SetSelectionEnd(self, int pos)
Sets the position that ends the selection - this becomes the currentPosition.
def SetSelectionEnd(*args, **kwargs): """ SetSelectionEnd(self, int pos) Sets the position that ends the selection - this becomes the currentPosition. """ return _stc.StyledTextCtrl_SetSelectionEnd(*args, **kwargs)
def SetSelectionMode(
*args, **kwargs)
SetSelectionMode(self, int mode)
Set the selection mode to stream (SC_SEL_STREAM) or rectangular (SC_SEL_RECTANGLE/SC_SEL_THIN) or by lines (SC_SEL_LINES).
def SetSelectionMode(*args, **kwargs): """ SetSelectionMode(self, int mode) Set the selection mode to stream (SC_SEL_STREAM) or rectangular (SC_SEL_RECTANGLE/SC_SEL_THIN) or by lines (SC_SEL_LINES). """ return _stc.StyledTextCtrl_SetSelectionMode(*args, **kwargs)
def SetSelectionNAnchor(
*args, **kwargs)
SetSelectionNAnchor(self, int selection, int posAnchor)
def SetSelectionNAnchor(*args, **kwargs): """SetSelectionNAnchor(self, int selection, int posAnchor)""" return _stc.StyledTextCtrl_SetSelectionNAnchor(*args, **kwargs)
def SetSelectionNAnchorVirtualSpace(
*args, **kwargs)
SetSelectionNAnchorVirtualSpace(self, int selection, int space)
def SetSelectionNAnchorVirtualSpace(*args, **kwargs): """SetSelectionNAnchorVirtualSpace(self, int selection, int space)""" return _stc.StyledTextCtrl_SetSelectionNAnchorVirtualSpace(*args, **kwargs)
def SetSelectionNCaret(
*args, **kwargs)
SetSelectionNCaret(self, int selection, int pos)
def SetSelectionNCaret(*args, **kwargs): """SetSelectionNCaret(self, int selection, int pos)""" return _stc.StyledTextCtrl_SetSelectionNCaret(*args, **kwargs)
def SetSelectionNCaretVirtualSpace(
*args, **kwargs)
SetSelectionNCaretVirtualSpace(self, int selection, int space)
def SetSelectionNCaretVirtualSpace(*args, **kwargs): """SetSelectionNCaretVirtualSpace(self, int selection, int space)""" return _stc.StyledTextCtrl_SetSelectionNCaretVirtualSpace(*args, **kwargs)
def SetSelectionNEnd(
*args, **kwargs)
SetSelectionNEnd(self, int selection, int pos)
Sets the position that ends the selection - this becomes the currentPosition.
def SetSelectionNEnd(*args, **kwargs): """ SetSelectionNEnd(self, int selection, int pos) Sets the position that ends the selection - this becomes the currentPosition. """ return _stc.StyledTextCtrl_SetSelectionNEnd(*args, **kwargs)
def SetSelectionNStart(
*args, **kwargs)
SetSelectionNStart(self, int selection, int pos)
Sets the position that starts the selection - this becomes the anchor.
def SetSelectionNStart(*args, **kwargs): """ SetSelectionNStart(self, int selection, int pos) Sets the position that starts the selection - this becomes the anchor. """ return _stc.StyledTextCtrl_SetSelectionNStart(*args, **kwargs)
def SetSelectionStart(
*args, **kwargs)
SetSelectionStart(self, int pos)
Sets the position that starts the selection - this becomes the anchor.
def SetSelectionStart(*args, **kwargs): """ SetSelectionStart(self, int pos) Sets the position that starts the selection - this becomes the anchor. """ return _stc.StyledTextCtrl_SetSelectionStart(*args, **kwargs)
def SetSize(
*args, **kwargs)
SetSize(self, Size size)
Sets the size of the window in pixels.
def SetSize(*args, **kwargs): """ SetSize(self, Size size) Sets the size of the window in pixels. """ return _core_.Window_SetSize(*args, **kwargs)
def SetSizeHints(
*args, **kwargs)
SetSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1, int incW=-1, int incH=-1)
Allows specification of minimum and maximum window sizes, and window size increments. If a pair of values is not set (or set to -1), the default values will be used. If this function is called, the user will not be able to size the window outside the given bounds (if it is a top-level window.) Sizers will also inspect the minimum window size and will use that value if set when calculating layout.
The resizing increments are only significant under Motif or Xt.
def SetSizeHints(*args, **kwargs): """ SetSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1, int incW=-1, int incH=-1) Allows specification of minimum and maximum window sizes, and window size increments. If a pair of values is not set (or set to -1), the default values will be used. If this function is called, the user will not be able to size the window outside the given bounds (if it is a top-level window.) Sizers will also inspect the minimum window size and will use that value if set when calculating layout. The resizing increments are only significant under Motif or Xt. """ return _core_.Window_SetSizeHints(*args, **kwargs)
def SetSizeHintsSz(
*args, **kwargs)
SetSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize, Size incSize=DefaultSize)
Allows specification of minimum and maximum window sizes, and window size increments. If a pair of values is not set (or set to -1), the default values will be used. If this function is called, the user will not be able to size the window outside the given bounds (if it is a top-level window.) Sizers will also inspect the minimum window size and will use that value if set when calculating layout.
The resizing increments are only significant under Motif or Xt.
def SetSizeHintsSz(*args, **kwargs): """ SetSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize, Size incSize=DefaultSize) Allows specification of minimum and maximum window sizes, and window size increments. If a pair of values is not set (or set to -1), the default values will be used. If this function is called, the user will not be able to size the window outside the given bounds (if it is a top-level window.) Sizers will also inspect the minimum window size and will use that value if set when calculating layout. The resizing increments are only significant under Motif or Xt. """ return _core_.Window_SetSizeHintsSz(*args, **kwargs)
def SetSizeWH(
*args, **kwargs)
SetSizeWH(self, int width, int height)
Sets the size of the window in pixels.
def SetSizeWH(*args, **kwargs): """ SetSizeWH(self, int width, int height) Sets the size of the window in pixels. """ return _core_.Window_SetSizeWH(*args, **kwargs)
def SetSizer(
*args, **kwargs)
SetSizer(self, Sizer sizer, bool deleteOld=True)
Sets the window to have the given layout sizer. The window will then own the object, and will take care of its deletion. If an existing layout sizer object is already owned by the window, it will be deleted if the deleteOld parameter is true. Note that this function will also call SetAutoLayout implicitly with a True parameter if the sizer is non-None, and False otherwise.
def SetSizer(*args, **kwargs): """ SetSizer(self, Sizer sizer, bool deleteOld=True) Sets the window to have the given layout sizer. The window will then own the object, and will take care of its deletion. If an existing layout sizer object is already owned by the window, it will be deleted if the deleteOld parameter is true. Note that this function will also call SetAutoLayout implicitly with a True parameter if the sizer is non-None, and False otherwise. """ return _core_.Window_SetSizer(*args, **kwargs)
def SetSizerAndFit(
*args, **kwargs)
SetSizerAndFit(self, Sizer sizer, bool deleteOld=True)
The same as SetSizer, except it also sets the size hints for the window based on the sizer's minimum size.
def SetSizerAndFit(*args, **kwargs): """ SetSizerAndFit(self, Sizer sizer, bool deleteOld=True) The same as SetSizer, except it also sets the size hints for the window based on the sizer's minimum size. """ return _core_.Window_SetSizerAndFit(*args, **kwargs)
def SetStatus(
*args, **kwargs)
SetStatus(self, int statusCode)
Change error status - 0 = OK.
def SetStatus(*args, **kwargs): """ SetStatus(self, int statusCode) Change error status - 0 = OK. """ return _stc.StyledTextCtrl_SetStatus(*args, **kwargs)
def SetStyle(
*args, **kwargs)
SetStyle(self, long start, long end, wxTextAttr style) -> bool
def SetStyle(*args, **kwargs): """SetStyle(self, long start, long end, wxTextAttr style) -> bool""" return _core_.TextAreaBase_SetStyle(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_SetStyleBits(*args, **kwargs)
def SetStyleBytes(
*args, **kwargs)
SetStyleBytes(self, int length, char styleBytes)
Set the styles for a segment of the document.
def SetStyleBytes(*args, **kwargs): """ SetStyleBytes(self, int length, char styleBytes) Set the styles for a segment of the document. """ return _stc.StyledTextCtrl_SetStyleBytes(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_SetStyling(*args, **kwargs)
def SetTabIndents(
*args, **kwargs)
SetTabIndents(self, bool tabIndents)
Sets whether a tab pressed when caret is within indentation indents.
def SetTabIndents(*args, **kwargs): """ SetTabIndents(self, bool tabIndents) Sets whether a tab pressed when caret is within indentation indents. """ return _stc.StyledTextCtrl_SetTabIndents(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_SetTabWidth(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_SetTargetEnd(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_SetTargetStart(*args, **kwargs)
def SetTechnology(
*args, **kwargs)
SetTechnology(self, int technology)
def SetTechnology(*args, **kwargs): """SetTechnology(self, int technology)""" return _stc.StyledTextCtrl_SetTechnology(*args, **kwargs)
def SetText(
*args, **kwargs)
SetText(self, String text)
Replace the contents of the document with the argument text.
def SetText(*args, **kwargs): """ SetText(self, String text) Replace the contents of the document with the argument text. """ return _stc.StyledTextCtrl_SetText(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_SetTextRaw(*args, **kwargs)
def SetTextUTF8(
self, text)
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.
def SetTextUTF8(self, text): """ 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. """ if not wx.USE_UNICODE: u = text.decode('utf-8') text = u.encode(wx.GetDefaultPyEncoding()) self.SetTextRaw(text)
def SetThemeEnabled(
*args, **kwargs)
SetThemeEnabled(self, bool enableTheme)
This function tells a window if it should use the system's "theme" code to draw the windows' background instead if its own background drawing code. This will only have an effect on platforms that support the notion of themes in user defined windows. One such platform is GTK+ where windows can have (very colourful) backgrounds defined by a user's selected theme.
Dialogs, notebook pages and the status bar have this flag set to true by default so that the default look and feel is simulated best.
def SetThemeEnabled(*args, **kwargs): """ SetThemeEnabled(self, bool enableTheme) This function tells a window if it should use the system's "theme" code to draw the windows' background instead if its own background drawing code. This will only have an effect on platforms that support the notion of themes in user defined windows. One such platform is GTK+ where windows can have (very colourful) backgrounds defined by a user's selected theme. Dialogs, notebook pages and the status bar have this flag set to true by default so that the default look and feel is simulated best. """ return _core_.Window_SetThemeEnabled(*args, **kwargs)
def SetToolTip(
*args, **kwargs)
SetToolTip(self, ToolTip tip)
Attach a tooltip to the window.
def SetToolTip(*args, **kwargs): """ SetToolTip(self, ToolTip tip) Attach a tooltip to the window. """ return _core_.Window_SetToolTip(*args, **kwargs)
def SetToolTipString(
*args, **kwargs)
SetToolTipString(self, String tip)
Attach a tooltip to the window.
def SetToolTipString(*args, **kwargs): """ SetToolTipString(self, String tip) Attach a tooltip to the window. """ return _core_.Window_SetToolTipString(*args, **kwargs)
def SetTransparent(
*args, **kwargs)
SetTransparent(self, byte alpha) -> bool
Attempt to set the transparency of this window to the alpha value,
returns True on success. The alpha value is an integer in the
range of 0 to 255, where 0 is fully transparent and 255 is fully
opaque.
def SetTransparent(*args, **kwargs): """ SetTransparent(self, byte alpha) -> bool Attempt to set the transparency of this window to the ``alpha`` value, returns True on success. The ``alpha`` value is an integer in the range of 0 to 255, where 0 is fully transparent and 255 is fully opaque. """ return _core_.Window_SetTransparent(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_SetTwoPhaseDraw(*args, **kwargs)
def SetUndoCollection(
*args, **kwargs)
SetUndoCollection(self, bool collectUndo)
Choose between collecting actions into the undo history and discarding them.
def SetUndoCollection(*args, **kwargs): """ SetUndoCollection(self, bool collectUndo) Choose between collecting actions into the undo history and discarding them. """ return _stc.StyledTextCtrl_SetUndoCollection(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_SetUseAntiAliasing(*args, **kwargs)
def SetUseHorizontalScrollBar(
*args, **kwargs)
SetUseHorizontalScrollBar(self, bool show)
Show or hide the horizontal scroll bar.
def SetUseHorizontalScrollBar(*args, **kwargs): """ SetUseHorizontalScrollBar(self, bool show) Show or hide the horizontal scroll bar. """ return _stc.StyledTextCtrl_SetUseHorizontalScrollBar(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_SetUseTabs(*args, **kwargs)
def SetUseVerticalScrollBar(
*args, **kwargs)
SetUseVerticalScrollBar(self, bool show)
Show or hide the vertical scroll bar.
def SetUseVerticalScrollBar(*args, **kwargs): """ SetUseVerticalScrollBar(self, bool show) Show or hide the vertical scroll bar. """ return _stc.StyledTextCtrl_SetUseVerticalScrollBar(*args, **kwargs)
def SetVScrollBar(
*args, **kwargs)
SetVScrollBar(self, ScrollBar bar)
Set the vertical scrollbar to use instead of the one that's built-in.
def SetVScrollBar(*args, **kwargs): """ SetVScrollBar(self, ScrollBar bar) Set the vertical scrollbar to use instead of the one that's built-in. """ return _stc.StyledTextCtrl_SetVScrollBar(*args, **kwargs)
def SetValidator(
*args, **kwargs)
SetValidator(self, Validator validator)
Deletes the current validator (if any) and sets the window validator, having called wx.Validator.Clone to create a new validator of this type.
def SetValidator(*args, **kwargs): """ SetValidator(self, Validator validator) Deletes the current validator (if any) and sets the window validator, having called wx.Validator.Clone to create a new validator of this type. """ return _core_.Window_SetValidator(*args, **kwargs)
def SetValue(
*args, **kwargs)
SetValue(self, String value)
Set the value in the text entry field. Generates a text change event.
def SetValue(*args, **kwargs): """ SetValue(self, String value) Set the value in the text entry field. Generates a text change event. """ return _core_.TextEntryBase_SetValue(*args, **kwargs)
def SetViewEOL(
*args, **kwargs)
SetViewEOL(self, bool visible)
Make the end of line characters visible or invisible.
def SetViewEOL(*args, **kwargs): """ SetViewEOL(self, bool visible) Make the end of line characters visible or invisible. """ return _stc.StyledTextCtrl_SetViewEOL(*args, **kwargs)
def SetViewWhiteSpace(
*args, **kwargs)
SetViewWhiteSpace(self, int viewWS)
Make white space characters invisible, always visible or visible outside indentation.
def SetViewWhiteSpace(*args, **kwargs): """ SetViewWhiteSpace(self, int viewWS) Make white space characters invisible, always visible or visible outside indentation. """ return _stc.StyledTextCtrl_SetViewWhiteSpace(*args, **kwargs)
def SetVirtualSize(
*args, **kwargs)
SetVirtualSize(self, Size size)
Set the the virtual size of a window in pixels. For most windows this is just the client area of the window, but for some like scrolled windows it is more or less independent of the screen window size.
def SetVirtualSize(*args, **kwargs): """ SetVirtualSize(self, Size size) Set the the virtual size of a window in pixels. For most windows this is just the client area of the window, but for some like scrolled windows it is more or less independent of the screen window size. """ return _core_.Window_SetVirtualSize(*args, **kwargs)
def SetVirtualSizeHints(
*args, **kw)
SetVirtualSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1)
def deprecated_func(*args, **kw): warnings.warn("Call to deprecated item. %s" % msg, wxPyDeprecationWarning, stacklevel=2) return item(*args, **kw)
def SetVirtualSizeHintsSz(
*args, **kw)
SetVirtualSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize)
def deprecated_func(*args, **kw): warnings.warn("Call to deprecated item. %s" % msg, wxPyDeprecationWarning, stacklevel=2) return item(*args, **kw)
def SetVirtualSizeWH(
*args, **kwargs)
SetVirtualSizeWH(self, int w, int h)
Set the the virtual size of a window in pixels. For most windows this is just the client area of the window, but for some like scrolled windows it is more or less independent of the screen window size.
def SetVirtualSizeWH(*args, **kwargs): """ SetVirtualSizeWH(self, int w, int h) Set the the virtual size of a window in pixels. For most windows this is just the client area of the window, but for some like scrolled windows it is more or less independent of the screen window size. """ return _core_.Window_SetVirtualSizeWH(*args, **kwargs)
def SetVirtualSpaceOptions(
*args, **kwargs)
SetVirtualSpaceOptions(self, int virtualSpaceOptions)
def SetVirtualSpaceOptions(*args, **kwargs): """SetVirtualSpaceOptions(self, int virtualSpaceOptions)""" return _stc.StyledTextCtrl_SetVirtualSpaceOptions(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_SetVisiblePolicy(*args, **kwargs)
def SetWhitespaceBackground(
*args, **kwargs)
SetWhitespaceBackground(self, bool useSetting, Colour back)
Set the background colour of all whitespace and whether to use this setting.
def SetWhitespaceBackground(*args, **kwargs): """ SetWhitespaceBackground(self, bool useSetting, Colour back) Set the background colour of all whitespace and whether to use this setting. """ return _stc.StyledTextCtrl_SetWhitespaceBackground(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_SetWhitespaceChars(*args, **kwargs)
def SetWhitespaceForeground(
*args, **kwargs)
SetWhitespaceForeground(self, bool useSetting, Colour fore)
Set the foreground colour of all whitespace and whether to use this setting.
def SetWhitespaceForeground(*args, **kwargs): """ SetWhitespaceForeground(self, bool useSetting, Colour fore) Set the foreground colour of all whitespace and whether to use this setting. """ return _stc.StyledTextCtrl_SetWhitespaceForeground(*args, **kwargs)
def SetWhitespaceSize(
*args, **kwargs)
SetWhitespaceSize(self, int size)
Set the size of the dots used to mark space characters.
def SetWhitespaceSize(*args, **kwargs): """ SetWhitespaceSize(self, int size) Set the size of the dots used to mark space characters. """ return _stc.StyledTextCtrl_SetWhitespaceSize(*args, **kwargs)
def SetWindowStyle(
*args, **kwargs)
SetWindowStyleFlag(self, long style)
Sets the style of the window. Please note that some styles cannot be changed after the window creation and that Refresh() might need to be called after changing the others for the change to take place immediately.
def SetWindowStyleFlag(*args, **kwargs): """ SetWindowStyleFlag(self, long style) Sets the style of the window. Please note that some styles cannot be changed after the window creation and that Refresh() might need to be called after changing the others for the change to take place immediately. """ return _core_.Window_SetWindowStyleFlag(*args, **kwargs)
def SetWindowStyleFlag(
*args, **kwargs)
SetWindowStyleFlag(self, long style)
Sets the style of the window. Please note that some styles cannot be changed after the window creation and that Refresh() might need to be called after changing the others for the change to take place immediately.
def SetWindowStyleFlag(*args, **kwargs): """ SetWindowStyleFlag(self, long style) Sets the style of the window. Please note that some styles cannot be changed after the window creation and that Refresh() might need to be called after changing the others for the change to take place immediately. """ return _core_.Window_SetWindowStyleFlag(*args, **kwargs)
def SetWindowVariant(
*args, **kwargs)
SetWindowVariant(self, int variant)
Sets the variant of the window/font size to use for this window, if the platform supports variants, for example, wxMac.
def SetWindowVariant(*args, **kwargs): """ SetWindowVariant(self, int variant) Sets the variant of the window/font size to use for this window, if the platform supports variants, for example, wxMac. """ return _core_.Window_SetWindowVariant(*args, **kwargs)
def SetWordChars(
*args, **kwargs)
SetWordChars(self, String characters)
Set the set of characters making up words for when moving or selecting by word. First sets defaults like SetCharsDefault.
def SetWordChars(*args, **kwargs): """ SetWordChars(self, String characters) Set the set of characters making up words for when moving or selecting by word. First sets defaults like SetCharsDefault. """ return _stc.StyledTextCtrl_SetWordChars(*args, **kwargs)
def SetWrapIndentMode(
*args, **kwargs)
SetWrapIndentMode(self, int mode)
Sets how wrapped sublines are placed. Default is fixed.
def SetWrapIndentMode(*args, **kwargs): """ SetWrapIndentMode(self, int mode) Sets how wrapped sublines are placed. Default is fixed. """ return _stc.StyledTextCtrl_SetWrapIndentMode(*args, **kwargs)
def SetWrapMode(
*args, **kwargs)
SetWrapMode(self, int mode)
Sets whether text is word wrapped.
def SetWrapMode(*args, **kwargs): """ SetWrapMode(self, int mode) Sets whether text is word wrapped. """ return _stc.StyledTextCtrl_SetWrapMode(*args, **kwargs)
def SetWrapStartIndent(
*args, **kwargs)
SetWrapStartIndent(self, int indent)
Set the start indent for wrapped lines.
def SetWrapStartIndent(*args, **kwargs): """ SetWrapStartIndent(self, int indent) Set the start indent for wrapped lines. """ return _stc.StyledTextCtrl_SetWrapStartIndent(*args, **kwargs)
def SetWrapVisualFlags(
*args, **kwargs)
SetWrapVisualFlags(self, int wrapVisualFlags)
Set the display mode of visual flags for wrapped lines.
def SetWrapVisualFlags(*args, **kwargs): """ SetWrapVisualFlags(self, int wrapVisualFlags) Set the display mode of visual flags for wrapped lines. """ return _stc.StyledTextCtrl_SetWrapVisualFlags(*args, **kwargs)
def SetWrapVisualFlagsLocation(
*args, **kwargs)
SetWrapVisualFlagsLocation(self, int wrapVisualFlagsLocation)
Set the location of visual flags for wrapped lines.
def SetWrapVisualFlagsLocation(*args, **kwargs): """ SetWrapVisualFlagsLocation(self, int wrapVisualFlagsLocation) Set the location of visual flags for wrapped lines. """ return _stc.StyledTextCtrl_SetWrapVisualFlagsLocation(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_SetXCaretPolicy(*args, **kwargs)
def SetXOffset(
*args, **kwargs)
SetXOffset(self, int newOffset)
Get and Set the xOffset (ie, horizonal scroll position).
def SetXOffset(*args, **kwargs): """ SetXOffset(self, int newOffset) Get and Set the xOffset (ie, horizonal scroll position). """ return _stc.StyledTextCtrl_SetXOffset(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_SetYCaretPolicy(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_SetZoom(*args, **kwargs)
def ShouldInheritColours(
*args, **kwargs)
ShouldInheritColours(self) -> bool
Return true from here to allow the colours of this window to be changed by InheritAttributes, returning false forbids inheriting them from the parent window.
The base class version returns false, but this method is overridden in wxControl where it returns true.
def ShouldInheritColours(*args, **kwargs): """ ShouldInheritColours(self) -> bool Return true from here to allow the colours of this window to be changed by InheritAttributes, returning false forbids inheriting them from the parent window. The base class version returns false, but this method is overridden in wxControl where it returns true. """ return _core_.Window_ShouldInheritColours(*args, **kwargs)
def Show(
*args, **kwargs)
Show(self, bool show=True) -> bool
Shows or hides the window. You may need to call Raise for a top level window if you want to bring it to top, although this is not needed if Show is called immediately after the frame creation. Returns True if the window has been shown or hidden or False if nothing was done because it already was in the requested state.
def Show(*args, **kwargs): """ Show(self, bool show=True) -> bool Shows or hides the window. You may need to call Raise for a top level window if you want to bring it to top, although this is not needed if Show is called immediately after the frame creation. Returns True if the window has been shown or hidden or False if nothing was done because it already was in the requested state. """ return _core_.Window_Show(*args, **kwargs)
def ShowLines(
*args, **kwargs)
ShowLines(self, int lineStart, int lineEnd)
Make a range of lines visible.
def ShowLines(*args, **kwargs): """ ShowLines(self, int lineStart, int lineEnd) Make a range of lines visible. """ return _stc.StyledTextCtrl_ShowLines(*args, **kwargs)
def ShowPosition(
*args, **kwargs)
ShowPosition(self, long pos)
def ShowPosition(*args, **kwargs): """ShowPosition(self, long pos)""" return _core_.TextAreaBase_ShowPosition(*args, **kwargs)
def ShowWithEffect(
*args, **kwargs)
ShowWithEffect(self, int effect, unsigned int timeout=0) -> bool
Show the window with a special effect, not implemented on most platforms (where it is the same as Show())
Timeout specifies how long the animation should take, in ms, the default value of 0 means to use the default (system-dependent) value.
def ShowWithEffect(*args, **kwargs): """ ShowWithEffect(self, int effect, unsigned int timeout=0) -> bool Show the window with a special effect, not implemented on most platforms (where it is the same as Show()) Timeout specifies how long the animation should take, in ms, the default value of 0 means to use the default (system-dependent) value. """ return _core_.Window_ShowWithEffect(*args, **kwargs)
def StartRecord(
*args, **kwargs)
StartRecord(self)
Start notifying the container of all key presses and commands.
def StartRecord(*args, **kwargs): """ StartRecord(self) Start notifying the container of all key presses and commands. """ return _stc.StyledTextCtrl_StartRecord(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_StartStyling(*args, **kwargs)
def StopRecord(
*args, **kwargs)
StopRecord(self)
Stop notifying the container of all key presses and commands.
def StopRecord(*args, **kwargs): """ StopRecord(self) Stop notifying the container of all key presses and commands. """ return _stc.StyledTextCtrl_StopRecord(*args, **kwargs)
def StutteredPageDown(
*args, **kwargs)
StutteredPageDown(self)
Move caret to bottom of page, or one page down if already at bottom of page.
def StutteredPageDown(*args, **kwargs): """ StutteredPageDown(self) Move caret to bottom of page, or one page down if already at bottom of page. """ return _stc.StyledTextCtrl_StutteredPageDown(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_StutteredPageDownExtend(*args, **kwargs)
def StutteredPageUp(
*args, **kwargs)
StutteredPageUp(self)
Move caret to top of page, or one page up if already at top of page.
def StutteredPageUp(*args, **kwargs): """ StutteredPageUp(self) Move caret to top of page, or one page up if already at top of page. """ return _stc.StyledTextCtrl_StutteredPageUp(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_StutteredPageUpExtend(*args, **kwargs)
def StyleClearAll(
*args, **kwargs)
StyleClearAll(self)
Clear all the styles and make equivalent to the global default style.
def StyleClearAll(*args, **kwargs): """ StyleClearAll(self) Clear all the styles and make equivalent to the global default style. """ return _stc.StyledTextCtrl_StyleClearAll(*args, **kwargs)
def StyleGetBackground(
*args, **kwargs)
StyleGetBackground(self, int style) -> Colour
Get the background colour of a style.
def StyleGetBackground(*args, **kwargs): """ StyleGetBackground(self, int style) -> Colour Get the background colour of a style. """ return _stc.StyledTextCtrl_StyleGetBackground(*args, **kwargs)
def StyleGetBold(
*args, **kwargs)
StyleGetBold(self, int style) -> bool
Get is a style bold or not.
def StyleGetBold(*args, **kwargs): """ StyleGetBold(self, int style) -> bool Get is a style bold or not. """ return _stc.StyledTextCtrl_StyleGetBold(*args, **kwargs)
def StyleGetCase(
*args, **kwargs)
StyleGetCase(self, int style) -> int
Get is a style mixed case, or to force upper or lower case.
def StyleGetCase(*args, **kwargs): """ StyleGetCase(self, int style) -> int Get is a style mixed case, or to force upper or lower case. """ return _stc.StyledTextCtrl_StyleGetCase(*args, **kwargs)
def StyleGetChangeable(
*args, **kwargs)
StyleGetChangeable(self, int style) -> bool
Get is a style changeable or not (read only). Experimental feature, currently buggy.
def StyleGetChangeable(*args, **kwargs): """ StyleGetChangeable(self, int style) -> bool Get is a style changeable or not (read only). Experimental feature, currently buggy. """ return _stc.StyledTextCtrl_StyleGetChangeable(*args, **kwargs)
def StyleGetCharacterSet(
*args, **kwargs)
StyleGetCharacterSet(self, int style) -> int
Get the character set of the font in a style.
def StyleGetCharacterSet(*args, **kwargs): """ StyleGetCharacterSet(self, int style) -> int Get the character set of the font in a style. """ return _stc.StyledTextCtrl_StyleGetCharacterSet(*args, **kwargs)
def StyleGetEOLFilled(
*args, **kwargs)
StyleGetEOLFilled(self, int style) -> bool
Get is a style to have its end of line filled or not.
def StyleGetEOLFilled(*args, **kwargs): """ StyleGetEOLFilled(self, int style) -> bool Get is a style to have its end of line filled or not. """ return _stc.StyledTextCtrl_StyleGetEOLFilled(*args, **kwargs)
def StyleGetFaceName(
*args, **kwargs)
StyleGetFaceName(self, int style) -> String
Get the font facename of a style
def StyleGetFaceName(*args, **kwargs): """ StyleGetFaceName(self, int style) -> String Get the font facename of a style """ return _stc.StyledTextCtrl_StyleGetFaceName(*args, **kwargs)
def StyleGetFont(
*args, **kwargs)
StyleGetFont(self, int style) -> Font
def StyleGetFont(*args, **kwargs): """StyleGetFont(self, int style) -> Font""" return _stc.StyledTextCtrl_StyleGetFont(*args, **kwargs)
def StyleGetForeground(
*args, **kwargs)
StyleGetForeground(self, int style) -> Colour
Get the foreground colour of a style.
def StyleGetForeground(*args, **kwargs): """ StyleGetForeground(self, int style) -> Colour Get the foreground colour of a style. """ return _stc.StyledTextCtrl_StyleGetForeground(*args, **kwargs)
def StyleGetHotSpot(
*args, **kwargs)
StyleGetHotSpot(self, int style) -> bool
Get is a style a hotspot or not.
def StyleGetHotSpot(*args, **kwargs): """ StyleGetHotSpot(self, int style) -> bool Get is a style a hotspot or not. """ return _stc.StyledTextCtrl_StyleGetHotSpot(*args, **kwargs)
def StyleGetItalic(
*args, **kwargs)
StyleGetItalic(self, int style) -> bool
Get is a style italic or not.
def StyleGetItalic(*args, **kwargs): """ StyleGetItalic(self, int style) -> bool Get is a style italic or not. """ return _stc.StyledTextCtrl_StyleGetItalic(*args, **kwargs)
def StyleGetSize(
*args, **kwargs)
StyleGetSize(self, int style) -> int
Get the size of characters of a style.
def StyleGetSize(*args, **kwargs): """ StyleGetSize(self, int style) -> int Get the size of characters of a style. """ return _stc.StyledTextCtrl_StyleGetSize(*args, **kwargs)
def StyleGetSizeFractional(
*args, **kwargs)
StyleGetSizeFractional(self, int style) -> int
def StyleGetSizeFractional(*args, **kwargs): """StyleGetSizeFractional(self, int style) -> int""" return _stc.StyledTextCtrl_StyleGetSizeFractional(*args, **kwargs)
def StyleGetUnderline(
*args, **kwargs)
StyleGetUnderline(self, int style) -> bool
Get is a style underlined or not.
def StyleGetUnderline(*args, **kwargs): """ StyleGetUnderline(self, int style) -> bool Get is a style underlined or not. """ return _stc.StyledTextCtrl_StyleGetUnderline(*args, **kwargs)
def StyleGetVisible(
*args, **kwargs)
StyleGetVisible(self, int style) -> bool
Get is a style visible or not.
def StyleGetVisible(*args, **kwargs): """ StyleGetVisible(self, int style) -> bool Get is a style visible or not. """ return _stc.StyledTextCtrl_StyleGetVisible(*args, **kwargs)
def StyleGetWeight(
*args, **kwargs)
StyleGetWeight(self, int style) -> int
def StyleGetWeight(*args, **kwargs): """StyleGetWeight(self, int style) -> int""" return _stc.StyledTextCtrl_StyleGetWeight(*args, **kwargs)
def StyleResetDefault(
*args, **kwargs)
StyleResetDefault(self)
Reset the default style to its state at startup
def StyleResetDefault(*args, **kwargs): """ StyleResetDefault(self) Reset the default style to its state at startup """ return _stc.StyledTextCtrl_StyleResetDefault(*args, **kwargs)
def StyleSetBackground(
*args, **kwargs)
StyleSetBackground(self, int style, Colour back)
Set the background colour of a style.
def StyleSetBackground(*args, **kwargs): """ StyleSetBackground(self, int style, Colour back) Set the background colour of a style. """ return _stc.StyledTextCtrl_StyleSetBackground(*args, **kwargs)
def StyleSetBold(
*args, **kwargs)
StyleSetBold(self, int style, bool bold)
Set a style to be bold or not.
def StyleSetBold(*args, **kwargs): """ StyleSetBold(self, int style, bool bold) Set a style to be bold or not. """ return _stc.StyledTextCtrl_StyleSetBold(*args, **kwargs)
def StyleSetCase(
*args, **kwargs)
StyleSetCase(self, int style, int caseForce)
Set a style to be mixed case, or to force upper or lower case.
def StyleSetCase(*args, **kwargs): """ StyleSetCase(self, int style, int caseForce) Set a style to be mixed case, or to force upper or lower case. """ return _stc.StyledTextCtrl_StyleSetCase(*args, **kwargs)
def StyleSetChangeable(
*args, **kwargs)
StyleSetChangeable(self, int style, bool changeable)
Set a style to be changeable or not (read only). Experimental feature, currently buggy.
def StyleSetChangeable(*args, **kwargs): """ StyleSetChangeable(self, int style, bool changeable) Set a style to be changeable or not (read only). Experimental feature, currently buggy. """ return _stc.StyledTextCtrl_StyleSetChangeable(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_StyleSetCharacterSet(*args, **kwargs)
def StyleSetEOLFilled(
*args, **kwargs)
StyleSetEOLFilled(self, int style, bool filled)
Set a style to have its end of line filled or not.
def StyleSetEOLFilled(*args, **kwargs): """ StyleSetEOLFilled(self, int style, bool filled) Set a style to have its end of line filled or not. """ return _stc.StyledTextCtrl_StyleSetEOLFilled(*args, **kwargs)
def StyleSetFaceName(
*args, **kwargs)
StyleSetFaceName(self, int style, String fontName)
Set the font of a style.
def StyleSetFaceName(*args, **kwargs): """ StyleSetFaceName(self, int style, String fontName) Set the font of a style. """ return _stc.StyledTextCtrl_StyleSetFaceName(*args, **kwargs)
def 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.
def 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`. """ return _stc.StyledTextCtrl_StyleSetFont(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_StyleSetFontAttr(*args, **kwargs)
def StyleSetFontEncoding(
*args, **kwargs)
StyleSetFontEncoding(self, int style, int encoding)
Set the font encoding to be used by a style.
def StyleSetFontEncoding(*args, **kwargs): """ StyleSetFontEncoding(self, int style, int encoding) Set the font encoding to be used by a style. """ return _stc.StyledTextCtrl_StyleSetFontEncoding(*args, **kwargs)
def StyleSetForeground(
*args, **kwargs)
StyleSetForeground(self, int style, Colour fore)
Set the foreground colour of a style.
def StyleSetForeground(*args, **kwargs): """ StyleSetForeground(self, int style, Colour fore) Set the foreground colour of a style. """ return _stc.StyledTextCtrl_StyleSetForeground(*args, **kwargs)
def StyleSetHotSpot(
*args, **kwargs)
StyleSetHotSpot(self, int style, bool hotspot)
Set a style to be a hotspot or not.
def StyleSetHotSpot(*args, **kwargs): """ StyleSetHotSpot(self, int style, bool hotspot) Set a style to be a hotspot or not. """ return _stc.StyledTextCtrl_StyleSetHotSpot(*args, **kwargs)
def StyleSetItalic(
*args, **kwargs)
StyleSetItalic(self, int style, bool italic)
Set a style to be italic or not.
def StyleSetItalic(*args, **kwargs): """ StyleSetItalic(self, int style, bool italic) Set a style to be italic or not. """ return _stc.StyledTextCtrl_StyleSetItalic(*args, **kwargs)
def StyleSetSize(
*args, **kwargs)
StyleSetSize(self, int style, int sizePoints)
Set the size of characters of a style.
def StyleSetSize(*args, **kwargs): """ StyleSetSize(self, int style, int sizePoints) Set the size of characters of a style. """ return _stc.StyledTextCtrl_StyleSetSize(*args, **kwargs)
def StyleSetSizeFractional(
*args, **kwargs)
StyleSetSizeFractional(self, int style, int caseForce)
def StyleSetSizeFractional(*args, **kwargs): """StyleSetSizeFractional(self, int style, int caseForce)""" return _stc.StyledTextCtrl_StyleSetSizeFractional(*args, **kwargs)
def 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
def 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 """ return _stc.StyledTextCtrl_StyleSetSpec(*args, **kwargs)
def StyleSetUnderline(
*args, **kwargs)
StyleSetUnderline(self, int style, bool underline)
Set a style to be underlined or not.
def StyleSetUnderline(*args, **kwargs): """ StyleSetUnderline(self, int style, bool underline) Set a style to be underlined or not. """ return _stc.StyledTextCtrl_StyleSetUnderline(*args, **kwargs)
def StyleSetVisible(
*args, **kwargs)
StyleSetVisible(self, int style, bool visible)
Set a style to be visible or not.
def StyleSetVisible(*args, **kwargs): """ StyleSetVisible(self, int style, bool visible) Set a style to be visible or not. """ return _stc.StyledTextCtrl_StyleSetVisible(*args, **kwargs)
def StyleSetWeight(
*args, **kwargs)
StyleSetWeight(self, int style, int weight)
def StyleSetWeight(*args, **kwargs): """StyleSetWeight(self, int style, int weight)""" return _stc.StyledTextCtrl_StyleSetWeight(*args, **kwargs)
def SwapMainAnchorCaret(
*args, **kwargs)
SwapMainAnchorCaret(self)
Swap that caret and anchor of the main selection.
def SwapMainAnchorCaret(*args, **kwargs): """ SwapMainAnchorCaret(self) Swap that caret and anchor of the main selection. """ return _stc.StyledTextCtrl_SwapMainAnchorCaret(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_Tab(*args, **kwargs)
def TargetFromSelection(
*args, **kwargs)
TargetFromSelection(self)
Make the target range start and end be the same as the selection range start and end.
def TargetFromSelection(*args, **kwargs): """ TargetFromSelection(self) Make the target range start and end be the same as the selection range start and end. """ return _stc.StyledTextCtrl_TargetFromSelection(*args, **kwargs)
def TextHeight(
*args, **kwargs)
TextHeight(self, int line) -> int
Retrieve the height of a particular line of text in pixels.
def TextHeight(*args, **kwargs): """ TextHeight(self, int line) -> int Retrieve the height of a particular line of text in pixels. """ return _stc.StyledTextCtrl_TextHeight(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_TextWidth(*args, **kwargs)
def Thaw(
*args, **kwargs)
Thaw(self)
Reenables window updating after a previous call to Freeze. Calls to Freeze/Thaw may be nested, so Thaw must be called the same number of times that Freeze was before the window will be updated.
def Thaw(*args, **kwargs): """ Thaw(self) Reenables window updating after a previous call to Freeze. Calls to Freeze/Thaw may be nested, so Thaw must be called the same number of times that Freeze was before the window will be updated. """ return _core_.Window_Thaw(*args, **kwargs)
def ToggleCaretSticky(
*args, **kwargs)
ToggleCaretSticky(self)
Switch between sticky and non-sticky: meant to be bound to a key.
def ToggleCaretSticky(*args, **kwargs): """ ToggleCaretSticky(self) Switch between sticky and non-sticky: meant to be bound to a key. """ return _stc.StyledTextCtrl_ToggleCaretSticky(*args, **kwargs)
def ToggleFold(
*args, **kwargs)
ToggleFold(self, int line)
Switch a header line between expanded and contracted.
def ToggleFold(*args, **kwargs): """ ToggleFold(self, int line) Switch a header line between expanded and contracted. """ return _stc.StyledTextCtrl_ToggleFold(*args, **kwargs)
def ToggleWindowStyle(
*args, **kwargs)
ToggleWindowStyle(self, int flag) -> bool
Turn the flag on if it had been turned off before and vice versa, returns True if the flag is turned on by this function call.
def ToggleWindowStyle(*args, **kwargs): """ ToggleWindowStyle(self, int flag) -> bool Turn the flag on if it had been turned off before and vice versa, returns True if the flag is turned on by this function call. """ return _core_.Window_ToggleWindowStyle(*args, **kwargs)
def TransferDataFromWindow(
*args, **kwargs)
TransferDataFromWindow(self) -> bool
Transfers values from child controls to data areas specified by their validators. Returns false if a transfer failed. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will also call TransferDataFromWindow() of all child windows.
def TransferDataFromWindow(*args, **kwargs): """ TransferDataFromWindow(self) -> bool Transfers values from child controls to data areas specified by their validators. Returns false if a transfer failed. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will also call TransferDataFromWindow() of all child windows. """ return _core_.Window_TransferDataFromWindow(*args, **kwargs)
def TransferDataToWindow(
*args, **kwargs)
TransferDataToWindow(self) -> bool
Transfers values to child controls from data areas specified by their validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will also call TransferDataToWindow() of all child windows.
def TransferDataToWindow(*args, **kwargs): """ TransferDataToWindow(self) -> bool Transfers values to child controls from data areas specified by their validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will also call TransferDataToWindow() of all child windows. """ return _core_.Window_TransferDataToWindow(*args, **kwargs)
def Unbind(
self, event, source=None, id=-1, id2=-1, handler=None)
Disconnects the event handler binding for event from self. Returns True if successful.
def Unbind(self, event, source=None, id=wx.ID_ANY, id2=wx.ID_ANY, handler=None): """ Disconnects the event handler binding for event from self. Returns True if successful. """ if source is not None: id = source.GetId() return event.Unbind(self, id, id2, handler)
def Undo(
*args, **kwargs)
Undo(self)
Undoes the last edit in the text field
def Undo(*args, **kwargs): """ Undo(self) Undoes the last edit in the text field """ return _core_.TextEntryBase_Undo(*args, **kwargs)
def Unlink(
*args, **kwargs)
Unlink(self)
def Unlink(*args, **kwargs): """Unlink(self)""" return _core_.EvtHandler_Unlink(*args, **kwargs)
def UnregisterHotKey(
*args, **kwargs)
UnregisterHotKey(self, int hotkeyId) -> bool
Unregisters a system wide hotkey.
def UnregisterHotKey(*args, **kwargs): """ UnregisterHotKey(self, int hotkeyId) -> bool Unregisters a system wide hotkey. """ return _core_.Window_UnregisterHotKey(*args, **kwargs)
def UnsetToolTip(
*args, **kwargs)
UnsetToolTip(self)
def UnsetToolTip(*args, **kwargs): """UnsetToolTip(self)""" return _core_.Window_UnsetToolTip(*args, **kwargs)
def Update(
*args, **kwargs)
Update(self)
Calling this method immediately repaints the invalidated area of the
window instead of waiting for the EVT_PAINT event to happen, (normally
this would usually only happen when the flow of control returns to the
event loop.) Notice that this function doesn't refresh the window and
does nothing if the window has been already repainted. Use Refresh
first if you want to immediately redraw the window (or some portion of
it) unconditionally.
def Update(*args, **kwargs): """ Update(self) Calling this method immediately repaints the invalidated area of the window instead of waiting for the EVT_PAINT event to happen, (normally this would usually only happen when the flow of control returns to the event loop.) Notice that this function doesn't refresh the window and does nothing if the window has been already repainted. Use `Refresh` first if you want to immediately redraw the window (or some portion of it) unconditionally. """ return _core_.Window_Update(*args, **kwargs)
def UpdateWindowUI(
*args, **kwargs)
UpdateWindowUI(self, long flags=UPDATE_UI_NONE)
This function sends EVT_UPDATE_UI events to the window. The particular
implementation depends on the window; for example a wx.ToolBar will
send an update UI event for each toolbar button, and a wx.Frame will
send an update UI event for each menubar menu item. You can call this
function from your application to ensure that your UI is up-to-date at
a particular point in time (as far as your EVT_UPDATE_UI handlers are
concerned). This may be necessary if you have called
wx.UpdateUIEvent.SetMode or wx.UpdateUIEvent.SetUpdateInterval to
limit the overhead that wxWindows incurs by sending update UI events
in idle time.
def UpdateWindowUI(*args, **kwargs): """ UpdateWindowUI(self, long flags=UPDATE_UI_NONE) This function sends EVT_UPDATE_UI events to the window. The particular implementation depends on the window; for example a wx.ToolBar will send an update UI event for each toolbar button, and a wx.Frame will send an update UI event for each menubar menu item. You can call this function from your application to ensure that your UI is up-to-date at a particular point in time (as far as your EVT_UPDATE_UI handlers are concerned). This may be necessary if you have called `wx.UpdateUIEvent.SetMode` or `wx.UpdateUIEvent.SetUpdateInterval` to limit the overhead that wxWindows incurs by sending update UI events in idle time. """ return _core_.Window_UpdateWindowUI(*args, **kwargs)
def UpperCase(
*args, **kwargs)
UpperCase(self)
Transform the selection to upper case.
def UpperCase(*args, **kwargs): """ UpperCase(self) Transform the selection to upper case. """ return _stc.StyledTextCtrl_UpperCase(*args, **kwargs)
def UseBgCol(
*args, **kwargs)
UseBgCol(self) -> bool
def UseBgCol(*args, **kwargs): """UseBgCol(self) -> bool""" return _core_.Window_UseBgCol(*args, **kwargs)
def UsePopUp(
*args, **kwargs)
UsePopUp(self, bool allowPopUp)
Set whether a pop up menu is displayed automatically when the user presses the wrong mouse button.
def UsePopUp(*args, **kwargs): """ UsePopUp(self, bool allowPopUp) Set whether a pop up menu is displayed automatically when the user presses the wrong mouse button. """ return _stc.StyledTextCtrl_UsePopUp(*args, **kwargs)
def UserListShow(
*args, **kwargs)
UserListShow(self, int listType, String itemList)
Display a list of strings and send notification when user chooses one.
def UserListShow(*args, **kwargs): """ UserListShow(self, int listType, String itemList) Display a list of strings and send notification when user chooses one. """ return _stc.StyledTextCtrl_UserListShow(*args, **kwargs)
def VCHome(
*args, **kwargs)
VCHome(self)
Move caret to before first visible character on line. If already there move to first character on line.
def VCHome(*args, **kwargs): """ VCHome(self) Move caret to before first visible character on line. If already there move to first character on line. """ return _stc.StyledTextCtrl_VCHome(*args, **kwargs)
def VCHomeExtend(
*args, **kwargs)
VCHomeExtend(self)
Like VCHome but extending selection to new caret position.
def VCHomeExtend(*args, **kwargs): """ VCHomeExtend(self) Like VCHome but extending selection to new caret position. """ return _stc.StyledTextCtrl_VCHomeExtend(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_VCHomeRectExtend(*args, **kwargs)
def VCHomeWrap(
*args, **kwargs)
VCHomeWrap(self)
def VCHomeWrap(*args, **kwargs): """VCHomeWrap(self)""" return _stc.StyledTextCtrl_VCHomeWrap(*args, **kwargs)
def VCHomeWrapExtend(
*args, **kwargs)
VCHomeWrapExtend(self)
def VCHomeWrapExtend(*args, **kwargs): """VCHomeWrapExtend(self)""" return _stc.StyledTextCtrl_VCHomeWrapExtend(*args, **kwargs)
def Validate(
*args, **kwargs)
Validate(self) -> bool
Validates the current values of the child controls using their validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will also call Validate() of all child windows. Returns false if any of the validations failed.
def Validate(*args, **kwargs): """ Validate(self) -> bool Validates the current values of the child controls using their validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will also call Validate() of all child windows. Returns false if any of the validations failed. """ return _core_.Window_Validate(*args, **kwargs)
def VerticalCentreCaret(
*args, **kwargs)
VerticalCentreCaret(self)
def VerticalCentreCaret(*args, **kwargs): """VerticalCentreCaret(self)""" return _stc.StyledTextCtrl_VerticalCentreCaret(*args, **kwargs)
def VisibleFromDocLine(
*args, **kwargs)
VisibleFromDocLine(self, int line) -> int
Find the display line of a document line taking hidden lines into account.
def VisibleFromDocLine(*args, **kwargs): """ VisibleFromDocLine(self, int line) -> int Find the display line of a document line taking hidden lines into account. """ return _stc.StyledTextCtrl_VisibleFromDocLine(*args, **kwargs)
def WarpPointer(
*args, **kwargs)
WarpPointer(self, int x, int y)
Moves the pointer to the given position on the window.
NOTE: This function is not supported under Mac because Apple Human Interface Guidelines forbid moving the mouse cursor programmatically.
def WarpPointer(*args, **kwargs): """ WarpPointer(self, int x, int y) Moves the pointer to the given position on the window. NOTE: This function is not supported under Mac because Apple Human Interface Guidelines forbid moving the mouse cursor programmatically. """ return _core_.Window_WarpPointer(*args, **kwargs)
def WindowToClientSize(
*args, **kwargs)
WindowToClientSize(self, Size size) -> Size
Converts window size size to corresponding client area size. In
other words, the returned value is what GetClientSize would return
if this window had given window size. Components with
wxDefaultCoord (-1) value are left unchanged.
Note that the conversion is not always exact, it assumes that non-client area doesn't change and so doesn't take into account things like menu bar (un)wrapping or (dis)appearance of the scrollbars.
def WindowToClientSize(*args, **kwargs): """ WindowToClientSize(self, Size size) -> Size Converts window size ``size`` to corresponding client area size. In other words, the returned value is what `GetClientSize` would return if this window had given window size. Components with ``wxDefaultCoord`` (-1) value are left unchanged. Note that the conversion is not always exact, it assumes that non-client area doesn't change and so doesn't take into account things like menu bar (un)wrapping or (dis)appearance of the scrollbars. """ return _core_.Window_WindowToClientSize(*args, **kwargs)
def WordEndPosition(
*args, **kwargs)
WordEndPosition(self, int pos, bool onlyWordCharacters) -> int
Get position of end of word.
def WordEndPosition(*args, **kwargs): """ WordEndPosition(self, int pos, bool onlyWordCharacters) -> int Get position of end of word. """ return _stc.StyledTextCtrl_WordEndPosition(*args, **kwargs)
def WordLeft(
*args, **kwargs)
WordLeft(self)
Move caret left one word.
def WordLeft(*args, **kwargs): """ WordLeft(self) Move caret left one word. """ return _stc.StyledTextCtrl_WordLeft(*args, **kwargs)
def WordLeftEnd(
*args, **kwargs)
WordLeftEnd(self)
Move caret left one word, position cursor at end of word.
def WordLeftEnd(*args, **kwargs): """ WordLeftEnd(self) Move caret left one word, position cursor at end of word. """ return _stc.StyledTextCtrl_WordLeftEnd(*args, **kwargs)
def WordLeftEndExtend(
*args, **kwargs)
WordLeftEndExtend(self)
Move caret left one word, position cursor at end of word, extending selection to new caret position.
def WordLeftEndExtend(*args, **kwargs): """ WordLeftEndExtend(self) Move caret left one word, position cursor at end of word, extending selection to new caret position. """ return _stc.StyledTextCtrl_WordLeftEndExtend(*args, **kwargs)
def WordLeftExtend(
*args, **kwargs)
WordLeftExtend(self)
Move caret left one word extending selection to new caret position.
def WordLeftExtend(*args, **kwargs): """ WordLeftExtend(self) Move caret left one word extending selection to new caret position. """ return _stc.StyledTextCtrl_WordLeftExtend(*args, **kwargs)
def WordPartLeft(
*args, **kwargs)
WordPartLeft(self)
Move to the previous change in capitalisation.
def WordPartLeft(*args, **kwargs): """ WordPartLeft(self) Move to the previous change in capitalisation. """ return _stc.StyledTextCtrl_WordPartLeft(*args, **kwargs)
def WordPartLeftExtend(
*args, **kwargs)
WordPartLeftExtend(self)
Move to the previous change in capitalisation extending selection to new caret position.
def WordPartLeftExtend(*args, **kwargs): """ WordPartLeftExtend(self) Move to the previous change in capitalisation extending selection to new caret position. """ return _stc.StyledTextCtrl_WordPartLeftExtend(*args, **kwargs)
def WordPartRight(
*args, **kwargs)
WordPartRight(self)
Move to the change next in capitalisation.
def WordPartRight(*args, **kwargs): """ WordPartRight(self) Move to the change next in capitalisation. """ return _stc.StyledTextCtrl_WordPartRight(*args, **kwargs)
def WordPartRightExtend(
*args, **kwargs)
WordPartRightExtend(self)
Move to the next change in capitalisation extending selection to new caret position.
def WordPartRightExtend(*args, **kwargs): """ WordPartRightExtend(self) Move to the next change in capitalisation extending selection to new caret position. """ return _stc.StyledTextCtrl_WordPartRightExtend(*args, **kwargs)
def WordRight(
*args, **kwargs)
WordRight(self)
Move caret right one word.
def WordRight(*args, **kwargs): """ WordRight(self) Move caret right one word. """ return _stc.StyledTextCtrl_WordRight(*args, **kwargs)
def WordRightEnd(
*args, **kwargs)
WordRightEnd(self)
Move caret right one word, position cursor at end of word.
def WordRightEnd(*args, **kwargs): """ WordRightEnd(self) Move caret right one word, position cursor at end of word. """ return _stc.StyledTextCtrl_WordRightEnd(*args, **kwargs)
def WordRightEndExtend(
*args, **kwargs)
WordRightEndExtend(self)
Move caret right one word, position cursor at end of word, extending selection to new caret position.
def WordRightEndExtend(*args, **kwargs): """ WordRightEndExtend(self) Move caret right one word, position cursor at end of word, extending selection to new caret position. """ return _stc.StyledTextCtrl_WordRightEndExtend(*args, **kwargs)
def WordRightExtend(
*args, **kwargs)
WordRightExtend(self)
Move caret right one word extending selection to new caret position.
def WordRightExtend(*args, **kwargs): """ WordRightExtend(self) Move caret right one word extending selection to new caret position. """ return _stc.StyledTextCtrl_WordRightExtend(*args, **kwargs)
def WordStartPosition(
*args, **kwargs)
WordStartPosition(self, int pos, bool onlyWordCharacters) -> int
Get position of start of word.
def WordStartPosition(*args, **kwargs): """ WordStartPosition(self, int pos, bool onlyWordCharacters) -> int Get position of start of word. """ return _stc.StyledTextCtrl_WordStartPosition(*args, **kwargs)
def WrapCount(
*args, **kwargs)
WrapCount(self, int line) -> int
The number of display lines needed to wrap a document line
def WrapCount(*args, **kwargs): """ WrapCount(self, int line) -> int The number of display lines needed to wrap a document line """ return _stc.StyledTextCtrl_WrapCount(*args, **kwargs)
def WriteText(
*args, **kwargs)
WriteText(self, String text)
Insert text at the current insertion point in the text field, replacing any text that is currently selected.
def WriteText(*args, **kwargs): """ WriteText(self, String text) Insert text at the current insertion point in the text field, replacing any text that is currently selected. """ return _core_.TextEntryBase_WriteText(*args, **kwargs)
def XYToPosition(
*args, **kwargs)
XYToPosition(self, long x, long y) -> long
def XYToPosition(*args, **kwargs): """XYToPosition(self, long x, long y) -> long""" return _core_.TextAreaBase_XYToPosition(*args, **kwargs)
def ZoomIn(
*args, **kwargs)
ZoomIn(self)
Magnify the displayed text by increasing the sizes by 1 point.
def ZoomIn(*args, **kwargs): """ ZoomIn(self) Magnify the displayed text by increasing the sizes by 1 point. """ return _stc.StyledTextCtrl_ZoomIn(*args, **kwargs)
def ZoomOut(
*args, **kwargs)
ZoomOut(self)
Make the displayed text smaller by decreasing the sizes by 1 point.
def ZoomOut(*args, **kwargs): """ ZoomOut(self) Make the displayed text smaller by decreasing the sizes by 1 point. """ return _stc.StyledTextCtrl_ZoomOut(*args, **kwargs)
class StyledTextCtrlPanel
class StyledTextCtrlPanel(wx.Panel): _custom_classes = {'wx.stc.StyledTextCtrl': ['PythonSTC','XMLSTC']} def _init_coll_boxSizer1_Items(self, parent): # generated method, don't edit parent.Add(self.styledTextCtrl1, 1, border=2, flag=wx.EXPAND) def _init_sizers(self): # generated method, don't edit self.boxSizer1 = wx.BoxSizer(orient=wx.VERTICAL) self._init_coll_boxSizer1_Items(self.boxSizer1) self.SetSizer(self.boxSizer1) def _init_ctrls(self, prnt): # generated method, don't edit wx.Panel.__init__(self, id=wxID_STYLEDTEXTCTRLPANEL, name='StyledTextCtrlPanel', parent=prnt, pos=wx.Point(519, 269), size=wx.Size(589, 342), style=wx.TAB_TRAVERSAL) self.SetClientSize(wx.Size(573, 304)) self.styledTextCtrl1 = XMLSTC(id=wxID_STYLEDTEXTCTRLPANELSTYLEDTEXTCTRL1, name='styledTextCtrl1', parent=self, pos=wx.Point(0, 0), size=wx.Size(573, 304), style=0) self._init_sizers() def __init__(self, parent, id, pos, size, style, name): self._init_ctrls(parent)
Ancestors (in MRO)
- StyledTextCtrlPanel
- wx._windows.Panel
- wx._core.Window
- wx._core.EvtHandler
- wx._core.Object
- __builtin__.object
Static methods
def FindFocus(
*args, **kwargs)
FindFocus() -> Window
Returns the window or control that currently has the keyboard focus, or None.
def FindFocus(*args, **kwargs): """ FindFocus() -> Window Returns the window or control that currently has the keyboard focus, or None. """ return _core_.Window_FindFocus(*args, **kwargs)
def GetCapture(
*args, **kwargs)
GetCapture() -> Window
Returns the window which currently captures the mouse or None
def GetCapture(*args, **kwargs): """ GetCapture() -> Window Returns the window which currently captures the mouse or None """ return _core_.Window_GetCapture(*args, **kwargs)
def GetClassDefaultAttributes(
*args, **kwargs)
GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
Get the default attributes for this class. This is useful if you want to use the same font or colour in your own control as in a standard control -- which is a much better idea than hard coding specific colours or fonts which might look completely out of place on the user's system, especially if it uses themes.
The variant parameter is only relevant under Mac currently and is
ignore under other platforms. Under Mac, it will change the size of
the returned font. See wx.Window.SetWindowVariant for more about
this.
def GetClassDefaultAttributes(*args, **kwargs): """ GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes Get the default attributes for this class. This is useful if you want to use the same font or colour in your own control as in a standard control -- which is a much better idea than hard coding specific colours or fonts which might look completely out of place on the user's system, especially if it uses themes. The variant parameter is only relevant under Mac currently and is ignore under other platforms. Under Mac, it will change the size of the returned font. See `wx.Window.SetWindowVariant` for more about this. """ return _windows_.Panel_GetClassDefaultAttributes(*args, **kwargs)
def NewControlId(
*args, **kwargs)
NewControlId(int count=1) -> int
Generate a unique id (or count of them consecutively), returns a valid id in the auto-id range or wxID_NONE if failed. If using autoid management, it will mark the id as reserved until it is used (by assigning it to a wxWindowIDRef) or unreserved.
def NewControlId(*args, **kwargs): """ NewControlId(int count=1) -> int Generate a unique id (or count of them consecutively), returns a valid id in the auto-id range or wxID_NONE if failed. If using autoid management, it will mark the id as reserved until it is used (by assigning it to a wxWindowIDRef) or unreserved. """ return _core_.Window_NewControlId(*args, **kwargs)
def ReleaseControlId(
id)
def ReleaseControlId(id): UnreserveControlId(id)
def UnreserveControlId(
*args, **kwargs)
UnreserveControlId(int id, int count=1)
If an ID generated from NewControlId is not assigned to a wxWindowIDRef, it must be unreserved.
def UnreserveControlId(*args, **kwargs): """ UnreserveControlId(int id, int count=1) If an ID generated from NewControlId is not assigned to a wxWindowIDRef, it must be unreserved. """ return _core_.Window_UnreserveControlId(*args, **kwargs)
Instance variables
var AcceleratorTable
See GetAcceleratorTable and SetAcceleratorTable
var AutoLayout
See GetAutoLayout and SetAutoLayout
var BackgroundColour
See GetBackgroundColour and SetBackgroundColour
var BackgroundStyle
See GetBackgroundStyle and SetBackgroundStyle
var BestSize
See GetBestSize
var BestVirtualSize
See GetBestVirtualSize
var Border
See GetBorder
var Caret
See GetCaret and SetCaret
var CharHeight
See GetCharHeight
var CharWidth
See GetCharWidth
var Children
See GetChildren
var ClassName
See GetClassName
var ClientAreaOrigin
See GetClientAreaOrigin
var ClientRect
See GetClientRect and SetClientRect
var ClientSize
See GetClientSize and SetClientSize
var Constraints
See GetConstraints and SetConstraints
var ContainingSizer
See GetContainingSizer and SetContainingSizer
var Cursor
See GetCursor and SetCursor
var DefaultAttributes
See GetDefaultAttributes
var DropTarget
See GetDropTarget and SetDropTarget
var EffectiveMinSize
See GetEffectiveMinSize
var Enabled
See IsEnabled and Enable
var EventHandler
See GetEventHandler and SetEventHandler
var EvtHandlerEnabled
See GetEvtHandlerEnabled and SetEvtHandlerEnabled
var ExtraStyle
See GetExtraStyle and SetExtraStyle
var Font
See GetFont and SetFont
var ForegroundColour
See GetForegroundColour and SetForegroundColour
var GrandParent
See GetGrandParent
var GtkWidget
GetGtkWidget(self) -> long
On wxGTK returns a pointer to the GtkWidget for this window as a long integer. On the other platforms this method returns zero.
var Handle
See GetHandle
var HelpText
See GetHelpText and SetHelpText
var Id
See GetId and SetId
var Label
See GetLabel and SetLabel
var LayoutDirection
See GetLayoutDirection and SetLayoutDirection
var MaxClientSize
GetMaxClientSize(self) -> Size
var MaxHeight
See GetMaxHeight
var MaxSize
See GetMaxSize and SetMaxSize
var MaxWidth
See GetMaxWidth
var MinClientSize
GetMinClientSize(self) -> Size
var MinHeight
See GetMinHeight
var MinSize
See GetMinSize and SetMinSize
var MinWidth
See GetMinWidth
var Name
See GetName and SetName
var NextHandler
See GetNextHandler and SetNextHandler
var Parent
See GetParent
var Position
See GetPosition and SetPosition
var PreviousHandler
See GetPreviousHandler and SetPreviousHandler
var Rect
See GetRect and SetRect
var ScreenPosition
See GetScreenPosition
var ScreenRect
See GetScreenRect
var Shown
See IsShown and Show
var Size
See GetSize and SetSize
var Sizer
See GetSizer and SetSizer
var ThemeEnabled
See GetThemeEnabled and SetThemeEnabled
var ToolTip
See GetToolTip and SetToolTip
var ToolTipString
var TopLevel
See IsTopLevel
var TopLevelParent
See GetTopLevelParent
var UpdateClientRect
See GetUpdateClientRect
var UpdateRegion
See GetUpdateRegion
var Validator
See GetValidator and SetValidator
var VirtualSize
See GetVirtualSize and SetVirtualSize
var WindowStyle
See GetWindowStyle and SetWindowStyle
var WindowStyleFlag
See GetWindowStyleFlag and SetWindowStyleFlag
var WindowVariant
See GetWindowVariant and SetWindowVariant
var thisown
The membership flag
Methods
def __init__(
self, parent, id, pos, size, style, name)
def __init__(self, parent, id, pos, size, style, name): self._init_ctrls(parent)
def AcceptsFocus(
*args, **kwargs)
AcceptsFocus(self) -> bool
Can this window have focus?
def AcceptsFocus(*args, **kwargs): """ AcceptsFocus(self) -> bool Can this window have focus? """ return _core_.Window_AcceptsFocus(*args, **kwargs)
def AcceptsFocusFromKeyboard(
*args, **kwargs)
AcceptsFocusFromKeyboard(self) -> bool
Can this window be given focus by keyboard navigation? if not, the only way to give it focus (provided it accepts it at all) is to click it.
def AcceptsFocusFromKeyboard(*args, **kwargs): """ AcceptsFocusFromKeyboard(self) -> bool Can this window be given focus by keyboard navigation? if not, the only way to give it focus (provided it accepts it at all) is to click it. """ return _core_.Window_AcceptsFocusFromKeyboard(*args, **kwargs)
def AddChild(
*args, **kwargs)
AddChild(self, Window child)
Adds a child window. This is called automatically by window creation functions so should not be required by the application programmer.
def AddChild(*args, **kwargs): """ AddChild(self, Window child) Adds a child window. This is called automatically by window creation functions so should not be required by the application programmer. """ return _core_.Window_AddChild(*args, **kwargs)
def AddPendingEvent(
*args, **kwargs)
AddPendingEvent(self, Event event)
def AddPendingEvent(*args, **kwargs): """AddPendingEvent(self, Event event)""" return _core_.EvtHandler_AddPendingEvent(*args, **kwargs)
def AdjustForLayoutDirection(
*args, **kwargs)
AdjustForLayoutDirection(self, int x, int width, int widthTotal) -> int
Mirror coordinates for RTL layout if this window uses it and if the mirroring is not done automatically like Win32.
def AdjustForLayoutDirection(*args, **kwargs): """ AdjustForLayoutDirection(self, int x, int width, int widthTotal) -> int Mirror coordinates for RTL layout if this window uses it and if the mirroring is not done automatically like Win32. """ return _core_.Window_AdjustForLayoutDirection(*args, **kwargs)
def AlwaysShowScrollbars(
*args, **kwargs)
AlwaysShowScrollbars(self, bool horz=True, bool vert=True)
def AlwaysShowScrollbars(*args, **kwargs): """AlwaysShowScrollbars(self, bool horz=True, bool vert=True)""" return _core_.Window_AlwaysShowScrollbars(*args, **kwargs)
def AssociateHandle(
*args, **kwargs)
AssociateHandle(self, long handle)
Associate the window with a new native handle
def AssociateHandle(*args, **kwargs): """ AssociateHandle(self, long handle) Associate the window with a new native handle """ return _core_.Window_AssociateHandle(*args, **kwargs)
def Bind(
self, event, handler, source=None, id=-1, id2=-1)
Bind an event to an event handler.
:param event: One of the EVT_* objects that specifies the type of event to bind,
:param handler: A callable object to be invoked when the event is delivered to self. Pass None to disconnect an event handler.
:param source: Sometimes the event originates from a different window than self, but you still want to catch it in self. (For example, a button event delivered to a frame.) By passing the source of the event, the event handling system is able to differentiate between the same event type from different controls.
:param id: Used to spcify the event source by ID instead of instance.
:param id2: Used when it is desirable to bind a handler to a range of IDs, such as with EVT_MENU_RANGE.
def Bind(self, event, handler, source=None, id=wx.ID_ANY, id2=wx.ID_ANY): """ Bind an event to an event handler. :param event: One of the EVT_* objects that specifies the type of event to bind, :param handler: A callable object to be invoked when the event is delivered to self. Pass None to disconnect an event handler. :param source: Sometimes the event originates from a different window than self, but you still want to catch it in self. (For example, a button event delivered to a frame.) By passing the source of the event, the event handling system is able to differentiate between the same event type from different controls. :param id: Used to spcify the event source by ID instead of instance. :param id2: Used when it is desirable to bind a handler to a range of IDs, such as with EVT_MENU_RANGE. """ assert isinstance(event, wx.PyEventBinder) assert handler is None or callable(handler) assert source is None or hasattr(source, 'GetId') if source is not None: id = source.GetId() event.Bind(self, id, id2, handler)
def CacheBestSize(
*args, **kwargs)
CacheBestSize(self, Size size)
Cache the best size so it doesn't need to be calculated again, (at least until some properties of the window change.)
def CacheBestSize(*args, **kwargs): """ CacheBestSize(self, Size size) Cache the best size so it doesn't need to be calculated again, (at least until some properties of the window change.) """ return _core_.Window_CacheBestSize(*args, **kwargs)
def CanAcceptFocus(
*args, **kwargs)
CanAcceptFocus(self) -> bool
Can this window have focus right now?
def CanAcceptFocus(*args, **kwargs): """ CanAcceptFocus(self) -> bool Can this window have focus right now? """ return _core_.Window_CanAcceptFocus(*args, **kwargs)
def CanAcceptFocusFromKeyboard(
*args, **kwargs)
CanAcceptFocusFromKeyboard(self) -> bool
Can this window be assigned focus from keyboard right now?
def CanAcceptFocusFromKeyboard(*args, **kwargs): """ CanAcceptFocusFromKeyboard(self) -> bool Can this window be assigned focus from keyboard right now? """ return _core_.Window_CanAcceptFocusFromKeyboard(*args, **kwargs)
def CanApplyThemeBorder(
*args, **kwargs)
CanApplyThemeBorder(self) -> bool
def CanApplyThemeBorder(*args, **kwargs): """CanApplyThemeBorder(self) -> bool""" return _core_.Window_CanApplyThemeBorder(*args, **kwargs)
def CanBeOutsideClientArea(
*args, **kwargs)
CanBeOutsideClientArea(self) -> bool
def CanBeOutsideClientArea(*args, **kwargs): """CanBeOutsideClientArea(self) -> bool""" return _core_.Window_CanBeOutsideClientArea(*args, **kwargs)
def CanScroll(
*args, **kwargs)
CanScroll(self, int orient) -> bool
Can the window have the scrollbar in this orientation?
def CanScroll(*args, **kwargs): """ CanScroll(self, int orient) -> bool Can the window have the scrollbar in this orientation? """ return _core_.Window_CanScroll(*args, **kwargs)
def CanSetTransparent(
*args, **kwargs)
CanSetTransparent(self) -> bool
Returns True if the platform supports setting the transparency for
this window. Note that this method will err on the side of caution,
so it is possible that this will return False when it is in fact
possible to set the transparency.
NOTE: On X-windows systems the X server must have the composite extension loaded, and there must be a composite manager program (such as xcompmgr) running.
def CanSetTransparent(*args, **kwargs): """ CanSetTransparent(self) -> bool Returns ``True`` if the platform supports setting the transparency for this window. Note that this method will err on the side of caution, so it is possible that this will return ``False`` when it is in fact possible to set the transparency. NOTE: On X-windows systems the X server must have the composite extension loaded, and there must be a composite manager program (such as xcompmgr) running. """ return _core_.Window_CanSetTransparent(*args, **kwargs)
def CaptureMouse(
*args, **kwargs)
CaptureMouse(self)
Directs all mouse input to this window. Call wx.Window.ReleaseMouse to release the capture.
Note that wxWindows maintains the stack of windows having captured the
mouse and when the mouse is released the capture returns to the window
which had had captured it previously and it is only really released if
there were no previous window. In particular, this means that you must
release the mouse as many times as you capture it, unless the window
receives the wx.MouseCaptureLostEvent event.
Any application which captures the mouse in the beginning of some
operation must handle wx.MouseCaptureLostEvent and cancel this
operation when it receives the event. The event handler must not
recapture mouse.
def CaptureMouse(*args, **kwargs): """ CaptureMouse(self) Directs all mouse input to this window. Call wx.Window.ReleaseMouse to release the capture. Note that wxWindows maintains the stack of windows having captured the mouse and when the mouse is released the capture returns to the window which had had captured it previously and it is only really released if there were no previous window. In particular, this means that you must release the mouse as many times as you capture it, unless the window receives the `wx.MouseCaptureLostEvent` event. Any application which captures the mouse in the beginning of some operation *must* handle `wx.MouseCaptureLostEvent` and cancel this operation when it receives the event. The event handler must not recapture mouse. """ return _core_.Window_CaptureMouse(*args, **kwargs)
def Center(
*args, **kwargs)
Center(self, int direction=BOTH)
Centers the window. The parameter specifies the direction for centering, and may be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. It may also include wx.CENTER_ON_SCREEN flag if you want to center the window on the entire screen and not on its parent window. If it is a top-level window and has no parent then it will always be centered relative to the screen.
def Center(*args, **kwargs): """ Center(self, int direction=BOTH) Centers the window. The parameter specifies the direction for centering, and may be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. It may also include wx.CENTER_ON_SCREEN flag if you want to center the window on the entire screen and not on its parent window. If it is a top-level window and has no parent then it will always be centered relative to the screen. """ return _core_.Window_Center(*args, **kwargs)
def CenterOnParent(
*args, **kwargs)
CenterOnParent(self, int dir=BOTH)
Center with respect to the the parent window
def CenterOnParent(*args, **kwargs): """ CenterOnParent(self, int dir=BOTH) Center with respect to the the parent window """ return _core_.Window_CenterOnParent(*args, **kwargs)
def Centre(
*args, **kwargs)
Center(self, int direction=BOTH)
Centers the window. The parameter specifies the direction for centering, and may be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. It may also include wx.CENTER_ON_SCREEN flag if you want to center the window on the entire screen and not on its parent window. If it is a top-level window and has no parent then it will always be centered relative to the screen.
def Center(*args, **kwargs): """ Center(self, int direction=BOTH) Centers the window. The parameter specifies the direction for centering, and may be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. It may also include wx.CENTER_ON_SCREEN flag if you want to center the window on the entire screen and not on its parent window. If it is a top-level window and has no parent then it will always be centered relative to the screen. """ return _core_.Window_Center(*args, **kwargs)
def CentreOnParent(
*args, **kwargs)
CenterOnParent(self, int dir=BOTH)
Center with respect to the the parent window
def CenterOnParent(*args, **kwargs): """ CenterOnParent(self, int dir=BOTH) Center with respect to the the parent window """ return _core_.Window_CenterOnParent(*args, **kwargs)
def ClearBackground(
*args, **kwargs)
ClearBackground(self)
Clears the window by filling it with the current background colour. Does not cause an erase background event to be generated.
def ClearBackground(*args, **kwargs): """ ClearBackground(self) Clears the window by filling it with the current background colour. Does not cause an erase background event to be generated. """ return _core_.Window_ClearBackground(*args, **kwargs)
def ClientToScreen(
*args, **kwargs)
ClientToScreen(self, Point pt) -> Point
Converts to screen coordinates from coordinates relative to this window.
def ClientToScreen(*args, **kwargs): """ ClientToScreen(self, Point pt) -> Point Converts to screen coordinates from coordinates relative to this window. """ return _core_.Window_ClientToScreen(*args, **kwargs)
def ClientToScreenXY(
*args, **kwargs)
ClientToScreenXY(int x, int y) -> (x,y)
Converts to screen coordinates from coordinates relative to this window.
def ClientToScreenXY(*args, **kwargs): """ ClientToScreenXY(int x, int y) -> (x,y) Converts to screen coordinates from coordinates relative to this window. """ return _core_.Window_ClientToScreenXY(*args, **kwargs)
def ClientToWindowSize(
*args, **kwargs)
ClientToWindowSize(self, Size size) -> Size
Converts client area size size to corresponding window size. In
other words, the returned value is what `GetSize` would return if this
window had client area of given size. Components withwx.DefaultCoord`` (-1) value are left unchanged.
Note that the conversion is not always exact, it assumes that non-client area doesn't change and so doesn't take into account things like menu bar (un)wrapping or (dis)appearance of the scrollbars.
def ClientToWindowSize(*args, **kwargs): """ ClientToWindowSize(self, Size size) -> Size Converts client area size ``size to corresponding window size. In other words, the returned value is what `GetSize` would return if this window had client area of given size. Components with ``wx.DefaultCoord`` (-1) value are left unchanged. Note that the conversion is not always exact, it assumes that non-client area doesn't change and so doesn't take into account things like menu bar (un)wrapping or (dis)appearance of the scrollbars. """ return _core_.Window_ClientToWindowSize(*args, **kwargs)
def Close(
*args, **kwargs)
Close(self, bool force=False) -> bool
This function simply generates a EVT_CLOSE event whose handler usually tries to close the window. It doesn't close the window itself, however. If force is False (the default) then the window's close handler will be allowed to veto the destruction of the window.
def Close(*args, **kwargs): """ Close(self, bool force=False) -> bool This function simply generates a EVT_CLOSE event whose handler usually tries to close the window. It doesn't close the window itself, however. If force is False (the default) then the window's close handler will be allowed to veto the destruction of the window. """ return _core_.Window_Close(*args, **kwargs)
def Connect(
*args, **kwargs)
Connect(self, int id, int lastId, EventType eventType, PyObject func)
def Connect(*args, **kwargs): """Connect(self, int id, int lastId, EventType eventType, PyObject func)""" return _core_.EvtHandler_Connect(*args, **kwargs)
def ConvertDialogPointToPixels(
*args, **kwargs)
ConvertDialogPointToPixels(self, Point pt) -> Point
Converts a point or size from dialog units to pixels. Dialog units are used for maintaining a dialog's proportions even if the font changes. For the x dimension, the dialog units are multiplied by the average character width and then divided by 4. For the y dimension, the dialog units are multiplied by the average character height and then divided by 8.
def ConvertDialogPointToPixels(*args, **kwargs): """ ConvertDialogPointToPixels(self, Point pt) -> Point Converts a point or size from dialog units to pixels. Dialog units are used for maintaining a dialog's proportions even if the font changes. For the x dimension, the dialog units are multiplied by the average character width and then divided by 4. For the y dimension, the dialog units are multiplied by the average character height and then divided by 8. """ return _core_.Window_ConvertDialogPointToPixels(*args, **kwargs)
def ConvertDialogSizeToPixels(
*args, **kwargs)
ConvertDialogSizeToPixels(self, Size sz) -> Size
Converts a point or size from dialog units to pixels. Dialog units are used for maintaining a dialog's proportions even if the font changes. For the x dimension, the dialog units are multiplied by the average character width and then divided by 4. For the y dimension, the dialog units are multiplied by the average character height and then divided by 8.
def ConvertDialogSizeToPixels(*args, **kwargs): """ ConvertDialogSizeToPixels(self, Size sz) -> Size Converts a point or size from dialog units to pixels. Dialog units are used for maintaining a dialog's proportions even if the font changes. For the x dimension, the dialog units are multiplied by the average character width and then divided by 4. For the y dimension, the dialog units are multiplied by the average character height and then divided by 8. """ return _core_.Window_ConvertDialogSizeToPixels(*args, **kwargs)
def ConvertPixelPointToDialog(
*args, **kwargs)
ConvertPixelPointToDialog(self, Point pt) -> Point
def ConvertPixelPointToDialog(*args, **kwargs): """ConvertPixelPointToDialog(self, Point pt) -> Point""" return _core_.Window_ConvertPixelPointToDialog(*args, **kwargs)
def ConvertPixelSizeToDialog(
*args, **kwargs)
ConvertPixelSizeToDialog(self, Size sz) -> Size
def ConvertPixelSizeToDialog(*args, **kwargs): """ConvertPixelSizeToDialog(self, Size sz) -> Size""" return _core_.Window_ConvertPixelSizeToDialog(*args, **kwargs)
def Create(
*args, **kwargs)
Create(self, Window parent, int id=-1, Point pos=DefaultPosition, Size size=DefaultSize, long style=wxTAB_TRAVERSAL|wxNO_BORDER, String name=PanelNameStr) -> bool
Create the GUI part of the Window for 2-phase creation mode.
def Create(*args, **kwargs): """ Create(self, Window parent, int id=-1, Point pos=DefaultPosition, Size size=DefaultSize, long style=wxTAB_TRAVERSAL|wxNO_BORDER, String name=PanelNameStr) -> bool Create the GUI part of the Window for 2-phase creation mode. """ return _windows_.Panel_Create(*args, **kwargs)
def DLG_PNT(
*args, **kwargs)
DLG_PNT(self, Point pt) -> Point
Converts a point or size from dialog units to pixels. Dialog units are used for maintaining a dialog's proportions even if the font changes. For the x dimension, the dialog units are multiplied by the average character width and then divided by 4. For the y dimension, the dialog units are multiplied by the average character height and then divided by 8.
def DLG_PNT(*args, **kwargs): """ DLG_PNT(self, Point pt) -> Point Converts a point or size from dialog units to pixels. Dialog units are used for maintaining a dialog's proportions even if the font changes. For the x dimension, the dialog units are multiplied by the average character width and then divided by 4. For the y dimension, the dialog units are multiplied by the average character height and then divided by 8. """ return _core_.Window_DLG_PNT(*args, **kwargs)
def DLG_SZE(
*args, **kwargs)
DLG_SZE(self, Size sz) -> Size
Converts a point or size from dialog units to pixels. Dialog units are used for maintaining a dialog's proportions even if the font changes. For the x dimension, the dialog units are multiplied by the average character width and then divided by 4. For the y dimension, the dialog units are multiplied by the average character height and then divided by 8.
def DLG_SZE(*args, **kwargs): """ DLG_SZE(self, Size sz) -> Size Converts a point or size from dialog units to pixels. Dialog units are used for maintaining a dialog's proportions even if the font changes. For the x dimension, the dialog units are multiplied by the average character width and then divided by 4. For the y dimension, the dialog units are multiplied by the average character height and then divided by 8. """ return _core_.Window_DLG_SZE(*args, **kwargs)
def DeletePendingEvents(
*args, **kwargs)
DeletePendingEvents(self)
def DeletePendingEvents(*args, **kwargs): """DeletePendingEvents(self)""" return _core_.EvtHandler_DeletePendingEvents(*args, **kwargs)
def Destroy(
*args, **kwargs)
Destroy(self) -> bool
Destroys the window safely. Frames and dialogs are not destroyed immediately when this function is called -- they are added to a list of windows to be deleted on idle time, when all the window's events have been processed. This prevents problems with events being sent to non-existent windows.
Returns True if the window has either been successfully deleted, or it has been added to the list of windows pending real deletion.
def Destroy(*args, **kwargs): """ Destroy(self) -> bool Destroys the window safely. Frames and dialogs are not destroyed immediately when this function is called -- they are added to a list of windows to be deleted on idle time, when all the window's events have been processed. This prevents problems with events being sent to non-existent windows. Returns True if the window has either been successfully deleted, or it has been added to the list of windows pending real deletion. """ args[0].this.own(False) return _core_.Window_Destroy(*args, **kwargs)
def DestroyChildren(
*args, **kwargs)
DestroyChildren(self) -> bool
Destroys all children of a window. Called automatically by the destructor.
def DestroyChildren(*args, **kwargs): """ DestroyChildren(self) -> bool Destroys all children of a window. Called automatically by the destructor. """ return _core_.Window_DestroyChildren(*args, **kwargs)
def Disable(
*args, **kwargs)
Disable(self) -> bool
Disables the window, same as Enable(false).
def Disable(*args, **kwargs): """ Disable(self) -> bool Disables the window, same as Enable(false). """ return _core_.Window_Disable(*args, **kwargs)
def Disconnect(
*args, **kwargs)
Disconnect(self, int id, int lastId=-1, EventType eventType=wxEVT_NULL, PyObject func=None) -> bool
def Disconnect(*args, **kwargs): """ Disconnect(self, int id, int lastId=-1, EventType eventType=wxEVT_NULL, PyObject func=None) -> bool """ return _core_.EvtHandler_Disconnect(*args, **kwargs)
def DissociateHandle(
*args, **kwargs)
DissociateHandle(self)
Dissociate the current native handle from the window
def DissociateHandle(*args, **kwargs): """ DissociateHandle(self) Dissociate the current native handle from the window """ return _core_.Window_DissociateHandle(*args, **kwargs)
def DragAcceptFiles(
*args, **kwargs)
DragAcceptFiles(self, bool accept)
Enables or disables eligibility for drop file events, EVT_DROP_FILES.
def DragAcceptFiles(*args, **kwargs): """ DragAcceptFiles(self, bool accept) Enables or disables eligibility for drop file events, EVT_DROP_FILES. """ return _core_.Window_DragAcceptFiles(*args, **kwargs)
def Enable(
*args, **kwargs)
Enable(self, bool enable=True) -> bool
Enable or disable the window for user input. Note that when a parent window is disabled, all of its children are disabled as well and they are reenabled again when the parent is. Returns true if the window has been enabled or disabled, false if nothing was done, i.e. if the window had already been in the specified state.
def Enable(*args, **kwargs): """ Enable(self, bool enable=True) -> bool Enable or disable the window for user input. Note that when a parent window is disabled, all of its children are disabled as well and they are reenabled again when the parent is. Returns true if the window has been enabled or disabled, false if nothing was done, i.e. if the window had already been in the specified state. """ return _core_.Window_Enable(*args, **kwargs)
def FindWindowById(
*args, **kwargs)
FindWindowById(self, long winid) -> Window
Find a child of this window by window ID
def FindWindowById(*args, **kwargs): """ FindWindowById(self, long winid) -> Window Find a child of this window by window ID """ return _core_.Window_FindWindowById(*args, **kwargs)
def FindWindowByLabel(
*args, **kwargs)
FindWindowByLabel(self, String label) -> Window
Find a child of this window by label
def FindWindowByLabel(*args, **kwargs): """ FindWindowByLabel(self, String label) -> Window Find a child of this window by label """ return _core_.Window_FindWindowByLabel(*args, **kwargs)
def FindWindowByName(
*args, **kwargs)
FindWindowByName(self, String name) -> Window
Find a child of this window by name
def FindWindowByName(*args, **kwargs): """ FindWindowByName(self, String name) -> Window Find a child of this window by name """ return _core_.Window_FindWindowByName(*args, **kwargs)
def Fit(
*args, **kwargs)
Fit(self)
Sizes the window so that it fits around its subwindows. This function won't do anything if there are no subwindows and will only really work correctly if sizers are used for the subwindows layout. Also, if the window has exactly one subwindow it is better (faster and the result is more precise as Fit adds some margin to account for fuzziness of its calculations) to call window.SetClientSize(child.GetSize()) instead of calling Fit.
def Fit(*args, **kwargs): """ Fit(self) Sizes the window so that it fits around its subwindows. This function won't do anything if there are no subwindows and will only really work correctly if sizers are used for the subwindows layout. Also, if the window has exactly one subwindow it is better (faster and the result is more precise as Fit adds some margin to account for fuzziness of its calculations) to call window.SetClientSize(child.GetSize()) instead of calling Fit. """ return _core_.Window_Fit(*args, **kwargs)
def FitInside(
*args, **kwargs)
FitInside(self)
Similar to Fit, but sizes the interior (virtual) size of a window. Mainly useful with scrolled windows to reset scrollbars after sizing changes that do not trigger a size event, and/or scrolled windows without an interior sizer. This function similarly won't do anything if there are no subwindows.
def FitInside(*args, **kwargs): """ FitInside(self) Similar to Fit, but sizes the interior (virtual) size of a window. Mainly useful with scrolled windows to reset scrollbars after sizing changes that do not trigger a size event, and/or scrolled windows without an interior sizer. This function similarly won't do anything if there are no subwindows. """ return _core_.Window_FitInside(*args, **kwargs)
def Freeze(
*args, **kwargs)
Freeze(self)
Freezes the window or, in other words, prevents any updates from taking place on screen, the window is not redrawn at all. Thaw must be called to reenable window redrawing. Calls to Freeze/Thaw may be nested, with the actual Thaw being delayed until all the nesting has been undone.
This method is useful for visual appearance optimization (for example, it is a good idea to use it before inserting large amount of text into a wxTextCtrl under wxGTK) but is not implemented on all platforms nor for all controls so it is mostly just a hint to wxWindows and not a mandatory directive.
def Freeze(*args, **kwargs): """ Freeze(self) Freezes the window or, in other words, prevents any updates from taking place on screen, the window is not redrawn at all. Thaw must be called to reenable window redrawing. Calls to Freeze/Thaw may be nested, with the actual Thaw being delayed until all the nesting has been undone. This method is useful for visual appearance optimization (for example, it is a good idea to use it before inserting large amount of text into a wxTextCtrl under wxGTK) but is not implemented on all platforms nor for all controls so it is mostly just a hint to wxWindows and not a mandatory directive. """ return _core_.Window_Freeze(*args, **kwargs)
def GetAcceleratorTable(
*args, **kwargs)
GetAcceleratorTable(self) -> AcceleratorTable
Gets the accelerator table for this window.
def GetAcceleratorTable(*args, **kwargs): """ GetAcceleratorTable(self) -> AcceleratorTable Gets the accelerator table for this window. """ return _core_.Window_GetAcceleratorTable(*args, **kwargs)
def GetAdjustedBestSize(
*args, **kw)
def deprecated_func(*args, **kw): warnings.warn("Call to deprecated item. %s" % msg, wxPyDeprecationWarning, stacklevel=2) return item(*args, **kw)
def GetAutoLayout(
*args, **kwargs)
GetAutoLayout(self) -> bool
Returns the current autoLayout setting
def GetAutoLayout(*args, **kwargs): """ GetAutoLayout(self) -> bool Returns the current autoLayout setting """ return _core_.Window_GetAutoLayout(*args, **kwargs)
def GetBackgroundColour(
*args, **kwargs)
GetBackgroundColour(self) -> Colour
Returns the background colour of the window.
def GetBackgroundColour(*args, **kwargs): """ GetBackgroundColour(self) -> Colour Returns the background colour of the window. """ return _core_.Window_GetBackgroundColour(*args, **kwargs)
def GetBackgroundStyle(
*args, **kwargs)
GetBackgroundStyle(self) -> int
Returns the background style of the window.
:see: SetBackgroundStyle
def GetBackgroundStyle(*args, **kwargs): """ GetBackgroundStyle(self) -> int Returns the background style of the window. :see: `SetBackgroundStyle` """ return _core_.Window_GetBackgroundStyle(*args, **kwargs)
def GetBestFittingSize(
*args, **kw)
GetEffectiveMinSize(self) -> Size
This function will merge the window's best size into the window's minimum size, giving priority to the min size components, and returns the results.
def deprecated_func(*args, **kw): warnings.warn("Call to deprecated item. %s" % msg, wxPyDeprecationWarning, stacklevel=2) return item(*args, **kw)
def GetBestSize(
*args, **kwargs)
GetBestSize(self) -> Size
This function returns the best acceptable minimal size for the window, if applicable. For example, for a static text control, it will be the minimal size such that the control label is not truncated. For windows containing subwindows (such as wx.Panel), the size returned by this function will be the same as the size the window would have had after calling Fit.
def GetBestSize(*args, **kwargs): """ GetBestSize(self) -> Size This function returns the best acceptable minimal size for the window, if applicable. For example, for a static text control, it will be the minimal size such that the control label is not truncated. For windows containing subwindows (such as wx.Panel), the size returned by this function will be the same as the size the window would have had after calling Fit. """ return _core_.Window_GetBestSize(*args, **kwargs)
def GetBestSizeTuple(
*args, **kwargs)
GetBestSizeTuple() -> (width, height)
This function returns the best acceptable minimal size for the window, if applicable. For example, for a static text control, it will be the minimal size such that the control label is not truncated. For windows containing subwindows (such as wx.Panel), the size returned by this function will be the same as the size the window would have had after calling Fit.
def GetBestSizeTuple(*args, **kwargs): """ GetBestSizeTuple() -> (width, height) This function returns the best acceptable minimal size for the window, if applicable. For example, for a static text control, it will be the minimal size such that the control label is not truncated. For windows containing subwindows (such as wx.Panel), the size returned by this function will be the same as the size the window would have had after calling Fit. """ return _core_.Window_GetBestSizeTuple(*args, **kwargs)
def GetBestVirtualSize(
*args, **kwargs)
GetBestVirtualSize(self) -> Size
Return the largest of ClientSize and BestSize (as determined by a sizer, interior children, or other means)
def GetBestVirtualSize(*args, **kwargs): """ GetBestVirtualSize(self) -> Size Return the largest of ClientSize and BestSize (as determined by a sizer, interior children, or other means) """ return _core_.Window_GetBestVirtualSize(*args, **kwargs)
def GetBorder(
*args)
GetBorder(self, long flags) -> int GetBorder(self) -> int
Get border for the flags of this window
def GetBorder(*args): """ GetBorder(self, long flags) -> int GetBorder(self) -> int Get border for the flags of this window """ return _core_.Window_GetBorder(*args)
def GetCaret(
*args, **kwargs)
GetCaret(self) -> Caret
Returns the caret associated with the window.
def GetCaret(*args, **kwargs): """ GetCaret(self) -> Caret Returns the caret associated with the window. """ return _core_.Window_GetCaret(*args, **kwargs)
def GetCharHeight(
*args, **kwargs)
GetCharHeight(self) -> int
Get the (average) character size for the current font.
def GetCharHeight(*args, **kwargs): """ GetCharHeight(self) -> int Get the (average) character size for the current font. """ return _core_.Window_GetCharHeight(*args, **kwargs)
def GetCharWidth(
*args, **kwargs)
GetCharWidth(self) -> int
Get the (average) character size for the current font.
def GetCharWidth(*args, **kwargs): """ GetCharWidth(self) -> int Get the (average) character size for the current font. """ return _core_.Window_GetCharWidth(*args, **kwargs)
def GetChildren(
*args, **kwargs)
GetChildren(self) -> WindowList
Returns an object containing a list of the window's children. The object provides a Python sequence-like interface over the internal list maintained by the window..
def GetChildren(*args, **kwargs): """ GetChildren(self) -> WindowList Returns an object containing a list of the window's children. The object provides a Python sequence-like interface over the internal list maintained by the window.. """ return _core_.Window_GetChildren(*args, **kwargs)
def GetClassName(
*args, **kwargs)
GetClassName(self) -> String
Returns the class name of the C++ class using wxRTTI.
def GetClassName(*args, **kwargs): """ GetClassName(self) -> String Returns the class name of the C++ class using wxRTTI. """ return _core_.Object_GetClassName(*args, **kwargs)
def GetClientAreaOrigin(
*args, **kwargs)
GetClientAreaOrigin(self) -> Point
Get the origin of the client area of the window relative to the window's top left corner (the client area may be shifted because of the borders, scrollbars, other decorations...)
def GetClientAreaOrigin(*args, **kwargs): """ GetClientAreaOrigin(self) -> Point Get the origin of the client area of the window relative to the window's top left corner (the client area may be shifted because of the borders, scrollbars, other decorations...) """ return _core_.Window_GetClientAreaOrigin(*args, **kwargs)
def GetClientRect(
*args, **kwargs)
GetClientRect(self) -> Rect
Get the client area position and size as a wx.Rect object.
def GetClientRect(*args, **kwargs): """ GetClientRect(self) -> Rect Get the client area position and size as a `wx.Rect` object. """ return _core_.Window_GetClientRect(*args, **kwargs)
def GetClientSize(
*args, **kwargs)
GetClientSize(self) -> Size
This gets the size of the window's 'client area' in pixels. The client area is the area which may be drawn on by the programmer, excluding title bar, border, scrollbars, etc.
def GetClientSize(*args, **kwargs): """ GetClientSize(self) -> Size This gets the size of the window's 'client area' in pixels. The client area is the area which may be drawn on by the programmer, excluding title bar, border, scrollbars, etc. """ return _core_.Window_GetClientSize(*args, **kwargs)
def GetClientSizeTuple(
*args, **kwargs)
GetClientSizeTuple() -> (width, height)
This gets the size of the window's 'client area' in pixels. The client area is the area which may be drawn on by the programmer, excluding title bar, border, scrollbars, etc.
def GetClientSizeTuple(*args, **kwargs): """ GetClientSizeTuple() -> (width, height) This gets the size of the window's 'client area' in pixels. The client area is the area which may be drawn on by the programmer, excluding title bar, border, scrollbars, etc. """ return _core_.Window_GetClientSizeTuple(*args, **kwargs)
def GetConstraints(
*args, **kwargs)
GetConstraints(self) -> LayoutConstraints
Returns a pointer to the window's layout constraints, or None if there are none.
def GetConstraints(*args, **kwargs): """ GetConstraints(self) -> LayoutConstraints Returns a pointer to the window's layout constraints, or None if there are none. """ return _core_.Window_GetConstraints(*args, **kwargs)
def GetContainingSizer(
*args, **kwargs)
GetContainingSizer(self) -> Sizer
Return the sizer that this window is a member of, if any, otherwise None.
def GetContainingSizer(*args, **kwargs): """ GetContainingSizer(self) -> Sizer Return the sizer that this window is a member of, if any, otherwise None. """ return _core_.Window_GetContainingSizer(*args, **kwargs)
def GetCursor(
*args, **kwargs)
GetCursor(self) -> Cursor
Return the cursor associated with this window.
def GetCursor(*args, **kwargs): """ GetCursor(self) -> Cursor Return the cursor associated with this window. """ return _core_.Window_GetCursor(*args, **kwargs)
def GetDefaultAttributes(
*args, **kwargs)
GetDefaultAttributes(self) -> VisualAttributes
Get the default attributes for an instance of this class. This is useful if you want to use the same font or colour in your own control as in a standard control -- which is a much better idea than hard coding specific colours or fonts which might look completely out of place on the user's system, especially if it uses themes.
def GetDefaultAttributes(*args, **kwargs): """ GetDefaultAttributes(self) -> VisualAttributes Get the default attributes for an instance of this class. This is useful if you want to use the same font or colour in your own control as in a standard control -- which is a much better idea than hard coding specific colours or fonts which might look completely out of place on the user's system, especially if it uses themes. """ return _core_.Window_GetDefaultAttributes(*args, **kwargs)
def GetDropTarget(
*args, **kwargs)
GetDropTarget(self) -> DropTarget
Returns the associated drop target, which may be None.
def GetDropTarget(*args, **kwargs): """ GetDropTarget(self) -> DropTarget Returns the associated drop target, which may be None. """ return _core_.Window_GetDropTarget(*args, **kwargs)
def GetEffectiveMinSize(
*args, **kwargs)
GetEffectiveMinSize(self) -> Size
This function will merge the window's best size into the window's minimum size, giving priority to the min size components, and returns the results.
def GetEffectiveMinSize(*args, **kwargs): """ GetEffectiveMinSize(self) -> Size This function will merge the window's best size into the window's minimum size, giving priority to the min size components, and returns the results. """ return _core_.Window_GetEffectiveMinSize(*args, **kwargs)
def GetEventHandler(
*args, **kwargs)
GetEventHandler(self) -> EvtHandler
Returns the event handler for this window. By default, the window is its own event handler.
def GetEventHandler(*args, **kwargs): """ GetEventHandler(self) -> EvtHandler Returns the event handler for this window. By default, the window is its own event handler. """ return _core_.Window_GetEventHandler(*args, **kwargs)
def GetEvtHandlerEnabled(
*args, **kwargs)
GetEvtHandlerEnabled(self) -> bool
def GetEvtHandlerEnabled(*args, **kwargs): """GetEvtHandlerEnabled(self) -> bool""" return _core_.EvtHandler_GetEvtHandlerEnabled(*args, **kwargs)
def GetExtraStyle(
*args, **kwargs)
GetExtraStyle(self) -> long
Returns the extra style bits for the window.
def GetExtraStyle(*args, **kwargs): """ GetExtraStyle(self) -> long Returns the extra style bits for the window. """ return _core_.Window_GetExtraStyle(*args, **kwargs)
def GetFont(
*args, **kwargs)
GetFont(self) -> Font
Returns the default font used for this window.
def GetFont(*args, **kwargs): """ GetFont(self) -> Font Returns the default font used for this window. """ return _core_.Window_GetFont(*args, **kwargs)
def GetForegroundColour(
*args, **kwargs)
GetForegroundColour(self) -> Colour
Returns the foreground colour of the window. The interpretation of foreground colour is dependent on the window class; it may be the text colour or other colour, or it may not be used at all.
def GetForegroundColour(*args, **kwargs): """ GetForegroundColour(self) -> Colour Returns the foreground colour of the window. The interpretation of foreground colour is dependent on the window class; it may be the text colour or other colour, or it may not be used at all. """ return _core_.Window_GetForegroundColour(*args, **kwargs)
def GetFullTextExtent(
*args, **kwargs)
GetFullTextExtent(String string, Font font=None) -> (width, height, descent, externalLeading)
Get the width, height, decent and leading of the text using the current or specified font.
def GetFullTextExtent(*args, **kwargs): """ GetFullTextExtent(String string, Font font=None) -> (width, height, descent, externalLeading) Get the width, height, decent and leading of the text using the current or specified font. """ return _core_.Window_GetFullTextExtent(*args, **kwargs)
def GetGrandParent(
*args, **kwargs)
GetGrandParent(self) -> Window
Returns the parent of the parent of this window, or None if there isn't one.
def GetGrandParent(*args, **kwargs): """ GetGrandParent(self) -> Window Returns the parent of the parent of this window, or None if there isn't one. """ return _core_.Window_GetGrandParent(*args, **kwargs)
def GetGtkWidget(
*args, **kwargs)
GetGtkWidget(self) -> long
On wxGTK returns a pointer to the GtkWidget for this window as a long integer. On the other platforms this method returns zero.
def GetGtkWidget(*args, **kwargs): """ GetGtkWidget(self) -> long On wxGTK returns a pointer to the GtkWidget for this window as a long integer. On the other platforms this method returns zero. """ return _core_.Window_GetGtkWidget(*args, **kwargs)
def GetHandle(
*args, **kwargs)
GetHandle(self) -> long
Returns the platform-specific handle (as a long integer) of the physical window. On wxMSW this is the win32 window handle, on wxGTK it is the XWindow ID, and on wxMac it is the ControlRef.
def GetHandle(*args, **kwargs): """ GetHandle(self) -> long Returns the platform-specific handle (as a long integer) of the physical window. On wxMSW this is the win32 window handle, on wxGTK it is the XWindow ID, and on wxMac it is the ControlRef. """ return _core_.Window_GetHandle(*args, **kwargs)
def GetHelpText(
*args, **kwargs)
GetHelpText(self) -> String
Gets the help text to be used as context-sensitive help for this
window. Note that the text is actually stored by the current
wx.HelpProvider implementation, and not in the window object itself.
def GetHelpText(*args, **kwargs): """ GetHelpText(self) -> String Gets the help text to be used as context-sensitive help for this window. Note that the text is actually stored by the current `wx.HelpProvider` implementation, and not in the window object itself. """ return _core_.Window_GetHelpText(*args, **kwargs)
def GetHelpTextAtPoint(
*args, **kwargs)
GetHelpTextAtPoint(self, Point pt, wxHelpEvent::Origin origin) -> String
Get the help string associated with the given position in this window.
Notice that pt may be invalid if event origin is keyboard or unknown and this method should return the global window help text then
def GetHelpTextAtPoint(*args, **kwargs): """ GetHelpTextAtPoint(self, Point pt, wxHelpEvent::Origin origin) -> String Get the help string associated with the given position in this window. Notice that pt may be invalid if event origin is keyboard or unknown and this method should return the global window help text then """ return _core_.Window_GetHelpTextAtPoint(*args, **kwargs)
def GetId(
*args, **kwargs)
GetId(self) -> int
Returns the identifier of the window. Each window has an integer identifier. If the application has not provided one (or the default Id -1 is used) then an unique identifier with a negative value will be generated.
def GetId(*args, **kwargs): """ GetId(self) -> int Returns the identifier of the window. Each window has an integer identifier. If the application has not provided one (or the default Id -1 is used) then an unique identifier with a negative value will be generated. """ return _core_.Window_GetId(*args, **kwargs)
def GetLabel(
*args, **kwargs)
GetLabel(self) -> String
Generic way of getting a label from any window, for identification purposes. The interpretation of this function differs from class to class. For frames and dialogs, the value returned is the title. For buttons or static text controls, it is the button text. This function can be useful for meta-programs such as testing tools or special-needs access programs)which need to identify windows by name.
def GetLabel(*args, **kwargs): """ GetLabel(self) -> String Generic way of getting a label from any window, for identification purposes. The interpretation of this function differs from class to class. For frames and dialogs, the value returned is the title. For buttons or static text controls, it is the button text. This function can be useful for meta-programs such as testing tools or special-needs access programs)which need to identify windows by name. """ return _core_.Window_GetLabel(*args, **kwargs)
def GetLayoutDirection(
*args, **kwargs)
GetLayoutDirection(self) -> int
Get the layout direction (LTR or RTL) for this window. Returns
wx.Layout_Default if layout direction is not supported.
def GetLayoutDirection(*args, **kwargs): """ GetLayoutDirection(self) -> int Get the layout direction (LTR or RTL) for this window. Returns ``wx.Layout_Default`` if layout direction is not supported. """ return _core_.Window_GetLayoutDirection(*args, **kwargs)
def GetMainWindowOfCompositeControl(
*args, **kwargs)
GetMainWindowOfCompositeControl(self) -> Window
def GetMainWindowOfCompositeControl(*args, **kwargs): """GetMainWindowOfCompositeControl(self) -> Window""" return _core_.Window_GetMainWindowOfCompositeControl(*args, **kwargs)
def GetMaxClientSize(
*args, **kwargs)
GetMaxClientSize(self) -> Size
def GetMaxClientSize(*args, **kwargs): """GetMaxClientSize(self) -> Size""" return _core_.Window_GetMaxClientSize(*args, **kwargs)
def GetMaxHeight(
*args, **kwargs)
GetMaxHeight(self) -> int
def GetMaxHeight(*args, **kwargs): """GetMaxHeight(self) -> int""" return _core_.Window_GetMaxHeight(*args, **kwargs)
def GetMaxSize(
*args, **kwargs)
GetMaxSize(self) -> Size
def GetMaxSize(*args, **kwargs): """GetMaxSize(self) -> Size""" return _core_.Window_GetMaxSize(*args, **kwargs)
def GetMaxWidth(
*args, **kwargs)
GetMaxWidth(self) -> int
def GetMaxWidth(*args, **kwargs): """GetMaxWidth(self) -> int""" return _core_.Window_GetMaxWidth(*args, **kwargs)
def GetMinClientSize(
*args, **kwargs)
GetMinClientSize(self) -> Size
def GetMinClientSize(*args, **kwargs): """GetMinClientSize(self) -> Size""" return _core_.Window_GetMinClientSize(*args, **kwargs)
def GetMinHeight(
*args, **kwargs)
GetMinHeight(self) -> int
def GetMinHeight(*args, **kwargs): """GetMinHeight(self) -> int""" return _core_.Window_GetMinHeight(*args, **kwargs)
def GetMinSize(
*args, **kwargs)
GetMinSize(self) -> Size
def GetMinSize(*args, **kwargs): """GetMinSize(self) -> Size""" return _core_.Window_GetMinSize(*args, **kwargs)
def GetMinWidth(
*args, **kwargs)
GetMinWidth(self) -> int
def GetMinWidth(*args, **kwargs): """GetMinWidth(self) -> int""" return _core_.Window_GetMinWidth(*args, **kwargs)
def GetName(
*args, **kwargs)
GetName(self) -> String
Returns the windows name. This name is not guaranteed to be unique; it is up to the programmer to supply an appropriate name in the window constructor or via wx.Window.SetName.
def GetName(*args, **kwargs): """ GetName(self) -> String Returns the windows name. This name is not guaranteed to be unique; it is up to the programmer to supply an appropriate name in the window constructor or via wx.Window.SetName. """ return _core_.Window_GetName(*args, **kwargs)
def GetNextHandler(
*args, **kwargs)
GetNextHandler(self) -> EvtHandler
def GetNextHandler(*args, **kwargs): """GetNextHandler(self) -> EvtHandler""" return _core_.EvtHandler_GetNextHandler(*args, **kwargs)
def GetNextSibling(
*args, **kwargs)
GetNextSibling(self) -> Window
def GetNextSibling(*args, **kwargs): """GetNextSibling(self) -> Window""" return _core_.Window_GetNextSibling(*args, **kwargs)
def GetParent(
*args, **kwargs)
GetParent(self) -> Window
Returns the parent window of this window, or None if there isn't one.
def GetParent(*args, **kwargs): """ GetParent(self) -> Window Returns the parent window of this window, or None if there isn't one. """ return _core_.Window_GetParent(*args, **kwargs)
def GetPopupMenuSelectionFromUser(
*args, **kwargs)
GetPopupMenuSelectionFromUser(self, Menu menu, Point pos=DefaultPosition) -> int
Simply return the id of the selected item or wxID_NONE without generating any events.
def GetPopupMenuSelectionFromUser(*args, **kwargs): """ GetPopupMenuSelectionFromUser(self, Menu menu, Point pos=DefaultPosition) -> int Simply return the id of the selected item or wxID_NONE without generating any events. """ return _core_.Window_GetPopupMenuSelectionFromUser(*args, **kwargs)
def GetPosition(
*args, **kwargs)
GetPosition(self) -> Point
Get the window's position. Notice that the position is in client
coordinates for child windows and screen coordinates for the top level
ones, use GetScreenPosition if you need screen coordinates for all
kinds of windows.
def GetPosition(*args, **kwargs): """ GetPosition(self) -> Point Get the window's position. Notice that the position is in client coordinates for child windows and screen coordinates for the top level ones, use `GetScreenPosition` if you need screen coordinates for all kinds of windows. """ return _core_.Window_GetPosition(*args, **kwargs)
def GetPositionTuple(
*args, **kwargs)
GetPositionTuple() -> (x,y)
Get the window's position. Notice that the position is in client
coordinates for child windows and screen coordinates for the top level
ones, use GetScreenPosition if you need screen coordinates for all
kinds of windows.
def GetPositionTuple(*args, **kwargs): """ GetPositionTuple() -> (x,y) Get the window's position. Notice that the position is in client coordinates for child windows and screen coordinates for the top level ones, use `GetScreenPosition` if you need screen coordinates for all kinds of windows. """ return _core_.Window_GetPositionTuple(*args, **kwargs)
def GetPrevSibling(
*args, **kwargs)
GetPrevSibling(self) -> Window
def GetPrevSibling(*args, **kwargs): """GetPrevSibling(self) -> Window""" return _core_.Window_GetPrevSibling(*args, **kwargs)
def GetPreviousHandler(
*args, **kwargs)
GetPreviousHandler(self) -> EvtHandler
def GetPreviousHandler(*args, **kwargs): """GetPreviousHandler(self) -> EvtHandler""" return _core_.EvtHandler_GetPreviousHandler(*args, **kwargs)
def GetRect(
*args, **kwargs)
GetRect(self) -> Rect
Returns the size and position of the window as a wx.Rect object.
def GetRect(*args, **kwargs): """ GetRect(self) -> Rect Returns the size and position of the window as a `wx.Rect` object. """ return _core_.Window_GetRect(*args, **kwargs)
def GetScreenPosition(
*args, **kwargs)
GetScreenPosition(self) -> Point
Get the position of the window in screen coordinantes.
def GetScreenPosition(*args, **kwargs): """ GetScreenPosition(self) -> Point Get the position of the window in screen coordinantes. """ return _core_.Window_GetScreenPosition(*args, **kwargs)
def GetScreenPositionTuple(
*args, **kwargs)
GetScreenPositionTuple() -> (x,y)
Get the position of the window in screen coordinantes.
def GetScreenPositionTuple(*args, **kwargs): """ GetScreenPositionTuple() -> (x,y) Get the position of the window in screen coordinantes. """ return _core_.Window_GetScreenPositionTuple(*args, **kwargs)
def GetScreenRect(
*args, **kwargs)
GetScreenRect(self) -> Rect
Returns the size and position of the window in screen coordinantes as
a wx.Rect object.
def GetScreenRect(*args, **kwargs): """ GetScreenRect(self) -> Rect Returns the size and position of the window in screen coordinantes as a `wx.Rect` object. """ return _core_.Window_GetScreenRect(*args, **kwargs)
def GetScrollPos(
*args, **kwargs)
GetScrollPos(self, int orientation) -> int
Returns the built-in scrollbar position.
def GetScrollPos(*args, **kwargs): """ GetScrollPos(self, int orientation) -> int Returns the built-in scrollbar position. """ return _core_.Window_GetScrollPos(*args, **kwargs)
def GetScrollRange(
*args, **kwargs)
GetScrollRange(self, int orientation) -> int
Returns the built-in scrollbar range.
def GetScrollRange(*args, **kwargs): """ GetScrollRange(self, int orientation) -> int Returns the built-in scrollbar range. """ return _core_.Window_GetScrollRange(*args, **kwargs)
def GetScrollThumb(
*args, **kwargs)
GetScrollThumb(self, int orientation) -> int
Returns the built-in scrollbar thumb size.
def GetScrollThumb(*args, **kwargs): """ GetScrollThumb(self, int orientation) -> int Returns the built-in scrollbar thumb size. """ return _core_.Window_GetScrollThumb(*args, **kwargs)
def GetSize(
*args, **kwargs)
GetSize(self) -> Size
Get the window size.
def GetSize(*args, **kwargs): """ GetSize(self) -> Size Get the window size. """ return _core_.Window_GetSize(*args, **kwargs)
def GetSizeTuple(
*args, **kwargs)
GetSizeTuple() -> (width, height)
Get the window size.
def GetSizeTuple(*args, **kwargs): """ GetSizeTuple() -> (width, height) Get the window size. """ return _core_.Window_GetSizeTuple(*args, **kwargs)
def GetSizer(
*args, **kwargs)
GetSizer(self) -> Sizer
Return the sizer associated with the window by a previous call to SetSizer or None if there isn't one.
def GetSizer(*args, **kwargs): """ GetSizer(self) -> Sizer Return the sizer associated with the window by a previous call to SetSizer or None if there isn't one. """ return _core_.Window_GetSizer(*args, **kwargs)
def GetTextExtent(
*args, **kwargs)
GetTextExtent(String string) -> (width, height)
Get the width and height of the text using the current font.
def GetTextExtent(*args, **kwargs): """ GetTextExtent(String string) -> (width, height) Get the width and height of the text using the current font. """ return _core_.Window_GetTextExtent(*args, **kwargs)
def GetThemeEnabled(
*args, **kwargs)
GetThemeEnabled(self) -> bool
Return the themeEnabled flag.
def GetThemeEnabled(*args, **kwargs): """ GetThemeEnabled(self) -> bool Return the themeEnabled flag. """ return _core_.Window_GetThemeEnabled(*args, **kwargs)
def GetToolTip(
*args, **kwargs)
GetToolTip(self) -> ToolTip
get the associated tooltip or None if none
def GetToolTip(*args, **kwargs): """ GetToolTip(self) -> ToolTip get the associated tooltip or None if none """ return _core_.Window_GetToolTip(*args, **kwargs)
def GetToolTipString(
self)
def GetToolTipString(self): tip = self.GetToolTip() if tip: return tip.GetTip() else: return None
def GetTopLevelParent(
*args, **kwargs)
GetTopLevelParent(self) -> Window
Returns the first frame or dialog in this window's parental hierarchy.
def GetTopLevelParent(*args, **kwargs): """ GetTopLevelParent(self) -> Window Returns the first frame or dialog in this window's parental hierarchy. """ return _core_.Window_GetTopLevelParent(*args, **kwargs)
def GetUpdateClientRect(
*args, **kwargs)
GetUpdateClientRect(self) -> Rect
Get the update rectangle region bounding box in client coords.
def GetUpdateClientRect(*args, **kwargs): """ GetUpdateClientRect(self) -> Rect Get the update rectangle region bounding box in client coords. """ return _core_.Window_GetUpdateClientRect(*args, **kwargs)
def GetUpdateRegion(
*args, **kwargs)
GetUpdateRegion(self) -> Region
Returns the region specifying which parts of the window have been damaged. Should only be called within an EVT_PAINT handler.
def GetUpdateRegion(*args, **kwargs): """ GetUpdateRegion(self) -> Region Returns the region specifying which parts of the window have been damaged. Should only be called within an EVT_PAINT handler. """ return _core_.Window_GetUpdateRegion(*args, **kwargs)
def GetValidator(
*args, **kwargs)
GetValidator(self) -> Validator
Returns a pointer to the current validator for the window, or None if there is none.
def GetValidator(*args, **kwargs): """ GetValidator(self) -> Validator Returns a pointer to the current validator for the window, or None if there is none. """ return _core_.Window_GetValidator(*args, **kwargs)
def GetVirtualSize(
*args, **kwargs)
GetVirtualSize(self) -> Size
Get the the virtual size of the window in pixels. For most windows this is just the client area of the window, but for some like scrolled windows it is more or less independent of the screen window size.
def GetVirtualSize(*args, **kwargs): """ GetVirtualSize(self) -> Size Get the the virtual size of the window in pixels. For most windows this is just the client area of the window, but for some like scrolled windows it is more or less independent of the screen window size. """ return _core_.Window_GetVirtualSize(*args, **kwargs)
def GetVirtualSizeTuple(
*args, **kwargs)
GetVirtualSizeTuple() -> (width, height)
Get the the virtual size of the window in pixels. For most windows this is just the client area of the window, but for some like scrolled windows it is more or less independent of the screen window size.
def GetVirtualSizeTuple(*args, **kwargs): """ GetVirtualSizeTuple() -> (width, height) Get the the virtual size of the window in pixels. For most windows this is just the client area of the window, but for some like scrolled windows it is more or less independent of the screen window size. """ return _core_.Window_GetVirtualSizeTuple(*args, **kwargs)
def GetWindowBorderSize(
*args, **kwargs)
GetWindowBorderSize(self) -> Size
Return the size of the left/right and top/bottom borders.
def GetWindowBorderSize(*args, **kwargs): """ GetWindowBorderSize(self) -> Size Return the size of the left/right and top/bottom borders. """ return _core_.Window_GetWindowBorderSize(*args, **kwargs)
def GetWindowStyle(
*args, **kwargs)
GetWindowStyleFlag(self) -> long
Gets the window style that was passed to the constructor or Create method.
def GetWindowStyleFlag(*args, **kwargs): """ GetWindowStyleFlag(self) -> long Gets the window style that was passed to the constructor or Create method. """ return _core_.Window_GetWindowStyleFlag(*args, **kwargs)
def GetWindowStyleFlag(
*args, **kwargs)
GetWindowStyleFlag(self) -> long
Gets the window style that was passed to the constructor or Create method.
def GetWindowStyleFlag(*args, **kwargs): """ GetWindowStyleFlag(self) -> long Gets the window style that was passed to the constructor or Create method. """ return _core_.Window_GetWindowStyleFlag(*args, **kwargs)
def GetWindowVariant(
*args, **kwargs)
GetWindowVariant(self) -> int
def GetWindowVariant(*args, **kwargs): """GetWindowVariant(self) -> int""" return _core_.Window_GetWindowVariant(*args, **kwargs)
HandleAsNavigationKey(self, KeyEvent event) -> bool
This function will generate the appropriate call to Navigate if the
key event is one normally used for keyboard navigation. Returns
True if the key pressed was for navigation and was handled,
False otherwise.
def HandleWindowEvent(
*args, **kwargs)
HandleWindowEvent(self, Event event) -> bool
Process an event by calling GetEventHandler()->ProcessEvent() and handling any exceptions thrown by event handlers. It's mostly useful when processing wx events when called from C code (e.g. in GTK+ callback) when the exception wouldn't correctly propagate to wx.EventLoop.
def HandleWindowEvent(*args, **kwargs): """ HandleWindowEvent(self, Event event) -> bool Process an event by calling GetEventHandler()->ProcessEvent() and handling any exceptions thrown by event handlers. It's mostly useful when processing wx events when called from C code (e.g. in GTK+ callback) when the exception wouldn't correctly propagate to wx.EventLoop. """ return _core_.Window_HandleWindowEvent(*args, **kwargs)
def HasCapture(
*args, **kwargs)
HasCapture(self) -> bool
Returns true if this window has the current mouse capture.
def HasCapture(*args, **kwargs): """ HasCapture(self) -> bool Returns true if this window has the current mouse capture. """ return _core_.Window_HasCapture(*args, **kwargs)
def HasExtraStyle(
*args, **kwargs)
HasExtraStyle(self, int exFlag) -> bool
Returns True if the given extra flag is set.
def HasExtraStyle(*args, **kwargs): """ HasExtraStyle(self, int exFlag) -> bool Returns ``True`` if the given extra flag is set. """ return _core_.Window_HasExtraStyle(*args, **kwargs)
def HasFlag(
*args, **kwargs)
HasFlag(self, int flag) -> bool
Test if the given style is set for this window.
def HasFlag(*args, **kwargs): """ HasFlag(self, int flag) -> bool Test if the given style is set for this window. """ return _core_.Window_HasFlag(*args, **kwargs)
def HasFocus(
*args, **kwargs)
HasFocus(self) -> bool
Returns True if the window has the keyboard focus.
def HasFocus(*args, **kwargs): """ HasFocus(self) -> bool Returns ``True`` if the window has the keyboard focus. """ return _core_.Window_HasFocus(*args, **kwargs)
def HasMultiplePages(
*args, **kwargs)
HasMultiplePages(self) -> bool
def HasMultiplePages(*args, **kwargs): """HasMultiplePages(self) -> bool""" return _core_.Window_HasMultiplePages(*args, **kwargs)
def HasScrollbar(
*args, **kwargs)
HasScrollbar(self, int orient) -> bool
Does the window have the scrollbar for this orientation?
def HasScrollbar(*args, **kwargs): """ HasScrollbar(self, int orient) -> bool Does the window have the scrollbar for this orientation? """ return _core_.Window_HasScrollbar(*args, **kwargs)
def HasTransparentBackground(
*args, **kwargs)
HasTransparentBackground(self) -> bool
Returns True if this window's background is transparent (as, for
example, for wx.StaticText) and should show the parent window's
background.
This method is mostly used internally by the library itself and you normally shouldn't have to call it. You may, however, have to override it in your custom control classes to ensure that background is painted correctly.
def HasTransparentBackground(*args, **kwargs): """ HasTransparentBackground(self) -> bool Returns True if this window's background is transparent (as, for example, for `wx.StaticText`) and should show the parent window's background. This method is mostly used internally by the library itself and you normally shouldn't have to call it. You may, however, have to override it in your custom control classes to ensure that background is painted correctly. """ return _core_.Window_HasTransparentBackground(*args, **kwargs)
def Hide(
*args, **kwargs)
Hide(self) -> bool
Equivalent to calling Show(False).
def Hide(*args, **kwargs): """ Hide(self) -> bool Equivalent to calling Show(False). """ return _core_.Window_Hide(*args, **kwargs)
def HideWithEffect(
*args, **kwargs)
HideWithEffect(self, int effect, unsigned int timeout=0) -> bool
Hide the window with a special effect, not implemented on most platforms (where it is the same as Hide())
Timeout specifies how long the animation should take, in ms, the default value of 0 means to use the default (system-dependent) value.
def HideWithEffect(*args, **kwargs): """ HideWithEffect(self, int effect, unsigned int timeout=0) -> bool Hide the window with a special effect, not implemented on most platforms (where it is the same as Hide()) Timeout specifies how long the animation should take, in ms, the default value of 0 means to use the default (system-dependent) value. """ return _core_.Window_HideWithEffect(*args, **kwargs)
def HitTest(
*args, **kwargs)
HitTest(self, Point pt) -> int
Test where the given (in client coords) point lies
def HitTest(*args, **kwargs): """ HitTest(self, Point pt) -> int Test where the given (in client coords) point lies """ return _core_.Window_HitTest(*args, **kwargs)
def HitTestXY(
*args, **kwargs)
HitTestXY(self, int x, int y) -> int
Test where the given (in client coords) point lies
def HitTestXY(*args, **kwargs): """ HitTestXY(self, int x, int y) -> int Test where the given (in client coords) point lies """ return _core_.Window_HitTestXY(*args, **kwargs)
def InformFirstDirection(
*args, **kwargs)
InformFirstDirection(self, int direction, int size, int availableOtherDir) -> bool
wxSizer and friends use this to give a chance to a component to recalc its min size once one of the final size components is known. Override this function when that is useful (such as for wxStaticText which can stretch over several lines). Parameter availableOtherDir tells the item how much more space there is available in the opposite direction (-1 if unknown).
def InformFirstDirection(*args, **kwargs): """ InformFirstDirection(self, int direction, int size, int availableOtherDir) -> bool wxSizer and friends use this to give a chance to a component to recalc its min size once one of the final size components is known. Override this function when that is useful (such as for wxStaticText which can stretch over several lines). Parameter availableOtherDir tells the item how much more space there is available in the opposite direction (-1 if unknown). """ return _core_.Window_InformFirstDirection(*args, **kwargs)
def InheritAttributes(
*args, **kwargs)
InheritAttributes(self)
This function is (or should be, in case of custom controls) called during window creation to intelligently set up the window visual attributes, that is the font and the foreground and background colours.
By 'intelligently' the following is meant: by default, all windows use their own default attributes. However if some of the parent's attributes are explicitly changed (that is, using SetFont and not SetOwnFont) and if the corresponding attribute hadn't been explicitly set for this window itself, then this window takes the same value as used by the parent. In addition, if the window overrides ShouldInheritColours to return false, the colours will not be changed no matter what and only the font might.
This rather complicated logic is necessary in order to accommodate the different usage scenarios. The most common one is when all default attributes are used and in this case, nothing should be inherited as in modern GUIs different controls use different fonts (and colours) than their siblings so they can't inherit the same value from the parent. However it was also deemed desirable to allow to simply change the attributes of all children at once by just changing the font or colour of their common parent, hence in this case we do inherit the parents attributes.
def InheritAttributes(*args, **kwargs): """ InheritAttributes(self) This function is (or should be, in case of custom controls) called during window creation to intelligently set up the window visual attributes, that is the font and the foreground and background colours. By 'intelligently' the following is meant: by default, all windows use their own default attributes. However if some of the parent's attributes are explicitly changed (that is, using SetFont and not SetOwnFont) and if the corresponding attribute hadn't been explicitly set for this window itself, then this window takes the same value as used by the parent. In addition, if the window overrides ShouldInheritColours to return false, the colours will not be changed no matter what and only the font might. This rather complicated logic is necessary in order to accommodate the different usage scenarios. The most common one is when all default attributes are used and in this case, nothing should be inherited as in modern GUIs different controls use different fonts (and colours) than their siblings so they can't inherit the same value from the parent. However it was also deemed desirable to allow to simply change the attributes of all children at once by just changing the font or colour of their common parent, hence in this case we do inherit the parents attributes. """ return _core_.Window_InheritAttributes(*args, **kwargs)
def InheritsBackgroundColour(
*args, **kwargs)
InheritsBackgroundColour(self) -> bool
def InheritsBackgroundColour(*args, **kwargs): """InheritsBackgroundColour(self) -> bool""" return _core_.Window_InheritsBackgroundColour(*args, **kwargs)
def InitDialog(
*args, **kwargs)
InitDialog(self)
Sends an EVT_INIT_DIALOG event, whose handler usually transfers data to the dialog via validators.
def InitDialog(*args, **kwargs): """ InitDialog(self) Sends an EVT_INIT_DIALOG event, whose handler usually transfers data to the dialog via validators. """ return _core_.Window_InitDialog(*args, **kwargs)
def InvalidateBestSize(
*args, **kwargs)
InvalidateBestSize(self)
Reset the cached best size value so it will be recalculated the next time it is needed.
def InvalidateBestSize(*args, **kwargs): """ InvalidateBestSize(self) Reset the cached best size value so it will be recalculated the next time it is needed. """ return _core_.Window_InvalidateBestSize(*args, **kwargs)
def IsBeingDeleted(
*args, **kwargs)
IsBeingDeleted(self) -> bool
Is the window in the process of being deleted?
def IsBeingDeleted(*args, **kwargs): """ IsBeingDeleted(self) -> bool Is the window in the process of being deleted? """ return _core_.Window_IsBeingDeleted(*args, **kwargs)
def IsDoubleBuffered(
*args, **kwargs)
IsDoubleBuffered(self) -> bool
Returns True if the window contents is double-buffered by the
system, i.e. if any drawing done on the window is really done on a
temporary backing surface and transferred to the screen all at once
later.
def IsDoubleBuffered(*args, **kwargs): """ IsDoubleBuffered(self) -> bool Returns ``True`` if the window contents is double-buffered by the system, i.e. if any drawing done on the window is really done on a temporary backing surface and transferred to the screen all at once later. """ return _core_.Window_IsDoubleBuffered(*args, **kwargs)
def IsEnabled(
*args, **kwargs)
IsEnabled(self) -> bool
Returns true if the window is enabled for input, false otherwise. This method takes into account the enabled state of parent windows up to the top-level window.
def IsEnabled(*args, **kwargs): """ IsEnabled(self) -> bool Returns true if the window is enabled for input, false otherwise. This method takes into account the enabled state of parent windows up to the top-level window. """ return _core_.Window_IsEnabled(*args, **kwargs)
def IsExposed(
*args, **kwargs)
IsExposed(self, int x, int y, int w=1, int h=1) -> bool
Returns true if the given point or rectangle area has been exposed since the last repaint. Call this in an paint event handler to optimize redrawing by only redrawing those areas, which have been exposed.
def IsExposed(*args, **kwargs): """ IsExposed(self, int x, int y, int w=1, int h=1) -> bool Returns true if the given point or rectangle area has been exposed since the last repaint. Call this in an paint event handler to optimize redrawing by only redrawing those areas, which have been exposed. """ return _core_.Window_IsExposed(*args, **kwargs)
def IsExposedPoint(
*args, **kwargs)
IsExposedPoint(self, Point pt) -> bool
Returns true if the given point or rectangle area has been exposed since the last repaint. Call this in an paint event handler to optimize redrawing by only redrawing those areas, which have been exposed.
def IsExposedPoint(*args, **kwargs): """ IsExposedPoint(self, Point pt) -> bool Returns true if the given point or rectangle area has been exposed since the last repaint. Call this in an paint event handler to optimize redrawing by only redrawing those areas, which have been exposed. """ return _core_.Window_IsExposedPoint(*args, **kwargs)
def IsExposedRect(
*args, **kwargs)
IsExposedRect(self, Rect rect) -> bool
Returns true if the given point or rectangle area has been exposed since the last repaint. Call this in an paint event handler to optimize redrawing by only redrawing those areas, which have been exposed.
def IsExposedRect(*args, **kwargs): """ IsExposedRect(self, Rect rect) -> bool Returns true if the given point or rectangle area has been exposed since the last repaint. Call this in an paint event handler to optimize redrawing by only redrawing those areas, which have been exposed. """ return _core_.Window_IsExposedRect(*args, **kwargs)
def IsFrozen(
*args, **kwargs)
IsFrozen(self) -> bool
Returns True if the window has been frozen and not thawed yet.
:see: Freeze and Thaw
def IsFrozen(*args, **kwargs): """ IsFrozen(self) -> bool Returns ``True`` if the window has been frozen and not thawed yet. :see: `Freeze` and `Thaw` """ return _core_.Window_IsFrozen(*args, **kwargs)
def IsRetained(
*args, **kwargs)
IsRetained(self) -> bool
Returns true if the window is retained, false otherwise. Retained windows are only available on X platforms.
def IsRetained(*args, **kwargs): """ IsRetained(self) -> bool Returns true if the window is retained, false otherwise. Retained windows are only available on X platforms. """ return _core_.Window_IsRetained(*args, **kwargs)
def IsSameAs(
*args, **kwargs)
IsSameAs(self, Object p) -> bool
For wx.Objects that use C++ reference counting internally, this method can be used to determine if two objects are referencing the same data object.
def IsSameAs(*args, **kwargs): """ IsSameAs(self, Object p) -> bool For wx.Objects that use C++ reference counting internally, this method can be used to determine if two objects are referencing the same data object. """ return _core_.Object_IsSameAs(*args, **kwargs)
def IsScrollbarAlwaysShown(
*args, **kwargs)
IsScrollbarAlwaysShown(self, int orient) -> bool
def IsScrollbarAlwaysShown(*args, **kwargs): """IsScrollbarAlwaysShown(self, int orient) -> bool""" return _core_.Window_IsScrollbarAlwaysShown(*args, **kwargs)
def IsShown(
*args, **kwargs)
IsShown(self) -> bool
Returns true if the window is shown, false if it has been hidden.
def IsShown(*args, **kwargs): """ IsShown(self) -> bool Returns true if the window is shown, false if it has been hidden. """ return _core_.Window_IsShown(*args, **kwargs)
def IsShownOnScreen(
*args, **kwargs)
IsShownOnScreen(self) -> bool
Returns True if the window is physically visible on the screen,
i.e. it is shown and all its parents up to the toplevel window are
shown as well.
def IsShownOnScreen(*args, **kwargs): """ IsShownOnScreen(self) -> bool Returns ``True`` if the window is physically visible on the screen, i.e. it is shown and all its parents up to the toplevel window are shown as well. """ return _core_.Window_IsShownOnScreen(*args, **kwargs)
def IsThisEnabled(
*args, **kwargs)
IsThisEnabled(self) -> bool
Returns the internal enabled state independent of the parent(s) state,
i.e. the state in which the window would be if all of its parents are
enabled. Use IsEnabled to get the effective window state.
def IsThisEnabled(*args, **kwargs): """ IsThisEnabled(self) -> bool Returns the internal enabled state independent of the parent(s) state, i.e. the state in which the window would be if all of its parents are enabled. Use `IsEnabled` to get the effective window state. """ return _core_.Window_IsThisEnabled(*args, **kwargs)
def IsTopLevel(
*args, **kwargs)
IsTopLevel(self) -> bool
Returns true if the given window is a top-level one. Currently all frames and dialogs are always considered to be top-level windows (even if they have a parent window).
def IsTopLevel(*args, **kwargs): """ IsTopLevel(self) -> bool Returns true if the given window is a top-level one. Currently all frames and dialogs are always considered to be top-level windows (even if they have a parent window). """ return _core_.Window_IsTopLevel(*args, **kwargs)
def IsUnlinked(
*args, **kwargs)
IsUnlinked(self) -> bool
def IsUnlinked(*args, **kwargs): """IsUnlinked(self) -> bool""" return _core_.EvtHandler_IsUnlinked(*args, **kwargs)
def Layout(
*args, **kwargs)
Layout(self) -> bool
Invokes the constraint-based layout algorithm or the sizer-based algorithm for this window. See SetAutoLayout: when auto layout is on, this function gets called automatically by the default EVT_SIZE handler when the window is resized.
def Layout(*args, **kwargs): """ Layout(self) -> bool Invokes the constraint-based layout algorithm or the sizer-based algorithm for this window. See SetAutoLayout: when auto layout is on, this function gets called automatically by the default EVT_SIZE handler when the window is resized. """ return _core_.Window_Layout(*args, **kwargs)
def LineDown(
*args, **kwargs)
LineDown(self) -> bool
This is just a wrapper for ScrollLines(1).
def LineDown(*args, **kwargs): """ LineDown(self) -> bool This is just a wrapper for ScrollLines(1). """ return _core_.Window_LineDown(*args, **kwargs)
def LineUp(
*args, **kwargs)
LineUp(self) -> bool
This is just a wrapper for ScrollLines(-1).
def LineUp(*args, **kwargs): """ LineUp(self) -> bool This is just a wrapper for ScrollLines(-1). """ return _core_.Window_LineUp(*args, **kwargs)
def Lower(
*args, **kwargs)
Lower(self)
Lowers the window to the bottom of the window hierarchy. In current version of wxWidgets this works both for managed and child windows.
def Lower(*args, **kwargs): """ Lower(self) Lowers the window to the bottom of the window hierarchy. In current version of wxWidgets this works both for managed and child windows. """ return _core_.Window_Lower(*args, **kwargs)
def MakeModal(
*args, **kwargs)
MakeModal(self, bool modal=True)
Disables all other windows in the application so that the user can only interact with this window. Passing False will reverse this effect.
def MakeModal(*args, **kwargs): """ MakeModal(self, bool modal=True) Disables all other windows in the application so that the user can only interact with this window. Passing False will reverse this effect. """ return _core_.Window_MakeModal(*args, **kwargs)
def Move(
*args, **kwargs)
Move(self, Point pt, int flags=SIZE_USE_EXISTING)
Moves the window to the given position.
def Move(*args, **kwargs): """ Move(self, Point pt, int flags=SIZE_USE_EXISTING) Moves the window to the given position. """ return _core_.Window_Move(*args, **kwargs)
def MoveAfterInTabOrder(
*args, **kwargs)
MoveAfterInTabOrder(self, Window win)
Moves this window in the tab navigation order after the specified sibling window. This means that when the user presses the TAB key on that other window, the focus switches to this window.
The default tab order is the same as creation order. This function
and MoveBeforeInTabOrder allow to change it after creating all the
windows.
def MoveAfterInTabOrder(*args, **kwargs): """ MoveAfterInTabOrder(self, Window win) Moves this window in the tab navigation order after the specified sibling window. This means that when the user presses the TAB key on that other window, the focus switches to this window. The default tab order is the same as creation order. This function and `MoveBeforeInTabOrder` allow to change it after creating all the windows. """ return _core_.Window_MoveAfterInTabOrder(*args, **kwargs)
def MoveBeforeInTabOrder(
*args, **kwargs)
MoveBeforeInTabOrder(self, Window win)
Same as MoveAfterInTabOrder except that it inserts this window just
before win instead of putting it right after it.
def MoveBeforeInTabOrder(*args, **kwargs): """ MoveBeforeInTabOrder(self, Window win) Same as `MoveAfterInTabOrder` except that it inserts this window just before win instead of putting it right after it. """ return _core_.Window_MoveBeforeInTabOrder(*args, **kwargs)
def MoveXY(
*args, **kwargs)
MoveXY(self, int x, int y, int flags=SIZE_USE_EXISTING)
Moves the window to the given position.
def MoveXY(*args, **kwargs): """ MoveXY(self, int x, int y, int flags=SIZE_USE_EXISTING) Moves the window to the given position. """ return _core_.Window_MoveXY(*args, **kwargs)
Navigate(self, int flags=NavigationKeyEvent.IsForward) -> bool
Does keyboard navigation starting from this window to another. This is equivalient to self.GetParent().NavigateIn().
NavigateIn(self, int flags=NavigationKeyEvent.IsForward) -> bool
Navigates inside this window.
def OnPaint(
*args, **kwargs)
OnPaint(self, PaintEvent event)
def OnPaint(*args, **kwargs): """OnPaint(self, PaintEvent event)""" return _core_.Window_OnPaint(*args, **kwargs)
def PageDown(
*args, **kwargs)
PageDown(self) -> bool
This is just a wrapper for ScrollPages(1).
def PageDown(*args, **kwargs): """ PageDown(self) -> bool This is just a wrapper for ScrollPages(1). """ return _core_.Window_PageDown(*args, **kwargs)
def PageUp(
*args, **kwargs)
PageUp(self) -> bool
This is just a wrapper for ScrollPages(-1).
def PageUp(*args, **kwargs): """ PageUp(self) -> bool This is just a wrapper for ScrollPages(-1). """ return _core_.Window_PageUp(*args, **kwargs)
def PopEventHandler(
*args, **kwargs)
PopEventHandler(self, bool deleteHandler=False) -> EvtHandler
Removes and returns the top-most event handler on the event handler
stack. If deleteHandler is True then the wx.EvtHandler object will be
destroyed after it is popped, and None will be returned instead.
def PopEventHandler(*args, **kwargs): """ PopEventHandler(self, bool deleteHandler=False) -> EvtHandler Removes and returns the top-most event handler on the event handler stack. If deleteHandler is True then the wx.EvtHandler object will be destroyed after it is popped, and ``None`` will be returned instead. """ return _core_.Window_PopEventHandler(*args, **kwargs)
def PopupMenu(
*args, **kwargs)
PopupMenu(self, Menu menu, Point pos=DefaultPosition) -> bool
Pops up the given menu at the specified coordinates, relative to this window, and returns control when the user has dismissed the menu. If a menu item is selected, the corresponding menu event is generated and will be processed as usual. If the default position is given then the current position of the mouse cursor will be used.
def PopupMenu(*args, **kwargs): """ PopupMenu(self, Menu menu, Point pos=DefaultPosition) -> bool Pops up the given menu at the specified coordinates, relative to this window, and returns control when the user has dismissed the menu. If a menu item is selected, the corresponding menu event is generated and will be processed as usual. If the default position is given then the current position of the mouse cursor will be used. """ return _core_.Window_PopupMenu(*args, **kwargs)
def PopupMenuXY(
*args, **kwargs)
PopupMenuXY(self, Menu menu, int x=-1, int y=-1) -> bool
Pops up the given menu at the specified coordinates, relative to this window, and returns control when the user has dismissed the menu. If a menu item is selected, the corresponding menu event is generated and will be processed as usual. If the default position is given then the current position of the mouse cursor will be used.
def PopupMenuXY(*args, **kwargs): """ PopupMenuXY(self, Menu menu, int x=-1, int y=-1) -> bool Pops up the given menu at the specified coordinates, relative to this window, and returns control when the user has dismissed the menu. If a menu item is selected, the corresponding menu event is generated and will be processed as usual. If the default position is given then the current position of the mouse cursor will be used. """ return _core_.Window_PopupMenuXY(*args, **kwargs)
def PostCreate(
self, pre)
Phase 3 of the 2-phase create
def PostCreate(self, pre): """ Phase 3 of the 2-phase create <wink!> Call this method after precreating the window with the 2-phase create method. """ self.this = pre.this self.thisown = pre.thisown pre.thisown = 0 if hasattr(self, '_setOORInfo'): try: self._setOORInfo(self) except TypeError: pass if hasattr(self, '_setCallbackInfo'): try: self._setCallbackInfo(self, pre.__class__) except TypeError: pass
def PostSizeEvent(
*args, **kwargs)
PostSizeEvent(self)
This is a more readable synonym for SendSizeEvent(wx.SEND_EVENT_POST)
def PostSizeEvent(*args, **kwargs): """ PostSizeEvent(self) This is a more readable synonym for SendSizeEvent(wx.SEND_EVENT_POST) """ return _core_.Window_PostSizeEvent(*args, **kwargs)
def PostSizeEventToParent(
*args, **kwargs)
PostSizeEventToParent(self)
This is the same as SendSizeEventToParent() but using PostSizeEvent()
def PostSizeEventToParent(*args, **kwargs): """ PostSizeEventToParent(self) This is the same as SendSizeEventToParent() but using PostSizeEvent() """ return _core_.Window_PostSizeEventToParent(*args, **kwargs)
def ProcessEvent(
*args, **kwargs)
ProcessEvent(self, Event event) -> bool
def ProcessEvent(*args, **kwargs): """ProcessEvent(self, Event event) -> bool""" return _core_.EvtHandler_ProcessEvent(*args, **kwargs)
def ProcessEventLocally(
*args, **kwargs)
ProcessEventLocally(self, Event event) -> bool
def ProcessEventLocally(*args, **kwargs): """ProcessEventLocally(self, Event event) -> bool""" return _core_.EvtHandler_ProcessEventLocally(*args, **kwargs)
def ProcessPendingEvents(
*args, **kwargs)
ProcessPendingEvents(self)
def ProcessPendingEvents(*args, **kwargs): """ProcessPendingEvents(self)""" return _core_.EvtHandler_ProcessPendingEvents(*args, **kwargs)
def ProcessWindowEvent(
*args, **kwargs)
ProcessWindowEvent(self, Event event) -> bool
Process an event by calling GetEventHandler().ProcessEvent(): this is a straightforward replacement for ProcessEvent() itself which shouldn't be used directly with windows as it doesn't take into account any event handlers associated with the window
def ProcessWindowEvent(*args, **kwargs): """ ProcessWindowEvent(self, Event event) -> bool Process an event by calling GetEventHandler().ProcessEvent(): this is a straightforward replacement for ProcessEvent() itself which shouldn't be used directly with windows as it doesn't take into account any event handlers associated with the window """ return _core_.Window_ProcessWindowEvent(*args, **kwargs)
def PushEventHandler(
*args, **kwargs)
PushEventHandler(self, EvtHandler handler)
Pushes this event handler onto the event handler stack for the window. An event handler is an object that is capable of processing the events sent to a window. (In other words, is able to dispatch the events to a handler function.) By default, the window is its own event handler, but an application may wish to substitute another, for example to allow central implementation of event-handling for a variety of different window classes.
wx.Window.PushEventHandler allows an application to set up a chain of
event handlers, where an event not handled by one event handler is
handed to the next one in the chain. Use wx.Window.PopEventHandler
to remove the event handler. Ownership of the handler is not given
to the window, so you should be sure to pop the handler before the
window is destroyed and either let PopEventHandler destroy it, or call
its Destroy method yourself.
def PushEventHandler(*args, **kwargs): """ PushEventHandler(self, EvtHandler handler) Pushes this event handler onto the event handler stack for the window. An event handler is an object that is capable of processing the events sent to a window. (In other words, is able to dispatch the events to a handler function.) By default, the window is its own event handler, but an application may wish to substitute another, for example to allow central implementation of event-handling for a variety of different window classes. wx.Window.PushEventHandler allows an application to set up a chain of event handlers, where an event not handled by one event handler is handed to the next one in the chain. Use `wx.Window.PopEventHandler` to remove the event handler. Ownership of the handler is *not* given to the window, so you should be sure to pop the handler before the window is destroyed and either let PopEventHandler destroy it, or call its Destroy method yourself. """ return _core_.Window_PushEventHandler(*args, **kwargs)
def QueueEvent(
*args, **kwargs)
QueueEvent(self, Event event)
def QueueEvent(*args, **kwargs): """QueueEvent(self, Event event)""" return _core_.EvtHandler_QueueEvent(*args, **kwargs)
def Raise(
*args, **kwargs)
Raise(self)
Raises the window to the top of the window hierarchy. In current version of wxWidgets this works both for managed and child windows.
def Raise(*args, **kwargs): """ Raise(self) Raises the window to the top of the window hierarchy. In current version of wxWidgets this works both for managed and child windows. """ return _core_.Window_Raise(*args, **kwargs)
def Refresh(
*args, **kwargs)
Refresh(self, bool eraseBackground=True, Rect rect=None)
Mark the specified rectangle (or the whole window) as "dirty" so it will be repainted. Causes an EVT_PAINT event to be generated and sent to the window.
def Refresh(*args, **kwargs): """ Refresh(self, bool eraseBackground=True, Rect rect=None) Mark the specified rectangle (or the whole window) as "dirty" so it will be repainted. Causes an EVT_PAINT event to be generated and sent to the window. """ return _core_.Window_Refresh(*args, **kwargs)
def RefreshRect(
*args, **kwargs)
RefreshRect(self, Rect rect, bool eraseBackground=True)
Redraws the contents of the given rectangle: the area inside it will be repainted. This is the same as Refresh but has a nicer syntax.
def RefreshRect(*args, **kwargs): """ RefreshRect(self, Rect rect, bool eraseBackground=True) Redraws the contents of the given rectangle: the area inside it will be repainted. This is the same as Refresh but has a nicer syntax. """ return _core_.Window_RefreshRect(*args, **kwargs)
def RegisterHotKey(
*args, **kwargs)
RegisterHotKey(self, int hotkeyId, int modifiers, int keycode) -> bool
Registers a system wide hotkey. Every time the user presses the hotkey registered here, this window will receive a hotkey event. It will receive the event even if the application is in the background and does not have the input focus because the user is working with some other application. To bind an event handler function to this hotkey use EVT_HOTKEY with an id equal to hotkeyId. Returns True if the hotkey was registered successfully.
def RegisterHotKey(*args, **kwargs): """ RegisterHotKey(self, int hotkeyId, int modifiers, int keycode) -> bool Registers a system wide hotkey. Every time the user presses the hotkey registered here, this window will receive a hotkey event. It will receive the event even if the application is in the background and does not have the input focus because the user is working with some other application. To bind an event handler function to this hotkey use EVT_HOTKEY with an id equal to hotkeyId. Returns True if the hotkey was registered successfully. """ return _core_.Window_RegisterHotKey(*args, **kwargs)
def ReleaseMouse(
*args, **kwargs)
ReleaseMouse(self)
Releases mouse input captured with wx.Window.CaptureMouse.
def ReleaseMouse(*args, **kwargs): """ ReleaseMouse(self) Releases mouse input captured with wx.Window.CaptureMouse. """ return _core_.Window_ReleaseMouse(*args, **kwargs)
def RemoveChild(
*args, **kwargs)
RemoveChild(self, Window child)
Removes a child window. This is called automatically by window deletion functions so should not be required by the application programmer.
def RemoveChild(*args, **kwargs): """ RemoveChild(self, Window child) Removes a child window. This is called automatically by window deletion functions so should not be required by the application programmer. """ return _core_.Window_RemoveChild(*args, **kwargs)
def RemoveEventHandler(
*args, **kwargs)
RemoveEventHandler(self, EvtHandler handler) -> bool
Find the given handler in the event handler chain and remove (but not delete) it from the event handler chain, returns True if it was found and False otherwise (this also results in an assert failure so this function should only be called when the handler is supposed to be there.)
def RemoveEventHandler(*args, **kwargs): """ RemoveEventHandler(self, EvtHandler handler) -> bool Find the given handler in the event handler chain and remove (but not delete) it from the event handler chain, returns True if it was found and False otherwise (this also results in an assert failure so this function should only be called when the handler is supposed to be there.) """ return _core_.Window_RemoveEventHandler(*args, **kwargs)
def Reparent(
*args, **kwargs)
Reparent(self, Window newParent) -> bool
Reparents the window, i.e the window will be removed from its current parent window (e.g. a non-standard toolbar in a wxFrame) and then re-inserted into another. Available on Windows and GTK. Returns True if the parent was changed, False otherwise (error or newParent == oldParent)
def Reparent(*args, **kwargs): """ Reparent(self, Window newParent) -> bool Reparents the window, i.e the window will be removed from its current parent window (e.g. a non-standard toolbar in a wxFrame) and then re-inserted into another. Available on Windows and GTK. Returns True if the parent was changed, False otherwise (error or newParent == oldParent) """ return _core_.Window_Reparent(*args, **kwargs)
def SafelyProcessEvent(
*args, **kwargs)
SafelyProcessEvent(self, Event event) -> bool
def SafelyProcessEvent(*args, **kwargs): """SafelyProcessEvent(self, Event event) -> bool""" return _core_.EvtHandler_SafelyProcessEvent(*args, **kwargs)
def ScreenToClient(
*args, **kwargs)
ScreenToClient(self, Point pt) -> Point
Converts from screen to client window coordinates.
def ScreenToClient(*args, **kwargs): """ ScreenToClient(self, Point pt) -> Point Converts from screen to client window coordinates. """ return _core_.Window_ScreenToClient(*args, **kwargs)
def ScreenToClientXY(
*args, **kwargs)
ScreenToClientXY(int x, int y) -> (x,y)
Converts from screen to client window coordinates.
def ScreenToClientXY(*args, **kwargs): """ ScreenToClientXY(int x, int y) -> (x,y) Converts from screen to client window coordinates. """ return _core_.Window_ScreenToClientXY(*args, **kwargs)
def ScrollLines(
*args, **kwargs)
ScrollLines(self, int lines) -> bool
If the platform and window class supports it, scrolls the window by the given number of lines down, if lines is positive, or up if lines is negative. Returns True if the window was scrolled, False if it was already on top/bottom and nothing was done.
def ScrollLines(*args, **kwargs): """ ScrollLines(self, int lines) -> bool If the platform and window class supports it, scrolls the window by the given number of lines down, if lines is positive, or up if lines is negative. Returns True if the window was scrolled, False if it was already on top/bottom and nothing was done. """ return _core_.Window_ScrollLines(*args, **kwargs)
def ScrollPages(
*args, **kwargs)
ScrollPages(self, int pages) -> bool
If the platform and window class supports it, scrolls the window by the given number of pages down, if pages is positive, or up if pages is negative. Returns True if the window was scrolled, False if it was already on top/bottom and nothing was done.
def ScrollPages(*args, **kwargs): """ ScrollPages(self, int pages) -> bool If the platform and window class supports it, scrolls the window by the given number of pages down, if pages is positive, or up if pages is negative. Returns True if the window was scrolled, False if it was already on top/bottom and nothing was done. """ return _core_.Window_ScrollPages(*args, **kwargs)
def ScrollWindow(
*args, **kwargs)
ScrollWindow(self, int dx, int dy, Rect rect=None)
Physically scrolls the pixels in the window and move child windows accordingly. Use this function to optimise your scrolling implementations, to minimise the area that must be redrawn. Note that it is rarely required to call this function from a user program.
def ScrollWindow(*args, **kwargs): """ ScrollWindow(self, int dx, int dy, Rect rect=None) Physically scrolls the pixels in the window and move child windows accordingly. Use this function to optimise your scrolling implementations, to minimise the area that must be redrawn. Note that it is rarely required to call this function from a user program. """ return _core_.Window_ScrollWindow(*args, **kwargs)
def SendIdleEvents(
*args, **kwargs)
SendIdleEvents(self, IdleEvent event) -> bool
Send idle event to window and all subwindows. Returns True if more idle time is requested.
def SendIdleEvents(*args, **kwargs): """ SendIdleEvents(self, IdleEvent event) -> bool Send idle event to window and all subwindows. Returns True if more idle time is requested. """ return _core_.Window_SendIdleEvents(*args, **kwargs)
def SendSizeEvent(
*args, **kwargs)
SendSizeEvent(self, int flags=0)
Sends a size event to the window using its current size -- this has an effect of refreshing the window layout.
By default the event is sent, i.e. processed immediately, but if flags value includes wxSEND_EVENT_POST then it's posted, i.e. only schedule for later processing.
def SendSizeEvent(*args, **kwargs): """ SendSizeEvent(self, int flags=0) Sends a size event to the window using its current size -- this has an effect of refreshing the window layout. By default the event is sent, i.e. processed immediately, but if flags value includes wxSEND_EVENT_POST then it's posted, i.e. only schedule for later processing. """ return _core_.Window_SendSizeEvent(*args, **kwargs)
def SendSizeEventToParent(
*args, **kwargs)
SendSizeEventToParent(self, int flags=0)
This is a safe wrapper for GetParent().SendSizeEvent(): it checks that we have a parent window and it's not in process of being deleted.
def SendSizeEventToParent(*args, **kwargs): """ SendSizeEventToParent(self, int flags=0) This is a safe wrapper for GetParent().SendSizeEvent(): it checks that we have a parent window and it's not in process of being deleted. """ return _core_.Window_SendSizeEventToParent(*args, **kwargs)
def SetAcceleratorTable(
*args, **kwargs)
SetAcceleratorTable(self, AcceleratorTable accel)
Sets the accelerator table for this window.
def SetAcceleratorTable(*args, **kwargs): """ SetAcceleratorTable(self, AcceleratorTable accel) Sets the accelerator table for this window. """ return _core_.Window_SetAcceleratorTable(*args, **kwargs)
def SetAutoLayout(
*args, **kwargs)
SetAutoLayout(self, bool autoLayout)
Determines whether the Layout function will be called automatically
when the window is resized. lease note that this only happens for the
windows usually used to contain children, namely wx.Panel and
wx.TopLevelWindow (and the classes deriving from them).
This method is called implicitly by SetSizer but if you use
SetConstraints you should call it manually or otherwise the window
layout won't be correctly updated when its size changes.
def SetAutoLayout(*args, **kwargs): """ SetAutoLayout(self, bool autoLayout) Determines whether the Layout function will be called automatically when the window is resized. lease note that this only happens for the windows usually used to contain children, namely `wx.Panel` and `wx.TopLevelWindow` (and the classes deriving from them). This method is called implicitly by `SetSizer` but if you use `SetConstraints` you should call it manually or otherwise the window layout won't be correctly updated when its size changes. """ return _core_.Window_SetAutoLayout(*args, **kwargs)
def SetBackgroundColour(
*args, **kwargs)
SetBackgroundColour(self, Colour colour) -> bool
Sets the background colour of the window. Returns True if the colour
was changed. The background colour is usually painted by the default
EVT_ERASE_BACKGROUND event handler function under Windows and
automatically under GTK. Using wx.NullColour will reset the window
to the default background colour.
Note that setting the background colour may not cause an immediate
refresh, so you may wish to call ClearBackground or Refresh after
calling this function.
Using this function will disable attempts to use themes for this window, if the system supports them. Use with care since usually the themes represent the appearance chosen by the user to be used for all applications on the system.
def SetBackgroundColour(*args, **kwargs): """ SetBackgroundColour(self, Colour colour) -> bool Sets the background colour of the window. Returns True if the colour was changed. The background colour is usually painted by the default EVT_ERASE_BACKGROUND event handler function under Windows and automatically under GTK. Using `wx.NullColour` will reset the window to the default background colour. Note that setting the background colour may not cause an immediate refresh, so you may wish to call `ClearBackground` or `Refresh` after calling this function. Using this function will disable attempts to use themes for this window, if the system supports them. Use with care since usually the themes represent the appearance chosen by the user to be used for all applications on the system. """ return _core_.Window_SetBackgroundColour(*args, **kwargs)
def SetBackgroundStyle(
*args, **kwargs)
SetBackgroundStyle(self, int style) -> bool
Returns the background style of the window. The background style indicates how the background of the window is drawn.
====================== ========================================
wx.BG_STYLE_SYSTEM The background colour or pattern should
be determined by the system
wx.BG_STYLE_COLOUR The background should be a solid colour
wx.BG_STYLE_CUSTOM The background will be implemented by the
application.
====================== ========================================
On GTK+, use of wx.BG_STYLE_CUSTOM allows the flicker-free drawing of a custom background, such as a tiled bitmap. Currently the style has no effect on other platforms.
:see: GetBackgroundStyle, SetBackgroundColour
def SetBackgroundStyle(*args, **kwargs): """ SetBackgroundStyle(self, int style) -> bool Returns the background style of the window. The background style indicates how the background of the window is drawn. ====================== ======================================== wx.BG_STYLE_SYSTEM The background colour or pattern should be determined by the system wx.BG_STYLE_COLOUR The background should be a solid colour wx.BG_STYLE_CUSTOM The background will be implemented by the application. ====================== ======================================== On GTK+, use of wx.BG_STYLE_CUSTOM allows the flicker-free drawing of a custom background, such as a tiled bitmap. Currently the style has no effect on other platforms. :see: `GetBackgroundStyle`, `SetBackgroundColour` """ return _core_.Window_SetBackgroundStyle(*args, **kwargs)
def SetBestFittingSize(
*args, **kw)
SetInitialSize(self, Size size=DefaultSize)
A 'Smart' SetSize that will fill in default size components with the window's best size values. Also set's the minsize for use with sizers.
def deprecated_func(*args, **kw): warnings.warn("Call to deprecated item. %s" % msg, wxPyDeprecationWarning, stacklevel=2) return item(*args, **kw)
def SetCanFocus(
*args, **kwargs)
SetCanFocus(self, bool canFocus)
def SetCanFocus(*args, **kwargs): """SetCanFocus(self, bool canFocus)""" return _core_.Window_SetCanFocus(*args, **kwargs)
def SetCaret(
*args, **kwargs)
SetCaret(self, Caret caret)
Sets the caret associated with the window.
def SetCaret(*args, **kwargs): """ SetCaret(self, Caret caret) Sets the caret associated with the window. """ return _core_.Window_SetCaret(*args, **kwargs)
def SetClientRect(
*args, **kwargs)
SetClientRect(self, Rect rect)
This sets the size of the window client area in pixels. Using this function to size a window tends to be more device-independent than wx.Window.SetSize, since the application need not worry about what dimensions the border or title bar have when trying to fit the window around panel items, for example.
def SetClientRect(*args, **kwargs): """ SetClientRect(self, Rect rect) This sets the size of the window client area in pixels. Using this function to size a window tends to be more device-independent than wx.Window.SetSize, since the application need not worry about what dimensions the border or title bar have when trying to fit the window around panel items, for example. """ return _core_.Window_SetClientRect(*args, **kwargs)
def SetClientSize(
*args, **kwargs)
SetClientSize(self, Size size)
This sets the size of the window client area in pixels. Using this function to size a window tends to be more device-independent than wx.Window.SetSize, since the application need not worry about what dimensions the border or title bar have when trying to fit the window around panel items, for example.
def SetClientSize(*args, **kwargs): """ SetClientSize(self, Size size) This sets the size of the window client area in pixels. Using this function to size a window tends to be more device-independent than wx.Window.SetSize, since the application need not worry about what dimensions the border or title bar have when trying to fit the window around panel items, for example. """ return _core_.Window_SetClientSize(*args, **kwargs)
def SetClientSizeWH(
*args, **kwargs)
SetClientSizeWH(self, int width, int height)
This sets the size of the window client area in pixels. Using this function to size a window tends to be more device-independent than wx.Window.SetSize, since the application need not worry about what dimensions the border or title bar have when trying to fit the window around panel items, for example.
def SetClientSizeWH(*args, **kwargs): """ SetClientSizeWH(self, int width, int height) This sets the size of the window client area in pixels. Using this function to size a window tends to be more device-independent than wx.Window.SetSize, since the application need not worry about what dimensions the border or title bar have when trying to fit the window around panel items, for example. """ return _core_.Window_SetClientSizeWH(*args, **kwargs)
def SetConstraints(
*args, **kwargs)
SetConstraints(self, LayoutConstraints constraints)
Sets the window to have the given layout constraints. If an existing layout constraints object is already owned by the window, it will be deleted. Pass None to disassociate and delete the window's current constraints.
You must call SetAutoLayout to tell a window to use the constraints automatically in its default EVT_SIZE handler; otherwise, you must handle EVT_SIZE yourself and call Layout() explicitly. When setting both a wx.LayoutConstraints and a wx.Sizer, only the sizer will have effect.
def SetConstraints(*args, **kwargs): """ SetConstraints(self, LayoutConstraints constraints) Sets the window to have the given layout constraints. If an existing layout constraints object is already owned by the window, it will be deleted. Pass None to disassociate and delete the window's current constraints. You must call SetAutoLayout to tell a window to use the constraints automatically in its default EVT_SIZE handler; otherwise, you must handle EVT_SIZE yourself and call Layout() explicitly. When setting both a wx.LayoutConstraints and a wx.Sizer, only the sizer will have effect. """ return _core_.Window_SetConstraints(*args, **kwargs)
def SetContainingSizer(
*args, **kwargs)
SetContainingSizer(self, Sizer sizer)
This normally does not need to be called by application code. It is called internally when a window is added to a sizer, and is used so the window can remove itself from the sizer when it is destroyed.
def SetContainingSizer(*args, **kwargs): """ SetContainingSizer(self, Sizer sizer) This normally does not need to be called by application code. It is called internally when a window is added to a sizer, and is used so the window can remove itself from the sizer when it is destroyed. """ return _core_.Window_SetContainingSizer(*args, **kwargs)
def SetCursor(
*args, **kwargs)
SetCursor(self, Cursor cursor) -> bool
Sets the window's cursor. Notice that the window cursor also sets it for the children of the window implicitly.
The cursor may be wx.NullCursor in which case the window cursor will be reset back to default.
def SetCursor(*args, **kwargs): """ SetCursor(self, Cursor cursor) -> bool Sets the window's cursor. Notice that the window cursor also sets it for the children of the window implicitly. The cursor may be wx.NullCursor in which case the window cursor will be reset back to default. """ return _core_.Window_SetCursor(*args, **kwargs)
def SetDimensions(
*args, **kwargs)
SetDimensions(self, int x, int y, int width, int height, int sizeFlags=SIZE_AUTO)
Sets the position and size of the window in pixels. The sizeFlags parameter indicates the interpretation of the other params if they are equal to -1.
======================== ======================================
wx.SIZE_AUTO A -1 indicates that a class-specific
default should be used.
wx.SIZE_USE_EXISTING Existing dimensions should be used if
-1 values are supplied.
wxSIZE_ALLOW_MINUS_ONE Allow dimensions of -1 and less to be
interpreted as real dimensions, not
default values.
======================== ======================================
def SetDimensions(*args, **kwargs): """ SetDimensions(self, int x, int y, int width, int height, int sizeFlags=SIZE_AUTO) Sets the position and size of the window in pixels. The sizeFlags parameter indicates the interpretation of the other params if they are equal to -1. ======================== ====================================== wx.SIZE_AUTO A -1 indicates that a class-specific default should be used. wx.SIZE_USE_EXISTING Existing dimensions should be used if -1 values are supplied. wxSIZE_ALLOW_MINUS_ONE Allow dimensions of -1 and less to be interpreted as real dimensions, not default values. ======================== ====================================== """ return _core_.Window_SetDimensions(*args, **kwargs)
def SetDoubleBuffered(
*args, **kwargs)
SetDoubleBuffered(self, bool on)
Put the native window into double buffered or composited mode.
def SetDoubleBuffered(*args, **kwargs): """ SetDoubleBuffered(self, bool on) Put the native window into double buffered or composited mode. """ return _core_.Window_SetDoubleBuffered(*args, **kwargs)
def SetDropTarget(
*args, **kwargs)
SetDropTarget(self, DropTarget dropTarget)
Associates a drop target with this window. If the window already has a drop target, it is deleted.
def SetDropTarget(*args, **kwargs): """ SetDropTarget(self, DropTarget dropTarget) Associates a drop target with this window. If the window already has a drop target, it is deleted. """ return _core_.Window_SetDropTarget(*args, **kwargs)
def SetEventHandler(
*args, **kwargs)
SetEventHandler(self, EvtHandler handler)
Sets the event handler for this window. An event handler is an object that is capable of processing the events sent to a window. (In other words, is able to dispatch the events to handler function.) By default, the window is its own event handler, but an application may wish to substitute another, for example to allow central implementation of event-handling for a variety of different window classes.
It is usually better to use wx.Window.PushEventHandler since this sets
up a chain of event handlers, where an event not handled by one event
handler is handed off to the next one in the chain.
def SetEventHandler(*args, **kwargs): """ SetEventHandler(self, EvtHandler handler) Sets the event handler for this window. An event handler is an object that is capable of processing the events sent to a window. (In other words, is able to dispatch the events to handler function.) By default, the window is its own event handler, but an application may wish to substitute another, for example to allow central implementation of event-handling for a variety of different window classes. It is usually better to use `wx.Window.PushEventHandler` since this sets up a chain of event handlers, where an event not handled by one event handler is handed off to the next one in the chain. """ return _core_.Window_SetEventHandler(*args, **kwargs)
def SetEvtHandlerEnabled(
*args, **kwargs)
SetEvtHandlerEnabled(self, bool enabled)
def SetEvtHandlerEnabled(*args, **kwargs): """SetEvtHandlerEnabled(self, bool enabled)""" return _core_.EvtHandler_SetEvtHandlerEnabled(*args, **kwargs)
def SetExtraStyle(
*args, **kwargs)
SetExtraStyle(self, long exStyle)
Sets the extra style bits for the window. Extra styles are the less often used style bits which can't be set with the constructor or with SetWindowStyleFlag()
def SetExtraStyle(*args, **kwargs): """ SetExtraStyle(self, long exStyle) Sets the extra style bits for the window. Extra styles are the less often used style bits which can't be set with the constructor or with SetWindowStyleFlag() """ return _core_.Window_SetExtraStyle(*args, **kwargs)
def SetFocus(
*args, **kwargs)
SetFocus(self)
Set's the focus to this window, allowing it to receive keyboard input.
def SetFocus(*args, **kwargs): """ SetFocus(self) Set's the focus to this window, allowing it to receive keyboard input. """ return _core_.Window_SetFocus(*args, **kwargs)
def SetFocusFromKbd(
*args, **kwargs)
SetFocusFromKbd(self)
Set focus to this window as the result of a keyboard action. Normally only called internally.
def SetFocusFromKbd(*args, **kwargs): """ SetFocusFromKbd(self) Set focus to this window as the result of a keyboard action. Normally only called internally. """ return _core_.Window_SetFocusFromKbd(*args, **kwargs)
def SetFocusIgnoringChildren(
*args, **kwargs)
SetFocusIgnoringChildren(self)
In contrast to SetFocus (see above) this will set the focus to the
panel even of there are child windows in the panel. This is only
rarely needed.
def SetFocusIgnoringChildren(*args, **kwargs): """ SetFocusIgnoringChildren(self) In contrast to `SetFocus` (see above) this will set the focus to the panel even of there are child windows in the panel. This is only rarely needed. """ return _windows_.Panel_SetFocusIgnoringChildren(*args, **kwargs)
def SetFont(
*args, **kwargs)
SetFont(self, Font font) -> bool
Sets the font for this window.
def SetFont(*args, **kwargs): """ SetFont(self, Font font) -> bool Sets the font for this window. """ return _core_.Window_SetFont(*args, **kwargs)
def SetForegroundColour(
*args, **kwargs)
SetForegroundColour(self, Colour colour) -> bool
Sets the foreground colour of the window. Returns True is the colour was changed. The interpretation of foreground colour is dependent on the window class; it may be the text colour or other colour, or it may not be used at all.
def SetForegroundColour(*args, **kwargs): """ SetForegroundColour(self, Colour colour) -> bool Sets the foreground colour of the window. Returns True is the colour was changed. The interpretation of foreground colour is dependent on the window class; it may be the text colour or other colour, or it may not be used at all. """ return _core_.Window_SetForegroundColour(*args, **kwargs)
def SetHelpText(
*args, **kwargs)
SetHelpText(self, String text)
Sets the help text to be used as context-sensitive help for this
window. Note that the text is actually stored by the current
wx.HelpProvider implementation, and not in the window object itself.
def SetHelpText(*args, **kwargs): """ SetHelpText(self, String text) Sets the help text to be used as context-sensitive help for this window. Note that the text is actually stored by the current `wx.HelpProvider` implementation, and not in the window object itself. """ return _core_.Window_SetHelpText(*args, **kwargs)
def SetHelpTextForId(
*args, **kw)
SetHelpTextForId(self, String text)
Associate this help text with all windows with the same id as this one.
def deprecated_func(*args, **kw): warnings.warn("Call to deprecated item. %s" % msg, wxPyDeprecationWarning, stacklevel=2) return item(*args, **kw)
def SetId(
*args, **kwargs)
SetId(self, int winid)
Sets the identifier of the window. Each window has an integer identifier. If the application has not provided one, an identifier will be generated. Normally, the identifier should be provided on creation and should not be modified subsequently.
def SetId(*args, **kwargs): """ SetId(self, int winid) Sets the identifier of the window. Each window has an integer identifier. If the application has not provided one, an identifier will be generated. Normally, the identifier should be provided on creation and should not be modified subsequently. """ return _core_.Window_SetId(*args, **kwargs)
def SetInitialSize(
*args, **kwargs)
SetInitialSize(self, Size size=DefaultSize)
A 'Smart' SetSize that will fill in default size components with the window's best size values. Also set's the minsize for use with sizers.
def SetInitialSize(*args, **kwargs): """ SetInitialSize(self, Size size=DefaultSize) A 'Smart' SetSize that will fill in default size components with the window's *best size* values. Also set's the minsize for use with sizers. """ return _core_.Window_SetInitialSize(*args, **kwargs)
def SetLabel(
*args, **kwargs)
SetLabel(self, String label)
Set the text which the window shows in its label if applicable.
def SetLabel(*args, **kwargs): """ SetLabel(self, String label) Set the text which the window shows in its label if applicable. """ return _core_.Window_SetLabel(*args, **kwargs)
def SetLayoutDirection(
*args, **kwargs)
SetLayoutDirection(self, int dir)
Set the layout direction (LTR or RTL) for this window.
def SetLayoutDirection(*args, **kwargs): """ SetLayoutDirection(self, int dir) Set the layout direction (LTR or RTL) for this window. """ return _core_.Window_SetLayoutDirection(*args, **kwargs)
def SetMaxClientSize(
*args, **kwargs)
SetMaxClientSize(self, Size size)
def SetMaxClientSize(*args, **kwargs): """SetMaxClientSize(self, Size size)""" return _core_.Window_SetMaxClientSize(*args, **kwargs)
def SetMaxSize(
*args, **kwargs)
SetMaxSize(self, Size maxSize)
A more convenient method than SetSizeHints for setting just the
max size.
def SetMaxSize(*args, **kwargs): """ SetMaxSize(self, Size maxSize) A more convenient method than `SetSizeHints` for setting just the max size. """ return _core_.Window_SetMaxSize(*args, **kwargs)
def SetMinClientSize(
*args, **kwargs)
SetMinClientSize(self, Size size)
def SetMinClientSize(*args, **kwargs): """SetMinClientSize(self, Size size)""" return _core_.Window_SetMinClientSize(*args, **kwargs)
def SetMinSize(
*args, **kwargs)
SetMinSize(self, Size minSize)
A more convenient method than SetSizeHints for setting just the
min size.
def SetMinSize(*args, **kwargs): """ SetMinSize(self, Size minSize) A more convenient method than `SetSizeHints` for setting just the min size. """ return _core_.Window_SetMinSize(*args, **kwargs)
def SetName(
*args, **kwargs)
SetName(self, String name)
Sets the window's name. The window name is used for ressource setting in X, it is not the same as the window title/label
def SetName(*args, **kwargs): """ SetName(self, String name) Sets the window's name. The window name is used for ressource setting in X, it is not the same as the window title/label """ return _core_.Window_SetName(*args, **kwargs)
def SetNextHandler(
*args, **kwargs)
SetNextHandler(self, EvtHandler handler)
def SetNextHandler(*args, **kwargs): """SetNextHandler(self, EvtHandler handler)""" return _core_.EvtHandler_SetNextHandler(*args, **kwargs)
def SetOwnBackgroundColour(
*args, **kwargs)
SetOwnBackgroundColour(self, Colour colour)
def SetOwnBackgroundColour(*args, **kwargs): """SetOwnBackgroundColour(self, Colour colour)""" return _core_.Window_SetOwnBackgroundColour(*args, **kwargs)
def SetOwnFont(
*args, **kwargs)
SetOwnFont(self, Font font)
def SetOwnFont(*args, **kwargs): """SetOwnFont(self, Font font)""" return _core_.Window_SetOwnFont(*args, **kwargs)
def SetOwnForegroundColour(
*args, **kwargs)
SetOwnForegroundColour(self, Colour colour)
def SetOwnForegroundColour(*args, **kwargs): """SetOwnForegroundColour(self, Colour colour)""" return _core_.Window_SetOwnForegroundColour(*args, **kwargs)
def SetPosition(
*args, **kwargs)
Move(self, Point pt, int flags=SIZE_USE_EXISTING)
Moves the window to the given position.
def Move(*args, **kwargs): """ Move(self, Point pt, int flags=SIZE_USE_EXISTING) Moves the window to the given position. """ return _core_.Window_Move(*args, **kwargs)
def SetPreviousHandler(
*args, **kwargs)
SetPreviousHandler(self, EvtHandler handler)
def SetPreviousHandler(*args, **kwargs): """SetPreviousHandler(self, EvtHandler handler)""" return _core_.EvtHandler_SetPreviousHandler(*args, **kwargs)
def SetRect(
*args, **kwargs)
SetRect(self, Rect rect, int sizeFlags=SIZE_AUTO)
Sets the position and size of the window in pixels using a wx.Rect.
def SetRect(*args, **kwargs): """ SetRect(self, Rect rect, int sizeFlags=SIZE_AUTO) Sets the position and size of the window in pixels using a wx.Rect. """ return _core_.Window_SetRect(*args, **kwargs)
def SetScrollPos(
*args, **kwargs)
SetScrollPos(self, int orientation, int pos, bool refresh=True)
Sets the position of one of the built-in scrollbars.
def SetScrollPos(*args, **kwargs): """ SetScrollPos(self, int orientation, int pos, bool refresh=True) Sets the position of one of the built-in scrollbars. """ return _core_.Window_SetScrollPos(*args, **kwargs)
def SetScrollbar(
*args, **kwargs)
SetScrollbar(self, int orientation, int position, int thumbSize, int range, bool refresh=True)
Sets the scrollbar properties of a built-in scrollbar.
def SetScrollbar(*args, **kwargs): """ SetScrollbar(self, int orientation, int position, int thumbSize, int range, bool refresh=True) Sets the scrollbar properties of a built-in scrollbar. """ return _core_.Window_SetScrollbar(*args, **kwargs)
def SetSize(
*args, **kwargs)
SetSize(self, Size size)
Sets the size of the window in pixels.
def SetSize(*args, **kwargs): """ SetSize(self, Size size) Sets the size of the window in pixels. """ return _core_.Window_SetSize(*args, **kwargs)
def SetSizeHints(
*args, **kwargs)
SetSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1, int incW=-1, int incH=-1)
Allows specification of minimum and maximum window sizes, and window size increments. If a pair of values is not set (or set to -1), the default values will be used. If this function is called, the user will not be able to size the window outside the given bounds (if it is a top-level window.) Sizers will also inspect the minimum window size and will use that value if set when calculating layout.
The resizing increments are only significant under Motif or Xt.
def SetSizeHints(*args, **kwargs): """ SetSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1, int incW=-1, int incH=-1) Allows specification of minimum and maximum window sizes, and window size increments. If a pair of values is not set (or set to -1), the default values will be used. If this function is called, the user will not be able to size the window outside the given bounds (if it is a top-level window.) Sizers will also inspect the minimum window size and will use that value if set when calculating layout. The resizing increments are only significant under Motif or Xt. """ return _core_.Window_SetSizeHints(*args, **kwargs)
def SetSizeHintsSz(
*args, **kwargs)
SetSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize, Size incSize=DefaultSize)
Allows specification of minimum and maximum window sizes, and window size increments. If a pair of values is not set (or set to -1), the default values will be used. If this function is called, the user will not be able to size the window outside the given bounds (if it is a top-level window.) Sizers will also inspect the minimum window size and will use that value if set when calculating layout.
The resizing increments are only significant under Motif or Xt.
def SetSizeHintsSz(*args, **kwargs): """ SetSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize, Size incSize=DefaultSize) Allows specification of minimum and maximum window sizes, and window size increments. If a pair of values is not set (or set to -1), the default values will be used. If this function is called, the user will not be able to size the window outside the given bounds (if it is a top-level window.) Sizers will also inspect the minimum window size and will use that value if set when calculating layout. The resizing increments are only significant under Motif or Xt. """ return _core_.Window_SetSizeHintsSz(*args, **kwargs)
def SetSizeWH(
*args, **kwargs)
SetSizeWH(self, int width, int height)
Sets the size of the window in pixels.
def SetSizeWH(*args, **kwargs): """ SetSizeWH(self, int width, int height) Sets the size of the window in pixels. """ return _core_.Window_SetSizeWH(*args, **kwargs)
def SetSizer(
*args, **kwargs)
SetSizer(self, Sizer sizer, bool deleteOld=True)
Sets the window to have the given layout sizer. The window will then own the object, and will take care of its deletion. If an existing layout sizer object is already owned by the window, it will be deleted if the deleteOld parameter is true. Note that this function will also call SetAutoLayout implicitly with a True parameter if the sizer is non-None, and False otherwise.
def SetSizer(*args, **kwargs): """ SetSizer(self, Sizer sizer, bool deleteOld=True) Sets the window to have the given layout sizer. The window will then own the object, and will take care of its deletion. If an existing layout sizer object is already owned by the window, it will be deleted if the deleteOld parameter is true. Note that this function will also call SetAutoLayout implicitly with a True parameter if the sizer is non-None, and False otherwise. """ return _core_.Window_SetSizer(*args, **kwargs)
def SetSizerAndFit(
*args, **kwargs)
SetSizerAndFit(self, Sizer sizer, bool deleteOld=True)
The same as SetSizer, except it also sets the size hints for the window based on the sizer's minimum size.
def SetSizerAndFit(*args, **kwargs): """ SetSizerAndFit(self, Sizer sizer, bool deleteOld=True) The same as SetSizer, except it also sets the size hints for the window based on the sizer's minimum size. """ return _core_.Window_SetSizerAndFit(*args, **kwargs)
def SetThemeEnabled(
*args, **kwargs)
SetThemeEnabled(self, bool enableTheme)
This function tells a window if it should use the system's "theme" code to draw the windows' background instead if its own background drawing code. This will only have an effect on platforms that support the notion of themes in user defined windows. One such platform is GTK+ where windows can have (very colourful) backgrounds defined by a user's selected theme.
Dialogs, notebook pages and the status bar have this flag set to true by default so that the default look and feel is simulated best.
def SetThemeEnabled(*args, **kwargs): """ SetThemeEnabled(self, bool enableTheme) This function tells a window if it should use the system's "theme" code to draw the windows' background instead if its own background drawing code. This will only have an effect on platforms that support the notion of themes in user defined windows. One such platform is GTK+ where windows can have (very colourful) backgrounds defined by a user's selected theme. Dialogs, notebook pages and the status bar have this flag set to true by default so that the default look and feel is simulated best. """ return _core_.Window_SetThemeEnabled(*args, **kwargs)
def SetToolTip(
*args, **kwargs)
SetToolTip(self, ToolTip tip)
Attach a tooltip to the window.
def SetToolTip(*args, **kwargs): """ SetToolTip(self, ToolTip tip) Attach a tooltip to the window. """ return _core_.Window_SetToolTip(*args, **kwargs)
def SetToolTipString(
*args, **kwargs)
SetToolTipString(self, String tip)
Attach a tooltip to the window.
def SetToolTipString(*args, **kwargs): """ SetToolTipString(self, String tip) Attach a tooltip to the window. """ return _core_.Window_SetToolTipString(*args, **kwargs)
def SetTransparent(
*args, **kwargs)
SetTransparent(self, byte alpha) -> bool
Attempt to set the transparency of this window to the alpha value,
returns True on success. The alpha value is an integer in the
range of 0 to 255, where 0 is fully transparent and 255 is fully
opaque.
def SetTransparent(*args, **kwargs): """ SetTransparent(self, byte alpha) -> bool Attempt to set the transparency of this window to the ``alpha`` value, returns True on success. The ``alpha`` value is an integer in the range of 0 to 255, where 0 is fully transparent and 255 is fully opaque. """ return _core_.Window_SetTransparent(*args, **kwargs)
def SetValidator(
*args, **kwargs)
SetValidator(self, Validator validator)
Deletes the current validator (if any) and sets the window validator, having called wx.Validator.Clone to create a new validator of this type.
def SetValidator(*args, **kwargs): """ SetValidator(self, Validator validator) Deletes the current validator (if any) and sets the window validator, having called wx.Validator.Clone to create a new validator of this type. """ return _core_.Window_SetValidator(*args, **kwargs)
def SetVirtualSize(
*args, **kwargs)
SetVirtualSize(self, Size size)
Set the the virtual size of a window in pixels. For most windows this is just the client area of the window, but for some like scrolled windows it is more or less independent of the screen window size.
def SetVirtualSize(*args, **kwargs): """ SetVirtualSize(self, Size size) Set the the virtual size of a window in pixels. For most windows this is just the client area of the window, but for some like scrolled windows it is more or less independent of the screen window size. """ return _core_.Window_SetVirtualSize(*args, **kwargs)
def SetVirtualSizeHints(
*args, **kw)
SetVirtualSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1)
def deprecated_func(*args, **kw): warnings.warn("Call to deprecated item. %s" % msg, wxPyDeprecationWarning, stacklevel=2) return item(*args, **kw)
def SetVirtualSizeHintsSz(
*args, **kw)
SetVirtualSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize)
def deprecated_func(*args, **kw): warnings.warn("Call to deprecated item. %s" % msg, wxPyDeprecationWarning, stacklevel=2) return item(*args, **kw)
def SetVirtualSizeWH(
*args, **kwargs)
SetVirtualSizeWH(self, int w, int h)
Set the the virtual size of a window in pixels. For most windows this is just the client area of the window, but for some like scrolled windows it is more or less independent of the screen window size.
def SetVirtualSizeWH(*args, **kwargs): """ SetVirtualSizeWH(self, int w, int h) Set the the virtual size of a window in pixels. For most windows this is just the client area of the window, but for some like scrolled windows it is more or less independent of the screen window size. """ return _core_.Window_SetVirtualSizeWH(*args, **kwargs)
def SetWindowStyle(
*args, **kwargs)
SetWindowStyleFlag(self, long style)
Sets the style of the window. Please note that some styles cannot be changed after the window creation and that Refresh() might need to be called after changing the others for the change to take place immediately.
def SetWindowStyleFlag(*args, **kwargs): """ SetWindowStyleFlag(self, long style) Sets the style of the window. Please note that some styles cannot be changed after the window creation and that Refresh() might need to be called after changing the others for the change to take place immediately. """ return _core_.Window_SetWindowStyleFlag(*args, **kwargs)
def SetWindowStyleFlag(
*args, **kwargs)
SetWindowStyleFlag(self, long style)
Sets the style of the window. Please note that some styles cannot be changed after the window creation and that Refresh() might need to be called after changing the others for the change to take place immediately.
def SetWindowStyleFlag(*args, **kwargs): """ SetWindowStyleFlag(self, long style) Sets the style of the window. Please note that some styles cannot be changed after the window creation and that Refresh() might need to be called after changing the others for the change to take place immediately. """ return _core_.Window_SetWindowStyleFlag(*args, **kwargs)
def SetWindowVariant(
*args, **kwargs)
SetWindowVariant(self, int variant)
Sets the variant of the window/font size to use for this window, if the platform supports variants, for example, wxMac.
def SetWindowVariant(*args, **kwargs): """ SetWindowVariant(self, int variant) Sets the variant of the window/font size to use for this window, if the platform supports variants, for example, wxMac. """ return _core_.Window_SetWindowVariant(*args, **kwargs)
def ShouldInheritColours(
*args, **kwargs)
ShouldInheritColours(self) -> bool
Return true from here to allow the colours of this window to be changed by InheritAttributes, returning false forbids inheriting them from the parent window.
The base class version returns false, but this method is overridden in wxControl where it returns true.
def ShouldInheritColours(*args, **kwargs): """ ShouldInheritColours(self) -> bool Return true from here to allow the colours of this window to be changed by InheritAttributes, returning false forbids inheriting them from the parent window. The base class version returns false, but this method is overridden in wxControl where it returns true. """ return _core_.Window_ShouldInheritColours(*args, **kwargs)
def Show(
*args, **kwargs)
Show(self, bool show=True) -> bool
Shows or hides the window. You may need to call Raise for a top level window if you want to bring it to top, although this is not needed if Show is called immediately after the frame creation. Returns True if the window has been shown or hidden or False if nothing was done because it already was in the requested state.
def Show(*args, **kwargs): """ Show(self, bool show=True) -> bool Shows or hides the window. You may need to call Raise for a top level window if you want to bring it to top, although this is not needed if Show is called immediately after the frame creation. Returns True if the window has been shown or hidden or False if nothing was done because it already was in the requested state. """ return _core_.Window_Show(*args, **kwargs)
def ShowWithEffect(
*args, **kwargs)
ShowWithEffect(self, int effect, unsigned int timeout=0) -> bool
Show the window with a special effect, not implemented on most platforms (where it is the same as Show())
Timeout specifies how long the animation should take, in ms, the default value of 0 means to use the default (system-dependent) value.
def ShowWithEffect(*args, **kwargs): """ ShowWithEffect(self, int effect, unsigned int timeout=0) -> bool Show the window with a special effect, not implemented on most platforms (where it is the same as Show()) Timeout specifies how long the animation should take, in ms, the default value of 0 means to use the default (system-dependent) value. """ return _core_.Window_ShowWithEffect(*args, **kwargs)
def Thaw(
*args, **kwargs)
Thaw(self)
Reenables window updating after a previous call to Freeze. Calls to Freeze/Thaw may be nested, so Thaw must be called the same number of times that Freeze was before the window will be updated.
def Thaw(*args, **kwargs): """ Thaw(self) Reenables window updating after a previous call to Freeze. Calls to Freeze/Thaw may be nested, so Thaw must be called the same number of times that Freeze was before the window will be updated. """ return _core_.Window_Thaw(*args, **kwargs)
def ToggleWindowStyle(
*args, **kwargs)
ToggleWindowStyle(self, int flag) -> bool
Turn the flag on if it had been turned off before and vice versa, returns True if the flag is turned on by this function call.
def ToggleWindowStyle(*args, **kwargs): """ ToggleWindowStyle(self, int flag) -> bool Turn the flag on if it had been turned off before and vice versa, returns True if the flag is turned on by this function call. """ return _core_.Window_ToggleWindowStyle(*args, **kwargs)
def TransferDataFromWindow(
*args, **kwargs)
TransferDataFromWindow(self) -> bool
Transfers values from child controls to data areas specified by their validators. Returns false if a transfer failed. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will also call TransferDataFromWindow() of all child windows.
def TransferDataFromWindow(*args, **kwargs): """ TransferDataFromWindow(self) -> bool Transfers values from child controls to data areas specified by their validators. Returns false if a transfer failed. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will also call TransferDataFromWindow() of all child windows. """ return _core_.Window_TransferDataFromWindow(*args, **kwargs)
def TransferDataToWindow(
*args, **kwargs)
TransferDataToWindow(self) -> bool
Transfers values to child controls from data areas specified by their validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will also call TransferDataToWindow() of all child windows.
def TransferDataToWindow(*args, **kwargs): """ TransferDataToWindow(self) -> bool Transfers values to child controls from data areas specified by their validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will also call TransferDataToWindow() of all child windows. """ return _core_.Window_TransferDataToWindow(*args, **kwargs)
def Unbind(
self, event, source=None, id=-1, id2=-1, handler=None)
Disconnects the event handler binding for event from self. Returns True if successful.
def Unbind(self, event, source=None, id=wx.ID_ANY, id2=wx.ID_ANY, handler=None): """ Disconnects the event handler binding for event from self. Returns True if successful. """ if source is not None: id = source.GetId() return event.Unbind(self, id, id2, handler)
def Unlink(
*args, **kwargs)
Unlink(self)
def Unlink(*args, **kwargs): """Unlink(self)""" return _core_.EvtHandler_Unlink(*args, **kwargs)
def UnregisterHotKey(
*args, **kwargs)
UnregisterHotKey(self, int hotkeyId) -> bool
Unregisters a system wide hotkey.
def UnregisterHotKey(*args, **kwargs): """ UnregisterHotKey(self, int hotkeyId) -> bool Unregisters a system wide hotkey. """ return _core_.Window_UnregisterHotKey(*args, **kwargs)
def UnsetToolTip(
*args, **kwargs)
UnsetToolTip(self)
def UnsetToolTip(*args, **kwargs): """UnsetToolTip(self)""" return _core_.Window_UnsetToolTip(*args, **kwargs)
def Update(
*args, **kwargs)
Update(self)
Calling this method immediately repaints the invalidated area of the
window instead of waiting for the EVT_PAINT event to happen, (normally
this would usually only happen when the flow of control returns to the
event loop.) Notice that this function doesn't refresh the window and
does nothing if the window has been already repainted. Use Refresh
first if you want to immediately redraw the window (or some portion of
it) unconditionally.
def Update(*args, **kwargs): """ Update(self) Calling this method immediately repaints the invalidated area of the window instead of waiting for the EVT_PAINT event to happen, (normally this would usually only happen when the flow of control returns to the event loop.) Notice that this function doesn't refresh the window and does nothing if the window has been already repainted. Use `Refresh` first if you want to immediately redraw the window (or some portion of it) unconditionally. """ return _core_.Window_Update(*args, **kwargs)
def UpdateWindowUI(
*args, **kwargs)
UpdateWindowUI(self, long flags=UPDATE_UI_NONE)
This function sends EVT_UPDATE_UI events to the window. The particular
implementation depends on the window; for example a wx.ToolBar will
send an update UI event for each toolbar button, and a wx.Frame will
send an update UI event for each menubar menu item. You can call this
function from your application to ensure that your UI is up-to-date at
a particular point in time (as far as your EVT_UPDATE_UI handlers are
concerned). This may be necessary if you have called
wx.UpdateUIEvent.SetMode or wx.UpdateUIEvent.SetUpdateInterval to
limit the overhead that wxWindows incurs by sending update UI events
in idle time.
def UpdateWindowUI(*args, **kwargs): """ UpdateWindowUI(self, long flags=UPDATE_UI_NONE) This function sends EVT_UPDATE_UI events to the window. The particular implementation depends on the window; for example a wx.ToolBar will send an update UI event for each toolbar button, and a wx.Frame will send an update UI event for each menubar menu item. You can call this function from your application to ensure that your UI is up-to-date at a particular point in time (as far as your EVT_UPDATE_UI handlers are concerned). This may be necessary if you have called `wx.UpdateUIEvent.SetMode` or `wx.UpdateUIEvent.SetUpdateInterval` to limit the overhead that wxWindows incurs by sending update UI events in idle time. """ return _core_.Window_UpdateWindowUI(*args, **kwargs)
def UseBgCol(
*args, **kwargs)
UseBgCol(self) -> bool
def UseBgCol(*args, **kwargs): """UseBgCol(self) -> bool""" return _core_.Window_UseBgCol(*args, **kwargs)
def Validate(
*args, **kwargs)
Validate(self) -> bool
Validates the current values of the child controls using their validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will also call Validate() of all child windows. Returns false if any of the validations failed.
def Validate(*args, **kwargs): """ Validate(self) -> bool Validates the current values of the child controls using their validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will also call Validate() of all child windows. Returns false if any of the validations failed. """ return _core_.Window_Validate(*args, **kwargs)
def WarpPointer(
*args, **kwargs)
WarpPointer(self, int x, int y)
Moves the pointer to the given position on the window.
NOTE: This function is not supported under Mac because Apple Human Interface Guidelines forbid moving the mouse cursor programmatically.
def WarpPointer(*args, **kwargs): """ WarpPointer(self, int x, int y) Moves the pointer to the given position on the window. NOTE: This function is not supported under Mac because Apple Human Interface Guidelines forbid moving the mouse cursor programmatically. """ return _core_.Window_WarpPointer(*args, **kwargs)
def WindowToClientSize(
*args, **kwargs)
WindowToClientSize(self, Size size) -> Size
Converts window size size to corresponding client area size. In
other words, the returned value is what GetClientSize would return
if this window had given window size. Components with
wxDefaultCoord (-1) value are left unchanged.
Note that the conversion is not always exact, it assumes that non-client area doesn't change and so doesn't take into account things like menu bar (un)wrapping or (dis)appearance of the scrollbars.
def WindowToClientSize(*args, **kwargs): """ WindowToClientSize(self, Size size) -> Size Converts window size ``size`` to corresponding client area size. In other words, the returned value is what `GetClientSize` would return if this window had given window size. Components with ``wxDefaultCoord`` (-1) value are left unchanged. Note that the conversion is not always exact, it assumes that non-client area doesn't change and so doesn't take into account things like menu bar (un)wrapping or (dis)appearance of the scrollbars. """ return _core_.Window_WindowToClientSize(*args, **kwargs)
class XMLSTC
This is a modified StyledTextCtrl for xml. It has weirdness because it was adpated from a Python STC in wx examples.
class XMLSTC(stc.StyledTextCtrl): """ This is a modified StyledTextCtrl for xml. It has weirdness because it was adpated from a Python STC in wx examples.""" fold_symbols = 2 def __init__(self, parent, id, pos=wx.DefaultPosition, size=wx.DefaultSize, style=0,name=None): stc.StyledTextCtrl.__init__(self, parent, id, pos, size, style,name) self.CmdKeyAssign(ord('B'), stc.STC_SCMOD_CTRL, stc.STC_CMD_ZOOMIN) self.CmdKeyAssign(ord('N'), stc.STC_SCMOD_CTRL, stc.STC_CMD_ZOOMOUT) self.SetLexer(stc.STC_LEX_XML) #self.SetKeyWords(0, " ".join(keyword.kwlist)) self.SetProperty("fold", "1") self.SetProperty("tab.timmy.whinge.level", "1") self.SetMargins(0,0) #self.SetViewWhiteSpace(False) #self.SetBufferedDraw(False) #self.SetViewEOL(True) #self.SetEOLMode(stc.STC_EOL_CRLF) #self.SetUseAntiAliasing(True) self.SetEdgeMode(stc.STC_EDGE_BACKGROUND) self.SetEdgeColumn(78) # Setup a margin to hold fold markers self.SetFoldFlags(16) ### WHAT IS THIS VALUE? WHAT ARE THE OTHER FLAGS? DOES IT MATTER? self.SetMarginType(2, stc.STC_MARGIN_SYMBOL) self.SetMarginMask(2, stc.STC_MASK_FOLDERS) self.SetMarginSensitive(2, True) self.SetMarginWidth(2, 12) if self.fold_symbols == 0: # Arrow pointing right for contracted folders, arrow pointing down for expanded self.MarkerDefine(stc.STC_MARKNUM_FOLDEROPEN, stc.STC_MARK_ARROWDOWN, "black", "black") self.MarkerDefine(stc.STC_MARKNUM_FOLDER, stc.STC_MARK_ARROW, "black", "black") self.MarkerDefine(stc.STC_MARKNUM_FOLDERSUB, stc.STC_MARK_EMPTY, "black", "black") self.MarkerDefine(stc.STC_MARKNUM_FOLDERTAIL, stc.STC_MARK_EMPTY, "black", "black") self.MarkerDefine(stc.STC_MARKNUM_FOLDEREND, stc.STC_MARK_EMPTY, "white", "black") self.MarkerDefine(stc.STC_MARKNUM_FOLDEROPENMID, stc.STC_MARK_EMPTY, "white", "black") self.MarkerDefine(stc.STC_MARKNUM_FOLDERMIDTAIL, stc.STC_MARK_EMPTY, "white", "black") elif self.fold_symbols == 1: # Plus for contracted folders, minus for expanded self.MarkerDefine(stc.STC_MARKNUM_FOLDEROPEN, stc.STC_MARK_MINUS, "white", "black") self.MarkerDefine(stc.STC_MARKNUM_FOLDER, stc.STC_MARK_PLUS, "white", "black") self.MarkerDefine(stc.STC_MARKNUM_FOLDERSUB, stc.STC_MARK_EMPTY, "white", "black") self.MarkerDefine(stc.STC_MARKNUM_FOLDERTAIL, stc.STC_MARK_EMPTY, "white", "black") self.MarkerDefine(stc.STC_MARKNUM_FOLDEREND, stc.STC_MARK_EMPTY, "white", "black") self.MarkerDefine(stc.STC_MARKNUM_FOLDEROPENMID, stc.STC_MARK_EMPTY, "white", "black") self.MarkerDefine(stc.STC_MARKNUM_FOLDERMIDTAIL, stc.STC_MARK_EMPTY, "white", "black") elif self.fold_symbols == 2: # Like a flattened tree control using circular headers and curved joins self.MarkerDefine(stc.STC_MARKNUM_FOLDEROPEN, stc.STC_MARK_CIRCLEMINUS, "white", "#404040") self.MarkerDefine(stc.STC_MARKNUM_FOLDER, stc.STC_MARK_CIRCLEPLUS, "white", "#404040") self.MarkerDefine(stc.STC_MARKNUM_FOLDERSUB, stc.STC_MARK_VLINE, "white", "#404040") self.MarkerDefine(stc.STC_MARKNUM_FOLDERTAIL, stc.STC_MARK_LCORNERCURVE, "white", "#404040") self.MarkerDefine(stc.STC_MARKNUM_FOLDEREND, stc.STC_MARK_CIRCLEPLUSCONNECTED, "white", "#404040") self.MarkerDefine(stc.STC_MARKNUM_FOLDEROPENMID, stc.STC_MARK_CIRCLEMINUSCONNECTED, "white", "#404040") self.MarkerDefine(stc.STC_MARKNUM_FOLDERMIDTAIL, stc.STC_MARK_TCORNERCURVE, "white", "#404040") elif self.fold_symbols == 3: # Like a flattened tree control using square headers self.MarkerDefine(stc.STC_MARKNUM_FOLDEROPEN, stc.STC_MARK_BOXMINUS, "white", "#808080") self.MarkerDefine(stc.STC_MARKNUM_FOLDER, stc.STC_MARK_BOXPLUS, "white", "#808080") self.MarkerDefine(stc.STC_MARKNUM_FOLDERSUB, stc.STC_MARK_VLINE, "white", "#808080") self.MarkerDefine(stc.STC_MARKNUM_FOLDERTAIL, stc.STC_MARK_LCORNER, "white", "#808080") self.MarkerDefine(stc.STC_MARKNUM_FOLDEREND, stc.STC_MARK_BOXPLUSCONNECTED, "white", "#808080") self.MarkerDefine(stc.STC_MARKNUM_FOLDEROPENMID, stc.STC_MARK_BOXMINUSCONNECTED, "white", "#808080") self.MarkerDefine(stc.STC_MARKNUM_FOLDERMIDTAIL, stc.STC_MARK_TCORNER, "white", "#808080") self.Bind(stc.EVT_STC_UPDATEUI, self.OnUpdateUI) self.Bind(stc.EVT_STC_MARGINCLICK, self.OnMarginClick) self.Bind(wx.EVT_KEY_DOWN, self.OnKeyPressed) # Make some styles, The lexer defines what each style is used for, we # just have to define what each style looks like. This set is adapted from # Scintilla sample property files. # Global default styles for all languages self.StyleSetSpec(stc.STC_STYLE_DEFAULT, "face:%(helv)s,size:%(size)d" % faces) self.StyleClearAll() # Reset all to be like the default # Global default styles for all languages self.StyleSetSpec(stc.STC_STYLE_DEFAULT, "face:%(helv)s,size:%(size)d" % faces) self.StyleSetSpec(stc.STC_STYLE_LINENUMBER, "back:#C0C0C0,face:%(helv)s,size:%(size2)d" % faces) self.StyleSetSpec(stc.STC_STYLE_CONTROLCHAR, "face:%(other)s" % faces) #self.StyleSetSpec(stc.STC_STYLE_BRACELIGHT, "fore:#FFFFFF,back:#0000FF,bold") #self.StyleSetSpec(stc.STC_STYLE_BRACEBAD, "fore:#000000,back:#FF0000,bold") #styleidnames={wx.stc.STC_H_DEFAULT: 'Default', wx.stc.STC_H_TAG: 'Tag', wx.stc.STC_H_TAGUNKNOWN: 'Tag unknown', wx.stc.STC_H_ATTRIBUTE: 'Attribute', wx.stc.STC_H_NUMBER: 'Number', wx.stc.STC_H_DOUBLESTRING: 'Double quoted string', wx.stc.STC_H_SINGLESTRING:'Single quoted string', wx.stc.STC_H_OTHER: 'Other inside tag', wx.stc.STC_H_COMMENT: 'Comment', wx.stc.STC_H_ENTITY: 'Entity', wx.stc.STC_H_TAGEND: 'Tag end', wx.stc.STC_H_XMLSTART: 'XML start', wx.stc.STC_H_XMLEND: 'XML End'} ##TOD:This is the section I have to define the styles for in order to work # styles=['STC_H_ASP', 'STC_H_ASPAT', 'STC_H_ATTRIBUTE', 'STC_H_ATTRIBUTEUNKNOWN', # 'STC_H_CDATA', 'STC_H_COMMENT', 'STC_H_DEFAULT', 'STC_H_DOUBLESTRING', 'STC_H_ENTITY', # 'STC_H_NUMBER', 'STC_H_OTHER', 'STC_H_QUESTION', 'STC_H_SCRIPT', 'STC_H_SGML_1ST_PARAM', # 'STC_H_SGML_1ST_PARAM_COMMENT', 'STC_H_SGML_BLOCK_DEFAULT', 'STC_H_SGML_COMMAND', #'STC_H_SGML_COMMENT', 'STC_H_SGML_DEFAULT', 'STC_H_SGML_DOUBLESTRING', 'STC_H_SGML_ENTITY', #'STC_H_SGML_ERROR', 'STC_H_SGML_SIMPLESTRING', 'STC_H_SGML_SPECIAL', #'STC_H_SINGLESTRING', 'STC_H_TAG', 'STC_H_TAGEND', 'STC_H_TAGUNKNOWN', #'STC_H_VALUE', 'STC_H_XCCOMMENT', 'STC_H_XMLEND', 'STC_H_XMLSTART'] # XML styles, just taken from the above python sample # XML styles Mostly HTML styles # Default self.StyleSetSpec(stc.STC_H_DEFAULT, "fore:#000000,face:%(helv)s,size:%(size)d" % faces) # Comments self.StyleSetSpec(stc.STC_H_XCCOMMENT, "fore:#007F00,face:%(other)s,size:%(size)d" % faces) # Number self.StyleSetSpec(stc.STC_H_NUMBER, "fore:#007F7F,size:%(size)d" % faces) # String self.StyleSetSpec(stc.STC_H_ATTRIBUTE, "fore:#7F007F,face:%(helv)s,size:%(size)d" % faces) # Single quoted string self.StyleSetSpec(stc.STC_H_QUESTION, "fore:#7F007F,face:%(helv)s,size:%(size)d" % faces) # Keyword self.StyleSetSpec(stc.STC_H_ATTRIBUTEUNKNOWN, "fore:#00007F,bold,size:%(size)d" % faces) # Single quotes self.StyleSetSpec(stc.STC_H_SINGLESTRING, "fore:#7F0000,size:%(size)d" % faces) # double quotes self.StyleSetSpec(stc.STC_H_DOUBLESTRING, "fore:#7F0000,size:%(size)d" % faces) # Tag name definition self.StyleSetSpec(stc.STC_H_TAG, "fore:#0000FF,bold,size:%(size)d" % faces) # UnknownTag definition self.StyleSetSpec(stc.STC_H_TAGUNKNOWN, "fore:#007F7F,bold,size:%(size)d" % faces) # Operators self.StyleSetSpec(stc.STC_H_XMLSTART, "bold,size:%(size)d" % faces) # Identifiers self.StyleSetSpec(stc.STC_H_CDATA, "fore:#000000,face:%(helv)s,size:%(size)d" % faces) # Comment-blocks self.StyleSetSpec(stc.STC_H_COMMENT, "fore:#7F007F,underline,size:%(size)d" % faces) # End of line where string is not closed #self.StyleSetSpec(stc.STC_H_XMLEND, "fore:#000000,face:%(mono)s,size:%(size)d" % faces) self.SetCaretForeground("BLUE") self.SetCaretForeground("BLUE") # register some images for use in the AutoComplete box. self.RegisterImage(1, wx.ArtProvider.GetBitmap(wx.ART_NEW, size=(16,16))) self.RegisterImage(2, wx.ArtProvider.GetBitmap(wx.ART_NEW, size=(16,16))) self.RegisterImage(3, wx.ArtProvider.GetBitmap(wx.ART_COPY, size=(16,16))) def OnKeyPressed(self, event): if self.CallTipActive(): self.CallTipCancel() key = event.GetKeyCode() if key == 32 and event.ControlDown(): pos = self.GetCurrentPos() # Tips if event.ShiftDown(): self.CallTipSetBackground("yellow") self.CallTipShow(pos, 'lots of of text: blah, blah, blah\n\n' 'show some suff, maybe parameters..\n\n' 'fubar(param1, param2)') # Code completion else: #lst = [] #for x in range(50000): # lst.append('%05d' % x) #st = " ".join(lst) #print len(st) #self.AutoCompShow(0, st) kw = keyword.kwlist[:] kw.append("zzzzzz?2") kw.append("aaaaa?2") kw.append("__init__?3") kw.append("zzaaaaa?2") kw.append("zzbaaaa?2") kw.append("this_is_a_longer_value") #kw.append("this_is_a_much_much_much_much_much_much_much_longer_value") kw.sort() # Python sorts are case sensitive self.AutoCompSetIgnoreCase(False) # so this needs to match # Images are specified with a appended "?type" for i in range(len(kw)): if kw[i] in keyword.kwlist: kw[i] = kw[i] + "?1" self.AutoCompShow(0, " ".join(kw)) else: event.Skip() def OnUpdateUI(self, evt): # check for matching braces braceAtCaret = -1 braceOpposite = -1 charBefore = None caretPos = self.GetCurrentPos() if caretPos > 0: charBefore = self.GetCharAt(caretPos - 1) styleBefore = self.GetStyleAt(caretPos - 1) # check before if charBefore and chr(charBefore) in "[]{}()<>" and styleBefore == stc.STC_H_XMLSTART: braceAtCaret = caretPos - 1 # check after if braceAtCaret < 0: charAfter = self.GetCharAt(caretPos) styleAfter = self.GetStyleAt(caretPos) if charAfter and chr(charAfter) in "[]{}()<>" and styleAfter == stc.STC_H_XMLEND: braceAtCaret = caretPos if braceAtCaret >= 0: braceOpposite = self.BraceMatch(braceAtCaret) if braceAtCaret != -1 and braceOpposite == -1: self.BraceBadLight(braceAtCaret) else: self.BraceHighlight(braceAtCaret, braceOpposite) #pt = self.PointFromPosition(braceOpposite) #self.Refresh(True, wxRect(pt.x, pt.y, 5,5)) #print pt #self.Refresh(False) def OnMarginClick(self, evt): # fold and unfold as needed if evt.GetMargin() == 2: if evt.GetShift() and evt.GetControl(): self.FoldAll() else: lineClicked = self.LineFromPosition(evt.GetPosition()) if self.GetFoldLevel(lineClicked) & stc.STC_FOLDLEVELHEADERFLAG: if evt.GetShift(): self.SetFoldExpanded(lineClicked, True) self.Expand(lineClicked, True, True, 1) elif evt.GetControl(): if self.GetFoldExpanded(lineClicked): self.SetFoldExpanded(lineClicked, False) self.Expand(lineClicked, False, True, 0) else: self.SetFoldExpanded(lineClicked, True) self.Expand(lineClicked, True, True, 100) else: self.ToggleFold(lineClicked) def FoldAll(self): lineCount = self.GetLineCount() expanding = True # find out if we are folding or unfolding for lineNum in range(lineCount): if self.GetFoldLevel(lineNum) & stc.STC_FOLDLEVELHEADERFLAG: expanding = not self.GetFoldExpanded(lineNum) break lineNum = 0 while lineNum < lineCount: level = self.GetFoldLevel(lineNum) if level & stc.STC_FOLDLEVELHEADERFLAG and \ (level & stc.STC_FOLDLEVELNUMBERMASK) == stc.STC_FOLDLEVELBASE: if expanding: self.SetFoldExpanded(lineNum, True) lineNum = self.Expand(lineNum, True) lineNum = lineNum - 1 else: lastChild = self.GetLastChild(lineNum, -1) self.SetFoldExpanded(lineNum, False) if lastChild > lineNum: self.HideLines(lineNum+1, lastChild) lineNum = lineNum + 1 def Expand(self, line, doExpand, force=False, visLevels=0, level=-1): lastChild = self.GetLastChild(line, level) line = line + 1 while line <= lastChild: if force: if visLevels > 0: self.ShowLines(line, line) else: self.HideLines(line, line) else: if doExpand: self.ShowLines(line, line) if level == -1: level = self.GetFoldLevel(line) if level & stc.STC_FOLDLEVELHEADERFLAG: if force: if visLevels > 1: self.SetFoldExpanded(line, True) else: self.SetFoldExpanded(line, False) line = self.Expand(line, doExpand, force, visLevels-1) else: if doExpand and self.GetFoldExpanded(line): line = self.Expand(line, True, force, visLevels-1) else: line = self.Expand(line, False, force, visLevels-1) else: line = line + 1 return line
Ancestors (in MRO)
- XMLSTC
- wx.stc.StyledTextCtrl
- wx._core.Control
- wx._core.Window
- wx._core.EvtHandler
- wx._core.Object
- wx._core.TextCtrlIface
- wx._core.TextAreaBase
- wx._core.TextEntryBase
- __builtin__.object
Class variables
var fold_symbols
Static methods
def Ellipsize(
*args, **kwargs)
Ellipsize(String label, DC dc, int mode, int maxWidth, int flags=ELLIPSIZE_FLAGS_DEFAULT) -> String
def Ellipsize(*args, **kwargs): """Ellipsize(String label, DC dc, int mode, int maxWidth, int flags=ELLIPSIZE_FLAGS_DEFAULT) -> String""" return _core_.Control_Ellipsize(*args, **kwargs)
def EscapeMnemonics(
*args, **kwargs)
EscapeMnemonics(String str) -> String
escapes (by doubling them) the mnemonics
def EscapeMnemonics(*args, **kwargs): """ EscapeMnemonics(String str) -> String escapes (by doubling them) the mnemonics """ return _core_.Control_EscapeMnemonics(*args, **kwargs)
def FindAccelIndex(
*args, **kwargs)
FindAccelIndex(String label) -> int
Return the accel index in the string or -1 if none.
def FindAccelIndex(*args, **kwargs): """ FindAccelIndex(String label) -> int Return the accel index in the string or -1 if none. """ return _core_.Control_FindAccelIndex(*args, **kwargs)
def FindFocus(
*args, **kwargs)
FindFocus() -> Window
Returns the window or control that currently has the keyboard focus, or None.
def FindFocus(*args, **kwargs): """ FindFocus() -> Window Returns the window or control that currently has the keyboard focus, or None. """ return _core_.Window_FindFocus(*args, **kwargs)
def GetCapture(
*args, **kwargs)
GetCapture() -> Window
Returns the window which currently captures the mouse or None
def GetCapture(*args, **kwargs): """ GetCapture() -> Window Returns the window which currently captures the mouse or None """ return _core_.Window_GetCapture(*args, **kwargs)
def GetClassDefaultAttributes(
*args, **kwargs)
GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
Get the default attributes for this class. This is useful if you want to use the same font or colour in your own control as in a standard control -- which is a much better idea than hard coding specific colours or fonts which might look completely out of place on the user's system, especially if it uses themes.
The variant parameter is only relevant under Mac currently and is
ignore under other platforms. Under Mac, it will change the size of
the returned font. See wx.Window.SetWindowVariant for more about
this.
def GetClassDefaultAttributes(*args, **kwargs): """ GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes Get the default attributes for this class. This is useful if you want to use the same font or colour in your own control as in a standard control -- which is a much better idea than hard coding specific colours or fonts which might look completely out of place on the user's system, especially if it uses themes. The variant parameter is only relevant under Mac currently and is ignore under other platforms. Under Mac, it will change the size of the returned font. See `wx.Window.SetWindowVariant` for more about this. """ return _core_.Control_GetClassDefaultAttributes(*args, **kwargs)
def GetCompositeControlsDefaultAttributes(
*args, **kwargs)
GetCompositeControlsDefaultAttributes(int variant) -> VisualAttributes
def GetCompositeControlsDefaultAttributes(*args, **kwargs): """GetCompositeControlsDefaultAttributes(int variant) -> VisualAttributes""" return _core_.Control_GetCompositeControlsDefaultAttributes(*args, **kwargs)
def GetLibraryVersionInfo(
*args, **kwargs)
GetLibraryVersionInfo() -> VersionInfo
def GetLibraryVersionInfo(*args, **kwargs): """GetLibraryVersionInfo() -> VersionInfo""" return _stc.StyledTextCtrl_GetLibraryVersionInfo(*args, **kwargs)
def NewControlId(
*args, **kwargs)
NewControlId(int count=1) -> int
Generate a unique id (or count of them consecutively), returns a valid id in the auto-id range or wxID_NONE if failed. If using autoid management, it will mark the id as reserved until it is used (by assigning it to a wxWindowIDRef) or unreserved.
def NewControlId(*args, **kwargs): """ NewControlId(int count=1) -> int Generate a unique id (or count of them consecutively), returns a valid id in the auto-id range or wxID_NONE if failed. If using autoid management, it will mark the id as reserved until it is used (by assigning it to a wxWindowIDRef) or unreserved. """ return _core_.Window_NewControlId(*args, **kwargs)
def ReleaseControlId(
id)
def ReleaseControlId(id): UnreserveControlId(id)
def RemoveMnemonics(
*args, **kwargs)
RemoveMnemonics(String str) -> String
removes the mnemonics characters
def RemoveMnemonics(*args, **kwargs): """ RemoveMnemonics(String str) -> String removes the mnemonics characters """ return _core_.Control_RemoveMnemonics(*args, **kwargs)
def UnreserveControlId(
*args, **kwargs)
UnreserveControlId(int id, int count=1)
If an ID generated from NewControlId is not assigned to a wxWindowIDRef, it must be unreserved.
def UnreserveControlId(*args, **kwargs): """ UnreserveControlId(int id, int count=1) If an ID generated from NewControlId is not assigned to a wxWindowIDRef, it must be unreserved. """ return _core_.Window_UnreserveControlId(*args, **kwargs)
Instance variables
var AcceleratorTable
See GetAcceleratorTable and SetAcceleratorTable
var Alignment
See GetAlignment
var Anchor
GetAnchor(self) -> int
Returns the position of the opposite end of the selection to the caret.
var AutoLayout
See GetAutoLayout and SetAutoLayout
var BackSpaceUnIndents
GetBackSpaceUnIndents(self) -> bool
Does a backspace pressed when caret is within indentation unindent?
var BackgroundColour
See GetBackgroundColour and SetBackgroundColour
var BackgroundStyle
See GetBackgroundStyle and SetBackgroundStyle
var BestSize
See GetBestSize
var BestVirtualSize
See GetBestVirtualSize
var Border
See GetBorder
var BufferedDraw
GetBufferedDraw(self) -> bool
Is drawing done first into a buffer or direct to the screen?
var Caret
See GetCaret and SetCaret
var CaretForeground
GetCaretForeground(self) -> Colour
Get the foreground colour of the caret.
var CaretLineBack
GetCaretLineBackground(self) -> Colour
Get the colour of the background of the line containing the caret.
var CaretLineBackAlpha
GetCaretLineBackAlpha(self) -> int
Get the background alpha of the caret line.
var CaretLineBackground
GetCaretLineBackground(self) -> Colour
Get the colour of the background of the line containing the caret.
var CaretLineVisible
GetCaretLineVisible(self) -> bool
Is the background of the line containing the caret in a different colour?
var CaretPeriod
GetCaretPeriod(self) -> int
Get the time in milliseconds that the caret is on and off.
var CaretSticky
GetCaretSticky(self) -> int
Can the caret preferred x position only be changed by explicit movement commands?
var CaretStyle
GetCaretStyle(self) -> int
Returns the current style of the caret.
var CaretWidth
GetCaretWidth(self) -> int
Returns the width of the insert mode caret.
var CharHeight
See GetCharHeight
var CharWidth
See GetCharWidth
var Children
See GetChildren
var ClassName
See GetClassName
var ClientAreaOrigin
See GetClientAreaOrigin
var ClientRect
See GetClientRect and SetClientRect
var ClientSize
See GetClientSize and SetClientSize
var CodePage
GetCodePage(self) -> int
Get the code page used to interpret the bytes of the document as characters.
var Constraints
See GetConstraints and SetConstraints
var ContainingSizer
See GetContainingSizer and SetContainingSizer
var ControlCharSymbol
GetControlCharSymbol(self) -> int
Get the way control characters are displayed.
var CurLine
GetCurLine(self) -> (text, pos)
Retrieve the text of the line containing the caret, and also theindex of the caret on the line.
var CurLineRaw
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.
var CurLineUTF8
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.
var CurrentLine
GetCurrentLine(self) -> int
Returns the line number of the line with the caret.
var CurrentPos
GetCurrentPos(self) -> int
Returns the position of the caret.
var Cursor
See GetCursor and SetCursor
var DefaultAttributes
See GetDefaultAttributes
var DefaultStyle
GetDefaultStyle(self) -> wxTextAttr
var DocPointer
GetDocPointer(self) -> void
Retrieve a pointer to the document object.
var DropTarget
See GetDropTarget and SetDropTarget
var EOLMode
GetEOLMode(self) -> int
Retrieve the current end of line mode - one of CRLF, CR, or LF.
var EdgeColour
GetEdgeColour(self) -> Colour
Retrieve the colour used in edge indication.
var EdgeColumn
GetEdgeColumn(self) -> int
Retrieve the column number which text should be kept within.
var EdgeMode
GetEdgeMode(self) -> int
Retrieve the edge highlight mode.
var EffectiveMinSize
See GetEffectiveMinSize
var Enabled
See IsEnabled and Enable
var EndAtLastLine
GetEndAtLastLine(self) -> bool
Retrieve whether the maximum scroll position has the last line at the bottom of the view.
var EndStyled
GetEndStyled(self) -> int
Retrieve the position of the last correctly styled character.
var EventHandler
See GetEventHandler and SetEventHandler
var EvtHandlerEnabled
See GetEvtHandlerEnabled and SetEvtHandlerEnabled
var ExtraStyle
See GetExtraStyle and SetExtraStyle
var FirstVisibleLine
GetFirstVisibleLine(self) -> int
Retrieve the display line at the top of the display.
var Font
See GetFont and SetFont
var ForegroundColour
See GetForegroundColour and SetForegroundColour
var GrandParent
See GetGrandParent
var GtkWidget
GetGtkWidget(self) -> long
On wxGTK returns a pointer to the GtkWidget for this window as a long integer. On the other platforms this method returns zero.
var Handle
See GetHandle
var HelpText
See GetHelpText and SetHelpText
var HighlightGuide
GetHighlightGuide(self) -> int
Get the highlighted indentation guide column.
var HotspotActiveBackground
GetHotspotActiveBackground(self) -> Colour
Get the back colour for active hotspots.
var HotspotActiveForeground
GetHotspotActiveForeground(self) -> Colour
Get the fore colour for active hotspots.
var HotspotActiveUnderline
GetHotspotActiveUnderline(self) -> bool
Get whether underlining for active hotspots.
var HotspotSingleLine
GetHotspotSingleLine(self) -> bool
Get the HotspotSingleLine property
var Id
See GetId and SetId
var Indent
GetIndent(self) -> int
Retrieve indentation size.
var IndentationGuides
GetIndentationGuides(self) -> int
Are the indentation guides visible?
var IndicatorCurrent
GetIndicatorCurrent(self) -> int
Get the current indicator
var IndicatorValue
GetIndicatorValue(self) -> int
Get the current indicator vaue
var InsertionPoint
GetInsertionPoint(self) -> long
Returns the insertion point for the combobox's text field.
var Label
See GetLabel and SetLabel
var LabelText
See GetLabelText
var LastKeydownProcessed
GetLastKeydownProcessed(self) -> bool
var LastPosition
GetLastPosition(self) -> long
Returns the last position in the combobox text field.
var LayoutCache
GetLayoutCache(self) -> int
Retrieve the degree of caching of layout information.
var LayoutDirection
See GetLayoutDirection and SetLayoutDirection
var Length
GetLength(self) -> int
Returns the number of bytes in the document.
var Lexer
GetLexer(self) -> int
Retrieve the lexing language of the document.
var LineCount
GetLineCount(self) -> int
Returns the number of lines in the document. There is always at least one.
var MarginLeft
GetMarginLeft(self) -> int
Returns the size in pixels of the left margin.
var MarginRight
GetMarginRight(self) -> int
Returns the size in pixels of the right margin.
var MaxClientSize
GetMaxClientSize(self) -> Size
var MaxHeight
See GetMaxHeight
var MaxLineState
GetMaxLineState(self) -> int
Retrieve the last line number that has line state.
var MaxSize
See GetMaxSize and SetMaxSize
var MaxWidth
See GetMaxWidth
var MinClientSize
GetMinClientSize(self) -> Size
var MinHeight
See GetMinHeight
var MinSize
See GetMinSize and SetMinSize
var MinWidth
See GetMinWidth
var ModEventMask
GetModEventMask(self) -> int
Get which document modification events are sent to the container.
var Modify
GetModify(self) -> bool
Is the document different from when it was last saved?
var MouseDownCaptures
GetMouseDownCaptures(self) -> bool
Get whether mouse gets captured.
var MouseDwellTime
GetMouseDwellTime(self) -> int
Retrieve the time the mouse must sit still to generate a mouse dwell event.
var Name
See GetName and SetName
var NextHandler
See GetNextHandler and SetNextHandler
var NumberOfLines
GetNumberOfLines(self) -> int
var Overtype
GetOvertype(self) -> bool
Returns true if overtype mode is active otherwise false is returned.
var Parent
See GetParent
var PasteConvertEndings
GetPasteConvertEndings(self) -> bool
Get convert-on-paste setting
var Position
See GetPosition and SetPosition
var PositionCacheSize
GetPositionCacheSize(self) -> int
How many entries are allocated to the position cache?
var PreviousHandler
See GetPreviousHandler and SetPreviousHandler
var PrintColourMode
GetPrintColourMode(self) -> int
Returns the print colour mode.
var PrintMagnification
GetPrintMagnification(self) -> int
Returns the print magnification.
var PrintWrapMode
GetPrintWrapMode(self) -> int
Is printing line wrapped?
var ReadOnly
GetReadOnly(self) -> bool
In read-only mode?
var Rect
See GetRect and SetRect
var STCCursor
GetSTCCursor(self) -> int
Get cursor type.
var STCFocus
GetSTCFocus(self) -> bool
Get internal focus flag.
var ScreenPosition
See GetScreenPosition
var ScreenRect
See GetScreenRect
var ScrollWidth
GetScrollWidth(self) -> int
Retrieve the document width assumed for scrolling.
var ScrollWidthTracking
GetScrollWidthTracking(self) -> bool
Retrieve whether the scroll width tracks wide lines.
var SearchFlags
GetSearchFlags(self) -> int
Get the search flags used by SearchInTarget.
var SelAlpha
GetSelAlpha(self) -> int
Get the alpha of the selection.
var SelEOLFilled
GetSelEOLFilled(self) -> bool
Is the selection end of line filled?
var SelectedText
GetSelectedText(self) -> String
Retrieve the selected text.
var SelectedTextRaw
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.
var SelectedTextUTF8
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.
var Selection
GetSelection() -> (from, to)
If the return values from and to are the same, there is no selection.
var SelectionEnd
GetSelectionEnd(self) -> int
Returns the position at the end of the selection.
var SelectionMode
GetSelectionMode(self) -> int
Get the mode of the current selection.
var SelectionStart
GetSelectionStart(self) -> int
Returns the position at the start of the selection.
var Shown
See IsShown and Show
var Size
See GetSize and SetSize
var Sizer
See GetSizer and SetSizer
var Status
GetStatus(self) -> int
Get error status.
var StyleBits
GetStyleBits(self) -> int
Retrieve number of bits in style bytes used to hold the lexical state.
var StyleBitsNeeded
GetStyleBitsNeeded(self) -> int
Retrieve the number of bits the current lexer needs for styling.
var TabIndents
GetTabIndents(self) -> bool
Does a tab pressed when caret is within indentation indent?
var TabWidth
GetTabWidth(self) -> int
Retrieve the visible size of a tab.
var TargetEnd
GetTargetEnd(self) -> int
Get the position that ends the target.
var TargetStart
GetTargetStart(self) -> int
Get the position that starts the target.
var Text
GetText(self) -> String
Retrieve all the text in the document.
var TextLength
GetTextLength(self) -> int
Retrieve the number of characters in the document.
var TextRaw
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.
var TextUTF8
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.
var ThemeEnabled
See GetThemeEnabled and SetThemeEnabled
var ToolTip
See GetToolTip and SetToolTip
var ToolTipString
var TopLevel
See IsTopLevel
var TopLevelParent
See GetTopLevelParent
var TwoPhaseDraw
GetTwoPhaseDraw(self) -> bool
Is drawing done in two phases with backgrounds drawn before foregrounds?
var UndoCollection
GetUndoCollection(self) -> bool
Is undo history being collected?
var UpdateClientRect
See GetUpdateClientRect
var UpdateRegion
See GetUpdateRegion
var UseAntiAliasing
GetUseAntiAliasing(self) -> bool
Returns the current UseAntiAliasing setting.
var UseHorizontalScrollBar
GetUseHorizontalScrollBar(self) -> bool
Is the horizontal scroll bar visible?
var UseTabs
GetUseTabs(self) -> bool
Retrieve whether tabs will be used in indentation.
var UseVerticalScrollBar
GetUseVerticalScrollBar(self) -> bool
Is the vertical scroll bar visible?
var Validator
See GetValidator and SetValidator
var Value
GetValue(self) -> String
Returns the current value in the text field.
var ViewEOL
GetViewEOL(self) -> bool
Are the end of line characters visible?
var ViewWhiteSpace
GetViewWhiteSpace(self) -> int
Are white space characters currently visible? Returns one of SCWS_* constants.
var VirtualSize
See GetVirtualSize and SetVirtualSize
var WindowStyle
See GetWindowStyle and SetWindowStyle
var WindowStyleFlag
See GetWindowStyleFlag and SetWindowStyleFlag
var WindowVariant
See GetWindowVariant and SetWindowVariant
var WrapMode
GetWrapMode(self) -> int
Retrieve whether text is word wrapped.
var WrapStartIndent
GetWrapStartIndent(self) -> int
Retrive the start indent for wrapped lines.
var WrapVisualFlags
GetWrapVisualFlags(self) -> int
Retrive the display mode of visual flags for wrapped lines.
var WrapVisualFlagsLocation
GetWrapVisualFlagsLocation(self) -> int
Retrive the location of visual flags for wrapped lines.
var XOffset
GetXOffset(self) -> int
var Zoom
GetZoom(self) -> int
Retrieve the zoom level.
var thisown
The membership flag
Methods
def __init__(
self, parent, id, pos=wx.Point(-1, -1), size=wx.Size(-1, -1), style=0, name=None)
def __init__(self, parent, id, pos=wx.DefaultPosition, size=wx.DefaultSize, style=0,name=None): stc.StyledTextCtrl.__init__(self, parent, id, pos, size, style,name) self.CmdKeyAssign(ord('B'), stc.STC_SCMOD_CTRL, stc.STC_CMD_ZOOMIN) self.CmdKeyAssign(ord('N'), stc.STC_SCMOD_CTRL, stc.STC_CMD_ZOOMOUT) self.SetLexer(stc.STC_LEX_XML) #self.SetKeyWords(0, " ".join(keyword.kwlist)) self.SetProperty("fold", "1") self.SetProperty("tab.timmy.whinge.level", "1") self.SetMargins(0,0) #self.SetViewWhiteSpace(False) #self.SetBufferedDraw(False) #self.SetViewEOL(True) #self.SetEOLMode(stc.STC_EOL_CRLF) #self.SetUseAntiAliasing(True) self.SetEdgeMode(stc.STC_EDGE_BACKGROUND) self.SetEdgeColumn(78) # Setup a margin to hold fold markers self.SetFoldFlags(16) ### WHAT IS THIS VALUE? WHAT ARE THE OTHER FLAGS? DOES IT MATTER? self.SetMarginType(2, stc.STC_MARGIN_SYMBOL) self.SetMarginMask(2, stc.STC_MASK_FOLDERS) self.SetMarginSensitive(2, True) self.SetMarginWidth(2, 12) if self.fold_symbols == 0: # Arrow pointing right for contracted folders, arrow pointing down for expanded self.MarkerDefine(stc.STC_MARKNUM_FOLDEROPEN, stc.STC_MARK_ARROWDOWN, "black", "black") self.MarkerDefine(stc.STC_MARKNUM_FOLDER, stc.STC_MARK_ARROW, "black", "black") self.MarkerDefine(stc.STC_MARKNUM_FOLDERSUB, stc.STC_MARK_EMPTY, "black", "black") self.MarkerDefine(stc.STC_MARKNUM_FOLDERTAIL, stc.STC_MARK_EMPTY, "black", "black") self.MarkerDefine(stc.STC_MARKNUM_FOLDEREND, stc.STC_MARK_EMPTY, "white", "black") self.MarkerDefine(stc.STC_MARKNUM_FOLDEROPENMID, stc.STC_MARK_EMPTY, "white", "black") self.MarkerDefine(stc.STC_MARKNUM_FOLDERMIDTAIL, stc.STC_MARK_EMPTY, "white", "black") elif self.fold_symbols == 1: # Plus for contracted folders, minus for expanded self.MarkerDefine(stc.STC_MARKNUM_FOLDEROPEN, stc.STC_MARK_MINUS, "white", "black") self.MarkerDefine(stc.STC_MARKNUM_FOLDER, stc.STC_MARK_PLUS, "white", "black") self.MarkerDefine(stc.STC_MARKNUM_FOLDERSUB, stc.STC_MARK_EMPTY, "white", "black") self.MarkerDefine(stc.STC_MARKNUM_FOLDERTAIL, stc.STC_MARK_EMPTY, "white", "black") self.MarkerDefine(stc.STC_MARKNUM_FOLDEREND, stc.STC_MARK_EMPTY, "white", "black") self.MarkerDefine(stc.STC_MARKNUM_FOLDEROPENMID, stc.STC_MARK_EMPTY, "white", "black") self.MarkerDefine(stc.STC_MARKNUM_FOLDERMIDTAIL, stc.STC_MARK_EMPTY, "white", "black") elif self.fold_symbols == 2: # Like a flattened tree control using circular headers and curved joins self.MarkerDefine(stc.STC_MARKNUM_FOLDEROPEN, stc.STC_MARK_CIRCLEMINUS, "white", "#404040") self.MarkerDefine(stc.STC_MARKNUM_FOLDER, stc.STC_MARK_CIRCLEPLUS, "white", "#404040") self.MarkerDefine(stc.STC_MARKNUM_FOLDERSUB, stc.STC_MARK_VLINE, "white", "#404040") self.MarkerDefine(stc.STC_MARKNUM_FOLDERTAIL, stc.STC_MARK_LCORNERCURVE, "white", "#404040") self.MarkerDefine(stc.STC_MARKNUM_FOLDEREND, stc.STC_MARK_CIRCLEPLUSCONNECTED, "white", "#404040") self.MarkerDefine(stc.STC_MARKNUM_FOLDEROPENMID, stc.STC_MARK_CIRCLEMINUSCONNECTED, "white", "#404040") self.MarkerDefine(stc.STC_MARKNUM_FOLDERMIDTAIL, stc.STC_MARK_TCORNERCURVE, "white", "#404040") elif self.fold_symbols == 3: # Like a flattened tree control using square headers self.MarkerDefine(stc.STC_MARKNUM_FOLDEROPEN, stc.STC_MARK_BOXMINUS, "white", "#808080") self.MarkerDefine(stc.STC_MARKNUM_FOLDER, stc.STC_MARK_BOXPLUS, "white", "#808080") self.MarkerDefine(stc.STC_MARKNUM_FOLDERSUB, stc.STC_MARK_VLINE, "white", "#808080") self.MarkerDefine(stc.STC_MARKNUM_FOLDERTAIL, stc.STC_MARK_LCORNER, "white", "#808080") self.MarkerDefine(stc.STC_MARKNUM_FOLDEREND, stc.STC_MARK_BOXPLUSCONNECTED, "white", "#808080") self.MarkerDefine(stc.STC_MARKNUM_FOLDEROPENMID, stc.STC_MARK_BOXMINUSCONNECTED, "white", "#808080") self.MarkerDefine(stc.STC_MARKNUM_FOLDERMIDTAIL, stc.STC_MARK_TCORNER, "white", "#808080") self.Bind(stc.EVT_STC_UPDATEUI, self.OnUpdateUI) self.Bind(stc.EVT_STC_MARGINCLICK, self.OnMarginClick) self.Bind(wx.EVT_KEY_DOWN, self.OnKeyPressed) # Make some styles, The lexer defines what each style is used for, we # just have to define what each style looks like. This set is adapted from # Scintilla sample property files. # Global default styles for all languages self.StyleSetSpec(stc.STC_STYLE_DEFAULT, "face:%(helv)s,size:%(size)d" % faces) self.StyleClearAll() # Reset all to be like the default # Global default styles for all languages self.StyleSetSpec(stc.STC_STYLE_DEFAULT, "face:%(helv)s,size:%(size)d" % faces) self.StyleSetSpec(stc.STC_STYLE_LINENUMBER, "back:#C0C0C0,face:%(helv)s,size:%(size2)d" % faces) self.StyleSetSpec(stc.STC_STYLE_CONTROLCHAR, "face:%(other)s" % faces) #self.StyleSetSpec(stc.STC_STYLE_BRACELIGHT, "fore:#FFFFFF,back:#0000FF,bold") #self.StyleSetSpec(stc.STC_STYLE_BRACEBAD, "fore:#000000,back:#FF0000,bold") leidnames={wx.stc.STC_H_DEFAULT: 'Default', wx.stc.STC_H_TAG: 'Tag', wx.stc.STC_H_TAGUNKNOWN: 'Tag unknown', wx.stc.STC_H_ATTRIBUTE: 'Attribute', wx.stc.STC_H_NUMBER: 'Number', wx.stc.STC_H_DOUBLESTRING: 'Double quoted string', wx.stc.STC_H_SINGLESTRING:'Single quoted string', wx.stc.STC_H_OTHER: 'Other inside tag', wx.stc.STC_H_COMMENT: 'Comment', wx.stc.STC_H_ENTITY: 'Entity', wx.stc.STC_H_TAGEND: 'Tag end', wx.stc.STC_H_XMLSTART: 'XML start', wx.stc.STC_H_XMLEND: 'XML End'} D:This is the section I have to define the styles for in order to work yles=['STC_H_ASP', 'STC_H_ASPAT', 'STC_H_ATTRIBUTE', 'STC_H_ATTRIBUTEUNKNOWN', TC_H_CDATA', 'STC_H_COMMENT', 'STC_H_DEFAULT', 'STC_H_DOUBLESTRING', 'STC_H_ENTITY', TC_H_NUMBER', 'STC_H_OTHER', 'STC_H_QUESTION', 'STC_H_SCRIPT', 'STC_H_SGML_1ST_PARAM', TC_H_SGML_1ST_PARAM_COMMENT', 'STC_H_SGML_BLOCK_DEFAULT', 'STC_H_SGML_COMMAND', C_H_SGML_COMMENT', 'STC_H_SGML_DEFAULT', 'STC_H_SGML_DOUBLESTRING', 'STC_H_SGML_ENTITY', C_H_SGML_ERROR', 'STC_H_SGML_SIMPLESTRING', 'STC_H_SGML_SPECIAL', C_H_SINGLESTRING', 'STC_H_TAG', 'STC_H_TAGEND', 'STC_H_TAGUNKNOWN', C_H_VALUE', 'STC_H_XCCOMMENT', 'STC_H_XMLEND', 'STC_H_XMLSTART'] # XML styles, just taken from the above python sample # XML styles Mostly HTML styles # Default self.StyleSetSpec(stc.STC_H_DEFAULT, "fore:#000000,face:%(helv)s,size:%(size)d" % faces) # Comments self.StyleSetSpec(stc.STC_H_XCCOMMENT, "fore:#007F00,face:%(other)s,size:%(size)d" % faces) # Number self.StyleSetSpec(stc.STC_H_NUMBER, "fore:#007F7F,size:%(size)d" % faces) # String self.StyleSetSpec(stc.STC_H_ATTRIBUTE, "fore:#7F007F,face:%(helv)s,size:%(size)d" % faces) # Single quoted string self.StyleSetSpec(stc.STC_H_QUESTION, "fore:#7F007F,face:%(helv)s,size:%(size)d" % faces) # Keyword self.StyleSetSpec(stc.STC_H_ATTRIBUTEUNKNOWN, "fore:#00007F,bold,size:%(size)d" % faces) # Single quotes self.StyleSetSpec(stc.STC_H_SINGLESTRING, "fore:#7F0000,size:%(size)d" % faces) # double quotes self.StyleSetSpec(stc.STC_H_DOUBLESTRING, "fore:#7F0000,size:%(size)d" % faces) # Tag name definition self.StyleSetSpec(stc.STC_H_TAG, "fore:#0000FF,bold,size:%(size)d" % faces) # UnknownTag definition self.StyleSetSpec(stc.STC_H_TAGUNKNOWN, "fore:#007F7F,bold,size:%(size)d" % faces) # Operators self.StyleSetSpec(stc.STC_H_XMLSTART, "bold,size:%(size)d" % faces) # Identifiers self.StyleSetSpec(stc.STC_H_CDATA, "fore:#000000,face:%(helv)s,size:%(size)d" % faces) # Comment-blocks self.StyleSetSpec(stc.STC_H_COMMENT, "fore:#7F007F,underline,size:%(size)d" % faces) # End of line where string is not closed #self.StyleSetSpec(stc.STC_H_XMLEND, "fore:#000000,face:%(mono)s,size:%(size)d" % faces) self.SetCaretForeground("BLUE") self.SetCaretForeground("BLUE") # register some images for use in the AutoComplete box. self.RegisterImage(1, wx.ArtProvider.GetBitmap(wx.ART_NEW, size=(16,16))) self.RegisterImage(2, wx.ArtProvider.GetBitmap(wx.ART_NEW, size=(16,16))) self.RegisterImage(3, wx.ArtProvider.GetBitmap(wx.ART_COPY, size=(16,16)))
def AcceptsFocus(
*args, **kwargs)
AcceptsFocus(self) -> bool
Can this window have focus?
def AcceptsFocus(*args, **kwargs): """ AcceptsFocus(self) -> bool Can this window have focus? """ return _core_.Window_AcceptsFocus(*args, **kwargs)
def AcceptsFocusFromKeyboard(
*args, **kwargs)
AcceptsFocusFromKeyboard(self) -> bool
Can this window be given focus by keyboard navigation? if not, the only way to give it focus (provided it accepts it at all) is to click it.
def AcceptsFocusFromKeyboard(*args, **kwargs): """ AcceptsFocusFromKeyboard(self) -> bool Can this window be given focus by keyboard navigation? if not, the only way to give it focus (provided it accepts it at all) is to click it. """ return _core_.Window_AcceptsFocusFromKeyboard(*args, **kwargs)
def AddChild(
*args, **kwargs)
AddChild(self, Window child)
Adds a child window. This is called automatically by window creation functions so should not be required by the application programmer.
def AddChild(*args, **kwargs): """ AddChild(self, Window child) Adds a child window. This is called automatically by window creation functions so should not be required by the application programmer. """ return _core_.Window_AddChild(*args, **kwargs)
def AddPendingEvent(
*args, **kwargs)
AddPendingEvent(self, Event event)
def AddPendingEvent(*args, **kwargs): """AddPendingEvent(self, Event event)""" return _core_.EvtHandler_AddPendingEvent(*args, **kwargs)
def AddRefDocument(
*args, **kwargs)
AddRefDocument(self, void docPointer)
Extend life of document.
def AddRefDocument(*args, **kwargs): """ AddRefDocument(self, void docPointer) Extend life of document. """ return _stc.StyledTextCtrl_AddRefDocument(*args, **kwargs)
def AddSelection(
*args, **kwargs)
AddSelection(self, int caret, int anchor) -> int
Add a selection
def AddSelection(*args, **kwargs): """ AddSelection(self, int caret, int anchor) -> int Add a selection """ return _stc.StyledTextCtrl_AddSelection(*args, **kwargs)
def AddStyledText(
*args, **kwargs)
AddStyledText(self, wxMemoryBuffer data)
Add array of cells to document.
def AddStyledText(*args, **kwargs): """ AddStyledText(self, wxMemoryBuffer data) Add array of cells to document. """ return _stc.StyledTextCtrl_AddStyledText(*args, **kwargs)
def AddText(
*args, **kwargs)
AddText(self, String text)
Add text to the document at current position.
def AddText(*args, **kwargs): """ AddText(self, String text) Add text to the document at current position. """ return _stc.StyledTextCtrl_AddText(*args, **kwargs)
def AddTextRaw(
*args, **kwargs)
AddTextRaw(self, char text, int length=-1)
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.
def AddTextRaw(*args, **kwargs): """ AddTextRaw(self, char text, int length=-1) 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. """ return _stc.StyledTextCtrl_AddTextRaw(*args, **kwargs)
def AddTextUTF8(
self, text)
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.
def AddTextUTF8(self, text): """ 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. """ if not wx.USE_UNICODE: u = text.decode('utf-8') text = u.encode(wx.GetDefaultPyEncoding()) self.AddTextRaw(text)
def AddUndoAction(
*args, **kwargs)
AddUndoAction(self, int token, int flags)
Add a container action to the undo stack
def AddUndoAction(*args, **kwargs): """ AddUndoAction(self, int token, int flags) Add a container action to the undo stack """ return _stc.StyledTextCtrl_AddUndoAction(*args, **kwargs)
def AdjustForLayoutDirection(
*args, **kwargs)
AdjustForLayoutDirection(self, int x, int width, int widthTotal) -> int
Mirror coordinates for RTL layout if this window uses it and if the mirroring is not done automatically like Win32.
def AdjustForLayoutDirection(*args, **kwargs): """ AdjustForLayoutDirection(self, int x, int width, int widthTotal) -> int Mirror coordinates for RTL layout if this window uses it and if the mirroring is not done automatically like Win32. """ return _core_.Window_AdjustForLayoutDirection(*args, **kwargs)
def Allocate(
*args, **kwargs)
Allocate(self, int bytes)
Enlarge the document to a particular size of text bytes.
def Allocate(*args, **kwargs): """ Allocate(self, int bytes) Enlarge the document to a particular size of text bytes. """ return _stc.StyledTextCtrl_Allocate(*args, **kwargs)
def AlwaysShowScrollbars(
*args, **kwargs)
AlwaysShowScrollbars(self, bool horz=True, bool vert=True)
def AlwaysShowScrollbars(*args, **kwargs): """AlwaysShowScrollbars(self, bool horz=True, bool vert=True)""" return _core_.Window_AlwaysShowScrollbars(*args, **kwargs)
def AnnotationClearAll(
*args, **kwargs)
AnnotationClearAll(self)
Clear the annotations from all lines
def AnnotationClearAll(*args, **kwargs): """ AnnotationClearAll(self) Clear the annotations from all lines """ return _stc.StyledTextCtrl_AnnotationClearAll(*args, **kwargs)
def AnnotationClearLine(
*args, **kwargs)
AnnotationClearLine(self, int line)
def AnnotationClearLine(*args, **kwargs): """AnnotationClearLine(self, int line)""" return _stc.StyledTextCtrl_AnnotationClearLine(*args, **kwargs)
def AnnotationGetLines(
*args, **kwargs)
AnnotationGetLines(self, int line) -> int
Get the number of annotation lines for a line
def AnnotationGetLines(*args, **kwargs): """ AnnotationGetLines(self, int line) -> int Get the number of annotation lines for a line """ return _stc.StyledTextCtrl_AnnotationGetLines(*args, **kwargs)
def AnnotationGetStyle(
*args, **kwargs)
AnnotationGetStyle(self, int line) -> int
Get the style number for the annotations for a line
def AnnotationGetStyle(*args, **kwargs): """ AnnotationGetStyle(self, int line) -> int Get the style number for the annotations for a line """ return _stc.StyledTextCtrl_AnnotationGetStyle(*args, **kwargs)
def AnnotationGetStyleOffset(
*args, **kwargs)
AnnotationGetStyleOffset(self) -> int
Get the start of the range of style numbers used for annotations
def AnnotationGetStyleOffset(*args, **kwargs): """ AnnotationGetStyleOffset(self) -> int Get the start of the range of style numbers used for annotations """ return _stc.StyledTextCtrl_AnnotationGetStyleOffset(*args, **kwargs)
def AnnotationGetStyles(
*args, **kwargs)
AnnotationGetStyles(self, int line) -> String
Get the annotation styles for a line
def AnnotationGetStyles(*args, **kwargs): """ AnnotationGetStyles(self, int line) -> String Get the annotation styles for a line """ return _stc.StyledTextCtrl_AnnotationGetStyles(*args, **kwargs)
def AnnotationGetText(
*args, **kwargs)
AnnotationGetText(self, int line) -> String
Get the annotation text for a line
def AnnotationGetText(*args, **kwargs): """ AnnotationGetText(self, int line) -> String Get the annotation text for a line """ return _stc.StyledTextCtrl_AnnotationGetText(*args, **kwargs)
def AnnotationGetVisible(
*args, **kwargs)
AnnotationGetVisible(self) -> int
Get the visibility for the annotations for a view
def AnnotationGetVisible(*args, **kwargs): """ AnnotationGetVisible(self) -> int Get the visibility for the annotations for a view """ return _stc.StyledTextCtrl_AnnotationGetVisible(*args, **kwargs)
def AnnotationSetStyle(
*args, **kwargs)
AnnotationSetStyle(self, int line, int style)
Set the style number for the annotations for a line
def AnnotationSetStyle(*args, **kwargs): """ AnnotationSetStyle(self, int line, int style) Set the style number for the annotations for a line """ return _stc.StyledTextCtrl_AnnotationSetStyle(*args, **kwargs)
def AnnotationSetStyleOffset(
*args, **kwargs)
AnnotationSetStyleOffset(self, int style)
Get the start of the range of style numbers used for annotations
def AnnotationSetStyleOffset(*args, **kwargs): """ AnnotationSetStyleOffset(self, int style) Get the start of the range of style numbers used for annotations """ return _stc.StyledTextCtrl_AnnotationSetStyleOffset(*args, **kwargs)
def AnnotationSetStyles(
*args, **kwargs)
AnnotationSetStyles(self, int line, String styles)
Set the annotation styles for a line
def AnnotationSetStyles(*args, **kwargs): """ AnnotationSetStyles(self, int line, String styles) Set the annotation styles for a line """ return _stc.StyledTextCtrl_AnnotationSetStyles(*args, **kwargs)
def AnnotationSetText(
*args, **kwargs)
AnnotationSetText(self, int line, String text)
Set the annotation text for a line
def AnnotationSetText(*args, **kwargs): """ AnnotationSetText(self, int line, String text) Set the annotation text for a line """ return _stc.StyledTextCtrl_AnnotationSetText(*args, **kwargs)
def AnnotationSetVisible(
*args, **kwargs)
AnnotationSetVisible(self, int visible)
Set the visibility for the annotations for a view
def AnnotationSetVisible(*args, **kwargs): """ AnnotationSetVisible(self, int visible) Set the visibility for the annotations for a view """ return _stc.StyledTextCtrl_AnnotationSetVisible(*args, **kwargs)
def AppendText(
*args, **kwargs)
AppendText(self, String text)
Add text to the end of the text field, without removing any existing text. Will reset the selection if any.
def AppendText(*args, **kwargs): """ AppendText(self, String text) Add text to the end of the text field, without removing any existing text. Will reset the selection if any. """ return _core_.TextEntryBase_AppendText(*args, **kwargs)
def AppendTextRaw(
*args, **kwargs)
AppendTextRaw(self, char text, int length=-1)
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.
def AppendTextRaw(*args, **kwargs): """ AppendTextRaw(self, char text, int length=-1) 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. """ return _stc.StyledTextCtrl_AppendTextRaw(*args, **kwargs)
def AppendTextUTF8(
self, text)
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.
def AppendTextUTF8(self, text): """ 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. """ if not wx.USE_UNICODE: u = text.decode('utf-8') text = u.encode(wx.GetDefaultPyEncoding()) self.AppendTextRaw(text)
def AssociateHandle(
*args, **kwargs)
AssociateHandle(self, long handle)
Associate the window with a new native handle
def AssociateHandle(*args, **kwargs): """ AssociateHandle(self, long handle) Associate the window with a new native handle """ return _core_.Window_AssociateHandle(*args, **kwargs)
def AutoCompActive(
*args, **kwargs)
AutoCompActive(self) -> bool
Is there an auto-completion list visible?
def AutoCompActive(*args, **kwargs): """ AutoCompActive(self) -> bool Is there an auto-completion list visible? """ return _stc.StyledTextCtrl_AutoCompActive(*args, **kwargs)
def AutoCompCancel(
*args, **kwargs)
AutoCompCancel(self)
Remove the auto-completion list from the screen.
def AutoCompCancel(*args, **kwargs): """ AutoCompCancel(self) Remove the auto-completion list from the screen. """ return _stc.StyledTextCtrl_AutoCompCancel(*args, **kwargs)
def AutoCompComplete(
*args, **kwargs)
AutoCompComplete(self)
User has selected an item so remove the list and insert the selection.
def AutoCompComplete(*args, **kwargs): """ AutoCompComplete(self) User has selected an item so remove the list and insert the selection. """ return _stc.StyledTextCtrl_AutoCompComplete(*args, **kwargs)
def AutoCompGetAutoHide(
*args, **kwargs)
AutoCompGetAutoHide(self) -> bool
Retrieve whether or not autocompletion is hidden automatically when nothing matches.
def AutoCompGetAutoHide(*args, **kwargs): """ AutoCompGetAutoHide(self) -> bool Retrieve whether or not autocompletion is hidden automatically when nothing matches. """ return _stc.StyledTextCtrl_AutoCompGetAutoHide(*args, **kwargs)
def AutoCompGetCancelAtStart(
*args, **kwargs)
AutoCompGetCancelAtStart(self) -> bool
Retrieve whether auto-completion cancelled by backspacing before start.
def AutoCompGetCancelAtStart(*args, **kwargs): """ AutoCompGetCancelAtStart(self) -> bool Retrieve whether auto-completion cancelled by backspacing before start. """ return _stc.StyledTextCtrl_AutoCompGetCancelAtStart(*args, **kwargs)
def AutoCompGetCaseInsensitiveBehaviour(
*args, **kwargs)
AutoCompGetCaseInsensitiveBehaviour(self) -> int
def AutoCompGetCaseInsensitiveBehaviour(*args, **kwargs): """AutoCompGetCaseInsensitiveBehaviour(self) -> int""" return _stc.StyledTextCtrl_AutoCompGetCaseInsensitiveBehaviour(*args, **kwargs)
def AutoCompGetChooseSingle(
*args, **kwargs)
AutoCompGetChooseSingle(self) -> bool
Retrieve whether a single item auto-completion list automatically choose the item.
def AutoCompGetChooseSingle(*args, **kwargs): """ AutoCompGetChooseSingle(self) -> bool Retrieve whether a single item auto-completion list automatically choose the item. """ return _stc.StyledTextCtrl_AutoCompGetChooseSingle(*args, **kwargs)
def AutoCompGetCurrent(
*args, **kwargs)
AutoCompGetCurrent(self) -> int
Get currently selected item position in the auto-completion list
def AutoCompGetCurrent(*args, **kwargs): """ AutoCompGetCurrent(self) -> int Get currently selected item position in the auto-completion list """ return _stc.StyledTextCtrl_AutoCompGetCurrent(*args, **kwargs)
def AutoCompGetDropRestOfWord(
*args, **kwargs)
AutoCompGetDropRestOfWord(self) -> bool
Retrieve whether or not autocompletion deletes any word characters after the inserted text upon completion.
def AutoCompGetDropRestOfWord(*args, **kwargs): """ AutoCompGetDropRestOfWord(self) -> bool Retrieve whether or not autocompletion deletes any word characters after the inserted text upon completion. """ return _stc.StyledTextCtrl_AutoCompGetDropRestOfWord(*args, **kwargs)
def AutoCompGetIgnoreCase(
*args, **kwargs)
AutoCompGetIgnoreCase(self) -> bool
Retrieve state of ignore case flag.
def AutoCompGetIgnoreCase(*args, **kwargs): """ AutoCompGetIgnoreCase(self) -> bool Retrieve state of ignore case flag. """ return _stc.StyledTextCtrl_AutoCompGetIgnoreCase(*args, **kwargs)
def AutoCompGetMaxHeight(
*args, **kwargs)
AutoCompGetMaxHeight(self) -> int
Set the maximum height, in rows, of auto-completion and user lists.
def AutoCompGetMaxHeight(*args, **kwargs): """ AutoCompGetMaxHeight(self) -> int Set the maximum height, in rows, of auto-completion and user lists. """ return _stc.StyledTextCtrl_AutoCompGetMaxHeight(*args, **kwargs)
def AutoCompGetMaxWidth(
*args, **kwargs)
AutoCompGetMaxWidth(self) -> int
Get the maximum width, in characters, of auto-completion and user lists.
def AutoCompGetMaxWidth(*args, **kwargs): """ AutoCompGetMaxWidth(self) -> int Get the maximum width, in characters, of auto-completion and user lists. """ return _stc.StyledTextCtrl_AutoCompGetMaxWidth(*args, **kwargs)
def AutoCompGetSeparator(
*args, **kwargs)
AutoCompGetSeparator(self) -> int
Retrieve the auto-completion list separator character.
def AutoCompGetSeparator(*args, **kwargs): """ AutoCompGetSeparator(self) -> int Retrieve the auto-completion list separator character. """ return _stc.StyledTextCtrl_AutoCompGetSeparator(*args, **kwargs)
def AutoCompGetTypeSeparator(
*args, **kwargs)
AutoCompGetTypeSeparator(self) -> int
Retrieve the auto-completion list type-separator character.
def AutoCompGetTypeSeparator(*args, **kwargs): """ AutoCompGetTypeSeparator(self) -> int Retrieve the auto-completion list type-separator character. """ return _stc.StyledTextCtrl_AutoCompGetTypeSeparator(*args, **kwargs)
def AutoCompPosStart(
*args, **kwargs)
AutoCompPosStart(self) -> int
Retrieve the position of the caret when the auto-completion list was displayed.
def AutoCompPosStart(*args, **kwargs): """ AutoCompPosStart(self) -> int Retrieve the position of the caret when the auto-completion list was displayed. """ return _stc.StyledTextCtrl_AutoCompPosStart(*args, **kwargs)
def AutoCompSelect(
*args, **kwargs)
AutoCompSelect(self, String text)
Select the item in the auto-completion list that starts with a string.
def AutoCompSelect(*args, **kwargs): """ AutoCompSelect(self, String text) Select the item in the auto-completion list that starts with a string. """ return _stc.StyledTextCtrl_AutoCompSelect(*args, **kwargs)
def AutoCompSetAutoHide(
*args, **kwargs)
AutoCompSetAutoHide(self, bool autoHide)
Set whether or not autocompletion is hidden automatically when nothing matches.
def AutoCompSetAutoHide(*args, **kwargs): """ AutoCompSetAutoHide(self, bool autoHide) Set whether or not autocompletion is hidden automatically when nothing matches. """ return _stc.StyledTextCtrl_AutoCompSetAutoHide(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_AutoCompSetCancelAtStart(*args, **kwargs)
def AutoCompSetCaseInsensitiveBehaviour(
*args, **kwargs)
AutoCompSetCaseInsensitiveBehaviour(self, int behaviour)
def AutoCompSetCaseInsensitiveBehaviour(*args, **kwargs): """AutoCompSetCaseInsensitiveBehaviour(self, int behaviour)""" return _stc.StyledTextCtrl_AutoCompSetCaseInsensitiveBehaviour(*args, **kwargs)
def AutoCompSetChooseSingle(
*args, **kwargs)
AutoCompSetChooseSingle(self, bool chooseSingle)
Should a single item auto-completion list automatically choose the item.
def AutoCompSetChooseSingle(*args, **kwargs): """ AutoCompSetChooseSingle(self, bool chooseSingle) Should a single item auto-completion list automatically choose the item. """ return _stc.StyledTextCtrl_AutoCompSetChooseSingle(*args, **kwargs)
def AutoCompSetDropRestOfWord(
*args, **kwargs)
AutoCompSetDropRestOfWord(self, bool dropRestOfWord)
Set whether or not autocompletion deletes any word characters after the inserted text upon completion.
def AutoCompSetDropRestOfWord(*args, **kwargs): """ AutoCompSetDropRestOfWord(self, bool dropRestOfWord) Set whether or not autocompletion deletes any word characters after the inserted text upon completion. """ return _stc.StyledTextCtrl_AutoCompSetDropRestOfWord(*args, **kwargs)
def AutoCompSetFillUps(
*args, **kwargs)
AutoCompSetFillUps(self, String characterSet)
Define a set of characters that when typed will cause the autocompletion to choose the selected item.
def AutoCompSetFillUps(*args, **kwargs): """ AutoCompSetFillUps(self, String characterSet) Define a set of characters that when typed will cause the autocompletion to choose the selected item. """ return _stc.StyledTextCtrl_AutoCompSetFillUps(*args, **kwargs)
def AutoCompSetIgnoreCase(
*args, **kwargs)
AutoCompSetIgnoreCase(self, bool ignoreCase)
Set whether case is significant when performing auto-completion searches.
def AutoCompSetIgnoreCase(*args, **kwargs): """ AutoCompSetIgnoreCase(self, bool ignoreCase) Set whether case is significant when performing auto-completion searches. """ return _stc.StyledTextCtrl_AutoCompSetIgnoreCase(*args, **kwargs)
def AutoCompSetMaxHeight(
*args, **kwargs)
AutoCompSetMaxHeight(self, int rowCount)
Set the maximum height, in rows, of auto-completion and user lists. The default is 5 rows.
def AutoCompSetMaxHeight(*args, **kwargs): """ AutoCompSetMaxHeight(self, int rowCount) Set the maximum height, in rows, of auto-completion and user lists. The default is 5 rows. """ return _stc.StyledTextCtrl_AutoCompSetMaxHeight(*args, **kwargs)
def AutoCompSetMaxWidth(
*args, **kwargs)
AutoCompSetMaxWidth(self, int 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.
def AutoCompSetMaxWidth(*args, **kwargs): """ AutoCompSetMaxWidth(self, int 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. """ return _stc.StyledTextCtrl_AutoCompSetMaxWidth(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_AutoCompSetSeparator(*args, **kwargs)
def 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 '?'.
def 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 '?'. """ return _stc.StyledTextCtrl_AutoCompSetTypeSeparator(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_AutoCompShow(*args, **kwargs)
def AutoCompStops(
*args, **kwargs)
AutoCompStops(self, String characterSet)
Define a set of character that when typed cancel the auto-completion list.
def AutoCompStops(*args, **kwargs): """ AutoCompStops(self, String characterSet) Define a set of character that when typed cancel the auto-completion list. """ return _stc.StyledTextCtrl_AutoCompStops(*args, **kwargs)
def AutoComplete(
*args, **kwargs)
AutoComplete(self, wxArrayString choices) -> bool
def AutoComplete(*args, **kwargs): """AutoComplete(self, wxArrayString choices) -> bool""" return _core_.TextEntryBase_AutoComplete(*args, **kwargs)
def AutoCompleteDirectories(
*args, **kwargs)
AutoCompleteDirectories(self) -> bool
def AutoCompleteDirectories(*args, **kwargs): """AutoCompleteDirectories(self) -> bool""" return _core_.TextEntryBase_AutoCompleteDirectories(*args, **kwargs)
def AutoCompleteFileNames(
*args, **kwargs)
AutoCompleteFileNames(self) -> bool
def AutoCompleteFileNames(*args, **kwargs): """AutoCompleteFileNames(self) -> bool""" return _core_.TextEntryBase_AutoCompleteFileNames(*args, **kwargs)
def BackTab(
*args, **kwargs)
BackTab(self)
Dedent the selected lines.
def BackTab(*args, **kwargs): """ BackTab(self) Dedent the selected lines. """ return _stc.StyledTextCtrl_BackTab(*args, **kwargs)
def BeginUndoAction(
*args, **kwargs)
BeginUndoAction(self)
Start a sequence of actions that is undone and redone as a unit. May be nested.
def BeginUndoAction(*args, **kwargs): """ BeginUndoAction(self) Start a sequence of actions that is undone and redone as a unit. May be nested. """ return _stc.StyledTextCtrl_BeginUndoAction(*args, **kwargs)
def Bind(
self, event, handler, source=None, id=-1, id2=-1)
Bind an event to an event handler.
:param event: One of the EVT_* objects that specifies the type of event to bind,
:param handler: A callable object to be invoked when the event is delivered to self. Pass None to disconnect an event handler.
:param source: Sometimes the event originates from a different window than self, but you still want to catch it in self. (For example, a button event delivered to a frame.) By passing the source of the event, the event handling system is able to differentiate between the same event type from different controls.
:param id: Used to spcify the event source by ID instead of instance.
:param id2: Used when it is desirable to bind a handler to a range of IDs, such as with EVT_MENU_RANGE.
def Bind(self, event, handler, source=None, id=wx.ID_ANY, id2=wx.ID_ANY): """ Bind an event to an event handler. :param event: One of the EVT_* objects that specifies the type of event to bind, :param handler: A callable object to be invoked when the event is delivered to self. Pass None to disconnect an event handler. :param source: Sometimes the event originates from a different window than self, but you still want to catch it in self. (For example, a button event delivered to a frame.) By passing the source of the event, the event handling system is able to differentiate between the same event type from different controls. :param id: Used to spcify the event source by ID instead of instance. :param id2: Used when it is desirable to bind a handler to a range of IDs, such as with EVT_MENU_RANGE. """ assert isinstance(event, wx.PyEventBinder) assert handler is None or callable(handler) assert source is None or hasattr(source, 'GetId') if source is not None: id = source.GetId() event.Bind(self, id, id2, handler)
def BraceBadLight(
*args, **kwargs)
BraceBadLight(self, int pos)
Highlight the character at a position indicating there is no matching brace.
def BraceBadLight(*args, **kwargs): """ BraceBadLight(self, int pos) Highlight the character at a position indicating there is no matching brace. """ return _stc.StyledTextCtrl_BraceBadLight(*args, **kwargs)
def BraceBadLightIndicator(
*args, **kwargs)
BraceBadLightIndicator(self, bool useBraceBadLightIndicator, int indicator)
def BraceBadLightIndicator(*args, **kwargs): """BraceBadLightIndicator(self, bool useBraceBadLightIndicator, int indicator)""" return _stc.StyledTextCtrl_BraceBadLightIndicator(*args, **kwargs)
def BraceHighlight(
*args, **kwargs)
BraceHighlight(self, int pos1, int pos2)
Highlight the characters at two positions.
def BraceHighlight(*args, **kwargs): """ BraceHighlight(self, int pos1, int pos2) Highlight the characters at two positions. """ return _stc.StyledTextCtrl_BraceHighlight(*args, **kwargs)
def BraceHighlightIndicator(
*args, **kwargs)
BraceHighlightIndicator(self, bool useBraceHighlightIndicator, int indicator)
def BraceHighlightIndicator(*args, **kwargs): """BraceHighlightIndicator(self, bool useBraceHighlightIndicator, int indicator)""" return _stc.StyledTextCtrl_BraceHighlightIndicator(*args, **kwargs)
def BraceMatch(
*args, **kwargs)
BraceMatch(self, int pos) -> int
Find the position of a matching brace or INVALID_POSITION if no match.
def BraceMatch(*args, **kwargs): """ BraceMatch(self, int pos) -> int Find the position of a matching brace or INVALID_POSITION if no match. """ return _stc.StyledTextCtrl_BraceMatch(*args, **kwargs)
def CacheBestSize(
*args, **kwargs)
CacheBestSize(self, Size size)
Cache the best size so it doesn't need to be calculated again, (at least until some properties of the window change.)
def CacheBestSize(*args, **kwargs): """ CacheBestSize(self, Size size) Cache the best size so it doesn't need to be calculated again, (at least until some properties of the window change.) """ return _core_.Window_CacheBestSize(*args, **kwargs)
def CallTipActive(
*args, **kwargs)
CallTipActive(self) -> bool
Is there an active call tip?
def CallTipActive(*args, **kwargs): """ CallTipActive(self) -> bool Is there an active call tip? """ return _stc.StyledTextCtrl_CallTipActive(*args, **kwargs)
def CallTipCancel(
*args, **kwargs)
CallTipCancel(self)
Remove the call tip from the screen.
def CallTipCancel(*args, **kwargs): """ CallTipCancel(self) Remove the call tip from the screen. """ return _stc.StyledTextCtrl_CallTipCancel(*args, **kwargs)
def CallTipPosAtStart(
*args, **kwargs)
CallTipPosAtStart(self) -> int
Retrieve the position where the caret was before displaying the call tip.
def CallTipPosAtStart(*args, **kwargs): """ CallTipPosAtStart(self) -> int Retrieve the position where the caret was before displaying the call tip. """ return _stc.StyledTextCtrl_CallTipPosAtStart(*args, **kwargs)
def CallTipSetBackground(
*args, **kwargs)
CallTipSetBackground(self, Colour back)
Set the background colour for the call tip.
def CallTipSetBackground(*args, **kwargs): """ CallTipSetBackground(self, Colour back) Set the background colour for the call tip. """ return _stc.StyledTextCtrl_CallTipSetBackground(*args, **kwargs)
def CallTipSetForeground(
*args, **kwargs)
CallTipSetForeground(self, Colour fore)
Set the foreground colour for the call tip.
def CallTipSetForeground(*args, **kwargs): """ CallTipSetForeground(self, Colour fore) Set the foreground colour for the call tip. """ return _stc.StyledTextCtrl_CallTipSetForeground(*args, **kwargs)
def CallTipSetForegroundHighlight(
*args, **kwargs)
CallTipSetForegroundHighlight(self, Colour fore)
Set the foreground colour for the highlighted part of the call tip.
def CallTipSetForegroundHighlight(*args, **kwargs): """ CallTipSetForegroundHighlight(self, Colour fore) Set the foreground colour for the highlighted part of the call tip. """ return _stc.StyledTextCtrl_CallTipSetForegroundHighlight(*args, **kwargs)
def CallTipSetHighlight(
*args, **kwargs)
CallTipSetHighlight(self, int start, int end)
Highlight a segment of the definition.
def CallTipSetHighlight(*args, **kwargs): """ CallTipSetHighlight(self, int start, int end) Highlight a segment of the definition. """ return _stc.StyledTextCtrl_CallTipSetHighlight(*args, **kwargs)
def CallTipSetPosition(
*args, **kwargs)
CallTipSetPosition(self, bool above)
def CallTipSetPosition(*args, **kwargs): """CallTipSetPosition(self, bool above)""" return _stc.StyledTextCtrl_CallTipSetPosition(*args, **kwargs)
def CallTipShow(
*args, **kwargs)
CallTipShow(self, int pos, String definition)
Show a call tip containing a definition near position pos.
def CallTipShow(*args, **kwargs): """ CallTipShow(self, int pos, String definition) Show a call tip containing a definition near position pos. """ return _stc.StyledTextCtrl_CallTipShow(*args, **kwargs)
def CallTipUseStyle(
*args, **kwargs)
CallTipUseStyle(self, int tabSize)
Enable use of STYLE_CALLTIP and set call tip tab size in pixels.
def CallTipUseStyle(*args, **kwargs): """ CallTipUseStyle(self, int tabSize) Enable use of STYLE_CALLTIP and set call tip tab size in pixels. """ return _stc.StyledTextCtrl_CallTipUseStyle(*args, **kwargs)
def CanAcceptFocus(
*args, **kwargs)
CanAcceptFocus(self) -> bool
Can this window have focus right now?
def CanAcceptFocus(*args, **kwargs): """ CanAcceptFocus(self) -> bool Can this window have focus right now? """ return _core_.Window_CanAcceptFocus(*args, **kwargs)
def CanAcceptFocusFromKeyboard(
*args, **kwargs)
CanAcceptFocusFromKeyboard(self) -> bool
Can this window be assigned focus from keyboard right now?
def CanAcceptFocusFromKeyboard(*args, **kwargs): """ CanAcceptFocusFromKeyboard(self) -> bool Can this window be assigned focus from keyboard right now? """ return _core_.Window_CanAcceptFocusFromKeyboard(*args, **kwargs)
def CanApplyThemeBorder(
*args, **kwargs)
CanApplyThemeBorder(self) -> bool
def CanApplyThemeBorder(*args, **kwargs): """CanApplyThemeBorder(self) -> bool""" return _core_.Window_CanApplyThemeBorder(*args, **kwargs)
def CanBeOutsideClientArea(
*args, **kwargs)
CanBeOutsideClientArea(self) -> bool
def CanBeOutsideClientArea(*args, **kwargs): """CanBeOutsideClientArea(self) -> bool""" return _core_.Window_CanBeOutsideClientArea(*args, **kwargs)
def CanCopy(
*args, **kwargs)
CanCopy(self) -> bool
Returns True if the text field has a text selection to copy to the clipboard.
def CanCopy(*args, **kwargs): """ CanCopy(self) -> bool Returns True if the text field has a text selection to copy to the clipboard. """ return _core_.TextEntryBase_CanCopy(*args, **kwargs)
def CanCut(
*args, **kwargs)
CanCut(self) -> bool
Returns True if the text field is editable and there is a text selection to copy to the clipboard.
def CanCut(*args, **kwargs): """ CanCut(self) -> bool Returns True if the text field is editable and there is a text selection to copy to the clipboard. """ return _core_.TextEntryBase_CanCut(*args, **kwargs)
def CanPaste(
*args, **kwargs)
CanPaste(self) -> bool
Returns True if the text field is editable and there is text on the clipboard that can be pasted into the text field.
def CanPaste(*args, **kwargs): """ CanPaste(self) -> bool Returns True if the text field is editable and there is text on the clipboard that can be pasted into the text field. """ return _core_.TextEntryBase_CanPaste(*args, **kwargs)
def CanRedo(
*args, **kwargs)
CanRedo(self) -> bool
Returns True if the text field is editable and the last undo can be redone.
def CanRedo(*args, **kwargs): """ CanRedo(self) -> bool Returns True if the text field is editable and the last undo can be redone. """ return _core_.TextEntryBase_CanRedo(*args, **kwargs)
def CanScroll(
*args, **kwargs)
CanScroll(self, int orient) -> bool
Can the window have the scrollbar in this orientation?
def CanScroll(*args, **kwargs): """ CanScroll(self, int orient) -> bool Can the window have the scrollbar in this orientation? """ return _core_.Window_CanScroll(*args, **kwargs)
def CanSetTransparent(
*args, **kwargs)
CanSetTransparent(self) -> bool
Returns True if the platform supports setting the transparency for
this window. Note that this method will err on the side of caution,
so it is possible that this will return False when it is in fact
possible to set the transparency.
NOTE: On X-windows systems the X server must have the composite extension loaded, and there must be a composite manager program (such as xcompmgr) running.
def CanSetTransparent(*args, **kwargs): """ CanSetTransparent(self) -> bool Returns ``True`` if the platform supports setting the transparency for this window. Note that this method will err on the side of caution, so it is possible that this will return ``False`` when it is in fact possible to set the transparency. NOTE: On X-windows systems the X server must have the composite extension loaded, and there must be a composite manager program (such as xcompmgr) running. """ return _core_.Window_CanSetTransparent(*args, **kwargs)
def CanUndo(
*args, **kwargs)
CanUndo(self) -> bool
Returns True if the text field is editable and the last edit can be undone.
def CanUndo(*args, **kwargs): """ CanUndo(self) -> bool Returns True if the text field is editable and the last edit can be undone. """ return _core_.TextEntryBase_CanUndo(*args, **kwargs)
def Cancel(
*args, **kwargs)
Cancel(self)
Cancel any modes such as call tip or auto-completion list display.
def Cancel(*args, **kwargs): """ Cancel(self) Cancel any modes such as call tip or auto-completion list display. """ return _stc.StyledTextCtrl_Cancel(*args, **kwargs)
def CaptureMouse(
*args, **kwargs)
CaptureMouse(self)
Directs all mouse input to this window. Call wx.Window.ReleaseMouse to release the capture.
Note that wxWindows maintains the stack of windows having captured the
mouse and when the mouse is released the capture returns to the window
which had had captured it previously and it is only really released if
there were no previous window. In particular, this means that you must
release the mouse as many times as you capture it, unless the window
receives the wx.MouseCaptureLostEvent event.
Any application which captures the mouse in the beginning of some
operation must handle wx.MouseCaptureLostEvent and cancel this
operation when it receives the event. The event handler must not
recapture mouse.
def CaptureMouse(*args, **kwargs): """ CaptureMouse(self) Directs all mouse input to this window. Call wx.Window.ReleaseMouse to release the capture. Note that wxWindows maintains the stack of windows having captured the mouse and when the mouse is released the capture returns to the window which had had captured it previously and it is only really released if there were no previous window. In particular, this means that you must release the mouse as many times as you capture it, unless the window receives the `wx.MouseCaptureLostEvent` event. Any application which captures the mouse in the beginning of some operation *must* handle `wx.MouseCaptureLostEvent` and cancel this operation when it receives the event. The event handler must not recapture mouse. """ return _core_.Window_CaptureMouse(*args, **kwargs)
def Center(
*args, **kwargs)
Center(self, int direction=BOTH)
Centers the window. The parameter specifies the direction for centering, and may be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. It may also include wx.CENTER_ON_SCREEN flag if you want to center the window on the entire screen and not on its parent window. If it is a top-level window and has no parent then it will always be centered relative to the screen.
def Center(*args, **kwargs): """ Center(self, int direction=BOTH) Centers the window. The parameter specifies the direction for centering, and may be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. It may also include wx.CENTER_ON_SCREEN flag if you want to center the window on the entire screen and not on its parent window. If it is a top-level window and has no parent then it will always be centered relative to the screen. """ return _core_.Window_Center(*args, **kwargs)
def CenterOnParent(
*args, **kwargs)
CenterOnParent(self, int dir=BOTH)
Center with respect to the the parent window
def CenterOnParent(*args, **kwargs): """ CenterOnParent(self, int dir=BOTH) Center with respect to the the parent window """ return _core_.Window_CenterOnParent(*args, **kwargs)
def Centre(
*args, **kwargs)
Center(self, int direction=BOTH)
Centers the window. The parameter specifies the direction for centering, and may be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. It may also include wx.CENTER_ON_SCREEN flag if you want to center the window on the entire screen and not on its parent window. If it is a top-level window and has no parent then it will always be centered relative to the screen.
def Center(*args, **kwargs): """ Center(self, int direction=BOTH) Centers the window. The parameter specifies the direction for centering, and may be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. It may also include wx.CENTER_ON_SCREEN flag if you want to center the window on the entire screen and not on its parent window. If it is a top-level window and has no parent then it will always be centered relative to the screen. """ return _core_.Window_Center(*args, **kwargs)
def CentreOnParent(
*args, **kwargs)
CenterOnParent(self, int dir=BOTH)
Center with respect to the the parent window
def CenterOnParent(*args, **kwargs): """ CenterOnParent(self, int dir=BOTH) Center with respect to the the parent window """ return _core_.Window_CenterOnParent(*args, **kwargs)
def ChangeLexerState(
*args, **kwargs)
ChangeLexerState(self, int start, int end) -> int
def ChangeLexerState(*args, **kwargs): """ChangeLexerState(self, int start, int end) -> int""" return _stc.StyledTextCtrl_ChangeLexerState(*args, **kwargs)
def ChangeValue(
*args, **kwargs)
ChangeValue(self, String value)
Set the value in the text entry field. Does not generate a text change event.
def ChangeValue(*args, **kwargs): """ ChangeValue(self, String value) Set the value in the text entry field. Does not generate a text change event. """ return _core_.TextEntryBase_ChangeValue(*args, **kwargs)
def CharLeft(
*args, **kwargs)
CharLeft(self)
Move caret left one character.
def CharLeft(*args, **kwargs): """ CharLeft(self) Move caret left one character. """ return _stc.StyledTextCtrl_CharLeft(*args, **kwargs)
def CharLeftExtend(
*args, **kwargs)
CharLeftExtend(self)
Move caret left one character extending selection to new caret position.
def CharLeftExtend(*args, **kwargs): """ CharLeftExtend(self) Move caret left one character extending selection to new caret position. """ return _stc.StyledTextCtrl_CharLeftExtend(*args, **kwargs)
def CharLeftRectExtend(
*args, **kwargs)
CharLeftRectExtend(self)
Move caret left one character, extending rectangular selection to new caret position.
def CharLeftRectExtend(*args, **kwargs): """ CharLeftRectExtend(self) Move caret left one character, extending rectangular selection to new caret position. """ return _stc.StyledTextCtrl_CharLeftRectExtend(*args, **kwargs)
def CharPositionFromPoint(
*args, **kwargs)
CharPositionFromPoint(self, int x, int y) -> int
Find the position of a character from a point within the window.
def CharPositionFromPoint(*args, **kwargs): """ CharPositionFromPoint(self, int x, int y) -> int Find the position of a character from a point within the window. """ return _stc.StyledTextCtrl_CharPositionFromPoint(*args, **kwargs)
def CharPositionFromPointClose(
*args, **kwargs)
CharPositionFromPointClose(self, int x, int y) -> int
Find the position of a character from a point within the window. Return INVALID_POSITION if not close to text.
def CharPositionFromPointClose(*args, **kwargs): """ CharPositionFromPointClose(self, int x, int y) -> int Find the position of a character from a point within the window. Return INVALID_POSITION if not close to text. """ return _stc.StyledTextCtrl_CharPositionFromPointClose(*args, **kwargs)
def CharRight(
*args, **kwargs)
CharRight(self)
Move caret right one character.
def CharRight(*args, **kwargs): """ CharRight(self) Move caret right one character. """ return _stc.StyledTextCtrl_CharRight(*args, **kwargs)
def CharRightExtend(
*args, **kwargs)
CharRightExtend(self)
Move caret right one character extending selection to new caret position.
def CharRightExtend(*args, **kwargs): """ CharRightExtend(self) Move caret right one character extending selection to new caret position. """ return _stc.StyledTextCtrl_CharRightExtend(*args, **kwargs)
def CharRightRectExtend(
*args, **kwargs)
CharRightRectExtend(self)
Move caret right one character, extending rectangular selection to new caret position.
def CharRightRectExtend(*args, **kwargs): """ CharRightRectExtend(self) Move caret right one character, extending rectangular selection to new caret position. """ return _stc.StyledTextCtrl_CharRightRectExtend(*args, **kwargs)
def ChooseCaretX(
*args, **kwargs)
ChooseCaretX(self)
Set the last x chosen value to be the caret x position.
def ChooseCaretX(*args, **kwargs): """ ChooseCaretX(self) Set the last x chosen value to be the caret x position. """ return _stc.StyledTextCtrl_ChooseCaretX(*args, **kwargs)
def Clear(
*args, **kwargs)
Clear(self)
Clear all text from the text field
def Clear(*args, **kwargs): """ Clear(self) Clear all text from the text field """ return _core_.TextEntryBase_Clear(*args, **kwargs)
def ClearAll(
*args, **kwargs)
ClearAll(self)
Delete all text in the document.
def ClearAll(*args, **kwargs): """ ClearAll(self) Delete all text in the document. """ return _stc.StyledTextCtrl_ClearAll(*args, **kwargs)
def ClearBackground(
*args, **kwargs)
ClearBackground(self)
Clears the window by filling it with the current background colour. Does not cause an erase background event to be generated.
def ClearBackground(*args, **kwargs): """ ClearBackground(self) Clears the window by filling it with the current background colour. Does not cause an erase background event to be generated. """ return _core_.Window_ClearBackground(*args, **kwargs)
def ClearDocumentStyle(
*args, **kwargs)
ClearDocumentStyle(self)
Set all style bytes to 0, remove all folding information.
def ClearDocumentStyle(*args, **kwargs): """ ClearDocumentStyle(self) Set all style bytes to 0, remove all folding information. """ return _stc.StyledTextCtrl_ClearDocumentStyle(*args, **kwargs)
def ClearRegisteredImages(
*args, **kwargs)
ClearRegisteredImages(self)
Clear all the registered images.
def ClearRegisteredImages(*args, **kwargs): """ ClearRegisteredImages(self) Clear all the registered images. """ return _stc.StyledTextCtrl_ClearRegisteredImages(*args, **kwargs)
def ClearSelections(
*args, **kwargs)
ClearSelections(self)
Clear selections to a single empty stream selection
def ClearSelections(*args, **kwargs): """ ClearSelections(self) Clear selections to a single empty stream selection """ return _stc.StyledTextCtrl_ClearSelections(*args, **kwargs)
def ClientToScreen(
*args, **kwargs)
ClientToScreen(self, Point pt) -> Point
Converts to screen coordinates from coordinates relative to this window.
def ClientToScreen(*args, **kwargs): """ ClientToScreen(self, Point pt) -> Point Converts to screen coordinates from coordinates relative to this window. """ return _core_.Window_ClientToScreen(*args, **kwargs)
def ClientToScreenXY(
*args, **kwargs)
ClientToScreenXY(int x, int y) -> (x,y)
Converts to screen coordinates from coordinates relative to this window.
def ClientToScreenXY(*args, **kwargs): """ ClientToScreenXY(int x, int y) -> (x,y) Converts to screen coordinates from coordinates relative to this window. """ return _core_.Window_ClientToScreenXY(*args, **kwargs)
def ClientToWindowSize(
*args, **kwargs)
ClientToWindowSize(self, Size size) -> Size
Converts client area size size to corresponding window size. In
other words, the returned value is what `GetSize` would return if this
window had client area of given size. Components withwx.DefaultCoord`` (-1) value are left unchanged.
Note that the conversion is not always exact, it assumes that non-client area doesn't change and so doesn't take into account things like menu bar (un)wrapping or (dis)appearance of the scrollbars.
def ClientToWindowSize(*args, **kwargs): """ ClientToWindowSize(self, Size size) -> Size Converts client area size ``size to corresponding window size. In other words, the returned value is what `GetSize` would return if this window had client area of given size. Components with ``wx.DefaultCoord`` (-1) value are left unchanged. Note that the conversion is not always exact, it assumes that non-client area doesn't change and so doesn't take into account things like menu bar (un)wrapping or (dis)appearance of the scrollbars. """ return _core_.Window_ClientToWindowSize(*args, **kwargs)
def Close(
*args, **kwargs)
Close(self, bool force=False) -> bool
This function simply generates a EVT_CLOSE event whose handler usually tries to close the window. It doesn't close the window itself, however. If force is False (the default) then the window's close handler will be allowed to veto the destruction of the window.
def Close(*args, **kwargs): """ Close(self, bool force=False) -> bool This function simply generates a EVT_CLOSE event whose handler usually tries to close the window. It doesn't close the window itself, however. If force is False (the default) then the window's close handler will be allowed to veto the destruction of the window. """ return _core_.Window_Close(*args, **kwargs)
def CmdKeyAssign(
*args, **kwargs)
CmdKeyAssign(self, int key, int modifiers, int cmd)
When key+modifier combination km is pressed perform msg.
def CmdKeyAssign(*args, **kwargs): """ CmdKeyAssign(self, int key, int modifiers, int cmd) When key+modifier combination km is pressed perform msg. """ return _stc.StyledTextCtrl_CmdKeyAssign(*args, **kwargs)
def CmdKeyClear(
*args, **kwargs)
CmdKeyClear(self, int key, int modifiers)
When key+modifier combination km is pressed do nothing.
def CmdKeyClear(*args, **kwargs): """ CmdKeyClear(self, int key, int modifiers) When key+modifier combination km is pressed do nothing. """ return _stc.StyledTextCtrl_CmdKeyClear(*args, **kwargs)
def CmdKeyClearAll(
*args, **kwargs)
CmdKeyClearAll(self)
Drop all key mappings.
def CmdKeyClearAll(*args, **kwargs): """ CmdKeyClearAll(self) Drop all key mappings. """ return _stc.StyledTextCtrl_CmdKeyClearAll(*args, **kwargs)
def CmdKeyExecute(
*args, **kwargs)
CmdKeyExecute(self, int cmd)
Perform one of the operations defined by the wx.stc.STC_CMD_* constants.
def CmdKeyExecute(*args, **kwargs): """ CmdKeyExecute(self, int cmd) Perform one of the operations defined by the wx.stc.STC_CMD_* constants. """ return _stc.StyledTextCtrl_CmdKeyExecute(*args, **kwargs)
def Colourise(
*args, **kwargs)
Colourise(self, int start, int end)
Colourise a segment of the document using the current lexing language.
def Colourise(*args, **kwargs): """ Colourise(self, int start, int end) Colourise a segment of the document using the current lexing language. """ return _stc.StyledTextCtrl_Colourise(*args, **kwargs)
def Command(
*args, **kwargs)
Command(self, CommandEvent event)
Simulates the effect of the user issuing a command to the item.
:see: wx.CommandEvent
def Command(*args, **kwargs): """ Command(self, CommandEvent event) Simulates the effect of the user issuing a command to the item. :see: `wx.CommandEvent` """ return _core_.Control_Command(*args, **kwargs)
def Connect(
*args, **kwargs)
Connect(self, int id, int lastId, EventType eventType, PyObject func)
def Connect(*args, **kwargs): """Connect(self, int id, int lastId, EventType eventType, PyObject func)""" return _core_.EvtHandler_Connect(*args, **kwargs)
def ContractedFoldNext(
*args, **kwargs)
ContractedFoldNext(self, int lineStart) -> int
def ContractedFoldNext(*args, **kwargs): """ContractedFoldNext(self, int lineStart) -> int""" return _stc.StyledTextCtrl_ContractedFoldNext(*args, **kwargs)
def ConvertDialogPointToPixels(
*args, **kwargs)
ConvertDialogPointToPixels(self, Point pt) -> Point
Converts a point or size from dialog units to pixels. Dialog units are used for maintaining a dialog's proportions even if the font changes. For the x dimension, the dialog units are multiplied by the average character width and then divided by 4. For the y dimension, the dialog units are multiplied by the average character height and then divided by 8.
def ConvertDialogPointToPixels(*args, **kwargs): """ ConvertDialogPointToPixels(self, Point pt) -> Point Converts a point or size from dialog units to pixels. Dialog units are used for maintaining a dialog's proportions even if the font changes. For the x dimension, the dialog units are multiplied by the average character width and then divided by 4. For the y dimension, the dialog units are multiplied by the average character height and then divided by 8. """ return _core_.Window_ConvertDialogPointToPixels(*args, **kwargs)
def ConvertDialogSizeToPixels(
*args, **kwargs)
ConvertDialogSizeToPixels(self, Size sz) -> Size
Converts a point or size from dialog units to pixels. Dialog units are used for maintaining a dialog's proportions even if the font changes. For the x dimension, the dialog units are multiplied by the average character width and then divided by 4. For the y dimension, the dialog units are multiplied by the average character height and then divided by 8.
def ConvertDialogSizeToPixels(*args, **kwargs): """ ConvertDialogSizeToPixels(self, Size sz) -> Size Converts a point or size from dialog units to pixels. Dialog units are used for maintaining a dialog's proportions even if the font changes. For the x dimension, the dialog units are multiplied by the average character width and then divided by 4. For the y dimension, the dialog units are multiplied by the average character height and then divided by 8. """ return _core_.Window_ConvertDialogSizeToPixels(*args, **kwargs)
def ConvertEOLs(
*args, **kwargs)
ConvertEOLs(self, int eolMode)
Convert all line endings in the document to one mode.
def ConvertEOLs(*args, **kwargs): """ ConvertEOLs(self, int eolMode) Convert all line endings in the document to one mode. """ return _stc.StyledTextCtrl_ConvertEOLs(*args, **kwargs)
def ConvertPixelPointToDialog(
*args, **kwargs)
ConvertPixelPointToDialog(self, Point pt) -> Point
def ConvertPixelPointToDialog(*args, **kwargs): """ConvertPixelPointToDialog(self, Point pt) -> Point""" return _core_.Window_ConvertPixelPointToDialog(*args, **kwargs)
def ConvertPixelSizeToDialog(
*args, **kwargs)
ConvertPixelSizeToDialog(self, Size sz) -> Size
def ConvertPixelSizeToDialog(*args, **kwargs): """ConvertPixelSizeToDialog(self, Size sz) -> Size""" return _core_.Window_ConvertPixelSizeToDialog(*args, **kwargs)
def Copy(
*args, **kwargs)
Copy(self)
Copies the selected text to the clipboard.
def Copy(*args, **kwargs): """ Copy(self) Copies the selected text to the clipboard. """ return _core_.TextEntryBase_Copy(*args, **kwargs)
def CopyAllowLine(
*args, **kwargs)
CopyAllowLine(self)
Copy the selection, if selection empty copy the line with the caret
def CopyAllowLine(*args, **kwargs): """ CopyAllowLine(self) Copy the selection, if selection empty copy the line with the caret """ return _stc.StyledTextCtrl_CopyAllowLine(*args, **kwargs)
def CopyRange(
*args, **kwargs)
CopyRange(self, int start, int end)
Copy a range of text to the clipboard. Positions are clipped into the document.
def CopyRange(*args, **kwargs): """ CopyRange(self, int start, int end) Copy a range of text to the clipboard. Positions are clipped into the document. """ return _stc.StyledTextCtrl_CopyRange(*args, **kwargs)
def CopyText(
*args, **kwargs)
CopyText(self, int length, String text)
Copy argument text to the clipboard.
def CopyText(*args, **kwargs): """ CopyText(self, int length, String text) Copy argument text to the clipboard. """ return _stc.StyledTextCtrl_CopyText(*args, **kwargs)
def CountCharacters(
*args, **kwargs)
CountCharacters(self, int startPos, int endPos) -> int
def CountCharacters(*args, **kwargs): """CountCharacters(self, int startPos, int endPos) -> int""" return _stc.StyledTextCtrl_CountCharacters(*args, **kwargs)
def Create(
*args, **kwargs)
Create(self, Window parent, int id=ID_ANY, Point pos=DefaultPosition, Size size=DefaultSize, long style=0, String name=wxSTCNameStr) -> bool
def Create(*args, **kwargs): """ Create(self, Window parent, int id=ID_ANY, Point pos=DefaultPosition, Size size=DefaultSize, long style=0, String name=wxSTCNameStr) -> bool """ return _stc.StyledTextCtrl_Create(*args, **kwargs)
def CreateDocument(
*args, **kwargs)
CreateDocument(self) -> void
Create a new document object. Starts with reference count of 1 and not selected into editor.
def CreateDocument(*args, **kwargs): """ CreateDocument(self) -> void Create a new document object. Starts with reference count of 1 and not selected into editor. """ return _stc.StyledTextCtrl_CreateDocument(*args, **kwargs)
def CreateLoader(
*args, **kwargs)
CreateLoader(self, int bytes) -> void
def CreateLoader(*args, **kwargs): """CreateLoader(self, int bytes) -> void""" return _stc.StyledTextCtrl_CreateLoader(*args, **kwargs)
def Cut(
*args, **kwargs)
Cut(self)
Copies the selected text to the clipboard and removes the selection.
def Cut(*args, **kwargs): """ Cut(self) Copies the selected text to the clipboard and removes the selection. """ return _core_.TextEntryBase_Cut(*args, **kwargs)
def DLG_PNT(
*args, **kwargs)
DLG_PNT(self, Point pt) -> Point
Converts a point or size from dialog units to pixels. Dialog units are used for maintaining a dialog's proportions even if the font changes. For the x dimension, the dialog units are multiplied by the average character width and then divided by 4. For the y dimension, the dialog units are multiplied by the average character height and then divided by 8.
def DLG_PNT(*args, **kwargs): """ DLG_PNT(self, Point pt) -> Point Converts a point or size from dialog units to pixels. Dialog units are used for maintaining a dialog's proportions even if the font changes. For the x dimension, the dialog units are multiplied by the average character width and then divided by 4. For the y dimension, the dialog units are multiplied by the average character height and then divided by 8. """ return _core_.Window_DLG_PNT(*args, **kwargs)
def DLG_SZE(
*args, **kwargs)
DLG_SZE(self, Size sz) -> Size
Converts a point or size from dialog units to pixels. Dialog units are used for maintaining a dialog's proportions even if the font changes. For the x dimension, the dialog units are multiplied by the average character width and then divided by 4. For the y dimension, the dialog units are multiplied by the average character height and then divided by 8.
def DLG_SZE(*args, **kwargs): """ DLG_SZE(self, Size sz) -> Size Converts a point or size from dialog units to pixels. Dialog units are used for maintaining a dialog's proportions even if the font changes. For the x dimension, the dialog units are multiplied by the average character width and then divided by 4. For the y dimension, the dialog units are multiplied by the average character height and then divided by 8. """ return _core_.Window_DLG_SZE(*args, **kwargs)
def DelLineLeft(
*args, **kwargs)
DelLineLeft(self)
Delete back from the current position to the start of the line.
def DelLineLeft(*args, **kwargs): """ DelLineLeft(self) Delete back from the current position to the start of the line. """ return _stc.StyledTextCtrl_DelLineLeft(*args, **kwargs)
def DelLineRight(
*args, **kwargs)
DelLineRight(self)
Delete forwards from the current position to the end of the line.
def DelLineRight(*args, **kwargs): """ DelLineRight(self) Delete forwards from the current position to the end of the line. """ return _stc.StyledTextCtrl_DelLineRight(*args, **kwargs)
def DelWordLeft(
*args, **kwargs)
DelWordLeft(self)
Delete the word to the left of the caret.
def DelWordLeft(*args, **kwargs): """ DelWordLeft(self) Delete the word to the left of the caret. """ return _stc.StyledTextCtrl_DelWordLeft(*args, **kwargs)
def DelWordRight(
*args, **kwargs)
DelWordRight(self)
Delete the word to the right of the caret.
def DelWordRight(*args, **kwargs): """ DelWordRight(self) Delete the word to the right of the caret. """ return _stc.StyledTextCtrl_DelWordRight(*args, **kwargs)
def DelWordRightEnd(
*args, **kwargs)
DelWordRightEnd(self)
Delete the word to the right of the caret, but not the trailing non-word characters.
def DelWordRightEnd(*args, **kwargs): """ DelWordRightEnd(self) Delete the word to the right of the caret, but not the trailing non-word characters. """ return _stc.StyledTextCtrl_DelWordRightEnd(*args, **kwargs)
def DeleteBack(
*args, **kwargs)
DeleteBack(self)
Delete the selection or if no selection, the character before the caret.
def DeleteBack(*args, **kwargs): """ DeleteBack(self) Delete the selection or if no selection, the character before the caret. """ return _stc.StyledTextCtrl_DeleteBack(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_DeleteBackNotLine(*args, **kwargs)
def DeletePendingEvents(
*args, **kwargs)
DeletePendingEvents(self)
def DeletePendingEvents(*args, **kwargs): """DeletePendingEvents(self)""" return _core_.EvtHandler_DeletePendingEvents(*args, **kwargs)
def DeleteRange(
*args, **kwargs)
DeleteRange(self, int pos, int deleteLength)
def DeleteRange(*args, **kwargs): """DeleteRange(self, int pos, int deleteLength)""" return _stc.StyledTextCtrl_DeleteRange(*args, **kwargs)
def DescribeKeyWordSets(
*args, **kwargs)
DescribeKeyWordSets(self) -> String
def DescribeKeyWordSets(*args, **kwargs): """DescribeKeyWordSets(self) -> String""" return _stc.StyledTextCtrl_DescribeKeyWordSets(*args, **kwargs)
def DescribeProperty(
*args, **kwargs)
DescribeProperty(self, String name) -> String
def DescribeProperty(*args, **kwargs): """DescribeProperty(self, String name) -> String""" return _stc.StyledTextCtrl_DescribeProperty(*args, **kwargs)
def Destroy(
*args, **kwargs)
Destroy(self) -> bool
Destroys the window safely. Frames and dialogs are not destroyed immediately when this function is called -- they are added to a list of windows to be deleted on idle time, when all the window's events have been processed. This prevents problems with events being sent to non-existent windows.
Returns True if the window has either been successfully deleted, or it has been added to the list of windows pending real deletion.
def Destroy(*args, **kwargs): """ Destroy(self) -> bool Destroys the window safely. Frames and dialogs are not destroyed immediately when this function is called -- they are added to a list of windows to be deleted on idle time, when all the window's events have been processed. This prevents problems with events being sent to non-existent windows. Returns True if the window has either been successfully deleted, or it has been added to the list of windows pending real deletion. """ args[0].this.own(False) return _core_.Window_Destroy(*args, **kwargs)
def DestroyChildren(
*args, **kwargs)
DestroyChildren(self) -> bool
Destroys all children of a window. Called automatically by the destructor.
def DestroyChildren(*args, **kwargs): """ DestroyChildren(self) -> bool Destroys all children of a window. Called automatically by the destructor. """ return _core_.Window_DestroyChildren(*args, **kwargs)
def Disable(
*args, **kwargs)
Disable(self) -> bool
Disables the window, same as Enable(false).
def Disable(*args, **kwargs): """ Disable(self) -> bool Disables the window, same as Enable(false). """ return _core_.Window_Disable(*args, **kwargs)
def DiscardEdits(
*args, **kwargs)
DiscardEdits(self)
def DiscardEdits(*args, **kwargs): """DiscardEdits(self)""" return _core_.TextAreaBase_DiscardEdits(*args, **kwargs)
def Disconnect(
*args, **kwargs)
Disconnect(self, int id, int lastId=-1, EventType eventType=wxEVT_NULL, PyObject func=None) -> bool
def Disconnect(*args, **kwargs): """ Disconnect(self, int id, int lastId=-1, EventType eventType=wxEVT_NULL, PyObject func=None) -> bool """ return _core_.EvtHandler_Disconnect(*args, **kwargs)
def DissociateHandle(
*args, **kwargs)
DissociateHandle(self)
Dissociate the current native handle from the window
def DissociateHandle(*args, **kwargs): """ DissociateHandle(self) Dissociate the current native handle from the window """ return _core_.Window_DissociateHandle(*args, **kwargs)
def DoDragOver(
*args, **kwargs)
DoDragOver(self, int x, int y, int def) -> int
Allow for simulating a DnD DragOver.
def DoDragOver(*args, **kwargs): """ DoDragOver(self, int x, int y, int def) -> int Allow for simulating a DnD DragOver. """ return _stc.StyledTextCtrl_DoDragOver(*args, **kwargs)
def DoDropText(
*args, **kwargs)
DoDropText(self, long x, long y, String data) -> bool
Allow for simulating a DnD DropText.
def DoDropText(*args, **kwargs): """ DoDropText(self, long x, long y, String data) -> bool Allow for simulating a DnD DropText. """ return _stc.StyledTextCtrl_DoDropText(*args, **kwargs)
def DocLineFromVisible(
*args, **kwargs)
DocLineFromVisible(self, int lineDisplay) -> int
Find the document line of a display line taking hidden lines into account.
def DocLineFromVisible(*args, **kwargs): """ DocLineFromVisible(self, int lineDisplay) -> int Find the document line of a display line taking hidden lines into account. """ return _stc.StyledTextCtrl_DocLineFromVisible(*args, **kwargs)
def DocumentEnd(
*args, **kwargs)
DocumentEnd(self)
Move caret to last position in document.
def DocumentEnd(*args, **kwargs): """ DocumentEnd(self) Move caret to last position in document. """ return _stc.StyledTextCtrl_DocumentEnd(*args, **kwargs)
def DocumentEndExtend(
*args, **kwargs)
DocumentEndExtend(self)
Move caret to last position in document extending selection to new caret position.
def DocumentEndExtend(*args, **kwargs): """ DocumentEndExtend(self) Move caret to last position in document extending selection to new caret position. """ return _stc.StyledTextCtrl_DocumentEndExtend(*args, **kwargs)
def DocumentStart(
*args, **kwargs)
DocumentStart(self)
Move caret to first position in document.
def DocumentStart(*args, **kwargs): """ DocumentStart(self) Move caret to first position in document. """ return _stc.StyledTextCtrl_DocumentStart(*args, **kwargs)
def DocumentStartExtend(
*args, **kwargs)
DocumentStartExtend(self)
Move caret to first position in document extending selection to new caret position.
def DocumentStartExtend(*args, **kwargs): """ DocumentStartExtend(self) Move caret to first position in document extending selection to new caret position. """ return _stc.StyledTextCtrl_DocumentStartExtend(*args, **kwargs)
def DragAcceptFiles(
*args, **kwargs)
DragAcceptFiles(self, bool accept)
Enables or disables eligibility for drop file events, EVT_DROP_FILES.
def DragAcceptFiles(*args, **kwargs): """ DragAcceptFiles(self, bool accept) Enables or disables eligibility for drop file events, EVT_DROP_FILES. """ return _core_.Window_DragAcceptFiles(*args, **kwargs)
def EditToggleOvertype(
*args, **kwargs)
EditToggleOvertype(self)
Switch from insert to overtype mode or the reverse.
def EditToggleOvertype(*args, **kwargs): """ EditToggleOvertype(self) Switch from insert to overtype mode or the reverse. """ return _stc.StyledTextCtrl_EditToggleOvertype(*args, **kwargs)
def EmptyUndoBuffer(
*args, **kwargs)
EmptyUndoBuffer(self)
Delete the undo history.
def EmptyUndoBuffer(*args, **kwargs): """ EmptyUndoBuffer(self) Delete the undo history. """ return _stc.StyledTextCtrl_EmptyUndoBuffer(*args, **kwargs)
def Enable(
*args, **kwargs)
Enable(self, bool enable=True) -> bool
Enable or disable the window for user input. Note that when a parent window is disabled, all of its children are disabled as well and they are reenabled again when the parent is. Returns true if the window has been enabled or disabled, false if nothing was done, i.e. if the window had already been in the specified state.
def Enable(*args, **kwargs): """ Enable(self, bool enable=True) -> bool Enable or disable the window for user input. Note that when a parent window is disabled, all of its children are disabled as well and they are reenabled again when the parent is. Returns true if the window has been enabled or disabled, false if nothing was done, i.e. if the window had already been in the specified state. """ return _core_.Window_Enable(*args, **kwargs)
def EndUndoAction(
*args, **kwargs)
EndUndoAction(self)
End a sequence of actions that is undone and redone as a unit.
def EndUndoAction(*args, **kwargs): """ EndUndoAction(self) End a sequence of actions that is undone and redone as a unit. """ return _stc.StyledTextCtrl_EndUndoAction(*args, **kwargs)
def EnsureCaretVisible(
*args, **kwargs)
EnsureCaretVisible(self)
Ensure the caret is visible.
def EnsureCaretVisible(*args, **kwargs): """ EnsureCaretVisible(self) Ensure the caret is visible. """ return _stc.StyledTextCtrl_EnsureCaretVisible(*args, **kwargs)
def EnsureVisible(
*args, **kwargs)
EnsureVisible(self, int line)
Ensure a particular line is visible by expanding any header line hiding it.
def EnsureVisible(*args, **kwargs): """ EnsureVisible(self, int line) Ensure a particular line is visible by expanding any header line hiding it. """ return _stc.StyledTextCtrl_EnsureVisible(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_EnsureVisibleEnforcePolicy(*args, **kwargs)
def Expand(
self, line, doExpand, force=False, visLevels=0, level=-1)
def Expand(self, line, doExpand, force=False, visLevels=0, level=-1): lastChild = self.GetLastChild(line, level) line = line + 1 while line <= lastChild: if force: if visLevels > 0: self.ShowLines(line, line) else: self.HideLines(line, line) else: if doExpand: self.ShowLines(line, line) if level == -1: level = self.GetFoldLevel(line) if level & stc.STC_FOLDLEVELHEADERFLAG: if force: if visLevels > 1: self.SetFoldExpanded(line, True) else: self.SetFoldExpanded(line, False) line = self.Expand(line, doExpand, force, visLevels-1) else: if doExpand and self.GetFoldExpanded(line): line = self.Expand(line, True, force, visLevels-1) else: line = self.Expand(line, False, force, visLevels-1) else: line = line + 1 return line
def 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.
def 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. """ return _stc.StyledTextCtrl_FindColumn(*args, **kwargs)
def FindText(
*args, **kwargs)
FindText(self, int minPos, int maxPos, String text, int flags=0) -> int
Find some text in the document.
def FindText(*args, **kwargs): """ FindText(self, int minPos, int maxPos, String text, int flags=0) -> int Find some text in the document. """ return _stc.StyledTextCtrl_FindText(*args, **kwargs)
def FindWindowById(
*args, **kwargs)
FindWindowById(self, long winid) -> Window
Find a child of this window by window ID
def FindWindowById(*args, **kwargs): """ FindWindowById(self, long winid) -> Window Find a child of this window by window ID """ return _core_.Window_FindWindowById(*args, **kwargs)
def FindWindowByLabel(
*args, **kwargs)
FindWindowByLabel(self, String label) -> Window
Find a child of this window by label
def FindWindowByLabel(*args, **kwargs): """ FindWindowByLabel(self, String label) -> Window Find a child of this window by label """ return _core_.Window_FindWindowByLabel(*args, **kwargs)
def FindWindowByName(
*args, **kwargs)
FindWindowByName(self, String name) -> Window
Find a child of this window by name
def FindWindowByName(*args, **kwargs): """ FindWindowByName(self, String name) -> Window Find a child of this window by name """ return _core_.Window_FindWindowByName(*args, **kwargs)
def Fit(
*args, **kwargs)
Fit(self)
Sizes the window so that it fits around its subwindows. This function won't do anything if there are no subwindows and will only really work correctly if sizers are used for the subwindows layout. Also, if the window has exactly one subwindow it is better (faster and the result is more precise as Fit adds some margin to account for fuzziness of its calculations) to call window.SetClientSize(child.GetSize()) instead of calling Fit.
def Fit(*args, **kwargs): """ Fit(self) Sizes the window so that it fits around its subwindows. This function won't do anything if there are no subwindows and will only really work correctly if sizers are used for the subwindows layout. Also, if the window has exactly one subwindow it is better (faster and the result is more precise as Fit adds some margin to account for fuzziness of its calculations) to call window.SetClientSize(child.GetSize()) instead of calling Fit. """ return _core_.Window_Fit(*args, **kwargs)
def FitInside(
*args, **kwargs)
FitInside(self)
Similar to Fit, but sizes the interior (virtual) size of a window. Mainly useful with scrolled windows to reset scrollbars after sizing changes that do not trigger a size event, and/or scrolled windows without an interior sizer. This function similarly won't do anything if there are no subwindows.
def FitInside(*args, **kwargs): """ FitInside(self) Similar to Fit, but sizes the interior (virtual) size of a window. Mainly useful with scrolled windows to reset scrollbars after sizing changes that do not trigger a size event, and/or scrolled windows without an interior sizer. This function similarly won't do anything if there are no subwindows. """ return _core_.Window_FitInside(*args, **kwargs)
def FoldAll(
self)
def FoldAll(self): lineCount = self.GetLineCount() expanding = True # find out if we are folding or unfolding for lineNum in range(lineCount): if self.GetFoldLevel(lineNum) & stc.STC_FOLDLEVELHEADERFLAG: expanding = not self.GetFoldExpanded(lineNum) break lineNum = 0 while lineNum < lineCount: level = self.GetFoldLevel(lineNum) if level & stc.STC_FOLDLEVELHEADERFLAG and \ (level & stc.STC_FOLDLEVELNUMBERMASK) == stc.STC_FOLDLEVELBASE: if expanding: self.SetFoldExpanded(lineNum, True) lineNum = self.Expand(lineNum, True) lineNum = lineNum - 1 else: lastChild = self.GetLastChild(lineNum, -1) self.SetFoldExpanded(lineNum, False) if lastChild > lineNum: self.HideLines(lineNum+1, lastChild) lineNum = lineNum + 1
def FormFeed(
*args, **kwargs)
FormFeed(self)
Insert a Form Feed character.
def FormFeed(*args, **kwargs): """ FormFeed(self) Insert a Form Feed character. """ return _stc.StyledTextCtrl_FormFeed(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_FormatRange(*args, **kwargs)
def Freeze(
*args, **kwargs)
Freeze(self)
Freezes the window or, in other words, prevents any updates from taking place on screen, the window is not redrawn at all. Thaw must be called to reenable window redrawing. Calls to Freeze/Thaw may be nested, with the actual Thaw being delayed until all the nesting has been undone.
This method is useful for visual appearance optimization (for example, it is a good idea to use it before inserting large amount of text into a wxTextCtrl under wxGTK) but is not implemented on all platforms nor for all controls so it is mostly just a hint to wxWindows and not a mandatory directive.
def Freeze(*args, **kwargs): """ Freeze(self) Freezes the window or, in other words, prevents any updates from taking place on screen, the window is not redrawn at all. Thaw must be called to reenable window redrawing. Calls to Freeze/Thaw may be nested, with the actual Thaw being delayed until all the nesting has been undone. This method is useful for visual appearance optimization (for example, it is a good idea to use it before inserting large amount of text into a wxTextCtrl under wxGTK) but is not implemented on all platforms nor for all controls so it is mostly just a hint to wxWindows and not a mandatory directive. """ return _core_.Window_Freeze(*args, **kwargs)
def GetAcceleratorTable(
*args, **kwargs)
GetAcceleratorTable(self) -> AcceleratorTable
Gets the accelerator table for this window.
def GetAcceleratorTable(*args, **kwargs): """ GetAcceleratorTable(self) -> AcceleratorTable Gets the accelerator table for this window. """ return _core_.Window_GetAcceleratorTable(*args, **kwargs)
def GetAdditionalCaretForeground(
*args, **kwargs)
GetAdditionalCaretForeground(self) -> Colour
Get the foreground colour of additional carets.
def GetAdditionalCaretForeground(*args, **kwargs): """ GetAdditionalCaretForeground(self) -> Colour Get the foreground colour of additional carets. """ return _stc.StyledTextCtrl_GetAdditionalCaretForeground(*args, **kwargs)
def GetAdditionalCaretsBlink(
*args, **kwargs)
GetAdditionalCaretsBlink(self) -> bool
Whether additional carets will blink
def GetAdditionalCaretsBlink(*args, **kwargs): """ GetAdditionalCaretsBlink(self) -> bool Whether additional carets will blink """ return _stc.StyledTextCtrl_GetAdditionalCaretsBlink(*args, **kwargs)
def GetAdditionalCaretsVisible(
*args, **kwargs)
GetAdditionalCaretsVisible(self) -> bool
Whether additional carets are visible
def GetAdditionalCaretsVisible(*args, **kwargs): """ GetAdditionalCaretsVisible(self) -> bool Whether additional carets are visible """ return _stc.StyledTextCtrl_GetAdditionalCaretsVisible(*args, **kwargs)
def GetAdditionalSelAlpha(
*args, **kwargs)
GetAdditionalSelAlpha(self) -> int
Get the alpha of the selection.
def GetAdditionalSelAlpha(*args, **kwargs): """ GetAdditionalSelAlpha(self) -> int Get the alpha of the selection. """ return _stc.StyledTextCtrl_GetAdditionalSelAlpha(*args, **kwargs)
def GetAdditionalSelectionTyping(
*args, **kwargs)
GetAdditionalSelectionTyping(self) -> bool
Whether typing can be performed into multiple selections
def GetAdditionalSelectionTyping(*args, **kwargs): """ GetAdditionalSelectionTyping(self) -> bool Whether typing can be performed into multiple selections """ return _stc.StyledTextCtrl_GetAdditionalSelectionTyping(*args, **kwargs)
def GetAdjustedBestSize(
*args, **kw)
def deprecated_func(*args, **kw): warnings.warn("Call to deprecated item. %s" % msg, wxPyDeprecationWarning, stacklevel=2) return item(*args, **kw)
def GetAlignment(
*args, **kwargs)
GetAlignment(self) -> int
Get the control alignment (left/right/centre, top/bottom/centre)
def GetAlignment(*args, **kwargs): """ GetAlignment(self) -> int Get the control alignment (left/right/centre, top/bottom/centre) """ return _core_.Control_GetAlignment(*args, **kwargs)
def GetAllLinesVisible(
*args, **kwargs)
GetAllLinesVisible(self) -> bool
def GetAllLinesVisible(*args, **kwargs): """GetAllLinesVisible(self) -> bool""" return _stc.StyledTextCtrl_GetAllLinesVisible(*args, **kwargs)
def GetAnchor(
*args, **kwargs)
GetAnchor(self) -> int
Returns the position of the opposite end of the selection to the caret.
def GetAnchor(*args, **kwargs): """ GetAnchor(self) -> int Returns the position of the opposite end of the selection to the caret. """ return _stc.StyledTextCtrl_GetAnchor(*args, **kwargs)
def GetAutoLayout(
*args, **kwargs)
GetAutoLayout(self) -> bool
Returns the current autoLayout setting
def GetAutoLayout(*args, **kwargs): """ GetAutoLayout(self) -> bool Returns the current autoLayout setting """ return _core_.Window_GetAutoLayout(*args, **kwargs)
def GetBackSpaceUnIndents(
*args, **kwargs)
GetBackSpaceUnIndents(self) -> bool
Does a backspace pressed when caret is within indentation unindent?
def GetBackSpaceUnIndents(*args, **kwargs): """ GetBackSpaceUnIndents(self) -> bool Does a backspace pressed when caret is within indentation unindent? """ return _stc.StyledTextCtrl_GetBackSpaceUnIndents(*args, **kwargs)
def GetBackgroundColour(
*args, **kwargs)
GetBackgroundColour(self) -> Colour
Returns the background colour of the window.
def GetBackgroundColour(*args, **kwargs): """ GetBackgroundColour(self) -> Colour Returns the background colour of the window. """ return _core_.Window_GetBackgroundColour(*args, **kwargs)
def GetBackgroundStyle(
*args, **kwargs)
GetBackgroundStyle(self) -> int
Returns the background style of the window.
:see: SetBackgroundStyle
def GetBackgroundStyle(*args, **kwargs): """ GetBackgroundStyle(self) -> int Returns the background style of the window. :see: `SetBackgroundStyle` """ return _core_.Window_GetBackgroundStyle(*args, **kwargs)
def GetBestFittingSize(
*args, **kw)
GetEffectiveMinSize(self) -> Size
This function will merge the window's best size into the window's minimum size, giving priority to the min size components, and returns the results.
def deprecated_func(*args, **kw): warnings.warn("Call to deprecated item. %s" % msg, wxPyDeprecationWarning, stacklevel=2) return item(*args, **kw)
def GetBestSize(
*args, **kwargs)
GetBestSize(self) -> Size
This function returns the best acceptable minimal size for the window, if applicable. For example, for a static text control, it will be the minimal size such that the control label is not truncated. For windows containing subwindows (such as wx.Panel), the size returned by this function will be the same as the size the window would have had after calling Fit.
def GetBestSize(*args, **kwargs): """ GetBestSize(self) -> Size This function returns the best acceptable minimal size for the window, if applicable. For example, for a static text control, it will be the minimal size such that the control label is not truncated. For windows containing subwindows (such as wx.Panel), the size returned by this function will be the same as the size the window would have had after calling Fit. """ return _core_.Window_GetBestSize(*args, **kwargs)
def GetBestSizeTuple(
*args, **kwargs)
GetBestSizeTuple() -> (width, height)
This function returns the best acceptable minimal size for the window, if applicable. For example, for a static text control, it will be the minimal size such that the control label is not truncated. For windows containing subwindows (such as wx.Panel), the size returned by this function will be the same as the size the window would have had after calling Fit.
def GetBestSizeTuple(*args, **kwargs): """ GetBestSizeTuple() -> (width, height) This function returns the best acceptable minimal size for the window, if applicable. For example, for a static text control, it will be the minimal size such that the control label is not truncated. For windows containing subwindows (such as wx.Panel), the size returned by this function will be the same as the size the window would have had after calling Fit. """ return _core_.Window_GetBestSizeTuple(*args, **kwargs)
def GetBestVirtualSize(
*args, **kwargs)
GetBestVirtualSize(self) -> Size
Return the largest of ClientSize and BestSize (as determined by a sizer, interior children, or other means)
def GetBestVirtualSize(*args, **kwargs): """ GetBestVirtualSize(self) -> Size Return the largest of ClientSize and BestSize (as determined by a sizer, interior children, or other means) """ return _core_.Window_GetBestVirtualSize(*args, **kwargs)
def GetBorder(
*args)
GetBorder(self, long flags) -> int GetBorder(self) -> int
Get border for the flags of this window
def GetBorder(*args): """ GetBorder(self, long flags) -> int GetBorder(self) -> int Get border for the flags of this window """ return _core_.Window_GetBorder(*args)
def GetBufferedDraw(
*args, **kwargs)
GetBufferedDraw(self) -> bool
Is drawing done first into a buffer or direct to the screen?
def GetBufferedDraw(*args, **kwargs): """ GetBufferedDraw(self) -> bool Is drawing done first into a buffer or direct to the screen? """ return _stc.StyledTextCtrl_GetBufferedDraw(*args, **kwargs)
def GetCaret(
*args, **kwargs)
GetCaret(self) -> Caret
Returns the caret associated with the window.
def GetCaret(*args, **kwargs): """ GetCaret(self) -> Caret Returns the caret associated with the window. """ return _core_.Window_GetCaret(*args, **kwargs)
def GetCaretForeground(
*args, **kwargs)
GetCaretForeground(self) -> Colour
Get the foreground colour of the caret.
def GetCaretForeground(*args, **kwargs): """ GetCaretForeground(self) -> Colour Get the foreground colour of the caret. """ return _stc.StyledTextCtrl_GetCaretForeground(*args, **kwargs)
def GetCaretLineBack(
*args, **kwargs)
GetCaretLineBackground(self) -> Colour
Get the colour of the background of the line containing the caret.
def GetCaretLineBackground(*args, **kwargs): """ GetCaretLineBackground(self) -> Colour Get the colour of the background of the line containing the caret. """ return _stc.StyledTextCtrl_GetCaretLineBackground(*args, **kwargs)
def GetCaretLineBackAlpha(
*args, **kwargs)
GetCaretLineBackAlpha(self) -> int
Get the background alpha of the caret line.
def GetCaretLineBackAlpha(*args, **kwargs): """ GetCaretLineBackAlpha(self) -> int Get the background alpha of the caret line. """ return _stc.StyledTextCtrl_GetCaretLineBackAlpha(*args, **kwargs)
def GetCaretLineBackground(
*args, **kwargs)
GetCaretLineBackground(self) -> Colour
Get the colour of the background of the line containing the caret.
def GetCaretLineBackground(*args, **kwargs): """ GetCaretLineBackground(self) -> Colour Get the colour of the background of the line containing the caret. """ return _stc.StyledTextCtrl_GetCaretLineBackground(*args, **kwargs)
def GetCaretLineVisible(
*args, **kwargs)
GetCaretLineVisible(self) -> bool
Is the background of the line containing the caret in a different colour?
def GetCaretLineVisible(*args, **kwargs): """ GetCaretLineVisible(self) -> bool Is the background of the line containing the caret in a different colour? """ return _stc.StyledTextCtrl_GetCaretLineVisible(*args, **kwargs)
def GetCaretPeriod(
*args, **kwargs)
GetCaretPeriod(self) -> int
Get the time in milliseconds that the caret is on and off.
def GetCaretPeriod(*args, **kwargs): """ GetCaretPeriod(self) -> int Get the time in milliseconds that the caret is on and off. """ return _stc.StyledTextCtrl_GetCaretPeriod(*args, **kwargs)
def GetCaretSticky(
*args, **kwargs)
GetCaretSticky(self) -> int
Can the caret preferred x position only be changed by explicit movement commands?
def GetCaretSticky(*args, **kwargs): """ GetCaretSticky(self) -> int Can the caret preferred x position only be changed by explicit movement commands? """ return _stc.StyledTextCtrl_GetCaretSticky(*args, **kwargs)
def GetCaretStyle(
*args, **kwargs)
GetCaretStyle(self) -> int
Returns the current style of the caret.
def GetCaretStyle(*args, **kwargs): """ GetCaretStyle(self) -> int Returns the current style of the caret. """ return _stc.StyledTextCtrl_GetCaretStyle(*args, **kwargs)
def GetCaretWidth(
*args, **kwargs)
GetCaretWidth(self) -> int
Returns the width of the insert mode caret.
def GetCaretWidth(*args, **kwargs): """ GetCaretWidth(self) -> int Returns the width of the insert mode caret. """ return _stc.StyledTextCtrl_GetCaretWidth(*args, **kwargs)
def GetCharAt(
*args, **kwargs)
GetCharAt(self, int pos) -> int
Returns the character byte at the position.
def GetCharAt(*args, **kwargs): """ GetCharAt(self, int pos) -> int Returns the character byte at the position. """ return _stc.StyledTextCtrl_GetCharAt(*args, **kwargs)
def GetCharHeight(
*args, **kwargs)
GetCharHeight(self) -> int
Get the (average) character size for the current font.
def GetCharHeight(*args, **kwargs): """ GetCharHeight(self) -> int Get the (average) character size for the current font. """ return _core_.Window_GetCharHeight(*args, **kwargs)
def GetCharWidth(
*args, **kwargs)
GetCharWidth(self) -> int
Get the (average) character size for the current font.
def GetCharWidth(*args, **kwargs): """ GetCharWidth(self) -> int Get the (average) character size for the current font. """ return _core_.Window_GetCharWidth(*args, **kwargs)
def GetChildren(
*args, **kwargs)
GetChildren(self) -> WindowList
Returns an object containing a list of the window's children. The object provides a Python sequence-like interface over the internal list maintained by the window..
def GetChildren(*args, **kwargs): """ GetChildren(self) -> WindowList Returns an object containing a list of the window's children. The object provides a Python sequence-like interface over the internal list maintained by the window.. """ return _core_.Window_GetChildren(*args, **kwargs)
def GetClassName(
*args, **kwargs)
GetClassName(self) -> String
Returns the class name of the C++ class using wxRTTI.
def GetClassName(*args, **kwargs): """ GetClassName(self) -> String Returns the class name of the C++ class using wxRTTI. """ return _core_.Object_GetClassName(*args, **kwargs)
def GetClientAreaOrigin(
*args, **kwargs)
GetClientAreaOrigin(self) -> Point
Get the origin of the client area of the window relative to the window's top left corner (the client area may be shifted because of the borders, scrollbars, other decorations...)
def GetClientAreaOrigin(*args, **kwargs): """ GetClientAreaOrigin(self) -> Point Get the origin of the client area of the window relative to the window's top left corner (the client area may be shifted because of the borders, scrollbars, other decorations...) """ return _core_.Window_GetClientAreaOrigin(*args, **kwargs)
def GetClientRect(
*args, **kwargs)
GetClientRect(self) -> Rect
Get the client area position and size as a wx.Rect object.
def GetClientRect(*args, **kwargs): """ GetClientRect(self) -> Rect Get the client area position and size as a `wx.Rect` object. """ return _core_.Window_GetClientRect(*args, **kwargs)
def GetClientSize(
*args, **kwargs)
GetClientSize(self) -> Size
This gets the size of the window's 'client area' in pixels. The client area is the area which may be drawn on by the programmer, excluding title bar, border, scrollbars, etc.
def GetClientSize(*args, **kwargs): """ GetClientSize(self) -> Size This gets the size of the window's 'client area' in pixels. The client area is the area which may be drawn on by the programmer, excluding title bar, border, scrollbars, etc. """ return _core_.Window_GetClientSize(*args, **kwargs)
def GetClientSizeTuple(
*args, **kwargs)
GetClientSizeTuple() -> (width, height)
This gets the size of the window's 'client area' in pixels. The client area is the area which may be drawn on by the programmer, excluding title bar, border, scrollbars, etc.
def GetClientSizeTuple(*args, **kwargs): """ GetClientSizeTuple() -> (width, height) This gets the size of the window's 'client area' in pixels. The client area is the area which may be drawn on by the programmer, excluding title bar, border, scrollbars, etc. """ return _core_.Window_GetClientSizeTuple(*args, **kwargs)
def GetCodePage(
*args, **kwargs)
GetCodePage(self) -> int
Get the code page used to interpret the bytes of the document as characters.
def GetCodePage(*args, **kwargs): """ GetCodePage(self) -> int Get the code page used to interpret the bytes of the document as characters. """ return _stc.StyledTextCtrl_GetCodePage(*args, **kwargs)
def GetColumn(
*args, **kwargs)
GetColumn(self, int pos) -> int
Retrieve the column number of a position, taking tab width into account.
def GetColumn(*args, **kwargs): """ GetColumn(self, int pos) -> int Retrieve the column number of a position, taking tab width into account. """ return _stc.StyledTextCtrl_GetColumn(*args, **kwargs)
def GetConstraints(
*args, **kwargs)
GetConstraints(self) -> LayoutConstraints
Returns a pointer to the window's layout constraints, or None if there are none.
def GetConstraints(*args, **kwargs): """ GetConstraints(self) -> LayoutConstraints Returns a pointer to the window's layout constraints, or None if there are none. """ return _core_.Window_GetConstraints(*args, **kwargs)
def GetContainingSizer(
*args, **kwargs)
GetContainingSizer(self) -> Sizer
Return the sizer that this window is a member of, if any, otherwise None.
def GetContainingSizer(*args, **kwargs): """ GetContainingSizer(self) -> Sizer Return the sizer that this window is a member of, if any, otherwise None. """ return _core_.Window_GetContainingSizer(*args, **kwargs)
def GetControlCharSymbol(
*args, **kwargs)
GetControlCharSymbol(self) -> int
Get the way control characters are displayed.
def GetControlCharSymbol(*args, **kwargs): """ GetControlCharSymbol(self) -> int Get the way control characters are displayed. """ return _stc.StyledTextCtrl_GetControlCharSymbol(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_GetCurLine(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_GetCurLineRaw(*args, **kwargs)
def GetCurLineUTF8(
self)
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.
def GetCurLineUTF8(self): """ 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. """ text, pos = self.GetCurLineRaw() if not wx.USE_UNICODE: u = text.decode(wx.GetDefaultPyEncoding()) text = u.encode('utf-8') return text, pos
def GetCurrentLine(
*args, **kwargs)
GetCurrentLine(self) -> int
Returns the line number of the line with the caret.
def GetCurrentLine(*args, **kwargs): """ GetCurrentLine(self) -> int Returns the line number of the line with the caret. """ return _stc.StyledTextCtrl_GetCurrentLine(*args, **kwargs)
def GetCurrentPos(
*args, **kwargs)
GetCurrentPos(self) -> int
Returns the position of the caret.
def GetCurrentPos(*args, **kwargs): """ GetCurrentPos(self) -> int Returns the position of the caret. """ return _stc.StyledTextCtrl_GetCurrentPos(*args, **kwargs)
def GetCursor(
*args, **kwargs)
GetCursor(self) -> Cursor
Return the cursor associated with this window.
def GetCursor(*args, **kwargs): """ GetCursor(self) -> Cursor Return the cursor associated with this window. """ return _core_.Window_GetCursor(*args, **kwargs)
def GetDefaultAttributes(
*args, **kwargs)
GetDefaultAttributes(self) -> VisualAttributes
Get the default attributes for an instance of this class. This is useful if you want to use the same font or colour in your own control as in a standard control -- which is a much better idea than hard coding specific colours or fonts which might look completely out of place on the user's system, especially if it uses themes.
def GetDefaultAttributes(*args, **kwargs): """ GetDefaultAttributes(self) -> VisualAttributes Get the default attributes for an instance of this class. This is useful if you want to use the same font or colour in your own control as in a standard control -- which is a much better idea than hard coding specific colours or fonts which might look completely out of place on the user's system, especially if it uses themes. """ return _core_.Window_GetDefaultAttributes(*args, **kwargs)
def GetDefaultStyle(
*args, **kwargs)
GetDefaultStyle(self) -> wxTextAttr
def GetDefaultStyle(*args, **kwargs): """GetDefaultStyle(self) -> wxTextAttr""" return _core_.TextAreaBase_GetDefaultStyle(*args, **kwargs)
def GetDocPointer(
*args, **kwargs)
GetDocPointer(self) -> void
Retrieve a pointer to the document object.
def GetDocPointer(*args, **kwargs): """ GetDocPointer(self) -> void Retrieve a pointer to the document object. """ return _stc.StyledTextCtrl_GetDocPointer(*args, **kwargs)
def GetDropTarget(
*args, **kwargs)
GetDropTarget(self) -> DropTarget
Returns the associated drop target, which may be None.
def GetDropTarget(*args, **kwargs): """ GetDropTarget(self) -> DropTarget Returns the associated drop target, which may be None. """ return _core_.Window_GetDropTarget(*args, **kwargs)
def GetEOLMode(
*args, **kwargs)
GetEOLMode(self) -> int
Retrieve the current end of line mode - one of CRLF, CR, or LF.
def GetEOLMode(*args, **kwargs): """ GetEOLMode(self) -> int Retrieve the current end of line mode - one of CRLF, CR, or LF. """ return _stc.StyledTextCtrl_GetEOLMode(*args, **kwargs)
def GetEdgeColour(
*args, **kwargs)
GetEdgeColour(self) -> Colour
Retrieve the colour used in edge indication.
def GetEdgeColour(*args, **kwargs): """ GetEdgeColour(self) -> Colour Retrieve the colour used in edge indication. """ return _stc.StyledTextCtrl_GetEdgeColour(*args, **kwargs)
def GetEdgeColumn(
*args, **kwargs)
GetEdgeColumn(self) -> int
Retrieve the column number which text should be kept within.
def GetEdgeColumn(*args, **kwargs): """ GetEdgeColumn(self) -> int Retrieve the column number which text should be kept within. """ return _stc.StyledTextCtrl_GetEdgeColumn(*args, **kwargs)
def GetEdgeMode(
*args, **kwargs)
GetEdgeMode(self) -> int
Retrieve the edge highlight mode.
def GetEdgeMode(*args, **kwargs): """ GetEdgeMode(self) -> int Retrieve the edge highlight mode. """ return _stc.StyledTextCtrl_GetEdgeMode(*args, **kwargs)
def GetEffectiveMinSize(
*args, **kwargs)
GetEffectiveMinSize(self) -> Size
This function will merge the window's best size into the window's minimum size, giving priority to the min size components, and returns the results.
def GetEffectiveMinSize(*args, **kwargs): """ GetEffectiveMinSize(self) -> Size This function will merge the window's best size into the window's minimum size, giving priority to the min size components, and returns the results. """ return _core_.Window_GetEffectiveMinSize(*args, **kwargs)
def GetEndAtLastLine(
*args, **kwargs)
GetEndAtLastLine(self) -> bool
Retrieve whether the maximum scroll position has the last line at the bottom of the view.
def GetEndAtLastLine(*args, **kwargs): """ GetEndAtLastLine(self) -> bool Retrieve whether the maximum scroll position has the last line at the bottom of the view. """ return _stc.StyledTextCtrl_GetEndAtLastLine(*args, **kwargs)
def GetEndStyled(
*args, **kwargs)
GetEndStyled(self) -> int
Retrieve the position of the last correctly styled character.
def GetEndStyled(*args, **kwargs): """ GetEndStyled(self) -> int Retrieve the position of the last correctly styled character. """ return _stc.StyledTextCtrl_GetEndStyled(*args, **kwargs)
def GetEventHandler(
*args, **kwargs)
GetEventHandler(self) -> EvtHandler
Returns the event handler for this window. By default, the window is its own event handler.
def GetEventHandler(*args, **kwargs): """ GetEventHandler(self) -> EvtHandler Returns the event handler for this window. By default, the window is its own event handler. """ return _core_.Window_GetEventHandler(*args, **kwargs)
def GetEvtHandlerEnabled(
*args, **kwargs)
GetEvtHandlerEnabled(self) -> bool
def GetEvtHandlerEnabled(*args, **kwargs): """GetEvtHandlerEnabled(self) -> bool""" return _core_.EvtHandler_GetEvtHandlerEnabled(*args, **kwargs)
def GetExtraAscent(
*args, **kwargs)
GetExtraAscent(self) -> int
Get extra ascent for each line
def GetExtraAscent(*args, **kwargs): """ GetExtraAscent(self) -> int Get extra ascent for each line """ return _stc.StyledTextCtrl_GetExtraAscent(*args, **kwargs)
def GetExtraDescent(
*args, **kwargs)
GetExtraDescent(self) -> int
Get extra descent for each line
def GetExtraDescent(*args, **kwargs): """ GetExtraDescent(self) -> int Get extra descent for each line """ return _stc.StyledTextCtrl_GetExtraDescent(*args, **kwargs)
def GetExtraStyle(
*args, **kwargs)
GetExtraStyle(self) -> long
Returns the extra style bits for the window.
def GetExtraStyle(*args, **kwargs): """ GetExtraStyle(self) -> long Returns the extra style bits for the window. """ return _core_.Window_GetExtraStyle(*args, **kwargs)
def GetFirstVisibleLine(
*args, **kwargs)
GetFirstVisibleLine(self) -> int
Retrieve the display line at the top of the display.
def GetFirstVisibleLine(*args, **kwargs): """ GetFirstVisibleLine(self) -> int Retrieve the display line at the top of the display. """ return _stc.StyledTextCtrl_GetFirstVisibleLine(*args, **kwargs)
def GetFoldExpanded(
*args, **kwargs)
GetFoldExpanded(self, int line) -> bool
Is a header line expanded?
def GetFoldExpanded(*args, **kwargs): """ GetFoldExpanded(self, int line) -> bool Is a header line expanded? """ return _stc.StyledTextCtrl_GetFoldExpanded(*args, **kwargs)
def GetFoldLevel(
*args, **kwargs)
GetFoldLevel(self, int line) -> int
Retrieve the fold level of a line.
def GetFoldLevel(*args, **kwargs): """ GetFoldLevel(self, int line) -> int Retrieve the fold level of a line. """ return _stc.StyledTextCtrl_GetFoldLevel(*args, **kwargs)
def GetFoldParent(
*args, **kwargs)
GetFoldParent(self, int line) -> int
Find the parent line of a child line.
def GetFoldParent(*args, **kwargs): """ GetFoldParent(self, int line) -> int Find the parent line of a child line. """ return _stc.StyledTextCtrl_GetFoldParent(*args, **kwargs)
def GetFont(
*args, **kwargs)
GetFont(self) -> Font
Returns the default font used for this window.
def GetFont(*args, **kwargs): """ GetFont(self) -> Font Returns the default font used for this window. """ return _core_.Window_GetFont(*args, **kwargs)
def GetForegroundColour(
*args, **kwargs)
GetForegroundColour(self) -> Colour
Returns the foreground colour of the window. The interpretation of foreground colour is dependent on the window class; it may be the text colour or other colour, or it may not be used at all.
def GetForegroundColour(*args, **kwargs): """ GetForegroundColour(self) -> Colour Returns the foreground colour of the window. The interpretation of foreground colour is dependent on the window class; it may be the text colour or other colour, or it may not be used at all. """ return _core_.Window_GetForegroundColour(*args, **kwargs)
def GetFullTextExtent(
*args, **kwargs)
GetFullTextExtent(String string, Font font=None) -> (width, height, descent, externalLeading)
Get the width, height, decent and leading of the text using the current or specified font.
def GetFullTextExtent(*args, **kwargs): """ GetFullTextExtent(String string, Font font=None) -> (width, height, descent, externalLeading) Get the width, height, decent and leading of the text using the current or specified font. """ return _core_.Window_GetFullTextExtent(*args, **kwargs)
def GetGapPosition(
*args, **kwargs)
GetGapPosition(self) -> int
def GetGapPosition(*args, **kwargs): """GetGapPosition(self) -> int""" return _stc.StyledTextCtrl_GetGapPosition(*args, **kwargs)
def GetGrandParent(
*args, **kwargs)
GetGrandParent(self) -> Window
Returns the parent of the parent of this window, or None if there isn't one.
def GetGrandParent(*args, **kwargs): """ GetGrandParent(self) -> Window Returns the parent of the parent of this window, or None if there isn't one. """ return _core_.Window_GetGrandParent(*args, **kwargs)
def GetGtkWidget(
*args, **kwargs)
GetGtkWidget(self) -> long
On wxGTK returns a pointer to the GtkWidget for this window as a long integer. On the other platforms this method returns zero.
def GetGtkWidget(*args, **kwargs): """ GetGtkWidget(self) -> long On wxGTK returns a pointer to the GtkWidget for this window as a long integer. On the other platforms this method returns zero. """ return _core_.Window_GetGtkWidget(*args, **kwargs)
def GetHandle(
*args, **kwargs)
GetHandle(self) -> long
Returns the platform-specific handle (as a long integer) of the physical window. On wxMSW this is the win32 window handle, on wxGTK it is the XWindow ID, and on wxMac it is the ControlRef.
def GetHandle(*args, **kwargs): """ GetHandle(self) -> long Returns the platform-specific handle (as a long integer) of the physical window. On wxMSW this is the win32 window handle, on wxGTK it is the XWindow ID, and on wxMac it is the ControlRef. """ return _core_.Window_GetHandle(*args, **kwargs)
def GetHelpText(
*args, **kwargs)
GetHelpText(self) -> String
Gets the help text to be used as context-sensitive help for this
window. Note that the text is actually stored by the current
wx.HelpProvider implementation, and not in the window object itself.
def GetHelpText(*args, **kwargs): """ GetHelpText(self) -> String Gets the help text to be used as context-sensitive help for this window. Note that the text is actually stored by the current `wx.HelpProvider` implementation, and not in the window object itself. """ return _core_.Window_GetHelpText(*args, **kwargs)
def GetHelpTextAtPoint(
*args, **kwargs)
GetHelpTextAtPoint(self, Point pt, wxHelpEvent::Origin origin) -> String
Get the help string associated with the given position in this window.
Notice that pt may be invalid if event origin is keyboard or unknown and this method should return the global window help text then
def GetHelpTextAtPoint(*args, **kwargs): """ GetHelpTextAtPoint(self, Point pt, wxHelpEvent::Origin origin) -> String Get the help string associated with the given position in this window. Notice that pt may be invalid if event origin is keyboard or unknown and this method should return the global window help text then """ return _core_.Window_GetHelpTextAtPoint(*args, **kwargs)
def GetHighlightGuide(
*args, **kwargs)
GetHighlightGuide(self) -> int
Get the highlighted indentation guide column.
def GetHighlightGuide(*args, **kwargs): """ GetHighlightGuide(self) -> int Get the highlighted indentation guide column. """ return _stc.StyledTextCtrl_GetHighlightGuide(*args, **kwargs)
def GetHint(
*args, **kwargs)
GetHint(self) -> String
def GetHint(*args, **kwargs): """GetHint(self) -> String""" return _core_.TextEntryBase_GetHint(*args, **kwargs)
def GetHotspotActiveBackground(
*args, **kwargs)
GetHotspotActiveBackground(self) -> Colour
Get the back colour for active hotspots.
def GetHotspotActiveBackground(*args, **kwargs): """ GetHotspotActiveBackground(self) -> Colour Get the back colour for active hotspots. """ return _stc.StyledTextCtrl_GetHotspotActiveBackground(*args, **kwargs)
def GetHotspotActiveForeground(
*args, **kwargs)
GetHotspotActiveForeground(self) -> Colour
Get the fore colour for active hotspots.
def GetHotspotActiveForeground(*args, **kwargs): """ GetHotspotActiveForeground(self) -> Colour Get the fore colour for active hotspots. """ return _stc.StyledTextCtrl_GetHotspotActiveForeground(*args, **kwargs)
def GetHotspotActiveUnderline(
*args, **kwargs)
GetHotspotActiveUnderline(self) -> bool
Get whether underlining for active hotspots.
def GetHotspotActiveUnderline(*args, **kwargs): """ GetHotspotActiveUnderline(self) -> bool Get whether underlining for active hotspots. """ return _stc.StyledTextCtrl_GetHotspotActiveUnderline(*args, **kwargs)
def GetHotspotSingleLine(
*args, **kwargs)
GetHotspotSingleLine(self) -> bool
Get the HotspotSingleLine property
def GetHotspotSingleLine(*args, **kwargs): """ GetHotspotSingleLine(self) -> bool Get the HotspotSingleLine property """ return _stc.StyledTextCtrl_GetHotspotSingleLine(*args, **kwargs)
def GetId(
*args, **kwargs)
GetId(self) -> int
Returns the identifier of the window. Each window has an integer identifier. If the application has not provided one (or the default Id -1 is used) then an unique identifier with a negative value will be generated.
def GetId(*args, **kwargs): """ GetId(self) -> int Returns the identifier of the window. Each window has an integer identifier. If the application has not provided one (or the default Id -1 is used) then an unique identifier with a negative value will be generated. """ return _core_.Window_GetId(*args, **kwargs)
def GetIdentifier(
*args, **kwargs)
GetIdentifier(self) -> int
def GetIdentifier(*args, **kwargs): """GetIdentifier(self) -> int""" return _stc.StyledTextCtrl_GetIdentifier(*args, **kwargs)
def GetIndent(
*args, **kwargs)
GetIndent(self) -> int
Retrieve indentation size.
def GetIndent(*args, **kwargs): """ GetIndent(self) -> int Retrieve indentation size. """ return _stc.StyledTextCtrl_GetIndent(*args, **kwargs)
def GetIndentationGuides(
*args, **kwargs)
GetIndentationGuides(self) -> int
Are the indentation guides visible?
def GetIndentationGuides(*args, **kwargs): """ GetIndentationGuides(self) -> int Are the indentation guides visible? """ return _stc.StyledTextCtrl_GetIndentationGuides(*args, **kwargs)
def GetIndicatorCurrent(
*args, **kwargs)
GetIndicatorCurrent(self) -> int
Get the current indicator
def GetIndicatorCurrent(*args, **kwargs): """ GetIndicatorCurrent(self) -> int Get the current indicator """ return _stc.StyledTextCtrl_GetIndicatorCurrent(*args, **kwargs)
def GetIndicatorValue(
*args, **kwargs)
GetIndicatorValue(self) -> int
Get the current indicator vaue
def GetIndicatorValue(*args, **kwargs): """ GetIndicatorValue(self) -> int Get the current indicator vaue """ return _stc.StyledTextCtrl_GetIndicatorValue(*args, **kwargs)
def GetInsertionPoint(
*args, **kwargs)
GetInsertionPoint(self) -> long
Returns the insertion point for the combobox's text field.
def GetInsertionPoint(*args, **kwargs): """ GetInsertionPoint(self) -> long Returns the insertion point for the combobox's text field. """ return _core_.TextEntryBase_GetInsertionPoint(*args, **kwargs)
def GetKeysUnicode(
*args, **kwargs)
GetKeysUnicode(self) -> bool
Are keys always interpreted as Unicode?
def GetKeysUnicode(*args, **kwargs): """ GetKeysUnicode(self) -> bool Are keys always interpreted as Unicode? """ return _stc.StyledTextCtrl_GetKeysUnicode(*args, **kwargs)
def GetLabel(
*args, **kwargs)
GetLabel(self) -> String
Generic way of getting a label from any window, for identification purposes. The interpretation of this function differs from class to class. For frames and dialogs, the value returned is the title. For buttons or static text controls, it is the button text. This function can be useful for meta-programs such as testing tools or special-needs access programs)which need to identify windows by name.
def GetLabel(*args, **kwargs): """ GetLabel(self) -> String Generic way of getting a label from any window, for identification purposes. The interpretation of this function differs from class to class. For frames and dialogs, the value returned is the title. For buttons or static text controls, it is the button text. This function can be useful for meta-programs such as testing tools or special-needs access programs)which need to identify windows by name. """ return _core_.Window_GetLabel(*args, **kwargs)
def GetLabelText(
*args, **kwargs)
GetLabelText(self) -> String
Get just the text of the label, without mnemonic characters ('&')
def GetLabelText(*args, **kwargs): """ GetLabelText(self) -> String Get just the text of the label, without mnemonic characters ('&') """ return _core_.Control_GetLabelText(*args, **kwargs)
def GetLastChild(
*args, **kwargs)
GetLastChild(self, int line, int level) -> int
Find the last child line of a header line.
def GetLastChild(*args, **kwargs): """ GetLastChild(self, int line, int level) -> int Find the last child line of a header line. """ return _stc.StyledTextCtrl_GetLastChild(*args, **kwargs)
def GetLastKeydownProcessed(
*args, **kwargs)
GetLastKeydownProcessed(self) -> bool
def GetLastKeydownProcessed(*args, **kwargs): """GetLastKeydownProcessed(self) -> bool""" return _stc.StyledTextCtrl_GetLastKeydownProcessed(*args, **kwargs)
def GetLastPosition(
*args, **kwargs)
GetLastPosition(self) -> long
Returns the last position in the combobox text field.
def GetLastPosition(*args, **kwargs): """ GetLastPosition(self) -> long Returns the last position in the combobox text field. """ return _core_.TextEntryBase_GetLastPosition(*args, **kwargs)
def GetLayoutCache(
*args, **kwargs)
GetLayoutCache(self) -> int
Retrieve the degree of caching of layout information.
def GetLayoutCache(*args, **kwargs): """ GetLayoutCache(self) -> int Retrieve the degree of caching of layout information. """ return _stc.StyledTextCtrl_GetLayoutCache(*args, **kwargs)
def GetLayoutDirection(
*args, **kwargs)
GetLayoutDirection(self) -> int
Get the layout direction (LTR or RTL) for this window. Returns
wx.Layout_Default if layout direction is not supported.
def GetLayoutDirection(*args, **kwargs): """ GetLayoutDirection(self) -> int Get the layout direction (LTR or RTL) for this window. Returns ``wx.Layout_Default`` if layout direction is not supported. """ return _core_.Window_GetLayoutDirection(*args, **kwargs)
def GetLength(
*args, **kwargs)
GetLength(self) -> int
Returns the number of bytes in the document.
def GetLength(*args, **kwargs): """ GetLength(self) -> int Returns the number of bytes in the document. """ return _stc.StyledTextCtrl_GetLength(*args, **kwargs)
def GetLexer(
*args, **kwargs)
GetLexer(self) -> int
Retrieve the lexing language of the document.
def GetLexer(*args, **kwargs): """ GetLexer(self) -> int Retrieve the lexing language of the document. """ return _stc.StyledTextCtrl_GetLexer(*args, **kwargs)
def GetLine(
*args, **kwargs)
GetLine(self, int line) -> String
Retrieve the contents of a line.
def GetLine(*args, **kwargs): """ GetLine(self, int line) -> String Retrieve the contents of a line. """ return _stc.StyledTextCtrl_GetLine(*args, **kwargs)
def GetLineCount(
*args, **kwargs)
GetLineCount(self) -> int
Returns the number of lines in the document. There is always at least one.
def GetLineCount(*args, **kwargs): """ GetLineCount(self) -> int Returns the number of lines in the document. There is always at least one. """ return _stc.StyledTextCtrl_GetLineCount(*args, **kwargs)
def GetLineEndPosition(
*args, **kwargs)
GetLineEndPosition(self, int line) -> int
Get the position after the last visible characters on a line.
def GetLineEndPosition(*args, **kwargs): """ GetLineEndPosition(self, int line) -> int Get the position after the last visible characters on a line. """ return _stc.StyledTextCtrl_GetLineEndPosition(*args, **kwargs)
def GetLineIndentPosition(
*args, **kwargs)
GetLineIndentPosition(self, int line) -> int
Retrieve the position before the first non indentation character on a line.
def GetLineIndentPosition(*args, **kwargs): """ GetLineIndentPosition(self, int line) -> int Retrieve the position before the first non indentation character on a line. """ return _stc.StyledTextCtrl_GetLineIndentPosition(*args, **kwargs)
def GetLineIndentation(
*args, **kwargs)
GetLineIndentation(self, int line) -> int
Retrieve the number of columns that a line is indented.
def GetLineIndentation(*args, **kwargs): """ GetLineIndentation(self, int line) -> int Retrieve the number of columns that a line is indented. """ return _stc.StyledTextCtrl_GetLineIndentation(*args, **kwargs)
def GetLineLength(
*args, **kwargs)
GetLineLength(self, long lineNo) -> int
def GetLineLength(*args, **kwargs): """GetLineLength(self, long lineNo) -> int""" return _core_.TextAreaBase_GetLineLength(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_GetLineRaw(*args, **kwargs)
def 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).
def 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). """ return _stc.StyledTextCtrl_GetLineSelEndPosition(*args, **kwargs)
def 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).
def 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). """ return _stc.StyledTextCtrl_GetLineSelStartPosition(*args, **kwargs)
def GetLineState(
*args, **kwargs)
GetLineState(self, int line) -> int
Retrieve the extra styling information for a line.
def GetLineState(*args, **kwargs): """ GetLineState(self, int line) -> int Retrieve the extra styling information for a line. """ return _stc.StyledTextCtrl_GetLineState(*args, **kwargs)
def GetLineText(
*args, **kwargs)
GetLineText(self, long lineNo) -> String
def GetLineText(*args, **kwargs): """GetLineText(self, long lineNo) -> String""" return _core_.TextAreaBase_GetLineText(*args, **kwargs)
def GetLineUTF8(
self, line)
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.
def GetLineUTF8(self, line): """ 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. """ text = self.GetLineRaw(line) if not wx.USE_UNICODE: u = text.decode(wx.GetDefaultPyEncoding()) text = u.encode('utf-8') return text
def GetLineVisible(
*args, **kwargs)
GetLineVisible(self, int line) -> bool
Is a line visible?
def GetLineVisible(*args, **kwargs): """ GetLineVisible(self, int line) -> bool Is a line visible? """ return _stc.StyledTextCtrl_GetLineVisible(*args, **kwargs)
def GetMainSelection(
*args, **kwargs)
GetMainSelection(self) -> int
Which selection is the main selection
def GetMainSelection(*args, **kwargs): """ GetMainSelection(self) -> int Which selection is the main selection """ return _stc.StyledTextCtrl_GetMainSelection(*args, **kwargs)
def GetMainWindowOfCompositeControl(
*args, **kwargs)
GetMainWindowOfCompositeControl(self) -> Window
def GetMainWindowOfCompositeControl(*args, **kwargs): """GetMainWindowOfCompositeControl(self) -> Window""" return _core_.Window_GetMainWindowOfCompositeControl(*args, **kwargs)
def GetMarginCursor(
*args, **kwargs)
GetMarginCursor(self, int margin) -> int
def GetMarginCursor(*args, **kwargs): """GetMarginCursor(self, int margin) -> int""" return _stc.StyledTextCtrl_GetMarginCursor(*args, **kwargs)
def GetMarginLeft(
*args, **kwargs)
GetMarginLeft(self) -> int
Returns the size in pixels of the left margin.
def GetMarginLeft(*args, **kwargs): """ GetMarginLeft(self) -> int Returns the size in pixels of the left margin. """ return _stc.StyledTextCtrl_GetMarginLeft(*args, **kwargs)
def GetMarginMask(
*args, **kwargs)
GetMarginMask(self, int margin) -> int
Retrieve the marker mask of a margin.
def GetMarginMask(*args, **kwargs): """ GetMarginMask(self, int margin) -> int Retrieve the marker mask of a margin. """ return _stc.StyledTextCtrl_GetMarginMask(*args, **kwargs)
def GetMarginOptions(
*args, **kwargs)
GetMarginOptions(self) -> int
def GetMarginOptions(*args, **kwargs): """GetMarginOptions(self) -> int""" return _stc.StyledTextCtrl_GetMarginOptions(*args, **kwargs)
def GetMarginRight(
*args, **kwargs)
GetMarginRight(self) -> int
Returns the size in pixels of the right margin.
def GetMarginRight(*args, **kwargs): """ GetMarginRight(self) -> int Returns the size in pixels of the right margin. """ return _stc.StyledTextCtrl_GetMarginRight(*args, **kwargs)
def GetMarginSensitive(
*args, **kwargs)
GetMarginSensitive(self, int margin) -> bool
Retrieve the mouse click sensitivity of a margin.
def GetMarginSensitive(*args, **kwargs): """ GetMarginSensitive(self, int margin) -> bool Retrieve the mouse click sensitivity of a margin. """ return _stc.StyledTextCtrl_GetMarginSensitive(*args, **kwargs)
def GetMarginType(
*args, **kwargs)
GetMarginType(self, int margin) -> int
Retrieve the type of a margin.
def GetMarginType(*args, **kwargs): """ GetMarginType(self, int margin) -> int Retrieve the type of a margin. """ return _stc.StyledTextCtrl_GetMarginType(*args, **kwargs)
def GetMarginWidth(
*args, **kwargs)
GetMarginWidth(self, int margin) -> int
Retrieve the width of a margin in pixels.
def GetMarginWidth(*args, **kwargs): """ GetMarginWidth(self, int margin) -> int Retrieve the width of a margin in pixels. """ return _stc.StyledTextCtrl_GetMarginWidth(*args, **kwargs)
def GetMargins(
*args, **kwargs)
GetMargins(self) -> Point
def GetMargins(*args, **kwargs): """GetMargins(self) -> Point""" return _core_.TextEntryBase_GetMargins(*args, **kwargs)
def GetMarkerSymbolDefined(
*args, **kwargs)
GetMarkerSymbolDefined(self, int markerNumber) -> int
Which symbol was defined for markerNumber with MarkerDefine
def GetMarkerSymbolDefined(*args, **kwargs): """ GetMarkerSymbolDefined(self, int markerNumber) -> int Which symbol was defined for markerNumber with MarkerDefine """ return _stc.StyledTextCtrl_GetMarkerSymbolDefined(*args, **kwargs)
def GetMaxClientSize(
*args, **kwargs)
GetMaxClientSize(self) -> Size
def GetMaxClientSize(*args, **kwargs): """GetMaxClientSize(self) -> Size""" return _core_.Window_GetMaxClientSize(*args, **kwargs)
def GetMaxHeight(
*args, **kwargs)
GetMaxHeight(self) -> int
def GetMaxHeight(*args, **kwargs): """GetMaxHeight(self) -> int""" return _core_.Window_GetMaxHeight(*args, **kwargs)
def GetMaxLineState(
*args, **kwargs)
GetMaxLineState(self) -> int
Retrieve the last line number that has line state.
def GetMaxLineState(*args, **kwargs): """ GetMaxLineState(self) -> int Retrieve the last line number that has line state. """ return _stc.StyledTextCtrl_GetMaxLineState(*args, **kwargs)
def GetMaxSize(
*args, **kwargs)
GetMaxSize(self) -> Size
def GetMaxSize(*args, **kwargs): """GetMaxSize(self) -> Size""" return _core_.Window_GetMaxSize(*args, **kwargs)
def GetMaxWidth(
*args, **kwargs)
GetMaxWidth(self) -> int
def GetMaxWidth(*args, **kwargs): """GetMaxWidth(self) -> int""" return _core_.Window_GetMaxWidth(*args, **kwargs)
def GetMinClientSize(
*args, **kwargs)
GetMinClientSize(self) -> Size
def GetMinClientSize(*args, **kwargs): """GetMinClientSize(self) -> Size""" return _core_.Window_GetMinClientSize(*args, **kwargs)
def GetMinHeight(
*args, **kwargs)
GetMinHeight(self) -> int
def GetMinHeight(*args, **kwargs): """GetMinHeight(self) -> int""" return _core_.Window_GetMinHeight(*args, **kwargs)
def GetMinSize(
*args, **kwargs)
GetMinSize(self) -> Size
def GetMinSize(*args, **kwargs): """GetMinSize(self) -> Size""" return _core_.Window_GetMinSize(*args, **kwargs)
def GetMinWidth(
*args, **kwargs)
GetMinWidth(self) -> int
def GetMinWidth(*args, **kwargs): """GetMinWidth(self) -> int""" return _core_.Window_GetMinWidth(*args, **kwargs)
def GetModEventMask(
*args, **kwargs)
GetModEventMask(self) -> int
Get which document modification events are sent to the container.
def GetModEventMask(*args, **kwargs): """ GetModEventMask(self) -> int Get which document modification events are sent to the container. """ return _stc.StyledTextCtrl_GetModEventMask(*args, **kwargs)
def GetModify(
*args, **kwargs)
GetModify(self) -> bool
Is the document different from when it was last saved?
def GetModify(*args, **kwargs): """ GetModify(self) -> bool Is the document different from when it was last saved? """ return _stc.StyledTextCtrl_GetModify(*args, **kwargs)
def GetMouseDownCaptures(
*args, **kwargs)
GetMouseDownCaptures(self) -> bool
Get whether mouse gets captured.
def GetMouseDownCaptures(*args, **kwargs): """ GetMouseDownCaptures(self) -> bool Get whether mouse gets captured. """ return _stc.StyledTextCtrl_GetMouseDownCaptures(*args, **kwargs)
def GetMouseDwellTime(
*args, **kwargs)
GetMouseDwellTime(self) -> int
Retrieve the time the mouse must sit still to generate a mouse dwell event.
def GetMouseDwellTime(*args, **kwargs): """ GetMouseDwellTime(self) -> int Retrieve the time the mouse must sit still to generate a mouse dwell event. """ return _stc.StyledTextCtrl_GetMouseDwellTime(*args, **kwargs)
def GetMultiPaste(
*args, **kwargs)
GetMultiPaste(self) -> int
def GetMultiPaste(*args, **kwargs): """GetMultiPaste(self) -> int""" return _stc.StyledTextCtrl_GetMultiPaste(*args, **kwargs)
def GetMultipleSelection(
*args, **kwargs)
GetMultipleSelection(self) -> bool
Whether multiple selections can be made
def GetMultipleSelection(*args, **kwargs): """ GetMultipleSelection(self) -> bool Whether multiple selections can be made """ return _stc.StyledTextCtrl_GetMultipleSelection(*args, **kwargs)
def GetName(
*args, **kwargs)
GetName(self) -> String
Returns the windows name. This name is not guaranteed to be unique; it is up to the programmer to supply an appropriate name in the window constructor or via wx.Window.SetName.
def GetName(*args, **kwargs): """ GetName(self) -> String Returns the windows name. This name is not guaranteed to be unique; it is up to the programmer to supply an appropriate name in the window constructor or via wx.Window.SetName. """ return _core_.Window_GetName(*args, **kwargs)
def GetNextHandler(
*args, **kwargs)
GetNextHandler(self) -> EvtHandler
def GetNextHandler(*args, **kwargs): """GetNextHandler(self) -> EvtHandler""" return _core_.EvtHandler_GetNextHandler(*args, **kwargs)
def GetNextSibling(
*args, **kwargs)
GetNextSibling(self) -> Window
def GetNextSibling(*args, **kwargs): """GetNextSibling(self) -> Window""" return _core_.Window_GetNextSibling(*args, **kwargs)
def GetNumberOfLines(
*args, **kwargs)
GetNumberOfLines(self) -> int
def GetNumberOfLines(*args, **kwargs): """GetNumberOfLines(self) -> int""" return _core_.TextAreaBase_GetNumberOfLines(*args, **kwargs)
def GetOvertype(
*args, **kwargs)
GetOvertype(self) -> bool
Returns true if overtype mode is active otherwise false is returned.
def GetOvertype(*args, **kwargs): """ GetOvertype(self) -> bool Returns true if overtype mode is active otherwise false is returned. """ return _stc.StyledTextCtrl_GetOvertype(*args, **kwargs)
def GetParent(
*args, **kwargs)
GetParent(self) -> Window
Returns the parent window of this window, or None if there isn't one.
def GetParent(*args, **kwargs): """ GetParent(self) -> Window Returns the parent window of this window, or None if there isn't one. """ return _core_.Window_GetParent(*args, **kwargs)
def GetPasteConvertEndings(
*args, **kwargs)
GetPasteConvertEndings(self) -> bool
Get convert-on-paste setting
def GetPasteConvertEndings(*args, **kwargs): """ GetPasteConvertEndings(self) -> bool Get convert-on-paste setting """ return _stc.StyledTextCtrl_GetPasteConvertEndings(*args, **kwargs)
def GetPopupMenuSelectionFromUser(
*args, **kwargs)
GetPopupMenuSelectionFromUser(self, Menu menu, Point pos=DefaultPosition) -> int
Simply return the id of the selected item or wxID_NONE without generating any events.
def GetPopupMenuSelectionFromUser(*args, **kwargs): """ GetPopupMenuSelectionFromUser(self, Menu menu, Point pos=DefaultPosition) -> int Simply return the id of the selected item or wxID_NONE without generating any events. """ return _core_.Window_GetPopupMenuSelectionFromUser(*args, **kwargs)
def GetPosition(
*args, **kwargs)
GetPosition(self) -> Point
Get the window's position. Notice that the position is in client
coordinates for child windows and screen coordinates for the top level
ones, use GetScreenPosition if you need screen coordinates for all
kinds of windows.
def GetPosition(*args, **kwargs): """ GetPosition(self) -> Point Get the window's position. Notice that the position is in client coordinates for child windows and screen coordinates for the top level ones, use `GetScreenPosition` if you need screen coordinates for all kinds of windows. """ return _core_.Window_GetPosition(*args, **kwargs)
def GetPositionCacheSize(
*args, **kwargs)
GetPositionCacheSize(self) -> int
How many entries are allocated to the position cache?
def GetPositionCacheSize(*args, **kwargs): """ GetPositionCacheSize(self) -> int How many entries are allocated to the position cache? """ return _stc.StyledTextCtrl_GetPositionCacheSize(*args, **kwargs)
def GetPositionTuple(
*args, **kwargs)
GetPositionTuple() -> (x,y)
Get the window's position. Notice that the position is in client
coordinates for child windows and screen coordinates for the top level
ones, use GetScreenPosition if you need screen coordinates for all
kinds of windows.
def GetPositionTuple(*args, **kwargs): """ GetPositionTuple() -> (x,y) Get the window's position. Notice that the position is in client coordinates for child windows and screen coordinates for the top level ones, use `GetScreenPosition` if you need screen coordinates for all kinds of windows. """ return _core_.Window_GetPositionTuple(*args, **kwargs)
def GetPrevSibling(
*args, **kwargs)
GetPrevSibling(self) -> Window
def GetPrevSibling(*args, **kwargs): """GetPrevSibling(self) -> Window""" return _core_.Window_GetPrevSibling(*args, **kwargs)
def GetPreviousHandler(
*args, **kwargs)
GetPreviousHandler(self) -> EvtHandler
def GetPreviousHandler(*args, **kwargs): """GetPreviousHandler(self) -> EvtHandler""" return _core_.EvtHandler_GetPreviousHandler(*args, **kwargs)
def GetPrintColourMode(
*args, **kwargs)
GetPrintColourMode(self) -> int
Returns the print colour mode.
def GetPrintColourMode(*args, **kwargs): """ GetPrintColourMode(self) -> int Returns the print colour mode. """ return _stc.StyledTextCtrl_GetPrintColourMode(*args, **kwargs)
def GetPrintMagnification(
*args, **kwargs)
GetPrintMagnification(self) -> int
Returns the print magnification.
def GetPrintMagnification(*args, **kwargs): """ GetPrintMagnification(self) -> int Returns the print magnification. """ return _stc.StyledTextCtrl_GetPrintMagnification(*args, **kwargs)
def GetPrintWrapMode(
*args, **kwargs)
GetPrintWrapMode(self) -> int
Is printing line wrapped?
def GetPrintWrapMode(*args, **kwargs): """ GetPrintWrapMode(self) -> int Is printing line wrapped? """ return _stc.StyledTextCtrl_GetPrintWrapMode(*args, **kwargs)
def GetProperty(
*args, **kwargs)
GetProperty(self, String key) -> String
Retrieve a 'property' value previously set with SetProperty.
def GetProperty(*args, **kwargs): """ GetProperty(self, String key) -> String Retrieve a 'property' value previously set with SetProperty. """ return _stc.StyledTextCtrl_GetProperty(*args, **kwargs)
def GetPropertyExpanded(
*args, **kwargs)
GetPropertyExpanded(self, String key) -> String
Retrieve a 'property' value previously set with SetProperty, with '$()' variable replacement on returned buffer.
def GetPropertyExpanded(*args, **kwargs): """ GetPropertyExpanded(self, String key) -> String Retrieve a 'property' value previously set with SetProperty, with '$()' variable replacement on returned buffer. """ return _stc.StyledTextCtrl_GetPropertyExpanded(*args, **kwargs)
def GetPropertyInt(
*args, **kwargs)
GetPropertyInt(self, String key) -> int
Retrieve a 'property' value previously set with SetProperty, interpreted as an int AFTER any '$()' variable replacement.
def GetPropertyInt(*args, **kwargs): """ GetPropertyInt(self, String key) -> int Retrieve a 'property' value previously set with SetProperty, interpreted as an int AFTER any '$()' variable replacement. """ return _stc.StyledTextCtrl_GetPropertyInt(*args, **kwargs)
def GetPunctuationChars(
*args, **kwargs)
GetPunctuationChars(self) -> String
def GetPunctuationChars(*args, **kwargs): """GetPunctuationChars(self) -> String""" return _stc.StyledTextCtrl_GetPunctuationChars(*args, **kwargs)
def GetRange(
*args, **kwargs)
GetRange(self, long from, long to) -> String
Returns a subset of the value in the text field.
def GetRange(*args, **kwargs): """ GetRange(self, long from, long to) -> String Returns a subset of the value in the text field. """ return _core_.TextEntryBase_GetRange(*args, **kwargs)
def GetRangePointer(
*args, **kwargs)
GetRangePointer(self, int position, int rangeLength) -> char
def GetRangePointer(*args, **kwargs): """GetRangePointer(self, int position, int rangeLength) -> char""" return _stc.StyledTextCtrl_GetRangePointer(*args, **kwargs)
def GetReadOnly(
*args, **kwargs)
GetReadOnly(self) -> bool
In read-only mode?
def GetReadOnly(*args, **kwargs): """ GetReadOnly(self) -> bool In read-only mode? """ return _stc.StyledTextCtrl_GetReadOnly(*args, **kwargs)
def GetRect(
*args, **kwargs)
GetRect(self) -> Rect
Returns the size and position of the window as a wx.Rect object.
def GetRect(*args, **kwargs): """ GetRect(self) -> Rect Returns the size and position of the window as a `wx.Rect` object. """ return _core_.Window_GetRect(*args, **kwargs)
def GetRectangularSelectionAnchor(
*args, **kwargs)
GetRectangularSelectionAnchor(self) -> int
def GetRectangularSelectionAnchor(*args, **kwargs): """GetRectangularSelectionAnchor(self) -> int""" return _stc.StyledTextCtrl_GetRectangularSelectionAnchor(*args, **kwargs)
def GetRectangularSelectionAnchorVirtualSpace(
*args, **kwargs)
GetRectangularSelectionAnchorVirtualSpace(self) -> int
def GetRectangularSelectionAnchorVirtualSpace(*args, **kwargs): """GetRectangularSelectionAnchorVirtualSpace(self) -> int""" return _stc.StyledTextCtrl_GetRectangularSelectionAnchorVirtualSpace(*args, **kwargs)
def GetRectangularSelectionCaret(
*args, **kwargs)
GetRectangularSelectionCaret(self) -> int
def GetRectangularSelectionCaret(*args, **kwargs): """GetRectangularSelectionCaret(self) -> int""" return _stc.StyledTextCtrl_GetRectangularSelectionCaret(*args, **kwargs)
def GetRectangularSelectionCaretVirtualSpace(
*args, **kwargs)
GetRectangularSelectionCaretVirtualSpace(self) -> int
def GetRectangularSelectionCaretVirtualSpace(*args, **kwargs): """GetRectangularSelectionCaretVirtualSpace(self) -> int""" return _stc.StyledTextCtrl_GetRectangularSelectionCaretVirtualSpace(*args, **kwargs)
def GetRectangularSelectionModifier(
*args, **kwargs)
GetRectangularSelectionModifier(self) -> int
Get the modifier key used for rectangular selection.
def GetRectangularSelectionModifier(*args, **kwargs): """ GetRectangularSelectionModifier(self) -> int Get the modifier key used for rectangular selection. """ return _stc.StyledTextCtrl_GetRectangularSelectionModifier(*args, **kwargs)
def GetSTCCursor(
*args, **kwargs)
GetSTCCursor(self) -> int
Get cursor type.
def GetSTCCursor(*args, **kwargs): """ GetSTCCursor(self) -> int Get cursor type. """ return _stc.StyledTextCtrl_GetSTCCursor(*args, **kwargs)
def GetSTCFocus(
*args, **kwargs)
GetSTCFocus(self) -> bool
Get internal focus flag.
def GetSTCFocus(*args, **kwargs): """ GetSTCFocus(self) -> bool Get internal focus flag. """ return _stc.StyledTextCtrl_GetSTCFocus(*args, **kwargs)
def GetScreenPosition(
*args, **kwargs)
GetScreenPosition(self) -> Point
Get the position of the window in screen coordinantes.
def GetScreenPosition(*args, **kwargs): """ GetScreenPosition(self) -> Point Get the position of the window in screen coordinantes. """ return _core_.Window_GetScreenPosition(*args, **kwargs)
def GetScreenPositionTuple(
*args, **kwargs)
GetScreenPositionTuple() -> (x,y)
Get the position of the window in screen coordinantes.
def GetScreenPositionTuple(*args, **kwargs): """ GetScreenPositionTuple() -> (x,y) Get the position of the window in screen coordinantes. """ return _core_.Window_GetScreenPositionTuple(*args, **kwargs)
def GetScreenRect(
*args, **kwargs)
GetScreenRect(self) -> Rect
Returns the size and position of the window in screen coordinantes as
a wx.Rect object.
def GetScreenRect(*args, **kwargs): """ GetScreenRect(self) -> Rect Returns the size and position of the window in screen coordinantes as a `wx.Rect` object. """ return _core_.Window_GetScreenRect(*args, **kwargs)
def GetScrollPos(
*args, **kwargs)
GetScrollPos(self, int orientation) -> int
Returns the built-in scrollbar position.
def GetScrollPos(*args, **kwargs): """ GetScrollPos(self, int orientation) -> int Returns the built-in scrollbar position. """ return _core_.Window_GetScrollPos(*args, **kwargs)
def GetScrollRange(
*args, **kwargs)
GetScrollRange(self, int orientation) -> int
Returns the built-in scrollbar range.
def GetScrollRange(*args, **kwargs): """ GetScrollRange(self, int orientation) -> int Returns the built-in scrollbar range. """ return _core_.Window_GetScrollRange(*args, **kwargs)
def GetScrollThumb(
*args, **kwargs)
GetScrollThumb(self, int orientation) -> int
Returns the built-in scrollbar thumb size.
def GetScrollThumb(*args, **kwargs): """ GetScrollThumb(self, int orientation) -> int Returns the built-in scrollbar thumb size. """ return _core_.Window_GetScrollThumb(*args, **kwargs)
def GetScrollWidth(
*args, **kwargs)
GetScrollWidth(self) -> int
Retrieve the document width assumed for scrolling.
def GetScrollWidth(*args, **kwargs): """ GetScrollWidth(self) -> int Retrieve the document width assumed for scrolling. """ return _stc.StyledTextCtrl_GetScrollWidth(*args, **kwargs)
def GetScrollWidthTracking(
*args, **kwargs)
GetScrollWidthTracking(self) -> bool
Retrieve whether the scroll width tracks wide lines.
def GetScrollWidthTracking(*args, **kwargs): """ GetScrollWidthTracking(self) -> bool Retrieve whether the scroll width tracks wide lines. """ return _stc.StyledTextCtrl_GetScrollWidthTracking(*args, **kwargs)
def GetSearchFlags(
*args, **kwargs)
GetSearchFlags(self) -> int
Get the search flags used by SearchInTarget.
def GetSearchFlags(*args, **kwargs): """ GetSearchFlags(self) -> int Get the search flags used by SearchInTarget. """ return _stc.StyledTextCtrl_GetSearchFlags(*args, **kwargs)
def GetSelAlpha(
*args, **kwargs)
GetSelAlpha(self) -> int
Get the alpha of the selection.
def GetSelAlpha(*args, **kwargs): """ GetSelAlpha(self) -> int Get the alpha of the selection. """ return _stc.StyledTextCtrl_GetSelAlpha(*args, **kwargs)
def GetSelEOLFilled(
*args, **kwargs)
GetSelEOLFilled(self) -> bool
Is the selection end of line filled?
def GetSelEOLFilled(*args, **kwargs): """ GetSelEOLFilled(self) -> bool Is the selection end of line filled? """ return _stc.StyledTextCtrl_GetSelEOLFilled(*args, **kwargs)
def GetSelectedText(
*args, **kwargs)
GetSelectedText(self) -> String
Retrieve the selected text.
def GetSelectedText(*args, **kwargs): """ GetSelectedText(self) -> String Retrieve the selected text. """ return _stc.StyledTextCtrl_GetSelectedText(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_GetSelectedTextRaw(*args, **kwargs)
def GetSelectedTextUTF8(
self)
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.
def GetSelectedTextUTF8(self): """ 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. """ text = self.GetSelectedTextRaw() if not wx.USE_UNICODE: u = text.decode(wx.GetDefaultPyEncoding()) text = u.encode('utf-8') return text
def GetSelection(
*args, **kwargs)
GetSelection() -> (from, to)
If the return values from and to are the same, there is no selection.
def GetSelection(*args, **kwargs): """ GetSelection() -> (from, to) If the return values from and to are the same, there is no selection. """ return _core_.TextEntryBase_GetSelection(*args, **kwargs)
def GetSelectionEnd(
*args, **kwargs)
GetSelectionEnd(self) -> int
Returns the position at the end of the selection.
def GetSelectionEnd(*args, **kwargs): """ GetSelectionEnd(self) -> int Returns the position at the end of the selection. """ return _stc.StyledTextCtrl_GetSelectionEnd(*args, **kwargs)
def GetSelectionMode(
*args, **kwargs)
GetSelectionMode(self) -> int
Get the mode of the current selection.
def GetSelectionMode(*args, **kwargs): """ GetSelectionMode(self) -> int Get the mode of the current selection. """ return _stc.StyledTextCtrl_GetSelectionMode(*args, **kwargs)
def GetSelectionNAnchor(
*args, **kwargs)
GetSelectionNAnchor(self, int selection) -> int
def GetSelectionNAnchor(*args, **kwargs): """GetSelectionNAnchor(self, int selection) -> int""" return _stc.StyledTextCtrl_GetSelectionNAnchor(*args, **kwargs)
def GetSelectionNAnchorVirtualSpace(
*args, **kwargs)
GetSelectionNAnchorVirtualSpace(self, int selection) -> int
def GetSelectionNAnchorVirtualSpace(*args, **kwargs): """GetSelectionNAnchorVirtualSpace(self, int selection) -> int""" return _stc.StyledTextCtrl_GetSelectionNAnchorVirtualSpace(*args, **kwargs)
def GetSelectionNCaret(
*args, **kwargs)
GetSelectionNCaret(self, int selection) -> int
def GetSelectionNCaret(*args, **kwargs): """GetSelectionNCaret(self, int selection) -> int""" return _stc.StyledTextCtrl_GetSelectionNCaret(*args, **kwargs)
def GetSelectionNCaretVirtualSpace(
*args, **kwargs)
GetSelectionNCaretVirtualSpace(self, int selection) -> int
def GetSelectionNCaretVirtualSpace(*args, **kwargs): """GetSelectionNCaretVirtualSpace(self, int selection) -> int""" return _stc.StyledTextCtrl_GetSelectionNCaretVirtualSpace(*args, **kwargs)
def GetSelectionNEnd(
*args, **kwargs)
GetSelectionNEnd(self, int selection) -> int
Returns the position at the end of the selection.
def GetSelectionNEnd(*args, **kwargs): """ GetSelectionNEnd(self, int selection) -> int Returns the position at the end of the selection. """ return _stc.StyledTextCtrl_GetSelectionNEnd(*args, **kwargs)
def GetSelectionNStart(
*args, **kwargs)
GetSelectionNStart(self, int selection) -> int
Returns the position at the start of the selection.
def GetSelectionNStart(*args, **kwargs): """ GetSelectionNStart(self, int selection) -> int Returns the position at the start of the selection. """ return _stc.StyledTextCtrl_GetSelectionNStart(*args, **kwargs)
def GetSelectionStart(
*args, **kwargs)
GetSelectionStart(self) -> int
Returns the position at the start of the selection.
def GetSelectionStart(*args, **kwargs): """ GetSelectionStart(self) -> int Returns the position at the start of the selection. """ return _stc.StyledTextCtrl_GetSelectionStart(*args, **kwargs)
def GetSelections(
*args, **kwargs)
GetSelections(self) -> int
How many selections are there?
def GetSelections(*args, **kwargs): """ GetSelections(self) -> int How many selections are there? """ return _stc.StyledTextCtrl_GetSelections(*args, **kwargs)
def GetSize(
*args, **kwargs)
GetSize(self) -> Size
Get the window size.
def GetSize(*args, **kwargs): """ GetSize(self) -> Size Get the window size. """ return _core_.Window_GetSize(*args, **kwargs)
def GetSizeTuple(
*args, **kwargs)
GetSizeTuple() -> (width, height)
Get the window size.
def GetSizeTuple(*args, **kwargs): """ GetSizeTuple() -> (width, height) Get the window size. """ return _core_.Window_GetSizeTuple(*args, **kwargs)
def GetSizer(
*args, **kwargs)
GetSizer(self) -> Sizer
Return the sizer associated with the window by a previous call to SetSizer or None if there isn't one.
def GetSizer(*args, **kwargs): """ GetSizer(self) -> Sizer Return the sizer associated with the window by a previous call to SetSizer or None if there isn't one. """ return _core_.Window_GetSizer(*args, **kwargs)
def GetStatus(
*args, **kwargs)
GetStatus(self) -> int
Get error status.
def GetStatus(*args, **kwargs): """ GetStatus(self) -> int Get error status. """ return _stc.StyledTextCtrl_GetStatus(*args, **kwargs)
def GetString(
*args, **kw)
GetRange(self, long from, long to) -> String
Returns a subset of the value in the text field.
def deprecated_func(*args, **kw): warnings.warn("Call to deprecated item. %s" % msg, wxPyDeprecationWarning, stacklevel=2) return item(*args, **kw)
def GetStringSelection(
*args, **kwargs)
GetStringSelection(self) -> String
Returns the selected text.
def GetStringSelection(*args, **kwargs): """ GetStringSelection(self) -> String Returns the selected text. """ return _core_.TextEntryBase_GetStringSelection(*args, **kwargs)
def GetStyle(
*args, **kwargs)
GetStyle(self, long position, wxTextAttr style) -> bool
def GetStyle(*args, **kwargs): """GetStyle(self, long position, wxTextAttr style) -> bool""" return _core_.TextAreaBase_GetStyle(*args, **kwargs)
def GetStyleAt(
*args, **kwargs)
GetStyleAt(self, int pos) -> int
Returns the style byte at the position.
def GetStyleAt(*args, **kwargs): """ GetStyleAt(self, int pos) -> int Returns the style byte at the position. """ return _stc.StyledTextCtrl_GetStyleAt(*args, **kwargs)
def GetStyleBits(
*args, **kwargs)
GetStyleBits(self) -> int
Retrieve number of bits in style bytes used to hold the lexical state.
def GetStyleBits(*args, **kwargs): """ GetStyleBits(self) -> int Retrieve number of bits in style bytes used to hold the lexical state. """ return _stc.StyledTextCtrl_GetStyleBits(*args, **kwargs)
def GetStyleBitsNeeded(
*args, **kwargs)
GetStyleBitsNeeded(self) -> int
Retrieve the number of bits the current lexer needs for styling.
def GetStyleBitsNeeded(*args, **kwargs): """ GetStyleBitsNeeded(self) -> int Retrieve the number of bits the current lexer needs for styling. """ return _stc.StyledTextCtrl_GetStyleBitsNeeded(*args, **kwargs)
def GetStyledText(
*args, **kwargs)
GetStyledText(self, int startPos, int endPos) -> wxMemoryBuffer
Retrieve a buffer of cells.
def GetStyledText(*args, **kwargs): """ GetStyledText(self, int startPos, int endPos) -> wxMemoryBuffer Retrieve a buffer of cells. """ return _stc.StyledTextCtrl_GetStyledText(*args, **kwargs)
def GetTabIndents(
*args, **kwargs)
GetTabIndents(self) -> bool
Does a tab pressed when caret is within indentation indent?
def GetTabIndents(*args, **kwargs): """ GetTabIndents(self) -> bool Does a tab pressed when caret is within indentation indent? """ return _stc.StyledTextCtrl_GetTabIndents(*args, **kwargs)
def GetTabWidth(
*args, **kwargs)
GetTabWidth(self) -> int
Retrieve the visible size of a tab.
def GetTabWidth(*args, **kwargs): """ GetTabWidth(self) -> int Retrieve the visible size of a tab. """ return _stc.StyledTextCtrl_GetTabWidth(*args, **kwargs)
def GetTag(
*args, **kwargs)
GetTag(self, int tagNumber) -> String
def GetTag(*args, **kwargs): """GetTag(self, int tagNumber) -> String""" return _stc.StyledTextCtrl_GetTag(*args, **kwargs)
def GetTargetEnd(
*args, **kwargs)
GetTargetEnd(self) -> int
Get the position that ends the target.
def GetTargetEnd(*args, **kwargs): """ GetTargetEnd(self) -> int Get the position that ends the target. """ return _stc.StyledTextCtrl_GetTargetEnd(*args, **kwargs)
def GetTargetStart(
*args, **kwargs)
GetTargetStart(self) -> int
Get the position that starts the target.
def GetTargetStart(*args, **kwargs): """ GetTargetStart(self) -> int Get the position that starts the target. """ return _stc.StyledTextCtrl_GetTargetStart(*args, **kwargs)
def GetTechnology(
*args, **kwargs)
GetTechnology(self) -> int
def GetTechnology(*args, **kwargs): """GetTechnology(self) -> int""" return _stc.StyledTextCtrl_GetTechnology(*args, **kwargs)
def GetText(
*args, **kwargs)
GetText(self) -> String
Retrieve all the text in the document.
def GetText(*args, **kwargs): """ GetText(self) -> String Retrieve all the text in the document. """ return _stc.StyledTextCtrl_GetText(*args, **kwargs)
def GetTextExtent(
*args, **kwargs)
GetTextExtent(String string) -> (width, height)
Get the width and height of the text using the current font.
def GetTextExtent(*args, **kwargs): """ GetTextExtent(String string) -> (width, height) Get the width and height of the text using the current font. """ return _core_.Window_GetTextExtent(*args, **kwargs)
def GetTextLength(
*args, **kwargs)
GetTextLength(self) -> int
Retrieve the number of characters in the document.
def GetTextLength(*args, **kwargs): """ GetTextLength(self) -> int Retrieve the number of characters in the document. """ return _stc.StyledTextCtrl_GetTextLength(*args, **kwargs)
def GetTextRange(
*args, **kwargs)
GetTextRange(self, int startPos, int endPos) -> String
Retrieve a range of text.
def GetTextRange(*args, **kwargs): """ GetTextRange(self, int startPos, int endPos) -> String Retrieve a range of text. """ return _stc.StyledTextCtrl_GetTextRange(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_GetTextRangeRaw(*args, **kwargs)
def GetTextRangeUTF8(
self, startPos, endPos)
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.
def GetTextRangeUTF8(self, startPos, endPos): """ 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. """ text = self.GetTextRangeRaw(startPos, endPos) if not wx.USE_UNICODE: u = text.decode(wx.GetDefaultPyEncoding()) text = u.encode('utf-8') return text
def 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.
def 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. """ return _stc.StyledTextCtrl_GetTextRaw(*args, **kwargs)
def GetTextUTF8(
self)
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.
def GetTextUTF8(self): """ 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. """ text = self.GetTextRaw() if not wx.USE_UNICODE: u = text.decode(wx.GetDefaultPyEncoding()) text = u.encode('utf-8') return text
def GetThemeEnabled(
*args, **kwargs)
GetThemeEnabled(self) -> bool
Return the themeEnabled flag.
def GetThemeEnabled(*args, **kwargs): """ GetThemeEnabled(self) -> bool Return the themeEnabled flag. """ return _core_.Window_GetThemeEnabled(*args, **kwargs)
def GetToolTip(
*args, **kwargs)
GetToolTip(self) -> ToolTip
get the associated tooltip or None if none
def GetToolTip(*args, **kwargs): """ GetToolTip(self) -> ToolTip get the associated tooltip or None if none """ return _core_.Window_GetToolTip(*args, **kwargs)
def GetToolTipString(
self)
def GetToolTipString(self): tip = self.GetToolTip() if tip: return tip.GetTip() else: return None
def GetTopLevelParent(
*args, **kwargs)
GetTopLevelParent(self) -> Window
Returns the first frame or dialog in this window's parental hierarchy.
def GetTopLevelParent(*args, **kwargs): """ GetTopLevelParent(self) -> Window Returns the first frame or dialog in this window's parental hierarchy. """ return _core_.Window_GetTopLevelParent(*args, **kwargs)
def GetTwoPhaseDraw(
*args, **kwargs)
GetTwoPhaseDraw(self) -> bool
Is drawing done in two phases with backgrounds drawn before foregrounds?
def GetTwoPhaseDraw(*args, **kwargs): """ GetTwoPhaseDraw(self) -> bool Is drawing done in two phases with backgrounds drawn before foregrounds? """ return _stc.StyledTextCtrl_GetTwoPhaseDraw(*args, **kwargs)
def GetUndoCollection(
*args, **kwargs)
GetUndoCollection(self) -> bool
Is undo history being collected?
def GetUndoCollection(*args, **kwargs): """ GetUndoCollection(self) -> bool Is undo history being collected? """ return _stc.StyledTextCtrl_GetUndoCollection(*args, **kwargs)
def GetUpdateClientRect(
*args, **kwargs)
GetUpdateClientRect(self) -> Rect
Get the update rectangle region bounding box in client coords.
def GetUpdateClientRect(*args, **kwargs): """ GetUpdateClientRect(self) -> Rect Get the update rectangle region bounding box in client coords. """ return _core_.Window_GetUpdateClientRect(*args, **kwargs)
def GetUpdateRegion(
*args, **kwargs)
GetUpdateRegion(self) -> Region
Returns the region specifying which parts of the window have been damaged. Should only be called within an EVT_PAINT handler.
def GetUpdateRegion(*args, **kwargs): """ GetUpdateRegion(self) -> Region Returns the region specifying which parts of the window have been damaged. Should only be called within an EVT_PAINT handler. """ return _core_.Window_GetUpdateRegion(*args, **kwargs)
def GetUseAntiAliasing(
*args, **kwargs)
GetUseAntiAliasing(self) -> bool
Returns the current UseAntiAliasing setting.
def GetUseAntiAliasing(*args, **kwargs): """ GetUseAntiAliasing(self) -> bool Returns the current UseAntiAliasing setting. """ return _stc.StyledTextCtrl_GetUseAntiAliasing(*args, **kwargs)
def GetUseHorizontalScrollBar(
*args, **kwargs)
GetUseHorizontalScrollBar(self) -> bool
Is the horizontal scroll bar visible?
def GetUseHorizontalScrollBar(*args, **kwargs): """ GetUseHorizontalScrollBar(self) -> bool Is the horizontal scroll bar visible? """ return _stc.StyledTextCtrl_GetUseHorizontalScrollBar(*args, **kwargs)
def GetUseTabs(
*args, **kwargs)
GetUseTabs(self) -> bool
Retrieve whether tabs will be used in indentation.
def GetUseTabs(*args, **kwargs): """ GetUseTabs(self) -> bool Retrieve whether tabs will be used in indentation. """ return _stc.StyledTextCtrl_GetUseTabs(*args, **kwargs)
def GetUseVerticalScrollBar(
*args, **kwargs)
GetUseVerticalScrollBar(self) -> bool
Is the vertical scroll bar visible?
def GetUseVerticalScrollBar(*args, **kwargs): """ GetUseVerticalScrollBar(self) -> bool Is the vertical scroll bar visible? """ return _stc.StyledTextCtrl_GetUseVerticalScrollBar(*args, **kwargs)
def GetValidator(
*args, **kwargs)
GetValidator(self) -> Validator
Returns a pointer to the current validator for the window, or None if there is none.
def GetValidator(*args, **kwargs): """ GetValidator(self) -> Validator Returns a pointer to the current validator for the window, or None if there is none. """ return _core_.Window_GetValidator(*args, **kwargs)
def GetValue(
*args, **kwargs)
GetValue(self) -> String
Returns the current value in the text field.
def GetValue(*args, **kwargs): """ GetValue(self) -> String Returns the current value in the text field. """ return _core_.TextEntryBase_GetValue(*args, **kwargs)
def GetViewEOL(
*args, **kwargs)
GetViewEOL(self) -> bool
Are the end of line characters visible?
def GetViewEOL(*args, **kwargs): """ GetViewEOL(self) -> bool Are the end of line characters visible? """ return _stc.StyledTextCtrl_GetViewEOL(*args, **kwargs)
def GetViewWhiteSpace(
*args, **kwargs)
GetViewWhiteSpace(self) -> int
Are white space characters currently visible? Returns one of SCWS_* constants.
def GetViewWhiteSpace(*args, **kwargs): """ GetViewWhiteSpace(self) -> int Are white space characters currently visible? Returns one of SCWS_* constants. """ return _stc.StyledTextCtrl_GetViewWhiteSpace(*args, **kwargs)
def GetVirtualSize(
*args, **kwargs)
GetVirtualSize(self) -> Size
Get the the virtual size of the window in pixels. For most windows this is just the client area of the window, but for some like scrolled windows it is more or less independent of the screen window size.
def GetVirtualSize(*args, **kwargs): """ GetVirtualSize(self) -> Size Get the the virtual size of the window in pixels. For most windows this is just the client area of the window, but for some like scrolled windows it is more or less independent of the screen window size. """ return _core_.Window_GetVirtualSize(*args, **kwargs)
def GetVirtualSizeTuple(
*args, **kwargs)
GetVirtualSizeTuple() -> (width, height)
Get the the virtual size of the window in pixels. For most windows this is just the client area of the window, but for some like scrolled windows it is more or less independent of the screen window size.
def GetVirtualSizeTuple(*args, **kwargs): """ GetVirtualSizeTuple() -> (width, height) Get the the virtual size of the window in pixels. For most windows this is just the client area of the window, but for some like scrolled windows it is more or less independent of the screen window size. """ return _core_.Window_GetVirtualSizeTuple(*args, **kwargs)
def GetVirtualSpaceOptions(
*args, **kwargs)
GetVirtualSpaceOptions(self) -> int
def GetVirtualSpaceOptions(*args, **kwargs): """GetVirtualSpaceOptions(self) -> int""" return _stc.StyledTextCtrl_GetVirtualSpaceOptions(*args, **kwargs)
def GetWhitespaceChars(
*args, **kwargs)
GetWhitespaceChars(self) -> String
def GetWhitespaceChars(*args, **kwargs): """GetWhitespaceChars(self) -> String""" return _stc.StyledTextCtrl_GetWhitespaceChars(*args, **kwargs)
def GetWhitespaceSize(
*args, **kwargs)
GetWhitespaceSize(self) -> int
Get the size of the dots used to mark space characters.
def GetWhitespaceSize(*args, **kwargs): """ GetWhitespaceSize(self) -> int Get the size of the dots used to mark space characters. """ return _stc.StyledTextCtrl_GetWhitespaceSize(*args, **kwargs)
def GetWindowBorderSize(
*args, **kwargs)
GetWindowBorderSize(self) -> Size
Return the size of the left/right and top/bottom borders.
def GetWindowBorderSize(*args, **kwargs): """ GetWindowBorderSize(self) -> Size Return the size of the left/right and top/bottom borders. """ return _core_.Window_GetWindowBorderSize(*args, **kwargs)
def GetWindowStyle(
*args, **kwargs)
GetWindowStyleFlag(self) -> long
Gets the window style that was passed to the constructor or Create method.
def GetWindowStyleFlag(*args, **kwargs): """ GetWindowStyleFlag(self) -> long Gets the window style that was passed to the constructor or Create method. """ return _core_.Window_GetWindowStyleFlag(*args, **kwargs)
def GetWindowStyleFlag(
*args, **kwargs)
GetWindowStyleFlag(self) -> long
Gets the window style that was passed to the constructor or Create method.
def GetWindowStyleFlag(*args, **kwargs): """ GetWindowStyleFlag(self) -> long Gets the window style that was passed to the constructor or Create method. """ return _core_.Window_GetWindowStyleFlag(*args, **kwargs)
def GetWindowVariant(
*args, **kwargs)
GetWindowVariant(self) -> int
def GetWindowVariant(*args, **kwargs): """GetWindowVariant(self) -> int""" return _core_.Window_GetWindowVariant(*args, **kwargs)
def GetWordChars(
*args, **kwargs)
GetWordChars(self) -> String
def GetWordChars(*args, **kwargs): """GetWordChars(self) -> String""" return _stc.StyledTextCtrl_GetWordChars(*args, **kwargs)
def GetWrapIndentMode(
*args, **kwargs)
GetWrapIndentMode(self) -> int
Retrieve how wrapped sublines are placed. Default is fixed.
def GetWrapIndentMode(*args, **kwargs): """ GetWrapIndentMode(self) -> int Retrieve how wrapped sublines are placed. Default is fixed. """ return _stc.StyledTextCtrl_GetWrapIndentMode(*args, **kwargs)
def GetWrapMode(
*args, **kwargs)
GetWrapMode(self) -> int
Retrieve whether text is word wrapped.
def GetWrapMode(*args, **kwargs): """ GetWrapMode(self) -> int Retrieve whether text is word wrapped. """ return _stc.StyledTextCtrl_GetWrapMode(*args, **kwargs)
def GetWrapStartIndent(
*args, **kwargs)
GetWrapStartIndent(self) -> int
Retrive the start indent for wrapped lines.
def GetWrapStartIndent(*args, **kwargs): """ GetWrapStartIndent(self) -> int Retrive the start indent for wrapped lines. """ return _stc.StyledTextCtrl_GetWrapStartIndent(*args, **kwargs)
def GetWrapVisualFlags(
*args, **kwargs)
GetWrapVisualFlags(self) -> int
Retrive the display mode of visual flags for wrapped lines.
def GetWrapVisualFlags(*args, **kwargs): """ GetWrapVisualFlags(self) -> int Retrive the display mode of visual flags for wrapped lines. """ return _stc.StyledTextCtrl_GetWrapVisualFlags(*args, **kwargs)
def GetWrapVisualFlagsLocation(
*args, **kwargs)
GetWrapVisualFlagsLocation(self) -> int
Retrive the location of visual flags for wrapped lines.
def GetWrapVisualFlagsLocation(*args, **kwargs): """ GetWrapVisualFlagsLocation(self) -> int Retrive the location of visual flags for wrapped lines. """ return _stc.StyledTextCtrl_GetWrapVisualFlagsLocation(*args, **kwargs)
def GetXOffset(
*args, **kwargs)
GetXOffset(self) -> int
def GetXOffset(*args, **kwargs): """GetXOffset(self) -> int""" return _stc.StyledTextCtrl_GetXOffset(*args, **kwargs)
def GetZoom(
*args, **kwargs)
GetZoom(self) -> int
Retrieve the zoom level.
def GetZoom(*args, **kwargs): """ GetZoom(self) -> int Retrieve the zoom level. """ return _stc.StyledTextCtrl_GetZoom(*args, **kwargs)
def GotoLine(
*args, **kwargs)
GotoLine(self, int line)
Set caret to start of a line and ensure it is visible.
def GotoLine(*args, **kwargs): """ GotoLine(self, int line) Set caret to start of a line and ensure it is visible. """ return _stc.StyledTextCtrl_GotoLine(*args, **kwargs)
def GotoPos(
*args, **kwargs)
GotoPos(self, int pos)
Set caret to a position and ensure it is visible.
def GotoPos(*args, **kwargs): """ GotoPos(self, int pos) Set caret to a position and ensure it is visible. """ return _stc.StyledTextCtrl_GotoPos(*args, **kwargs)
HandleAsNavigationKey(self, KeyEvent event) -> bool
This function will generate the appropriate call to Navigate if the
key event is one normally used for keyboard navigation. Returns
True if the key pressed was for navigation and was handled,
False otherwise.
def HandleWindowEvent(
*args, **kwargs)
HandleWindowEvent(self, Event event) -> bool
Process an event by calling GetEventHandler()->ProcessEvent() and handling any exceptions thrown by event handlers. It's mostly useful when processing wx events when called from C code (e.g. in GTK+ callback) when the exception wouldn't correctly propagate to wx.EventLoop.
def HandleWindowEvent(*args, **kwargs): """ HandleWindowEvent(self, Event event) -> bool Process an event by calling GetEventHandler()->ProcessEvent() and handling any exceptions thrown by event handlers. It's mostly useful when processing wx events when called from C code (e.g. in GTK+ callback) when the exception wouldn't correctly propagate to wx.EventLoop. """ return _core_.Window_HandleWindowEvent(*args, **kwargs)
def HasCapture(
*args, **kwargs)
HasCapture(self) -> bool
Returns true if this window has the current mouse capture.
def HasCapture(*args, **kwargs): """ HasCapture(self) -> bool Returns true if this window has the current mouse capture. """ return _core_.Window_HasCapture(*args, **kwargs)
def HasExtraStyle(
*args, **kwargs)
HasExtraStyle(self, int exFlag) -> bool
Returns True if the given extra flag is set.
def HasExtraStyle(*args, **kwargs): """ HasExtraStyle(self, int exFlag) -> bool Returns ``True`` if the given extra flag is set. """ return _core_.Window_HasExtraStyle(*args, **kwargs)
def HasFlag(
*args, **kwargs)
HasFlag(self, int flag) -> bool
Test if the given style is set for this window.
def HasFlag(*args, **kwargs): """ HasFlag(self, int flag) -> bool Test if the given style is set for this window. """ return _core_.Window_HasFlag(*args, **kwargs)
def HasFocus(
*args, **kwargs)
HasFocus(self) -> bool
Returns True if the window has the keyboard focus.
def HasFocus(*args, **kwargs): """ HasFocus(self) -> bool Returns ``True`` if the window has the keyboard focus. """ return _core_.Window_HasFocus(*args, **kwargs)
def HasMultiplePages(
*args, **kwargs)
HasMultiplePages(self) -> bool
def HasMultiplePages(*args, **kwargs): """HasMultiplePages(self) -> bool""" return _core_.Window_HasMultiplePages(*args, **kwargs)
def HasScrollbar(
*args, **kwargs)
HasScrollbar(self, int orient) -> bool
Does the window have the scrollbar for this orientation?
def HasScrollbar(*args, **kwargs): """ HasScrollbar(self, int orient) -> bool Does the window have the scrollbar for this orientation? """ return _core_.Window_HasScrollbar(*args, **kwargs)
def HasSelection(
*args, **kwargs)
HasSelection(self) -> bool
Returns True if there is a non-empty selection in the text field.
def HasSelection(*args, **kwargs): """ HasSelection(self) -> bool Returns True if there is a non-empty selection in the text field. """ return _core_.TextEntryBase_HasSelection(*args, **kwargs)
def HasTransparentBackground(
*args, **kwargs)
HasTransparentBackground(self) -> bool
Returns True if this window's background is transparent (as, for
example, for wx.StaticText) and should show the parent window's
background.
This method is mostly used internally by the library itself and you normally shouldn't have to call it. You may, however, have to override it in your custom control classes to ensure that background is painted correctly.
def HasTransparentBackground(*args, **kwargs): """ HasTransparentBackground(self) -> bool Returns True if this window's background is transparent (as, for example, for `wx.StaticText`) and should show the parent window's background. This method is mostly used internally by the library itself and you normally shouldn't have to call it. You may, however, have to override it in your custom control classes to ensure that background is painted correctly. """ return _core_.Window_HasTransparentBackground(*args, **kwargs)
def Hide(
*args, **kwargs)
Hide(self) -> bool
Equivalent to calling Show(False).
def Hide(*args, **kwargs): """ Hide(self) -> bool Equivalent to calling Show(False). """ return _core_.Window_Hide(*args, **kwargs)
def HideLines(
*args, **kwargs)
HideLines(self, int lineStart, int lineEnd)
Make a range of lines invisible.
def HideLines(*args, **kwargs): """ HideLines(self, int lineStart, int lineEnd) Make a range of lines invisible. """ return _stc.StyledTextCtrl_HideLines(*args, **kwargs)
def HideSelection(
*args, **kwargs)
HideSelection(self, bool normal)
Draw the selection in normal style or with selection highlighted.
def HideSelection(*args, **kwargs): """ HideSelection(self, bool normal) Draw the selection in normal style or with selection highlighted. """ return _stc.StyledTextCtrl_HideSelection(*args, **kwargs)
def HideWithEffect(
*args, **kwargs)
HideWithEffect(self, int effect, unsigned int timeout=0) -> bool
Hide the window with a special effect, not implemented on most platforms (where it is the same as Hide())
Timeout specifies how long the animation should take, in ms, the default value of 0 means to use the default (system-dependent) value.
def HideWithEffect(*args, **kwargs): """ HideWithEffect(self, int effect, unsigned int timeout=0) -> bool Hide the window with a special effect, not implemented on most platforms (where it is the same as Hide()) Timeout specifies how long the animation should take, in ms, the default value of 0 means to use the default (system-dependent) value. """ return _core_.Window_HideWithEffect(*args, **kwargs)
def HitTest(
*args, **kwargs)
HitTest(self, Point pt) -> int
Test where the given (in client coords) point lies
def HitTest(*args, **kwargs): """ HitTest(self, Point pt) -> int Test where the given (in client coords) point lies """ return _core_.Window_HitTest(*args, **kwargs)
def HitTestPos(
*args, **kwargs)
HitTestPos(Point pt) -> (result, position)
Find the character position in the text coresponding to the point given in pixels. NB: pt is in device coords but is not adjusted for the client area origin nor scrolling.
def HitTestPos(*args, **kwargs): """ HitTestPos(Point pt) -> (result, position) Find the character position in the text coresponding to the point given in pixels. NB: pt is in device coords but is not adjusted for the client area origin nor scrolling. """ return _core_.TextAreaBase_HitTestPos(*args, **kwargs)
def HitTestXY(
*args, **kwargs)
HitTestXY(self, int x, int y) -> int
Test where the given (in client coords) point lies
def HitTestXY(*args, **kwargs): """ HitTestXY(self, int x, int y) -> int Test where the given (in client coords) point lies """ return _core_.Window_HitTestXY(*args, **kwargs)
def Home(
*args, **kwargs)
Home(self)
Move caret to first position on line.
def Home(*args, **kwargs): """ Home(self) Move caret to first position on line. """ return _stc.StyledTextCtrl_Home(*args, **kwargs)
def HomeDisplay(
*args, **kwargs)
HomeDisplay(self)
Move caret to first position on display line.
def HomeDisplay(*args, **kwargs): """ HomeDisplay(self) Move caret to first position on display line. """ return _stc.StyledTextCtrl_HomeDisplay(*args, **kwargs)
def HomeDisplayExtend(
*args, **kwargs)
HomeDisplayExtend(self)
Move caret to first position on display line extending selection to new caret position.
def HomeDisplayExtend(*args, **kwargs): """ HomeDisplayExtend(self) Move caret to first position on display line extending selection to new caret position. """ return _stc.StyledTextCtrl_HomeDisplayExtend(*args, **kwargs)
def HomeExtend(
*args, **kwargs)
HomeExtend(self)
Move caret to first position on line extending selection to new caret position.
def HomeExtend(*args, **kwargs): """ HomeExtend(self) Move caret to first position on line extending selection to new caret position. """ return _stc.StyledTextCtrl_HomeExtend(*args, **kwargs)
def HomeRectExtend(
*args, **kwargs)
HomeRectExtend(self)
Move caret to first position on line, extending rectangular selection to new caret position.
def HomeRectExtend(*args, **kwargs): """ HomeRectExtend(self) Move caret to first position on line, extending rectangular selection to new caret position. """ return _stc.StyledTextCtrl_HomeRectExtend(*args, **kwargs)
def 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)?.
def 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)?. """ return _stc.StyledTextCtrl_HomeWrap(*args, **kwargs)
def HomeWrapExtend(
*args, **kwargs)
HomeWrapExtend(self)
def HomeWrapExtend(*args, **kwargs): """HomeWrapExtend(self)""" return _stc.StyledTextCtrl_HomeWrapExtend(*args, **kwargs)
def IndicatorAllOnFor(
*args, **kwargs)
IndicatorAllOnFor(self, int position) -> int
Are any indicators present at position?
def IndicatorAllOnFor(*args, **kwargs): """ IndicatorAllOnFor(self, int position) -> int Are any indicators present at position? """ return _stc.StyledTextCtrl_IndicatorAllOnFor(*args, **kwargs)
def IndicatorClearRange(
*args, **kwargs)
IndicatorClearRange(self, int position, int clearLength)
Turn a indicator off over a range.
def IndicatorClearRange(*args, **kwargs): """ IndicatorClearRange(self, int position, int clearLength) Turn a indicator off over a range. """ return _stc.StyledTextCtrl_IndicatorClearRange(*args, **kwargs)
def IndicatorEnd(
*args, **kwargs)
IndicatorEnd(self, int indicator, int position) -> int
Where does a particular indicator end?
def IndicatorEnd(*args, **kwargs): """ IndicatorEnd(self, int indicator, int position) -> int Where does a particular indicator end? """ return _stc.StyledTextCtrl_IndicatorEnd(*args, **kwargs)
def IndicatorFillRange(
*args, **kwargs)
IndicatorFillRange(self, int position, int fillLength)
Turn a indicator on over a range.
def IndicatorFillRange(*args, **kwargs): """ IndicatorFillRange(self, int position, int fillLength) Turn a indicator on over a range. """ return _stc.StyledTextCtrl_IndicatorFillRange(*args, **kwargs)
def IndicatorGetAlpha(
*args, **kwargs)
IndicatorGetAlpha(self, int indicator) -> int
Get the alpha fill colour of the given indicator.
def IndicatorGetAlpha(*args, **kwargs): """ IndicatorGetAlpha(self, int indicator) -> int Get the alpha fill colour of the given indicator. """ return _stc.StyledTextCtrl_IndicatorGetAlpha(*args, **kwargs)
def IndicatorGetForeground(
*args, **kwargs)
IndicatorGetForeground(self, int indic) -> Colour
Retrieve the foreground colour of an indicator.
def IndicatorGetForeground(*args, **kwargs): """ IndicatorGetForeground(self, int indic) -> Colour Retrieve the foreground colour of an indicator. """ return _stc.StyledTextCtrl_IndicatorGetForeground(*args, **kwargs)
def IndicatorGetOutlineAlpha(
*args, **kwargs)
IndicatorGetOutlineAlpha(self, int indicator) -> int
def IndicatorGetOutlineAlpha(*args, **kwargs): """IndicatorGetOutlineAlpha(self, int indicator) -> int""" return _stc.StyledTextCtrl_IndicatorGetOutlineAlpha(*args, **kwargs)
def IndicatorGetStyle(
*args, **kwargs)
IndicatorGetStyle(self, int indic) -> int
Retrieve the style of an indicator.
def IndicatorGetStyle(*args, **kwargs): """ IndicatorGetStyle(self, int indic) -> int Retrieve the style of an indicator. """ return _stc.StyledTextCtrl_IndicatorGetStyle(*args, **kwargs)
def IndicatorGetUnder(
*args, **kwargs)
IndicatorGetUnder(self, int indic) -> bool
Retrieve whether indicator drawn under or over text.
def IndicatorGetUnder(*args, **kwargs): """ IndicatorGetUnder(self, int indic) -> bool Retrieve whether indicator drawn under or over text. """ return _stc.StyledTextCtrl_IndicatorGetUnder(*args, **kwargs)
def IndicatorSetAlpha(
*args, **kwargs)
IndicatorSetAlpha(self, int indicator, int alpha)
Set the alpha fill colour of the given indicator.
def IndicatorSetAlpha(*args, **kwargs): """ IndicatorSetAlpha(self, int indicator, int alpha) Set the alpha fill colour of the given indicator. """ return _stc.StyledTextCtrl_IndicatorSetAlpha(*args, **kwargs)
def IndicatorSetForeground(
*args, **kwargs)
IndicatorSetForeground(self, int indic, Colour fore)
Set the foreground colour of an indicator.
def IndicatorSetForeground(*args, **kwargs): """ IndicatorSetForeground(self, int indic, Colour fore) Set the foreground colour of an indicator. """ return _stc.StyledTextCtrl_IndicatorSetForeground(*args, **kwargs)
def IndicatorSetOutlineAlpha(
*args, **kwargs)
IndicatorSetOutlineAlpha(self, int indicator, int alpha)
def IndicatorSetOutlineAlpha(*args, **kwargs): """IndicatorSetOutlineAlpha(self, int indicator, int alpha)""" return _stc.StyledTextCtrl_IndicatorSetOutlineAlpha(*args, **kwargs)
def IndicatorSetStyle(
*args, **kwargs)
IndicatorSetStyle(self, int indic, int style)
Set an indicator to plain, squiggle or TT.
def IndicatorSetStyle(*args, **kwargs): """ IndicatorSetStyle(self, int indic, int style) Set an indicator to plain, squiggle or TT. """ return _stc.StyledTextCtrl_IndicatorSetStyle(*args, **kwargs)
def IndicatorSetUnder(
*args, **kwargs)
IndicatorSetUnder(self, int indic, bool under)
Set an indicator to draw under text or over(default).
def IndicatorSetUnder(*args, **kwargs): """ IndicatorSetUnder(self, int indic, bool under) Set an indicator to draw under text or over(default). """ return _stc.StyledTextCtrl_IndicatorSetUnder(*args, **kwargs)
def IndicatorStart(
*args, **kwargs)
IndicatorStart(self, int indicator, int position) -> int
Where does a particular indicator start?
def IndicatorStart(*args, **kwargs): """ IndicatorStart(self, int indicator, int position) -> int Where does a particular indicator start? """ return _stc.StyledTextCtrl_IndicatorStart(*args, **kwargs)
def IndicatorValueAt(
*args, **kwargs)
IndicatorValueAt(self, int indicator, int position) -> int
What value does a particular indicator have at at a position?
def IndicatorValueAt(*args, **kwargs): """ IndicatorValueAt(self, int indicator, int position) -> int What value does a particular indicator have at at a position? """ return _stc.StyledTextCtrl_IndicatorValueAt(*args, **kwargs)
def InformFirstDirection(
*args, **kwargs)
InformFirstDirection(self, int direction, int size, int availableOtherDir) -> bool
wxSizer and friends use this to give a chance to a component to recalc its min size once one of the final size components is known. Override this function when that is useful (such as for wxStaticText which can stretch over several lines). Parameter availableOtherDir tells the item how much more space there is available in the opposite direction (-1 if unknown).
def InformFirstDirection(*args, **kwargs): """ InformFirstDirection(self, int direction, int size, int availableOtherDir) -> bool wxSizer and friends use this to give a chance to a component to recalc its min size once one of the final size components is known. Override this function when that is useful (such as for wxStaticText which can stretch over several lines). Parameter availableOtherDir tells the item how much more space there is available in the opposite direction (-1 if unknown). """ return _core_.Window_InformFirstDirection(*args, **kwargs)
def InheritAttributes(
*args, **kwargs)
InheritAttributes(self)
This function is (or should be, in case of custom controls) called during window creation to intelligently set up the window visual attributes, that is the font and the foreground and background colours.
By 'intelligently' the following is meant: by default, all windows use their own default attributes. However if some of the parent's attributes are explicitly changed (that is, using SetFont and not SetOwnFont) and if the corresponding attribute hadn't been explicitly set for this window itself, then this window takes the same value as used by the parent. In addition, if the window overrides ShouldInheritColours to return false, the colours will not be changed no matter what and only the font might.
This rather complicated logic is necessary in order to accommodate the different usage scenarios. The most common one is when all default attributes are used and in this case, nothing should be inherited as in modern GUIs different controls use different fonts (and colours) than their siblings so they can't inherit the same value from the parent. However it was also deemed desirable to allow to simply change the attributes of all children at once by just changing the font or colour of their common parent, hence in this case we do inherit the parents attributes.
def InheritAttributes(*args, **kwargs): """ InheritAttributes(self) This function is (or should be, in case of custom controls) called during window creation to intelligently set up the window visual attributes, that is the font and the foreground and background colours. By 'intelligently' the following is meant: by default, all windows use their own default attributes. However if some of the parent's attributes are explicitly changed (that is, using SetFont and not SetOwnFont) and if the corresponding attribute hadn't been explicitly set for this window itself, then this window takes the same value as used by the parent. In addition, if the window overrides ShouldInheritColours to return false, the colours will not be changed no matter what and only the font might. This rather complicated logic is necessary in order to accommodate the different usage scenarios. The most common one is when all default attributes are used and in this case, nothing should be inherited as in modern GUIs different controls use different fonts (and colours) than their siblings so they can't inherit the same value from the parent. However it was also deemed desirable to allow to simply change the attributes of all children at once by just changing the font or colour of their common parent, hence in this case we do inherit the parents attributes. """ return _core_.Window_InheritAttributes(*args, **kwargs)
def InheritsBackgroundColour(
*args, **kwargs)
InheritsBackgroundColour(self) -> bool
def InheritsBackgroundColour(*args, **kwargs): """InheritsBackgroundColour(self) -> bool""" return _core_.Window_InheritsBackgroundColour(*args, **kwargs)
def InitDialog(
*args, **kwargs)
InitDialog(self)
Sends an EVT_INIT_DIALOG event, whose handler usually transfers data to the dialog via validators.
def InitDialog(*args, **kwargs): """ InitDialog(self) Sends an EVT_INIT_DIALOG event, whose handler usually transfers data to the dialog via validators. """ return _core_.Window_InitDialog(*args, **kwargs)
def InsertText(
*args, **kwargs)
InsertText(self, int pos, String text)
Insert string at a position.
def InsertText(*args, **kwargs): """ InsertText(self, int pos, String text) Insert string at a position. """ return _stc.StyledTextCtrl_InsertText(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_InsertTextRaw(*args, **kwargs)
def InsertTextUTF8(
self, pos, text)
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.
def InsertTextUTF8(self, pos, text): """ 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. """ if not wx.USE_UNICODE: u = text.decode('utf-8') text = u.encode(wx.GetDefaultPyEncoding()) self.InsertTextRaw(pos, text)
def InvalidateBestSize(
*args, **kwargs)
InvalidateBestSize(self)
Reset the cached best size value so it will be recalculated the next time it is needed.
def InvalidateBestSize(*args, **kwargs): """ InvalidateBestSize(self) Reset the cached best size value so it will be recalculated the next time it is needed. """ return _core_.Window_InvalidateBestSize(*args, **kwargs)
def IsBeingDeleted(
*args, **kwargs)
IsBeingDeleted(self) -> bool
Is the window in the process of being deleted?
def IsBeingDeleted(*args, **kwargs): """ IsBeingDeleted(self) -> bool Is the window in the process of being deleted? """ return _core_.Window_IsBeingDeleted(*args, **kwargs)
def IsDoubleBuffered(
*args, **kwargs)
IsDoubleBuffered(self) -> bool
Returns True if the window contents is double-buffered by the
system, i.e. if any drawing done on the window is really done on a
temporary backing surface and transferred to the screen all at once
later.
def IsDoubleBuffered(*args, **kwargs): """ IsDoubleBuffered(self) -> bool Returns ``True`` if the window contents is double-buffered by the system, i.e. if any drawing done on the window is really done on a temporary backing surface and transferred to the screen all at once later. """ return _core_.Window_IsDoubleBuffered(*args, **kwargs)
def IsEditable(
*args, **kwargs)
IsEditable(self) -> bool
def IsEditable(*args, **kwargs): """IsEditable(self) -> bool""" return _core_.TextEntryBase_IsEditable(*args, **kwargs)
def IsEmpty(
*args, **kwargs)
IsEmpty(self) -> bool
Returns True if the value in the text field is empty.
def IsEmpty(*args, **kwargs): """ IsEmpty(self) -> bool Returns True if the value in the text field is empty. """ return _core_.TextEntryBase_IsEmpty(*args, **kwargs)
def IsEnabled(
*args, **kwargs)
IsEnabled(self) -> bool
Returns true if the window is enabled for input, false otherwise. This method takes into account the enabled state of parent windows up to the top-level window.
def IsEnabled(*args, **kwargs): """ IsEnabled(self) -> bool Returns true if the window is enabled for input, false otherwise. This method takes into account the enabled state of parent windows up to the top-level window. """ return _core_.Window_IsEnabled(*args, **kwargs)
def IsExposed(
*args, **kwargs)
IsExposed(self, int x, int y, int w=1, int h=1) -> bool
Returns true if the given point or rectangle area has been exposed since the last repaint. Call this in an paint event handler to optimize redrawing by only redrawing those areas, which have been exposed.
def IsExposed(*args, **kwargs): """ IsExposed(self, int x, int y, int w=1, int h=1) -> bool Returns true if the given point or rectangle area has been exposed since the last repaint. Call this in an paint event handler to optimize redrawing by only redrawing those areas, which have been exposed. """ return _core_.Window_IsExposed(*args, **kwargs)
def IsExposedPoint(
*args, **kwargs)
IsExposedPoint(self, Point pt) -> bool
Returns true if the given point or rectangle area has been exposed since the last repaint. Call this in an paint event handler to optimize redrawing by only redrawing those areas, which have been exposed.
def IsExposedPoint(*args, **kwargs): """ IsExposedPoint(self, Point pt) -> bool Returns true if the given point or rectangle area has been exposed since the last repaint. Call this in an paint event handler to optimize redrawing by only redrawing those areas, which have been exposed. """ return _core_.Window_IsExposedPoint(*args, **kwargs)
def IsExposedRect(
*args, **kwargs)
IsExposedRect(self, Rect rect) -> bool
Returns true if the given point or rectangle area has been exposed since the last repaint. Call this in an paint event handler to optimize redrawing by only redrawing those areas, which have been exposed.
def IsExposedRect(*args, **kwargs): """ IsExposedRect(self, Rect rect) -> bool Returns true if the given point or rectangle area has been exposed since the last repaint. Call this in an paint event handler to optimize redrawing by only redrawing those areas, which have been exposed. """ return _core_.Window_IsExposedRect(*args, **kwargs)
def IsFrozen(
*args, **kwargs)
IsFrozen(self) -> bool
Returns True if the window has been frozen and not thawed yet.
:see: Freeze and Thaw
def IsFrozen(*args, **kwargs): """ IsFrozen(self) -> bool Returns ``True`` if the window has been frozen and not thawed yet. :see: `Freeze` and `Thaw` """ return _core_.Window_IsFrozen(*args, **kwargs)
def IsModified(
*args, **kwargs)
IsModified(self) -> bool
def IsModified(*args, **kwargs): """IsModified(self) -> bool""" return _core_.TextAreaBase_IsModified(*args, **kwargs)
def IsRetained(
*args, **kwargs)
IsRetained(self) -> bool
Returns true if the window is retained, false otherwise. Retained windows are only available on X platforms.
def IsRetained(*args, **kwargs): """ IsRetained(self) -> bool Returns true if the window is retained, false otherwise. Retained windows are only available on X platforms. """ return _core_.Window_IsRetained(*args, **kwargs)
def IsSameAs(
*args, **kwargs)
IsSameAs(self, Object p) -> bool
For wx.Objects that use C++ reference counting internally, this method can be used to determine if two objects are referencing the same data object.
def IsSameAs(*args, **kwargs): """ IsSameAs(self, Object p) -> bool For wx.Objects that use C++ reference counting internally, this method can be used to determine if two objects are referencing the same data object. """ return _core_.Object_IsSameAs(*args, **kwargs)
def IsScrollbarAlwaysShown(
*args, **kwargs)
IsScrollbarAlwaysShown(self, int orient) -> bool
def IsScrollbarAlwaysShown(*args, **kwargs): """IsScrollbarAlwaysShown(self, int orient) -> bool""" return _core_.Window_IsScrollbarAlwaysShown(*args, **kwargs)
def IsShown(
*args, **kwargs)
IsShown(self) -> bool
Returns true if the window is shown, false if it has been hidden.
def IsShown(*args, **kwargs): """ IsShown(self) -> bool Returns true if the window is shown, false if it has been hidden. """ return _core_.Window_IsShown(*args, **kwargs)
def IsShownOnScreen(
*args, **kwargs)
IsShownOnScreen(self) -> bool
Returns True if the window is physically visible on the screen,
i.e. it is shown and all its parents up to the toplevel window are
shown as well.
def IsShownOnScreen(*args, **kwargs): """ IsShownOnScreen(self) -> bool Returns ``True`` if the window is physically visible on the screen, i.e. it is shown and all its parents up to the toplevel window are shown as well. """ return _core_.Window_IsShownOnScreen(*args, **kwargs)
def IsThisEnabled(
*args, **kwargs)
IsThisEnabled(self) -> bool
Returns the internal enabled state independent of the parent(s) state,
i.e. the state in which the window would be if all of its parents are
enabled. Use IsEnabled to get the effective window state.
def IsThisEnabled(*args, **kwargs): """ IsThisEnabled(self) -> bool Returns the internal enabled state independent of the parent(s) state, i.e. the state in which the window would be if all of its parents are enabled. Use `IsEnabled` to get the effective window state. """ return _core_.Window_IsThisEnabled(*args, **kwargs)
def IsTopLevel(
*args, **kwargs)
IsTopLevel(self) -> bool
Returns true if the given window is a top-level one. Currently all frames and dialogs are always considered to be top-level windows (even if they have a parent window).
def IsTopLevel(*args, **kwargs): """ IsTopLevel(self) -> bool Returns true if the given window is a top-level one. Currently all frames and dialogs are always considered to be top-level windows (even if they have a parent window). """ return _core_.Window_IsTopLevel(*args, **kwargs)
def IsUnlinked(
*args, **kwargs)
IsUnlinked(self) -> bool
def IsUnlinked(*args, **kwargs): """IsUnlinked(self) -> bool""" return _core_.EvtHandler_IsUnlinked(*args, **kwargs)
def Layout(
*args, **kwargs)
Layout(self) -> bool
Invokes the constraint-based layout algorithm or the sizer-based algorithm for this window. See SetAutoLayout: when auto layout is on, this function gets called automatically by the default EVT_SIZE handler when the window is resized.
def Layout(*args, **kwargs): """ Layout(self) -> bool Invokes the constraint-based layout algorithm or the sizer-based algorithm for this window. See SetAutoLayout: when auto layout is on, this function gets called automatically by the default EVT_SIZE handler when the window is resized. """ return _core_.Window_Layout(*args, **kwargs)
def LineCopy(
*args, **kwargs)
LineCopy(self)
Copy the line containing the caret.
def LineCopy(*args, **kwargs): """ LineCopy(self) Copy the line containing the caret. """ return _stc.StyledTextCtrl_LineCopy(*args, **kwargs)
def LineCut(
*args, **kwargs)
LineCut(self)
Cut the line containing the caret.
def LineCut(*args, **kwargs): """ LineCut(self) Cut the line containing the caret. """ return _stc.StyledTextCtrl_LineCut(*args, **kwargs)
def LineDelete(
*args, **kwargs)
LineDelete(self)
Delete the line containing the caret.
def LineDelete(*args, **kwargs): """ LineDelete(self) Delete the line containing the caret. """ return _stc.StyledTextCtrl_LineDelete(*args, **kwargs)
def LineDown(
*args, **kwargs)
LineDown(self)
Move caret down one line.
def LineDown(*args, **kwargs): """ LineDown(self) Move caret down one line. """ return _stc.StyledTextCtrl_LineDown(*args, **kwargs)
def LineDownExtend(
*args, **kwargs)
LineDownExtend(self)
Move caret down one line extending selection to new caret position.
def LineDownExtend(*args, **kwargs): """ LineDownExtend(self) Move caret down one line extending selection to new caret position. """ return _stc.StyledTextCtrl_LineDownExtend(*args, **kwargs)
def LineDownRectExtend(
*args, **kwargs)
LineDownRectExtend(self)
Move caret down one line, extending rectangular selection to new caret position.
def LineDownRectExtend(*args, **kwargs): """ LineDownRectExtend(self) Move caret down one line, extending rectangular selection to new caret position. """ return _stc.StyledTextCtrl_LineDownRectExtend(*args, **kwargs)
def LineDuplicate(
*args, **kwargs)
LineDuplicate(self)
Duplicate the current line.
def LineDuplicate(*args, **kwargs): """ LineDuplicate(self) Duplicate the current line. """ return _stc.StyledTextCtrl_LineDuplicate(*args, **kwargs)
def LineEnd(
*args, **kwargs)
LineEnd(self)
Move caret to last position on line.
def LineEnd(*args, **kwargs): """ LineEnd(self) Move caret to last position on line. """ return _stc.StyledTextCtrl_LineEnd(*args, **kwargs)
def LineEndDisplay(
*args, **kwargs)
LineEndDisplay(self)
Move caret to last position on display line.
def LineEndDisplay(*args, **kwargs): """ LineEndDisplay(self) Move caret to last position on display line. """ return _stc.StyledTextCtrl_LineEndDisplay(*args, **kwargs)
def LineEndDisplayExtend(
*args, **kwargs)
LineEndDisplayExtend(self)
Move caret to last position on display line extending selection to new caret position.
def LineEndDisplayExtend(*args, **kwargs): """ LineEndDisplayExtend(self) Move caret to last position on display line extending selection to new caret position. """ return _stc.StyledTextCtrl_LineEndDisplayExtend(*args, **kwargs)
def LineEndExtend(
*args, **kwargs)
LineEndExtend(self)
Move caret to last position on line extending selection to new caret position.
def LineEndExtend(*args, **kwargs): """ LineEndExtend(self) Move caret to last position on line extending selection to new caret position. """ return _stc.StyledTextCtrl_LineEndExtend(*args, **kwargs)
def LineEndRectExtend(
*args, **kwargs)
LineEndRectExtend(self)
Move caret to last position on line, extending rectangular selection to new caret position.
def LineEndRectExtend(*args, **kwargs): """ LineEndRectExtend(self) Move caret to last position on line, extending rectangular selection to new caret position. """ return _stc.StyledTextCtrl_LineEndRectExtend(*args, **kwargs)
def LineEndWrap(
*args, **kwargs)
LineEndWrap(self)
def LineEndWrap(*args, **kwargs): """LineEndWrap(self)""" return _stc.StyledTextCtrl_LineEndWrap(*args, **kwargs)
def LineEndWrapExtend(
*args, **kwargs)
LineEndWrapExtend(self)
def LineEndWrapExtend(*args, **kwargs): """LineEndWrapExtend(self)""" return _stc.StyledTextCtrl_LineEndWrapExtend(*args, **kwargs)
def LineFromPosition(
*args, **kwargs)
LineFromPosition(self, int pos) -> int
Retrieve the line containing a position.
def LineFromPosition(*args, **kwargs): """ LineFromPosition(self, int pos) -> int Retrieve the line containing a position. """ return _stc.StyledTextCtrl_LineFromPosition(*args, **kwargs)
def LineLength(
*args, **kwargs)
LineLength(self, int line) -> int
How many characters are on a line, including end of line characters?
def LineLength(*args, **kwargs): """ LineLength(self, int line) -> int How many characters are on a line, including end of line characters? """ return _stc.StyledTextCtrl_LineLength(*args, **kwargs)
def LineScroll(
*args, **kwargs)
LineScroll(self, int columns, int lines)
Scroll horizontally and vertically.
def LineScroll(*args, **kwargs): """ LineScroll(self, int columns, int lines) Scroll horizontally and vertically. """ return _stc.StyledTextCtrl_LineScroll(*args, **kwargs)
def LineScrollDown(
*args, **kwargs)
LineScrollDown(self)
Scroll the document down, keeping the caret visible.
def LineScrollDown(*args, **kwargs): """ LineScrollDown(self) Scroll the document down, keeping the caret visible. """ return _stc.StyledTextCtrl_LineScrollDown(*args, **kwargs)
def LineScrollUp(
*args, **kwargs)
LineScrollUp(self)
Scroll the document up, keeping the caret visible.
def LineScrollUp(*args, **kwargs): """ LineScrollUp(self) Scroll the document up, keeping the caret visible. """ return _stc.StyledTextCtrl_LineScrollUp(*args, **kwargs)
def LineTranspose(
*args, **kwargs)
LineTranspose(self)
Switch the current line with the previous.
def LineTranspose(*args, **kwargs): """ LineTranspose(self) Switch the current line with the previous. """ return _stc.StyledTextCtrl_LineTranspose(*args, **kwargs)
def LineUp(
*args, **kwargs)
LineUp(self)
Move caret up one line.
def LineUp(*args, **kwargs): """ LineUp(self) Move caret up one line. """ return _stc.StyledTextCtrl_LineUp(*args, **kwargs)
def LineUpExtend(
*args, **kwargs)
LineUpExtend(self)
Move caret up one line extending selection to new caret position.
def LineUpExtend(*args, **kwargs): """ LineUpExtend(self) Move caret up one line extending selection to new caret position. """ return _stc.StyledTextCtrl_LineUpExtend(*args, **kwargs)
def LineUpRectExtend(
*args, **kwargs)
LineUpRectExtend(self)
Move caret up one line, extending rectangular selection to new caret position.
def LineUpRectExtend(*args, **kwargs): """ LineUpRectExtend(self) Move caret up one line, extending rectangular selection to new caret position. """ return _stc.StyledTextCtrl_LineUpRectExtend(*args, **kwargs)
def LinesJoin(
*args, **kwargs)
LinesJoin(self)
Join the lines in the target.
def LinesJoin(*args, **kwargs): """ LinesJoin(self) Join the lines in the target. """ return _stc.StyledTextCtrl_LinesJoin(*args, **kwargs)
def LinesOnScreen(
*args, **kwargs)
LinesOnScreen(self) -> int
Retrieves the number of lines completely visible.
def LinesOnScreen(*args, **kwargs): """ LinesOnScreen(self) -> int Retrieves the number of lines completely visible. """ return _stc.StyledTextCtrl_LinesOnScreen(*args, **kwargs)
def LinesSplit(
*args, **kwargs)
LinesSplit(self, int pixelWidth)
Split the lines in the target into lines that are less wide than pixelWidth where possible.
def LinesSplit(*args, **kwargs): """ LinesSplit(self, int pixelWidth) Split the lines in the target into lines that are less wide than pixelWidth where possible. """ return _stc.StyledTextCtrl_LinesSplit(*args, **kwargs)
def LoadFile(
*args, **kwargs)
LoadFile(self, String file, int fileType=wxTEXT_TYPE_ANY) -> bool
def LoadFile(*args, **kwargs): """LoadFile(self, String file, int fileType=wxTEXT_TYPE_ANY) -> bool""" return _core_.TextAreaBase_LoadFile(*args, **kwargs)
def Lower(
*args, **kwargs)
Lower(self)
Lowers the window to the bottom of the window hierarchy. In current version of wxWidgets this works both for managed and child windows.
def Lower(*args, **kwargs): """ Lower(self) Lowers the window to the bottom of the window hierarchy. In current version of wxWidgets this works both for managed and child windows. """ return _core_.Window_Lower(*args, **kwargs)
def LowerCase(
*args, **kwargs)
LowerCase(self)
Transform the selection to lower case.
def LowerCase(*args, **kwargs): """ LowerCase(self) Transform the selection to lower case. """ return _stc.StyledTextCtrl_LowerCase(*args, **kwargs)
def MakeModal(
*args, **kwargs)
MakeModal(self, bool modal=True)
Disables all other windows in the application so that the user can only interact with this window. Passing False will reverse this effect.
def MakeModal(*args, **kwargs): """ MakeModal(self, bool modal=True) Disables all other windows in the application so that the user can only interact with this window. Passing False will reverse this effect. """ return _core_.Window_MakeModal(*args, **kwargs)
def MarginGetStyle(
*args, **kwargs)
MarginGetStyle(self, int line) -> int
Get the style number for the text margin for a line
def MarginGetStyle(*args, **kwargs): """ MarginGetStyle(self, int line) -> int Get the style number for the text margin for a line """ return _stc.StyledTextCtrl_MarginGetStyle(*args, **kwargs)
def MarginGetStyleOffset(
*args, **kwargs)
MarginGetStyleOffset(self) -> int
Get the start of the range of style numbers used for margin text
def MarginGetStyleOffset(*args, **kwargs): """ MarginGetStyleOffset(self) -> int Get the start of the range of style numbers used for margin text """ return _stc.StyledTextCtrl_MarginGetStyleOffset(*args, **kwargs)
def MarginGetStyles(
*args, **kwargs)
MarginGetStyles(self, int line) -> String
Get the styles in the text margin for a line
def MarginGetStyles(*args, **kwargs): """ MarginGetStyles(self, int line) -> String Get the styles in the text margin for a line """ return _stc.StyledTextCtrl_MarginGetStyles(*args, **kwargs)
def MarginGetText(
*args, **kwargs)
MarginGetText(self, int line) -> String
Get the text in the text margin for a line
def MarginGetText(*args, **kwargs): """ MarginGetText(self, int line) -> String Get the text in the text margin for a line """ return _stc.StyledTextCtrl_MarginGetText(*args, **kwargs)
def MarginSetStyle(
*args, **kwargs)
MarginSetStyle(self, int line, int style)
Set the style number for the text margin for a line
def MarginSetStyle(*args, **kwargs): """ MarginSetStyle(self, int line, int style) Set the style number for the text margin for a line """ return _stc.StyledTextCtrl_MarginSetStyle(*args, **kwargs)
def MarginSetStyleOffset(
*args, **kwargs)
MarginSetStyleOffset(self, int style)
Get the start of the range of style numbers used for margin text
def MarginSetStyleOffset(*args, **kwargs): """ MarginSetStyleOffset(self, int style) Get the start of the range of style numbers used for margin text """ return _stc.StyledTextCtrl_MarginSetStyleOffset(*args, **kwargs)
def MarginSetStyles(
*args, **kwargs)
MarginSetStyles(self, int line, String styles)
Set the style in the text margin for a line
def MarginSetStyles(*args, **kwargs): """ MarginSetStyles(self, int line, String styles) Set the style in the text margin for a line """ return _stc.StyledTextCtrl_MarginSetStyles(*args, **kwargs)
def MarginSetText(
*args, **kwargs)
MarginSetText(self, int line, String text)
Set the text in the text margin for a line
def MarginSetText(*args, **kwargs): """ MarginSetText(self, int line, String text) Set the text in the text margin for a line """ return _stc.StyledTextCtrl_MarginSetText(*args, **kwargs)
def MarginTextClearAll(
*args, **kwargs)
MarginTextClearAll(self)
Clear the margin text on all lines
def MarginTextClearAll(*args, **kwargs): """ MarginTextClearAll(self) Clear the margin text on all lines """ return _stc.StyledTextCtrl_MarginTextClearAll(*args, **kwargs)
def MarkDirty(
*args, **kwargs)
MarkDirty(self)
def MarkDirty(*args, **kwargs): """MarkDirty(self)""" return _core_.TextAreaBase_MarkDirty(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_MarkerAdd(*args, **kwargs)
def MarkerAddSet(
*args, **kwargs)
MarkerAddSet(self, int line, int set)
Add a set of markers to a line.
def MarkerAddSet(*args, **kwargs): """ MarkerAddSet(self, int line, int set) Add a set of markers to a line. """ return _stc.StyledTextCtrl_MarkerAddSet(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_MarkerDefine(*args, **kwargs)
def MarkerDefineBitmap(
*args, **kwargs)
MarkerDefineBitmap(self, int markerNumber, Bitmap bmp)
Define a marker from a bitmap
def MarkerDefineBitmap(*args, **kwargs): """ MarkerDefineBitmap(self, int markerNumber, Bitmap bmp) Define a marker from a bitmap """ return _stc.StyledTextCtrl_MarkerDefineBitmap(*args, **kwargs)
def MarkerDefineRGBAImage(
*args, **kwargs)
MarkerDefineRGBAImage(self, int markerNumber, unsigned char pixels)
def MarkerDefineRGBAImage(*args, **kwargs): """MarkerDefineRGBAImage(self, int markerNumber, unsigned char pixels)""" return _stc.StyledTextCtrl_MarkerDefineRGBAImage(*args, **kwargs)
def MarkerDelete(
*args, **kwargs)
MarkerDelete(self, int line, int markerNumber)
Delete a marker from a line.
def MarkerDelete(*args, **kwargs): """ MarkerDelete(self, int line, int markerNumber) Delete a marker from a line. """ return _stc.StyledTextCtrl_MarkerDelete(*args, **kwargs)
def MarkerDeleteAll(
*args, **kwargs)
MarkerDeleteAll(self, int markerNumber)
Delete all markers with a particular number from all lines.
def MarkerDeleteAll(*args, **kwargs): """ MarkerDeleteAll(self, int markerNumber) Delete all markers with a particular number from all lines. """ return _stc.StyledTextCtrl_MarkerDeleteAll(*args, **kwargs)
def MarkerDeleteHandle(
*args, **kwargs)
MarkerDeleteHandle(self, int handle)
Delete a marker.
def MarkerDeleteHandle(*args, **kwargs): """ MarkerDeleteHandle(self, int handle) Delete a marker. """ return _stc.StyledTextCtrl_MarkerDeleteHandle(*args, **kwargs)
def MarkerEnableHighlight(
*args, **kwargs)
MarkerEnableHighlight(self, bool enabled)
def MarkerEnableHighlight(*args, **kwargs): """MarkerEnableHighlight(self, bool enabled)""" return _stc.StyledTextCtrl_MarkerEnableHighlight(*args, **kwargs)
def MarkerGet(
*args, **kwargs)
MarkerGet(self, int line) -> int
Get a bit mask of all the markers set on a line.
def MarkerGet(*args, **kwargs): """ MarkerGet(self, int line) -> int Get a bit mask of all the markers set on a line. """ return _stc.StyledTextCtrl_MarkerGet(*args, **kwargs)
def MarkerLineFromHandle(
*args, **kwargs)
MarkerLineFromHandle(self, int handle) -> int
Retrieve the line number at which a particular marker is located.
def MarkerLineFromHandle(*args, **kwargs): """ MarkerLineFromHandle(self, int handle) -> int Retrieve the line number at which a particular marker is located. """ return _stc.StyledTextCtrl_MarkerLineFromHandle(*args, **kwargs)
def MarkerNext(
*args, **kwargs)
MarkerNext(self, int lineStart, int markerMask) -> int
Find the next line after lineStart that includes a marker in mask.
def MarkerNext(*args, **kwargs): """ MarkerNext(self, int lineStart, int markerMask) -> int Find the next line after lineStart that includes a marker in mask. """ return _stc.StyledTextCtrl_MarkerNext(*args, **kwargs)
def MarkerPrevious(
*args, **kwargs)
MarkerPrevious(self, int lineStart, int markerMask) -> int
Find the previous line before lineStart that includes a marker in mask.
def MarkerPrevious(*args, **kwargs): """ MarkerPrevious(self, int lineStart, int markerMask) -> int Find the previous line before lineStart that includes a marker in mask. """ return _stc.StyledTextCtrl_MarkerPrevious(*args, **kwargs)
def MarkerSetAlpha(
*args, **kwargs)
MarkerSetAlpha(self, int markerNumber, int alpha)
Set the alpha used for a marker that is drawn in the text area, not the margin.
def MarkerSetAlpha(*args, **kwargs): """ MarkerSetAlpha(self, int markerNumber, int alpha) Set the alpha used for a marker that is drawn in the text area, not the margin. """ return _stc.StyledTextCtrl_MarkerSetAlpha(*args, **kwargs)
def MarkerSetBackground(
*args, **kwargs)
MarkerSetBackground(self, int markerNumber, Colour back)
Set the background colour used for a particular marker number.
def MarkerSetBackground(*args, **kwargs): """ MarkerSetBackground(self, int markerNumber, Colour back) Set the background colour used for a particular marker number. """ return _stc.StyledTextCtrl_MarkerSetBackground(*args, **kwargs)
def MarkerSetBackgroundSelected(
*args, **kwargs)
MarkerSetBackgroundSelected(self, int markerNumber, Colour back)
def MarkerSetBackgroundSelected(*args, **kwargs): """MarkerSetBackgroundSelected(self, int markerNumber, Colour back)""" return _stc.StyledTextCtrl_MarkerSetBackgroundSelected(*args, **kwargs)
def MarkerSetForeground(
*args, **kwargs)
MarkerSetForeground(self, int markerNumber, Colour fore)
Set the foreground colour used for a particular marker number.
def MarkerSetForeground(*args, **kwargs): """ MarkerSetForeground(self, int markerNumber, Colour fore) Set the foreground colour used for a particular marker number. """ return _stc.StyledTextCtrl_MarkerSetForeground(*args, **kwargs)
def Move(
*args, **kwargs)
Move(self, Point pt, int flags=SIZE_USE_EXISTING)
Moves the window to the given position.
def Move(*args, **kwargs): """ Move(self, Point pt, int flags=SIZE_USE_EXISTING) Moves the window to the given position. """ return _core_.Window_Move(*args, **kwargs)
def MoveAfterInTabOrder(
*args, **kwargs)
MoveAfterInTabOrder(self, Window win)
Moves this window in the tab navigation order after the specified sibling window. This means that when the user presses the TAB key on that other window, the focus switches to this window.
The default tab order is the same as creation order. This function
and MoveBeforeInTabOrder allow to change it after creating all the
windows.
def MoveAfterInTabOrder(*args, **kwargs): """ MoveAfterInTabOrder(self, Window win) Moves this window in the tab navigation order after the specified sibling window. This means that when the user presses the TAB key on that other window, the focus switches to this window. The default tab order is the same as creation order. This function and `MoveBeforeInTabOrder` allow to change it after creating all the windows. """ return _core_.Window_MoveAfterInTabOrder(*args, **kwargs)
def MoveBeforeInTabOrder(
*args, **kwargs)
MoveBeforeInTabOrder(self, Window win)
Same as MoveAfterInTabOrder except that it inserts this window just
before win instead of putting it right after it.
def MoveBeforeInTabOrder(*args, **kwargs): """ MoveBeforeInTabOrder(self, Window win) Same as `MoveAfterInTabOrder` except that it inserts this window just before win instead of putting it right after it. """ return _core_.Window_MoveBeforeInTabOrder(*args, **kwargs)
def MoveCaretInsideView(
*args, **kwargs)
MoveCaretInsideView(self)
Move the caret inside current view if it's not there already.
def MoveCaretInsideView(*args, **kwargs): """ MoveCaretInsideView(self) Move the caret inside current view if it's not there already. """ return _stc.StyledTextCtrl_MoveCaretInsideView(*args, **kwargs)
def MoveSelectedLinesDown(
*args, **kwargs)
MoveSelectedLinesDown(self)
def MoveSelectedLinesDown(*args, **kwargs): """MoveSelectedLinesDown(self)""" return _stc.StyledTextCtrl_MoveSelectedLinesDown(*args, **kwargs)
def MoveSelectedLinesUp(
*args, **kwargs)
MoveSelectedLinesUp(self)
def MoveSelectedLinesUp(*args, **kwargs): """MoveSelectedLinesUp(self)""" return _stc.StyledTextCtrl_MoveSelectedLinesUp(*args, **kwargs)
def MoveXY(
*args, **kwargs)
MoveXY(self, int x, int y, int flags=SIZE_USE_EXISTING)
Moves the window to the given position.
def MoveXY(*args, **kwargs): """ MoveXY(self, int x, int y, int flags=SIZE_USE_EXISTING) Moves the window to the given position. """ return _core_.Window_MoveXY(*args, **kwargs)
Navigate(self, int flags=NavigationKeyEvent.IsForward) -> bool
Does keyboard navigation starting from this window to another. This is equivalient to self.GetParent().NavigateIn().
NavigateIn(self, int flags=NavigationKeyEvent.IsForward) -> bool
Navigates inside this window.
def NewLine(
*args, **kwargs)
NewLine(self)
Insert a new line, may use a CRLF, CR or LF depending on EOL mode.
def NewLine(*args, **kwargs): """ NewLine(self) Insert a new line, may use a CRLF, CR or LF depending on EOL mode. """ return _stc.StyledTextCtrl_NewLine(*args, **kwargs)
def OnKeyPressed(
self, event)
def OnKeyPressed(self, event): if self.CallTipActive(): self.CallTipCancel() key = event.GetKeyCode() if key == 32 and event.ControlDown(): pos = self.GetCurrentPos() # Tips if event.ShiftDown(): self.CallTipSetBackground("yellow") self.CallTipShow(pos, 'lots of of text: blah, blah, blah\n\n' 'show some suff, maybe parameters..\n\n' 'fubar(param1, param2)') # Code completion else: #lst = [] #for x in range(50000): # lst.append('%05d' % x) #st = " ".join(lst) #print len(st) #self.AutoCompShow(0, st) kw = keyword.kwlist[:] kw.append("zzzzzz?2") kw.append("aaaaa?2") kw.append("__init__?3") kw.append("zzaaaaa?2") kw.append("zzbaaaa?2") kw.append("this_is_a_longer_value") #kw.append("this_is_a_much_much_much_much_much_much_much_longer_value") kw.sort() # Python sorts are case sensitive self.AutoCompSetIgnoreCase(False) # so this needs to match # Images are specified with a appended "?type" for i in range(len(kw)): if kw[i] in keyword.kwlist: kw[i] = kw[i] + "?1" self.AutoCompShow(0, " ".join(kw)) else: event.Skip()
def OnMarginClick(
self, evt)
def OnMarginClick(self, evt): # fold and unfold as needed if evt.GetMargin() == 2: if evt.GetShift() and evt.GetControl(): self.FoldAll() else: lineClicked = self.LineFromPosition(evt.GetPosition()) if self.GetFoldLevel(lineClicked) & stc.STC_FOLDLEVELHEADERFLAG: if evt.GetShift(): self.SetFoldExpanded(lineClicked, True) self.Expand(lineClicked, True, True, 1) elif evt.GetControl(): if self.GetFoldExpanded(lineClicked): self.SetFoldExpanded(lineClicked, False) self.Expand(lineClicked, False, True, 0) else: self.SetFoldExpanded(lineClicked, True) self.Expand(lineClicked, True, True, 100) else: self.ToggleFold(lineClicked)
def OnPaint(
*args, **kwargs)
OnPaint(self, PaintEvent event)
def OnPaint(*args, **kwargs): """OnPaint(self, PaintEvent event)""" return _core_.Window_OnPaint(*args, **kwargs)
def OnUpdateUI(
self, evt)
def OnUpdateUI(self, evt): # check for matching braces braceAtCaret = -1 braceOpposite = -1 charBefore = None caretPos = self.GetCurrentPos() if caretPos > 0: charBefore = self.GetCharAt(caretPos - 1) styleBefore = self.GetStyleAt(caretPos - 1) # check before if charBefore and chr(charBefore) in "[]{}()<>" and styleBefore == stc.STC_H_XMLSTART: braceAtCaret = caretPos - 1 # check after if braceAtCaret < 0: charAfter = self.GetCharAt(caretPos) styleAfter = self.GetStyleAt(caretPos) if charAfter and chr(charAfter) in "[]{}()<>" and styleAfter == stc.STC_H_XMLEND: braceAtCaret = caretPos if braceAtCaret >= 0: braceOpposite = self.BraceMatch(braceAtCaret) if braceAtCaret != -1 and braceOpposite == -1: self.BraceBadLight(braceAtCaret) else: self.BraceHighlight(braceAtCaret, braceOpposite)
def PageDown(
*args, **kwargs)
PageDown(self)
Move caret one page down.
def PageDown(*args, **kwargs): """ PageDown(self) Move caret one page down. """ return _stc.StyledTextCtrl_PageDown(*args, **kwargs)
def PageDownExtend(
*args, **kwargs)
PageDownExtend(self)
Move caret one page down extending selection to new caret position.
def PageDownExtend(*args, **kwargs): """ PageDownExtend(self) Move caret one page down extending selection to new caret position. """ return _stc.StyledTextCtrl_PageDownExtend(*args, **kwargs)
def PageDownRectExtend(
*args, **kwargs)
PageDownRectExtend(self)
Move caret one page down, extending rectangular selection to new caret position.
def PageDownRectExtend(*args, **kwargs): """ PageDownRectExtend(self) Move caret one page down, extending rectangular selection to new caret position. """ return _stc.StyledTextCtrl_PageDownRectExtend(*args, **kwargs)
def PageUp(
*args, **kwargs)
PageUp(self)
Move caret one page up.
def PageUp(*args, **kwargs): """ PageUp(self) Move caret one page up. """ return _stc.StyledTextCtrl_PageUp(*args, **kwargs)
def PageUpExtend(
*args, **kwargs)
PageUpExtend(self)
Move caret one page up extending selection to new caret position.
def PageUpExtend(*args, **kwargs): """ PageUpExtend(self) Move caret one page up extending selection to new caret position. """ return _stc.StyledTextCtrl_PageUpExtend(*args, **kwargs)
def PageUpRectExtend(
*args, **kwargs)
PageUpRectExtend(self)
Move caret one page up, extending rectangular selection to new caret position.
def PageUpRectExtend(*args, **kwargs): """ PageUpRectExtend(self) Move caret one page up, extending rectangular selection to new caret position. """ return _stc.StyledTextCtrl_PageUpRectExtend(*args, **kwargs)
def ParaDown(
*args, **kwargs)
ParaDown(self)
Move caret between paragraphs (delimited by empty lines).
def ParaDown(*args, **kwargs): """ ParaDown(self) Move caret between paragraphs (delimited by empty lines). """ return _stc.StyledTextCtrl_ParaDown(*args, **kwargs)
def ParaDownExtend(
*args, **kwargs)
ParaDownExtend(self)
def ParaDownExtend(*args, **kwargs): """ParaDownExtend(self)""" return _stc.StyledTextCtrl_ParaDownExtend(*args, **kwargs)
def ParaUp(
*args, **kwargs)
ParaUp(self)
def ParaUp(*args, **kwargs): """ParaUp(self)""" return _stc.StyledTextCtrl_ParaUp(*args, **kwargs)
def ParaUpExtend(
*args, **kwargs)
ParaUpExtend(self)
def ParaUpExtend(*args, **kwargs): """ParaUpExtend(self)""" return _stc.StyledTextCtrl_ParaUpExtend(*args, **kwargs)
def Paste(
*args, **kwargs)
Paste(self)
Pastes text from the clipboard to the text field.
def Paste(*args, **kwargs): """ Paste(self) Pastes text from the clipboard to the text field. """ return _core_.TextEntryBase_Paste(*args, **kwargs)
def PointFromPosition(
*args, **kwargs)
PointFromPosition(self, int pos) -> Point
Retrieve the point in the window where a position is displayed.
def PointFromPosition(*args, **kwargs): """ PointFromPosition(self, int pos) -> Point Retrieve the point in the window where a position is displayed. """ return _stc.StyledTextCtrl_PointFromPosition(*args, **kwargs)
def PopEventHandler(
*args, **kwargs)
PopEventHandler(self, bool deleteHandler=False) -> EvtHandler
Removes and returns the top-most event handler on the event handler
stack. If deleteHandler is True then the wx.EvtHandler object will be
destroyed after it is popped, and None will be returned instead.
def PopEventHandler(*args, **kwargs): """ PopEventHandler(self, bool deleteHandler=False) -> EvtHandler Removes and returns the top-most event handler on the event handler stack. If deleteHandler is True then the wx.EvtHandler object will be destroyed after it is popped, and ``None`` will be returned instead. """ return _core_.Window_PopEventHandler(*args, **kwargs)
def PopupMenu(
*args, **kwargs)
PopupMenu(self, Menu menu, Point pos=DefaultPosition) -> bool
Pops up the given menu at the specified coordinates, relative to this window, and returns control when the user has dismissed the menu. If a menu item is selected, the corresponding menu event is generated and will be processed as usual. If the default position is given then the current position of the mouse cursor will be used.
def PopupMenu(*args, **kwargs): """ PopupMenu(self, Menu menu, Point pos=DefaultPosition) -> bool Pops up the given menu at the specified coordinates, relative to this window, and returns control when the user has dismissed the menu. If a menu item is selected, the corresponding menu event is generated and will be processed as usual. If the default position is given then the current position of the mouse cursor will be used. """ return _core_.Window_PopupMenu(*args, **kwargs)
def PopupMenuXY(
*args, **kwargs)
PopupMenuXY(self, Menu menu, int x=-1, int y=-1) -> bool
Pops up the given menu at the specified coordinates, relative to this window, and returns control when the user has dismissed the menu. If a menu item is selected, the corresponding menu event is generated and will be processed as usual. If the default position is given then the current position of the mouse cursor will be used.
def PopupMenuXY(*args, **kwargs): """ PopupMenuXY(self, Menu menu, int x=-1, int y=-1) -> bool Pops up the given menu at the specified coordinates, relative to this window, and returns control when the user has dismissed the menu. If a menu item is selected, the corresponding menu event is generated and will be processed as usual. If the default position is given then the current position of the mouse cursor will be used. """ return _core_.Window_PopupMenuXY(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_PositionAfter(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_PositionBefore(*args, **kwargs)
def PositionFromLine(
*args, **kwargs)
PositionFromLine(self, int line) -> int
Retrieve the position at the start of a line.
def PositionFromLine(*args, **kwargs): """ PositionFromLine(self, int line) -> int Retrieve the position at the start of a line. """ return _stc.StyledTextCtrl_PositionFromLine(*args, **kwargs)
def PositionFromPoint(
*args, **kwargs)
PositionFromPoint(self, Point pt) -> int
Find the position from a point within the window.
def PositionFromPoint(*args, **kwargs): """ PositionFromPoint(self, Point pt) -> int Find the position from a point within the window. """ return _stc.StyledTextCtrl_PositionFromPoint(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_PositionFromPointClose(*args, **kwargs)
def PositionToCoords(
*args, **kwargs)
PositionToCoords(self, long pos) -> Point
def PositionToCoords(*args, **kwargs): """PositionToCoords(self, long pos) -> Point""" return _core_.TextAreaBase_PositionToCoords(*args, **kwargs)
def PositionToXY(
*args, **kwargs)
PositionToXY(long pos) -> (x, y)
def PositionToXY(*args, **kwargs): """PositionToXY(long pos) -> (x, y)""" return _stc.StyledTextCtrl_PositionToXY(*args, **kwargs)
def PostCreate(
self, pre)
Phase 3 of the 2-phase create
def PostCreate(self, pre): """ Phase 3 of the 2-phase create <wink!> Call this method after precreating the window with the 2-phase create method. """ self.this = pre.this self.thisown = pre.thisown pre.thisown = 0 if hasattr(self, '_setOORInfo'): try: self._setOORInfo(self) except TypeError: pass if hasattr(self, '_setCallbackInfo'): try: self._setCallbackInfo(self, pre.__class__) except TypeError: pass
def PostSizeEvent(
*args, **kwargs)
PostSizeEvent(self)
This is a more readable synonym for SendSizeEvent(wx.SEND_EVENT_POST)
def PostSizeEvent(*args, **kwargs): """ PostSizeEvent(self) This is a more readable synonym for SendSizeEvent(wx.SEND_EVENT_POST) """ return _core_.Window_PostSizeEvent(*args, **kwargs)
def PostSizeEventToParent(
*args, **kwargs)
PostSizeEventToParent(self)
This is the same as SendSizeEventToParent() but using PostSizeEvent()
def PostSizeEventToParent(*args, **kwargs): """ PostSizeEventToParent(self) This is the same as SendSizeEventToParent() but using PostSizeEvent() """ return _core_.Window_PostSizeEventToParent(*args, **kwargs)
def PrivateLexerCall(
*args, **kwargs)
PrivateLexerCall(self, int operation, void pointer) -> void
def PrivateLexerCall(*args, **kwargs): """PrivateLexerCall(self, int operation, void pointer) -> void""" return _stc.StyledTextCtrl_PrivateLexerCall(*args, **kwargs)
def ProcessEvent(
*args, **kwargs)
ProcessEvent(self, Event event) -> bool
def ProcessEvent(*args, **kwargs): """ProcessEvent(self, Event event) -> bool""" return _core_.EvtHandler_ProcessEvent(*args, **kwargs)
def ProcessEventLocally(
*args, **kwargs)
ProcessEventLocally(self, Event event) -> bool
def ProcessEventLocally(*args, **kwargs): """ProcessEventLocally(self, Event event) -> bool""" return _core_.EvtHandler_ProcessEventLocally(*args, **kwargs)
def ProcessPendingEvents(
*args, **kwargs)
ProcessPendingEvents(self)
def ProcessPendingEvents(*args, **kwargs): """ProcessPendingEvents(self)""" return _core_.EvtHandler_ProcessPendingEvents(*args, **kwargs)
def ProcessWindowEvent(
*args, **kwargs)
ProcessWindowEvent(self, Event event) -> bool
Process an event by calling GetEventHandler().ProcessEvent(): this is a straightforward replacement for ProcessEvent() itself which shouldn't be used directly with windows as it doesn't take into account any event handlers associated with the window
def ProcessWindowEvent(*args, **kwargs): """ ProcessWindowEvent(self, Event event) -> bool Process an event by calling GetEventHandler().ProcessEvent(): this is a straightforward replacement for ProcessEvent() itself which shouldn't be used directly with windows as it doesn't take into account any event handlers associated with the window """ return _core_.Window_ProcessWindowEvent(*args, **kwargs)
def PropertyNames(
*args, **kwargs)
PropertyNames(self) -> String
def PropertyNames(*args, **kwargs): """PropertyNames(self) -> String""" return _stc.StyledTextCtrl_PropertyNames(*args, **kwargs)
def PropertyType(
*args, **kwargs)
PropertyType(self, String name) -> int
def PropertyType(*args, **kwargs): """PropertyType(self, String name) -> int""" return _stc.StyledTextCtrl_PropertyType(*args, **kwargs)
def PushEventHandler(
*args, **kwargs)
PushEventHandler(self, EvtHandler handler)
Pushes this event handler onto the event handler stack for the window. An event handler is an object that is capable of processing the events sent to a window. (In other words, is able to dispatch the events to a handler function.) By default, the window is its own event handler, but an application may wish to substitute another, for example to allow central implementation of event-handling for a variety of different window classes.
wx.Window.PushEventHandler allows an application to set up a chain of
event handlers, where an event not handled by one event handler is
handed to the next one in the chain. Use wx.Window.PopEventHandler
to remove the event handler. Ownership of the handler is not given
to the window, so you should be sure to pop the handler before the
window is destroyed and either let PopEventHandler destroy it, or call
its Destroy method yourself.
def PushEventHandler(*args, **kwargs): """ PushEventHandler(self, EvtHandler handler) Pushes this event handler onto the event handler stack for the window. An event handler is an object that is capable of processing the events sent to a window. (In other words, is able to dispatch the events to a handler function.) By default, the window is its own event handler, but an application may wish to substitute another, for example to allow central implementation of event-handling for a variety of different window classes. wx.Window.PushEventHandler allows an application to set up a chain of event handlers, where an event not handled by one event handler is handed to the next one in the chain. Use `wx.Window.PopEventHandler` to remove the event handler. Ownership of the handler is *not* given to the window, so you should be sure to pop the handler before the window is destroyed and either let PopEventHandler destroy it, or call its Destroy method yourself. """ return _core_.Window_PushEventHandler(*args, **kwargs)
def QueueEvent(
*args, **kwargs)
QueueEvent(self, Event event)
def QueueEvent(*args, **kwargs): """QueueEvent(self, Event event)""" return _core_.EvtHandler_QueueEvent(*args, **kwargs)
def RGBAImageSetHeight(
*args, **kwargs)
RGBAImageSetHeight(self, int height)
def RGBAImageSetHeight(*args, **kwargs): """RGBAImageSetHeight(self, int height)""" return _stc.StyledTextCtrl_RGBAImageSetHeight(*args, **kwargs)
def RGBAImageSetWidth(
*args, **kwargs)
RGBAImageSetWidth(self, int width)
def RGBAImageSetWidth(*args, **kwargs): """RGBAImageSetWidth(self, int width)""" return _stc.StyledTextCtrl_RGBAImageSetWidth(*args, **kwargs)
def Raise(
*args, **kwargs)
Raise(self)
Raises the window to the top of the window hierarchy. In current version of wxWidgets this works both for managed and child windows.
def Raise(*args, **kwargs): """ Raise(self) Raises the window to the top of the window hierarchy. In current version of wxWidgets this works both for managed and child windows. """ return _core_.Window_Raise(*args, **kwargs)
def Redo(
*args, **kwargs)
Redo(self)
Redoes the last undo in the text field
def Redo(*args, **kwargs): """ Redo(self) Redoes the last undo in the text field """ return _core_.TextEntryBase_Redo(*args, **kwargs)
def Refresh(
*args, **kwargs)
Refresh(self, bool eraseBackground=True, Rect rect=None)
Mark the specified rectangle (or the whole window) as "dirty" so it will be repainted. Causes an EVT_PAINT event to be generated and sent to the window.
def Refresh(*args, **kwargs): """ Refresh(self, bool eraseBackground=True, Rect rect=None) Mark the specified rectangle (or the whole window) as "dirty" so it will be repainted. Causes an EVT_PAINT event to be generated and sent to the window. """ return _core_.Window_Refresh(*args, **kwargs)
def RefreshRect(
*args, **kwargs)
RefreshRect(self, Rect rect, bool eraseBackground=True)
Redraws the contents of the given rectangle: the area inside it will be repainted. This is the same as Refresh but has a nicer syntax.
def RefreshRect(*args, **kwargs): """ RefreshRect(self, Rect rect, bool eraseBackground=True) Redraws the contents of the given rectangle: the area inside it will be repainted. This is the same as Refresh but has a nicer syntax. """ return _core_.Window_RefreshRect(*args, **kwargs)
def RegisterHotKey(
*args, **kwargs)
RegisterHotKey(self, int hotkeyId, int modifiers, int keycode) -> bool
Registers a system wide hotkey. Every time the user presses the hotkey registered here, this window will receive a hotkey event. It will receive the event even if the application is in the background and does not have the input focus because the user is working with some other application. To bind an event handler function to this hotkey use EVT_HOTKEY with an id equal to hotkeyId. Returns True if the hotkey was registered successfully.
def RegisterHotKey(*args, **kwargs): """ RegisterHotKey(self, int hotkeyId, int modifiers, int keycode) -> bool Registers a system wide hotkey. Every time the user presses the hotkey registered here, this window will receive a hotkey event. It will receive the event even if the application is in the background and does not have the input focus because the user is working with some other application. To bind an event handler function to this hotkey use EVT_HOTKEY with an id equal to hotkeyId. Returns True if the hotkey was registered successfully. """ return _core_.Window_RegisterHotKey(*args, **kwargs)
def RegisterImage(
*args, **kwargs)
RegisterImage(self, int type, Bitmap bmp)
Register an image for use in autocompletion lists.
def RegisterImage(*args, **kwargs): """ RegisterImage(self, int type, Bitmap bmp) Register an image for use in autocompletion lists. """ return _stc.StyledTextCtrl_RegisterImage(*args, **kwargs)
def RegisterRGBAImage(
*args, **kwargs)
RegisterRGBAImage(self, int type, unsigned char pixels)
def RegisterRGBAImage(*args, **kwargs): """RegisterRGBAImage(self, int type, unsigned char pixels)""" return _stc.StyledTextCtrl_RegisterRGBAImage(*args, **kwargs)
def ReleaseDocument(
*args, **kwargs)
ReleaseDocument(self, void docPointer)
Release a reference to the document, deleting document if it fades to black.
def ReleaseDocument(*args, **kwargs): """ ReleaseDocument(self, void docPointer) Release a reference to the document, deleting document if it fades to black. """ return _stc.StyledTextCtrl_ReleaseDocument(*args, **kwargs)
def ReleaseMouse(
*args, **kwargs)
ReleaseMouse(self)
Releases mouse input captured with wx.Window.CaptureMouse.
def ReleaseMouse(*args, **kwargs): """ ReleaseMouse(self) Releases mouse input captured with wx.Window.CaptureMouse. """ return _core_.Window_ReleaseMouse(*args, **kwargs)
def Remove(
*args, **kwargs)
Remove(self, long from, long to)
Removes the text between two positions in the text field
def Remove(*args, **kwargs): """ Remove(self, long from, long to) Removes the text between two positions in the text field """ return _core_.TextEntryBase_Remove(*args, **kwargs)
def RemoveChild(
*args, **kwargs)
RemoveChild(self, Window child)
Removes a child window. This is called automatically by window deletion functions so should not be required by the application programmer.
def RemoveChild(*args, **kwargs): """ RemoveChild(self, Window child) Removes a child window. This is called automatically by window deletion functions so should not be required by the application programmer. """ return _core_.Window_RemoveChild(*args, **kwargs)
def RemoveEventHandler(
*args, **kwargs)
RemoveEventHandler(self, EvtHandler handler) -> bool
Find the given handler in the event handler chain and remove (but not delete) it from the event handler chain, returns True if it was found and False otherwise (this also results in an assert failure so this function should only be called when the handler is supposed to be there.)
def RemoveEventHandler(*args, **kwargs): """ RemoveEventHandler(self, EvtHandler handler) -> bool Find the given handler in the event handler chain and remove (but not delete) it from the event handler chain, returns True if it was found and False otherwise (this also results in an assert failure so this function should only be called when the handler is supposed to be there.) """ return _core_.Window_RemoveEventHandler(*args, **kwargs)
def RemoveSelection(
*args, **kwargs)
RemoveSelection(self)
def RemoveSelection(*args, **kwargs): """RemoveSelection(self)""" return _core_.TextEntryBase_RemoveSelection(*args, **kwargs)
def Reparent(
*args, **kwargs)
Reparent(self, Window newParent) -> bool
Reparents the window, i.e the window will be removed from its current parent window (e.g. a non-standard toolbar in a wxFrame) and then re-inserted into another. Available on Windows and GTK. Returns True if the parent was changed, False otherwise (error or newParent == oldParent)
def Reparent(*args, **kwargs): """ Reparent(self, Window newParent) -> bool Reparents the window, i.e the window will be removed from its current parent window (e.g. a non-standard toolbar in a wxFrame) and then re-inserted into another. Available on Windows and GTK. Returns True if the parent was changed, False otherwise (error or newParent == oldParent) """ return _core_.Window_Reparent(*args, **kwargs)
def Replace(
*args, **kwargs)
Replace(self, long from, long to, String value)
Replaces the text between two positions with the given text.
def Replace(*args, **kwargs): """ Replace(self, long from, long to, String value) Replaces the text between two positions with the given text. """ return _core_.TextEntryBase_Replace(*args, **kwargs)
def ReplaceSelection(
*args, **kwargs)
ReplaceSelection(self, String text)
Replace the selected text with the argument text.
def ReplaceSelection(*args, **kwargs): """ ReplaceSelection(self, String text) Replace the selected text with the argument text. """ return _stc.StyledTextCtrl_ReplaceSelection(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_ReplaceTarget(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_ReplaceTargetRE(*args, **kwargs)
def RotateSelection(
*args, **kwargs)
RotateSelection(self)
Set the main selection to the next selection.
def RotateSelection(*args, **kwargs): """ RotateSelection(self) Set the main selection to the next selection. """ return _stc.StyledTextCtrl_RotateSelection(*args, **kwargs)
def SafelyProcessEvent(
*args, **kwargs)
SafelyProcessEvent(self, Event event) -> bool
def SafelyProcessEvent(*args, **kwargs): """SafelyProcessEvent(self, Event event) -> bool""" return _core_.EvtHandler_SafelyProcessEvent(*args, **kwargs)
def SaveFile(
*args, **kwargs)
SaveFile(self, String file=wxEmptyString, int fileType=wxTEXT_TYPE_ANY) -> bool
def SaveFile(*args, **kwargs): """SaveFile(self, String file=wxEmptyString, int fileType=wxTEXT_TYPE_ANY) -> bool""" return _core_.TextAreaBase_SaveFile(*args, **kwargs)
def ScreenToClient(
*args, **kwargs)
ScreenToClient(self, Point pt) -> Point
Converts from screen to client window coordinates.
def ScreenToClient(*args, **kwargs): """ ScreenToClient(self, Point pt) -> Point Converts from screen to client window coordinates. """ return _core_.Window_ScreenToClient(*args, **kwargs)
def ScreenToClientXY(
*args, **kwargs)
ScreenToClientXY(int x, int y) -> (x,y)
Converts from screen to client window coordinates.
def ScreenToClientXY(*args, **kwargs): """ ScreenToClientXY(int x, int y) -> (x,y) Converts from screen to client window coordinates. """ return _core_.Window_ScreenToClientXY(*args, **kwargs)
def ScrollLines(
*args, **kwargs)
ScrollLines(self, int lines) -> bool
If the platform and window class supports it, scrolls the window by the given number of lines down, if lines is positive, or up if lines is negative. Returns True if the window was scrolled, False if it was already on top/bottom and nothing was done.
def ScrollLines(*args, **kwargs): """ ScrollLines(self, int lines) -> bool If the platform and window class supports it, scrolls the window by the given number of lines down, if lines is positive, or up if lines is negative. Returns True if the window was scrolled, False if it was already on top/bottom and nothing was done. """ return _core_.Window_ScrollLines(*args, **kwargs)
def ScrollPages(
*args, **kwargs)
ScrollPages(self, int pages) -> bool
If the platform and window class supports it, scrolls the window by the given number of pages down, if pages is positive, or up if pages is negative. Returns True if the window was scrolled, False if it was already on top/bottom and nothing was done.
def ScrollPages(*args, **kwargs): """ ScrollPages(self, int pages) -> bool If the platform and window class supports it, scrolls the window by the given number of pages down, if pages is positive, or up if pages is negative. Returns True if the window was scrolled, False if it was already on top/bottom and nothing was done. """ return _core_.Window_ScrollPages(*args, **kwargs)
def ScrollToColumn(
*args, **kwargs)
ScrollToColumn(self, int column)
Scroll enough to make the given column visible
def ScrollToColumn(*args, **kwargs): """ ScrollToColumn(self, int column) Scroll enough to make the given column visible """ return _stc.StyledTextCtrl_ScrollToColumn(*args, **kwargs)
def ScrollToEnd(
*args, **kwargs)
ScrollToEnd(self)
def ScrollToEnd(*args, **kwargs): """ScrollToEnd(self)""" return _stc.StyledTextCtrl_ScrollToEnd(*args, **kwargs)
def ScrollToLine(
*args, **kwargs)
ScrollToLine(self, int line)
Scroll enough to make the given line visible.
def ScrollToLine(*args, **kwargs): """ ScrollToLine(self, int line) Scroll enough to make the given line visible. """ return _stc.StyledTextCtrl_ScrollToLine(*args, **kwargs)
def ScrollToStart(
*args, **kwargs)
ScrollToStart(self)
def ScrollToStart(*args, **kwargs): """ScrollToStart(self)""" return _stc.StyledTextCtrl_ScrollToStart(*args, **kwargs)
def ScrollWindow(
*args, **kwargs)
ScrollWindow(self, int dx, int dy, Rect rect=None)
Physically scrolls the pixels in the window and move child windows accordingly. Use this function to optimise your scrolling implementations, to minimise the area that must be redrawn. Note that it is rarely required to call this function from a user program.
def ScrollWindow(*args, **kwargs): """ ScrollWindow(self, int dx, int dy, Rect rect=None) Physically scrolls the pixels in the window and move child windows accordingly. Use this function to optimise your scrolling implementations, to minimise the area that must be redrawn. Note that it is rarely required to call this function from a user program. """ return _core_.Window_ScrollWindow(*args, **kwargs)
def SearchAnchor(
*args, **kwargs)
SearchAnchor(self)
Sets the current caret position to be the search anchor.
def SearchAnchor(*args, **kwargs): """ SearchAnchor(self) Sets the current caret position to be the search anchor. """ return _stc.StyledTextCtrl_SearchAnchor(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_SearchInTarget(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_SearchNext(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_SearchPrev(*args, **kwargs)
def SelectAll(
*args, **kwargs)
SelectAll(self)
Select all text in the text field.
def SelectAll(*args, **kwargs): """ SelectAll(self) Select all text in the text field. """ return _core_.TextEntryBase_SelectAll(*args, **kwargs)
def SelectNone(
*args, **kwargs)
SelectNone(self)
def SelectNone(*args, **kwargs): """SelectNone(self)""" return _stc.StyledTextCtrl_SelectNone(*args, **kwargs)
def SelectionDuplicate(
*args, **kwargs)
SelectionDuplicate(self)
Duplicate the selection. If selection empty duplicate the line containing the caret.
def SelectionDuplicate(*args, **kwargs): """ SelectionDuplicate(self) Duplicate the selection. If selection empty duplicate the line containing the caret. """ return _stc.StyledTextCtrl_SelectionDuplicate(*args, **kwargs)
def SelectionIsRectangle(
*args, **kwargs)
SelectionIsRectangle(self) -> bool
Is the selection rectangular? The alternative is the more common stream selection.
def SelectionIsRectangle(*args, **kwargs): """ SelectionIsRectangle(self) -> bool Is the selection rectangular? The alternative is the more common stream selection. """ return _stc.StyledTextCtrl_SelectionIsRectangle(*args, **kwargs)
def SendIdleEvents(
*args, **kwargs)
SendIdleEvents(self, IdleEvent event) -> bool
Send idle event to window and all subwindows. Returns True if more idle time is requested.
def SendIdleEvents(*args, **kwargs): """ SendIdleEvents(self, IdleEvent event) -> bool Send idle event to window and all subwindows. Returns True if more idle time is requested. """ return _core_.Window_SendIdleEvents(*args, **kwargs)
def SendMsg(
*args, **kwargs)
SendMsg(self, int msg, UIntPtr wp=0, wxIntPtr lp=0) -> wxIntPtr
Send a message to Scintilla.
def SendMsg(*args, **kwargs): """ SendMsg(self, int msg, UIntPtr wp=0, wxIntPtr lp=0) -> wxIntPtr Send a message to Scintilla. """ return _stc.StyledTextCtrl_SendMsg(*args, **kwargs)
def SendSizeEvent(
*args, **kwargs)
SendSizeEvent(self, int flags=0)
Sends a size event to the window using its current size -- this has an effect of refreshing the window layout.
By default the event is sent, i.e. processed immediately, but if flags value includes wxSEND_EVENT_POST then it's posted, i.e. only schedule for later processing.
def SendSizeEvent(*args, **kwargs): """ SendSizeEvent(self, int flags=0) Sends a size event to the window using its current size -- this has an effect of refreshing the window layout. By default the event is sent, i.e. processed immediately, but if flags value includes wxSEND_EVENT_POST then it's posted, i.e. only schedule for later processing. """ return _core_.Window_SendSizeEvent(*args, **kwargs)
def SendSizeEventToParent(
*args, **kwargs)
SendSizeEventToParent(self, int flags=0)
This is a safe wrapper for GetParent().SendSizeEvent(): it checks that we have a parent window and it's not in process of being deleted.
def SendSizeEventToParent(*args, **kwargs): """ SendSizeEventToParent(self, int flags=0) This is a safe wrapper for GetParent().SendSizeEvent(): it checks that we have a parent window and it's not in process of being deleted. """ return _core_.Window_SendSizeEventToParent(*args, **kwargs)
def SetAcceleratorTable(
*args, **kwargs)
SetAcceleratorTable(self, AcceleratorTable accel)
Sets the accelerator table for this window.
def SetAcceleratorTable(*args, **kwargs): """ SetAcceleratorTable(self, AcceleratorTable accel) Sets the accelerator table for this window. """ return _core_.Window_SetAcceleratorTable(*args, **kwargs)
def SetAdditionalCaretForeground(
*args, **kwargs)
SetAdditionalCaretForeground(self, Colour fore)
Set the foreground colour of additional carets.
def SetAdditionalCaretForeground(*args, **kwargs): """ SetAdditionalCaretForeground(self, Colour fore) Set the foreground colour of additional carets. """ return _stc.StyledTextCtrl_SetAdditionalCaretForeground(*args, **kwargs)
def SetAdditionalCaretsBlink(
*args, **kwargs)
SetAdditionalCaretsBlink(self, bool additionalCaretsBlink)
Set whether additional carets will blink
def SetAdditionalCaretsBlink(*args, **kwargs): """ SetAdditionalCaretsBlink(self, bool additionalCaretsBlink) Set whether additional carets will blink """ return _stc.StyledTextCtrl_SetAdditionalCaretsBlink(*args, **kwargs)
def SetAdditionalCaretsVisible(
*args, **kwargs)
SetAdditionalCaretsVisible(self, bool additionalCaretsBlink)
Set whether additional carets are visible
def SetAdditionalCaretsVisible(*args, **kwargs): """ SetAdditionalCaretsVisible(self, bool additionalCaretsBlink) Set whether additional carets are visible """ return _stc.StyledTextCtrl_SetAdditionalCaretsVisible(*args, **kwargs)
def SetAdditionalSelAlpha(
*args, **kwargs)
SetAdditionalSelAlpha(self, int alpha)
Set the alpha of the selection.
def SetAdditionalSelAlpha(*args, **kwargs): """ SetAdditionalSelAlpha(self, int alpha) Set the alpha of the selection. """ return _stc.StyledTextCtrl_SetAdditionalSelAlpha(*args, **kwargs)
def SetAdditionalSelBackground(
*args, **kwargs)
SetAdditionalSelBackground(self, Colour back)
Set the background colour of additional selections. Must have previously called SetSelBack with non-zero first argument for this to have an effect.
def SetAdditionalSelBackground(*args, **kwargs): """ SetAdditionalSelBackground(self, Colour back) Set the background colour of additional selections. Must have previously called SetSelBack with non-zero first argument for this to have an effect. """ return _stc.StyledTextCtrl_SetAdditionalSelBackground(*args, **kwargs)
def SetAdditionalSelForeground(
*args, **kwargs)
SetAdditionalSelForeground(self, Colour fore)
Set the foreground colour of additional selections. Must have previously called SetSelFore with non-zero first argument for this to have an effect.
def SetAdditionalSelForeground(*args, **kwargs): """ SetAdditionalSelForeground(self, Colour fore) Set the foreground colour of additional selections. Must have previously called SetSelFore with non-zero first argument for this to have an effect. """ return _stc.StyledTextCtrl_SetAdditionalSelForeground(*args, **kwargs)
def SetAdditionalSelectionTyping(
*args, **kwargs)
SetAdditionalSelectionTyping(self, bool additionalSelectionTyping)
Set whether typing can be performed into multiple selections
def SetAdditionalSelectionTyping(*args, **kwargs): """ SetAdditionalSelectionTyping(self, bool additionalSelectionTyping) Set whether typing can be performed into multiple selections """ return _stc.StyledTextCtrl_SetAdditionalSelectionTyping(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_SetAnchor(*args, **kwargs)
def SetAutoLayout(
*args, **kwargs)
SetAutoLayout(self, bool autoLayout)
Determines whether the Layout function will be called automatically
when the window is resized. lease note that this only happens for the
windows usually used to contain children, namely wx.Panel and
wx.TopLevelWindow (and the classes deriving from them).
This method is called implicitly by SetSizer but if you use
SetConstraints you should call it manually or otherwise the window
layout won't be correctly updated when its size changes.
def SetAutoLayout(*args, **kwargs): """ SetAutoLayout(self, bool autoLayout) Determines whether the Layout function will be called automatically when the window is resized. lease note that this only happens for the windows usually used to contain children, namely `wx.Panel` and `wx.TopLevelWindow` (and the classes deriving from them). This method is called implicitly by `SetSizer` but if you use `SetConstraints` you should call it manually or otherwise the window layout won't be correctly updated when its size changes. """ return _core_.Window_SetAutoLayout(*args, **kwargs)
def SetBackSpaceUnIndents(
*args, **kwargs)
SetBackSpaceUnIndents(self, bool bsUnIndents)
Sets whether a backspace pressed when caret is within indentation unindents.
def SetBackSpaceUnIndents(*args, **kwargs): """ SetBackSpaceUnIndents(self, bool bsUnIndents) Sets whether a backspace pressed when caret is within indentation unindents. """ return _stc.StyledTextCtrl_SetBackSpaceUnIndents(*args, **kwargs)
def SetBackgroundColour(
*args, **kwargs)
SetBackgroundColour(self, Colour colour) -> bool
Sets the background colour of the window. Returns True if the colour
was changed. The background colour is usually painted by the default
EVT_ERASE_BACKGROUND event handler function under Windows and
automatically under GTK. Using wx.NullColour will reset the window
to the default background colour.
Note that setting the background colour may not cause an immediate
refresh, so you may wish to call ClearBackground or Refresh after
calling this function.
Using this function will disable attempts to use themes for this window, if the system supports them. Use with care since usually the themes represent the appearance chosen by the user to be used for all applications on the system.
def SetBackgroundColour(*args, **kwargs): """ SetBackgroundColour(self, Colour colour) -> bool Sets the background colour of the window. Returns True if the colour was changed. The background colour is usually painted by the default EVT_ERASE_BACKGROUND event handler function under Windows and automatically under GTK. Using `wx.NullColour` will reset the window to the default background colour. Note that setting the background colour may not cause an immediate refresh, so you may wish to call `ClearBackground` or `Refresh` after calling this function. Using this function will disable attempts to use themes for this window, if the system supports them. Use with care since usually the themes represent the appearance chosen by the user to be used for all applications on the system. """ return _core_.Window_SetBackgroundColour(*args, **kwargs)
def SetBackgroundStyle(
*args, **kwargs)
SetBackgroundStyle(self, int style) -> bool
Returns the background style of the window. The background style indicates how the background of the window is drawn.
====================== ========================================
wx.BG_STYLE_SYSTEM The background colour or pattern should
be determined by the system
wx.BG_STYLE_COLOUR The background should be a solid colour
wx.BG_STYLE_CUSTOM The background will be implemented by the
application.
====================== ========================================
On GTK+, use of wx.BG_STYLE_CUSTOM allows the flicker-free drawing of a custom background, such as a tiled bitmap. Currently the style has no effect on other platforms.
:see: GetBackgroundStyle, SetBackgroundColour
def SetBackgroundStyle(*args, **kwargs): """ SetBackgroundStyle(self, int style) -> bool Returns the background style of the window. The background style indicates how the background of the window is drawn. ====================== ======================================== wx.BG_STYLE_SYSTEM The background colour or pattern should be determined by the system wx.BG_STYLE_COLOUR The background should be a solid colour wx.BG_STYLE_CUSTOM The background will be implemented by the application. ====================== ======================================== On GTK+, use of wx.BG_STYLE_CUSTOM allows the flicker-free drawing of a custom background, such as a tiled bitmap. Currently the style has no effect on other platforms. :see: `GetBackgroundStyle`, `SetBackgroundColour` """ return _core_.Window_SetBackgroundStyle(*args, **kwargs)
def SetBestFittingSize(
*args, **kw)
SetInitialSize(self, Size size=DefaultSize)
A 'Smart' SetSize that will fill in default size components with the window's best size values. Also set's the minsize for use with sizers.
def deprecated_func(*args, **kw): warnings.warn("Call to deprecated item. %s" % msg, wxPyDeprecationWarning, stacklevel=2) return item(*args, **kw)
def 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.
def 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. """ return _stc.StyledTextCtrl_SetBufferedDraw(*args, **kwargs)
def SetCanFocus(
*args, **kwargs)
SetCanFocus(self, bool canFocus)
def SetCanFocus(*args, **kwargs): """SetCanFocus(self, bool canFocus)""" return _core_.Window_SetCanFocus(*args, **kwargs)
def SetCaret(
*args, **kwargs)
SetCaret(self, Caret caret)
Sets the caret associated with the window.
def SetCaret(*args, **kwargs): """ SetCaret(self, Caret caret) Sets the caret associated with the window. """ return _core_.Window_SetCaret(*args, **kwargs)
def SetCaretForeground(
*args, **kwargs)
SetCaretForeground(self, Colour fore)
Set the foreground colour of the caret.
def SetCaretForeground(*args, **kwargs): """ SetCaretForeground(self, Colour fore) Set the foreground colour of the caret. """ return _stc.StyledTextCtrl_SetCaretForeground(*args, **kwargs)
def SetCaretLineBack(
*args, **kwargs)
SetCaretLineBackground(self, Colour back)
Set the colour of the background of the line containing the caret.
def SetCaretLineBackground(*args, **kwargs): """ SetCaretLineBackground(self, Colour back) Set the colour of the background of the line containing the caret. """ return _stc.StyledTextCtrl_SetCaretLineBackground(*args, **kwargs)
def SetCaretLineBackAlpha(
*args, **kwargs)
SetCaretLineBackAlpha(self, int alpha)
Set background alpha of the caret line.
def SetCaretLineBackAlpha(*args, **kwargs): """ SetCaretLineBackAlpha(self, int alpha) Set background alpha of the caret line. """ return _stc.StyledTextCtrl_SetCaretLineBackAlpha(*args, **kwargs)
def SetCaretLineBackground(
*args, **kwargs)
SetCaretLineBackground(self, Colour back)
Set the colour of the background of the line containing the caret.
def SetCaretLineBackground(*args, **kwargs): """ SetCaretLineBackground(self, Colour back) Set the colour of the background of the line containing the caret. """ return _stc.StyledTextCtrl_SetCaretLineBackground(*args, **kwargs)
def SetCaretLineVisible(
*args, **kwargs)
SetCaretLineVisible(self, bool show)
Display the background of the line containing the caret in a different colour.
def SetCaretLineVisible(*args, **kwargs): """ SetCaretLineVisible(self, bool show) Display the background of the line containing the caret in a different colour. """ return _stc.StyledTextCtrl_SetCaretLineVisible(*args, **kwargs)
def SetCaretPeriod(
*args, **kwargs)
SetCaretPeriod(self, int periodMilliseconds)
Get the time in milliseconds that the caret is on and off. 0 = steady on.
def SetCaretPeriod(*args, **kwargs): """ SetCaretPeriod(self, int periodMilliseconds) Get the time in milliseconds that the caret is on and off. 0 = steady on. """ return _stc.StyledTextCtrl_SetCaretPeriod(*args, **kwargs)
def SetCaretSticky(
*args, **kwargs)
SetCaretSticky(self, int useCaretStickyBehaviour)
Stop the caret preferred x position changing when the user types.
def SetCaretSticky(*args, **kwargs): """ SetCaretSticky(self, int useCaretStickyBehaviour) Stop the caret preferred x position changing when the user types. """ return _stc.StyledTextCtrl_SetCaretSticky(*args, **kwargs)
def SetCaretStyle(
*args, **kwargs)
SetCaretStyle(self, int caretStyle)
Set the style of the caret to be drawn.
def SetCaretStyle(*args, **kwargs): """ SetCaretStyle(self, int caretStyle) Set the style of the caret to be drawn. """ return _stc.StyledTextCtrl_SetCaretStyle(*args, **kwargs)
def SetCaretWidth(
*args, **kwargs)
SetCaretWidth(self, int pixelWidth)
Set the width of the insert mode caret.
def SetCaretWidth(*args, **kwargs): """ SetCaretWidth(self, int pixelWidth) Set the width of the insert mode caret. """ return _stc.StyledTextCtrl_SetCaretWidth(*args, **kwargs)
def SetCharsDefault(
*args, **kwargs)
SetCharsDefault(self)
Reset the set of characters for whitespace and word characters to the defaults.
def SetCharsDefault(*args, **kwargs): """ SetCharsDefault(self) Reset the set of characters for whitespace and word characters to the defaults. """ return _stc.StyledTextCtrl_SetCharsDefault(*args, **kwargs)
def SetClientRect(
*args, **kwargs)
SetClientRect(self, Rect rect)
This sets the size of the window client area in pixels. Using this function to size a window tends to be more device-independent than wx.Window.SetSize, since the application need not worry about what dimensions the border or title bar have when trying to fit the window around panel items, for example.
def SetClientRect(*args, **kwargs): """ SetClientRect(self, Rect rect) This sets the size of the window client area in pixels. Using this function to size a window tends to be more device-independent than wx.Window.SetSize, since the application need not worry about what dimensions the border or title bar have when trying to fit the window around panel items, for example. """ return _core_.Window_SetClientRect(*args, **kwargs)
def SetClientSize(
*args, **kwargs)
SetClientSize(self, Size size)
This sets the size of the window client area in pixels. Using this function to size a window tends to be more device-independent than wx.Window.SetSize, since the application need not worry about what dimensions the border or title bar have when trying to fit the window around panel items, for example.
def SetClientSize(*args, **kwargs): """ SetClientSize(self, Size size) This sets the size of the window client area in pixels. Using this function to size a window tends to be more device-independent than wx.Window.SetSize, since the application need not worry about what dimensions the border or title bar have when trying to fit the window around panel items, for example. """ return _core_.Window_SetClientSize(*args, **kwargs)
def SetClientSizeWH(
*args, **kwargs)
SetClientSizeWH(self, int width, int height)
This sets the size of the window client area in pixels. Using this function to size a window tends to be more device-independent than wx.Window.SetSize, since the application need not worry about what dimensions the border or title bar have when trying to fit the window around panel items, for example.
def SetClientSizeWH(*args, **kwargs): """ SetClientSizeWH(self, int width, int height) This sets the size of the window client area in pixels. Using this function to size a window tends to be more device-independent than wx.Window.SetSize, since the application need not worry about what dimensions the border or title bar have when trying to fit the window around panel items, for example. """ return _core_.Window_SetClientSizeWH(*args, **kwargs)
def SetCodePage(
*args, **kwargs)
SetCodePage(self, int codePage)
Set the code page used to interpret the bytes of the document as characters.
def SetCodePage(*args, **kwargs): """ SetCodePage(self, int codePage) Set the code page used to interpret the bytes of the document as characters. """ return _stc.StyledTextCtrl_SetCodePage(*args, **kwargs)
def SetConstraints(
*args, **kwargs)
SetConstraints(self, LayoutConstraints constraints)
Sets the window to have the given layout constraints. If an existing layout constraints object is already owned by the window, it will be deleted. Pass None to disassociate and delete the window's current constraints.
You must call SetAutoLayout to tell a window to use the constraints automatically in its default EVT_SIZE handler; otherwise, you must handle EVT_SIZE yourself and call Layout() explicitly. When setting both a wx.LayoutConstraints and a wx.Sizer, only the sizer will have effect.
def SetConstraints(*args, **kwargs): """ SetConstraints(self, LayoutConstraints constraints) Sets the window to have the given layout constraints. If an existing layout constraints object is already owned by the window, it will be deleted. Pass None to disassociate and delete the window's current constraints. You must call SetAutoLayout to tell a window to use the constraints automatically in its default EVT_SIZE handler; otherwise, you must handle EVT_SIZE yourself and call Layout() explicitly. When setting both a wx.LayoutConstraints and a wx.Sizer, only the sizer will have effect. """ return _core_.Window_SetConstraints(*args, **kwargs)
def SetContainingSizer(
*args, **kwargs)
SetContainingSizer(self, Sizer sizer)
This normally does not need to be called by application code. It is called internally when a window is added to a sizer, and is used so the window can remove itself from the sizer when it is destroyed.
def SetContainingSizer(*args, **kwargs): """ SetContainingSizer(self, Sizer sizer) This normally does not need to be called by application code. It is called internally when a window is added to a sizer, and is used so the window can remove itself from the sizer when it is destroyed. """ return _core_.Window_SetContainingSizer(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_SetControlCharSymbol(*args, **kwargs)
def SetCurrentPos(
*args, **kwargs)
SetCurrentPos(self, int pos)
Sets the position of the caret.
def SetCurrentPos(*args, **kwargs): """ SetCurrentPos(self, int pos) Sets the position of the caret. """ return _stc.StyledTextCtrl_SetCurrentPos(*args, **kwargs)
def SetCursor(
*args, **kwargs)
SetCursor(self, Cursor cursor) -> bool
Sets the window's cursor. Notice that the window cursor also sets it for the children of the window implicitly.
The cursor may be wx.NullCursor in which case the window cursor will be reset back to default.
def SetCursor(*args, **kwargs): """ SetCursor(self, Cursor cursor) -> bool Sets the window's cursor. Notice that the window cursor also sets it for the children of the window implicitly. The cursor may be wx.NullCursor in which case the window cursor will be reset back to default. """ return _core_.Window_SetCursor(*args, **kwargs)
def SetDefaultStyle(
*args, **kwargs)
SetDefaultStyle(self, wxTextAttr style) -> bool
def SetDefaultStyle(*args, **kwargs): """SetDefaultStyle(self, wxTextAttr style) -> bool""" return _core_.TextAreaBase_SetDefaultStyle(*args, **kwargs)
def SetDimensions(
*args, **kwargs)
SetDimensions(self, int x, int y, int width, int height, int sizeFlags=SIZE_AUTO)
Sets the position and size of the window in pixels. The sizeFlags parameter indicates the interpretation of the other params if they are equal to -1.
======================== ======================================
wx.SIZE_AUTO A -1 indicates that a class-specific
default should be used.
wx.SIZE_USE_EXISTING Existing dimensions should be used if
-1 values are supplied.
wxSIZE_ALLOW_MINUS_ONE Allow dimensions of -1 and less to be
interpreted as real dimensions, not
default values.
======================== ======================================
def SetDimensions(*args, **kwargs): """ SetDimensions(self, int x, int y, int width, int height, int sizeFlags=SIZE_AUTO) Sets the position and size of the window in pixels. The sizeFlags parameter indicates the interpretation of the other params if they are equal to -1. ======================== ====================================== wx.SIZE_AUTO A -1 indicates that a class-specific default should be used. wx.SIZE_USE_EXISTING Existing dimensions should be used if -1 values are supplied. wxSIZE_ALLOW_MINUS_ONE Allow dimensions of -1 and less to be interpreted as real dimensions, not default values. ======================== ====================================== """ return _core_.Window_SetDimensions(*args, **kwargs)
def SetDocPointer(
*args, **kwargs)
SetDocPointer(self, void docPointer)
Change the document object used.
def SetDocPointer(*args, **kwargs): """ SetDocPointer(self, void docPointer) Change the document object used. """ return _stc.StyledTextCtrl_SetDocPointer(*args, **kwargs)
def SetDoubleBuffered(
*args, **kwargs)
SetDoubleBuffered(self, bool on)
Put the native window into double buffered or composited mode.
def SetDoubleBuffered(*args, **kwargs): """ SetDoubleBuffered(self, bool on) Put the native window into double buffered or composited mode. """ return _core_.Window_SetDoubleBuffered(*args, **kwargs)
def SetDropTarget(
*args, **kwargs)
SetDropTarget(self, DropTarget dropTarget)
Associates a drop target with this window. If the window already has a drop target, it is deleted.
def SetDropTarget(*args, **kwargs): """ SetDropTarget(self, DropTarget dropTarget) Associates a drop target with this window. If the window already has a drop target, it is deleted. """ return _core_.Window_SetDropTarget(*args, **kwargs)
def SetEOLMode(
*args, **kwargs)
SetEOLMode(self, int eolMode)
Set the current end of line mode.
def SetEOLMode(*args, **kwargs): """ SetEOLMode(self, int eolMode) Set the current end of line mode. """ return _stc.StyledTextCtrl_SetEOLMode(*args, **kwargs)
def SetEdgeColour(
*args, **kwargs)
SetEdgeColour(self, Colour edgeColour)
Change the colour used in edge indication.
def SetEdgeColour(*args, **kwargs): """ SetEdgeColour(self, Colour edgeColour) Change the colour used in edge indication. """ return _stc.StyledTextCtrl_SetEdgeColour(*args, **kwargs)
def SetEdgeColumn(
*args, **kwargs)
SetEdgeColumn(self, int column)
Set the column number of the edge. If text goes past the edge then it is highlighted.
def SetEdgeColumn(*args, **kwargs): """ SetEdgeColumn(self, int column) Set the column number of the edge. If text goes past the edge then it is highlighted. """ return _stc.StyledTextCtrl_SetEdgeColumn(*args, **kwargs)
def 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).
def 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). """ return _stc.StyledTextCtrl_SetEdgeMode(*args, **kwargs)
def SetEditable(
*args, **kwargs)
SetEditable(self, bool editable)
def SetEditable(*args, **kwargs): """SetEditable(self, bool editable)""" return _core_.TextEntryBase_SetEditable(*args, **kwargs)
def SetEmptySelection(
*args, **kwargs)
SetEmptySelection(self, int pos)
def SetEmptySelection(*args, **kwargs): """SetEmptySelection(self, int pos)""" return _stc.StyledTextCtrl_SetEmptySelection(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_SetEndAtLastLine(*args, **kwargs)
def SetEventHandler(
*args, **kwargs)
SetEventHandler(self, EvtHandler handler)
Sets the event handler for this window. An event handler is an object that is capable of processing the events sent to a window. (In other words, is able to dispatch the events to handler function.) By default, the window is its own event handler, but an application may wish to substitute another, for example to allow central implementation of event-handling for a variety of different window classes.
It is usually better to use wx.Window.PushEventHandler since this sets
up a chain of event handlers, where an event not handled by one event
handler is handed off to the next one in the chain.
def SetEventHandler(*args, **kwargs): """ SetEventHandler(self, EvtHandler handler) Sets the event handler for this window. An event handler is an object that is capable of processing the events sent to a window. (In other words, is able to dispatch the events to handler function.) By default, the window is its own event handler, but an application may wish to substitute another, for example to allow central implementation of event-handling for a variety of different window classes. It is usually better to use `wx.Window.PushEventHandler` since this sets up a chain of event handlers, where an event not handled by one event handler is handed off to the next one in the chain. """ return _core_.Window_SetEventHandler(*args, **kwargs)
def SetEvtHandlerEnabled(
*args, **kwargs)
SetEvtHandlerEnabled(self, bool enabled)
def SetEvtHandlerEnabled(*args, **kwargs): """SetEvtHandlerEnabled(self, bool enabled)""" return _core_.EvtHandler_SetEvtHandlerEnabled(*args, **kwargs)
def SetExtraAscent(
*args, **kwargs)
SetExtraAscent(self, int extraAscent)
Set extra ascent for each line
def SetExtraAscent(*args, **kwargs): """ SetExtraAscent(self, int extraAscent) Set extra ascent for each line """ return _stc.StyledTextCtrl_SetExtraAscent(*args, **kwargs)
def SetExtraDescent(
*args, **kwargs)
SetExtraDescent(self, int extraDescent)
Set extra descent for each line
def SetExtraDescent(*args, **kwargs): """ SetExtraDescent(self, int extraDescent) Set extra descent for each line """ return _stc.StyledTextCtrl_SetExtraDescent(*args, **kwargs)
def SetExtraStyle(
*args, **kwargs)
SetExtraStyle(self, long exStyle)
Sets the extra style bits for the window. Extra styles are the less often used style bits which can't be set with the constructor or with SetWindowStyleFlag()
def SetExtraStyle(*args, **kwargs): """ SetExtraStyle(self, long exStyle) Sets the extra style bits for the window. Extra styles are the less often used style bits which can't be set with the constructor or with SetWindowStyleFlag() """ return _core_.Window_SetExtraStyle(*args, **kwargs)
def SetFirstVisibleLine(
*args, **kwargs)
SetFirstVisibleLine(self, int lineDisplay)
Scroll so that a display line is at the top of the display.
def SetFirstVisibleLine(*args, **kwargs): """ SetFirstVisibleLine(self, int lineDisplay) Scroll so that a display line is at the top of the display. """ return _stc.StyledTextCtrl_SetFirstVisibleLine(*args, **kwargs)
def SetFocus(
*args, **kwargs)
SetFocus(self)
Set's the focus to this window, allowing it to receive keyboard input.
def SetFocus(*args, **kwargs): """ SetFocus(self) Set's the focus to this window, allowing it to receive keyboard input. """ return _core_.Window_SetFocus(*args, **kwargs)
def SetFocusFromKbd(
*args, **kwargs)
SetFocusFromKbd(self)
Set focus to this window as the result of a keyboard action. Normally only called internally.
def SetFocusFromKbd(*args, **kwargs): """ SetFocusFromKbd(self) Set focus to this window as the result of a keyboard action. Normally only called internally. """ return _core_.Window_SetFocusFromKbd(*args, **kwargs)
def SetFoldExpanded(
*args, **kwargs)
SetFoldExpanded(self, int line, bool expanded)
Show the children of a header line.
def SetFoldExpanded(*args, **kwargs): """ SetFoldExpanded(self, int line, bool expanded) Show the children of a header line. """ return _stc.StyledTextCtrl_SetFoldExpanded(*args, **kwargs)
def SetFoldFlags(
*args, **kwargs)
SetFoldFlags(self, int flags)
Set some style options for folding.
def SetFoldFlags(*args, **kwargs): """ SetFoldFlags(self, int flags) Set some style options for folding. """ return _stc.StyledTextCtrl_SetFoldFlags(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_SetFoldLevel(*args, **kwargs)
def SetFoldMarginColour(
*args, **kwargs)
SetFoldMarginColour(self, bool useSetting, Colour back)
Set the colours used as a chequerboard pattern in the fold margin
def SetFoldMarginColour(*args, **kwargs): """ SetFoldMarginColour(self, bool useSetting, Colour back) Set the colours used as a chequerboard pattern in the fold margin """ return _stc.StyledTextCtrl_SetFoldMarginColour(*args, **kwargs)
def SetFoldMarginHiColour(
*args, **kwargs)
SetFoldMarginHiColour(self, bool useSetting, Colour fore)
def SetFoldMarginHiColour(*args, **kwargs): """SetFoldMarginHiColour(self, bool useSetting, Colour fore)""" return _stc.StyledTextCtrl_SetFoldMarginHiColour(*args, **kwargs)
def SetFont(
*args, **kwargs)
SetFont(self, Font font) -> bool
Sets the font for this window.
def SetFont(*args, **kwargs): """ SetFont(self, Font font) -> bool Sets the font for this window. """ return _core_.Window_SetFont(*args, **kwargs)
def SetForegroundColour(
*args, **kwargs)
SetForegroundColour(self, Colour colour) -> bool
Sets the foreground colour of the window. Returns True is the colour was changed. The interpretation of foreground colour is dependent on the window class; it may be the text colour or other colour, or it may not be used at all.
def SetForegroundColour(*args, **kwargs): """ SetForegroundColour(self, Colour colour) -> bool Sets the foreground colour of the window. Returns True is the colour was changed. The interpretation of foreground colour is dependent on the window class; it may be the text colour or other colour, or it may not be used at all. """ return _core_.Window_SetForegroundColour(*args, **kwargs)
def SetHScrollBar(
*args, **kwargs)
SetHScrollBar(self, ScrollBar bar)
Set the horizontal scrollbar to use instead of the ont that's built-in.
def SetHScrollBar(*args, **kwargs): """ SetHScrollBar(self, ScrollBar bar) Set the horizontal scrollbar to use instead of the ont that's built-in. """ return _stc.StyledTextCtrl_SetHScrollBar(*args, **kwargs)
def SetHelpText(
*args, **kwargs)
SetHelpText(self, String text)
Sets the help text to be used as context-sensitive help for this
window. Note that the text is actually stored by the current
wx.HelpProvider implementation, and not in the window object itself.
def SetHelpText(*args, **kwargs): """ SetHelpText(self, String text) Sets the help text to be used as context-sensitive help for this window. Note that the text is actually stored by the current `wx.HelpProvider` implementation, and not in the window object itself. """ return _core_.Window_SetHelpText(*args, **kwargs)
def SetHelpTextForId(
*args, **kw)
SetHelpTextForId(self, String text)
Associate this help text with all windows with the same id as this one.
def deprecated_func(*args, **kw): warnings.warn("Call to deprecated item. %s" % msg, wxPyDeprecationWarning, stacklevel=2) return item(*args, **kw)
def SetHighlightGuide(
*args, **kwargs)
SetHighlightGuide(self, int column)
Set the highlighted indentation guide column. 0 = no highlighted guide.
def SetHighlightGuide(*args, **kwargs): """ SetHighlightGuide(self, int column) Set the highlighted indentation guide column. 0 = no highlighted guide. """ return _stc.StyledTextCtrl_SetHighlightGuide(*args, **kwargs)
def SetHint(
*args, **kwargs)
SetHint(self, String hint) -> bool
def SetHint(*args, **kwargs): """SetHint(self, String hint) -> bool""" return _core_.TextEntryBase_SetHint(*args, **kwargs)
def SetHotspotActiveBackground(
*args, **kwargs)
SetHotspotActiveBackground(self, bool useSetting, Colour back)
Set a back colour for active hotspots.
def SetHotspotActiveBackground(*args, **kwargs): """ SetHotspotActiveBackground(self, bool useSetting, Colour back) Set a back colour for active hotspots. """ return _stc.StyledTextCtrl_SetHotspotActiveBackground(*args, **kwargs)
def SetHotspotActiveForeground(
*args, **kwargs)
SetHotspotActiveForeground(self, bool useSetting, Colour fore)
Set a fore colour for active hotspots.
def SetHotspotActiveForeground(*args, **kwargs): """ SetHotspotActiveForeground(self, bool useSetting, Colour fore) Set a fore colour for active hotspots. """ return _stc.StyledTextCtrl_SetHotspotActiveForeground(*args, **kwargs)
def SetHotspotActiveUnderline(
*args, **kwargs)
SetHotspotActiveUnderline(self, bool underline)
Enable / Disable underlining active hotspots.
def SetHotspotActiveUnderline(*args, **kwargs): """ SetHotspotActiveUnderline(self, bool underline) Enable / Disable underlining active hotspots. """ return _stc.StyledTextCtrl_SetHotspotActiveUnderline(*args, **kwargs)
def SetHotspotSingleLine(
*args, **kwargs)
SetHotspotSingleLine(self, bool singleLine)
Limit hotspots to single line so hotspots on two lines don't merge.
def SetHotspotSingleLine(*args, **kwargs): """ SetHotspotSingleLine(self, bool singleLine) Limit hotspots to single line so hotspots on two lines don't merge. """ return _stc.StyledTextCtrl_SetHotspotSingleLine(*args, **kwargs)
def SetId(
*args, **kwargs)
SetId(self, int winid)
Sets the identifier of the window. Each window has an integer identifier. If the application has not provided one, an identifier will be generated. Normally, the identifier should be provided on creation and should not be modified subsequently.
def SetId(*args, **kwargs): """ SetId(self, int winid) Sets the identifier of the window. Each window has an integer identifier. If the application has not provided one, an identifier will be generated. Normally, the identifier should be provided on creation and should not be modified subsequently. """ return _core_.Window_SetId(*args, **kwargs)
def SetIdentifier(
*args, **kwargs)
SetIdentifier(self, int identifier)
def SetIdentifier(*args, **kwargs): """SetIdentifier(self, int identifier)""" return _stc.StyledTextCtrl_SetIdentifier(*args, **kwargs)
def SetIndent(
*args, **kwargs)
SetIndent(self, int indentSize)
Set the number of spaces used for one level of indentation.
def SetIndent(*args, **kwargs): """ SetIndent(self, int indentSize) Set the number of spaces used for one level of indentation. """ return _stc.StyledTextCtrl_SetIndent(*args, **kwargs)
def SetIndentationGuides(
*args, **kwargs)
SetIndentationGuides(self, int indentView)
Show or hide indentation guides.
def SetIndentationGuides(*args, **kwargs): """ SetIndentationGuides(self, int indentView) Show or hide indentation guides. """ return _stc.StyledTextCtrl_SetIndentationGuides(*args, **kwargs)
def SetIndicatorCurrent(
*args, **kwargs)
SetIndicatorCurrent(self, int indicator)
Set the indicator used for IndicatorFillRange and IndicatorClearRange
def SetIndicatorCurrent(*args, **kwargs): """ SetIndicatorCurrent(self, int indicator) Set the indicator used for IndicatorFillRange and IndicatorClearRange """ return _stc.StyledTextCtrl_SetIndicatorCurrent(*args, **kwargs)
def SetIndicatorValue(
*args, **kwargs)
SetIndicatorValue(self, int value)
Set the value used for IndicatorFillRange
def SetIndicatorValue(*args, **kwargs): """ SetIndicatorValue(self, int value) Set the value used for IndicatorFillRange """ return _stc.StyledTextCtrl_SetIndicatorValue(*args, **kwargs)
def SetInitialSize(
*args, **kwargs)
SetInitialSize(self, Size size=DefaultSize)
A 'Smart' SetSize that will fill in default size components with the window's best size values. Also set's the minsize for use with sizers.
def SetInitialSize(*args, **kwargs): """ SetInitialSize(self, Size size=DefaultSize) A 'Smart' SetSize that will fill in default size components with the window's *best size* values. Also set's the minsize for use with sizers. """ return _core_.Window_SetInitialSize(*args, **kwargs)
def SetInsertionPoint(
*args, **kwargs)
SetInsertionPoint(self, long pos)
Sets the insertion point in the combobox text field.
def SetInsertionPoint(*args, **kwargs): """ SetInsertionPoint(self, long pos) Sets the insertion point in the combobox text field. """ return _core_.TextEntryBase_SetInsertionPoint(*args, **kwargs)
def SetInsertionPointEnd(
*args, **kwargs)
SetInsertionPointEnd(self)
Move the insertion point to the end of the current value.
def SetInsertionPointEnd(*args, **kwargs): """ SetInsertionPointEnd(self) Move the insertion point to the end of the current value. """ return _core_.TextEntryBase_SetInsertionPointEnd(*args, **kwargs)
def SetKeyWords(
*args, **kwargs)
SetKeyWords(self, int keywordSet, String keyWords)
Set up the key words used by the lexer.
def SetKeyWords(*args, **kwargs): """ SetKeyWords(self, int keywordSet, String keyWords) Set up the key words used by the lexer. """ return _stc.StyledTextCtrl_SetKeyWords(*args, **kwargs)
def SetKeysUnicode(
*args, **kwargs)
SetKeysUnicode(self, bool keysUnicode)
Always interpret keyboard input as Unicode
def SetKeysUnicode(*args, **kwargs): """ SetKeysUnicode(self, bool keysUnicode) Always interpret keyboard input as Unicode """ return _stc.StyledTextCtrl_SetKeysUnicode(*args, **kwargs)
def SetLabel(
*args, **kwargs)
SetLabel(self, String label)
Set the text which the window shows in its label if applicable.
def SetLabel(*args, **kwargs): """ SetLabel(self, String label) Set the text which the window shows in its label if applicable. """ return _core_.Window_SetLabel(*args, **kwargs)
def SetLabelMarkup(
*args, **kwargs)
SetLabelMarkup(self, String markup) -> bool
def SetLabelMarkup(*args, **kwargs): """SetLabelMarkup(self, String markup) -> bool""" return _core_.Control_SetLabelMarkup(*args, **kwargs)
def SetLabelText(
*args, **kwargs)
SetLabelText(self, String text)
def SetLabelText(*args, **kwargs): """SetLabelText(self, String text)""" return _core_.Control_SetLabelText(*args, **kwargs)
def SetLastKeydownProcessed(
*args, **kwargs)
SetLastKeydownProcessed(self, bool val)
def SetLastKeydownProcessed(*args, **kwargs): """SetLastKeydownProcessed(self, bool val)""" return _stc.StyledTextCtrl_SetLastKeydownProcessed(*args, **kwargs)
def SetLayoutCache(
*args, **kwargs)
SetLayoutCache(self, int mode)
Sets the degree of caching of layout information.
def SetLayoutCache(*args, **kwargs): """ SetLayoutCache(self, int mode) Sets the degree of caching of layout information. """ return _stc.StyledTextCtrl_SetLayoutCache(*args, **kwargs)
def SetLayoutDirection(
*args, **kwargs)
SetLayoutDirection(self, int dir)
Set the layout direction (LTR or RTL) for this window.
def SetLayoutDirection(*args, **kwargs): """ SetLayoutDirection(self, int dir) Set the layout direction (LTR or RTL) for this window. """ return _core_.Window_SetLayoutDirection(*args, **kwargs)
def SetLexer(
*args, **kwargs)
SetLexer(self, int lexer)
Set the lexing language of the document.
def SetLexer(*args, **kwargs): """ SetLexer(self, int lexer) Set the lexing language of the document. """ return _stc.StyledTextCtrl_SetLexer(*args, **kwargs)
def SetLexerLanguage(
*args, **kwargs)
SetLexerLanguage(self, String language)
Set the lexing language of the document based on string name.
def SetLexerLanguage(*args, **kwargs): """ SetLexerLanguage(self, String language) Set the lexing language of the document based on string name. """ return _stc.StyledTextCtrl_SetLexerLanguage(*args, **kwargs)
def SetLineIndentation(
*args, **kwargs)
SetLineIndentation(self, int line, int indentSize)
Change the indentation of a line to a number of columns.
def SetLineIndentation(*args, **kwargs): """ SetLineIndentation(self, int line, int indentSize) Change the indentation of a line to a number of columns. """ return _stc.StyledTextCtrl_SetLineIndentation(*args, **kwargs)
def SetLineState(
*args, **kwargs)
SetLineState(self, int line, int state)
Used to hold extra styling information for each line.
def SetLineState(*args, **kwargs): """ SetLineState(self, int line, int state) Used to hold extra styling information for each line. """ return _stc.StyledTextCtrl_SetLineState(*args, **kwargs)
def SetMainSelection(
*args, **kwargs)
SetMainSelection(self, int selection)
Set the main selection
def SetMainSelection(*args, **kwargs): """ SetMainSelection(self, int selection) Set the main selection """ return _stc.StyledTextCtrl_SetMainSelection(*args, **kwargs)
def SetMarginCursor(
*args, **kwargs)
SetMarginCursor(self, int margin, int cursor)
def SetMarginCursor(*args, **kwargs): """SetMarginCursor(self, int margin, int cursor)""" return _stc.StyledTextCtrl_SetMarginCursor(*args, **kwargs)
def SetMarginLeft(
*args, **kwargs)
SetMarginLeft(self, int pixelWidth)
Sets the size in pixels of the left margin.
def SetMarginLeft(*args, **kwargs): """ SetMarginLeft(self, int pixelWidth) Sets the size in pixels of the left margin. """ return _stc.StyledTextCtrl_SetMarginLeft(*args, **kwargs)
def SetMarginMask(
*args, **kwargs)
SetMarginMask(self, int margin, int mask)
Set a mask that determines which markers are displayed in a margin.
def SetMarginMask(*args, **kwargs): """ SetMarginMask(self, int margin, int mask) Set a mask that determines which markers are displayed in a margin. """ return _stc.StyledTextCtrl_SetMarginMask(*args, **kwargs)
def SetMarginOptions(
*args, **kwargs)
SetMarginOptions(self, int marginOptions)
def SetMarginOptions(*args, **kwargs): """SetMarginOptions(self, int marginOptions)""" return _stc.StyledTextCtrl_SetMarginOptions(*args, **kwargs)
def SetMarginRight(
*args, **kwargs)
SetMarginRight(self, int pixelWidth)
Sets the size in pixels of the right margin.
def SetMarginRight(*args, **kwargs): """ SetMarginRight(self, int pixelWidth) Sets the size in pixels of the right margin. """ return _stc.StyledTextCtrl_SetMarginRight(*args, **kwargs)
def SetMarginSensitive(
*args, **kwargs)
SetMarginSensitive(self, int margin, bool sensitive)
Make a margin sensitive or insensitive to mouse clicks.
def SetMarginSensitive(*args, **kwargs): """ SetMarginSensitive(self, int margin, bool sensitive) Make a margin sensitive or insensitive to mouse clicks. """ return _stc.StyledTextCtrl_SetMarginSensitive(*args, **kwargs)
def SetMarginType(
*args, **kwargs)
SetMarginType(self, int margin, int marginType)
Set a margin to be either numeric or symbolic.
def SetMarginType(*args, **kwargs): """ SetMarginType(self, int margin, int marginType) Set a margin to be either numeric or symbolic. """ return _stc.StyledTextCtrl_SetMarginType(*args, **kwargs)
def SetMarginWidth(
*args, **kwargs)
SetMarginWidth(self, int margin, int pixelWidth)
Set the width of a margin to a width expressed in pixels.
def SetMarginWidth(*args, **kwargs): """ SetMarginWidth(self, int margin, int pixelWidth) Set the width of a margin to a width expressed in pixels. """ return _stc.StyledTextCtrl_SetMarginWidth(*args, **kwargs)
def SetMargins(
*args, **kwargs)
SetMargins(self, int left, int right)
Set the left and right margin in the edit area, measured in pixels.
def SetMargins(*args, **kwargs): """ SetMargins(self, int left, int right) Set the left and right margin in the edit area, measured in pixels. """ return _stc.StyledTextCtrl_SetMargins(*args, **kwargs)
def SetMaxClientSize(
*args, **kwargs)
SetMaxClientSize(self, Size size)
def SetMaxClientSize(*args, **kwargs): """SetMaxClientSize(self, Size size)""" return _core_.Window_SetMaxClientSize(*args, **kwargs)
def SetMaxLength(
*args, **kwargs)
SetMaxLength(self, long len)
Set the max number of characters which may be entered in a single line text control.
def SetMaxLength(*args, **kwargs): """ SetMaxLength(self, long len) Set the max number of characters which may be entered in a single line text control. """ return _core_.TextEntryBase_SetMaxLength(*args, **kwargs)
def SetMaxSize(
*args, **kwargs)
SetMaxSize(self, Size maxSize)
A more convenient method than SetSizeHints for setting just the
max size.
def SetMaxSize(*args, **kwargs): """ SetMaxSize(self, Size maxSize) A more convenient method than `SetSizeHints` for setting just the max size. """ return _core_.Window_SetMaxSize(*args, **kwargs)
def SetMinClientSize(
*args, **kwargs)
SetMinClientSize(self, Size size)
def SetMinClientSize(*args, **kwargs): """SetMinClientSize(self, Size size)""" return _core_.Window_SetMinClientSize(*args, **kwargs)
def SetMinSize(
*args, **kwargs)
SetMinSize(self, Size minSize)
A more convenient method than SetSizeHints for setting just the
min size.
def SetMinSize(*args, **kwargs): """ SetMinSize(self, Size minSize) A more convenient method than `SetSizeHints` for setting just the min size. """ return _core_.Window_SetMinSize(*args, **kwargs)
def SetModEventMask(
*args, **kwargs)
SetModEventMask(self, int mask)
Set which document modification events are sent to the container.
def SetModEventMask(*args, **kwargs): """ SetModEventMask(self, int mask) Set which document modification events are sent to the container. """ return _stc.StyledTextCtrl_SetModEventMask(*args, **kwargs)
def SetModified(
*args, **kwargs)
SetModified(self, bool modified)
def SetModified(*args, **kwargs): """SetModified(self, bool modified)""" return _core_.TextAreaBase_SetModified(*args, **kwargs)
def SetMouseDownCaptures(
*args, **kwargs)
SetMouseDownCaptures(self, bool captures)
Set whether the mouse is captured when its button is pressed.
def SetMouseDownCaptures(*args, **kwargs): """ SetMouseDownCaptures(self, bool captures) Set whether the mouse is captured when its button is pressed. """ return _stc.StyledTextCtrl_SetMouseDownCaptures(*args, **kwargs)
def SetMouseDwellTime(
*args, **kwargs)
SetMouseDwellTime(self, int periodMilliseconds)
Sets the time the mouse must sit still to generate a mouse dwell event.
def SetMouseDwellTime(*args, **kwargs): """ SetMouseDwellTime(self, int periodMilliseconds) Sets the time the mouse must sit still to generate a mouse dwell event. """ return _stc.StyledTextCtrl_SetMouseDwellTime(*args, **kwargs)
def SetMultiPaste(
*args, **kwargs)
SetMultiPaste(self, int multiPaste)
def SetMultiPaste(*args, **kwargs): """SetMultiPaste(self, int multiPaste)""" return _stc.StyledTextCtrl_SetMultiPaste(*args, **kwargs)
def SetMultipleSelection(
*args, **kwargs)
SetMultipleSelection(self, bool multipleSelection)
Set whether multiple selections can be made
def SetMultipleSelection(*args, **kwargs): """ SetMultipleSelection(self, bool multipleSelection) Set whether multiple selections can be made """ return _stc.StyledTextCtrl_SetMultipleSelection(*args, **kwargs)
def SetName(
*args, **kwargs)
SetName(self, String name)
Sets the window's name. The window name is used for ressource setting in X, it is not the same as the window title/label
def SetName(*args, **kwargs): """ SetName(self, String name) Sets the window's name. The window name is used for ressource setting in X, it is not the same as the window title/label """ return _core_.Window_SetName(*args, **kwargs)
def SetNextHandler(
*args, **kwargs)
SetNextHandler(self, EvtHandler handler)
def SetNextHandler(*args, **kwargs): """SetNextHandler(self, EvtHandler handler)""" return _core_.EvtHandler_SetNextHandler(*args, **kwargs)
def SetOvertype(
*args, **kwargs)
SetOvertype(self, bool overtype)
Set to overtype (true) or insert mode.
def SetOvertype(*args, **kwargs): """ SetOvertype(self, bool overtype) Set to overtype (true) or insert mode. """ return _stc.StyledTextCtrl_SetOvertype(*args, **kwargs)
def SetOwnBackgroundColour(
*args, **kwargs)
SetOwnBackgroundColour(self, Colour colour)
def SetOwnBackgroundColour(*args, **kwargs): """SetOwnBackgroundColour(self, Colour colour)""" return _core_.Window_SetOwnBackgroundColour(*args, **kwargs)
def SetOwnFont(
*args, **kwargs)
SetOwnFont(self, Font font)
def SetOwnFont(*args, **kwargs): """SetOwnFont(self, Font font)""" return _core_.Window_SetOwnFont(*args, **kwargs)
def SetOwnForegroundColour(
*args, **kwargs)
SetOwnForegroundColour(self, Colour colour)
def SetOwnForegroundColour(*args, **kwargs): """SetOwnForegroundColour(self, Colour colour)""" return _core_.Window_SetOwnForegroundColour(*args, **kwargs)
def SetPasteConvertEndings(
*args, **kwargs)
SetPasteConvertEndings(self, bool convert)
Enable/Disable convert-on-paste for line endings
def SetPasteConvertEndings(*args, **kwargs): """ SetPasteConvertEndings(self, bool convert) Enable/Disable convert-on-paste for line endings """ return _stc.StyledTextCtrl_SetPasteConvertEndings(*args, **kwargs)
def SetPosition(
*args, **kwargs)
Move(self, Point pt, int flags=SIZE_USE_EXISTING)
Moves the window to the given position.
def Move(*args, **kwargs): """ Move(self, Point pt, int flags=SIZE_USE_EXISTING) Moves the window to the given position. """ return _core_.Window_Move(*args, **kwargs)
def SetPositionCacheSize(
*args, **kwargs)
SetPositionCacheSize(self, int size)
Set number of entries in position cache
def SetPositionCacheSize(*args, **kwargs): """ SetPositionCacheSize(self, int size) Set number of entries in position cache """ return _stc.StyledTextCtrl_SetPositionCacheSize(*args, **kwargs)
def SetPreviousHandler(
*args, **kwargs)
SetPreviousHandler(self, EvtHandler handler)
def SetPreviousHandler(*args, **kwargs): """SetPreviousHandler(self, EvtHandler handler)""" return _core_.EvtHandler_SetPreviousHandler(*args, **kwargs)
def SetPrintColourMode(
*args, **kwargs)
SetPrintColourMode(self, int mode)
Modify colours when printing for clearer printed text.
def SetPrintColourMode(*args, **kwargs): """ SetPrintColourMode(self, int mode) Modify colours when printing for clearer printed text. """ return _stc.StyledTextCtrl_SetPrintColourMode(*args, **kwargs)
def SetPrintMagnification(
*args, **kwargs)
SetPrintMagnification(self, int magnification)
Sets the print magnification added to the point size of each style for printing.
def SetPrintMagnification(*args, **kwargs): """ SetPrintMagnification(self, int magnification) Sets the print magnification added to the point size of each style for printing. """ return _stc.StyledTextCtrl_SetPrintMagnification(*args, **kwargs)
def SetPrintWrapMode(
*args, **kwargs)
SetPrintWrapMode(self, int mode)
Set printing to line wrapped (SC_WRAP_WORD) or not line wrapped (SC_WRAP_NONE).
def SetPrintWrapMode(*args, **kwargs): """ SetPrintWrapMode(self, int mode) Set printing to line wrapped (SC_WRAP_WORD) or not line wrapped (SC_WRAP_NONE). """ return _stc.StyledTextCtrl_SetPrintWrapMode(*args, **kwargs)
def SetProperty(
*args, **kwargs)
SetProperty(self, String key, String value)
Set up a value that may be used by a lexer for some optional feature.
def SetProperty(*args, **kwargs): """ SetProperty(self, String key, String value) Set up a value that may be used by a lexer for some optional feature. """ return _stc.StyledTextCtrl_SetProperty(*args, **kwargs)
def SetPunctuationChars(
*args, **kwargs)
SetPunctuationChars(self, String characters)
def SetPunctuationChars(*args, **kwargs): """SetPunctuationChars(self, String characters)""" return _stc.StyledTextCtrl_SetPunctuationChars(*args, **kwargs)
def SetReadOnly(
*args, **kwargs)
SetReadOnly(self, bool readOnly)
Set to read only or read write.
def SetReadOnly(*args, **kwargs): """ SetReadOnly(self, bool readOnly) Set to read only or read write. """ return _stc.StyledTextCtrl_SetReadOnly(*args, **kwargs)
def SetRect(
*args, **kwargs)
SetRect(self, Rect rect, int sizeFlags=SIZE_AUTO)
Sets the position and size of the window in pixels using a wx.Rect.
def SetRect(*args, **kwargs): """ SetRect(self, Rect rect, int sizeFlags=SIZE_AUTO) Sets the position and size of the window in pixels using a wx.Rect. """ return _core_.Window_SetRect(*args, **kwargs)
def SetRectangularSelectionAnchor(
*args, **kwargs)
SetRectangularSelectionAnchor(self, int posAnchor)
def SetRectangularSelectionAnchor(*args, **kwargs): """SetRectangularSelectionAnchor(self, int posAnchor)""" return _stc.StyledTextCtrl_SetRectangularSelectionAnchor(*args, **kwargs)
def SetRectangularSelectionAnchorVirtualSpace(
*args, **kwargs)
SetRectangularSelectionAnchorVirtualSpace(self, int space)
def SetRectangularSelectionAnchorVirtualSpace(*args, **kwargs): """SetRectangularSelectionAnchorVirtualSpace(self, int space)""" return _stc.StyledTextCtrl_SetRectangularSelectionAnchorVirtualSpace(*args, **kwargs)
def SetRectangularSelectionCaret(
*args, **kwargs)
SetRectangularSelectionCaret(self, int pos)
def SetRectangularSelectionCaret(*args, **kwargs): """SetRectangularSelectionCaret(self, int pos)""" return _stc.StyledTextCtrl_SetRectangularSelectionCaret(*args, **kwargs)
def SetRectangularSelectionCaretVirtualSpace(
*args, **kwargs)
SetRectangularSelectionCaretVirtualSpace(self, int space)
def SetRectangularSelectionCaretVirtualSpace(*args, **kwargs): """SetRectangularSelectionCaretVirtualSpace(self, int space)""" return _stc.StyledTextCtrl_SetRectangularSelectionCaretVirtualSpace(*args, **kwargs)
def SetRectangularSelectionModifier(
*args, **kwargs)
SetRectangularSelectionModifier(self, int 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 SCMOD_CTRL(default), SCMOD_ALT, or SCMOD_SUPER.
def SetRectangularSelectionModifier(*args, **kwargs): """ SetRectangularSelectionModifier(self, int 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 SCMOD_CTRL(default), SCMOD_ALT, or SCMOD_SUPER. """ return _stc.StyledTextCtrl_SetRectangularSelectionModifier(*args, **kwargs)
def SetSTCCursor(
*args, **kwargs)
SetSTCCursor(self, int cursorType)
Sets the cursor to one of the SC_CURSOR* values.
def SetSTCCursor(*args, **kwargs): """ SetSTCCursor(self, int cursorType) Sets the cursor to one of the SC_CURSOR* values. """ return _stc.StyledTextCtrl_SetSTCCursor(*args, **kwargs)
def SetSTCFocus(
*args, **kwargs)
SetSTCFocus(self, bool focus)
Change internal focus flag.
def SetSTCFocus(*args, **kwargs): """ SetSTCFocus(self, bool focus) Change internal focus flag. """ return _stc.StyledTextCtrl_SetSTCFocus(*args, **kwargs)
def SetSavePoint(
*args, **kwargs)
SetSavePoint(self)
Remember the current position in the undo history as the position at which the document was saved.
def SetSavePoint(*args, **kwargs): """ SetSavePoint(self) Remember the current position in the undo history as the position at which the document was saved. """ return _stc.StyledTextCtrl_SetSavePoint(*args, **kwargs)
def SetScrollPos(
*args, **kwargs)
SetScrollPos(self, int orientation, int pos, bool refresh=True)
Sets the position of one of the built-in scrollbars.
def SetScrollPos(*args, **kwargs): """ SetScrollPos(self, int orientation, int pos, bool refresh=True) Sets the position of one of the built-in scrollbars. """ return _core_.Window_SetScrollPos(*args, **kwargs)
def SetScrollWidth(
*args, **kwargs)
SetScrollWidth(self, int pixelWidth)
Sets the document width assumed for scrolling.
def SetScrollWidth(*args, **kwargs): """ SetScrollWidth(self, int pixelWidth) Sets the document width assumed for scrolling. """ return _stc.StyledTextCtrl_SetScrollWidth(*args, **kwargs)
def SetScrollWidthTracking(
*args, **kwargs)
SetScrollWidthTracking(self, bool tracking)
Sets whether the maximum width line displayed is used to set scroll width.
def SetScrollWidthTracking(*args, **kwargs): """ SetScrollWidthTracking(self, bool tracking) Sets whether the maximum width line displayed is used to set scroll width. """ return _stc.StyledTextCtrl_SetScrollWidthTracking(*args, **kwargs)
def SetScrollbar(
*args, **kwargs)
SetScrollbar(self, int orientation, int position, int thumbSize, int range, bool refresh=True)
Sets the scrollbar properties of a built-in scrollbar.
def SetScrollbar(*args, **kwargs): """ SetScrollbar(self, int orientation, int position, int thumbSize, int range, bool refresh=True) Sets the scrollbar properties of a built-in scrollbar. """ return _core_.Window_SetScrollbar(*args, **kwargs)
def SetSearchFlags(
*args, **kwargs)
SetSearchFlags(self, int flags)
Set the search flags used by SearchInTarget.
def SetSearchFlags(*args, **kwargs): """ SetSearchFlags(self, int flags) Set the search flags used by SearchInTarget. """ return _stc.StyledTextCtrl_SetSearchFlags(*args, **kwargs)
def SetSelAlpha(
*args, **kwargs)
SetSelAlpha(self, int alpha)
Set the alpha of the selection.
def SetSelAlpha(*args, **kwargs): """ SetSelAlpha(self, int alpha) Set the alpha of the selection. """ return _stc.StyledTextCtrl_SetSelAlpha(*args, **kwargs)
def SetSelBackground(
*args, **kwargs)
SetSelBackground(self, bool useSetting, Colour back)
Set the background colour of the main and additional selections and whether to use this setting.
def SetSelBackground(*args, **kwargs): """ SetSelBackground(self, bool useSetting, Colour back) Set the background colour of the main and additional selections and whether to use this setting. """ return _stc.StyledTextCtrl_SetSelBackground(*args, **kwargs)
def SetSelEOLFilled(
*args, **kwargs)
SetSelEOLFilled(self, bool filled)
Set the selection to have its end of line filled or not.
def SetSelEOLFilled(*args, **kwargs): """ SetSelEOLFilled(self, bool filled) Set the selection to have its end of line filled or not. """ return _stc.StyledTextCtrl_SetSelEOLFilled(*args, **kwargs)
def SetSelForeground(
*args, **kwargs)
SetSelForeground(self, bool useSetting, Colour fore)
Set the foreground colour of the main and additional selections and whether to use this setting.
def SetSelForeground(*args, **kwargs): """ SetSelForeground(self, bool useSetting, Colour fore) Set the foreground colour of the main and additional selections and whether to use this setting. """ return _stc.StyledTextCtrl_SetSelForeground(*args, **kwargs)
def SetSelection(
*args, **kwargs)
SetSelection(self, long from, long to)
Selects the text starting at the first position up to (but not including) the character at the last position. If both parameters are -1 then all text in the control is selected.
def SetSelection(*args, **kwargs): """ SetSelection(self, long from, long to) Selects the text starting at the first position up to (but not including) the character at the last position. If both parameters are -1 then all text in the control is selected. """ return _core_.TextEntryBase_SetSelection(*args, **kwargs)
def SetSelectionEnd(
*args, **kwargs)
SetSelectionEnd(self, int pos)
Sets the position that ends the selection - this becomes the currentPosition.
def SetSelectionEnd(*args, **kwargs): """ SetSelectionEnd(self, int pos) Sets the position that ends the selection - this becomes the currentPosition. """ return _stc.StyledTextCtrl_SetSelectionEnd(*args, **kwargs)
def SetSelectionMode(
*args, **kwargs)
SetSelectionMode(self, int mode)
Set the selection mode to stream (SC_SEL_STREAM) or rectangular (SC_SEL_RECTANGLE/SC_SEL_THIN) or by lines (SC_SEL_LINES).
def SetSelectionMode(*args, **kwargs): """ SetSelectionMode(self, int mode) Set the selection mode to stream (SC_SEL_STREAM) or rectangular (SC_SEL_RECTANGLE/SC_SEL_THIN) or by lines (SC_SEL_LINES). """ return _stc.StyledTextCtrl_SetSelectionMode(*args, **kwargs)
def SetSelectionNAnchor(
*args, **kwargs)
SetSelectionNAnchor(self, int selection, int posAnchor)
def SetSelectionNAnchor(*args, **kwargs): """SetSelectionNAnchor(self, int selection, int posAnchor)""" return _stc.StyledTextCtrl_SetSelectionNAnchor(*args, **kwargs)
def SetSelectionNAnchorVirtualSpace(
*args, **kwargs)
SetSelectionNAnchorVirtualSpace(self, int selection, int space)
def SetSelectionNAnchorVirtualSpace(*args, **kwargs): """SetSelectionNAnchorVirtualSpace(self, int selection, int space)""" return _stc.StyledTextCtrl_SetSelectionNAnchorVirtualSpace(*args, **kwargs)
def SetSelectionNCaret(
*args, **kwargs)
SetSelectionNCaret(self, int selection, int pos)
def SetSelectionNCaret(*args, **kwargs): """SetSelectionNCaret(self, int selection, int pos)""" return _stc.StyledTextCtrl_SetSelectionNCaret(*args, **kwargs)
def SetSelectionNCaretVirtualSpace(
*args, **kwargs)
SetSelectionNCaretVirtualSpace(self, int selection, int space)
def SetSelectionNCaretVirtualSpace(*args, **kwargs): """SetSelectionNCaretVirtualSpace(self, int selection, int space)""" return _stc.StyledTextCtrl_SetSelectionNCaretVirtualSpace(*args, **kwargs)
def SetSelectionNEnd(
*args, **kwargs)
SetSelectionNEnd(self, int selection, int pos)
Sets the position that ends the selection - this becomes the currentPosition.
def SetSelectionNEnd(*args, **kwargs): """ SetSelectionNEnd(self, int selection, int pos) Sets the position that ends the selection - this becomes the currentPosition. """ return _stc.StyledTextCtrl_SetSelectionNEnd(*args, **kwargs)
def SetSelectionNStart(
*args, **kwargs)
SetSelectionNStart(self, int selection, int pos)
Sets the position that starts the selection - this becomes the anchor.
def SetSelectionNStart(*args, **kwargs): """ SetSelectionNStart(self, int selection, int pos) Sets the position that starts the selection - this becomes the anchor. """ return _stc.StyledTextCtrl_SetSelectionNStart(*args, **kwargs)
def SetSelectionStart(
*args, **kwargs)
SetSelectionStart(self, int pos)
Sets the position that starts the selection - this becomes the anchor.
def SetSelectionStart(*args, **kwargs): """ SetSelectionStart(self, int pos) Sets the position that starts the selection - this becomes the anchor. """ return _stc.StyledTextCtrl_SetSelectionStart(*args, **kwargs)
def SetSize(
*args, **kwargs)
SetSize(self, Size size)
Sets the size of the window in pixels.
def SetSize(*args, **kwargs): """ SetSize(self, Size size) Sets the size of the window in pixels. """ return _core_.Window_SetSize(*args, **kwargs)
def SetSizeHints(
*args, **kwargs)
SetSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1, int incW=-1, int incH=-1)
Allows specification of minimum and maximum window sizes, and window size increments. If a pair of values is not set (or set to -1), the default values will be used. If this function is called, the user will not be able to size the window outside the given bounds (if it is a top-level window.) Sizers will also inspect the minimum window size and will use that value if set when calculating layout.
The resizing increments are only significant under Motif or Xt.
def SetSizeHints(*args, **kwargs): """ SetSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1, int incW=-1, int incH=-1) Allows specification of minimum and maximum window sizes, and window size increments. If a pair of values is not set (or set to -1), the default values will be used. If this function is called, the user will not be able to size the window outside the given bounds (if it is a top-level window.) Sizers will also inspect the minimum window size and will use that value if set when calculating layout. The resizing increments are only significant under Motif or Xt. """ return _core_.Window_SetSizeHints(*args, **kwargs)
def SetSizeHintsSz(
*args, **kwargs)
SetSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize, Size incSize=DefaultSize)
Allows specification of minimum and maximum window sizes, and window size increments. If a pair of values is not set (or set to -1), the default values will be used. If this function is called, the user will not be able to size the window outside the given bounds (if it is a top-level window.) Sizers will also inspect the minimum window size and will use that value if set when calculating layout.
The resizing increments are only significant under Motif or Xt.
def SetSizeHintsSz(*args, **kwargs): """ SetSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize, Size incSize=DefaultSize) Allows specification of minimum and maximum window sizes, and window size increments. If a pair of values is not set (or set to -1), the default values will be used. If this function is called, the user will not be able to size the window outside the given bounds (if it is a top-level window.) Sizers will also inspect the minimum window size and will use that value if set when calculating layout. The resizing increments are only significant under Motif or Xt. """ return _core_.Window_SetSizeHintsSz(*args, **kwargs)
def SetSizeWH(
*args, **kwargs)
SetSizeWH(self, int width, int height)
Sets the size of the window in pixels.
def SetSizeWH(*args, **kwargs): """ SetSizeWH(self, int width, int height) Sets the size of the window in pixels. """ return _core_.Window_SetSizeWH(*args, **kwargs)
def SetSizer(
*args, **kwargs)
SetSizer(self, Sizer sizer, bool deleteOld=True)
Sets the window to have the given layout sizer. The window will then own the object, and will take care of its deletion. If an existing layout sizer object is already owned by the window, it will be deleted if the deleteOld parameter is true. Note that this function will also call SetAutoLayout implicitly with a True parameter if the sizer is non-None, and False otherwise.
def SetSizer(*args, **kwargs): """ SetSizer(self, Sizer sizer, bool deleteOld=True) Sets the window to have the given layout sizer. The window will then own the object, and will take care of its deletion. If an existing layout sizer object is already owned by the window, it will be deleted if the deleteOld parameter is true. Note that this function will also call SetAutoLayout implicitly with a True parameter if the sizer is non-None, and False otherwise. """ return _core_.Window_SetSizer(*args, **kwargs)
def SetSizerAndFit(
*args, **kwargs)
SetSizerAndFit(self, Sizer sizer, bool deleteOld=True)
The same as SetSizer, except it also sets the size hints for the window based on the sizer's minimum size.
def SetSizerAndFit(*args, **kwargs): """ SetSizerAndFit(self, Sizer sizer, bool deleteOld=True) The same as SetSizer, except it also sets the size hints for the window based on the sizer's minimum size. """ return _core_.Window_SetSizerAndFit(*args, **kwargs)
def SetStatus(
*args, **kwargs)
SetStatus(self, int statusCode)
Change error status - 0 = OK.
def SetStatus(*args, **kwargs): """ SetStatus(self, int statusCode) Change error status - 0 = OK. """ return _stc.StyledTextCtrl_SetStatus(*args, **kwargs)
def SetStyle(
*args, **kwargs)
SetStyle(self, long start, long end, wxTextAttr style) -> bool
def SetStyle(*args, **kwargs): """SetStyle(self, long start, long end, wxTextAttr style) -> bool""" return _core_.TextAreaBase_SetStyle(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_SetStyleBits(*args, **kwargs)
def SetStyleBytes(
*args, **kwargs)
SetStyleBytes(self, int length, char styleBytes)
Set the styles for a segment of the document.
def SetStyleBytes(*args, **kwargs): """ SetStyleBytes(self, int length, char styleBytes) Set the styles for a segment of the document. """ return _stc.StyledTextCtrl_SetStyleBytes(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_SetStyling(*args, **kwargs)
def SetTabIndents(
*args, **kwargs)
SetTabIndents(self, bool tabIndents)
Sets whether a tab pressed when caret is within indentation indents.
def SetTabIndents(*args, **kwargs): """ SetTabIndents(self, bool tabIndents) Sets whether a tab pressed when caret is within indentation indents. """ return _stc.StyledTextCtrl_SetTabIndents(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_SetTabWidth(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_SetTargetEnd(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_SetTargetStart(*args, **kwargs)
def SetTechnology(
*args, **kwargs)
SetTechnology(self, int technology)
def SetTechnology(*args, **kwargs): """SetTechnology(self, int technology)""" return _stc.StyledTextCtrl_SetTechnology(*args, **kwargs)
def SetText(
*args, **kwargs)
SetText(self, String text)
Replace the contents of the document with the argument text.
def SetText(*args, **kwargs): """ SetText(self, String text) Replace the contents of the document with the argument text. """ return _stc.StyledTextCtrl_SetText(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_SetTextRaw(*args, **kwargs)
def SetTextUTF8(
self, text)
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.
def SetTextUTF8(self, text): """ 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. """ if not wx.USE_UNICODE: u = text.decode('utf-8') text = u.encode(wx.GetDefaultPyEncoding()) self.SetTextRaw(text)
def SetThemeEnabled(
*args, **kwargs)
SetThemeEnabled(self, bool enableTheme)
This function tells a window if it should use the system's "theme" code to draw the windows' background instead if its own background drawing code. This will only have an effect on platforms that support the notion of themes in user defined windows. One such platform is GTK+ where windows can have (very colourful) backgrounds defined by a user's selected theme.
Dialogs, notebook pages and the status bar have this flag set to true by default so that the default look and feel is simulated best.
def SetThemeEnabled(*args, **kwargs): """ SetThemeEnabled(self, bool enableTheme) This function tells a window if it should use the system's "theme" code to draw the windows' background instead if its own background drawing code. This will only have an effect on platforms that support the notion of themes in user defined windows. One such platform is GTK+ where windows can have (very colourful) backgrounds defined by a user's selected theme. Dialogs, notebook pages and the status bar have this flag set to true by default so that the default look and feel is simulated best. """ return _core_.Window_SetThemeEnabled(*args, **kwargs)
def SetToolTip(
*args, **kwargs)
SetToolTip(self, ToolTip tip)
Attach a tooltip to the window.
def SetToolTip(*args, **kwargs): """ SetToolTip(self, ToolTip tip) Attach a tooltip to the window. """ return _core_.Window_SetToolTip(*args, **kwargs)
def SetToolTipString(
*args, **kwargs)
SetToolTipString(self, String tip)
Attach a tooltip to the window.
def SetToolTipString(*args, **kwargs): """ SetToolTipString(self, String tip) Attach a tooltip to the window. """ return _core_.Window_SetToolTipString(*args, **kwargs)
def SetTransparent(
*args, **kwargs)
SetTransparent(self, byte alpha) -> bool
Attempt to set the transparency of this window to the alpha value,
returns True on success. The alpha value is an integer in the
range of 0 to 255, where 0 is fully transparent and 255 is fully
opaque.
def SetTransparent(*args, **kwargs): """ SetTransparent(self, byte alpha) -> bool Attempt to set the transparency of this window to the ``alpha`` value, returns True on success. The ``alpha`` value is an integer in the range of 0 to 255, where 0 is fully transparent and 255 is fully opaque. """ return _core_.Window_SetTransparent(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_SetTwoPhaseDraw(*args, **kwargs)
def SetUndoCollection(
*args, **kwargs)
SetUndoCollection(self, bool collectUndo)
Choose between collecting actions into the undo history and discarding them.
def SetUndoCollection(*args, **kwargs): """ SetUndoCollection(self, bool collectUndo) Choose between collecting actions into the undo history and discarding them. """ return _stc.StyledTextCtrl_SetUndoCollection(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_SetUseAntiAliasing(*args, **kwargs)
def SetUseHorizontalScrollBar(
*args, **kwargs)
SetUseHorizontalScrollBar(self, bool show)
Show or hide the horizontal scroll bar.
def SetUseHorizontalScrollBar(*args, **kwargs): """ SetUseHorizontalScrollBar(self, bool show) Show or hide the horizontal scroll bar. """ return _stc.StyledTextCtrl_SetUseHorizontalScrollBar(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_SetUseTabs(*args, **kwargs)
def SetUseVerticalScrollBar(
*args, **kwargs)
SetUseVerticalScrollBar(self, bool show)
Show or hide the vertical scroll bar.
def SetUseVerticalScrollBar(*args, **kwargs): """ SetUseVerticalScrollBar(self, bool show) Show or hide the vertical scroll bar. """ return _stc.StyledTextCtrl_SetUseVerticalScrollBar(*args, **kwargs)
def SetVScrollBar(
*args, **kwargs)
SetVScrollBar(self, ScrollBar bar)
Set the vertical scrollbar to use instead of the one that's built-in.
def SetVScrollBar(*args, **kwargs): """ SetVScrollBar(self, ScrollBar bar) Set the vertical scrollbar to use instead of the one that's built-in. """ return _stc.StyledTextCtrl_SetVScrollBar(*args, **kwargs)
def SetValidator(
*args, **kwargs)
SetValidator(self, Validator validator)
Deletes the current validator (if any) and sets the window validator, having called wx.Validator.Clone to create a new validator of this type.
def SetValidator(*args, **kwargs): """ SetValidator(self, Validator validator) Deletes the current validator (if any) and sets the window validator, having called wx.Validator.Clone to create a new validator of this type. """ return _core_.Window_SetValidator(*args, **kwargs)
def SetValue(
*args, **kwargs)
SetValue(self, String value)
Set the value in the text entry field. Generates a text change event.
def SetValue(*args, **kwargs): """ SetValue(self, String value) Set the value in the text entry field. Generates a text change event. """ return _core_.TextEntryBase_SetValue(*args, **kwargs)
def SetViewEOL(
*args, **kwargs)
SetViewEOL(self, bool visible)
Make the end of line characters visible or invisible.
def SetViewEOL(*args, **kwargs): """ SetViewEOL(self, bool visible) Make the end of line characters visible or invisible. """ return _stc.StyledTextCtrl_SetViewEOL(*args, **kwargs)
def SetViewWhiteSpace(
*args, **kwargs)
SetViewWhiteSpace(self, int viewWS)
Make white space characters invisible, always visible or visible outside indentation.
def SetViewWhiteSpace(*args, **kwargs): """ SetViewWhiteSpace(self, int viewWS) Make white space characters invisible, always visible or visible outside indentation. """ return _stc.StyledTextCtrl_SetViewWhiteSpace(*args, **kwargs)
def SetVirtualSize(
*args, **kwargs)
SetVirtualSize(self, Size size)
Set the the virtual size of a window in pixels. For most windows this is just the client area of the window, but for some like scrolled windows it is more or less independent of the screen window size.
def SetVirtualSize(*args, **kwargs): """ SetVirtualSize(self, Size size) Set the the virtual size of a window in pixels. For most windows this is just the client area of the window, but for some like scrolled windows it is more or less independent of the screen window size. """ return _core_.Window_SetVirtualSize(*args, **kwargs)
def SetVirtualSizeHints(
*args, **kw)
SetVirtualSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1)
def deprecated_func(*args, **kw): warnings.warn("Call to deprecated item. %s" % msg, wxPyDeprecationWarning, stacklevel=2) return item(*args, **kw)
def SetVirtualSizeHintsSz(
*args, **kw)
SetVirtualSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize)
def deprecated_func(*args, **kw): warnings.warn("Call to deprecated item. %s" % msg, wxPyDeprecationWarning, stacklevel=2) return item(*args, **kw)
def SetVirtualSizeWH(
*args, **kwargs)
SetVirtualSizeWH(self, int w, int h)
Set the the virtual size of a window in pixels. For most windows this is just the client area of the window, but for some like scrolled windows it is more or less independent of the screen window size.
def SetVirtualSizeWH(*args, **kwargs): """ SetVirtualSizeWH(self, int w, int h) Set the the virtual size of a window in pixels. For most windows this is just the client area of the window, but for some like scrolled windows it is more or less independent of the screen window size. """ return _core_.Window_SetVirtualSizeWH(*args, **kwargs)
def SetVirtualSpaceOptions(
*args, **kwargs)
SetVirtualSpaceOptions(self, int virtualSpaceOptions)
def SetVirtualSpaceOptions(*args, **kwargs): """SetVirtualSpaceOptions(self, int virtualSpaceOptions)""" return _stc.StyledTextCtrl_SetVirtualSpaceOptions(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_SetVisiblePolicy(*args, **kwargs)
def SetWhitespaceBackground(
*args, **kwargs)
SetWhitespaceBackground(self, bool useSetting, Colour back)
Set the background colour of all whitespace and whether to use this setting.
def SetWhitespaceBackground(*args, **kwargs): """ SetWhitespaceBackground(self, bool useSetting, Colour back) Set the background colour of all whitespace and whether to use this setting. """ return _stc.StyledTextCtrl_SetWhitespaceBackground(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_SetWhitespaceChars(*args, **kwargs)
def SetWhitespaceForeground(
*args, **kwargs)
SetWhitespaceForeground(self, bool useSetting, Colour fore)
Set the foreground colour of all whitespace and whether to use this setting.
def SetWhitespaceForeground(*args, **kwargs): """ SetWhitespaceForeground(self, bool useSetting, Colour fore) Set the foreground colour of all whitespace and whether to use this setting. """ return _stc.StyledTextCtrl_SetWhitespaceForeground(*args, **kwargs)
def SetWhitespaceSize(
*args, **kwargs)
SetWhitespaceSize(self, int size)
Set the size of the dots used to mark space characters.
def SetWhitespaceSize(*args, **kwargs): """ SetWhitespaceSize(self, int size) Set the size of the dots used to mark space characters. """ return _stc.StyledTextCtrl_SetWhitespaceSize(*args, **kwargs)
def SetWindowStyle(
*args, **kwargs)
SetWindowStyleFlag(self, long style)
Sets the style of the window. Please note that some styles cannot be changed after the window creation and that Refresh() might need to be called after changing the others for the change to take place immediately.
def SetWindowStyleFlag(*args, **kwargs): """ SetWindowStyleFlag(self, long style) Sets the style of the window. Please note that some styles cannot be changed after the window creation and that Refresh() might need to be called after changing the others for the change to take place immediately. """ return _core_.Window_SetWindowStyleFlag(*args, **kwargs)
def SetWindowStyleFlag(
*args, **kwargs)
SetWindowStyleFlag(self, long style)
Sets the style of the window. Please note that some styles cannot be changed after the window creation and that Refresh() might need to be called after changing the others for the change to take place immediately.
def SetWindowStyleFlag(*args, **kwargs): """ SetWindowStyleFlag(self, long style) Sets the style of the window. Please note that some styles cannot be changed after the window creation and that Refresh() might need to be called after changing the others for the change to take place immediately. """ return _core_.Window_SetWindowStyleFlag(*args, **kwargs)
def SetWindowVariant(
*args, **kwargs)
SetWindowVariant(self, int variant)
Sets the variant of the window/font size to use for this window, if the platform supports variants, for example, wxMac.
def SetWindowVariant(*args, **kwargs): """ SetWindowVariant(self, int variant) Sets the variant of the window/font size to use for this window, if the platform supports variants, for example, wxMac. """ return _core_.Window_SetWindowVariant(*args, **kwargs)
def SetWordChars(
*args, **kwargs)
SetWordChars(self, String characters)
Set the set of characters making up words for when moving or selecting by word. First sets defaults like SetCharsDefault.
def SetWordChars(*args, **kwargs): """ SetWordChars(self, String characters) Set the set of characters making up words for when moving or selecting by word. First sets defaults like SetCharsDefault. """ return _stc.StyledTextCtrl_SetWordChars(*args, **kwargs)
def SetWrapIndentMode(
*args, **kwargs)
SetWrapIndentMode(self, int mode)
Sets how wrapped sublines are placed. Default is fixed.
def SetWrapIndentMode(*args, **kwargs): """ SetWrapIndentMode(self, int mode) Sets how wrapped sublines are placed. Default is fixed. """ return _stc.StyledTextCtrl_SetWrapIndentMode(*args, **kwargs)
def SetWrapMode(
*args, **kwargs)
SetWrapMode(self, int mode)
Sets whether text is word wrapped.
def SetWrapMode(*args, **kwargs): """ SetWrapMode(self, int mode) Sets whether text is word wrapped. """ return _stc.StyledTextCtrl_SetWrapMode(*args, **kwargs)
def SetWrapStartIndent(
*args, **kwargs)
SetWrapStartIndent(self, int indent)
Set the start indent for wrapped lines.
def SetWrapStartIndent(*args, **kwargs): """ SetWrapStartIndent(self, int indent) Set the start indent for wrapped lines. """ return _stc.StyledTextCtrl_SetWrapStartIndent(*args, **kwargs)
def SetWrapVisualFlags(
*args, **kwargs)
SetWrapVisualFlags(self, int wrapVisualFlags)
Set the display mode of visual flags for wrapped lines.
def SetWrapVisualFlags(*args, **kwargs): """ SetWrapVisualFlags(self, int wrapVisualFlags) Set the display mode of visual flags for wrapped lines. """ return _stc.StyledTextCtrl_SetWrapVisualFlags(*args, **kwargs)
def SetWrapVisualFlagsLocation(
*args, **kwargs)
SetWrapVisualFlagsLocation(self, int wrapVisualFlagsLocation)
Set the location of visual flags for wrapped lines.
def SetWrapVisualFlagsLocation(*args, **kwargs): """ SetWrapVisualFlagsLocation(self, int wrapVisualFlagsLocation) Set the location of visual flags for wrapped lines. """ return _stc.StyledTextCtrl_SetWrapVisualFlagsLocation(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_SetXCaretPolicy(*args, **kwargs)
def SetXOffset(
*args, **kwargs)
SetXOffset(self, int newOffset)
Get and Set the xOffset (ie, horizonal scroll position).
def SetXOffset(*args, **kwargs): """ SetXOffset(self, int newOffset) Get and Set the xOffset (ie, horizonal scroll position). """ return _stc.StyledTextCtrl_SetXOffset(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_SetYCaretPolicy(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_SetZoom(*args, **kwargs)
def ShouldInheritColours(
*args, **kwargs)
ShouldInheritColours(self) -> bool
Return true from here to allow the colours of this window to be changed by InheritAttributes, returning false forbids inheriting them from the parent window.
The base class version returns false, but this method is overridden in wxControl where it returns true.
def ShouldInheritColours(*args, **kwargs): """ ShouldInheritColours(self) -> bool Return true from here to allow the colours of this window to be changed by InheritAttributes, returning false forbids inheriting them from the parent window. The base class version returns false, but this method is overridden in wxControl where it returns true. """ return _core_.Window_ShouldInheritColours(*args, **kwargs)
def Show(
*args, **kwargs)
Show(self, bool show=True) -> bool
Shows or hides the window. You may need to call Raise for a top level window if you want to bring it to top, although this is not needed if Show is called immediately after the frame creation. Returns True if the window has been shown or hidden or False if nothing was done because it already was in the requested state.
def Show(*args, **kwargs): """ Show(self, bool show=True) -> bool Shows or hides the window. You may need to call Raise for a top level window if you want to bring it to top, although this is not needed if Show is called immediately after the frame creation. Returns True if the window has been shown or hidden or False if nothing was done because it already was in the requested state. """ return _core_.Window_Show(*args, **kwargs)
def ShowLines(
*args, **kwargs)
ShowLines(self, int lineStart, int lineEnd)
Make a range of lines visible.
def ShowLines(*args, **kwargs): """ ShowLines(self, int lineStart, int lineEnd) Make a range of lines visible. """ return _stc.StyledTextCtrl_ShowLines(*args, **kwargs)
def ShowPosition(
*args, **kwargs)
ShowPosition(self, long pos)
def ShowPosition(*args, **kwargs): """ShowPosition(self, long pos)""" return _core_.TextAreaBase_ShowPosition(*args, **kwargs)
def ShowWithEffect(
*args, **kwargs)
ShowWithEffect(self, int effect, unsigned int timeout=0) -> bool
Show the window with a special effect, not implemented on most platforms (where it is the same as Show())
Timeout specifies how long the animation should take, in ms, the default value of 0 means to use the default (system-dependent) value.
def ShowWithEffect(*args, **kwargs): """ ShowWithEffect(self, int effect, unsigned int timeout=0) -> bool Show the window with a special effect, not implemented on most platforms (where it is the same as Show()) Timeout specifies how long the animation should take, in ms, the default value of 0 means to use the default (system-dependent) value. """ return _core_.Window_ShowWithEffect(*args, **kwargs)
def StartRecord(
*args, **kwargs)
StartRecord(self)
Start notifying the container of all key presses and commands.
def StartRecord(*args, **kwargs): """ StartRecord(self) Start notifying the container of all key presses and commands. """ return _stc.StyledTextCtrl_StartRecord(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_StartStyling(*args, **kwargs)
def StopRecord(
*args, **kwargs)
StopRecord(self)
Stop notifying the container of all key presses and commands.
def StopRecord(*args, **kwargs): """ StopRecord(self) Stop notifying the container of all key presses and commands. """ return _stc.StyledTextCtrl_StopRecord(*args, **kwargs)
def StutteredPageDown(
*args, **kwargs)
StutteredPageDown(self)
Move caret to bottom of page, or one page down if already at bottom of page.
def StutteredPageDown(*args, **kwargs): """ StutteredPageDown(self) Move caret to bottom of page, or one page down if already at bottom of page. """ return _stc.StyledTextCtrl_StutteredPageDown(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_StutteredPageDownExtend(*args, **kwargs)
def StutteredPageUp(
*args, **kwargs)
StutteredPageUp(self)
Move caret to top of page, or one page up if already at top of page.
def StutteredPageUp(*args, **kwargs): """ StutteredPageUp(self) Move caret to top of page, or one page up if already at top of page. """ return _stc.StyledTextCtrl_StutteredPageUp(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_StutteredPageUpExtend(*args, **kwargs)
def StyleClearAll(
*args, **kwargs)
StyleClearAll(self)
Clear all the styles and make equivalent to the global default style.
def StyleClearAll(*args, **kwargs): """ StyleClearAll(self) Clear all the styles and make equivalent to the global default style. """ return _stc.StyledTextCtrl_StyleClearAll(*args, **kwargs)
def StyleGetBackground(
*args, **kwargs)
StyleGetBackground(self, int style) -> Colour
Get the background colour of a style.
def StyleGetBackground(*args, **kwargs): """ StyleGetBackground(self, int style) -> Colour Get the background colour of a style. """ return _stc.StyledTextCtrl_StyleGetBackground(*args, **kwargs)
def StyleGetBold(
*args, **kwargs)
StyleGetBold(self, int style) -> bool
Get is a style bold or not.
def StyleGetBold(*args, **kwargs): """ StyleGetBold(self, int style) -> bool Get is a style bold or not. """ return _stc.StyledTextCtrl_StyleGetBold(*args, **kwargs)
def StyleGetCase(
*args, **kwargs)
StyleGetCase(self, int style) -> int
Get is a style mixed case, or to force upper or lower case.
def StyleGetCase(*args, **kwargs): """ StyleGetCase(self, int style) -> int Get is a style mixed case, or to force upper or lower case. """ return _stc.StyledTextCtrl_StyleGetCase(*args, **kwargs)
def StyleGetChangeable(
*args, **kwargs)
StyleGetChangeable(self, int style) -> bool
Get is a style changeable or not (read only). Experimental feature, currently buggy.
def StyleGetChangeable(*args, **kwargs): """ StyleGetChangeable(self, int style) -> bool Get is a style changeable or not (read only). Experimental feature, currently buggy. """ return _stc.StyledTextCtrl_StyleGetChangeable(*args, **kwargs)
def StyleGetCharacterSet(
*args, **kwargs)
StyleGetCharacterSet(self, int style) -> int
Get the character set of the font in a style.
def StyleGetCharacterSet(*args, **kwargs): """ StyleGetCharacterSet(self, int style) -> int Get the character set of the font in a style. """ return _stc.StyledTextCtrl_StyleGetCharacterSet(*args, **kwargs)
def StyleGetEOLFilled(
*args, **kwargs)
StyleGetEOLFilled(self, int style) -> bool
Get is a style to have its end of line filled or not.
def StyleGetEOLFilled(*args, **kwargs): """ StyleGetEOLFilled(self, int style) -> bool Get is a style to have its end of line filled or not. """ return _stc.StyledTextCtrl_StyleGetEOLFilled(*args, **kwargs)
def StyleGetFaceName(
*args, **kwargs)
StyleGetFaceName(self, int style) -> String
Get the font facename of a style
def StyleGetFaceName(*args, **kwargs): """ StyleGetFaceName(self, int style) -> String Get the font facename of a style """ return _stc.StyledTextCtrl_StyleGetFaceName(*args, **kwargs)
def StyleGetFont(
*args, **kwargs)
StyleGetFont(self, int style) -> Font
def StyleGetFont(*args, **kwargs): """StyleGetFont(self, int style) -> Font""" return _stc.StyledTextCtrl_StyleGetFont(*args, **kwargs)
def StyleGetForeground(
*args, **kwargs)
StyleGetForeground(self, int style) -> Colour
Get the foreground colour of a style.
def StyleGetForeground(*args, **kwargs): """ StyleGetForeground(self, int style) -> Colour Get the foreground colour of a style. """ return _stc.StyledTextCtrl_StyleGetForeground(*args, **kwargs)
def StyleGetHotSpot(
*args, **kwargs)
StyleGetHotSpot(self, int style) -> bool
Get is a style a hotspot or not.
def StyleGetHotSpot(*args, **kwargs): """ StyleGetHotSpot(self, int style) -> bool Get is a style a hotspot or not. """ return _stc.StyledTextCtrl_StyleGetHotSpot(*args, **kwargs)
def StyleGetItalic(
*args, **kwargs)
StyleGetItalic(self, int style) -> bool
Get is a style italic or not.
def StyleGetItalic(*args, **kwargs): """ StyleGetItalic(self, int style) -> bool Get is a style italic or not. """ return _stc.StyledTextCtrl_StyleGetItalic(*args, **kwargs)
def StyleGetSize(
*args, **kwargs)
StyleGetSize(self, int style) -> int
Get the size of characters of a style.
def StyleGetSize(*args, **kwargs): """ StyleGetSize(self, int style) -> int Get the size of characters of a style. """ return _stc.StyledTextCtrl_StyleGetSize(*args, **kwargs)
def StyleGetSizeFractional(
*args, **kwargs)
StyleGetSizeFractional(self, int style) -> int
def StyleGetSizeFractional(*args, **kwargs): """StyleGetSizeFractional(self, int style) -> int""" return _stc.StyledTextCtrl_StyleGetSizeFractional(*args, **kwargs)
def StyleGetUnderline(
*args, **kwargs)
StyleGetUnderline(self, int style) -> bool
Get is a style underlined or not.
def StyleGetUnderline(*args, **kwargs): """ StyleGetUnderline(self, int style) -> bool Get is a style underlined or not. """ return _stc.StyledTextCtrl_StyleGetUnderline(*args, **kwargs)
def StyleGetVisible(
*args, **kwargs)
StyleGetVisible(self, int style) -> bool
Get is a style visible or not.
def StyleGetVisible(*args, **kwargs): """ StyleGetVisible(self, int style) -> bool Get is a style visible or not. """ return _stc.StyledTextCtrl_StyleGetVisible(*args, **kwargs)
def StyleGetWeight(
*args, **kwargs)
StyleGetWeight(self, int style) -> int
def StyleGetWeight(*args, **kwargs): """StyleGetWeight(self, int style) -> int""" return _stc.StyledTextCtrl_StyleGetWeight(*args, **kwargs)
def StyleResetDefault(
*args, **kwargs)
StyleResetDefault(self)
Reset the default style to its state at startup
def StyleResetDefault(*args, **kwargs): """ StyleResetDefault(self) Reset the default style to its state at startup """ return _stc.StyledTextCtrl_StyleResetDefault(*args, **kwargs)
def StyleSetBackground(
*args, **kwargs)
StyleSetBackground(self, int style, Colour back)
Set the background colour of a style.
def StyleSetBackground(*args, **kwargs): """ StyleSetBackground(self, int style, Colour back) Set the background colour of a style. """ return _stc.StyledTextCtrl_StyleSetBackground(*args, **kwargs)
def StyleSetBold(
*args, **kwargs)
StyleSetBold(self, int style, bool bold)
Set a style to be bold or not.
def StyleSetBold(*args, **kwargs): """ StyleSetBold(self, int style, bool bold) Set a style to be bold or not. """ return _stc.StyledTextCtrl_StyleSetBold(*args, **kwargs)
def StyleSetCase(
*args, **kwargs)
StyleSetCase(self, int style, int caseForce)
Set a style to be mixed case, or to force upper or lower case.
def StyleSetCase(*args, **kwargs): """ StyleSetCase(self, int style, int caseForce) Set a style to be mixed case, or to force upper or lower case. """ return _stc.StyledTextCtrl_StyleSetCase(*args, **kwargs)
def StyleSetChangeable(
*args, **kwargs)
StyleSetChangeable(self, int style, bool changeable)
Set a style to be changeable or not (read only). Experimental feature, currently buggy.
def StyleSetChangeable(*args, **kwargs): """ StyleSetChangeable(self, int style, bool changeable) Set a style to be changeable or not (read only). Experimental feature, currently buggy. """ return _stc.StyledTextCtrl_StyleSetChangeable(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_StyleSetCharacterSet(*args, **kwargs)
def StyleSetEOLFilled(
*args, **kwargs)
StyleSetEOLFilled(self, int style, bool filled)
Set a style to have its end of line filled or not.
def StyleSetEOLFilled(*args, **kwargs): """ StyleSetEOLFilled(self, int style, bool filled) Set a style to have its end of line filled or not. """ return _stc.StyledTextCtrl_StyleSetEOLFilled(*args, **kwargs)
def StyleSetFaceName(
*args, **kwargs)
StyleSetFaceName(self, int style, String fontName)
Set the font of a style.
def StyleSetFaceName(*args, **kwargs): """ StyleSetFaceName(self, int style, String fontName) Set the font of a style. """ return _stc.StyledTextCtrl_StyleSetFaceName(*args, **kwargs)
def 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.
def 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`. """ return _stc.StyledTextCtrl_StyleSetFont(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_StyleSetFontAttr(*args, **kwargs)
def StyleSetFontEncoding(
*args, **kwargs)
StyleSetFontEncoding(self, int style, int encoding)
Set the font encoding to be used by a style.
def StyleSetFontEncoding(*args, **kwargs): """ StyleSetFontEncoding(self, int style, int encoding) Set the font encoding to be used by a style. """ return _stc.StyledTextCtrl_StyleSetFontEncoding(*args, **kwargs)
def StyleSetForeground(
*args, **kwargs)
StyleSetForeground(self, int style, Colour fore)
Set the foreground colour of a style.
def StyleSetForeground(*args, **kwargs): """ StyleSetForeground(self, int style, Colour fore) Set the foreground colour of a style. """ return _stc.StyledTextCtrl_StyleSetForeground(*args, **kwargs)
def StyleSetHotSpot(
*args, **kwargs)
StyleSetHotSpot(self, int style, bool hotspot)
Set a style to be a hotspot or not.
def StyleSetHotSpot(*args, **kwargs): """ StyleSetHotSpot(self, int style, bool hotspot) Set a style to be a hotspot or not. """ return _stc.StyledTextCtrl_StyleSetHotSpot(*args, **kwargs)
def StyleSetItalic(
*args, **kwargs)
StyleSetItalic(self, int style, bool italic)
Set a style to be italic or not.
def StyleSetItalic(*args, **kwargs): """ StyleSetItalic(self, int style, bool italic) Set a style to be italic or not. """ return _stc.StyledTextCtrl_StyleSetItalic(*args, **kwargs)
def StyleSetSize(
*args, **kwargs)
StyleSetSize(self, int style, int sizePoints)
Set the size of characters of a style.
def StyleSetSize(*args, **kwargs): """ StyleSetSize(self, int style, int sizePoints) Set the size of characters of a style. """ return _stc.StyledTextCtrl_StyleSetSize(*args, **kwargs)
def StyleSetSizeFractional(
*args, **kwargs)
StyleSetSizeFractional(self, int style, int caseForce)
def StyleSetSizeFractional(*args, **kwargs): """StyleSetSizeFractional(self, int style, int caseForce)""" return _stc.StyledTextCtrl_StyleSetSizeFractional(*args, **kwargs)
def 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
def 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 """ return _stc.StyledTextCtrl_StyleSetSpec(*args, **kwargs)
def StyleSetUnderline(
*args, **kwargs)
StyleSetUnderline(self, int style, bool underline)
Set a style to be underlined or not.
def StyleSetUnderline(*args, **kwargs): """ StyleSetUnderline(self, int style, bool underline) Set a style to be underlined or not. """ return _stc.StyledTextCtrl_StyleSetUnderline(*args, **kwargs)
def StyleSetVisible(
*args, **kwargs)
StyleSetVisible(self, int style, bool visible)
Set a style to be visible or not.
def StyleSetVisible(*args, **kwargs): """ StyleSetVisible(self, int style, bool visible) Set a style to be visible or not. """ return _stc.StyledTextCtrl_StyleSetVisible(*args, **kwargs)
def StyleSetWeight(
*args, **kwargs)
StyleSetWeight(self, int style, int weight)
def StyleSetWeight(*args, **kwargs): """StyleSetWeight(self, int style, int weight)""" return _stc.StyledTextCtrl_StyleSetWeight(*args, **kwargs)
def SwapMainAnchorCaret(
*args, **kwargs)
SwapMainAnchorCaret(self)
Swap that caret and anchor of the main selection.
def SwapMainAnchorCaret(*args, **kwargs): """ SwapMainAnchorCaret(self) Swap that caret and anchor of the main selection. """ return _stc.StyledTextCtrl_SwapMainAnchorCaret(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_Tab(*args, **kwargs)
def TargetFromSelection(
*args, **kwargs)
TargetFromSelection(self)
Make the target range start and end be the same as the selection range start and end.
def TargetFromSelection(*args, **kwargs): """ TargetFromSelection(self) Make the target range start and end be the same as the selection range start and end. """ return _stc.StyledTextCtrl_TargetFromSelection(*args, **kwargs)
def TextHeight(
*args, **kwargs)
TextHeight(self, int line) -> int
Retrieve the height of a particular line of text in pixels.
def TextHeight(*args, **kwargs): """ TextHeight(self, int line) -> int Retrieve the height of a particular line of text in pixels. """ return _stc.StyledTextCtrl_TextHeight(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_TextWidth(*args, **kwargs)
def Thaw(
*args, **kwargs)
Thaw(self)
Reenables window updating after a previous call to Freeze. Calls to Freeze/Thaw may be nested, so Thaw must be called the same number of times that Freeze was before the window will be updated.
def Thaw(*args, **kwargs): """ Thaw(self) Reenables window updating after a previous call to Freeze. Calls to Freeze/Thaw may be nested, so Thaw must be called the same number of times that Freeze was before the window will be updated. """ return _core_.Window_Thaw(*args, **kwargs)
def ToggleCaretSticky(
*args, **kwargs)
ToggleCaretSticky(self)
Switch between sticky and non-sticky: meant to be bound to a key.
def ToggleCaretSticky(*args, **kwargs): """ ToggleCaretSticky(self) Switch between sticky and non-sticky: meant to be bound to a key. """ return _stc.StyledTextCtrl_ToggleCaretSticky(*args, **kwargs)
def ToggleFold(
*args, **kwargs)
ToggleFold(self, int line)
Switch a header line between expanded and contracted.
def ToggleFold(*args, **kwargs): """ ToggleFold(self, int line) Switch a header line between expanded and contracted. """ return _stc.StyledTextCtrl_ToggleFold(*args, **kwargs)
def ToggleWindowStyle(
*args, **kwargs)
ToggleWindowStyle(self, int flag) -> bool
Turn the flag on if it had been turned off before and vice versa, returns True if the flag is turned on by this function call.
def ToggleWindowStyle(*args, **kwargs): """ ToggleWindowStyle(self, int flag) -> bool Turn the flag on if it had been turned off before and vice versa, returns True if the flag is turned on by this function call. """ return _core_.Window_ToggleWindowStyle(*args, **kwargs)
def TransferDataFromWindow(
*args, **kwargs)
TransferDataFromWindow(self) -> bool
Transfers values from child controls to data areas specified by their validators. Returns false if a transfer failed. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will also call TransferDataFromWindow() of all child windows.
def TransferDataFromWindow(*args, **kwargs): """ TransferDataFromWindow(self) -> bool Transfers values from child controls to data areas specified by their validators. Returns false if a transfer failed. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will also call TransferDataFromWindow() of all child windows. """ return _core_.Window_TransferDataFromWindow(*args, **kwargs)
def TransferDataToWindow(
*args, **kwargs)
TransferDataToWindow(self) -> bool
Transfers values to child controls from data areas specified by their validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will also call TransferDataToWindow() of all child windows.
def TransferDataToWindow(*args, **kwargs): """ TransferDataToWindow(self) -> bool Transfers values to child controls from data areas specified by their validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will also call TransferDataToWindow() of all child windows. """ return _core_.Window_TransferDataToWindow(*args, **kwargs)
def Unbind(
self, event, source=None, id=-1, id2=-1, handler=None)
Disconnects the event handler binding for event from self. Returns True if successful.
def Unbind(self, event, source=None, id=wx.ID_ANY, id2=wx.ID_ANY, handler=None): """ Disconnects the event handler binding for event from self. Returns True if successful. """ if source is not None: id = source.GetId() return event.Unbind(self, id, id2, handler)
def Undo(
*args, **kwargs)
Undo(self)
Undoes the last edit in the text field
def Undo(*args, **kwargs): """ Undo(self) Undoes the last edit in the text field """ return _core_.TextEntryBase_Undo(*args, **kwargs)
def Unlink(
*args, **kwargs)
Unlink(self)
def Unlink(*args, **kwargs): """Unlink(self)""" return _core_.EvtHandler_Unlink(*args, **kwargs)
def UnregisterHotKey(
*args, **kwargs)
UnregisterHotKey(self, int hotkeyId) -> bool
Unregisters a system wide hotkey.
def UnregisterHotKey(*args, **kwargs): """ UnregisterHotKey(self, int hotkeyId) -> bool Unregisters a system wide hotkey. """ return _core_.Window_UnregisterHotKey(*args, **kwargs)
def UnsetToolTip(
*args, **kwargs)
UnsetToolTip(self)
def UnsetToolTip(*args, **kwargs): """UnsetToolTip(self)""" return _core_.Window_UnsetToolTip(*args, **kwargs)
def Update(
*args, **kwargs)
Update(self)
Calling this method immediately repaints the invalidated area of the
window instead of waiting for the EVT_PAINT event to happen, (normally
this would usually only happen when the flow of control returns to the
event loop.) Notice that this function doesn't refresh the window and
does nothing if the window has been already repainted. Use Refresh
first if you want to immediately redraw the window (or some portion of
it) unconditionally.
def Update(*args, **kwargs): """ Update(self) Calling this method immediately repaints the invalidated area of the window instead of waiting for the EVT_PAINT event to happen, (normally this would usually only happen when the flow of control returns to the event loop.) Notice that this function doesn't refresh the window and does nothing if the window has been already repainted. Use `Refresh` first if you want to immediately redraw the window (or some portion of it) unconditionally. """ return _core_.Window_Update(*args, **kwargs)
def UpdateWindowUI(
*args, **kwargs)
UpdateWindowUI(self, long flags=UPDATE_UI_NONE)
This function sends EVT_UPDATE_UI events to the window. The particular
implementation depends on the window; for example a wx.ToolBar will
send an update UI event for each toolbar button, and a wx.Frame will
send an update UI event for each menubar menu item. You can call this
function from your application to ensure that your UI is up-to-date at
a particular point in time (as far as your EVT_UPDATE_UI handlers are
concerned). This may be necessary if you have called
wx.UpdateUIEvent.SetMode or wx.UpdateUIEvent.SetUpdateInterval to
limit the overhead that wxWindows incurs by sending update UI events
in idle time.
def UpdateWindowUI(*args, **kwargs): """ UpdateWindowUI(self, long flags=UPDATE_UI_NONE) This function sends EVT_UPDATE_UI events to the window. The particular implementation depends on the window; for example a wx.ToolBar will send an update UI event for each toolbar button, and a wx.Frame will send an update UI event for each menubar menu item. You can call this function from your application to ensure that your UI is up-to-date at a particular point in time (as far as your EVT_UPDATE_UI handlers are concerned). This may be necessary if you have called `wx.UpdateUIEvent.SetMode` or `wx.UpdateUIEvent.SetUpdateInterval` to limit the overhead that wxWindows incurs by sending update UI events in idle time. """ return _core_.Window_UpdateWindowUI(*args, **kwargs)
def UpperCase(
*args, **kwargs)
UpperCase(self)
Transform the selection to upper case.
def UpperCase(*args, **kwargs): """ UpperCase(self) Transform the selection to upper case. """ return _stc.StyledTextCtrl_UpperCase(*args, **kwargs)
def UseBgCol(
*args, **kwargs)
UseBgCol(self) -> bool
def UseBgCol(*args, **kwargs): """UseBgCol(self) -> bool""" return _core_.Window_UseBgCol(*args, **kwargs)
def UsePopUp(
*args, **kwargs)
UsePopUp(self, bool allowPopUp)
Set whether a pop up menu is displayed automatically when the user presses the wrong mouse button.
def UsePopUp(*args, **kwargs): """ UsePopUp(self, bool allowPopUp) Set whether a pop up menu is displayed automatically when the user presses the wrong mouse button. """ return _stc.StyledTextCtrl_UsePopUp(*args, **kwargs)
def UserListShow(
*args, **kwargs)
UserListShow(self, int listType, String itemList)
Display a list of strings and send notification when user chooses one.
def UserListShow(*args, **kwargs): """ UserListShow(self, int listType, String itemList) Display a list of strings and send notification when user chooses one. """ return _stc.StyledTextCtrl_UserListShow(*args, **kwargs)
def VCHome(
*args, **kwargs)
VCHome(self)
Move caret to before first visible character on line. If already there move to first character on line.
def VCHome(*args, **kwargs): """ VCHome(self) Move caret to before first visible character on line. If already there move to first character on line. """ return _stc.StyledTextCtrl_VCHome(*args, **kwargs)
def VCHomeExtend(
*args, **kwargs)
VCHomeExtend(self)
Like VCHome but extending selection to new caret position.
def VCHomeExtend(*args, **kwargs): """ VCHomeExtend(self) Like VCHome but extending selection to new caret position. """ return _stc.StyledTextCtrl_VCHomeExtend(*args, **kwargs)
def 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.
def 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. """ return _stc.StyledTextCtrl_VCHomeRectExtend(*args, **kwargs)
def VCHomeWrap(
*args, **kwargs)
VCHomeWrap(self)
def VCHomeWrap(*args, **kwargs): """VCHomeWrap(self)""" return _stc.StyledTextCtrl_VCHomeWrap(*args, **kwargs)
def VCHomeWrapExtend(
*args, **kwargs)
VCHomeWrapExtend(self)
def VCHomeWrapExtend(*args, **kwargs): """VCHomeWrapExtend(self)""" return _stc.StyledTextCtrl_VCHomeWrapExtend(*args, **kwargs)
def Validate(
*args, **kwargs)
Validate(self) -> bool
Validates the current values of the child controls using their validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will also call Validate() of all child windows. Returns false if any of the validations failed.
def Validate(*args, **kwargs): """ Validate(self) -> bool Validates the current values of the child controls using their validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will also call Validate() of all child windows. Returns false if any of the validations failed. """ return _core_.Window_Validate(*args, **kwargs)
def VerticalCentreCaret(
*args, **kwargs)
VerticalCentreCaret(self)
def VerticalCentreCaret(*args, **kwargs): """VerticalCentreCaret(self)""" return _stc.StyledTextCtrl_VerticalCentreCaret(*args, **kwargs)
def VisibleFromDocLine(
*args, **kwargs)
VisibleFromDocLine(self, int line) -> int
Find the display line of a document line taking hidden lines into account.
def VisibleFromDocLine(*args, **kwargs): """ VisibleFromDocLine(self, int line) -> int Find the display line of a document line taking hidden lines into account. """ return _stc.StyledTextCtrl_VisibleFromDocLine(*args, **kwargs)
def WarpPointer(
*args, **kwargs)
WarpPointer(self, int x, int y)
Moves the pointer to the given position on the window.
NOTE: This function is not supported under Mac because Apple Human Interface Guidelines forbid moving the mouse cursor programmatically.
def WarpPointer(*args, **kwargs): """ WarpPointer(self, int x, int y) Moves the pointer to the given position on the window. NOTE: This function is not supported under Mac because Apple Human Interface Guidelines forbid moving the mouse cursor programmatically. """ return _core_.Window_WarpPointer(*args, **kwargs)
def WindowToClientSize(
*args, **kwargs)
WindowToClientSize(self, Size size) -> Size
Converts window size size to corresponding client area size. In
other words, the returned value is what GetClientSize would return
if this window had given window size. Components with
wxDefaultCoord (-1) value are left unchanged.
Note that the conversion is not always exact, it assumes that non-client area doesn't change and so doesn't take into account things like menu bar (un)wrapping or (dis)appearance of the scrollbars.
def WindowToClientSize(*args, **kwargs): """ WindowToClientSize(self, Size size) -> Size Converts window size ``size`` to corresponding client area size. In other words, the returned value is what `GetClientSize` would return if this window had given window size. Components with ``wxDefaultCoord`` (-1) value are left unchanged. Note that the conversion is not always exact, it assumes that non-client area doesn't change and so doesn't take into account things like menu bar (un)wrapping or (dis)appearance of the scrollbars. """ return _core_.Window_WindowToClientSize(*args, **kwargs)
def WordEndPosition(
*args, **kwargs)
WordEndPosition(self, int pos, bool onlyWordCharacters) -> int
Get position of end of word.
def WordEndPosition(*args, **kwargs): """ WordEndPosition(self, int pos, bool onlyWordCharacters) -> int Get position of end of word. """ return _stc.StyledTextCtrl_WordEndPosition(*args, **kwargs)
def WordLeft(
*args, **kwargs)
WordLeft(self)
Move caret left one word.
def WordLeft(*args, **kwargs): """ WordLeft(self) Move caret left one word. """ return _stc.StyledTextCtrl_WordLeft(*args, **kwargs)
def WordLeftEnd(
*args, **kwargs)
WordLeftEnd(self)
Move caret left one word, position cursor at end of word.
def WordLeftEnd(*args, **kwargs): """ WordLeftEnd(self) Move caret left one word, position cursor at end of word. """ return _stc.StyledTextCtrl_WordLeftEnd(*args, **kwargs)
def WordLeftEndExtend(
*args, **kwargs)
WordLeftEndExtend(self)
Move caret left one word, position cursor at end of word, extending selection to new caret position.
def WordLeftEndExtend(*args, **kwargs): """ WordLeftEndExtend(self) Move caret left one word, position cursor at end of word, extending selection to new caret position. """ return _stc.StyledTextCtrl_WordLeftEndExtend(*args, **kwargs)
def WordLeftExtend(
*args, **kwargs)
WordLeftExtend(self)
Move caret left one word extending selection to new caret position.
def WordLeftExtend(*args, **kwargs): """ WordLeftExtend(self) Move caret left one word extending selection to new caret position. """ return _stc.StyledTextCtrl_WordLeftExtend(*args, **kwargs)
def WordPartLeft(
*args, **kwargs)
WordPartLeft(self)
Move to the previous change in capitalisation.
def WordPartLeft(*args, **kwargs): """ WordPartLeft(self) Move to the previous change in capitalisation. """ return _stc.StyledTextCtrl_WordPartLeft(*args, **kwargs)
def WordPartLeftExtend(
*args, **kwargs)
WordPartLeftExtend(self)
Move to the previous change in capitalisation extending selection to new caret position.
def WordPartLeftExtend(*args, **kwargs): """ WordPartLeftExtend(self) Move to the previous change in capitalisation extending selection to new caret position. """ return _stc.StyledTextCtrl_WordPartLeftExtend(*args, **kwargs)
def WordPartRight(
*args, **kwargs)
WordPartRight(self)
Move to the change next in capitalisation.
def WordPartRight(*args, **kwargs): """ WordPartRight(self) Move to the change next in capitalisation. """ return _stc.StyledTextCtrl_WordPartRight(*args, **kwargs)
def WordPartRightExtend(
*args, **kwargs)
WordPartRightExtend(self)
Move to the next change in capitalisation extending selection to new caret position.
def WordPartRightExtend(*args, **kwargs): """ WordPartRightExtend(self) Move to the next change in capitalisation extending selection to new caret position. """ return _stc.StyledTextCtrl_WordPartRightExtend(*args, **kwargs)
def WordRight(
*args, **kwargs)
WordRight(self)
Move caret right one word.
def WordRight(*args, **kwargs): """ WordRight(self) Move caret right one word. """ return _stc.StyledTextCtrl_WordRight(*args, **kwargs)
def WordRightEnd(
*args, **kwargs)
WordRightEnd(self)
Move caret right one word, position cursor at end of word.
def WordRightEnd(*args, **kwargs): """ WordRightEnd(self) Move caret right one word, position cursor at end of word. """ return _stc.StyledTextCtrl_WordRightEnd(*args, **kwargs)
def WordRightEndExtend(
*args, **kwargs)
WordRightEndExtend(self)
Move caret right one word, position cursor at end of word, extending selection to new caret position.
def WordRightEndExtend(*args, **kwargs): """ WordRightEndExtend(self) Move caret right one word, position cursor at end of word, extending selection to new caret position. """ return _stc.StyledTextCtrl_WordRightEndExtend(*args, **kwargs)
def WordRightExtend(
*args, **kwargs)
WordRightExtend(self)
Move caret right one word extending selection to new caret position.
def WordRightExtend(*args, **kwargs): """ WordRightExtend(self) Move caret right one word extending selection to new caret position. """ return _stc.StyledTextCtrl_WordRightExtend(*args, **kwargs)
def WordStartPosition(
*args, **kwargs)
WordStartPosition(self, int pos, bool onlyWordCharacters) -> int
Get position of start of word.
def WordStartPosition(*args, **kwargs): """ WordStartPosition(self, int pos, bool onlyWordCharacters) -> int Get position of start of word. """ return _stc.StyledTextCtrl_WordStartPosition(*args, **kwargs)
def WrapCount(
*args, **kwargs)
WrapCount(self, int line) -> int
The number of display lines needed to wrap a document line
def WrapCount(*args, **kwargs): """ WrapCount(self, int line) -> int The number of display lines needed to wrap a document line """ return _stc.StyledTextCtrl_WrapCount(*args, **kwargs)
def WriteText(
*args, **kwargs)
WriteText(self, String text)
Insert text at the current insertion point in the text field, replacing any text that is currently selected.
def WriteText(*args, **kwargs): """ WriteText(self, String text) Insert text at the current insertion point in the text field, replacing any text that is currently selected. """ return _core_.TextEntryBase_WriteText(*args, **kwargs)
def XYToPosition(
*args, **kwargs)
XYToPosition(self, long x, long y) -> long
def XYToPosition(*args, **kwargs): """XYToPosition(self, long x, long y) -> long""" return _core_.TextAreaBase_XYToPosition(*args, **kwargs)
def ZoomIn(
*args, **kwargs)
ZoomIn(self)
Magnify the displayed text by increasing the sizes by 1 point.
def ZoomIn(*args, **kwargs): """ ZoomIn(self) Magnify the displayed text by increasing the sizes by 1 point. """ return _stc.StyledTextCtrl_ZoomIn(*args, **kwargs)
def ZoomOut(
*args, **kwargs)
ZoomOut(self)
Make the displayed text smaller by decreasing the sizes by 1 point.
def ZoomOut(*args, **kwargs): """ ZoomOut(self) Make the displayed text smaller by decreasing the sizes by 1 point. """ return _stc.StyledTextCtrl_ZoomOut(*args, **kwargs)
Module variables
var demoText
var faces
var overview
var wxID_STYLEDTEXTCTRLPANEL
var wxID_STYLEDTEXTCTRLPANELSTYLEDTEXTCTRL1