wxruby3 1.6.1 → 1.7.0

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

@@ -0,0 +1,311 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # 
+  HL_CONTEXTMENU = 1
+  
+  # 
+  HL_ALIGN_LEFT = 2
+  
+  # 
+  HL_ALIGN_RIGHT = 4
+  
+  # 
+  HL_ALIGN_CENTRE = 8
+  
+  # 
+  HL_DEFAULT_STYLE = 2097161
+  
+  # 
+  # 
+  EVT_HYPERLINK = 10313
+  
+  # This class shows a static text element which links to an URL.
+  # 
+  # Appearance and behaviour is completely customizable.
+  # In fact, when the user clicks on the hyperlink, a {Wx::HyperlinkEvent} is sent but if that event is not handled (or it's skipped; see {Wx::Event#skip}), then a call to {launch_default_browser} is done with the hyperlink's URL.
+  # Note that standard {Wx::Window} functions like {Wx::Window#set_background_colour}, {Wx::Window#set_font}, {Wx::Window#set_cursor}, {Wx::Window#set_label} can be used to customize appearance of the hyperlink.
+  # ### Styles
+  # 
+  # This class supports the following styles:
+  # 
+  # - {Wx::HL_ALIGN_LEFT}: Align the text to the left. 
+  # 
+  # - {Wx::HL_ALIGN_RIGHT}: Align the text to the right. This style is not supported under Windows. 
+  # 
+  # - {Wx::HL_ALIGN_CENTRE}: Center the text (horizontally). This style is not supported under Windows. 
+  # 
+  # - {Wx::HL_CONTEXTMENU}: Pop up a context menu when the hyperlink is right-clicked. The context menu contains a "Copy URL" menu item which is automatically handled by the hyperlink and which just copies in the clipboard the URL (not the label) of the control. 
+  # 
+  # - {Wx::HL_DEFAULT_STYLE}: The default style for {Wx::HyperlinkCtrl}: {Wx::Border::BORDER_NONE}|{Wx::HL_CONTEXTMENU}|{Wx::HL_ALIGN_CENTRE}. 
+  # 
+  # ### Events emitted by this class
+  # 
+  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::HyperlinkEvent} events.
+  # Event handler methods for events emitted by this class:
+  # 
+  # - {Wx::EvtHandler#evt_hyperlink}(id, meth = nil, &block): The hyperlink was (left) clicked. If this event is not handled in user's code (or it's skipped; see {Wx::Event#skip}), then a call to {Wx::LaunchDefaultBrowser} is done with the hyperlink's URL. 
+  # 
+  # Currently this class is implemented using native support in WXGTK and WXMSW and a generic version is used by the other ports.
+  # 
+  # 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::URL
+  # @see  Wx::HyperlinkEvent 
+  # 
+  # 
+  # @wxrb_require USE_HYPERLINKCTRL
+  class HyperlinkCtrl < Control
+  
+    # @overload initialize()
+    #   @return [Wx::HyperlinkCtrl]
+    # @overload initialize(parent, id, label, url, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::HL_DEFAULT_STYLE, name=Wx::HYPERLINK_CTRL_NAME_STR)
+    #   Constructor.
+    #   
+    #   See {Wx::HyperlinkCtrl#create} for more info.
+    #   @param parent [Wx::Window] 
+    #   @param id [Integer] 
+    #   @param label [String] 
+    #   @param url [String] 
+    #   @param pos [Array(Integer, Integer), Wx::Point] 
+    #   @param size [Array(Integer, Integer), Wx::Size] 
+    #   @param style [Integer] 
+    #   @param name [String] 
+    #   @return [Wx::HyperlinkCtrl]
+    # @overload initialize(parent, id, label, url, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::HL_DEFAULT_STYLE, name=Wx::HYPERLINK_CTRL_NAME_STR, &block)
+    #   Constructor.
+    #   
+    #   See {Wx::HyperlinkCtrl#create} for more info.
+    #   @param parent [Wx::Window] 
+    #   @param id [Integer] 
+    #   @param label [String] 
+    #   @param url [String] 
+    #   @param pos [Array(Integer, Integer), Wx::Point] 
+    #   @param size [Array(Integer, Integer), Wx::Size] 
+    #   @param style [Integer] 
+    #   @param name [String] 
+    #   @yieldparam [Wx::HyperlinkCtrl] win new instance
+    #   @return [Wx::HyperlinkCtrl]
+    def initialize(*args) end
+    
+    # Creates the hyperlink control.
+    # @param parent [Wx::Window]  Parent window. Must not be nil.
+    # @param id [Integer]  Window identifier. A value of {Wx::StandardID::ID_ANY} indicates a default value.
+    # @param label [String]  The label of the hyperlink.
+    # @param url [String]  The URL associated with the given label.
+    # @param pos [Array(Integer, Integer), Wx::Point]  Window position.
+    # @param size [Array(Integer, Integer), Wx::Size]  Window size. If the {Wx::DEFAULT_SIZE} is specified then the window is sized appropriately.
+    # @param style [Integer]  Window style. See {Wx::HyperlinkCtrl}.
+    # @param name [String]  Window name.
+    # @return [Boolean]
+    def create(parent, id, label, url, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::HL_DEFAULT_STYLE, name=Wx::HYPERLINK_CTRL_NAME_STR) end
+    
+    # Returns the colour used to print the label of the hyperlink when the mouse is over the control.
+    # 
+    # In native WXMSW version of this control hover colour is always the same as normal colour, i.e. the control doesn't change its appearance when the mouse hovers over it.
+    # @return [Wx::Colour]
+    def get_hover_colour; end
+    alias_method :hover_colour, :get_hover_colour
+    
+    # Returns the colour used to print the label when the link has never been clicked before (i.e. the link has not been visited) and the mouse is not over the control.
+    # @return [Wx::Colour]
+    def get_normal_colour; end
+    alias_method :normal_colour, :get_normal_colour
+    
+    # Returns the URL associated with the hyperlink.
+    # @return [String]
+    def get_url; end
+    alias_method :url, :get_url
+    
+    # Returns true if the hyperlink has already been clicked by the user at least one time.
+    # @return [Boolean]
+    def get_visited; end
+    alias_method :visited, :get_visited
+    
+    # Returns the colour used to print the label when the mouse is not over the control and the link has already been clicked before (i.e. the link has been visited).
+    # @return [Wx::Colour]
+    def get_visited_colour; end
+    alias_method :visited_colour, :get_visited_colour
+    
+    # Sets the colour used to print the label of the hyperlink when the mouse is over the control.
+    # 
+    # Changing this colour is not supported in the native WXMSW version.
+    # @param colour [Wx::Colour,String,Symbol] 
+    # @return [void]
+    def set_hover_colour(colour) end
+    alias_method :hover_colour=, :set_hover_colour
+    
+    # Sets the colour used to print the label when the link has never been clicked before (i.e. the link has not been visited) and the mouse is not over the control.
+    # @param colour [Wx::Colour,String,Symbol] 
+    # @return [void]
+    def set_normal_colour(colour) end
+    alias_method :normal_colour=, :set_normal_colour
+    
+    # Sets the URL associated with the hyperlink.
+    # @param url [String] 
+    # @return [void]
+    def set_url(url) end
+    alias_method :url=, :set_url
+    
+    # Marks the hyperlink as visited (see {Wx::HyperlinkCtrl#set_visited_colour}).
+    # @param visited [Boolean] 
+    # @return [void]
+    def set_visited(visited=true) end
+    alias_method :visited=, :set_visited
+    
+    # Sets the colour used to print the label when the mouse is not over the control and the link has already been clicked before (i.e. the link has been visited).
+    # @param colour [Wx::Colour,String,Symbol] 
+    # @return [void]
+    def set_visited_colour(colour) end
+    alias_method :visited_colour=, :set_visited_colour
+    
+  end # HyperlinkCtrl
+  
+  # This is the generic implementation of a class that shows a static text element which links to a URL.
+  # For WXOSX this class is identical to wxHyperlinkCtrl.
+  # 
+  # Appearance and behaviour is completely customizable.
+  # In fact, when the user clicks on the hyperlink, a {Wx::HyperlinkEvent} is sent but if that event is not handled (or it's skipped; see {Wx::Event#skip}), then a call to {launch_default_browser} is done with the hyperlink's URL.
+  # Note that standard {Wx::Window} functions like {Wx::Window#set_background_colour}, {Wx::Window#set_font}, {Wx::Window#set_cursor}, {Wx::Window#set_label} can be used to customize appearance of the hyperlink.
+  # ### Styles
+  # 
+  # This class supports the following styles:
+  # 
+  # - {Wx::HL_ALIGN_LEFT}: Align the text to the left. 
+  # 
+  # - {Wx::HL_ALIGN_RIGHT}: Align the text to the right. This style is not supported under Windows. 
+  # 
+  # - {Wx::HL_ALIGN_CENTRE}: Center the text (horizontally). This style is not supported under Windows. 
+  # 
+  # - {Wx::HL_CONTEXTMENU}: Pop up a context menu when the hyperlink is right-clicked. The context menu contains a "Copy URL" menu item which is automatically handled by the hyperlink and which just copies in the clipboard the URL (not the label) of the control. 
+  # 
+  # - {Wx::HL_DEFAULT_STYLE}: The default style for {Wx::HyperlinkCtrl}: {Wx::Border::BORDER_NONE}|{Wx::HL_CONTEXTMENU}|{Wx::HL_ALIGN_CENTRE}. 
+  # 
+  # ### Events emitted by this class
+  # 
+  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::HyperlinkEvent} events.
+  # 
+  # 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::URL
+  # @see  Wx::HyperlinkEvent 
+  # 
+  # 
+  # @wxrb_require USE_HYPERLINKCTRL
+  class GenericHyperlinkCtrl < Control
+  
+    # @overload initialize()
+    #   @return [Wx::GenericHyperlinkCtrl]
+    # @overload initialize(parent, id, label, url, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::HL_DEFAULT_STYLE, name=Wx::HYPERLINK_CTRL_NAME_STR)
+    #   Constructor.
+    #   
+    #   See {Wx::GenericHyperlinkCtrl#create} for more info.
+    #   @param parent [Wx::Window] 
+    #   @param id [Integer] 
+    #   @param label [String] 
+    #   @param url [String] 
+    #   @param pos [Array(Integer, Integer), Wx::Point] 
+    #   @param size [Array(Integer, Integer), Wx::Size] 
+    #   @param style [Integer] 
+    #   @param name [String] 
+    #   @return [Wx::GenericHyperlinkCtrl]
+    # @overload initialize(parent, id, label, url, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::HL_DEFAULT_STYLE, name=Wx::HYPERLINK_CTRL_NAME_STR, &block)
+    #   Constructor.
+    #   
+    #   See {Wx::GenericHyperlinkCtrl#create} for more info.
+    #   @param parent [Wx::Window] 
+    #   @param id [Integer] 
+    #   @param label [String] 
+    #   @param url [String] 
+    #   @param pos [Array(Integer, Integer), Wx::Point] 
+    #   @param size [Array(Integer, Integer), Wx::Size] 
+    #   @param style [Integer] 
+    #   @param name [String] 
+    #   @yieldparam [Wx::GenericHyperlinkCtrl] win new instance
+    #   @return [Wx::GenericHyperlinkCtrl]
+    def initialize(*args) end
+    
+    # Creates the hyperlink control.
+    # @param parent [Wx::Window] 
+    # @param id [Integer] 
+    # @param label [String] 
+    # @param url [String] 
+    # @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, id, label, url, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::HL_DEFAULT_STYLE, name=Wx::HYPERLINK_CTRL_NAME_STR) end
+    
+    # Returns the colour used to print the label of the hyperlink when the mouse is over the control.
+    # 
+    # In native WXMSW version of this control hover colour is always the same as normal colour, i.e. the control doesn't change its appearance when the mouse hovers over it.
+    # @return [Wx::Colour]
+    def get_hover_colour; end
+    alias_method :hover_colour, :get_hover_colour
+    
+    # Returns the colour used to print the label when the link has never been clicked before (i.e. the link has not been visited) and the mouse is not over the control.
+    # @return [Wx::Colour]
+    def get_normal_colour; end
+    alias_method :normal_colour, :get_normal_colour
+    
+    # Returns the URL associated with the hyperlink.
+    # @return [String]
+    def get_url; end
+    alias_method :url, :get_url
+    
+    # Returns true if the hyperlink has already been clicked by the user at least one time.
+    # @return [Boolean]
+    def get_visited; end
+    alias_method :visited, :get_visited
+    
+    # Returns the colour used to print the label when the mouse is not over the control and the link has already been clicked before (i.e. the link has been visited).
+    # @return [Wx::Colour]
+    def get_visited_colour; end
+    alias_method :visited_colour, :get_visited_colour
+    
+    # Sets the colour used to print the label of the hyperlink when the mouse is over the control.
+    # 
+    # Changing this colour is not supported in the native WXMSW version.
+    # @param colour [Wx::Colour,String,Symbol] 
+    # @return [void]
+    def set_hover_colour(colour) end
+    alias_method :hover_colour=, :set_hover_colour
+    
+    # Sets the colour used to print the label when the link has never been clicked before (i.e. the link has not been visited) and the mouse is not over the control.
+    # @param colour [Wx::Colour,String,Symbol] 
+    # @return [void]
+    def set_normal_colour(colour) end
+    alias_method :normal_colour=, :set_normal_colour
+    
+    # Sets the URL associated with the hyperlink.
+    # @param url [String] 
+    # @return [void]
+    def set_url(url) end
+    alias_method :url=, :set_url
+    
+    # Marks the hyperlink as visited (see {Wx::HyperlinkCtrl#set_visited_colour}).
+    # @param visited [Boolean] 
+    # @return [void]
+    def set_visited(visited=true) end
+    alias_method :visited=, :set_visited
+    
+    # Sets the colour used to print the label when the mouse is not over the control and the link has already been clicked before (i.e. the link has been visited).
+    # @param colour [Wx::Colour,String,Symbol] 
+    # @return [void]
+    def set_visited_colour(colour) end
+    alias_method :visited_colour=, :set_visited_colour
+    
+  end # GenericHyperlinkCtrl
+  
+
+end

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

@@ -0,0 +1,44 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # This event class is used for the events generated by {Wx::HyperlinkCtrl}.
+  # 
+  # ### Events using this class
+  # 
+  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::HyperlinkEvent} events.
+  # Event handler methods:
+  # 
+  # - {Wx::EvtHandler#evt_hyperlink}(id, meth = nil, &block): User clicked on a hyperlink. 
+  # 
+  # Category:  {Wx::Events}
+  # 
+  # @wxrb_require USE_HYPERLINKCTRL
+  class HyperlinkEvent < CommandEvent
+  
+    # The constructor is not normally used by the user code.
+    # @param generator [Wx::Object] 
+    # @param id [Integer] 
+    # @param url [String] 
+    # @return [Wx::HyperlinkEvent]
+    def initialize(generator, id, url) end
+    
+    # Returns the URL of the hyperlink where the user has just clicked.
+    # @return [String]
+    def get_url; end
+    alias_method :url, :get_url
+    
+    # Sets the URL associated with the event.
+    # @param url [String] 
+    # @return [void]
+    def set_url(url) end
+    alias_method :url=, :set_url
+    
+  end # HyperlinkEvent
+  
+
+end

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

@@ -0,0 +1,267 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # 
+  ICON_SCREEN_DEPTH = -1
+  
+  # An empty {Wx::Icon}.
+  # 
+  NULL_ICON = nil
+  
+  # An empty {Wx::IconBundle}.
+  # 
+  NULL_ICON_BUNDLE = nil
+  
+  # An icon is a small rectangular bitmap usually used for denoting a minimized application.
+  # 
+  # It differs from a {Wx::Bitmap} in always having a mask associated with it for transparent drawing. On some platforms, icons and bitmaps are implemented identically, since there is no real distinction between a {Wx::Bitmap} with a mask and an icon; and there is no specific icon format on some platforms (X-based applications usually standardize on XPMs for small bitmaps and icons). However, some platforms (such as Windows) make the distinction, so a separate class is provided.
+  # 
+  # <div class="wxrb-remark">
+  # <b>Remark:</b>
+  # <p>It is usually desirable to associate a pertinent icon with a frame. Icons can also be used for other purposes, for example with {Wx::TreeCtrl} and {Wx::ListCtrl}. Icons have different formats on different platforms therefore separate icons will usually be created for the different environments. Platform-specific methods for creating a {Wx::Icon} structure are catered for, and this is an occasion where conditional compilation will probably be required. Note that a new icon must be created for every time the icon is to be used for a new window. In Windows, the icon will not be reloaded if it has already been used. An icon allocated to a frame will be deleted when the frame is deleted. For more information please see Bitmaps and Icons.
+  # </p>
+  # </div>
+  # 
+  # Category:  Graphics Device Interface (GDI)
+  # Predefined objects/pointers: {Wx::NULL_ICON}
+  # @see Bitmaps and Icons
+  # @see  Supported Bitmap File Formats
+  # @see  Wx::IconBundle
+  # @see  Wx::DC#draw_icon
+  # @see  Wx::Cursor 
+  # 
+  # 
+  # 
+  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  class Icon < Bitmap
+  
+    # @overload initialize()
+    #   Default ctor.
+    #   
+    #   Constructs an icon object with no data; an assignment or another member function such as {Wx::Icon#load_file} must be called subsequently.
+    #   @return [Wx::Icon]
+    # @overload initialize(icon)
+    #   Copy ctor.
+    #   @param icon [Wx::Icon] 
+    #   @return [Wx::Icon]
+    # @overload initialize(name, type=Wx::ICON_DEFAULT_TYPE, desiredWidth=-1, desiredHeight=-1)
+    #   Loads an icon from a file or resource.
+    #   
+    #   
+    #   @see Wx::Icon#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 [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::ICON_DEFAULT_TYPE} constant has different value under different wxWidgets ports. See the {Wx::icon.h} header for the value it takes for a specific port.
+    #   @param desiredWidth [Integer]  Specifies the desired width of the icon. This parameter only has an effect in Windows where icon resources can contain several icons of different sizes.
+    #   @param desiredHeight [Integer]  Specifies the desired height of the icon. This parameter only has an effect in Windows where icon resources can contain several icons of different sizes.
+    #   @return [Wx::Icon]
+    # @overload initialize(loc)
+    #   Loads an icon from the specified location.
+    #   @param loc [Wx::IconLocation] 
+    #   @return [Wx::Icon]
+    def initialize(*args) end
+    
+    # Copies bmp bitmap to this icon.
+    # 
+    # Under MS Windows the bitmap must have mask colour set.
+    # @see Wx::Icon#load_file 
+    # @param bmp [Wx::Bitmap] 
+    # @return [void]
+    def copy_from_bitmap(bmp) end
+    
+    # Gets the colour depth of the icon.
+    # 
+    # A value of 1 indicates a monochrome icon.
+    # @return [Integer]
+    def get_depth; end
+    alias_method :depth, :get_depth
+    
+    # Gets the height of the icon in physical pixels.
+    # 
+    # 
+    # @see Wx::Icon#get_width
+    # @see  Wx::Icon#get_logical_height 
+    # @return [Integer]
+    def get_height; end
+    alias_method :height, :get_height
+    
+    # Gets the height of the icon in logical pixels.
+    # 
+    # See {Wx::Bitmap#get_logical_height}.
+    # @return [Float]
+    def get_logical_height; end
+    alias_method :logical_height, :get_logical_height
+    
+    # Gets the size of the icon in logical pixels.
+    # 
+    # See {Wx::Bitmap#get_logical_size}.
+    # @return [Wx::Size]
+    def get_logical_size; end
+    alias_method :logical_size, :get_logical_size
+    
+    # Gets the width of the icon in logical pixels.
+    # 
+    # See {Wx::Bitmap#get_logical_width}.
+    # @return [Float]
+    def get_logical_width; end
+    alias_method :logical_width, :get_logical_width
+    
+    # Gets the scale factor of this icon.
+    # 
+    # See {Wx::Bitmap#get_scale_factor}.
+    # @return [Float]
+    def get_scale_factor; end
+    alias_method :scale_factor, :get_scale_factor
+    
+    # Gets the size of the icon in physical pixels.
+    # 
+    # 
+    # @see Wx::Icon#get_logical_size 
+    # @return [Wx::Size]
+    def get_size; end
+    alias_method :size, :get_size
+    
+    # Gets the width of the icon in physical pixels.
+    # 
+    # 
+    # @see Wx::Icon#get_height
+    # @see  Wx::Icon#get_logical_width 
+    # @return [Integer]
+    def get_width; end
+    alias_method :width, :get_width
+    
+    # Returns true if icon data is present.
+    # @return [Boolean]
+    def is_ok; end
+    alias_method :ok?, :is_ok
+    
+    # Loads an icon from a file or resource.
+    # 
+    # true if the operation succeeded, false otherwise.
+    # @param name [String]  Either a filename or a Windows resource name. The meaning of name is determined by the type parameter.
+    # @param type [Wx::BitmapType]  One of the {Wx::BitmapType} values; see the note in the class detailed description. Note that the {Wx::ICON_DEFAULT_TYPE} constant has different value under different wxWidgets ports. See the {Wx::icon.h} header for the value it takes for a specific port.
+    # @param desiredWidth [Integer]  Specifies the desired width of the icon. This parameter only has an effect in Windows where icon resources can contain several icons of different sizes.
+    # @param desiredHeight [Integer]  Specifies the desired height of the icon. This parameter only has an effect in Windows where icon resources can contain several icons of different sizes.
+    # @return [Boolean]
+    def load_file(name, type=Wx::ICON_DEFAULT_TYPE, desiredWidth=-1, desiredHeight=-1) end
+    
+  end # Icon
+  
+  # This class contains multiple copies of an icon in different sizes.
+  # 
+  # It is typically used in {Wx::Dialog#set_icons} and {Wx::TopLevelWindow#set_icons}.
+  # 
+  # Category:  Graphics Device Interface (GDI)
+  # Predefined objects/pointers: {Wx::NULL_ICON_BUNDLE}
+  # 
+  # 
+  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  class IconBundle < GDIObject
+  
+    # Return invalid icon if exact size is not found.
+    # 
+    FALLBACK_NONE = 0
+    
+    # Return the icon of the system icon size if exact size is not found.
+    # 
+    FALLBACK_SYSTEM = 1
+    
+    # Return the icon of closest larger size or, if there is no icon of larger size in the bundle, the closest icon of smaller size.
+    # 
+    FALLBACK_NEAREST_LARGER = 2
+    
+    # @overload initialize()
+    #   Default ctor.
+    #   @return [Wx::IconBundle]
+    # @overload initialize(file, type=Wx::BitmapType::BITMAP_TYPE_ANY)
+    #   Initializes the bundle with the icon(s) found in the file.
+    #   @param file [String] 
+    #   @param type [Wx::BitmapType] 
+    #   @return [Wx::IconBundle]
+    # @overload initialize(stream, type=Wx::BitmapType::BITMAP_TYPE_ANY)
+    #   Initializes the bundle with the icon(s) found in the stream.
+    #   
+    #   Notice that the stream must be seekable, at least if it contains more than one icon. The stream pointer is positioned after the last icon read from the stream when this function returns.
+    #   @param stream [IO,Wx::InputStream] 
+    #   @param type [Wx::BitmapType] 
+    #   @return [Wx::IconBundle]
+    # @overload initialize(icon)
+    #   Initializes the bundle with a single icon.
+    #   @param icon [Wx::Icon] 
+    #   @return [Wx::IconBundle]
+    # @overload initialize(ic)
+    #   Copy constructor.
+    #   @param ic [Wx::IconBundle] 
+    #   @return [Wx::IconBundle]
+    def initialize(*args) end
+    
+    # @overload add_icon(file, type=Wx::BitmapType::BITMAP_TYPE_ANY)
+    #   Adds all the icons contained in the file to the bundle; if the collection already contains icons with the same width and height, they are replaced by the new ones.
+    #   @param file [String] 
+    #   @param type [Wx::BitmapType] 
+    #   @return [void]
+    # @overload add_icon(stream, type=Wx::BitmapType::BITMAP_TYPE_ANY)
+    #   Adds all the icons contained in the stream to the bundle; if the collection already contains icons with the same width and height, they are replaced by the new ones.
+    #   
+    #   Notice that, as well as in the constructor loading the icon bundle from stream, the stream must be seekable, at least if more than one icon is to be loaded from it.
+    #   @param stream [IO,Wx::InputStream] 
+    #   @param type [Wx::BitmapType] 
+    #   @return [void]
+    # @overload add_icon(icon)
+    #   Adds the icon to the collection; if the collection already contains an icon with the same width and height, it is replaced by the new one.
+    #   @param icon [Wx::Icon] 
+    #   @return [void]
+    def add_icon(*args) end
+    
+    # @overload get_icon(size, flags=Wx::IconBundle::FALLBACK_SYSTEM)
+    #   Returns the icon with the given size.
+    #   
+    #   If size is {Wx::DEFAULT_SIZE}, it is interpreted as the standard system icon size, i.e. the size returned by {Wx::SystemSettings.get_metric} for {Wx::SystemMetric::SYS_ICON_X} and {Wx::SystemMetric::SYS_ICON_Y}.
+    #   If the bundle contains an icon with exactly the requested size, it's always returned. Otherwise, the behaviour depends on the flags. If only {Wx::IconBundle::FALLBACK_NONE} is given, the function returns an invalid icon. If {Wx::IconBundle::FALLBACK_SYSTEM} is given, it tries to find the icon of standard system size, regardless of the size passed as parameter. Otherwise, or if the icon system size is not found either, but {Wx::IconBundle::FALLBACK_NEAREST_LARGER} flag is specified, the function returns the smallest icon of the size larger than the requested one or, if this fails too, just the icon closest to the specified size.
+    #   The flags parameter is available only since wxWidgets 2.9.4.
+    #   @param size [Array(Integer, Integer), Wx::Size] 
+    #   @param flags [Integer] 
+    #   @return [Wx::Icon]
+    # @overload get_icon(size=Wx::DEFAULT_COORD, flags=Wx::IconBundle::FALLBACK_SYSTEM)
+    #   Same as.
+    #   
+    #   ```ruby
+    #     get_icon(Wx::Size.new(size,size))
+    #   ```
+    #   .
+    #   @param size [Integer] 
+    #   @param flags [Integer] 
+    #   @return [Wx::Icon]
+    def get_icon(*args) end
+    alias_method :icon, :get_icon
+    
+    # Returns the icon with exactly the given size or {Wx::NULL_ICON} if this size is not available.
+    # @param size [Array(Integer, Integer), Wx::Size] 
+    # @return [Wx::Icon]
+    def get_icon_of_exact_size(size) end
+    alias_method :icon_of_exact_size, :get_icon_of_exact_size
+    
+    # return the number of available icons
+    # @return [Integer]
+    def get_icon_count; end
+    alias_method :icon_count, :get_icon_count
+    
+    # return the icon at index (must be < {Wx::IconBundle#get_icon_count})
+    # @param n [Integer] 
+    # @return [Wx::Icon]
+    def get_icon_by_index(n) end
+    alias_method :icon_by_index, :get_icon_by_index
+    
+    # Returns true if the bundle doesn't contain any icons, false otherwise (in which case a call to {Wx::IconBundle#get_icon} with default parameter should return a valid icon).
+    # @return [Boolean]
+    def is_empty; end
+    alias_method :empty?, :is_empty
+    
+  end # IconBundle
+  
+
+end

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

@@ -0,0 +1,40 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # {Wx::IconLocation} is a tiny class describing the location of an (external, i.e.
+  # 
+  # not embedded into the application resources) icon. For most platforms it simply contains the file name but under some others (notably Windows) the same file may contain multiple icons and so this class also stores the index of the icon inside the file.
+  # In any case, its details should be of no interest to the application code and most of them are not even documented here (on purpose) as it is only meant to be used as an opaque class: the application may get the object of this class from somewhere and the only reasonable thing to do with it later is to create a {Wx::Icon} from it.
+  # 
+  # Category:  Graphics Device Interface (GDI)
+  # @see Wx::Icon
+  # @see  Wx::FileType::GetIcon 
+  # 
+  # 
+  # 
+  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  class IconLocation < ::Object
+  
+    # Returns true if the object is valid, i.e. was properly initialized, and false otherwise.
+    # @return [Boolean]
+    def is_ok; end
+    alias_method :ok?, :is_ok
+    
+    # @param filename [String] 
+    # @return [void]
+    def set_file_name(filename) end
+    alias_method :file_name=, :set_file_name
+    
+    # @return [Wx::String]
+    def get_file_name; end
+    alias_method :file_name, :get_file_name
+    
+  end # IconLocation
+  
+
+end