wxruby3 1.6.0 → 1.7.0

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

@@ -0,0 +1,1240 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  module RTC
+
+    # This class knows how to lay out paragraphs.
+    # 
+    # Category:  Rich Text
+    # @see Wx::RTC::RichTextCompositeObject
+    # @see  Wx::RTC::RichTextObject
+    # @see  Wx::RTC::RichTextBuffer
+    # @see  Wx::RTC::RichTextCtrl 
+    # 
+    # 
+    # 
+    # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+    # @wxrb_require USE_RICHTEXT
+    class RichTextParagraphLayoutBox < RichTextCompositeObject
+    
+      # @overload initialize(parent=nil)
+      #   @param parent [Wx::RTC::RichTextObject] 
+      #   @return [Wx::RTC::RichTextParagraphLayoutBox]
+      # @overload initialize(obj)
+      #   @param obj [Wx::RTC::RichTextParagraphLayoutBox] 
+      #   @return [Wx::RTC::RichTextParagraphLayoutBox]
+      def initialize(*args) end
+      
+      # Hit-testing: returns a flag indicating hit test details, plus information about position.
+      # 
+      # contextObj is returned to specify what object position is relevant to, since otherwise there's an ambiguity. @ obj might not be a child of contextObj, since we may be referring to the container itself if we have no hit on a child - for example if we click outside an object.
+      # The function puts the position in textPosition if one is found. pt is in logical units (a zero y position is at the beginning of the buffer).
+      # One of the {Wx::RTC::RichTextHitTestFlags} values.
+      # @param dc [Wx::ReadOnlyDC] 
+      # @param context [Wx::RTC::RichTextDrawingContext] 
+      # @param pt [Array(Integer, Integer), Wx::Point] 
+      # @param textPosition [Integer] 
+      # @param flags [Integer] 
+      # @return [Array(Integer,Integer,Wx::RTC::RichTextObject,Wx::RTC::RichTextObject)]
+      def hit_test(dc, context, pt, textPosition, flags=0) end
+      
+      # Draw the item, within the given range.
+      # 
+      # Some objects may ignore the range (for example paragraphs) while others must obey it (lines, to implement wrapping)
+      # @param dc [Wx::DC] 
+      # @param context [Wx::RTC::RichTextDrawingContext] 
+      # @param range [Range] 
+      # @param selection [Wx::RTC::RichTextSelection] 
+      # @param rect [Wx::Rect] 
+      # @param descent [Integer] 
+      # @param style [Integer] 
+      # @return [Boolean]
+      def draw(dc, context, range, selection, rect, descent, style) end
+      
+      # Lay the item out at the specified position with the given size constraint.
+      # 
+      # Layout must set the cached size. rect is the available space for the object, and parentRect is the container that is used to determine a relative size or position (for example if a text box must be 50% of the parent text box).
+      # @param dc [Wx::ReadOnlyDC] 
+      # @param context [Wx::RTC::RichTextDrawingContext] 
+      # @param rect [Wx::Rect] 
+      # @param parentRect [Wx::Rect] 
+      # @param style [Integer] 
+      # @return [Boolean]
+      def layout(dc, context, rect, parentRect, style) end
+      
+      # Returns the object size for the given range.
+      # 
+      # Returns false if the range is invalid for this object.
+      # @param range [Range] 
+      # @param size [Array(Integer, Integer), Wx::Size] 
+      # @param descent [int] 
+      # @param dc [Wx::ReadOnlyDC] 
+      # @param context [Wx::RTC::RichTextDrawingContext] 
+      # @param flags [Integer] 
+      # @param position [Array(Integer, Integer), Wx::Point] 
+      # @param parentSize [Array(Integer, Integer), Wx::Size] 
+      # @param partialExtents [Array,nil] 
+      # @return [Boolean]
+      def get_range_size(range, size, descent, dc, context, flags, position=(Wx::Point.new(0, 0)), parentSize=Wx::DEFAULT_SIZE, partialExtents=nil) end
+      alias_method :range_size, :get_range_size
+      
+      # Deletes the given range.
+      # @param range [Range] 
+      # @return [Boolean]
+      def delete_range(range) end
+      
+      # Returns any text in this object for the given range.
+      # @param range [Range] 
+      # @return [String]
+      def get_text_for_range(range) end
+      alias_method :text_for_range, :get_text_for_range
+      
+      # Imports this object from XML.
+      # @param buffer [Wx::RTC::RichTextBuffer] 
+      # @param node [Wx::XmlNode] 
+      # @param handler [Wx::RTC::RichTextXMLHandler] 
+      # @param recurse [Boolean] 
+      # @return [Array(Boolean,Boolean)]
+      def import_from_xml(buffer, node, handler, recurse) end
+      
+      # Returns the XML node name of this object.
+      # 
+      # This must be overridden for {Wx::XmlNode}-base XML export to work.
+      # @return [String]
+      def get_xml_node_name; end
+      alias_method :xml_node_name, :get_xml_node_name
+      
+      # Returns true if objects of this class can accept the focus, i.e. a call to SetFocusObject is possible.
+      # 
+      # For example, containers supporting text, such as a text box object, can accept the focus, but a table can't (set the focus to individual cells instead).
+      # @return [Boolean]
+      def accepts_focus; end
+      
+      # Associates a control with the buffer, for operations that for example require refreshing the window.
+      # @param ctrl [Wx::RTC::RichTextCtrl] 
+      # @return [void]
+      def set_rich_text_ctrl(ctrl) end
+      alias_method :rich_text_ctrl=, :set_rich_text_ctrl
+      
+      # Returns the associated control.
+      # @return [Wx::RTC::RichTextCtrl]
+      def get_rich_text_ctrl; end
+      alias_method :rich_text_ctrl, :get_rich_text_ctrl
+      
+      # Sets a flag indicating whether the last paragraph is partial or complete.
+      # @param partialPara [Boolean] 
+      # @return [void]
+      def set_partial_paragraph(partialPara) end
+      alias_method :partial_paragraph=, :set_partial_paragraph
+      
+      # Returns a flag indicating whether the last paragraph is partial or complete.
+      # @return [Boolean]
+      def get_partial_paragraph; end
+      alias_method :partial_paragraph, :get_partial_paragraph
+      
+      # Returns the style sheet associated with the overall buffer.
+      # @return [Wx::RTC::RichTextStyleSheet]
+      def get_style_sheet; end
+      alias_method :style_sheet, :get_style_sheet
+      
+      # Returns true if this object is top-level, i.e. contains its own paragraphs, such as a text box.
+      # @return [Boolean]
+      def is_top_level; end
+      alias_method :top_level?, :is_top_level
+      
+      # Submits a command to insert paragraphs.
+      # @param buffer [Wx::RTC::RichTextBuffer] 
+      # @param pos [Integer] 
+      # @param paragraphs [Wx::RTC::RichTextParagraphLayoutBox] 
+      # @param ctrl [Wx::RTC::RichTextCtrl] 
+      # @param flags [Integer] 
+      # @return [Boolean]
+      def insert_paragraphs_with_undo(buffer, pos, paragraphs, ctrl, flags=0) end
+      
+      # Submits a command to insert the given text.
+      # @param buffer [Wx::RTC::RichTextBuffer] 
+      # @param pos [Integer] 
+      # @param text [String] 
+      # @param ctrl [Wx::RTC::RichTextCtrl] 
+      # @param flags [Integer] 
+      # @return [Boolean]
+      def insert_text_with_undo(buffer, pos, text, ctrl, flags=0) end
+      
+      # Submits a command to insert the given text.
+      # @param buffer [Wx::RTC::RichTextBuffer] 
+      # @param pos [Integer] 
+      # @param ctrl [Wx::RTC::RichTextCtrl] 
+      # @param flags [Integer] 
+      # @return [Boolean]
+      def insert_newline_with_undo(buffer, pos, ctrl, flags=0) end
+      
+      # Submits a command to insert the given image.
+      # @param buffer [Wx::RTC::RichTextBuffer] 
+      # @param pos [Integer] 
+      # @param imageBlock [Wx::RTC::RichTextImageBlock] 
+      # @param ctrl [Wx::RTC::RichTextCtrl] 
+      # @param flags [Integer] 
+      # @param textAttr [Wx::RTC::RichTextAttr] 
+      # @return [Boolean]
+      def insert_image_with_undo(buffer, pos, imageBlock, ctrl, flags, textAttr) end
+      
+      # Submits a command to insert the given field.
+      # 
+      # Field data can be included in properties.
+      # @see Wx::RTC::RichTextField
+      # @see  Wx::RTC::RichTextFieldType
+      # @see  Wx::RTC::RichTextFieldTypeStandard 
+      # @param buffer [Wx::RTC::RichTextBuffer] 
+      # @param pos [Integer] 
+      # @param fieldType [String] 
+      # @param properties [Wx::RTC::RichTextProperties] 
+      # @param ctrl [Wx::RTC::RichTextCtrl] 
+      # @param flags [Integer] 
+      # @param textAttr [Wx::RTC::RichTextAttr] 
+      # @return [Wx::RTC::RichTextField]
+      def insert_field_with_undo(buffer, pos, fieldType, properties, ctrl, flags, textAttr) end
+      
+      # Returns the style that is appropriate for a new paragraph at this position.
+      # 
+      # If the previous paragraph has a paragraph style name, looks up the next-paragraph style.
+      # @param buffer [Wx::RTC::RichTextBuffer] 
+      # @param pos [Integer] 
+      # @param caretPosition [Boolean] 
+      # @param lookUpNewParaStyle [Boolean] 
+      # @return [Wx::RTC::RichTextAttr]
+      def get_style_for_new_paragraph(buffer, pos, caretPosition=false, lookUpNewParaStyle=false) end
+      alias_method :style_for_new_paragraph, :get_style_for_new_paragraph
+      
+      # Inserts an object.
+      # @param buffer [Wx::RTC::RichTextBuffer] 
+      # @param pos [Integer] 
+      # @param object [Wx::RTC::RichTextObject] 
+      # @param ctrl [Wx::RTC::RichTextCtrl] 
+      # @param flags [Integer] 
+      # @return [Wx::RTC::RichTextObject]
+      def insert_object_with_undo(buffer, pos, object, ctrl, flags=0) end
+      
+      # Submits a command to delete this range.
+      # @param range [Range] 
+      # @param ctrl [Wx::RTC::RichTextCtrl] 
+      # @param buffer [Wx::RTC::RichTextBuffer] 
+      # @return [Boolean]
+      def delete_range_with_undo(range, ctrl, buffer) end
+      
+      # Draws the floating objects in this buffer.
+      # @param dc [Wx::DC] 
+      # @param context [Wx::RTC::RichTextDrawingContext] 
+      # @param range [Range] 
+      # @param selection [Wx::RTC::RichTextSelection] 
+      # @param rect [Wx::Rect] 
+      # @param descent [Integer] 
+      # @param style [Integer] 
+      # @return [void]
+      def draw_floats(dc, context, range, selection, rect, descent, style) end
+      
+      # Moves an anchored object to another paragraph.
+      # @param from [Wx::RTC::RichTextParagraph] 
+      # @param to [Wx::RTC::RichTextParagraph] 
+      # @param obj [Wx::RTC::RichTextObject] 
+      # @return [void]
+      def move_anchored_object_to_paragraph(from, to, obj) end
+      
+      # Initializes the object.
+      # @return [void]
+      def init; end
+      
+      # Clears all the children.
+      # @return [void]
+      def clear; end
+      
+      # Clears and initializes with one blank paragraph.
+      # @return [void]
+      def reset; end
+      
+      # Convenience function to add a paragraph of text.
+      # @param text [String] 
+      # @param paraStyle [Wx::RTC::RichTextAttr] 
+      # @return [Range]
+      def add_paragraph(text, paraStyle=nil) end
+      
+      # Convenience function to add an image.
+      # @param image [Wx::Image] 
+      # @param paraStyle [Wx::RTC::RichTextAttr] 
+      # @return [Range]
+      def add_image(image, paraStyle=nil) end
+      
+      # Adds multiple paragraphs, based on newlines.
+      # @param text [String] 
+      # @param paraStyle [Wx::RTC::RichTextAttr] 
+      # @return [Range]
+      def add_paragraphs(text, paraStyle=nil) end
+      
+      # Returns the line at the given position.
+      # 
+      # If caretPosition is true, the position is a caret position, which is normally a smaller number.
+      # @param pos [Integer] 
+      # @param caretPosition [Boolean] 
+      # @return [Wx::RTC::RichTextLine]
+      def get_line_at_position(pos, caretPosition=false) end
+      alias_method :line_at_position, :get_line_at_position
+      
+      # Returns the line at the given y pixel position, or the last line.
+      # @param y [Integer] 
+      # @return [Wx::RTC::RichTextLine]
+      def get_line_at_y_position(y) end
+      alias_method :line_at_y_position, :get_line_at_y_position
+      
+      # Returns the paragraph at the given character or caret position.
+      # @param pos [Integer] 
+      # @param caretPosition [Boolean] 
+      # @return [Wx::RTC::RichTextParagraph]
+      def get_paragraph_at_position(pos, caretPosition=false) end
+      alias_method :paragraph_at_position, :get_paragraph_at_position
+      
+      # Returns the line size at the given position.
+      # @param pos [Integer] 
+      # @param caretPosition [Boolean] 
+      # @return [Wx::Size]
+      def get_line_size_at_position(pos, caretPosition=false) end
+      alias_method :line_size_at_position, :get_line_size_at_position
+      
+      # Given a position, returns the number of the visible line (potentially many to a paragraph), starting from zero at the start of the buffer.
+      # 
+      # We also have to pass a bool (startOfLine) that indicates whether the caret is being shown at the end of the previous line or at the start of the next, since the caret can be shown at two visible positions for the same underlying position.
+      # @param pos [Integer] 
+      # @param caretPosition [Boolean] 
+      # @param startOfLine [Boolean] 
+      # @return [Integer]
+      def get_visible_line_number(pos, caretPosition=false, startOfLine=false) end
+      alias_method :visible_line_number, :get_visible_line_number
+      
+      # Given a line number, returns the corresponding {Wx::RTC::RichTextLine} object.
+      # @param lineNumber [Integer] 
+      # @return [Wx::RTC::RichTextLine]
+      def get_line_for_visible_line_number(lineNumber) end
+      alias_method :line_for_visible_line_number, :get_line_for_visible_line_number
+      
+      # Returns the leaf object in a paragraph at this position.
+      # @param position [Integer] 
+      # @return [Wx::RTC::RichTextObject]
+      def get_leaf_object_at_position(position) end
+      alias_method :leaf_object_at_position, :get_leaf_object_at_position
+      
+      # Returns the paragraph by number.
+      # @param paragraphNumber [Integer] 
+      # @return [Wx::RTC::RichTextParagraph]
+      def get_paragraph_at_line(paragraphNumber) end
+      alias_method :paragraph_at_line, :get_paragraph_at_line
+      
+      # Returns the paragraph for a given line.
+      # @param line [Wx::RTC::RichTextLine] 
+      # @return [Wx::RTC::RichTextParagraph]
+      def get_paragraph_for_line(line) end
+      alias_method :paragraph_for_line, :get_paragraph_for_line
+      
+      # Returns the length of the paragraph.
+      # @param paragraphNumber [Integer] 
+      # @return [Integer]
+      def get_paragraph_length(paragraphNumber) end
+      alias_method :paragraph_length, :get_paragraph_length
+      
+      # Returns the number of paragraphs.
+      # @return [Integer]
+      def get_paragraph_count; end
+      alias_method :paragraph_count, :get_paragraph_count
+      
+      # Returns the number of visible lines.
+      # @return [Integer]
+      def get_line_count; end
+      alias_method :line_count, :get_line_count
+      
+      # Returns the text of the paragraph.
+      # @param paragraphNumber [Integer] 
+      # @return [String]
+      def get_paragraph_text(paragraphNumber) end
+      alias_method :paragraph_text, :get_paragraph_text
+      
+      # Converts zero-based line column and paragraph number to a position.
+      # @param x [Integer] 
+      # @param y [Integer] 
+      # @return [Integer]
+      def xy_to_position(x, y) end
+      
+      # Converts a zero-based position to line column and paragraph number.
+      # @param pos [Integer] 
+      # @return [Array(Boolean,Integer,Integer)]
+      def position_to_xy(pos) end
+      
+      # @overload set_style(range, style, flags=Wx::RTC::RICHTEXT_SETSTYLE_WITH_UNDO)
+      #   Sets the attributes for the given range.
+      #   
+      #   Pass 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. So, for example, to set the style for a character at position 5, use the range (5,5). This differs from the {Wx::RTC::RichTextCtrl} API, where you would specify (5,6).
+      #   flags may contain a bit list of the following values:
+      #   
+      #   - {Wx::RTC::RICHTEXT_SETSTYLE_NONE}: no style flag.
+      #   - {Wx::RTC::RICHTEXT_SETSTYLE_WITH_UNDO}: specifies that this operation should be undoable.
+      #   - {Wx::RTC::RICHTEXT_SETSTYLE_OPTIMIZE}: specifies that the style should not be applied if the combined style at this point is already the style in question.
+      #   - {Wx::RTC::RICHTEXT_SETSTYLE_PARAGRAPHS_ONLY}: specifies that the style should only be applied to paragraphs, and not the content. This allows content styling to be preserved independently from that of e.g. a named paragraph style.
+      #   - {Wx::RTC::RICHTEXT_SETSTYLE_CHARACTERS_ONLY}: specifies that the style should only be applied to characters, and not the paragraph. This allows content styling to be preserved independently from that of e.g. a named paragraph style.
+      #   - {Wx::RTC::RICHTEXT_SETSTYLE_RESET}: resets (clears) the existing style before applying the new style.
+      #   - {Wx::RTC::RICHTEXT_SETSTYLE_REMOVE}: removes the specified style. Only the style flags are used in this operation.
+      #   @param range [Range] 
+      #   @param style [Wx::RTC::RichTextAttr] 
+      #   @param flags [Integer] 
+      #   @return [Boolean]
+      # @overload set_style(obj, textAttr, flags=Wx::RTC::RICHTEXT_SETSTYLE_WITH_UNDO)
+      #   Sets the attributes for the given object only, for example the box attributes for a text box.
+      #   @param obj [Wx::RTC::RichTextObject] 
+      #   @param textAttr [Wx::RTC::RichTextAttr] 
+      #   @param flags [Integer] 
+      #   @return [void]
+      def set_style(*args) end
+      
+      # Returns the combined text attributes for this 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::RichTextParagraphLayoutBox#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] 
+      # @param style [Wx::RTC::RichTextAttr] 
+      # @return [Boolean]
+      def get_style(position, style) end
+      alias_method :style, :get_style
+      
+      # Returns the content (uncombined) attributes for this position.
+      # @param position [Integer] 
+      # @param style [Wx::RTC::RichTextAttr] 
+      # @return [Boolean]
+      def get_uncombined_style(position, style) end
+      alias_method :uncombined_style, :get_uncombined_style
+      
+      # Implementation helper for GetStyle.
+      # 
+      # If combineStyles is true, combine base, paragraph and context attributes.
+      # @param position [Integer] 
+      # @param style [Wx::RTC::RichTextAttr] 
+      # @param combineStyles [Boolean] 
+      # @return [Boolean]
+      def do_get_style(position, style, combineStyles=true) end
+      
+      # This function gets a style representing the common, combined attributes in the given range.
+      # 
+      # Attributes which have different values within the specified range will not be included the style flags.
+      # The function is used to get the attributes to display in the formatting dialog: the user can edit the attributes common to the selection, and optionally specify the values of further attributes to be applied uniformly.
+      # To apply the edited attributes, you can use {Wx::RTC::RichTextParagraphLayoutBox#set_style} specifying the {Wx::RTC::RICHTEXT_SETSTYLE_OPTIMIZE} flag, which will only apply attributes that are different from the combined attributes within the range. So, the user edits the effective, displayed attributes for the range, but his choice won't be applied unnecessarily to content. As an example, say the style for a paragraph specifies bold, but the paragraph text doesn't specify a weight. The combined style is bold, and this is what the user will see on-screen and in the formatting dialog. The user now specifies red text, in addition to bold. When applying with {Wx::RTC::RichTextParagraphLayoutBox#set_style}, the content font weight attributes won't be changed to bold because this is already specified by the paragraph. However the text colour attributes will be changed to show red.
+      # @param range [Range] 
+      # @param style [Wx::RTC::RichTextAttr] 
+      # @return [Boolean]
+      def get_style_for_range(range, style) end
+      alias_method :style_for_range, :get_style_for_range
+      
+      # Combines style with currentStyle for the purpose of summarising the attributes of a range of content.
+      # @param currentStyle [Wx::RTC::RichTextAttr] 
+      # @param style [Wx::RTC::RichTextAttr] 
+      # @param clashingAttr [Wx::RTC::RichTextAttr] 
+      # @param absentAttr [Wx::RTC::RichTextAttr] 
+      # @return [Boolean]
+      def collect_style(currentStyle, style, clashingAttr, absentAttr) end
+      
+      # @overload set_list_style(range, def_, flags=Wx::RTC::RICHTEXT_SETSTYLE_WITH_UNDO, startFrom=1, specifiedLevel=-1)
+      #   Sets the list attributes for the given range, passing 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:
+      #   
+      #   - {Wx::RTC::RICHTEXT_SETSTYLE_WITH_UNDO}: specifies that this command will be undoable.
+      #   - {Wx::RTC::RICHTEXT_SETSTYLE_RENUMBER}: specifies that numbering should start from startFrom, otherwise existing attributes are used.
+      #   - {Wx::RTC::RICHTEXT_SETSTYLE_SPECIFY_LEVEL}: specifies that listLevel should be used as the level for all paragraphs, otherwise the current indentation will be used.
+      #   @see Wx::RTC::RichTextParagraphLayoutBox#number_list
+      #   @see  Wx::RTC::RichTextParagraphLayoutBox#promote_list
+      #   @see  Wx::RTC::RichTextParagraphLayoutBox#clear_list_style. 
+      #   @param range [Range] 
+      #   @param def_ [Wx::RTC::RichTextListStyleDefinition] 
+      #   @param flags [Integer] 
+      #   @param startFrom [Integer] 
+      #   @param specifiedLevel [Integer] 
+      #   @return [Boolean]
+      # @overload set_list_style(range, defName, flags=Wx::RTC::RICHTEXT_SETSTYLE_WITH_UNDO, startFrom=1, specifiedLevel=-1)
+      #   @param range [Range] 
+      #   @param defName [String] 
+      #   @param flags [Integer] 
+      #   @param startFrom [Integer] 
+      #   @param specifiedLevel [Integer] 
+      #   @return [Boolean]
+      def set_list_style(*args) 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.
+      # @see Wx::RTC::RichTextParagraphLayoutBox#set_list_style
+      # @see  Wx::RTC::RichTextParagraphLayoutBox#promote_list
+      # @see  Wx::RTC::RichTextParagraphLayoutBox#number_list 
+      # @param range [Range] 
+      # @param flags [Integer] 
+      # @return [Boolean]
+      def clear_list_style(range, flags=Wx::RTC::RICHTEXT_SETSTYLE_WITH_UNDO) end
+      
+      # @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:
+      #   
+      #   - {Wx::RTC::RICHTEXT_SETSTYLE_WITH_UNDO}: specifies that this command will be undoable.
+      #   - {Wx::RTC::RICHTEXT_SETSTYLE_RENUMBER}: specifies that numbering should start from startFrom, otherwise existing attributes are used.
+      #   - {Wx::RTC::RICHTEXT_SETSTYLE_SPECIFY_LEVEL}: specifies that listLevel should be used as the level for all paragraphs, otherwise the current indentation will be used.
+      #   
+      #   def can be nil to indicate that the existing list style should be used.
+      #   @see Wx::RTC::RichTextParagraphLayoutBox#set_list_style
+      #   @see  Wx::RTC::RichTextParagraphLayoutBox#promote_list
+      #   @see  Wx::RTC::RichTextParagraphLayoutBox#clear_list_style 
+      #   @param range [Range] 
+      #   @param def_ [Wx::RTC::RichTextListStyleDefinition] 
+      #   @param flags [Integer] 
+      #   @param startFrom [Integer] 
+      #   @param specifiedLevel [Integer] 
+      #   @return [Boolean]
+      # @overload number_list(range, defName, flags=Wx::RTC::RICHTEXT_SETSTYLE_WITH_UNDO, startFrom=1, specifiedLevel=-1)
+      #   @param range [Range] 
+      #   @param defName [String] 
+      #   @param flags [Integer] 
+      #   @param startFrom [Integer] 
+      #   @param specifiedLevel [Integer] 
+      #   @return [Boolean]
+      def number_list(*args) end
+      
+      # @overload promote_list(promoteBy, range, def_=nil, flags=Wx::RTC::RICHTEXT_SETSTYLE_WITH_UNDO, specifiedLevel=-1)
+      #   Promotes the list items within 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:
+      #   
+      #   - {Wx::RTC::RICHTEXT_SETSTYLE_WITH_UNDO}: specifies that this command will be undoable.
+      #   - {Wx::RTC::RICHTEXT_SETSTYLE_RENUMBER}: specifies that numbering should start from startFrom, otherwise existing attributes are used.
+      #   - {Wx::RTC::RICHTEXT_SETSTYLE_SPECIFY_LEVEL}: specifies that listLevel should be used as the level for all paragraphs, otherwise the current indentation will be used.
+      #   @see Wx::RTC::RichTextParagraphLayoutBox#set_list_style
+      #   @see  Wx::RTC::RichTextParagraphLayoutBox#set_list_style
+      #   @see  Wx::RTC::RichTextParagraphLayoutBox#clear_list_style 
+      #   @param promoteBy [Integer] 
+      #   @param range [Range] 
+      #   @param def_ [Wx::RTC::RichTextListStyleDefinition] 
+      #   @param flags [Integer] 
+      #   @param specifiedLevel [Integer] 
+      #   @return [Boolean]
+      # @overload promote_list(promoteBy, range, defName, flags=Wx::RTC::RICHTEXT_SETSTYLE_WITH_UNDO, specifiedLevel=-1)
+      #   @param promoteBy [Integer] 
+      #   @param range [Range] 
+      #   @param defName [String] 
+      #   @param flags [Integer] 
+      #   @param specifiedLevel [Integer] 
+      #   @return [Boolean]
+      def promote_list(*args) end
+      
+      # Helper for NumberList and PromoteList, that does renumbering and promotion simultaneously def can be nil/empty to indicate that the existing list style should be used.
+      # @param range [Range] 
+      # @param promotionRange [Range] 
+      # @param promoteBy [Integer] 
+      # @param def_ [Wx::RTC::RichTextListStyleDefinition] 
+      # @param flags [Integer] 
+      # @param startFrom [Integer] 
+      # @param specifiedLevel [Integer] 
+      # @return [Boolean]
+      def do_number_list(range, promotionRange, promoteBy, def_, flags=Wx::RTC::RICHTEXT_SETSTYLE_WITH_UNDO, startFrom=1, specifiedLevel=-1) end
+      
+      # Fills in the attributes for numbering a paragraph after previousParagraph.
+      # @param previousParagraph [Wx::RTC::RichTextParagraph] 
+      # @param attr [Wx::RTC::RichTextAttr] 
+      # @return [Boolean]
+      def find_next_paragraph_number(previousParagraph, attr) 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:
+      # 
+      # - {Wx::RTC::RICHTEXT_SETPROPERTIES_NONE}: no flag.
+      # - {Wx::RTC::RICHTEXT_SETPROPERTIES_WITH_UNDO}: specifies that this operation should be undoable.
+      # - {Wx::RTC::RICHTEXT_SETPROPERTIES_PARAGRAPHS_ONLY}: specifies that the properties should only be applied to paragraphs, and not the content.
+      # - {Wx::RTC::RICHTEXT_SETPROPERTIES_CHARACTERS_ONLY}: specifies that the properties should only be applied to characters, and not the paragraph.
+      # - {Wx::RTC::RICHTEXT_SETPROPERTIES_RESET}: resets (clears) the existing properties before applying the new properties.
+      # - {Wx::RTC::RICHTEXT_SETPROPERTIES_REMOVE}: removes the specified properties.
+      # @param range [Range] 
+      # @param properties [Wx::RTC::RichTextProperties] 
+      # @param flags [Integer] 
+      # @return [Boolean]
+      def set_properties(range, properties, flags=Wx::RTC::RICHTEXT_SETPROPERTIES_WITH_UNDO) end
+      
+      # Sets with undo the properties for the given object.
+      # @param obj [Wx::RTC::RichTextObject] 
+      # @param properties [Wx::RTC::RichTextProperties] 
+      # @param objToSet [Wx::RTC::RichTextObject] 
+      # @return [Boolean]
+      def set_object_properties_with_undo(obj, properties, objToSet=nil) 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] 
+      # @param style [Wx::RTC::RichTextAttr] 
+      # @return [Boolean]
+      def has_character_attributes(range, style) end
+      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] 
+      # @return [Boolean]
+      def has_paragraph_attributes(range, style) end
+      alias_method :has_paragraph_attributes?, :has_paragraph_attributes
+      
+      # Clones the object.
+      # @return [Wx::RTC::RichTextObject]
+      def clone; end
+      
+      # Prepares the content just before insertion (or after buffer reset).
+      # 
+      # Currently is only called if undo mode is on.
+      # @param container [Wx::RTC::RichTextParagraphLayoutBox] 
+      # @return [void]
+      def prepare_content(container) end
+      
+      # Insert fragment into this box at the given position.
+      # 
+      # If partialParagraph is true, it is assumed that the last (or only) paragraph is just a piece of data with no paragraph marker.
+      # @param position [Integer] 
+      # @param fragment [Wx::RTC::RichTextParagraphLayoutBox] 
+      # @return [Boolean]
+      def insert_fragment(position, fragment) end
+      
+      # Make a copy of the fragment corresponding to the given range, putting it in fragment.
+      # @param range [Range] 
+      # @param fragment [Wx::RTC::RichTextParagraphLayoutBox] 
+      # @return [Boolean]
+      def copy_fragment(range, fragment) end
+      
+      # Apply the style sheet to the buffer, for example if the styles have changed.
+      # @param styleSheet [Wx::RTC::RichTextStyleSheet] 
+      # @return [Boolean]
+      def apply_style_sheet(styleSheet) end
+      
+      # @param obj [Wx::RTC::RichTextParagraphLayoutBox] 
+      # @return [void]
+      def copy(obj) end
+      
+      # Calculate ranges.
+      # @return [void]
+      def update_ranges; end
+      
+      # Get all the text.
+      # @return [String]
+      def get_text; end
+      alias_method :text, :get_text
+      
+      # Sets the default style, affecting the style currently being applied (for example, setting the default style to bold will cause subsequently inserted text to be bold).
+      # 
+      # This is not cumulative - setting the default style will replace the previous default style.
+      # Setting it to a default attribute object makes new content take on the 'basic' style.
+      # @param style [Wx::RTC::RichTextAttr] 
+      # @return [Boolean]
+      def set_default_style(style) end
+      alias_method :default_style=, :set_default_style
+      
+      # Returns the current default style, affecting 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_default_style; end
+      alias_method :default_style, :get_default_style
+      
+      # 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]
+      def set_basic_style(style) end
+      alias_method :basic_style=, :set_basic_style
+      
+      # Returns 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
+      alias_method :basic_style, :get_basic_style
+      
+      # Invalidates the buffer.
+      # 
+      # With no argument, invalidates whole buffer.
+      # @param invalidRange [Range] 
+      # @return [void]
+      def invalidate(invalidRange=Wx::RICHTEXT_ALL) end
+      
+      # Do the (in)validation for this object only.
+      # @param invalidRange [Range] 
+      # @return [void]
+      def do_invalidate(invalidRange) end
+      
+      # Do the (in)validation both up and down the hierarchy.
+      # @param invalidRange [Range] 
+      # @return [void]
+      def invalidate_hierarchy(invalidRange=Wx::RICHTEXT_ALL) end
+      
+      # Gather information about floating objects.
+      # 
+      # If untilObj is non-null, will stop getting information if the current object is this, since we will collect the rest later.
+      # @param availableRect [Wx::Rect] 
+      # @param untilObj [Wx::RTC::RichTextObject] 
+      # @return [Boolean]
+      def update_floating_objects(availableRect, untilObj=nil) end
+      
+      # Get invalid range, rounding to entire paragraphs if argument is true.
+      # @param wholeParagraphs [Boolean] 
+      # @return [Range]
+      def get_invalid_range(wholeParagraphs=false) end
+      alias_method :invalid_range, :get_invalid_range
+      
+      # Returns true if this object needs layout.
+      # @return [Boolean]
+      def is_dirty; end
+      alias_method :dirty?, :is_dirty
+      
+      # Returns the {Wx::RTC::RichTextFloatCollector} of this object.
+      # @return [Wx::RTC::RichTextFloatCollector]
+      def get_float_collector; end
+      alias_method :float_collector, :get_float_collector
+      
+      # Returns the number of floating objects at this level.
+      # @return [Integer]
+      def get_floating_object_count; end
+      alias_method :floating_object_count, :get_floating_object_count
+      
+      # Returns a list of floating objects.
+      # @param objects [Array<Wx::RTC::RichTextObject>] 
+      # @return [Boolean]
+      def get_floating_objects(objects) end
+      alias_method :floating_objects, :get_floating_objects
+      
+    end # RichTextParagraphLayoutBox
+    
+    # This class implements the general concept of a field, an object that represents additional functionality such as a footnote, a bookmark, a page number, a table of contents, and so on.
+    # 
+    # Extra information (such as a bookmark name) can be stored in the object properties.
+    # Drawing, layout, and property editing is delegated to classes derived from {Wx::RTC::RichTextFieldType}, such as instances of {Wx::RTC::RichTextFieldTypeStandard}; this makes the use of fields an efficient method of introducing extra functionality, since most of the information required to draw a field (such as a bitmap) is kept centrally in a single field type definition.
+    # The FieldType property, accessed by SetFieldType/GetFieldType, is used to retrieve the field type definition. So be careful not to overwrite this property.
+    # {Wx::RTC::RichTextField} is derived from {Wx::RTC::RichTextParagraphLayoutBox}, which means that it can contain its own read-only content, refreshed when the application calls the UpdateField function. Whether a field is treated as a composite or a single graphic is determined by the field type definition. If using {Wx::RTC::RichTextFieldTypeStandard}, passing the display type {Wx::RTC::RichTextFieldTypeStandard::RICHTEXT_FIELD_STYLE_COMPOSITE} to the field type definition causes the field to behave like a composite; the other display styles display a simple graphic. When implementing a composite field, you will still need to derive from {Wx::RTC::RichTextFieldTypeStandard} or {Wx::RTC::RichTextFieldType}, if only to implement UpdateField to refresh the field content appropriately. {Wx::RTC::RichTextFieldTypeStandard} is only one possible implementation, but covers common needs especially for simple, static fields using text or a bitmap.
+    # Register field types on application initialisation with the static function {Wx::RTC::RichTextBuffer.add_field_type}. They will be deleted automatically on application exit.
+    # An application can write a field to a control with {Wx::RTC::RichTextCtrl#write_field}, taking a field type, the properties for the field, and optional attributes.
+    # 
+    # Category:  Rich Text
+    # @see Wx::RTC::RichTextFieldTypeStandard
+    # @see  Wx::RTC::RichTextFieldType
+    # @see  Wx::RTC::RichTextParagraphLayoutBox
+    # @see  Wx::RTC::RichTextProperties
+    # @see  Wx::RTC::RichTextCtrl 
+    # 
+    # 
+    # 
+    # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+    # @wxrb_require USE_RICHTEXT
+    class RichTextField < RichTextParagraphLayoutBox
+    
+      # @overload initialize(fieldType=(''), parent=nil)
+      #   Default constructor; optionally pass the parent object.
+      #   @param fieldType [String] 
+      #   @param parent [Wx::RTC::RichTextObject] 
+      #   @return [Wx::RTC::RichTextField]
+      # @overload initialize(obj)
+      #   Copy constructor.
+      #   @param obj [Wx::RTC::RichTextField] 
+      #   @return [Wx::RTC::RichTextField]
+      def initialize(*args) end
+      
+      # Draw the item, within the given range.
+      # 
+      # Some objects may ignore the range (for example paragraphs) while others must obey it (lines, to implement wrapping)
+      # @param dc [Wx::DC] 
+      # @param context [Wx::RTC::RichTextDrawingContext] 
+      # @param range [Range] 
+      # @param selection [Wx::RTC::RichTextSelection] 
+      # @param rect [Wx::Rect] 
+      # @param descent [Integer] 
+      # @param style [Integer] 
+      # @return [Boolean]
+      def draw(dc, context, range, selection, rect, descent, style) end
+      
+      # Lay the item out at the specified position with the given size constraint.
+      # 
+      # Layout must set the cached size. rect is the available space for the object, and parentRect is the container that is used to determine a relative size or position (for example if a text box must be 50% of the parent text box).
+      # @param dc [Wx::ReadOnlyDC] 
+      # @param context [Wx::RTC::RichTextDrawingContext] 
+      # @param rect [Wx::Rect] 
+      # @param parentRect [Wx::Rect] 
+      # @param style [Integer] 
+      # @return [Boolean]
+      def layout(dc, context, rect, parentRect, style) end
+      
+      # Returns the object size for the given range.
+      # 
+      # Returns false if the range is invalid for this object.
+      # @param range [Range] 
+      # @param size [Array(Integer, Integer), Wx::Size] 
+      # @param descent [int] 
+      # @param dc [Wx::ReadOnlyDC] 
+      # @param context [Wx::RTC::RichTextDrawingContext] 
+      # @param flags [Integer] 
+      # @param position [Array(Integer, Integer), Wx::Point] 
+      # @param parentSize [Array(Integer, Integer), Wx::Size] 
+      # @param partialExtents [Array,nil] 
+      # @return [Boolean]
+      def get_range_size(range, size, descent, dc, context, flags, position=(Wx::Point.new(0, 0)), parentSize=Wx::DEFAULT_SIZE, partialExtents=nil) end
+      alias_method :range_size, :get_range_size
+      
+      # Returns the XML node name of this object.
+      # 
+      # This must be overridden for {Wx::XmlNode}-base XML export to work.
+      # @return [String]
+      def get_xml_node_name; end
+      alias_method :xml_node_name, :get_xml_node_name
+      
+      # Returns true if we can edit the object's properties via a GUI.
+      # @return [Boolean]
+      def can_edit_properties; end
+      alias_method :can_edit_properties?, :can_edit_properties
+      
+      # Edits the object's properties via a GUI.
+      # @param parent [Wx::Window] 
+      # @param buffer [Wx::RTC::RichTextBuffer] 
+      # @return [Boolean]
+      def edit_properties(parent, buffer) end
+      
+      # Returns the label to be used for the properties context menu item.
+      # @return [String]
+      def get_properties_menu_label; end
+      alias_method :properties_menu_label, :get_properties_menu_label
+      
+      # Returns true if objects of this class can accept the focus, i.e. a call to SetFocusObject is possible.
+      # 
+      # For example, containers supporting text, such as a text box object, can accept the focus, but a table can't (set the focus to individual cells instead).
+      # @return [Boolean]
+      def accepts_focus; end
+      
+      # Calculates the range of the object.
+      # 
+      # By default, guess that the object is 1 unit long.
+      # @param start [Integer] 
+      # @param end_ [Integer] 
+      # @return [Integer]
+      def calculate_range(start, end_) end
+      
+      # If a field has children, we don't want the user to be able to edit it.
+      # @return [Boolean]
+      def is_atomic; end
+      alias_method :atomic?, :is_atomic
+      
+      # Returns true if the buffer is empty.
+      # @return [Boolean]
+      def is_empty; end
+      alias_method :empty?, :is_empty
+      
+      # Returns true if this object is top-level, i.e. contains its own paragraphs, such as a text box.
+      # @return [Boolean]
+      def is_top_level; end
+      alias_method :top_level?, :is_top_level
+      
+      # @param fieldType [String] 
+      # @return [void]
+      def set_field_type(fieldType) end
+      alias_method :field_type=, :set_field_type
+      
+      # @return [String]
+      def get_field_type; end
+      alias_method :field_type, :get_field_type
+      
+      # Update the field; delegated to the associated field type.
+      # 
+      # This would typically expand the field to its value, if this is a dynamically changing and/or composite field.
+      # @param buffer [Wx::RTC::RichTextBuffer] 
+      # @return [Boolean]
+      def update_field(buffer) end
+      
+      # Clones the object.
+      # @return [Wx::RTC::RichTextObject]
+      def clone; end
+      
+      # @param obj [Wx::RTC::RichTextField] 
+      # @return [void]
+      def copy(obj) end
+      
+    end # RichTextField
+    
+    # A style sheet contains named paragraph and character styles that make it easy for a user to apply combinations of attributes to a {Wx::RTC::RichTextCtrl}.
+    # 
+    # You can use a {Wx::RTC::RichTextStyleListBox} in your user interface to show available styles to the user, and allow application of styles to the control.
+    # 
+    # Category:  Rich Text
+    # 
+    # @wxrb_require USE_RICHTEXT
+    class RichTextStyleSheet < Object
+    
+      # @overload initialize()
+      #   Constructor.
+      #   @return [Wx::RTC::RichTextStyleSheet]
+      # @overload initialize(sheet)
+      #   Copy constructor.
+      #   @param sheet [Wx::RTC::RichTextStyleSheet] 
+      #   @return [Wx::RTC::RichTextStyleSheet]
+      def initialize(*args) end
+      
+      # Copies given style sheet.
+      # @param sheet [Wx::RTC::RichTextStyleSheet] 
+      # @return [void]
+      def copy(sheet) end
+      
+      # Adds a definition to the character style list.
+      # @param def_ [Wx::RTC::RichTextCharacterStyleDefinition] 
+      # @return [Boolean]
+      def add_character_style(def_) end
+      
+      # Adds a definition to the list style list.
+      # @param def_ [Wx::RTC::RichTextListStyleDefinition] 
+      # @return [Boolean]
+      def add_list_style(def_) end
+      
+      # Adds a definition to the paragraph style list.
+      # @param def_ [Wx::RTC::RichTextParagraphStyleDefinition] 
+      # @return [Boolean]
+      def add_paragraph_style(def_) end
+      
+      # Adds a definition to the appropriate style list.
+      # @param def_ [Wx::RTC::RichTextStyleDefinition] 
+      # @return [Boolean]
+      def add_style(def_) end
+      
+      # Deletes all styles.
+      # @return [void]
+      def delete_styles; end
+      
+      # Finds a character definition by name.
+      # @param name [String] 
+      # @param recurse [Boolean] 
+      # @return [Wx::RTC::RichTextCharacterStyleDefinition]
+      def find_character_style(name, recurse=true) end
+      
+      # Finds a list definition by name.
+      # @param name [String] 
+      # @param recurse [Boolean] 
+      # @return [Wx::RTC::RichTextListStyleDefinition]
+      def find_list_style(name, recurse=true) end
+      
+      # Finds a paragraph definition by name.
+      # @param name [String] 
+      # @param recurse [Boolean] 
+      # @return [Wx::RTC::RichTextParagraphStyleDefinition]
+      def find_paragraph_style(name, recurse=true) end
+      
+      # Finds a style definition by name.
+      # @param name [String] 
+      # @return [Wx::RTC::RichTextStyleDefinition]
+      def find_style(name) end
+      
+      # Returns the nth character style.
+      # @param n [Integer] 
+      # @return [Wx::RTC::RichTextCharacterStyleDefinition]
+      def get_character_style(n) end
+      alias_method :character_style, :get_character_style
+      
+      # Returns the number of character styles.
+      # @return [Integer]
+      def get_character_style_count; end
+      alias_method :character_style_count, :get_character_style_count
+      
+      # Returns the style sheet's description.
+      # @return [Wx::String]
+      def get_description; end
+      alias_method :description, :get_description
+      
+      # Returns the nth list style.
+      # @param n [Integer] 
+      # @return [Wx::RTC::RichTextListStyleDefinition]
+      def get_list_style(n) end
+      alias_method :list_style, :get_list_style
+      
+      # Returns the number of list styles.
+      # @return [Integer]
+      def get_list_style_count; end
+      alias_method :list_style_count, :get_list_style_count
+      
+      # Returns the style sheet's name.
+      # @return [Wx::String]
+      def get_name; end
+      alias_method :name, :get_name
+      
+      # Returns the nth paragraph style.
+      # @param n [Integer] 
+      # @return [Wx::RTC::RichTextParagraphStyleDefinition]
+      def get_paragraph_style(n) end
+      alias_method :paragraph_style, :get_paragraph_style
+      
+      # Returns the number of paragraph styles.
+      # @return [Integer]
+      def get_paragraph_style_count; end
+      alias_method :paragraph_style_count, :get_paragraph_style_count
+      
+      # Removes a character style.
+      # @param def_ [Wx::RTC::RichTextStyleDefinition] 
+      # @param deleteStyle [Boolean] 
+      # @return [Boolean]
+      def remove_character_style(def_, deleteStyle=false) end
+      
+      # Removes a list style.
+      # @param def_ [Wx::RTC::RichTextStyleDefinition] 
+      # @param deleteStyle [Boolean] 
+      # @return [Boolean]
+      def remove_list_style(def_, deleteStyle=false) end
+      
+      # Removes a paragraph style.
+      # @param def_ [Wx::RTC::RichTextStyleDefinition] 
+      # @param deleteStyle [Boolean] 
+      # @return [Boolean]
+      def remove_paragraph_style(def_, deleteStyle=false) end
+      
+      # Removes a style.
+      # @param def_ [Wx::RTC::RichTextStyleDefinition] 
+      # @param deleteStyle [Boolean] 
+      # @return [Boolean]
+      def remove_style(def_, deleteStyle=false) end
+      
+      # Sets the style sheet's description.
+      # @param descr [String] 
+      # @return [void]
+      def set_description(descr) end
+      alias_method :description=, :set_description
+      
+      # Sets the style sheet's name.
+      # @param name [String] 
+      # @return [void]
+      def set_name(name) end
+      alias_method :name=, :set_name
+      
+      # Returns the sheet's properties.
+      # @return [Wx::RTC::RichTextProperties]
+      def get_properties; end
+      alias_method :properties, :get_properties
+      
+      # Sets the sheet's properties.
+      # @param props [Wx::RTC::RichTextProperties] 
+      # @return [void]
+      def set_properties(props) end
+      alias_method :properties=, :set_properties
+      
+    end # RichTextStyleSheet
+    
+    # This is a base class for paragraph and character styles.
+    # 
+    # Category:  Rich Text
+    # 
+    # @wxrb_require USE_RICHTEXT
+    class RichTextStyleDefinition < Object
+    
+      # Constructor.
+      # @param name [String] 
+      # @return [Wx::RTC::RichTextStyleDefinition]
+      def initialize(name=('')) end
+      
+      # Returns the style on which this style is based.
+      # @return [Wx::String]
+      def get_base_style; end
+      alias_method :base_style, :get_base_style
+      
+      # Returns the style's description.
+      # @return [Wx::String]
+      def get_description; end
+      alias_method :description, :get_description
+      
+      # Returns the style name.
+      # @return [Wx::String]
+      def get_name; end
+      alias_method :name, :get_name
+      
+      # Returns the style attributes combined with the attributes of the specified base style, if any.
+      # 
+      # This function works recursively.
+      # @param sheet [Wx::RTC::RichTextStyleSheet] 
+      # @return [Wx::RTC::RichTextAttr]
+      def get_style_merged_with_base(sheet) end
+      alias_method :style_merged_with_base, :get_style_merged_with_base
+      
+      # Sets the name of the style that this style is based on.
+      # @param name [String] 
+      # @return [void]
+      def set_base_style(name) end
+      alias_method :base_style=, :set_base_style
+      
+      # Sets the style description.
+      # @param descr [String] 
+      # @return [void]
+      def set_description(descr) end
+      alias_method :description=, :set_description
+      
+      # Sets the name of the style.
+      # @param name [String] 
+      # @return [void]
+      def set_name(name) end
+      alias_method :name=, :set_name
+      
+      # Sets the attributes for this style.
+      # @param style [Wx::RTC::RichTextAttr] 
+      # @return [void]
+      def set_style(style) end
+      alias_method :style=, :set_style
+      
+      # Returns the definition's properties.
+      # @return [Wx::RTC::RichTextProperties]
+      def get_properties; end
+      alias_method :properties, :get_properties
+      
+      # Sets the definition's properties.
+      # @param props [Wx::RTC::RichTextProperties] 
+      # @return [void]
+      def set_properties(props) end
+      alias_method :properties=, :set_properties
+      
+    end # RichTextStyleDefinition
+    
+    # This class represents a character style definition, usually added to a {Wx::RTC::RichTextStyleSheet}.
+    # 
+    # Category:  Rich Text
+    # 
+    # @wxrb_require USE_RICHTEXT
+    class RichTextCharacterStyleDefinition < RichTextStyleDefinition
+    
+      # Constructor.
+      # @param name [String] 
+      # @return [Wx::RTC::RichTextCharacterStyleDefinition]
+      def initialize(name=('')) end
+      
+    end # RichTextCharacterStyleDefinition
+    
+    # This class represents a paragraph style definition, usually added to a {Wx::RTC::RichTextStyleSheet}.
+    # 
+    # Category:  Rich Text
+    # 
+    # @wxrb_require USE_RICHTEXT
+    class RichTextParagraphStyleDefinition < RichTextStyleDefinition
+    
+      # Constructor.
+      # @param name [String] 
+      # @return [Wx::RTC::RichTextParagraphStyleDefinition]
+      def initialize(name=('')) end
+      
+      # Returns the style that should normally follow this style.
+      # @return [Wx::String]
+      def get_next_style; end
+      alias_method :next_style, :get_next_style
+      
+      # Sets the style that should normally follow this style.
+      # @param name [String] 
+      # @return [void]
+      def set_next_style(name) end
+      alias_method :next_style=, :set_next_style
+      
+    end # RichTextParagraphStyleDefinition
+    
+    # This class represents a list style definition, usually added to a {Wx::RTC::RichTextStyleSheet}.
+    # 
+    # The class inherits paragraph attributes from {Wx::RichTextStyleParagraphDefinition}, and adds 10 further attribute objects, one for each level of a list. When applying a list style to a paragraph, the list style's base and appropriate level attributes are merged with the paragraph's existing attributes.
+    # You can apply a list style to one or more paragraphs using {Wx::RTC::RichTextCtrl#set_list_style}. You can also use the functions {Wx::RTC::RichTextCtrl#number_list}, {Wx::RTC::RichTextCtrl#promote_list} and {Wx::RTC::RichTextCtrl#clear_list_style}.
+    # As usual, there are {Wx::RTC::RichTextBuffer} versions of these functions so that you can apply them directly to a buffer without requiring a control.
+    # 
+    # Category:  Rich Text
+    # 
+    # @wxrb_require USE_RICHTEXT
+    class RichTextListStyleDefinition < RichTextParagraphStyleDefinition
+    
+      # Constructor.
+      # @param name [String] 
+      # @return [Wx::RTC::RichTextListStyleDefinition]
+      def initialize(name=('')) end
+      
+      # This function combines the given paragraph style with the list style's base attributes and level style matching the given indent, returning the combined attributes.
+      # 
+      # If styleSheet is specified, the base style for this definition will also be included in the result.
+      # @param indent [Integer] 
+      # @param paraStyle [Wx::RTC::RichTextAttr] 
+      # @param styleSheet [Wx::RTC::RichTextStyleSheet] 
+      # @return [Wx::RTC::RichTextAttr]
+      def combine_with_paragraph_style(indent, paraStyle, styleSheet=nil) end
+      
+      # This function finds the level (from 0 to 9) whose indentation attribute mostly closely matches indent (expressed in tenths of a millimetre).
+      # @param indent [Integer] 
+      # @return [Integer]
+      def find_level_for_indent(indent) end
+      
+      # This function combines the list style's base attributes and the level style matching the given indent, returning the combined attributes.
+      # 
+      # If styleSheet is specified, the base style for this definition will also be included in the result.
+      # @param indent [Integer] 
+      # @param styleSheet [Wx::RTC::RichTextStyleSheet] 
+      # @return [Wx::RTC::RichTextAttr]
+      def get_combined_style(indent, styleSheet=nil) end
+      alias_method :combined_style, :get_combined_style
+      
+      # This function combines the list style's base attributes and the style for the specified level, returning the combined attributes.
+      # 
+      # If styleSheet is specified, the base style for this definition will also be included in the result.
+      # @param level [Integer] 
+      # @param styleSheet [Wx::RTC::RichTextStyleSheet] 
+      # @return [Wx::RTC::RichTextAttr]
+      def get_combined_style_for_level(level, styleSheet=nil) end
+      alias_method :combined_style_for_level, :get_combined_style_for_level
+      
+      # Returns the style for the given level.
+      # 
+      # level is a number between 0 and 9.
+      # @param level [Integer] 
+      # @return [Wx::RTC::RichTextAttr]
+      def get_level_attributes(level) end
+      alias_method :level_attributes, :get_level_attributes
+      
+      # Returns the number of levels.
+      # 
+      # This is hard-wired to 10. Returns the style for the given level. level is a number between 0 and 9.
+      # @return [Integer]
+      def get_level_count; end
+      alias_method :level_count, :get_level_count
+      
+      # Returns true if the given level has numbered list attributes.
+      # @param level [Integer] 
+      # @return [Boolean]
+      def is_numbered(level) end
+      alias_method :numbered?, :is_numbered
+      
+      # Sets the style for the given level.
+      # 
+      # level is a number between 0 and 9. The first and most flexible form uses a {Wx::TextAttr} object, while the second form is for convenient setting of the most commonly-used attributes.
+      # @param level [Integer] 
+      # @param attr [Wx::RTC::RichTextAttr] 
+      # @return [void]
+      def set_level_attributes(level, attr) end
+      
+      # Convenience function for setting the major attributes for a list level specification.
+      # @param i [Integer] 
+      # @param leftIndent [Integer] 
+      # @param leftSubIndent [Integer] 
+      # @param bulletStyle [Integer] 
+      # @param bulletSymbol [String] 
+      # @return [void]
+      def set_attributes(i, leftIndent, leftSubIndent, bulletStyle, bulletSymbol=('')) end
+      
+    end # RichTextListStyleDefinition
+    
+
+  end
+
+end