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