Several corrections to wxDocManager fields documentation.

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

diff --git a/src/msw/statbmp.cpp b/src/msw/statbmp.cpp
index ab210117e5f0638e6b68ddb9847fbeb3c14202f7..31c46938b82515edb8dfd91211fc101a5b77dd3b 100644 (file)
--- a/src/msw/statbmp.cpp
+++ b/src/msw/statbmp.cpp
@@ -1,12 +1,12 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        statbmp.cpp
+// Name:        src/msw/statbmp.cpp

 // Purpose:     wxStaticBitmap
 // Author:      Julian Smart
 // Modified by:
 // Created:     04/01/98
 // RCS-ID:      $Id$
 // Purpose:     wxStaticBitmap
 // Author:      Julian Smart
 // Modified by:
 // Created:     04/01/98
 // RCS-ID:      $Id$

-// Copyright:   (c) Julian Smart and Markus Holzem
-// Licence:     wxWindows license
+// Copyright:   (c) Julian Smart
+// Licence:     wxWindows licence

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


@@ -17,10 +17,6 @@
 // headers
 // ---------------------------------------------------------------------------
 
 // headers
 // ---------------------------------------------------------------------------
 

-#ifdef __GNUG__
-    #pragma implementation "statbmp.h"
-#endif
-

 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 


@@ -28,24 +24,27 @@
     #pragma hdrstop
 #endif
 
     #pragma hdrstop
 #endif
 

-#include "wx/window.h"
-#include "wx/msw/private.h"
+#if wxUSE_STATBMP
+
+#include "wx/statbmp.h"

 
 #ifndef WX_PRECOMP
 
 #ifndef WX_PRECOMP

+    #include "wx/app.h"
+    #include "wx/window.h"

     #include "wx/icon.h"
     #include "wx/icon.h"

-    #include "wx/statbmp.h"
+    #include "wx/dcclient.h"

 #endif
 
 #endif
 

+#include "wx/msw/private.h"
+
+#include "wx/sysopt.h"
+

 #include <stdio.h>
 
 // ---------------------------------------------------------------------------
 // macors
 // ---------------------------------------------------------------------------
 
 #include <stdio.h>
 
 // ---------------------------------------------------------------------------
 // macors
 // ---------------------------------------------------------------------------
 

-#if !USE_SHARED_LIBRARY
-    IMPLEMENT_DYNAMIC_CLASS(wxStaticBitmap, wxControl)
-#endif
-

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


@@ -54,108 +53,195 @@
 // wxStaticBitmap
 // ---------------------------------------------------------------------------
 
 // wxStaticBitmap
 // ---------------------------------------------------------------------------
 

-bool wxStaticBitmap::Create(wxWindow *parent, wxWindowID id,
-                            const wxBitmap& bitmap,
-                            const wxPoint& pos,
-                            const wxSize& size,
-                            long style,
-                            const wxString& name)
+// we may have either bitmap or icon: if a bitmap with mask is passed, we
+// will transform it to an icon ourselves because otherwise the mask will
+// be ignored by Windows
+// note that this function will create a new object every time
+// it is called even if the image needs no conversion
+
+static wxGDIImage* ConvertImage( const wxGDIImage& bitmap )

 {
 {

-    Init();
+    bool isIcon = bitmap.IsKindOf( CLASSINFO(wxIcon) );
+
+    if( !isIcon )
+    {
+        wxASSERT_MSG( wxDynamicCast(&bitmap, wxBitmap),
+                      wxT("not an icon and not a bitmap?") );

 
 

-    SetName(name);
-    if (parent)
-        parent->AddChild(this);
+        const wxBitmap& bmp = (const wxBitmap&)bitmap;
+        wxMask *mask = bmp.GetMask();
+        if ( mask && mask->GetMaskBitmap() )
+        {
+            wxIcon* icon = new wxIcon;
+            icon->CopyFromBitmap(bmp);

 
 

-    m_backgroundColour = parent->GetBackgroundColour() ;
-    m_foregroundColour = parent->GetForegroundColour() ;
+            return icon;
+        }

 
 

-    if ( id == -1 )
-        m_windowId = (int)NewControlId();
-    else
-        m_windowId = id;
+        return new wxBitmap( bmp );
+    }

 
 

-    int x = pos.x;
-    int y = pos.y;
-    int width = size.x;
-    int height = size.y;
+    // copying a bitmap is a cheap operation
+    return new wxIcon( (const wxIcon&)bitmap );
+}

 
 

-    m_windowStyle = style;
+bool wxStaticBitmap::Create(wxWindow *parent,
+                            wxWindowID id,
+                            const wxGDIImage& bitmap,
+                            const wxPoint& pos,
+                            const wxSize& size,
+                            long style,
+                            const wxString& name)
+{
+    if ( !CreateControl(parent, id, pos, size, style, wxDefaultValidator, name) )
+        return false;

 
 

+    // we may have either bitmap or icon: if a bitmap with mask is passed, we
+    // will transform it to an icon ourselves because otherwise the mask will
+    // be ignored by Windows

     m_isIcon = bitmap.IsKindOf(CLASSINFO(wxIcon));
 
     m_isIcon = bitmap.IsKindOf(CLASSINFO(wxIcon));
 

-#ifdef __WIN32__
-    // create a static control with either SS_BITMAP or SS_ICON style depending
-    // on what we have here
-    const wxChar *classname = wxT("STATIC");
-    int winstyle = m_isIcon ? SS_ICON : SS_BITMAP;
-#else // Win16
-    const wxChar *classname = wxT("BUTTON");
-    int winstyle = BS_OWNERDRAW;
-#endif // Win32
+    wxGDIImage *image = ConvertImage( bitmap );
+    m_isIcon = image->IsKindOf( CLASSINFO(wxIcon) );

 
 

-    m_hWnd = (WXHWND)::CreateWindow
-                       (
-                        classname,
-                        wxT(""),
-                        winstyle | WS_CHILD | WS_VISIBLE,
-                        0, 0, 0, 0,
-                        (HWND)parent->GetHWND(),
-                        (HMENU)m_windowId,
-                        wxGetInstance(),
-                        NULL
-                       );
+    // create the native control
+    if ( !MSWCreateControl(wxT("STATIC"), wxEmptyString, pos, size) )
+    {
+        // control creation failed
+        return false;
+    }

 
 

-    wxCHECK_MSG( m_hWnd, FALSE, wxT("Failed to create static bitmap") );
+    // no need to delete the new image
+    SetImageNoCopy(image);
+
+    // GetBestSize will work properly now, so set the best size if needed
+    SetInitialSize(size);
+
+    // painting manually is reported not to work under Windows CE (see #10093),
+    // so don't do it there even if this probably means that alpha is not
+    // supported there -- but at least bitmaps without alpha appear correctly
+#ifndef __WXWINCE__
+    // Windows versions before XP (and even XP if the application has no
+    // manifest and so the old comctl32.dll is used) don't draw correctly the
+    // images with alpha channel so we need to draw them ourselves and it's
+    // easier to just always do it rather than check if we have an image with
+    // alpha or not
+    if ( wxTheApp->GetComCtl32Version() < 600 )
+    {
+        Connect(wxEVT_PAINT, wxPaintEventHandler(wxStaticBitmap::DoPaintManually));
+    }
+#endif // !__WXWINCE__

 
 

-    SetBitmap(bitmap);
+    return true;
+}

 
 

-    // Subclass again for purposes of dialog editing mode
-    SubclassWin(m_hWnd);
+WXDWORD wxStaticBitmap::MSWGetStyle(long style, WXDWORD *exstyle) const
+{
+    WXDWORD msStyle = wxControl::MSWGetStyle(style, exstyle);

 
 

-    SetFont(GetParent()->GetFont());
+    // what kind of control are we?
+    msStyle |= m_isIcon ? SS_ICON : SS_BITMAP;

 
 

-    SetSize(x, y, width, height);
+    // we use SS_CENTERIMAGE to prevent the control from resizing the bitmap to
+    // fit to its size -- this is unexpected and doesn't happen in other ports
+    //
+    // and SS_NOTIFY is necessary to receive mouse events
+    msStyle |= SS_CENTERIMAGE | SS_NOTIFY;

 
 

-    return TRUE;
+    return msStyle;

 }
 
 bool wxStaticBitmap::ImageIsOk() const
 {
 }
 
 bool wxStaticBitmap::ImageIsOk() const
 {

-    if ( m_isIcon && m_image.icon )
-        return m_image.icon->Ok();
-    else if ( m_image.bitmap )
-        return m_image.bitmap->Ok();
-    else
-        return FALSE;
+    return m_image && m_image->IsOk();

 }
 
 }
 

-void wxStaticBitmap::Free()
+wxIcon wxStaticBitmap::GetIcon() const
+{
+    wxCHECK_MSG( m_image, wxIcon(), wxT("no image in wxStaticBitmap") );
+
+    // we can't ask for an icon if all we have is a bitmap
+    wxCHECK_MSG( m_isIcon, wxIcon(), wxT("no icon in this wxStaticBitmap") );
+
+    return *(wxIcon *)m_image;
+}
+
+wxBitmap wxStaticBitmap::GetBitmap() const

 {
     if ( m_isIcon )
 {
     if ( m_isIcon )

-        delete m_image.icon;
-    else
-        delete m_image.bitmap;
+    {
+        // don't fail because we might have replaced the bitmap with icon
+        // ourselves internally in ConvertImage() to keep the transparency but
+        // the user code doesn't know about it so it still can use GetBitmap()
+        // to retrieve the bitmap
+        return wxBitmap(GetIcon());
+    }
+    else // we have a bitmap
+    {
+        wxCHECK_MSG( m_image, wxBitmap(), wxT("no image in wxStaticBitmap") );
+
+        return *(wxBitmap *)m_image;
+    }
+}

 
 

-    m_image.icon = NULL;
+void wxStaticBitmap::Free()
+{
+    wxDELETE(m_image);

 }
 
 wxSize wxStaticBitmap::DoGetBestSize() const
 {
 }
 
 wxSize wxStaticBitmap::DoGetBestSize() const
 {

-    // reuse the current size (as wxWindow does) instead of using some
-    // arbitrary default size (as wxControl, our immediate base class, does)
-    return wxWindow::DoGetBestSize();
+    if ( ImageIsOk() )
+    {
+        wxSize best(m_image->GetWidth(), m_image->GetHeight());
+        CacheBestSize(best);
+        return best;
+    }
+
+    // this is completely arbitrary
+    return wxSize(16, 16);
+}
+
+#ifndef __WXWINCE__
+
+void wxStaticBitmap::DoPaintManually(wxPaintEvent& WXUNUSED(event))
+{
+    wxPaintDC dc(this);
+
+    const wxSize size(GetSize());
+    const wxBitmap bmp(GetBitmap());
+
+    // Clear the background: notice that we're supposed to be transparent, so
+    // use the parent background colour if we don't have our own instead of
+    // falling back to the default
+    const wxWindow *win = UseBgCol() ? this : GetParent();
+    dc.SetBrush(win->GetBackgroundColour());
+    dc.SetPen(*wxTRANSPARENT_PEN);
+    dc.DrawRectangle(0, 0, size.GetWidth(), size.GetHeight());
+
+    // Draw the image in the middle
+    dc.DrawBitmap(bmp,
+                  (size.GetWidth() - bmp.GetWidth()) / 2,
+                  (size.GetHeight() - bmp.GetHeight()) / 2,
+                  true /* use mask */);

 }
 
 }
 

-void wxStaticBitmap::SetBitmap(const wxBitmap& bitmap)
+#endif // !__WXWINCE__
+
+void wxStaticBitmap::SetImage( const wxGDIImage* image )
+{
+    wxGDIImage* convertedImage = ConvertImage( *image );
+    SetImageNoCopy( convertedImage );
+    InvalidateBestSize();
+}
+
+void wxStaticBitmap::SetImageNoCopy( wxGDIImage* image)

 {
     Free();
 
 {
     Free();
 

-    m_isIcon = bitmap.IsKindOf(CLASSINFO(wxIcon));
-    if ( m_isIcon )
-        m_image.icon = new wxIcon((const wxIcon&)bitmap);
-    else
-        m_image.bitmap = new wxBitmap(bitmap);
+    m_isIcon = image->IsKindOf( CLASSINFO(wxIcon) );
+    // the image has already been copied
+    m_image = image;

 
     int x, y;
     int w, h;
 
     int x, y;
     int w, h;


@@ -163,78 +249,41 @@ void wxStaticBitmap::SetBitmap(const wxBitmap& bitmap)
     GetSize(&w, &h);
 
 #ifdef __WIN32__
     GetSize(&w, &h);
 
 #ifdef __WIN32__

-    HANDLE handle = m_isIcon ? (HANDLE)m_image.icon->GetHICON()
-                             : (HANDLE)m_image.bitmap->GetHBITMAP();
-    ::SendMessage((HWND)m_hWnd, STM_SETIMAGE,
+    HANDLE handle = (HANDLE)m_image->GetHandle();
+    LONG style = ::GetWindowLong( (HWND)GetHWND(), GWL_STYLE ) ;
+    ::SetWindowLong( (HWND)GetHWND(), GWL_STYLE, ( style & ~( SS_BITMAP|SS_ICON ) ) |
+                     ( m_isIcon ? SS_ICON : SS_BITMAP ) );
+    HGDIOBJ oldHandle = (HGDIOBJ)::SendMessage(GetHwnd(), STM_SETIMAGE,

                   m_isIcon ? IMAGE_ICON : IMAGE_BITMAP, (LPARAM)handle);
                   m_isIcon ? IMAGE_ICON : IMAGE_BITMAP, (LPARAM)handle);

+    // detect if this is still the handle we passed before or
+    // if the static-control made a copy of the bitmap!
+    if (m_currentHandle != 0 && oldHandle != (HGDIOBJ) m_currentHandle)
+    {
+        // the static control made a copy and we are responsible for deleting it
+        DeleteObject((HGDIOBJ) oldHandle);
+    }
+    m_currentHandle = (WXHANDLE)handle;

 #endif // Win32
 
     if ( ImageIsOk() )
     {
 #endif // Win32
 
     if ( ImageIsOk() )
     {

-        int width = bitmap.GetWidth(),
-            height = bitmap.GetHeight();
+        int width = image->GetWidth(),
+            height = image->GetHeight();

         if ( width && height )
         {
             w = width;
             h = height;
 
         if ( width && height )
         {
             w = width;
             h = height;
 

-            ::MoveWindow((HWND)GetHWND(), x, y, width, height, FALSE);
+            ::MoveWindow(GetHwnd(), x, y, width, height, FALSE);

         }
     }
 
         }
     }
 

-    RECT rect ;
-    rect.left   = x ;
-    rect.top    = y ;
-    rect.right  = x + w ;
-    rect.bottom = y + h ;
-    InvalidateRect((HWND)GetParent()->GetHWND(), &rect, TRUE);
+    RECT rect;
+    rect.left   = x;
+    rect.top    = y;
+    rect.right  = x + w;
+    rect.bottom = y + h;
+    ::InvalidateRect(GetHwndOf(GetParent()), &rect, TRUE);

 }
 
 }
 

-// under Win32 we use the standard static control style for this
-#ifdef __WIN16__
-bool wxStaticBitmap::MSWOnDraw(WXDRAWITEMSTRUCT *item)
-{
-    LPDRAWITEMSTRUCT lpDIS = (LPDRAWITEMSTRUCT) item;
-
-    wxBitmap* bitmap = m_image.bitmap;
-    if ( !bitmap->Ok() )
-        return FALSE;
-
-    HDC hDC = lpDIS->hDC;
-    HDC memDC = ::CreateCompatibleDC(hDC);
-
-    HBITMAP old = (HBITMAP) ::SelectObject(memDC, (HBITMAP) bitmap->GetHBITMAP());
-
-    if (!old)
-        return FALSE;
-
-    int x = lpDIS->rcItem.left;
-    int y = lpDIS->rcItem.top;
-    int width = lpDIS->rcItem.right - x;
-    int height = lpDIS->rcItem.bottom - y;
-
-    // Centre the bitmap in the control area
-    int x1 = (int) (x + ((width - bitmap->GetWidth()) / 2));
-    int y1 = (int) (y + ((height - bitmap->GetHeight()) / 2));
-
-    ::BitBlt(hDC, x1, y1, bitmap->GetWidth(), bitmap->GetHeight(), memDC, 0, 0, SRCCOPY);
-
-    ::SelectObject(memDC, old);
-
-    ::DeleteDC(memDC);
-
-    return TRUE;
-}
-
-long wxStaticBitmap::MSWWindowProc(WXUINT nMsg,
-                                   WXWPARAM wParam,
-                                   WXLPARAM lParam)
-{
-    // Ensure that static items get messages. Some controls don't like this
-    // message to be intercepted (e.g. RichEdit), hence the tests.
-    if ( nMsg == WM_NCHITTEST )
-        return (long)HTCLIENT;
-
-    return wxWindow::MSWWindowProc(nMsg, wParam, lParam);
-}
-#endif // Win16
+#endif // wxUSE_STATBMP