synchronize GTK2 minimum version in docs

[wxWidgets.git] / include / wx / imaglist.h

diff --git a/include/wx/imaglist.h b/include/wx/imaglist.h
index 6558755bc761bfb3705a851c7a245ebc972029b2..c9f07299f08a744944a912a1dda24c34bc7252a1 100644 (file)
--- a/include/wx/imaglist.h
+++ b/include/wx/imaglist.h
@@ -1,14 +1,57 @@
+/////////////////////////////////////////////////////////////////////////////
+// Name:        wx/imaglist.h
+// Purpose:     wxImageList base header
+// Author:      Julian Smart
+// Modified by:
+// Created:
+// Copyright:   (c) Julian Smart
+// RCS-ID:      $Id$
+// Licence:     wxWindows licence
+/////////////////////////////////////////////////////////////////////////////
+
 #ifndef _WX_IMAGLIST_H_BASE_
 #define _WX_IMAGLIST_H_BASE_
 
-#if defined(__WIN32__)
-    #include "wx/msw/imaglist.h"
-#endif
-#include "wx/generic/imaglist.h"
-#if !defined(__WIN32__)
-    #define wxImageList wxGenericImageList
-    #define sm_classwxImageList sm_classwxGenericImageList
+#include "wx/defs.h"
+
+/*
+ * wxImageList is used for wxListCtrl, wxTreeCtrl. These controls refer to
+ * images for their items by an index into an image list.
+ * A wxImageList is capable of creating images with optional masks from
+ * a variety of sources - a single bitmap plus a colour to indicate the mask,
+ * two bitmaps, or an icon.
+ *
+ * Image lists can also create and draw images used for drag and drop functionality.
+ * This is not yet implemented in wxImageList. We need to discuss a generic API
+ * for doing drag and drop and see whether it ties in with the Win95 view of it.
+ * See below for candidate functions and an explanation of how they might be
+ * used.
+ */
+
+// Flag values for Set/GetImageList
+enum
+{
+    wxIMAGE_LIST_NORMAL, // Normal icons
+    wxIMAGE_LIST_SMALL,  // Small icons
+    wxIMAGE_LIST_STATE   // State icons: unimplemented (see WIN32 documentation)
+};
+
+// Flags for Draw
+#define wxIMAGELIST_DRAW_NORMAL         0x0001
+#define wxIMAGELIST_DRAW_TRANSPARENT    0x0002
+#define wxIMAGELIST_DRAW_SELECTED       0x0004
+#define wxIMAGELIST_DRAW_FOCUSED        0x0008
+
+#if defined(__WXMSW__) || defined(__WXMAC__)
+    #define wxHAS_NATIVE_IMAGELIST
 #endif
 
+#if !defined(wxHAS_NATIVE_IMAGELIST)
+    #include "wx/generic/imaglist.h"
+#elif defined(__WXMSW__)
+    #include "wx/msw/imaglist.h"
+#elif defined(__WXMAC__)
+    #include "wx/osx/imaglist.h"
 #endif
-    // _WX_IMAGLIST_H_BASE_
+
+#endif // _WX_IMAGLIST_H_BASE_