wxruby3 1.6.1 → 1.7.0

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

@@ -0,0 +1,284 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # A 2x3 matrix representing an affine 2D transformation.
+  # 
+  # This is an abstract base class implemented by {Wx::AffineMatrix2D} only so far, but in the future we also plan to derive {Wx::GraphicsMatrix} from it.
+  # 
+  # Category:  {Wx::Miscellaneous}
+  # 
+  # 
+  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  # @wxrb_require USE_GEOMETRY
+  class AffineMatrix2DBase < ::Object
+  
+    # Check that this matrix is identical with t.
+    # @param t [Wx::AffineMatrix2DBase]  The matrix compared with this.
+    # @return [Boolean]
+    def is_equal(t) end
+    alias_method :equal?, :is_equal
+    
+    # Check that this matrix is identical with t.
+    # @param t [Wx::AffineMatrix2DBase]  The matrix compared with this.
+    # @return [Boolean]
+    def ==(t) end
+    
+    # Default constructor.
+    # 
+    # The matrix elements are initialize to the identity matrix.
+    # @return [Wx::AffineMatrix2DBase]
+    def initialize; end
+    
+    # Set all elements of this matrix.
+    # @param mat2D [Wx::Matrix2D]  The rotational components of the matrix (upper 2 x 2).
+    # @param tr [Array(Float, Float), Wx::Point2DDouble]  The translational components of the matrix.
+    # @return [void]
+    def set(mat2D, tr) end
+    
+    # Get the component values of the matrix.
+    # @return [Array(Wx::Matrix2D,Wx::Point2DDouble)]
+    def get; end
+    
+    # Concatenate this matrix with another one.
+    # 
+    # The parameter matrix is the multiplicand.
+    # 
+    # ```
+    #   //           | t.m_11  t.m_12  0 |   | m_11  m_12   0 |
+    #   // matrix' = | t.m_21  t.m_22  0 | x | m_21  m_22   0 |
+    #   //           | t.m_tx  t.m_ty  1 |   | m_tx  m_ty   1 |
+    # ```
+    # @param t [Wx::AffineMatrix2DBase]  The multiplicand.
+    # @return [void]
+    def concat(t) end
+    
+    # Invert this matrix.
+    # 
+    # If the matrix is not invertible, i.e. if its determinant is 0, returns false and doesn't modify it.
+    # 
+    # ```
+    #   //           | m_11  m_12  0 |
+    #   // Invert    | m_21  m_22  0 |
+    #   //           | m_tx  m_ty  1 |
+    # ```
+    # @return [Boolean]
+    def invert; end
+    
+    # Check if this is the identity matrix.
+    # @return [Boolean]
+    def is_identity; end
+    alias_method :identity?, :is_identity
+    
+    # Add the translation to this matrix.
+    # @param dx [Float]  The translation in x direction.
+    # @param dy [Float]  The translation in y direction.
+    # @return [void]
+    def translate(dx, dy) end
+    
+    # Add scaling to this matrix.
+    # @param xScale [Float]  Scaling in x direction.
+    # @param yScale [Float]  Scaling in y direction.
+    # @return [void]
+    def scale(xScale, yScale) end
+    
+    # Add clockwise rotation to this matrix.
+    # @param cRadians [Float]  Rotation angle in radians, clockwise.
+    # @return [void]
+    def rotate(cRadians) end
+    
+    # Add mirroring to this matrix.
+    # @param direction [Integer]  The direction(s) used for mirroring. One of {Wx::Orientation::HORIZONTAL}, {Wx::Orientation::VERTICAL} or their combination {Wx::Orientation::BOTH}.
+    # @return [void]
+    def mirror(direction=Wx::Orientation::HORIZONTAL) end
+    
+    # Applies this matrix to the point.
+    # 
+    # The point with the transformations applied.
+    # @param p [Array(Float, Float), Wx::Point2DDouble]  The point receiving the transformations.
+    # @return [Wx::Point2DDouble]
+    def transform_point(p) end
+    
+    # Applies the linear part of this matrix, i.e. without translation.
+    # 
+    # The source with the transformations applied.
+    # @param p [Array(Float, Float), Wx::Point2DDouble]  The source receiving the transformations.
+    # @return [Wx::Point2DDouble]
+    def transform_distance(p) end
+    
+  end # AffineMatrix2DBase
+  
+  # A 3x2 matrix representing an affine 2D transformation.
+  # 
+  # Category:  {Wx::Miscellaneous}
+  # 
+  # 
+  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  # @wxrb_require USE_GEOMETRY
+  class AffineMatrix2D < AffineMatrix2DBase
+  
+    # Check that this matrix is identical with t.
+    # @param t [Wx::AffineMatrix2DBase]  The matrix compared with this.
+    # @return [Boolean]
+    def ==(t) end
+    
+    # Default constructor.
+    # 
+    # The matrix elements are initialize to the identity matrix.
+    # @return [Wx::AffineMatrix2D]
+    def initialize; end
+    
+    # Get the component values of the matrix.
+    # @return [Array(Wx::Matrix2D,Wx::Point2DDouble)]
+    def get; end
+    
+    # Set all elements of this matrix.
+    # @param mat2D [Wx::Matrix2D]  The rotational components of the matrix (upper 2 x 2).
+    # @param tr [Array(Float, Float), Wx::Point2DDouble]  The translational components of the matrix.
+    # @return [void]
+    def set(mat2D, tr) end
+    
+    # Concatenate this matrix with another one.
+    # 
+    # The parameter matrix is the multiplicand.
+    # 
+    # ```
+    #   //           | t.m_11  t.m_12  0 |   | m_11  m_12   0 |
+    #   // matrix' = | t.m_21  t.m_22  0 | x | m_21  m_22   0 |
+    #   //           | t.m_tx  t.m_ty  1 |   | m_tx  m_ty   1 |
+    # ```
+    # @param t [Wx::AffineMatrix2DBase]  The multiplicand.
+    # @return [void]
+    def concat(t) end
+    
+    # Invert this matrix.
+    # 
+    # If the matrix is not invertible, i.e. if its determinant is 0, returns false and doesn't modify it.
+    # 
+    # ```
+    #   //           | m_11  m_12  0 |
+    #   // Invert    | m_21  m_22  0 |
+    #   //           | m_tx  m_ty  1 |
+    # ```
+    # @return [Boolean]
+    def invert; end
+    
+    # Check if this is the identity matrix.
+    # @return [Boolean]
+    def is_identity; end
+    alias_method :identity?, :is_identity
+    
+    # Add the translation to this matrix.
+    # 
+    # ```
+    #   //           |  1   0   0 |   | m_11  m_12   0 |
+    #   // matrix' = |  0   1   0 | x | m_21  m_22   0 |
+    #   //           | dx  dy   1 |   | m_tx  m_ty   1 |
+    # ```
+    # @param dx [Float]  The translation in x direction.
+    # @param dy [Float]  The translation in y direction.
+    # @return [void]
+    def translate(dx, dy) end
+    
+    # Add scaling to this matrix.
+    # 
+    # ```
+    #   //           | xScale   0      0 |   | m_11  m_12   0 |
+    #   // matrix' = |   0    yScale   0 | x | m_21  m_22   0 |
+    #   //           |   0      0      1 |   | m_tx  m_ty   1 |
+    # ```
+    # @param xScale [Float]  Scaling in x direction.
+    # @param yScale [Float]  Scaling in y direction.
+    # @return [void]
+    def scale(xScale, yScale) end
+    
+    # Add clockwise rotation to this matrix.
+    # 
+    # ```
+    #   //           | cos    sin   0 |   | m_11  m_12   0 |
+    #   // matrix' = | -sin   cos   0 | x | m_21  m_22   0 |
+    #   //           |  0      0    1 |   | m_tx  m_ty   1 |
+    # ```
+    # @param cRadians [Float]  Rotation angle in radians, clockwise.
+    # @return [void]
+    def rotate(cRadians) end
+    
+  end # AffineMatrix2D
+  
+  # A simple container for 2x2 matrix.
+  # 
+  # This simple structure is used with {Wx::AffineMatrix2D}.
+  # 
+  # Category:  {Wx::Miscellaneous}
+  # 
+  # 
+  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  # @wxrb_require USE_GEOMETRY
+  class Matrix2D < ::Object
+  
+    # The matrix elements in the usual mathematical notation.
+    # 
+    # 
+    # @return [Float]
+    def m_11; end
+    # The matrix elements in the usual mathematical notation.
+    # 
+    # 
+    # @param val [Float]
+    # @return [void]
+    def m_11=(val); end
+    
+    # 
+    # 
+    # 
+    # @return [Float]
+    def m_12; end
+    # 
+    # 
+    # 
+    # @param val [Float]
+    # @return [void]
+    def m_12=(val); end
+    
+    # 
+    # 
+    # 
+    # @return [Float]
+    def m_21; end
+    # 
+    # 
+    # 
+    # @param val [Float]
+    # @return [void]
+    def m_21=(val); end
+    
+    # 
+    # 
+    # 
+    # @return [Float]
+    def m_22; end
+    # 
+    # 
+    # 
+    # @param val [Float]
+    # @return [void]
+    def m_22=(val); end
+    
+    # Default constructor.
+    # 
+    # Initializes the matrix elements to the identity.
+    # @param v11 [Float] 
+    # @param v12 [Float] 
+    # @param v21 [Float] 
+    # @param v22 [Float] 
+    # @return [Wx::Matrix2D]
+    def initialize(v11=1, v12=0, v21=0, v22=1) end
+    
+  end # Matrix2D
+  
+
+end

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

@@ -0,0 +1,275 @@
+# :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.
+  # 
+  # 
+  # 
+  # @wxrb_require USE_ANIMATIONCTRL
+  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)
+    
+    # represents an animated WebP file.
+    # 
+    ANIMATION_TYPE_WEBP = Wx::AnimationType.new(3)
+    
+    # autodetect the filetype.
+    # 
+    ANIMATION_TYPE_ANY = Wx::AnimationType.new(4)
+    
+  end # AnimationType
+  
+  # 
+  # 
+  # 
+  # 
+  # @wxrb_require USE_ANIMATIONCTRL
+  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  page_samples_animate 
+  # 
+  # 
+  # 
+  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  # @wxrb_require USE_ANIMATIONCTRL
+  class Animation < Object
+  
+    # @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.
+    #   @return [Wx::Animation]
+    # @overload initialize(other)
+    #   Copy constructor.
+    #   @param other [Wx::Animation] 
+    #   @return [Wx::Animation]
+    def initialize(*args) end
+    
+    # Returns true if animation data is present.
+    # @return [Boolean]
+    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 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]
+    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 [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 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}.
+    # @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 [Wx::AnimationType] 
+    # @return [Wx::AnimationDecoder]
+    def self.find_handler(animType) end
+    
+    # Load the stock animation decoders (currently GIF, ANI and WebP) 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.
+  # 
+  # 
+  # 
+  # @wxrb_require USE_ANIMATIONCTRL
+  class AnimationDecoder < ::Object
+  
+    # @return [Wx::AnimationDecoder]
+    def initialize; end
+    
+    # Load the animation image frames from the given stream.
+    # @param stream [IO,Wx::InputStream] 
+    # @return [Boolean]
+    def load(stream) end
+    
+    # Returns true if this decoder supports loading from the given stream.
+    # @param stream [IO,Wx::InputStream] 
+    # @return [Boolean]
+    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 [Wx::AnimationType]
+    def get_type; end
+    alias_method :type, :get_type
+    
+    # Convert given frame to {Wx::Image}.
+    # @param frame [Integer] 
+    # @return [Array(Boolean,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 [Wx::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 [Boolean]
+    def do_can_read(stream) end
+    
+  end # AnimationDecoder
+  
+
+end