wxruby3 0.9.0.pre.beta.2-x64-mingw-ucrt-3.2-3.2.2

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

@@ -0,0 +1,253 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # 
+  AC_NO_AUTORESIZE = 16
+  
+  # 
+  AC_DEFAULT_STYLE = 2097152
+  
+  # Supported animation types.
+  # 
+  # 
+  # 
+  class AnimationType < Wx::Enum
+  
+    # 
+    # 
+    ANIMATION_TYPE_INVALID = Wx::AnimationType.new(0)
+    
+    # represents an animated GIF file.
+    # 
+    ANIMATION_TYPE_GIF = Wx::AnimationType.new(1)
+    
+    # represents an ANI file.
+    # 
+    ANIMATION_TYPE_ANI = Wx::AnimationType.new(2)
+    
+    # autodetect the filetype.
+    # 
+    ANIMATION_TYPE_ANY = Wx::AnimationType.new(3)
+    
+  end # AnimationType
+  
+  # 
+  # 
+  # 
+  # 
+  class AnimationDisposal < Wx::Enum
+  
+    # No disposal specified. The decoder is not required to take any action.
+    # 
+    ANIM_UNSPECIFIED = Wx::AnimationDisposal.new(-1)
+    
+    # Do not dispose. The graphic is to be left in place.
+    # 
+    ANIM_DONOTREMOVE = Wx::AnimationDisposal.new(0)
+    
+    # Restore to background color.
+    # 
+    ANIM_TOBACKGROUND = Wx::AnimationDisposal.new(1)
+    
+    # Restore to previous.
+    # 
+    ANIM_TOPREVIOUS = Wx::AnimationDisposal.new(2)
+    
+  end # AnimationDisposal
+  
+  # An empty animation object.
+  # 
+  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 
+  # 
+  # 
+  class Animation < Object
+  
+    # @overload initialize()
+    #   Constructs a new empty animation object.
+    #   Call {Wx::Animation#load} to initialize it.
+    #   @see Wx::AnimationCtrl#create_animation 
+    #   @return [Animation]
+    # @overload initialize(name, type=Wx::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]
+    # @overload initialize(other)
+    #   Copy constructor.
+    #   @param other [Wx::Animation] 
+    #   @return [Animation]
+    def initialize(*args) end
+    
+    # Returns true if animation data is present.
+    # @return [true,false]
+    def is_ok; end
+    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]
+    def get_delay(frame) end
+    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.
+    # @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.
+    # @param frame [Integer] 
+    # @return [Wx::Image]
+    def get_frame(frame) end
+    alias_method :frame, :get_frame
+    
+    # Returns the size of the animation.
+    # @return [Wx::Size]
+    def get_size; end
+    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 [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]
+    def load_file(name, type=Wx::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]
+    def load(stream, type=Wx::ANIMATION_TYPE_ANY) end
+    
+    # Returns the list of animation decoders used by the generic animation and {Wx::GenericAnimationCtrl}.
+    # @return [Array<Wx::AnimationDecoder>]
+    def self.get_handlers; end
+    
+    # Add a new decoder to the list of animation decoders.
+    # @param handler [Wx::AnimationDecoder] 
+    # @return [void]
+    def self.add_handler(handler) end
+    
+    # Insert a new decoder to the front of the list of animation decoders.
+    # @param handler [Wx::AnimationDecoder] 
+    # @return [void]
+    def self.insert_handler(handler) end
+    
+    # Search for an animation decoder by type.
+    # @param animType [AnimationType] 
+    # @return [Wx::AnimationDecoder]
+    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
+    
+  end # Animation
+  
+  # {Wx::AnimationDecoder} is used by {Wx::Animation} for loading frames and other information for the animation from the animation image file.
+  # 
+  # 
+  class AnimationDecoder < ::Object
+  
+    # @return [AnimationDecoder]
+    def initialize; end
+    
+    # Load the animation image frames from the given stream.
+    # @param stream [IO,Wx::InputStream] 
+    # @return [true,false]
+    def load(stream) end
+    
+    # Returns true if this decoder supports loading from the given stream.
+    # @param stream [IO,Wx::InputStream] 
+    # @return [true,false]
+    def can_read(stream) end
+    alias_method :can_read?, :can_read
+    
+    # Create a copy of this decoder.
+    # @return [Wx::AnimationDecoder]
+    def clone; end
+    
+    # Return the animation type this decoder implements.
+    # @return [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)]
+    def convert_to_image(frame) end
+    
+    # @param frame [Integer] 
+    # @return [Wx::Size]
+    def get_frame_size(frame) end
+    alias_method :frame_size, :get_frame_size
+    
+    # @param frame [Integer] 
+    # @return [Wx::Point]
+    def get_frame_position(frame) end
+    alias_method :frame_position, :get_frame_position
+    
+    # What should be done after displaying this frame.
+    # @param frame [Integer] 
+    # @return [AnimationDisposal]
+    def get_disposal_method(frame) end
+    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]
+    def get_delay(frame) end
+    alias_method :delay, :get_delay
+    
+    # The transparent colour for this frame, if any, or {Wx::NULL_COLOUR}.
+    # @param frame [Integer] 
+    # @return [Wx::Colour]
+    def get_transparent_colour(frame) end
+    alias_method :transparent_colour, :get_transparent_colour
+    
+    # @return [Wx::Size]
+    def get_animation_size; end
+    alias_method :animation_size, :get_animation_size
+    
+    # @return [Wx::Colour]
+    def get_background_colour; end
+    alias_method :background_colour, :get_background_colour
+    
+    # @return [Integer]
+    def get_frame_count; end
+    alias_method :frame_count, :get_frame_count
+    
+    
+    protected
+    
+    # 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]
+    def do_can_read(stream) end
+    
+  end # AnimationDecoder
+  
+
+end

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

@@ -0,0 +1,129 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+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).
+  # For the platforms where this control has a native implementation, it may have only limited support for the animation types, see {Wx::GenericAnimationCtrl} if you need to support all of them.
+  # === 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
+  #   </td></tr></table></div>
+  # @see Wx::Animation
+  # @see  Animation Sample 
+  # 
+  # 
+  class AnimationCtrl < Control
+  
+    # Initializes the object and calls {Wx::AnimationCtrl#create} with all the parameters.
+    # @param parent [Wx::Window] 
+    # @param id [Integer] 
+    # @param anim [Wx::Animation] 
+    # @param pos [Array(Integer, Integer), Wx::Point] 
+    # @param size [Array(Integer, Integer), Wx::Size] 
+    # @param style [Integer] 
+    # @param name [String] 
+    # @return [AnimationCtrl]
+    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.
+    # @param parent [Wx::Window]  Parent window, must be non-NULL.
+    # @param id [Integer]  The identifier for the control.
+    # @param anim [Wx::Animation]  The initial animation shown in the control.
+    # @param pos [Array(Integer, Integer), Wx::Point]  Initial position.
+    # @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]
+    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]
+    def create_animation; end
+    
+    # Returns the animation associated with this control.
+    # @return [Wx::Animation]
+    def get_animation; end
+    alias_method :animation, :get_animation
+    
+    # Returns the inactive bitmap shown in this control when the; see {Wx::AnimationCtrl#set_inactive_bitmap} for more info.
+    # @return [Wx::Bitmap]
+    def get_inactive_bitmap; end
+    alias_method :inactive_bitmap, :get_inactive_bitmap
+    
+    # Returns true if the animation is being played.
+    # @return [true,false]
+    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]
+    def load_file(file, animType=Wx::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]
+    def load(file, animType=Wx::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]
+    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]
+    def set_animation(anim) end
+    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.
+    # @param bmp [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image] 
+    # @return [void]
+    def set_inactive_bitmap(bmp) end
+    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
+    
+  end # AnimationCtrl
+  
+
+end

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

@@ -0,0 +1,170 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # 
+  BU_LEFT = 64
+  
+  # 
+  BU_TOP = 128
+  
+  # 
+  BU_RIGHT = 256
+  
+  # 
+  BU_BOTTOM = 512
+  
+  # 
+  BU_ALIGN_MASK = 960
+  
+  # 
+  BU_EXACTFIT = 1
+  
+  # 
+  BU_NOTEXT = 2
+  
+  # 
+  BU_AUTODRAW = 4
+  
+  # A class for common button functionality used as the base for the various button classes.
+  # 
+  # 
+  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
+    #   @param x [Integer] 
+    #   @param y [Integer] 
+    #   @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
+    #   @param sz [Array(Integer, Integer), Wx::Size] 
+    #   @return [void]
+    def set_bitmap_margins(*args) end
+    alias_method :bitmap_margins=, :set_bitmap_margins
+    
+    # @return [AnyButton]
+    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]
+    def get_bitmap; end
+    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
+    # @return [Wx::Bitmap]
+    def get_bitmap_label; end
+    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
+    # @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}.
+    # @return [void]
+    def set_bitmap(bitmap, dir=Wx::LEFT) end
+    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] 
+    # @return [void]
+    def set_bitmap_current(bitmap) end
+    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
+    # @see  Wx::AnyButton#set_bitmap_pressed
+    # @see  Wx::AnyButton#set_bitmap_focus
+    # @param bitmap [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image] 
+    # @return [void]
+    def set_bitmap_disabled(bitmap) end
+    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
+    # @see  Wx::AnyButton#set_bitmap_pressed
+    # @see  Wx::AnyButton#set_bitmap_disabled
+    # @param bitmap [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image] 
+    # @return [void]
+    def set_bitmap_focus(bitmap) end
+    alias_method :bitmap_focus=, :set_bitmap_focus
+    
+    # Sets the bitmap label for the button.
+    # This is the bitmap used for the unselected state, and for all other states if no other bitmaps are provided.
+    # @see Wx::AnyButton#set_bitmap
+    # @see  Wx::AnyButton#get_bitmap_label
+    # @param bitmap [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image] 
+    # @return [void]
+    def set_bitmap_label(bitmap) end
+    alias_method :bitmap_label=, :set_bitmap_label
+    
+    # Sets the bitmap for the selected (depressed) button appearance.
+    # @param bitmap [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image] 
+    # @return [void]
+    def set_bitmap_pressed(bitmap) end
+    alias_method :bitmap_pressed=, :set_bitmap_pressed
+    
+    # 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 [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
+    
+  end # AnyButton
+  
+
+end