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

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,27 +650,27 @@ 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.
     # childId is 0 (the action for this object) or greater than 0 (the action for a child).
     # {Wx::AccStatus::ACC_NOT_SUPPORTED} if there is no default action for this window (e.g. an edit control).
     # @param childId [Integer] 
-    # @return [AccStatus]
+    # @return [Wx::AccStatus]
     def do_default_action(childId) end
     
     # Gets the specified child (starting from 1).
     # If child is NULL and the return value is {Wx::AccStatus::ACC_OK}, this means that the child is a simple element and not an accessible object.
     # @param childId [Integer] 
     # @param child [Wx::Accessible] 
-    # @return [AccStatus]
+    # @return [Wx::AccStatus]
     def get_child(childId, child) end
     alias_method :child, :get_child
     
     # Returns the number of children in childCount.
     # @param childCount [int] 
-    # @return [AccStatus]
+    # @return [Wx::AccStatus]
     def get_child_count(childCount) end
     alias_method :child_count, :get_child_count
     
@@ -679,14 +679,14 @@ module Wx
     # the current document."
     # @param childId [Integer] 
     # @param actionName [String] 
-    # @return [AccStatus]
+    # @return [Wx::AccStatus]
     def get_default_action(childId, actionName) end
     alias_method :default_action, :get_default_action
     
     # Returns the description for this object or a child.
     # @param childId [Integer] 
     # @param description [String] 
-    # @return [AccStatus]
+    # @return [Wx::AccStatus]
     def get_description(childId, description) end
     alias_method :description, :get_description
     
@@ -694,14 +694,14 @@ module Wx
     # If childId is 0 and child is NULL, no object in this subhierarchy has the focus. If this object has the focus, child should be 'this'.
     # @param childId [int] 
     # @param child [Wx::Accessible] 
-    # @return [AccStatus]
+    # @return [Wx::AccStatus]
     def get_focus(childId, child) end
     alias_method :focus, :get_focus
     
     # Returns help text for this object or a child, similar to tooltip text.
     # @param childId [Integer] 
     # @param helpText [String] 
-    # @return [AccStatus]
+    # @return [Wx::AccStatus]
     def get_help_text(childId, helpText) end
     alias_method :help_text, :get_help_text
     
@@ -709,7 +709,7 @@ module Wx
     # Returns e.g. ALT+K.
     # @param childId [Integer] 
     # @param shortcut [String] 
-    # @return [AccStatus]
+    # @return [Wx::AccStatus]
     def get_keyboard_shortcut(childId, shortcut) end
     alias_method :keyboard_shortcut, :get_keyboard_shortcut
     
@@ -717,20 +717,20 @@ module Wx
     # rect is in screen coordinates.
     # @param rect [Wx::Rect] 
     # @param elementId [Integer] 
-    # @return [AccStatus]
+    # @return [Wx::AccStatus]
     def get_location(rect, elementId) end
     alias_method :location, :get_location
     
     # Gets the name of the specified object.
     # @param childId [Integer] 
     # @param name [String] 
-    # @return [AccStatus]
+    # @return [Wx::AccStatus]
     def get_name(childId, name) end
     alias_method :name, :get_name
     
     # Returns the parent of this object, or NULL.
     # @param parent [Wx::Accessible] 
-    # @return [AccStatus]
+    # @return [Wx::AccStatus]
     def get_parent(parent) end
     alias_method :parent, :get_parent
     
@@ -738,18 +738,22 @@ module Wx
     # See {Wx::AccRole} for a list of these roles.
     # @param childId [Integer] 
     # @param role [Wx::AccRole] 
-    # @return [AccStatus]
+    # @return [Wx::AccStatus]
     def get_role(childId, role) end
     alias_method :role, :get_role
     
     # 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]
+    # @return [Wx::AccStatus]
     def get_selections(selections) end
     alias_method :selections, :get_selections
     
@@ -757,14 +761,14 @@ module Wx
     # See {Wx::AccStatus} for a list of these states.
     # @param childId [Integer] 
     # @param state [long] 
-    # @return [AccStatus]
+    # @return [Wx::AccStatus]
     def get_state(childId, state) end
     alias_method :state, :get_state
     
     # Returns a localized string representing the value for the object or child.
     # @param childId [Integer] 
     # @param strValue [String] 
-    # @return [AccStatus]
+    # @return [Wx::AccStatus]
     def get_value(childId, strValue) end
     alias_method :value, :get_value
     
@@ -779,22 +783,22 @@ module Wx
     # @param pt [Array(Integer, Integer), Wx::Point] 
     # @param childId [int] 
     # @param childObject [Wx::Accessible] 
-    # @return [AccStatus]
+    # @return [Wx::AccStatus]
     def hit_test(pt, childId, childObject) end
     
     # Navigates from fromId to toId or to toObject.
-    # @param navDir [NavDir] 
+    # @param navDir [Wx::NavDir] 
     # @param fromId [Integer] 
     # @param toId [int] 
     # @param toObject [Wx::Accessible] 
-    # @return [AccStatus]
+    # @return [Wx::AccStatus]
     def navigate(navDir, fromId, toId, toObject) end
     
     # Selects the object or child.
     # See {Wx::AccSelectionFlags} for a list of the selection actions.
     # @param childId [Integer] 
-    # @param selectFlags [AccSelectionFlags] 
-    # @return [AccStatus]
+    # @param selectFlags [Wx::AccSelectionFlags] 
+    # @return [Wx::AccStatus]
     def select(childId, selectFlags) end
     
     # Sets the window associated with this object.
@@ -806,7 +810,7 @@ module Wx
     # Allows the application to send an event when something changes in an accessible object.
     # @param eventType [Integer] 
     # @param window [Wx::Window] 
-    # @param objectType [AccObject] 
+    # @param objectType [Wx::AccObject] 
     # @param objectId [Integer] 
     # @return [void]
     def self.notify_event(eventType, window, objectType, objectId) end

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

@@ -9,9 +9,9 @@ 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> {Wx::MSW} Appearance
-  #   </td><td> {Wx::GTK} Appearance
-  #   </td><td> {Wx::OSX} Appearance
+  # 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
@@ -19,7 +19,7 @@ module Wx
     # @overload initialize()
     #   Default constructor.
     #   Use {Wx::ActivityIndicator#create} to really create the control after using this constructor.
-    #   @return [ActivityIndicator]
+    #   @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.
@@ -29,7 +29,7 @@ module Wx
     #   @param size [Array(Integer, Integer), Wx::Size] 
     #   @param style [Integer] 
     #   @param name [String] 
-    #   @return [ActivityIndicator]
+    #   @return [Wx::ActivityIndicator]
     def initialize(*args) end
     
     # Create the control initialized using the default constructor.
@@ -40,7 +40,7 @@ module Wx
     # @param size [Array(Integer, Integer), Wx::Size] 
     # @param style [Integer] 
     # @param name [String] 
-    # @return [true,false]
+    # @return [Boolean]
     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.
@@ -55,7 +55,7 @@ module Wx
     
     # 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]
+    # @return [Boolean]
     def is_running; end
     alias_method :running?, :is_running
     

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

@@ -76,22 +76,22 @@ 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]
+    #   @param type [Wx::AnimationType]  One of the {Wx::AnimationType} values; {Wx::AnimationType::ANIMATION_TYPE_ANY} means that the function should try to autodetect the filetype.
+    #   @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.
-    # @return [true,false]
+    # @return [Boolean]
     def is_ok; end
     alias_method :ok?, :is_ok
     
@@ -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
@@ -123,15 +123,15 @@ module Wx
     # Loads an animation from a file.
     # true if the operation succeeded, false otherwise.
     # @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 [true,false]
+    # @param type [Wx::AnimationType]  One of the {Wx::AnimationType} values; {Wx::AnimationType::ANIMATION_TYPE_ANY} means that the function should try to autodetect the filetype.
+    # @return [Boolean]
     def load_file(name, type=Wx::AnimationType::ANIMATION_TYPE_ANY) end
     
     # 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 type [AnimationType]  One of the {Wx::AnimationType} enumeration values.
-    # @return [true,false]
+    # @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 [Wx::AnimationType]  One of the {Wx::AnimationType} enumeration values.
+    # @return [Boolean]
     def load(stream, type=Wx::AnimationType::ANIMATION_TYPE_ANY) end
     
     # Returns the list of animation decoders used by the generic animation and {Wx::GenericAnimationCtrl}.
@@ -149,7 +149,7 @@ module Wx
     def self.insert_handler(handler) end
     
     # Search for an animation decoder by type.
-    # @param animType [AnimationType] 
+    # @param animType [Wx::AnimationType] 
     # @return [Wx::AnimationDecoder]
     def self.find_handler(animType) end
     
@@ -170,17 +170,17 @@ module Wx
   # 
   class AnimationDecoder < ::Object
   
-    # @return [AnimationDecoder]
+    # @return [Wx::AnimationDecoder]
     def initialize; end
     
     # Load the animation image frames from the given stream.
     # @param stream [IO,Wx::InputStream] 
-    # @return [true,false]
+    # @return [Boolean]
     def load(stream) end
     
     # Returns true if this decoder supports loading from the given stream.
     # @param stream [IO,Wx::InputStream] 
-    # @return [true,false]
+    # @return [Boolean]
     def can_read(stream) end
     alias_method :can_read?, :can_read
     
@@ -189,13 +189,13 @@ module Wx
     def clone; end
     
     # Return the animation type this decoder implements.
-    # @return [AnimationType]
+    # @return [Wx::AnimationType]
     def get_type; end
     alias_method :type, :get_type
     
     # Convert given frame to {Wx::Image}.
     # @param frame [Integer] 
-    # @return [Array(true,false,Wx::Image)]
+    # @return [Array(Boolean,Wx::Image)]
     def convert_to_image(frame) end
     
     # @param frame [Integer] 
@@ -210,7 +210,7 @@ module Wx
     
     # What should be done after displaying this frame.
     # @param frame [Integer] 
-    # @return [AnimationDisposal]
+    # @return [Wx::AnimationDisposal]
     def get_disposal_method(frame) end
     alias_method :disposal_method, :get_disposal_method
     
@@ -244,7 +244,7 @@ module Wx
     
     # Checks the signature of the data in the given stream and returns true if it appears to be a valid animation format recognized by the animation decoder; this function should modify the stream current position without taking care of restoring it since <code>Wx::AnimationDecoder#can_read</code> will do it.
     # @param stream [IO,Wx::InputStream] 
-    # @return [true,false]
+    # @return [Boolean]
     def do_can_read(stream) end
     
   end # AnimationDecoder

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

@@ -14,17 +14,18 @@ module Wx
   # === Styles
   # 
   # This class supports the following styles:
-  #  
+  # 
   # - {Wx::AC_DEFAULT_STYLE}: The default style: {Wx::Border::BORDER_NONE}. 
+  # 
   # - {Wx::AC_NO_AUTORESIZE}: By default, the control will adjust its size to exactly fit to the size of the animation when SetAnimation is called. If this style flag is given, the control will not change its size 
   # 
   # === 
   # 
   # Category:  {Wx::Controls}
-  # Implementations:  native under {Wx::GTK}, {Wx::MSW} ports; a generic implementation is used elsewhere.
-  #  <div class='appearance'><span class='appearance'>Appearance:</span><table><tr><td> {Wx::MSW} Appearance
-  #   </td><td> {Wx::GTK} Appearance
-  #   </td><td> {Wx::OSX} Appearance
+  # Implementations:  native under wxGTK, wxMSW ports; a generic implementation is used elsewhere.
+  #  <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>
   # @see Wx::Animation
   # @see  Animation Sample 
@@ -40,7 +41,7 @@ module Wx
     # @param size [Array(Integer, Integer), Wx::Size] 
     # @param style [Integer] 
     # @param name [String] 
-    # @return [AnimationCtrl]
+    # @return [Wx::AnimationCtrl]
     def initialize(parent, id, anim=Wx::NULL_ANIMATION, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::AC_DEFAULT_STYLE, name=Wx::AnimationCtrlNameStr) end
     
     # Creates the control with the given anim animation.
@@ -54,7 +55,7 @@ module Wx
     # @param size [Array(Integer, Integer), Wx::Size]  Initial size.
     # @param style [Integer]  The window style, see {Wx::AC_}* flags.
     # @param name [String]  Control name.
-    # @return [true,false]
+    # @return [Boolean]
     def create(parent, id, anim=Wx::NULL_ANIMATION, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::AC_DEFAULT_STYLE, name=Wx::AnimationCtrlNameStr) end
     
     # Create a new animation object compatible with this control.
@@ -74,27 +75,27 @@ module Wx
     alias_method :inactive_bitmap, :get_inactive_bitmap
     
     # Returns true if the animation is being played.
-    # @return [true,false]
+    # @return [Boolean]
     def is_playing; end
     alias_method :playing?, :is_playing
     
     # Loads the animation from the given file and calls {Wx::AnimationCtrl#set_animation}.
     # See {Wx::Animation#load_file} for more info.
     # @param file [String] 
-    # @param animType [AnimationType] 
-    # @return [true,false]
+    # @param animType [Wx::AnimationType] 
+    # @return [Boolean]
     def load_file(file, animType=Wx::AnimationType::ANIMATION_TYPE_ANY) end
     
     # Loads the animation from the given stream and calls {Wx::AnimationCtrl#set_animation}.
     # See {Wx::Animation#load} for more info.
     # @param file [IO,Wx::InputStream] 
-    # @param animType [AnimationType] 
-    # @return [true,false]
+    # @param animType [Wx::AnimationType] 
+    # @return [Boolean]
     def load(file, animType=Wx::AnimationType::ANIMATION_TYPE_ANY) end
     
     # Starts playing the animation.
     # The animation is always played in loop mode (unless the last frame of the animation has an infinite delay time) and always start from the first frame even if you {Wx::stopped} it while some other frame was displayed.
-    # @return [true,false]
+    # @return [Boolean]
     def play; end
     
     # Sets the animation to play in this control.

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

@@ -53,7 +53,7 @@ module Wx
     def set_bitmap_margins(*args) end
     alias_method :bitmap_margins=, :set_bitmap_margins
     
-    # @return [AnyButton]
+    # @return [Wx::AnyButton]
     def initialize; end
     
     # Return the bitmap shown by the button.
@@ -100,7 +100,7 @@ module Wx
     # @see Wx::AnyButton#set_bitmap_position
     # @see  Wx::AnyButton#set_bitmap_margins
     # @param bitmap [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image]  The bitmap bundle containing the resolution-dependent bitmaps to display in the button. At default DPI, the size of the bitmap is determined by the default bundle size, i.e. the value returned from {Wx::BitmapBundle#get_default_size}. If the bitmap bundle is invalid, any currently shown bitmaps are removed from the button.
-    # @param dir [Direction]  The position of the bitmap inside the button. By default it is positioned to the left of the text, near to the left button border. Other possible values include {Wx::Direction::RIGHT}, {Wx::Direction::TOP} and {Wx::Direction::BOTTOM}.
+    # @param dir [Wx::Direction]  The position of the bitmap inside the button. By default it is positioned to the left of the text, near to the left button border. Other possible values include {Wx::Direction::RIGHT}, {Wx::Direction::TOP} and {Wx::Direction::BOTTOM}.
     # @return [void]
     def set_bitmap(bitmap, dir=Wx::Direction::LEFT) end
     alias_method :bitmap=, :set_bitmap
@@ -159,7 +159,7 @@ module Wx
     
     # Set the position at which the bitmap is displayed.
     # This method should only be called if the button does have an associated bitmap.
-    # @param dir [Direction]  Direction in which the bitmap should be positioned, one of {Wx::Direction::LEFT}, {Wx::Direction::RIGHT}, {Wx::Direction::TOP} or {Wx::Direction::BOTTOM}.
+    # @param dir [Wx::Direction]  Direction in which the bitmap should be positioned, one of {Wx::Direction::LEFT}, {Wx::Direction::RIGHT}, {Wx::Direction::TOP} or {Wx::Direction::BOTTOM}.
     # @return [void]
     def set_bitmap_position(dir) end
     alias_method :bitmap_position=, :set_bitmap_position