Add wxDEPRECATED_MSG() and use it in a couple of places.
[wxWidgets.git] / 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 // Licence: wxWindows licence
9 /////////////////////////////////////////////////////////////////////////////
10
11 #ifndef _WX_IMAGLIST_H_BASE_
12 #define _WX_IMAGLIST_H_BASE_
13
14 #include "wx/defs.h"
15
16 /*
17 * wxImageList is used for wxListCtrl, wxTreeCtrl. These controls refer to
18 * images for their items by an index into an image list.
19 * A wxImageList is capable of creating images with optional masks from
20 * a variety of sources - a single bitmap plus a colour to indicate the mask,
21 * two bitmaps, or an icon.
22 *
23 * Image lists can also create and draw images used for drag and drop functionality.
24 * This is not yet implemented in wxImageList. We need to discuss a generic API
25 * for doing drag and drop and see whether it ties in with the Win95 view of it.
26 * See below for candidate functions and an explanation of how they might be
27 * used.
28 */
29
30 // Flag values for Set/GetImageList
31 enum
32 {
33 wxIMAGE_LIST_NORMAL, // Normal icons
34 wxIMAGE_LIST_SMALL, // Small icons
35 wxIMAGE_LIST_STATE // State icons: unimplemented (see WIN32 documentation)
36 };
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 #if defined(__WXMSW__) || defined(__WXMAC__)
45 #define wxHAS_NATIVE_IMAGELIST
46 #endif
47
48 #if !defined(wxHAS_NATIVE_IMAGELIST)
49 #include "wx/generic/imaglist.h"
50 #elif defined(__WXMSW__)
51 #include "wx/msw/imaglist.h"
52 #elif defined(__WXMAC__)
53 #include "wx/osx/imaglist.h"
54 #endif
55
56 #endif // _WX_IMAGLIST_H_BASE_