include/wx/generic/imaglist.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/generic/imaglist.h
   3 // Purpose:
   4 // Author:      Robert Roebling
   5 // Created:     01/02/97
   6 // Id:
   7 // Copyright:   (c) 1998 Robert Roebling and Julian Smart
   8 // Licence:     wxWindows licence
   9 /////////////////////////////////////////////////////////////////////////////
  10
  11 #ifndef __IMAGELISTH_G__
  12 #define __IMAGELISTH_G__
  13
  14 #include "wx/defs.h"
  15 #include "wx/list.h"
  16 #include "wx/icon.h"
  17
  18 class WXDLLEXPORT wxDC;
  19 class WXDLLEXPORT wxBitmap;
  20 class WXDLLEXPORT wxColour;
  21
  22 /*
  23  * wxImageList is used for wxListCtrl, wxTreeCtrl. These controls refer to
  24  * images for their items by an index into an image list.
  25  * A wxImageList is capable of creating images with optional masks from
  26  * a variety of sources - a single bitmap plus a colour to indicate the mask,
  27  * two bitmaps, or an icon.
  28  *
  29  * Image lists can also create and draw images used for drag and drop functionality.
  30  * This is not yet implemented in wxImageList. We need to discuss a generic API
  31  * for doing drag and drop and see whether it ties in with the Win95 view of it.
  32  * See below for candidate functions and an explanation of how they might be
  33  * used.
  34  */
  35
  36 #if !defined(wxIMAGELIST_DRAW_NORMAL)
  37
  38 // Flags for Draw
  39 #define wxIMAGELIST_DRAW_NORMAL         0x0001
  40 #define wxIMAGELIST_DRAW_TRANSPARENT    0x0002
  41 #define wxIMAGELIST_DRAW_SELECTED       0x0004
  42 #define wxIMAGELIST_DRAW_FOCUSED        0x0008
  43
  44 // Flag values for Set/GetImageList
  45 enum {
  46     wxIMAGE_LIST_NORMAL, // Normal icons
  47     wxIMAGE_LIST_SMALL,  // Small icons
  48     wxIMAGE_LIST_STATE   // State icons: unimplemented (see WIN32 documentation)
  49 };
  50
  51 #endif
  52
  53 class WXDLLEXPORT wxGenericImageList: public wxObject
  54 {
  55 public:
  56     wxGenericImageList() { m_width = m_height = 0; }
  57     wxGenericImageList( int width, int height, bool mask = true, int initialCount = 1 );
  58     ~wxGenericImageList();
  59     bool Create( int width, int height, bool mask = true, int initialCount = 1 );
  60     bool Create();
  61
  62     virtual int GetImageCount() const;
  63     virtual bool GetSize( int index, int &width, int &height ) const;
  64
  65     int Add( const wxBitmap& bitmap );
  66     int Add( const wxBitmap& bitmap, const wxBitmap& mask );
  67     int Add( const wxBitmap& bitmap, const wxColour& maskColour );
  68     wxBitmap GetBitmap(int index) const;
  69     wxIcon GetIcon(int index) const;
  70     bool Replace( int index, const wxBitmap &bitmap );
  71     bool Replace( int index, const wxBitmap &bitmap, const wxBitmap& mask );
  72     bool Remove( int index );
  73     bool RemoveAll();
  74
  75     virtual bool Draw(int index, wxDC& dc, int x, int y,
  76               int flags = wxIMAGELIST_DRAW_NORMAL,
  77               bool solidBackground = false);
  78
  79     // Internal use only
  80     const wxBitmap *GetBitmapPtr(int index) const;
  81 private:
  82     wxList  m_images;
  83
  84     int     m_width;
  85     int     m_height;
  86
  87     DECLARE_DYNAMIC_CLASS(wxGenericImageList)
  88 };
  89
  90 #if !defined(__WXMSW__) || defined(__WXUNIVERSAL__)
  91 /*
  92  * wxImageList has to be a real class or we have problems with
  93  * the run-time information.
  94  */
  95
  96 class WXDLLEXPORT wxImageList: public wxGenericImageList
  97 {
  98     DECLARE_DYNAMIC_CLASS(wxImageList)
  99
 100 public:
 101     wxImageList() {}
 102
 103     wxImageList( int width, int height, bool mask = true, int initialCount = 1 )
 104         : wxGenericImageList(width, height, mask, initialCount)
 105     {
 106     }
 107 };
 108 #endif // !__WXMSW__ || __WXUNIVERSAL__
 109
 110 #endif  // __IMAGELISTH_G__
 111