wxPython/wx/py/wxd/stc_.py

   1 """StyledTextCtrl decorator class module.
   2 """
   3
   4 __author__ = "Patrick K. O'Brien <pobrien@orbtech.com>"
   5 __cvsid__ = "$Id$"
   6 __revision__ = "$Revision$"[11:-2]
   7
   8
   9 # These are not the real wxPython classes. These are Python versions
  10 # for documentation purposes. They are also used to apply docstrings
  11 # to the real wxPython classes, which are SWIG-generated wrappers for
  12 # C-language classes.
  13
  14
  15 from Controls import Control
  16 import Parameters as wx
  17
  18
  19 class StyledTextCtrl(Control):
  20     """StyledTextCtrl class."""
  21
  22     def __init__(self, parent, id, pos=wx.DefaultPosition,
  23                  size=wx.DefaultSize, style=0, name=wx.PySTCNameStr):
  24         """Create a StyledTextCtrl instance."""
  25         pass
  26
  27     def AddRefDocument(self, docPointer):
  28         """Extend life of document."""
  29         pass
  30
  31     def AddStyledText(self, data):
  32         """Add array of cells to document."""
  33         pass
  34
  35     def AddText(self, text):
  36         """Add text to the document."""
  37         pass
  38
  39     def AutoCompActive(self):
  40         """Is there an auto-completion list visible?"""
  41         pass
  42
  43     def AutoCompCancel(self):
  44         """Remove the auto-completion list from the screen."""
  45         pass
  46
  47     def AutoCompComplete(self):
  48         """User has selected an item so remove the list and insert the
  49         selection."""
  50         pass
  51
  52     def AutoCompGetAutoHide(self):
  53         """Return whether or not autocompletion is hidden
  54         automatically when nothing matches."""
  55         pass
  56
  57     def AutoCompGetCancelAtStart(self):
  58         """Return whether auto-completion cancelled by backspacing
  59         before start."""
  60         pass
  61
  62     def AutoCompGetChooseSingle(self):
  63         """Return whether a single item auto-completion list
  64         automatically choose the item."""
  65         pass
  66
  67     def AutoCompGetDropRestOfWord(self):
  68         """Return whether or not autocompletion deletes any word
  69         characters after the inserted text upon completion."""
  70         pass
  71
  72     def AutoCompGetIgnoreCase(self):
  73         """Return state of ignore case flag."""
  74         pass
  75
  76     def AutoCompGetSeparator(self):
  77         """Return the auto-completion list separator character."""
  78         pass
  79
  80     def AutoCompPosStart(self):
  81         """Return the position of the caret when the auto-completion
  82         list was displayed."""
  83         pass
  84
  85     def AutoCompSelect(self, text):
  86         """Select the item in the auto-completion list that starts
  87         with a string."""
  88         pass
  89
  90     def AutoCompSetAutoHide(self, autoHide):
  91         """Set whether or not autocompletion is hidden automatically
  92         when nothing matches."""
  93         pass
  94
  95     def AutoCompSetCancelAtStart(self, cancel):
  96         """Should the auto-completion list be cancelled if the user
  97         backspaces to a position before where the box was created."""
  98         pass
  99
 100     def AutoCompSetChooseSingle(self, chooseSingle):
 101         """Should a single item auto-completion list automatically
 102         choose the item."""
 103         pass
 104
 105     def AutoCompSetDropRestOfWord(self, dropRestOfWord):
 106         """Set whether or not autocompletion deletes any word
 107         characters after the inserted text upon completion."""
 108         pass
 109
 110     def AutoCompSetFillUps(self, characterSet):
 111         """Define a set of characters that when typed will cause the
 112         autocompletion to choose the selected item."""
 113         pass
 114
 115     def AutoCompSetIgnoreCase(self, ignoreCase):
 116         """Set whether case is significant when performing
 117         auto-completion searches."""
 118         pass
 119
 120     def AutoCompSetSeparator(self, separatorCharacter):
 121         """Change the separator character in the string setting up an
 122         auto-completion list.  Default is space but can be changed if
 123         items contain space."""
 124         pass
 125
 126     def AutoCompShow(self, lenEntered, itemList):
 127         """Display a auto-completion list.
 128
 129         The lenEntered parameter indicates how many characters before
 130         the caret should be used to provide context."""
 131         pass
 132
 133     def AutoCompStops(self, characterSet):
 134         """Define a set of character that when typed cancel the
 135         auto-completion list."""
 136         pass
 137
 138     def BeginUndoAction(self):
 139         """Start a sequence of actions that is undone and redone as a
 140         unit.  May be nested."""
 141         pass
 142
 143     def BraceBadLight(self, pos):
 144         """Highlight the character at a position indicating there is
 145         no matching brace."""
 146         pass
 147
 148     def BraceHighlight(self, pos1, pos2):
 149         """Highlight the characters at two positions."""
 150         pass
 151
 152     def BraceMatch(self, pos):
 153         """Find the position of a matching brace or INVALID_POSITION
 154         if no match."""
 155         pass
 156
 157     def CallTipActive(self):
 158         """Is there an active call tip?"""
 159         pass
 160
 161     def CallTipCancel(self):
 162         """Remove the call tip from the screen."""
 163         pass
 164
 165     def CallTipPosAtStart(self):
 166         """Return the position where the caret was before displaying
 167         the call tip."""
 168         pass
 169
 170     def CallTipSetBackground(self, back):
 171         """Set the background colour for the call tip."""
 172         pass
 173
 174     def CallTipSetHighlight(self, start, end):
 175         """Highlight a segment of the definition."""
 176         pass
 177
 178     def CallTipShow(self, pos, definition):
 179         """Show a call tip containing a definition near position pos."""
 180         pass
 181
 182     def CanPaste(self):
 183         """Will a paste succeed?"""
 184         pass
 185
 186     def CanRedo(self):
 187         """Are there any redoable actions in the undo history?"""
 188         pass
 189
 190     def CanUndo(self):
 191         """Are there any undoable actions in the undo history?"""
 192         pass
 193
 194     def Clear(self):
 195         """Clear the selection."""
 196         pass
 197
 198     def ClearAll(self):
 199         """Delete all text in the document."""
 200         pass
 201
 202     def ClearDocumentStyle(self):
 203         """Set all style bytes to 0, remove all folding information."""
 204         pass
 205
 206     def CmdKeyAssign(self, key, modifiers, cmd):
 207         """When key+modifier combination km is pressed perform msg."""
 208         pass
 209
 210     def CmdKeyClear(self, key, modifiers):
 211         """When key+modifier combination km do nothing."""
 212         pass
 213
 214     def CmdKeyClearAll(self):
 215         """Drop all key mappings."""
 216         pass
 217
 218     def CmdKeyExecute(self, cmd):
 219         """Perform one of the operations defined by the STC_CMD_*
 220         constants."""
 221         pass
 222
 223     def Colourise(self, start, end):
 224         """Colourise a segment of the document using the current
 225         lexing language."""
 226         pass
 227
 228     def ConvertEOLs(self, eolMode):
 229         """Convert all line endings in the document to one mode."""
 230         pass
 231
 232     def Copy(self):
 233         """Copy the selection to the clipboard."""
 234         pass
 235
 236     def CreateDocument(self):
 237         """Create a new document object.
 238
 239         Starts with reference count of 1 and not selected into editor."""
 240         pass
 241
 242     def Cut(self):
 243         """Cut the selection to the clipboard."""
 244         pass
 245
 246     def DelLineLeft(self):
 247         """Delete from the current position to the start of the line."""
 248         pass
 249
 250     def DelLineRight(self):
 251         """Delete from the current position to the end of the line."""
 252         pass
 253
 254     def DocLineFromVisible(self, lineDisplay):
 255         """Find the document line of a display line taking hidden
 256         lines into account."""
 257         pass
 258
 259     def EmptyUndoBuffer(self):
 260         """Delete the undo history."""
 261         pass
 262
 263     def EndUndoAction(self):
 264         """End a sequence of actions that is undone and redone as a
 265         unit."""
 266         pass
 267
 268     def EnsureCaretVisible(self):
 269         """Ensure the caret is visible."""
 270         pass
 271
 272     def EnsureVisible(self, line):
 273         """Ensure a particular line is visible by expanding any header
 274         line hiding it."""
 275         pass
 276
 277     def EnsureVisibleEnforcePolicy(self, line):
 278         """Ensure a particular line is visible by expanding any header
 279         line hiding it.  Use the currently set visibility policy to
 280         determine which range to display."""
 281         pass
 282
 283     def FindText(self, minPos, maxPos, text, flags=0):
 284         """Find some text in the document."""
 285         pass
 286
 287     def FormatRange(self, doDraw, startPos, endPos, draw,
 288                     target, renderRect, pageRect):
 289         """On Windows, will draw the document into a display context
 290         such as a printer."""
 291         pass
 292
 293     def GetAnchor(self):
 294         """Return the position of the opposite end of the selection to
 295         the caret."""
 296         pass
 297
 298     def GetBackSpaceUnIndents(self):
 299         """Does a backspace pressed when caret is within indentation
 300         unindent?"""
 301         pass
 302
 303     def GetBufferedDraw(self):
 304         """Is drawing done first into a buffer or direct to the
 305         screen?"""
 306         pass
 307
 308     def GetCaretForeground(self):
 309         """Return the foreground colour of the caret."""
 310         pass
 311
 312     def GetCaretLineBack(self):
 313         """Return the colour of the background of the line containing
 314         the caret."""
 315         pass
 316
 317     def GetCaretLineVisible(self):
 318         """Is the background of the line containing the caret in a
 319         different colour?"""
 320         pass
 321
 322     def GetCaretPeriod(self):
 323         """Return the time in milliseconds that the caret is on and
 324         off."""
 325         pass
 326
 327     def GetCaretWidth(self):
 328         """Return the width of the insert mode caret."""
 329         pass
 330
 331     def GetCharAt(self, pos):
 332         """Return the character byte at the position."""
 333         pass
 334
 335     def GetCodePage(self):
 336         """Return the code page used to interpret the bytes of the
 337         document as characters."""
 338         pass
 339
 340     def GetColumn(self, pos):
 341         """Return the column number of a position, taking tab width
 342         into account."""
 343         pass
 344
 345     def GetControlCharSymbol(self):
 346         """Return the way control characters are displayed."""
 347         pass
 348
 349     def GetCurLine(self):
 350         """Return (text, pos) tuple with the text of the line
 351         containing the caret and the position of the caret within the
 352         line."""
 353         pass
 354
 355     def GetCurrentLine(self):
 356         """Return the line number of the line with the caret."""
 357         pass
 358
 359     def GetCurrentPos(self):
 360         """Return the position of the caret."""
 361         pass
 362
 363     def GetCursor(self):
 364         """Return cursor type."""
 365         pass
 366
 367     def GetDocPointer(self):
 368         """Return a pointer to the document object."""
 369         pass
 370
 371     def GetEOLMode(self):
 372         """Return the current end of line mode: CRLF, CR, or LF."""
 373         pass
 374
 375     def GetEdgeColour(self):
 376         """Return the colour used in edge indication."""
 377         pass
 378
 379     def GetEdgeColumn(self):
 380         """Return the column number which text should be kept within."""
 381         pass
 382
 383     def GetEdgeMode(self):
 384         """Return the edge highlight mode."""
 385         pass
 386
 387     def GetEndAtLastLine(self):
 388         """Return whether the maximum scroll position has the last
 389         line at the bottom of the view."""
 390         pass
 391
 392     def GetEndStyled(self):
 393         """Return the position of the last correctly styled character."""
 394         pass
 395
 396     def GetFirstVisibleLine(self):
 397         """Return the line at the top of the display."""
 398         pass
 399
 400     def GetFoldExpanded(self, line):
 401         """Is a header line expanded?"""
 402         pass
 403
 404     def GetFoldLevel(self, line):
 405         """Return the fold level of a line."""
 406         pass
 407
 408     def GetFoldParent(self, line):
 409         """Find the parent line of a child line."""
 410         pass
 411
 412     def GetHighlightGuide(self):
 413         """Return the highlighted indentation guide column."""
 414         pass
 415
 416     def GetIndent(self):
 417         """Return indentation size."""
 418         pass
 419
 420     def GetIndentationGuides(self):
 421         """Are the indentation guides visible?"""
 422         pass
 423
 424     def GetLastChild(self, line, level):
 425         """Find the last child line of a header line."""
 426         pass
 427
 428     def GetLastKeydownProcessed(self):
 429         """Can be used to prevent the EVT_CHAR handler from adding the
 430         char."""
 431         pass
 432
 433     def GetLayoutCache(self):
 434         """Return the degree of caching of layout information."""
 435         pass
 436
 437     def GetLength(self):
 438         """Return the number of characters in the document."""
 439         pass
 440
 441     def GetLexer(self):
 442         """Return the lexing language of the document."""
 443         pass
 444
 445     def GetLine(self, line):
 446         """Return the contents of a line."""
 447         pass
 448
 449     def GetLineCount(self):
 450         """Return the number of lines in the document. There is
 451         always at least one."""
 452         pass
 453
 454     def GetLineEndPosition(self, line):
 455         """Return the position after the last visible characters on a
 456         line."""
 457         pass
 458
 459     def GetLineIndentPosition(self, line):
 460         """Return the position before the first non indentation
 461         character on a line."""
 462         pass
 463
 464     def GetLineIndentation(self, line):
 465         """Return the number of columns that a line is indented."""
 466         pass
 467
 468     def GetLineState(self, line):
 469         """Return the extra styling information for a line."""
 470         pass
 471
 472     def GetLineVisible(self, line):
 473         """Is a line visible?"""
 474         pass
 475
 476     def GetMarginLeft(self):
 477         """Return the size in pixels of the left margin."""
 478         pass
 479
 480     def GetMarginMask(self, margin):
 481         """Return the marker mask of a margin."""
 482         pass
 483
 484     def GetMarginRight(self):
 485         """Return the size in pixels of the right margin."""
 486         pass
 487
 488     def GetMarginSensitive(self, margin):
 489         """Return the mouse click sensitivity of a margin."""
 490         pass
 491
 492     def GetMarginType(self, margin):
 493         """Return the type of a margin."""
 494         pass
 495
 496     def GetMarginWidth(self, margin):
 497         """Return the width of a margin in pixels."""
 498         pass
 499
 500     def GetMaxLineState(self):
 501         """Return the last line number that has line state."""
 502         pass
 503
 504     def GetModEventMask(self):
 505         """Return which document modification events are sent to the
 506         container."""
 507         pass
 508
 509     def GetModify(self):
 510         """Is the document different from when it was last saved?"""
 511         pass
 512
 513     def GetMouseDownCaptures(self):
 514         """Return whether mouse gets captured."""
 515         pass
 516
 517     def GetMouseDwellTime(self):
 518         """Return the time the mouse must sit still to generate a
 519         mouse dwell event."""
 520         pass
 521
 522     def GetOvertype(self):
 523         """Return true if overtype mode is active otherwise false is
 524         returned."""
 525         pass
 526
 527     def GetPrintColourMode(self):
 528         """Return the print colour mode."""
 529         pass
 530
 531     def GetPrintMagnification(self):
 532         """Return the print magnification."""
 533         pass
 534
 535     def GetReadOnly(self):
 536         """In read-only mode?"""
 537         pass
 538
 539     def GetSTCFocus(self):
 540         """Return internal focus flag."""
 541         pass
 542
 543     def GetScrollWidth(self):
 544         """Return the document width assumed for scrolling."""
 545         pass
 546
 547     def GetSearchFlags(self):
 548         """Return the search flags used by SearchInTarget."""
 549         pass
 550
 551     def GetSelectedText(self):
 552         """Return the selected text."""
 553         pass
 554
 555     def GetSelectionEnd(self):
 556         """Return the position at the end of the selection."""
 557         pass
 558
 559     def GetSelection(self):
 560         """Return the start and end positions of the current
 561         selection."""
 562         pass
 563
 564     def GetSelectionStart(self):
 565         """Return the position at the start of the selection."""
 566         pass
 567
 568     def GetStatus(self):
 569         """Return error status."""
 570         pass
 571
 572     def GetStyleAt(self, pos):
 573         """Return the style byte at the position."""
 574         pass
 575
 576     def GetStyleBits(self):
 577         """Return number of bits in style bytes used to hold the
 578         lexical state."""
 579         pass
 580
 581     def GetStyledText(self, startPos, endPos):
 582         """Return a buffer of cells."""
 583         pass
 584
 585     def GetTabIndents(self):
 586         """Does a tab pressed when caret is within indentation indent?"""
 587         pass
 588
 589     def GetTabWidth(self):
 590         """Return the visible size of a tab."""
 591         pass
 592
 593     def GetTargetEnd(self):
 594         """Return the position that ends the target."""
 595         pass
 596
 597     def GetTargetStart(self):
 598         """Return the position that starts the target."""
 599         pass
 600
 601     def GetText(self):
 602         """Return all the text in the document."""
 603         pass
 604
 605     def GetTextLength(self):
 606         """Return the number of characters in the document."""
 607         pass
 608
 609     def GetTextRange(self, startPos, endPos):
 610         """Return a range of text."""
 611         pass
 612
 613     def GetUndoCollection(self):
 614         """Is undo history being collected?"""
 615         pass
 616
 617     def GetUseHorizontalScrollBar(self):
 618         """Is the horizontal scroll bar visible?"""
 619         pass
 620
 621     def GetUseTabs(self):
 622         """Return whether tabs will be used in indentation."""
 623         pass
 624
 625     def GetViewEOL(self):
 626         """Are the end of line characters visible?"""
 627         pass
 628
 629     def GetViewWhiteSpace(self):
 630         """Are white space characters currently visible? Return one
 631         of SCWS_* constants."""
 632         pass
 633
 634     def GetWrapMode(self):
 635         """Return whether text is word wrapped."""
 636         pass
 637
 638     def GetXOffset(self):
 639         """Return the xOffset (self, ie, horizonal scroll position)."""
 640         pass
 641
 642     def GetZoom(self):
 643         """Return the zoom level."""
 644         pass
 645
 646     def GotoLine(self, line):
 647         """Set caret to start of a line and ensure it is visible."""
 648         pass
 649
 650     def GotoPos(self, pos):
 651         """Set caret to a position and ensure it is visible."""
 652         pass
 653
 654     def HideLines(self, lineStart, lineEnd):
 655         """Make a range of lines invisible."""
 656         pass
 657
 658     def HideSelection(self, normal):
 659         """Draw the selection in normal style or with selection
 660         highlighted."""
 661         pass
 662
 663     def HomeDisplay(self):
 664         """Move caret to first position on display line."""
 665         pass
 666
 667     def HomeDisplayExtend(self):
 668         """Move caret to first position on display line extending
 669         selection to new caret position."""
 670         pass
 671
 672     def IndicatorGetForeground(self, indic):
 673         """Return the foreground colour of an indicator."""
 674         pass
 675
 676     def IndicatorGetStyle(self, indic):
 677         """Return the style of an indicator."""
 678         pass
 679
 680     def IndicatorSetForeground(self, indic, fore):
 681         """Set the foreground colour of an indicator."""
 682         pass
 683
 684     def IndicatorSetStyle(self, indic, style):
 685         """Set an indicator to plain, squiggle or TT."""
 686         pass
 687
 688     def InsertText(self, pos, text):
 689         """Insert string at a position."""
 690         pass
 691
 692     def LineEndDisplay(self):
 693         """Move caret to last position on display line."""
 694         pass
 695
 696     def LineEndDisplayExtend(self):
 697         """Move caret to last position on display line extending
 698         selection to new caret position."""
 699         pass
 700
 701     def LineFromPosition(self, pos):
 702         """Return the line containing a position."""
 703         pass
 704
 705     def LineLength(self, line):
 706         """How many characters are on a line, not including end of
 707         line characters?"""
 708         pass
 709
 710     def LineScroll(self, columns, lines):
 711         """Scroll horizontally and vertically."""
 712         pass
 713
 714     def LinesOnScreen(self):
 715         """Retrieves the number of lines completely visible."""
 716         pass
 717
 718     def MarkerAdd(self, line, markerNumber):
 719         """Add a marker to a line, return an ID that can be used to
 720         find or delete the marker."""
 721         pass
 722
 723     def MarkerDefine(self, markerNumber, markerSymbol,
 724                      foreground=wx.NullColour, background=wx.NullColour):
 725         """Set the symbol used for a particular marker number, and
 726         optionally the fore and background colours."""
 727         pass
 728
 729     def MarkerDelete(self, line, markerNumber):
 730         """Delete a marker from a line."""
 731         pass
 732
 733     def MarkerDeleteAll(self, markerNumber):
 734         """Delete all markers with a particular number from all lines."""
 735         pass
 736
 737     def MarkerDeleteHandle(self, handle):
 738         """Delete a marker."""
 739         pass
 740
 741     def MarkerGet(self, line):
 742         """Return a bit mask of all the markers set on a line."""
 743         pass
 744
 745     def MarkerLineFromHandle(self, handle):
 746         """Return the line number at which a particular marker is
 747         located."""
 748         pass
 749
 750     def MarkerNext(self, lineStart, markerMask):
 751         """Find the next line after lineStart that includes a marker
 752         in mask."""
 753         pass
 754
 755     def MarkerPrevious(self, lineStart, markerMask):
 756         """Find the previous line before lineStart that includes a
 757         marker in mask."""
 758         pass
 759
 760     def MarkerSetBackground(self, markerNumber, back):
 761         """Set the background colour used for a particular marker
 762         number."""
 763         pass
 764
 765     def MarkerSetForeground(self, markerNumber, fore):
 766         """Set the foreground colour used for a particular marker
 767         number."""
 768         pass
 769
 770     def MoveCaretInsideView(self):
 771         """Move the caret inside current view if it is not there
 772         already."""
 773         pass
 774
 775     def Paste(self):
 776         """Paste the contents of the clipboard into the document
 777         replacing the selection."""
 778         pass
 779
 780     def PointFromPosition(self, pos):
 781         """Return the point in the window where a position is
 782         displayed."""
 783         pass
 784
 785     def PositionFromLine(self, line):
 786         """Return the position at the start of a line."""
 787         pass
 788
 789     def PositionFromPoint(self, pt):
 790         """Find the position from a point within the window."""
 791         pass
 792
 793     def PositionFromPointClose(self, x, y):
 794         """Find the position from a point within the window but return
 795         INVALID_POSITION if not close to text."""
 796         pass
 797
 798     def Redo(self):
 799         """Redo the next action on the undo history."""
 800         pass
 801
 802     def ReleaseDocument(self, docPointer):
 803         """Release a reference to the document, deleting document if
 804         it fades to black."""
 805         pass
 806
 807     def ReplaceSelection(self, text):
 808         """Replace the selected text with the argument text."""
 809         pass
 810
 811     def ReplaceTarget(self, text):
 812         """Replace the target text with the argument text.
 813
 814         Text is counted so it can contain nulls.  Return the length
 815         of the replacement text."""
 816         pass
 817
 818     def ReplaceTargetRE(self, text):
 819         """Replace the target text with the argument text after \d
 820         processing.
 821
 822         Text is counted so it can contain nulls.  Looks for \d where d
 823         is between 1 and 9 and replaces these with the strings matched
 824         in the last search operation which were surrounded by \(self,
 825         and \).  Return the length of the replacement text including
 826         any change caused by processing the \d patterns."""
 827         pass
 828
 829     def ScrollToColumn(self, column):
 830         """Scroll enough to make the given column visible."""
 831         pass
 832
 833     def ScrollToLine(self, line):
 834         """Scroll enough to make the given line visible."""
 835         pass
 836
 837     def SearchAnchor(self):
 838         """Sets the current caret position to be the search anchor."""
 839         pass
 840
 841     def SearchInTarget(self, text):
 842         """Search for a counted string in the target and set the
 843         target to the found range.
 844
 845         Text is counted so it can contain nulls.  Return length of
 846         range or -1 for failure in which case target is not moved."""
 847         pass
 848
 849     def SearchNext(self, flags, text):
 850         """Find some text starting at the search anchor.  Does not
 851         ensure the selection is visible."""
 852         pass
 853
 854     def SearchPrev(self, flags, text):
 855         """Find some text starting at the search anchor and moving
 856         backwards.  Does not ensure the selection is visible."""
 857         pass
 858
 859     def SelectAll(self):
 860         """Select all the text in the document."""
 861         pass
 862
 863     def SelectionIsRectangle(self):
 864         """Is the selection rectangular?  The alternative is the more
 865         common stream selection."""
 866         pass
 867
 868     def SendMsg(self, msg, wp=0, lp=0):
 869         """Send a message to Scintilla."""
 870         pass
 871
 872     def SetAnchor(self, posAnchor):
 873         """Set the selection anchor to a position.  The anchor is the
 874         opposite end of the selection from the caret."""
 875         pass
 876
 877     def SetBackSpaceUnIndents(self, bsUnIndents):
 878         """Sets whether a backspace pressed when caret is within
 879         indentation unindents."""
 880         pass
 881
 882     def SetBufferedDraw(self, buffered):
 883         """If drawing is buffered then each line of text is drawn into
 884         a bitmap buffer before drawing it to the screen to avoid
 885         flicker."""
 886         pass
 887
 888     def SetCaretForeground(self, fore):
 889         """Set the foreground colour of the caret."""
 890         pass
 891
 892     def SetCaretLineBack(self, back):
 893         """Set the colour of the background of the line containing the
 894         caret."""
 895         pass
 896
 897     def SetCaretLineVisible(self, show):
 898         """Display the background of the line containing the caret in
 899         a different colour."""
 900         pass
 901
 902     def SetCaretPeriod(self, periodMilliseconds):
 903         """Return the time in milliseconds that the caret is on and
 904         off. 0 = steady on."""
 905         pass
 906
 907     def SetCaretWidth(self, pixelWidth):
 908         """Set the width of the insert mode caret."""
 909         pass
 910
 911     def SetCodePage(self, codePage):
 912         """Set the code page used to interpret the bytes of the
 913         document as characters."""
 914         pass
 915
 916     def SetControlCharSymbol(self, symbol):
 917         """Change the way control characters are displayed: If symbol
 918         is < 32, keep the drawn way, else, use the given character."""
 919         pass
 920
 921     def SetCurrentPos(self, pos):
 922         """Sets the position of the caret."""
 923         pass
 924
 925     def SetCursor(self, cursorType):
 926         """Sets the cursor to one of the SC_CURSOR* values."""
 927         pass
 928
 929     def SetDocPointer(self, docPointer):
 930         """Change the document object used."""
 931         pass
 932
 933     def SetEOLMode(self, eolMode):
 934         """Set the current end of line mode."""
 935         pass
 936
 937     def SetEdgeColour(self, edgeColour):
 938         """Change the colour used in edge indication."""
 939         pass
 940
 941     def SetEdgeColumn(self, column):
 942         """Set the column number of the edge.  If text goes past the
 943         edge then it is highlighted."""
 944         pass
 945
 946     def SetEdgeMode(self, mode):
 947         """The edge may be displayed by a line (self, EDGE_LINE) or by
 948         highlighting text that goes beyond it (self, EDGE_BACKGROUND)
 949         or not displayed at all (self, EDGE_NONE)."""
 950         pass
 951
 952     def SetEndAtLastLine(self, endAtLastLine):
 953         """Sets the scroll range so that maximum scroll position has
 954         the last line at the bottom of the view (self, default).
 955         Setting this to false allows scrolling one page below the last
 956         line."""
 957         pass
 958
 959     def SetFoldExpanded(self, line, expanded):
 960         """Show the children of a header line."""
 961         pass
 962
 963     def SetFoldFlags(self, flags):
 964         """Set some debugging options for folding."""
 965         pass
 966
 967     def SetFoldLevel(self, line, level):
 968         """Set the fold level of a line.  This encodes an integer
 969         level along with flags indicating whether the line is a header
 970         and whether it is effectively white space."""
 971         pass
 972
 973     def SetHScrollBar(self, bar):
 974         """Set the horizontal scrollbar to use instead of the one
 975         that's built-in."""
 976         pass
 977
 978     def SetHighlightGuide(self, column):
 979         """Set the highlighted indentation guide column.  0 = no
 980         highlighted guide."""
 981         pass
 982
 983     def SetIndent(self, indentSize):
 984         """Set the number of spaces used for one level of indentation."""
 985         pass
 986
 987     def SetIndentationGuides(self, show):
 988         """Show or hide indentation guides."""
 989         pass
 990
 991     def SetKeyWords(self, keywordSet, keyWords):
 992         """Set up the key words used by the lexer."""
 993         pass
 994
 995     def SetLastKeydownProcessed(self, val):
 996         """Set ???."""
 997         pass
 998
 999     def SetLayoutCache(self, mode):
1000         """Sets the degree of caching of layout information."""
1001         pass
1002
1003     def SetLexer(self, lexer):
1004         """Set the lexing language of the document."""
1005         pass
1006
1007     def SetLexerLanguage(self, language):
1008         """Set the lexing language of the document based on string
1009         name."""
1010         pass
1011
1012     def SetLineIndentation(self, line, indentSize):
1013         """Change the indentation of a line to a number of columns."""
1014         pass
1015
1016     def SetLineState(self, line, state):
1017         """Used to hold extra styling information for each line."""
1018         pass
1019
1020     def SetMarginLeft(self, pixelWidth):
1021         """Sets the size in pixels of the left margin."""
1022         pass
1023
1024     def SetMarginMask(self, margin, mask):
1025         """Set a mask that determines which markers are displayed in a
1026         margin."""
1027         pass
1028
1029     def SetMarginRight(self, pixelWidth):
1030         """Sets the size in pixels of the right margin."""
1031         pass
1032
1033     def SetMarginSensitive(self, margin, sensitive):
1034         """Make a margin sensitive or insensitive to mouse clicks."""
1035         pass
1036
1037     def SetMarginType(self, margin, marginType):
1038         """Set a margin to be either numeric or symbolic."""
1039         pass
1040
1041     def SetMarginWidth(self, margin, pixelWidth):
1042         """Set the width of a margin to a width expressed in pixels."""
1043         pass
1044
1045     def SetMargins(self, left, right):
1046         """Set the left and right margin in the edit area, measured in
1047         pixels."""
1048         pass
1049
1050     def SetModEventMask(self, mask):
1051         """Set which document modification events are sent to the
1052         container."""
1053         pass
1054
1055     def SetMouseDownCaptures(self, captures):
1056         """Set whether the mouse is captured when its button is
1057         pressed."""
1058         pass
1059
1060     def SetMouseDwellTime(self, periodMilliseconds):
1061         """Sets the time the mouse must sit still to generate a mouse
1062         dwell event."""
1063         pass
1064
1065     def SetOvertype(self, overtype):
1066         """Set to overtype (self, true) or insert mode."""
1067         pass
1068
1069     def SetPrintColourMode(self, mode):
1070         """Modify colours when printing for clearer printed text."""
1071         pass
1072
1073     def SetPrintMagnification(self, magnification):
1074         """Sets the print magnification added to the point size of
1075         each style for printing."""
1076         pass
1077
1078     def SetProperty(self, key, value):
1079         """Set up a value that may be used by a lexer for some
1080         optional feature."""
1081         pass
1082
1083     def SetReadOnly(self, readOnly):
1084         """Set to read only or read write."""
1085         pass
1086
1087     def SetSTCFocus(self, focus):
1088         """Change internal focus flag."""
1089         pass
1090
1091     def SetSavePoint(self):
1092         """Remember the current position in the undo history as the
1093         position at which the document was saved."""
1094         pass
1095
1096     def SetScrollWidth(self, pixelWidth):
1097         """Sets the document width assumed for scrolling."""
1098         pass
1099
1100     def SetSearchFlags(self, flags):
1101         """Set the search flags used by SearchInTarget."""
1102         pass
1103
1104     def SetSelBackground(self, useSetting, back):
1105         """Set the background colour of the selection and whether to
1106         use this setting."""
1107         pass
1108
1109     def SetSelForeground(self, useSetting, fore):
1110         """Set the foreground colour of the selection and whether to
1111         use this setting."""
1112         pass
1113
1114     def SetSelection(self, start, end):
1115         """Select a range of text."""
1116         pass
1117
1118     def SetSelectionEnd(self, pos):
1119         """Sets the position that ends the selection - this becomes
1120         the currentPosition."""
1121         pass
1122
1123     def SetSelectionStart(self, pos):
1124         """Sets the position that starts the selection - this becomes
1125         the anchor."""
1126         pass
1127
1128     def SetStatus(self, statusCode):
1129         """Change error status - 0 = OK."""
1130         pass
1131
1132     def SetStyleBits(self, bits):
1133         """Divide each styling byte into lexical class bits (self,
1134         default: 5) and indicator bits (self, default: 3). If a lexer
1135         requires more than 32 lexical states, then this is used to
1136         expand the possible states."""
1137         pass
1138
1139     def SetStyleBytes(self, length, styleBytes):
1140         """Set the styles for a segment of the document."""
1141         pass
1142
1143     def SetStyling(self, length, style):
1144         """Change style from current styling position for length
1145         characters to a style and move the current styling position to
1146         after this newly styled segment."""
1147         pass
1148
1149     def SetTabIndents(self, tabIndents):
1150         """Sets whether a tab pressed when caret is within indentation
1151         indents."""
1152         pass
1153
1154     def SetTabWidth(self, tabWidth):
1155         """Change the visible size of a tab to be a multiple of the
1156         width of a space character."""
1157         pass
1158
1159     def SetTargetEnd(self, pos):
1160         """Sets the position that ends the target which is used for
1161         updating the document without affecting the scroll position."""
1162         pass
1163
1164     def SetTargetStart(self, pos):
1165         """Sets the position that starts the target which is used for
1166         updating the document without affecting the scroll position."""
1167         pass
1168
1169     def SetText(self, text):
1170         """Replace the contents of the document with the argument
1171         text."""
1172         pass
1173
1174     def SetUndoCollection(self, collectUndo):
1175         """Choose between collecting actions into the undo history and
1176         discarding them."""
1177         pass
1178
1179     def SetUseHorizontalScrollBar(self, show):
1180         """Show or hide the horizontal scroll bar."""
1181         pass
1182
1183     def SetUseTabs(self, useTabs):
1184         """Indentation will only use space characters if useTabs is
1185         false, otherwise it will use a combination of tabs and spaces."""
1186         pass
1187
1188     def SetVScrollBar(self, bar):
1189         """Set the vertical scrollbar to use instead of the one that's
1190         built-in."""
1191         pass
1192
1193     def SetViewEOL(self, visible):
1194         """Make the end of line characters visible or invisible."""
1195         pass
1196
1197     def SetViewWhiteSpace(self, viewWS):
1198         """Make white space characters invisible, always visible or
1199         visible outside indentation."""
1200         pass
1201
1202     def SetVisiblePolicy(self, visiblePolicy, visibleSlop):
1203         """Set the way the display area is determined when a
1204         particular line is to be moved to by Find, FindNext, GotoLine,
1205         etc."""
1206         pass
1207
1208     def SetWhitespaceBackground(self, useSetting, back):
1209         """Set the background colour of all whitespace and whether to
1210         use this setting."""
1211         pass
1212
1213     def SetWhitespaceForeground(self, useSetting, fore):
1214         """Set the foreground colour of all whitespace and whether to
1215         use this setting."""
1216         pass
1217
1218     def SetWordChars(self, characters):
1219         """Set the set of characters making up words for when moving
1220         or selecting by word."""
1221         pass
1222
1223     def SetWrapMode(self, mode):
1224         """Sets whether text is word wrapped."""
1225         pass
1226
1227     def SetXCaretPolicy(self, caretPolicy, caretSlop):
1228         """Set the way the caret is kept visible when going sideway.
1229         The exclusion zone is given in pixels."""
1230         pass
1231
1232     def SetXOffset(self, newOffset):
1233         """Set the xOffset (self, ie, horizonal scroll position)."""
1234         pass
1235
1236     def SetYCaretPolicy(self, caretPolicy, caretSlop):
1237         """Set the way the line the caret is on is kept visible.  The
1238         exclusion zone is given in lines."""
1239         pass
1240
1241     def SetZoom(self, zoom):
1242         """Set the zoom level. This number of points is added to the
1243         size of all fonts.  It may be positive to magnify or negative
1244         to reduce."""
1245         pass
1246
1247     def ShowLines(self, lineStart, lineEnd):
1248         """Make a range of lines visible."""
1249         pass
1250
1251     def StartRecord(self):
1252         """Start notifying the container of all key presses and
1253         commands."""
1254         pass
1255
1256     def StartStyling(self, pos, mask):
1257         """Set the current styling position and mask.
1258
1259         The styling mask can be used to protect some bits in each
1260         styling byte from modification."""
1261         pass
1262
1263     def StopRecord(self):
1264         """Stop notifying the container of all key presses and
1265         commands."""
1266         pass
1267
1268     def StyleClearAll(self):
1269         """Clear all the styles and make equivalent to the global
1270         default style."""
1271         pass
1272
1273     def StyleResetDefault(self):
1274         """Reset the default style to its state at startup."""
1275         pass
1276
1277     def StyleSetBackground(self, style, back):
1278         """Set the background colour of a style."""
1279         pass
1280
1281     def StyleSetBold(self, style, bold):
1282         """Set a style to be bold or not."""
1283         pass
1284
1285     def StyleSetCase(self, style, caseForce):
1286         """Set a style to be mixed case, or to force upper or lower
1287         case."""
1288         pass
1289
1290     def StyleSetChangeable(self, style, changeable):
1291         """Set a style to be changeable or not (self, read only).
1292         Experimental feature, currently buggy."""
1293         pass
1294
1295     def StyleSetCharacterSet(self, style, characterSet):
1296         """Set the character set of the font in a style."""
1297         pass
1298
1299     def StyleSetEOLFilled(self, style, filled):
1300         """Set a style to have its end of line filled or not."""
1301         pass
1302
1303     def StyleSetFaceName(self, style, fontName):
1304         """Set the font of a style."""
1305         pass
1306
1307     def StyleSetFont(self, styleNum, font):
1308         """Set style size, face, bold, italic, and underline
1309         attributes from a Font's attributes."""
1310         pass
1311
1312     def StyleSetFontAttr(self, styleNum, size, faceName,
1313                          bold, italic, underline):
1314         """Set all font style attributes at once."""
1315         pass
1316
1317     def StyleSetForeground(self, style, fore):
1318         """Set the foreground colour of a style."""
1319         pass
1320
1321     def StyleSetItalic(self, style, italic):
1322         """Set a style to be italic or not."""
1323         pass
1324
1325     def StyleSetSize(self, style, sizePoints):
1326         """Set the size of characters of a style."""
1327         pass
1328
1329     def StyleSetSpec(self, styleNum, spec):
1330         """Extract style settings from a spec-string which is composed
1331         of one or more of the following comma separated elements:
1332
1333         bold             turns on bold
1334         italic           turns on italics
1335         fore:#RRGGBB     sets the foreground colour
1336         back:#RRGGBB     sets the background colour
1337         face:[facename]  sets the font face name to use
1338         size:[num]       sets the font size in points
1339         eol              turns on eol filling
1340         underline        turns on underlining
1341         """
1342         pass
1343
1344     def StyleSetUnderline(self, style, underline):
1345         """Set a style to be underlined or not."""
1346         pass
1347
1348     def StyleSetVisible(self, style, visible):
1349         """Set a style to be visible or not."""
1350         pass
1351
1352     def TextHeight(self, line):
1353         """Return the height of a particular line of text in pixels."""
1354         pass
1355
1356     def TextWidth(self, style, text):
1357         """Measure the pixel width of some text in a particular style.
1358         Nul terminated text argument.  Does not handle tab or control
1359         characters."""
1360         pass
1361
1362     def ToggleFold(self, line):
1363         """Switch a header line between expanded and contracted."""
1364         pass
1365
1366     def Undo(self):
1367         """Undo one action in the undo history."""
1368         pass
1369
1370     def UsePopUp(self, allowPopUp):
1371         """Set whether a pop up menu is displayed automatically when
1372         the user presses the wrong mouse button."""
1373         pass
1374
1375     def UserListShow(self, listType, itemList):
1376         """Display a list of strings and send notification when user
1377         chooses one."""
1378         pass
1379
1380     def VisibleFromDocLine(self, line):
1381         """Find the display line of a document line taking hidden
1382         lines into account."""
1383         pass
1384
1385     def WordEndPosition(self, pos, onlyWordCharacters):
1386         """Return position of end of word."""
1387         pass
1388
1389     def WordPartLeft(self):
1390         """Move to the previous change in capitalisation."""
1391         pass
1392
1393     def WordPartLeftExtend(self):
1394         """Move to the previous change in capitalisation extending
1395         selection to new caret position."""
1396         pass
1397
1398     def WordPartRight(self):
1399         """Move to the change next in capitalisation."""
1400         pass
1401
1402     def WordPartRightExtend(self):
1403         """Move to the next change in capitalisation extending
1404         selection to new caret position."""
1405         pass
1406
1407     def WordStartPosition(self, pos, onlyWordCharacters):
1408         """Return position of start of word."""
1409         pass