wxruby3 0.9.1 → 0.9.3

data/lib/wx/doc/app.rb

@@ -5,42 +5,52 @@
 # :startdoc:
 
 
-class Wx::App
-
-  # Set the menu item id for the About menu item.
-  # Default is {Wx::ID_ABOUT}
-  # @param [Integer] id
-  def set_mac_about_menu_itemid(id) end
-  alias :mac_about_menu_itemid= :set_mac_about_menu_itemid
-  
-  # Get the current menu item id for the About menu item.
-  # Default is {Wx::ID_ABOUT}
-  # @return [Integer]
-  def get_mac_about_menu_itemid(id) end
-  alias :mac_about_menu_itemid :get_mac_about_menu_itemid
-
-  # Set the menu item id for the Preferences menu item.
-  # Default is {Wx::ID_PREFERENCES}
-  # @param [Integer] id
-  def set_mac_preferences_menu_itemid(id) end
-  alias :mac_preferences_menu_itemid= :set_mac_preferences_menu_itemid
-
-  # Get the current menu item id for the Preferences menu item.
-  # Default is {Wx::ID_PREFERENCES}
-  # @return [Integer]
-  def get_mac_preferences_menu_itemid(id) end
-  alias :mac_preferences_menu_itemid :get_mac_preferences_menu_itemid
-
-  # Set the menu item id for the Exit menu item.
-  # Default is {Wx::ID_EXIT}
-  # @param [Integer] id
-  def set_mac_exit_menu_itemid(id) end
-  alias :mac_exit_menu_itemid= :set_mac_exit_menu_itemid
-
-  # Get the current menu item id for the Exit menu item.
-  # Default is {Wx::ID_EXIT}
-  # @return [Integer]
-  def get_mac_exit_menu_itemid(id) end
-  alias :mac_exit_menu_itemid :get_mac_exit_menu_itemid
-  
+module Wx
+
+  class App
+
+    # Set the menu item id for the About menu item.
+    # Default is {Wx::ID_ABOUT}
+    # @param [Integer] id
+    # @wxrb_require WXOSX
+    def set_mac_about_menu_itemid(id) end
+    alias :mac_about_menu_itemid= :set_mac_about_menu_itemid
+
+    # Get the current menu item id for the About menu item.
+    # Default is {Wx::ID_ABOUT}
+    # @return [Integer]
+    # @wxrb_require WXOSX
+    def get_mac_about_menu_itemid(id) end
+    alias :mac_about_menu_itemid :get_mac_about_menu_itemid
+
+    # Set the menu item id for the Preferences menu item.
+    # Default is {Wx::ID_PREFERENCES}
+    # @param [Integer] id
+    # @wxrb_require WXOSX
+    def set_mac_preferences_menu_itemid(id) end
+    alias :mac_preferences_menu_itemid= :set_mac_preferences_menu_itemid
+
+    # Get the current menu item id for the Preferences menu item.
+    # Default is {Wx::ID_PREFERENCES}
+    # @return [Integer]
+    # @wxrb_require WXOSX
+    def get_mac_preferences_menu_itemid(id) end
+    alias :mac_preferences_menu_itemid :get_mac_preferences_menu_itemid
+
+    # Set the menu item id for the Exit menu item.
+    # Default is {Wx::ID_EXIT}
+    # @param [Integer] id
+    # @wxrb_require WXOSX
+    def set_mac_exit_menu_itemid(id) end
+    alias :mac_exit_menu_itemid= :set_mac_exit_menu_itemid
+
+    # Get the current menu item id for the Exit menu item.
+    # Default is {Wx::ID_EXIT}
+    # @return [Integer]
+    # @wxrb_require WXOSX
+    def get_mac_exit_menu_itemid(id) end
+    alias :mac_exit_menu_itemid :get_mac_exit_menu_itemid
+
+  end
+
 end

data/lib/wx/doc/art_locator.rb

@@ -9,55 +9,60 @@
 # :startdoc:
 
 
-module Wx::ArtLocator
+module Wx
 
-  # Default name of art folder.
-  ART_FOLDER = 'art'
+  module ArtLocator
 
-  class << self
+    # Default name of art folder.
+    ART_FOLDER = 'art'
 
-    # Returns the base name for the folder holding application art files.
-    # By default this returns ART_FOLDER
-    # @return [String]
-    def art_folder; end
+    class << self
 
-    # Sets the base name for the folder holding application art files.
-    # @param [String] name art folder base name
-    def art_folder=(name) end
+      # Returns the base name for the folder holding application art files.
+      # By default this returns ART_FOLDER
+      # @return [String]
+      def art_folder; end
 
-    # Adds one or more search paths to look for art files.
-    # By default ArtLocator#find_art will look only at locations of the caller's
-    # file path. If search paths have been added though these will be searched
-    # after the lookup in the caller's path has failed.
-    def add_search_path(*names) end
-    alias :add_search_paths :add_search_path
+      # Sets the base name for the folder holding application art files.
+      # @param [String] name art folder base name
+      def art_folder=(name) end
 
-    # Searches for the an art file for the given 'art_name'.
-    # By default the search will be performed at the following locations (in order):
-    # 1. <art_path>/<#art_folder>/<art_section>/<art_type>/
-    # 2. <art_path>/<#art_folder>/<art_section>/
-    # 3. <art_path>/<#art_folder>/
-    # 4. <art_path>/
-    # Where 'art_type' is any of <code>:icon</code>, <code>:bitmap</code>, <code>:cursor</code>,
-    # <code>:image</code> or <code>nil</code>. If 'art_type' is nil the first location will be skipped.
-    # In case 'art_path' == <code>nil</code> the absolute path to the folder holding the caller's
-    # code will be used which is determined through ::Kernel#caller_locations.
-    # If 'art_section' is also <code>nil</code> the basename of the caller's source file will be used.
-    # At each location the existence of a file with base name 'art_name' and each of the supported
-    # extensions for the given 'art_type' (see wxWidgets documentation) will be tested. If 'art_type' is nil
-    # all extensions for all supported bitmap types will be tested (similar to when 'art_type' is :image).
-    # If an optional Wx::BitmapType is specified through 'bmp_type' the tested extensions will
-    # be restricted to the extensions supported for specified the bitmap type.
-    #
-    # In case additional search paths have been specified through #add_search_path these will be
-    # searched after the lookup at 'art_path' fails. For each search path the same lookups
-    # will be performed (replacing 'art_path' by the search path).
-    # @param [String,Symbol] art_name base name for art file
-    # @param [Symbol,nil] art_type type of art to look for (:icon, :bitmap, :cursor, :image)
-    # @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
-    # @param [Wx::BitmapType,nil] bmp_type bitmap type of art file
-    def find_art(art_name, art_type: nil, art_path: nil, art_section: nil, bmp_type: nil) end
+      # Adds one or more search paths to look for art files.
+      # By default ArtLocator#find_art will look only at locations of the caller's
+      # file path. If search paths have been added though these will be searched
+      # after the lookup in the caller's path has failed.
+      def add_search_path(*names) end
+      alias :add_search_paths :add_search_path
+
+      # Searches for the an art file for the given 'art_name'.
+      # By default the search will be performed at the following locations (in order):
+      # 1. <art_path>/<#art_folder>/<art_section>/<art_type>/
+      # 2. <art_path>/<#art_folder>/<art_section>/
+      # 3. <art_path>/<#art_folder>/
+      # 4. <art_path>/
+      # Where 'art_type' is any of <code>:icon</code>, <code>:bitmap</code>, <code>:cursor</code>,
+      # <code>:image</code> or <code>nil</code>. If 'art_type' is nil the first location will be skipped.
+      # In case 'art_path' == <code>nil</code> the absolute path to the folder holding the caller's
+      # code will be used which is determined through ::Kernel#caller_locations.
+      # If 'art_section' is also <code>nil</code> the basename of the caller's source file will be used.
+      # At each location the existence of a file with base name 'art_name' and each of the supported
+      # extensions for the given 'art_type' (see wxWidgets documentation) will be tested. If 'art_type' is nil
+      # all extensions for all supported bitmap types will be tested (similar to when 'art_type' is :image).
+      # If an optional Wx::BitmapType is specified through 'bmp_type' the tested extensions will
+      # be restricted to the extensions supported for specified the bitmap type.
+      #
+      # In case additional search paths have been specified through #add_search_path these will be
+      # searched after the lookup at 'art_path' fails. For each search path the same lookups
+      # will be performed (replacing 'art_path' by the search path).
+      # @param [String,Symbol] art_name base name for art file
+      # @param [Symbol,nil] art_type type of art to look for (:icon, :bitmap, :cursor, :image)
+      # @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
+      # @param [Wx::BitmapType,nil] bmp_type bitmap type of art file
+      # @return [String,nil] full path of art file or nil if not found
+      def find_art(art_name, art_type: nil, art_path: nil, art_section: nil, bmp_type: nil) end
+
+    end
 
   end
 

data/lib/wx/doc/aui/auimanager.rb

@@ -5,14 +5,22 @@
 # :startdoc:
 
 
-class Wx::AUI::AuiManager
+module Wx
 
-  # Yield each pane to the given block.
-  # @yieldparam [Wx::AUI::AuiPaneInfo] pane the Aui pane info yielded
-  def each_pane; end
+  module AUI
+
+    class AuiManager
+
+      # Yield each pane to the given block.
+      # @yieldparam [Wx::AUI::AuiPaneInfo] pane the Aui pane info yielded
+      def each_pane; end
+
+      # Returns an array of all panes managed by the frame manager.
+      # @return [Array<Wx::AUI::AuiPaneInfo>] all managed panes
+      def get_all_panes; end
+      alias_method :all_panes, :get_all_panes
+    end
+
+  end
 
-  # Returns an array of all panes managed by the frame manager.
-  # @return [Array<Wx::AUI::AuiPaneInfo>] all managed panes
-  def get_all_panes; end
-  alias_method :all_panes, :get_all_panes
 end

data/lib/wx/doc/aui/auinotebook.rb

@@ -5,11 +5,26 @@
 # :startdoc:
 
 
-class Wx::AUI::AuiNotebook
+module Wx
 
-  # Finds tab control and its tab index associated with a given window.
-  # @param [Wx::Window] page the notebook page window
-  # @return [Array<Wx::AUI::AuiTabCtrl, Integer>, nil] tab control and index if found else nil
-  def find_tab(page) end
+  module AUI
+
+    class AuiNotebook
+
+      # Iterate each notebook page.
+      # Passes each page to the given block.
+      # Returns an Enumerator if no block given.
+      # @yieldparam [Wx::Window] page notebook page
+      # @return [Object,Enumerator] last result of block or Enumerator if no block given.
+      def each_page; end
+
+      # Finds tab control and its tab index associated with a given window.
+      # @param [Wx::Window] page the notebook page window
+      # @return [Array<Wx::AUI::AuiTabCtrl, Integer>, nil] tab control and index if found else nil
+      def find_tab(page) end
+
+    end
+
+  end
 
 end

data/lib/wx/doc/clipboard.rb

@@ -5,14 +5,18 @@
 # :startdoc:
 
 
-class Wx::Clipboard
+module Wx
 
-  alias :place :set_data
-  alias :fetch :get_data
+  class Clipboard
 
-  # Opens the global clipboard and passes the clipboard object to the block.
-  # @yieldparam [Wx::Clipboard] clip the global clipboard object
-  # @return [Object] block result
-  def self.open; end
+    alias :place :set_data
+    alias :fetch :get_data
+
+    # Opens the global clipboard and passes the clipboard object to the block.
+    # @yieldparam [Wx::Clipboard] clip the global clipboard object
+    # @return [Object] block result
+    def self.open; end
+
+  end
 
 end

data/lib/wx/doc/colour_dialog.rb

@@ -5,17 +5,21 @@
 # :startdoc:
 
 
-class Wx::ColourDialog
+module Wx
 
-  # Returns (a copy of) the colour data of the dialog.
-  # @return [Wx::ColourData] colour data copy
-  def get_colour_data; end
-  alias :colour_data :get_colour_data
+  class ColourDialog
 
-  # Updates the colour data for the dialog.
-  # @param [Wx::ColourData] clr_data the colour data to update the dialog with
-  # @return [void]
-  def set_colour_data(clr_data); end
-  alias :colour_data= :set_colour_data
+    # Returns (a copy of) the colour data of the dialog.
+    # @return [Wx::ColourData] colour data copy
+    def get_colour_data; end
+    alias :colour_data :get_colour_data
+
+    # Updates the colour data for the dialog.
+    # @param [Wx::ColourData] clr_data the colour data to update the dialog with
+    # @return [void]
+    def set_colour_data(clr_data); end
+    alias :colour_data= :set_colour_data
+
+  end
 
 end

data/lib/wx/doc/comboctrl.rb

@@ -0,0 +1,18 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
+
+module Wx
+
+  class OwnerDrawnComboBox < ComboCtrl
+
+    alias :get_item_data :get_client_object
+
+    alias :set_item_data :set_client_object
+
+  end
+
+end

data/lib/wx/doc/controlwithitems.rb

@@ -5,13 +5,39 @@
 # :startdoc:
 
 
-class Wx::ControlWithItems
-
-  # Returns true if the items in the control are sorted
-  # (style Wx::LB_SORT for list boxes or Wx::CB_SORT for combo boxes).
-  # This method is mostly meant for internal use only.
-  # @return [Boolean] true is sorted, false otherwise
-  def is_sorted; end
-  alias :sorted? :is_sorted
+module Wx
+
+  class ControlWithItems
+
+    alias :get_client_data :get_client_object
+
+    alias :set_client_data :set_client_object
+
+    alias :has_client_data :has_client_object_data
+
+    alias :has_client_data? :has_client_object_data
+
+    # Yield each string to the given block.
+    # Returns an Enumerator if no block given.
+    # @yieldparam [String] string the string yielded
+    # @return [Object,Enumerator] last result of block or Enumerator if no block given.
+    def each_string; end
+
+    # Returns true if the items in the control are sorted
+    # (style Wx::LB_SORT for list boxes or Wx::CB_SORT for combo boxes).
+    # This method is mostly meant for internal use only.
+    # @return [Boolean] true is sorted, false otherwise
+    def is_sorted; end
+    alias :sorted? :is_sorted
+
+    alias :get_list_selection :get_selection
+
+    alias :set_list_selection :set_selection
+
+    alias :get_list_string_selection :get_string_selection
+
+    alias :set_list_string_selection :set_string_selection
+
+  end
 
 end

data/lib/wx/doc/data_object.rb

@@ -27,7 +27,7 @@ module Wx
   # so the number of virtual functions to be implemented is reduced.
   # This class is the base class for {Wx::TextDataObject}, {Wx::FileDataObject}, {Wx::BitmapDataObject},
   # {Wx::wxCustomDataObject} and others.
-  # ===
+  #
   #
   # Category:  Clipboard and Drag & Drop
   # @see Drag and Drop Overview
@@ -74,7 +74,7 @@ module Wx
   # The objects which may be set must override {Wx::DataObjectSimpleBase#_set_data} (which
   # returns <code>false</code>).
   # Of course, the objects supporting both operations must override all three methods.
-  # ===
+  #
   #
   # Category:  Clipboard and Drag & Drop
   # @see Drag and Drop Overview

data/lib/wx/doc/date_picker_ctrl.rb

@@ -0,0 +1,23 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
+
+module Wx
+
+  class DatePickerCtrl < Control
+
+    # If the control had been previously limited to a range of dates using #set_range, returns the lower and upper bounds of this range.
+    #
+    # If no range is set (or only one of the bounds is set), dt1 and/or dt2 are set to be invalid.
+    #
+    # Notice that when using a native MSW implementation of this control the lower range is always set, even
+    # if #set_range hadn't been called explicitly, as the native control only supports dates later than year 1601.
+    # @return [Array(Time, Time),nil] a set with the lower and upper range limit or nil if no range previously set
+    def get_range; end
+
+  end
+
+end

data/lib/wx/doc/editable_listbox.rb

@@ -0,0 +1,44 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
+
+module Wx
+
+  class EditableListBox < Panel
+
+    # Returns list control of composite.
+    # @return [Wx::ListCtrl]
+    def get_list_ctrl; end
+    alias :list_ctrl :get_list_ctrl
+
+    # Returns button of composite.
+    # @return [Wx::BitmapButton]
+    def get_del_button; end
+    alias :del_button :get_del_button
+
+    # Returns button of composite.
+    # @return [Wx::BitmapButton]
+    def get_new_button; end
+    alias :new_button :get_new_button
+
+    # Returns button of composite.
+    # @return [Wx::BitmapButton]
+    def get_up_button; end
+    alias :up_button :get_up_button
+
+    # Returns button of composite.
+    # @return [Wx::BitmapButton]
+    def get_down_button; end
+    alias :down_button :get_down_button
+
+    # Returns button of composite.
+    # @return [Wx::BitmapButton]
+    def get_edit_button; end
+    alias :edit_button :get_edit_button
+
+  end
+
+end

data/lib/wx/doc/enum.rb

@@ -68,6 +68,21 @@ module Wx
     # @return [Boolean]
     def !; end
 
+    # Returns true if all bits that are set (=1) in mask are also set in self; returns false otherwise.
+    # @param [Integer] mask
+    # @return [Boolean]
+    def allbits?(mask) end
+
+    # Returns true if any bit that is set (=1) in mask is also set in self; returns false otherwise.
+    # @param [Integer] mask
+    # @return [Boolean]
+    def anybits?(mask) end
+
+    # Returns true if no bit that is set (=1) in mask is also set in self; returns false otherwise.
+    # @param [Integer] mask
+    # @return [Boolean]
+    def nobits?(mask) end
+
     # Return next integer value from enum's value.
     # @return [Integer] next integer value
     def succ; end

data/lib/wx/doc/event.rb

@@ -27,4 +27,16 @@ module Wx
 
   end
 
+  class CommandEvent < Event
+
+    alias :set_client_data :set_client_object
+
+    alias :client_data= :set_client_object
+
+    alias :get_client_data :get_client_object
+
+    alias :client_data :get_client_object
+
+  end
+
 end