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

data/lib/wx/core/menu.rb

@@ -75,4 +75,9 @@ class Wx::Menu
   methods_with_optional_ids_and_pos :insert,
                                     :insert_check_item,
                                     :insert_radio_item
+
+  # wxRuby2 backward compatibility version; no alias as #append has been altered above
+  def append_item(*args)
+    append(*args)
+  end
 end

data/lib/wx/core/pen.rb

@@ -0,0 +1,6 @@
+
+module Wx
+
+  ThePenList = Wx::Pen
+
+end

data/lib/wx/core/window.rb

@@ -1,5 +1,6 @@
 # Copyright 2004-2007 by Kevin Smith
-# released under the MIT-style wxruby2 license
+# Copyright 2022 by Martin Corino
+# released under the MIT(-style) wxruby2/3 license
 
 # The base class for all things displayed on screen
 class Wx::Window
@@ -69,4 +70,30 @@ class Wx::Window
       self.paint(&block)
     end
   end
+
+  # implement non-static variants of these
+
+  def from_dip(*args)
+    Wx::Window.from_dip(*args, self)
+  end
+  def to_dip(*args)
+    Wx::Window.to_dip(*args, self)
+  end
+
+  def from_phys(*args)
+    Wx::Window.from_phys(*args, self)
+  end
+  def to_phys(*args)
+    Wx::Window.to_phys(*args, self)
+  end
+
+  # implement Window update locker
+  def locked(&block)
+    self.freeze
+    begin
+      block.call if block_given?
+    ensure
+      self.thaw
+    end
+  end
 end

data/lib/wx/doc/app.rb

@@ -0,0 +1,40 @@
+
+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
+  
+end

data/lib/wx/doc/bitmap.rb

@@ -8,20 +8,16 @@ module Wx
   # Default BitmapType for current platform. Actual value is platform dependent.
   CURSOR_DEFAULT_TYPE = Wx::BitmapType::BITMAP_TYPE_ANY
 
-  class Bitmap
-
-    # Searches for an art file with basename 'name' and creates a Bitmap 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)
-    # @return [Wx::Bitmap]
-    # @see Wx::ArtLocator::find_art
-    def self.Bitmap(name, bmp_type = nil); end
-
-  end
+  # Searches for an art file with basename 'name' and creates a Bitmap 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)
+  # @return [Wx::Bitmap]
+  # @see Wx::ArtLocator::find_art
+  def self.Bitmap(name, bmp_type = nil); end
 
 end

data/lib/wx/doc/brush.rb

@@ -0,0 +1,17 @@
+
+module Wx
+
+  class Brush
+
+    # Finds a brush with the specified attributes in the global list and returns it, else creates a new brush, adds it to the global brush list, and returns it.
+    # @param [Wx::Colour,String,Symbol] colour The Brush colour.
+    # @param [Wx::BrushStyle] style The brush style. See {Wx::BrushStyle} for a list of the styles.
+    # @return [Wx::Brush]
+    def self.find_or_create_brush(colour, style=Wx::BrushStyle::BRUSHSTYLE_SOLID) end
+
+  end
+
+  # In wxRuby this is simply an alias for the Brush class.
+  TheBrushList = Wx::Brush
+
+end

data/lib/wx/doc/event_loop.rb

@@ -0,0 +1,7 @@
+
+module Wx
+
+  # In wxRuby simply an alias for GUIEventLoop.
+  EventLoop = GUIEventLoop
+
+end

data/lib/wx/doc/extra/00_starting.md

@@ -18,9 +18,9 @@ is available for anyone to look at and use in any way they like. Also, anyone ca
 and enhancements to the project.
 
 Like wxWidgets wxRuby is a cross platform toolkit. This means that the same program will run on multiple platforms 
-without modification. Currently Supported platforms are Microsoft Windows and Linux or other 
-unix-like systems with GTK2 or GTK3 libraries. As wxWidgets also has stable releases for Mac OSX and Linux QT platforms
-it should not be to hard to support these. Contributions to achieve this are appreciated.
+without modification. Currently Supported platforms are Microsoft Windows, MacOSX and Linux or other 
+unix-like systems with GTK2 or GTK3 libraries. Contributions to achieve support for other wxWidgets supported platforms
+are appreciated.
 
 Since the programming language is Ruby, wxRuby programs are simple and easy to write and understand. To accomplish the
 full Ruby experience wxRuby has not ported the wxWidgets API 1 on 1 to Ruby but has made an effort to make the wxRuby
@@ -75,7 +75,7 @@ require 'wx'
 Wx::App.run { puts 'Hello world!' }
 ```
 
-As you can there is no obligation to create an instance of the Wx::App class in wxRuby for
+As you can see there is no obligation to create an instance of the Wx::App class in wxRuby for
 (admittedly extremely) simple applications. Calling the #run class method with a block will suffice.<br>
 The class method will create an instance of the generic Wx::App class under the hood and use the 
 provided block as the #on_init callback. As the code inside the block returns a false-type value (#puts 
@@ -127,8 +127,8 @@ When creating #on_init/#on_exit methods it is important to understand that those
 with wxWidgets itself). The base Wx::App class actually does not define these methods so it's also not needed (even not possible)
 to call `super` in the implementation. The wxRuby application class implementation will call the wxWidget OnInit base implementation
 itself and after successful completion check for the existence of an #on_init method (which could also be 'automagicallly'
-created from a block passed to #run) and call that if available or terminate the application if not. For the
-exit sequence to executions are similar but reversed (first a possible #on_exit method and than the wxWidgets base OnExit).
+created from a block passed to #run) and call that if available or terminate the application if not. The
+exit sequence of executions are similar but reversed (first a possible #on_exit method and than the wxWidgets base OnExit).
 
 What remains though is that for a derived application class it is still not necessary to explicitly create a class instance.
 Simply calling the #run class method will suffice.

data/lib/wx/doc/extra/02_lifecycles.md

@@ -76,7 +76,7 @@ As mentioned above the wxWidgets GUI framework resources will only be fully init
 starts. Likewise the framework resources will be de-initialized (deleted) after `#on_exit` method ends which means that 
 your application should not attempt to access any of these resources (windows, fonts, colours etc.) after that moment.
 
-Also, largely because of the way the wxWidgets framework is designed but also because of that way this meshes with Ruby 
+Also, largely because of the way the wxWidgets framework is designed but also because of the way this meshes with Ruby 
 GC, there is no safe way to re-initialize the framework after an application instance ends it run. This means you 
 **cannot** safely attempt to start another application instance after a previous (first) one has ended. 
 
@@ -120,7 +120,7 @@ therefor provides special support to ease handling the destruction of these. See
 One of the trickier things to handle correctly in the kind of native extensions like wxRuby is maintaining object 
 identities i.e. keeping native instances synced with their Ruby wrapper counter parts.
 
-Whenever a native extension is allowed to call back into Ruby space we encounter the problem the we need to map any 
+Whenever a native extension is allowed to call back into Ruby space we encounter the problem that we need to map any 
 native object data provided for the call to the right Ruby types and when necessary to the right Ruby instance (object
 identity).
 
@@ -131,8 +131,8 @@ passing them on to Ruby space.
 For a lot of other objects though it is essential to not only map to the right **most derived** class type but also to
 the exact Ruby instance which was originally instantiated as wrapper for the native object if any exists (in case no
 Ruby instance existed yet a new instance of the correct **most derived** class should be instantiated at that point). 
-The reason this is important is 1. because the Ruby instance may have been used to identify, link to or otherwise 
-reference other data and/or functionality related to that specific Ruby/native pair and 2. the Ruby instance could 
+The reason this is important is **1.** because the Ruby instance may have been used to identify, link to or otherwise 
+reference other data and/or functionality related to that specific Ruby/native pair and **2.** the Ruby instance could 
 contain data elements (instance variables) related to that specific Ruby/native pair.<br>
 In the case of wxRuby Window instance for example it is common to derive custom Window classes with custom behaviour and
 corresponding instance variables that drive that behaviour. When an event handler or an overloaded native method is passed
@@ -155,11 +155,12 @@ There are however quite a lot of wrapped native objects in wxRuby for which *obj
 object tracking has been disabled for their classes. This means these kind of classes/object should **not** be derived from
 (if even possible and/or useful) to add functionality/information or their identity used as key to link other information.<br>
 These classes include:
-- classes considered POD types like Wx::Size, Wx::Point, Wx::RealPoint, Wx::Rect, Wx::GBSpan, Wx::GBPosition, Wx::BusyInfoFlags,
+* classes considered POD types like Wx::Size, Wx::Point, Wx::RealPoint, Wx::Rect, Wx::GBSpan, Wx::GBPosition, Wx::BusyInfoFlags,
 Wx::AboutDialogInfo
-- final non-instantiatable classes like the Wx::DC (Device Context) class family, Wx::GraphicsContext, Wx::WindowsDisabler,
+* final non-instantiatable classes like the Wx::DC (Device Context) class family, Wx::GraphicsContext, Wx::WindowsDisabler,
 Wx::EventBlocker, Wx::BusyInfo
-- classes with native singleton objects like Wx::Clipboard
-- the reference counted GDI objects like Wx::Pen, Wx::Brush, Wx::Colour, Wx::Cursor, Wx::Bitmap, Wx::Icon
+* classes with native singleton objects like Wx::Clipboard
+* the reference counted GDI objects like Wx::Pen, Wx::Brush, Wx::Colour, Wx::Cursor, Wx::Bitmap, Wx::Icon and similar 
+reference counted objects like Wx::Font
 
 The reference documentation will note untracked object classes.

data/lib/wx/doc/extra/09_exceptions.md

@@ -15,7 +15,7 @@ your own Ruby application code.
 
 Any exceptions raised from wxRuby wrapper code signal coding errors that need to be rectified.
 
-As far as handling application code exceptions is concerned the same advice applies as for wxWidgets itself; do **not**
+As far as handling application code exceptions is concerned the same advice applies as for wxWidgets itself; do **NOT**
 let exceptions escape your event handlers meaning that if you can reasonably expect application code to raise exceptions
 you should make sure to catch any such exceptions within the context of the event handler like:
 

data/lib/wx/doc/extra/11_drawing_and_dc.md

@@ -12,9 +12,9 @@ device context object is destroyed.
 For this reason the common practice in wxWidgets C++ code would be to create temporary DC objects on the
 stack and draw on them while they are in scope (for several classes it is even strongly advised to never create
 them any other way and to never keep objects alive out of scope). When leaving the scope these object would than be 
-automatically destroyed and the any buffered output flushed to the final target.
+automatically destroyed and any buffered output flushed to the final target.
 
-In Ruby this approach is impossible as Ruby is a purely dynamic language and does not **this kind** of scope bound
+In Ruby this approach is impossible as Ruby is a purely dynamic language and does not support **this kind** of scope bound
 life cycles. Any DC object created would have to be dynamically created and due to the properties of the GC driven
 life cycles could well be kept alive beyond the scope of it's creation. This will not always cause problems but could
 and does not really have an upside.
@@ -24,7 +24,7 @@ cannot be instantiated using `new`. Rather all `Wx::DC` derived classes provide
 temporary dc objects that will be passed on to blocks given and will only exist for the duration of the execution of
 the block. This will guarantee proper DC cleanup when leaving it's usage scope.
 
-> Note that it is a **BAD** idea to think about storing the dc reference provide to the block for later access!
+> Note that it is a **BAD** idea to think about storing the dc reference provided to the block for later access!
 
 A typical usage of a `::draw_on` method would be:
 
@@ -48,7 +48,7 @@ The `Wx::PaintDC` and `Wx::AutoBufferedPaintDC` classes provide `::draw_on` meth
 this is mostly to be consistent.
 
 In this case it is recommended to instead use the `Wx::Window#paint` or `Wx::Window#paint_buffered` methods as these
-provide some optimizations with regard to automatically detecting is the methods are called inside `Wx::EVT_PAINT` 
+provide some optimizations with regard to automatically detecting if the methods are called inside `Wx::EVT_PAINT` 
 handlers (which should normally be the case) or not.
 
 So the typical way to do buffered painting inside a windows `Wx::EVT_PAINT` handler would be something like:

data/lib/wx/doc/font.rb

@@ -0,0 +1,27 @@
+
+module Wx
+  class Font
+
+    # @overload find_or_create_font(point_size, family, style, weight, underline=false, facename='', encoding=Wx::FontEncoding::FONTENCODING_DEFAULT)
+    #   Finds a font of the given specification in the global font list, or creates one and adds it to the list.
+    #   @param [Integer] point_size Size in points. See {Wx::Font#set_point_size} for more info.
+    #   @param [Wx::FontFamily] family The font family: a generic portable way of referring to fonts without specifying a facename.
+    #   @param [Wx::FontStyle] style One of {Wx::FontStyle::FONTSTYLE_NORMAL}, {Wx::FontStyle::FONTSTYLE_SLANT} and {Wx::FontStyle::FONTSTYLE_ITALIC}.
+    #   @param [Wx::FontWeight] weight Font weight, sometimes also referred to as font boldness. One of the {Wx::FontWeight} enumeration values.
+    #   @param [Boolean] underline The value can be true or false.
+    #   @param [String] facename An optional string specifying the face name to be used. If it is an empty string, a default face name will be chosen based on the family.
+    #   @param [Wx::FontEncoding] encoding An encoding which may be one of the enumeration values of {Wx::FontEncoding}. If the specified encoding isn't available, no font is created (see also Font Encodings).
+    #   @return [Wx::Font]
+    #   @see Wx::Font#initialize
+    # @overload find_or_create_font(font_info)
+    #   Finds a font of the given specification in the global font list, or creates one and adds it to the list.
+    #   @param [Wx::FontInfo] font_info
+    #   @return [Wx::Font]
+    def self.find_or_create_font(*args) end
+
+  end
+
+  # In wxRuby this is simply an alias for the Font class.
+  TheFontList = Font
+
+end

data/lib/wx/doc/functions.rb

@@ -11,32 +11,73 @@ module Wx
   # @param lvl  [Integer] logging level (like {Wx::LOG_Message})
   # @param fmt  [String]  message (formatting) string
   # @param args [Array<Object>] optional message arguments
-  # @return [nil]
-  def self.log_generic(lvl, fmt, *args) end
+  # @param filename [String] optional file name for log info
+  # @param line [Integer] optional line number for log info
+  # @param func [String] optional function name for log info
+  # @param component [String] optional component name for log info
+  # @return [void]
+  def self.log_generic(lvl, fmt, *args, filename: nil, line: 0, func: nil, component: nil) end
 
   # Log a Wx low priority informational message to the current Wx log output
   # @param fmt  [String]  message (formatting) string
   # @param args [Array<Object>] optional message arguments
-  # @return [nil]
-  def self.log_info(fmt, *args) end
+  # @param filename [String] optional file name for log info
+  # @param line [Integer] optional line number for log info
+  # @param func [String] optional function name for log info
+  # @param component [String] optional component name for log info
+  # @return [void]
+  def self.log_info(fmt, *args, filename: nil, line: 0, func: nil, component: nil) end
 
   # Log a Wx Informational message to the current Wx log output
   # @param fmt  [String]  message (formatting) string
   # @param args [Array<Object>] optional message arguments
-  # @return [nil]
-  def self.log_message(fmt, *args) end
+  # @param filename [String] optional file name for log info
+  # @param line [Integer] optional line number for log info
+  # @param func [String] optional function name for log info
+  # @param component [String] optional component name for log info
+  # @return [void]
+  def self.log_message(fmt, *args, filename: nil, line: 0, func: nil, component: nil) end
 
   # Log a Wx Error message to the current Wx log output
   # @param fmt  [String]  message (formatting) string
   # @param args [Array<Object>] optional message arguments
-  # @return [nil]
-  def self.log_error(fmt, *args) end
+  # @param filename [String] optional file name for log info
+  # @param line [Integer] optional line number for log info
+  # @param func [String] optional function name for log info
+  # @param component [String] optional component name for log info
+  # @return [void]
+  def self.log_error(fmt, *args, filename: nil, line: 0, func: nil, component: nil) end
 
   # Log a Wx Warning message to the current Wx log output
   # @param fmt  [String]  message (formatting) string
   # @param args [Array<Object>] optional message arguments
-  # @return [nil]
-  def self.log_warning(fmt, *args) end
+  # @param filename [String] optional file name for log info
+  # @param line [Integer] optional line number for log info
+  # @param func [String] optional function name for log info
+  # @param component [String] optional component name for log info
+  # @return [void]
+  def self.log_warning(fmt, *args, filename: nil, line: 0, func: nil, component: nil) end
+
+  # Log a Wx verbose informational message to the current Wx log output
+  # (needs explicit activation to be shown)
+  # @param fmt  [String]  message (formatting) string
+  # @param args [Array<Object>] optional message arguments
+  # @param filename [String] optional file name for log info
+  # @param line [Integer] optional line number for log info
+  # @param func [String] optional function name for log info
+  # @param component [String] optional component name for log info
+  # @return [void]
+  def self.log_verbose(fmt, *args, filename: nil, line: 0, func: nil, component: nil) end
+
+  # Log a Wx debug message to the current Wx log output
+  # @param fmt  [String]  message (formatting) string
+  # @param args [Array<Object>] optional message arguments
+  # @param filename [String] optional file name for log info
+  # @param line [Integer] optional line number for log info
+  # @param func [String] optional function name for log info
+  # @param component [String] optional component name for log info
+  # @return [void]
+  def self.log_debug(fmt, *args, filename: nil, line: 0, func: nil, component: nil) end
 
   # Log a Wx Status message - this is directed to the status bar of the
   # specified Frame window, or the application main window if not specified.
@@ -51,19 +92,6 @@ module Wx
   # @return [nil]
   def self.log_status(fmt, *args) end
 
-  # Log a Wx verbose informational message to the current Wx log output
-  # (needs explicit activation to be shown)
-  # @param fmt  [String]  message (formatting) string
-  # @param args [Array<Object>] optional message arguments
-  # @return [nil]
-  def self.log_verbose(fmt, *args) end
-
-  # Log a Wx debug message to the current Wx log output
-  # @param fmt  [String]  message (formatting) string
-  # @param args [Array<Object>] optional message arguments
-  # @return [nil]
-  def self.log_debug(fmt, *args) end
-
   # @!endgroup
 
   # @!group Other class methods

data/lib/wx/doc/gc_dc.rb

@@ -1,5 +1,5 @@
 
-class Wx
+module Wx
 
   class GCDC < Wx::DC
 

data/lib/wx/doc/gen/about_dialog_info.rb

@@ -66,7 +66,7 @@ module Wx
   class AboutDialogInfo < ::Object
   
     # Default constructor leaves all fields are initially uninitialized, in general you should call at least {Wx::AboutDialogInfo#set_version}, {Wx::AboutDialogInfo#set_copyright} and {Wx::AboutDialogInfo#set_description}.
-    # @return [AboutDialogInfo]
+    # @return [Wx::AboutDialogInfo]
     def initialize; end
     
     # Adds an artist name to be shown in the program credits.

data/lib/wx/doc/gen/accelerator.rb

@@ -58,11 +58,11 @@ module Wx
     #   @param keyCode [Integer,String]  The keycode (or character) to be detected. See {Wx::KeyCode} for a full list of keycodes.
     #   @param cmd [Integer]  The menu or control command identifier (ID).
     #   @param item [Wx::MenuItem]  The menu item associated with this accelerator.
-    #   @return [AcceleratorEntry]
+    #   @return [Wx::AcceleratorEntry]
     # @overload initialize(entry)
     #   Copy ctor.
     #   @param entry [Wx::AcceleratorEntry] 
-    #   @return [AcceleratorEntry]
+    #   @return [Wx::AcceleratorEntry]
     def initialize(*args) end
     
     # Returns the command identifier for the accelerator table entry.
@@ -148,16 +148,16 @@ module Wx
   
     # @overload initialize()
     #   Default ctor.
-    #   @return [AcceleratorTable]
+    #   @return [Wx::AcceleratorTable]
     # @overload initialize(entries)
     #   Initializes the accelerator table from an array of {Wx::AcceleratorEntry}.
     #   @param entries [Array<Wx::AcceleratorEntry>]  The array of entries.
-    #   @return [AcceleratorTable]
+    #   @return [Wx::AcceleratorTable]
     # @overload initialize(resource)
     #   Loads the accelerator table from a Windows resource (Windows only).
-    #   Availability:  only available for the {Wx::MSW} port.  {Wx::msw}
+    #   Availability:  only available for the wxMSW port.  {Wx::msw}
     #   @param resource [String]  Name of a Windows accelerator.
-    #   @return [AcceleratorTable]
+    #   @return [Wx::AcceleratorTable]
     def initialize(*args) end
     
     # Returns true if the accelerator table is valid.

data/lib/wx/doc/gen/accessible.rb

@@ -638,7 +638,7 @@ module Wx
   # Most functions work with an object id, which can be zero to refer to 'this' UI element, or greater than zero to refer to the nth child element. This allows you to specify elements that don't have a corresponding {Wx::Window} or {Wx::Accessible}; for example, the sash of a splitter window.
   # For details on the semantics of functions and types, please refer to the Microsoft Active Accessibility 1.2 documentation.
   # This class is compiled into wxWidgets only if the {Wx::Setup::USE_ACCESSIBILITY} setup symbol is set to 1.
-  # Availability:  only available for the {Wx::MSW} port.  {Wx::msw} 
+  # Availability:  only available for the wxMSW port.  {Wx::msw} 
   # === 
   # 
   # Category:  {Wx::Miscellaneous}
@@ -650,7 +650,7 @@ module Wx
     # Constructor, taking an optional window.
     # The object can be associated with a window later.
     # @param win [Wx::Window] 
-    # @return [Accessible]
+    # @return [Wx::Accessible]
     def initialize(win=nil) end
     
     # Performs the default action for the object.
@@ -744,9 +744,13 @@ module Wx
     
     # Gets a variant representing the selected children of this object.
     # Acceptable values are: 
+    # 
     # - a null variant (<code>IsNull()</code> returns true) if no children are selected 
+    # 
     # - a <code>void*</code> pointer to a {Wx::Accessible} of selected child object 
+    # 
     # - an integer representing the selected child element, or 0 if this object is selected (<code>GetType()</code> <code>==</code> <code>"long"</code>) 
+    # 
     # - a list variant (<code>GetType()</code> <code>==</code> <code>"list"</code>) if multiple child objects are selected
     # @param selections [Wx::Variant] 
     # @return [AccStatus]

data/lib/wx/doc/gen/activity_indicator.rb

@@ -0,0 +1,65 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # Small control showing an animation indicating that the program is currently busy performing some background task.
+  # === 
+  # 
+  # Category:  {Wx::Controls}  <div class='appearance'><span class='appearance'>Appearance:</span><table><tr><td> wxMSW Appearance
+  #   </td><td> wxGTK Appearance
+  #   </td><td> wxOSX Appearance
+  #   </td></tr></table></div>
+  # 
+  class ActivityIndicator < Control
+  
+    # @overload initialize()
+    #   Default constructor.
+    #   Use {Wx::ActivityIndicator#create} to really create the control after using this constructor.
+    #   @return [Wx::ActivityIndicator]
+    # @overload initialize(parent, winid=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=("activityindicator"))
+    #   Constructor fully creating the control.
+    #   The arguments have the usual meanings and only parent is typically required.
+    #   @param parent [Wx::Window] 
+    #   @param winid [Integer] 
+    #   @param pos [Array(Integer, Integer), Wx::Point] 
+    #   @param size [Array(Integer, Integer), Wx::Size] 
+    #   @param style [Integer] 
+    #   @param name [String] 
+    #   @return [Wx::ActivityIndicator]
+    def initialize(*args) end
+    
+    # Create the control initialized using the default constructor.
+    # This method can be used to finish the control creation if it hadn't been done already by using the non-default constructor.
+    # @param parent [Wx::Window] 
+    # @param winid [Integer] 
+    # @param pos [Array(Integer, Integer), Wx::Point] 
+    # @param size [Array(Integer, Integer), Wx::Size] 
+    # @param style [Integer] 
+    # @param name [String] 
+    # @return [true,false]
+    def create(parent, winid=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=("activityindicator")) end
+    
+    # Starts animation of the indicator.
+    # Does nothing if the indicator is already running.
+    # @return [void]
+    def start; end
+    
+    # Stops the animation of the indicator.
+    # Notice that the animation is stopped even if {Wx::ActivityIndicator#start} had been called multiple times before, i.e. the calls are not cumulative.
+    # @return [void]
+    def stop; end
+    
+    # Returns true if the control is currently showing activity.
+    # Returns false initially, true once {Wx::ActivityIndicator#start} is called and false again after calling {Wx::ActivityIndicator#stop}.
+    # @return [true,false]
+    def is_running; end
+    alias_method :running?, :is_running
+    
+  end # ActivityIndicator
+  
+
+end

data/lib/wx/doc/gen/animation.rb

@@ -76,18 +76,18 @@ module Wx
     #   Constructs a new empty animation object.
     #   Call {Wx::Animation#load} to initialize it.
     #   @see Wx::AnimationCtrl#create_animation 
-    #   @return [Animation]
+    #   @return [Wx::Animation]
     # @overload initialize(name, type=Wx::AnimationType::ANIMATION_TYPE_ANY)
     #   Constructs a new animation object and load the animation data from the given filename.
     #   
     #   @see Wx::AnimationCtrl#create_animation 
     #   @param name [String]  A filename.
     #   @param type [AnimationType]  One of the {Wx::AnimationType} values; {Wx::AnimationType::ANIMATION_TYPE_ANY} means that the function should try to autodetect the filetype.
-    #   @return [Animation]
+    #   @return [Wx::Animation]
     # @overload initialize(other)
     #   Copy constructor.
     #   @param other [Wx::Animation] 
-    #   @return [Animation]
+    #   @return [Wx::Animation]
     def initialize(*args) end
     
     # Returns true if animation data is present.
@@ -103,13 +103,13 @@ module Wx
     alias_method :delay, :get_delay
     
     # Returns the number of frames for this animation.
-    # This method is not implemented in the native {Wx::GTK} implementation of this class and always returns 0 there.
+    # This method is not implemented in the native wxGTK implementation of this class and always returns 0 there.
     # @return [Integer]
     def get_frame_count; end
     alias_method :frame_count, :get_frame_count
     
     # Returns the i-th frame as a {Wx::Image}.
-    # This method is not implemented in the native {Wx::GTK} implementation of this class and always returns an invalid image there.
+    # This method is not implemented in the native wxGTK implementation of this class and always returns an invalid image there.
     # @param frame [Integer] 
     # @return [Wx::Image]
     def get_frame(frame) end
@@ -129,7 +129,7 @@ module Wx
     
     # Loads an animation from the given stream.
     # true if the operation succeeded, false otherwise.
-    # @param stream [IO,Wx::InputStream]  The stream to use to load the animation. Under {Wx::GTK} may be any kind of stream; under other platforms this must be a seekable stream.
+    # @param stream [IO,Wx::InputStream]  The stream to use to load the animation. Under wxGTK may be any kind of stream; under other platforms this must be a seekable stream.
     # @param type [AnimationType]  One of the {Wx::AnimationType} enumeration values.
     # @return [true,false]
     def load(stream, type=Wx::AnimationType::ANIMATION_TYPE_ANY) end
@@ -170,7 +170,7 @@ module Wx
   # 
   class AnimationDecoder < ::Object
   
-    # @return [AnimationDecoder]
+    # @return [Wx::AnimationDecoder]
     def initialize; end
     
     # Load the animation image frames from the given stream.