#include </home/zeitlin/src/wx/github/interface/wx/iconbndl.h>
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 Types | |
enum | { FALLBACK_NONE = 0, FALLBACK_SYSTEM = 1, FALLBACK_NEAREST_LARGER = 2 } |
The elements of this enum determine what happens if GetIcon() doesn't find the icon of exactly the requested size. More... | |
Public Member Functions | |
wxIconBundle () | |
Default ctor. | |
wxIconBundle (const wxString &file, wxBitmapType type=wxBITMAP_TYPE_ANY) | |
Initializes the bundle with the icon(s) found in the file. | |
wxIconBundle (wxInputStream &stream, wxBitmapType type=wxBITMAP_TYPE_ANY) | |
Initializes the bundle with the icon(s) found in the stream. | |
wxIconBundle (const wxIcon &icon) | |
Initializes the bundle with a single icon. | |
wxIconBundle (const wxIconBundle &ic) | |
Copy constructor. | |
virtual | ~wxIconBundle () |
Destructor. | |
void | AddIcon (const wxString &file, wxBitmapType type=wxBITMAP_TYPE_ANY) |
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 | AddIcon (wxInputStream &stream, wxBitmapType type=wxBITMAP_TYPE_ANY) |
Adds all the icons contained in the stream to the bundle; if the collection already contains icons with the same width and height, they are replaced by the new ones. | |
void | 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. | |
wxIcon | GetIcon (const wxSize &size, int flags=FALLBACK_SYSTEM) const |
Returns the icon with the given size. | |
wxIcon | GetIcon (wxCoord size=wxDefaultCoord, int flags=FALLBACK_SYSTEM) const |
Same as. | |
wxIcon | GetIconOfExactSize (const wxSize &size) const |
Returns the icon with exactly the given size or wxNullIcon if this size is not available. | |
size_t | GetIconCount () const |
return the number of available icons | |
wxIcon | GetIconByIndex (size_t n) const |
return the icon at index (must be < GetIconCount()) | |
bool | 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 & | operator= (const wxIconBundle &ic) |
Assignment operator, using reference counting. |
anonymous enum |
The elements of this enum determine what happens if GetIcon() doesn't find the icon of exactly the requested size.
wxIconBundle::wxIconBundle | ( | ) |
Default ctor.
wxIconBundle::wxIconBundle | ( | const wxString & | file, |
wxBitmapType | type = wxBITMAP_TYPE_ANY |
||
) |
Initializes the bundle with the icon(s) found in the file.
wxIconBundle::wxIconBundle | ( | wxInputStream & | stream, |
wxBitmapType | type = wxBITMAP_TYPE_ANY |
||
) |
Initializes the bundle with the icon(s) found in the stream.
Notice that the stream must be seekable, at least if it contains more than one icon. The stream pointer is positioned after the last icon read from the stream when this function returns.
wxIconBundle::wxIconBundle | ( | const wxIcon & | icon | ) |
Initializes the bundle with a single icon.
wxIconBundle::wxIconBundle | ( | const wxIconBundle & | ic | ) |
Copy constructor.
virtual wxIconBundle::~wxIconBundle | ( | ) | [virtual] |
Destructor.
void wxIconBundle::AddIcon | ( | const wxString & | file, |
wxBitmapType | type = wxBITMAP_TYPE_ANY |
||
) |
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 | ( | wxInputStream & | stream, |
wxBitmapType | type = wxBITMAP_TYPE_ANY |
||
) |
Adds all the icons contained in the stream to the bundle; if the collection already contains icons with the same width and height, they are replaced by the new ones.
Notice that, as well as in the constructor loading the icon bundle from stream, the stream must be seekable, at least if more than one icon is to be loaded from it.
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 size is wxDefaultSize, it is interpreted as the standard system icon size, i.e. the size returned by wxSystemSettings::GetMetric() for wxSYS_ICON_X
and wxSYS_ICON_Y
.
If the bundle contains an icon with exactly the requested size, it's always returned. Otherwise, the behaviour depends on the flags. If only ::FALLBACK_NONE is given, the function returns an invalid icon. If ::FALLBACK_SYSTEM is given, it tries to find the icon of standard system size, regardless of the size passed as parameter. Otherwise, or if the icon system size is not found neither, but ::FALLBACK_NEAREST_LARGER flag is specified, the function returns the smallest icon of the size larger than the requested one or, if this fails too, just the icon closest to the specified size.
The flags parameter is available only since wxWidgets 2.9.4.
wxIcon wxIconBundle::GetIcon | ( | wxCoord | size = wxDefaultCoord , |
int | flags = FALLBACK_SYSTEM |
||
) | const |
wxIcon wxIconBundle::GetIconByIndex | ( | size_t | n | ) | const |
return the icon at index (must be < GetIconCount())
size_t wxIconBundle::GetIconCount | ( | ) | const |
return the number of available icons
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.