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 8f02359753444e3bb6a0accd8056d07ac6fcd5f7..31c46938b82515edb8dfd91211fc101a5b77dd3b 100644 (file)
--- a/src/msw/statbmp.cpp
+++ b/src/msw/statbmp.cpp
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

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

 // Purpose:     wxStaticBitmap
 // Author:      Julian Smart
 // Modified by:
 // Purpose:     wxStaticBitmap
 // Author:      Julian Smart
 // Modified by:


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

-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-    #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"
 


@@ -30,73 +26,25 @@
 
 #if wxUSE_STATBMP
 
 
 #if wxUSE_STATBMP
 

-#include "wx/window.h"
-#include "wx/msw/private.h"
+#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 wxUSE_EXTENDED_RTTI
-WX_DEFINE_FLAGS( wxStaticBitmapStyle )
-
-WX_BEGIN_FLAGS( wxStaticBitmapStyle )
-    // new style border flags, we put them first to
-    // use them for streaming out
-    WX_FLAGS_MEMBER(wxBORDER_SIMPLE)
-    WX_FLAGS_MEMBER(wxBORDER_SUNKEN)
-    WX_FLAGS_MEMBER(wxBORDER_DOUBLE)
-    WX_FLAGS_MEMBER(wxBORDER_RAISED)
-    WX_FLAGS_MEMBER(wxBORDER_STATIC)
-    WX_FLAGS_MEMBER(wxBORDER_NONE)
-    
-    // old style border flags
-    WX_FLAGS_MEMBER(wxSIMPLE_BORDER)
-    WX_FLAGS_MEMBER(wxSUNKEN_BORDER)
-    WX_FLAGS_MEMBER(wxDOUBLE_BORDER)
-    WX_FLAGS_MEMBER(wxRAISED_BORDER)
-    WX_FLAGS_MEMBER(wxSTATIC_BORDER)
-    WX_FLAGS_MEMBER(wxNO_BORDER)
-
-    // standard window styles
-    WX_FLAGS_MEMBER(wxTAB_TRAVERSAL)
-    WX_FLAGS_MEMBER(wxCLIP_CHILDREN)
-    WX_FLAGS_MEMBER(wxTRANSPARENT_WINDOW)
-    WX_FLAGS_MEMBER(wxWANTS_CHARS)
-    WX_FLAGS_MEMBER(wxNO_FULL_REPAINT_ON_RESIZE)
-    WX_FLAGS_MEMBER(wxALWAYS_SHOW_SB )
-    WX_FLAGS_MEMBER(wxVSCROLL)
-    WX_FLAGS_MEMBER(wxHSCROLL)
-
-WX_END_FLAGS( wxStaticBitmapStyle )
-
-IMPLEMENT_DYNAMIC_CLASS_XTI(wxStaticBitmap, wxControl,"wx/statbmp.h")
-
-WX_BEGIN_PROPERTIES_TABLE(wxStaticBitmap)
-    WX_PROPERTY_FLAGS( WindowStyle , wxStaticBitmapStyle , long , SetWindowStyleFlag , GetWindowStyleFlag , , 0 /*flags*/ , wxT("Helpstring") , wxT("group")) // style
-WX_END_PROPERTIES_TABLE()
-
-WX_BEGIN_HANDLERS_TABLE(wxStaticBitmap)
-WX_END_HANDLERS_TABLE()
-
-WX_CONSTRUCTOR_5( wxStaticBitmap, wxWindow* , Parent , wxWindowID , Id , wxBitmap, Bitmap, wxPoint , Position , wxSize , Size )
-
-#else
-IMPLEMENT_DYNAMIC_CLASS(wxStaticBitmap, wxControl)
-#endif
-
-/*
-       TODO PROPERTIES :
-               bitmap
-*/
-

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


@@ -111,8 +59,6 @@ IMPLEMENT_DYNAMIC_CLASS(wxStaticBitmap, wxControl)
 // note that this function will create a new object every time
 // it is called even if the image needs no conversion
 
 // note that this function will create a new object every time
 // it is called even if the image needs no conversion
 

-#ifndef __WIN16__
-

 static wxGDIImage* ConvertImage( const wxGDIImage& bitmap )
 {
     bool isIcon = bitmap.IsKindOf( CLASSINFO(wxIcon) );
 static wxGDIImage* ConvertImage( const wxGDIImage& bitmap )
 {
     bool isIcon = bitmap.IsKindOf( CLASSINFO(wxIcon) );


@@ -120,7 +66,7 @@ static wxGDIImage* ConvertImage( const wxGDIImage& bitmap )
     if( !isIcon )
     {
         wxASSERT_MSG( wxDynamicCast(&bitmap, wxBitmap),
     if( !isIcon )
     {
         wxASSERT_MSG( wxDynamicCast(&bitmap, wxBitmap),

-                      _T("not an icon and not a bitmap?") );
+                      wxT("not an icon and not a bitmap?") );

 
         const wxBitmap& bmp = (const wxBitmap&)bitmap;
         wxMask *mask = bmp.GetMask();
 
         const wxBitmap& bmp = (const wxBitmap&)bitmap;
         wxMask *mask = bmp.GetMask();


@@ -139,8 +85,6 @@ static wxGDIImage* ConvertImage( const wxGDIImage& bitmap )
     return new wxIcon( (const wxIcon&)bitmap );
 }
 
     return new wxIcon( (const wxIcon&)bitmap );
 }
 

-#endif
-

 bool wxStaticBitmap::Create(wxWindow *parent,
                             wxWindowID id,
                             const wxGDIImage& bitmap,
 bool wxStaticBitmap::Create(wxWindow *parent,
                             wxWindowID id,
                             const wxGDIImage& bitmap,


@@ -150,87 +94,145 @@ bool wxStaticBitmap::Create(wxWindow *parent,
                             const wxString& name)
 {
     if ( !CreateControl(parent, id, pos, size, style, wxDefaultValidator, name) )
                             const wxString& name)
 {
     if ( !CreateControl(parent, id, pos, size, style, wxDefaultValidator, name) )

-        return FALSE;
+        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
 
     // 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

-    wxGDIImage *image = (wxGDIImage *)NULL;

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

-#ifdef __WIN16__
-    wxASSERT_MSG( !m_isIcon, "Icons are not supported in wxStaticBitmap under WIN16." );
-    image = &bitmap;
-#else // Win32
-    image = ConvertImage( bitmap );
+    wxGDIImage *image = ConvertImage( bitmap );

     m_isIcon = image->IsKindOf( CLASSINFO(wxIcon) );
     m_isIcon = image->IsKindOf( CLASSINFO(wxIcon) );

-#endif // Win16/32

 
     // create the native control
 
     // create the native control

-    if ( !MSWCreateControl(
-#ifdef __WIN32__
-                           _T("STATIC"),
-#else // Win16
-                           _T("BUTTON"),
-#endif // Win32/16
-                           wxEmptyString, pos, size) )
+    if ( !MSWCreateControl(wxT("STATIC"), wxEmptyString, pos, size) )

     {
         // control creation failed
     {
         // control creation failed

-        return FALSE;
+        return false;

     }
 
     // no need to delete the new image
     SetImageNoCopy(image);
 
     }
 
     // no need to delete the new image
     SetImageNoCopy(image);
 

-    return TRUE;
-}
+    // GetBestSize will work properly now, so set the best size if needed
+    SetInitialSize(size);

 
 

-wxBorder wxStaticBitmap::GetDefaultBorder() const
-{
-    return wxBORDER_NONE;
+    // 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__
+
+    return true;

 }
 
 WXDWORD wxStaticBitmap::MSWGetStyle(long style, WXDWORD *exstyle) const
 {
     WXDWORD msStyle = wxControl::MSWGetStyle(style, exstyle);
 
 }
 
 WXDWORD wxStaticBitmap::MSWGetStyle(long style, WXDWORD *exstyle) const
 {
     WXDWORD msStyle = wxControl::MSWGetStyle(style, exstyle);
 

-#ifdef __WIN32__

     // what kind of control are we?
     msStyle |= m_isIcon ? SS_ICON : SS_BITMAP;
 
     // 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
     // what kind of control are we?
     msStyle |= m_isIcon ? SS_ICON : SS_BITMAP;
 
     // 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

-    msStyle |= SS_CENTERIMAGE;
-#else // Win16
-    msStyle |= BS_OWNERDRAW;
-#endif // Win32/16
+    //
+    // and SS_NOTIFY is necessary to receive mouse events
+    msStyle |= SS_CENTERIMAGE | SS_NOTIFY;

 
     return msStyle;
 }
 
 bool wxStaticBitmap::ImageIsOk() const
 {
 
     return msStyle;
 }
 
 bool wxStaticBitmap::ImageIsOk() const
 {

-    return m_image && m_image->Ok();
+    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

 {
 {

-    delete m_image;
+    if ( m_isIcon )
+    {
+        // 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") );

 
 

-    m_image = NULL;
+        return *(wxBitmap *)m_image;
+    }
+}
+
+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 */);
+}
+
+#endif // !__WXWINCE__
+

 void wxStaticBitmap::SetImage( const wxGDIImage* image )
 {
     wxGDIImage* convertedImage = ConvertImage( *image );
     SetImageNoCopy( convertedImage );
 void wxStaticBitmap::SetImage( const wxGDIImage* image )
 {
     wxGDIImage* convertedImage = ConvertImage( *image );
     SetImageNoCopy( convertedImage );

+    InvalidateBestSize();

 }
 
 void wxStaticBitmap::SetImageNoCopy( wxGDIImage* image)
 }
 
 void wxStaticBitmap::SetImageNoCopy( wxGDIImage* image)


@@ -251,8 +253,16 @@ void wxStaticBitmap::SetImageNoCopy( wxGDIImage* image)
     LONG style = ::GetWindowLong( (HWND)GetHWND(), GWL_STYLE ) ;
     ::SetWindowLong( (HWND)GetHWND(), GWL_STYLE, ( style & ~( SS_BITMAP|SS_ICON ) ) |
                      ( m_isIcon ? SS_ICON : SS_BITMAP ) );
     LONG style = ::GetWindowLong( (HWND)GetHWND(), GWL_STYLE ) ;
     ::SetWindowLong( (HWND)GetHWND(), GWL_STYLE, ( style & ~( SS_BITMAP|SS_ICON ) ) |
                      ( m_isIcon ? SS_ICON : SS_BITMAP ) );

-    ::SendMessage(GetHwnd(), STM_SETIMAGE,
+    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() )


@@ -273,61 +283,7 @@ void wxStaticBitmap::SetImageNoCopy( wxGDIImage* image)
     rect.top    = y;
     rect.right  = x + w;
     rect.bottom = y + h;
     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;
-
-    wxCHECK_MSG( !m_isIcon, FALSE, _T("icons not supported in wxStaticBitmap") );
-
-    wxBitmap* bitmap = (wxBitmap *)m_image;
-    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;
-}
-#endif // Win16
-
-// We need this or the control can never be moved e.g. in Dialog Editor.
-long wxStaticBitmap::MSWWindowProc(WXUINT nMsg,
-                                   WXWPARAM wParam,
-                                   WXLPARAM lParam)
-{
-#ifndef __WXWINCE__
-    // 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;
-#endif
-
-    return wxWindow::MSWWindowProc(nMsg, wParam, lParam);
+    ::InvalidateRect(GetHwndOf(GetParent()), &rect, TRUE);

 }
 
 #endif // wxUSE_STATBMP
 }
 
 #endif // wxUSE_STATBMP