wxIconBundle Class Reference
[Graphics Device Interface (GDI)]
#include <wx/iconbndl.h>
Detailed Description
This class contains multiple copies of an icon in different sizes. It is typically used in wxDialog::SetIcons and wxTopLevelWindow::SetIcons.
Predefined objects/pointers: wxNullIconBundle
Public Member Functions | |
| wxIconBundle () | |
| wxIconBundle (const wxString &file, wxBitmapType type) | |
| wxIconBundle (const wxIcon &icon) | |
| wxIconBundle (const wxIconBundle &ic) | |
| virtual | ~wxIconBundle () |
| void | AddIcon (const wxString &file, wxBitmapType type) |
| void | AddIcon (const wxIcon &icon) |
| wxIcon | GetIcon (const wxSize &size) const |
| wxIcon | GetIcon (wxCoord size=wxDefaultCoord) const |
| wxIcon | GetIconOfExactSize (const wxSize &size) const |
| bool | IsEmpty () const |
| wxIconBundle & | operator= (const wxIconBundle &ic) |
| bool | operator== (const wxIconBundle &ic) |
| bool | operator!= (const wxIconBundle &ic) |
Constructor & Destructor Documentation
| wxIconBundle::wxIconBundle | ( | ) |
Default ctor.
| wxIconBundle::wxIconBundle | ( | const wxString & | file, | |
| wxBitmapType | type | |||
| ) |
Initializes the bundle with the icon(s) found in the file.
| wxIconBundle::wxIconBundle | ( | const wxIcon & | icon | ) |
Initializes the bundle with a single icon.
| wxIconBundle::wxIconBundle | ( | const wxIconBundle & | ic | ) |
Copy constructor.
| virtual wxIconBundle::~wxIconBundle | ( | ) | [virtual] |
Destructor.
Member Function Documentation
| void wxIconBundle::AddIcon | ( | const wxString & | file, | |
| wxBitmapType | type | |||
| ) |
Adds all the icons contained in the file to the bundle; if the collection already contains icons with the same width and height, they are replaced by the new ones.
| void wxIconBundle::AddIcon | ( | const wxIcon & | icon | ) |
Adds the icon to the collection; if the collection already contains an icon with the same width and height, it is replaced by the new one.
Returns the icon with the given size; if no such icon exists, returns the icon with size wxSYS_ICON_X and wxSYS_ICON_Y; if no such icon exists, returns the first icon in the bundle.
If size = wxDefaultSize, returns the icon with size wxSYS_ICON_X and wxSYS_ICON_Y.
| wxIcon wxIconBundle::GetIcon | ( | wxCoord | size = wxDefaultCoord |
) | const |
Returns the icon with exactly the given size or wxNullIcon if this size is not available.
| bool wxIconBundle::IsEmpty | ( | ) | const |
Returns true if the bundle doesn't contain any icons, false otherwise (in which case a call to GetIcon() with default parameter should return a valid icon).
| wxIconBundle& wxIconBundle::operator= | ( | const wxIconBundle & | ic | ) |
Assignment operator, using reference counting.
| bool wxIconBundle::operator== | ( | const wxIconBundle & | ic | ) |
Equality operator. This returns true if two icon bundles are equal.
| bool wxIconBundle::operator!= | ( | const wxIconBundle & | ic | ) |
Inequality operator. This returns true if two icon bundles are not equal.
