wxruby3 0.9.0.pre.rc.3-x64-mingw-ucrt → 0.9.0-x64-mingw-ucrt

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

@@ -58,7 +58,7 @@ module Wx::RTC
   
     # @overload initialize(commandType=Wx::EVT_NULL, winid=0)
     #   Constructor.
-    #   @param commandType [Wx::AUI::AuiMDIChildFrame::EventType]  The type of the event.
+    #   @param commandType [Wx::CommandLinkButton::EventType]  The type of the event.
     #   @param winid [Integer]  Window identifier. The value {Wx::StandardID::ID_ANY} indicates a default value.
     #   @return [Wx::RTC::RichTextEvent]
     # @overload initialize(event)
@@ -93,24 +93,24 @@ module Wx::RTC
     
     # Returns the old style sheet.
     # Can be used in a {Wx::RTC::EVT_RICHTEXT_STYLESHEET_CHANGING} or {Wx::RTC::EVT_RICHTEXT_STYLESHEET_CHANGED} event handler.
-    # @return [Wx::RichTextStyleSheet]
+    # @return [Wx::RTC::RichTextStyleSheet]
     def get_old_style_sheet; end
     alias_method :old_style_sheet, :get_old_style_sheet
     
     # Sets the old style sheet variable.
-    # @param sheet [Wx::RichTextStyleSheet] 
+    # @param sheet [Wx::RTC::RichTextStyleSheet] 
     # @return [void]
     def set_old_style_sheet(sheet) end
     alias_method :old_style_sheet=, :set_old_style_sheet
     
     # Returns the new style sheet.
     # Can be used in a {Wx::RTC::EVT_RICHTEXT_STYLESHEET_CHANGING} or {Wx::RTC::EVT_RICHTEXT_STYLESHEET_CHANGED} event handler.
-    # @return [Wx::RichTextStyleSheet]
+    # @return [Wx::RTC::RichTextStyleSheet]
     def get_new_style_sheet; end
     alias_method :new_style_sheet, :get_new_style_sheet
     
     # Sets the new style sheet variable.
-    # @param sheet [Wx::RichTextStyleSheet] 
+    # @param sheet [Wx::RTC::RichTextStyleSheet] 
     # @return [void]
     def set_new_style_sheet(sheet) end
     alias_method :new_style_sheet=, :set_new_style_sheet
@@ -138,23 +138,23 @@ module Wx::RTC
     alias_method :character=, :set_character
     
     # Returns the container for which the event is relevant.
-    # @return [Wx::RichTextParagraphLayoutBox]
+    # @return [Wx::RTC::RichTextParagraphLayoutBox]
     def get_container; end
     alias_method :container, :get_container
     
     # Sets the container for which the event is relevant.
-    # @param container [Wx::RichTextParagraphLayoutBox] 
+    # @param container [Wx::RTC::RichTextParagraphLayoutBox] 
     # @return [void]
     def set_container(container) end
     alias_method :container=, :set_container
     
     # Returns the old container, for a focus change event.
-    # @return [Wx::RichTextParagraphLayoutBox]
+    # @return [Wx::RTC::RichTextParagraphLayoutBox]
     def get_old_container; end
     alias_method :old_container, :get_old_container
     
     # Sets the old container, for a focus change event.
-    # @param container [Wx::RichTextParagraphLayoutBox] 
+    # @param container [Wx::RTC::RichTextParagraphLayoutBox] 
     # @return [void]
     def set_old_container(container) end
     alias_method :old_container=, :set_old_container

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

@@ -28,12 +28,12 @@ module Wx::RTC
     #   Not all handlers will implement file loading.
     #   @param buffer [Wx::RTC::RichTextBuffer] 
     #   @param stream [IO,Wx::InputStream] 
-    #   @return [true,false]
+    #   @return [Boolean]
     # @overload load_file(buffer, filename)
     #   Loads the buffer from a file.
     #   @param buffer [Wx::RTC::RichTextBuffer] 
     #   @param filename [String] 
-    #   @return [true,false]
+    #   @return [Boolean]
     def load_file(*args) end
     
     # @overload save_file(buffer, stream)
@@ -41,38 +41,38 @@ module Wx::RTC
     #   Not all handlers will implement file saving.
     #   @param buffer [Wx::RTC::RichTextBuffer] 
     #   @param stream [IO,Wx::OutputStream] 
-    #   @return [true,false]
+    #   @return [Boolean]
     # @overload save_file(buffer, filename)
     #   Saves the buffer to a file.
     #   @param buffer [Wx::RTC::RichTextBuffer] 
     #   @param filename [String] 
-    #   @return [true,false]
+    #   @return [Boolean]
     def save_file(*args) end
     
     # Returns true if we handle this filename (if using files).
     # By default, checks the extension.
     # @param filename [String] 
-    # @return [true,false]
+    # @return [Boolean]
     def can_handle(filename) end
     alias_method :can_handle?, :can_handle
     
     # Returns true if we can save using this handler.
-    # @return [true,false]
+    # @return [Boolean]
     def can_save; end
     alias_method :can_save?, :can_save
     
     # Returns true if we can load using this handler.
-    # @return [true,false]
+    # @return [Boolean]
     def can_load; end
     alias_method :can_load?, :can_load
     
     # Returns true if this handler should be visible to the user.
-    # @return [true,false]
+    # @return [Boolean]
     def is_visible; end
     alias_method :visible?, :is_visible
     
     # Sets whether the handler should be visible to the user (via the application's load and save dialogs).
-    # @param visible [true,false] 
+    # @param visible [Boolean] 
     # @return [void]
     def set_visible(visible) end
     alias_method :visible=, :set_visible
@@ -151,17 +151,17 @@ module Wx::RTC
   
     # @param name [String] 
     # @param ext [String] 
-    # @param type [RichTextFileType] 
+    # @param type [Wx::RichTextFileType] 
     # @return [Wx::RTC::RichTextPlainTextHandler]
     def initialize(name=("Text"), ext=("txt"), type=Wx::RTC::RichTextFileType::RICHTEXT_TYPE_TEXT) end
     
     # Returns true if we can save using this handler.
-    # @return [true,false]
+    # @return [Boolean]
     def can_save; end
     alias_method :can_save?, :can_save
     
     # Returns true if we can load using this handler.
-    # @return [true,false]
+    # @return [Boolean]
     def can_load; end
     alias_method :can_load?, :can_load
     

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

@@ -0,0 +1,282 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx::RTC
+
+  # 
+  RICHTEXT_FORMAT_STYLE_EDITOR = 1
+  
+  # 
+  RICHTEXT_FORMAT_FONT = 2
+  
+  # 
+  RICHTEXT_FORMAT_TABS = 4
+  
+  # 
+  RICHTEXT_FORMAT_BULLETS = 8
+  
+  # 
+  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: 
+  # ```
+  #   wxRichTextRange range;
+  #   if (m_richTextCtrl->HasSelection())
+  #       range = m_richTextCtrl->GetSelectionRange();
+  #   else
+  #       range = wxRichTextRange(0, m_richTextCtrl->GetLastPosition()+1);
+  #   
+  #   int pages = wxRICHTEXT_FORMAT_FONT|wxRICHTEXT_FORMAT_INDENTS_SPACING| \
+  #               wxRICHTEXT_FORMAT_TABS|wxRICHTEXT_FORMAT_BULLETS;
+  #   
+  #   wxRichTextFormattingDialog formatDlg(pages, this);
+  #   formatDlg.GetStyle(m_richTextCtrl, range);
+  #   
+  #   if (formatDlg.ShowModal() == wxID_OK)
+  #   {
+  #       formatDlg.ApplyStyle(m_richTextCtrl, range);
+  #   }
+  # ```
+  # 
+  # === 
+  # 
+  # Category:  Rich Text
+  # 
+  class RichTextFormattingDialog < PropertySheetDialog
+  
+    # 
+    # 
+    Option_AllowPixelFontSize = 1
+    
+    # @overload initialize()
+    #   Default ctor.
+    #   @return [Wx::RTC::RichTextFormattingDialog]
+    # @overload initialize(flags, parent, title=("Formatting"), id=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, sz=Wx::DEFAULT_SIZE, style=Wx::DEFAULT_DIALOG_STYLE)
+    #   Constructors.
+    #   @param flags [Integer]  The pages to show.
+    #   @param parent [Wx::Window]  The dialog's parent.
+    #   @param title [String]  The dialog's title.
+    #   @param id [Integer]  The dialog's ID.
+    #   @param pos [Array(Integer, Integer), Wx::Point]  The dialog's position.
+    #   @param sz [Array(Integer, Integer), Wx::Size]  The dialog's size.
+    #   @param style [Integer]  The dialog's window style.
+    #   @return [Wx::RTC::RichTextFormattingDialog]
+    def initialize(*args) end
+    
+    # Apply attributes to the given range, only changing attributes that need to be changed.
+    # @param ctrl [Wx::RTC::RichTextCtrl] 
+    # @param range [Range] 
+    # @param flags [Integer] 
+    # @return [Boolean]
+    def apply_style(ctrl, range, flags=(Wx::RTC::RICHTEXT_SETSTYLE_WITH_UNDO|Wx::RTC::RICHTEXT_SETSTYLE_OPTIMIZE)) end
+    
+    # Creation: see {Wx::RTC::RichTextFormattingDialog#initialize} "the constructor" for details about the parameters.
+    # @param flags [Integer] 
+    # @param parent [Wx::Window] 
+    # @param title [String] 
+    # @param id [Integer] 
+    # @param pos [Array(Integer, Integer), Wx::Point] 
+    # @param sz [Array(Integer, Integer), Wx::Size] 
+    # @param style [Integer] 
+    # @return [Boolean]
+    def create(flags, parent, title=(Wx::GetTranslation.new("Formatting")), id=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, sz=Wx::DEFAULT_SIZE, style=Wx::DEFAULT_DIALOG_STYLE) end
+    
+    # Gets the attributes being edited.
+    # @return [Wx::TextAttr]
+    def get_attributes; end
+    alias_method :attributes, :get_attributes
+    
+    # Returns the image list associated with the dialog, used for example if showing the dialog as a toolbook.
+    # @return [Wx::ImageList]
+    def get_image_list; end
+    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] 
+    # @return [Boolean]
+    def get_style(ctrl, range) end
+    alias_method :style, :get_style
+    
+    # Gets the associated style definition, if any.
+    # @return [Wx::RTC::RichTextStyleDefinition]
+    def get_style_definition; end
+    alias_method :style_definition, :get_style_definition
+    
+    # Gets the associated style sheet, if any.
+    # @return [Wx::RTC::RichTextStyleSheet]
+    def get_style_sheet; end
+    alias_method :style_sheet, :get_style_sheet
+    
+    # Sets the attributes to be edited.
+    # @param attr [Wx::TextAttr] 
+    # @return [void]
+    def set_attributes(attr) end
+    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]
+    def set_options(options) end
+    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
+    alias_method :options, :get_options
+    
+    # Returns true if the given option is present.
+    # @param option [Integer] 
+    # @return [Boolean]
+    def has_option(option) end
+    alias_method :has_option?, :has_option
+    
+    # Sets the image list associated with the dialog's property sheet.
+    # @param imageList [Wx::ImageList] 
+    # @return [void]
+    def set_image_list(imageList) end
+    alias_method :image_list=, :set_image_list
+    
+    # Sets the attributes and optionally updates the display, if update is true.
+    # @param style [Wx::TextAttr] 
+    # @param update [Boolean] 
+    # @return [Boolean]
+    def set_style(style, update=true) end
+    alias_method :style=, :set_style
+    
+    # Sets the style definition and optionally update the display, if update is true.
+    # @param styleDef [Wx::RTC::RichTextStyleDefinition] 
+    # @param sheet [Wx::RTC::RichTextStyleSheet] 
+    # @param update [Boolean] 
+    # @return [Boolean]
+    def set_style_definition(styleDef, sheet, update=true) end
+    
+    # Updates the display.
+    # @return [Boolean]
+    def update_display; end
+    
+    # Helper for pages to get the top-level dialog.
+    # @param win [Wx::Window] 
+    # @return [Wx::RTC::RichTextFormattingDialog]
+    def self.get_dialog(win) end
+    
+    # Helper for pages to get the attributes.
+    # @param win [Wx::Window] 
+    # @return [Wx::TextAttr]
+    def self.get_dialog_attributes(win) end
+    
+    # Helper for pages to get the style.
+    # @param win [Wx::Window] 
+    # @return [Wx::RTC::RichTextStyleDefinition]
+    def self.get_dialog_style_definition(win) end
+    
+    # Returns the object to be used to customize the dialog and provide pages.
+    # @return [Wx::RTC::RichTextFormattingDialogFactory]
+    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]
+    def self.set_formatting_dialog_factory(factory) end
+    
+    # Returns true if the dialog will restore the last-selected page.
+    # @return [Boolean]
+    def self.get_restore_last_page; end
+    
+    # Pass true if the dialog should restore the last-selected page.
+    # @param b [Boolean] 
+    # @return [void]
+    def self.set_restore_last_page(b) end
+    
+    # Returns the page identifier of the last page selected (not the control id).
+    # @return [Integer]
+    def self.get_last_page; end
+    
+    # Sets the page identifier of the last page selected (not the control id).
+    # @param lastPage [Integer] 
+    # @return [void]
+    def self.set_last_page(lastPage) end
+    
+    # Sets the custom colour data for use by the colour dialog.
+    # @param colourData [Wx::ColourData] 
+    # @return [void]
+    def self.set_colour_data(colourData) end
+    
+    # Returns the custom colour data for use by the colour dialog.
+    # @return [Wx::ColourData]
+    def self.get_colour_data; end
+    
+  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
+  # 
+  class RichTextFormattingDialogFactory < Object
+  
+    # Constructor.
+    # @return [Wx::RTC::RichTextFormattingDialogFactory]
+    def initialize; end
+    
+    # Creates the main dialog buttons.
+    # @param dialog [Wx::RTC::RichTextFormattingDialog] 
+    # @return [Boolean]
+    def create_buttons(dialog) end
+    
+    # Creates a page, given a page identifier.
+    # @param page [Integer] 
+    # @param title [String] 
+    # @param dialog [Wx::RTC::RichTextFormattingDialog] 
+    # @return [Wx::Panel]
+    def create_page(page, title, dialog) end
+    
+    # Creates all pages under the dialog's book control, also calling AddPage().
+    # @param pages [Integer] 
+    # @param dialog [Wx::RTC::RichTextFormattingDialog] 
+    # @return [Boolean]
+    def create_pages(pages, dialog) end
+    
+    # Enumerate all available page identifiers.
+    # @param i [Integer] 
+    # @return [Integer]
+    def get_page_id(i) end
+    alias_method :page_id, :get_page_id
+    
+    # Gets the number of available page identifiers.
+    # @return [Integer]
+    def get_page_id_count; end
+    alias_method :page_id_count, :get_page_id_count
+    
+    # Gets the image index for the given page identifier.
+    # @param id [Integer] 
+    # @return [Integer]
+    def get_page_image(id) end
+    alias_method :page_image, :get_page_image
+    
+    # Set the property sheet style, called at the start of {Wx::RTC::RichTextFormattingDialog#create}.
+    # @param dialog [Wx::RTC::RichTextFormattingDialog] 
+    # @return [Boolean]
+    def set_sheet_style(dialog) end
+    alias_method :sheet_style=, :set_sheet_style
+    
+    # Invokes help for the dialog.
+    # @param page [Integer] 
+    # @param dialog [Wx::RTC::RichTextFormattingDialog] 
+    # @return [Boolean]
+    def show_help(page, dialog) end
+    
+  end # RichTextFormattingDialogFactory
+  
+
+end

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

@@ -92,8 +92,8 @@ module Wx::RTC
     alias_method :footer_margin, :get_footer_margin
     
     # Returns the footer text on odd or even pages, and at a given position on the page (left, centre or right).
-    # @param page [RichTextOddEvenPage] 
-    # @param location [RichTextPageLocation] 
+    # @param page [Wx::RichTextOddEvenPage] 
+    # @param location [Wx::RichTextPageLocation] 
     # @return [String]
     def get_footer_text(page=Wx::RTC::RichTextOddEvenPage::RICHTEXT_PAGE_EVEN, location=Wx::RTC::RichTextPageLocation::RICHTEXT_PAGE_CENTRE) end
     alias_method :footer_text, :get_footer_text
@@ -104,21 +104,21 @@ module Wx::RTC
     alias_method :header_margin, :get_header_margin
     
     # Returns the header text on odd or even pages, and at a given position on the page (left, centre or right).
-    # @param page [RichTextOddEvenPage] 
-    # @param location [RichTextPageLocation] 
+    # @param page [Wx::RichTextOddEvenPage] 
+    # @param location [Wx::RichTextPageLocation] 
     # @return [String]
     def get_header_text(page=Wx::RTC::RichTextOddEvenPage::RICHTEXT_PAGE_EVEN, location=Wx::RTC::RichTextPageLocation::RICHTEXT_PAGE_CENTRE) end
     alias_method :header_text, :get_header_text
     
     # Returns true if the header and footer will be shown on the first page.
-    # @return [true,false]
+    # @return [Boolean]
     def get_show_on_first_page; end
     alias_method :show_on_first_page, :get_show_on_first_page
     
     # Helper function for getting the header or footer text, odd or even pages, and at a given position on the page (left, centre or right).
     # @param headerFooter [Integer] 
-    # @param page [RichTextOddEvenPage] 
-    # @param location [RichTextPageLocation] 
+    # @param page [Wx::RichTextOddEvenPage] 
+    # @param location [Wx::RichTextPageLocation] 
     # @return [String]
     def get_text(headerFooter, page, location) end
     alias_method :text, :get_text
@@ -140,16 +140,16 @@ module Wx::RTC
     
     # Sets the footer text on odd or even pages, and at a given position on the page (left, centre or right).
     # @param text [String] 
-    # @param page [RichTextOddEvenPage] 
-    # @param location [RichTextPageLocation] 
+    # @param page [Wx::RichTextOddEvenPage] 
+    # @param location [Wx::RichTextPageLocation] 
     # @return [void]
     def set_footer_text(text, page=Wx::RTC::RichTextOddEvenPage::RICHTEXT_PAGE_ALL, location=Wx::RTC::RichTextPageLocation::RICHTEXT_PAGE_CENTRE) end
     alias_method :footer_text=, :set_footer_text
     
     # Sets the header text on odd or even pages, and at a given position on the page (left, centre or right).
     # @param text [String] 
-    # @param page [RichTextOddEvenPage] 
-    # @param location [RichTextPageLocation] 
+    # @param page [Wx::RichTextOddEvenPage] 
+    # @param location [Wx::RichTextPageLocation] 
     # @return [void]
     def set_header_text(text, page=Wx::RTC::RichTextOddEvenPage::RICHTEXT_PAGE_ALL, location=Wx::RTC::RichTextPageLocation::RICHTEXT_PAGE_CENTRE) end
     alias_method :header_text=, :set_header_text
@@ -161,7 +161,7 @@ module Wx::RTC
     def set_margins(headerMargin, footerMargin) end
     
     # Pass true to show the header or footer on first page (the default).
-    # @param showOnFirstPage [true,false] 
+    # @param showOnFirstPage [Boolean] 
     # @return [void]
     def set_show_on_first_page(showOnFirstPage) end
     alias_method :show_on_first_page=, :set_show_on_first_page
@@ -169,8 +169,8 @@ module Wx::RTC
     # Helper function for setting the header or footer text, odd or even pages, and at a given position on the page (left, centre or right).
     # @param text [String] 
     # @param headerFooter [Integer] 
-    # @param page [RichTextOddEvenPage] 
-    # @param location [RichTextPageLocation] 
+    # @param page [Wx::RichTextOddEvenPage] 
+    # @param location [Wx::RichTextPageLocation] 
     # @return [void]
     def set_text(text, headerFooter, page, location) end
     

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

@@ -40,15 +40,11 @@ module Wx::RTC
     # @return [void]
     def clear_temporary_image_locations; end
     
-    # Deletes the in-memory or temporary files generated by the last operation.
-    # @return [true,false]
-    def delete_temporary_images; 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>] 
-    # @return [true,false]
+    # @return [Boolean]
     def self.delete_temporary_images(flags, imageLocations) end
     
     # Returns the mapping for converting point sizes to HTML font sizes.
@@ -68,17 +64,8 @@ module Wx::RTC
     
     # 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: 
-    # ```
-    #   wxArrayInt fontSizeMapping;
-    #   fontSizeMapping.Add(7);
-    #   fontSizeMapping.Add(9);
-    #   fontSizeMapping.Add(11);
-    #   fontSizeMapping.Add(12);
-    #   fontSizeMapping.Add(14);
-    #   fontSizeMapping.Add(22);
-    #   fontSizeMapping.Add(100);
-    #   
-    #   htmlHandler.SetFontSizeMapping(fontSizeMapping);
+    # ```ruby
+    #   html_handler.set_font_size_mapping([7,9,11,12,14,22,100])
     # ```
     # @param fontSizeMapping [Array<Integer>] 
     # @return [void]