keep selected image in sync with the normal one if it hasn't been changed (patch...

[wxWidgets.git] / src / msw / gdiimage.cpp

diff --git a/src/msw/gdiimage.cpp b/src/msw/gdiimage.cpp
index d880396fdb7fb834d97010b6fab0dd2a6600bea6..1e7606bcbece9ba0b1cac7626429025c383743f4 100644 (file)
--- a/src/msw/gdiimage.cpp
+++ b/src/msw/gdiimage.cpp
@@ -6,7 +6,7 @@
 // Created:     20.11.99
 // RCS-ID:      $Id$
 // Copyright:   (c) 1999 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
 // Created:     20.11.99
 // RCS-ID:      $Id$
 // Copyright:   (c) 1999 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 ///////////////////////////////////////////////////////////////////////////////
 
 // ============================================================================
 ///////////////////////////////////////////////////////////////////////////////
 
 // ============================================================================


@@ -30,29 +30,26 @@
 
 #ifndef WX_PRECOMP
     #include "wx/string.h"
 
 #ifndef WX_PRECOMP
     #include "wx/string.h"

+    #include "wx/log.h"

 #endif // WX_PRECOMP
 
 #include "wx/msw/private.h"
 
 #include "wx/app.h"
 
 #endif // WX_PRECOMP
 
 #include "wx/msw/private.h"
 
 #include "wx/app.h"
 

-#include "wx/msw/dib.h"
-#include "wx/msw/bitmap.h"
-#include "wx/msw/gdiimage.h"

 #include "wx/bitmap.h"
 #include "wx/bitmap.h"

+#include "wx/msw/gdiimage.h"
+#include "wx/msw/dib.h"

 
 

-#if wxUSE_XPM_IN_MSW
-#   include "wx/xpmhand.h"
-#endif // wxUSE_XPM_IN_MSW
-
-#ifdef __WIN16__
-#   include "wx/msw/curico.h"
-#endif // __WIN16__
+#include "wx/listimpl.cpp"
+WX_DEFINE_LIST(wxGDIImageHandlerList);

 
 // ----------------------------------------------------------------------------
 // private classes
 // ----------------------------------------------------------------------------
 
 
 // ----------------------------------------------------------------------------
 // private classes
 // ----------------------------------------------------------------------------
 

+#ifndef __WXMICROWIN__
+

 // all image handlers are declared/defined in this file because the outside
 // world doesn't have to know about them (but only about wxBITMAP_TYPE_XXX ids)
 
 // all image handlers are declared/defined in this file because the outside
 // world doesn't have to know about them (but only about wxBITMAP_TYPE_XXX ids)
 


@@ -108,14 +105,14 @@ public:
                         int WXUNUSED(height),
                         int WXUNUSED(depth) = 1)
     {
                         int WXUNUSED(height),
                         int WXUNUSED(depth) = 1)
     {

-        return FALSE;
+        return false;

     }
 
     virtual bool Save(wxGDIImage *WXUNUSED(image),
                       const wxString& WXUNUSED(name),
                       int WXUNUSED(type))
     {
     }
 
     virtual bool Save(wxGDIImage *WXUNUSED(image),
                       const wxString& WXUNUSED(name),
                       int WXUNUSED(type))
     {

-        return FALSE;
+        return false;

     }
 
     virtual bool Load(wxGDIImage *image,
     }
 
     virtual bool Load(wxGDIImage *image,


@@ -124,7 +121,7 @@ public:
                       int desiredWidth, int desiredHeight)
     {
         wxIcon *icon = wxDynamicCast(image, wxIcon);
                       int desiredWidth, int desiredHeight)
     {
         wxIcon *icon = wxDynamicCast(image, wxIcon);

-        wxCHECK_MSG( icon, FALSE, _T("wxIconHandler only works with icons") );
+        wxCHECK_MSG( icon, false, _T("wxIconHandler only works with icons") );

 
         return LoadIcon(icon, name, flags, desiredWidth, desiredHeight);
     }
 
         return LoadIcon(icon, name, flags, desiredWidth, desiredHeight);
     }


@@ -173,22 +170,23 @@ private:
 // wxWin macros
 // ----------------------------------------------------------------------------
 
 // wxWin macros
 // ----------------------------------------------------------------------------
 

-    IMPLEMENT_DYNAMIC_CLASS(wxBMPFileHandler, wxBitmapHandler)
-    IMPLEMENT_DYNAMIC_CLASS(wxBMPResourceHandler, wxBitmapHandler)
-    IMPLEMENT_DYNAMIC_CLASS(wxICOFileHandler, wxGDIImageHandler)
-    IMPLEMENT_DYNAMIC_CLASS(wxICOResourceHandler, wxGDIImageHandler)
+IMPLEMENT_DYNAMIC_CLASS(wxBMPFileHandler, wxBitmapHandler)
+IMPLEMENT_DYNAMIC_CLASS(wxBMPResourceHandler, wxBitmapHandler)
+IMPLEMENT_DYNAMIC_CLASS(wxICOFileHandler, wxObject)
+IMPLEMENT_DYNAMIC_CLASS(wxICOResourceHandler, wxObject)

 
 // ----------------------------------------------------------------------------
 // private functions
 // ----------------------------------------------------------------------------
 
 
 // ----------------------------------------------------------------------------
 // private functions
 // ----------------------------------------------------------------------------
 

-static wxSize GetHiconSize(HICON hicon);
+#endif
+    // __MICROWIN__

 
 // ============================================================================
 // implementation
 // ============================================================================
 
 
 // ============================================================================
 // implementation
 // ============================================================================
 

-wxList wxGDIImage::ms_handlers;
+wxGDIImageHandlerList wxGDIImage::ms_handlers;

 
 // ----------------------------------------------------------------------------
 // wxGDIImage functions forwarded to wxGDIImageRefData
 
 // ----------------------------------------------------------------------------
 // wxGDIImage functions forwarded to wxGDIImageRefData


@@ -202,10 +200,10 @@ bool wxGDIImage::FreeResource(bool WXUNUSED(force))
         GetGDIImageData()->m_handle = 0;
     }
 
         GetGDIImageData()->m_handle = 0;
     }
 

-    return TRUE;
+    return true;

 }
 
 }
 

-WXHANDLE wxGDIImage::GetResourceHandle()
+WXHANDLE wxGDIImage::GetResourceHandle() const

 {
     return GetHandle();
 }
 {
     return GetHandle();
 }


@@ -230,21 +228,21 @@ bool wxGDIImage::RemoveHandler(const wxString& name)
     if ( handler )
     {
         ms_handlers.DeleteObject(handler);
     if ( handler )
     {
         ms_handlers.DeleteObject(handler);

-        return TRUE;
+        return true;

     }
     else
     }
     else

-        return FALSE;
+        return false;

 }
 
 wxGDIImageHandler *wxGDIImage::FindHandler(const wxString& name)
 {
 }
 
 wxGDIImageHandler *wxGDIImage::FindHandler(const wxString& name)
 {

-    wxNode *node = ms_handlers.First();
+    wxGDIImageHandlerList::Node *node = ms_handlers.GetFirst();

     while ( node )
     {
     while ( node )
     {

-        wxGDIImageHandler *handler = (wxGDIImageHandler *)node->Data();
+        wxGDIImageHandler *handler = node->GetData();

         if ( handler->GetName() == name )
             return handler;
         if ( handler->GetName() == name )
             return handler;

-        node = node->Next();
+        node = node->GetNext();

     }
 
     return NULL;
     }
 
     return NULL;


@@ -253,31 +251,31 @@ wxGDIImageHandler *wxGDIImage::FindHandler(const wxString& name)
 wxGDIImageHandler *wxGDIImage::FindHandler(const wxString& extension,
                                            long type)
 {
 wxGDIImageHandler *wxGDIImage::FindHandler(const wxString& extension,
                                            long type)
 {

-    wxNode *node = ms_handlers.First();
+    wxGDIImageHandlerList::Node *node = ms_handlers.GetFirst();

     while ( node )
     {
     while ( node )
     {

-        wxGDIImageHandler *handler = (wxGDIImageHandler *)node->Data();
+        wxGDIImageHandler *handler = node->GetData();

         if ( (handler->GetExtension() = extension) &&
              (type == -1 || handler->GetType() == type) )
         {
             return handler;
         }
 
         if ( (handler->GetExtension() = extension) &&
              (type == -1 || handler->GetType() == type) )
         {
             return handler;
         }
 

-        node = node->Next();
+        node = node->GetNext();

     }
     return NULL;
 }
 
 wxGDIImageHandler *wxGDIImage::FindHandler(long type)
 {
     }
     return NULL;
 }
 
 wxGDIImageHandler *wxGDIImage::FindHandler(long type)
 {

-    wxNode *node = ms_handlers.First();
+    wxGDIImageHandlerList::Node *node = ms_handlers.GetFirst();

     while ( node )
     {
     while ( node )
     {

-        wxGDIImageHandler *handler = (wxGDIImageHandler *)node->Data();
+        wxGDIImageHandler *handler = node->GetData();

         if ( handler->GetType() == type )
             return handler;
 
         if ( handler->GetType() == type )
             return handler;
 

-        node = node->Next();
+        node = node->GetNext();

     }
 
     return NULL;
     }
 
     return NULL;


@@ -285,11 +283,11 @@ wxGDIImageHandler *wxGDIImage::FindHandler(long type)
 
 void wxGDIImage::CleanUpHandlers()
 {
 
 void wxGDIImage::CleanUpHandlers()
 {

-    wxNode *node = ms_handlers.First();
+    wxGDIImageHandlerList::Node *node = ms_handlers.GetFirst();

     while ( node )
     {
     while ( node )
     {

-        wxGDIImageHandler *handler = (wxGDIImageHandler *)node->Data();
-        wxNode *next = node->Next();
+        wxGDIImageHandler *handler = node->GetData();
+        wxGDIImageHandlerList::Node *next = node->GetNext();

         delete handler;
         delete node;
         node = next;
         delete handler;
         delete node;
         node = next;


@@ -298,20 +296,16 @@ void wxGDIImage::CleanUpHandlers()
 
 void wxGDIImage::InitStandardHandlers()
 {
 
 void wxGDIImage::InitStandardHandlers()
 {

+#ifndef __WXMICROWIN__

     AddHandler(new wxBMPResourceHandler);
     AddHandler(new wxBMPFileHandler);
     AddHandler(new wxBMPResourceHandler);
     AddHandler(new wxBMPFileHandler);

-
-    // GRG: Add these handlers by default if XPM support is enabled
-
-#if wxUSE_XPM_IN_MSW
-    AddHandler(new wxXPMFileHandler);
-    AddHandler(new wxXPMDataHandler);
-#endif // wxUSE_XPM_IN_MSW
-

     AddHandler(new wxICOResourceHandler);
     AddHandler(new wxICOFileHandler);
     AddHandler(new wxICOResourceHandler);
     AddHandler(new wxICOFileHandler);

+#endif

 }
 
 }
 

+#ifndef __WXMICROWIN__
+

 // ----------------------------------------------------------------------------
 // wxBitmap handlers
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // wxBitmap handlers
 // ----------------------------------------------------------------------------


@@ -324,27 +318,26 @@ bool wxBMPResourceHandler::LoadFile(wxBitmap *bitmap,
     // TODO: load colourmap.
     bitmap->SetHBITMAP((WXHBITMAP)::LoadBitmap(wxGetInstance(), name));
 
     // TODO: load colourmap.
     bitmap->SetHBITMAP((WXHBITMAP)::LoadBitmap(wxGetInstance(), name));
 

-    wxBitmapRefData *data = bitmap->GetBitmapData();
-    if ( bitmap->Ok() )
-    {
-        BITMAP bm;
-        if ( !::GetObject(GetHbitmapOf(*bitmap), sizeof(BITMAP), (LPSTR) &bm) )
-        {
-            wxLogLastError(wxT("GetObject(HBITMAP)"));
-        }
-
-        data->m_width = bm.bmWidth;
-        data->m_height = bm.bmHeight;
-        data->m_depth = bm.bmBitsPixel;
-    }
-    else
+    if ( !bitmap->Ok() )

     {
         // it's probably not found
         wxLogError(wxT("Can't load bitmap '%s' from resources! Check .rc file."),
                    name.c_str());
     {
         // it's probably not found
         wxLogError(wxT("Can't load bitmap '%s' from resources! Check .rc file."),
                    name.c_str());

+
+        return false;

     }
 
     }
 

-    return bitmap->Ok();
+    BITMAP bm;
+    if ( !::GetObject(GetHbitmapOf(*bitmap), sizeof(BITMAP), (LPSTR) &bm) )
+    {
+        wxLogLastError(wxT("GetObject(HBITMAP)"));
+    }
+
+    bitmap->SetWidth(bm.bmWidth);
+    bitmap->SetHeight(bm.bmHeight);
+    bitmap->SetDepth(bm.bmBitsPixel);
+
+    return true;

 }
 
 bool wxBMPFileHandler::LoadFile(wxBitmap *bitmap,
 }
 
 bool wxBMPFileHandler::LoadFile(wxBitmap *bitmap,


@@ -352,36 +345,23 @@ bool wxBMPFileHandler::LoadFile(wxBitmap *bitmap,
                                 int WXUNUSED(desiredWidth),
                                 int WXUNUSED(desiredHeight))
 {
                                 int WXUNUSED(desiredWidth),
                                 int WXUNUSED(desiredHeight))
 {

-#if wxUSE_IMAGE_LOADING_IN_MSW
-    wxPalette *palette = NULL;
-    bool success = wxLoadIntoBitmap(WXSTRINGCAST name, bitmap, &palette) != 0;
-    if ( success && palette )
-    {
-        bitmap->SetPalette(*palette);
-    }
+    wxCHECK_MSG( bitmap, false, _T("NULL bitmap in LoadFile") );

 
 

-    // it was copied by the bitmap if it was loaded successfully
-    delete palette;
+    wxDIB dib(name);

 
 

-    return success;
-#else
-    return FALSE;
-#endif
+    return dib.IsOk() && bitmap->CopyFromDIB(dib);

 }
 
 bool wxBMPFileHandler::SaveFile(wxBitmap *bitmap,
                                 const wxString& name,
                                 int WXUNUSED(type),
 }
 
 bool wxBMPFileHandler::SaveFile(wxBitmap *bitmap,
                                 const wxString& name,
                                 int WXUNUSED(type),

-                                const wxPalette *pal)
+                                const wxPalette * WXUNUSED(pal))

 {
 {

-#if wxUSE_IMAGE_LOADING_IN_MSW
-    wxPalette *actualPalette = (wxPalette *)pal;
-    if ( !actualPalette )
-        actualPalette = bitmap->GetPalette();
-    return wxSaveBitmap(WXSTRINGCAST name, bitmap, actualPalette) != 0;
-#else
-    return FALSE;
-#endif
+    wxCHECK_MSG( bitmap, false, _T("NULL bitmap in SaveFile") );
+
+    wxDIB dib(*bitmap);
+
+    return dib.Save(name);

 }
 
 // ----------------------------------------------------------------------------
 }
 
 // ----------------------------------------------------------------------------


@@ -390,82 +370,170 @@ bool wxBMPFileHandler::SaveFile(wxBitmap *bitmap,
 
 bool wxICOFileHandler::LoadIcon(wxIcon *icon,
                                 const wxString& name,
 
 bool wxICOFileHandler::LoadIcon(wxIcon *icon,
                                 const wxString& name,

-                                long flags,
+                                long WXUNUSED(flags),

                                 int desiredWidth, int desiredHeight)
 {
                                 int desiredWidth, int desiredHeight)
 {

-#if wxUSE_RESOURCE_LOADING_IN_MSW

     icon->UnRef();
 
     // actual size
     wxSize size;
 
     icon->UnRef();
 
     // actual size
     wxSize size;
 

-#ifdef __WIN32__
-    HICON hicon = ::ExtractIcon(wxGetInstance(), name, 0 /* first */);
+    HICON hicon = NULL;
+
+    // Parse the filename: it may be of the form "filename;n" in order to
+    // specify the nth icon in the file.
+    //
+    // For the moment, ignore the issue of possible semicolons in the
+    // filename.
+    int iconIndex = 0;
+    wxString nameReal(name);
+    wxString strIconIndex = name.AfterLast(wxT(';'));
+    if (strIconIndex != name)
+    {
+        iconIndex = wxAtoi(strIconIndex);
+        nameReal = name.BeforeLast(wxT(';'));
+    }
+
+#if 0
+    // If we don't know what size icon we're looking for,
+    // try to find out what's there.
+    // Unfortunately this doesn't work, because ExtractIconEx
+    // will scale the icon to the 'desired' size, even if that
+    // size of icon isn't explicitly stored. So we would have
+    // to parse the icon file outselves.
+    if ( desiredWidth == -1 &&
+         desiredHeight == -1)
+    {
+        // Try loading a large icon first
+        if ( ::ExtractIconEx(nameReal, iconIndex, &hicon, NULL, 1) == 1)
+        {
+        }
+        // Then try loading a small icon
+        else if ( ::ExtractIconEx(nameReal, iconIndex, NULL, &hicon, 1) == 1)
+        {
+        }
+    }
+    else
+#endif
+    // were we asked for a large icon?
+    if ( desiredWidth == ::GetSystemMetrics(SM_CXICON) &&
+         desiredHeight == ::GetSystemMetrics(SM_CYICON) )
+    {
+        // get the specified large icon from file
+        if ( !::ExtractIconEx(nameReal, iconIndex, &hicon, NULL, 1) )
+        {
+            // it is not an error, but it might still be useful to be informed
+            // about it optionally
+            wxLogTrace(_T("iconload"),
+                       _T("No large icons found in the file '%s'."),
+                       name.c_str());
+        }
+    }
+    else if ( desiredWidth == ::GetSystemMetrics(SM_CXSMICON) &&
+              desiredHeight == ::GetSystemMetrics(SM_CYSMICON) )
+    {
+        // get the specified small icon from file
+        if ( !::ExtractIconEx(nameReal, iconIndex, NULL, &hicon, 1) )
+        {
+            wxLogTrace(_T("iconload"),
+                       _T("No small icons found in the file '%s'."),
+                       name.c_str());
+        }
+    }
+    //else: not standard size, load below
+
+    if ( !hicon )
+    {
+        // take any size icon from the file by index
+        hicon = ::ExtractIcon(wxGetInstance(), nameReal, iconIndex);
+    }
+

     if ( !hicon )
     {
         wxLogSysError(_T("Failed to load icon from the file '%s'"),
                       name.c_str());
 
     if ( !hicon )
     {
         wxLogSysError(_T("Failed to load icon from the file '%s'"),
                       name.c_str());
 

-        return FALSE;
+        return false;

     }
 
     }
 

-    size = GetHiconSize(hicon);
-#else // Win16
-    HICON hicon = ReadIconFile((wxChar *)name.c_str(),
-                               wxGetInstance(),
-                               &size.x, &size.y);
-#endif // Win32/Win16
+    size = wxGetHiconSize(hicon);

 
     if ( (desiredWidth != -1 && desiredWidth != size.x) ||
          (desiredHeight != -1 && desiredHeight != size.y) )
     {
 
     if ( (desiredWidth != -1 && desiredWidth != size.x) ||
          (desiredHeight != -1 && desiredHeight != size.y) )
     {

-        wxLogDebug(_T("Returning FALSE from wxICOFileHandler::Load because of the size mismatch: actual (%d, %d), requested (%d, %d)"),
-                      size.x, size.y,
-                      desiredWidth, desiredHeight);
+        wxLogTrace(_T("iconload"),
+                   _T("Returning false from wxICOFileHandler::Load because of the size mismatch: actual (%d, %d), requested (%d, %d)"),
+                   size.x, size.y,
+                   desiredWidth, desiredHeight);

 
         ::DestroyIcon(hicon);
 
 
         ::DestroyIcon(hicon);
 

-        return FALSE;
+        return false;

     }
 
     icon->SetHICON((WXHICON)hicon);
     icon->SetSize(size.x, size.y);
 
     return icon->Ok();
     }
 
     icon->SetHICON((WXHICON)hicon);
     icon->SetSize(size.x, size.y);
 
     return icon->Ok();

-#else
-    return FALSE;
-#endif

 }
 
 bool wxICOResourceHandler::LoadIcon(wxIcon *icon,
                                     const wxString& name,
 }
 
 bool wxICOResourceHandler::LoadIcon(wxIcon *icon,
                                     const wxString& name,

-                                    long flags,
+                                    long WXUNUSED(flags),

                                     int desiredWidth, int desiredHeight)
 {
     HICON hicon;
 
                                     int desiredWidth, int desiredHeight)
 {
     HICON hicon;
 

-#if defined(__WIN32__) && !defined(__SC__)
-    if ( desiredWidth != -1 && desiredHeight != -1 )
+    // do we need the icon of the specific size or would any icon do?
+    bool hasSize = desiredWidth != -1 || desiredHeight != -1;
+
+    wxASSERT_MSG( !hasSize || (desiredWidth != -1 && desiredHeight != -1),
+                  _T("width and height should be either both -1 or not") );
+
+    // try to load the icon from this program first to allow overriding the
+    // standard icons (although why one would want to do it considering that
+    // we already have wxApp::GetStdIcon() is unclear)
+
+    // note that we can't just always call LoadImage() because it seems to do
+    // some icon rescaling internally which results in very ugly 16x16 icons
+    if ( hasSize )

     {
         hicon = (HICON)::LoadImage(wxGetInstance(), name, IMAGE_ICON,
                                     desiredWidth, desiredHeight,
                                     LR_DEFAULTCOLOR);
     }
     else
     {
         hicon = (HICON)::LoadImage(wxGetInstance(), name, IMAGE_ICON,
                                     desiredWidth, desiredHeight,
                                     LR_DEFAULTCOLOR);
     }
     else

-#endif // Win32

     {
         hicon = ::LoadIcon(wxGetInstance(), name);
     }
 
     {
         hicon = ::LoadIcon(wxGetInstance(), name);
     }
 

-    wxSize size = GetHiconSize(hicon);
-    icon->SetSize(size.x, size.y);
-
-    // Override the found values with desired values
-    if ( desiredWidth > -1 && desiredHeight > -1 )
+    // next check if it's not a standard icon
+    if ( !hicon && !hasSize )

     {
     {

-        icon->SetSize(desiredWidth, desiredHeight);
+        static const struct
+        {
+            const wxChar *name;
+            LPTSTR id;
+        } stdIcons[] =
+        {
+            { wxT("wxICON_QUESTION"),   IDI_QUESTION    },
+            { wxT("wxICON_WARNING"),    IDI_EXCLAMATION },
+            { wxT("wxICON_ERROR"),      IDI_HAND        },
+            { wxT("wxICON_INFORMATION"),       IDI_ASTERISK    },
+        };
+
+        for ( size_t nIcon = 0; !hicon && nIcon < WXSIZEOF(stdIcons); nIcon++ )
+        {
+            if ( name == stdIcons[nIcon].name )
+            {
+                hicon = ::LoadIcon((HINSTANCE)NULL, stdIcons[nIcon].id);
+            }
+        }

     }
 
     }
 

+    wxSize size = wxGetHiconSize(hicon);
+    icon->SetSize(size.x, size.y);
+

     icon->SetHICON((WXHICON)hicon);
 
     return icon->Ok();
     icon->SetHICON((WXHICON)hicon);
 
     return icon->Ok();


@@ -475,12 +543,10 @@ bool wxICOResourceHandler::LoadIcon(wxIcon *icon,
 // private functions
 // ----------------------------------------------------------------------------
 
 // private functions
 // ----------------------------------------------------------------------------
 

-static wxSize GetHiconSize(HICON hicon)
+wxSize wxGetHiconSize(HICON hicon)

 {
     wxSize size(32, 32);    // default
 
 {
     wxSize size(32, 32);    // default
 

-#ifdef __WIN32__
-    // Win32s doesn't have GetIconInfo function...

     if ( hicon && wxGetOsVersion() != wxWIN32S )
     {
         ICONINFO info;
     if ( hicon && wxGetOsVersion() != wxWIN32S )
     {
         ICONINFO info;


@@ -505,7 +571,9 @@ static wxSize GetHiconSize(HICON hicon)
                 ::DeleteObject(info.hbmColor);
         }
     }
                 ::DeleteObject(info.hbmColor);
         }
     }

-#endif

 
     return size;
 }
 
     return size;
 }

+
+#endif // __WXMICROWIN__
+