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

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

@@ -7,13 +7,13 @@
 module Wx::RTC
 
   # The base class for file handlers.
-  # === 
   # 
   # Category:  Rich Text
   # @see Wx::RTC::RichTextBuffer
   # @see  Wx::RTC::RichTextCtrl 
   # 
   # 
+  # @wxrb_require USE_RICHTEXT
   class RichTextFileHandler < Object
   
     # Creates a file handler object.
@@ -25,6 +25,7 @@ module Wx::RTC
     
     # @overload load_file(buffer, stream)
     #   Loads the buffer from a stream.
+    #   
     #   Not all handlers will implement file loading.
     #   @param buffer [Wx::RTC::RichTextBuffer] 
     #   @param stream [IO,Wx::InputStream] 
@@ -38,6 +39,7 @@ module Wx::RTC
     
     # @overload save_file(buffer, stream)
     #   Saves the buffer to a stream.
+    #   
     #   Not all handlers will implement file saving.
     #   @param buffer [Wx::RTC::RichTextBuffer] 
     #   @param stream [IO,Wx::OutputStream] 
@@ -50,6 +52,7 @@ module Wx::RTC
     def save_file(*args) end
     
     # Returns true if we handle this filename (if using files).
+    # 
     # By default, checks the extension.
     # @param filename [String] 
     # @return [Boolean]
@@ -111,6 +114,7 @@ module Wx::RTC
     alias_method :type, :get_type
     
     # Sets flags that change the behaviour of loading or saving.
+    # 
     # See the documentation for each handler class to see what flags are relevant for each handler.
     # You call this function directly if you are using a file handler explicitly (without going through the text control or buffer LoadFile/SaveFile API). Or, you can call the control or buffer's SetHandlerFlags function to set the flags that will be used for subsequent load and save operations.
     # @param flags [Integer] 
@@ -124,6 +128,7 @@ module Wx::RTC
     alias_method :flags, :get_flags
     
     # Sets the encoding to use when saving a file.
+    # 
     # If empty, a suitable encoding is chosen.
     # @param encoding [String] 
     # @return [void]
@@ -131,6 +136,7 @@ module Wx::RTC
     alias_method :encoding=, :set_encoding
     
     # Returns the encoding to use when saving a file.
+    # 
     # If empty, a suitable encoding is chosen.
     # @return [Wx::String]
     def get_encoding; end
@@ -139,7 +145,6 @@ module Wx::RTC
   end # RichTextFileHandler
   
   # Implements saving a buffer to plain text.
-  # === 
   # 
   # Category:  Rich Text
   # @see Wx::RTC::RichTextFileHandler
@@ -147,6 +152,7 @@ module Wx::RTC
   # @see  Wx::RTC::RichTextCtrl 
   # 
   # 
+  # @wxrb_require USE_RICHTEXT
   class RichTextPlainTextHandler < RichTextFileHandler
   
     # @param name [String] 

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

@@ -22,6 +22,7 @@ module Wx::RTC
   RICHTEXT_FORMAT_INDENTS_SPACING = 16
   
   # This dialog allows the user to edit a character and/or paragraph style.
+  # 
   # In the constructor, specify the pages that will be created. Use {Wx::RTC::RichTextFormattingDialog#get_style} to retrieve the common style for a given range, and then use {Wx::RTC::RichTextFormattingDialog#apply_style} to apply the user-selected formatting to a control.
   # For example: 
   # ```
@@ -43,10 +44,9 @@ module Wx::RTC
   #   }
   # ```
   # 
-  # === 
-  # 
   # Category:  Rich Text
   # 
+  # @wxrb_require USE_RICHTEXT
   class RichTextFormattingDialog < PropertySheetDialog
   
     # 
@@ -97,6 +97,7 @@ module Wx::RTC
     alias_method :image_list, :get_image_list
     
     # Gets common attributes from the given range and calls {Wx::RTC::RichTextFormattingDialog#set_attributes}.
+    # 
     # Attributes that do not have common values in the given range will be omitted from the style's flags.
     # @param ctrl [Wx::RTC::RichTextCtrl] 
     # @param range [Range] 
@@ -121,6 +122,7 @@ module Wx::RTC
     alias_method :attributes=, :set_attributes
     
     # Sets the dialog options, determining what the interface presents to the user.
+    # 
     # Currently the only option is Option_AllowPixelFontSize.
     # @param options [Integer] 
     # @return [void]
@@ -128,6 +130,7 @@ module Wx::RTC
     alias_method :options=, :set_options
     
     # Gets the dialog options, determining what the interface presents to the user.
+    # 
     # Currently the only option is Option_AllowPixelFontSize.
     # @return [Integer]
     def get_options; end
@@ -183,6 +186,7 @@ module Wx::RTC
     def self.get_formatting_dialog_factory; end
     
     # Sets the formatting factory object to be used for customization and page creation.
+    # 
     # It deletes the existing factory object.
     # @param factory [Wx::RTC::RichTextFormattingDialogFactory] 
     # @return [void]
@@ -218,11 +222,12 @@ module Wx::RTC
   end # RichTextFormattingDialog
   
   # This class provides pages for {Wx::RTC::RichTextFormattingDialog}, and allows other customization of the dialog.
+  # 
   # A default instance of this class is provided automatically. If you wish to change the behaviour of the formatting dialog (for example add or replace a page), you may derive from this class, override one or more functions, and call the static function {Wx::RTC::RichTextFormattingDialog.set_formatting_dialog_factory}.
-  # === 
   # 
   # Category:  Rich Text
   # 
+  # @wxrb_require USE_RICHTEXT
   class RichTextFormattingDialogFactory < Object
   
     # Constructor.

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

@@ -10,6 +10,7 @@ module Wx::RTC
   # 
   # 
   # 
+  # @wxrb_require USE_PRINTING_ARCHITECTURE,USE_RICHTEXT
   class RichTextOddEvenPage < Wx::Enum
   
     # 
@@ -30,6 +31,7 @@ module Wx::RTC
   # 
   # 
   # 
+  # @wxrb_require USE_PRINTING_ARCHITECTURE,USE_RICHTEXT
   class RichTextPageLocation < Wx::Enum
   
     # 
@@ -47,6 +49,7 @@ module Wx::RTC
   end # RichTextPageLocation
   
   # This class represents header and footer data to be passed to the {Wx::RTC::RichTextPrinting} and {Wx::RTC::RichTextPrintout} classes.
+  # 
   # Headers and footers can be specified independently for odd, even or both page sides. Different text can be specified for left, centre and right locations on the page, and the font and text colour can also be specified.
   # You can specify the following keywords in header and footer text, which will be substituted for the actual values during printing and preview.
   # 
@@ -56,12 +59,11 @@ module Wx::RTC
   # - @TIME@: the current time.
   # - @TITLE@: the title of the document, as passed to the {Wx::RTC::RichTextPrinting} or {Wx::RichTextLayout} constructor.
   # 
-  # === 
-  # 
   # Category:  Rich Text
   # 
   # 
   # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  # @wxrb_require USE_PRINTING_ARCHITECTURE,USE_RICHTEXT
   class RichTextHeaderFooterData < Object
   
     # @overload initialize()

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

@@ -7,13 +7,14 @@
 module Wx::RTC
 
   # Handles HTML output (only) for {Wx::RTC::RichTextCtrl} content.
+  # 
   # The most flexible way to use this class is to create a temporary object and call its functions directly, rather than use {Wx::RTC::RichTextBuffer#save_file} or {Wx::RTC::RichTextCtrl#save_file}.
   # Image handling requires a little extra work from the application, to choose an appropriate image format for the target HTML viewer and to clean up the temporary images later. If you are planning to load the HTML into a standard web browser, you can specify the handler flag {Wx::RTC::RICHTEXT_HANDLER_SAVE_IMAGES_TO_BASE64} (the default) and no extra work is required: the images will be written with the HTML.
   # However, if you want {Wx::HTML} compatibility, you will need to use {Wx::RTC::RICHTEXT_HANDLER_SAVE_IMAGES_TO_MEMORY} or {Wx::RTC::RICHTEXT_HANDLER_SAVE_IMAGES_TO_FILES}.
   # In this case, you must either call {Wx::RTC::RichTextHTMLHandler#delete_temporary_images} before the next load operation, or you must store the image locations and delete them yourself when appropriate.
   # You can call {Wx::RTC::RichTextHTMLHandler#get_temporary_image_locations} to get the array of temporary image names.
   # 
-  # == Handler flags
+  # ## Handler flags
   # 
   # The following flags can be used with this handler, via the handler's {Wx::RTC::RichTextHTMLHandler#set_flags} function or the buffer or control's SetHandlerFlags() function:
   # 
@@ -23,10 +24,9 @@ module Wx::RTC
   # - {Wx::RTC::RICHTEXT_HANDLER_NO_HEADER_FOOTER} Don't include header and footer tags (HTML, HEAD, BODY), so that the HTML can be used as part of a larger document.
   # - {Wx::RTC::RICHTEXT_HANDLER_USE_CSS} Use CSS where possible, otherwise use workarounds that will show in {Wx::HTML::HtmlWindow}.
   # 
-  # === 
-  # 
   # Category:  Rich Text
   # 
+  # @wxrb_require USE_RICHTEXT
   class RichTextHTMLHandler < RichTextFileHandler
   
     # Constructor.
@@ -41,6 +41,7 @@ module Wx::RTC
     def clear_temporary_image_locations; end
     
     # Delete the in-memory or temporary files generated by the last operation.
+    # 
     # This is a static function that can be used to delete the saved locations from an earlier operation, for example after the user has viewed the HTML file.
     # @param flags [Integer] 
     # @param imageLocations [Array<String>] 
@@ -63,6 +64,7 @@ module Wx::RTC
     alias_method :temporary_image_locations, :get_temporary_image_locations
     
     # Sets the mapping for converting point sizes to HTML font sizes.
+    # 
     # There should be 7 elements, one for each HTML font size, each element specifying the maximum point size for that HTML font size. For example: 
     # ```ruby
     #   html_handler.set_font_size_mapping([7,9,11,12,14,22,100])
@@ -73,6 +75,7 @@ module Wx::RTC
     alias_method :font_size_mapping=, :set_font_size_mapping
     
     # Sets the directory for storing temporary files.
+    # 
     # If empty, the system temporary directory will be used.
     # @param tempDir [String] 
     # @return [void]

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

@@ -7,7 +7,6 @@
 module Wx::RTC
 
   # This class implements a graphic object.
-  # === 
   # 
   # Category:  Rich Text
   # @see Wx::RTC::RichTextBuffer
@@ -17,6 +16,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 RichTextImage < RichTextObject
   
     # @overload initialize(parent=nil)
@@ -42,6 +42,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] 
@@ -54,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] 
@@ -64,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] 
@@ -122,6 +125,7 @@ module Wx::RTC
     alias_method :floatable?, :is_floatable
     
     # 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
@@ -197,13 +201,13 @@ module Wx::RTC
   end # RichTextImage
   
   # This class stores information about an image, in binary in-memory form.
-  # === 
   # 
   # Category:  Rich Text
   # @see Wx::RTC::RichTextBuffer
   # @see  Wx::RTC::RichTextCtrl 
   # 
   # 
+  # @wxrb_require USE_RICHTEXT
   class RichTextImageBlock < Object
   
     # @overload initialize()
@@ -225,6 +229,7 @@ module Wx::RTC
     
     # @overload make_image_block(filename, imageType, image, convertToJPEG=true)
     #   Load the original image into a memory block.
+    #   
     #   If the image is not a JPEG, we must convert it into a JPEG to conserve space. If it's not a JPEG we can make use of image, already scaled, so we don't have to load the image a second time.
     #   @param filename [String] 
     #   @param imageType [Wx::BitmapType]