src/msw/checklst.cpp

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        msw/checklst.cpp
   3 // Purpose:     implementation of wxCheckListBox class
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     16.11.97
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
   9 // Licence:     wxWindows licence
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 // ============================================================================
  13 // declarations
  14 // ============================================================================
  15
  16 // ----------------------------------------------------------------------------
  17 // headers
  18 // ----------------------------------------------------------------------------
  19
  20 #ifdef __GNUG__
  21 #pragma implementation "checklst.h"
  22 #endif
  23
  24 // For compilers that support precompilation, includes "wx.h".
  25 #include "wx/wxprec.h"
  26
  27 #ifdef __BORLANDC__
  28 #pragma hdrstop
  29 #endif
  30
  31 #if wxUSE_OWNER_DRAWN
  32
  33 #ifndef WX_PRECOMP
  34     #include "wx/object.h"
  35     #include "wx/colour.h"
  36     #include "wx/font.h"
  37     #include "wx/bitmap.h"
  38     #include "wx/window.h"
  39     #include "wx/listbox.h"
  40     #include "wx/dcmemory.h"
  41
  42     #include "wx/settings.h"
  43
  44     #include "wx/log.h"
  45 #endif
  46
  47 #include "wx/ownerdrw.h"
  48 #include "wx/checklst.h"
  49
  50 #include <windows.h>
  51 #include <windowsx.h>
  52
  53 #include "wx/msw/private.h"
  54
  55 #if defined(__GNUWIN32_OLD__)
  56     #include "wx/msw/gnuwin32/extra.h"
  57 #endif
  58
  59 // ----------------------------------------------------------------------------
  60 // private functions
  61 // ----------------------------------------------------------------------------
  62
  63 // get item (converted to right type)
  64 #define GetItem(n)    ((wxCheckListBoxItem *)(GetItem(n)))
  65
  66 // ============================================================================
  67 // implementation
  68 // ============================================================================
  69
  70 IMPLEMENT_DYNAMIC_CLASS(wxCheckListBox, wxListBox)
  71
  72 // ----------------------------------------------------------------------------
  73 // declaration and implementation of wxCheckListBoxItem class
  74 // ----------------------------------------------------------------------------
  75
  76 class wxCheckListBoxItem : public wxOwnerDrawn
  77 {
  78 friend class WXDLLEXPORT wxCheckListBox;
  79 public:
  80   // ctor
  81   wxCheckListBoxItem(wxCheckListBox *pParent, size_t nIndex);
  82
  83   // drawing functions
  84   virtual bool OnDrawItem(wxDC& dc, const wxRect& rc, wxODAction act, wxODStatus stat);
  85
  86   // simple accessors and operations
  87   bool IsChecked() const { return m_bChecked; }
  88
  89   void Check(bool bCheck);
  90   void Toggle() { Check(!IsChecked()); }
  91
  92   void SendEvent();
  93
  94 private:
  95
  96     DECLARE_NO_COPY_CLASS(wxCheckListBoxItem)
  97   bool            m_bChecked;
  98   wxCheckListBox *m_pParent;
  99   size_t          m_nIndex;
 100 };
 101
 102 wxCheckListBoxItem::wxCheckListBoxItem(wxCheckListBox *pParent, size_t nIndex)
 103                   : wxOwnerDrawn(wxEmptyString, TRUE)   // checkable
 104 {
 105   m_bChecked = FALSE;
 106   m_pParent  = pParent;
 107   m_nIndex   = nIndex;
 108
 109   // we don't initialize m_nCheckHeight/Width vars because it's
 110   // done in OnMeasure while they are used only in OnDraw and we
 111   // know that there will always be OnMeasure before OnDraw
 112
 113   // fix appearance
 114   SetMarginWidth(GetDefaultMarginWidth());
 115 }
 116
 117 /*
 118  * JACS - I've got the owner-draw stuff partially working with WIN16,
 119  * with a really horrible-looking cross for wxCheckListBox instead of a
 120  * check - could use a bitmap check-mark instead, defined in wx.rc.
 121  * Also there's a refresh problem whereby it doesn't always draw the
 122  * check until you click to the right of it, which is OK for WIN32.
 123  */
 124
 125 bool wxCheckListBoxItem::OnDrawItem(wxDC& dc, const wxRect& rc,
 126                                     wxODAction act, wxODStatus stat)
 127 {
 128   if ( IsChecked() )
 129     stat = (wxOwnerDrawn::wxODStatus)(stat | wxOwnerDrawn::wxODChecked);
 130
 131   if ( wxOwnerDrawn::OnDrawItem(dc, rc, act, stat) ) {
 132     // ## using native API for performance and precision
 133     size_t nCheckWidth  = GetDefaultMarginWidth(),
 134          nCheckHeight = m_pParent->GetItemHeight();
 135
 136     int x = rc.GetX(),
 137         y = rc.GetY();
 138
 139     HDC hdc = (HDC)dc.GetHDC();
 140
 141     // create pens
 142     HPEN hpenBack = CreatePen(PS_SOLID, 0, GetSysColor(COLOR_WINDOW)),
 143          hpenGray = CreatePen(PS_SOLID, 0, RGB(128, 128, 128)),
 144          hpenPrev = (HPEN)SelectObject(hdc, hpenBack);
 145
 146     // we erase the 1-pixel border
 147     Rectangle(hdc, x, y, x + nCheckWidth, y + nCheckHeight);
 148
 149     // shift check mark 1 pixel to the right (it looks better like this)
 150     x++;
 151
 152     if ( IsChecked() ) {
 153       // first create a monochrome bitmap in a memory DC
 154       HDC hdcMem = CreateCompatibleDC(hdc);
 155       HBITMAP hbmpCheck = CreateBitmap(nCheckWidth, nCheckHeight, 1, 1, 0);
 156       HBITMAP hbmpOld = (HBITMAP)SelectObject(hdcMem, hbmpCheck);
 157
 158       // then draw a check mark into it
 159
 160       RECT rect;
 161       rect.left   = 0;
 162       rect.top    = 0;
 163       rect.right  = nCheckWidth;
 164       rect.bottom = nCheckHeight;
 165
 166 #ifdef __WXWINCE__
 167       DrawFrameControl(hdcMem, &rect, DFC_BUTTON, DFCS_BUTTONCHECK);
 168 #else
 169       DrawFrameControl(hdcMem, &rect, DFC_MENU, DFCS_MENUCHECK);
 170 #endif
 171
 172       // finally copy it to screen DC and clean up
 173       BitBlt(hdc, x, y, nCheckWidth - 1, nCheckHeight,
 174              hdcMem, 0, 0, SRCCOPY);
 175
 176       SelectObject(hdcMem, hbmpOld);
 177       DeleteObject(hbmpCheck);
 178       DeleteDC(hdcMem);
 179     }
 180
 181     // now we draw the smaller rectangle
 182     y++;
 183     nCheckWidth  -= 2;
 184     nCheckHeight -= 2;
 185
 186     // draw hollow gray rectangle
 187     (void)SelectObject(hdc, hpenGray);
 188     HBRUSH hbrPrev  = (HBRUSH)SelectObject(hdc, GetStockObject(NULL_BRUSH));
 189     Rectangle(hdc, x, y, x + nCheckWidth, y + nCheckHeight);
 190
 191     // clean up
 192     (void)SelectObject(hdc, hpenPrev);
 193     (void)SelectObject(hdc, hbrPrev);
 194
 195     DeleteObject(hpenBack);
 196     DeleteObject(hpenGray);
 197
 198     /*
 199     dc.DrawRectangle(x, y, nCheckWidth, nCheckHeight);
 200
 201     if ( IsChecked() ) {
 202       dc.DrawLine(x, y, x + nCheckWidth, y + nCheckHeight);
 203       dc.DrawLine(x, y + nCheckHeight, x + nCheckWidth, y);
 204     }
 205     */
 206
 207     return TRUE;
 208   }
 209
 210   return FALSE;
 211 }
 212
 213 // change the state of the item and redraw it
 214 void wxCheckListBoxItem::Check(bool check)
 215 {
 216     m_bChecked = check;
 217
 218     // index may be changed because new items were added/deleted
 219     if ( m_pParent->GetItemIndex(this) != (int)m_nIndex )
 220     {
 221         // update it
 222         int index = m_pParent->GetItemIndex(this);
 223
 224         wxASSERT_MSG( index != wxNOT_FOUND, wxT("what does this item do here?") );
 225
 226         m_nIndex = (size_t)index;
 227     }
 228
 229     HWND hwndListbox = (HWND)m_pParent->GetHWND();
 230
 231     #ifdef __WIN32__
 232         RECT rcUpdate;
 233
 234         if ( ::SendMessage(hwndListbox, LB_GETITEMRECT,
 235                            m_nIndex, (LPARAM)&rcUpdate) == LB_ERR )
 236         {
 237             wxLogDebug(wxT("LB_GETITEMRECT failed"));
 238         }
 239     #else // Win16
 240         // FIXME this doesn't work if the listbox is scrolled!
 241         size_t nHeight = m_pParent->GetItemHeight();
 242         size_t y = m_nIndex * nHeight;
 243         RECT rcUpdate ;
 244         rcUpdate.left   = 0 ;
 245         rcUpdate.top    = y ;
 246         rcUpdate.right  = GetDefaultMarginWidth() ;
 247         rcUpdate.bottom = y + nHeight ;
 248     #endif  // Win32/16
 249
 250     InvalidateRect(hwndListbox, &rcUpdate, FALSE);
 251 }
 252
 253 // send an "item checked" event
 254 void wxCheckListBoxItem::SendEvent()
 255 {
 256     wxCommandEvent event(wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, m_pParent->GetId());
 257     event.SetInt(m_nIndex);
 258     event.SetEventObject(m_pParent);
 259     m_pParent->ProcessCommand(event);
 260 }
 261
 262 // ----------------------------------------------------------------------------
 263 // implementation of wxCheckListBox class
 264 // ----------------------------------------------------------------------------
 265
 266 // define event table
 267 // ------------------
 268 BEGIN_EVENT_TABLE(wxCheckListBox, wxListBox)
 269   EVT_KEY_DOWN(wxCheckListBox::OnKeyDown)
 270   EVT_LEFT_DOWN(wxCheckListBox::OnLeftClick)
 271 END_EVENT_TABLE()
 272
 273 // control creation
 274 // ----------------
 275
 276 // def ctor: use Create() to really create the control
 277 wxCheckListBox::wxCheckListBox()
 278 {
 279 }
 280
 281 // ctor which creates the associated control
 282 wxCheckListBox::wxCheckListBox(wxWindow *parent, wxWindowID id,
 283                                const wxPoint& pos, const wxSize& size,
 284                                int nStrings, const wxString choices[],
 285                                long style, const wxValidator& val,
 286                                const wxString& name)
 287 {
 288     Create(parent, id, pos, size, nStrings, choices, style, val, name);
 289 }
 290
 291 bool wxCheckListBox::Create(wxWindow *parent, wxWindowID id,
 292                             const wxPoint& pos, const wxSize& size,
 293                             int n, const wxString choices[],
 294                             long style,
 295                             const wxValidator& validator, const wxString& name)
 296 {
 297     return wxListBox::Create(parent, id, pos, size, n, choices,
 298                              style | wxLB_OWNERDRAW, validator, name);
 299 }
 300
 301 // misc overloaded methods
 302 // -----------------------
 303
 304 void wxCheckListBox::Delete(int N)
 305 {
 306     wxCHECK_RET( N >= 0 && N < m_noItems,
 307                  wxT("invalid index in wxListBox::Delete") );
 308
 309     wxListBox::Delete(N);
 310
 311     // free memory
 312     delete m_aItems[N];
 313
 314     m_aItems.RemoveAt(N);
 315 }
 316
 317 bool wxCheckListBox::SetFont( const wxFont &font )
 318 {
 319     size_t i;
 320     for ( i = 0; i < m_aItems.GetCount(); i++ )
 321         m_aItems[i]->SetFont(font);
 322
 323     wxListBox::SetFont(font);
 324
 325     return TRUE;
 326 }
 327
 328 // create/retrieve item
 329 // --------------------
 330
 331 // create a check list box item
 332 wxOwnerDrawn *wxCheckListBox::CreateLboxItem(size_t nIndex)
 333 {
 334   wxCheckListBoxItem *pItem = new wxCheckListBoxItem(this, nIndex);
 335   return pItem;
 336 }
 337
 338 // return item size
 339 // ----------------
 340 bool wxCheckListBox::MSWOnMeasure(WXMEASUREITEMSTRUCT *item)
 341 {
 342   if ( wxListBox::MSWOnMeasure(item) ) {
 343     MEASUREITEMSTRUCT *pStruct = (MEASUREITEMSTRUCT *)item;
 344
 345     // save item height
 346     m_nItemHeight = pStruct->itemHeight;
 347
 348     // add place for the check mark
 349     pStruct->itemWidth += wxOwnerDrawn::GetDefaultMarginWidth();
 350
 351     return TRUE;
 352   }
 353
 354   return FALSE;
 355 }
 356
 357 // check items
 358 // -----------
 359
 360 bool wxCheckListBox::IsChecked(size_t uiIndex) const
 361 {
 362     wxCHECK_MSG( uiIndex < (size_t)GetCount(), FALSE, _T("bad wxCheckListBox index") );
 363
 364     return GetItem(uiIndex)->IsChecked();
 365 }
 366
 367 void wxCheckListBox::Check(size_t uiIndex, bool bCheck)
 368 {
 369     wxCHECK_RET( uiIndex < (size_t)GetCount(), _T("bad wxCheckListBox index") );
 370
 371     GetItem(uiIndex)->Check(bCheck);
 372 }
 373
 374 // process events
 375 // --------------
 376
 377 void wxCheckListBox::OnKeyDown(wxKeyEvent& event)
 378 {
 379     // what do we do?
 380     enum
 381     {
 382         None,
 383         Toggle,
 384         Set,
 385         Clear
 386     } oper;
 387
 388     switch ( event.GetKeyCode() )
 389     {
 390         case WXK_SPACE:
 391             oper = Toggle;
 392             break;
 393
 394         case WXK_NUMPAD_ADD:
 395         case '+':
 396             oper = Set;
 397             break;
 398
 399         case WXK_NUMPAD_SUBTRACT:
 400         case '-':
 401             oper = Clear;
 402             break;
 403
 404         default:
 405             oper = None;
 406     }
 407
 408     if ( oper != None )
 409     {
 410         wxArrayInt selections;
 411         int count = 0;
 412         if ( HasMultipleSelection() )
 413         {
 414             count = GetSelections(selections);
 415         }
 416         else
 417         {
 418             int sel = GetSelection();
 419             if (sel != -1)
 420             {
 421                 count = 1;
 422                 selections.Add(sel);
 423             }
 424         }
 425
 426         for ( int i = 0; i < count; i++ )
 427         {
 428             wxCheckListBoxItem *item = GetItem(selections[i]);
 429             if ( !item )
 430             {
 431                 wxFAIL_MSG( _T("no wxCheckListBoxItem?") );
 432                 continue;
 433             }
 434
 435             switch ( oper )
 436             {
 437                 case Toggle:
 438                     item->Toggle();
 439                     break;
 440
 441                 case Set:
 442                 case Clear:
 443                     item->Check( oper == Set );
 444                     break;
 445
 446                 default:
 447                     wxFAIL_MSG( _T("what should this key do?") );
 448             }
 449
 450             // we should send an event as this has been done by the user and
 451             // not by the program
 452             item->SendEvent();
 453         }
 454     }
 455     else // nothing to do
 456     {
 457         event.Skip();
 458     }
 459 }
 460
 461 void wxCheckListBox::OnLeftClick(wxMouseEvent& event)
 462 {
 463   // clicking on the item selects it, clicking on the checkmark toggles
 464   if ( event.GetX() <= wxOwnerDrawn::GetDefaultMarginWidth() ) {
 465     int nItem = HitTest(event.GetX(), event.GetY());
 466
 467     if ( nItem != wxNOT_FOUND ) {
 468       wxCheckListBoxItem *item = GetItem(nItem);
 469       item->Toggle();
 470       item->SendEvent();
 471     }
 472     //else: it's not an error, just click outside of client zone
 473   }
 474   else {
 475     // implement default behaviour: clicking on the item selects it
 476     event.Skip();
 477   }
 478 }
 479
 480 int wxCheckListBox::DoHitTestItem(wxCoord x, wxCoord y) const
 481 {
 482   #ifdef __WIN32__
 483     int nItem = (int)::SendMessage
 484                              (
 485                               (HWND)GetHWND(),
 486                               LB_ITEMFROMPOINT,
 487                               0,
 488                               MAKELPARAM(x, y)
 489                              );
 490   #else // Win16
 491     // FIXME this doesn't work when the listbox is scrolled!
 492     int nItem = y / m_nItemHeight;
 493   #endif // Win32/16
 494
 495   return nItem >= m_noItems ? wxNOT_FOUND : nItem;
 496 }
 497
 498 #endif
 499