src/msw/bmpbuttn.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/msw/bmpbuttn.cpp
   3 // Purpose:     wxBitmapButton
   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 // For compilers that support precompilation, includes "wx.h".
  13 #include "wx/wxprec.h"
  14
  15 #ifdef __BORLANDC__
  16     #pragma hdrstop
  17 #endif
  18
  19 #if wxUSE_BMPBUTTON
  20
  21 #include "wx/bmpbuttn.h"
  22
  23 #ifndef WX_PRECOMP
  24     #include "wx/log.h"
  25     #include "wx/dcmemory.h"
  26 #endif
  27
  28 #include "wx/msw/private.h"
  29 #include "wx/image.h"
  30 #include "wx/msw/uxtheme.h"
  31
  32 // ----------------------------------------------------------------------------
  33 // macros
  34 // ----------------------------------------------------------------------------
  35
  36 #if wxUSE_EXTENDED_RTTI
  37
  38 WX_DEFINE_FLAGS( wxBitmapButtonStyle )
  39
  40 wxBEGIN_FLAGS( wxBitmapButtonStyle )
  41     // new style border flags, we put them first to
  42     // use them for streaming out
  43     wxFLAGS_MEMBER(wxBORDER_SIMPLE)
  44     wxFLAGS_MEMBER(wxBORDER_SUNKEN)
  45     wxFLAGS_MEMBER(wxBORDER_DOUBLE)
  46     wxFLAGS_MEMBER(wxBORDER_RAISED)
  47     wxFLAGS_MEMBER(wxBORDER_STATIC)
  48     wxFLAGS_MEMBER(wxBORDER_NONE)
  49
  50     // old style border flags
  51     wxFLAGS_MEMBER(wxSIMPLE_BORDER)
  52     wxFLAGS_MEMBER(wxSUNKEN_BORDER)
  53     wxFLAGS_MEMBER(wxDOUBLE_BORDER)
  54     wxFLAGS_MEMBER(wxRAISED_BORDER)
  55     wxFLAGS_MEMBER(wxSTATIC_BORDER)
  56     wxFLAGS_MEMBER(wxBORDER)
  57
  58     // standard window styles
  59     wxFLAGS_MEMBER(wxTAB_TRAVERSAL)
  60     wxFLAGS_MEMBER(wxCLIP_CHILDREN)
  61     wxFLAGS_MEMBER(wxTRANSPARENT_WINDOW)
  62     wxFLAGS_MEMBER(wxWANTS_CHARS)
  63     wxFLAGS_MEMBER(wxFULL_REPAINT_ON_RESIZE)
  64     wxFLAGS_MEMBER(wxALWAYS_SHOW_SB )
  65     wxFLAGS_MEMBER(wxVSCROLL)
  66     wxFLAGS_MEMBER(wxHSCROLL)
  67
  68     wxFLAGS_MEMBER(wxBU_AUTODRAW)
  69     wxFLAGS_MEMBER(wxBU_LEFT)
  70     wxFLAGS_MEMBER(wxBU_RIGHT)
  71     wxFLAGS_MEMBER(wxBU_TOP)
  72     wxFLAGS_MEMBER(wxBU_BOTTOM)
  73 wxEND_FLAGS( wxBitmapButtonStyle )
  74
  75 IMPLEMENT_DYNAMIC_CLASS_XTI(wxBitmapButton, wxButton,"wx/bmpbuttn.h")
  76
  77 wxBEGIN_PROPERTIES_TABLE(wxBitmapButton)
  78     wxPROPERTY_FLAGS( WindowStyle , wxBitmapButtonStyle , long , SetWindowStyleFlag , GetWindowStyleFlag , EMPTY_MACROVALUE, 0 /*flags*/ , wxT("Helpstring") , wxT("group")) // style
  79 wxEND_PROPERTIES_TABLE()
  80
  81 wxBEGIN_HANDLERS_TABLE(wxBitmapButton)
  82 wxEND_HANDLERS_TABLE()
  83
  84 wxCONSTRUCTOR_5( wxBitmapButton , wxWindow* , Parent , wxWindowID , Id , wxBitmap , Bitmap , wxPoint , Position , wxSize , Size )
  85
  86 #else
  87 IMPLEMENT_DYNAMIC_CLASS(wxBitmapButton, wxButton)
  88 #endif
  89
  90 BEGIN_EVENT_TABLE(wxBitmapButton, wxBitmapButtonBase)
  91     EVT_SYS_COLOUR_CHANGED(wxBitmapButton::OnSysColourChanged)
  92     EVT_ENTER_WINDOW(wxBitmapButton::OnMouseEnterOrLeave)
  93     EVT_LEAVE_WINDOW(wxBitmapButton::OnMouseEnterOrLeave)
  94 END_EVENT_TABLE()
  95
  96 /*
  97 TODO PROPERTIES :
  98
  99 long "style" , wxBU_AUTODRAW
 100 bool "default" , 0
 101 bitmap "selected" ,
 102 bitmap "focus" ,
 103 bitmap "disabled" ,
 104 */
 105
 106 bool wxBitmapButton::Create(wxWindow *parent, wxWindowID id,
 107     const wxBitmap& bitmap,
 108     const wxPoint& pos,
 109     const wxSize& size, long style,
 110     const wxValidator& wxVALIDATOR_PARAM(validator),
 111     const wxString& name)
 112 {
 113     m_bmpNormal = bitmap;
 114     SetName(name);
 115
 116 #if wxUSE_VALIDATORS
 117     SetValidator(validator);
 118 #endif // wxUSE_VALIDATORS
 119
 120     parent->AddChild(this);
 121
 122     m_backgroundColour = parent->GetBackgroundColour();
 123     m_foregroundColour = parent->GetForegroundColour();
 124     m_windowStyle = style;
 125
 126     if ( style & wxBU_AUTODRAW )
 127     {
 128         m_marginX =
 129         m_marginY = 4;
 130     }
 131
 132     if (id == wxID_ANY)
 133         m_windowId = NewControlId();
 134     else
 135         m_windowId = id;
 136
 137     long msStyle = WS_VISIBLE | WS_TABSTOP | WS_CHILD | BS_OWNERDRAW ;
 138
 139     if ( m_windowStyle & wxCLIP_SIBLINGS )
 140         msStyle |= WS_CLIPSIBLINGS;
 141
 142 #ifdef __WIN32__
 143     if(m_windowStyle & wxBU_LEFT)
 144         msStyle |= BS_LEFT;
 145     if(m_windowStyle & wxBU_RIGHT)
 146         msStyle |= BS_RIGHT;
 147     if(m_windowStyle & wxBU_TOP)
 148         msStyle |= BS_TOP;
 149     if(m_windowStyle & wxBU_BOTTOM)
 150         msStyle |= BS_BOTTOM;
 151 #endif
 152
 153     m_hWnd = (WXHWND) CreateWindowEx(
 154                     0,
 155                     wxT("BUTTON"),
 156                     wxEmptyString,
 157                     msStyle,
 158                     0, 0, 0, 0,
 159                     GetWinHwnd(parent),
 160                     (HMENU)m_windowId,
 161                     wxGetInstance(),
 162                     NULL
 163                    );
 164
 165     // Subclass again for purposes of dialog editing mode
 166     SubclassWin(m_hWnd);
 167
 168     SetPosition(pos);
 169     SetBestSize(size);
 170
 171     return true;
 172 }
 173
 174 bool wxBitmapButton::SetBackgroundColour(const wxColour& colour)
 175 {
 176     if ( !wxBitmapButtonBase::SetBackgroundColour(colour) )
 177     {
 178         // didn't change
 179         return false;
 180     }
 181
 182     // invalidate the brush, it will be recreated the next time it's needed
 183     m_brushDisabled = wxNullBrush;
 184
 185     return true;
 186 }
 187
 188 void wxBitmapButton::OnSysColourChanged(wxSysColourChangedEvent& event)
 189 {
 190     m_brushDisabled = wxNullBrush;
 191
 192     if ( !IsEnabled() )
 193     {
 194         // this change affects our current state
 195         Refresh();
 196     }
 197
 198     event.Skip();
 199 }
 200
 201 void wxBitmapButton::OnMouseEnterOrLeave(wxMouseEvent& event)
 202 {
 203     if ( IsEnabled() && m_bmpHover.Ok() )
 204         Refresh();
 205
 206     event.Skip();
 207 }
 208
 209 void wxBitmapButton::OnSetBitmap()
 210 {
 211     // if the focus bitmap is specified but hover one isn't, use the focus
 212     // bitmap for hovering as well if this is consistent with the current
 213     // Windows version look and feel
 214     //
 215     // rationale: this is compatible with the old wxGTK behaviour and also
 216     // makes it much easier to do "the right thing" for all platforms (some of
 217     // them, such as Windows XP, have "hot" buttons while others don't)
 218     if ( !m_bmpHover.Ok() &&
 219             m_bmpFocus.Ok() &&
 220                 wxUxThemeEngine::GetIfActive() )
 221     {
 222         m_bmpHover = m_bmpFocus;
 223     }
 224
 225     // this will redraw us
 226     wxBitmapButtonBase::OnSetBitmap();
 227 }
 228
 229 // VZ: should be at the very least less than wxDEFAULT_BUTTON_MARGIN
 230 #define FOCUS_MARGIN 3
 231
 232 bool wxBitmapButton::MSWOnDraw(WXDRAWITEMSTRUCT *item)
 233 {
 234 #ifndef __WXWINCE__
 235     long style = GetWindowLong((HWND) GetHWND(), GWL_STYLE);
 236     if (style & BS_BITMAP)
 237     {
 238         // Let default procedure draw the bitmap, which is defined
 239         // in the Windows resource.
 240         return false;
 241     }
 242 #endif
 243
 244     LPDRAWITEMSTRUCT lpDIS = (LPDRAWITEMSTRUCT) item;
 245     HDC hDC                = lpDIS->hDC;
 246     UINT state             = lpDIS->itemState;
 247     bool isSelected        = (state & ODS_SELECTED) != 0;
 248     bool autoDraw          = (GetWindowStyleFlag() & wxBU_AUTODRAW) != 0;
 249
 250
 251     // choose the bitmap to use depending on the button state
 252     wxBitmap *bitmap;
 253
 254     if ( isSelected && m_bmpSelected.Ok() )
 255         bitmap = &m_bmpSelected;
 256     else if ( m_bmpHover.Ok() && IsMouseInWindow() )
 257         bitmap = &m_bmpHover;
 258     else if ((state & ODS_FOCUS) && m_bmpFocus.Ok())
 259         bitmap = &m_bmpFocus;
 260     else if ((state & ODS_DISABLED) && m_bmpDisabled.Ok())
 261         bitmap = &m_bmpDisabled;
 262     else
 263         bitmap = &m_bmpNormal;
 264
 265     if ( !bitmap->Ok() )
 266         return false;
 267
 268     // centre the bitmap in the control area
 269     int x      = lpDIS->rcItem.left;
 270     int y      = lpDIS->rcItem.top;
 271     int width  = lpDIS->rcItem.right - x;
 272     int height = lpDIS->rcItem.bottom - y;
 273     int wBmp   = bitmap->GetWidth();
 274     int hBmp   = bitmap->GetHeight();
 275
 276     int x1,y1;
 277
 278     if(m_windowStyle & wxBU_LEFT)
 279         x1 = x + (FOCUS_MARGIN+1);
 280     else if(m_windowStyle & wxBU_RIGHT)
 281         x1 = x + (width - wBmp) - (FOCUS_MARGIN+1);
 282     else
 283         x1 = x + (width - wBmp) / 2;
 284
 285     if(m_windowStyle & wxBU_TOP)
 286         y1 = y + (FOCUS_MARGIN+1);
 287     else if(m_windowStyle & wxBU_BOTTOM)
 288         y1 = y + (height - hBmp) - (FOCUS_MARGIN+1);
 289     else
 290         y1 = y + (height - hBmp) / 2;
 291
 292     if ( isSelected && autoDraw )
 293     {
 294         x1++;
 295         y1++;
 296     }
 297
 298     // draw the face, if auto-drawing
 299     if ( autoDraw )
 300     {
 301         DrawFace((WXHDC) hDC,
 302                  lpDIS->rcItem.left, lpDIS->rcItem.top,
 303                  lpDIS->rcItem.right, lpDIS->rcItem.bottom,
 304                  isSelected);
 305     }
 306
 307     // draw the bitmap
 308     wxDCTemp dst((WXHDC)hDC);
 309     dst.DrawBitmap(*bitmap, x1, y1, true);
 310
 311     // draw focus / disabled state, if auto-drawing
 312     if ( (state & ODS_DISABLED) && autoDraw )
 313     {
 314         DrawButtonDisable((WXHDC) hDC,
 315                           lpDIS->rcItem.left, lpDIS->rcItem.top,
 316                           lpDIS->rcItem.right, lpDIS->rcItem.bottom,
 317                           true);
 318     }
 319     else if ( (state & ODS_FOCUS) && autoDraw )
 320     {
 321         DrawButtonFocus((WXHDC) hDC,
 322                         lpDIS->rcItem.left,
 323                         lpDIS->rcItem.top,
 324                         lpDIS->rcItem.right,
 325                         lpDIS->rcItem.bottom,
 326                         isSelected);
 327     }
 328
 329     return true;
 330 }
 331
 332 // GRG Feb/2000, support for bmp buttons with Win95/98 standard LNF
 333
 334 void wxBitmapButton::DrawFace( WXHDC dc, int left, int top,
 335     int right, int bottom, bool sel )
 336 {
 337     HPEN oldp;
 338     HPEN penHiLight;
 339     HPEN penLight;
 340     HPEN penShadow;
 341     HPEN penDkShadow;
 342     HBRUSH brushFace;
 343
 344     // create needed pens and brush
 345     penHiLight  = CreatePen(PS_SOLID, 0, GetSysColor(COLOR_3DHILIGHT));
 346     penLight    = CreatePen(PS_SOLID, 0, GetSysColor(COLOR_3DLIGHT));
 347     penShadow   = CreatePen(PS_SOLID, 0, GetSysColor(COLOR_3DSHADOW));
 348     penDkShadow = CreatePen(PS_SOLID, 0, GetSysColor(COLOR_3DDKSHADOW));
 349     // brushFace   = CreateSolidBrush(GetSysColor(COLOR_BTNFACE));
 350     // Taking the background colour fits in better with
 351     // Windows XP themes.
 352     brushFace   = CreateSolidBrush(m_backgroundColour.m_pixel);
 353
 354     // draw the rectangle
 355     RECT rect;
 356     rect.left   = left;
 357     rect.right  = right;
 358     rect.top    = top;
 359     rect.bottom = bottom;
 360     FillRect((HDC) dc, &rect, brushFace);
 361
 362     // draw the border
 363     oldp = (HPEN) SelectObject( (HDC) dc, sel? penDkShadow : penHiLight);
 364
 365     wxDrawLine((HDC) dc, left, top, right-1, top);
 366     wxDrawLine((HDC) dc, left, top+1, left, bottom-1);
 367
 368     SelectObject( (HDC) dc, sel? penShadow : penLight);
 369     wxDrawLine((HDC) dc, left+1, top+1, right-2, top+1);
 370     wxDrawLine((HDC) dc, left+1, top+2, left+1, bottom-2);
 371
 372     SelectObject( (HDC) dc, sel? penLight : penShadow);
 373     wxDrawLine((HDC) dc, left+1, bottom-2, right-1, bottom-2);
 374     wxDrawLine((HDC) dc, right-2, bottom-3, right-2, top);
 375
 376     SelectObject( (HDC) dc, sel? penHiLight : penDkShadow);
 377     wxDrawLine((HDC) dc, left, bottom-1, right+2, bottom-1);
 378     wxDrawLine((HDC) dc, right-1, bottom-2, right-1, top-1);
 379
 380     // delete allocated resources
 381     SelectObject((HDC) dc,oldp);
 382     DeleteObject(penHiLight);
 383     DeleteObject(penLight);
 384     DeleteObject(penShadow);
 385     DeleteObject(penDkShadow);
 386     DeleteObject(brushFace);
 387 }
 388
 389 void wxBitmapButton::DrawButtonFocus( WXHDC dc, int left, int top, int right,
 390     int bottom, bool WXUNUSED(sel) )
 391 {
 392     RECT rect;
 393     rect.left = left;
 394     rect.top = top;
 395     rect.right = right;
 396     rect.bottom = bottom;
 397     InflateRect( &rect, - FOCUS_MARGIN, - FOCUS_MARGIN );
 398
 399     // GRG: the focus rectangle should not move when the button is pushed!
 400 /*
 401     if ( sel )
 402         OffsetRect( &rect, 1, 1 );
 403 */
 404
 405     DrawFocusRect( (HDC) dc, &rect );
 406 }
 407
 408 void
 409 wxBitmapButton::DrawButtonDisable( WXHDC dc,
 410                                    int left, int top, int right, int bottom,
 411                                    bool with_marg )
 412 {
 413     if ( !m_brushDisabled.Ok() )
 414     {
 415         // draw a bitmap with two black and two background colour pixels
 416         wxBitmap bmp(2, 2);
 417         wxMemoryDC dc;
 418         dc.SelectObject(bmp);
 419         dc.SetPen(*wxBLACK_PEN);
 420         dc.DrawPoint(0, 0);
 421         dc.DrawPoint(1, 1);
 422         dc.SetPen(GetBackgroundColour());
 423         dc.DrawPoint(0, 1);
 424         dc.DrawPoint(1, 0);
 425
 426         m_brushDisabled = wxBrush(bmp);
 427     }
 428
 429     SelectInHDC selectBrush((HDC)dc, GetHbrushOf(m_brushDisabled));
 430
 431     // ROP for "dest |= pattern" operation -- as it doesn't have a standard
 432     // name, give it our own
 433     static const DWORD PATTERNPAINT = 0xFA0089UL;
 434
 435     if ( with_marg )
 436     {
 437         left += m_marginX;
 438         top += m_marginY;
 439         right -= 2 * m_marginX;
 440         bottom -= 2 * m_marginY;
 441     }
 442
 443     ::PatBlt( (HDC) dc, left, top, right, bottom, PATTERNPAINT);
 444 }
 445
 446 void wxBitmapButton::SetDefault()
 447 {
 448     wxButton::SetDefault();
 449 }
 450
 451 wxSize wxBitmapButton::DoGetBestSize() const
 452 {
 453     if ( m_bmpNormal.Ok() )
 454     {
 455         wxSize best(m_bmpNormal.GetWidth() + 2*m_marginX,
 456                       m_bmpNormal.GetHeight() + 2*m_marginY);
 457         CacheBestSize(best);
 458         return best;
 459     }
 460
 461     // no idea what our best size should be, defer to the base class
 462     return wxBitmapButtonBase::DoGetBestSize();
 463 }
 464
 465 #endif // wxUSE_BMPBUTTON