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