1//---------------------------------------------------------------------------
2// This file is generated by wxPython's SIP generator.  Do not edit by hand.
3//
4// Copyright: (c) 2018 by Total Control Software
5// License:   wxWindows License
6//
7// This file will be included by _core.sip
8//
9//---------------------------------------------------------------------------
10
11//---------------------------------------------------------------------------
12
13const int wxIMAGELIST_DRAW_NORMAL;
14const int wxIMAGELIST_DRAW_TRANSPARENT;
15const int wxIMAGELIST_DRAW_SELECTED;
16const int wxIMAGELIST_DRAW_FOCUSED;
17enum
18{
19    wxIMAGE_LIST_NORMAL,
20    wxIMAGE_LIST_SMALL,
21    wxIMAGE_LIST_STATE
22};
23
24class wxImageList : wxObject
25{
26    %Docstring
27        ImageList()
28        ImageList(width, height, mask=True, initialCount=1)
29
30        A wxImageList contains a list of images, which are stored in an
31        unspecified form.
32    %End
33    %TypeHeaderCode
34        #include <wx/imaglist.h>
35    %End
36
37public:
38    wxImageList();
39    %PreMethodCode
40        if (!wxPyCheckForApp()) return NULL;
41    %End
42
43    wxImageList(
44        int width,
45        int height,
46        bool mask = true,
47        int initialCount = 1
48    );
49    %PreMethodCode
50        if (!wxPyCheckForApp()) return NULL;
51    %End
52
53    int Add(
54        const wxBitmap & bitmap,
55        const wxBitmap & mask = wxNullBitmap
56    );
57    %Docstring
58        Add(bitmap, mask=NullBitmap) -> int
59        Add(bitmap, maskColour) -> int
60        Add(icon) -> int
61
62        Adds a new image or images using a bitmap and optional mask bitmap.
63    %End
64
65    int Add(
66        const wxBitmap & bitmap,
67        const wxColour & maskColour
68    );
69
70    int Add(
71        const wxIcon & icon
72    );
73
74    bool Create(
75        int width,
76        int height,
77        bool mask = true,
78        int initialCount = 1
79    );
80    %Docstring
81        Create(width, height, mask=True, initialCount=1) -> bool
82
83        Initializes the list.
84    %End
85
86    bool Draw(
87        int index,
88        wxDC & dc,
89        int x,
90        int y,
91        int flags = wxIMAGELIST_DRAW_NORMAL,
92        bool solidBackground = false
93    );
94    %Docstring
95        Draw(index, dc, x, y, flags=IMAGELIST_DRAW_NORMAL, solidBackground=False) -> bool
96
97        Draws a specified image onto a device context.
98    %End
99
100    wxBitmap GetBitmap(
101        int index
102    ) const;
103    %Docstring
104        GetBitmap(index) -> Bitmap
105
106        Returns the bitmap corresponding to the given index.
107    %End
108
109    wxIcon GetIcon(
110        int index
111    ) const;
112    %Docstring
113        GetIcon(index) -> Icon
114
115        Returns the icon corresponding to the given index.
116    %End
117
118    int GetImageCount() const;
119    %Docstring
120        GetImageCount() -> int
121
122        Returns the number of images in the list.
123    %End
124
125    void GetSize(
126        int index,
127        int & width   /Out/,
128        int & height   /Out/
129    ) const;
130    %Docstring
131        GetSize(index) -> (width, height)
132
133        Retrieves the size of the images in the list.
134    %End
135
136    bool Remove(
137        int index
138    );
139    %Docstring
140        Remove(index) -> bool
141
142        Removes the image at the given position.
143    %End
144
145    bool RemoveAll();
146    %Docstring
147        RemoveAll() -> bool
148
149        Removes all the images in the list.
150    %End
151
152    bool Replace(
153        int index,
154        const wxBitmap & bitmap,
155        const wxBitmap & mask = wxNullBitmap
156    );
157    %Docstring
158        Replace(index, bitmap, mask=NullBitmap) -> bool
159        Replace(index, icon) -> bool
160
161        Replaces the existing image with the new image.
162    %End
163
164    bool Replace(
165        int index,
166        const wxIcon & icon
167    );
168
169    private:
170        wxImageList(const wxImageList&);
171
172
173    private:
174        wxImageList& operator=(const wxImageList&);
175
176
177    public:
178
179
180    %Property(name=ImageCount, get=GetImageCount)
181};  // end of class wxImageList
182
183
184
185//---------------------------------------------------------------------------
186
187