Ticket #17680: stcdocs.patch

File stcdocs.patch, 123.1 KB (added by NewPagodi, 3 years ago)
  • include/wx/stc/stc.h

    diff --git a/include/wx/stc/stc.h b/include/wx/stc/stc.h
    index f5c97c5..1b73462 100644
    a b public: 
    28702870    // Insert string at a position.
    28712871    void InsertText(int pos, const wxString& text);
    28722872
    2873     // Change the text that is being inserted in response to SC_MOD_INSERTCHECK
     2873    // Change the text that is being inserted in response to wxSTC_MOD_INSERTCHECK
    28742874    void ChangeInsertion(int length, const wxString& text);
    28752875
    28762876    // Delete all text in the document.
    public: 
    29272927    bool GetUndoCollection() const;
    29282928
    29292929    // Are white space characters currently visible?
    2930     // Returns one of SCWS_* constants.
     2930    // Returns one of wxSTC_WS_* constants.
    29312931    int GetViewWhiteSpace() const;
    29322932
    29332933    // Make white space characters invisible, always visible or visible outside indentation.
    29342934    void SetViewWhiteSpace(int viewWS);
    29352935
    29362936    // Retrieve the current tab draw mode.
    2937     // Returns one of SCTD_* constants.
     2937    // Returns one of wxSTC_TD_* constants.
    29382938    int GetTabDrawMode() const;
    29392939
    29402940    // Set how tabs are drawn when visible.
    public: 
    29442944    int PositionFromPoint(wxPoint pt) const;
    29452945
    29462946    // Find the position from a point within the window but return
    2947     // INVALID_POSITION if not close to text.
     2947    // wxSTC_INVALID_POSITION if not close to text.
    29482948    int PositionFromPointClose(int x, int y);
    29492949
    29502950    // Set caret to start of a line and ensure it is visible.
    public: 
    29582958    void SetAnchor(int anchor);
    29592959
    29602960    // Retrieve the text of the line containing the caret.
    2961     // Returns the index of the caret on the line.
    2962     // Result is NUL-terminated.
    29632961    #ifdef SWIG
    29642962    wxString GetCurLine(int* OUTPUT);
    29652963#else
    public: 
    29722970    // Convert all line endings in the document to one mode.
    29732971    void ConvertEOLs(int eolMode);
    29742972
    2975     // Retrieve the current end of line mode - one of CRLF, CR, or LF.
     2973    // Retrieve the current end of line mode - one of wxSTC_EOL_CRLF, wxSTC_EOL_CR, or wxSTC_EOL_LF.
    29762974    int GetEOLMode() const;
    29772975
    29782976    // Set the current end of line mode.
    public: 
    30933091    // Retrieve the cursor shown in a margin.
    30943092    int GetMarginCursor(int margin) const;
    30953093
    3096     // Set the background colour of a margin. Only visible for SC_MARGIN_COLOUR.
     3094    // Set the background colour of a margin. Only visible for wxSTC_MARGIN_COLOUR.
    30973095    void SetMarginBackground(int margin, const wxColour& back);
    30983096
    30993097    // Retrieve the background colour of a margin
    public: 
    31913189    int StyleGetWeight(int style) const;
    31923190
    31933191    // Set the character set of the font in a style.
    3194     // Converts the Scintilla character set values to a wxFontEncoding.
    31953192    void StyleSetCharacterSet(int style, int characterSet);
    31963193
    31973194    // Set a style to be a hotspot or not.
    public: 
    36773674    // Replace the target text with the argument text after \\d processing.
    36783675    // Text is counted so it can contain NULs.
    36793676    // Looks for \\d where d is between 1 and 9 and replaces these with the strings
    3680     // matched in the last search operation which were surrounded by \( and \).
     3677    // matched in the last search operation which were surrounded by \\( and \\).
    36813678    // Returns the length of the replacement text including any change
    36823679    // caused by processing the \\d patterns.
    36833680    int ReplaceTargetRE(const wxString& text);
    public: 
    37203717    // Set the foreground colour for the highlighted part of the call tip.
    37213718    void CallTipSetForegroundHighlight(const wxColour& fore);
    37223719
    3723     // Enable use of STYLE_CALLTIP and set call tip tab size in pixels.
     3720    // Enable use of wxSTC_STYLE_CALLTIP and set call tip tab size in pixels.
    37243721    void CallTipUseStyle(int tabSize);
    37253722
    37263723    // Set position of calltip, above or below text.
    public: 
    38613858    // Retrive the start indent for wrapped lines.
    38623859    int GetWrapStartIndent() const;
    38633860
    3864     // Sets how wrapped sublines are placed. Default is fixed.
     3861    // Sets how wrapped sublines are placed. Default is wxSTC_WRAPINDENT_FIXED.
    38653862    void SetWrapIndentMode(int wrapIndentMode);
    38663863
    3867     // Retrieve how wrapped sublines are placed. Default is fixed.
     3864    // Retrieve how wrapped sublines are placed. Default is wxSTC_WRAPINDENT_FIXED.
    38683865    int GetWrapIndentMode() const;
    38693866
    38703867    // Sets the degree of caching of layout information.
    public: 
    38863883    bool GetScrollWidthTracking() const;
    38873884
    38883885    // Measure the pixel width of some text in a particular style.
    3889     // NUL terminated text argument.
    38903886    // Does not handle tab or control characters.
    38913887    int TextWidth(int style, const wxString& text);
    38923888
    public: 
    39373933    int GetMultiPaste() const;
    39383934
    39393935    // Retrieve the value of a tag from a regular expression search.
    3940     // Result is NUL-terminated.
    39413936    wxString GetTag(int tagNumber) const;
    39423937
    39433938    // Join the lines in the target.
    public: 
    41564151    // Use specified indicator to highlight non matching brace instead of changing its style.
    41574152    void BraceBadLightIndicator(bool useSetting, int indicator);
    41584153
    4159     // Find the position of a matching brace or INVALID_POSITION if no match.
     4154    // Find the position of a matching brace or wxSTC_INVALID_POSITION if no match.
    41604155    // The maxReStyle must be 0 for now. It may be defined in a future release.
    41614156    int BraceMatch(int pos, int maxReStyle=0);
    41624157
    public: 
    41854180    // Retrieve the edge highlight mode.
    41864181    int GetEdgeMode() const;
    41874182
    4188     // The edge may be displayed by a line (EDGE_LINE/EDGE_MULTILINE) or by highlighting text that
    4189     // goes beyond it (EDGE_BACKGROUND) or not displayed at all (EDGE_NONE).
     4183    // The edge may be displayed by a line (wxSTC_EDGE_LINE/wxSTC_EDGE_MULTILINE) or by highlighting text that
     4184    // goes beyond it (wxSTC_EDGE_BACKGROUND) or not displayed at all (wxSTC_EDGE_NONE).
    41904185    void SetEdgeMode(int edgeMode);
    41914186
    41924187    // Retrieve the colour used in edge indication.
    public: 
    42664261    // Get whether mouse wheel can be active outside the window.
    42674262    bool GetMouseWheelCaptures() const;
    42684263
    4269     // Sets the cursor to one of the SC_CURSOR* values.
     4264    // Sets the cursor to one of the wxSTC_CURSOR* values.
    42704265    void SetSTCCursor(int cursorType);
    42714266
    42724267    // Get cursor type.
    public: 
    43034298    // Delete forwards from the current position to the end of the line.
    43044299    void DelLineRight();
    43054300
    4306     // Get and Set the xOffset (ie, horizontal scroll position).
     4301    // Set the xOffset (ie, horizontal scroll position).
    43074302    void SetXOffset(int xOffset);
     4303
     4304    // Get the xOffset (ie, horizontal scroll position).
    43084305    int GetXOffset() const;
    43094306
    43104307    // Set the last x chosen value to be the caret x position.
    public: 
    43184315    // The exclusion zone is given in lines.
    43194316    void SetYCaretPolicy(int caretPolicy, int caretSlop);
    43204317
    4321     // Set printing to line wrapped (SC_WRAP_WORD) or not line wrapped (SC_WRAP_NONE).
     4318    // Set printing to line wrapped (wxSTC_WRAP_WORD) or not line wrapped (wxSTC_WRAP_NONE).
    43224319    void SetPrintWrapMode(int wrapMode);
    43234320
    43244321    // Is printing line wrapped?
    public: 
    43784375    // Copy argument text to the clipboard.
    43794376    void CopyText(int length, const wxString& text);
    43804377
    4381     // Set the selection mode to stream (SC_SEL_STREAM) or rectangular (SC_SEL_RECTANGLE/SC_SEL_THIN) or
    4382     // by lines (SC_SEL_LINES).
     4378    // Set the selection mode to stream (wxSTC_SEL_STREAM) or rectangular (wxSTC_SEL_RECTANGLE/wxSTC_SEL_THIN) or
     4379    // by lines (wxSTC_SEL_LINES).
    43834380    void SetSelectionMode(int selectionMode);
    43844381
    43854382    // Get the mode of the current selection.
    43864383    int GetSelectionMode() const;
    43874384
    4388     // Retrieve the position of the start of the selection at the given line (INVALID_POSITION if no selection on this line).
     4385    // Retrieve the position of the start of the selection at the given line (wxSTC_INVALID_POSITION if no selection on this line).
    43894386    int GetLineSelStartPosition(int line);
    43904387
    4391     // Retrieve the position of the end of the selection at the given line (INVALID_POSITION if no selection on this line).
     4388    // Retrieve the position of the end of the selection at the given line (wxSTC_INVALID_POSITION if no selection on this line).
    43924389    int GetLineSelEndPosition(int line);
    43934390
    43944391    // Move caret down one line, extending rectangular selection to new caret position.
    public: 
    46804677    int CharPositionFromPoint(int x, int y);
    46814678
    46824679    // Find the position of a character from a point within the window.
    4683     // Return INVALID_POSITION if not close to text.
     4680    // Return wxSTC_INVALID_POSITION if not close to text.
    46844681    int CharPositionFromPointClose(int x, int y);
    46854682
    46864683    // Set whether switching to rectangular mode while selecting with the mouse is allowed.
    public: 
    48034800    // On GTK+, allow selecting the modifier key to use for mouse-based
    48044801    // rectangular selection. Often the window manager requires Alt+Mouse Drag
    48054802    // for moving windows.
    4806     // Valid values are SCMOD_CTRL(default), SCMOD_ALT, or SCMOD_SUPER.
     4803    // Valid values are wxSTC_KEYMOD_CTRL (default), wxSTC_KEYMOD_ALT, or wxSTC_KEYMOD_SUPER.
    48074804    void SetRectangularSelectionModifier(int modifier);
    48084805
    48094806    // Get the modifier key used for rectangular selection.
    public: 
    49244921    void SetRepresentation(const wxString& encodedCharacter, const wxString& representation);
    49254922
    49264923    // Set the way a character is drawn.
    4927     // Result is NUL-terminated.
    49284924    wxString GetRepresentation(const wxString& encodedCharacter) const;
    49294925
    49304926    // Remove a character representation.
    public: 
    49574953    // Load a lexer library (dll / so).
    49584954    void LoadLexerLibrary(const wxString& path);
    49594955
    4960     // Retrieve a 'property' value previously set with SetProperty.
     4956    // Retrieve a "property" value previously set with SetProperty.
    49614957    wxString GetProperty(const wxString& key);
    49624958
    4963     // Retrieve a 'property' value previously set with SetProperty,
    4964     // with '$()' variable replacement on returned buffer.
     4959    // Retrieve a "property" value previously set with SetProperty,
     4960    // with "$()" variable replacement on returned buffer.
    49654961    wxString GetPropertyExpanded(const wxString& key);
    49664962
    4967     // Retrieve a 'property' value previously set with SetProperty,
    4968     // interpreted as an int AFTER any '$()' variable replacement.
     4963    // Retrieve a "property" value previously set with SetProperty,
     4964    // interpreted as an int AFTER any "$()" variable replacement.
    49694965    int GetPropertyInt(const wxString &key, int defaultValue=0) const;
    49704966
    49714967    // Retrieve the number of bits the current lexer needs for styling.
    public: 
    49774973    // For private communication between an application and a known lexer.
    49784974    void* PrivateLexerCall(int operation, void* pointer);
    49794975
    4980     // Retrieve a '\n' separated list of properties understood by the current lexer.
    4981     // Result is NUL-terminated.
     4976    // Retrieve a '\\n' separated list of properties understood by the current lexer.
    49824977    wxString PropertyNames() const;
    49834978
    49844979    // Retrieve the type of a property.
    49854980    int PropertyType(const wxString& name);
    49864981
    49874982    // Describe a property.
    4988     // Result is NUL-terminated.
    49894983    wxString DescribeProperty(const wxString& name) const;
    49904984
    4991     // Retrieve a '\n' separated list of descriptions of the keyword sets understood by the current lexer.
    4992     // Result is NUL-terminated.
     4985    // Retrieve a '\\n' separated list of descriptions of the keyword sets understood by the current lexer.
    49934986    wxString DescribeKeyWordSets() const;
    49944987
    49954988    // Bit set of LineEndType enumertion for which line ends beyond the standard
    public: 
    50225015    int DistanceToSecondaryStyles() const;
    50235016
    50245017    // Get the set of base styles that can be extended with sub styles
    5025     // Result is NUL-terminated.
    50265018    wxString GetSubStyleBases() const;
    50275019
    50285020    //}}}
  • new file src/stc/gen_docs.py

    diff --git a/src/stc/gen_docs.py b/src/stc/gen_docs.py
    new file mode 100644
    index 0000000..41f6974
    - +  
     1#!/usr/bin/env python
     2#----------------------------------------------------------------------------
     3# Name:         src/stc/gen_docs.py
     4# Purpose:      Helper function and data used by gen_iface.py to generate
     5#               docstrings for wxStyledTextCtrl methods.
     6# Author:       New Pagodi
     7# Created:      2017-02-24
     8# Copyright:    (c) 2017 wxWidgets development team
     9# Licence:      wxWindows licence
     10#----------------------------------------------------------------------------
     11
     12
     13# List of the categories for the documentation.  Tuple items are:
     14#
     15#         1. the brief name for this category (this must be 1 word)
     16#         2. the full name of this category.  This will appear in the documentation.
     17#         3. the description of this category or 0 for none.
     18#
     19categoriesList = [
     20    ('TextRetrievalAndModification'    ,'Text retrieval and modification', 0),
     21    ('Searching'                       ,'Searching and replacing', 0),
     22    ('Overtype'                        ,'Overtype', 0),
     23    ('CutCopyAndPaste'                 ,'Cut copy and paste', 0),
     24    ('ErrorHandling'                   ,'Error handling', 0),
     25    ('UndoAndRedo'                     ,'Undo and Redo', 0),
     26    ('SelectionAndInformation'         ,'Selection and information', 0),
     27    ('MultipleSelectionAndVirtualSpace','Multiple Selection and Virtual Space', 0),
     28    ('ScrollingAndAutomaticScrolling'  ,'Scrolling and automatic scrolling', 0),
     29    ('WhiteSpace'                      ,'White space', 0),
     30    ('Cursor'                          ,'Cursor', 0),
     31    ('MouseCapture'                    ,'Mouse capture', 0),
     32    ('LineEndings'                     ,'Line endings', 0),
     33    ('Words'                           ,'Words', 0),
     34    ('Styling'                         ,'Styling', 0),
     35    ('StyleDefinition'                 ,'Style definition', 0),
     36    ('CaretAndSelectionStyles'         ,'Caret selection and hotspot styles', 0),
     37    ('CharacterRepresentations'        ,'Character representations', 0),
     38    ('Margins'                         ,'Margins', 0),
     39    ('Annotations'                     ,'Annotations', 0),
     40    ('OtherSettings'                   ,'Other settings', 0),
     41    ('BraceHighlighting'               ,'Brace highlighting', 0),
     42    ('TabsAndIndentationGuides'        ,'Tabs and Indentation Guides', 0),
     43    ('Markers'                         ,'Markers', 0),
     44    ('Indicators'                      ,'Indicators', 0),
     45    ('Autocompletion'                  ,'Autocompletion', 0),
     46    ('UserLists'                       ,'User lists', 0),
     47    ('CallTips'                        ,'Call tips', 0),
     48    ('KeyboardCommands'                ,'Keyboard commands', 0),
     49    ('KeyBindings'                     ,'Key bindings', 0),
     50    ('PopupEditMenu'                   ,'Popup edit menu', 0),
     51    ('MacroRecording'                  ,'Macro recording', 0),
     52    ('Printing'                        ,'Printing', 0),
     53    ('DirectAccess'                    ,'Direct access', 0),
     54    ('MultipleViews'                   ,'Multiple views', 0),
     55    ('BackgroundLoadSave'              ,'Background loading and saving', 0),
     56    ('Folding'                         ,'Folding', 0),
     57    ('LineWrapping'                    ,'Line wrapping', 0),
     58    ('Zooming'                         ,'Zooming', 0),
     59    ('LongLines'                       ,'Long lines', 0),
     60    ('Lexer'                           ,'Lexer', 0),
     61    ('Notifications'                   ,'Event related items', 0),
     62    ('DeprecatedMessages'              ,'Deprecated items',
     63        ('These methods should not be used in new code.',))
     64]
     65
     66# Assign each method to a category
     67docsMap = {
     68    'AnnotationClearAll':'Annotations',
     69    'AnnotationGetLines':'Annotations',
     70    'AnnotationGetStyle':'Annotations',
     71    'AnnotationGetStyleOffset':'Annotations',
     72    'AnnotationGetStyles':'Annotations',
     73    'AnnotationGetText':'Annotations',
     74    'AnnotationGetVisible':'Annotations',
     75    'AnnotationSetStyle':'Annotations',
     76    'AnnotationSetStyleOffset':'Annotations',
     77    'AnnotationSetStyles':'Annotations',
     78    'AnnotationSetText':'Annotations',
     79    'AnnotationSetVisible':'Annotations',
     80    'AutoCActive':'Autocompletion',
     81    'AutoCCancel':'Autocompletion',
     82    'AutoCComplete':'Autocompletion',
     83    'AutoCGetAutoHide':'Autocompletion',
     84    'AutoCGetCancelAtStart':'Autocompletion',
     85    'AutoCGetCaseInsensitiveBehaviour':'Autocompletion',
     86    'AutoCGetChooseSingle':'Autocompletion',
     87    'AutoCGetCurrent':'Autocompletion',
     88    'AutoCGetDropRestOfWord':'Autocompletion',
     89    'AutoCGetIgnoreCase':'Autocompletion',
     90    'AutoCGetMaxHeight':'Autocompletion',
     91    'AutoCGetMaxWidth':'Autocompletion',
     92    'AutoCGetMulti':'Autocompletion',
     93    'AutoCGetOrder':'Autocompletion',
     94    'AutoCGetSeparator':'Autocompletion',
     95    'AutoCGetTypeSeparator':'Autocompletion',
     96    'AutoCPosStart':'Autocompletion',
     97    'AutoCSelect':'Autocompletion',
     98    'AutoCSetAutoHide':'Autocompletion',
     99    'AutoCSetCancelAtStart':'Autocompletion',
     100    'AutoCSetCaseInsensitiveBehaviour':'Autocompletion',
     101    'AutoCSetChooseSingle':'Autocompletion',
     102    'AutoCSetDropRestOfWord':'Autocompletion',
     103    'AutoCSetFillUps':'Autocompletion',
     104    'AutoCSetIgnoreCase':'Autocompletion',
     105    'AutoCSetMaxHeight':'Autocompletion',
     106    'AutoCSetMaxWidth':'Autocompletion',
     107    'AutoCSetMulti':'Autocompletion',
     108    'AutoCSetOrder':'Autocompletion',
     109    'AutoCSetSeparator':'Autocompletion',
     110    'AutoCSetTypeSeparator':'Autocompletion',
     111    'AutoCShow':'Autocompletion',
     112    'AutoCStops':'Autocompletion',
     113    'ClearRegisteredImages':'Autocompletion',
     114    'RegisterImage':'Autocompletion',
     115    'RegisterRGBAImage':'Autocompletion',
     116    'CreateLoader':'BackgroundLoadSave',
     117    'BraceBadLight':'BraceHighlighting',
     118    'BraceBadLightIndicator':'BraceHighlighting',
     119    'BraceHighlight':'BraceHighlighting',
     120    'BraceHighlightIndicator':'BraceHighlighting',
     121    'BraceMatch':'BraceHighlighting',
     122    'CallTipActive':'CallTips',
     123    'CallTipCancel':'CallTips',
     124    'CallTipPosStart':'CallTips',
     125    'CallTipSetBack':'CallTips',
     126    'CallTipSetFore':'CallTips',
     127    'CallTipSetForeHlt':'CallTips',
     128    'CallTipSetHlt':'CallTips',
     129    'CallTipSetPosition':'CallTips',
     130    'CallTipSetPosStart':'CallTips',
     131    'CallTipShow':'CallTips',
     132    'CallTipUseStyle':'CallTips',
     133    'GetCaretFore':'CaretAndSelectionStyles',
     134    'GetCaretLineBack':'CaretAndSelectionStyles',
     135    'GetCaretLineBackAlpha':'CaretAndSelectionStyles',
     136    'GetCaretLineVisible':'CaretAndSelectionStyles',
     137    'GetCaretLineVisibleAlways':'CaretAndSelectionStyles',
     138    'GetCaretPeriod':'CaretAndSelectionStyles',
     139    'GetCaretSticky':'CaretAndSelectionStyles',
     140    'GetCaretStyle':'CaretAndSelectionStyles',
     141    'GetCaretWidth':'CaretAndSelectionStyles',
     142    'GetHotspotActiveBack':'CaretAndSelectionStyles',
     143    'GetHotspotActiveFore':'CaretAndSelectionStyles',
     144    'GetHotspotActiveUnderline':'CaretAndSelectionStyles',
     145    'GetHotspotSingleLine':'CaretAndSelectionStyles',
     146    'GetSelAlpha':'CaretAndSelectionStyles',
     147    'GetSelEOLFilled':'CaretAndSelectionStyles',
     148    'SetCaretFore':'CaretAndSelectionStyles',
     149    'SetCaretLineBack':'CaretAndSelectionStyles',
     150    'SetCaretLineBackAlpha':'CaretAndSelectionStyles',
     151    'SetCaretLineVisible':'CaretAndSelectionStyles',
     152    'SetCaretLineVisibleAlways':'CaretAndSelectionStyles',
     153    'SetCaretPeriod':'CaretAndSelectionStyles',
     154    'SetCaretSticky':'CaretAndSelectionStyles',
     155    'SetCaretStyle':'CaretAndSelectionStyles',
     156    'SetCaretWidth':'CaretAndSelectionStyles',
     157    'SetHotspotActiveBack':'CaretAndSelectionStyles',
     158    'SetHotspotActiveFore':'CaretAndSelectionStyles',
     159    'SetHotspotActiveUnderline':'CaretAndSelectionStyles',
     160    'SetHotspotSingleLine':'CaretAndSelectionStyles',
     161    'SetSelAlpha':'CaretAndSelectionStyles',
     162    'SetSelBack':'CaretAndSelectionStyles',
     163    'SetSelEOLFilled':'CaretAndSelectionStyles',
     164    'SetSelFore':'CaretAndSelectionStyles',
     165    'ToggleCaretSticky':'CaretAndSelectionStyles',
     166    'ClearRepresentation':'CharacterRepresentations',
     167    'GetControlCharSymbol':'CharacterRepresentations',
     168    'GetRepresentation':'CharacterRepresentations',
     169    'SetControlCharSymbol':'CharacterRepresentations',
     170    'SetRepresentation':'CharacterRepresentations',
     171    'GetCursor':'Cursor',
     172    'SetCursor':'Cursor',
     173    'CanPaste':'CutCopyAndPaste',
     174    'Clear':'CutCopyAndPaste',
     175    'Copy':'CutCopyAndPaste',
     176    'CopyAllowLine':'CutCopyAndPaste',
     177    'CopyRange':'CutCopyAndPaste',
     178    'CopyText':'CutCopyAndPaste',
     179    'Cut':'CutCopyAndPaste',
     180    'GetPasteConvertEndings':'CutCopyAndPaste',
     181    'Paste':'CutCopyAndPaste',
     182    'SetPasteConvertEndings':'CutCopyAndPaste',
     183    'GetKeysUnicode':'DeprecatedMessages',
     184    'GetStyleBits':'DeprecatedMessages',
     185    'GetStyleBitsNeeded':'DeprecatedMessages',
     186    'SetKeysUnicode':'DeprecatedMessages',
     187    'SetStyleBits':'DeprecatedMessages',
     188    'GetCharacterPointer':'DirectAccess',
     189    'GetDirectFunction':'DirectAccess',
     190    'GetDirectPointer':'DirectAccess',
     191    'GetGapPosition':'DirectAccess',
     192    'GetRangePointer':'DirectAccess',
     193    'GetStatus':'ErrorHandling',
     194    'SetStatus':'ErrorHandling',
     195    'ContractedFoldNext':'Folding',
     196    'DocLineFromVisible':'Folding',
     197    'EnsureVisible':'Folding',
     198    'EnsureVisibleEnforcePolicy':'Folding',
     199    'ExpandChildren':'Folding',
     200    'FoldAll':'Folding',
     201    'FoldChildren':'Folding',
     202    'FoldDisplayTextSetStyle':'Folding',
     203    'FoldLine':'Folding',
     204    'GetAllLinesVisible':'Folding',
     205    'GetAutomaticFold':'Folding',
     206    'GetFoldExpanded':'Folding',
     207    'GetFoldLevel':'Folding',
     208    'GetFoldParent':'Folding',
     209    'GetLastChild':'Folding',
     210    'GetLineVisible':'Folding',
     211    'HideLines':'Folding',
     212    'SetAutomaticFold':'Folding',
     213    'SetFoldExpanded':'Folding',
     214    'SetFoldFlags':'Folding',
     215    'SetFoldLevel':'Folding',
     216    'ShowLines':'Folding',
     217    'ToggleFold':'Folding',
     218    'ToggleFoldShowText':'Folding',
     219    'VisibleFromDocLine':'Folding',
     220    'GetIndicatorCurrent':'Indicators',
     221    'GetIndicatorValue':'Indicators',
     222    'IndicatorAllOnFor':'Indicators',
     223    'IndicatorClearRange':'Indicators',
     224    'IndicatorEnd':'Indicators',
     225    'IndicatorFillRange':'Indicators',
     226    'IndicatorStart':'Indicators',
     227    'IndicatorValueAt':'Indicators',
     228    'IndicGetAlpha':'Indicators',
     229    'IndicGetFlags':'Indicators',
     230    'IndicGetFore':'Indicators',
     231    'IndicGetHoverFore':'Indicators',
     232    'IndicGetHoverStyle':'Indicators',
     233    'IndicGetOutlineAlpha':'Indicators',
     234    'IndicGetStyle':'Indicators',
     235    'IndicGetUnder':'Indicators',
     236    'IndicSetAlpha':'Indicators',
     237    'IndicSetFlags':'Indicators',
     238    'IndicSetFore':'Indicators',
     239    'IndicSetHoverFore':'Indicators',
     240    'IndicSetHoverStyle':'Indicators',
     241    'IndicSetOutlineAlpha':'Indicators',
     242    'IndicSetStyle':'Indicators',
     243    'IndicSetUnder':'Indicators',
     244    'SetIndicatorCurrent':'Indicators',
     245    'SetIndicatorValue':'Indicators',
     246    'AssignCmdKey':'KeyBindings',
     247    'ClearAllCmdKeys':'KeyBindings',
     248    'ClearCmdKey':'KeyBindings',
     249    'BackTab':'KeyboardCommands',
     250    'Cancel':'KeyboardCommands',
     251    'CharLeft':'KeyboardCommands',
     252    'CharLeftExtend':'KeyboardCommands',
     253    'CharLeftRectExtend':'KeyboardCommands',
     254    'CharRight':'KeyboardCommands',
     255    'CharRightExtend':'KeyboardCommands',
     256    'CharRightRectExtend':'KeyboardCommands',
     257    'DeleteBack':'KeyboardCommands',
     258    'DeleteBackNotLine':'KeyboardCommands',
     259    'DelLineLeft':'KeyboardCommands',
     260    'DelLineRight':'KeyboardCommands',
     261    'DelWordLeft':'KeyboardCommands',
     262    'DelWordRight':'KeyboardCommands',
     263    'DelWordRightEnd':'KeyboardCommands',
     264    'DocumentEnd':'KeyboardCommands',
     265    'DocumentEndExtend':'KeyboardCommands',
     266    'DocumentStart':'KeyboardCommands',
     267    'DocumentStartExtend':'KeyboardCommands',
     268    'EditToggleOvertype':'KeyboardCommands',
     269    'FormFeed':'KeyboardCommands',
     270    'Home':'KeyboardCommands',
     271    'HomeDisplay':'KeyboardCommands',
     272    'HomeDisplayExtend':'KeyboardCommands',
     273    'HomeExtend':'KeyboardCommands',
     274    'HomeRectExtend':'KeyboardCommands',
     275    'HomeWrap':'KeyboardCommands',
     276    'HomeWrapExtend':'KeyboardCommands',
     277    'LineCopy':'KeyboardCommands',
     278    'LineCut':'KeyboardCommands',
     279    'LineDelete':'KeyboardCommands',
     280    'LineDown':'KeyboardCommands',
     281    'LineDownExtend':'KeyboardCommands',
     282    'LineDownRectExtend':'KeyboardCommands',
     283    'LineDuplicate':'KeyboardCommands',
     284    'LineEnd':'KeyboardCommands',
     285    'LineEndDisplay':'KeyboardCommands',
     286    'LineEndDisplayExtend':'KeyboardCommands',
     287    'LineEndExtend':'KeyboardCommands',
     288    'LineEndRectExtend':'KeyboardCommands',
     289    'LineEndWrap':'KeyboardCommands',
     290    'LineEndWrapExtend':'KeyboardCommands',
     291    'LineScrollDown':'KeyboardCommands',
     292    'LineScrollUp':'KeyboardCommands',
     293    'LineTranspose':'KeyboardCommands',
     294    'LineUp':'KeyboardCommands',
     295    'LineUpExtend':'KeyboardCommands',
     296    'LineUpRectExtend':'KeyboardCommands',
     297    'LowerCase':'KeyboardCommands',
     298    'NewLine':'KeyboardCommands',
     299    'PageDown':'KeyboardCommands',
     300    'PageDownExtend':'KeyboardCommands',
     301    'PageDownRectExtend':'KeyboardCommands',
     302    'PageUp':'KeyboardCommands',
     303    'PageUpExtend':'KeyboardCommands',
     304    'PageUpRectExtend':'KeyboardCommands',
     305    'ParaDown':'KeyboardCommands',
     306    'ParaDownExtend':'KeyboardCommands',
     307    'ParaUp':'KeyboardCommands',
     308    'ParaUpExtend':'KeyboardCommands',
     309    'ScrollToEnd':'KeyboardCommands',
     310    'ScrollToStart':'KeyboardCommands',
     311    'SelectionDuplicate':'KeyboardCommands',
     312    'StutteredPageDown':'KeyboardCommands',
     313    'StutteredPageDownExtend':'KeyboardCommands',
     314    'StutteredPageUp':'KeyboardCommands',
     315    'StutteredPageUpExtend':'KeyboardCommands',
     316    'Tab':'KeyboardCommands',
     317    'UpperCase':'KeyboardCommands',
     318    'VCHome':'KeyboardCommands',
     319    'VCHomeDisplay':'KeyboardCommands',
     320    'VCHomeDisplayExtend':'KeyboardCommands',
     321    'VCHomeExtend':'KeyboardCommands',
     322    'VCHomeRectExtend':'KeyboardCommands',
     323    'VCHomeWrap':'KeyboardCommands',
     324    'VCHomeWrapExtend':'KeyboardCommands',
     325    'VerticalCentreCaret':'KeyboardCommands',
     326    'WordLeft':'KeyboardCommands',
     327    'WordLeftEnd':'KeyboardCommands',
     328    'WordLeftEndExtend':'KeyboardCommands',
     329    'WordLeftExtend':'KeyboardCommands',
     330    'WordPartLeft':'KeyboardCommands',
     331    'WordPartLeftExtend':'KeyboardCommands',
     332    'WordPartRight':'KeyboardCommands',
     333    'WordPartRightExtend':'KeyboardCommands',
     334    'WordRight':'KeyboardCommands',
     335    'WordRightEnd':'KeyboardCommands',
     336    'WordRightEndExtend':'KeyboardCommands',
     337    'WordRightExtend':'KeyboardCommands',
     338    'AllocateSubStyles':'Lexer',
     339    'ChangeLexerState':'Lexer',
     340    'Colourise':'Lexer',
     341    'DescribeKeyWordSets':'Lexer',
     342    'DescribeProperty':'Lexer',
     343    'DistanceToSecondaryStyles':'Lexer',
     344    'FreeSubStyles':'Lexer',
     345    'GetLexer':'Lexer',
     346    'GetLexerLanguage':'Lexer',
     347    'GetPrimaryStyleFromStyle':'Lexer',
     348    'GetProperty':'Lexer',
     349    'GetPropertyExpanded':'Lexer',
     350    'GetPropertyInt':'Lexer',
     351    'GetStyleFromSubStyle':'Lexer',
     352    'GetSubStyleBases':'Lexer',
     353    'GetSubStylesLength':'Lexer',
     354    'GetSubStylesStart':'Lexer',
     355    'LoadLexerLibrary':'Lexer',
     356    'PrivateLexerCall':'Lexer',
     357    'PropertyNames':'Lexer',
     358    'PropertyType':'Lexer',
     359    'SetIdentifiers':'Lexer',
     360    'SetKeyWords':'Lexer',
     361    'SetLexer':'Lexer',
     362    'SetLexerLanguage':'Lexer',
     363    'SetProperty':'Lexer',
     364    'ConvertEOLs':'LineEndings',
     365    'GetEOLMode':'LineEndings',
     366    'GetLineEndTypesActive':'LineEndings',
     367    'GetLineEndTypesAllowed':'LineEndings',
     368    'GetLineEndTypesSupported':'LineEndings',
     369    'GetViewEOL':'LineEndings',
     370    'SetEOLMode':'LineEndings',
     371    'SetLineEndTypesAllowed':'LineEndings',
     372    'SetViewEOL':'LineEndings',
     373    'GetLayoutCache':'LineWrapping',
     374    'GetPositionCache':'LineWrapping',
     375    'GetWrapIndentMode':'LineWrapping',
     376    'GetWrapMode':'LineWrapping',
     377    'GetWrapStartIndent':'LineWrapping',
     378    'GetWrapVisualFlags':'LineWrapping',
     379    'GetWrapVisualFlagsLocation':'LineWrapping',
     380    'LinesJoin':'LineWrapping',
     381    'LinesSplit':'LineWrapping',
     382    'SetPositionCache':'LineWrapping',
     383    'SetWrapIndentMode':'LineWrapping',
     384    'SetWrapMode':'LineWrapping',
     385    'SetWrapStartIndent':'LineWrapping',
     386    'SetWrapVisualFlags':'LineWrapping',
     387    'SetWrapVisualFlagsLocation':'LineWrapping',
     388    'WrapCount':'LineWrapping',
     389    'GetEdgeColour':'LongLines',
     390    'GetEdgeColumn':'LongLines',
     391    'GetEdgeMode':'LongLines',
     392    'MultiEdgeAddLine':'LongLines',
     393    'MultiEdgeClearAll':'LongLines',
     394    'SetEdgeColour':'LongLines',
     395    'SetEdgeColumn':'LongLines',
     396    'SetEdgeMode':'LongLines',
     397    'StartRecord':'MacroRecording',
     398    'StopRecord':'MacroRecording',
     399    'GetMarginBackN':'Margins',
     400    'GetMarginCursorN':'Margins',
     401    'GetMarginLeft':'Margins',
     402    'GetMarginMaskN':'Margins',
     403    'GetMarginOptions':'Margins',
     404    'GetMarginRight':'Margins',
     405    'GetMargins':'Margins',
     406    'GetMarginSensitiveN':'Margins',
     407    'GetMarginTypeN':'Margins',
     408    'GetMarginWidthN':'Margins',
     409    'MarginGetStyle':'Margins',
     410    'MarginGetStyleOffset':'Margins',
     411    'MarginGetStyles':'Margins',
     412    'MarginGetText':'Margins',
     413    'MarginSetStyle':'Margins',
     414    'MarginSetStyleOffset':'Margins',
     415    'MarginSetStyles':'Margins',
     416    'MarginSetText':'Margins',
     417    'MarginTextClearAll':'Margins',
     418    'SetFoldMarginColour':'Margins',
     419    'SetFoldMarginHiColour':'Margins',
     420    'SetMarginBackN':'Margins',
     421    'SetMarginCursorN':'Margins',
     422    'SetMarginLeft':'Margins',
     423    'SetMarginMaskN':'Margins',
     424    'SetMarginOptions':'Margins',
     425    'SetMarginRight':'Margins',
     426    'SetMargins':'Margins',
     427    'SetMarginSensitiveN':'Margins',
     428    'SetMarginTypeN':'Margins',
     429    'SetMarginWidthN':'Margins',
     430    'MarkerAdd':'Markers',
     431    'MarkerAddSet':'Markers',
     432    'MarkerDefine':'Markers',
     433    'MarkerDefinePixmap':'Markers',
     434    'MarkerDefineRGBAImage':'Markers',
     435    'MarkerDelete':'Markers',
     436    'MarkerDeleteAll':'Markers',
     437    'MarkerDeleteHandle':'Markers',
     438    'MarkerEnableHighlight':'Markers',
     439    'MarkerGet':'Markers',
     440    'MarkerLineFromHandle':'Markers',
     441    'MarkerNext':'Markers',
     442    'MarkerPrevious':'Markers',
     443    'MarkerSetAlpha':'Markers',
     444    'MarkerSetBack':'Markers',
     445    'MarkerSetBackSelected':'Markers',
     446    'MarkerSetFore':'Markers',
     447    'MarkerSymbolDefined':'Markers',
     448    'RGBAImageSetHeight':'Markers',
     449    'RGBAImageSetScale':'Markers',
     450    'RGBAImageSetWidth':'Markers',
     451    'GetMouseDownCaptures':'MouseCapture',
     452    'GetMouseWheelCaptures':'MouseCapture',
     453    'SetMouseDownCaptures':'MouseCapture',
     454    'SetMouseWheelCaptures':'MouseCapture',
     455    'AddSelection':'MultipleSelectionAndVirtualSpace',
     456    'ClearSelections':'MultipleSelectionAndVirtualSpace',
     457    'DropSelectionN':'MultipleSelectionAndVirtualSpace',
     458    'GetAdditionalCaretFore':'MultipleSelectionAndVirtualSpace',
     459    'GetAdditionalCaretsBlink':'MultipleSelectionAndVirtualSpace',
     460    'GetAdditionalCaretsVisible':'MultipleSelectionAndVirtualSpace',
     461    'GetAdditionalSelAlpha':'MultipleSelectionAndVirtualSpace',
     462    'GetAdditionalSelectionTyping':'MultipleSelectionAndVirtualSpace',
     463    'GetMainSelection':'MultipleSelectionAndVirtualSpace',
     464    'GetMultiPaste':'MultipleSelectionAndVirtualSpace',
     465    'GetMultipleSelection':'MultipleSelectionAndVirtualSpace',
     466    'GetRectangularSelectionAnchor':'MultipleSelectionAndVirtualSpace',
     467    'GetRectangularSelectionAnchorVirtualSpace':'MultipleSelectionAndVirtualSpace',
     468    'GetRectangularSelectionCaret':'MultipleSelectionAndVirtualSpace',
     469    'GetRectangularSelectionCaretVirtualSpace':'MultipleSelectionAndVirtualSpace',
     470    'GetRectangularSelectionModifier':'MultipleSelectionAndVirtualSpace',
     471    'GetSelectionEmpty':'MultipleSelectionAndVirtualSpace',
     472    'GetSelectionNAnchor':'MultipleSelectionAndVirtualSpace',
     473    'GetSelectionNAnchorVirtualSpace':'MultipleSelectionAndVirtualSpace',
     474    'GetSelectionNCaret':'MultipleSelectionAndVirtualSpace',
     475    'GetSelectionNCaretVirtualSpace':'MultipleSelectionAndVirtualSpace',
     476    'GetSelectionNEnd':'MultipleSelectionAndVirtualSpace',
     477    'GetSelectionNStart':'MultipleSelectionAndVirtualSpace',
     478    'GetSelections':'MultipleSelectionAndVirtualSpace',
     479    'GetVirtualSpaceOptions':'MultipleSelectionAndVirtualSpace',
     480    'MultipleSelectAddEach':'MultipleSelectionAndVirtualSpace',
     481    'MultipleSelectAddNext':'MultipleSelectionAndVirtualSpace',
     482    'RotateSelection':'MultipleSelectionAndVirtualSpace',
     483    'SetAdditionalCaretFore':'MultipleSelectionAndVirtualSpace',
     484    'SetAdditionalCaretsBlink':'MultipleSelectionAndVirtualSpace',
     485    'SetAdditionalCaretsVisible':'MultipleSelectionAndVirtualSpace',
     486    'SetAdditionalSelAlpha':'MultipleSelectionAndVirtualSpace',
     487    'SetAdditionalSelBack':'MultipleSelectionAndVirtualSpace',
     488    'SetAdditionalSelectionTyping':'MultipleSelectionAndVirtualSpace',
     489    'SetAdditionalSelFore':'MultipleSelectionAndVirtualSpace',
     490    'SetMainSelection':'MultipleSelectionAndVirtualSpace',
     491    'SetMultiPaste':'MultipleSelectionAndVirtualSpace',
     492    'SetMultipleSelection':'MultipleSelectionAndVirtualSpace',
     493    'SetRectangularSelectionAnchor':'MultipleSelectionAndVirtualSpace',
     494    'SetRectangularSelectionAnchorVirtualSpace':'MultipleSelectionAndVirtualSpace',
     495    'SetRectangularSelectionCaret':'MultipleSelectionAndVirtualSpace',
     496    'SetRectangularSelectionCaretVirtualSpace':'MultipleSelectionAndVirtualSpace',
     497    'SetRectangularSelectionModifier':'MultipleSelectionAndVirtualSpace',
     498    'SetSelectionNAnchor':'MultipleSelectionAndVirtualSpace',
     499    'SetSelectionNAnchorVirtualSpace':'MultipleSelectionAndVirtualSpace',
     500    'SetSelectionNCaret':'MultipleSelectionAndVirtualSpace',
     501    'SetSelectionNCaretVirtualSpace':'MultipleSelectionAndVirtualSpace',
     502    'SetSelectionNEnd':'MultipleSelectionAndVirtualSpace',
     503    'SetSelectionNStart':'MultipleSelectionAndVirtualSpace',
     504    'SetVirtualSpaceOptions':'MultipleSelectionAndVirtualSpace',
     505    'SwapMainAnchorCaret':'MultipleSelectionAndVirtualSpace',
     506    'AddRefDocument':'MultipleViews',
     507    'CreateDocument':'MultipleViews',
     508    'GetDocPointer':'MultipleViews',
     509    'ReleaseDocument':'MultipleViews',
     510    'SetDocPointer':'MultipleViews',
     511    'GetIdentifier':'Notifications',
     512    'GetModEventMask':'Notifications',
     513    'GetMouseDwellTime':'Notifications',
     514    'SetIdentifier':'Notifications',
     515    'SetModEventMask':'Notifications',
     516    'SetMouseDwellTime':'Notifications',
     517    'GetBufferedDraw':'OtherSettings',
     518    'GetCodePage':'OtherSettings',
     519    'GetFocus':'OtherSettings',
     520    'GetIMEInteraction':'OtherSettings',
     521    'GetPhasesDraw':'OtherSettings',
     522    'GetTechnology':'OtherSettings',
     523    'GetTwoPhaseDraw':'OtherSettings',
     524    'SetBufferedDraw':'OtherSettings',
     525    'SetCodePage':'OtherSettings',
     526    'SetFocus':'OtherSettings',
     527    'SetIMEInteraction':'OtherSettings',
     528    'SetLayoutCache':'OtherSettings',
     529    'SetPhasesDraw':'OtherSettings',
     530    'SetTechnology':'OtherSettings',
     531    'SetTwoPhaseDraw':'OtherSettings',
     532    'GetOvertype':'Overtype',
     533    'SetOvertype':'Overtype',
     534    'UsePopUp':'PopupEditMenu',
     535    'FormatRange':'Printing',
     536    'GetPrintColourMode':'Printing',
     537    'GetPrintMagnification':'Printing',
     538    'GetPrintWrapMode':'Printing',
     539    'SetPrintColourMode':'Printing',
     540    'SetPrintMagnification':'Printing',
     541    'SetPrintWrapMode':'Printing',
     542    'GetEndAtLastLine':'ScrollingAndAutomaticScrolling',
     543    'GetFirstVisibleLine':'ScrollingAndAutomaticScrolling',
     544    'GetHScrollBar':'ScrollingAndAutomaticScrolling',
     545    'GetScrollWidth':'ScrollingAndAutomaticScrolling',
     546    'GetScrollWidthTracking':'ScrollingAndAutomaticScrolling',
     547    'GetVScrollBar':'ScrollingAndAutomaticScrolling',
     548    'GetXOffset':'ScrollingAndAutomaticScrolling',
     549    'LineScroll':'ScrollingAndAutomaticScrolling',
     550    'ScrollCaret':'ScrollingAndAutomaticScrolling',
     551    'ScrollRange':'ScrollingAndAutomaticScrolling',
     552    'SetEndAtLastLine':'ScrollingAndAutomaticScrolling',
     553    'SetFirstVisibleLine':'ScrollingAndAutomaticScrolling',
     554    'SetHScrollBar':'ScrollingAndAutomaticScrolling',
     555    'SetScrollWidth':'ScrollingAndAutomaticScrolling',
     556    'SetScrollWidthTracking':'ScrollingAndAutomaticScrolling',
     557    'SetVisiblePolicy':'ScrollingAndAutomaticScrolling',
     558    'SetVScrollBar':'ScrollingAndAutomaticScrolling',
     559    'SetXCaretPolicy':'ScrollingAndAutomaticScrolling',
     560    'SetXOffset':'ScrollingAndAutomaticScrolling',
     561    'SetYCaretPolicy':'ScrollingAndAutomaticScrolling',
     562    'FindText':'Searching',
     563    'GetSearchFlags':'Searching',
     564    'GetTag':'Searching',
     565    'GetTargetEnd':'Searching',
     566    'GetTargetStart':'Searching',
     567    'GetTargetText':'Searching',
     568    'ReplaceTarget':'Searching',
     569    'ReplaceTargetRE':'Searching',
     570    'SearchAnchor':'Searching',
     571    'SearchInTarget':'Searching',
     572    'SearchNext':'Searching',
     573    'SearchPrev':'Searching',
     574    'SetSearchFlags':'Searching',
     575    'SetTargetEnd':'Searching',
     576    'SetTargetRange':'Searching',
     577    'SetTargetStart':'Searching',
     578    'TargetFromSelection':'Searching',
     579    'TargetWholeDocument':'Searching',
     580    'CharPositionFromPoint':'SelectionAndInformation',
     581    'CharPositionFromPointClose':'SelectionAndInformation',
     582    'ChooseCaretX':'SelectionAndInformation',
     583    'CountCharacters':'SelectionAndInformation',
     584    'FindColumn':'SelectionAndInformation',
     585    'GetAnchor':'SelectionAndInformation',
     586    'GetColumn':'SelectionAndInformation',
     587    'GetCurLine':'SelectionAndInformation',
     588    'GetCurrentPos':'SelectionAndInformation',
     589    'GetLength':'SelectionAndInformation',
     590    'GetLineCount':'SelectionAndInformation',
     591    'GetLineEndPosition':'SelectionAndInformation',
     592    'GetLineSelEndPosition':'SelectionAndInformation',
     593    'GetLineSelStartPosition':'SelectionAndInformation',
     594    'GetModify':'SelectionAndInformation',
     595    'GetMouseSelectionRectangularSwitch':'SelectionAndInformation',
     596    'GetSelectionEnd':'SelectionAndInformation',
     597    'GetSelectionMode':'SelectionAndInformation',
     598    'GetSelectionStart':'SelectionAndInformation',
     599    'GetSelText':'SelectionAndInformation',
     600    'GetTextLength':'SelectionAndInformation',
     601    'GotoLine':'SelectionAndInformation',
     602    'GotoPos':'SelectionAndInformation',
     603    'HideSelection':'SelectionAndInformation',
     604    'LineFromPosition':'SelectionAndInformation',
     605    'LineLength':'SelectionAndInformation',
     606    'LinesOnScreen':'SelectionAndInformation',
     607    'MoveCaretInsideView':'SelectionAndInformation',
     608    'MoveSelectedLinesDown':'SelectionAndInformation',
     609    'MoveSelectedLinesUp':'SelectionAndInformation',
     610    'PointXFromPosition':'SelectionAndInformation',
     611    'PositionAfter':'SelectionAndInformation',
     612    'PositionBefore':'SelectionAndInformation',
     613    'PositionFromLine':'SelectionAndInformation',
     614    'PositionFromPoint':'SelectionAndInformation',
     615    'PositionFromPointClose':'SelectionAndInformation',
     616    'PositionRelative':'SelectionAndInformation',
     617    'SelectAll':'SelectionAndInformation',
     618    'SelectionIsRectangle':'SelectionAndInformation',
     619    'SetAnchor':'SelectionAndInformation',
     620    'SetCurrentPos':'SelectionAndInformation',
     621    'SetEmptySelection':'SelectionAndInformation',
     622    'SetMouseSelectionRectangularSwitch':'SelectionAndInformation',
     623    'SetSelectionEnd':'SelectionAndInformation',
     624    'SetSelectionMode':'SelectionAndInformation',
     625    'SetSelectionStart':'SelectionAndInformation',
     626    'TextHeight':'SelectionAndInformation',
     627    'TextWidth':'SelectionAndInformation',
     628    'StyleClearAll':'StyleDefinition',
     629    'StyleGetBack':'StyleDefinition',
     630    'StyleGetBold':'StyleDefinition',
     631    'StyleGetCase':'StyleDefinition',
     632    'StyleGetChangeable':'StyleDefinition',
     633    'StyleGetCharacterSet':'StyleDefinition',
     634    'StyleGetEOLFilled':'StyleDefinition',
     635    'StyleGetFont':'StyleDefinition',
     636    'StyleGetFore':'StyleDefinition',
     637    'StyleGetHotSpot':'StyleDefinition',
     638    'StyleGetItalic':'StyleDefinition',
     639    'StyleGetSize':'StyleDefinition',
     640    'StyleGetSizeFractional':'StyleDefinition',
     641    'StyleGetUnderline':'StyleDefinition',
     642    'StyleGetVisible':'StyleDefinition',
     643    'StyleGetWeight':'StyleDefinition',
     644    'StyleResetDefault':'StyleDefinition',
     645    'StyleSetBack':'StyleDefinition',
     646    'StyleSetBold':'StyleDefinition',
     647    'StyleSetCase':'StyleDefinition',
     648    'StyleSetChangeable':'StyleDefinition',
     649    'StyleSetCharacterSet':'StyleDefinition',
     650    'StyleSetEOLFilled':'StyleDefinition',
     651    'StyleSetFont':'StyleDefinition',
     652    'StyleSetFore':'StyleDefinition',
     653    'StyleSetHotSpot':'StyleDefinition',
     654    'StyleSetItalic':'StyleDefinition',
     655    'StyleSetSize':'StyleDefinition',
     656    'StyleSetSizeFractional':'StyleDefinition',
     657    'StyleSetUnderline':'StyleDefinition',
     658    'StyleSetVisible':'StyleDefinition',
     659    'StyleSetWeight':'StyleDefinition',
     660    'GetEndStyled':'Styling',
     661    'GetIdleStyling':'Styling',
     662    'GetLineState':'Styling',
     663    'GetMaxLineState':'Styling',
     664    'SetIdleStyling':'Styling',
     665    'SetLineState':'Styling',
     666    'SetStyling':'Styling',
     667    'SetStylingEx':'Styling',
     668    'StartStyling':'Styling',
     669    'AddTabStop':'TabsAndIndentationGuides',
     670    'ClearTabStops':'TabsAndIndentationGuides',
     671    'GetBackSpaceUnIndents':'TabsAndIndentationGuides',
     672    'GetHighlightGuide':'TabsAndIndentationGuides',
     673    'GetIndent':'TabsAndIndentationGuides',
     674    'GetIndentationGuides':'TabsAndIndentationGuides',
     675    'GetLineIndentation':'TabsAndIndentationGuides',
     676    'GetLineIndentPosition':'TabsAndIndentationGuides',
     677    'GetNextTabStop':'TabsAndIndentationGuides',
     678    'GetTabIndents':'TabsAndIndentationGuides',
     679    'GetTabWidth':'TabsAndIndentationGuides',
     680    'GetUseTabs':'TabsAndIndentationGuides',
     681    'SetBackSpaceUnIndents':'TabsAndIndentationGuides',
     682    'SetHighlightGuide':'TabsAndIndentationGuides',
     683    'SetIndent':'TabsAndIndentationGuides',
     684    'SetIndentationGuides':'TabsAndIndentationGuides',
     685    'SetLineIndentation':'TabsAndIndentationGuides',
     686    'SetTabIndents':'TabsAndIndentationGuides',
     687    'SetTabWidth':'TabsAndIndentationGuides',
     688    'SetUseTabs':'TabsAndIndentationGuides',
     689    'AddStyledText':'TextRetrievalAndModification',
     690    'AddText':'TextRetrievalAndModification',
     691    'Allocate':'TextRetrievalAndModification',
     692    'AllocateExtendedStyles':'TextRetrievalAndModification',
     693    'AppendText':'TextRetrievalAndModification',
     694    'ChangeInsertion':'TextRetrievalAndModification',
     695    'ClearAll':'TextRetrievalAndModification',
     696    'ClearDocumentStyle':'TextRetrievalAndModification',
     697    'DeleteRange':'TextRetrievalAndModification',
     698    'GetCharAt':'TextRetrievalAndModification',
     699    'GetLine':'TextRetrievalAndModification',
     700    'GetReadOnly':'TextRetrievalAndModification',
     701    'GetStyleAt':'TextRetrievalAndModification',
     702    'GetStyledText':'TextRetrievalAndModification',
     703    'GetText':'TextRetrievalAndModification',
     704    'GetTextRange':'TextRetrievalAndModification',
     705    'InsertText':'TextRetrievalAndModification',
     706    'ReleaseAllExtendedStyles':'TextRetrievalAndModification',
     707    'ReplaceSel':'TextRetrievalAndModification',
     708    'SetReadOnly':'TextRetrievalAndModification',
     709    'SetSavePoint':'TextRetrievalAndModification',
     710    'SetText':'TextRetrievalAndModification',
     711    'AddUndoAction':'UndoAndRedo',
     712    'BeginUndoAction':'UndoAndRedo',
     713    'CanRedo':'UndoAndRedo',
     714    'CanUndo':'UndoAndRedo',
     715    'EmptyUndoBuffer':'UndoAndRedo',
     716    'EndUndoAction':'UndoAndRedo',
     717    'GetUndoCollection':'UndoAndRedo',
     718    'Redo':'UndoAndRedo',
     719    'SetUndoCollection':'UndoAndRedo',
     720    'Undo':'UndoAndRedo',
     721    'UserListShow':'UserLists',
     722    'GetExtraAscent':'WhiteSpace',
     723    'GetExtraDescent':'WhiteSpace',
     724    'GetTabDrawMode':'WhiteSpace',
     725    'GetViewWS':'WhiteSpace',
     726    'GetWhitespaceSize':'WhiteSpace',
     727    'SetExtraAscent':'WhiteSpace',
     728    'SetExtraDescent':'WhiteSpace',
     729    'SetTabDrawMode':'WhiteSpace',
     730    'SetViewWS':'WhiteSpace',
     731    'SetWhitespaceBack':'WhiteSpace',
     732    'SetWhitespaceFore':'WhiteSpace',
     733    'SetWhitespaceSize':'WhiteSpace',
     734    'GetPunctuationChars':'Words',
     735    'GetWhitespaceChars':'Words',
     736    'GetWordChars':'Words',
     737    'IsRangeWord':'Words',
     738    'SetCharsDefault':'Words',
     739    'SetPunctuationChars':'Words',
     740    'SetWhitespaceChars':'Words',
     741    'SetWordChars':'Words',
     742    'WordEndPosition':'Words',
     743    'WordStartPosition':'Words',
     744    'GetZoom':'Zooming',
     745    'SetZoom':'Zooming',
     746    'ZoomIn':'Zooming',
     747    'ZoomOut':'Zooming'
     748}
     749
     750
     751# A few of docstrings in Scintilla.iface are unsuitable for use with wxSTC.
     752# This map can be used to supply alternate docstrings for those items.
     753docOverrides = {
     754    'ClearRegisteredImages':('Clear all the registered images.',),
     755    'RegisterImage':('Register an image for use in autocompletion lists.',),
     756
     757    'MarkerDefine':
     758        ('Set the symbol used for a particular marker number,',
     759        'and optionally the fore and background colours.',),
     760
     761    'MarkerDefinePixmap':('Define a marker from a bitmap',),
     762
     763    'SetCodePage':
     764        ('Set the code page used to interpret the bytes of the document as characters.',),
     765
     766    'GetXOffset':('Get the xOffset (ie, horizontal scroll position).',),
     767    'SetXOffset':('Set the xOffset (ie, horizontal scroll position).',),
     768    'GetSelText':('Retrieve the selected text.',),
     769
     770    'PointXFromPosition':
     771        ('Retrieve the point in the window where a position is displayed.',),
     772
     773    'StyleGetFont':('Get the font facename of a style',),
     774    'GetLine':('Retrieve the contents of a line.',),
     775    'GetStyledText':('Retrieve a buffer of cells.',),
     776    'GetText':('Retrieve all the text in the document.',),
     777    'GetTextRange':('Retrieve a range of text.',),
     778
     779    'GetWordChars':
     780        ('Get the set of characters making up words for when moving or selecting by word.',),
     781
     782    'GetLexerLanguage':('Retrieve the lexing language of the document.',)
     783}
     784
     785
     786# This map can be used to change a few words in a docstring to make it
     787# consistent with names used by wxSTC.
     788#
     789# For example {'INVALID_POSITION':'wxSTC_INVALID_POSITION'} will turn the
     790# string 'Return INVALID_POSITION if not close to text.'
     791# into 'Return wxSTC_INVALID_POSITION if not close to text.'
     792#
     793docSubstitutions = {
     794    'BraceMatch':{'INVALID_POSITION':'wxSTC_INVALID_POSITION'},
     795    'GetLineSelEndPosition':{'INVALID_POSITION':'wxSTC_INVALID_POSITION'},
     796    'GetLineSelStartPosition':{'INVALID_POSITION':'wxSTC_INVALID_POSITION'},
     797    'PositionFromPointClose':{'INVALID_POSITION':'wxSTC_INVALID_POSITION'},
     798    'CharPositionFromPointClose':{'INVALID_POSITION':'wxSTC_INVALID_POSITION'},
     799
     800    'GetRepresentation':{'Result is NUL-terminated.':''},
     801    'GetSubStyleBases':{'Result is NUL-terminated.':''},
     802    'DescribeProperty':{'Result is NUL-terminated.':''},
     803    'GetProperty':{'Result is NUL-terminated.':''},
     804    'GetPropertyExpanded':{'Result is NUL-terminated.':''},
     805    'GetTag':{'Result is NUL-terminated.':''},
     806    'TextWidth':{'NUL terminated text argument.':''},
     807    'GetCurLine':{'Result is NUL-terminated.':'',
     808        'Returns the index of the caret on the line.':''},
     809
     810    'DescribeKeyWordSets':{'\\n':'\\\\n','Result is NUL-terminated.':''},
     811    'PropertyNames':{'\\n':'\\\\n','Result is NUL-terminated.':''},
     812    'ReplaceTargetRE':{'\\d':'\\\\d','\\(':'\\\\(','\\)':'\\\\)'},
     813
     814    'CallTipUseStyle':{'STYLE_CALLTIP':'wxSTC_STYLE_CALLTIP'},
     815    'ChangeInsertion':{'SC_MOD_INSERTCHECK':'wxSTC_MOD_INSERTCHECK'},
     816    'GetWrapIndentMode':{'Default is fixed':'Default is wxSTC_WRAPINDENT_FIXED'},
     817    'GetTabDrawMode':{'SCTD_*':'wxSTC_TD_*'},
     818    'GetViewWS':{'SCWS_*':'wxSTC_WS_*'},
     819    'SetCursor':{'SC_CURSOR':'wxSTC_CURSOR'},
     820    'SetMarginBackN':{'SC_MARGIN_COLOUR':'wxSTC_MARGIN_COLOUR'},
     821    'SetWrapIndentMode':{'Default is fixed':'Default is wxSTC_WRAPINDENT_FIXED'},
     822
     823    'GetEOLMode':
     824        {'CRLF, CR, or LF':'wxSTC_EOL_CRLF, wxSTC_EOL_CR, or wxSTC_EOL_LF'},
     825
     826    'SetEdgeMode':{'EDGE_LINE':'wxSTC_EDGE_LINE',
     827        'EDGE_MULTILINE':'wxSTC_EDGE_MULTILINE',
     828        'EDGE_BACKGROUND':'wxSTC_EDGE_BACKGROUND','EDGE_NONE':'wxSTC_EDGE_NONE'},
     829
     830    'SetPrintWrapMode':
     831        {'SC_WRAP_WORD':'wxSTC_WRAP_WORD','SC_WRAP_NONE':'wxSTC_WRAP_NONE'},
     832
     833    'SetRectangularSelectionModifier':{'SCMOD_CTRL':'wxSTC_KEYMOD_CTRL ',
     834        'SCMOD_ALT':'wxSTC_KEYMOD_ALT','SCMOD_SUPER':'wxSTC_KEYMOD_SUPER'},
     835
     836    'SetSelectionMode':{'SC_SEL_STREAM':'wxSTC_SEL_STREAM',
     837        'SC_SEL_RECTANGLE':'wxSTC_SEL_RECTANGLE','SC_SEL_THIN':'wxSTC_SEL_THIN',
     838        'SC_SEL_LINES':'wxSTC_SEL_LINES'}
     839}
     840
     841
     842# This map can be used to add extended documentation to the interface header.
     843extendedDocs = {
     844
     845    'GetSearchFlags':
     846        ('The return value will be a bit list containing one or more of the',
     847        '@link wxStyledTextCtrl::wxSTC_FIND_WHOLEWORD wxSTC_FIND_* @endlink constants.',),
     848
     849    'SetSearchFlags':
     850        ('The input should be a bit list containing one or more of the',
     851        '@link wxStyledTextCtrl::wxSTC_FIND_WHOLEWORD wxSTC_FIND_* @endlink constants.',),
     852
     853    'GetStatus':
     854        ('The return value will be one of the',
     855        '@link wxStyledTextCtrl::wxSTC_STATUS_OK wxSTC_STATUS_* @endlink constants.',),
     856
     857    'SetStatus':
     858        ('The input should be one of the',
     859        '@link wxStyledTextCtrl::wxSTC_STATUS_OK wxSTC_STATUS_* @endlink constants.',),
     860
     861    'GetSelectionMode':
     862        ('The return value will be one of the',
     863        '@link wxStyledTextCtrl::wxSTC_SEL_STREAM wxSTC_SEL_* @endlink constants.',),
     864
     865    'GetMultiPaste':
     866        ('The return value will be one of the',
     867        '@link wxStyledTextCtrl::wxSTC_MULTIPASTE_ONCE wxSTC_MULTIPASTE_* '
     868        '@endlink constants.',),
     869
     870    'SetMultiPaste':
     871        ('The input should be one of the',
     872        '@link wxStyledTextCtrl::wxSTC_MULTIPASTE_ONCE wxSTC_MULTIPASTE_* '
     873        '@endlink constants.',),
     874
     875    'GetVirtualSpaceOptions':
     876        ('The return value will be one of the',
     877        '@link wxStyledTextCtrl::wxSTC_VS_NONE wxSTC_VS_* @endlink constants.',),
     878
     879    'SetVirtualSpaceOptions':
     880        ('The input should be one of the',
     881        '@link wxStyledTextCtrl::wxSTC_VS_NONE wxSTC_VS_* @endlink constants.',),
     882
     883    'GetRectangularSelectionModifier':
     884        ('The return value will be a bit list containing one or more of the',
     885        '@link wxStyledTextCtrl::wxSTC_KEYMOD_NORM wxSTC_KEYMOD_* @endlink constants.',),
     886
     887    'SetXCaretPolicy':
     888        ('The first argument should be a bit list containing one or more of the',
     889        '@link wxStyledTextCtrl::wxSTC_CARET_SLOP wxSTC_CARET_* @endlink constants.',),
     890
     891    'SetYCaretPolicy':
     892        ('The first argument should be a bit list containing one or more of the',
     893        '@link wxStyledTextCtrl::wxSTC_CARET_SLOP wxSTC_CARET_* @endlink constants.',),
     894
     895    'SetVisiblePolicy':
     896        ('The first argument should be a bit list containing one or more of the',
     897        '@link wxStyledTextCtrl::wxSTC_VISIBLE_SLOP wxSTC_VISIBLE_* @endlink constants.',),
     898
     899    'SetViewWS':
     900        ('The input should be one of the',
     901        '@link wxStyledTextCtrl::wxSTC_WS_INVISIBLE wxSTC_WS_* @endlink  constants.',),
     902
     903    'SetTabDrawMode':
     904        ('The input should be one of the',
     905        '@link wxStyledTextCtrl::wxSTC_TD_LONGARROW wxSTC_TD_* @endlink constants.',),
     906
     907    'GetCursor':
     908        ('The return value will be one of the',
     909        '@link wxStyledTextCtrl::wxSTC_CURSORNORMAL wxSTC_CURSOR* @endlink constants.',),
     910
     911    'SetEOLMode':
     912        ('The input should be one of the',
     913        '@link wxStyledTextCtrl::wxSTC_EOL_CRLF wxSTC_EOL_* @endlink  constants.',),
     914
     915    'GetLineEndTypesActive':
     916        ('The return value will be one of the',
     917        '@link wxStyledTextCtrl::wxSTC_LINE_END_TYPE_DEFAULT wxSTC_LINE_END_TYPE_* '
     918        '@endlink constants.',),
     919
     920    'GetLineEndTypesAllowed':
     921        ('The return value will be one of the',
     922        '@link wxStyledTextCtrl::wxSTC_LINE_END_TYPE_DEFAULT wxSTC_LINE_END_TYPE_* '
     923        '@endlink constants.',),
     924
     925    'SetLineEndTypesAllowed':
     926        ('The input should be one of the',
     927        '@link wxStyledTextCtrl::wxSTC_LINE_END_TYPE_DEFAULT '
     928        'wxSTC_LINE_END_TYPE_* @endlink constants.',),
     929
     930   'GetLineEndTypesSupported':
     931        ('The return value will be a bit list containing one or more of the',
     932        '@link wxStyledTextCtrl::wxSTC_LINE_END_TYPE_DEFAULT '
     933        'wxSTC_LINE_END_TYPE_* @endlink constants.',),
     934
     935    'GetIdleStyling':
     936        ('The return value will be one of the',
     937        '@link wxStyledTextCtrl::wxSTC_IDLESTYLING_NONE wxSTC_IDLESTYLING_* '
     938        '@endlink constants.',),
     939
     940    'SetIdleStyling':
     941        ('The input should be one of the',
     942        '@link wxStyledTextCtrl::wxSTC_IDLESTYLING_NONE wxSTC_IDLESTYLING_* '
     943        '@endlink constants.',),
     944
     945    'StyleGetWeight':
     946        ('The return value will be an integer that is possibly one of the',
     947        '@link wxStyledTextCtrl::wxSTC_WEIGHT_NORMAL wxSTC_WEIGHT_* @endlink constants.',),
     948
     949    'StyleSetWeight':
     950        ('The second argument can be an integer or one of the',
     951        '@link wxStyledTextCtrl::wxSTC_WEIGHT_NORMAL wxSTC_WEIGHT_* @endlink constants.',),
     952
     953    'StyleGetCase':
     954        ('The return value will be one of the',
     955        '@link wxStyledTextCtrl::wxSTC_CASE_MIXED wxSTC_CASE_* @endlink constants.',),
     956
     957    'StyleSetCase':
     958        ('The second argument should be one of the',
     959        '@link wxStyledTextCtrl::wxSTC_CASE_MIXED wxSTC_CASE_* @endlink constants.',),
     960
     961    'GetCaretStyle':
     962        ('The return value will be one of the',
     963        '@link wxStyledTextCtrl::wxSTC_CARETSTYLE_INVISIBLE wxSTC_CARETSTYLE_* '
     964        '@endlink constants.',),
     965
     966    'SetCaretStyle':
     967        ('The input should be one of the',
     968        '@link wxStyledTextCtrl::wxSTC_CARETSTYLE_INVISIBLE wxSTC_CARETSTYLE_* '
     969        '@endlink constants.',),
     970
     971    'GetCaretSticky':
     972        ('The return value will be one of the',
     973        '@link wxStyledTextCtrl::wxSTC_CARETSTICKY_OFF wxSTC_CARETSTICKY_* '
     974        '@endlink constants.',),
     975
     976    'SetCaretSticky':
     977        ('The input should be one of the',
     978        '@link wxStyledTextCtrl::wxSTC_CARETSTICKY_OFF wxSTC_CARETSTICKY_* '
     979        '@endlink constants.',),
     980
     981    'GetMarginTypeN':
     982        ('The return value will be one of the',
     983        '@link wxStyledTextCtrl::wxSTC_MARGIN_SYMBOL wxSTC_MARGIN_* @endlink constants.',),
     984
     985    'SetMarginTypeN':
     986        ('The second argument should be one of the',
     987        '@link wxStyledTextCtrl::wxSTC_MARGIN_SYMBOL wxSTC_MARGIN_* @endlink constants.',),
     988
     989    'GetMarginCursorN':
     990        ('The return value will be one of the',
     991        '@link wxStyledTextCtrl::wxSTC_CURSORNORMAL wxSTC_CURSOR* @endlink constants.',),
     992
     993    'SetMarginCursorN':
     994        ('The second argument should be one of the',
     995        '@link wxStyledTextCtrl::wxSTC_CURSORNORMAL wxSTC_CURSOR* @endlink constants.',),
     996
     997    'GetMarginOptions':
     998        ('The return value will be one of the',
     999        '@link wxStyledTextCtrl::wxSTC_MARGINOPTION_NONE wxSTC_MARGINOPTION_* '
     1000        '@endlink constants.',),
     1001
     1002    'SetMarginOptions':
     1003        ('The input should be one of the',
     1004        '@link wxStyledTextCtrl::wxSTC_MARGINOPTION_NONE wxSTC_MARGINOPTION_* '
     1005        '@endlink constants.',),
     1006
     1007    'AnnotationGetVisible':
     1008        ('The return value will be one of the',
     1009        '@link wxStyledTextCtrl::wxSTC_ANNOTATION_HIDDEN wxSTC_ANNOTATION_* '
     1010        '@endlink constants.',),
     1011
     1012    'AnnotationSetVisible':
     1013        ('The input should be one of the',
     1014        '@link wxStyledTextCtrl::wxSTC_ANNOTATION_HIDDEN wxSTC_ANNOTATION_* '
     1015        '@endlink constants.',),
     1016
     1017    'GetPhasesDraw':
     1018        ('The return value will be one of the',
     1019        '@link wxStyledTextCtrl::wxSTC_PHASES_ONE wxSTC_PHASES_* @endlink constants.',),
     1020
     1021    'SetPhasesDraw':
     1022        ('The input should be one of the',
     1023        '@link wxStyledTextCtrl::wxSTC_PHASES_ONE wxSTC_PHASES_* @endlink constants.',),
     1024
     1025    'GetTechnology':
     1026        ('The return value will be one of the',
     1027        '@link wxStyledTextCtrl::wxSTC_TECHNOLOGY_DEFAULT wxSTC_TECHNOLOGY_* '
     1028        '@endlink constants.',),
     1029
     1030    'SetTechnology':
     1031        ('The input should be one of the',
     1032        '@link wxStyledTextCtrl::wxSTC_TECHNOLOGY_DEFAULT wxSTC_TECHNOLOGY_* '
     1033        '@endlink constants.',),
     1034
     1035    'GetIMEInteraction':
     1036        ('The return value will be one of the',
     1037        '@link wxStyledTextCtrl::wxSTC_IME_WINDOWED wxSTC_IME_* @endlink constants.',),
     1038
     1039    'SetIMEInteraction':
     1040        ('The input should be one of the',
     1041        '@link wxStyledTextCtrl::wxSTC_IME_WINDOWED wxSTC_IME_* @endlink constants.',),
     1042
     1043    'GetIndentationGuides':
     1044        ('The return value will be one of the',
     1045        '@link wxStyledTextCtrl::wxSTC_IV_NONE wxSTC_IV_* @endlink constants.',),
     1046
     1047    'SetIndentationGuides':
     1048        ('The input should be one of the',
     1049        '@link wxStyledTextCtrl::wxSTC_IV_NONE wxSTC_IV_* @endlink constants.',),
     1050
     1051    'MarkerSymbolDefined':
     1052        ('The return value will be one of the',
     1053        '@link wxStyledTextCtrl::wxSTC_MARK_CIRCLE wxSTC_MARK_* @endlink constants.',),
     1054
     1055    'MarkerDefine':
     1056        ('The second argument should be one of the',
     1057        '@link wxStyledTextCtrl::wxSTC_MARK_CIRCLE wxSTC_MARK_* @endlink constants.',),
     1058
     1059    'IndicGetStyle':
     1060        ('The return value will be one of the',
     1061        '@link wxStyledTextCtrl::wxSTC_INDIC_PLAIN wxSTC_INDIC_* @endlink constants.',),
     1062
     1063    'IndicSetStyle':
     1064        ('The second argument should be one of the',
     1065        '@link wxStyledTextCtrl::wxSTC_INDIC_PLAIN wxSTC_INDIC_* @endlink constants.',),
     1066
     1067    'IndicGetFlags':
     1068        ('The return value will be a bit list containing one or more of the',
     1069        '@link wxStyledTextCtrl::wxSTC_INDICFLAG_VALUEFORE wxSTC_INDICFLAG_* '
     1070        '@endlink constants.',),
     1071
     1072    'IndicSetFlags':
     1073        ('The second argument should be a bit list containing one or more of the',
     1074        '@link wxStyledTextCtrl::wxSTC_INDICFLAG_VALUEFORE wxSTC_INDICFLAG_* '
     1075        '@endlink constants.',),
     1076
     1077    'AutoCGetCaseInsensitiveBehaviour':
     1078        ('The return value will be one of the',
     1079        '@link wxStyledTextCtrl::wxSTC_CASEINSENSITIVEBEHAVIOUR_RESPECTCASE '
     1080        'wxSTC_CASEINSENSITIVEBEHAVIOUR_* @endlink constants.',),
     1081
     1082    'AutoCSetCaseInsensitiveBehaviour':
     1083        ('The input should be one of the',
     1084        '@link wxStyledTextCtrl::wxSTC_CASEINSENSITIVEBEHAVIOUR_RESPECTCASE '
     1085        'wxSTC_CASEINSENSITIVEBEHAVIOUR_* @endlink constants.',),
     1086
     1087    'AutoCGetMulti':
     1088        ('The return value will be one of the',
     1089        '@link wxStyledTextCtrl::wxSTC_MULTIAUTOC_ONCE wxSTC_MULTIAUTOC_* '
     1090        '@endlink constants.',),
     1091
     1092    'AutoCSetMulti':
     1093        ('The input should be one of the',
     1094        '@link wxStyledTextCtrl::wxSTC_MULTIAUTOC_ONCE wxSTC_MULTIAUTOC_* '
     1095        '@endlink constants.',),
     1096
     1097    'AutoCGetOrder':
     1098        ('The return value will be one of the',
     1099        '@link wxStyledTextCtrl::wxSTC_ORDER_PRESORTED wxSTC_ORDER_* @endlink constants.',),
     1100
     1101    'AutoCSetOrder':
     1102        ('The input should be one of the',
     1103        '@link wxStyledTextCtrl::wxSTC_ORDER_PRESORTED wxSTC_ORDER_* @endlink constants.',),
     1104
     1105    'GetPrintColourMode':
     1106        ('The return value will be one of the',
     1107        '@link wxStyledTextCtrl::wxSTC_PRINT_NORMAL wxSTC_PRINT_* @endlink constants.',),
     1108
     1109    'SetPrintColourMode':
     1110        ('The input should be one of the',
     1111        '@link wxStyledTextCtrl::wxSTC_PRINT_NORMAL wxSTC_PRINT_* @endlink constants.',),
     1112
     1113    'GetPrintWrapMode':
     1114        ('The return value will be one of the',
     1115        '@link wxStyledTextCtrl::wxSTC_WRAP_NONE wxSTC_WRAP_* @endlink constants.',),
     1116
     1117    'SetFoldFlags':
     1118        ('The second argument should be a bit list containing one or more of the',
     1119        '@link wxStyledTextCtrl::wxSTC_FOLDFLAG_LINEBEFORE_EXPANDED '
     1120        'wxSTC_FOLDFLAG_* @endlink constants.',),
     1121
     1122    'GetAutomaticFold':
     1123        ('The return value will be a bit list containing one or more of the',
     1124        '@link wxStyledTextCtrl::wxSTC_AUTOMATICFOLD_SHOW '
     1125        'wxSTC_AUTOMATICFOLD_* @endlink constants.',),
     1126
     1127    'SetAutomaticFold':
     1128        ('The input should be a bit list containing one or more of the',
     1129        '@link wxStyledTextCtrl::wxSTC_AUTOMATICFOLD_SHOW '
     1130        'wxSTC_AUTOMATICFOLD_* @endlink constants.',),
     1131
     1132    'FoldDisplayTextSetStyle':
     1133        ('The input should be one of the',
     1134        '@link wxStyledTextCtrl::wxSTC_FOLDDISPLAYTEXT_HIDDEN '
     1135        'wxSTC_FOLDDISPLAYTEXT_* @endlink constants.',),
     1136
     1137    'GetWrapMode':
     1138        ('The return value will be one of the',
     1139        '@link wxStyledTextCtrl::wxSTC_WRAP_NONE wxSTC_WRAP_* @endlink constants.',),
     1140
     1141    'SetWrapMode':
     1142        ('The input should be one of the',
     1143        '@link wxStyledTextCtrl::wxSTC_WRAP_NONE wxSTC_WRAP_* @endlink constants.',),
     1144
     1145    'GetWrapVisualFlags':
     1146        ('The return value will be a bit list containing one or more of the',
     1147        '@link wxStyledTextCtrl::wxSTC_WRAPVISUALFLAG_NONE '
     1148        'wxSTC_WRAPVISUALFLAG_* @endlink constants.',),
     1149
     1150    'SetWrapVisualFlags':
     1151        ('The input should be a bit list containing one or more of the',
     1152        '@link wxStyledTextCtrl::wxSTC_WRAPVISUALFLAG_NONE '
     1153        'wxSTC_WRAPVISUALFLAG_* @endlink constants.',),
     1154
     1155    'GetWrapVisualFlagsLocation':
     1156        ('The return value will be a bit list containing one or more of the',
     1157        '@link wxStyledTextCtrl::wxSTC_WRAPVISUALFLAGLOC_DEFAULT '
     1158        'wxSTC_WRAPVISUALFLAGLOC_* @endlink constants.',),
     1159
     1160    'SetWrapVisualFlagsLocation':
     1161        ('The input should be a bit list containing one or more of the',
     1162        '@link wxStyledTextCtrl::wxSTC_WRAPVISUALFLAGLOC_DEFAULT '
     1163        'wxSTC_WRAPVISUALFLAGLOC_* @endlink constants.',),
     1164
     1165    'GetWrapIndentMode':
     1166        ('The return value will be one of the',
     1167        '@link wxStyledTextCtrl::wxSTC_WRAPINDENT_FIXED wxSTC_WRAPINDENT_* '
     1168        '@endlink constants.',),
     1169
     1170    'SetWrapIndentMode':
     1171        ('The input should be one of the',
     1172        '@link wxStyledTextCtrl::wxSTC_WRAPINDENT_FIXED wxSTC_WRAPINDENT_* '
     1173        '@endlink constants.',),
     1174
     1175    'GetLayoutCache':
     1176        ('The return value will be one of the',
     1177        '@link wxStyledTextCtrl::wxSTC_CACHE_NONE wxSTC_CACHE_* @endlink constants.',),
     1178
     1179    'SetLayoutCache':
     1180        ('The input should be one of the',
     1181        '@link wxStyledTextCtrl::wxSTC_CACHE_NONE wxSTC_CACHE_* @endlink constants.',),
     1182
     1183    'GetEdgeMode':
     1184        ('The return value will be one of the',
     1185        '@link wxStyledTextCtrl::wxSTC_EDGE_NONE wxSTC_EDGE_* @endlink constants.',),
     1186
     1187    'SetEdgeMode':
     1188        ('The input should be one of the',
     1189        '@link wxStyledTextCtrl::wxSTC_EDGE_NONE wxSTC_EDGE_* @endlink constants.',),
     1190
     1191    'GetLexer':
     1192        ('The return value will be one of the',
     1193        '@link wxStyledTextCtrl::wxSTC_LEX_A68K wxSTC_LEX_* @endlink constants.',),
     1194
     1195    'SetLexer':
     1196        ('The input should be one of the',
     1197        '@link wxStyledTextCtrl::wxSTC_LEX_A68K wxSTC_LEX_* @endlink constants.',),
     1198
     1199    'GetModEventMask':
     1200        ('The return value will wxSTC_MODEVENTMASKALL if all changes generate',
     1201         'events.  Otherwise it will be a bit list containing one or more of the',
     1202        '@link wxStyledTextCtrl::wxSTC_MOD_INSERTTEXT wxSTC_MOD_* @endlink constants,',
     1203        'the @link wxStyledTextCtrl::wxSTC_PERFORMED_REDO wxSTC_PERFORMED_* @endlink constants,',
     1204        'wxSTC_STARTACTION, wxSTC_MULTILINEUNDOREDO, '
     1205        'wxSTC_MULTISTEPUNDOREDO, and wxSTC_LASTSTEPINUNDOREDO.',),
     1206
     1207    'SetModEventMask':
     1208        ('The input should be a bit list containing one or more of the',
     1209        '@link wxStyledTextCtrl::wxSTC_MOD_INSERTTEXT wxSTC_MOD_* @endlink constants,',
     1210        'the @link wxStyledTextCtrl::wxSTC_PERFORMED_REDO wxSTC_PERFORMED_* @endlink constants,',
     1211        'wxSTC_STARTACTION, wxSTC_MULTILINEUNDOREDO, '
     1212        'wxSTC_MULTISTEPUNDOREDO, and wxSTC_LASTSTEPINUNDOREDO.',
     1213        'The input can also be wxSTC_MODEVENTMASKALL to indicate that all changes',
     1214        'should generate events.'),
     1215
     1216    'GetMouseDwellTime':
     1217        ('The return value will be a time in milliseconds or wxSTC_TIME_FOREVER.',),
     1218
     1219    'SetMouseDwellTime':
     1220        ('The input should be a time in milliseconds or wxSTC_TIME_FOREVER.',),
     1221
     1222    'FindText':
     1223        ('The fourth argument should be a bit list containing one or more of the',
     1224        '@link wxStyledTextCtrl::wxSTC_FIND_WHOLEWORD wxSTC_FIND_* @endlink constants.',),
     1225
     1226    'AddUndoAction':
     1227        ('The flags argument can be either 0 or wxSTC_UNDO_MAY_COALESCE.',),
     1228
     1229    'AssignCmdKey':
     1230        ('The second argument should be a bit list containing one or more of the',
     1231        '@link wxStyledTextCtrl::wxSTC_KEYMOD_NORM wxSTC_KEYMOD_* @endlink constants',
     1232        'and the third argument should be one of the',
     1233        '@link wxStyledTextCtrl::wxSTC_CMD_BACKTAB wxSTC_CMD_* @endlink constants.',),
     1234
     1235    'ClearCmdKey':
     1236        ('The second argument should be a bit list containing one or more of the',
     1237        '@link wxStyledTextCtrl::wxSTC_KEYMOD_NORM wxSTC_KEYMOD_* @endlink constants.'),
     1238
     1239    'FoldLine':
     1240        ('The second argument should be one of the',
     1241        '@link wxStyledTextCtrl::wxSTC_FOLDACTION_CONTRACT wxSTC_FOLDACTION_* '
     1242        '@endlink constants.'),
     1243
     1244    'FoldChildren':
     1245        ('The second argument should be one of the',
     1246        '@link wxStyledTextCtrl::wxSTC_FOLDACTION_CONTRACT wxSTC_FOLDACTION_* '
     1247        '@endlink constants.'),
     1248
     1249    'FoldAll':
     1250        ('The input should be one of the',
     1251        '@link wxStyledTextCtrl::wxSTC_FOLDACTION_CONTRACT wxSTC_FOLDACTION_* '
     1252        '@endlink constants.'),
     1253
     1254    'UsePopUp':
     1255        ('The input should be one of the',
     1256        '@link wxStyledTextCtrl::wxSTC_POPUP_NEVER wxSTC_POPUP_* @endlink constants.',),
     1257
     1258    'PropertyType':
     1259        ('The return value will be one of the',
     1260        '@link wxStyledTextCtrl::wxSTC_TYPE_BOOLEAN wxSTC_TYPE_* @endlink constants.',),
     1261
     1262    'GetCurLine':
     1263        ('linePos can optionally be passed in to receive the index of the',
     1264        'caret on the line.',),
     1265
     1266    'StyleSetCharacterSet':
     1267        ('Converts the Scintilla character set values to a wxFontEncoding.',),
     1268
     1269}
     1270
     1271
     1272# This map can be used to add since annotations to the interface header.
     1273sinceAnnotations= {
     1274    'AddTabStop':'3.1.0',
     1275    'AllocateExtendedStyles':'3.1.0',
     1276    'AllocateSubStyles':'3.1.0',
     1277    'AutoCGetMulti':'3.1.0',
     1278    'AutoCGetOrder':'3.1.0',
     1279    'AutoCSetMulti':'3.1.0',
     1280    'AutoCSetOrder':'3.1.0',
     1281    'CallTipPosStart':'3.1.0',
     1282    'ChangeInsertion':'3.1.0',
     1283    'ClearRepresentation':'3.1.0',
     1284    'ClearTabStops':'3.1.0',
     1285    'DistanceToSecondaryStyles':'3.1.0',
     1286    'DropSelectionN':'3.1.0',
     1287    'ExpandChildren':'3.1.0',
     1288    'FoldAll':'3.1.0',
     1289    'FoldChildren':'3.1.0',
     1290    'FoldLine':'3.1.0',
     1291    'FreeSubStyles':'3.1.0',
     1292    'GetAutomaticFold':'3.1.0',
     1293    'GetCaretLineVisibleAlways':'3.1.0',
     1294    'GetIMEInteraction':'3.1.0',
     1295    'GetLineEndTypesActive':'3.1.0',
     1296    'GetLineEndTypesAllowed':'3.1.0',
     1297    'GetLineEndTypesSupported':'3.1.0',
     1298    'GetMouseSelectionRectangularSwitch':'3.1.0',
     1299    'GetNextTabStop':'3.1.0',
     1300    'GetPhasesDraw':'3.1.0',
     1301    'GetPrimaryStyleFromStyle':'3.1.0',
     1302    'GetRepresentation':'3.1.0',
     1303    'GetSelectionEmpty':'3.1.0',
     1304    'GetStyleFromSubStyle':'3.1.0',
     1305    'GetSubStyleBases':'3.1.0',
     1306    'GetSubStylesLength':'3.1.0',
     1307    'GetSubStylesStart':'3.1.0',
     1308    'GetTargetText':'3.1.0',
     1309    'IndicGetFlags':'3.1.0',
     1310    'IndicGetHoverFore':'3.1.0',
     1311    'IndicGetHoverStyle':'3.1.0',
     1312    'IndicSetFlags':'3.1.0',
     1313    'IndicSetHoverFore':'3.1.0',
     1314    'IndicSetHoverStyle':'3.1.0',
     1315    'PositionRelative':'3.1.0',
     1316    'ReleaseAllExtendedStyles':'3.1.0',
     1317    'RGBAImageSetScale':'3.1.0',
     1318    'ScrollRange':'3.1.0',
     1319    'SetAutomaticFold':'3.1.0',
     1320    'SetCaretLineVisibleAlways':'3.1.0',
     1321    'SetIdentifiers':'3.1.0',
     1322    'SetIMEInteraction':'3.1.0',
     1323    'SetLineEndTypesAllowed':'3.1.0',
     1324    'SetMouseSelectionRectangularSwitch':'3.1.0',
     1325    'SetPhasesDraw':'3.1.0',
     1326    'SetRepresentation':'3.1.0',
     1327    'SetTargetRange':'3.1.0',
     1328    'VCHomeDisplay':'3.1.0',
     1329    'VCHomeDisplayExtend':'3.1.0',
     1330
     1331    'FoldDisplayTextSetStyle':'3.1.1',
     1332    'GetDirectFunction':'3.1.1',
     1333    'GetDirectPointer':'3.1.1',
     1334    'GetIdleStyling':'3.1.1',
     1335    'GetLexerLanguage':'3.1.1',
     1336    'GetMarginBackN':'3.1.1',
     1337    'GetMargins':'3.1.1',
     1338    'GetMouseWheelCaptures':'3.1.1',
     1339    'GetTabDrawMode':'3.1.1',
     1340    'IsRangeWord':'3.1.1',
     1341    'LoadLexerLibrary':'3.1.1',
     1342    'MultiEdgeAddLine':'3.1.1',
     1343    'MultiEdgeClearAll':'3.1.1',
     1344    'MultipleSelectAddEach':'3.1.1',
     1345    'MultipleSelectAddNext':'3.1.1',
     1346    'SetIdleStyling':'3.1.1',
     1347    'SetMarginBackN':'3.1.1',
     1348    'SetMargins':'3.1.1',
     1349    'SetMouseWheelCaptures':'3.1.1',
     1350    'SetTabDrawMode':'3.1.1',
     1351    'TargetWholeDocument':'3.1.1',
     1352    'ToggleFoldShowText':'3.1.1'
     1353}
     1354
     1355
     1356#----------------------------------------------------------------------------
     1357
     1358def buildDocs(name, docs):
     1359    docsLong = 0
     1360
     1361    # If an item does not have a category or the category to which it is
     1362    # assigned is not in categoriesList, it will be assigned to 'OtherSettings'
     1363    if name in docsMap:
     1364        category = docsMap[name]
     1365    else:
     1366        category = 'OtherSettings'
     1367
     1368    if category not in [ x for (x,y,z) in categoriesList]:
     1369        category = 'OtherSettings'
     1370
     1371    if name in docOverrides:
     1372        docs = docOverrides[name]
     1373
     1374    if name in docSubstitutions:
     1375        post = docSubstitutions[name]
     1376        newdocs = []
     1377        for d in docs:
     1378            for x,y in post.items():
     1379                d=d.replace(x,y)
     1380            newdocs.append(d)
     1381        newdocs[:] = [x for x in newdocs if x.strip()!='']
     1382        docs=tuple(newdocs)
     1383
     1384    if name in extendedDocs:
     1385        docsLong = extendedDocs[name]
     1386
     1387    if name in sinceAnnotations:
     1388        note = ('@since '+sinceAnnotations[name],)
     1389        if docsLong==0:
     1390            docsLong = note
     1391        else:
     1392            docsLong = docsLong + note
     1393
     1394    if category=='DeprecatedMessages':
     1395        note = ('@deprecated',)
     1396        if docsLong==0:
     1397            docsLong = note
     1398        else:
     1399            docsLong = docsLong + note
     1400
     1401    return category, docs, docsLong
  • src/stc/gen_iface.py

    diff --git a/src/stc/gen_iface.py b/src/stc/gen_iface.py
    index 0494fff..67a235a 100755
    a b  
    1414import sys, string, re, os
    1515from fileinput import FileInput
    1616
     17sys.dont_write_bytecode = True
     18from gen_docs import categoriesList,buildDocs
    1719
    1820IFACE         = os.path.abspath('./scintilla/include/Scintilla.iface')
    1921HDR_SCN       = os.path.abspath('./scintilla/include/Scintilla.h')
    paramTypeMap = { 
    8991#            default name.
    9092#         2. Method definition for the .h file, 0 to leave alone
    9193#         3. Method implementation for the .cpp file, 0 to leave alone.
    92 #         4. tuple of Doc string lines, or 0 to leave alone.
    9394#
    9495methodOverrideMap = {
    9596    'AddText' : (0,
    methodOverrideMap = { 
    9798
    9899                 '''void %s(const wxString& text) {
    99100                    const wxWX2MBbuf buf = wx2stc(text);
    100                     SendMsg(%s, wx2stclen(text, buf), (sptr_t)(const char*)buf);''',
    101                  0),
     101                    SendMsg(%s, wx2stclen(text, buf), (sptr_t)(const char*)buf);'''
     102                 ),
    102103
    103104    'AddStyledText' : (0,
    104105                       'void %s(const wxMemoryBuffer& data);',
    105106
    106107                       '''void %s(const wxMemoryBuffer& data) {
    107                           SendMsg(%s, data.GetDataLen(), (sptr_t)data.GetData());''',
    108                        0),
     108                          SendMsg(%s, data.GetDataLen(), (sptr_t)data.GetData());'''
     109                       ),
    109110
    110111    'AppendText' : (0,
    111112                 'void %s(const wxString& text) wxOVERRIDE;',
    112113
    113114                 '''void %s(const wxString& text) {
    114115                    const wxWX2MBbuf buf = wx2stc(text);
    115                     SendMsg(%s, wx2stclen(text, buf), (sptr_t)(const char*)buf);''',
    116                  0),
     116                    SendMsg(%s, wx2stclen(text, buf), (sptr_t)(const char*)buf);'''
     117                 ),
    117118
    118     'GetViewWS' : ( 'GetViewWhiteSpace', 0, 0, 0),
    119     'SetViewWS' : ( 'SetViewWhiteSpace', 0, 0, 0),
     119    'GetViewWS' : ( 'GetViewWhiteSpace', 0, 0),
     120    'SetViewWS' : ( 'SetViewWhiteSpace', 0, 0),
    120121
    121122    'GetCharAt' :
    122123    ( 0, 0,
    123124      '''int %s(int pos) const {
    124          return (unsigned char)SendMsg(%s, pos, 0);''',
    125       0),
     125         return (unsigned char)SendMsg(%s, pos, 0);'''
     126    ),
    126127
    127128    'GetStyleAt' :
    128129    ( 0, 0,
    129130      '''int %s(int pos) const {
    130          return (unsigned char)SendMsg(%s, pos, 0);''',
    131       0),
     131         return (unsigned char)SendMsg(%s, pos, 0);'''
     132    ),
    132133
    133134    'GetStyledText' :
    134135    (0,
    methodOverrideMap = { 
    149150        tr.chrg.cpMax = endPos;
    150151        len = SendMsg(%s, 0, (sptr_t)&tr);
    151152        buf.UngetWriteBuf(len);
    152         return buf;''',
    153 
    154      ('Retrieve a buffer of cells.',)),
     153        return buf;'''
     154    ),
    155155
    156156
    157157    'PositionFromPoint' :
    methodOverrideMap = { 
    159159     'int %s(wxPoint pt) const;',
    160160
    161161     '''int %s(wxPoint pt) const {
    162         return SendMsg(%s, pt.x, pt.y);''',
    163      0),
     162        return SendMsg(%s, pt.x, pt.y);'''
     163    ),
    164164
    165165    'GetCurLine' :
    166166    (0,
    methodOverrideMap = { 
    180180        mbuf.UngetWriteBuf(len);
    181181        mbuf.AppendByte(0);
    182182        if (linePos)  *linePos = pos;
    183         return stc2wx(buf);''',
    184 
    185      0),
     183        return stc2wx(buf);'''
     184    ),
    186185
    187     'MarkerSetFore' : ('MarkerSetForeground', 0, 0, 0),
    188     'MarkerSetBack' : ('MarkerSetBackground', 0, 0, 0),
    189     'MarkerSetBackSelected' : ('MarkerSetBackgroundSelected', 0,0,0),
     186    'MarkerSetFore' : ('MarkerSetForeground', 0, 0),
     187    'MarkerSetBack' : ('MarkerSetBackground', 0, 0),
     188    'MarkerSetBackSelected' : ('MarkerSetBackgroundSelected', 0,0),
    190189
    191     'MarkerSymbolDefined' : ('GetMarkerSymbolDefined', 0, 0, 0),
     190    'MarkerSymbolDefined' : ('GetMarkerSymbolDefined', 0, 0),
    192191
    193192    'MarkerDefine' :
    194193    (0,
    methodOverrideMap = { 
    204203                if (foreground.IsOk())
    205204                    MarkerSetForeground(markerNumber, foreground);
    206205                if (background.IsOk())
    207                     MarkerSetBackground(markerNumber, background);''',
    208 
    209      ('Set the symbol used for a particular marker number,',
    210       'and optionally the fore and background colours.')),
     206                    MarkerSetBackground(markerNumber, background);'''
     207    ),
    211208
    212209
    213210    'MarkerDefinePixmap' :
    methodOverrideMap = { 
    226223        buff[len] = 0;
    227224        SendMsg(%s, markerNumber, (sptr_t)buff);
    228225        delete [] buff;
    229         ''',
    230      ('Define a marker from a bitmap',)),
    231 
    232     'GetMargins' : ('GetMarginCount', 0, 0, 0),
    233     'SetMargins' : ('SetMarginCount', 0, 0, 0),
    234     'GetMarginBackN' : ('GetMarginBackground', 0, 0, 0),
    235     'SetMarginBackN' : ('SetMarginBackground', 0, 0, 0),
    236     'SetMarginTypeN' : ('SetMarginType', 0, 0, 0),
    237     'GetMarginTypeN' : ('GetMarginType', 0, 0, 0),
    238     'SetMarginWidthN' : ('SetMarginWidth', 0, 0, 0),
    239     'GetMarginWidthN' : ('GetMarginWidth', 0, 0, 0),
    240     'SetMarginMaskN' : ('SetMarginMask', 0, 0, 0),
    241     'GetMarginMaskN' : ('GetMarginMask', 0, 0, 0),
    242     'SetMarginSensitiveN' : ('SetMarginSensitive', 0, 0, 0),
    243     'GetMarginSensitiveN' : ('GetMarginSensitive', 0, 0, 0),
    244     'SetMarginCursorN' : ('SetMarginCursor', 0, 0, 0),
    245     'GetMarginCursorN' : ('GetMarginCursor', 0, 0, 0),
    246    
     226        '''
     227    ),
     228
     229    'GetMargins' : ('GetMarginCount', 0, 0),
     230    'SetMargins' : ('SetMarginCount', 0, 0),
     231    'GetMarginBackN' : ('GetMarginBackground', 0, 0),
     232    'SetMarginBackN' : ('SetMarginBackground', 0, 0),
     233    'SetMarginTypeN' : ('SetMarginType', 0, 0),
     234    'GetMarginTypeN' : ('GetMarginType', 0, 0),
     235    'SetMarginWidthN' : ('SetMarginWidth', 0, 0),
     236    'GetMarginWidthN' : ('GetMarginWidth', 0, 0),
     237    'SetMarginMaskN' : ('SetMarginMask', 0, 0),
     238    'GetMarginMaskN' : ('GetMarginMask', 0, 0),
     239    'SetMarginSensitiveN' : ('SetMarginSensitive', 0, 0),
     240    'GetMarginSensitiveN' : ('GetMarginSensitive', 0, 0),
     241    'SetMarginCursorN' : ('SetMarginCursor', 0, 0),
     242    'GetMarginCursorN' : ('GetMarginCursor', 0, 0),
     243
    247244    'MarginGetText' :
    248245    (0,
    249246    'wxString %s(int line) const;',
    methodOverrideMap = { 
    257254         SendMsg(msg, line, (sptr_t)buf);
    258255         mbuf.UngetWriteBuf(len);
    259256         mbuf.AppendByte(0);
    260          return stc2wx(buf);''',
    261      0),
    262      
    263      'MarginGetStyles' :
     257         return stc2wx(buf);'''
     258    ),
     259
     260    'MarginGetStyles' :
    264261     (0,
    265262    'wxString %s(int line) const;',
    266263
    methodOverrideMap = { 
    273270         SendMsg(msg, line, (sptr_t)buf);
    274271         mbuf.UngetWriteBuf(len);
    275272         mbuf.AppendByte(0);
    276          return stc2wx(buf);''',
    277      0),
     273         return stc2wx(buf);'''
     274    ),
    278275
    279     'SetAdditionalSelFore' : ('SetAdditionalSelForeground', 0, 0, 0),
    280     'SetAdditionalSelBack' : ('SetAdditionalSelBackground', 0, 0, 0),
    281     'SetAdditionalCaretFore' : ('SetAdditionalCaretForeground', 0, 0, 0),
    282     'GetAdditionalCaretFore' : ('GetAdditionalCaretForeground', 0, 0, 0),
     276    'SetAdditionalSelFore' : ('SetAdditionalSelForeground', 0, 0),
     277    'SetAdditionalSelBack' : ('SetAdditionalSelBackground', 0, 0),
     278    'SetAdditionalCaretFore' : ('SetAdditionalCaretForeground', 0, 0),
     279    'GetAdditionalCaretFore' : ('GetAdditionalCaretForeground', 0, 0),
    283280
    284281    'AnnotationGetText' :
    285282    (0,
    methodOverrideMap = { 
    294291         SendMsg(msg, line, (sptr_t)buf);
    295292         mbuf.UngetWriteBuf(len);
    296293         mbuf.AppendByte(0);
    297          return stc2wx(buf);''',
    298      0),
     294         return stc2wx(buf);'''
     295    ),
    299296
    300297    'AnnotationGetStyles' :
    301298    (0,
    methodOverrideMap = { 
    310307         SendMsg(msg, line, (sptr_t)buf);
    311308         mbuf.UngetWriteBuf(len);
    312309         mbuf.AppendByte(0);
    313          return stc2wx(buf);''',
    314      0),
    315 
    316     'StyleGetFore' : ('StyleGetForeground', 0, 0, 0),
    317     'StyleGetBack' : ('StyleGetBackground', 0, 0, 0),
    318     'StyleSetFore' : ('StyleSetForeground', 0, 0, 0),
    319     'StyleSetBack' : ('StyleSetBackground', 0, 0, 0),
    320     'SetSelFore' : ('SetSelForeground', 0, 0, 0),
    321     'SetSelBack' : ('SetSelBackground', 0, 0, 0),
    322     'SetCaretFore' : ('SetCaretForeground', 0, 0, 0),
     310         return stc2wx(buf);'''
     311    ),
     312
     313    'StyleGetFore' : ('StyleGetForeground', 0, 0),
     314    'StyleGetBack' : ('StyleGetBackground', 0, 0),
     315    'StyleSetFore' : ('StyleSetForeground', 0, 0),
     316    'StyleSetBack' : ('StyleSetBackground', 0, 0),
     317    'SetSelFore' : ('SetSelForeground', 0, 0),
     318    'SetSelBack' : ('SetSelBackground', 0, 0),
     319    'SetCaretFore' : ('SetCaretForeground', 0, 0),
     320
    323321    'StyleGetFont' :
    324322    ('StyleGetFaceName',
    325323     'wxString %s(int style);',
    methodOverrideMap = { 
    331329         SendMsg(msg, style, (sptr_t)buf);
    332330         mbuf.UngetWriteBuf(len);
    333331         mbuf.AppendByte(0);
    334          return stc2wx(buf);''',
    335          ('Get the font facename of a style',)),
    336     'StyleSetFont' : ('StyleSetFaceName', 0, 0, 0),
     332         return stc2wx(buf);'''
     333    ),
     334
     335    'StyleSetFont' : ('StyleSetFaceName', 0, 0),
    337336
    338337    'StyleSetCharacterSet' : (0, 0,
    339338    '''void %s(int style, int characterSet) {
    methodOverrideMap = { 
    429428        // effective wxFONENCODING_DEFAULT == SC_SHARSET_DEFAULT and so when
    430429        // Scintilla internally uses SC_CHARSET_DEFAULT we will translate it back
    431430        // to wxFONENCODING_DEFAULT in Font::Create.
    432         SendMsg(%s, style, encoding+1);''',
    433         ('Set the character set of the font in a style.',
    434          'Converts the Scintilla character set values to a wxFontEncoding.'),),
     431        SendMsg(%s, style, encoding+1);'''
     432    ),
    435433
    436434    'AssignCmdKey' :
    437435    ('CmdKeyAssign',
    438436     'void %s(int key, int modifiers, int cmd);',
    439437
    440438     '''void %s(int key, int modifiers, int cmd) {
    441          SendMsg(%s, MAKELONG(key, modifiers), cmd);''',
    442      0),
     439         SendMsg(%s, MAKELONG(key, modifiers), cmd);'''
     440    ),
    443441
    444442
    445443    'ClearCmdKey' :
    methodOverrideMap = { 
    447445     'void %s(int key, int modifiers);',
    448446
    449447     '''void %s(int key, int modifiers) {
    450          SendMsg(%s, MAKELONG(key, modifiers));''',
    451      0),
     448         SendMsg(%s, MAKELONG(key, modifiers));'''
     449    ),
    452450
    453     'ClearAllCmdKeys' : ('CmdKeyClearAll', 0, 0, 0),
     451    'ClearAllCmdKeys' : ('CmdKeyClearAll', 0, 0),
    454452
    455453    'StartStyling' :
    456454    (0,
    methodOverrideMap = { 
    460458        wxASSERT_MSG(unused==0,
    461459                     "The second argument passed to StartStyling should be 0");
    462460
    463         SendMsg(%s, start, unused);''',
    464      0),
     461        SendMsg(%s, start, unused);'''
     462    ),
    465463
    466464    'SetStylingEx' :
    467465    ('SetStyleBytes',
    468466     'void %s(int length, char* styleBytes);',
    469467
    470468     '''void %s(int length, char* styleBytes) {
    471         SendMsg(%s, length, (sptr_t)styleBytes);''',
    472      0),
    473 
    474 
    475     'IndicSetAlpha' : ('IndicatorSetAlpha', 0, 0, 0),
    476     'IndicGetAlpha' : ('IndicatorGetAlpha', 0, 0, 0),
    477     'IndicSetOutlineAlpha' : ('IndicatorSetOutlineAlpha', 0, 0, 0),
    478     'IndicGetOutlineAlpha' : ('IndicatorGetOutlineAlpha', 0, 0, 0),
    479     'IndicSetStyle' : ('IndicatorSetStyle', 0, 0, 0),
    480     'IndicGetStyle' : ('IndicatorGetStyle', 0, 0, 0),
    481     'IndicSetFore' : ('IndicatorSetForeground', 0, 0, 0),
    482     'IndicGetFore' : ('IndicatorGetForeground', 0, 0, 0),
    483     'IndicSetUnder': ('IndicatorSetUnder', 0, 0, 0),
    484     'IndicGetUnder': ('IndicatorGetUnder', 0, 0, 0),
    485     'IndicSetHoverStyle': ('IndicatorSetHoverStyle', 0, 0, 0),
    486     'IndicGetHoverStyle': ('IndicatorGetHoverStyle', 0, 0, 0),
    487     'IndicSetHoverFore': ('IndicatorSetHoverForeground', 0, 0, 0),
    488     'IndicGetHoverFore': ('IndicatorGetHoverForeground', 0, 0, 0),
    489     'IndicSetFlags': ('IndicatorSetFlags', 0, 0, 0),
    490     'IndicGetFlags': ('IndicatorGetFlags', 0, 0, 0),
    491 
    492     'SetWhitespaceFore' : ('SetWhitespaceForeground', 0, 0, 0),
    493     'SetWhitespaceBack' : ('SetWhitespaceBackground', 0, 0, 0),
    494 
    495     'AutoCShow' : ('AutoCompShow', 0, 0, 0),
    496     'AutoCCancel' : ('AutoCompCancel', 0, 0, 0),
    497     'AutoCActive' : ('AutoCompActive', 0, 0, 0),
    498     'AutoCPosStart' : ('AutoCompPosStart', 0, 0, 0),
    499     'AutoCComplete' : ('AutoCompComplete', 0, 0, 0),
    500     'AutoCStops' : ('AutoCompStops', 0, 0, 0),
    501     'AutoCSetSeparator' : ('AutoCompSetSeparator', 0, 0, 0),
    502     'AutoCGetSeparator' : ('AutoCompGetSeparator', 0, 0, 0),
    503     'AutoCSelect' : ('AutoCompSelect', 0, 0, 0),
    504     'AutoCSetCancelAtStart' : ('AutoCompSetCancelAtStart', 0, 0, 0),
    505     'AutoCGetCancelAtStart' : ('AutoCompGetCancelAtStart', 0, 0, 0),
    506     'AutoCSetFillUps' : ('AutoCompSetFillUps', 0, 0, 0),
    507     'AutoCSetChooseSingle' : ('AutoCompSetChooseSingle', 0, 0, 0),
    508     'AutoCGetChooseSingle' : ('AutoCompGetChooseSingle', 0, 0, 0),
    509     'AutoCSetIgnoreCase' : ('AutoCompSetIgnoreCase', 0, 0, 0),
    510     'AutoCGetIgnoreCase' : ('AutoCompGetIgnoreCase', 0, 0, 0),
    511     'AutoCSetAutoHide' : ('AutoCompSetAutoHide', 0, 0, 0),
    512     'AutoCGetAutoHide' : ('AutoCompGetAutoHide', 0, 0, 0),
    513     'AutoCSetDropRestOfWord' : ('AutoCompSetDropRestOfWord', 0,0,0),
    514     'AutoCGetDropRestOfWord' : ('AutoCompGetDropRestOfWord', 0,0,0),
    515     'AutoCGetTypeSeparator' : ('AutoCompGetTypeSeparator', 0, 0, 0),
    516     'AutoCSetTypeSeparator' : ('AutoCompSetTypeSeparator', 0, 0, 0),
    517     'AutoCGetCurrent'       : ('AutoCompGetCurrent', 0, 0, 0),
    518     'AutoCGetCurrentText'   : (None, 0, 0, 0),
    519     'AutoCSetMaxWidth'      : ('AutoCompSetMaxWidth', 0, 0, 0),
    520     'AutoCGetMaxWidth'      : ('AutoCompGetMaxWidth', 0, 0, 0),
    521     'AutoCSetMaxHeight'     : ('AutoCompSetMaxHeight', 0, 0, 0),
    522     'AutoCGetMaxHeight'     : ('AutoCompGetMaxHeight', 0, 0, 0),
    523     'AutoCGetMaxHeight'     : ('AutoCompGetMaxHeight', 0, 0, 0),
    524     'AutoCSetCaseInsensitiveBehaviour'     : ('AutoCompSetCaseInsensitiveBehaviour', 0, 0, 0),
    525     'AutoCGetCaseInsensitiveBehaviour'     : ('AutoCompGetCaseInsensitiveBehaviour', 0, 0, 0),
    526     'AutoCSetMulti'         : ('AutoCompSetMulti', 0, 0, 0),
    527     'AutoCGetMulti'         : ('AutoCompGetMulti', 0, 0, 0),
    528     'AutoCSetOrder'         : ('AutoCompSetOrder', 0, 0, 0),
    529     'AutoCGetOrder'         : ('AutoCompGetOrder', 0, 0, 0),
     469        SendMsg(%s, length, (sptr_t)styleBytes);'''
     470    ),
     471
     472
     473    'IndicSetAlpha' : ('IndicatorSetAlpha', 0, 0),
     474    'IndicGetAlpha' : ('IndicatorGetAlpha', 0, 0),
     475    'IndicSetOutlineAlpha' : ('IndicatorSetOutlineAlpha', 0, 0),
     476    'IndicGetOutlineAlpha' : ('IndicatorGetOutlineAlpha', 0, 0),
     477    'IndicSetStyle' : ('IndicatorSetStyle', 0, 0),
     478    'IndicGetStyle' : ('IndicatorGetStyle', 0, 0),
     479    'IndicSetFore' : ('IndicatorSetForeground', 0, 0),
     480    'IndicGetFore' : ('IndicatorGetForeground', 0, 0),
     481    'IndicSetUnder': ('IndicatorSetUnder', 0, 0),
     482    'IndicGetUnder': ('IndicatorGetUnder', 0, 0),
     483    'IndicSetHoverStyle': ('IndicatorSetHoverStyle', 0, 0),
     484    'IndicGetHoverStyle': ('IndicatorGetHoverStyle', 0, 0),
     485    'IndicSetHoverFore': ('IndicatorSetHoverForeground', 0, 0),
     486    'IndicGetHoverFore': ('IndicatorGetHoverForeground', 0, 0),
     487    'IndicSetFlags': ('IndicatorSetFlags', 0, 0),
     488    'IndicGetFlags': ('IndicatorGetFlags', 0, 0),
     489
     490    'SetWhitespaceFore' : ('SetWhitespaceForeground', 0, 0),
     491    'SetWhitespaceBack' : ('SetWhitespaceBackground', 0, 0),
     492
     493    'AutoCShow' : ('AutoCompShow', 0, 0),
     494    'AutoCCancel' : ('AutoCompCancel', 0, 0),
     495    'AutoCActive' : ('AutoCompActive', 0, 0),
     496    'AutoCPosStart' : ('AutoCompPosStart', 0, 0),
     497    'AutoCComplete' : ('AutoCompComplete', 0, 0),
     498    'AutoCStops' : ('AutoCompStops', 0, 0),
     499    'AutoCSetSeparator' : ('AutoCompSetSeparator', 0, 0),
     500    'AutoCGetSeparator' : ('AutoCompGetSeparator', 0, 0),
     501    'AutoCSelect' : ('AutoCompSelect', 0, 0),
     502    'AutoCSetCancelAtStart' : ('AutoCompSetCancelAtStart', 0, 0),
     503    'AutoCGetCancelAtStart' : ('AutoCompGetCancelAtStart', 0, 0),
     504    'AutoCSetFillUps' : ('AutoCompSetFillUps', 0, 0),
     505    'AutoCSetChooseSingle' : ('AutoCompSetChooseSingle', 0, 0),
     506    'AutoCGetChooseSingle' : ('AutoCompGetChooseSingle', 0, 0),
     507    'AutoCSetIgnoreCase' : ('AutoCompSetIgnoreCase', 0, 0),
     508    'AutoCGetIgnoreCase' : ('AutoCompGetIgnoreCase', 0, 0),
     509    'AutoCSetAutoHide' : ('AutoCompSetAutoHide', 0, 0),
     510    'AutoCGetAutoHide' : ('AutoCompGetAutoHide', 0, 0),
     511    'AutoCSetDropRestOfWord' : ('AutoCompSetDropRestOfWord', 0,0),
     512    'AutoCGetDropRestOfWord' : ('AutoCompGetDropRestOfWord', 0,0),
     513    'AutoCGetTypeSeparator' : ('AutoCompGetTypeSeparator', 0, 0),
     514    'AutoCSetTypeSeparator' : ('AutoCompSetTypeSeparator', 0, 0),
     515    'AutoCGetCurrent'       : ('AutoCompGetCurrent', 0, 0),
     516    'AutoCGetCurrentText'   : (None, 0, 0),
     517    'AutoCSetMaxWidth'      : ('AutoCompSetMaxWidth', 0, 0),
     518    'AutoCGetMaxWidth'      : ('AutoCompGetMaxWidth', 0, 0),
     519    'AutoCSetMaxHeight'     : ('AutoCompSetMaxHeight', 0, 0),
     520    'AutoCGetMaxHeight'     : ('AutoCompGetMaxHeight', 0, 0),
     521    'AutoCGetMaxHeight'     : ('AutoCompGetMaxHeight', 0, 0),
     522    'AutoCSetCaseInsensitiveBehaviour'     : ('AutoCompSetCaseInsensitiveBehaviour', 0, 0),
     523    'AutoCGetCaseInsensitiveBehaviour'     : ('AutoCompGetCaseInsensitiveBehaviour', 0, 0),
     524    'AutoCSetMulti'         : ('AutoCompSetMulti', 0, 0),
     525    'AutoCGetMulti'         : ('AutoCompGetMulti', 0, 0),
     526    'AutoCSetOrder'         : ('AutoCompSetOrder', 0, 0),
     527    'AutoCGetOrder'         : ('AutoCompGetOrder', 0, 0),
    530528
    531529    'RegisterImage' :
    532530    (0,
    methodOverrideMap = { 
    544542        buff[len] = 0;
    545543        SendMsg(%s, type, (sptr_t)buff);
    546544        delete [] buff;
    547      ''',
    548      ('Register an image for use in autocompletion lists.',)),
    549 
    550 
    551     'ClearRegisteredImages' : (0, 0, 0,
    552                                ('Clear all the registered images.',)),
    553 
     545     '''
     546    ),
    554547
    555     'SetHScrollBar' : ('SetUseHorizontalScrollBar', 0, 0, 0),
    556     'GetHScrollBar' : ('GetUseHorizontalScrollBar', 0, 0, 0),
     548    'SetHScrollBar' : ('SetUseHorizontalScrollBar', 0, 0),
     549    'GetHScrollBar' : ('GetUseHorizontalScrollBar', 0, 0),
    557550
    558     'SetVScrollBar' : ('SetUseVerticalScrollBar', 0, 0, 0),
    559     'GetVScrollBar' : ('GetUseVerticalScrollBar', 0, 0, 0),
     551    'SetVScrollBar' : ('SetUseVerticalScrollBar', 0, 0),
     552    'GetVScrollBar' : ('GetUseVerticalScrollBar', 0, 0),
    560553
    561     'GetCaretFore' : ('GetCaretForeground', 0, 0, 0),
     554    'GetCaretFore' : ('GetCaretForeground', 0, 0),
    562555
    563556    'FindText' :
    564557    (0,
    methodOverrideMap = { 
    573566            const wxWX2MBbuf buf = wx2stc(text);
    574567            ft.lpstrText = (char*)(const char*)buf;
    575568
    576             return SendMsg(%s, flags, (sptr_t)&ft);''',
    577      0),
     569            return SendMsg(%s, flags, (sptr_t)&ft);'''
     570    ),
    578571
    579572    'FormatRange' :
    580573    (0,
    methodOverrideMap = { 
    612605             fr.chrg.cpMin = startPos;
    613606             fr.chrg.cpMax = endPos;
    614607
    615              return SendMsg(%s, doDraw, (sptr_t)&fr);''',
    616      0),
     608             return SendMsg(%s, doDraw, (sptr_t)&fr);'''
     609    ),
    617610
    618611
    619612    'GetLine' :
    methodOverrideMap = { 
    629622         SendMsg(%s, line, (sptr_t)buf);
    630623         mbuf.UngetWriteBuf(len);
    631624         mbuf.AppendByte(0);
    632          return stc2wx(buf);''',
    633 
    634      ('Retrieve the contents of a line.',)),
     625         return stc2wx(buf);'''
     626    ),
    635627
    636     'SetSel' : (None, 0,0,0), #'SetSelection', 0, 0, 0),
     628    'SetSel' : (None, 0,0), #'SetSelection', 0, 0, 0),
    637629
    638630    'GetSelText' :
    639631    ('GetSelectedText',
    methodOverrideMap = { 
    648640         SendMsg(%s, 0, (sptr_t)buf);
    649641         mbuf.UngetWriteBuf(len);
    650642         mbuf.AppendByte(0);
    651          return stc2wx(buf);''',
    652 
    653      ('Retrieve the selected text.',)),
    654 
     643         return stc2wx(buf);'''
     644    ),
    655645
    656646    'GetTextRange' :
    657647    (0,
    methodOverrideMap = { 
    674664         SendMsg(%s, 0, (sptr_t)&tr);
    675665         mbuf.UngetWriteBuf(len);
    676666         mbuf.AppendByte(0);
    677          return stc2wx(buf);''',
    678 
    679      ('Retrieve a range of text.',)),
     667         return stc2wx(buf);'''
     668    ),
    680669
    681670    'PointXFromPosition' :
    682671    ('PointFromPosition',
    methodOverrideMap = { 
    684673     '''wxPoint %s(int pos) {
    685674         int x = SendMsg(%s, 0, pos);
    686675         int y = SendMsg(SCI_POINTYFROMPOSITION, 0, pos);
    687          return wxPoint(x, y);''',
    688      ('Retrieve the point in the window where a position is displayed.',)),
     676         return wxPoint(x, y);'''
     677    ),
    689678
    690     'PointYFromPosition' : (None, 0, 0, 0),
     679    'PointYFromPosition' : (None, 0, 0),
    691680
    692     'ScrollCaret' : ('EnsureCaretVisible', 0, 0, 0),
    693     'ReplaceSel' : ('ReplaceSelection', 0, 0, 0),
    694     'Null' : (None, 0, 0, 0),
     681    'ScrollCaret' : ('EnsureCaretVisible', 0, 0),
     682    'ReplaceSel' : ('ReplaceSelection', 0, 0),
     683    'Null' : (None, 0, 0),
    695684
    696685    'GetText' :
    697686    (0,
    methodOverrideMap = { 
    704693         SendMsg(%s, len+1, (sptr_t)buf);
    705694         mbuf.UngetWriteBuf(len);
    706695         mbuf.AppendByte(0);
    707          return stc2wx(buf);''',
    708 
    709      ('Retrieve all the text in the document.', )),
     696         return stc2wx(buf);'''
     697    ),
    710698
    711699    'GetDirectFunction' :
    712700    (0,
    713701     'void* %s() const;',
    714702     '''void* %s() const {
    715          return (void*)SendMsg(%s);''',
    716      0),
     703         return (void*)SendMsg(%s);'''
     704    ),
    717705
    718706    'GetDirectPointer' :
    719707    (0,
    720708     'void* %s() const;',
    721709     '''void* %s() const {
    722          return (void*)SendMsg(%s);''',
    723      0),
     710         return (void*)SendMsg(%s);'''
     711    ),
    724712
    725713    'GetTargetText' :
    726714    (0,
    methodOverrideMap = { 
    734722         SendMsg(%s, 0, (sptr_t)buf);
    735723         mbuf.UngetWriteBuf(endPos-startPos);
    736724         mbuf.AppendByte(0);
    737          return stc2wx(buf);''',
     725         return stc2wx(buf);'''
     726    ),
    738727
    739      0),
     728    'CallTipPosStart'   : ('CallTipPosAtStart', 0, 0),
     729    'CallTipSetPosStart': ('CallTipSetPosAtStart', 0, 0),
     730    'CallTipSetHlt'     : ('CallTipSetHighlight', 0, 0),
     731    'CallTipSetBack'    : ('CallTipSetBackground', 0, 0),
     732    'CallTipSetFore'    : ('CallTipSetForeground', 0, 0),
     733    'CallTipSetForeHlt' : ('CallTipSetForegroundHighlight', 0, 0),
    740734
    741     'CallTipPosStart'   : ('CallTipPosAtStart', 0, 0, 0),
    742     'CallTipSetPosStart': ('CallTipSetPosAtStart', 0, 0, 0),
    743     'CallTipSetHlt'     : ('CallTipSetHighlight', 0, 0, 0),
    744     'CallTipSetBack'    : ('CallTipSetBackground', 0, 0, 0),
    745     'CallTipSetFore'    : ('CallTipSetForeground', 0, 0, 0),
    746     'CallTipSetForeHlt' : ('CallTipSetForegroundHighlight', 0, 0, 0),
     735    'SetHotspotActiveFore' : ('SetHotspotActiveForeground', 0, 0),
     736    'SetHotspotActiveBack' : ('SetHotspotActiveBackground', 0, 0),
     737    'GetHotspotActiveFore' : ('GetHotspotActiveForeground', 0, 0),
     738    'GetHotspotActiveBack' : ('GetHotspotActiveBackground', 0, 0),
    747739
    748     'SetHotspotActiveFore' : ('SetHotspotActiveForeground', 0, 0, 0),
    749     'SetHotspotActiveBack' : ('SetHotspotActiveBackground', 0, 0, 0),
    750     'GetHotspotActiveFore' : ('GetHotspotActiveForeground', 0, 0, 0),
    751     'GetHotspotActiveBack' : ('GetHotspotActiveBackground', 0, 0, 0),
    752 
    753     'GetCaretLineBack' : ('GetCaretLineBackground', 0, 0, 0),
    754     'SetCaretLineBack' : ('SetCaretLineBackground', 0, 0, 0),
     740    'GetCaretLineBack' : ('GetCaretLineBackground', 0, 0),
     741    'SetCaretLineBack' : ('SetCaretLineBackground', 0, 0),
    755742
    756743    'ReplaceTarget' :
    757744    (0,
    methodOverrideMap = { 
    760747     '''
    761748     int %s(const wxString& text) {
    762749         const wxWX2MBbuf buf = wx2stc(text);
    763          return SendMsg(%s, wx2stclen(text, buf), (sptr_t)(const char*)buf);''',
    764      0),
     750         return SendMsg(%s, wx2stclen(text, buf), (sptr_t)(const char*)buf);'''
     751    ),
    765752
    766753    'ReplaceTargetRE' :
    767754    (0,
    methodOverrideMap = { 
    770757     '''
    771758     int %s(const wxString& text) {
    772759         const wxWX2MBbuf buf = wx2stc(text);
    773          return SendMsg(%s, wx2stclen(text, buf), (sptr_t)(const char*)buf);''',
    774      ('Replace the target text with the argument text after \\\d processing.',
    775       'Text is counted so it can contain NULs.',
    776       'Looks for \\\d where d is between 1 and 9 and replaces these with the strings',
    777       'matched in the last search operation which were surrounded by \( and \).',
    778       'Returns the length of the replacement text including any change',
    779       'caused by processing the \\\d patterns.',)),
     760         return SendMsg(%s, wx2stclen(text, buf), (sptr_t)(const char*)buf);'''
     761    ),
    780762
    781763    'SearchInTarget' :
    782764    (0,
    methodOverrideMap = { 
    785767     '''
    786768     int %s(const wxString& text) {
    787769         const wxWX2MBbuf buf = wx2stc(text);
    788          return SendMsg(%s, wx2stclen(text, buf), (sptr_t)(const char*)buf);''',
    789      0),
     770         return SendMsg(%s, wx2stclen(text, buf), (sptr_t)(const char*)buf);'''
     771    ),
    790772
    791773    # not sure what to do about these yet
    792     'TargetAsUTF8' :       ( None, 0, 0, 0),
    793     'SetLengthForEncode' : ( None, 0, 0, 0),
    794     'EncodedFromUTF8' :    ( None, 0, 0, 0),
     774    'TargetAsUTF8' :       ( None, 0, 0),
     775    'SetLengthForEncode' : ( None, 0, 0),
     776    'EncodedFromUTF8' :    ( None, 0, 0),
    795777
    796778
    797779    'GetProperty' :
    methodOverrideMap = { 
    807789         SendMsg(%s, (uptr_t)(const char*)wx2stc(key), (sptr_t)buf);
    808790         mbuf.UngetWriteBuf(len);
    809791         mbuf.AppendByte(0);
    810          return stc2wx(buf);''',
    811      ("Retrieve a 'property' value previously set with SetProperty.",)),
     792         return stc2wx(buf);'''
     793    ),
    812794
    813795    'GetPropertyExpanded' :
    814796    (0,
    methodOverrideMap = { 
    823805         SendMsg(%s, (uptr_t)(const char*)wx2stc(key), (sptr_t)buf);
    824806         mbuf.UngetWriteBuf(len);
    825807         mbuf.AppendByte(0);
    826          return stc2wx(buf);''',
    827      ("Retrieve a 'property' value previously set with SetProperty,",
    828       "with '$()' variable replacement on returned buffer.")),
     808         return stc2wx(buf);'''
     809    ),
    829810
    830811    'GetPropertyInt' :
    831812    (0,
    832813    'int %s(const wxString &key, int defaultValue=0) const;',
    833814    '''int %s(const wxString &key, int defaultValue) const {
    834         return SendMsg(%s, (uptr_t)(const char*)wx2stc(key), defaultValue);''',
    835        ("Retrieve a 'property' value previously set with SetProperty,",
    836         "interpreted as an int AFTER any '$()' variable replacement.")),
     815        return SendMsg(%s, (uptr_t)(const char*)wx2stc(key), defaultValue);'''
     816    ),
    837817
    838818    'BraceMatch' :
    839819    (0,
    methodOverrideMap = { 
    842822        wxASSERT_MSG(maxReStyle==0,
    843823                     "The second argument passed to BraceMatch should be 0");
    844824
    845         return SendMsg(%s, pos, maxReStyle);''',
    846      0),
     825        return SendMsg(%s, pos, maxReStyle);'''
     826    ),
    847827
    848828    'GetDocPointer' :
    849829    (0,
    850830     'void* %s();',
    851831     '''void* %s() {
    852          return (void*)SendMsg(%s);''',
    853      0),
     832         return (void*)SendMsg(%s);'''
     833    ),
    854834
    855835    'SetDocPointer' :
    856836    (0,
    857837     'void %s(void* docPointer);',
    858838     '''void %s(void* docPointer) {
    859          SendMsg(%s, 0, (sptr_t)docPointer);''',
    860      0),
     839         SendMsg(%s, 0, (sptr_t)docPointer);'''
     840    ),
    861841
    862842    'CreateDocument' :
    863843    (0,
    864844     'void* %s();',
    865845     '''void* %s() {
    866          return (void*)SendMsg(%s);''',
    867      0),
     846         return (void*)SendMsg(%s);'''
     847    ),
    868848
    869849    'AddRefDocument' :
    870850    (0,
    871851     'void %s(void* docPointer);',
    872852     '''void %s(void* docPointer) {
    873          SendMsg(%s, 0, (sptr_t)docPointer);''',
    874      0),
     853         SendMsg(%s, 0, (sptr_t)docPointer);'''
     854    ),
    875855
    876856    'ReleaseDocument' :
    877857    (0,
    878858     'void %s(void* docPointer);',
    879859     '''void %s(void* docPointer) {
    880          SendMsg(%s, 0, (sptr_t)docPointer);''',
    881      0),
     860         SendMsg(%s, 0, (sptr_t)docPointer);'''
     861    ),
    882862
    883863    'SetCodePage' :
    884864    (0,
    methodOverrideMap = { 
    891871    wxASSERT_MSG(codePage != wxSTC_CP_UTF8,
    892872                 wxT("wxSTC_CP_UTF8 may not be used when wxUSE_UNICODE is off."));
    893873#endif
    894     SendMsg(%s, codePage);''',
    895      ("Set the code page used to interpret the bytes of the document as characters.",) ),
     874    SendMsg(%s, codePage);'''
     875    ),
    896876
    897877
    898     'GrabFocus' : (None, 0, 0, 0),
     878    'GrabFocus' : (None, 0, 0),
    899879
    900880    # Rename some that would otherwise hide the wxWindow methods
    901     'SetFocus'  : ('SetSTCFocus', 0, 0, 0),
    902     'GetFocus'  : ('GetSTCFocus', 0, 0, 0),
    903     'SetCursor' : ('SetSTCCursor', 0, 0, 0),
    904     'GetCursor' : ('GetSTCCursor', 0, 0, 0),
     881    'SetFocus'  : ('SetSTCFocus', 0, 0),
     882    'GetFocus'  : ('GetSTCFocus', 0, 0),
     883    'SetCursor' : ('SetSTCCursor', 0, 0),
     884    'GetCursor' : ('GetSTCCursor', 0, 0),
    905885
    906     'SetPositionCache' : ('SetPositionCacheSize', 0, 0, 0),
    907     'GetPositionCache' : ('GetPositionCacheSize', 0, 0, 0),
     886    'SetPositionCache' : ('SetPositionCacheSize', 0, 0),
     887    'GetPositionCache' : ('GetPositionCacheSize', 0, 0),
    908888
    909889    'GetLexerLanguage' :(0,
    910890     'wxString %s() const;',
    methodOverrideMap = { 
    919899         SendMsg(msg, 0, (sptr_t)buf);
    920900         mbuf.UngetWriteBuf(len);
    921901         mbuf.AppendByte(0);
    922          return stc2wx(buf);''',
    923 
    924          ('Retrieve the lexing language of the document.',)),
     902         return stc2wx(buf);'''
     903    ),
    925904
    926     'SetFontQuality' : (None, 0, 0, 0),
    927     'GetFontQuality' : (None, 0, 0, 0),
    928     'SetSelection' : (None, 0, 0, 0),
     905    'SetFontQuality' : (None, 0, 0),
     906    'GetFontQuality' : (None, 0, 0),
     907    'SetSelection' : (None, 0, 0),
    929908
    930909    'GetCharacterPointer' : (0,
    931910                             'const char* %s() const;',
    932911                             'const char* %s() const {\n'
    933                              '    return (const char*)SendMsg(%s, 0, 0);',
    934                              0),
    935    
     912                             '    return (const char*)SendMsg(%s, 0, 0);'
     913                            ),
     914
    936915    'GetRangePointer' : (0,
    937916                             'const char* %s(int position, int rangeLength) const;',
    938917                             'const char* %s(int position, int rangeLength) const {\n'
    939                              '    return (const char*)SendMsg(%s, position, rangeLength);',
    940                              0),
    941    
     918                             '    return (const char*)SendMsg(%s, position, rangeLength);'
     919                        ),
    942920
    943921    'GetWordChars' :
    944922    (0,
    methodOverrideMap = { 
    954932         SendMsg(msg, 0, (sptr_t)buf);
    955933         mbuf.UngetWriteBuf(len);
    956934         mbuf.AppendByte(0);
    957          return stc2wx(buf);''',
    958 
    959      ('Get the set of characters making up words for when moving or selecting by word.',)),
     935         return stc2wx(buf);'''
     936    ),
    960937
    961938    'GetTag' :
    962939    (0,
    methodOverrideMap = { 
    972949         SendMsg(msg, tagNumber, (sptr_t)buf);
    973950         mbuf.UngetWriteBuf(len);
    974951         mbuf.AppendByte(0);
    975          return stc2wx(buf);''',
    976      0),
     952         return stc2wx(buf);'''
     953    ),
    977954
    978955    'GetWhitespaceChars' :
    979956    (0,
    methodOverrideMap = { 
    989966         SendMsg(msg, 0, (sptr_t)buf);
    990967         mbuf.UngetWriteBuf(len);
    991968         mbuf.AppendByte(0);
    992          return stc2wx(buf);''',
    993      0),
     969         return stc2wx(buf);'''
     970    ),
    994971
    995972
    996973    'GetPunctuationChars' :
    methodOverrideMap = { 
    1007984         SendMsg(msg, 0, (sptr_t)buf);
    1008985         mbuf.UngetWriteBuf(len);
    1009986         mbuf.AppendByte(0);
    1010          return stc2wx(buf);''',
    1011      0),
     987         return stc2wx(buf);'''
     988    ),
    1012989
    1013990
    1014991    'PropertyNames' :
    methodOverrideMap = { 
    10251002         SendMsg(msg, 0, (sptr_t)buf);
    10261003         mbuf.UngetWriteBuf(len);
    10271004         mbuf.AppendByte(0);
    1028          return stc2wx(buf);''',
    1029      0),
     1005         return stc2wx(buf);'''
     1006    ),
    10301007
    10311008
    10321009
    methodOverrideMap = { 
    10441021         SendMsg(msg, (sptr_t)(const char*)wx2stc(name), (sptr_t)buf);
    10451022         mbuf.UngetWriteBuf(len);
    10461023         mbuf.AppendByte(0);
    1047          return stc2wx(buf);''',
    1048      0),
     1024         return stc2wx(buf);'''
     1025    ),
    10491026
    10501027
    10511028
    methodOverrideMap = { 
    10631040         SendMsg(msg, 0, (sptr_t)buf);
    10641041         mbuf.UngetWriteBuf(len);
    10651042         mbuf.AppendByte(0);
    1066          return stc2wx(buf);''',
    1067      0),
    1068      
     1043         return stc2wx(buf);'''
     1044    ),
    10691045
    10701046    'MarkerDefineRGBAImage' :
    10711047    (0,
    10721048    'void %s(int markerNumber, const unsigned char* pixels);',
    10731049    '''void %s(int markerNumber, const unsigned char* pixels) {
    1074            SendMsg(%s, markerNumber, (sptr_t)pixels);''',
    1075     0),
     1050           SendMsg(%s, markerNumber, (sptr_t)pixels);'''
     1051    ),
    10761052
    10771053
    10781054    'RegisterRGBAImage' :
    10791055    (0,
    10801056    'void %s(int type, const unsigned char* pixels);',
    10811057    '''void %s(int type, const unsigned char* pixels) {
    1082            SendMsg(%s, type, (sptr_t)pixels);''',
    1083     0),
     1058           SendMsg(%s, type, (sptr_t)pixels);'''
     1059    ),
    10841060
    10851061
    10861062    # I think these are only available on the native OSX backend, so
    10871063    # don't add them to the wx API...
    1088     'FindIndicatorShow' : (None, 0,0,0),
    1089     'FindIndicatorFlash' : (None, 0,0,0),
    1090     'FindIndicatorHide' : (None, 0,0,0),
     1064    'FindIndicatorShow' : (None, 0,0),
     1065    'FindIndicatorFlash' : (None, 0,0),
     1066    'FindIndicatorHide' : (None, 0,0),
    10911067
    10921068    'CreateLoader' :
    10931069    (0,
    10941070     'void* %s(int bytes) const;',
    10951071     """void* %s(int bytes) const {
    1096          return (void*)(sptr_t)SendMsg(%s, bytes); """,
    1097      0),
     1072         return (void*)(sptr_t)SendMsg(%s, bytes); """
     1073    ),
    10981074
    10991075    'GetRepresentation' :
    11001076    (0,
    methodOverrideMap = { 
    11091085         SendMsg(msg, (sptr_t)(const char*)wx2stc(encodedCharacter), (sptr_t)buf);
    11101086         mbuf.UngetWriteBuf(len);
    11111087         mbuf.AppendByte(0);
    1112          return stc2wx(buf);''',
    1113      0),
     1088         return stc2wx(buf);'''
     1089    ),
    11141090
    11151091     'PrivateLexerCall' :
    11161092     (0,
    11171093      'void* %s(int operation, void* pointer);',
    11181094      """void* %s(int operation, void* pointer) {
    1119            return (void*)(sptr_t)SendMsg(%s, operation, (sptr_t)pointer); """,
    1120       0),
    1121      
    1122     'GetMultiPaste' :
    1123     (0, 0, 0,
    1124     ('Retrieve the effect of pasting when there are multiple selections.',)),
     1095           return (void*)(sptr_t)SendMsg(%s, operation, (sptr_t)pointer); """
     1096     ),
    11251097
    11261098    'GetSubStyleBases' :
    11271099    (0,
    methodOverrideMap = { 
    11361108         SendMsg(msg, 0, (sptr_t)buf);
    11371109         mbuf.UngetWriteBuf(len);
    11381110         mbuf.AppendByte(0);
    1139          return stc2wx(buf);''',
    1140      0),
    1141    
    1142     '' : ('', 0, 0, 0),
     1111         return stc2wx(buf);'''
     1112    ),
     1113
     1114    '' : ('', 0, 0),
    11431115
    11441116    }
    11451117
    def processIface(iface, h_tmplt, cpp_tmplt, ih_tmplt, h_dest, cpp_dest, docstr_d 
    12151187        else:
    12161188            print('***** Unknown line type: %s' % line)
    12171189
     1190    # build the items for the table of contents in the interface header
     1191    tableitems=''
     1192    firstitem=True
     1193    for category, title, description  in categoriesList:
     1194        if firstitem:
     1195            firstitem=False
     1196        else:
     1197            tableitems+='\n'
     1198        tableitems+='    - @ref_member_group{'+category+', '+title+'}'
     1199
    12181200    # process templates
    12191201    data = {}
    12201202    data['VALUES'] = processVals(values)
    def processIface(iface, h_tmplt, cpp_tmplt, ih_tmplt, h_dest, cpp_dest, docstr_d 
    12231205    data['METHOD_DEFS'] = defs
    12241206    data['METHOD_IDEFS'] = idefs
    12251207    data['METHOD_IMPS'] = imps
     1208    data['TABLE_OF_CONTENTS'] = tableitems
    12261209
    12271210    # get template text
    12281211    h_text = open(h_tmplt).read()
    def processMethods(methods): 
    12881271    idefs = []
    12891272    imps = []
    12901273    dstr = []
     1274    piecesForInterface = {}
    12911275
    1292     for retType, name, number, param1, param2, docs, is_const, is_override in methods:
     1276    # Initialize each of the piecesForInterface with an empty list
     1277    for c in categoriesList:
     1278        piecesForInterface[c[0]]=[]
     1279
     1280    for retType, interfName, number, param1, param2, docs, is_const, is_override in methods:
    12931281        retType = retTypeMap.get(retType, retType)
    12941282        params = makeParamString(param1, param2)
    12951283
    1296         name, theDef, theImp, docs = checkMethodOverride(name, number, docs)
     1284        name, theDef, theImp = checkMethodOverride(interfName, number)
    12971285
    12981286        if name is None:
    12991287            continue
    13001288
     1289        category, docs, docsLong = buildDocs(interfName, docs)
     1290
    13011291        # Build docstrings
    13021292        st = 'DocStr(wxStyledTextCtrl::%s,\n' \
    13031293             '"%s", "");\n' % (name, joinWithNewLines(docs))
    def processMethods(methods): 
    13221312          theDef = theDef.replace(' wxOVERRIDE', '')
    13231313
    13241314        # Build the method definition for the interface .h file
     1315        intrflines = []
    13251316        if docs:
    1326             idefs.append('')
    1327             idefs.append('    /**')
     1317            intrflines.append('')
     1318            intrflines.append('    /**')
    13281319            for x in docs:
    1329                 idefs.append('        ' + x)
    1330             idefs.append('    */')
     1320                intrflines.append('        ' + x)
     1321
     1322            if docsLong != 0:
     1323                intrflines.append('')
     1324                for y in docsLong:
     1325                    intrflines.append('        ' + y)
     1326            intrflines.append('    */')
     1327        else:
     1328            print('warning: ' + name + ' is undocumented.')
     1329
    13311330        if name == 'GetCurLine':
    1332             idefs.append('    wxString GetCurLine(int* linePos=NULL);')
     1331            intrflines.append('    wxString GetCurLine(int* linePos=NULL);')
    13331332        else:
    1334             idefs.append(theDef)
    1335                      
     1333            intrflines.append(theDef)
     1334
     1335        piecesForInterface[category]+=intrflines
     1336
     1337
    13361338        # Build the method implementation string
    13371339        if docs:
    13381340            imps.append('')
    def processMethods(methods): 
    13581360            theImp = theImp + ';\n}'
    13591361        imps.append(theImp)
    13601362
     1363    # For the interface file, merge all the pieces into one list
     1364    for c in categoriesList:
     1365        idefs.append('')
     1366        idefs.append('    /**')
     1367        idefs.append('        @member_group_name{' + c[0] + ', ' + c[1] + '}')
    13611368
    1362     return joinWithNewLines(defs), joinWithNewLines(imps), joinWithNewLines(dstr), joinWithNewLines(idefs)
     1369        if c[2] != 0:
     1370            idefs.append('')
     1371            for z in c[2]:
     1372                idefs.append('        ' + z)
     1373
     1374        idefs.append('    */')
     1375        idefs.append('    //@{')
    13631376
     1377        idefs+=piecesForInterface[c[0]]
     1378        idefs.append('')
     1379        idefs.append('    //@}')
     1380
     1381    return joinWithNewLines(defs), joinWithNewLines(imps), joinWithNewLines(dstr), joinWithNewLines(idefs)
    13641382
    13651383#----------------------------------------------------------------------------
    13661384
    1367 def checkMethodOverride(name, number, docs):
     1385def checkMethodOverride(name, number):
    13681386    theDef = theImp = None
    13691387    if name in methodOverrideMap:
    13701388        item = methodOverrideMap[name]
    def checkMethodOverride(name, number, docs): 
    13761394                theDef = '    ' + (item[1] % name)
    13771395            if item[2] != 0:
    13781396                theImp = item[2] % ('wxStyledTextCtrl::'+name, number) + '\n}'
    1379             if item[3] != 0:
    1380                 docs = item[3]
    13811397        except:
    13821398            print("************* " + name)
    13831399            raise
    13841400
    1385     return name, theDef, theImp, docs
     1401    return name, theDef, theImp
    13861402
    13871403#----------------------------------------------------------------------------
    13881404
  • src/stc/scintilla/README.txt

    diff --git a/src/stc/scintilla/README.txt b/src/stc/scintilla/README.txt
    index cea8c56..79de26b 100644
    a b that list. Also, for any enums that begin with 'SCXX_' instead of 
    4646'SC_', add an entry to valPrefixes to make sure the new names for
    4747constants are generated consistently.
    4848
    49 7. Run gen_iface.py.
     497. Run gen_iface.py.  It's best to use python 2.6 or later.  If
     50using an earlier version, please delete any .pyc files generated.
    5051
    51528. Any other new methods should be checked to ensure that the
    5253generated code is appropriate for what they are doing and if not then
    instead. 
    56579. Add documentation code for any new methods to
    5758interface/wx/stc/stc.h, also check any documentation-only changes from
    5859Scintilla.iface and see if the existing docs for those items should be
    59 updated too.
     60updated too.  For new functions in Scintilla.iface, an entry should be
     61added to the docsMap and sinceAnnotations dictionaries in gen_docs.py.
    6062
    616310. Apply the fix for scintilla/src/UniConversion.h based on commit by
    6264Vadim Zeitlin <vadim@wxwidgets.org> from March 5th, 2016.
  • src/stc/stc.cpp

    diff --git a/src/stc/stc.cpp b/src/stc/stc.cpp
    index fad8f97..c45d240 100644
    a b void wxStyledTextCtrl::InsertText(int pos, const wxString& text) 
    287287    SendMsg(SCI_INSERTTEXT, pos, (sptr_t)(const char*)wx2stc(text));
    288288}
    289289
    290 // Change the text that is being inserted in response to SC_MOD_INSERTCHECK
     290// Change the text that is being inserted in response to wxSTC_MOD_INSERTCHECK
    291291void wxStyledTextCtrl::ChangeInsertion(int length, const wxString& text)
    292292{
    293293    SendMsg(SCI_CHANGEINSERTION, length, (sptr_t)(const char*)wx2stc(text));
    bool wxStyledTextCtrl::GetUndoCollection() const 
    409409}
    410410
    411411// Are white space characters currently visible?
    412 // Returns one of SCWS_* constants.
     412// Returns one of wxSTC_WS_* constants.
    413413int wxStyledTextCtrl::GetViewWhiteSpace() const
    414414{
    415415    return SendMsg(SCI_GETVIEWWS, 0, 0);
    void wxStyledTextCtrl::SetViewWhiteSpace(int viewWS) 
    422422}
    423423
    424424// Retrieve the current tab draw mode.
    425 // Returns one of SCTD_* constants.
     425// Returns one of wxSTC_TD_* constants.
    426426int wxStyledTextCtrl::GetTabDrawMode() const
    427427{
    428428    return SendMsg(SCI_GETTABDRAWMODE, 0, 0);
    int wxStyledTextCtrl::PositionFromPoint(wxPoint pt) const { 
    440440}
    441441
    442442// Find the position from a point within the window but return
    443 // INVALID_POSITION if not close to text.
     443// wxSTC_INVALID_POSITION if not close to text.
    444444int wxStyledTextCtrl::PositionFromPointClose(int x, int y)
    445445{
    446446    return SendMsg(SCI_POSITIONFROMPOINTCLOSE, x, y);
    void wxStyledTextCtrl::SetAnchor(int anchor) 
    466466}
    467467
    468468// Retrieve the text of the line containing the caret.
    469 // Returns the index of the caret on the line.
    470 // Result is NUL-terminated.
    471469wxString wxStyledTextCtrl::GetCurLine(int* linePos) {
    472470        int len = LineLength(GetCurrentLine());
    473471        if (!len) {
    void wxStyledTextCtrl::ConvertEOLs(int eolMode) 
    497495    SendMsg(SCI_CONVERTEOLS, eolMode, 0);
    498496}
    499497
    500 // Retrieve the current end of line mode - one of CRLF, CR, or LF.
     498// Retrieve the current end of line mode - one of wxSTC_EOL_CRLF, wxSTC_EOL_CR, or wxSTC_EOL_LF.
    501499int wxStyledTextCtrl::GetEOLMode() const
    502500{
    503501    return SendMsg(SCI_GETEOLMODE, 0, 0);
    int wxStyledTextCtrl::GetMarginCursor(int margin) const 
    755753    return SendMsg(SCI_GETMARGINCURSORN, margin, 0);
    756754}
    757755
    758 // Set the background colour of a margin. Only visible for SC_MARGIN_COLOUR.
     756// Set the background colour of a margin. Only visible for wxSTC_MARGIN_COLOUR.
    759757void wxStyledTextCtrl::SetMarginBackground(int margin, const wxColour& back)
    760758{
    761759    SendMsg(SCI_SETMARGINBACKN, margin, wxColourAsLong(back));
    int wxStyledTextCtrl::StyleGetWeight(int style) const 
    958956}
    959957
    960958// Set the character set of the font in a style.
    961 // Converts the Scintilla character set values to a wxFontEncoding.
    962959void wxStyledTextCtrl::StyleSetCharacterSet(int style, int characterSet) {
    963960        wxFontEncoding encoding;
    964961
    void wxStyledTextCtrl::TargetWholeDocument() 
    20742071// Replace the target text with the argument text after \\d processing.
    20752072// Text is counted so it can contain NULs.
    20762073// Looks for \\d where d is between 1 and 9 and replaces these with the strings
    2077 // matched in the last search operation which were surrounded by \( and \).
     2074// matched in the last search operation which were surrounded by \\( and \\).
    20782075// Returns the length of the replacement text including any change
    20792076// caused by processing the \\d patterns.
    20802077
    void wxStyledTextCtrl::CallTipSetForegroundHighlight(const wxColour& fore) 
    21582155    SendMsg(SCI_CALLTIPSETFOREHLT, wxColourAsLong(fore), 0);
    21592156}
    21602157
    2161 // Enable use of STYLE_CALLTIP and set call tip tab size in pixels.
     2158// Enable use of wxSTC_STYLE_CALLTIP and set call tip tab size in pixels.
    21622159void wxStyledTextCtrl::CallTipUseStyle(int tabSize)
    21632160{
    21642161    SendMsg(SCI_CALLTIPUSESTYLE, tabSize, 0);
    int wxStyledTextCtrl::GetWrapStartIndent() const 
    24372434    return SendMsg(SCI_GETWRAPSTARTINDENT, 0, 0);
    24382435}
    24392436
    2440 // Sets how wrapped sublines are placed. Default is fixed.
     2437// Sets how wrapped sublines are placed. Default is wxSTC_WRAPINDENT_FIXED.
    24412438void wxStyledTextCtrl::SetWrapIndentMode(int wrapIndentMode)
    24422439{
    24432440    SendMsg(SCI_SETWRAPINDENTMODE, wrapIndentMode, 0);
    24442441}
    24452442
    2446 // Retrieve how wrapped sublines are placed. Default is fixed.
     2443// Retrieve how wrapped sublines are placed. Default is wxSTC_WRAPINDENT_FIXED.
    24472444int wxStyledTextCtrl::GetWrapIndentMode() const
    24482445{
    24492446    return SendMsg(SCI_GETWRAPINDENTMODE, 0, 0);
    bool wxStyledTextCtrl::GetScrollWidthTracking() const 
    24862483}
    24872484
    24882485// Measure the pixel width of some text in a particular style.
    2489 // NUL terminated text argument.
    24902486// Does not handle tab or control characters.
    24912487int wxStyledTextCtrl::TextWidth(int style, const wxString& text)
    24922488{
    int wxStyledTextCtrl::GetMultiPaste() const 
    25792575}
    25802576
    25812577// Retrieve the value of a tag from a regular expression search.
    2582 // Result is NUL-terminated.
    25832578wxString wxStyledTextCtrl::GetTag(int tagNumber) const {
    25842579         const int msg = SCI_GETTAG;
    25852580         int len = SendMsg(msg, tagNumber, (sptr_t)NULL);
    void wxStyledTextCtrl::BraceBadLightIndicator(bool useSetting, int indicator) 
    30133008    SendMsg(SCI_BRACEBADLIGHTINDICATOR, useSetting, indicator);
    30143009}
    30153010
    3016 // Find the position of a matching brace or INVALID_POSITION if no match.
     3011// Find the position of a matching brace or wxSTC_INVALID_POSITION if no match.
    30173012// The maxReStyle must be 0 for now. It may be defined in a future release.
    30183013int wxStyledTextCtrl::BraceMatch(int pos, int maxReStyle){
    30193014        wxASSERT_MSG(maxReStyle==0,
    int wxStyledTextCtrl::GetEdgeMode() const 
    30693064    return SendMsg(SCI_GETEDGEMODE, 0, 0);
    30703065}
    30713066
    3072 // The edge may be displayed by a line (EDGE_LINE/EDGE_MULTILINE) or by highlighting text that
    3073 // goes beyond it (EDGE_BACKGROUND) or not displayed at all (EDGE_NONE).
     3067// The edge may be displayed by a line (wxSTC_EDGE_LINE/wxSTC_EDGE_MULTILINE) or by highlighting text that
     3068// goes beyond it (wxSTC_EDGE_BACKGROUND) or not displayed at all (wxSTC_EDGE_NONE).
    30743069void wxStyledTextCtrl::SetEdgeMode(int edgeMode)
    30753070{
    30763071    SendMsg(SCI_SETEDGEMODE, edgeMode, 0);
    bool wxStyledTextCtrl::GetMouseWheelCaptures() const 
    32233218    return SendMsg(SCI_GETMOUSEWHEELCAPTURES, 0, 0) != 0;
    32243219}
    32253220
    3226 // Sets the cursor to one of the SC_CURSOR* values.
     3221// Sets the cursor to one of the wxSTC_CURSOR* values.
    32273222void wxStyledTextCtrl::SetSTCCursor(int cursorType)
    32283223{
    32293224    SendMsg(SCI_SETCURSOR, cursorType, 0);
    void wxStyledTextCtrl::DelLineRight() 
    32933288    SendMsg(SCI_DELLINERIGHT, 0, 0);
    32943289}
    32953290
    3296 // Get and Set the xOffset (ie, horizontal scroll position).
     3291// Set the xOffset (ie, horizontal scroll position).
    32973292void wxStyledTextCtrl::SetXOffset(int xOffset)
    32983293{
    32993294    SendMsg(SCI_SETXOFFSET, xOffset, 0);
    33003295}
     3296
     3297// Get the xOffset (ie, horizontal scroll position).
    33013298int wxStyledTextCtrl::GetXOffset() const
    33023299{
    33033300    return SendMsg(SCI_GETXOFFSET, 0, 0);
    void wxStyledTextCtrl::SetYCaretPolicy(int caretPolicy, int caretSlop) 
    33233320    SendMsg(SCI_SETYCARETPOLICY, caretPolicy, caretSlop);
    33243321}
    33253322
    3326 // Set printing to line wrapped (SC_WRAP_WORD) or not line wrapped (SC_WRAP_NONE).
     3323// Set printing to line wrapped (wxSTC_WRAP_WORD) or not line wrapped (wxSTC_WRAP_NONE).
    33273324void wxStyledTextCtrl::SetPrintWrapMode(int wrapMode)
    33283325{
    33293326    SendMsg(SCI_SETPRINTWRAPMODE, wrapMode, 0);
    void wxStyledTextCtrl::CopyText(int length, const wxString& text) 
    34423439    SendMsg(SCI_COPYTEXT, length, (sptr_t)(const char*)wx2stc(text));
    34433440}
    34443441
    3445 // Set the selection mode to stream (SC_SEL_STREAM) or rectangular (SC_SEL_RECTANGLE/SC_SEL_THIN) or
    3446 // by lines (SC_SEL_LINES).
     3442// Set the selection mode to stream (wxSTC_SEL_STREAM) or rectangular (wxSTC_SEL_RECTANGLE/wxSTC_SEL_THIN) or
     3443// by lines (wxSTC_SEL_LINES).
    34473444void wxStyledTextCtrl::SetSelectionMode(int selectionMode)
    34483445{
    34493446    SendMsg(SCI_SETSELECTIONMODE, selectionMode, 0);
    int wxStyledTextCtrl::GetSelectionMode() const 
    34553452    return SendMsg(SCI_GETSELECTIONMODE, 0, 0);
    34563453}
    34573454
    3458 // Retrieve the position of the start of the selection at the given line (INVALID_POSITION if no selection on this line).
     3455// Retrieve the position of the start of the selection at the given line (wxSTC_INVALID_POSITION if no selection on this line).
    34593456int wxStyledTextCtrl::GetLineSelStartPosition(int line)
    34603457{
    34613458    return SendMsg(SCI_GETLINESELSTARTPOSITION, line, 0);
    34623459}
    34633460
    3464 // Retrieve the position of the end of the selection at the given line (INVALID_POSITION if no selection on this line).
     3461// Retrieve the position of the end of the selection at the given line (wxSTC_INVALID_POSITION if no selection on this line).
    34653462int wxStyledTextCtrl::GetLineSelEndPosition(int line)
    34663463{
    34673464    return SendMsg(SCI_GETLINESELENDPOSITION, line, 0);
    int wxStyledTextCtrl::CharPositionFromPoint(int x, int y) 
    40774074}
    40784075
    40794076// Find the position of a character from a point within the window.
    4080 // Return INVALID_POSITION if not close to text.
     4077// Return wxSTC_INVALID_POSITION if not close to text.
    40814078int wxStyledTextCtrl::CharPositionFromPointClose(int x, int y)
    40824079{
    40834080    return SendMsg(SCI_CHARPOSITIONFROMPOINTCLOSE, x, y);
    int wxStyledTextCtrl::GetVirtualSpaceOptions() const 
    43204317// On GTK+, allow selecting the modifier key to use for mouse-based
    43214318// rectangular selection. Often the window manager requires Alt+Mouse Drag
    43224319// for moving windows.
    4323 // Valid values are SCMOD_CTRL(default), SCMOD_ALT, or SCMOD_SUPER.
     4320// Valid values are wxSTC_KEYMOD_CTRL (default), wxSTC_KEYMOD_ALT, or wxSTC_KEYMOD_SUPER.
    43244321void wxStyledTextCtrl::SetRectangularSelectionModifier(int modifier)
    43254322{
    43264323    SendMsg(SCI_SETRECTANGULARSELECTIONMODIFIER, modifier, 0);
    void wxStyledTextCtrl::SetRepresentation(const wxString& encodedCharacter, const 
    45504547}
    45514548
    45524549// Set the way a character is drawn.
    4553 // Result is NUL-terminated.
    45544550wxString wxStyledTextCtrl::GetRepresentation(const wxString& encodedCharacter) const {
    45554551         int msg = SCI_GETREPRESENTATION;
    45564552         int len = SendMsg(msg, (sptr_t)(const char*)wx2stc(encodedCharacter), (sptr_t)NULL);
    void wxStyledTextCtrl::LoadLexerLibrary(const wxString& path) 
    46244620    SendMsg(SCI_LOADLEXERLIBRARY, 0, (sptr_t)(const char*)wx2stc(path));
    46254621}
    46264622
    4627 // Retrieve a 'property' value previously set with SetProperty.
     4623// Retrieve a "property" value previously set with SetProperty.
    46284624wxString wxStyledTextCtrl::GetProperty(const wxString& key) {
    46294625         int len = SendMsg(SCI_GETPROPERTY, (sptr_t)(const char*)wx2stc(key), 0);
    46304626         if (!len) return wxEmptyString;
    wxString wxStyledTextCtrl::GetProperty(const wxString& key) { 
    46374633         return stc2wx(buf);
    46384634}
    46394635
    4640 // Retrieve a 'property' value previously set with SetProperty,
    4641 // with '$()' variable replacement on returned buffer.
     4636// Retrieve a "property" value previously set with SetProperty,
     4637// with "$()" variable replacement on returned buffer.
    46424638wxString wxStyledTextCtrl::GetPropertyExpanded(const wxString& key) {
    46434639         int len = SendMsg(SCI_GETPROPERTYEXPANDED, (uptr_t)(const char*)wx2stc(key), 0);
    46444640         if (!len) return wxEmptyString;
    wxString wxStyledTextCtrl::GetPropertyExpanded(const wxString& key) { 
    46514647         return stc2wx(buf);
    46524648}
    46534649
    4654 // Retrieve a 'property' value previously set with SetProperty,
    4655 // interpreted as an int AFTER any '$()' variable replacement.
     4650// Retrieve a "property" value previously set with SetProperty,
     4651// interpreted as an int AFTER any "$()" variable replacement.
    46564652int wxStyledTextCtrl::GetPropertyInt(const wxString &key, int defaultValue) const {
    46574653        return SendMsg(SCI_GETPROPERTYINT, (uptr_t)(const char*)wx2stc(key), defaultValue);
    46584654}
    void* wxStyledTextCtrl::PrivateLexerCall(int operation, void* pointer) { 
    46824678           return (void*)(sptr_t)SendMsg(SCI_PRIVATELEXERCALL, operation, (sptr_t)pointer);
    46834679}
    46844680
    4685 // Retrieve a '\n' separated list of properties understood by the current lexer.
    4686 // Result is NUL-terminated.
     4681// Retrieve a '\\n' separated list of properties understood by the current lexer.
    46874682wxString wxStyledTextCtrl::PropertyNames() const {
    46884683         const int msg = SCI_PROPERTYNAMES;
    46894684         int len = SendMsg(msg, 0, (sptr_t)NULL);
    int wxStyledTextCtrl::PropertyType(const wxString& name) 
    47044699}
    47054700
    47064701// Describe a property.
    4707 // Result is NUL-terminated.
    47084702wxString wxStyledTextCtrl::DescribeProperty(const wxString& name) const {
    47094703         const int msg = SCI_DESCRIBEPROPERTY;
    47104704         int len = SendMsg(msg, (sptr_t)(const char*)wx2stc(name), (sptr_t)NULL);
    wxString wxStyledTextCtrl::DescribeProperty(const wxString& name) const { 
    47184712         return stc2wx(buf);
    47194713}
    47204714
    4721 // Retrieve a '\n' separated list of descriptions of the keyword sets understood by the current lexer.
    4722 // Result is NUL-terminated.
     4715// Retrieve a '\\n' separated list of descriptions of the keyword sets understood by the current lexer.
    47234716wxString wxStyledTextCtrl::DescribeKeyWordSets() const {
    47244717         const int msg = SCI_DESCRIBEKEYWORDSETS;
    47254718         int len = SendMsg(msg, 0, (sptr_t)NULL);
    int wxStyledTextCtrl::DistanceToSecondaryStyles() const 
    47904783}
    47914784
    47924785// Get the set of base styles that can be extended with sub styles
    4793 // Result is NUL-terminated.
    47944786wxString wxStyledTextCtrl::GetSubStyleBases() const {
    47954787         int msg = SCI_GETSUBSTYLEBASES;
    47964788         int len = SendMsg(msg, 0, (sptr_t)NULL);
  • src/stc/stc.interface.h.in

    diff --git a/src/stc/stc.interface.h.in b/src/stc/stc.interface.h.in
    index 3603715..2e4d121 100644
    a b  
    5050
    5151    Links for quick access to the various categories of wxStyledTextCtrl functions:
    5252    - @ref_member_group{ctor, Constructors and related methods}
    53     - @ref_member_group{scintilla_functions, Scintilla methods}
     53%(TABLE_OF_CONTENTS)s
    5454    - @ref_member_group{additional_methods, Additional wxStyledTextCtrl methods}
    5555    - @ref_member_group{raw_variants , Raw variants}
    5656    - @ref_member_group{text_entry, Text entry methods}
    public: 
    181181
    182182    // Scintilla methods (generated by gen_iface.py)
    183183    // ----------------------------------------------
    184     ///@member_group_name{scintilla_functions, Scintilla methods}
    185     //@{
    186184
    187185    // **** Generated methods {{{
    188186
    public: 
    190188
    191189    //}}}
    192190
    193     //@}
    194 
    195191
    196192    // Manually declared methods
    197193    // ----------------------------------------------