Show
Ignore:
Timestamp:
10/09/08 09:30:57 (3 months ago)
Author:
FM
Message:

revised richtext headers

Files:
1 modified

Legend:

Unmodified
Added
Removed

  • wxWidgets/trunk/interface/wx/richtext/richtextctrl.h

    r55912 r56199  
    11///////////////////////////////////////////////////////////////////////////// 
    22// Name:        richtext/richtextctrl.h 
    3 // Purpose:     interface of wxRichTextEvent 
     3// Purpose:     interface of wxRichTextCtrl and wxRichTextEvent 
    44// Author:      wxWidgets team 
    55// RCS-ID:      $Id$ 
    … …  
    1212    This is the event class for wxRichTextCtrl notifications. 
    1313 
     14    @beginEventTable{wxRichTextEvent} 
     15    @event{EVT_RICHTEXT_CHARACTER(id, func)} 
     16        Process a wxEVT_COMMAND_RICHTEXT_CHARACTER event, generated when the user 
     17        presses a character key. Valid event functions: GetFlags, GetPosition, GetCharacter. 
     18    @event{EVT_RICHTEXT_DELETE(id, func)} 
     19        Process a wxEVT_COMMAND_RICHTEXT_DELETE event, generated when the user 
     20        presses the backspace or delete key. Valid event functions: GetFlags, GetPosition. 
     21    @event{EVT_RICHTEXT_RETURN(id, func)} 
     22        Process a wxEVT_COMMAND_RICHTEXT_RETURN event, generated when the user 
     23        presses the return key. Valid event functions: GetFlags, GetPosition. 
     24    @event{EVT_RICHTEXT_STYLE_CHANGED(id, func)} 
     25        Process a wxEVT_COMMAND_RICHTEXT_STYLE_CHANGED event, generated when 
     26        styling has been applied to the control. Valid event functions: GetPosition, GetRange. 
     27    @event{EVT_RICHTEXT_STYLESHEET_CHANGED(id, func)} 
     28        Process a wxEVT_COMMAND_RICHTEXT_STYLESHEET_CHANGING event, generated 
     29        when the control's stylesheet has changed, for example the user added, 
     30        edited or deleted a style. Valid event functions: GetRange, GetPosition. 
     31    @event{EVT_RICHTEXT_STYLESHEET_REPLACING(id, func)} 
     32        Process a wxEVT_COMMAND_RICHTEXT_STYLESHEET_REPLACING event, generated 
     33        when the control's stylesheet is about to be replaced, for example when 
     34        a file is loaded into the control. 
     35        Valid event functions: Veto, GetOldStyleSheet, GetNewStyleSheet. 
     36    @event{EVT_RICHTEXT_STYLESHEET_REPLACED(id, func)} 
     37        Process a wxEVT_COMMAND_RICHTEXT_STYLESHEET_REPLACED event, generated 
     38        when the control's stylesheet has been replaced, for example when a file 
     39        is loaded into the control. 
     40        Valid event functions: GetOldStyleSheet, GetNewStyleSheet. 
     41    @event{EVT_RICHTEXT_CONTENT_INSERTED(id, func)} 
     42        Process a wxEVT_COMMAND_RICHTEXT_CONTENT_INSERTED event, generated when 
     43        content has been inserted into the control. 
     44        Valid event functions: GetPosition, GetRange. 
     45    @event{EVT_RICHTEXT_CONTENT_DELETED(id, func)} 
     46        Process a wxEVT_COMMAND_RICHTEXT_CONTENT_DELETED event, generated when 
     47        content has been deleted from the control. 
     48        Valid event functions: GetPosition, GetRange. 
     49    @event{EVT_RICHTEXT_BUFFER_RESET(id, func)} 
     50        Process a wxEVT_COMMAND_RICHTEXT_BUFFER_RESET event, generated when the 
     51        buffer has been reset by deleting all content. 
     52        You can use this to set a default style for the first new paragraph. 
     53    @endEventTable 
     54 
    1455    @library{wxrichtext} 
    15     @category{richtext} 
     56    @category{events,richtext} 
    1657*/ 
    1758class wxRichTextEvent : public wxNotifyEvent 
    … …  
    2667        Constructor. 
    2768 
     69        @param commandType 
     70            The type of the event. 
    2871        @param id 
    2972            Window identifier. The value @c wxID_ANY indicates a default value. 
    … …  
    4285 
    4386    /** 
    44         Returns flags indicating modifier keys pressed. Possible values are 
    45         wxRICHTEXT_CTRL_DOWN, 
    46         wxRICHTEXT_SHIFT_DOWN, and wxRICHTEXT_ALT_DOWN. 
     87        Returns flags indicating modifier keys pressed. 
     88 
     89        Possible values are wxRICHTEXT_CTRL_DOWN, wxRICHTEXT_SHIFT_DOWN, and wxRICHTEXT_ALT_DOWN. 
    4790    */ 
    4891    int GetFlags() const; 
    4992 
    5093    /** 
    51         Returns the new style sheet. Can be used in a 
    52         wxEVT_COMMAND_RICHTEXT_STYLESHEET_CHANGING or 
     94        Returns the new style sheet. 
     95 
     96        Can be used in a wxEVT_COMMAND_RICHTEXT_STYLESHEET_CHANGING or 
    5397        wxEVT_COMMAND_RICHTEXT_STYLESHEET_CHANGED event handler. 
    5498    */ 
    … …  
    56100 
    57101    /** 
    58         Returns the old style sheet. Can be used in a 
    59         wxEVT_COMMAND_RICHTEXT_STYLESHEET_CHANGING or 
     102        Returns the old style sheet. 
     103 
     104        Can be used in a wxEVT_COMMAND_RICHTEXT_STYLESHEET_CHANGING or 
    60105        wxEVT_COMMAND_RICHTEXT_STYLESHEET_CHANGED event handler. 
    61106    */ 
    … …  
    78123 
    79124    /** 
    80         Sets flags indicating modifier keys pressed. Possible values are 
    81         wxRICHTEXT_CTRL_DOWN, 
    82         wxRICHTEXT_SHIFT_DOWN, and wxRICHTEXT_ALT_DOWN. 
     125        Sets flags indicating modifier keys pressed. 
     126 
     127        Possible values are wxRICHTEXT_CTRL_DOWN, wxRICHTEXT_SHIFT_DOWN, and wxRICHTEXT_ALT_DOWN. 
    83128    */ 
    84129    void SetFlags(int flags); 
    … …  
    114159 
    115160    wxRichTextCtrl sends notification events: see wxRichTextEvent. 
     161 
    116162    It also sends the standard wxTextCtrl events wxEVT_COMMAND_TEXT_ENTER and 
    117     wxEVT_COMMAND_TEXT_UPDATED, 
    118     and wxTextUrlEvent when URL content is clicked. 
     163    wxEVT_COMMAND_TEXT_UPDATED, and wxTextUrlEvent when URL content is clicked. 
    119164 
    120165    For more information, see the @ref overview_richtextctrl. 
    … …  
    204249    /** 
    205250        Applies the style sheet to the buffer, matching paragraph styles in the sheet 
    206         against named styles 
    207         in the buffer. This might be useful if the styles have changed. If @a sheet is 
    208         @NULL, the 
    209         sheet set with SetStyleSheet is used. 
     251        against named styles in the buffer. 
     252 
     253        This might be useful if the styles have changed. 
     254        If @a sheet is @NULL, the sheet set with SetStyleSheet() is used. 
    210255        Currently this applies paragraph styles only. 
    211256    */ 
    … …  
    223268 
    224269    /** 
    225         Begins using alignment 
     270        Begins using alignment. 
    226271        For alignment values, see wxTextAttr. 
    227272    */ 
    … …  
    260305    /** 
    261306        Begins applying a left indent and subindent in tenths of a millimetre. 
    262         The subindent is an offset from the left edge of the paragraph, and is  
    263         used for all but the first line in a paragraph. A positive value will  
     307        The subindent is an offset from the left edge of the paragraph, and is 
     308        used for all but the first line in a paragraph. A positive value will 
    264309        cause the first line to appear to the left of the subsequent lines, and 
    265310        a negative value will cause the first line to be indented to the right 
    … …  
    280325    /** 
    281326        Begins appling line spacing. @e spacing is a multiple, where 10 means 
    282         single-spacing, 
    283         15 means 1.5 spacing, and 20 means double spacing. The following constants are 
    284         defined for convenience: 
     327        single-spacing, 15 means 1.5 spacing, and 20 means double spacing. 
     328 
     329        The ::wxTextAttrLineSpacing constants are defined for convenience. 
    285330    */ 
    286331    bool BeginLineSpacing(int lineSpacing); 
    287332 
    288333    /** 
    289         Begins using a specified list style. Optionally, you can also pass a level and 
    290         a number. 
     334        Begins using a specified list style. 
     335        Optionally, you can also pass a level and a number. 
    291336    */ 
    292337    bool BeginListStyle(const wxString& listStyle, int level = 1, 
    … …  
    294339 
    295340    /** 
    296         Begins a numbered bullet. This call will be needed for each item in the list, 
    297         and the 
     341        Begins a numbered bullet. 
     342 
     343        This call will be needed for each item in the list, and the 
    298344        application should take care of incrementing the numbering. 
     345 
    299346        @a bulletNumber is a number, usually starting with 1. 
    300347        @a leftIndent and @a leftSubIndent are values in tenths of a millimetre. 
    301         @a bulletStyle is a bitlist of the following values: 
    302          
    303         wxRichTextBuffer uses indentation to render a bulleted item. The left indent is 
    304         the distance between 
    305         the margin and the bullet. The content of the paragraph, including the first 
    306         line, starts 
    307         at leftMargin + leftSubIndent. So the distance between the left edge of the 
    308         bullet and the 
     348        @a bulletStyle is a bitlist of the  ::wxTextAttrBulletStyle values. 
     349 
     350        wxRichTextBuffer uses indentation to render a bulleted item. 
     351        The left indent is the distance between the margin and the bullet. 
     352        The content of the paragraph, including the first line, starts 
     353        at leftMargin + leftSubIndent. 
     354        So the distance between the left edge of the bullet and the 
    309355        left of the actual paragraph is leftSubIndent. 
    310356    */ 
    … …  
    315361    /** 
    316362        Begins paragraph spacing; pass the before-paragraph and after-paragraph spacing 
    317         in tenths of 
    318         a millimetre. 
     363        in tenths of a millimetre. 
    319364    */ 
    320365    bool BeginParagraphSpacing(int before, int after); 
    … …  
    341386 
    342387    /** 
    343         Begins applying a symbol bullet, using a character from the current font. See 
    344         BeginNumberedBullet() for 
    345         an explanation of how indentation is used to render the bulleted paragraph. 
     388        Begins applying a symbol bullet, using a character from the current font. 
     389        See BeginNumberedBullet() for an explanation of how indentation is used 
     390        to render the bulleted paragraph. 
    346391    */ 
    347392    bool BeginSymbolBullet(wxChar symbol, int leftIndent, 
    … …  
    355400 
    356401    /** 
    357         Begins applying wxTEXT_ATTR_URL to the content. Pass a URL and optionally, a 
    358         character style to apply, 
    359         since it is common to mark a URL with a familiar style such as blue text with 
    360         underlining. 
     402        Begins applying wxTEXT_ATTR_URL to the content. 
     403 
     404        Pass a URL and optionally, a character style to apply, since it is common 
     405        to mark a URL with a familiar style such as blue text with underlining. 
    361406    */ 
    362407    bool BeginURL(const wxString& url, 
    … …  
    407452        Clears the list style from the given range, clearing list-related attributes 
    408453        and applying any named paragraph style associated with each paragraph. 
     454 
    409455        @a flags is a bit list of the following: 
    410          wxRICHTEXT_SETSTYLE_WITH_UNDO: specifies that this command will be undoable. 
    411         See also SetListStyle(), PromoteList(), NumberList(). 
     456        - wxRICHTEXT_SETSTYLE_WITH_UNDO: specifies that this command will be undoable. 
     457 
     458        @see SetListStyle(), PromoteList(), NumberList(). 
    412459    */ 
    413460    bool ClearListStyle(const wxRichTextRange& range, 
    … …  
    579626    /** 
    580627        Helper function for extending the selection, returning @true if the selection 
    581         was 
    582         changed. Selections are in caret positions. 
     628        was changed. Selections are in caret positions. 
    583629    */ 
    584630    bool ExtendSelection(long oldPosition, long newPosition, 
    … …  
    586632 
    587633    /** 
    588         Helper function for finding the caret position for the next word. Direction 
    589         is 1 (forward) or -1 (backwards). 
     634        Helper function for finding the caret position for the next word. 
     635        Direction is 1 (forward) or -1 (backwards). 
    590636    */ 
    591637    virtual long FindNextWordPosition(int direction = 1) const; 
    … …  
    598644 
    599645    /** 
    600         Gets the basic (overall) style. This is the style of the whole 
    601         buffer before further styles are applied, unlike the default style, which 
    602         only affects the style currently being applied (for example, setting the default 
    603         style to bold will cause subsequently inserted text to be bold). 
     646        Gets the basic (overall) style. 
     647 
     648        This is the style of the whole buffer before further styles are applied, 
     649        unlike the default style, which only affects the style currently being 
     650        applied (for example, setting the default style to bold will cause 
     651        subsequently inserted text to be bold). 
    604652    */ 
    605653    const wxTextAttr GetBasicStyle() const; 
    … …  
    619667 
    620668    /** 
    621         Returns the caret height and position for the given character position 
     669        Returns the caret height and position for the given character position. 
    622670    */ 
    623671    bool GetCaretPositionForIndex(long position, wxRect& rect); 
    … …  
    630678    /** 
    631679        Returns the current default style, which can be used to change how subsequently 
    632         inserted 
    633         text is displayed. 
     680        inserted text is displayed. 
    634681    */ 
    635682    const wxTextAttr GetDefaultStyle() const; 
    … …  
    652699 
    653700    /** 
    654         Returns flags that change the behaviour of loading or saving. See the 
    655         documentation for each 
    656         handler class to see what flags are relevant for each handler. 
     701        Returns flags that change the behaviour of loading or saving. 
     702        See the documentation for each handler class to see what flags are 
     703        relevant for each handler. 
    657704    */ 
    658705    int GetHandlerFlags() const; 
    … …  
    695742    /** 
    696743        Gets the text for the given range. 
    697         The end point of range is specified as the last character position of the span 
    698         of text, plus one. 
     744        The end point of range is specified as the last character position of 
     745        the span of text, plus one. 
    699746    */ 
    700747    virtual wxString GetRange(long from, long to) const; 
    … …  
    721768        Gets the attributes at the given position. 
    722769        This function gets the combined style - that is, the style you see on the 
    723         screen as a result 
    724         of combining base style, paragraph style and character style attributes. To get 
    725         the character 
    726         or paragraph style alone, use GetUncombinedStyle(). 
     770        screen as a result of combining base style, paragraph style and character 
     771        style attributes. 
     772 
     773        To get the character or paragraph style alone, use GetUncombinedStyle(). 
    727774    */ 
    728775    virtual bool GetStyle(long position, wxTextAttr& style); 
    729776 
    730777    /** 
    731         Gets the attributes common to the specified range. Attributes that differ in 
    732         value within the range will 
    733         not be included in @e style's flags. 
     778        Gets the attributes common to the specified range. 
     779        Attributes that differ in value within the range will not be included 
     780        in @a style flags. 
    734781    */ 
    735782    bool GetStyleForRange(const wxRichTextRange& range, 
    … …  
    737784 
    738785    /** 
    739         Returns the style sheet associated with the control, if any. A style sheet 
    740         allows named 
    741         character and paragraph styles to be applied. 
     786        Returns the style sheet associated with the control, if any. 
     787        A style sheet allows named character and paragraph styles to be applied. 
    742788    */ 
    743789    wxRichTextStyleSheet* GetStyleSheet() const; 
    … …  
    746792        Gets the attributes at the given position. 
    747793        This function gets the @e uncombined style - that is, the attributes associated 
    748         with the 
    749         paragraph or character content, and not necessarily the combined attributes you 
    750         see on the 
    751         screen. To get the combined attributes, use GetStyle(). 
     794        with the paragraph or character content, and not necessarily the combined 
     795        attributes you see on the screen. 
     796        To get the combined attributes, use GetStyle(). 
     797 
    752798        If you specify (any) paragraph attribute in @e style's flags, this function 
    753         will fetch 
    754         the paragraph attributes. Otherwise, it will return the character attributes. 
     799        will fetch the paragraph attributes. 
     800        Otherwise, it will return the character attributes. 
    755801    */ 
    756802    virtual bool GetUncombinedStyle(long position, wxTextAttr& style); 
    … …  
    762808 
    763809    /** 
    764         Internal helper function returning the line for the visible caret position. If 
    765         the caret is 
    766         shown at the very end of the line, it means the next character is actually 
    767         on the following line. So this function gets the line we're expecting to find 
    768         if this is the case. 
     810        Internal helper function returning the line for the visible caret position. 
     811        If the caret is shown at the very end of the line, it means the next character 
     812        is actually on the following line. 
     813        So this function gets the line we're expecting to find if this is the case. 
    769814    */ 
    770815    wxRichTextLine* GetVisibleLineForCaretPosition(long caretPosition) const; 
    771816 
    772817    /** 
    773         Test if this whole range has character attributes of the specified kind. If any 
    774         of the attributes are different within the range, the test fails. You 
    775         can use this to implement, for example, bold button updating. @a style must have 
    776         flags indicating which attributes are of interest. 
     818        Test if this whole range has character attributes of the specified kind. 
     819        If any of the attributes are different within the range, the test fails. 
     820 
     821        You can use this to implement, for example, bold button updating. 
     822        @a style must have flags indicating which attributes are of interest. 
    777823    */ 
    778824    bool HasCharacterAttributes(const wxRichTextRange& range, 
    … …  
    780826 
    781827    /** 
    782         Test if this whole range has paragraph attributes of the specified kind. If any 
    783         of the attributes are different within the range, the test fails. You 
    784         can use this to implement, for example, centering button updating. @a style 
    785         must have 
    786         flags indicating which attributes are of interest. 
     828        Test if this whole range has paragraph attributes of the specified kind. 
     829        If any of the attributes are different within the range, the test fails. 
     830        You can use this to implement, for example, centering button updating. 
     831        @a style must have flags indicating which attributes are of interest. 
    787832    */ 
    788833    bool HasParagraphAttributes(const wxRichTextRange& range, 
    … …  
    818863    /** 
    819864        Returns @true if the user has recently set the default style without moving 
    820         the caret, 
    821         and therefore the UI needs to reflect the default style and not the style at 
    822         the caret. 
     865        the caret, and therefore the UI needs to reflect the default style and not 
     866        the style at the caret. 
     867 
    823868        Below is an example of code that uses this function to determine whether the UI 
    824869        should show that the current style is bold. 
    825          
    826         See also SetAndShowDefaultStyle(). 
     870 
     871        @see SetAndShowDefaultStyle(). 
    827872    */ 
    828873    bool IsDefaultStyleShowing() const; 
    … …  
    854899 
    855900    /** 
    856         Returns @true if all of the selection is aligned according to the specified 
    857         flag. 
     901        Returns @true if all of the selection is aligned according to the specified flag. 
    858902    */ 
    859903    virtual bool IsSelectionAligned(wxTextAttrAlignment alignment); 
    … …  
    875919 
    876920    /** 
    877         Returns @true if the control is single-line. Currently wxRichTextCtrl does not 
    878         support single-line editing. 
     921        Returns @true if the control is single-line. 
     922        Currently wxRichTextCtrl does not support single-line editing. 
    879923    */ 
    880924    bool IsSingleLine() const; 
    … …  
    887931    /** 
    888932        Lays out the buffer, which must be done before certain operations, such as 
    889         setting the caret position. This function should not normally be required by the 
    890         application. 
     933        setting the caret position. 
     934        This function should not normally be required by the application. 
    891935    */ 
    892936    virtual bool LayoutContent(bool onlyVisibleRect = false); 
    893937 
    894938    /** 
    895         Inserts a line break at the current insertion point. A line break forces 
    896         wrapping within a paragraph, and 
    897         can be introduced by using this function, by appending the wxChar value @b 
    898         wxRichTextLineBreakChar to text content, 
    899         or by typing Shift-Return. 
     939        Inserts a line break at the current insertion point. 
     940 
     941        A line break forces wrapping within a paragraph, and can be introduced by 
     942        using this function, by appending the wxChar value @b  wxRichTextLineBreakChar 
     943        to text content, or by typing Shift-Return. 
    900944    */ 
    901945    virtual bool LineBreak(); 
    902946 
    903947    /** 
    904         Loads content into the control's buffer using the given type. If the specified 
    905         type 
    906         is wxRICHTEXT_TYPE_ANY, the type is deduced from the filename extension. 
     948        Loads content into the control's buffer using the given type. 
     949 
     950        If the specified type is wxRICHTEXT_TYPE_ANY, the type is deduced from 
     951        the filename extension. 
     952 
    907953        This function looks for a suitable wxRichTextFileHandler object. 
    908954    */ 
    … …  
    9851031 
    9861032    /** 
    987         Inserts a new paragraph at the current insertion point. See also LineBreak(). 
     1033        Inserts a new paragraph at the current insertion point. @see LineBreak(). 
    9881034    */ 
    9891035    virtual bool Newline(); 
    … …  
    9911037    //@{ 
    9921038    /** 
    993         Numbers the paragraphs in the given range. Pass flags to determine how the 
    994         attributes are set. 
     1039        Numbers the paragraphs in the given range. 
     1040        Pass flags to determine how the attributes are set. 
     1041 
    9951042        Either the style definition or the name of the style definition (in the current 
    9961043        sheet) can be passed. 
     1044 
    9971045        @a flags is a bit list of the following: 
    998          wxRICHTEXT_SETSTYLE_WITH_UNDO: specifies that this command will be undoable. 
    999          wxRICHTEXT_SETSTYLE_RENUMBER: specifies that numbering should start from @e 
    1000         startFrom, otherwise existing attributes are used. 
    1001          wxRICHTEXT_SETSTYLE_SPECIFY_LEVEL: specifies that @a listLevel should be used 
    1002         as the level for all paragraphs, otherwise the current indentation will be used. 
    1003         See also SetListStyle(), PromoteList(), ClearListStyle(). 
     1046        - wxRICHTEXT_SETSTYLE_WITH_UNDO: specifies that this command will be undoable. 
     1047        - wxRICHTEXT_SETSTYLE_RENUMBER: specifies that numbering should start from 
     1048          @a startFrom, otherwise existing attributes are used. 
     1049        - wxRICHTEXT_SETSTYLE_SPECIFY_LEVEL: specifies that @a listLevel should be used 
     1050          as the level for all paragraphs, otherwise the current indentation will be used. 
     1051 
     1052        @see SetListStyle(), PromoteList(), ClearListStyle(). 
    10041053    */ 
    10051054    bool NumberList(const wxRichTextRange& range, 
    … …  
    11291178    //@{ 
    11301179    /** 
    1131         Promotes or demotes the paragraphs in the given range. A positive @a promoteBy 
    1132         produces a smaller indent, and a negative number 
     1180        Promotes or demotes the paragraphs in the given range. 
     1181        A positive @a promoteBy produces a smaller indent, and a negative number 
    11331182        produces a larger indent. Pass flags to determine how the attributes are set. 
    11341183        Either the style definition or the name of the style definition (in the current 
    11351184        sheet) can be passed. 
     1185 
    11361186        @a flags is a bit list of the following: 
    1137         wxRICHTEXT_SETSTYLE_WITH_UNDO: specifies that this command will be undoable. 
    1138          wxRICHTEXT_SETSTYLE_RENUMBER: specifies that numbering should start from @e 
    1139         startFrom, otherwise existing attributes are used. 
    1140         wxRICHTEXT_SETSTYLE_SPECIFY_LEVEL: specifies that @a listLevel should be used 
     1187        - wxRICHTEXT_SETSTYLE_WITH_UNDO: specifies that this command will be undoable. 
     1188        - wxRICHTEXT_SETSTYLE_RENUMBER: specifies that numbering should start from 
     1189          @a startFrom, otherwise existing attributes are used. 
     1190        - wxRICHTEXT_SETSTYLE_SPECIFY_LEVEL: specifies that @a listLevel should be used 
    11411191        as the level for all paragraphs, otherwise the current indentation will be used. 
    1142         See also SetListStyle(), See also SetListStyle(), ClearListStyle(). 
     1192 
     1193        @see SetListStyle(), @see SetListStyle(), ClearListStyle(). 
    11431194    */ 
    11441195    bool PromoteList(int promoteBy, const wxRichTextRange& range, 
    … …  
    11631214 
    11641215    /** 
    1165         Replaces the content in the specified range with the string specified by @e 
    1166         value. 
     1216        Replaces the content in the specified range with the string specified by 
     1217        @a value. 
    11671218    */ 
    11681219    virtual void Replace(long from, long to, const wxString& value); 
    11691220 
    11701221    /** 
    1171         Saves the buffer content using the given type. If the specified type 
    1172         is wxRICHTEXT_TYPE_ANY, the type is deduced from the filename extension. 
     1222        Saves the buffer content using the given type. 
     1223 
     1224        If the specified type is wxRICHTEXT_TYPE_ANY, the type is deduced from 
     1225        the filename extension. 
     1226 
    11731227        This function looks for a suitable wxRichTextFileHandler object. 
    11741228    */ 
    … …  
    11931247    /** 
    11941248        Sets @a attr as the default style and tells the control that the UI should 
    1195         reflect 
    1196         this attribute until the user moves the caret. 
    1197         See also IsDefaultStyleShowing(). 
     1249        reflect this attribute until the user moves the caret. 
     1250 
     1251        @see IsDefaultStyleShowing(). 
    11981252    */ 
    11991253    void SetAndShowDefaultStyle(const wxTextAttr& attr); 
    12001254 
    12011255    /** 
    1202         Sets the basic (overall) style. This is the style of the whole 
    1203         buffer before further styles are applied, unlike the default style, which 
    1204         only affects the style currently being applied (for example, setting the default 
    1205         style to bold will cause subsequently inserted text to be bold). 
     1256        Sets the basic (overall) style. 
     1257 
     1258        This is the style of the whole buffer before further styles are applied, 
     1259        unlike the default style, which only affects the style currently being 
     1260        applied (for example, setting the default style to bold will cause 
     1261        subsequently inserted text to be bold). 
    12061262    */ 
    12071263    virtual void SetBasicStyle(const wxTextAttr& style); 
    … …  
    12161272    /** 
    12171273        Sets the current default style, which can be used to change how subsequently 
    1218         inserted 
    1219         text is displayed. 
     1274        inserted text is displayed. 
    12201275    */ 
    12211276    virtual bool SetDefaultStyle(const wxTextAttr& style); 
    … …