include/wx/imaglist.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/imaglist.h
   3 // Purpose:     wxImageList base header
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:
   7 // Copyright:   (c) Julian Smart
   8 // RCS-ID:      $Id$
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_IMAGLIST_H_BASE_
  13 #define _WX_IMAGLIST_H_BASE_
  14
  15 #include "wx/defs.h"
  16
  17 /*
  18  * wxImageList is used for wxListCtrl, wxTreeCtrl. These controls refer to
  19  * images for their items by an index into an image list.
  20  * A wxImageList is capable of creating images with optional masks from
  21  * a variety of sources - a single bitmap plus a colour to indicate the mask,
  22  * two bitmaps, or an icon.
  23  *
  24  * Image lists can also create and draw images used for drag and drop functionality.
  25  * This is not yet implemented in wxImageList. We need to discuss a generic API
  26  * for doing drag and drop and see whether it ties in with the Win95 view of it.
  27  * See below for candidate functions and an explanation of how they might be
  28  * used.
  29  */
  30
  31 // Flag values for Set/GetImageList
  32 enum
  33 {
  34     wxIMAGE_LIST_NORMAL, // Normal icons
  35     wxIMAGE_LIST_SMALL,  // Small icons
  36     wxIMAGE_LIST_STATE   // State icons: unimplemented (see WIN32 documentation)
  37 };
  38
  39 // Flags for Draw
  40 #define wxIMAGELIST_DRAW_NORMAL         0x0001
  41 #define wxIMAGELIST_DRAW_TRANSPARENT    0x0002
  42 #define wxIMAGELIST_DRAW_SELECTED       0x0004
  43 #define wxIMAGELIST_DRAW_FOCUSED        0x0008
  44
  45 #if defined(__WXMSW__) || defined(__WXMAC__)
  46     #define wxHAS_NATIVE_IMAGELIST
  47 #endif
  48
  49 #if !defined(wxHAS_NATIVE_IMAGELIST)
  50     #include "wx/generic/imaglist.h"
  51 #elif defined(__WXMSW__)
  52     #include "wx/msw/imaglist.h"
  53 #elif defined(__WXMAC__)
  54     #include "wx/osx/imaglist.h"
  55 #endif
  56
  57 #endif // _WX_IMAGLIST_H_BASE_