wxruby3 0.9.0 → 0.9.2

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,59 @@
 # :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
+      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/const.rb

@@ -11,74 +11,74 @@ module Wx
   These constants are not documented in the wxWidgets interface headers
   although they are referenced in various argument defaults which *are*
   in the interface header declarations so we do want them included the
-  wxRuby docs so the doc links work but we do not need them in the
-  wxRuby implementation since these are internal to the C++ wrappers.
+  wxRuby docs so the doc links work.
 =end
 
-  DefaultDateTimeFormat = '%c'
-  DefaultTimeSpanFormat = '%H:%M:%S'
+  DEFAULT_DATE_TIME_FORMAT = '%c'
+  DEFAULT_TIME_SPAN_FORMAT = '%H:%M:%S'
 
-  ChoiceNameStr = 'choice'
-  ColourPickerCtrlNameStr = 'colourpicker'
-  ColourPickerWidgetNameStr = 'colourpickerwidget'
-  HyperlinkCtrlNameStr = 'hyperlink'
-  PanelNameStr = 'panel'
-  ListBoxNameStr = 'listBox'
-  FrameNameStr = 'frame'
-  StatusLineNameStr = 'status_line'
-  StaticBitmapNameStr = 'staticBitmap'
-  WebViewNameStr = 'wxWebView'
-  AnimationCtrlNameStr = 'animationctrl'
-  ToolBarNameStr = 'toolbar'
-  TextCtrlNameStr = 'text'
-  ListCtrlNameStr = 'listCtrl'
-  FilePickerCtrlNameStr = 'filepicker'
-  FilePickerWidgetNameStr = 'filepickerwidget'
-  DirPickerCtrlNameStr = 'dirpicker'
-  DirPickerWidgetNameStr = 'dirpickerwidget'
-  FileCtrlNameStr = 'wxfilectrl'
-  StaticBoxNameStr = 'groupBox'
-  ButtonNameStr = 'button'
-  RadioBoxNameStr = 'radioBox'
-  StaticLineNameStr = 'staticLine'
-  RadioButtonNameStr = 'radioButton'
-  BitmapRadioButtonNameStr = 'radioButton'
-  GaugeNameStr = 'gauge'
-  DataViewCtrlNameStr = 'dataviewCtrl'
-  FontPickerCtrlNameStr = 'fontpicker'
-  FontPickerWidgetNameStr = 'fontpickerwidget'
-  RearrangeListNameStr = 'wxRearrangeList'
-  RearrangeDialogNameStr = 'wxRearrangeDlg'
-  NotebookNameStr = 'notebook'
-  ControlNameStr = 'control'
-  ScrollBarNameStr = 'scrollBar'
-  StatusBarNameStr = 'statusBar'
-  SliderNameStr = 'slider'
-  HeaderCtrlNameStr = 'wxHeaderCtrl'
-  BitmapComboBoxNameStr = 'bitmapComboBox'
-  CheckBoxNameStr = 'check'
-  FileDialogNameStr = 'filedlg'
-  AddRemoveCtrlNameStr = 'wxAddRemoveCtrl'
-  StaticTextNameStr = 'staticText'
-  ComboBoxNameStr = 'comboBox'
-  SearchCtrlNameStr = 'searchCtrl'
-  DirDialogNameStr = 'wxDirCtrl'
-  TreeCtrlNameStr = 'treeCtrl'
-  DialogNameStr = 'dialog'
-  CollapsibleHeaderCtrlNameStr = 'collapsibleHeader'
-  CollapsiblePaneNameStr = 'collapsiblePane'
-  BannerWindowNameStr = 'bannerwindow'
-  GridNameStr = 'grid'
-  TreeListCtrlNameStr = 'wxTreeListCtrl'
-  HtmlListBoxNameStr = 'htmlListBox'
-  SimpleHtmlListBoxNameStr = 'simpleHtmlListBox'
-  EditableListBoxNameStr = 'editableListBox'
-  VListBoxNameStr = 'wxVListBox'
-  CollapsiblePaneNameStr = 'collapsiblePane'
-  MSWHeaderCtrlNameStr = 'wxMSWHeaderCtrl'
-  PropertyGridManagerNameStr = 'wxPropertyGridManager'
-  PropertyGridNameStr = 'wxPropertyGrid'
-  STCNameStr = 'stcwindow'
-  STCNameStr = 'stcwindow'
+  CHOICE_NAME_STR = 'choice'
+  COLOUR_PICKER_CTRL_NAME_STR = 'colourpicker'
+  COLOUR_PICKER_WIDGET_NAME_STR = 'colourpickerwidget'
+  HYPERLINK_CTRL_NAME_STR = 'hyperlink'
+  PANEL_NAME_STR = 'panel'
+  LIST_BOX_NAME_STR = 'listBox'
+  FRAME_NAME_STR = 'frame'
+  STATUS_LINE_NAME_STR = 'status_line'
+  STATIC_BITMAP_NAME_STR = 'staticBitmap'
+  WEB_VIEW_NAME_STR = 'wxWebView'
+  ANIMATION_CTRL_NAME_STR = 'animationctrl'
+  TOOL_BAR_NAME_STR = 'toolbar'
+  TEXT_CTRL_NAME_STR = 'text'
+  LIST_CTRL_NAME_STR = 'listCtrl'
+  FILE_PICKER_CTRL_NAME_STR = 'filepicker'
+  FILE_PICKER_WIDGET_NAME_STR = 'filepickerwidget'
+  DIR_PICKER_CTRL_NAME_STR = 'dirpicker'
+  DIR_PICKER_WIDGET_NAME_STR = 'dirpickerwidget'
+  FILE_CTRL_NAME_STR = 'wxfilectrl'
+  FILE_SELECTOR_PROMPT_STR = 'Select a file'
+  STATIC_BOX_NAME_STR = 'groupBox'
+  BUTTON_NAME_STR = 'button'
+  RADIO_BOX_NAME_STR = 'radioBox'
+  STATIC_LINE_NAME_STR = 'staticLine'
+  RADIO_BUTTON_NAME_STR = 'radioButton'
+  BITMAP_RADIO_BUTTON_NAME_STR = 'radioButton'
+  GAUGE_NAME_STR = 'gauge'
+  DATA_VIEW_CTRL_NAME_STR = 'dataviewCtrl'
+  FONT_PICKER_CTRL_NAME_STR = 'fontpicker'
+  FONT_PICKER_WIDGET_NAME_STR = 'fontpickerwidget'
+  REARRANGE_LIST_NAME_STR = 'wxRearrangeList'
+  REARRANGE_DIALOG_NAME_STR = 'wxRearrangeDlg'
+  NOTEBOOK_NAME_STR = 'notebook'
+  CONTROL_NAME_STR = 'control'
+  SCROLL_BAR_NAME_STR = 'scrollBar'
+  STATUS_BAR_NAME_STR = 'statusBar'
+  SLIDER_NAME_STR = 'slider'
+  HEADER_CTRL_NAME_STR = 'wxHeaderCtrl'
+  BITMAP_COMBO_BOX_NAME_STR = 'bitmapComboBox'
+  CHECK_BOX_NAME_STR = 'check'
+  FILE_DIALOG_NAME_STR = 'filedlg'
+  ADD_REMOVE_CTRL_NAME_STR = 'wxAddRemoveCtrl'
+  STATIC_TEXT_NAME_STR = 'staticText'
+  COMBO_BOX_NAME_STR = 'comboBox'
+  SEARCH_CTRL_NAME_STR = 'searchCtrl'
+  TREE_CTRL_NAME_STR = 'treeCtrl'
+  DIALOG_NAME_STR = 'dialog'
+  COLLAPSIBLE_HEADER_CTRL_NAME_STR = 'collapsibleHeader'
+  COLLAPSIBLE_PANE_NAME_STR = 'collapsiblePane'
+  BANNER_WINDOW_NAME_STR = 'bannerwindow'
+  GRID_NAME_STR = 'grid'
+  TREE_LIST_CTRL_NAME_STR = 'wxTreeListCtrl'
+  HTML_LIST_BOX_NAME_STR = 'htmlListBox'
+  SIMPLE_HTML_LIST_BOX_NAME_STR = 'simpleHtmlListBox'
+  EDITABLE_LIST_BOX_NAME_STR = 'editableListBox'
+  V_LIST_BOX_NAME_STR = 'wxVListBox'
+
+  # wxMSW only
+  MSW_HEADER_CTRL_NAME_STR = 'wxMSWHeaderCtrl'
+
+  PROPERTY_GRID_MANAGER_NAME_STR = 'wxPropertyGridManager'
+  PROPERTY_GRID_NAME_STR = 'wxPropertyGrid'
+  STC_NAME_STR = 'stcwindow'
 
 end

data/lib/wx/doc/controlwithitems.rb

@@ -5,13 +5,23 @@
 # :startdoc:
 
 
-class Wx::ControlWithItems
+module Wx
 
-  # 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
+  class ControlWithItems
+
+    # 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
+
+  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/event.rb

@@ -27,10 +27,4 @@ module Wx
 
   end
 
-  # Find a window with the focus, that is also a descendant of the given window.
-  # This is used to determine the window to initially send commands to.
-  # @param [Wx::Window] ancestor
-  # @return [Wx::Window,nil] descendant window of ancestor with focus
-  def self.find_focus_descendant(ancestor) end
-
 end