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