Files
wxWidgets/src/common/iconbndl.cpp
Vadim Zeitlin d928f01967 Fix setting frame icon when using non-standard icon sizes in wxMSW.
Set the closest (and larger, if possible) icon if the icon of exactly the
system icon size is not available. This fixes setting the icons when using
custom DPI settings under MSW as the standard icon size may be different from
the standard 32*32 in this case.

This also improves wxIconBundle::GetIcon() to make its behaviour when the icon
with exactly the given size is not found more flexible as a side effect.

Closes #13891.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70455 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-01-24 22:17:47 +00:00

329 lines
8.4 KiB
C++

/////////////////////////////////////////////////////////////////////////////
// Name: src/common/iconbndl.cpp
// Purpose: wxIconBundle
// Author: Mattia Barbon, Vadim Zeitlin
// Created: 23.03.2002
// RCS-ID: $Id$
// Copyright: (c) Mattia barbon
// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
// For compilers that support precompilation, includes "wx.h".
#include "wx/wxprec.h"
#ifdef __BORLANDC__
#pragma hdrstop
#endif
#include "wx/iconbndl.h"
#ifndef WX_PRECOMP
#include "wx/settings.h"
#include "wx/log.h"
#include "wx/intl.h"
#include "wx/bitmap.h"
#include "wx/image.h"
#include "wx/stream.h"
#endif
#include "wx/wfstream.h"
#include "wx/arrimpl.cpp"
WX_DEFINE_OBJARRAY(wxIconArray)
IMPLEMENT_DYNAMIC_CLASS(wxIconBundle, wxGDIObject)
#define M_ICONBUNDLEDATA static_cast<wxIconBundleRefData*>(m_refData)
// ----------------------------------------------------------------------------
// wxIconBundleRefData
// ----------------------------------------------------------------------------
class WXDLLEXPORT wxIconBundleRefData : public wxGDIRefData
{
public:
wxIconBundleRefData() { }
// We need the copy ctor for CloneGDIRefData() but notice that we use the
// base class default ctor in it and not the copy one which it doesn't have.
wxIconBundleRefData(const wxIconBundleRefData& other)
: wxGDIRefData(),
m_icons(other.m_icons)
{
}
// default assignment operator and dtor are ok
virtual bool IsOk() const { return !m_icons.empty(); }
wxIconArray m_icons;
};
// ============================================================================
// wxIconBundle implementation
// ============================================================================
wxIconBundle::wxIconBundle()
{
}
#if wxUSE_STREAMS && wxUSE_IMAGE
#if wxUSE_FFILE || wxUSE_FILE
wxIconBundle::wxIconBundle(const wxString& file, wxBitmapType type)
: wxGDIObject()
{
AddIcon(file, type);
}
#endif // wxUSE_FFILE || wxUSE_FILE
wxIconBundle::wxIconBundle(wxInputStream& stream, wxBitmapType type)
: wxGDIObject()
{
AddIcon(stream, type);
}
#endif // wxUSE_STREAMS && wxUSE_IMAGE
wxIconBundle::wxIconBundle(const wxIcon& icon)
: wxGDIObject()
{
AddIcon(icon);
}
wxGDIRefData *wxIconBundle::CreateGDIRefData() const
{
return new wxIconBundleRefData;
}
wxGDIRefData *wxIconBundle::CloneGDIRefData(const wxGDIRefData *data) const
{
return new wxIconBundleRefData(*static_cast<const wxIconBundleRefData *>(data));
}
void wxIconBundle::DeleteIcons()
{
UnRef();
}
#if wxUSE_STREAMS && wxUSE_IMAGE
namespace
{
// Adds icon from 'input' to the bundle. Shows 'errorMessage' on failure
// (it must contain "%d", because it is used to report # of image in the file
// that failed to load):
void DoAddIcon(wxIconBundle& bundle,
wxInputStream& input,
wxBitmapType type,
const wxString& errorMessage)
{
wxImage image;
const wxFileOffset posOrig = input.TellI();
const size_t count = wxImage::GetImageCount(input, type);
for ( size_t i = 0; i < count; ++i )
{
if ( i )
{
// the call to LoadFile() for the first sub-image updated the
// stream position but we need to start reading the subsequent
// sub-image at the image beginning too
input.SeekI(posOrig);
}
if ( !image.LoadFile(input, type, i) )
{
wxLogError(errorMessage, i);
continue;
}
if ( type == wxBITMAP_TYPE_ANY )
{
// store the type so that we don't need to try all handlers again
// for the subsequent images, they should all be of the same type
type = image.GetType();
}
wxIcon tmp;
tmp.CopyFromBitmap(wxBitmap(image));
bundle.AddIcon(tmp);
}
}
} // anonymous namespace
#if wxUSE_FFILE || wxUSE_FILE
void wxIconBundle::AddIcon(const wxString& file, wxBitmapType type)
{
#ifdef __WXMAC__
// Deal with standard icons
if ( type == wxBITMAP_TYPE_ICON_RESOURCE )
{
wxIcon tmp(file, type);
if (tmp.IsOk())
{
AddIcon(tmp);
return;
}
}
#endif // __WXMAC__
#if wxUSE_FFILE
wxFFileInputStream stream(file);
#elif wxUSE_FILE
wxFileInputStream stream(file);
#endif
DoAddIcon
(
*this,
stream, type,
wxString::Format(_("Failed to load image %%d from file '%s'."), file)
);
}
#endif // wxUSE_FFILE || wxUSE_FILE
void wxIconBundle::AddIcon(wxInputStream& stream, wxBitmapType type)
{
DoAddIcon(*this, stream, type, _("Failed to load image %d from stream."));
}
#endif // wxUSE_STREAMS && wxUSE_IMAGE
wxIcon wxIconBundle::GetIcon(const wxSize& size, int flags) const
{
wxASSERT( size == wxDefaultSize || (size.x >= 0 && size.y > 0) );
// We need the standard system icon size when using FALLBACK_SYSTEM.
wxCoord sysX = 0,
sysY = 0;
if ( flags & FALLBACK_SYSTEM )
{
sysX = wxSystemSettings::GetMetric(wxSYS_ICON_X);
sysY = wxSystemSettings::GetMetric(wxSYS_ICON_Y);
}
// If size == wxDefaultSize, we use system default icon size by convention.
wxCoord sizeX = size.x;
wxCoord sizeY = size.y;
if ( size == wxDefaultSize )
{
wxASSERT_MSG( flags == FALLBACK_SYSTEM,
wxS("Must have valid size if not using FALLBACK_SYSTEM") );
sizeX = sysX;
sizeY = sysY;
}
// Iterate over all icons searching for the exact match or the closest icon
// for FALLBACK_NEAREST_LARGER.
wxIcon iconBest;
int bestDiff = 0;
bool bestIsLarger = false;
bool bestIsSystem = false;
const size_t count = GetIconCount();
const wxIconArray& iconArray = M_ICONBUNDLEDATA->m_icons;
for ( size_t i = 0; i < count; i++ )
{
const wxIcon& icon = iconArray[i];
if ( !icon.IsOk() )
continue;
wxCoord sx = icon.GetWidth(),
sy = icon.GetHeight();
// Exact match ends search immediately in any case.
if ( sx == sizeX && sy == sizeY )
{
iconBest = icon;
break;
}
if ( flags & FALLBACK_SYSTEM )
{
if ( sx == sysX && sy == sysY )
{
iconBest = icon;
bestIsSystem = true;
continue;
}
}
if ( !bestIsSystem && (flags & FALLBACK_NEAREST_LARGER) )
{
bool iconLarger = (sx >= sizeX) && (sy >= sizeY);
int iconDiff = abs(sx - sizeX) + abs(sy - sizeY);
// Use current icon as candidate for the best icon, if either:
// - we have no candidate yet
// - we have no candidate larger than desired size and current icon is
// - current icon is closer to desired size than candidate
if ( !iconBest.IsOk() ||
(!bestIsLarger && iconLarger) ||
(iconLarger && (iconDiff < bestDiff)) )
{
iconBest = icon;
bestIsLarger = iconLarger;
bestDiff = iconDiff;
continue;
}
}
}
#if defined( __WXMAC__ ) && wxOSX_USE_CARBON
if (!iconBest.IsOk())
return wxNullIcon;
return wxIcon(iconBest.GetHICON(), size);
#else
return iconBest;
#endif
}
wxIcon wxIconBundle::GetIconOfExactSize(const wxSize& size) const
{
return GetIcon(size, FALLBACK_NONE);
}
void wxIconBundle::AddIcon(const wxIcon& icon)
{
wxCHECK_RET( icon.IsOk(), wxT("invalid icon") );
AllocExclusive();
wxIconArray& iconArray = M_ICONBUNDLEDATA->m_icons;
// replace existing icon with the same size if we already have it
const size_t count = iconArray.size();
for ( size_t i = 0; i < count; ++i )
{
wxIcon& tmp = iconArray[i];
if ( tmp.IsOk() &&
tmp.GetWidth() == icon.GetWidth() &&
tmp.GetHeight() == icon.GetHeight() )
{
tmp = icon;
return;
}
}
// if we don't, add an icon with new size
iconArray.Add(icon);
}
size_t wxIconBundle::GetIconCount() const
{
return IsOk() ? M_ICONBUNDLEDATA->m_icons.size() : 0;
}
wxIcon wxIconBundle::GetIconByIndex(size_t n) const
{
wxCHECK_MSG( n < GetIconCount(), wxNullIcon, wxT("invalid index") );
return M_ICONBUNDLEDATA->m_icons[n];
}