Applied patch [ 1382552 ] Fixes GDI-ressource leak in wxStaticBitmap
[wxWidgets.git] / src / msw / statbmp.cpp
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: statbmp.cpp
3 // Purpose: wxStaticBitmap
4 // Author: Julian Smart
5 // Modified by:
6 // Created: 04/01/98
7 // RCS-ID: $Id$
8 // Copyright: (c) Julian Smart
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
11
12 // ===========================================================================
13 // declarations
14 // ===========================================================================
15
16 // ---------------------------------------------------------------------------
17 // headers
18 // ---------------------------------------------------------------------------
19
20 // For compilers that support precompilation, includes "wx.h".
21 #include "wx/wxprec.h"
22
23 #ifdef __BORLANDC__
24 #pragma hdrstop
25 #endif
26
27 #if wxUSE_STATBMP
28
29 #include "wx/window.h"
30 #include "wx/msw/private.h"
31
32 #ifndef WX_PRECOMP
33 #include "wx/icon.h"
34 #include "wx/statbmp.h"
35 #endif
36
37 #include "wx/sysopt.h"
38
39 #include <stdio.h>
40
41 // ---------------------------------------------------------------------------
42 // macors
43 // ---------------------------------------------------------------------------
44
45 #if wxUSE_EXTENDED_RTTI
46 WX_DEFINE_FLAGS( wxStaticBitmapStyle )
47
48 wxBEGIN_FLAGS( wxStaticBitmapStyle )
49 // new style border flags, we put them first to
50 // use them for streaming out
51 wxFLAGS_MEMBER(wxBORDER_SIMPLE)
52 wxFLAGS_MEMBER(wxBORDER_SUNKEN)
53 wxFLAGS_MEMBER(wxBORDER_DOUBLE)
54 wxFLAGS_MEMBER(wxBORDER_RAISED)
55 wxFLAGS_MEMBER(wxBORDER_STATIC)
56 wxFLAGS_MEMBER(wxBORDER_NONE)
57
58 // old style border flags
59 wxFLAGS_MEMBER(wxSIMPLE_BORDER)
60 wxFLAGS_MEMBER(wxSUNKEN_BORDER)
61 wxFLAGS_MEMBER(wxDOUBLE_BORDER)
62 wxFLAGS_MEMBER(wxRAISED_BORDER)
63 wxFLAGS_MEMBER(wxSTATIC_BORDER)
64 wxFLAGS_MEMBER(wxBORDER)
65
66 // standard window styles
67 wxFLAGS_MEMBER(wxTAB_TRAVERSAL)
68 wxFLAGS_MEMBER(wxCLIP_CHILDREN)
69 wxFLAGS_MEMBER(wxTRANSPARENT_WINDOW)
70 wxFLAGS_MEMBER(wxWANTS_CHARS)
71 wxFLAGS_MEMBER(wxFULL_REPAINT_ON_RESIZE)
72 wxFLAGS_MEMBER(wxALWAYS_SHOW_SB )
73 wxFLAGS_MEMBER(wxVSCROLL)
74 wxFLAGS_MEMBER(wxHSCROLL)
75
76 wxEND_FLAGS( wxStaticBitmapStyle )
77
78 IMPLEMENT_DYNAMIC_CLASS_XTI(wxStaticBitmap, wxControl,"wx/statbmp.h")
79
80 wxBEGIN_PROPERTIES_TABLE(wxStaticBitmap)
81 wxPROPERTY_FLAGS( WindowStyle , wxStaticBitmapStyle , long , SetWindowStyleFlag , GetWindowStyleFlag , EMPTY_MACROVALUE, 0 /*flags*/ , wxT("Helpstring") , wxT("group")) // style
82 wxEND_PROPERTIES_TABLE()
83
84 wxBEGIN_HANDLERS_TABLE(wxStaticBitmap)
85 wxEND_HANDLERS_TABLE()
86
87 wxCONSTRUCTOR_5( wxStaticBitmap, wxWindow* , Parent , wxWindowID , Id , wxBitmap, Bitmap, wxPoint , Position , wxSize , Size )
88
89 #else
90 IMPLEMENT_DYNAMIC_CLASS(wxStaticBitmap, wxControl)
91 #endif
92
93 /*
94 TODO PROPERTIES :
95 bitmap
96 */
97
98 // ===========================================================================
99 // implementation
100 // ===========================================================================
101
102 // ---------------------------------------------------------------------------
103 // wxStaticBitmap
104 // ---------------------------------------------------------------------------
105
106 // we may have either bitmap or icon: if a bitmap with mask is passed, we
107 // will transform it to an icon ourselves because otherwise the mask will
108 // be ignored by Windows
109 // note that this function will create a new object every time
110 // it is called even if the image needs no conversion
111
112 static wxGDIImage* ConvertImage( const wxGDIImage& bitmap )
113 {
114 bool isIcon = bitmap.IsKindOf( CLASSINFO(wxIcon) );
115
116 if( !isIcon )
117 {
118 wxASSERT_MSG( wxDynamicCast(&bitmap, wxBitmap),
119 _T("not an icon and not a bitmap?") );
120
121 const wxBitmap& bmp = (const wxBitmap&)bitmap;
122 wxMask *mask = bmp.GetMask();
123 if ( mask && mask->GetMaskBitmap() )
124 {
125 wxIcon* icon = new wxIcon;
126 icon->CopyFromBitmap(bmp);
127
128 return icon;
129 }
130
131 return new wxBitmap( bmp );
132 }
133
134 // copying a bitmap is a cheap operation
135 return new wxIcon( (const wxIcon&)bitmap );
136 }
137
138 bool wxStaticBitmap::Create(wxWindow *parent,
139 wxWindowID id,
140 const wxGDIImage& bitmap,
141 const wxPoint& pos,
142 const wxSize& size,
143 long style,
144 const wxString& name)
145 {
146 if ( !CreateControl(parent, id, pos, size, style, wxDefaultValidator, name) )
147 return false;
148
149 // we may have either bitmap or icon: if a bitmap with mask is passed, we
150 // will transform it to an icon ourselves because otherwise the mask will
151 // be ignored by Windows
152 m_isIcon = bitmap.IsKindOf(CLASSINFO(wxIcon));
153
154 wxGDIImage *image = ConvertImage( bitmap );
155 m_isIcon = image->IsKindOf( CLASSINFO(wxIcon) );
156
157 // create the native control
158 if ( !MSWCreateControl(_T("STATIC"), wxEmptyString, pos, size) )
159 {
160 // control creation failed
161 return false;
162 }
163
164 // no need to delete the new image
165 SetImageNoCopy(image);
166
167 // GetBestSize will work properly now, so set the best size if needed
168 SetBestSize(size);
169
170 return true;
171 }
172
173 wxBorder wxStaticBitmap::GetDefaultBorder() const
174 {
175 return wxBORDER_NONE;
176 }
177
178 WXDWORD wxStaticBitmap::MSWGetStyle(long style, WXDWORD *exstyle) const
179 {
180 WXDWORD msStyle = wxControl::MSWGetStyle(style, exstyle);
181
182 // what kind of control are we?
183 msStyle |= m_isIcon ? SS_ICON : SS_BITMAP;
184
185 // we use SS_CENTERIMAGE to prevent the control from resizing the bitmap to
186 // fit to its size -- this is unexpected and doesn't happen in other ports
187 //
188 // and SS_NOTIFY is necessary to receive mouse events
189 msStyle |= SS_CENTERIMAGE | SS_NOTIFY;
190
191 return msStyle;
192 }
193
194 bool wxStaticBitmap::ImageIsOk() const
195 {
196 return m_image && m_image->Ok();
197 }
198
199 wxIcon wxStaticBitmap::GetIcon() const
200 {
201 wxCHECK_MSG( m_image, wxIcon(), _T("no image in wxStaticBitmap") );
202
203 // we can't ask for an icon if all we have is a bitmap
204 wxCHECK_MSG( m_isIcon, wxIcon(), _T("no icon in this wxStaticBitmap") );
205
206 return *(wxIcon *)m_image;
207 }
208
209 wxBitmap wxStaticBitmap::GetBitmap() const
210 {
211 if ( m_isIcon )
212 {
213 // don't fail because we might have replaced the bitmap with icon
214 // ourselves internally in ConvertImage() to keep the transparency but
215 // the user code doesn't know about it so it still can use GetBitmap()
216 // to retrieve the bitmap
217 return wxBitmap(GetIcon());
218 }
219 else // we have a bitmap
220 {
221 wxCHECK_MSG( m_image, wxBitmap(), _T("no image in wxStaticBitmap") );
222
223 return *(wxBitmap *)m_image;
224 }
225 }
226
227 void wxStaticBitmap::Free()
228 {
229 delete m_image;
230
231 m_image = NULL;
232 }
233
234 wxSize wxStaticBitmap::DoGetBestSize() const
235 {
236 if ( ImageIsOk() )
237 {
238 wxSize best(m_image->GetWidth(), m_image->GetHeight());
239 CacheBestSize(best);
240 return best;
241 }
242
243 // this is completely arbitrary
244 return wxSize(16, 16);
245 }
246
247 void wxStaticBitmap::SetImage( const wxGDIImage* image )
248 {
249 wxGDIImage* convertedImage = ConvertImage( *image );
250 SetImageNoCopy( convertedImage );
251 InvalidateBestSize();
252 }
253
254 void wxStaticBitmap::SetImageNoCopy( wxGDIImage* image)
255 {
256 Free();
257
258 m_isIcon = image->IsKindOf( CLASSINFO(wxIcon) );
259 // the image has already been copied
260 m_image = image;
261
262 int x, y;
263 int w, h;
264 GetPosition(&x, &y);
265 GetSize(&w, &h);
266
267 #ifdef __WIN32__
268 HANDLE handle = (HANDLE)m_image->GetHandle();
269 LONG style = ::GetWindowLong( (HWND)GetHWND(), GWL_STYLE ) ;
270 ::SetWindowLong( (HWND)GetHWND(), GWL_STYLE, ( style & ~( SS_BITMAP|SS_ICON ) ) |
271 ( m_isIcon ? SS_ICON : SS_BITMAP ) );
272 HGDIOBJ oldHandle = (HGDIOBJ)::SendMessage(GetHwnd(), STM_SETIMAGE,
273 m_isIcon ? IMAGE_ICON : IMAGE_BITMAP, (LPARAM)handle);
274 // detect if this is still the handle we passed before or
275 // if the static-control made a copy of the bitmap!
276 if (m_currentHandle != 0 && oldHandle != m_currentHandle)
277 {
278 // the static control made a copy and we are responsible for deleting it
279 DeleteObject(oldHandle);
280 }
281 m_currentHandle = (HGDIOBJ)handle;
282 #endif // Win32
283
284 if ( ImageIsOk() )
285 {
286 int width = image->GetWidth(),
287 height = image->GetHeight();
288 if ( width && height )
289 {
290 w = width;
291 h = height;
292
293 ::MoveWindow(GetHwnd(), x, y, width, height, FALSE);
294 }
295 }
296
297 RECT rect;
298 rect.left = x;
299 rect.top = y;
300 rect.right = x + w;
301 rect.bottom = y + h;
302 ::InvalidateRect(GetHwndOf(GetParent()), &rect, TRUE);
303 }
304
305 #endif // wxUSE_STATBMP
306