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

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

@@ -0,0 +1,98 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # A simple banner window showing either a bitmap or text.
+  # Banner windows can be used to present some overview of the current window contents to the user in an aesthetically pleasant way. They are typically positioned along the left or top edge of the window (although this class also supports right- and bottom-aligned banners) and show either a bitmap with a logo or a few lines of text on a gradient-filled background.
+  # Using this class is very simple, e.g.: 
+  # ```
+  #   MyFrame::MyFrame(...)
+  #   {
+  #       ... create the frame itself ...
+  #   
+  #       // Create and initialize the banner.
+  #       wxBannerWindow* banner = new wxBannerWindow(this, wxTOP);
+  #       banner->SetText("Welcome to my wonderful program",
+  #                       "  Before doing anything else, you need to connect to "
+  #                       "the online server.\n"
+  #                       "  Please enter your credentials in the controls below.");
+  #   
+  #       // And position it along the top edge of the window.
+  #       wxSizer* sizer = new wxBoxSizer(wxVERTICAL);
+  #       sizer->Add(banner, wxSizerFlags().Expand());
+  #   
+  #       ... add the rest of the window contents to the same sizer ...
+  #   
+  #       SetSizerAndFit(sizer);
+  #   }
+  # ```
+  # 
+  # This class is currently implemented generically and so looks the same under all platforms.
+  # === 
+  # 
+  # Category:  Miscellaneous Windows  <div class='appearance'><span class='appearance'>Appearance:</span><table class='appearance'><tr><td> Generic Appearance
+  #   </td></tr></table></div>
+  # 
+  class BannerWindow < Window
+  
+    # @overload initialize()
+    #   Default constructor, use {Wx::BannerWindow#create} later.
+    #   This constructor is only used for two-step creation, if possible, prefer using the constructor below directly instead of using this one and calling {Wx::BannerWindow#create} later.
+    #   @return [Wx::BannerWindow]
+    # @overload initialize(parent, winid, dir=Wx::Direction::LEFT, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=Wx::BannerWindowNameStr)
+    #   Full constructor provided for consistency with the other classes only.
+    #   Prefer to use the shorter constructor documented above. You should rarely, if ever, need to use non-default values for any other parameters: as the banner window doesn't generate any events, its identifier is not particularly useful; its position and size will be almost always managed by the containing sizer and it doesn't have any specific styles. So only the parent and the banner direction need to be specified.
+    #   @param parent [Wx::Window] 
+    #   @param winid [Integer] 
+    #   @param dir [Wx::Direction] 
+    #   @param pos [Array(Integer, Integer), Wx::Point] 
+    #   @param size [Array(Integer, Integer), Wx::Size] 
+    #   @param style [Integer] 
+    #   @param name [String] 
+    #   @return [Wx::BannerWindow]
+    def initialize(*args) end
+    
+    # Really create the banner window for the objects created using the default constructor.
+    # It's an error to call {Wx::BannerWindow#create} for the objects created using non-default constructor.
+    # @param parent [Wx::Window] 
+    # @param winid [Integer] 
+    # @param dir [Wx::Direction] 
+    # @param pos [Array(Integer, Integer), Wx::Point] 
+    # @param size [Array(Integer, Integer), Wx::Size] 
+    # @param style [Integer] 
+    # @param name [String] 
+    # @return [Boolean]
+    def create(parent, winid, dir=Wx::Direction::LEFT, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=Wx::BannerWindowNameStr) end
+    
+    # Provide the bitmap to use as background.
+    # Notice that ideally the bitmap should be big enough to always cover the entire banner, e.g. for a horizontal banner with {Wx::Direction::TOP} style its width should be bigger than any reasonable window size. Otherwise the bitmap is extended to cover the entire window area with a solid colour taken from the bitmap pixel on the edge in which direction the extension occurs so all bitmap pixels on this edge (top for {Wx::Direction::LEFT}, right for {Wx::Direction::TOP} and {Wx::Direction::BOTTOM} and bottom for {Wx::Direction::RIGHT}) should have the same colour to avoid jarring discontinuity.
+    # If, on the other hand, the bitmap is bigger than the window size, then it is truncated. For {Wx::Direction::LEFT} orientation the bitmap is truncated from the top, for {Wx::Direction::TOP} and {Wx::Direction::BOTTOM}  from the right and for {Wx::Direction::RIGHT}  from the bottom, so put the most important part of the bitmap information in the opposite direction where it will never be truncated.
+    # If no valid background bitmap is specified, the banner draws gradient background but if a valid bitmap is given here, the gradient is not draw and the start and end colours specified for it are ignored.
+    # @param bmp [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image]  Bitmap to use as background. May be invalid to indicate that no background bitmap should be used.
+    # @return [void]
+    def set_bitmap(bmp) end
+    alias_method :bitmap=, :set_bitmap
+    
+    # Set the text to display.
+    # This is mutually exclusive with {Wx::BannerWindow#set_bitmap}.
+    # Title is rendered in bold and should be single line, message can have multiple lines but is not wrapped automatically, include explicit line breaks in the string if you want to have multiple lines.
+    # @param title [String] 
+    # @param message [String] 
+    # @return [void]
+    def set_text(title, message) end
+    
+    # Set the colours between which the gradient runs.
+    # The gradient colours are ignored if {Wx::BannerWindow#set_bitmap} is used.
+    # @param start [Wx::Colour,String,Symbol] 
+    # @param end_ [Wx::Colour,String,Symbol] 
+    # @return [void]
+    def set_gradient(start, end_) end
+    
+  end # BannerWindow
+  
+
+end

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

@@ -16,7 +16,11 @@ module Wx
   # This class encapsulates the concept of a platform-dependent bitmap, either monochrome or colour or colour with alpha channel support.
   # If you need direct access the bitmap data instead going through drawing to it using {Wx::MemoryDC} you need to use the {Wx::PixelData} class (either {Wx::NativePixelData} for RGB bitmaps or {Wx::AlphaPixelData} for bitmaps with an additionally alpha channel).
   # Note that many {Wx::Bitmap} functions take a type parameter, which is a value of the {Wx::BitmapType} enumeration. The validity of those values depends however on the platform where your program is running and from the wxWidgets configuration. If all possible wxWidgets settings are used:
-  # - {Wx::MSW} supports BMP and ICO files, BMP and ICO resources;- {Wx::GTK} supports any file supported by gdk-pixbuf;- {Wx::Mac} supports PICT resources;- {Wx::X11} supports XPM files, XPM data, XBM data;
+  # 
+  # - wxMSW supports BMP and ICO files, BMP and ICO resources;
+  # - wxGTK supports any file supported by gdk-pixbuf;
+  # - {Wx::Mac} supports PICT resources;
+  # - wxX11 supports XPM files, XPM data, XBM data;
   # 
   # In addition, {Wx::Bitmap} can load and save all formats that {Wx::Image} can; see {Wx::Image} for more info. Of course, you must have loaded the {Wx::Image} handlers (see {init_all_image_handlers} and {Wx::Image.add_handler}). Note that all available {Wx::BitmapHandlers} for a given wxWidgets port are automatically loaded at startup so you won't need to use {Wx::Bitmap.add_handler}.
   # More on the difference between {Wx::Image} and {Wx::Bitmap}: {Wx::Image} is just a buffer of RGB bytes with an optional buffer for the alpha bytes. It is all generic, platform independent and image file format independent code. It includes generic code for scaling, resizing, clipping, and other manipulations of the image data. OTOH, {Wx::Bitmap} is intended to be a wrapper of whatever is the native image format that is quickest/easiest to draw to a DC or to be the target of the drawing operations performed on a {Wx::MemoryDC}. By splitting the responsibilities between {Wx::Image}/{Wx::Bitmap} like this then it's easier to use generic code shared by all platforms and image types for generic operations and platform specific code where performance or compatibility is needed.
@@ -41,7 +45,7 @@ module Wx
     # @overload initialize()
     #   Default constructor.
     #   Constructs a bitmap object with no data; an assignment or another member function such as {Wx::Bitmap#create} or {Wx::Bitmap#load_file} must be called subsequently.
-    #   @return [Bitmap]
+    #   @return [Wx::Bitmap]
     # @overload initialize(bitmap)
     #   Copy constructor, uses reference counting.
     #   To make a real copy, you can use:
@@ -50,7 +54,7 @@ module Wx
     #                     Wx::Rect.new(0, 0, oldBitmap.width, oldBitmap.height))
     #   ```
     #   @param bitmap [Wx::Bitmap] 
-    #   @return [Bitmap]
+    #   @return [Wx::Bitmap]
     # @overload initialize(width, height, depth=Wx::BITMAP_SCREEN_DEPTH)
     #   Creates a new bitmap.
     #   A depth of {Wx::BITMAP_SCREEN_DEPTH} indicates the depth of the current screen or visual.
@@ -59,25 +63,25 @@ module Wx
     #   @param width [Integer]  The width of the bitmap in pixels, must be strictly positive.
     #   @param height [Integer]  The height of the bitmap in pixels, must be strictly positive.
     #   @param depth [Integer]  The number of bits used to represent each bitmap pixel.
-    #   @return [Bitmap]
+    #   @return [Wx::Bitmap]
     # @overload initialize(sz, depth=Wx::BITMAP_SCREEN_DEPTH)
     #   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 depth [Integer] 
-    #   @return [Bitmap]
+    #   @return [Wx::Bitmap]
     # @overload initialize(width, height, dc)
     #   Create a bitmap compatible with the given DC, inheriting its magnification factor.
     #   @param width [Integer]  The width of the bitmap in pixels, must be strictly positive.
     #   @param height [Integer]  The height of the bitmap in pixels, must be strictly positive.
     #   @param dc [Wx::DC]  DC from which the scaling factor is inherited
-    #   @return [Bitmap]
+    #   @return [Wx::Bitmap]
     # @overload initialize(name, type=Wx::BITMAP_DEFAULT_TYPE)
     #   Loads a bitmap from a file or resource.
     #   
     #   @see Wx::Bitmap#load_file 
     #   @param name [String]  This can refer to a resource name or a filename under MS Windows and X. Its meaning is determined by the type parameter.
-    #   @param type [BitmapType]  May be one of the {Wx::BitmapType} values and indicates which type of bitmap should be loaded. See the note in the class detailed description. Note that the {Wx::BITMAP_DEFAULT_TYPE} constant has different value under different wxWidgets ports. See the bitmap.h header for the value it takes for a specific port.
-    #   @return [Bitmap]
+    #   @param type [Wx::BitmapType]  May be one of the {Wx::BitmapType} values and indicates which type of bitmap should be loaded. See the note in the class detailed description. Note that the {Wx::BITMAP_DEFAULT_TYPE} constant has different value under different wxWidgets ports. See the bitmap.h header for the value it takes for a specific port.
+    #   @return [Wx::Bitmap]
     # @overload initialize(img, depth=Wx::BITMAP_SCREEN_DEPTH)
     #   Creates this bitmap object from the given image.
     #   This has to be done to actually display an image as you cannot draw an image directly on a window.
@@ -85,18 +89,18 @@ module Wx
     #   On Windows, if there is a palette present (set with SetPalette), it will be used when creating the {Wx::Bitmap} (most useful in 8-bit display mode). On other platforms, the palette is currently ignored.
     #   @param img [Wx::Image]  Platform-independent {Wx::Image} object.
     #   @param depth [Integer]  Specifies the depth of the bitmap. If this is omitted, the display depth of the screen is used.
-    #   @return [Bitmap]
+    #   @return [Wx::Bitmap]
     # @overload initialize(img, dc)
     #   Creates a bitmap compatible with the given DC from the given image.
     #   This constructor initializes the bitmap with the data of the given image, which must be valid, but inherits the scaling factor from the given device context instead of simply using the default factor of 1.
     #   @param img [Wx::Image]  Platform-independent {Wx::Image} object.
     #   @param dc [Wx::DC]  DC from which the scaling factor is inherited
-    #   @return [Bitmap]
+    #   @return [Wx::Bitmap]
     # @overload initialize(cursor)
     #   Creates bitmap corresponding to the given cursor.
     #   This can be useful to display a cursor as it cannot be drawn directly on a window.
     #   @param cursor [Wx::Cursor]  A valid {Wx::Cursor}.
-    #   @return [Bitmap]
+    #   @return [Wx::Bitmap]
     def initialize(*args) end
     
     # Returns disabled (dimmed) version of the bitmap.
@@ -112,7 +116,7 @@ module Wx
     
     # Creates the bitmap from an icon.
     # @param icon [Wx::Icon] 
-    # @return [true,false]
+    # @return [Boolean]
     def copy_from_icon(icon) end
     
     # @overload create(width, height, depth=Wx::BITMAP_SCREEN_DEPTH)
@@ -123,19 +127,19 @@ module Wx
     #   @param width [Integer]  The width of the bitmap in pixels, must be strictly positive.
     #   @param height [Integer]  The height of the bitmap in pixels, must be strictly positive.
     #   @param depth [Integer]  The number of bits used to represent each bitmap pixel.
-    #   @return [true,false]
+    #   @return [Boolean]
     # @overload create(sz, depth=Wx::BITMAP_SCREEN_DEPTH)
     #   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 depth [Integer] 
-    #   @return [true,false]
+    #   @return [Boolean]
     # @overload create(width, height, dc)
     #   Create a bitmap compatible with the given DC, inheriting its magnification factor.
     #   true if the creation was successful.
     #   @param width [Integer]  The width of the bitmap in pixels, must be strictly positive.
     #   @param height [Integer]  The height of the bitmap in pixels, must be strictly positive.
     #   @param dc [Wx::DC]  DC from which the scaling factor is inherited
-    #   @return [true,false]
+    #   @return [Boolean]
     def create(*args) end
     
     # @overload create_with_dip_size(size, scale, depth=Wx::BITMAP_SCREEN_DEPTH)
@@ -143,20 +147,22 @@ module Wx
     #   The physical size of the bitmap is obtained by multiplying the given size by scale and rounding it to the closest integer.
     #   After using this function the following postconditions are true:
     #   
-    #   - {Wx::Bitmap#get_size} returns size multiplied by scale - {Wx::Bitmap#get_dip_size} returns size - {Wx::Bitmap#get_scale_factor} returns scale 
+    #   - {Wx::Bitmap#get_size} returns size multiplied by scale 
+    #   - {Wx::Bitmap#get_dip_size} returns size 
+    #   - {Wx::Bitmap#get_scale_factor} returns scale 
     #   
     #   true if the creation was successful.
     #   @param size [Array(Integer, Integer), Wx::Size]  The size of the bitmap in DPI-independent pixels. Both width and height must be strictly positive.
     #   @param scale [Float]  Scale factor used by the bitmap, see {Wx::Bitmap#set_scale_factor}.
     #   @param depth [Integer]  The number of bits used to represent each bitmap pixel.
-    #   @return [true,false]
+    #   @return [Boolean]
     # @overload create_with_dip_size(width, height, scale, depth=Wx::BITMAP_SCREEN_DEPTH)
     #   This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
     #   @param width [Integer] 
     #   @param height [Integer] 
     #   @param scale [Float] 
     #   @param depth [Integer] 
-    #   @return [true,false]
+    #   @return [Boolean]
     def create_with_dip_size(*args) end
     
     # Create a bitmap with a scale factor.
@@ -167,7 +173,7 @@ module Wx
     # @param height [Integer]  The height of the bitmap in pixels, must be strictly positive.
     # @param depth [Integer]  The number of bits used to represent each bitmap pixel.
     # @param logicalScale [Float]  Scale factor used by the bitmap, see {Wx::Bitmap#set_scale_factor}.
-    # @return [true,false]
+    # @return [Boolean]
     def create_scaled(width, height, depth, logicalScale) end
     
     # Gets the colour depth of the bitmap.
@@ -201,7 +207,7 @@ module Wx
     alias_method :logical_height, :get_logical_height
     
     # Returns the size of the bitmap in logical pixels.
-    # For the platforms using DPI-independent pixels, i.e. those where {Wx::HAS_DPI_INDEPENDENT_PIXELS} is defined, such as {Wx::OSX} or {Wx::GTK} 3, this function returns the physical size of the bitmap, as returned by {Wx::Bitmap#get_size}, divided by its scale factor, as returned by {Wx::Bitmap#get_scale_factor}, while for the other platforms, it simply returns the same thing as {Wx::Bitmap#get_size}.
+    # For the platforms using DPI-independent pixels, i.e. those where {Wx::HAS_DPI_INDEPENDENT_PIXELS} is defined, such as wxOSX or wxGTK 3, this function returns the physical size of the bitmap, as returned by {Wx::Bitmap#get_size}, divided by its scale factor, as returned by {Wx::Bitmap#get_scale_factor}, while for the other platforms, it simply returns the same thing as {Wx::Bitmap#get_size}.
     # This ensures that the result of this function is always expressed in the pixel coordinates appropriate for the current platform, i.e. its return value is always in logical pixels, used for window and {Wx::DC} coordinates, whether these pixels are the same as physical pixels, which are returned by {Wx::Bitmap#get_size}, or not.
     # @see Wx::Bitmap#get_logical_width
     # @see  Wx::Bitmap#get_logical_height
@@ -235,7 +241,7 @@ module Wx
     
     # Returns the scale factor of this bitmap.
     # Scale factor is 1 by default, but can be greater to indicate that the size of bitmap in logical, DPI-independent pixels is smaller than its actual size in physical pixels. Bitmaps with scale factor greater than 1 must be used in high DPI to appear sharp on the screen.
-    # Note that the scale factor is only used in the ports where logical pixels are not the same as physical ones, such as {Wx::OSX} or {Wx::GTK3}, and this function always returns 1 under the other platforms.
+    # Note that the scale factor is only used in the ports where logical pixels are not the same as physical ones, such as wxOSX or wxGTK3, and this function always returns 1 under the other platforms.
     # @see Wx::Bitmap#set_scale_factor
     # @see  Wx::Bitmap#get_logical_width
     # @see  Wx::Bitmap#get_logical_height
@@ -282,12 +288,12 @@ module Wx
     
     # Returns true if the bitmap has an alpha channel.
     # Note that the fact that a bitmap has an alpha channel doesn't necessarily mean that it has any transparency, as all of its pixels could be using {Wx::ALPHA_OPAQUE} value. To actually examine the alpha values, the bitmap can be converted to {Wx::Image}.
-    # @return [true,false]
+    # @return [Boolean]
     def has_alpha; end
     alias_method :has_alpha?, :has_alpha
     
     # Returns true if bitmap data is present.
-    # @return [true,false]
+    # @return [Boolean]
     def is_ok; end
     alias_method :ok?, :is_ok
     
@@ -297,8 +303,8 @@ module Wx
     # A palette may be associated with the bitmap if one exists (especially for colour Windows bitmaps), and if the code supports it. You can check if one has been created by using the {Wx::Bitmap#get_palette} member.
     # @see Wx::Bitmap#save_file 
     # @param name [String]  Either a filename or a Windows resource name. The meaning of name is determined by the type parameter.
-    # @param type [BitmapType]  One of the {Wx::BitmapType} values; see the note in the class detailed description. Note that the {Wx::BITMAP_DEFAULT_TYPE} constant has different value under different wxWidgets ports. See the bitmap.h header for the value it takes for a specific port.
-    # @return [true,false]
+    # @param type [Wx::BitmapType]  One of the {Wx::BitmapType} values; see the note in the class detailed description. Note that the {Wx::BITMAP_DEFAULT_TYPE} constant has different value under different wxWidgets ports. See the bitmap.h header for the value it takes for a specific port.
+    # @return [Boolean]
     def load_file(name, type=Wx::BITMAP_DEFAULT_TYPE) end
     
     # Remove alpha channel from the bitmap.
@@ -312,13 +318,13 @@ module Wx
     # Depending on how wxWidgets has been configured, not all formats may be available.
     # @see Wx::Bitmap#load_file 
     # @param name [String]  A filename. The meaning of name is determined by the type parameter.
-    # @param type [BitmapType]  One of the {Wx::BitmapType} values; see the note in the class detailed description.
+    # @param type [Wx::BitmapType]  One of the {Wx::BitmapType} values; see the note in the class detailed description.
     # @param palette [Wx::Palette]  An optional palette used for saving the bitmap.
-    # @return [true,false]
+    # @return [Boolean]
     def save_file(name, type, palette=nil) end
     
     # Sets the bitmap scale factor.
-    # This doesn't change the bitmap actual size or its contents, but changes its scale factor, so that it appears in a smaller size when it is drawn on screen: e.g. setting scale to 2 means that the bitmap will be twice smaller (in each direction) when drawn on screen in the ports in which logical and physical pixels differ (i.e. {Wx::OSX} and {Wx::GTK3}, but not {Wx::MSW}).
+    # This doesn't change the bitmap actual size or its contents, but changes its scale factor, so that it appears in a smaller size when it is drawn on screen: e.g. setting scale to 2 means that the bitmap will be twice smaller (in each direction) when drawn on screen in the ports in which logical and physical pixels differ (i.e. wxOSX and wxGTK3, but not wxMSW).
     # When creating a new bitmap, {Wx::Bitmap#create_with_dip_size} can be used to specify the correct scale factor from the beginning.
     # @param scale [Float] 
     # @return [void]
@@ -328,7 +334,7 @@ module Wx
     # Sets the mask for this bitmap.
     # The bitmap object owns the mask once this has been called.
     # 
-    # A mask can be set also for bitmap with an alpha channel but doing so under {Wx::MSW} is not recommended because performance of drawing such bitmap is not very good.
+    # A mask can be set also for bitmap with an alpha channel but doing so under wxMSW is not recommended because performance of drawing such bitmap is not very good.
     # @see Wx::Bitmap#get_mask
     # @see  Wx::Mask 
     # @param mask [Wx::Mask] 
@@ -386,26 +392,26 @@ module Wx
     # @overload initialize()
     #   Default constructor constructs an empty bundle.
     #   An empty bundle can't be used for anything, but can be assigned something else later.
-    #   @return [BitmapBundle]
+    #   @return [Wx::BitmapBundle]
     # @overload initialize(bitmap)
     #   Conversion constructor from a single bitmap.
     #   This constructor does the same thing as {Wx::BitmapBundle.from_bitmap} and only exists for interoperability with the existing code using {Wx::Bitmap}.
     #   @param bitmap [Wx::Bitmap] 
-    #   @return [BitmapBundle]
+    #   @return [Wx::BitmapBundle]
     # @overload initialize(icon)
     #   Conversion constructor from a single icon.
     #   This constructor does the same thing as {Wx::BitmapBundle.from_bitmap} and only exists for interoperability with the existing code using {Wx::Icon}.
     #   @param icon [Wx::Icon] 
-    #   @return [BitmapBundle]
+    #   @return [Wx::BitmapBundle]
     # @overload initialize(image)
     #   Conversion constructor from a single image.
     #   Similarly to the constructor from {Wx::Bitmap}, this constructor only exists for interoperability with the existing code using {Wx::Image} and can be replaced with more readable {Wx::BitmapBundle.from_image} in the new code.
     #   @param image [Wx::Image] 
-    #   @return [BitmapBundle]
+    #   @return [Wx::BitmapBundle]
     # @overload initialize(other)
     #   Copy constructor creates a copy of another bundle.
     #   @param other [Wx::BitmapBundle] 
-    #   @return [BitmapBundle]
+    #   @return [Wx::BitmapBundle]
     def initialize(*args) end
     
     # Clear the existing bundle contents.
@@ -416,7 +422,7 @@ module Wx
     
     # Check if bitmap bundle is non-empty.
     # Return true if the bundle contains any bitmaps or false if it is empty.
-    # @return [true,false]
+    # @return [Boolean]
     def is_ok; end
     alias_method :ok?, :is_ok
     
@@ -480,7 +486,7 @@ module Wx
     # Check if the two bundles refer to the same object.
     # Bundles are considered to be same only if they actually use the same underlying object, i.e. are copies of each other. If the two bundles were independently constructed, they're not considered to be the same, even if they were created from the same bitmap.
     # @param other [Wx::BitmapBundle] 
-    # @return [true,false]
+    # @return [Boolean]
     def is_same_as(other) end
     alias_method :same_as?, :is_same_as
     
@@ -516,21 +522,6 @@ module Wx
     # @return [Wx::BitmapBundle]
     def self.from_image(image) end
     
-    # Create a bundle from a custom bitmap bundle implementation.
-    # This function can be used to create bundles implementing custom logic for creating the bitmaps, e.g. creating them on the fly rather than using predefined bitmaps.
-    # See {Wx::BitmapBundleImpl}.
-    # @param impl [Wx::BitmapBundleImpl]  A valid, i.e. non-null, pointer. This function takes ownership of it, so the caller must not call DecRef() on it.
-    # @return [Wx::BitmapBundle]
-    def self.from_impl(impl) end
-    
-    # Create a bundle from the bitmaps in the application resources.
-    # This function can only be used on the platforms supporting storing bitmaps in resources, and currently only works under MSW and MacOS and returns an empty bundle on the other platforms.
-    # Under MSW, for this function to create a valid bundle, you must have RCDATA resource with the given name in your application resource file (with the extension <code></code>.rc) containing PNG file, and any other resources using name as prefix and suffix with the scale, e.g. "_2x" or "_1_5x" (for 150% DPI) will be also loaded as part of the bundle.
-    # @see Wx::BitmapBundle.from_svg_resource 
-    # @param name [String] 
-    # @return [Wx::BitmapBundle]
-    def self.from_resources(name) end
-    
     # @overload self.from_files(path, filename, extension=("png"))
     #   Create a bundle from bitmaps stored as files.
     #   Looking in path for files using filename as prefix and potentionally a suffix with scale, e.g. "_2x" or "@2x"
@@ -544,18 +535,11 @@ module Wx
     #   @return [Wx::BitmapBundle]
     def self.from_files(*args) end
     
-    # @overload self.from_svg(data, sizeDef)
-    #   This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
-    #   @param data [String] 
-    #   @param sizeDef [Array(Integer, Integer), Wx::Size] 
-    #   @return [Wx::BitmapBundle]
-    # @overload self.from_svg(data, len, sizeDef)
-    #   This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
-    #   @param data [Integer] 
-    #   @param len [Integer] 
-    #   @param sizeDef [Array(Integer, Integer), Wx::Size] 
-    #   @return [Wx::BitmapBundle]
-    def self.from_svg(*args) end
+    # This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
+    # @param data [String] 
+    # @param sizeDef [Array(Integer, Integer), Wx::Size] 
+    # @return [Wx::BitmapBundle]
+    def self.from_svg(data, sizeDef) end
     
     # Create a bundle from the SVG image loaded from the given file.
     # This function loads the SVG data from the given path and calls {Wx::BitmapBundle.from_svg} with it. As it is just a wrapper for {Wx::BitmapBundle.from_svg}, please see that function documentation for more information about SVG support.
@@ -564,20 +548,11 @@ module Wx
     # @return [Wx::BitmapBundle]
     def self.from_svg_file(path, sizeDef) end
     
-    # Create a bundle from the SVG image loaded from an application resource.
-    # Available only on the platforms supporting images in resources, i.e., MSW and MacOS.
-    # @see Wx::BitmapBundle.from_resources
-    # @see  Wx::BitmapBundle.from_svg_file 
-    # @param name [String]  On MSW, it must be a resource with RT_RCDATA type. On MacOS, it must be a file with an extension "svg" placed in the "Resources" subdirectory of the application bundle.
-    # @param sizeDef [Array(Integer, Integer), Wx::Size]  The default size to return from {Wx::BitmapBundle#get_default_size} for this bundle.
-    # @return [Wx::BitmapBundle]
-    def self.from_svg_resource(name, sizeDef) end
-    
   end # BitmapBundle
   
   # This class encapsulates a monochrome mask bitmap, where the masked area is black and the unmasked area is white.
   # When associated with a bitmap and drawn in a device context, the unmasked area of the bitmap will be drawn, and the masked area will not be drawn.
-  # A mask can be associated also with a bitmap with an alpha channel but drawing such bitmaps under {Wx::MSW} may be slow so using them should be avoided if drawing performance is an important factor.
+  # A mask can be associated also with a bitmap with an alpha channel but drawing such bitmaps under wxMSW may be slow so using them should be avoided if drawing performance is an important factor.
   # 
   # === 
   # 
@@ -591,22 +566,22 @@ module Wx
   
     # @overload initialize()
     #   Default constructor.
-    #   @return [Mask]
+    #   @return [Wx::Mask]
     # @overload initialize(bitmap, index)
     #   Constructs a mask from a bitmap and a palette index that indicates the background.
     #   Not implemented for GTK.
     #   @param bitmap [Wx::Bitmap]  A valid bitmap.
     #   @param index [Integer]  Index into a palette, specifying the transparency colour.
-    #   @return [Mask]
+    #   @return [Wx::Mask]
     # @overload initialize(bitmap)
     #   Constructs a mask from a monochrome bitmap.
     #   @param bitmap [Wx::Bitmap] 
-    #   @return [Mask]
+    #   @return [Wx::Mask]
     # @overload initialize(bitmap, colour)
     #   Constructs a mask from a bitmap and a colour that indicates the background.
     #   @param bitmap [Wx::Bitmap] 
     #   @param colour [Wx::Colour,String,Symbol] 
-    #   @return [Mask]
+    #   @return [Wx::Mask]
     def initialize(*args) end
     
     # @overload create(bitmap, index)
@@ -614,20 +589,20 @@ module Wx
     #   Not implemented for GTK.
     #   @param bitmap [Wx::Bitmap]  A valid bitmap.
     #   @param index [Integer]  Index into a palette, specifying the transparency colour.
-    #   @return [true,false]
+    #   @return [Boolean]
     # @overload create(bitmap)
     #   Constructs a mask from a monochrome bitmap.
     #   @param bitmap [Wx::Bitmap] 
-    #   @return [true,false]
+    #   @return [Boolean]
     # @overload create(bitmap, colour)
     #   Constructs a mask from a bitmap and a colour that indicates the background.
     #   @param bitmap [Wx::Bitmap] 
     #   @param colour [Wx::Colour,String,Symbol] 
-    #   @return [true,false]
+    #   @return [Boolean]
     def create(*args) end
     
     # Returns the mask as a monochrome bitmap.
-    # Currently this method is implemented in {Wx::MSW}, {Wx::GTK} and {Wx::OSX}.
+    # Currently this method is implemented in wxMSW, wxGTK and wxOSX.
     # @return [Wx::Bitmap]
     def get_bitmap; end
     alias_method :bitmap, :get_bitmap

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

@@ -11,10 +11,13 @@ module Wx
   # === Styles
   # 
   # This class supports the following styles:
-  #  
+  # 
   # - {Wx::BU_LEFT}: Left-justifies the bitmap label. 
+  # 
   # - {Wx::BU_TOP}: Aligns the bitmap label to the top of the button. 
+  # 
   # - {Wx::BU_RIGHT}: Right-justifies the bitmap label. 
+  # 
   # - {Wx::BU_BOTTOM}: Aligns the bitmap label to the bottom of the button. 
   # 
   # Note that the {Wx::BU_EXACTFIT} style supported by {Wx::Button} is not used by this class as bitmap buttons don't have any minimal standard size by default.
@@ -22,13 +25,14 @@ 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_button}(id, meth = nil, &block): Process a {Wx::EVT_BUTTON} event, when the button is clicked. 
   # 
   # === 
   # 
-  # 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::Button 
   # 
@@ -37,7 +41,7 @@ module Wx
   
     # @overload initialize()
     #   Default ctor.
-    #   @return [BitmapButton]
+    #   @return [Wx::BitmapButton]
     # @overload initialize(parent, id, bitmap, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::ButtonNameStr)
     #   Constructor, creating and showing a button.
     #   The bitmap parameter is normally the only bitmap you need to provide, and wxWidgets will draw the button correctly in its different states. If you want more control, call any of the functions {Wx::BitmapButton#set_bitmap_pressed}, {Wx::BitmapButton#set_bitmap_focus}, {Wx::BitmapButton#set_bitmap_disabled}.
@@ -51,11 +55,11 @@ module Wx
     #   @param style [Integer]  Window style. See {Wx::BitmapButton}.
     #   @param validator [Wx::Validator]  Window validator.
     #   @param name [String]  Window name.
-    #   @return [BitmapButton]
+    #   @return [Wx::BitmapButton]
     def initialize(*args) end
     
     # Button creation function for two-step creation.
-    # For more details, see {Wx::BitmapButton#bitmap_button}.
+    # For more details, see {Wx::BitmapButton#initialize}.
     # @param parent [Wx::Window] 
     # @param id [Integer] 
     # @param bitmap [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image] 
@@ -64,7 +68,7 @@ module Wx
     # @param style [Integer] 
     # @param validator [Wx::Validator] 
     # @param name [String] 
-    # @return [true,false]
+    # @return [Boolean]
     def create(parent, id, bitmap, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::ButtonNameStr) end
     
     # Creation function for two-step creation of "Close" button.
@@ -72,7 +76,7 @@ module Wx
     # @param parent [Wx::Window]  The button parent window, must be non-NULL.
     # @param winid [Integer]  The identifier for the new button.
     # @param name [String]  The name for the new button.
-    # @return [true,false]
+    # @return [Boolean]
     def create_close_button(parent, winid, name=(())) end
     
     # Helper function creating a standard-looking "Close" button.

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

@@ -13,9 +13,11 @@ module Wx
   # === Styles
   # 
   # This class supports the following styles:
-  #  
+  # 
   # - {Wx::CB_READONLY}: Creates a combobox without a text editor. On some platforms the control may appear very different when this style is used. 
+  # 
   # - {Wx::CB_SORT}: Sorts the entries in the list alphabetically. 
+  # 
   # - {Wx::TE_PROCESS_ENTER}: The control will generate the event {Wx::EVT_TEXT_ENTER} (otherwise pressing Enter key is either processed internally by the control or used for navigation between dialog controls). Windows only. 
   # 
   # Todocreate {Wx::CB_PROCESS_ENTER} rather than reusing {Wx::TE_PROCESS_ENTER}!
@@ -24,15 +26,18 @@ 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_combobox}(id, meth = nil, &block): Process a {Wx::EVT_COMBOBOX} event, when an item on the list is selected. 
+  # 
   # - {Wx::EvtHandler#evt_text}(id, meth = nil, &block): Process a {Wx::EVT_TEXT} event, when the combobox text changes. 
+  # 
   # - {Wx::EvtHandler#evt_text_enter}(id, meth = nil, &block): Process a {Wx::EVT_TEXT_ENTER} event, when RETURN is pressed in the combobox. 
   # 
   # === 
   # 
-  # 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::ComboBox
   # @see  Wx::Choice
@@ -44,7 +49,7 @@ module Wx
   
     # @overload initialize()
     #   Default ctor.
-    #   @return [BitmapComboBox]
+    #   @return [Wx::BitmapComboBox]
     # @overload initialize(parent, id=Wx::StandardID::ID_ANY, value=(''), pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, choices=nil, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::BitmapComboBoxNameStr)
     #   Constructor, creating and showing a combobox.
     #   
@@ -59,7 +64,7 @@ module Wx
     #   @param style [Integer]  The window style, see {Wx::CB_}* flags.
     #   @param validator [Wx::Validator]  Validator which can be used for additional data checks.
     #   @param name [String]  Control name.
-    #   @return [BitmapComboBox]
+    #   @return [Wx::BitmapComboBox]
     # @overload initialize(parent, id, value, pos, size, choices, style, validator=Wx::DEFAULT_VALIDATOR, name=Wx::BitmapComboBoxNameStr)
     #   Constructor, creating and showing a combobox.
     #   
@@ -74,7 +79,7 @@ module Wx
     #   @param style [Integer]  The window style, see {Wx::CB_}* flags.
     #   @param validator [Wx::Validator]  Validator which can be used for additional data checks.
     #   @param name [String]  Control name.
-    #   @return [BitmapComboBox]
+    #   @return [Wx::BitmapComboBox]
     def initialize(*args) end
     
     # @overload append(item, bitmap=Wx::NULL_BITMAP)
@@ -101,7 +106,7 @@ module Wx
     #   @param style [Integer] 
     #   @param validator [Wx::Validator] 
     #   @param name [String] 
-    #   @return [true,false]
+    #   @return [Boolean]
     # @overload create(parent, id, value, pos, size, choices, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::BitmapComboBoxNameStr)
     #   Creates the combobox for two-step construction.
     #   @param parent [Wx::Window] 
@@ -113,7 +118,7 @@ module Wx
     #   @param style [Integer] 
     #   @param validator [Wx::Validator] 
     #   @param name [String] 
-    #   @return [true,false]
+    #   @return [Boolean]
     def create(*args) end
     
     # Returns the size of the bitmaps used in the combo box.