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

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

@@ -255,9 +255,21 @@ module Wx
   # 
   # == Available image handlers
   # 
-  # The following image handlers are available. {Wx::BMPHandler} is always installed by default. To use other image formats, install the appropriate handler with {Wx::Image.add_handler} or call {init_all_image_handlers}.
-  # 
-  # - {Wx::BMPHandler}: For loading (including alpha support) and saving, always installed.- {Wx::PNGHandler}: For loading and saving. Includes alpha support.- {Wx::JPEGHandler}: For loading and saving.- {Wx::GIFHandler}: For loading and saving (see below).- {Wx::PCXHandler}: For loading and saving (see below).- {Wx::PNMHandler}: For loading and saving (see below).- {Wx::TIFFHandler}: For loading and saving. Includes alpha support.- {Wx::TGAHandler}: For loading and saving. Includes alpha support.- {Wx::IFFHandler}: For loading only.- {Wx::XPMHandler}: For loading and saving.- {Wx::ICOHandler}: For loading and saving.- {Wx::CURHandler}: For loading and saving.- {Wx::ANIHandler}: For loading only.
+  # The following image handlers are available. {Wx::BMPHandler} is always installed by default. In wxRuby all image handlers are loaded by default at startup by {init_all_image_handlers}.
+  # 
+  # - {Wx::BMPHandler}: For loading (including alpha support) and saving, always installed.
+  # - {Wx::PNGHandler}: For loading and saving. Includes alpha support.
+  # - {Wx::JPEGHandler}: For loading and saving.
+  # - {Wx::GIFHandler}: For loading and saving (see below).
+  # - {Wx::PCXHandler}: For loading and saving (see below).
+  # - {Wx::PNMHandler}: For loading and saving (see below).
+  # - {Wx::TIFFHandler}: For loading and saving. Includes alpha support.
+  # - {Wx::TGAHandler}: For loading and saving. Includes alpha support.
+  # - {Wx::IFFHandler}: For loading only.
+  # - {Wx::XPMHandler}: For loading and saving.
+  # - {Wx::ICOHandler}: For loading and saving.
+  # - {Wx::CURHandler}: For loading and saving.
+  # - {Wx::ANIHandler}: For loading only.
   # 
   # When saving in PCX format, {Wx::PCXHandler} will count the number of different colours in the image; if there are 256 or less colours, it will save as 8 bit, else it will save as 24 bit.
   # Loading PNMs only works for ASCII or raw RGB images. When saving in PNM format, {Wx::PNMHandler} will always save as raw RGB.
@@ -283,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.
@@ -297,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.
@@ -311,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.
@@ -360,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
     
@@ -369,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
     
@@ -388,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
     
@@ -411,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
     
@@ -456,27 +468,26 @@ module Wx
     # It should be noted that although using {Wx::ImageResizeQuality::IMAGE_QUALITY_HIGH} produces much nicer looking results it is a slower method. Downsampling will use the box averaging method which seems to operate very fast. If you are upsampling larger images using this method you will most likely notice that it is a bit slower and in extreme cases it will be quite substantially slower as the bicubic algorithm has to process a lot of data.
     # It should also be noted that the high quality scaling may not work as expected when using a single mask colour for transparency, as the scaling will blur the image and will therefore remove the mask partially. Using the alpha channel will work.
     # Example: 
-    # ```
-    #   // get the bitmap from somewhere
-    #   wxBitmap bmp = ...;
+    # ```ruby
+    #   # get the bitmap from somewhere
+    #   bmp = ...
     #   
-    #   // rescale it to have size of 32*32
-    #   if ( bmp.GetWidth() != 32 || bmp.GetHeight() != 32 )
-    #   {
-    #       wxImage image = bmp.ConvertToImage();
-    #       bmp = wxBitmap(image.Scale(32, 32));
+    #   # rescale it to have size of 32*32
+    #   if bmp.width != 32 || bmp.height != 32
+    #      image = bmp.convert_to_image
+    #      bmp = Wx::Bitmap.new(image.scale(32, 32))
     #   
-    #       // another possibility:
-    #       image.Rescale(32, 32);
-    #       bmp = image;
-    #   }
+    #      # another possibility:
+    #      image.rescale(32, 32)
+    #      bmp = image.to_bitmap
+    #   end
     # ```
     # 
     # The algorithm used for the default (normal) quality value doesn't work with images larger than 65536 (2^16) pixels in either dimension for 32-bit programs. For 64-bit programs the limit is 2^48 and so not relevant in practice.
     # @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
     
@@ -499,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.
@@ -509,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)
@@ -547,28 +558,6 @@ module Wx
     # @return [Wx::Image]
     def change_lightness(alpha) end
     
-    # Computes the histogram of the image.
-    # histogram is a reference to {Wx::ImageHistogram} object. {Wx::ImageHistogram} is a specialization of {Wx::HashMap} "template" and is defined as follows:
-    # 
-    # ```
-    #   class WXDLLEXPORT wxImageHistogramEntry
-    #   {
-    #   public:
-    #       wxImageHistogramEntry() : index(0), value(0) {}
-    #       unsigned long index;
-    #       unsigned long value;
-    #   };
-    #   
-    #   WX_DECLARE_EXPORTED_HASH_MAP(unsigned long, wxImageHistogramEntry,
-    #                               wxIntegerHash, wxIntegerEqual,
-    #                               wxImageHistogram);
-    # ```
-    # 
-    # Returns number of colours in the histogram.
-    # @param histogram [Wx::ImageHistogram] 
-    # @return [Integer]
-    def compute_histogram(histogram) end
-    
     # Finds the first colour that is never used in the image.
     # The search begins at given initial colour and continues by increasing R, G and B components (in this order) by 1 until an unused colour is found or the colour space exhausted.
     # The parameters r, g, b are pointers to variables to save the colour.
@@ -579,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.
@@ -643,9 +632,11 @@ module Wx
     
     # Gets a user-defined string-valued option.
     # Generic options: 
+    # 
     # - {Wx::IMAGE_OPTION_FILENAME}: The name of the file from which the image was loaded.
     # 
     # Options specific to {Wx::GIFHandler}: 
+    # 
     # - {Wx::IMAGE_OPTION_GIF_COMMENT}: The comment text that is read from or written to the GIF file. In an animated GIF each frame can have its own comment. If there is only a comment in the first frame of a GIF it will not be repeated in other frames.
     # 
     # The value of the option or an empty string if not found. Use {Wx::Image#has_option} if an empty string can be a valid option value.
@@ -660,9 +651,11 @@ module Wx
     # Gets a user-defined integer-valued option.
     # The function is case-insensitive to name. If the given option is not present, the function returns 0. Use {Wx::Image#has_option} if 0 is a possibly valid value for the option.
     # Generic options: 
+    # 
     # - {Wx::IMAGE_OPTION_MAX_WIDTH} and {Wx::IMAGE_OPTION_MAX_HEIGHT}: If either of these options is specified, the loaded image will be scaled down (preserving its aspect ratio) so that its width is less than the max width given if it is not 0 and its height is less than the max height given if it is not 0. This is typically used for loading thumbnails and the advantage of using these options compared to calling {Wx::Image#rescale} after loading is that some handlers (only JPEG one right now) support rescaling the image during loading which is vastly more efficient than loading the entire huge image and rescaling it later (if these options are not supported by the handler, this is still what happens however). These options must be set before calling {Wx::Image#load_file} to have any effect.
     # 
     # - {Wx::IMAGE_OPTION_ORIGINAL_WIDTH} and {Wx::IMAGE_OPTION_ORIGINAL_HEIGHT}: These options will return the original size of the image if either {Wx::IMAGE_OPTION_MAX_WIDTH} or {Wx::IMAGE_OPTION_MAX_HEIGHT} is specified. 
+    # 
     # - {Wx::IMAGE_OPTION_QUALITY}: JPEG quality used when saving. This is an integer in 0..100 range with 0 meaning very poor and 100 excellent (but very badly compressed). This option is currently ignored for the other formats.
     # 
     # - {Wx::IMAGE_OPTION_RESOLUTIONUNIT}: The value of this option determines whether the resolution of the image is specified in centimetres or inches, see {Wx::ImageResolution} enum elements.
@@ -670,21 +663,33 @@ module Wx
     # - {Wx::IMAGE_OPTION_RESOLUTION}, {Wx::IMAGE_OPTION_RESOLUTIONX} and {Wx::IMAGE_OPTION_RESOLUTIONY}: These options define the resolution of the image in the units corresponding to {Wx::IMAGE_OPTION_RESOLUTIONUNIT} options value. The first option can be set before saving the image to set both horizontal and vertical resolution to the same value. The X and Y options are set by the image handlers if they support the image resolution (currently BMP, JPEG and TIFF handlers do) and the image provides the resolution information and can be queried after loading the image.
     # 
     # Options specific to {Wx::PNGHandler}: 
+    # 
     # - {Wx::IMAGE_OPTION_PNG_FORMAT}: Format for saving a PNG file, see {Wx::ImagePNGType} for the supported values. 
+    # 
     # - {Wx::IMAGE_OPTION_PNG_BITDEPTH}: Bit depth for every channel (R/G/B/A). 
+    # 
     # - {Wx::IMAGE_OPTION_PNG_FILTER}: Filter for saving a PNG file, see libpng (http://www.libpng.org/pub/png/libpng-1.2.5-manual.html) for possible values (e.g. PNG_FILTER_NONE, PNG_FILTER_SUB, PNG_FILTER_UP, etc). 
+    # 
     # - {Wx::IMAGE_OPTION_PNG_COMPRESSION_LEVEL}: Compression level (0..9) for saving a PNG file. A high value creates smaller-but-slower PNG file. Note that unlike other formats (e.g. JPEG) the PNG format is always lossless and thus this compression level doesn't tradeoff the image quality. 
+    # 
     # - {Wx::IMAGE_OPTION_PNG_COMPRESSION_MEM_LEVEL}: Compression memory usage level (1..9) for saving a PNG file. A high value means the saving process consumes more memory, but may create smaller PNG file. 
+    # 
     # - {Wx::IMAGE_OPTION_PNG_COMPRESSION_STRATEGY}: Possible values are 0 for default strategy, 1 for filter, and 2 for Huffman-only. You can use OptiPNG (http://optipng.sourceforge.net/) to get a suitable value for your application. 
+    # 
     # - {Wx::IMAGE_OPTION_PNG_COMPRESSION_BUFFER_SIZE}: Internal buffer size (in bytes) for saving a PNG file. Ideally this should be as big as the resulting PNG file. Use this option if your application produces images with small size variation.
     # 
     # Options specific to {Wx::TIFFHandler}: 
+    # 
     # - {Wx::IMAGE_OPTION_TIFF_BITSPERSAMPLE}: Number of bits per sample (channel). Currently values of 1 and 8 are supported. A value of 1 results in a black and white image. A value of 8 (the default) can mean greyscale or RGB, depending on the value of {Wx::IMAGE_OPTION_TIFF_SAMPLESPERPIXEL}. 
+    # 
     # - {Wx::IMAGE_OPTION_TIFF_SAMPLESPERPIXEL}: Number of samples (channels) per pixel. Currently values of 1 and 3 are supported. A value of 1 results in either a greyscale (by default) or black and white image, depending on the value of {Wx::IMAGE_OPTION_TIFF_BITSPERSAMPLE}. A value of 3 (the default) will result in an RGB image. 
+    # 
     # - {Wx::IMAGE_OPTION_TIFF_COMPRESSION}: Compression type. By default it is set to 1 (COMPRESSION_NONE). Typical other values are 5 (COMPRESSION_LZW) and 7 (COMPRESSION_JPEG). See tiff.h for more options. 
+    # 
     # - {Wx::IMAGE_OPTION_TIFF_PHOTOMETRIC}: Specifies the photometric interpretation. By default it is set to 2 (PHOTOMETRIC_RGB) for RGB images and 0 (PHOTOMETRIC_MINISWHITE) for greyscale or black and white images. It can also be set to 1 (PHOTOMETRIC_MINISBLACK) to treat the lowest value as black and highest as white. If you want a greyscale image it is also sufficient to only specify {Wx::IMAGE_OPTION_TIFF_PHOTOMETRIC} and set it to either PHOTOMETRIC_MINISWHITE or PHOTOMETRIC_MINISBLACK. The other values are taken care of.
     # 
     # Options specific to {Wx::GIFHandler}: 
+    # 
     # - {Wx::IMAGE_OPTION_GIF_TRANSPARENCY}: How to deal with transparent pixels. By default, the color of transparent pixels is changed to bright pink, so that if the image is accidentally drawn without transparency, it will be obvious. Normally, this would not be noticed, as these pixels will not be rendered. But in some cases it might be useful to load a GIF without making any modifications to its colours. Use {Wx::IMAGE_OPTION_GIF_TRANSPARENCY_UNCHANGED} to keep the colors correct. Use {Wx::IMAGE_OPTION_GIF_TRANSPARENCY_HIGHLIGHT} to convert transparent pixels to pink (default). This option has been added in wxWidgets 3.1.1.
     # 
     # Be careful when combining the options {Wx::IMAGE_OPTION_TIFF_SAMPLESPERPIXEL}, {Wx::IMAGE_OPTION_TIFF_BITSPERSAMPLE}, and {Wx::IMAGE_OPTION_TIFF_PHOTOMETRIC}. While some measures are taken to prevent illegal combinations and/or values, it is still easy to abuse them and come up with invalid results in the form of either corrupted images or crashes.
@@ -699,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
     
@@ -717,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
     
@@ -725,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
     
@@ -741,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
     
@@ -754,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
     
@@ -767,50 +772,63 @@ module Wx
     #   Depending on how wxWidgets has been configured, not all formats may be available.
     #   
     #   You can use {Wx::Image#get_option_int} to get the hotspot when loading cursor files: 
-    #   ```
-    #     int hotspot_x = image.GetOptionInt(wxIMAGE_OPTION_CUR_HOTSPOT_X);
-    #     int hotspot_y = image.GetOptionInt(wxIMAGE_OPTION_CUR_HOTSPOT_Y);
+    #   ```ruby
+    #     hotspot_x = image.get_option_int(Wx::IMAGE_OPTION_CUR_HOTSPOT_X)
+    #     hotspot_y = image.get_option_int(Wx::IMAGE_OPTION_CUR_HOTSPOT_Y)
     #   ```
     #   @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. 
+    #     
     #     - {Wx::BitmapType::BITMAP_TYPE_GIF}: Load a GIF bitmap file. 
+    #     
     #     - {Wx::BitmapType::BITMAP_TYPE_JPEG}: Load a JPEG bitmap file. 
+    #     
     #     - {Wx::BitmapType::BITMAP_TYPE_PNG}: Load a PNG bitmap file. 
+    #     
     #     - {Wx::BitmapType::BITMAP_TYPE_PCX}: Load a PCX bitmap file. 
+    #     
     #     - {Wx::BitmapType::BITMAP_TYPE_PNM}: Load a PNM bitmap file. 
+    #     
     #     - {Wx::BitmapType::BITMAP_TYPE_TIFF}: Load a TIFF bitmap file. 
+    #     
     #     - {Wx::BitmapType::BITMAP_TYPE_TGA}: Load a TGA bitmap file. 
+    #     
     #     - {Wx::BitmapType::BITMAP_TYPE_XPM}: Load a XPM bitmap file. 
+    #     
     #     - {Wx::BitmapType::BITMAP_TYPE_ICO}: Load a Windows icon file (ICO). 
+    #     
     #     - {Wx::BitmapType::BITMAP_TYPE_CUR}: Load a Windows cursor file (CUR). 
+    #     
     #     - {Wx::BitmapType::BITMAP_TYPE_ANI}: Load a Windows animated cursor file (ANI). 
+    #     
     #     - {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)
@@ -820,45 +838,54 @@ module Wx
     #   Depending on how wxWidgets has been configured, not all formats may be available.
     #   
     #   You can use {Wx::Image#set_option} to set the hotspot when saving an image into a cursor file (default hotspot is in the centre of the image): 
-    #   ```
-    #     image.SetOption(wxIMAGE_OPTION_CUR_HOTSPOT_X, hotspotX);
-    #     image.SetOption(wxIMAGE_OPTION_CUR_HOTSPOT_Y, hotspotY);
+    #   ```ruby
+    #     image.set_option(Wx::IMAGE_OPTION_CUR_HOTSPOT_X, hotspot_x)
+    #     image.set_option(Wx::IMAGE_OPTION_CUR_HOTSPOT_Y, hotspot_y)
     #   ```
     #   @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. 
+    #     
     #     - {Wx::BitmapType::BITMAP_TYPE_JPEG}: Save a JPEG image file. 
+    #     
     #     - {Wx::BitmapType::BITMAP_TYPE_PNG}: Save a PNG image file. 
+    #     
     #     - {Wx::BitmapType::BITMAP_TYPE_PCX}: Save a PCX image file (tries to save as 8-bit if possible, falls back to 24-bit otherwise). 
+    #     
     #     - {Wx::BitmapType::BITMAP_TYPE_PNM}: Save a PNM image file (as raw RGB always). 
+    #     
     #     - {Wx::BitmapType::BITMAP_TYPE_TIFF}: Save a TIFF image file. 
+    #     
     #     - {Wx::BitmapType::BITMAP_TYPE_XPM}: Save a XPM image file. 
+    #     
     #     - {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.
@@ -894,10 +921,10 @@ module Wx
     # Sets the flags used for loading image files by this object.
     # The flags will affect any future calls to {Wx::Image#load_file} for this object. To change the flags for all image objects, call {Wx::Image.set_default_load_flags} before creating any of them.
     # Currently the only defined flag is Load_Verbose which determines if the non-fatal (i.e. not preventing the file from being loaded completely) problems should result in the calls to {log_warning} function. It is recommended to customize handling of these warnings by e.g. defining a custom log target (see Logging Overview), but if such warnings should be completely suppressed, clearing this flag provides a simple way to do it, for example: 
-    # ```
-    #   wxImage image;
-    #   image.SetLoadFlags(image.GetLoadFlags() & ~wxImage::Load_Verbose);
-    #   image.LoadFile(...);
+    # ```ruby
+    #   image = Wx::Image.new
+    #   image.set_load_flags(image.get_load_flags & ~Wx::Image::Load_Verbose)
+    #   image.load_file(...)
     # ```
     # @see Wx::Image#load_file
     # @see  Wx::Image#set_load_flags
@@ -909,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
@@ -932,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)
@@ -981,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
@@ -1000,53 +1027,66 @@ module Wx
     # For the overload taking the parameter filename, that's the name of the file to query. For the overload taking the parameter stream, that's the opened input stream with image data.
     # See Wx::ImageHandler#get_image_count for more info.
     # The parameter type may be one of the following values: 
+    # 
     # - {Wx::BitmapType::BITMAP_TYPE_BMP}: Load a Windows bitmap file. 
+    # 
     # - {Wx::BitmapType::BITMAP_TYPE_GIF}: Load a GIF bitmap file. 
+    # 
     # - {Wx::BitmapType::BITMAP_TYPE_JPEG}: Load a JPEG bitmap file. 
+    # 
     # - {Wx::BitmapType::BITMAP_TYPE_PNG}: Load a PNG bitmap file. 
+    # 
     # - {Wx::BitmapType::BITMAP_TYPE_PCX}: Load a PCX bitmap file. 
+    # 
     # - {Wx::BitmapType::BITMAP_TYPE_PNM}: Load a PNM bitmap file. 
+    # 
     # - {Wx::BitmapType::BITMAP_TYPE_TIFF}: Load a TIFF bitmap file. 
+    # 
     # - {Wx::BitmapType::BITMAP_TYPE_TGA}: Load a TGA bitmap file. 
+    # 
     # - {Wx::BitmapType::BITMAP_TYPE_XPM}: Load a XPM bitmap file. 
+    # 
     # - {Wx::BitmapType::BITMAP_TYPE_ICO}: Load a Windows icon file (ICO). 
+    # 
     # - {Wx::BitmapType::BITMAP_TYPE_CUR}: Load a Windows cursor file (CUR). 
+    # 
     # - {Wx::BitmapType::BITMAP_TYPE_ANI}: Load a Windows animated cursor file (ANI). 
+    # 
     # - {Wx::BitmapType::BITMAP_TYPE_ANY}: Will try to autodetect the format.
     # 
     # 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
     
     # @overload initialize()
     #   Creates an empty {Wx::Image} object without an alpha channel.
-    #   @return [Image]
+    #   @return [Wx::Image]
     # @overload initialize(width, height, clear=true)
     #   Creates an image with the given size and clears it if requested.
     #   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.
-    #   @return [Image]
+    #   @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] 
-    #   @return [Image]
+    #   @param clear [Boolean] 
+    #   @return [Wx::Image]
     # @overload initialize(width, height, data)
     #   Creates an image from data in memory.
     #   If static_data is false then the {Wx::Image} will take ownership of the data and free it afterwards. For this, it has to be allocated with malloc.
     #   @param width [Integer]  Specifies the width of the image.
     #   @param height [Integer]  Specifies the height of the image.
     #   @param data [String]  A pointer to RGB data
-    #   @return [Image]
+    #   @return [Wx::Image]
     # @overload initialize(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 [Image]
+    #   @return [Wx::Image]
     # @overload initialize(width, height, data, alpha)
     #   Creates an image from data in memory.
     #   If static_data is false then the {Wx::Image} will take ownership of the data and free it afterwards. For this, it has to be allocated with malloc.
@@ -1054,51 +1094,59 @@ module Wx
     #   @param height [Integer]  Specifies the height of the image.
     #   @param data [String]  A pointer to RGB data
     #   @param alpha [String]  A pointer to alpha-channel data
-    #   @return [Image]
+    #   @return [Wx::Image]
     # @overload initialize(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 [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 [Image]
+    #   @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}.
     #   
     #   You can use {Wx::Image#get_option_int} to get the hotspot when loading cursor files: 
-    #   ```
-    #     int hotspot_x = image.GetOptionInt(wxIMAGE_OPTION_CUR_HOTSPOT_X);
-    #     int hotspot_y = image.GetOptionInt(wxIMAGE_OPTION_CUR_HOTSPOT_Y);
+    #   ```ruby
+    #     hotspot_x = image.get_option_int(Wx::IMAGE_OPTION_CUR_HOTSPOT_X)
+    #     hotspot_y = image.get_option_int(Wx::IMAGE_OPTION_CUR_HOTSPOT_Y)
     #   ```
     #   @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. 
+    #     
     #     - {Wx::BitmapType::BITMAP_TYPE_GIF}: Load a GIF bitmap file. 
+    #     
     #     - {Wx::BitmapType::BITMAP_TYPE_JPEG}: Load a JPEG bitmap file. 
+    #     
     #     - {Wx::BitmapType::BITMAP_TYPE_PNG}: Load a PNG bitmap file. 
+    #     
     #     - {Wx::BitmapType::BITMAP_TYPE_PCX}: Load a PCX bitmap file. 
+    #     
     #     - {Wx::BitmapType::BITMAP_TYPE_PNM}: Load a PNM bitmap file. 
+    #     
     #     - {Wx::BitmapType::BITMAP_TYPE_TIFF}: Load a TIFF bitmap file. 
+    #     
     #     - {Wx::BitmapType::BITMAP_TYPE_TGA}: Load a TGA bitmap file. 
+    #     
     #     - {Wx::BitmapType::BITMAP_TYPE_XPM}: Load a XPM bitmap file. 
+    #     
     #     - {Wx::BitmapType::BITMAP_TYPE_ICO}: Load a Windows icon file (ICO). 
+    #     
     #     - {Wx::BitmapType::BITMAP_TYPE_CUR}: Load a Windows cursor file (CUR). 
+    #     
     #     - {Wx::BitmapType::BITMAP_TYPE_ANI}: Load a Windows animated cursor file (ANI). 
+    #     
     #     - {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 [Image]
+    #   @return [Wx::Image]
     # @overload initialize(name, mimetype, index=-1)
     #   Creates an image from a file using MIME-types to specify the type.
     #   @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 description in wxImage(const wxString&, wxBitmapType, int) overload.
-    #   @return [Image]
+    #   @return [Wx::Image]
     def initialize(*args) end
     
     # Returns the file load flags used for this object.
@@ -1111,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.
@@ -1126,10 +1174,12 @@ module Wx
     
     # Iterates all registered {Wx::ImageHandler} objects, and returns a string containing file extension masks suitable for passing to file open/save dialog boxes.
     # The format of the returned string is <code>"(*.ext1;*.ext2)|*.ext1;*.ext2"</code>. It is usually a good idea to prepend a description before passing the result to the dialog. Example: 
-    # ```
-    #   wxFileDialog FileDlg( this, "Choose Image", ::wxGetCwd(), "",
-    #                         _("Image Files ") + wxImage::GetImageExtWildcard(),
-    #                         wxFD_OPEN );
+    # ```ruby
+    #   Wx::FileDialog(self, 'Choose Image', Dir.getwd, '',
+    #                  'Image Files ' + Wx::Image.get_image_ext_wildcard,
+    #                  Wx::FD_OPEN) do |file_dlg|
+    #     # ...
+    #   end
     # ```
     # @see Wx::ImageHandler 
     # @return [String]