wxruby3 0.9.0.pre.rc.1-x64-mingw-ucrt → 0.9.0.pre.rc.3-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.
@@ -456,20 +468,19 @@ 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.
@@ -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.
@@ -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.
@@ -767,25 +772,38 @@ 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: 
+    #     
     #     - {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]
@@ -820,9 +838,9 @@ 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.
@@ -839,14 +857,23 @@ module Wx
     #   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: 
+    #     
     #     - {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]
     # @overload save_file(name, mimetype)
@@ -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
@@ -1000,18 +1027,31 @@ 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).
@@ -1022,31 +1062,31 @@ module Wx
     
     # @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]
+    #   @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]
+    #   @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,64 @@ 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]
+    #   @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 [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: 
+    #     
     #     - {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.
@@ -1126,10 +1179,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]

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

@@ -45,7 +45,7 @@ module Wx
   
     # @overload initialize()
     #   Default ctor.
-    #   @return [ImageList]
+    #   @return [Wx::ImageList]
     # @overload initialize(width, height, mask=true, initialCount=1)
     #   Constructor specifying the image size, whether image masks should be created, and the initial size of the list.
     #   Note that the size is specified in logical pixels.
@@ -54,7 +54,7 @@ module Wx
     #   @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 initialCount [Integer]  The initial size of the list.
-    #   @return [ImageList]
+    #   @return [Wx::ImageList]
     def initialize(*args) end
     
     # @overload add(bitmap, mask=Wx::NULL_BITMAP)
@@ -79,7 +79,7 @@ module Wx
     #   
     #   The new zero-based image index.
     #   
-    #   Availability:  only available for the {Wx::MSW}, {Wx::OSX/Cocoa} ports.  {Wx::msw},{Wx::osx}
+    #   Availability:  only available for the wxMSW, wxOSX/Cocoa ports.  {Wx::msw},{Wx::osx}
     #   @param icon [Wx::Icon]  Icon to use as the image.
     #   @return [Integer]
     def add(*args) end
@@ -95,7 +95,7 @@ module Wx
     def create(width, height, mask=true, initialCount=1) end
     
     # Destroys the current list.
-    # This function resets the object to its initial state and does more than just {Wx::ImageList#remove_all} in the native {Wx::MSW} version.
+    # This function resets the object to its initial state and does more than just {Wx::ImageList#remove_all} in the native wxMSW version.
     # After calling it, {Wx::ImageList#create} may be called again to recreate the image list, e.g. using a different size.
     # @return [void]
     def destroy; end
@@ -106,7 +106,11 @@ module Wx
     # @param x [Integer]  X position on the device context.
     # @param y [Integer]  Y position on the device context.
     # @param flags [Integer]  How to draw the image. A bitlist of a selection of the following:
-    #   - {Wx::IMAGELIST_DRAW_NORMAL}: Draw the image normally.- {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.
+    #   
+    #   - {Wx::IMAGELIST_DRAW_NORMAL}: Draw the image normally.
+    #   - {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]
     def draw(index, dc, x, y, flags=Wx::IMAGELIST_DRAW_NORMAL, solidBackground=false) end
@@ -168,7 +172,7 @@ module Wx
     #   
     #   The original bitmap or icon is not affected by the {Wx::ImageList#replace} operation, and can be deleted afterwards.
     #   
-    #   Availability:  only available for the {Wx::MSW}, {Wx::OSX/Cocoa} ports.  {Wx::msw},{Wx::osx}
+    #   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]

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

@@ -26,23 +26,23 @@ module Wx
     # @param shiftDown [true,false] 
     # @param altDown [true,false] 
     # @param metaDown [true,false] 
-    # @return [KeyboardState]
+    # @return [Wx::KeyboardState]
     def initialize(controlDown=false, shiftDown=false, altDown=false, metaDown=false) end
     
     # Return the bit mask of all pressed modifier keys.
     # The return value is a combination of {Wx::KeyModifier::MOD_ALT}, {Wx::KeyModifier::MOD_CONTROL}, {Wx::KeyModifier::MOD_SHIFT} and {Wx::KeyModifier::MOD_META} bit masks. Additionally, {Wx::KeyModifier::MOD_NONE} is defined as 0, i.e. corresponds to no modifiers (see {Wx::KeyboardState#has_any_modifiers}) and {Wx::KeyModifier::MOD_CMD} is either {Wx::KeyModifier::MOD_CONTROL} (MSW and Unix) or {Wx::KeyModifier::MOD_META} (Mac), see {Wx::KeyboardState#cmd_down}. See {Wx::KeyModifier} for the full list of modifiers.
     # Notice that this function is easier to use correctly than, for example, {Wx::KeyboardState#control_down} because when using the latter you also have to remember to test that none of the other modifiers is pressed:
     # 
-    # ```
-    #   if ( ControlDown() && !AltDown() && !ShiftDown() && !MetaDown() )
-    #       ... handle Ctrl-XXX ...
+    # ```ruby
+    #   if control_down && !alt_down && !shift_down && !meta_down
+    #     ... handle Ctrl-XXX ...
     # ```
     # 
     # and forgetting to do it can result in serious program bugs (e.g. program not working with European keyboard layout where AltGr key which is seen by the program as combination of CTRL and ALT is used). On the other hand, you can simply write:
     # 
-    # ```
-    #   if ( GetModifiers() == wxMOD_CONTROL )
-    #       ... handle Ctrl-XXX ...
+    # ```ruby
+    #   if get_modifiers == Wx::MOD_CONTROL
+    #     ... handle Ctrl-XXX ...
     # ```
     # 
     # with this function.

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

@@ -13,14 +13,21 @@ module Wx
   # === Styles
   # 
   # This class supports the following styles:
-  #  
+  # 
   # - {Wx::LB_SINGLE}: Single-selection list. 
-  # - {Wx::LB_MULTIPLE}: Multiple-selection list: the user can toggle multiple items on and off. This is the same as {Wx::LB_EXTENDED} in {Wx::GTK2} port. 
+  # 
+  # - {Wx::LB_MULTIPLE}: Multiple-selection list: the user can toggle multiple items on and off. This is the same as {Wx::LB_EXTENDED} in wxGTK2 port. 
+  # 
   # - {Wx::LB_EXTENDED}: Extended-selection list: the user can extend the selection by using SHIFT or CTRL keys together with the cursor movement keys or the mouse. 
+  # 
   # - {Wx::LB_HSCROLL}: Create horizontal scrollbar if contents are too wide (Windows only). 
+  # 
   # - {Wx::LB_ALWAYS_SB}: Always show a vertical scrollbar. 
+  # 
   # - {Wx::LB_NEEDED_SB}: Only create a vertical scrollbar if needed. 
-  # - {Wx::LB_NO_SB}: Don't create vertical scrollbar ({Wx::MSW} and {Wx::GTK} only). 
+  # 
+  # - {Wx::LB_NO_SB}: Don't create vertical scrollbar (wxMSW and wxGTK only). 
+  # 
   # - {Wx::LB_SORT}: The listbox contents are sorted in alphabetical order. 
   # 
   # Note that {Wx::LB_SINGLE}, {Wx::LB_MULTIPLE} and {Wx::LB_EXTENDED} styles are mutually exclusive and you can specify at most one of them (single selection is the default). See also Window Styles.
@@ -28,14 +35,16 @@ module Wx
   # 
   # The following event-handler methods redirect the events to member method or handler blocks for {Wx::CommandEvent} events.
   # Event handler methods for events emitted by this class:
+  # 
   # - {Wx::EvtHandler#evt_listbox}(id, meth = nil, &block): Process a {Wx::EVT_LISTBOX} event, when an item on the list is selected or the selection changes. 
-  # - {Wx::EvtHandler#evt_listbox_dclick}(id, meth = nil, &block): Process a {Wx::EVT_LISTBOX_DCLICK} event, when the listbox is double-clicked. On some platforms (notably {Wx::GTK2}) pressing the enter key is handled as an equivalent of a double-click. 
+  # 
+  # - {Wx::EvtHandler#evt_listbox_dclick}(id, meth = nil, &block): Process a {Wx::EVT_LISTBOX_DCLICK} event, when the listbox is double-clicked. On some platforms (notably wxGTK2) pressing the enter key is handled as an equivalent of a double-click. 
   # 
   # === 
   # 
-  # Category:  {Wx::Controls}  <div class='appearance'><span class='appearance'>Appearance:</span><table><tr><td> {Wx::MSW} Appearance
-  #   </td><td> {Wx::GTK} Appearance
-  #   </td><td> {Wx::OSX} Appearance
+  # Category:  {Wx::Controls}  <div class='appearance'><span class='appearance'>Appearance:</span><table><tr><td> wxMSW Appearance
+  #   </td><td> wxGTK Appearance
+  #   </td><td> wxOSX Appearance
   #   </td></tr></table></div>
   # @see Wx::EditableListBox
   # @see  Wx::Choice
@@ -74,7 +83,7 @@ module Wx
     
     # @overload initialize()
     #   Default constructor.
-    #   @return [ListBox]
+    #   @return [Wx::ListBox]
     # @overload initialize(parent, id, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, choices=nil, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::ListBoxNameStr)
     #   Constructor, creating and showing a list box.
     #   @param parent [Wx::Window]  The parent window.
@@ -85,7 +94,7 @@ module Wx
     #   @param style [Integer]  Window style. See {Wx::ListBox}.
     #   @param validator [Wx::Validator]  The validator for this control.
     #   @param name [String]  The name of this class.
-    #   @return [ListBox]
+    #   @return [Wx::ListBox]
     # @overload initialize(parent, id, pos, size, choices, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::ListBoxNameStr)
     #   Constructor, creating and showing a list box.
     #   See the other {Wx::ListBox#list_box} constructor; the only difference is that this overload takes a {Wx::ArrayString} instead of a pointer to an array of {Wx::String}.
@@ -97,7 +106,7 @@ module Wx
     #   @param style [Integer] 
     #   @param validator [Wx::Validator] 
     #   @param name [String] 
-    #   @return [ListBox]
+    #   @return [Wx::ListBox]
     def initialize(*args) end
     
     # Deselects an item in the list box.
@@ -121,7 +130,7 @@ module Wx
     # This method can be used with single selection list boxes only, you must use {Wx::ListBox#get_selections} for the list boxes with {Wx::LB_MULTIPLE} style.
     # @see Wx::ListBox#set_selection
     # @see  Wx::ListBox#get_string_selection 
-    # @return [void]
+    # @return []
     def get_selection; end
     alias_method :selection, :get_selection
     
@@ -142,22 +151,22 @@ module Wx
     # @see Wx::ControlWithItems::GetSelection
     # @see  Wx::ControlWithItems::GetStringSelection
     # @see  Wx::ControlWithItems::SetSelection 
-    # @return [Array<Integer>]
+    # @return [Array(,Array<Integer>)]
     def get_selections; end
     alias_method :selections, :get_selections
     
     # @overload hit_test(point)
     #   Returns the item located at point, or {Wx::NOT_FOUND} if there is no item located at point.
-    #   It is currently implemented for {Wx::MSW}, {Wx::Mac} and {Wx::GTK2} ports.
+    #   It is currently implemented for wxMSW, {Wx::Mac} and wxGTK2 ports.
     #   
     #   Item located at point, or {Wx::NOT_FOUND} if unimplemented or the item does not exist.
     #   @param point [Array(Integer, Integer), Wx::Point]  Point of item (in client coordinates) to obtain
-    #   @return [void]
+    #   @return []
     # @overload hit_test(x, y)
     #   This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
     #   @param x [Integer] 
     #   @param y [Integer] 
-    #   @return [void]
+    #   @return []
     def hit_test(*args) end
     
     # Insert the given number of strings before the specified position.
@@ -191,14 +200,14 @@ module Wx
     def ensure_visible(n) end
     
     # Return the number of items that can fit vertically in the visible area of the listbox.
-    # Returns -1 if the number of items per page couldn't be determined. On {Wx::GTK} this method can only determine the number of items per page if there is at least one item in the listbox.
-    # @return [void]
+    # Returns -1 if the number of items per page couldn't be determined. On wxGTK this method can only determine the number of items per page if there is at least one item in the listbox.
+    # @return []
     def get_count_per_page; end
     alias_method :count_per_page, :get_count_per_page
     
     # Return the index of the topmost visible item.
     # Returns {Wx::NOT_FOUND} if the method is not implemented for the current platform.
-    # @return [void]
+    # @return []
     def get_top_item; end
     alias_method :top_item, :get_top_item
     
@@ -209,7 +218,7 @@ module Wx
     # 
     # true if all specified tabs are set, false otherwise
     # 
-    # Availability:  only available for the {Wx::MSW} port.  {Wx::msw}
+    # Availability:  only available for the wxMSW port.  {Wx::msw}
     # @param tabStops [Wx::Vector< int >]  If this argument is empty, tab stops are reset to their default value (every 32 dialog units). If it contains a single element, tab stops are set at each multiple of the given value. Otherwise tab stops are set at every element of the array, which must be in ascending order.
     # @return [true,false]
     def msw_set_tab_stops(tabStops) end
@@ -217,7 +226,7 @@ module Wx
     # Returns the number of items in the control.
     # 
     # @see Wx::ListBox#is_empty 
-    # @return [void]
+    # @return []
     def get_count; end
     alias_method :count, :get_count
     
@@ -240,7 +249,7 @@ module Wx
     # The zero-based position of the item, or {Wx::NOT_FOUND} if the string was not found.
     # @param string [String]  String to find.
     # @param caseSensitive [true,false]  Whether search is case sensitive (default is not).
-    # @return [void]
+    # @return []
     def find_string(string, caseSensitive=false) end
     
   end # ListBox