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

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

@@ -295,13 +295,13 @@ module Wx
     #   true if the call succeeded, false otherwise.
     #   @param width [Integer] 
     #   @param height [Integer] 
-    #   @param clear [true,false] 
-    #   @return [true,false]
+    #   @param clear [Boolean] 
+    #   @return [Boolean]
     # @overload create(sz, clear=true)
     #   This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
     #   @param sz [Array(Integer, Integer), Wx::Size] 
-    #   @param clear [true,false] 
-    #   @return [true,false]
+    #   @param clear [Boolean] 
+    #   @return [Boolean]
     # @overload create(width, height, data)
     #   Creates a fresh image.
     #   See wxImage::wxImage(int,int,unsigned char*,bool) for more info.
@@ -309,12 +309,12 @@ module Wx
     #   @param width [Integer] 
     #   @param height [Integer] 
     #   @param data [String] 
-    #   @return [true,false]
+    #   @return [Boolean]
     # @overload create(sz, data)
     #   This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
     #   @param sz [Array(Integer, Integer), Wx::Size] 
     #   @param data [String] 
-    #   @return [true,false]
+    #   @return [Boolean]
     # @overload create(width, height, data, alpha)
     #   Creates a fresh image.
     #   See wxImage::wxImage(int,int,unsigned char*,unsigned char*,bool) for more info.
@@ -323,13 +323,13 @@ module Wx
     #   @param height [Integer] 
     #   @param data [String] 
     #   @param alpha [String] 
-    #   @return [true,false]
+    #   @return [Boolean]
     # @overload create(sz, data, alpha)
     #   This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
     #   @param sz [Array(Integer, Integer), Wx::Size] 
     #   @param data [String] 
     #   @param alpha [String] 
-    #   @return [true,false]
+    #   @return [Boolean]
     def create(*args) end
     
     # Initialize the image data with zeroes (the default) or with the byte value given as value.
@@ -372,7 +372,7 @@ module Wx
     
     # Returns a mirrored copy of the image.
     # The parameter horizontally indicates the orientation.
-    # @param horizontally [true,false] 
+    # @param horizontally [Boolean] 
     # @return [Wx::Image]
     def mirror(horizontally=true) end
     
@@ -381,7 +381,7 @@ module Wx
     # @param image [Wx::Image]  The image containing the data to copy, must be valid.
     # @param x [Integer]  The horizontal position of the position to copy the data to.
     # @param y [Integer]  The vertical position of the position to copy the data to.
-    # @param alphaBlend [ImageAlphaBlendMode]  This parameter (new in wx 3.1.5) determines whether the alpha values of the original image replace (default) or are composed with the alpha channel of this image. Notice that alpha blending overrides the mask handling.
+    # @param alphaBlend [Wx::ImageAlphaBlendMode]  This parameter (new in wx 3.1.5) determines whether the alpha values of the original image replace (default) or are composed with the alpha channel of this image. Notice that alpha blending overrides the mask handling.
     # @return [void]
     def paste(image, x, y, alphaBlend=Wx::ImageAlphaBlendMode::IMAGE_ALPHA_BLEND_OVER) end
     
@@ -400,7 +400,7 @@ module Wx
     # @see Wx::Image#scale 
     # @param width [Integer] 
     # @param height [Integer] 
-    # @param quality [ImageResizeQuality] 
+    # @param quality [Wx::ImageResizeQuality] 
     # @return [Wx::Image]
     def rescale(width, height, quality=Wx::ImageResizeQuality::IMAGE_QUALITY_NORMAL) end
     
@@ -423,13 +423,13 @@ module Wx
     # Returns the rotated image, leaving this image intact.
     # @param angle [Float] 
     # @param rotationCentre [Array(Integer, Integer), Wx::Point] 
-    # @param interpolating [true,false] 
+    # @param interpolating [Boolean] 
     # @param offsetAfterRotation [Wx::Point] 
     # @return [Wx::Image]
     def rotate(angle, rotationCentre, interpolating=true, offsetAfterRotation=nil) end
     
     # Returns a copy of the image rotated 90 degrees in the direction indicated by clockwise.
-    # @param clockwise [true,false] 
+    # @param clockwise [Boolean] 
     # @return [Wx::Image]
     def rotate90(clockwise=true) end
     
@@ -487,7 +487,7 @@ module Wx
     # @see Wx::Image#rescale 
     # @param width [Integer] 
     # @param height [Integer] 
-    # @param quality [ImageResizeQuality] 
+    # @param quality [Wx::ImageResizeQuality] 
     # @return [Wx::Image]
     def scale(width, height, quality=Wx::ImageResizeQuality::IMAGE_QUALITY_NORMAL) end
     
@@ -510,7 +510,7 @@ module Wx
     #   The mask colour is chosen automatically using {Wx::Image#find_first_unused_colour}, see the overload below if this is not appropriate.
     #   Returns true on success, false on error.
     #   @param threshold [Integer] 
-    #   @return [true,false]
+    #   @return [Boolean]
     # @overload convert_alpha_to_mask(mr, mg, mb, threshold=Wx::IMAGE_ALPHA_THRESHOLD)
     #   If the image has alpha channel, this method converts it to mask using the specified colour as the mask colour.
     #   If the image has an alpha channel, all pixels with alpha value less than threshold are replaced with the mask colour and the alpha channel is removed. Otherwise nothing is done.
@@ -520,7 +520,7 @@ module Wx
     #   @param mg [Integer]  The green component of the mask colour.
     #   @param mb [Integer]  The blue component of the mask colour.
     #   @param threshold [Integer]  Pixels with alpha channel values below the given threshold are considered to be transparent, i.e. the corresponding mask pixels are set. Pixels with the alpha values above the threshold are considered to be opaque.
-    #   @return [true,false]
+    #   @return [Boolean]
     def convert_alpha_to_mask(*args) end
     
     # @overload convert_to_greyscale(weight_r, weight_g, weight_b)
@@ -568,7 +568,7 @@ module Wx
     # @param startR [Integer] 
     # @param startG [Integer] 
     # @param startB [Integer] 
-    # @return [Array(true,false,Integer,Integer,Integer)]
+    # @return [Array(Boolean,Integer,Integer,Integer)]
     def find_first_unused_colour(startR=1, startG=0, startB=0) end
     
     # Returns the red intensity at the given coordinate.
@@ -704,7 +704,7 @@ module Wx
     
     # Get the current mask colour or find a suitable unused colour that could be used as a mask colour.
     # Returns true if the image currently has a mask.
-    # @return [Array(true,false,Integer,Integer,Integer)]
+    # @return [Array(Boolean,Integer,Integer,Integer)]
     def get_or_find_mask_colour; end
     alias_method :or_find_mask_colour, :get_or_find_mask_colour
     
@@ -722,7 +722,7 @@ module Wx
     alias_method :sub_image, :get_sub_image
     
     # Gets the type of image found by {Wx::Image#load_file} or specified with {Wx::Image#save_file}.
-    # @return [BitmapType]
+    # @return [Wx::BitmapType]
     def get_type; end
     alias_method :type, :get_type
     
@@ -730,12 +730,12 @@ module Wx
     # 
     # @see Wx::Image#get_alpha
     # @see  Wx::Image#set_alpha 
-    # @return [true,false]
+    # @return [Boolean]
     def has_alpha; end
     alias_method :has_alpha?, :has_alpha
     
     # Returns true if there is a mask active, false otherwise.
-    # @return [true,false]
+    # @return [Boolean]
     def has_mask; end
     alias_method :has_mask?, :has_mask
     
@@ -746,12 +746,12 @@ module Wx
     # @see  Wx::Image#get_option
     # @see  Wx::Image#get_option_int 
     # @param name [String] 
-    # @return [true,false]
+    # @return [Boolean]
     def has_option(name) end
     alias_method :has_option?, :has_option
     
     # Returns true if image data is present.
-    # @return [true,false]
+    # @return [Boolean]
     def is_ok; end
     alias_method :ok?, :is_ok
     
@@ -759,7 +759,7 @@ module Wx
     # @param x [Integer] 
     # @param y [Integer] 
     # @param threshold [Integer] 
-    # @return [true,false]
+    # @return [Boolean]
     def is_transparent(x, y, threshold=Wx::IMAGE_ALPHA_THRESHOLD) end
     alias_method :transparent?, :is_transparent
     
@@ -778,7 +778,7 @@ module Wx
     #   ```
     #   @see Wx::Image#save_file 
     #   @param stream [IO,Wx::InputStream]  Opened input stream from which to load the image. Currently, the stream must support seeking.
-    #   @param type [BitmapType]  May be one of the following: 
+    #   @param type [Wx::BitmapType]  May be one of the following: 
     #     
     #     - {Wx::BitmapType::BITMAP_TYPE_BMP}: Load a Windows bitmap file. 
     #     
@@ -806,29 +806,29 @@ module Wx
     #     
     #     - {Wx::BitmapType::BITMAP_TYPE_ANY}: Will try to autodetect the format.
     #   @param index [Integer]  Index of the image to load in the case that the image file contains multiple images. This is only used by GIF, ICO and TIFF handlers. The default value (-1) means "choose the default image" and is interpreted as the first image (index=0) by the GIF and TIFF handler and as the largest and most colourful one by the ICO handler.
-    #   @return [true,false]
+    #   @return [Boolean]
     # @overload load_stream(stream, mimetype, index=-1)
     #   Loads an image from an input stream.
     #   @param stream [IO,Wx::InputStream]  Opened input stream from which to load the image. Currently, the stream must support seeking.
     #   @param mimetype [String]  MIME type string (for example 'image/jpeg')
     #   @param index [Integer]  See the description in the LoadFile(wxInputStream&, wxBitmapType, int) overload.
-    #   @return [true,false]
+    #   @return [Boolean]
     def load_stream(*args) end
     
     # @overload load_file(name, type=Wx::BitmapType::BITMAP_TYPE_ANY, index=-1)
     #   Loads an image from a file.
     #   If no handler type is provided, the library will try to autodetect the format.
     #   @param name [String]  Name of the file from which to load the image.
-    #   @param type [BitmapType]  See the description in the LoadFile(wxInputStream&, wxBitmapType, int) overload.
+    #   @param type [Wx::BitmapType]  See the description in the LoadFile(wxInputStream&, wxBitmapType, int) overload.
     #   @param index [Integer]  See the description in the LoadFile(wxInputStream&, wxBitmapType, int) overload.
-    #   @return [true,false]
+    #   @return [Boolean]
     # @overload load_file(name, mimetype, index=-1)
     #   Loads an image from a file.
     #   If no handler type is provided, the library will try to autodetect the format.
     #   @param name [String]  Name of the file from which to load the image.
     #   @param mimetype [String]  MIME type string (for example 'image/jpeg')
     #   @param index [Integer]  See the description in the LoadFile(wxInputStream&, wxBitmapType, int) overload.
-    #   @return [true,false]
+    #   @return [Boolean]
     def load_file(*args) end
     
     # @overload write(stream, mimetype)
@@ -845,18 +845,18 @@ module Wx
     #   @see Wx::Image#load_file 
     #   @param stream [IO,Wx::OutputStream]  Opened output stream to save the image to.
     #   @param mimetype [String]  MIME type.
-    #   @return [true,false]
+    #   @return [Boolean]
     # @overload write(stream, type)
     #   Saves an image in the given stream.
     #   @param stream [IO,Wx::OutputStream]  Opened output stream to save the image to.
-    #   @param type [BitmapType]  MIME type.
-    #   @return [true,false]
+    #   @param type [Wx::BitmapType]  MIME type.
+    #   @return [Boolean]
     def write(*args) end
     
     # @overload save_file(name, type)
     #   Saves an image in the named file.
     #   @param name [String]  Name of the file to save the image to.
-    #   @param type [BitmapType]  Currently these types can be used: 
+    #   @param type [Wx::BitmapType]  Currently these types can be used: 
     #     
     #     - {Wx::BitmapType::BITMAP_TYPE_BMP}: Save a BMP image file. 
     #     
@@ -875,17 +875,17 @@ module Wx
     #     - {Wx::BitmapType::BITMAP_TYPE_ICO}: Save a Windows icon file (ICO). The size may be up to 255 wide by 127 high. A single image is saved in 8 colors at the size supplied. 
     #     
     #     - {Wx::BitmapType::BITMAP_TYPE_CUR}: Save a Windows cursor file (CUR).
-    #   @return [true,false]
+    #   @return [Boolean]
     # @overload save_file(name, mimetype)
     #   Saves an image in the named file.
     #   @param name [String]  Name of the file to save the image to.
     #   @param mimetype [String]  MIME type.
-    #   @return [true,false]
+    #   @return [Boolean]
     # @overload save_file(name)
     #   Saves an image in the named file.
     #   File type is determined from the extension of the file name. Note that this function may fail if the extension is not recognized! You can use one of the forms above to save images to files with non-standard extensions.
     #   @param name [String]  Name of the file to save the image to.
-    #   @return [true,false]
+    #   @return [Boolean]
     def save_file(*args) end
     
     # This function is similar to {Wx::Image#set_data} and has similar restrictions.
@@ -936,7 +936,7 @@ module Wx
     
     # Specifies whether there is a mask or not.
     # The area of the mask is determined by the current mask colour.
-    # @param hasMask [true,false] 
+    # @param hasMask [Boolean] 
     # @return [void]
     def set_mask(hasMask=true) end
     alias_method :mask=, :set_mask
@@ -959,7 +959,7 @@ module Wx
     # @param mr [Integer] 
     # @param mg [Integer] 
     # @param mb [Integer] 
-    # @return [true,false]
+    # @return [Boolean]
     def set_mask_from_image(mask, mr, mg, mb) end
     
     # @overload set_option(name, value)
@@ -1008,7 +1008,7 @@ module Wx
     # Set the type of image returned by {Wx::Image#get_type}.
     # This method is mostly used internally by the library but can also be called from the user code if the image was created from data in the given bitmap format without using {Wx::Image#load_file} (which would set the type correctly automatically).
     # Notice that the image must be created before this function is called.
-    # @param type [BitmapType]  One of bitmap type constants, {Wx::BitmapType::BITMAP_TYPE_INVALID} is a valid value for it and can be used to reset the bitmap type to default but {Wx::BITMAP_TYPE_MAX} is not allowed here.
+    # @param type [Wx::BitmapType]  One of bitmap type constants, {Wx::BitmapType::BITMAP_TYPE_INVALID} is a valid value for it and can be used to reset the bitmap type to default but {Wx::BITMAP_TYPE_MAX} is not allowed here.
     # @return [void]
     def set_type(type) end
     alias_method :type=, :set_type
@@ -1056,7 +1056,7 @@ module Wx
     # 
     # Number of available images. For most image handlers, this is 1 (exceptions are TIFF and ICO formats as well as animated GIFs for which this function returns the number of frames in the animation).
     # @param filename [String] 
-    # @param type [BitmapType] 
+    # @param type [Wx::BitmapType] 
     # @return [Integer]
     def self.get_image_count(filename, type=Wx::BitmapType::BITMAP_TYPE_ANY) end
     
@@ -1068,12 +1068,12 @@ module Wx
     #   Does not create an alpha channel.
     #   @param width [Integer]  Specifies the width of the image.
     #   @param height [Integer]  Specifies the height of the image.
-    #   @param clear [true,false]  If true, initialize the image to black.
+    #   @param clear [Boolean]  If true, initialize the image to black.
     #   @return [Wx::Image]
     # @overload initialize(sz, clear=true)
     #   This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
     #   @param sz [Array(Integer, Integer), Wx::Size] 
-    #   @param clear [true,false] 
+    #   @param clear [Boolean] 
     #   @return [Wx::Image]
     # @overload initialize(width, height, data)
     #   Creates an image from data in memory.
@@ -1101,11 +1101,6 @@ module Wx
     #   @param data [String] 
     #   @param alpha [String] 
     #   @return [Wx::Image]
-    # @overload initialize(xpmData)
-    #   Creates an image from XPM data.
-    #   This constructor has become explicit in wxWidgets 3.1.6.
-    #   @param xpmData [char]  A pointer to XPM image data.
-    #   @return [Wx::Image]
     # @overload initialize(name, type=Wx::BitmapType::BITMAP_TYPE_ANY, index=-1)
     #   Creates an image from a file.
     #   Depending on how wxWidgets has been configured and by which handlers have been loaded, not all formats may be available. Any handler other than BMP must be previously initialized with {Wx::Image.add_handler} or {init_all_image_handlers}.
@@ -1117,7 +1112,7 @@ module Wx
     #   ```
     #   @see Wx::Image#load_file 
     #   @param name [String]  Name of the file from which to load the image.
-    #   @param type [BitmapType]  May be one of the following: 
+    #   @param type [Wx::BitmapType]  May be one of the following: 
     #     
     #     - {Wx::BitmapType::BITMAP_TYPE_BMP}: Load a Windows bitmap file. 
     #     
@@ -1164,12 +1159,12 @@ module Wx
     #   Returns true if at least one of the available image handlers can read the file with the given name.
     #   See Wx::ImageHandler::CanRead for more info.
     #   @param filename [String] 
-    #   @return [true,false]
+    #   @return [Boolean]
     # @overload self.can_read(stream)
     #   Returns true if at least one of the available image handlers can read the data in the given stream.
     #   See Wx::ImageHandler::CanRead for more info.
     #   @param stream [IO,Wx::InputStream] 
-    #   @return [true,false]
+    #   @return [Boolean]
     def self.can_read(*args) end
     
     # Returns the currently used default file load flags.

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

@@ -52,7 +52,7 @@ module Wx
     #   @see Wx::ImageList#create 
     #   @param width [Integer]  Width of the images in the list.
     #   @param height [Integer]  Height of the images in the list.
-    #   @param mask [true,false]  If true, all images will have masks, with the mask being created from the light grey pixels if not specified otherwise, i.e. if the image doesn't have neither alpha channel nor mask and no mask is explicitly specified when adding it. Note that if an image does have alpha channel or mask, it will always be used, whether this parameter is true or false.
+    #   @param mask [Boolean]  If true, all images will have masks, with the mask being created from the light grey pixels if not specified otherwise, i.e. if the image doesn't have neither alpha channel nor mask and no mask is explicitly specified when adding it. Note that if an image does have alpha channel or mask, it will always be used, whether this parameter is true or false.
     #   @param initialCount [Integer]  The initial size of the list.
     #   @return [Wx::ImageList]
     def initialize(*args) end
@@ -85,13 +85,13 @@ module Wx
     def add(*args) end
     
     # Initializes the list.
-    # See {Wx::ImageList#image_list} for details.
+    # See {Wx::ImageList#initialize} for details.
     # This function can be called only once after creating the object using its default ctor or after calling {Wx::ImageList#destroy}.
     # @param width [Integer] 
     # @param height [Integer] 
-    # @param mask [true,false] 
+    # @param mask [Boolean] 
     # @param initialCount [Integer] 
-    # @return [true,false]
+    # @return [Boolean]
     def create(width, height, mask=true, initialCount=1) end
     
     # Destroys the current list.
@@ -111,8 +111,8 @@ module Wx
     #   - {Wx::IMAGELIST_DRAW_TRANSPARENT}: Draw the image with transparency.
     #   - {Wx::IMAGELIST_DRAW_SELECTED}: Draw the image in selected state.
     #   - {Wx::IMAGELIST_DRAW_FOCUSED}: Draw the image in a focused state.
-    # @param solidBackground [true,false]  For optimisation - drawing can be faster if the function is told that the background is solid.
-    # @return [true,false]
+    # @param solidBackground [Boolean]  For optimisation - drawing can be faster if the function is told that the background is solid.
+    # @return [Boolean]
     def draw(index, dc, x, y, flags=Wx::IMAGELIST_DRAW_NORMAL, solidBackground=false) end
     
     # Returns the bitmap corresponding to the given index.
@@ -132,29 +132,19 @@ module Wx
     def get_image_count; end
     alias_method :image_count, :get_image_count
     
-    # @overload get_size(index, width, height)
-    #   Retrieves the size of the images in the list.
-    #   Currently, the index parameter is ignored as all images in the list have the same size.
-    #   
-    #   true if the function succeeded, false if it failed (for example, if the image list was not yet initialized).
-    #   @param index [Integer]  currently unused, should be 0
-    #   @param width [int]  receives the width of the images in the list
-    #   @param height [int]  receives the height of the images in the list
-    #   @return [true,false]
-    # @overload get_size()
-    #   Retrieves the size of the image list as passed to {Wx::ImageList#create}.
-    #   the size of the image list, which may be zero if the image list was not yet initialised.
-    #   @return [Wx::Size]
-    def get_size(*args) end
+    # Retrieves the size of the image list as passed to {Wx::ImageList#create}.
+    # the size of the image list, which may be zero if the image list was not yet initialised.
+    # @return [Wx::Size]
+    def get_size; end
     alias_method :size, :get_size
     
     # Removes the image at the given position.
     # @param index [Integer] 
-    # @return [true,false]
+    # @return [Boolean]
     def remove(index) end
     
     # Removes all the images in the list.
-    # @return [true,false]
+    # @return [Boolean]
     def remove_all; end
     
     # @overload replace(index, bitmap, mask=Wx::NULL_BITMAP)
@@ -165,7 +155,7 @@ module Wx
     #   @param index [Integer]  The index of the bitmap to be replaced.
     #   @param bitmap [Wx::Bitmap]  Bitmap representing the opaque areas of the image.
     #   @param mask [Wx::Bitmap]  Monochrome mask bitmap, representing the transparent areas of the image.
-    #   @return [true,false]
+    #   @return [Boolean]
     # @overload replace(index, icon)
     #   Replaces the existing image with the new image.
     #   true if the replacement was successful, false otherwise.
@@ -175,7 +165,7 @@ module Wx
     #   Availability:  only available for the wxMSW, wxOSX/Cocoa ports.  {Wx::msw},{Wx::osx}
     #   @param index [Integer]  The index of the bitmap to be replaced.
     #   @param icon [Wx::Icon]  Icon to use as the image.
-    #   @return [true,false]
+    #   @return [Boolean]
     def replace(*args) end
     
   end # ImageList

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

@@ -0,0 +1,152 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # An info bar is a transient window shown at top or bottom of its parent window to display non-critical information to the user.
+  # This class provides another way to show messages to the user, intermediate between message boxes and status bar messages. The message boxes are modal and thus interrupt the users work flow and should be used sparingly for this reason. However status bar messages are often too easy not to notice at all. An info bar provides a way to present the messages which has a much higher chance to be noticed by the user but without being annoying.
+  # Info bar may show an icon (on the left), text message and, optionally, buttons allowing the user to react to the information presented. Unless a custom button was added to the info bar, it also has a close button at the right allowing the user to dismiss it so it isn't necessary to provide a button just to close it.
+  # {Wx::InfoBar} calls its parent {Wx::Window#layout} method and assumes that it will change the parent layout appropriately depending on whether the info bar itself is shown or hidden. Usually this is achieved by simply using a sizer for the parent window layout and adding {Wx::InfoBar} to this sizer as one of the items. Considering the usual placement of the info bars, normally this sizer should be a vertical {Wx::BoxSizer} and the bar its first or last element so the simplest possible example of using this class would be: 
+  # ```
+  #   class MyFrame : public wxFrame
+  #   {
+  #       ...
+  #   
+  #       wxInfoBar *m_infoBar;
+  #   };
+  #   
+  #   MyFrame::MyFrame()
+  #   {
+  #       ...
+  #       m_infoBar = new wxInfoBar(this);
+  #   
+  #       wxSizer *sizer = new wxBoxSizer(wxVERTICAL);
+  #       sizer->Add(m_infoBar, wxSizerFlags().Expand());
+  #       ... add other frame controls to the sizer ...
+  #       SetSizer(sizer);
+  #   }
+  #   
+  #   void MyFrame::SomeMethod()
+  #   {
+  #       m_infoBar->ShowMessage("Something happened", wxICON_INFORMATION);
+  #   }
+  # ```
+  # 
+  # See the dialogs sample for more sophisticated examples.
+  # Currently this class is implemented generically (i.e. in the same platform-independent way for all ports) and also natively in wxGTK but the native implementation requires GTK+ 2.18 version or later (this requirement should be satisfied by any desktop systems currently in use).
+  # === 
+  # 
+  # Category:  Miscellaneous Windows
+  # @see Wx::StatusBar
+  # @see  Wx::MessageDialog
+  # 
+  # 
+  class InfoBar < Control
+  
+    # Set the effects to use when showing and hiding the bar.
+    # Either or both of the parameters can be set to {Wx::ShowEffect::SHOW_EFFECT_NONE} to disable using effects entirely.
+    # By default, the info bar uses {Wx::ShowEffect::SHOW_EFFECT_SLIDE_TO_BOTTOM} effect for showing itself and {Wx::ShowEffect::SHOW_EFFECT_SLIDE_TO_TOP} for hiding if it is the first element of the containing sizer and reverse effects if it's the last one. If it is neither the first nor the last element, no effect is used to avoid the use of an inappropriate one and this function must be called if an effect is desired.
+    # @param showEffect [Wx::ShowEffect]  The effect to use when showing the bar.
+    # @param hideEffect [Wx::ShowEffect]  The effect to use when hiding the bar.
+    # @return [void]
+    def set_show_hide_effects(showEffect, hideEffect) end
+    
+    # Return the effect currently used for showing the bar.
+    # @return [Wx::ShowEffect]
+    def get_show_effect; end
+    alias_method :show_effect, :get_show_effect
+    
+    # Return the effect currently used for hiding the bar.
+    # @return [Wx::ShowEffect]
+    def get_hide_effect; end
+    alias_method :hide_effect, :get_hide_effect
+    
+    # Set the duration of the animation used when showing or hiding the bar.
+    # By default, 500ms duration is used.
+    # @param duration [Integer]  Duration of the animation, in milliseconds.
+    # @return [void]
+    def set_effect_duration(duration) end
+    alias_method :effect_duration=, :set_effect_duration
+    
+    # Return the effect animation duration currently used.
+    # @return [Integer]
+    def get_effect_duration; end
+    alias_method :effect_duration, :get_effect_duration
+    
+    # @overload initialize()
+    #   Default constructor.
+    #   Use {Wx::InfoBar#create} for the objects created using this constructor.
+    #   @return [Wx::InfoBar]
+    # @overload initialize(parent, winid=Wx::StandardID::ID_ANY)
+    #   Constructor creating the info bar window.
+    #   
+    #   @see Wx::InfoBar#create 
+    #   @param parent [Wx::Window] 
+    #   @param winid [Integer] 
+    #   @return [Wx::InfoBar]
+    def initialize(*args) end
+    
+    # Create the info bar window.
+    # Notice that unlike most of the other {Wx::Window}-derived classes, {Wx::InfoBar} is created hidden and is only shown when {Wx::InfoBar#show_message} is called. This is more convenient as usually the info bar is created to be shown at some later time and not immediately and so creating it hidden avoids the need to call {Wx::InfoBar#hide} explicitly from the code using it.
+    # This should be only called if the object was created using its default constructor.
+    # @param parent [Wx::Window]  A valid parent window pointer.
+    # @param winid [Integer]  The id of the info bar window, usually unused as currently no events are generated by this class.
+    # @return [Boolean]
+    def create(parent, winid=Wx::StandardID::ID_ANY) end
+    
+    # Add a button to be shown in the info bar.
+    # The button added by this method will be shown to the right of the text (in LTR layout), with each successive button being added to the right of the previous one. If any buttons are added to the info bar using this method, the default "Close" button is not shown as it is assumed that the extra buttons already allow the user to close it.
+    # Clicking the button will generate a normal EVT_COMMAND_BUTTON_CLICKED event which can be handled as usual. The default handler in {Wx::InfoBar} itself closes the window whenever a button in it is clicked so if you wish the info bar to be hidden when the button is clicked, simply call <code>event.Skip()</code> in the button handler to let the base class handler do it (calling {Wx::InfoBar#dismiss} explicitly works too, of course). On the other hand, if you don't skip the event, the info bar will remain opened so make sure to do it for at least some buttons to allow the user to close it.
+    # Notice that the generic {Wx::InfoBar} implementation handles the button events itself and so they are not propagated to the info bar parent and you need to either inherit from {Wx::InfoBar} and handle them in your derived class or use {Wx::EvtHandler#bind}, as is done in the dialogs sample, to handle the button events in the parent frame.
+    # @param btnid [Integer]  Id of the button. It will be used in the button message clicking this button will generate.
+    # @param label [String]  The label of the button. It may only be empty if btnid is one of the stock ids in which case the corresponding stock label (see {get_stock_label}) will be used.
+    # @return [void]
+    def add_button(btnid, label=(())) end
+    
+    # Hide the info bar window.
+    # This method hides the window and lays out the parent window to account for its disappearance (unlike a simple {Wx::InfoBar#hide}).
+    # @return [void]
+    def dismiss; end
+    
+    # Remove a button previously added by {Wx::InfoBar#add_button}.
+    # @param btnid [Integer]  Id of the button to remove. If more than one button with the same id is used in the info bar (which is in any case not recommended), the last, i.e. most recently added, button with this id is removed.
+    # @return [void]
+    def remove_button(btnid) end
+    
+    # Show a message in the bar.
+    # If the bar is currently hidden, it will be shown. Otherwise its message will be updated in place.
+    # @param msg [String]  The text of the message.
+    # @param flags [Integer]  One of {Wx::ICON_NONE}, {Wx::ICON_INFORMATION} (default), {Wx::ICON_QUESTION}, {Wx::ICON_WARNING} or {Wx::ICON_ERROR} values. These flags have the same meaning as in {Wx::MessageDialog} for the generic version, i.e. show (or not, in case of {Wx::ICON_NONE}) the corresponding icon in the bar but can be interpreted by the native versions. For example, the GTK+ native implementation doesn't show icons at all but uses this parameter to select the appropriate background colour for the notification.
+    # @return [void]
+    def show_message(msg, flags=Wx::ICON_INFORMATION) end
+    
+    # Returns the number of currently shown buttons.
+    # This is simply the number of calls to {Wx::InfoBar#add_button} minus the number of calls to {Wx::InfoBar#remove_button} so far.
+    # The number of currently shown buttons, possibly 0.
+    # @return [Integer]
+    def get_button_count; end
+    alias_method :button_count, :get_button_count
+    
+    # Returns the ID of the button at the given position.
+    # The positions of the buttons are counted in order of their addition.
+    # 
+    # The ID of the button at the given position or {Wx::StandardID::ID_NONE} if it is out of range (this also results in an assertion failure).
+    # @param idx [Integer]  The position of the button in 0 to {Wx::InfoBar#get_button_count} range.
+    # @return [Integer]
+    def get_button_id(idx) end
+    alias_method :button_id, :get_button_id
+    
+    # Returns whether a button with the given ID is currently shown.
+    # true if the button with this ID is currently shown.
+    # @param btnid [Integer]  ID of the button to check for.
+    # @return [Boolean]
+    def has_button_id(btnid) end
+    alias_method :has_button_id?, :has_button_id
+    
+  end # InfoBar
+  
+
+end