wxruby3 0.9.1-x64-mingw-ucrt → 0.9.3-x64-mingw-ucrt

data/lib/wx/doc/gen/rtc/rich_text_ctrl.rb

@@ -82,6 +82,7 @@ module Wx::RTC
   # 
   # 
   # 
+  # @wxrb_require USE_RICHTEXT
   class RichTextCtrlSelectionState < Wx::Enum
   
     # 
@@ -171,10 +172,11 @@ module Wx::RTC
   EVT_RICHTEXT_FOCUS_OBJECT_CHANGED = 10369
   
   # {Wx::RTC::RichTextCtrl} provides a generic, ground-up implementation of a text control capable of showing multiple styles and images.
+  # 
   # {Wx::RTC::RichTextCtrl} sends notification events: see {Wx::RTC::RichTextEvent}.
   # It also sends the standard {Wx::TextCtrl} events {Wx::EVT_TEXT_ENTER} and {Wx::EVT_TEXT}, and {Wx::TextUrlEvent} when URL content is clicked.
   # For more information, see the wxRichTextCtrl Overview.
-  # === Styles
+  # ### Styles
   # 
   # This class supports the following styles:
   # 
@@ -184,13 +186,12 @@ module Wx::RTC
   # 
   # - {Wx::RTC::RE_READONLY}: The control will not be editable. 
   # 
-  # === 
-  # 
-  # Category:  Rich Text  <div class='appearance'><span class='appearance'>Appearance:</span><table><tr><td> wxMSW Appearance
-  #   </td><td> wxGTK Appearance
-  #   </td><td> wxOSX Appearance
+  # Category:  Rich Text  <div class='appearance'><span class='appearance'>Appearance:</span><table><tr><td> WXMSW Appearance
+  #   </td><td> WXGTK Appearance
+  #   </td><td> WXOSX Appearance
   #   </td></tr></table></div>
   # 
+  # @wxrb_require USE_RICHTEXT
   class RichTextCtrl < Control
   
     include Wx::TextEntry
@@ -201,6 +202,7 @@ module Wx::RTC
     # @overload initialize(parent, id=-1, value=(''), pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::RTC::RE_MULTILINE, validator=Wx::DEFAULT_VALIDATOR, name=Wx::TEXT_CTRL_NAME_STR)
     #   Constructor, creating and showing a rich text control.
     #   
+    #   
     #   @see Wx::RTC::RichTextCtrl#create
     #   @see  Wx::Validator 
     #   @param parent [Wx::Window]  Parent window. Must not be NULL.
@@ -231,6 +233,7 @@ module Wx::RTC
     def init; end
     
     # Gets the text for the given range.
+    # 
     # The end point of range is specified as the last character position of the span of text, plus one.
     # @param from [Integer] 
     # @param to [Integer] 
@@ -266,6 +269,7 @@ module Wx::RTC
     alias_method :editable?, :is_editable
     
     # Returns true if the control is single-line.
+    # 
     # Currently {Wx::RTC::RichTextCtrl} does not support single-line editing.
     # @return [Boolean]
     def is_single_line; end
@@ -297,6 +301,7 @@ module Wx::RTC
     alias_method :filename=, :set_filename
     
     # Sets the size of the buffer beyond which layout is delayed during resizing.
+    # 
     # This optimizes sizing for large buffers. The default is 20000.
     # @param threshold [Integer] 
     # @return [void]
@@ -304,6 +309,7 @@ module Wx::RTC
     alias_method :delayed_layout_threshold=, :set_delayed_layout_threshold
     
     # Gets the size of the buffer beyond which layout is delayed during resizing.
+    # 
     # This optimizes sizing for large buffers. The default is 20000.
     # @return [Integer]
     def get_delayed_layout_threshold; end
@@ -407,12 +413,14 @@ module Wx::RTC
     
     # Get the possible Drag'n'Drop start time.
     # @return [Wx::DateTime]
+    # @wxrb_require USE_DATETIME
     def get_drag_start_time; end
     alias_method :drag_start_time, :get_drag_start_time
     
     # Set the possible Drag'n'Drop start time.
     # @param st [Time,Date,DateTime] 
     # @return [void]
+    # @wxrb_require USE_DATETIME
     def set_drag_start_time(st) end
     alias_method :drag_start_time=, :set_drag_start_time
     
@@ -428,12 +436,14 @@ module Wx::RTC
     alias_method :context_menu=, :set_context_menu
     
     # Returns an anchor so we know how to extend the selection.
+    # 
     # It's a caret position since it's between two characters.
     # @return [Integer]
     def get_selection_anchor; end
     alias_method :selection_anchor, :get_selection_anchor
     
     # Sets an anchor so we know how to extend the selection.
+    # 
     # It's a caret position since it's between two characters.
     # @param anchor [Integer] 
     # @return [void]
@@ -456,6 +466,7 @@ module Wx::RTC
     alias_method :context_menu_properties_info, :get_context_menu_properties_info
     
     # Returns the {Wx::RTC::RichTextObject} object that currently has the editing focus.
+    # 
     # If there are no composite objects, this will be the top-level buffer.
     # @return [Wx::RTC::RichTextParagraphLayoutBox]
     def get_focus_object; end
@@ -478,6 +489,7 @@ module Wx::RTC
     def invalidate; end
     
     # Clears the buffer content, leaving a single empty paragraph.
+    # 
     # Cannot be undone.
     # @return [void]
     def clear; end
@@ -496,6 +508,7 @@ module Wx::RTC
     def remove(from, to) end
     
     # Loads content into the control's buffer using the given type.
+    # 
     # If the specified type is {Wx::RTC::RichTextFileType::RICHTEXT_TYPE_ANY}, the type is deduced from the filename extension.
     # This function looks for a suitable {Wx::RTC::RichTextFileHandler} object.
     # @param file [String] 
@@ -504,6 +517,7 @@ module Wx::RTC
     def load_file(file, type=Wx::RTC::RichTextFileType::RICHTEXT_TYPE_ANY) end
     
     # Helper function for {Wx::RTC::RichTextCtrl#load_file}.
+    # 
     # Loads content into the control's buffer using the given type.
     # If the specified type is {Wx::RTC::RichTextFileType::RICHTEXT_TYPE_ANY}, the type is deduced from the filename extension.
     # This function looks for a suitable {Wx::RTC::RichTextFileHandler} object.
@@ -513,6 +527,7 @@ module Wx::RTC
     def do_load_file(file, fileType) end
     
     # Saves the buffer content using the given type.
+    # 
     # If the specified type is {Wx::RTC::RichTextFileType::RICHTEXT_TYPE_ANY}, the type is deduced from the filename extension.
     # This function looks for a suitable {Wx::RTC::RichTextFileHandler} object.
     # @param file [String] 
@@ -521,6 +536,7 @@ module Wx::RTC
     def save_file(file=(''), type=Wx::RTC::RichTextFileType::RICHTEXT_TYPE_ANY) end
     
     # Helper function for {Wx::RTC::RichTextCtrl#save_file}.
+    # 
     # Saves the buffer content using the given type.
     # If the specified type is {Wx::RTC::RichTextFileType::RICHTEXT_TYPE_ANY}, the type is deduced from the filename extension.
     # This function looks for a suitable {Wx::RTC::RichTextFileHandler} object.
@@ -530,6 +546,7 @@ module Wx::RTC
     def do_save_file(file=(''), fileType=Wx::RTC::RichTextFileType::RICHTEXT_TYPE_ANY) end
     
     # Sets flags that change the behaviour of loading or saving.
+    # 
     # See the documentation for each handler class to see what flags are relevant for each handler.
     # @param flags [Integer] 
     # @return [void]
@@ -537,6 +554,7 @@ module Wx::RTC
     alias_method :handler_flags=, :set_handler_flags
     
     # Returns flags that change the behaviour of loading or saving.
+    # 
     # See the documentation for each handler class to see what flags are relevant for each handler.
     # @return [Integer]
     def get_handler_flags; end
@@ -556,6 +574,7 @@ module Wx::RTC
     alias_method :modified=, :set_modified
     
     # Sets the maximum number of characters that may be entered in a single line text control.
+    # 
     # For compatibility only; currently does nothing.
     # @param len [Integer] 
     # @return [void]
@@ -574,6 +593,7 @@ module Wx::RTC
     
     # @overload get_style(position, style)
     #   Gets the attributes at the given position.
+    #   
     #   This function gets the combined style - that is, the style you see on the screen as a result of combining base style, paragraph style and character style attributes.
     #   To get the character or paragraph style alone, use {Wx::RTC::RichTextCtrl#get_uncombined_style}.
     #   @param position [Integer] 
@@ -615,6 +635,7 @@ module Wx::RTC
     alias_method :style_for_range, :get_style_for_range
     
     # Sets the attributes for the given range, passing flags to determine how the attributes are set.
+    # 
     # The end point of range is specified as the last character position of the span of text, plus one. So, for example, to set the style for a character at position 5, use the range (5,6).
     # flags may contain a bit list of the following values:
     # 
@@ -633,6 +654,7 @@ module Wx::RTC
     
     # @overload get_uncombined_style(position, style)
     #   Gets the attributes at the given position.
+    #   
     #   This function gets the uncombined style - that is, the attributes associated with the paragraph or character content, and not necessarily the combined attributes you see on the screen. To get the combined attributes, use {Wx::RTC::RichTextCtrl#get_style}.
     #   If you specify (any) paragraph attribute in style's flags, this function will fetch the paragraph attributes. Otherwise, it will return the character attributes.
     #   @param position [Integer] 
@@ -670,6 +692,7 @@ module Wx::RTC
     def set_list_style(range, defName, flags=Wx::RTC::RICHTEXT_SETSTYLE_WITH_UNDO, startFrom=1, specifiedLevel=-1) end
     
     # Clears the list style from the given range, clearing list-related attributes and applying any named paragraph style associated with each paragraph.
+    # 
     # flags is a bit list of the following:
     # 
     # - {Wx::RTC::RICHTEXT_SETSTYLE_WITH_UNDO}: specifies that this command will be undoable.
@@ -683,6 +706,7 @@ module Wx::RTC
     
     # @overload number_list(range, def_=nil, flags=Wx::RTC::RICHTEXT_SETSTYLE_WITH_UNDO, startFrom=1, specifiedLevel=-1)
     #   Numbers the paragraphs in the given range.
+    #   
     #   Pass flags to determine how the attributes are set.
     #   Either the style definition or the name of the style definition (in the current sheet) can be passed.
     #   flags is a bit list of the following:
@@ -710,6 +734,7 @@ module Wx::RTC
     
     # @overload promote_list(promoteBy, range, def_=nil, flags=Wx::RTC::RICHTEXT_SETSTYLE_WITH_UNDO, specifiedLevel=-1)
     #   Promotes or demotes the paragraphs in the given range.
+    #   
     #   A positive promoteBy produces a smaller indent, and a negative number produces a larger indent. Pass flags to determine how the attributes are set. Either the style definition or the name of the style definition (in the current sheet) can be passed.
     #   flags is a bit list of the following:
     #   
@@ -737,6 +762,7 @@ module Wx::RTC
     def promote_list(*args) end
     
     # Sets the properties for the given range, passing flags to determine how the attributes are set.
+    # 
     # You can merge properties or replace them.
     # The end point of range is specified as the last character position of the span of text, plus one. So, for example, to set the properties for a character at position 5, use the range (5,6).
     # flags may contain a bit list of the following values:
@@ -772,6 +798,7 @@ module Wx::RTC
     def copy; end
     
     # Copies the selected content (if any) to the clipboard and deletes the selection.
+    # 
     # This is undoable.
     # @return [void]
     def cut; end
@@ -781,6 +808,7 @@ module Wx::RTC
     def paste; end
     
     # Deletes the content in the selection, if any.
+    # 
     # This is undoable.
     # @return [void]
     def delete_selection; end
@@ -845,6 +873,7 @@ module Wx::RTC
     
     # @overload set_selection(from, to)
     #   Sets the selection to the given range.
+    #   
     #   The end point of range is specified as the last character position of the span of text, plus one.
     #   So, for example, to set the selection for a character at position 5, use the range (5,6).
     #   @param from [Integer] 
@@ -878,6 +907,7 @@ module Wx::RTC
     
     # @overload write_image(image, bitmapType=Wx::BitmapType::BITMAP_TYPE_PNG, textAttr=(Wx::RichTextAttr.new()))
     #   Write a bitmap or image at the current insertion point.
+    #   
     #   Supply an optional type to use for internal and file storage of the raw data.
     #   @param image [Wx::Image] 
     #   @param bitmapType [Wx::BitmapType] 
@@ -902,6 +932,7 @@ module Wx::RTC
     def write_image(*args) end
     
     # Write a text box at the current insertion point, returning the text box.
+    # 
     # You can then call {Wx::RTC::RichTextCtrl#set_focus_object} to set the focus to the new object.
     # @param textAttr [Wx::RTC::RichTextAttr] 
     # @return [Wx::RTC::RichTextBox]
@@ -909,6 +940,7 @@ module Wx::RTC
     
     # Writes a field at the current insertion point.
     # 
+    # 
     # @see Wx::RTC::RichTextField
     # @see  Wx::RTC::RichTextFieldType
     # @see  Wx::RTC::RichTextFieldTypeStandard 
@@ -919,6 +951,7 @@ module Wx::RTC
     def write_field(fieldType, properties, textAttr=(Wx::RichTextAttr.new())) end
     
     # Write a table at the current insertion point, returning the table.
+    # 
     # You can then call {Wx::RTC::RichTextCtrl#set_focus_object} to set the focus to the new object.
     # @param rows [Integer] 
     # @param cols [Integer] 
@@ -929,16 +962,19 @@ module Wx::RTC
     
     # Inserts a new paragraph at the current insertion point.
     # 
+    # 
     # @see Wx::RTC::RichTextCtrl#line_break. 
     # @return [Boolean]
     def newline; end
     
     # Inserts a line break at the current insertion point.
+    # 
     # A line break forces wrapping within a paragraph, and can be introduced by using this function, by appending the {Wx::Char} value <b>{Wx::RICH_TEXT_LINE_BREAK_CHAR}</b> to text content, or by typing Shift-Return.
     # @return [Boolean]
     def line_break; end
     
     # Sets the basic (overall) style.
+    # 
     # This is the style of the whole buffer before further styles are applied, unlike the default style, which only affects the style currently being applied (for example, setting the default style to bold will cause subsequently inserted text to be bold).
     # @param style [Wx::RTC::RichTextAttr] 
     # @return [void]
@@ -946,6 +982,7 @@ module Wx::RTC
     alias_method :basic_style=, :set_basic_style
     
     # Gets the basic (overall) style.
+    # 
     # This is the style of the whole buffer before further styles are applied, unlike the default style, which only affects the style currently being applied (for example, setting the default style to bold will cause subsequently inserted text to be bold).
     # @return [Wx::RTC::RichTextAttr]
     def get_basic_style; end
@@ -1016,6 +1053,7 @@ module Wx::RTC
     def end_text_colour; end
     
     # Begins using alignment.
+    # 
     # For alignment values, see {Wx::TextAttr}.
     # @param alignment [Wx::TextAttrAlignment] 
     # @return [Boolean]
@@ -1026,6 +1064,7 @@ module Wx::RTC
     def end_alignment; end
     
     # Begins applying a left indent and subindent in tenths of a millimetre.
+    # 
     # The subindent is an offset from the left edge of the paragraph, and is used for all but the first line in a paragraph. A positive value will cause the first line to appear to the left of the subsequent lines, and a negative value will cause the first line to be indented to the right of the subsequent lines.
     # {Wx::RTC::RichTextBuffer} uses indentation to render a bulleted item. The content of the paragraph, including the first line, starts at the leftIndent plus the leftSubIndent.
     # @param leftIndent [Integer]  The distance between the margin and the bullet.
@@ -1057,6 +1096,7 @@ module Wx::RTC
     def end_paragraph_spacing; end
     
     # Begins applying line spacing.
+    # 
     # spacing is a multiple, where 10 means single-spacing, 15 means 1.5 spacing, and 20 means double spacing.
     # The {Wx::TextAttrLineSpacing} constants are defined for convenience.
     # @param lineSpacing [Integer] 
@@ -1068,6 +1108,7 @@ module Wx::RTC
     def end_line_spacing; end
     
     # Begins a numbered bullet.
+    # 
     # This call will be needed for each item in the list, and the application should take care of incrementing the numbering.
     # bulletNumber is a number, usually starting with 1. leftIndent and leftSubIndent are values in tenths of a millimetre. bulletStyle is a bitlist of the {Wx::TextAttrBulletStyle} values.
     # {Wx::RTC::RichTextBuffer} uses indentation to render a bulleted item. The left indent is the distance between the margin and the bullet. The content of the paragraph, including the first line, starts at leftMargin + leftSubIndent. So the distance between the left edge of the bullet and the left of the actual paragraph is leftSubIndent.
@@ -1083,6 +1124,7 @@ module Wx::RTC
     def end_numbered_bullet; end
     
     # Begins applying a symbol bullet, using a character from the current font.
+    # 
     # See {Wx::RTC::RichTextCtrl#begin_numbered_bullet} for an explanation of how indentation is used to render the bulleted paragraph.
     # @param symbol [String] 
     # @param leftIndent [Integer] 
@@ -1126,6 +1168,7 @@ module Wx::RTC
     def end_paragraph_style; end
     
     # Begins using a specified list style.
+    # 
     # Optionally, you can also pass a level and a number.
     # @param listStyle [String] 
     # @param level [Integer] 
@@ -1138,6 +1181,7 @@ module Wx::RTC
     def end_list_style; end
     
     # Begins applying {Wx::TextAttrFlags::TEXT_ATTR_URL} to the content.
+    # 
     # Pass a URL and optionally, a character style to apply, since it is common to mark a URL with a familiar style such as blue text with underlining.
     # @param url [String] 
     # @param characterStyle [String] 
@@ -1162,6 +1206,7 @@ module Wx::RTC
     def select_word(position) end
     
     # Returns the selection range in character positions.
+    # 
     # -1, -1 means no selection.
     # The range is in API convention, i.e. a single character selection is denoted by (n, n+1)
     # @return [Range]
@@ -1169,6 +1214,7 @@ module Wx::RTC
     alias_method :selection_range, :get_selection_range
     
     # Sets the selection to the given range.
+    # 
     # The end point of range is specified as the last character position of the span of text, plus one.
     # So, for example, to set the selection for a character at position 5, use the range (5,6).
     # @param range [Range] 
@@ -1177,12 +1223,14 @@ module Wx::RTC
     alias_method :selection_range=, :set_selection_range
     
     # Returns the selection range in character positions.
+    # 
     # -2, -2 means no selection -1, -1 means select everything. The range is in internal format, i.e. a single character selection is denoted by (n, n)
     # @return [Range]
     def get_internal_selection_range; end
     alias_method :internal_selection_range, :get_internal_selection_range
     
     # Sets the selection range in character positions.
+    # 
     # -2, -2 means no selection -1, -1 means select everything. The range is in internal format, i.e. a single character selection is denoted by (n, n)
     # @param range [Range] 
     # @return [void]
@@ -1200,6 +1248,7 @@ module Wx::RTC
     def add_image(image) end
     
     # Move the caret to the given character position.
+    # 
     # Please note that this does not update the current editing style from the new position; to do that, call {Wx::RTC::RichTextCtrl#set_insertion_point} instead.
     # @param pos [Integer] 
     # @param showAtLineStart [Boolean] 
@@ -1315,6 +1364,7 @@ module Wx::RTC
     def suppressing_undo; end
     
     # Test if this whole range has character attributes of the specified kind.
+    # 
     # If any of the attributes are different within the range, the test fails.
     # You can use this to implement, for example, bold button updating. style must have flags indicating which attributes are of interest.
     # @param range [Range] 
@@ -1324,6 +1374,7 @@ module Wx::RTC
     alias_method :has_character_attributes?, :has_character_attributes
     
     # Test if this whole range has paragraph attributes of the specified kind.
+    # 
     # If any of the attributes are different within the range, the test fails. You can use this to implement, for example, centering button updating. style must have flags indicating which attributes are of interest.
     # @param range [Range] 
     # @param style [Wx::RTC::RichTextAttr] 
@@ -1370,24 +1421,28 @@ module Wx::RTC
     def apply_underline_to_selection; end
     
     # Applies one or more {Wx::TextAttrEffects} flags to the selection (undoable).
+    # 
     # If there is no selection, it is applied to the default style.
     # @param flags [Integer] 
     # @return [Boolean]
     def apply_text_effect_to_selection(flags) end
     
     # Applies the given alignment to the selection or the default style (undoable).
+    # 
     # For alignment values, see {Wx::TextAttr}.
     # @param alignment [Wx::TextAttrAlignment] 
     # @return [Boolean]
     def apply_alignment_to_selection(alignment) end
     
     # Applies the style sheet to the buffer, matching paragraph styles in the sheet against named styles in the buffer.
+    # 
     # This might be useful if the styles have changed. If sheet is NULL, the sheet set with {Wx::RTC::RichTextCtrl#set_style_sheet} is used. Currently this applies paragraph styles only.
     # @param def_ [Wx::RTC::RichTextStyleDefinition] 
     # @return [Boolean]
     def apply_style(def_) end
     
     # Sets the style sheet associated with the control.
+    # 
     # A style sheet allows named character and paragraph styles to be applied.
     # @param styleSheet [Wx::RTC::RichTextStyleSheet] 
     # @return [void]
@@ -1395,6 +1450,7 @@ module Wx::RTC
     alias_method :style_sheet=, :set_style_sheet
     
     # Returns the style sheet associated with the control, if any.
+    # 
     # A style sheet allows named character and paragraph styles to be applied.
     # @return [Wx::RTC::RichTextStyleSheet]
     def get_style_sheet; end
@@ -1422,6 +1478,7 @@ module Wx::RTC
     def show_context_menu(menu, pt, addPropertyCommands) end
     
     # Prepares the context menu, optionally adding appropriate property-editing commands.
+    # 
     # Returns the number of property commands added.
     # @param menu [Wx::Menu] 
     # @param pt [Array(Integer, Integer), Wx::Point] 
@@ -1448,6 +1505,7 @@ module Wx::RTC
     alias_method :properties_menu_label, :get_properties_menu_label
     
     # Prepares the content just before insertion (or after buffer reset).
+    # 
     # Called by the same function in {Wx::RTC::RichTextBuffer}. Currently is only called if undo mode is on.
     # @param container [Wx::RTC::RichTextParagraphLayoutBox] 
     # @return [void]
@@ -1480,6 +1538,7 @@ module Wx::RTC
     alias_method :font_scale, :get_font_scale
     
     # Sets the scale factor for displaying certain dimensions such as indentation and inter-paragraph spacing.
+    # 
     # This can be useful when editing in a small control where you still want legible text, but a minimum of wasted white space.
     # @param dimScale [Float] 
     # @param refresh [Boolean] 
@@ -1541,12 +1600,14 @@ module Wx::RTC
     alias_method :scaled_rect, :get_scaled_rect
     
     # Returns true if this control can use virtual attributes and virtual text.
+    # 
     # The default is false.
     # @return [Boolean]
     def get_virtual_attributes_enabled; end
     alias_method :virtual_attributes_enabled, :get_virtual_attributes_enabled
     
     # Pass true to let the control use virtual attributes.
+    # 
     # The default is false.
     # @param b [Boolean] 
     # @return [void]
@@ -1564,6 +1625,7 @@ module Wx::RTC
     alias_method :font=, :set_font
     
     # Return true from here to allow the colours of this window to be changed by {Wx::RTC::RichTextCtrl#inherit_attributes}.
+    # 
     # Returning false forbids inheriting them from the parent window.
     # The base class version returns false, but this method is overridden in {Wx::Control} where it returns true.
     # @return [Boolean]
@@ -1575,6 +1637,7 @@ module Wx::RTC
     def position_caret(container=nil) end
     
     # Helper function for extending the selection, returning true if the selection was changed.
+    # 
     # Selections are in caret positions.
     # @param oldPosition [Integer] 
     # @param newPosition [Integer] 
@@ -1602,6 +1665,7 @@ module Wx::RTC
     def refresh_for_selection_change(oldSelection, newSelection) end
     
     # Sets the caret position.
+    # 
     # The caret position is the character position just before the caret. A value of -1 means the caret is at the start of the buffer. Please note that this does not update the current editing style from the new position or cause the actual caret to be refreshed; to do that, call {Wx::RTC::RichTextCtrl#set_insertion_point} instead.
     # @param position [Integer] 
     # @param showAtLineStart [Boolean] 
@@ -1631,6 +1695,7 @@ module Wx::RTC
     def move_caret_back(oldPosition) end
     
     # Returns the caret height and position for the given character position.
+    # 
     # If container is null, the current focus object will be used.
     # @param position [Integer] 
     # @param rect [Wx::Rect] 
@@ -1640,6 +1705,7 @@ module Wx::RTC
     alias_method :caret_position_for_index, :get_caret_position_for_index
     
     # Internal helper function returning the line for the visible caret position.
+    # 
     # If the caret is shown at the very end of the line, it means the next character is actually on the following line. So this function gets the line we're expecting to find if this is the case.
     # @param caretPosition [Integer] 
     # @return [Wx::RTC::RichTextLine]
@@ -1652,6 +1718,7 @@ module Wx::RTC
     alias_method :command_processor, :get_command_processor
     
     # Deletes content if there is a selection, e.g.
+    # 
     # when pressing a key. Returns the new caret position in newPos, or leaves it if there was no action. This is undoable.
     # @return [Integer,nil]
     def delete_selected_content; end
@@ -1669,6 +1736,7 @@ module Wx::RTC
     alias_method :logical_point, :get_logical_point
     
     # Helper function for finding the caret position for the next word.
+    # 
     # Direction is 1 (forward) or -1 (backwards).
     # @param direction [Integer] 
     # @return [Integer]
@@ -1728,6 +1796,7 @@ module Wx::RTC
     alias_method :delayed_image_processing_time=, :set_delayed_image_processing_time
     
     # Returns the caret position since the default formatting was changed.
+    # 
     # As soon as this position changes, we no longer reflect the default style in the UI. A value of -2 means that we should only reflect the style of the content under the caret.
     # @return [Integer]
     def get_caret_position_for_default_style; end
@@ -1740,6 +1809,7 @@ module Wx::RTC
     alias_method :caret_position_for_default_style=, :set_caret_position_for_default_style
     
     # Returns true if the user has recently set the default style without moving the caret, and therefore the UI needs to reflect the default style and not the style at the caret.
+    # 
     # Below is an example of code that uses this function to determine whether the UI should show that the current style is bold.
     # @see Wx::RTC::RichTextCtrl#set_and_show_default_style. 
     # @return [Boolean]
@@ -1748,6 +1818,7 @@ module Wx::RTC
     
     # Sets attr as the default style and tells the control that the UI should reflect this attribute until the user moves the caret.
     # 
+    # 
     # @see Wx::RTC::RichTextCtrl#is_default_style_showing. 
     # @param attr [Wx::RTC::RichTextAttr] 
     # @return [void]
@@ -1790,6 +1861,7 @@ module Wx::RTC
     def set_caret_position_after_click(container, position, hitTestFlags, extendSelection=false) end
     
     # Find the caret position for the combination of hit-test flags and character position.
+    # 
     # Returns the caret position and also an indication of where to place the caret (caretLineStart) since this is ambiguous (same position used for end of line and start of next).
     # @param position [Integer] 
     # @param hitTestFlags [Integer] 
@@ -1838,7 +1910,9 @@ module Wx::RTC
   # 
   # 
   # 
+  # 
   # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  # @wxrb_require USE_RICHTEXT
   class RichTextContextMenuPropertiesInfo < ::Object
   
     # Constructor.
@@ -1902,14 +1976,15 @@ module Wx::RTC
   end # RichTextContextMenuPropertiesInfo
   
   # {Wx::RTC::CommandProcessor} is a class that maintains a history of {Wx::Commands}, with undo/redo functionality built-in.
+  # 
   # Derive a new class from this if you want different behaviour.
-  # === 
   # 
   # Category:  Document/View Framework
   # @see wxCommandProcessor Overview
   # @see  Wx::Command 
   # 
   # 
+  # @wxrb_require USE_RICHTEXT
   class CommandProcessor < Object
   
     # Constructor.
@@ -1966,6 +2041,7 @@ module Wx::RTC
     def initialize; end
     
     # Returns a boolean value that indicates if changes have been made since the last save operation.
+    # 
     # This only works if {Wx::RTC::CommandProcessor#mark_as_saved} is called whenever the project is saved.
     # @return [Boolean]
     def is_dirty; end
@@ -1980,6 +2056,7 @@ module Wx::RTC
     def redo_; end
     
     # Tells the command processor to update the Undo and Redo items on this menu as appropriate.
+    # 
     # Set this to NULL if the menu is about to be destroyed and command operations may still be performed, or the command processor may try to access an invalid pointer.
     # @param menu [Wx::Menu] 
     # @return [void]

data/lib/wx/doc/gen/rtc/rich_text_event.rb

@@ -7,7 +7,8 @@
 module Wx::RTC
 
   # This is the event class for {Wx::RTC::RichTextCtrl} notifications.
-  # === Events using this class
+  # 
+  # ### Events using this class
   # 
   # The following event-handler methods redirect the events to member method or handler blocks for {Wx::RTC::RichTextEvent} events.
   # Event handler methods:
@@ -50,15 +51,14 @@ module Wx::RTC
   # 
   # - {Wx::EvtHandler#evt_richtext_focus_object_changed}(id, meth = nil, &block): Process a {Wx::RTC::EVT_RICHTEXT_FOCUS_OBJECT_CHANGED} event, generated when the current focus object has changed. 
   # 
-  # === 
-  # 
   # Category:  {Wx::Events}, Rich Text
   # 
+  # @wxrb_require USE_RICHTEXT
   class RichTextEvent < NotifyEvent
   
     # @overload initialize(commandType=Wx::EVT_NULL, winid=0)
     #   Constructor.
-    #   @param commandType [Wx::CommandLinkButton::EventType]  The type of the event.
+    #   @param commandType [Wx::StaticLine::EventType]  The type of the event.
     #   @param winid [Integer]  Window identifier. The value {Wx::StandardID::ID_ANY} indicates a default value.
     #   @return [Wx::RTC::RichTextEvent]
     # @overload initialize(event)
@@ -79,12 +79,14 @@ module Wx::RTC
     alias_method :position=, :set_position
     
     # Returns flags indicating modifier keys pressed.
+    # 
     # Possible values are {Wx::RTC::RICHTEXT_CTRL_DOWN}, {Wx::RTC::RICHTEXT_SHIFT_DOWN}, and {Wx::RTC::RICHTEXT_ALT_DOWN}.
     # @return [Integer]
     def get_flags; end
     alias_method :flags, :get_flags
     
     # Sets flags indicating modifier keys pressed.
+    # 
     # Possible values are {Wx::RTC::RICHTEXT_CTRL_DOWN}, {Wx::RTC::RICHTEXT_SHIFT_DOWN}, and {Wx::RTC::RICHTEXT_ALT_DOWN}.
     # @param flags [Integer] 
     # @return [void]
@@ -92,6 +94,7 @@ module Wx::RTC
     alias_method :flags=, :set_flags
     
     # Returns the old style sheet.
+    # 
     # Can be used in a {Wx::RTC::EVT_RICHTEXT_STYLESHEET_CHANGING} or {Wx::RTC::EVT_RICHTEXT_STYLESHEET_CHANGED} event handler.
     # @return [Wx::RTC::RichTextStyleSheet]
     def get_old_style_sheet; end
@@ -104,6 +107,7 @@ module Wx::RTC
     alias_method :old_style_sheet=, :set_old_style_sheet
     
     # Returns the new style sheet.
+    # 
     # Can be used in a {Wx::RTC::EVT_RICHTEXT_STYLESHEET_CHANGING} or {Wx::RTC::EVT_RICHTEXT_STYLESHEET_CHANGED} event handler.
     # @return [Wx::RTC::RichTextStyleSheet]
     def get_new_style_sheet; end