]> git.saurik.com Git - wxWidgets.git/blame - include/wx/generic/imaglist.h
wxNotebook interface (it may change!), implementation file is not yet
[wxWidgets.git] / include / wx / generic / imaglist.h
CommitLineData
c801d85f
KB
1/////////////////////////////////////////////////////////////////////////////
2// Name: imaglist.h
3// Purpose:
4// Author: Robert Roebling
5// Created: 01/02/97
6// Id:
7// Copyright: (c) 1998 Robert Roebling, Julian Smart and Markus Holzem
8// Licence: wxWindows licence
9/////////////////////////////////////////////////////////////////////////////
10
11#ifndef __IMAGELISTH_G__
12#define __IMAGELISTH_G__
13
14#ifdef __GNUG__
15#pragma interface
16#endif
17
18#include "wx/defs.h"
19#include "wx/gdicmn.h"
20#include "wx/bitmap.h"
21#include "wx/dc.h"
22
23/*
24 * wxImageList is used for wxListCtrl, wxTreeCtrl. These controls refer to
25 * images for their items by an index into an image list.
26 * A wxImageList is capable of creating images with optional masks from
27 * a variety of sources - a single bitmap plus a colour to indicate the mask,
28 * two bitmaps, or an icon.
29 *
30 * Image lists can also create and draw images used for drag and drop functionality.
31 * This is not yet implemented in wxImageList. We need to discuss a generic API
32 * for doing drag and drop and see whether it ties in with the Win95 view of it.
33 * See below for candidate functions and an explanation of how they might be
34 * used.
35 */
36
37// Flags for Draw
38#define wxIMAGELIST_DRAW_NORMAL 0x0001
39#define wxIMAGELIST_DRAW_TRANSPARENT 0x0002
40#define wxIMAGELIST_DRAW_SELECTED 0x0004
41#define wxIMAGELIST_DRAW_FOCUSED 0x0008
42
43class wxImageList: public wxObject
44{
45 DECLARE_DYNAMIC_CLASS(wxImageList)
46
47 public:
48
49 wxImageList(void);
50 ~wxImageList(void);
51 bool Create(void);
52 int GetImageCount(void) const;
53 int Add( const wxBitmap &bitmap );
54 bool Replace( const int index, const wxBitmap &bitmap );
55 bool Remove( const int index );
56 bool RemoveAll(void);
57 bool GetSize( const int index, int &width, int &height ) const;
58 bool Draw(const int index, wxDC& dc, const int x, const int y,
59 const int flags = wxIMAGELIST_DRAW_NORMAL, const bool solidBackground = FALSE );
60
61 private:
62
63 wxList m_images;
64};
65
66#endif // __IMAGELISTH_G__
67