wxruby3 1.6.1 → 1.7.0

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

@@ -0,0 +1,1188 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  module RTC
+
+    # This is a kind of paragraph layout box, used to represent the whole buffer.
+    # 
+    # Category:  Rich Text
+    # @see Wx::RTC::RichTextParagraphLayoutBox
+    # @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 RichTextBuffer < RichTextParagraphLayoutBox
+    
+      # @overload initialize()
+      #   Default constructor.
+      #   @return [Wx::RTC::RichTextBuffer]
+      # @overload initialize(obj)
+      #   Copy constructor.
+      #   @param obj [Wx::RTC::RichTextBuffer] 
+      #   @return [Wx::RTC::RichTextBuffer]
+      def initialize(*args) end
+      
+      # Sets style sheet, if any.
+      # 
+      # This will allow the application to use named character and paragraph styles found in the style sheet.
+      # Neither the buffer nor the control owns the style sheet so must be deleted by the application.
+      # @param styleSheet [Wx::RTC::RichTextStyleSheet] 
+      # @return [void]
+      def set_style_sheet(styleSheet) end
+      alias_method :style_sheet=, :set_style_sheet
+      
+      # Returns the style sheet.
+      # @return [Wx::RTC::RichTextStyleSheet]
+      def get_style_sheet; end
+      alias_method :style_sheet, :get_style_sheet
+      
+      # Sets the style sheet and sends a notification of the change.
+      # @param sheet [Wx::RTC::RichTextStyleSheet] 
+      # @return [Boolean]
+      def set_style_sheet_and_notify(sheet) end
+      alias_method :style_sheet_and_notify=, :set_style_sheet_and_notify
+      
+      # Pushes the style sheet to the top of the style sheet stack.
+      # @param styleSheet [Wx::RTC::RichTextStyleSheet] 
+      # @return [Boolean]
+      def push_style_sheet(styleSheet) end
+      
+      # Pops the style sheet from the top of the style sheet stack.
+      # @return [Wx::RTC::RichTextStyleSheet]
+      def pop_style_sheet; end
+      
+      # Returns the table storing fonts, for quick access and font reuse.
+      # @return [Wx::RTC::RichTextFontTable]
+      def get_font_table; end
+      alias_method :font_table, :get_font_table
+      
+      # Sets table storing fonts, for quick access and font reuse.
+      # @param table [Wx::RTC::RichTextFontTable] 
+      # @return [void]
+      def set_font_table(table) end
+      alias_method :font_table=, :set_font_table
+      
+      # Sets the scale factor for displaying fonts, for example for more comfortable editing.
+      # @param fontScale [Float] 
+      # @return [void]
+      def set_font_scale(fontScale) end
+      alias_method :font_scale=, :set_font_scale
+      
+      # Returns the scale factor for displaying fonts, for example for more comfortable editing.
+      # @return [Float]
+      def get_font_scale; end
+      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] 
+      # @return [void]
+      def set_dimension_scale(dimScale) end
+      alias_method :dimension_scale=, :set_dimension_scale
+      
+      # Returns the scale factor for displaying certain dimensions such as indentation and inter-paragraph spacing.
+      # @return [Float]
+      def get_dimension_scale; end
+      alias_method :dimension_scale, :get_dimension_scale
+      
+      # Initialisation.
+      # @return [void]
+      def init; end
+      
+      # Clears the buffer, adds an empty paragraph, and clears the command processor.
+      # @return [void]
+      def reset_and_clear_commands; end
+      
+      # @overload load_file(filename, type=Wx::RTC::RichTextFileType::RICHTEXT_TYPE_ANY)
+      #   Loads content from a stream or file.
+      #   
+      #   Not all handlers will implement file loading.
+      #   @param filename [String] 
+      #   @param type [Wx::RichTextFileType] 
+      #   @return [Boolean]
+      # @overload load_file(stream, type=Wx::RTC::RichTextFileType::RICHTEXT_TYPE_ANY)
+      #   @param stream [Wx::InputStream] 
+      #   @param type [Wx::RichTextFileType] 
+      #   @return [Boolean]
+      def load_file(*args) end
+      
+      # @overload save_file(filename, type=Wx::RTC::RichTextFileType::RICHTEXT_TYPE_ANY)
+      #   Saves content to a stream or file.
+      #   
+      #   Not all handlers will implement file saving.
+      #   @param filename [String] 
+      #   @param type [Wx::RichTextFileType] 
+      #   @return [Boolean]
+      # @overload save_file(stream, type=Wx::RTC::RichTextFileType::RICHTEXT_TYPE_ANY)
+      #   @param stream [Wx::OutputStream] 
+      #   @param type [Wx::RichTextFileType] 
+      #   @return [Boolean]
+      def save_file(*args) end
+      
+      # Sets the handler flags, controlling loading and saving.
+      # @param flags [Integer] 
+      # @return [void]
+      def set_handler_flags(flags) end
+      alias_method :handler_flags=, :set_handler_flags
+      
+      # Gets the handler flags, controlling loading and saving.
+      # @return [Integer]
+      def get_handler_flags; end
+      alias_method :handler_flags, :get_handler_flags
+      
+      # 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
+      
+      # Begin collapsing undo/redo commands.
+      # 
+      # Note that this may not work properly if combining commands that delete or insert content, changing ranges for subsequent actions.
+      # cmdName should be the name of the combined command that will appear next to Undo and Redo in the edit menu.
+      # @param cmdName [String] 
+      # @return [Boolean]
+      def begin_batch_undo(cmdName) end
+      
+      # End collapsing undo/redo commands.
+      # @return [Boolean]
+      def end_batch_undo; end
+      
+      # Returns true if we are collapsing commands.
+      # @return [Boolean]
+      def batching_undo; end
+      
+      # Begin suppressing undo/redo commands.
+      # 
+      # The way undo is suppressed may be implemented differently by each command. If not dealt with by a command implementation, then it will be implemented automatically by not storing the command in the undo history when the action is submitted to the command processor.
+      # @return [Boolean]
+      def begin_suppress_undo; end
+      
+      # End suppressing undo/redo commands.
+      # @return [Boolean]
+      def end_suppress_undo; end
+      
+      # Are we suppressing undo?
+      # 
+      # ?
+      # @return [Boolean]
+      def suppressing_undo; end
+      
+      # Copy the range to the clipboard.
+      # @param range [Range] 
+      # @return [Boolean]
+      def copy_to_clipboard(range) end
+      
+      # Paste the clipboard content to the buffer.
+      # @param position [Integer] 
+      # @return [Boolean]
+      def paste_from_clipboard(position) end
+      
+      # Returns true if we can paste from the clipboard.
+      # @return [Boolean]
+      def can_paste_from_clipboard; end
+      alias_method :can_paste_from_clipboard?, :can_paste_from_clipboard
+      
+      # Begin using a style.
+      # @param style [Wx::RTC::RichTextAttr] 
+      # @return [Boolean]
+      def begin_style(style) end
+      
+      # End the style.
+      # @return [Boolean]
+      def end_style; end
+      
+      # End all styles.
+      # @return [Boolean]
+      def end_all_styles; end
+      
+      # Clears the style stack.
+      # @return [void]
+      def clear_style_stack; end
+      
+      # Returns the size of the style stack, for example to check correct nesting.
+      # @return [Integer]
+      def get_style_stack_size; end
+      alias_method :style_stack_size, :get_style_stack_size
+      
+      # Begins using bold.
+      # @return [Boolean]
+      def begin_bold; end
+      
+      # Ends using bold.
+      # @return [Boolean]
+      def end_bold; end
+      
+      # Begins using italic.
+      # @return [Boolean]
+      def begin_italic; end
+      
+      # Ends using italic.
+      # @return [Boolean]
+      def end_italic; end
+      
+      # Begins using underline.
+      # @return [Boolean]
+      def begin_underline; end
+      
+      # Ends using underline.
+      # @return [Boolean]
+      def end_underline; end
+      
+      # Begins using point size.
+      # @param pointSize [Integer] 
+      # @return [Boolean]
+      def begin_font_size(pointSize) end
+      
+      # Ends using point size.
+      # @return [Boolean]
+      def end_font_size; end
+      
+      # Begins using this font.
+      # @param font [Wx::Font,Wx::FontInfo] 
+      # @return [Boolean]
+      def begin_font(font) end
+      
+      # Ends using a font.
+      # @return [Boolean]
+      def end_font; end
+      
+      # Begins using this colour.
+      # @param colour [Wx::Colour,String,Symbol] 
+      # @return [Boolean]
+      def begin_text_colour(colour) end
+      
+      # Ends using a colour.
+      # @return [Boolean]
+      def end_text_colour; end
+      
+      # Begins using alignment.
+      # @param alignment [Wx::TextAttrAlignment] 
+      # @return [Boolean]
+      def begin_alignment(alignment) end
+      
+      # Ends alignment.
+      # @return [Boolean]
+      def end_alignment; end
+      
+      # Begins using leftIndent for the left indent, and optionally leftSubIndent for the sub-indent.
+      # 
+      # Both are expressed in tenths of a millimetre.
+      # The sub-indent is an offset from the left 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 relative to the subsequent lines.
+      # @param leftIndent [Integer] 
+      # @param leftSubIndent [Integer] 
+      # @return [Boolean]
+      def begin_left_indent(leftIndent, leftSubIndent=0) end
+      
+      # Ends left indent.
+      # @return [Boolean]
+      def end_left_indent; end
+      
+      # Begins a right indent, specified in tenths of a millimetre.
+      # @param rightIndent [Integer] 
+      # @return [Boolean]
+      def begin_right_indent(rightIndent) end
+      
+      # Ends right indent.
+      # @return [Boolean]
+      def end_right_indent; end
+      
+      # Begins paragraph spacing; pass the before-paragraph and after-paragraph spacing in tenths of a millimetre.
+      # @param before [Integer] 
+      # @param after [Integer] 
+      # @return [Boolean]
+      def begin_paragraph_spacing(before, after) end
+      
+      # Ends paragraph spacing.
+      # @return [Boolean]
+      def end_paragraph_spacing; end
+      
+      # Begins line spacing using the specified value.
+      # 
+      # spacing is a multiple, where 10 means single-spacing, 15 means 1.5 spacing, and 20 means double spacing.
+      # The {Wx::TextAttrLineSpacing} enumeration values are defined for convenience.
+      # @param lineSpacing [Integer] 
+      # @return [Boolean]
+      def begin_line_spacing(lineSpacing) end
+      
+      # Ends line spacing.
+      # @return [Boolean]
+      def end_line_spacing; end
+      
+      # Begins 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 following 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.
+      # @param bulletNumber [Integer] 
+      # @param leftIndent [Integer] 
+      # @param leftSubIndent [Integer] 
+      # @param bulletStyle [Integer] 
+      # @return [Boolean]
+      def begin_numbered_bullet(bulletNumber, leftIndent, leftSubIndent, bulletStyle=(Wx::TextAttrBulletStyle::TEXT_ATTR_BULLET_STYLE_ARABIC|Wx::TextAttrBulletStyle::TEXT_ATTR_BULLET_STYLE_PERIOD)) end
+      
+      # Ends numbered bullet.
+      # @return [Boolean]
+      def end_numbered_bullet; end
+      
+      # Begins applying a symbol bullet, using a character from the current font.
+      # 
+      # See {Wx::RTC::RichTextBuffer#begin_numbered_bullet} for an explanation of how indentation is used to render the bulleted paragraph.
+      # @param symbol [String] 
+      # @param leftIndent [Integer] 
+      # @param leftSubIndent [Integer] 
+      # @param bulletStyle [Integer] 
+      # @return [Boolean]
+      def begin_symbol_bullet(symbol, leftIndent, leftSubIndent, bulletStyle=Wx::TextAttrBulletStyle::TEXT_ATTR_BULLET_STYLE_SYMBOL) end
+      
+      # Ends symbol bullet.
+      # @return [Boolean]
+      def end_symbol_bullet; end
+      
+      # Begins applying a standard bullet, using one of the standard bullet names (currently <code>standard/circle</code> or <code>standard/square</code>.
+      # 
+      # See {Wx::RTC::RichTextBuffer#begin_numbered_bullet} for an explanation of how indentation is used to render the bulleted paragraph.
+      # @param bulletName [String] 
+      # @param leftIndent [Integer] 
+      # @param leftSubIndent [Integer] 
+      # @param bulletStyle [Integer] 
+      # @return [Boolean]
+      def begin_standard_bullet(bulletName, leftIndent, leftSubIndent, bulletStyle=Wx::TextAttrBulletStyle::TEXT_ATTR_BULLET_STYLE_STANDARD) end
+      
+      # Ends standard bullet.
+      # @return [Boolean]
+      def end_standard_bullet; end
+      
+      # Begins named character style.
+      # @param characterStyle [String] 
+      # @return [Boolean]
+      def begin_character_style(characterStyle) end
+      
+      # Ends named character style.
+      # @return [Boolean]
+      def end_character_style; end
+      
+      # Begins named paragraph style.
+      # @param paragraphStyle [String] 
+      # @return [Boolean]
+      def begin_paragraph_style(paragraphStyle) end
+      
+      # Ends named character style.
+      # @return [Boolean]
+      def end_paragraph_style; end
+      
+      # Begins named list style.
+      # 
+      # Optionally, you can also pass a level and a number.
+      # @param listStyle [String] 
+      # @param level [Integer] 
+      # @param number [Integer] 
+      # @return [Boolean]
+      def begin_list_style(listStyle, level=1, number=1) end
+      
+      # Ends named character style.
+      # @return [Boolean]
+      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] 
+      # @return [Boolean]
+      def begin_url(url, characterStyle=('')) end
+      
+      # Ends URL.
+      # @return [Boolean]
+      def end_url; end
+      
+      # Adds an event handler.
+      # 
+      # A buffer associated with a control has the control as the only event handler, but the application is free to add more if further notification is required. All handlers are notified of an event originating from the buffer, such as the replacement of a style sheet during loading.
+      # The buffer never deletes any of the event handlers, unless {Wx::RTC::RichTextBuffer#remove_event_handler} is called with true as the second argument.
+      # @param handler [Wx::EvtHandler] 
+      # @return [Boolean]
+      def add_event_handler(handler) end
+      
+      # Removes an event handler from the buffer's list of handlers, deleting the object if deleteHandler is true.
+      # @param handler [Wx::EvtHandler] 
+      # @param deleteHandler [Boolean] 
+      # @return [Boolean]
+      def remove_event_handler(handler, deleteHandler=false) end
+      
+      # Clear event handlers.
+      # @return [void]
+      def clear_event_handlers; end
+      
+      # Send event to event handlers.
+      # 
+      # If sendToAll is true, will send to all event handlers, otherwise will stop at the first successful one.
+      # @param event [Wx::Event] 
+      # @param sendToAll [Boolean] 
+      # @return [Boolean]
+      def send_event(event, sendToAll=true) 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
+      
+      # Copies the buffer.
+      # @param obj [Wx::RTC::RichTextBuffer] 
+      # @return [void]
+      def copy(obj) end
+      
+      # Clones the buffer.
+      # @return [Wx::RTC::RichTextObject]
+      def clone; end
+      
+      # Submits a command to insert paragraphs.
+      # @param pos [Integer] 
+      # @param paragraphs [Wx::RTC::RichTextParagraphLayoutBox] 
+      # @param ctrl [Wx::RTC::RichTextCtrl] 
+      # @param flags [Integer] 
+      # @return [Boolean]
+      def insert_paragraphs_with_undo(pos, paragraphs, ctrl, flags=0) end
+      
+      # Submits a command to insert the given text.
+      # @param pos [Integer] 
+      # @param text [String] 
+      # @param ctrl [Wx::RTC::RichTextCtrl] 
+      # @param flags [Integer] 
+      # @return [Boolean]
+      def insert_text_with_undo(pos, text, ctrl, flags=0) end
+      
+      # Submits a command to insert a newline.
+      # @param pos [Integer] 
+      # @param ctrl [Wx::RTC::RichTextCtrl] 
+      # @param flags [Integer] 
+      # @return [Boolean]
+      def insert_newline_with_undo(pos, ctrl, flags=0) end
+      
+      # Submits a command to insert the given image.
+      # @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(pos, imageBlock, ctrl, flags=0, textAttr=(Wx::RichTextAttr.new())) end
+      
+      # Submits a command to insert an object.
+      # @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(pos, object, ctrl, flags) end
+      
+      # Submits a command to delete this range.
+      # @param range [Range] 
+      # @param ctrl [Wx::RTC::RichTextCtrl] 
+      # @return [Boolean]
+      def delete_range_with_undo(range, ctrl) end
+      
+      # Mark modified.
+      # @param modify [Boolean] 
+      # @return [void]
+      def modify(modify=true) end
+      
+      # Returns true if the buffer was modified.
+      # @return [Boolean]
+      def is_modified; end
+      alias_method :modified?, :is_modified
+      
+      # @overload dump()
+      #   Dumps contents of buffer for debugging purposes.
+      #   @return [void]
+      # @overload dump(stream)
+      #   Dump object data to the given output stream for debugging.
+      #   @param stream [Wx::TextOutputStream] 
+      #   @return [void]
+      def dump(*args) end
+      
+      # Returns the scale factor for calculating dimensions.
+      # @return [Float]
+      def get_scale; end
+      alias_method :scale, :get_scale
+      
+      # Sets the scale factor for calculating dimensions.
+      # @param scale [Float] 
+      # @return [void]
+      def set_scale(scale) end
+      alias_method :scale=, :set_scale
+      
+      # Adds a file handler to the end.
+      # @param handler [Wx::RTC::RichTextFileHandler] 
+      # @return [void]
+      def self.add_handler(handler) end
+      
+      # Inserts a file handler at the front.
+      # @param handler [Wx::RTC::RichTextFileHandler] 
+      # @return [void]
+      def self.insert_handler(handler) end
+      
+      # Removes a file handler.
+      # @param name [String] 
+      # @return [Boolean]
+      def self.remove_handler(name) end
+      
+      # @overload self.find_handler(name)
+      #   Finds a file handler by name.
+      #   @param name [String] 
+      #   @return [Wx::RTC::RichTextFileHandler]
+      # @overload self.find_handler(extension, imageType)
+      #   Finds a file handler by extension and type.
+      #   @param extension [String] 
+      #   @param imageType [Wx::RichTextFileType] 
+      #   @return [Wx::RTC::RichTextFileHandler]
+      # @overload self.find_handler(imageType)
+      #   Finds a handler by type.
+      #   @param imageType [Wx::RichTextFileType] 
+      #   @return [Wx::RTC::RichTextFileHandler]
+      def self.find_handler(*args) end
+      
+      # Finds a handler by filename or, if supplied, type.
+      # @param filename [String] 
+      # @param imageType [Wx::RichTextFileType] 
+      # @return [Wx::RTC::RichTextFileHandler]
+      def self.find_handler_filename_or_type(filename, imageType) end
+      
+      # Gets a wildcard incorporating all visible handlers.
+      # 
+      # If types is present, it will be filled with the file type corresponding to each filter. This can be used to determine the type to pass to LoadFile given a selected filter.
+      # @param combine [Boolean] 
+      # @param save [Boolean] 
+      # @param types [Array,nil] 
+      # @return [String]
+      def self.get_ext_wildcard(combine=false, save=false, types=nil) end
+      
+      # Clean up file handlers.
+      # @return [void]
+      def self.clean_up_handlers; end
+      
+      # Initialise the standard file handlers.
+      # 
+      # Currently, only the plain text loading/saving handler is initialised by default.
+      # @return [void]
+      def self.init_standard_handlers; end
+      
+      # Adds a drawing handler to the end.
+      # @param handler [Wx::RTC::RichTextDrawingHandler] 
+      # @return [void]
+      def self.add_drawing_handler(handler) end
+      
+      # Inserts a drawing handler at the front.
+      # @param handler [Wx::RTC::RichTextDrawingHandler] 
+      # @return [void]
+      def self.insert_drawing_handler(handler) end
+      
+      # Removes a drawing handler.
+      # @param name [String] 
+      # @return [Boolean]
+      def self.remove_drawing_handler(name) end
+      
+      # Finds a drawing handler by name.
+      # @param name [String] 
+      # @return [Wx::RTC::RichTextDrawingHandler]
+      def self.find_drawing_handler(name) end
+      
+      # Clean up drawing handlers.
+      # @return [void]
+      def self.clean_up_drawing_handlers; end
+      
+      # Adds a field type.
+      # 
+      # 
+      # @see Wx::RTC::RichTextBuffer.remove_field_type
+      # @see  Wx::RTC::RichTextBuffer.find_field_type
+      # @see  Wx::RTC::RichTextField
+      # @see  Wx::RTC::RichTextFieldType
+      # @see  Wx::RTC::RichTextFieldTypeStandard 
+      # @param fieldType [Wx::RTC::RichTextFieldType] 
+      # @return [void]
+      def self.add_field_type(fieldType) end
+      
+      # Removes a field type by name.
+      # 
+      # 
+      # @see Wx::RTC::RichTextBuffer.add_field_type
+      # @see  Wx::RTC::RichTextBuffer.find_field_type
+      # @see  Wx::RTC::RichTextField
+      # @see  Wx::RTC::RichTextFieldType
+      # @see  Wx::RTC::RichTextFieldTypeStandard 
+      # @param name [String] 
+      # @return [Boolean]
+      def self.remove_field_type(name) end
+      
+      # Finds a field type by name.
+      # 
+      # 
+      # @see Wx::RTC::RichTextBuffer.remove_field_type
+      # @see  Wx::RTC::RichTextBuffer.add_field_type
+      # @see  Wx::RTC::RichTextField
+      # @see  Wx::RTC::RichTextFieldType
+      # @see  Wx::RTC::RichTextFieldTypeStandard 
+      # @param name [String] 
+      # @return [Wx::RTC::RichTextFieldType]
+      def self.find_field_type(name) end
+      
+      # Cleans up field types.
+      # @return [void]
+      def self.clean_up_field_types; end
+      
+      # Returns the minimum margin between bullet and paragraph in 10ths of a mm.
+      # @return [Integer]
+      def self.get_bullet_right_margin; end
+      
+      # Sets the minimum margin between bullet and paragraph in 10ths of a mm.
+      # @param margin [Integer] 
+      # @return [void]
+      def self.set_bullet_right_margin(margin) end
+      
+      # Returns the factor to multiply by character height to get a reasonable bullet size.
+      # @return [Float]
+      def self.get_bullet_proportion; end
+      
+      # Sets the factor to multiply by character height to get a reasonable bullet size.
+      # @param prop [Float] 
+      # @return [void]
+      def self.set_bullet_proportion(prop) end
+      
+      # Returns the floating layout mode.
+      # 
+      # The default is true, where objects are laid out according to their floating status.
+      # @return [Boolean]
+      def self.get_floating_layout_mode; end
+      
+      # Sets the floating layout mode.
+      # 
+      # Pass false to speed up editing by not performing floating layout. This setting affects all buffers.
+      # @param mode [Boolean] 
+      # @return [void]
+      def self.set_floating_layout_mode(mode) end
+      
+    end # RichTextBuffer
+    
+    # Manages quick access to a pool of fonts for rendering rich text.
+    # 
+    # Category:  Rich Text
+    # @see Wx::RTC::RichTextBuffer
+    # @see  Wx::RTC::RichTextCtrl 
+    # 
+    # 
+    # @wxrb_require USE_RICHTEXT
+    class RichTextFontTable < Object
+    
+      # @overload initialize()
+      #   Default constructor.
+      #   @return [Wx::RTC::RichTextFontTable]
+      # @overload initialize(table)
+      #   Copy constructor.
+      #   @param table [Wx::RTC::RichTextFontTable] 
+      #   @return [Wx::RTC::RichTextFontTable]
+      def initialize(*args) end
+      
+      # Returns true if the font table is valid.
+      # @return [Boolean]
+      def is_ok; end
+      alias_method :ok?, :is_ok
+      
+      # Finds a font for the given attribute object.
+      # @param fontSpec [Wx::RTC::RichTextAttr] 
+      # @return [Wx::Font]
+      def find_font(fontSpec) end
+      
+      # Clears the font table.
+      # @return [void]
+      def clear; end
+      
+      # Equality operator.
+      # @param table [Wx::RTC::RichTextFontTable] 
+      # @return [Boolean]
+      def ==(table) end
+      
+      # Set the font scale factor.
+      # @param fontScale [Float] 
+      # @return [void]
+      def set_font_scale(fontScale) end
+      alias_method :font_scale=, :set_font_scale
+      
+    end # RichTextFontTable
+    
+    # The base class for custom field types.
+    # 
+    # Each type definition handles one field type. Override functions to provide drawing, layout, updating and property editing functionality for a field.
+    # Register field types on application initialisation with the static function {Wx::RTC::RichTextBuffer.add_field_type}. They will be deleted automatically on application exit.
+    # 
+    # Category:  Rich Text
+    # @see Wx::RTC::RichTextFieldTypeStandard
+    # @see  Wx::RTC::RichTextField
+    # @see  Wx::RTC::RichTextCtrl 
+    # 
+    # 
+    # @wxrb_require USE_RICHTEXT
+    class RichTextFieldType < Object
+    
+      # @overload initialize(name=(''))
+      #   Creates a field type definition.
+      #   @param name [String] 
+      #   @return [Wx::RTC::RichTextFieldType]
+      # @overload initialize(fieldType)
+      #   Copy constructor.
+      #   @param fieldType [Wx::RTC::RichTextFieldType] 
+      #   @return [Wx::RTC::RichTextFieldType]
+      def initialize(*args) end
+      
+      # @param fieldType [Wx::RTC::RichTextFieldType] 
+      # @return [void]
+      def copy(fieldType) 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 obj [Wx::RTC::RichTextField] 
+      # @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(obj, 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 obj [Wx::RTC::RichTextField] 
+      # @param dc [Wx::ReadOnlyDC] 
+      # @param context [Wx::RTC::RichTextDrawingContext] 
+      # @param rect [Wx::Rect] 
+      # @param parentRect [Wx::Rect] 
+      # @param style [Integer] 
+      # @return [Boolean]
+      def layout(obj, 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 obj [Wx::RTC::RichTextField] 
+      # @param range [Range] 
+      # @param size [Array(Integer, Integer), Wx::Size] 
+      # @param descent [Integer] 
+      # @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 [Array(Boolean,Integer)]
+      def get_range_size(obj, 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 true if we can edit the object's properties via a GUI.
+      # @param obj [Wx::RTC::RichTextField] 
+      # @return [Boolean]
+      def can_edit_properties(obj) end
+      alias_method :can_edit_properties?, :can_edit_properties
+      
+      # Edits the object's properties via a GUI.
+      # @param obj [Wx::RTC::RichTextField] 
+      # @param parent [Wx::Window] 
+      # @param buffer [Wx::RTC::RichTextBuffer] 
+      # @return [Boolean]
+      def edit_properties(obj, parent, buffer) end
+      
+      # Returns the label to be used for the properties context menu item.
+      # @param obj [Wx::RTC::RichTextField] 
+      # @return [String]
+      def get_properties_menu_label(obj) end
+      alias_method :properties_menu_label, :get_properties_menu_label
+      
+      # Update the field.
+      # 
+      # This would typically expand the field to its value, if this is a dynamically changing and/or composite field.
+      # @param buffer [Wx::RTC::RichTextBuffer] 
+      # @param obj [Wx::RTC::RichTextField] 
+      # @return [Boolean]
+      def update_field(buffer, obj) end
+      
+      # Returns true if this object is top-level, i.e. contains its own paragraphs, such as a text box.
+      # @param obj [Wx::RTC::RichTextField] 
+      # @return [Boolean]
+      def is_top_level(obj) end
+      alias_method :top_level?, :is_top_level
+      
+      # Sets the field type name.
+      # 
+      # There should be a unique name per field type object.
+      # @param name [String] 
+      # @return [void]
+      def set_name(name) end
+      alias_method :name=, :set_name
+      
+      # Returns the field type name.
+      # 
+      # There should be a unique name per field type object.
+      # @return [String]
+      def get_name; end
+      alias_method :name, :get_name
+      
+    end # RichTextFieldType
+    
+    # A field type that can handle fields with text or bitmap labels, with a small range of styles for implementing rectangular fields and fields that can be used for start and end tags.
+    # 
+    # The border, text and background colours can be customised; the default is white text on a black background.
+    # The following display styles can be used.
+    # ### Styles
+    # 
+    # This class supports the following styles:
+    # 
+    # - {Wx::RTC::RichTextFieldTypeStandard::RICHTEXT_FIELD_STYLE_COMPOSITE}: Creates a composite field; you will probably need to derive a new class to implement UpdateField. 
+    # 
+    # - {Wx::RTC::RichTextFieldTypeStandard::RICHTEXT_FIELD_STYLE_RECTANGLE}: Shows a rounded rectangle background. 
+    # 
+    # - {Wx::RTC::RichTextFieldTypeStandard::RICHTEXT_FIELD_STYLE_NO_BORDER}: Suppresses the background and border; mostly used with a bitmap label. 
+    # 
+    # - {Wx::RTC::RichTextFieldTypeStandard::RICHTEXT_FIELD_STYLE_START_TAG}: Shows a start tag background, with the pointy end facing right. 
+    # 
+    # - {Wx::RTC::RichTextFieldTypeStandard::RICHTEXT_FIELD_STYLE_END_TAG}: Shows an end tag background, with the pointy end facing left. 
+    # 
+    # Category:  Rich Text
+    # @see Wx::RTC::RichTextFieldType
+    # @see  Wx::RTC::RichTextField
+    # @see  Wx::RTC::RichTextBuffer
+    # @see  Wx::RTC::RichTextCtrl 
+    # 
+    # 
+    # @wxrb_require USE_RICHTEXT
+    class RichTextFieldTypeStandard < RichTextFieldType
+    
+      # 
+      # 
+      RICHTEXT_FIELD_STYLE_COMPOSITE = 1
+      
+      # 
+      # 
+      RICHTEXT_FIELD_STYLE_RECTANGLE = 2
+      
+      # 
+      # 
+      RICHTEXT_FIELD_STYLE_NO_BORDER = 4
+      
+      # 
+      # 
+      RICHTEXT_FIELD_STYLE_START_TAG = 8
+      
+      # 
+      # 
+      RICHTEXT_FIELD_STYLE_END_TAG = 16
+      
+      # @overload initialize(name, label, displayStyle=Wx::RTC::RichTextFieldTypeStandard::RICHTEXT_FIELD_STYLE_RECTANGLE)
+      #   Constructor, creating a field type definition with a text label.
+      #   @param name [String]  The name of the type definition. This must be unique, and is the type name used when adding a field to a control.
+      #   @param label [String]  The text label to be shown on the field.
+      #   @param displayStyle [Integer]  The display style: one of {Wx::RTC::RichTextFieldTypeStandard::RICHTEXT_FIELD_STYLE_RECTANGLE}, {Wx::RTC::RichTextFieldTypeStandard::RICHTEXT_FIELD_STYLE_NO_BORDER}, {Wx::RTC::RichTextFieldTypeStandard::RICHTEXT_FIELD_STYLE_START_TAG}, {Wx::RTC::RichTextFieldTypeStandard::RICHTEXT_FIELD_STYLE_END_TAG}.
+      #   @return [Wx::RTC::RichTextFieldTypeStandard]
+      # @overload initialize(name, bitmap, displayStyle=Wx::RTC::RichTextFieldTypeStandard::RICHTEXT_FIELD_STYLE_NO_BORDER)
+      #   Constructor, creating a field type definition with a bitmap label.
+      #   @param name [String]  The name of the type definition. This must be unique, and is the type name used when adding a field to a control.
+      #   @param bitmap [Wx::Bitmap]  The bitmap label to be shown on the field.
+      #   @param displayStyle [Integer]  The display style: one of {Wx::RTC::RichTextFieldTypeStandard::RICHTEXT_FIELD_STYLE_RECTANGLE}, {Wx::RTC::RichTextFieldTypeStandard::RICHTEXT_FIELD_STYLE_NO_BORDER}, {Wx::RTC::RichTextFieldTypeStandard::RICHTEXT_FIELD_STYLE_START_TAG}, {Wx::RTC::RichTextFieldTypeStandard::RICHTEXT_FIELD_STYLE_END_TAG}.
+      #   @return [Wx::RTC::RichTextFieldTypeStandard]
+      # @overload initialize()
+      #   The default constructor.
+      #   @return [Wx::RTC::RichTextFieldTypeStandard]
+      # @overload initialize(field)
+      #   The copy constructor.
+      #   @param field [Wx::RTC::RichTextFieldTypeStandard] 
+      #   @return [Wx::RTC::RichTextFieldTypeStandard]
+      def initialize(*args) end
+      
+      # Initialises the object.
+      # @return [void]
+      def init; end
+      
+      # Copies the object.
+      # @param field [Wx::RTC::RichTextFieldTypeStandard] 
+      # @return [void]
+      def copy(field) 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 obj [Wx::RTC::RichTextField] 
+      # @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(obj, 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 obj [Wx::RTC::RichTextField] 
+      # @param dc [Wx::ReadOnlyDC] 
+      # @param context [Wx::RTC::RichTextDrawingContext] 
+      # @param rect [Wx::Rect] 
+      # @param parentRect [Wx::Rect] 
+      # @param style [Integer] 
+      # @return [Boolean]
+      def layout(obj, 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 obj [Wx::RTC::RichTextField] 
+      # @param range [Range] 
+      # @param size [Array(Integer, Integer), Wx::Size] 
+      # @param descent [Integer] 
+      # @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 [Array(Boolean,Integer)]
+      def get_range_size(obj, 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
+      
+      # Get the size of the field, given the label, font size, and so on.
+      # @param obj [Wx::RTC::RichTextField] 
+      # @param dc [Wx::ReadOnlyDC] 
+      # @param context [Wx::RTC::RichTextDrawingContext] 
+      # @param style [Integer] 
+      # @return [Wx::Size]
+      def get_size(obj, dc, context, style) end
+      alias_method :size, :get_size
+      
+      # Returns true if the display type is {Wx::RTC::RichTextFieldTypeStandard::RICHTEXT_FIELD_STYLE_COMPOSITE}, false otherwise.
+      # @param obj [Wx::RTC::RichTextField] 
+      # @return [Boolean]
+      def is_top_level(obj) end
+      alias_method :top_level?, :is_top_level
+      
+      # Sets the text label for fields of this type.
+      # @param label [String] 
+      # @return [void]
+      def set_label(label) end
+      alias_method :label=, :set_label
+      
+      # Returns the text label for fields of this type.
+      # @return [Wx::String]
+      def get_label; end
+      alias_method :label, :get_label
+      
+      # Sets the bitmap label for fields of this type.
+      # @param bitmap [Wx::Bitmap] 
+      # @return [void]
+      def set_bitmap(bitmap) end
+      alias_method :bitmap=, :set_bitmap
+      
+      # Gets the bitmap label for fields of this type.
+      # @return [Wx::Bitmap]
+      def get_bitmap; end
+      alias_method :bitmap, :get_bitmap
+      
+      # Gets the display style for fields of this type.
+      # @return [Integer]
+      def get_display_style; end
+      alias_method :display_style, :get_display_style
+      
+      # Sets the display style for fields of this type.
+      # @param displayStyle [Integer] 
+      # @return [void]
+      def set_display_style(displayStyle) end
+      alias_method :display_style=, :set_display_style
+      
+      # Gets the font used for drawing the text label.
+      # @return [Wx::Font,Wx::FontInfo]
+      def get_font; end
+      alias_method :font, :get_font
+      
+      # Sets the font used for drawing the text label.
+      # @param font [Wx::Font,Wx::FontInfo] 
+      # @return [void]
+      def set_font(font) end
+      alias_method :font=, :set_font
+      
+      # Gets the colour used for drawing the text label.
+      # @return [Wx::Colour,String,Symbol]
+      def get_text_colour; end
+      alias_method :text_colour, :get_text_colour
+      
+      # Sets the colour used for drawing the text label.
+      # @param colour [Wx::Colour,String,Symbol] 
+      # @return [void]
+      def set_text_colour(colour) end
+      alias_method :text_colour=, :set_text_colour
+      
+      # Gets the colour used for drawing the field border.
+      # @return [Wx::Colour,String,Symbol]
+      def get_border_colour; end
+      alias_method :border_colour, :get_border_colour
+      
+      # Sets the colour used for drawing the field border.
+      # @param colour [Wx::Colour,String,Symbol] 
+      # @return [void]
+      def set_border_colour(colour) end
+      alias_method :border_colour=, :set_border_colour
+      
+      # Gets the colour used for drawing the field background.
+      # @return [Wx::Colour,String,Symbol]
+      def get_background_colour; end
+      alias_method :background_colour, :get_background_colour
+      
+      # Sets the colour used for drawing the field background.
+      # @param colour [Wx::Colour,String,Symbol] 
+      # @return [void]
+      def set_background_colour(colour) end
+      alias_method :background_colour=, :set_background_colour
+      
+      # Sets the vertical padding (the distance between the border and the text).
+      # @param padding [Integer] 
+      # @return [void]
+      def set_vertical_padding(padding) end
+      alias_method :vertical_padding=, :set_vertical_padding
+      
+      # Gets the vertical padding (the distance between the border and the text).
+      # @return [Integer]
+      def get_vertical_padding; end
+      alias_method :vertical_padding, :get_vertical_padding
+      
+      # Sets the horizontal padding (the distance between the border and the text).
+      # @param padding [Integer] 
+      # @return [void]
+      def set_horizontal_padding(padding) end
+      alias_method :horizontal_padding=, :set_horizontal_padding
+      
+      # Sets the horizontal padding (the distance between the border and the text).
+      # @return [Integer]
+      def get_horizontal_padding; end
+      alias_method :horizontal_padding, :get_horizontal_padding
+      
+      # Sets the horizontal margin surrounding the field object.
+      # @param margin [Integer] 
+      # @return [void]
+      def set_horizontal_margin(margin) end
+      alias_method :horizontal_margin=, :set_horizontal_margin
+      
+      # Gets the horizontal margin surrounding the field object.
+      # @return [Integer]
+      def get_horizontal_margin; end
+      alias_method :horizontal_margin, :get_horizontal_margin
+      
+      # Sets the vertical margin surrounding the field object.
+      # @param margin [Integer] 
+      # @return [void]
+      def set_vertical_margin(margin) end
+      alias_method :vertical_margin=, :set_vertical_margin
+      
+      # Gets the vertical margin surrounding the field object.
+      # @return [Integer]
+      def get_vertical_margin; end
+      alias_method :vertical_margin, :get_vertical_margin
+      
+    end # RichTextFieldTypeStandard
+    
+    # The base class for custom drawing handlers.
+    # 
+    # Currently, drawing handlers can provide virtual attributes.
+    # 
+    # Category:  Rich Text
+    # @see Wx::RTC::RichTextBuffer
+    # @see  Wx::RTC::RichTextCtrl 
+    # 
+    # 
+    # @wxrb_require USE_RICHTEXT
+    class RichTextDrawingHandler < Object
+    
+      # Creates a drawing handler object.
+      # @param name [String] 
+      # @return [Wx::RTC::RichTextDrawingHandler]
+      def initialize(name=('')) end
+      
+      # Returns true if this object has virtual attributes that we can provide.
+      # @param obj [Wx::RTC::RichTextObject] 
+      # @return [Boolean]
+      def has_virtual_attributes(obj) end
+      alias_method :has_virtual_attributes?, :has_virtual_attributes
+      
+      # Provides virtual attributes that we can provide.
+      # @param attr [Wx::RTC::RichTextAttr] 
+      # @param obj [Wx::RTC::RichTextObject] 
+      # @return [Boolean]
+      def get_virtual_attributes(attr, obj) end
+      alias_method :virtual_attributes, :get_virtual_attributes
+      
+      # Gets the count for mixed virtual attributes for individual positions within the object.
+      # 
+      # For example, individual characters within a text object may require special highlighting.
+      # @param obj [Wx::RTC::RichTextObject] 
+      # @return [Integer]
+      def get_virtual_subobject_attributes_count(obj) end
+      alias_method :virtual_subobject_attributes_count, :get_virtual_subobject_attributes_count
+      
+      # Gets the mixed virtual attributes for individual positions within the object.
+      # 
+      # For example, individual characters within a text object may require special highlighting. Returns the number of virtual attributes found.
+      # @param obj [Wx::RTC::RichTextObject] 
+      # @param positions [Array] 
+      # @param attributes [Array] 
+      # @return [Integer]
+      def get_virtual_subobject_attributes(obj, positions, attributes) end
+      alias_method :virtual_subobject_attributes, :get_virtual_subobject_attributes
+      
+      # Do we have virtual text for this object?
+      # 
+      # Virtual text allows an application to replace characters in an object for editing and display purposes, for example for highlighting special characters.
+      # @param obj [Wx::RTC::RichTextPlainText] 
+      # @return [Boolean]
+      def has_virtual_text(obj) end
+      alias_method :has_virtual_text?, :has_virtual_text
+      
+      # Gets the virtual text for this object.
+      # @param obj [Wx::RTC::RichTextPlainText] 
+      # @param text [String] 
+      # @return [Boolean]
+      def get_virtual_text(obj, text) end
+      alias_method :virtual_text, :get_virtual_text
+      
+      # Sets the name of the handler.
+      # @param name [String] 
+      # @return [void]
+      def set_name(name) end
+      alias_method :name=, :set_name
+      
+      # Returns the name of the handler.
+      # @return [String]
+      def get_name; end
+      alias_method :name, :get_name
+      
+    end # RichTextDrawingHandler
+    
+
+  end
+
+end