wxruby3 0.9.8 → 1.0.1

data/lib/wx/doc/image.rb

@@ -51,8 +51,62 @@ module Wx
     # @return [Hash] hash object extended with {Wx::Image::Histogram}
     def compute_histogram; end
 
+    # Converts a color in HSV colour space to RGB colour space.
+    # @param [Wx::Image::HSVValue,Array(Float,Float,Float)] arg HSV colour
+    def self.hsv_to_rgb(arg) end
+
+    # Converts a color in RGB colour space to HSV colour space.
+    # @param [Wx::Image::RGBValue,Array(Float,Float,Float)] arg RGB colour
+    def self.rgb_to_hsv(arg) end
+
+    class HSVValue
+
+      # Constructor for HSVValue, an object that contains values for hue, saturation and value which represent the value of a color.
+      # It is used by {Wx::Image.hsv_to_rgb} and {Wx::Image.rgb_to_hsv}, which convert between HSV color space and RGB color space.
+      # @param [Float] hue
+      # @param [Float] saturation
+      # @param [Float] value
+      # @return [Wx::Image::HSVValue]
+      def initialize(hue, saturation, value)end
+
+      attr :hue, :saturation, :value
+
+      # Make HSVValue usable for parallel assignments like `hue, saturation, value = hsv`
+      # @return [Array(Float,Float,Float)]
+      def to_ary; end
+
+      # Convert to {Wx::Image::RGBValue}
+      # @return [Wx::Image::RGBValue]
+      def to_rgb; end
+
+    end
+
+    class RGBValue
+
+      # Constructor for RGBValue, an object that contains values for red, green and blue which represent the value of a color.
+      # It is used by {Wx::Image.hsv_to_rgb} and {Wx::Image.rgb_to_hsv}, which convert between RGB color space and HSV color space.
+      # @param [Float] red
+      # @param [Float] green
+      # @param [Float] blue
+      # @return [Wx::Image::RGBValue]
+      def initialize(red, green, blue)end
+
+      attr :red, :green, :blue
+
+      # Make RGBValue usable for parallel assignments like `red, green, blue = rgb`
+      # @return [Array(Float,Float,Float)]
+      def to_ary; end
+
+      # Convert to {Wx::Image::HSVValue}
+      # @return [Wx::Image::HSVValue]
+      def to_hsv; end
+
+    end
+
   end
 
+  # @!group Art creation methods
+
   # 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
@@ -68,4 +122,6 @@ module Wx
   # @see Wx::ArtLocator::find_art
   def self.Image(name, bmp_type = nil, index=-1, art_path: nil, art_section: nil); end
 
+  # @!endgroup
+
 end

data/lib/wx/doc/list_ctrl.rb

@@ -13,13 +13,13 @@ module Wx
 
     # 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
+    # @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
+    # @return [::Object] result of last block iteration
     def each_selected(&block) end
 
     # Returns array of selected items.
@@ -31,10 +31,10 @@ module Wx
     # 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
+    # @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/memory_dc.rb

@@ -66,16 +66,7 @@ module Wx
 
   end
 
-  class AutoBufferedPaintDC < Wx::BufferedPaintDC
-
-    # Creates a Buffered DC and passes that to the given block to draw on.
-    # Destroys the DC after the block returns.
-    # Pass a pointer to the window on which you wish to paint.
-    # @note In wxRuby this method mostly exists to be consistent with the other DC classes. It is however recommended to use Wx::Window#paint_buffered instead.
-    # @param [Wx::Window] win The underlying window; everything drawn to this object will be flushed to this window when this object is destroyed.
-    # @yieldparam [Wx::AutoBufferedPaintDC] dc
-    def self.draw_on(win, &block) end
-
-  end
+  # This constant is set to either Wx::PaintDC if the platform supports native double buffering or Wx::BufferedPaintDC otherwise.
+  AutoBufferedPaintDC = _
 
 end

data/lib/wx/doc/mirror_dc.rb

@@ -14,7 +14,7 @@ module Wx
     # @param [Wx::DC] dc DC to duplicate the (mirrored) drawing on
     # @param [Boolean] mirror whether to mirror or not
     # @yieldparam [Wx::MirrorDC] dc the MirrorDC instance to paint on
-    # @return [Object] result of the block
+    # @return [::Object] result of the block
     def self.draw_on(dc, mirror) end
 
   end

data/lib/wx/doc/pen.rb

@@ -16,8 +16,34 @@ module Wx
     # @return [Wx::Pen]
     def self.find_or_create_pen(colour, width=1, style=Wx::PenStyle::PENSTYLE_SOLID) end
 
+    # Associates an array of dash values with the pen.
+    #
+    # @see Wx::Pen#get_dashes
+    # @param dashes [Array<Integer>]
+    # @return [void]
+    def set_dashes(dashes) end
+
+    # Gets an array of dashes.
+    #
+    # @see Wx::Pen#set_dashes
+    # @return [Array<Integer>]
+    def get_dashes; end
+    alias_method :dashes, :get_dashes
+
   end
 
   ThePenList = Wx::Pen
 
+  class PenInfo
+
+    # @param dashes [Array<Integer>]
+    # @return [Wx::PenInfo]
+    def dashes(dashes) end
+
+    # @return [Array<Integer>]
+    def get_dashes; end
+    alias_method :dashes, :get_dashes
+
+  end
+
 end

data/lib/wx/doc/persistence_manager.rb

@@ -14,7 +14,7 @@ module Wx
   # instance for the object it is called for.
   # This method raises a NoImplementError if the object class does not support persistence.
   # @see Defining Custom Persistent Windows
-  # @param obj [Object]
+  # @param obj [::Object]
   # @return [Wx::PersistentObject]
   def self.create_persistent_object(obj) end
 

data/lib/wx/doc/persistent_object.rb

@@ -11,7 +11,7 @@ module Wx
 
     # Save the specified value using the given name.
     # @param [String] name The name of the value in the configuration file.
-    # @param [Object] value The value to save, currently must be a type supported by wxConfig.
+    # @param [::Object] value The value to save, currently must be a type supported by wxConfig.
     # @return [Boolean] true if the value was saved or false if an error occurred.
     def save_value(name, value); end
     protected :save_value

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

@@ -18,7 +18,7 @@ module Wx::PG
     #   @param start [Integer,Wx::PG::Property] start position (either {Wx::Direction::TOP} or {Wx::Direction::BOTTOM} or the property to start at)
     #   @param reverse [true,false] iterate properties in reverse
     #   @yieldparam item [Wx::PG::PGProperty] property
-    #   @return [Object] result of last block execution
+    #   @return [::Object] result of last block execution
     # @overload each_property(flags, start, reverse:)
     #   @param flags [Integer] flags specifying iteration (see {Wx::PG::PG_ITERATOR_FLAGS})
     #   @param start [Integer,Wx::PG::Property] start position (either {Wx::Direction::TOP} or {Wx::Direction::BOTTOM} or the property to start at)
@@ -35,7 +35,7 @@ module Wx::PG
     #   @param start [Integer,Wx::PG::Property] start position (either {Wx::Direction::TOP} or {Wx::Direction::BOTTOM} or the property to start at)
     #   @param reverse [true,false] iterate properties in reverse
     #   @yieldparam item [Wx::PG::PGProperty] property
-    #   @return [Object] result of last block execution
+    #   @return [::Object] result of last block execution
     # @overload reverse_each_property(flags, start)
     #   @param flags [Integer] flags specifying iteration (see {Wx::PG::PG_ITERATOR_FLAGS})
     #   @param start [Integer,Wx::PG::Property] start position (either {Wx::Direction::TOP} or {Wx::Direction::BOTTOM} or the property to start at)
@@ -50,7 +50,7 @@ module Wx::PG
     # @overload each_property_attribute(id , &block)
     #   @param id [String,Wx::PG::PGProperty] (name of) property to iterate attributes of
     #   @yieldparam item [Wx::Variant] attribute
-    #   @return [Object] result of last block execution
+    #   @return [::Object] result of last block execution
     # @overload each_property_attribute(id)
     #   @param id [String,Wx::PG::PGProperty] (name of) property to iterate attributes of
     #   @return [Enumerator] an enumerator

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

@@ -13,7 +13,7 @@ module Wx::PRT
     # it's single argument.
     # @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
+    # @return [::Object] result of the block
     def self.draw_on(print_data) end
 
   end
@@ -24,7 +24,7 @@ module Wx::PRT
     # it's single argument.
     # @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
+    # @return [::Object] result of the block
     def self.draw_on(print_data) end
 
   end

data/lib/wx/doc/region_iterator.rb

@@ -31,7 +31,7 @@ module Wx
     # If no block is given an Enumerator is returned.
     # @overload each(&block)
     #   @yieldparam [Wx::Rect] rect
-    #   @return [Object]
+    #   @return [::Object]
     # @overload each()
     #   @return [Enumerator]
     def each; end

data/lib/wx/doc/scaled_dc.rb

@@ -16,7 +16,7 @@ module Wx
     # @param [Wx::DC] target DC to draw on (scaled)
     # @param [Float] scale scale factor
     # @yieldparam [Wx::ScaledDC] dc scaled dc to draw on
-    # @return [Object] result from block
+    # @return [::Object] result from block
     def self.draw_on(target, scale) end
   end
 

data/lib/wx/doc/screen_dc.rb

@@ -12,7 +12,7 @@ module Wx
     # Executes the given block providing a temporary (screen) dc as
     # it's single argument.
     # @yieldparam [Wx::ScreenDC] dc the ScreenDC instance to paint on
-    # @return [Object] result of the block
+    # @return [::Object] result of the block
     def self.draw_on; end
 
   end

data/lib/wx/doc/svg_file_dc.rb

@@ -18,7 +18,7 @@ module Wx
     # @param [Float] dpi resolution for SVG image
     # @param [String] title readable name for the SVG document
     # @yieldparam [Wx::SVGFileDC] dc the SVGFileDC instance to paint on
-    # @return [Object] result of the block
+    # @return [::Object] result of the block
     def self.draw_on(filename, width=320, height=240, dpi=72, title='') end
 
   end

data/lib/wx/doc/textctrl.rb

@@ -62,7 +62,7 @@ module Wx
 
     # Appends the string representation of `obj` to the text value of the control.
     # Calls #to_s to get the string representation of `obj`.
-    # @param [Object] obj
+    # @param [::Object] obj
     # @return [self]
     def <<(obj) end
 

data/lib/wx/doc/tree_ctrl.rb

@@ -37,7 +37,7 @@ module Wx
     #
     # Returns an invalid tree item if there are no further children.
     # @param [Wx::TreeItemId] parent_id the id of the parent tree item for which to iterate children
-    # @param [Object] cookie cookie value as returned from previous #get_first_cild or #get_next_child call.
+    # @param [::Object] cookie cookie value as returned from previous #get_first_cild or #get_next_child call.
     # @return [Array(Wx::TreeItemId, Object)] first child item id (if any) and cookie value
     def get_next_child(parent_id, cookie) end
 
@@ -74,7 +74,7 @@ module Wx
     # @param [Integer] pos child item's position to insert before
     # @param [Integer] image image index for unselected item
     # @param [Integer] selImage image index for selected item
-    # @param data [Object]
+    # @param data [::Object]
     # @return [Wx::TreeItemId] id of inserted tree item
     def insert_item_before(parent, pos, text, image=-1, selImage=-1, data=nil) end
 

data/lib/wx/doc/validator.rb

@@ -22,7 +22,7 @@ module Wx
     # Should retrieve and return the data from the associated window (#get_window).
     # By default returns nil (which indicates there is no custom data to transfer).
     # Overload for customized functionality.
-    # @return [Object] retrieved data from window
+    # @return [::Object] retrieved data from window
     def do_transfer_from_window; end
     protected :do_transfer_from_window
 
@@ -30,7 +30,7 @@ module Wx
     # Should transfer the given data to the associated window and return true if successful.
     # By default does nothing and just returns true.
     # Overload for customized functionality.
-    # @param [Object] data
+    # @param [::Object] data
     # @return [Boolean]
     def do_transfer_to_window(data) end
     protected :do_transfer_to_window
@@ -60,7 +60,7 @@ module Wx
       #   win.set_validator(val)
       #
       # @param [String,Symbol,Method,Proc] meth (name of) method or event handling proc; to be supplied when no block is given
-      # @yieldparam [Object] data the data retrieved from the window
+      # @yieldparam [::Object] data the data retrieved from the window
       def on_transfer_from_window(meth=nil, &block) end
 
       # Installs a callback handler to provide the data to transfer to the associated window.
@@ -85,13 +85,13 @@ module Wx
       #   win.set_validator(val)
       #
       # @param [String,Symbol,Method,Proc] meth (name of) method or event handling proc; to be supplied when no block is given
-      # @yieldreturn [Object] the data to transfer to the window
+      # @yieldreturn [::Object] the data to transfer to the window
       def on_transfer_to_window(meth=nil, &block) end
 
       # Method called with data transferred from window.
       # By default will call the on_transfer_from_window handler if defined.
       # Returns true if successful or none defined.
-      # @param [Object] data
+      # @param [::Object] data
       # @return [Boolean]
       def do_on_transfer_from_window(data) end
       protected :do_on_transfer_from_window
@@ -100,7 +100,7 @@ module Wx
       # By default will call the on_transfer_to_window handler if defined.
       # Returns the handler's result if successful.
       # Otherwise returns nil.
-      # @return [Object]
+      # @return [::Object]
       def do_on_transfer_to_window; end
       protected :do_on_transfer_to_window
 

data/lib/wx/doc/variant.rb

@@ -16,7 +16,7 @@ module Wx
     # Returns an enumerator when no block is given.
     # @overload each(&block)
     #   @yieldparam item [Wx::Variant] variant list item
-    #   @return [Object] result of last block execution
+    #   @return [::Object] result of last block execution
     # @overload each
     #   @return [Enumerator] an enumerator
     def each; end
@@ -52,7 +52,7 @@ module Wx
     #   @return [self]
     # @overload assign(value)
     #   Equality test operator.
-    #   @param value [Object]
+    #   @param value [::Object]
     #   @return [self]
     # @overload assign(value)
     #   Equality test operator.

data/lib/wx/doc/window.rb

@@ -44,13 +44,14 @@ module Wx
     # Creates a Wx::PaintDC when called from an evt_paint handler and a
     # Wx::ClientDC otherwise.
     # @yieldparam [Wx::PaintDC,Wx::ClientDC] dc dc to paint on
-    # @return [Object] result from block
+    # @return [::Object] result from block
     def paint; end
 
-    # Similar to #paint but this time creates a Wx::AutoBufferedPaintDC when called
+    # Similar to #paint but this time creates a buffered paint DC (which will be either a 'regular' Wx::PaintDC if
+    # the platform natively supports double buffering or a Wx::BufferedPaintDC otherwise) when called
     # from an evt_paint handler and a Wx::ClientDC otherwise.
-    # @yieldparam [Wx::AutoBufferedPaintDC,Wx::ClientDC] dc dc to paint on
-    # @return [Object] result from block
+    # @yieldparam [Wx::PaintDC,Wx::BufferedPaintDC,Wx::ClientDC] dc dc to paint on
+    # @return [::Object] result from block
     def paint_buffered; end
 
     # Yield each child window to the given block.

data/lib/wx/grid/keyword_defs.rb

@@ -13,5 +13,5 @@
 # wxGrid 	A grid (table) window
 Wx::define_keyword_ctors(Wx::GRID::Grid) do
   wx_ctor_params :id, :pos, :size, :style => Wx::WANTS_CHARS
-  wx_ctor_params :name => 'grid'
+  wx_ctor_params :name => Wx::GRID_NAME_STR
 end

data/lib/wx/html/keyword_defs.rb

@@ -13,16 +13,16 @@
 # wxHtmlWindow - Control for displaying HTML
 Wx::define_keyword_ctors(Wx::HTML::HtmlWindow) do
   wx_ctor_params :id, :pos, :size, :style => Wx::HTML::HW_DEFAULT_STYLE
-  wx_ctor_params :name => 'htmlWindow'
+  wx_ctor_params :name => Wx::HTML_WINDOW_NAME_STR
 end
 
 # wxHtmlListBox 	A listbox showing HTML content
 Wx::define_keyword_ctors(Wx::HTML::HtmlListBox) do
-  wx_ctor_params :id, :pos, :size, :style, :name => 'HtmlListBox'
+  wx_ctor_params :id, :pos, :size, :style, :name => Wx::HTML_LIST_BOX_NAME_STR
 end
 
 Wx::define_keyword_ctors(Wx::HTML::SimpleHtmlListBox) do
   wx_ctor_params :id, :pos, :size
   wx_ctor_params :choices => []
-  wx_ctor_params :style, :validator, :name => 'SimpleHtmlListBox'
+  wx_ctor_params :style, :validator, :name => Wx::SIMPLE_HTML_LIST_BOX_NAME_STR
 end