X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/77ffb5937e89927b621128789401db8921fe580f..07cf4247ec0ef30223a94d557d7734b1a99f692b:/include/wx/iconbndl.h diff --git a/include/wx/iconbndl.h b/include/wx/iconbndl.h index 869f93e3c2..c52c984d8a 100644 --- a/include/wx/iconbndl.h +++ b/include/wx/iconbndl.h @@ -6,68 +6,93 @@ // Created: 23.03.02 // RCS-ID: $Id$ // Copyright: (c) Mattia Barbon -// Licence: wxWidgets licence +// Licence: wxWindows licence /////////////////////////////////////////////////////////////////////////////// #ifndef _WX_ICONBNDL_H_ #define _WX_ICONBNDL_H_ -#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) -#pragma interface "iconbndl.h" -#endif - #include "wx/dynarray.h" +#include "wx/gdiobj.h" // for wxSize #include "wx/gdicmn.h" +#include "wx/icon.h" + +class WXDLLIMPEXP_FWD_CORE wxIcon; +class WXDLLIMPEXP_FWD_BASE wxString; -class WXDLLEXPORT wxIcon; -class WXDLLEXPORT wxString; +class WXDLLIMPEXP_FWD_CORE wxIconBundle; -WX_DECLARE_EXPORTED_OBJARRAY( wxIcon, wxIconArray ); +WX_DECLARE_EXPORTED_OBJARRAY(wxIcon, wxIconArray); // this class can't load bitmaps of type wxBITMAP_TYPE_ICO_RESOURCE, // if you need them, you have to load them manually and call // wxIconCollection::AddIcon -class WXDLLEXPORT wxIconBundle +class WXDLLIMPEXP_CORE wxIconBundle : public wxGDIObject { public: // default constructor - wxIconBundle() : m_icons() {} + wxIconBundle(); + // initializes the bundle with the icon(s) found in the file - wxIconBundle( const wxString& file, long type ) : m_icons() - { AddIcon( file, type ); } + wxIconBundle(const wxString& file, long type); + // initializes the bundle with a single icon - wxIconBundle( const wxIcon& icon ) : m_icons() - { AddIcon( icon ); } + wxIconBundle(const wxIcon& icon); - const wxIconBundle& operator =( const wxIconBundle& ic ); - wxIconBundle( const wxIconBundle& ic ) : m_icons() - { *this = ic; } + // initializes the bundle from another icon bundle + wxIconBundle(const wxIconBundle& icon); + + wxIconBundle& operator=(const wxIconBundle& ic) + { if ( this != &ic) Ref(ic); return *this; } - ~wxIconBundle() { DeleteIcons(); } // adds all the icons contained in the file to the collection, // if the collection already contains icons with the same // width and height, they are replaced - void AddIcon( const wxString& file, long type ); + void AddIcon(const wxString& file, long type); + // adds the icon to the collection, if the collection already // contains an icon with the same width and height, it is // replaced - void AddIcon( const wxIcon& icon ); + void AddIcon(const wxIcon& icon); // returns the icon with the given size; if no such icon exists, // returns the icon with size wxSYS_ICON_[XY]; if no such icon exists, // returns the first icon in the bundle - const wxIcon& GetIcon( const wxSize& size ) const; - // equivalent to GetIcon( wxSize( size, size ) ) - const wxIcon& GetIcon( wxCoord size = -1 ) const - { return GetIcon( wxSize( size, size ) ); } + wxIcon GetIcon(const wxSize& size) const; + + // equivalent to GetIcon(wxSize(size, size)) + wxIcon GetIcon(wxCoord size = wxDefaultCoord) const + { return GetIcon(wxSize(size, size)); } + + // returns the icon exactly of the specified size or wxNullIcon if no icon + // of exactly given size are available + wxIcon GetIconOfExactSize(const wxSize& size) const; + wxIcon GetIconOfExactSize(wxCoord size) const + { return GetIconOfExactSize(wxSize(size, size)); } + + // enumerate all icons in the bundle: don't use these functions if ti can + // be avoided, using GetIcon() directly is better + + // return the number of available icons + size_t GetIconCount() const; + + // return the icon at index (must be < GetIconCount()) + wxIcon GetIconByIndex(size_t n) const; + + // check if we have any icons at all + bool IsEmpty() const { return GetIconCount() == 0; } + +protected: + virtual wxGDIRefData *CreateGDIRefData() const; + virtual wxGDIRefData *CloneGDIRefData(const wxGDIRefData *data) const; + private: // delete all icons void DeleteIcons(); -public: - wxIconArray m_icons; + + DECLARE_DYNAMIC_CLASS(wxIconBundle) }; -#endif - // _WX_ICONBNDL_H_ +#endif // _WX_ICONBNDL_H_