wxruby3 0.9.2-x64-mingw-ucrt → 0.9.4-x64-mingw-ucrt

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

@@ -7,6 +7,7 @@
 module Wx
 
   # This function shows the standard about dialog containing the information specified in info.
+  # 
   # If the current platform has a native about dialog which is capable of showing all the fields in info, the native dialog is used, otherwise the function falls back to the generic wxWidgets version of the dialog, i.e. does the same thing as {generic_about_box}.
   # Here is an example of how this function may be used:
   # ```ruby
@@ -28,6 +29,7 @@ module Wx
   def self.about_box(info, parent=nil) end
   
   # This function does the same thing as {about_box} except that it always uses the generic wxWidgets version of the dialog instead of the native one.
+  # 
   # This is mainly useful if you need to customize the dialog by e.g. adding custom controls to it (customizing the native dialog is not currently supported).
   # See the Dialogs Sample for an example of about dialog customization.
   # @see Wx::AboutDialogInfo
@@ -37,6 +39,7 @@ module Wx
   def self.generic_about_box(info, parent=nil) end
   
   # {Wx::AboutDialogInfo} contains information shown in the standard About dialog displayed by the {about_box} function.
+  # 
   # This class contains the general information about the program, such as its name, version, copyright and so on, as well as lists of the program developers, documentation writers, artists and translators. The simple properties from the former group are represented as a string with the exception of the program icon and the program web site, while the lists from the latter group are stored as {Wx::ArrayString} and can be either set entirely at once using {Wx::AboutDialogInfo#set_developers} and similar functions or built one by one using {Wx::AboutDialogInfo#add_developer} etc.
   # Please also notice that while all the main platforms have the native implementation of the about dialog, they are often more limited than the generic version provided by wxWidgets and so the generic version is used if {Wx::AboutDialogInfo} has any fields not supported by the native version. Currently GTK+ version supports all the possible fields natively but MSW and Mac versions don't support URLs, licence text nor custom icons in the about dialog and if either of those is used, {about_box} will automatically use the generic version so you should avoid specifying these fields to achieve more native look and feel.
   # 
@@ -70,6 +73,7 @@ module Wx
     
     # Adds an artist name to be shown in the program credits.
     # 
+    # 
     # @see Wx::AboutDialogInfo#set_artists 
     # @param artist [String] 
     # @return [void]
@@ -77,6 +81,7 @@ module Wx
     
     # Adds a developer name to be shown in the program credits.
     # 
+    # 
     # @see Wx::AboutDialogInfo#set_developers 
     # @param developer [String] 
     # @return [void]
@@ -84,12 +89,14 @@ module Wx
     
     # Adds a documentation writer name to be shown in the program credits.
     # 
+    # 
     # @see Wx::AboutDialogInfo#set_doc_writers 
     # @param docwriter [String] 
     # @return [void]
     def add_doc_writer(docwriter) end
     
     # Adds a translator name to be shown in the program credits.
+    # 
     # Notice that if no translator names are specified explicitly, {about_box} will try to use the translation of the string <code>translator-credits</code> from the currently used message catalog  this can be used to show just the name of the translator of the program in the current language.
     # @see Wx::AboutDialogInfo#set_translators 
     # @param translator [String] 
@@ -97,6 +104,7 @@ module Wx
     def add_translator(translator) end
     
     # Get the name of the program.
+    # 
     # Name of the program
     # @see Wx::AboutDialogInfo#set_name 
     # @return [String]
@@ -105,12 +113,14 @@ module Wx
     
     # Returns true if a description string has been specified.
     # 
+    # 
     # @see Wx::AboutDialogInfo#get_description 
     # @return [Boolean]
     def has_description; end
     alias_method :has_description?, :has_description
     
     # Get the description string.
+    # 
     # The description string, free-form.
     # @return [Wx::String]
     def get_description; end
@@ -118,12 +128,14 @@ module Wx
     
     # Returns true if a copyright string has been specified.
     # 
+    # 
     # @see Wx::AboutDialogInfo#get_copyright 
     # @return [Boolean]
     def has_copyright; end
     alias_method :has_copyright?, :has_copyright
     
     # Get the copyright string.
+    # 
     # The copyright string
     # @return [Wx::String]
     def get_copyright; end
@@ -131,6 +143,7 @@ module Wx
     
     # Sets the list of artists to be shown in the program credits.
     # 
+    # 
     # @see Wx::AboutDialogInfo#add_artist 
     # @param artists [Array<String>] 
     # @return [void]
@@ -138,6 +151,7 @@ module Wx
     alias_method :artists=, :set_artists
     
     # Set the short string containing the program copyright information.
+    # 
     # Notice that any occurrences of <code>"(C)"</code> in copyright will be replaced by the copyright symbol (circled C) automatically, which means that you can avoid using this symbol in the program source code which can be problematic,
     # @param copyright [String] 
     # @return [void]
@@ -152,6 +166,7 @@ module Wx
     
     # Set the list of developers of the program.
     # 
+    # 
     # @see Wx::AboutDialogInfo#add_developer 
     # @param developers [Array<String>] 
     # @return [void]
@@ -160,6 +175,7 @@ module Wx
     
     # Set the list of documentation writers.
     # 
+    # 
     # @see Wx::AboutDialogInfo#add_doc_writer 
     # @param docwriters [Array<String>] 
     # @return [void]
@@ -177,6 +193,7 @@ module Wx
     alias_method :icon, :get_icon
     
     # Set the icon to be shown in the dialog.
+    # 
     # By default the icon of the main frame will be shown if the native about dialog supports custom icons. If it doesn't but a valid icon is specified using this method, the generic about dialog is used instead so you should avoid calling this function for maximally native look and feel.
     # @param icon [Wx::Icon] 
     # @return [void]
@@ -190,12 +207,14 @@ module Wx
     
     # Returns the licence string.
     # 
+    # 
     # @see Wx::AboutDialogInfo#set_licence 
     # @return [Wx::String]
     def get_licence; end
     alias_method :licence, :get_licence
     
     # Set the long, multiline string containing the text of the program licence.
+    # 
     # Only GTK+ version supports showing the licence text in the native about dialog currently so the generic version will be used under all the other platforms if this method is called. To preserve the native look and feel it is advised that you do not call this method but provide a separate menu item in the <code>"Help"</code> menu for displaying the text of your program licence.
     # @param licence [String] 
     # @return [void]
@@ -209,6 +228,7 @@ module Wx
     alias_method :license=, :set_license
     
     # Set the name of the program.
+    # 
     # If this method is not called, the string returned by {Wx::App::GetAppName} will be shown in the dialog.
     # @param name [String] 
     # @return [void]
@@ -216,6 +236,7 @@ module Wx
     alias_method :name=, :set_name
     
     # Set the list of translators.
+    # 
     # Please see {Wx::AboutDialogInfo#add_translator} for additional discussion.
     # @param translators [Array<String>] 
     # @return [void]
@@ -223,6 +244,7 @@ module Wx
     alias_method :translators=, :set_translators
     
     # Set the version of the program.
+    # 
     # The word "version" shouldn't be included in version. Example version values: "1.2" and "RC2". In about dialogs with more space set aside for version information, longVersion is used. Example longVersion values: "Version 1.2" and "Release Candidate 2". If version is non-empty but longVersion is empty, a long version is constructed automatically, using version (by simply prepending "Version " to version).
     # The generic about dialog and native GTK+ dialog use version only, as a suffix to the program name. The native MSW and macOS about dialogs use the long version.
     # @param version [String] 
@@ -233,6 +255,7 @@ module Wx
     
     # Return the short version string.
     # 
+    # 
     # @see Wx::AboutDialogInfo#set_version 
     # @return [Wx::String]
     def get_version; end
@@ -240,6 +263,7 @@ module Wx
     
     # Return the long version string if set.
     # 
+    # 
     # @see Wx::AboutDialogInfo#set_version 
     # @return [Wx::String]
     def get_long_version; end
@@ -261,6 +285,7 @@ module Wx
     alias_method :web_site_description, :get_web_site_description
     
     # Set the web site for the program and its description (which defaults to url itself if empty).
+    # 
     # Please notice that only GTK+ version currently supports showing the link in the native about dialog so if this method is called, the generic version will be used under all the other platforms.
     # @param url [String] 
     # @param desc [String] 

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

@@ -44,6 +44,7 @@ module Wx
   NULL_ACCELERATOR_TABLE = nil
   
   # An object used by an application wishing to create an accelerator table (see {Wx::AcceleratorTable}).
+  # 
   # Category:  Data Structures
   # @see Wx::AcceleratorTable
   # @see  Wx::Window#set_accelerator_table 
@@ -99,17 +100,20 @@ module Wx
     alias_method :ok?, :is_ok
     
     # Returns a textual representation of this accelerator.
+    # 
     # The returned string is of the form <code>[Alt+][Ctrl+][RawCtrl+][Shift+]Key</code> where the modifier keys are present only if the corresponding flag is set.
     # @return [String]
     def to_string; end
     
     # Returns a textual representation of this accelerator which is appropriate for saving in configuration files.
+    # 
     # Unlike the string returned by {Wx::AcceleratorEntry#to_string}, this one is never translated so, while it's not suitable for showing to the user, it can be used to uniquely identify the accelerator independently of the user language.
     # The returned string can still be parsed by {Wx::AcceleratorEntry#from_string}.
     # @return [String]
     def to_raw_string; end
     
     # Parses the given string and sets the accelerator accordingly.
+    # 
     # true if the given string correctly initialized this object (i.e. if {Wx::AcceleratorEntry#is_ok} returns true after this call)
     # @param str [String]  This string may be either in the same format as returned by {Wx::AcceleratorEntry#to_string}, i.e. contain the accelerator itself only, or have the format of a full menu item text with i.e. <code>Label TAB Accelerator</code>. In the latter case, the part of the string before the TAB is ignored. Notice that the latter format is only supported for the compatibility with the previous wxWidgets versions and the new code should pass only the accelerator string itself to this function.
     # @return [Boolean]
@@ -122,6 +126,7 @@ module Wx
   end # AcceleratorEntry
   
   # An accelerator table allows the application to specify a table of keyboard shortcuts for menu or button commands.
+  # 
   # The object {Wx::NULL_ACCELERATOR_TABLE} is defined to be a table with no data, and is the initial accelerator table for a window.
   # Example:
   # ```ruby
@@ -138,7 +143,7 @@ module Wx
   # <b>Remark:</b>
   # <p>An accelerator takes precedence over normal processing and can be a convenient way to program some event handling. For example, you can use an accelerator table to enable a dialog with a multi-line text control to accept CTRL-Enter as meaning 'OK'.
   # </p>
-  # </div>>
+  # </div>
   # 
   # Category:  Data Structures
   # Predefined objects/pointers: {Wx::NULL_ACCELERATOR_TABLE}
@@ -158,6 +163,7 @@ module Wx
     #   @return [Wx::AcceleratorTable]
     # @overload initialize(resource)
     #   Loads the accelerator table from a Windows resource (Windows only).
+    #   
     #   Availability:  only available for the WXMSW port.
     #   @param resource [String]  Name of a Windows accelerator.
     #   @return [Wx::AcceleratorTable]

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

@@ -635,6 +635,7 @@ module Wx
   end # AccSelectionFlags
   
   # The {Wx::Accessible} class allows wxWidgets applications, and wxWidgets itself, to return extended information about user interface elements to client applications such as screen readers.
+  # 
   # This is the main way in which wxWidgets implements accessibility features.
   # At present, only Microsoft Active Accessibility is supported by this class.
   # To use this class, derive from {Wx::Accessible}, implement appropriate functions, and associate an object of the class with a window using {Wx::Window#set_accessible}.
@@ -653,12 +654,14 @@ module Wx
   class Accessible < Object
   
     # Constructor, taking an optional window.
+    # 
     # The object can be associated with a window later.
     # @param win [Wx::Window] 
     # @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] 
@@ -666,6 +669,7 @@ module Wx
     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] 
     # @return [Array(Wx::AccStatus,Wx::Accessible)]
@@ -678,6 +682,7 @@ module Wx
     alias_method :child_count, :get_child_count
     
     # Gets the default action for this object (0) or a child (greater than 0).
+    # 
     # Return {Wx::AccStatus::ACC_OK} even if there is no action. actionName is the action, or the empty string if there is no action. The retrieved string describes the action that is performed on an object, not what the object does as a result. For example, a toolbar button that prints a document has a default action of "Press" rather than "Prints
     # the current document."
     # @param childId [Integer] 
@@ -692,6 +697,7 @@ module Wx
     alias_method :description, :get_description
     
     # Gets the window with the keyboard focus.
+    # 
     # 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'.
     # @return [Array(Wx::AccStatus,Integer,Wx::Accessible)]
     def get_focus; end
@@ -704,6 +710,7 @@ module Wx
     alias_method :help_text, :get_help_text
     
     # Returns the keyboard shortcut for this object or child.
+    # 
     # Returns e.g. ALT+K.
     # @param childId [Integer] 
     # @return [Array(Wx::AccStatus,String)]
@@ -711,6 +718,7 @@ module Wx
     alias_method :keyboard_shortcut, :get_keyboard_shortcut
     
     # Returns the rectangle for this object (id is 0) or a child element (id is greater than 0).
+    # 
     # rect is in screen coordinates.
     # @param rect [Wx::Rect] 
     # @param elementId [Integer] 
@@ -730,6 +738,7 @@ module Wx
     alias_method :parent, :get_parent
     
     # Returns a role constant describing this object.
+    # 
     # See {Wx::AccRole} for a list of these roles.
     # @param childId [Integer] 
     # @return [Array(Wx::AccStatus,Wx::AccRole)]
@@ -737,6 +746,7 @@ module Wx
     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 
@@ -752,6 +762,7 @@ module Wx
     alias_method :selections, :get_selections
     
     # Returns a state constant.
+    # 
     # See {Wx::AccStatus} for a list of these states.
     # @param childId [Integer] 
     # @return [Array(Wx::AccStatus,Integer)]
@@ -770,6 +781,7 @@ module Wx
     alias_method :window, :get_window
     
     # Returns a status value and object id to indicate whether the given point was on this or a child object.
+    # 
     # Can return either a child object, or an integer representing the child element, starting from 1.
     # pt is in screen coordinates.
     # @param pt [Array(Integer, Integer), Wx::Point] 
@@ -783,6 +795,7 @@ module Wx
     def navigate(navDir, fromId) end
     
     # Selects the object or child.
+    # 
     # See {Wx::AccSelectionFlags} for a list of the selection actions.
     # @param childId [Integer] 
     # @param selectFlags [Wx::AccSelectionFlags] 

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

@@ -7,6 +7,7 @@
 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
@@ -17,10 +18,12 @@ module Wx
   
     # @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] 
@@ -32,6 +35,7 @@ module Wx
     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] 
@@ -43,16 +47,19 @@ module Wx
     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 [Boolean]
     def is_running; end

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

@@ -67,6 +67,7 @@ module Wx
   NULL_ANIMATION = nil
   
   # The {Wx::Animation} class handles the interface between the animation control and the details of the animation image or data.
+  # 
   # Predefined objects/pointers: {Wx::NULL_ANIMATION}
   # @see Wx::AnimationCtrl
   # @see  Animation Sample 
@@ -77,12 +78,14 @@ module Wx
   
     # @overload initialize()
     #   Constructs a new empty animation object.
+    #   
     #   Call {Wx::Animation#load} to initialize it.
     #   @see Wx::AnimationCtrl#create_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 [Wx::AnimationType]  One of the {Wx::AnimationType} values; {Wx::AnimationType::ANIMATION_TYPE_ANY} means that the function should try to autodetect the filetype.
@@ -99,6 +102,7 @@ module Wx
     alias_method :ok?, :is_ok
     
     # Returns the delay for the i-th frame in milliseconds.
+    # 
     # If <code>-1</code> is returned the frame is to be displayed forever.
     # @param frame [Integer] 
     # @return [Integer]
@@ -106,12 +110,14 @@ module Wx
     alias_method :delay, :get_delay
     
     # Returns the number of frames for this animation.
+    # 
     # 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 WXGTK implementation of this class and always returns an invalid image there.
     # @param frame [Integer] 
     # @return [Wx::Image]
@@ -124,6 +130,7 @@ module Wx
     alias_method :size, :get_size
     
     # Loads an animation from a file.
+    # 
     # true if the operation succeeded, false otherwise.
     # @param name [String]  A filename.
     # @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.
@@ -131,6 +138,7 @@ module Wx
     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 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.
@@ -157,11 +165,13 @@ module Wx
     def self.find_handler(animType) end
     
     # Load the stock animation decoders (currently GIF and ANI) into the list of decoders.
+    # 
     # This is called automatically at program startup.
     # @return [void]
     def self.init_standard_handlers; end
     
     # Clear out the animation decoder list.
+    # 
     # This is called automatically at program shutdown.
     # @return [void]
     def self.clean_up_handlers; end
@@ -171,6 +181,7 @@ module Wx
   # {Wx::AnimationDecoder} is used by {Wx::Animation} for loading frames and other information for the animation from the animation image file.
   # 
   # 
+  # 
   # @wxrb_require USE_ANIMATIONCTRL
   class AnimationDecoder < ::Object
   
@@ -219,6 +230,7 @@ module Wx
     alias_method :disposal_method, :get_disposal_method
     
     # Return the number of milliseconds this frame should be displayed.
+    # 
     # If -1 is returned then the frame must be displayed forever.
     # @param frame [Integer] 
     # @return [Integer]

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

@@ -7,6 +7,7 @@
 module Wx
 
   # This is a static control which displays an animation.
+  # 
   # {Wx::AnimationCtrl} API is as simple as possible and won't give you full control on the animation; if you need it then use {Wx::MediaCtrl}.
   # This control is useful to display a (small) animation while doing a long task (e.g. a "throbber").
   # It is only available if {Wx::Setup::USE_ANIMATIONCTRL} is set to 1 (the default).
@@ -44,6 +45,7 @@ module Wx
     def initialize(parent, id, anim=Wx::NULL_ANIMATION, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::AC_DEFAULT_STYLE, name=Wx::ANIMATION_CTRL_NAME_STR) end
     
     # Creates the control with the given anim animation.
+    # 
     # After control creation you must explicitly call {Wx::AnimationCtrl#play} to start to play the animation. Until that function won't be called, the first frame of the animation is displayed.
     # 
     # true if the control was successfully created or false if creation failed.
@@ -58,6 +60,7 @@ module Wx
     def create(parent, id, anim=Wx::NULL_ANIMATION, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::AC_DEFAULT_STYLE, name=Wx::ANIMATION_CTRL_NAME_STR) end
     
     # Create a new animation object compatible with this control.
+    # 
     # A {Wx::Animation} object created using this function is always compatible with controls of this type, see {Wx::Animation#is_compatible_with}.
     # @see Wx::AnimationCtrl.create_compatible_animation
     # @return [Wx::Animation]
@@ -79,6 +82,7 @@ module Wx
     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 [Wx::AnimationType] 
@@ -86,6 +90,7 @@ module Wx
     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 [Wx::AnimationType] 
@@ -93,11 +98,13 @@ module Wx
     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 [Boolean]
     def play; end
     
     # Sets the animation to play in this control.
+    # 
     # If the previous animation is being played, it's {Wx::AnimationCtrl#stop} stopped. Until {Wx::AnimationCtrl#play} isn't called, a static image, the first frame of the given animation or the background colour will be shown (see {Wx::AnimationCtrl#set_inactive_bitmap} for more info).
     # @param anim [Wx::Animation] 
     # @return [void]
@@ -105,6 +112,7 @@ module Wx
     alias_method :animation=, :set_animation
     
     # Sets the bitmap to show on the control when it's not playing an animation.
+    # 
     # If you set as inactive bitmap {Wx::NULL_BITMAP} (which is the default), then the first frame of the animation is instead shown when the control is inactive; in this case, if there's no valid animation associated with the control (see {Wx::AnimationCtrl#set_animation}), then the background colour of the window is shown.
     # If the control is not playing the animation, the given bitmap will be immediately shown, otherwise it will be shown as soon as {Wx::AnimationCtrl#stop} is called.
     # Note that the inactive bitmap, if smaller than the control's size, will be centered in the control; if bigger, it will be stretched to fit it.
@@ -114,11 +122,13 @@ module Wx
     alias_method :inactive_bitmap=, :set_inactive_bitmap
     
     # Stops playing the animation.
+    # 
     # The control will show the first frame of the animation, a custom static image or the window's background colour as specified by the last {Wx::AnimationCtrl#set_inactive_bitmap} call.
     # @return [void]
     def stop; end
     
     # Create a new animation object compatible with this control.
+    # 
     # This method does the same thing as {Wx::AnimationCtrl#create_animation} but is static, i.e. can be called without creating any {Wx::AnimationCtrl} objects.
     # @return [Wx::Animation]
     def self.create_compatible_animation; end

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

@@ -33,11 +33,13 @@ module Wx
   # A class for common button functionality used as the base for the various button classes.
   # 
   # 
+  # 
   # @wxrb_require USE_BUTTON|USE_TOGGLEBTN
   class AnyButton < Control
   
     # @overload set_bitmap_margins(x, y)
     #   Set the margins between the bitmap and the text of the button.
+    #   
     #   This method is currently only implemented under MSW. If it is not called, default margin is used around the bitmap.
     #   @see Wx::AnyButton#set_bitmap
     #   @see  Wx::AnyButton#set_bitmap_position
@@ -46,6 +48,7 @@ module Wx
     #   @return [void]
     # @overload set_bitmap_margins(sz)
     #   Set the margins between the bitmap and the text of the button.
+    #   
     #   This method is currently only implemented under MSW. If it is not called, default margin is used around the bitmap.
     #   @see Wx::AnyButton#set_bitmap
     #   @see  Wx::AnyButton#set_bitmap_position
@@ -58,6 +61,7 @@ module Wx
     def initialize; end
     
     # Return the bitmap shown by the button.
+    # 
     # The returned bitmap may be invalid only if the button doesn't show any images.
     # @see Wx::AnyButton#set_bitmap
     # @return [Wx::Bitmap]
@@ -65,24 +69,28 @@ module Wx
     alias_method :bitmap, :get_bitmap
     
     # Returns the bitmap used when the mouse is over the button.
+    # 
     # The returned bitmap is only valid if {Wx::AnyButton#set_bitmap_current} had been previously called.
     # @return [Wx::Bitmap]
     def get_bitmap_current; end
     alias_method :bitmap_current, :get_bitmap_current
     
     # Returns the bitmap used for the disabled state.
+    # 
     # The returned bitmap is only valid if {Wx::AnyButton#set_bitmap_disabled} had been previously called.
     # @return [Wx::Bitmap]
     def get_bitmap_disabled; end
     alias_method :bitmap_disabled, :get_bitmap_disabled
     
     # Returns the bitmap used for the focused state.
+    # 
     # The returned bitmap is only valid if {Wx::AnyButton#set_bitmap_focus} had been previously called.
     # @return [Wx::Bitmap]
     def get_bitmap_focus; end
     alias_method :bitmap_focus, :get_bitmap_focus
     
     # Returns the bitmap for the normal state.
+    # 
     # This is exactly the same as {Wx::AnyButton#get_bitmap} but uses a name backwards-compatible with {Wx::BitmapButton}.
     # @see Wx::AnyButton#set_bitmap
     # @see  Wx::AnyButton#set_bitmap_label
@@ -91,12 +99,14 @@ module Wx
     alias_method :bitmap_label, :get_bitmap_label
     
     # Returns the bitmap used when the button is pressed.
+    # 
     # The returned bitmap is only valid if {Wx::AnyButton#set_bitmap_pressed} had been previously called.
     # @return [Wx::Bitmap]
     def get_bitmap_pressed; end
     alias_method :bitmap_pressed, :get_bitmap_pressed
     
     # Sets the bitmap to display in the button.
+    # 
     # The bitmap is displayed together with the button label. This method sets up a single bitmap which is used in all button states, use {Wx::AnyButton#set_bitmap_disabled}, {Wx::AnyButton#set_bitmap_pressed}, {Wx::AnyButton#set_bitmap_current} or {Wx::AnyButton#set_bitmap_focus} to change the individual images used in different states.
     # @see Wx::AnyButton#set_bitmap_position
     # @see  Wx::AnyButton#set_bitmap_margins
@@ -107,6 +117,7 @@ module Wx
     alias_method :bitmap=, :set_bitmap
     
     # Sets the bitmap to be shown when the mouse is over the button.
+    # 
     # If bitmap is invalid, the normal bitmap will be used in the current state.
     # @see Wx::AnyButton#get_bitmap_current
     # @param bitmap [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image] 
@@ -115,6 +126,7 @@ module Wx
     alias_method :bitmap_current=, :set_bitmap_current
     
     # Sets the bitmap for the disabled button appearance.
+    # 
     # If bitmap is invalid, the disabled bitmap is set to the automatically generated greyed out version of the normal bitmap, i.e. the same bitmap as is used by default if this method is not called at all. Use {Wx::AnyButton#set_bitmap} with an invalid bitmap to remove the bitmap completely (for all states).
     # @see Wx::AnyButton#get_bitmap_disabled
     # @see  Wx::AnyButton#set_bitmap_label
@@ -126,6 +138,7 @@ module Wx
     alias_method :bitmap_disabled=, :set_bitmap_disabled
     
     # Sets the bitmap for the button appearance when it has the keyboard focus.
+    # 
     # If bitmap is invalid, the normal bitmap will be used in the focused state.
     # @see Wx::AnyButton#get_bitmap_focus
     # @see  Wx::AnyButton#set_bitmap_label
@@ -137,11 +150,12 @@ module Wx
     alias_method :bitmap_focus=, :set_bitmap_focus
     
     # Sets the bitmap label for the button.
+    # 
     # <div class="wxrb-remark">
     # <b>Remark:</b>
     # <p>This is the bitmap used for the unselected state, and for all other states if no other bitmaps are provided.
     # </p>
-    # </div>>
+    # </div>
     # @see Wx::AnyButton#set_bitmap
     # @see  Wx::AnyButton#get_bitmap_label
     # @param bitmap [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image] 
@@ -157,12 +171,14 @@ module Wx
     
     # Get the margins between the bitmap and the text of the button.
     # 
+    # 
     # @see Wx::AnyButton#set_bitmap_margins
     # @return [Wx::Size]
     def get_bitmap_margins; end
     alias_method :bitmap_margins, :get_bitmap_margins
     
     # 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 [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]