add an assert indicating that old code overriding OnExecute() must be updated with 2.9

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

diff --git a/include/wx/imaglist.h b/include/wx/imaglist.h
index 8b10b0f524d8a51bee661f7bf03d3f0bb6206ac9..2779e3f1e598daa23351c68219cff19989677915 100644 (file)
--- a/include/wx/imaglist.h
+++ b/include/wx/imaglist.h
@@ -1,27 +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(__WXUNIVERSAL__)
-#include "wx/generic/imaglist.h"
-#elif defined(__WXMSW__)
-#if defined(__WIN16__)
-#include "wx/generic/imaglist.h"
-#else
-#include "wx/msw/imaglist.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__) || defined(__WXPALMOS__)
+    #define wxHAS_NATIVE_IMAGELIST
 #endif
-#elif defined(__WXMOTIF__)
-#include "wx/generic/imaglist.h"
-#elif defined(__WXGTK__)
-#include "wx/generic/imaglist.h"
-#elif defined(__WXQT__)
-#include "wx/generic/imaglist.h"
+
+#if !defined(wxHAS_NATIVE_IMAGELIST)
+    #include "wx/generic/imaglist.h"
+#elif defined(__WXMSW__)
+    #include "wx/msw/imaglist.h"
 #elif defined(__WXMAC__)
-#include "wx/generic/imaglist.h"
-#elif defined(__WXPM__)
-#include "wx/generic/imaglist.h"
-#elif defined(__WXSTUBS__)
-#include "wx/generic/imaglist.h"
+    #include "wx/mac/imaglist.h"
+#elif defined(__WXPALMOS__)
+    #include "wx/palmos/imaglist.h"
 #endif
 
-#endif
-    // _WX_IMAGLIST_H_BASE_
+#endif // _WX_IMAGLIST_H_BASE_