include/wx/iconbndl.h

   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
   9 // Licence:     wxWindows licence
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_ICONBNDL_H_
  13 #define _WX_ICONBNDL_H_
  14
  15 #include "wx/gdiobj.h"
  16 #include "wx/gdicmn.h"      // for wxSize
  17 #include "wx/icon.h"
  18
  19 #include "wx/dynarray.h"
  20
  21 class WXDLLIMPEXP_FWD_BASE wxInputStream;
  22
  23 WX_DECLARE_EXPORTED_OBJARRAY(wxIcon, wxIconArray);
  24
  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
  28 class WXDLLIMPEXP_CORE wxIconBundle : public wxGDIObject
  29 {
  30 public:
  31     // default constructor
  32     wxIconBundle();
  33
  34     // initializes the bundle with the icon(s) found in the file
  35 #if wxUSE_STREAMS
  36     wxIconBundle(const wxString& file, wxBitmapType type = wxBITMAP_TYPE_ANY);
  37     wxIconBundle(wxInputStream& stream, wxBitmapType type = wxBITMAP_TYPE_ANY);
  38 #endif // wxUSE_STREAMS
  39
  40     // initializes the bundle with a single icon
  41     wxIconBundle(const wxIcon& icon);
  42
  43     // default copy ctor and assignment operator are OK
  44
  45     // adds all the icons contained in the file to the collection,
  46     // if the collection already contains icons with the same
  47     // width and height, they are replaced
  48 #if wxUSE_STREAMS
  49     void AddIcon(const wxString& file, wxBitmapType type = wxBITMAP_TYPE_ANY);
  50     void AddIcon(wxInputStream& stream, wxBitmapType type = wxBITMAP_TYPE_ANY);
  51 #endif // wxUSE_STREAMS
  52
  53     // adds the icon to the collection, if the collection already
  54     // contains an icon with the same width and height, it is
  55     // replaced
  56     void AddIcon(const wxIcon& icon);
  57
  58     // returns the icon with the given size; if no such icon exists,
  59     // returns the icon with size wxSYS_ICON_[XY]; if no such icon exists,
  60     // returns the first icon in the bundle
  61     wxIcon GetIcon(const wxSize& size) const;
  62
  63     // equivalent to GetIcon(wxSize(size, size))
  64     wxIcon GetIcon(wxCoord size = wxDefaultCoord) const
  65         { return GetIcon(wxSize(size, size)); }
  66
  67     // returns the icon exactly of the specified size or wxNullIcon if no icon
  68     // of exactly given size are available
  69     wxIcon GetIconOfExactSize(const wxSize& size) const;
  70     wxIcon GetIconOfExactSize(wxCoord size) const
  71         { return GetIconOfExactSize(wxSize(size, size)); }
  72
  73     // enumerate all icons in the bundle: don't use these functions if ti can
  74     // be avoided, using GetIcon() directly is better
  75
  76     // return the number of available icons
  77     size_t GetIconCount() const;
  78
  79     // return the icon at index (must be < GetIconCount())
  80     wxIcon GetIconByIndex(size_t n) const;
  81
  82     // check if we have any icons at all
  83     bool IsEmpty() const { return GetIconCount() == 0; }
  84
  85 #if WXWIN_COMPATIBILITY_2_8
  86     wxDEPRECATED( void AddIcon(const wxString& file, long type)
  87         {
  88             AddIcon(file, (wxBitmapType)type);
  89         }
  90     )
  91
  92     wxDEPRECATED_CONSTRUCTOR( wxIconBundle (const wxString& file, long type)
  93         {
  94             AddIcon(file, (wxBitmapType)type);
  95         }
  96     )
  97 #endif // WXWIN_COMPATIBILITY_2_8
  98
  99 protected:
 100     virtual wxGDIRefData *CreateGDIRefData() const;
 101     virtual wxGDIRefData *CloneGDIRefData(const wxGDIRefData *data) const;
 102
 103 private:
 104     // delete all icons
 105     void DeleteIcons();
 106
 107     DECLARE_DYNAMIC_CLASS(wxIconBundle)
 108 };
 109
 110 #endif // _WX_ICONBNDL_H_