.\" This is a wxWidgets manpage page generated from the XML docs
.TH wxImageList 3wx 2005-02-15 "wxWidgets" "wxWidgets class documentation"
.SH NAME
wxImageList \- 
  A list of images, used with some controls
 
.SH DESCRIPTION

  


   A wxImageList contains a list of images, which are stored in an unspecified
   form. Images can have masks for transparent drawing, and can be made from a
   variety of sources including bitmaps and icons.
  
  


   wxImageList is used principally in conjunction with
   wxTreeCtrl
   and
   wxListCtrl
   classes.
  
 
.SH "PARENTS"

  wxObject
 
.SH "INCLUDE FILES"
wx/imaglist.h
.SH MEMBERS

  
.SS  wxImageList ()

     


      Default constructor.
     
    
.SS  wxImageList (int widthint heightconst bool mask = trueint initialCount = 1)

     


      Constructor specifying the image size, whether image masks should be
      created, and the initial size of the list.
     
    
   
  
.SS int Add (const wxBitmap& bitmapconst wxBitmap& mask = wxNullBitmap)

     


      Adds a new image using a bitmap and optional mask bitmap.
     
    
.SS int Add (const wxBitmap& bitmapconst wxColour& maskColour)

     


      Adds a new image using a bitmap and mask colour.
     
    
.SS int Add (const wxIcon& icon)

     


      Adds a new image using an icon.
     
    
   
  
.SS bool Create (int widthint heightconst bool mask = trueint initialCount = 1)

     


      Initializes the list. See
      wxImageList::wxImageList
      for details.
     
    
   
  
.SS bool Draw (int indexwxDC& dcint xint yint flags = wxIMAGELIST_DRAW_NORMALconst bool solidBackground = false)

     


      Draws a specified image onto a device context.
     
    
   
  
.SS wxBitmap GetBitmap (int index)

     


      Returns the bitmap corresponding to the given index.
     
    
   
  
.SS wxIcon GetIcon (int index)

     


      Returns the icon corresponding to the given index.
     
    
   
  
.SS int GetImageCount ()

     


      Returns the number of images in the list.
     
    
   
  
.SS bool GetSize (int indexint& widthint &height)

     


      Retrieves the size of the images in the list. Currently, the
      
       index
      
      parameter is ignored as all images in the list have the same size.
     
    
   
  
.SS bool Remove (int index)

     


      Removes the image at the given position.
     
    
   
  
.SS bool RemoveAll ()

     


      Removes all the images in the list.
     
    
   
  
.SS bool Replace (int indexconst wxBitmap& bitmapconst wxBitmap& mask = wxNullBitmap)

     


      Replaces the existing image with the new image.
     
     


      Windows only.
     
    
.SS bool Replace (int indexconst wxIcon& icon)

     


      Replaces the existing image with the new image.
     
    
 
.SH "SEE ALSO"

  wxObject
 
  wxTreeCtrl
  wxListCtrl
 
.SH "AUTHORS"
Documentation content by Julian Smart, Robert Roebling, Vadim Zeitlin, Robin Dunn, et al

Conversion to manpage format by Arnout Engelen (http://bzzt.net), bugreports welcome.