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

data/lib/wx/doc/grid/grid.rb

@@ -1,3 +1,9 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
 
 module Wx::GRID
 
@@ -15,6 +21,15 @@ module Wx::GRID
     alias :set_table :assign_table
     alias :table= :assign_table
 
+    # Iterates all selected blocks passing each corresponding Wx::GRID::GridBlockCoords to the given block
+    # or returns an enumerator if no block given.
+    # @yieldparam [Wx::GRID::GridBlockCoords] selected_block
+    # @return [Object,Enumerator] result of last block execution or an Enumerator if no block given
+    def selected_blocks; end
+
   end
-  
+
+  # Provides an opaque handle for grid windows.
+  class GridWindow; end
+
 end

data/lib/wx/doc/hboxsizer.rb

@@ -0,0 +1,33 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
+
+module Wx
+
+  # Just a shortcut version for creating a horizontal box sizer
+  class HBoxSizer < Wx::BoxSizer
+
+    # Constructor for a {Wx::HBoxSizer}.
+    # @return [Wx::HBoxSizer]
+    def initialize; end
+
+  end
+
+  # Just a shortcut version for creating a horizontal wrap sizer
+  class HWrapSizer < Wx::WrapSizer
+
+    # Constructor for a {Wx::HWrapSizer}.
+    # The flags parameter can be a combination of the values {Wx::EXTEND_LAST_ON_EACH_LINE} which will cause the last
+    # item on each line to use any remaining space on that line and {Wx::REMOVE_LEADING_SPACES} which removes any spacer
+    # elements from the beginning of a row.
+    # Both of these flags are on by default.
+    # @param flags [Integer]
+    # @return [Wx::HWrapSizer]
+    def initialize(flags=Wx::WRAPSIZER_DEFAULT_FLAGS) end
+
+  end
+
+end

data/lib/wx/doc/help_controller.rb

@@ -1,3 +1,9 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
 
 class Wx::HelpController
 

data/lib/wx/doc/html/html_help_controller.rb

@@ -1,3 +1,9 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
 
 class Wx::HTML::HelpController
 

data/lib/wx/doc/icon.rb

@@ -1,18 +1,26 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
 
-class Wx::Icon
+
+class Wx
 
   # Searches for an art file with basename 'name' and creates an Icon if found.
   # Raises an ArgumentError if not found.
   # Wx::ArtLocator::find_art is used to look up the art file using ::Kernel#caller_locations to
-  # determine the values for the 'art_path' and 'art_owner' arguments ('art_path' is set to the
-  # absolute path to the folder holding the caller's code and 'art_owner' to the basename of the
-  # caller's source file). The 'art_type' argument is set to <code>:icon</code>.
+  # determine the values for the 'art_path' and 'art_section' arguments if not specified here
+  # ('art_path' is set to the absolute path to the folder holding the caller's code and 'art_section'
+  # to the basename of the caller's source file). The 'art_type' argument is set to <code>:icon</code>.
   # @param [String,Symbol] name base name of art file
   # @param [Wx::BitmapType,nil] bmp_type bitmap type for art file (nil means any supported type)
   # @param [Integer] desired_width
   # @param [Integer] desired_height
+  # @param [String,nil] art_path base path to look up the art file
+  # @param [String,nil] art_section optional owner folder name for art files
   # @return [Wx::Icon]
   # @see Wx::ArtLocator::find_art
-  def self.Icon(name, bmp_type = nil, desired_width=-1, desired_height=-1); end
+  def self.Icon(name, bmp_type = nil, desired_width=-1, desired_height=-1, art_path: nil, art_section: nil); end
 
 end

data/lib/wx/doc/id_helper.rb

@@ -1,3 +1,9 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
 
 module Wx
 

data/lib/wx/doc/image.rb

@@ -1,3 +1,9 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
 
 module Wx
 
@@ -11,23 +17,55 @@ module Wx
     # @return [Array<String>]
     def self.extensions; end
 
+    # Returns an array with the supported mime types of the available image handlers.
+    # @return [Array<String>]
+    def self.mime_types; end
+
     # returns a Hash with all supported extensions per available BitmapType
     # @return [Hash]
     def self.handler_extensions; end
 
-    # Searches for an art file with basename 'name' and creates an Image if found.
-    # Raises an ArgumentError if not found.
-    # Wx::ArtLocator::find_art is used to look up the art file using ::Kernel#caller_locations to
-    # determine the values for the 'art_path' and 'art_owner' arguments ('art_path' is set to the
-    # absolute path to the folder holding the caller's code and 'art_owner' to the basename of the
-    # caller's source file). The 'art_type' argument is set to <code>:icon</code>.
-    # @param [String,Symbol] name base name of art file
-    # @param [Wx::BitmapType,nil] bmp_type bitmap type for art file (nil means any supported type)
-    # @param [Integer] index  Index of the image to load in the case that the image file contains multiple images. This is only used by GIF, ICO and TIFF handlers. The default value (-1) means "choose the default image" and is interpreted as the first image (index=0) by the GIF and TIFF handler and as the largest and most colourful one by the ICO handler.
-    # @return [Wx::Image]
-    # @see Wx::ArtLocator::find_art
-    def self.Image(name, bmp_type = nil, index=-1); end
+    module Histogram
+
+      # Calculate an image histogram key from given RGB values.
+      # @param [Integer] r Red value
+      # @param [Integer] g Green value
+      # @param [Integer] b Blue value
+      # @return [Integer] key value
+      def make_key(r,g,b) end
+
+      # Find first colour that is not used in the image and has higher RGB values than RGB(r, g, b)
+      # @param [Integer] r Red value
+      # @param [Integer] g Green value
+      # @param [Integer] b Blue value
+      # @return [Array(Integer,Integer,Integer),nil] RGB values of first unused colour or nil if none found
+      def find_first_unused_colour(r=1, g=0, b=0) end
+
+    end
+
+    # Computes the histogram of the image and fills a hash table, indexed
+    # with integer keys built as 0xRRGGBB, containing pairs (Array) of integer values.
+    # For each pair the first value is the index of the first pixel in the colour in the image
+    # and the second value the number of pixels having the colour in the image.
+    # The returned Hash object is extended with the {Wx::Image::Histogram} mixin.
+    # @return [Hash] hash object extended with {Wx::Image::Histogram}
+    def compute_histogram; end
 
   end
 
+  # Searches for an art file with basename 'name' and creates an Image if found.
+  # Raises an ArgumentError if not found.
+  # Wx::ArtLocator::find_art is used to look up the art file using ::Kernel#caller_locations to
+  # determine the values for the 'art_path' and 'art_section' arguments if not specified here
+  # ('art_path' is set to the absolute path to the folder holding the caller's code and 'art_section'
+  # to the basename of the caller's source file). The 'art_type' argument is set to <code>:image</code>.
+  # @param [String,Symbol] name base name of art file
+  # @param [Wx::BitmapType,nil] bmp_type bitmap type for art file (nil means any supported type)
+  # @param [Integer] index  Index of the image to load in the case that the image file contains multiple images. This is only used by GIF, ICO and TIFF handlers. The default value (-1) means "choose the default image" and is interpreted as the first image (index=0) by the GIF and TIFF handler and as the largest and most colourful one by the ICO handler.
+  # @param [String,nil] art_path base path to look up the art file
+  # @param [String,nil] art_section optional owner folder name for art files
+  # @return [Wx::Image]
+  # @see Wx::ArtLocator::find_art
+  def self.Image(name, bmp_type = nil, index=-1, art_path: nil, art_section: nil); end
+
 end

data/lib/wx/doc/list_ctrl.rb

@@ -0,0 +1,38 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
+
+class Wx::ListCtrl
+
+  include Enumerable
+
+  # Iterates all items in the list control passing each item (id) to the given block.
+  # @yieldparam [Integer] item
+  # @return [Object] result of last block iteration
+  def each(&block) end
+
+  # Iterates all selected items in the list control (like #get_next_item(item, Wx::LIST_NEXT_ALL, Wx::LIST_STATE_SELECTED))
+  # passing each item (id) to the given block.
+  # @yieldparam [Integer] item
+  # @return [Object] result of last block iteration
+  def each_selected(&block) end
+
+  # Returns array of selected items.
+  # @return [Array<Integer>] selected items
+  def get_selections; end
+
+  # Call this function to sort the items in the list control.
+  # The sorting method will call the given block repeatedly to compare two items from the list
+  # passing the <b>item data</b> for each item as well as the `data` argument given to the #sort_items method.
+  # The block should return 0 if the items are equal, negative value if the first item is less than the second
+  # one and positive value if the first one is greater than the second one.
+  # @param [Object] data user data to pass on to the sorting block
+  # @yieldparam [Object] item_data1 data for first item
+  # @yieldparam [Object] item_data2 data for second item
+  # @yieldparam [Object] data propagated data argument
+  def sort_items(data = nil, &block) end
+
+end

data/lib/wx/doc/log.rb

@@ -0,0 +1,45 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
+
+module Wx
+
+  class Log
+
+    # Sets the current component for log info to the given value before executing the
+    # given block and restores the previous component value after the block returns.
+    # @param [String] comp component value for log info
+    def self.for_component(comp, &block) end
+
+  end
+
+  class LogStderr
+
+    # Creates a new LogStderr for the given file handle.
+    # Possible values are 2 for `stderr` and 1 for `stdout`.
+    # @param [Integer] fh file stream handle
+    def initialize(fh = 2) end
+  end
+
+  class LogNull
+
+    # Suspends logging before executing the given block and restarts logging when the block returns.
+    def self.no_log(&block) end
+
+  end
+
+  class LogChain
+
+    # Releases the redirection chain and restores the previous log instance as the active log target.
+    # Traditionally in C++ applications would rely on the destructor to do this but that is not a really
+    # predictable option in wxRuby since destruction only takes place after GC collection (which is not
+    # exactly predictable) so wxRuby adds this method to better control restoration time if needed.
+    # @return [void]
+    def release; end
+
+  end
+
+end

data/lib/wx/doc/memory_dc.rb

@@ -1,3 +1,9 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
 
 module Wx
 

data/lib/wx/doc/mirror_dc.rb

@@ -1,3 +1,9 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
 
 module Wx
 

data/lib/wx/doc/pen.rb

@@ -1,3 +1,9 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
 
 module Wx
 

data/lib/wx/doc/pg/events.rb

@@ -1,3 +1,9 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
 
 class Wx::EvtHandler
 

data/lib/wx/doc/pg/pg_property.rb

@@ -1,3 +1,9 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
 
 module Wx::PG
 
@@ -5,4 +11,15 @@ module Wx::PG
 
   PG_DEFAULT_IMAGE_SIZE = Wx::DEFAULT_SIZE
 
+  class PGProperty
+
+    # Iterate each attribute.
+    # Passes the variant for each attribute to the given block.
+    # Returns an Enumerator if no block given.
+    # @yieldparam [Wx::Variant] variant attribute's variant
+    # @return [Object,Enumerator] last result of block or Enumerator if no block given.
+    def each_attribute; end
+
+  end
+
 end

data/lib/wx/doc/pg/pgeditor.rb

@@ -1,3 +1,9 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
 
 module Wx::PG
 

data/lib/wx/doc/pg/property_grid.rb

@@ -1,3 +1,9 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
 
 module Wx::PG
 

data/lib/wx/doc/pg/property_grid_interface.rb

@@ -1,3 +1,9 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
 
 module Wx::PG
 

data/lib/wx/doc/progress_dialog.rb

@@ -1,3 +1,9 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
 
 class Wx::ProgressDialog
 

data/lib/wx/doc/prt/page_setup_dialog.rb

@@ -1,3 +1,9 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
 
 class Wx::PRT::PageSetupDialog
 

data/lib/wx/doc/prt/print_data.rb

@@ -1,3 +1,9 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
 
 class Wx::PRT::PrintDialogData
 

data/lib/wx/doc/prt/print_dialog.rb

@@ -1,3 +1,9 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
 
 class Wx::PRT::PrintDialog
 

data/lib/wx/doc/prt/printer.rb

@@ -1,3 +1,9 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
 
 class Wx::PRT::Printer
 

data/lib/wx/doc/prt/printer_dc.rb

@@ -1,3 +1,9 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
 
 module Wx::PRT
 
@@ -8,7 +14,7 @@ module Wx::PRT
     # @param [Wx::PRT::PrintData] print_data print_data defining the print settings
     # @yieldparam [Wx::PrinterDC] dc the PrinterDC instance to paint on
     # @return [Object] result of the block
-    def self.draw_on(win) end
+    def self.draw_on(print_data) end
 
   end
 
@@ -19,7 +25,7 @@ module Wx::PRT
     # @param [Wx::PRT::PrintData] print_data print_data defining the print settings
     # @yieldparam [Wx::PostScriptDC] dc the PostScriptDC instance to paint on
     # @return [Object] result of the block
-    def self.draw_on(win) end
+    def self.draw_on(print_data) end
 
   end
 

data/lib/wx/doc/radio_box.rb

@@ -1,3 +1,9 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
 
 class Wx::RadioBox
 

data/lib/wx/doc/rbn/ribbon_bar.rb

@@ -1,3 +1,9 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
 
 class Wx::RBN::RibbonBar
 

data/lib/wx/doc/rbn/ribbon_button_bar.rb

@@ -1,3 +1,9 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
 
 class Wx::RBN::RibbonButtonBar
 

data/lib/wx/doc/rbn/ribbon_gallery.rb

@@ -1,3 +1,9 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
 
 class Wx::RBN::RibbonGallery
 

data/lib/wx/doc/rbn/ribbon_tool_bar.rb

@@ -1,3 +1,9 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
 
 class Wx::RBN::RibbonToolBar
 

data/lib/wx/doc/region_iterator.rb

@@ -1,3 +1,9 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
 
 class Wx::RegionIterator
 

data/lib/wx/doc/rtc/richtext_buffer.rb

@@ -0,0 +1,28 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
+
+class Wx::RTC::RichTextBuffer
+
+  # Iterates all RichTextFileHandler-s and passes each handler to the given block
+  # or returns an enumerator if no block given.
+  # @yieldparam [Wx::RTC::RichTextFileHandler] handler
+  # @return [Object,Enumerator] last result of given block or enumerator
+  def self.each_handler; end
+
+  # Iterates all RichTextFieldType-s and passes each field type to the given block
+  # or returns an enumerator if no block given.
+  # @yieldparam [Wx::RTC::RichTextFieldType] field type
+  # @return [Object,Enumerator] last result of given block or enumerator
+  def self.each_field_type; end
+
+  # Iterates all RichTextDrawingHandler-s and passes each handler to the given block
+  # or returns an enumerator if no block given.
+  # @yieldparam [Wx::RTC::RichTextDrawingHandler] handler
+  # @return [Object,Enumerator] last result of given block or enumerator
+  def self.each_drawing_handler; end
+
+end

data/lib/wx/doc/rtc/richtext_formatting_dialog.rb

@@ -0,0 +1,68 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
+
+module Wx::RTC
+
+  RICHTEXT_FORMAT_MARGINS = 0x0040
+  RICHTEXT_FORMAT_SIZE = 0x0080
+  RICHTEXT_FORMAT_BORDERS = 0x0100
+  RICHTEXT_FORMAT_BACKGROUND = 0x0200
+
+  class RichTextFormattingDialog
+
+    # Returns associated richtext object
+    # @return [Wx::RTC::RichTextObject]
+    def get_object; end
+    alias :object :get_object
+
+    # Sets associated richtext object
+    # @param [Wx::RTC::Object] obj
+    # @return [void]
+    def set_object(obj) end
+    alias :object= :set_object
+
+    # Apply attributes to the object being edited, only changing attributes that need to be changed.
+    # @param ctrl [Wx::RTC::RichTextCtrl]
+    # @param flags [Integer]
+    # @return [true,false]
+    def apply_style(ctrl, flags=Wx::RTC::RICHTEXT_SETSTYLE_WITH_UNDO) end
+
+  end
+
+  class RichTextObjectPropertiesDialog < RichTextFormattingDialog
+
+    ID_RICHTEXTOBJECTPROPERTIESDIALOG = 10650
+
+    # @overload initialize()
+    #   Default ctor.
+    #   @return [Wx::RTC::RichTextObjectPropertiesDialog]
+    # @overload initialize(obj, parent, caption=("Object Properties"), id=ID_RICHTEXTOBJECTPROPERTIESDIALOG, pos=Wx::DEFAULT_POSITION, sz=[400,300], style=Wx::DEFAULT_DIALOG_STYLE|Wx::TAB_TRAVERSAL)
+    #   Constructors.
+    #   @param obj [Wx::RTC::RichTextObject]  The richtext object to edit properties of.
+    #   @param parent [Wx::Window]  The dialog's parent.
+    #   @param caption [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::RichTextObjectPropertiesDialog]
+    def initialize(*args) end
+
+    # Creation: see {Wx::RTC::RichTextObjectPropertiesDialog#initialize} "the constructor" for details about the parameters.
+    # @param obj [Wx::RTC::RichTextObject]
+    # @param parent [Wx::Window]
+    # @param caption [String]
+    # @param id [Integer]
+    # @param pos [Array(Integer, Integer), Wx::Point]
+    # @param size [Array(Integer, Integer), Wx::Size]
+    # @param style [Integer]
+    # @return [true,false]
+    def create(obj, parent, id = ID_RICHTEXTOBJECTPROPERTIESDIALOG, caption = 'Object Properties', pos = Wx::DEFAULT_POSITION, size = [400,300], style = Wx::DEFAULT_DIALOG_STYLE|Wx::TAB_TRAVERSAL) end
+
+  end
+
+end

data/lib/wx/doc/rtc/richtext_printing.rb

@@ -1,3 +1,9 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
 
 class Wx::RTC::RichTextPrinting
 

data/lib/wx/doc/rtc/richtext_style_sheet.rb

@@ -0,0 +1,20 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
+
+class Wx::RTC::RichTextStyleSheet
+
+  # Copy ctor
+  # @param [Wx::RTC::RichTextStyleSheet] sheet
+  # @return [Wx::RTC::RichTextStyleSheet]
+  def initialize(sheet) end
+
+  # Copy given style sheet
+  # @param [Wx::RTC::RichTextStyleSheet] sheet
+  # @return [void]
+  def copy(sheet) end
+
+end