1 ///////////////////////////////////////////////////////////////////////////////
3 // Purpose: wxIconBundle
4 // Author: Mattia barbon
8 // Copyright: (c) Mattia Barbon
9 // Licence: wxWindows licence
10 ///////////////////////////////////////////////////////////////////////////////
12 #ifndef _WX_ICONBNDL_H_
13 #define _WX_ICONBNDL_H_
15 #include "wx/dynarray.h"
16 #include "wx/gdiobj.h"
18 #include "wx/gdicmn.h"
21 class WXDLLIMPEXP_FWD_CORE wxIcon
;
22 class WXDLLIMPEXP_FWD_BASE wxString
;
24 class WXDLLIMPEXP_FWD_CORE wxIconBundle
;
26 WX_DECLARE_EXPORTED_OBJARRAY(wxIcon
, wxIconArray
);
28 // this class can't load bitmaps of type wxBITMAP_TYPE_ICO_RESOURCE,
29 // if you need them, you have to load them manually and call
30 // wxIconCollection::AddIcon
31 class WXDLLIMPEXP_CORE wxIconBundle
: public wxGDIObject
34 // default constructor
37 // initializes the bundle with the icon(s) found in the file
38 wxIconBundle(const wxString
& file
, wxBitmapType type
);
40 // initializes the bundle with a single icon
41 wxIconBundle(const wxIcon
& icon
);
43 // initializes the bundle from another icon bundle
44 wxIconBundle(const wxIconBundle
& icon
);
46 wxIconBundle
& operator=(const wxIconBundle
& ic
)
47 { if ( this != &ic
) Ref(ic
); return *this; }
50 // adds all the icons contained in the file to the collection,
51 // if the collection already contains icons with the same
52 // width and height, they are replaced
53 void AddIcon(const wxString
& file
, wxBitmapType type
);
55 // adds the icon to the collection, if the collection already
56 // contains an icon with the same width and height, it is
58 void AddIcon(const wxIcon
& icon
);
60 // returns the icon with the given size; if no such icon exists,
61 // returns the icon with size wxSYS_ICON_[XY]; if no such icon exists,
62 // returns the first icon in the bundle
63 wxIcon
GetIcon(const wxSize
& size
) const;
65 // equivalent to GetIcon(wxSize(size, size))
66 wxIcon
GetIcon(wxCoord size
= wxDefaultCoord
) const
67 { return GetIcon(wxSize(size
, size
)); }
69 // returns the icon exactly of the specified size or wxNullIcon if no icon
70 // of exactly given size are available
71 wxIcon
GetIconOfExactSize(const wxSize
& size
) const;
72 wxIcon
GetIconOfExactSize(wxCoord size
) const
73 { return GetIconOfExactSize(wxSize(size
, size
)); }
75 // enumerate all icons in the bundle: don't use these functions if ti can
76 // be avoided, using GetIcon() directly is better
78 // return the number of available icons
79 size_t GetIconCount() const;
81 // return the icon at index (must be < GetIconCount())
82 wxIcon
GetIconByIndex(size_t n
) const;
84 // check if we have any icons at all
85 bool IsEmpty() const { return GetIconCount() == 0; }
87 #ifdef WXWIN_COMPATIBILITY_2_8
88 wxDEPRECATED( void AddIcon(const wxString
& file
, long type
)
90 AddIcon(file
, (long)type
);
94 wxDEPRECATED( wxIconBundle(const wxString
& file
, long type
)
96 AddIcon(file
, (wxBitmapType
)type
);
99 #endif // WXWIN_COMPATIBILITY_2_8
102 virtual wxGDIRefData
*CreateGDIRefData() const;
103 virtual wxGDIRefData
*CloneGDIRefData(const wxGDIRefData
*data
) const;
109 DECLARE_DYNAMIC_CLASS(wxIconBundle
)
112 #endif // _WX_ICONBNDL_H_