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
13class wxIconBundle : wxGDIObject
14{
15    %Docstring
16        IconBundle()
17        IconBundle(file, type=BITMAP_TYPE_ANY)
18        IconBundle(stream, type=BITMAP_TYPE_ANY)
19        IconBundle(icon)
20        IconBundle(ic)
21
22        This class contains multiple copies of an icon in different sizes.
23    %End
24    %TypeHeaderCode
25        #include <wx/iconbndl.h>
26    %End
27
28public:
29    enum
30    {
31        FALLBACK_NONE,
32        FALLBACK_SYSTEM,
33        FALLBACK_NEAREST_LARGER
34    };
35
36    wxIconBundle();
37    %PreMethodCode
38        if (!wxPyCheckForApp()) return NULL;
39    %End
40
41    wxIconBundle(
42        const wxString & file,
43        wxBitmapType type = wxBITMAP_TYPE_ANY
44    );
45    %PreMethodCode
46        if (!wxPyCheckForApp()) return NULL;
47    %End
48
49    wxIconBundle(
50        wxInputStream & stream,
51        wxBitmapType type = wxBITMAP_TYPE_ANY
52    );
53    %PreMethodCode
54        if (!wxPyCheckForApp()) return NULL;
55    %End
56
57    wxIconBundle(
58        const wxIcon & icon
59    );
60    %PreMethodCode
61        if (!wxPyCheckForApp()) return NULL;
62    %End
63
64    wxIconBundle(
65        const wxIconBundle & ic
66    );
67    %PreMethodCode
68        if (!wxPyCheckForApp()) return NULL;
69    %End
70
71    virtual
72    ~wxIconBundle();
73
74    void AddIcon(
75        const wxString & file,
76        wxBitmapType type = wxBITMAP_TYPE_ANY
77    );
78    %Docstring
79        AddIcon(file, type=BITMAP_TYPE_ANY)
80        AddIcon(stream, type=BITMAP_TYPE_ANY)
81        AddIcon(icon)
82
83        Adds all the icons contained in the file to the bundle; if the
84        collection already contains icons with the same width and height, they
85        are replaced by the new ones.
86    %End
87
88    void AddIcon(
89        wxInputStream & stream,
90        wxBitmapType type = wxBITMAP_TYPE_ANY
91    );
92
93    void AddIcon(
94        const wxIcon & icon
95    );
96
97    wxIcon GetIcon(
98        const wxSize & size,
99        int flags = FALLBACK_SYSTEM
100    ) const;
101    %Docstring
102        GetIcon(size, flags=FALLBACK_SYSTEM) -> Icon
103        GetIcon(size=DefaultCoord, flags=FALLBACK_SYSTEM) -> Icon
104
105        Returns the icon with the given size.
106    %End
107
108    wxIcon GetIcon(
109        wxCoord size = wxDefaultCoord,
110        int flags = FALLBACK_SYSTEM
111    ) const;
112
113    wxIcon GetIconOfExactSize(
114        const wxSize & size
115    ) const;
116    %Docstring
117        GetIconOfExactSize(size) -> Icon
118
119        Returns the icon with exactly the given size or wxNullIcon if this
120        size is not available.
121    %End
122
123    size_t GetIconCount() const;
124    %Docstring
125        GetIconCount() -> size_t
126
127        return the number of available icons
128    %End
129
130    wxIcon GetIconByIndex(
131        size_t n
132    ) const;
133    %Docstring
134        GetIconByIndex(n) -> Icon
135
136        return the icon at index (must be < GetIconCount())
137    %End
138
139    bool IsEmpty() const;
140    %Docstring
141        IsEmpty() -> bool
142
143        Returns true if the bundle doesn't contain any icons, false otherwise
144        (in which case a call to GetIcon() with default parameter should
145        return a valid icon).
146    %End
147
148    public:
149
150
151    %Property(name=Icon, get=GetIcon)
152    %Property(name=IconCount, get=GetIconCount)
153};  // end of class wxIconBundle
154
155
156wxIconBundle wxNullIconBundle;
157
158
159//---------------------------------------------------------------------------
160
161