# :stopdoc:
# This file is automatically generated by the WXRuby3 documentation 
# generator. Do not alter this file.
# :startdoc:


module Wx

  # A mixin class to be used with other classes that use a {Wx::ImageList}.
  # This class is used by classes such as {Wx::Notebook} and {Wx::TreeCtrl}, that use image indices to specify the icons used for their items (page icons for the former or the items inside the control for the latter).
  # The icon index can either be a special value NO_IMAGE to indicate that an item doesn't use an image at all or a small positive integer to specify the index of the icon in the list of images maintained by this class. Note that for many controls, either none of the items should have an icon or all of them should have one, i.e. mixing the items with and without an icon doesn't always work well and may result in less than ideal appearance.
  # To initialize the list of icons used, call {Wx::WithImages#set_images} method passing it a vector of {Wx::BitmapBundle} objects which can, in the simplest case, be just {Wx::Bitmap} or {Wx::Icon} objects  however, as always with {Wx::BitmapBundle}, either more than one bitmap or icon needs to be specified or the bitmap bundle needs to be created from SVG to obtain better appearance in high DPI.
  # Alternative, traditional API which was the only one available until wxWidgets 3.1.6, is based on the use of {Wx::ImageList} class. To use it, you need to create an object of this class and then call either {Wx::WithImages#assign_image_list} to set this image list and give the control its ownership or {Wx::WithImages#set_image_list} to retain the ownership of the image list, which can be useful if the same image list is shared by multiple controls, but requires deleting the image list later.
  # {Wx::ImageList}-based API is not formally deprecated, but its use is discouraged because it is more complicated than simply providing a vector of bitmaps and it doesn't allow specifying multiple images or using SVG, which is required for good high DPI support. Please don't use {Wx::WithImages#assign_image_list} and {Wx::WithImages#set_image_list} in the new code and use {Wx::WithImages#set_images} instead.
  # 
  # 
  # @note  In wxRuby this is a mixin module instead of a (base) class.
  module WithImages
  
    # @return [WithImages]
    def initialize; end
    
    # Return the number of images in this control.
    # The returned value may be 0 if there are no images associated with the control.
    # @see Wx::WithImages#has_images
    # @return [Integer]
    def get_image_count; end
    alias_method :image_count, :get_image_count
    
    # Return true if the control has any images associated with it.
    # 
    # @see Wx::WithImages#get_image_count
    # @return [true,false]
    def has_images; end
    alias_method :has_images?, :has_images
    
    # Set the images to use for the items in the control.
    # This function allows to specify the images to use in multiple different resolutions, letting the control to select the appropriate one for its DPI scaling. For this reason, it should be preferred to using the functions taking {Wx::ImageList}, which has a fixed size, in the new code.
    # @param images [Array<Wx::Image>]  Non empty vector of bitmap bundles. Valid image indexes for the items in this control are determined by the size of this vector.
    # @return [void]
    def set_images(images) end
    alias_method :images=, :set_images
    
    # Sets the image list for the page control and takes ownership of the list.
    # This function exists for compatibility only, please use {Wx::WithImages#set_images} in the new code.
    # @see Wx::ImageList
    # @see  Wx::WithImages#set_image_list 
    # @param imageList [Wx::ImageList] 
    # @return [void]
    def set_image_list(imageList) end
    alias_method :image_list=, :set_image_list
    
    # Returns the associated image list, may be NULL.
    # Note that the new code should use {Wx::WithImages#get_updated_image_list_for} instead.
    # @see Wx::ImageList
    # @see  Wx::WithImages#set_image_list 
    # @return [Wx::ImageList]
    def get_image_list; end
    alias_method :image_list, :get_image_list
    
    # Returns the image list updated to reflect the DPI scaling used for the given window if possible.
    # If {Wx::WithImages#set_images} has been called, this function creates the image list containing the images using the DPI scaling in effect for the provided win, which must be valid.
    # Otherwise it behaves as {Wx::WithImages#get_image_list}, i.e. returns the image list previously set using {Wx::WithImages#set_image_list} or {Wx::WithImages#assign_image_list}, and just returns NULL if none of them had been called.
    # Possibly null pointer owned by this object, i.e. which must not be deleted by the caller.
    # @param win [Wx::Window] 
    # @return [Wx::ImageList]
    def get_updated_image_list_for(win) end
    alias_method :updated_image_list_for, :get_updated_image_list_for
    
  end # WithImages
  

end