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

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

@@ -7,7 +7,6 @@
 module Wx::RTC
 
   # This class knows how to lay out paragraphs.
-  # === 
   # 
   # Category:  Rich Text
   # @see Wx::RTC::RichTextCompositeObject
@@ -18,6 +17,7 @@ module Wx::RTC
   # 
   # 
   # @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)
@@ -29,6 +29,7 @@ module Wx::RTC
     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.
@@ -36,13 +37,12 @@ module Wx::RTC
     # @param context [Wx::RTC::RichTextDrawingContext] 
     # @param pt [Array(Integer, Integer), Wx::Point] 
     # @param textPosition [Integer] 
-    # @param obj [Wx::RTC::RichTextObject] 
-    # @param contextObj [Wx::RTC::RichTextObject] 
     # @param flags [Integer] 
-    # @return [Array(Integer,Integer)]
-    def hit_test(dc, context, pt, textPosition, obj, contextObj, flags=0) end
+    # @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] 
@@ -55,6 +55,7 @@ module Wx::RTC
     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::DC] 
     # @param context [Wx::RTC::RichTextDrawingContext] 
@@ -65,6 +66,7 @@ module Wx::RTC
     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] 
@@ -99,12 +101,14 @@ module Wx::RTC
     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
@@ -178,6 +182,7 @@ module Wx::RTC
     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
@@ -193,6 +198,7 @@ module Wx::RTC
     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] 
@@ -267,6 +273,7 @@ module Wx::RTC
     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] 
@@ -295,6 +302,7 @@ module Wx::RTC
     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] 
@@ -362,6 +370,7 @@ module Wx::RTC
     
     # @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:
@@ -386,6 +395,7 @@ module Wx::RTC
     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] 
@@ -401,6 +411,7 @@ module Wx::RTC
     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] 
@@ -409,6 +420,7 @@ module Wx::RTC
     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.
@@ -428,6 +440,7 @@ module Wx::RTC
     
     # @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:
     #   
@@ -453,6 +466,7 @@ module Wx::RTC
     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.
@@ -466,6 +480,7 @@ module Wx::RTC
     
     # @overload number_list(range, def_=nil, flags=Wx::RTC::RICHTEXT_SETSTYLE_WITH_UNDO, startFrom=1, specifiedLevel=-1)
     #   Numbers the paragraphs in the given range.
+    #   
     #   Pass flags to determine how the attributes are set. Either the style definition or the name of the style definition (in the current sheet) can be passed.
     #   flags is a bit list of the following:
     #   
@@ -494,6 +509,7 @@ module Wx::RTC
     
     # @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:
     #   
@@ -536,6 +552,7 @@ module Wx::RTC
     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:
@@ -560,6 +577,7 @@ module Wx::RTC
     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] 
@@ -568,6 +586,7 @@ module Wx::RTC
     alias_method :has_character_attributes?, :has_character_attributes
     
     # Test if this whole range has paragraph attributes of the specified kind.
+    # 
     # If any of the attributes are different within the range, the test fails. You can use this to implement, for example, centering button updating. style must have flags indicating which attributes are of interest.
     # @param range [Range] 
     # @param style [Wx::RTC::RichTextAttr] 
@@ -580,12 +599,14 @@ module Wx::RTC
     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] 
@@ -617,6 +638,7 @@ module Wx::RTC
     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] 
@@ -630,6 +652,7 @@ module Wx::RTC
     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]
@@ -637,12 +660,14 @@ module Wx::RTC
     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]
@@ -659,6 +684,7 @@ module Wx::RTC
     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] 
@@ -695,13 +721,13 @@ module Wx::RTC
   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
@@ -713,6 +739,7 @@ module Wx::RTC
   # 
   # 
   # @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)
@@ -727,6 +754,7 @@ module Wx::RTC
     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] 
@@ -739,6 +767,7 @@ module Wx::RTC
     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::DC] 
     # @param context [Wx::RTC::RichTextDrawingContext] 
@@ -749,6 +778,7 @@ module Wx::RTC
     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] 
@@ -764,6 +794,7 @@ module Wx::RTC
     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
@@ -786,11 +817,13 @@ module Wx::RTC
     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] 
@@ -822,6 +855,7 @@ module Wx::RTC
     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]
@@ -838,11 +872,12 @@ module Wx::RTC
   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
   
     # Constructor.
@@ -989,10 +1024,10 @@ module Wx::RTC
   end # RichTextStyleSheet
   
   # This is a base class for paragraph and character styles.
-  # === 
   # 
   # Category:  Rich Text
   # 
+  # @wxrb_require USE_RICHTEXT
   class RichTextStyleDefinition < Object
   
     # Constructor.
@@ -1016,6 +1051,7 @@ module Wx::RTC
     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]
@@ -1060,10 +1096,10 @@ module Wx::RTC
   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.
@@ -1074,10 +1110,10 @@ module Wx::RTC
   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.
@@ -1099,13 +1135,14 @@ module Wx::RTC
   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.
@@ -1114,6 +1151,7 @@ module Wx::RTC
     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] 
@@ -1127,6 +1165,7 @@ module Wx::RTC
     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] 
@@ -1135,6 +1174,7 @@ module Wx::RTC
     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] 
@@ -1143,6 +1183,7 @@ module Wx::RTC
     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]
@@ -1150,6 +1191,7 @@ module Wx::RTC
     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
@@ -1162,6 +1204,7 @@ module Wx::RTC
     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] 

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

@@ -7,14 +7,16 @@
 module Wx::RTC
 
   # This class provides a simple interface for performing {Wx::RTC::RichTextBuffer} printing and previewing.
+  # 
   # It uses {Wx::RTC::RichTextPrintout} for layout and rendering.
-  # === 
   # 
   # Category:  Rich Text
   # 
+  # @wxrb_require USE_PRINTING_ARCHITECTURE,USE_RICHTEXT
   class RichTextPrinting < Object
   
     # Constructor.
+    # 
     # Optionally pass a title to be used in the preview frame and printing wait dialog, and also a parent window for these windows.
     # @param name [String] 
     # @param parentWindow [Wx::Window] 
@@ -22,6 +24,7 @@ module Wx::RTC
     def initialize(name=("PRINTING"), parentWindow=nil) end
     
     # A convenience function to get the footer text.
+    # 
     # See {Wx::RTC::RichTextHeaderFooterData} for details.
     # @param page [Wx::RichTextOddEvenPage] 
     # @param location [Wx::RichTextPageLocation] 
@@ -35,6 +38,7 @@ module Wx::RTC
     alias_method :header_footer_data, :get_header_footer_data
     
     # A convenience function to get the header text.
+    # 
     # See {Wx::RTC::RichTextHeaderFooterData} for details.
     # @param page [Wx::RichTextOddEvenPage] 
     # @param location [Wx::RichTextPageLocation] 
@@ -62,18 +66,21 @@ module Wx::RTC
     def page_setup; end
     
     # Shows a preview window for the given buffer.
+    # 
     # The function takes its own copy of buffer.
     # @param buffer [Wx::RTC::RichTextBuffer] 
     # @return [Boolean]
     def preview_buffer(buffer) end
     
     # Shows a preview window for the given file.
+    # 
     # richTextFile can be a text file or XML file, or other file depending on the available file handlers.
     # @param richTextFile [String] 
     # @return [Boolean]
     def preview_file(richTextFile) end
     
     # Prints the given buffer.
+    # 
     # The function takes its own copy of buffer. showPrintDialog can be true to show the print dialog, or false to print quietly.
     # @param buffer [Wx::RTC::RichTextBuffer] 
     # @param showPrintDialog [Boolean] 
@@ -81,6 +88,7 @@ module Wx::RTC
     def print_buffer(buffer, showPrintDialog=true) end
     
     # Prints the given file.
+    # 
     # richTextFile can be a text file or XML file, or other file depending on the available file handlers. showPrintDialog can be true to show the print dialog, or false to print quietly.
     # @param richTextFile [String] 
     # @param showPrintDialog [Boolean] 
@@ -88,6 +96,7 @@ module Wx::RTC
     def print_file(richTextFile, showPrintDialog=true) end
     
     # A convenience function to set the footer text.
+    # 
     # See {Wx::RTC::RichTextHeaderFooterData} for details.
     # @param text [String] 
     # @param page [Wx::RichTextOddEvenPage] 
@@ -115,6 +124,7 @@ module Wx::RTC
     alias_method :header_footer_text_colour=, :set_header_footer_text_colour
     
     # A convenience function to set the header text.
+    # 
     # See {Wx::RTC::RichTextHeaderFooterData} for details.
     # @param text [String] 
     # @param page [Wx::RichTextOddEvenPage] 
@@ -162,11 +172,12 @@ module Wx::RTC
   end # RichTextPrinting
   
   # This class implements print layout for {Wx::RTC::RichTextBuffer}.
+  # 
   # Instead of using it directly, you should normally use the {Wx::RTC::RichTextPrinting} class.
-  # === 
   # 
   # Category:  Rich Text
   # 
+  # @wxrb_require USE_PRINTING_ARCHITECTURE,USE_RICHTEXT
   class RichTextPrintout < Printout
   
     # Constructor.
@@ -219,6 +230,7 @@ module Wx::RTC
     alias_method :header_footer_data=, :set_header_footer_data
     
     # Sets margins in 10ths of millimetre.
+    # 
     # Defaults to 1 inch for margins.
     # @param top [Integer] 
     # @param bottom [Integer] 
@@ -229,6 +241,7 @@ module Wx::RTC
     alias_method :margins=, :set_margins
     
     # Sets the buffer to print.
+    # 
     # {Wx::RTC::RichTextPrintout} does not manage this pointer; it should be managed by the calling code, such as {Wx::RTC::RichTextPrinting}.
     # @param buffer [Wx::RTC::RichTextBuffer] 
     # @return [void]

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

@@ -7,20 +7,22 @@
 module Wx::RTC
 
   # This is a listbox that can display the styles in a {Wx::RTC::RichTextStyleSheet}, and apply the selection to an associated {Wx::RTC::RichTextCtrl}.
+  # 
   # See <code>samples/richtext</code> for an example of how to use it.
-  # === 
   # 
   # Category:  Rich Text
   # @see Wx::RTC::RichTextStyleComboCtrl
   # @see  wxRichTextCtrl Overview 
   # 
   # 
+  # @wxrb_require USE_RICHTEXT
   class RichTextStyleListBox < HtmlListBox
   
     # Which type of style definition is currently showing?
     # 
     # 
     # 
+    # @wxrb_require USE_RICHTEXT
     class RichTextStyleType < Wx::Enum
     
       # 
@@ -104,7 +106,7 @@ module Wx::RTC
     alias_method :style_sheet, :get_style_sheet
     
     # Returns the type of style to show in the list box.
-    # @return [Wx::wxRichTextStyleListBox::RichTextStyleType]
+    # @return [Wx::RichTextStyleListBox::RichTextStyleType]
     def get_style_type; end
     alias_method :style_type, :get_style_type
     
@@ -132,13 +134,14 @@ module Wx::RTC
     alias_method :style_sheet=, :set_style_sheet
     
     # Sets the style type to display.
+    # 
     # One of
     # 
     # - {Wx::RTC::RichTextStyleListBox::RichTextStyleType::RICHTEXT_STYLE_ALL},
     # - {Wx::RTC::RichTextStyleListBox::RichTextStyleType::RICHTEXT_STYLE_PARAGRAPH},
     # - {Wx::RTC::RichTextStyleListBox::RichTextStyleType::RICHTEXT_STYLE_CHARACTER}
     # - {Wx::RTC::RichTextStyleListBox::RichTextStyleType::RICHTEXT_STYLE_LIST}.
-    # @param styleType [Wx::wxRichTextStyleListBox::RichTextStyleType] 
+    # @param styleType [Wx::RichTextStyleListBox::RichTextStyleType] 
     # @return [void]
     def set_style_type(styleType) end
     alias_method :style_type=, :set_style_type
@@ -150,19 +153,19 @@ module Wx::RTC
   end # RichTextStyleListBox
   
   # This class incorporates a {Wx::RTC::RichTextStyleListBox} and a choice control that allows the user to select the category of style to view.
+  # 
   # It is demonstrated in the {Wx::RTC::RichTextCtrl} sample in <code>samples/richtext</code>.
   # To use {Wx::RTC::RichTextStyleListCtrl}, add the control to your window hierarchy and call {Wx::RTC::RichTextStyleListCtrl#set_style_type} with one of {Wx::RTC::RichTextStyleListBox::RichTextStyleType::RICHTEXT_STYLE_ALL}, {Wx::RTC::RichTextStyleListBox::RichTextStyleType::RICHTEXT_STYLE_PARAGRAPH}, {Wx::RTC::RichTextStyleListBox::RichTextStyleType::RICHTEXT_STYLE_CHARACTER} and {Wx::RTC::RichTextStyleListBox::RichTextStyleType::RICHTEXT_STYLE_LIST} to set the current view.
   # Associate the control with a style sheet and rich text control with SetStyleSheet and SetRichTextCtrl, so that when a style is double-clicked, it is applied to the selection.
-  # === Styles
+  # ### Styles
   # 
   # This class supports the following styles:
   # 
   # - {Wx::RICHTEXTSTYLELIST_HIDE_TYPE_SELECTOR}: This style hides the category selection control. 
   # 
-  # === 
-  # 
   # Category:  Rich Text
   # 
+  # @wxrb_require USE_RICHTEXT
   class RichTextStyleListCtrl < Control
   
     # @overload initialize(parent, id=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0)
@@ -207,7 +210,7 @@ module Wx::RTC
     alias_method :style_sheet, :get_style_sheet
     
     # Returns the type of style to show in the list box.
-    # @return [Wx::wxRichTextStyleListBox::RichTextStyleType]
+    # @return [Wx::RichTextStyleListBox::RichTextStyleType]
     def get_style_type; end
     alias_method :style_type, :get_style_type
     
@@ -224,13 +227,14 @@ module Wx::RTC
     alias_method :style_sheet=, :set_style_sheet
     
     # Sets the style type to display.
+    # 
     # One of
     # 
     # - {Wx::RTC::RichTextStyleListBox::RichTextStyleType::RICHTEXT_STYLE_ALL},
     # - {Wx::RTC::RichTextStyleListBox::RichTextStyleType::RICHTEXT_STYLE_PARAGRAPH},
     # - {Wx::RTC::RichTextStyleListBox::RichTextStyleType::RICHTEXT_STYLE_CHARACTER}
     # - {Wx::RTC::RichTextStyleListBox::RichTextStyleType::RICHTEXT_STYLE_LIST}.
-    # @param styleType [Wx::wxRichTextStyleListBox::RichTextStyleType] 
+    # @param styleType [Wx::RichTextStyleListBox::RichTextStyleType] 
     # @return [void]
     def set_style_type(styleType) end
     alias_method :style_type=, :set_style_type
@@ -242,14 +246,15 @@ module Wx::RTC
   end # RichTextStyleListCtrl
   
   # This is a combo control that can display the styles in a {Wx::RTC::RichTextStyleSheet}, and apply the selection to an associated {Wx::RTC::RichTextCtrl}.
+  # 
   # See <code>samples/richtext</code> for an example of how to use it.
-  # === 
   # 
   # Category:  Rich Text
   # @see Wx::RTC::RichTextStyleListBox
   # @see  wxRichTextCtrl Overview 
   # 
   # 
+  # @wxrb_require USE_RICHTEXT
   class RichTextStyleComboCtrl < ComboCtrl
   
     # @overload initialize(parent, id=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0)

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

@@ -52,11 +52,12 @@ module Wx::RTC
   RICHTEXT_ORGANISER_BROWSE_NUMBERING = 1120
   
   # This class shows a style sheet and allows the user to edit, add and remove styles.
+  # 
   # It can also be used as a style browser, for example if the application is not using a permanent {Wx::RTC::RichTextStyleComboCtrl} or {Wx::RTC::RichTextStyleListCtrl} to present styles.
-  # === 
   # 
   # Category:  Rich Text
   # 
+  # @wxrb_require USE_RICHTEXT
   class RichTextStyleOrganiserDialog < Dialog
   
     # @overload initialize()
@@ -64,6 +65,7 @@ module Wx::RTC
     #   @return [Wx::RTC::RichTextStyleOrganiserDialog]
     # @overload initialize(flags, sheet, ctrl, parent, id=Wx::StandardID::ID_ANY, caption=(_.new("STYLE ORGANISER")), pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=(Wx::DEFAULT_DIALOG_STYLE|Wx::RESIZE_BORDER|Wx::SYSTEM_MENU|Wx::CLOSE_BOX))
     #   Constructor.
+    #   
     #   To create a dialog, pass a bitlist of flags (see below), a style sheet, a text control to apply a selected style to (or NULL), followed by the usual window parameters.
     #   To specify the operations available to the user, pass a combination of these values to flags: 
     #   
@@ -105,6 +107,7 @@ module Wx::RTC
     def apply_style(ctrl=nil) end
     
     # Creates the dialog.
+    # 
     # See the ctor.
     # @param flags [Integer] 
     # @param sheet [Wx::RTC::RichTextStyleSheet]