src/common/iconbndl.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/common/iconbndl.cpp
   3 // Purpose:     wxIconBundle
   4 // Author:      Mattia Barbon, Vadim Zeitlin
   5 // Created:     23.03.2002
   6 // RCS-ID:      $Id$
   7 // Copyright:   (c) Mattia barbon
   8 // Licence:     wxWindows licence
   9 /////////////////////////////////////////////////////////////////////////////
  10
  11 // For compilers that support precompilation, includes "wx.h".
  12 #include "wx/wxprec.h"
  13
  14 #ifdef __BORLANDC__
  15     #pragma hdrstop
  16 #endif
  17
  18 #include "wx/iconbndl.h"
  19
  20 #ifndef WX_PRECOMP
  21     #include "wx/settings.h"
  22     #include "wx/log.h"
  23     #include "wx/intl.h"
  24     #include "wx/bitmap.h"
  25     #include "wx/image.h"
  26     #include "wx/stream.h"
  27 #endif
  28
  29 #include "wx/wfstream.h"
  30
  31 #include "wx/arrimpl.cpp"
  32 WX_DEFINE_OBJARRAY(wxIconArray)
  33
  34 IMPLEMENT_DYNAMIC_CLASS(wxIconBundle, wxGDIObject)
  35
  36 #define M_ICONBUNDLEDATA static_cast<wxIconBundleRefData*>(m_refData)
  37
  38 // ----------------------------------------------------------------------------
  39 // wxIconBundleRefData
  40 // ----------------------------------------------------------------------------
  41
  42 class WXDLLEXPORT wxIconBundleRefData : public wxGDIRefData
  43 {
  44 public:
  45     // default and copy ctors and assignment operators are ok
  46
  47     virtual bool IsOk() const { return !m_icons.empty(); }
  48
  49     wxIconArray m_icons;
  50 };
  51
  52 // ============================================================================
  53 // wxIconBundle implementation
  54 // ============================================================================
  55
  56 wxIconBundle::wxIconBundle()
  57 {
  58 }
  59
  60 #if wxUSE_STREAMS && wxUSE_IMAGE
  61
  62 #if wxUSE_FFILE || wxUSE_FILE
  63 wxIconBundle::wxIconBundle(const wxString& file, wxBitmapType type)
  64             : wxGDIObject()
  65 {
  66     AddIcon(file, type);
  67 }
  68 #endif // wxUSE_FFILE || wxUSE_FILE
  69
  70 wxIconBundle::wxIconBundle(wxInputStream& stream, wxBitmapType type)
  71             : wxGDIObject()
  72 {
  73     AddIcon(stream, type);
  74 }
  75 #endif // wxUSE_STREAMS && wxUSE_IMAGE
  76
  77 wxIconBundle::wxIconBundle(const wxIcon& icon)
  78             : wxGDIObject()
  79 {
  80     AddIcon(icon);
  81 }
  82
  83 wxGDIRefData *wxIconBundle::CreateGDIRefData() const
  84 {
  85     return new wxIconBundleRefData;
  86 }
  87
  88 wxGDIRefData *wxIconBundle::CloneGDIRefData(const wxGDIRefData *data) const
  89 {
  90     return new wxIconBundleRefData(*static_cast<const wxIconBundleRefData *>(data));
  91 }
  92
  93 void wxIconBundle::DeleteIcons()
  94 {
  95     UnRef();
  96 }
  97
  98 #if wxUSE_STREAMS && wxUSE_IMAGE
  99
 100 namespace
 101 {
 102
 103 // Adds icon from 'input' to the bundle. Shows 'errorMessage' on failure
 104 // (it must contain "%d", because it is used to report # of image in the file
 105 // that failed to load):
 106 void DoAddIcon(wxIconBundle& bundle,
 107                wxInputStream& input,
 108                wxBitmapType type,
 109                const wxString& errorMessage)
 110 {
 111     wxImage image;
 112
 113     const wxFileOffset posOrig = input.TellI();
 114
 115     const size_t count = wxImage::GetImageCount(input, type);
 116     for ( size_t i = 0; i < count; ++i )
 117     {
 118         if ( i )
 119         {
 120             // the call to LoadFile() for the first sub-image updated the
 121             // stream position but we need to start reading the subsequent
 122             // sub-image at the image beginning too
 123             input.SeekI(posOrig);
 124         }
 125
 126         if ( !image.LoadFile(input, type, i) )
 127         {
 128             wxLogError(errorMessage, i);
 129             continue;
 130         }
 131
 132         if ( type == wxBITMAP_TYPE_ANY )
 133         {
 134             // store the type so that we don't need to try all handlers again
 135             // for the subsequent images, they should all be of the same type
 136             type = image.GetType();
 137         }
 138
 139         wxIcon tmp;
 140         tmp.CopyFromBitmap(wxBitmap(image));
 141         bundle.AddIcon(tmp);
 142     }
 143 }
 144
 145 } // anonymous namespace
 146
 147 #if wxUSE_FFILE || wxUSE_FILE
 148
 149 void wxIconBundle::AddIcon(const wxString& file, wxBitmapType type)
 150 {
 151 #ifdef __WXMAC__
 152     // Deal with standard icons
 153     if ( type == wxBITMAP_TYPE_ICON_RESOURCE )
 154     {
 155         wxIcon tmp(file, type);
 156         if (tmp.Ok())
 157         {
 158             AddIcon(tmp);
 159             return;
 160         }
 161     }
 162 #endif // __WXMAC__
 163
 164 #if wxUSE_FFILE
 165     wxFFileInputStream stream(file);
 166 #elif wxUSE_FILE
 167     wxFileInputStream stream(file);
 168 #endif
 169     DoAddIcon
 170     (
 171         *this,
 172         stream, type,
 173         wxString::Format(_("Failed to load image %%d from file '%s'."), file)
 174     );
 175 }
 176
 177 #endif // wxUSE_FFILE || wxUSE_FILE
 178
 179 void wxIconBundle::AddIcon(wxInputStream& stream, wxBitmapType type)
 180 {
 181     DoAddIcon(*this, stream, type, _("Failed to load image %d from stream."));
 182 }
 183
 184 #endif // wxUSE_STREAMS && wxUSE_IMAGE
 185
 186 wxIcon wxIconBundle::GetIcon(const wxSize& size) const
 187 {
 188     const size_t count = GetIconCount();
 189
 190     // optimize for the common case of icon bundles containing one icon only
 191     wxIcon iconBest;
 192     switch ( count )
 193     {
 194         case 0:
 195             // nothing to do, iconBest is already invalid
 196             break;
 197
 198         case 1:
 199             iconBest = M_ICONBUNDLEDATA->m_icons[0];
 200             break;
 201
 202         default:
 203             // there is more than one icon, find the best match:
 204             wxCoord sysX = wxSystemSettings::GetMetric( wxSYS_ICON_X ),
 205                     sysY = wxSystemSettings::GetMetric( wxSYS_ICON_Y );
 206
 207             const wxIconArray& iconArray = M_ICONBUNDLEDATA->m_icons;
 208             for ( size_t i = 0; i < count; i++ )
 209             {
 210                 const wxIcon& icon = iconArray[i];
 211                 wxCoord sx = icon.GetWidth(),
 212                         sy = icon.GetHeight();
 213
 214                 // if we got an icon of exactly the requested size, we're done
 215                 if ( sx == size.x && sy == size.y )
 216                 {
 217                     iconBest = icon;
 218                     break;
 219                 }
 220
 221                 // the best icon is by default (arbitrarily) the first one but
 222                 // if we find a system-sized icon, take it instead
 223                 if ((sx == sysX && sy == sysY) || !iconBest.IsOk())
 224                     iconBest = icon;
 225             }
 226     }
 227
 228 #if defined( __WXMAC__ ) && wxOSX_USE_CARBON
 229     return wxIcon(iconBest.GetHICON(), size);
 230 #else
 231     return iconBest;
 232 #endif
 233 }
 234
 235 wxIcon wxIconBundle::GetIconOfExactSize(const wxSize& size) const
 236 {
 237     wxIcon icon = GetIcon(size);
 238     if ( icon.Ok() &&
 239             (icon.GetWidth() != size.x || icon.GetHeight() != size.y) )
 240     {
 241         icon = wxNullIcon;
 242     }
 243
 244     return icon;
 245 }
 246
 247 void wxIconBundle::AddIcon(const wxIcon& icon)
 248 {
 249     wxCHECK_RET( icon.IsOk(), wxT("invalid icon") );
 250
 251     AllocExclusive();
 252
 253     wxIconArray& iconArray = M_ICONBUNDLEDATA->m_icons;
 254
 255     // replace existing icon with the same size if we already have it
 256     const size_t count = iconArray.size();
 257     for ( size_t i = 0; i < count; ++i )
 258     {
 259         wxIcon& tmp = iconArray[i];
 260         if ( tmp.Ok() &&
 261                 tmp.GetWidth() == icon.GetWidth() &&
 262                 tmp.GetHeight() == icon.GetHeight() )
 263         {
 264             tmp = icon;
 265             return;
 266         }
 267     }
 268
 269     // if we don't, add an icon with new size
 270     iconArray.Add(icon);
 271 }
 272
 273 size_t wxIconBundle::GetIconCount() const
 274 {
 275     return IsOk() ? M_ICONBUNDLEDATA->m_icons.size() : 0;
 276 }
 277
 278 wxIcon wxIconBundle::GetIconByIndex(size_t n) const
 279 {
 280     wxCHECK_MSG( n < GetIconCount(), wxNullIcon, wxT("invalid index") );
 281
 282     return M_ICONBUNDLEDATA->m_icons[n];
 283 }