]> git.saurik.com Git - wxWidgets.git/blame - include/wx/iconbndl.h
Add RunScript and implement on all backends. Document and add a very simple unit...
[wxWidgets.git] / include / wx / iconbndl.h
CommitLineData
f618020a
MB
1///////////////////////////////////////////////////////////////////////////////
2// Name: wx/iconbndl.h
3// Purpose: wxIconBundle
4// Author: Mattia barbon
5// Modified by:
6// Created: 23.03.02
7// RCS-ID: $Id$
8// Copyright: (c) Mattia Barbon
65571936 9// Licence: wxWindows licence
f618020a
MB
10///////////////////////////////////////////////////////////////////////////////
11
12#ifndef _WX_ICONBNDL_H_
13#define _WX_ICONBNDL_H_
14
52734360 15#include "wx/gdiobj.h"
b85b06e1 16#include "wx/gdicmn.h" // for wxSize
52734360 17#include "wx/icon.h"
f618020a 18
7105649b
VZ
19#include "wx/dynarray.h"
20
cee875e3
VS
21class WXDLLIMPEXP_FWD_BASE wxInputStream;
22
d2cb636a
PC
23WX_DECLARE_EXPORTED_OBJARRAY(wxIcon, wxIconArray);
24
f618020a
MB
25// this class can't load bitmaps of type wxBITMAP_TYPE_ICO_RESOURCE,
26// if you need them, you have to load them manually and call
27// wxIconCollection::AddIcon
53a2db12 28class WXDLLIMPEXP_CORE wxIconBundle : public wxGDIObject
f618020a
MB
29{
30public:
31 // default constructor
52734360
VZ
32 wxIconBundle();
33
f618020a 34 // initializes the bundle with the icon(s) found in the file
e94be2b1 35#if wxUSE_STREAMS && wxUSE_IMAGE
89e1de64 36#if wxUSE_FFILE || wxUSE_FILE
b85b06e1 37 wxIconBundle(const wxString& file, wxBitmapType type = wxBITMAP_TYPE_ANY);
89e1de64 38#endif // wxUSE_FFILE || wxUSE_FILE
cee875e3 39 wxIconBundle(wxInputStream& stream, wxBitmapType type = wxBITMAP_TYPE_ANY);
e94be2b1 40#endif // wxUSE_STREAMS && wxUSE_IMAGE
52734360 41
f618020a 42 // initializes the bundle with a single icon
52734360
VZ
43 wxIconBundle(const wxIcon& icon);
44
24af522c 45 // default copy ctor and assignment operator are OK
f618020a
MB
46
47 // adds all the icons contained in the file to the collection,
48 // if the collection already contains icons with the same
49 // width and height, they are replaced
e94be2b1 50#if wxUSE_STREAMS && wxUSE_IMAGE
89e1de64 51#if wxUSE_FFILE || wxUSE_FILE
b85b06e1 52 void AddIcon(const wxString& file, wxBitmapType type = wxBITMAP_TYPE_ANY);
89e1de64 53#endif // wxUSE_FFILE || wxUSE_FILE
cee875e3 54 void AddIcon(wxInputStream& stream, wxBitmapType type = wxBITMAP_TYPE_ANY);
e94be2b1 55#endif // wxUSE_STREAMS && wxUSE_IMAGE
52734360 56
f618020a
MB
57 // adds the icon to the collection, if the collection already
58 // contains an icon with the same width and height, it is
59 // replaced
52734360 60 void AddIcon(const wxIcon& icon);
f618020a
MB
61
62 // returns the icon with the given size; if no such icon exists,
63 // returns the icon with size wxSYS_ICON_[XY]; if no such icon exists,
64 // returns the first icon in the bundle
52734360
VZ
65 wxIcon GetIcon(const wxSize& size) const;
66
9b5933bc 67 // equivalent to GetIcon(wxSize(size, size))
52734360 68 wxIcon GetIcon(wxCoord size = wxDefaultCoord) const
9b5933bc 69 { return GetIcon(wxSize(size, size)); }
52734360 70
9b5933bc
VZ
71 // returns the icon exactly of the specified size or wxNullIcon if no icon
72 // of exactly given size are available
73 wxIcon GetIconOfExactSize(const wxSize& size) const;
74 wxIcon GetIconOfExactSize(wxCoord size) const
75 { return GetIconOfExactSize(wxSize(size, size)); }
52734360
VZ
76
77 // enumerate all icons in the bundle: don't use these functions if ti can
78 // be avoided, using GetIcon() directly is better
79
80 // return the number of available icons
81 size_t GetIconCount() const;
82
83 // return the icon at index (must be < GetIconCount())
84 wxIcon GetIconByIndex(size_t n) const;
85
f7186899
VZ
86 // check if we have any icons at all
87 bool IsEmpty() const { return GetIconCount() == 0; }
88
831b64f3 89#if WXWIN_COMPATIBILITY_2_8
89e1de64 90#if wxUSE_STREAMS && wxUSE_IMAGE && (wxUSE_FFILE || wxUSE_FILE)
0ddec397
VZ
91 wxDEPRECATED( void AddIcon(const wxString& file, long type)
92 {
1473d17f 93 AddIcon(file, (wxBitmapType)type);
0ddec397
VZ
94 }
95 )
70bf3295
SC
96
97 wxDEPRECATED_CONSTRUCTOR( wxIconBundle (const wxString& file, long type)
0ddec397
VZ
98 {
99 AddIcon(file, (wxBitmapType)type);
100 }
101 )
89e1de64 102#endif // wxUSE_STREAMS && wxUSE_IMAGE && (wxUSE_FFILE || wxUSE_FILE)
0ddec397
VZ
103#endif // WXWIN_COMPATIBILITY_2_8
104
52734360 105protected:
8f884a0d
VZ
106 virtual wxGDIRefData *CreateGDIRefData() const;
107 virtual wxGDIRefData *CloneGDIRefData(const wxGDIRefData *data) const;
52734360 108
f618020a
MB
109private:
110 // delete all icons
111 void DeleteIcons();
52734360
VZ
112
113 DECLARE_DYNAMIC_CLASS(wxIconBundle)
f618020a
MB
114};
115
52734360 116#endif // _WX_ICONBNDL_H_