src/msw/checklst.cpp

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/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 // 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_CHECKLISTBOX && wxUSE_OWNER_DRAWN
  28
  29 #include "wx/checklst.h"
  30
  31 #ifndef WX_PRECOMP
  32     #include "wx/msw/wrapcctl.h"
  33     #include "wx/object.h"
  34     #include "wx/colour.h"
  35     #include "wx/font.h"
  36     #include "wx/bitmap.h"
  37     #include "wx/window.h"
  38     #include "wx/listbox.h"
  39     #include "wx/dcmemory.h"
  40     #include "wx/settings.h"
  41     #include "wx/log.h"
  42 #endif
  43
  44 #include "wx/ownerdrw.h"
  45
  46 #include <windowsx.h>
  47
  48 #include "wx/renderer.h"
  49 #include "wx/msw/private.h"
  50
  51 // ----------------------------------------------------------------------------
  52 // private functions
  53 // ----------------------------------------------------------------------------
  54
  55 // get item (converted to right type)
  56 #define GetItem(n)    ((wxCheckListBoxItem *)(GetItem(n)))
  57
  58 // ============================================================================
  59 // implementation
  60 // ============================================================================
  61
  62
  63 #if wxUSE_EXTENDED_RTTI
  64 WX_DEFINE_FLAGS( wxCheckListBoxStyle )
  65
  66 wxBEGIN_FLAGS( wxCheckListBoxStyle )
  67     // new style border flags, we put them first to
  68     // use them for streaming out
  69     wxFLAGS_MEMBER(wxBORDER_SIMPLE)
  70     wxFLAGS_MEMBER(wxBORDER_SUNKEN)
  71     wxFLAGS_MEMBER(wxBORDER_DOUBLE)
  72     wxFLAGS_MEMBER(wxBORDER_RAISED)
  73     wxFLAGS_MEMBER(wxBORDER_STATIC)
  74     wxFLAGS_MEMBER(wxBORDER_NONE)
  75
  76     // old style border flags
  77     wxFLAGS_MEMBER(wxSIMPLE_BORDER)
  78     wxFLAGS_MEMBER(wxSUNKEN_BORDER)
  79     wxFLAGS_MEMBER(wxDOUBLE_BORDER)
  80     wxFLAGS_MEMBER(wxRAISED_BORDER)
  81     wxFLAGS_MEMBER(wxSTATIC_BORDER)
  82     wxFLAGS_MEMBER(wxBORDER)
  83
  84     // standard window styles
  85     wxFLAGS_MEMBER(wxTAB_TRAVERSAL)
  86     wxFLAGS_MEMBER(wxCLIP_CHILDREN)
  87     wxFLAGS_MEMBER(wxTRANSPARENT_WINDOW)
  88     wxFLAGS_MEMBER(wxWANTS_CHARS)
  89     wxFLAGS_MEMBER(wxFULL_REPAINT_ON_RESIZE)
  90     wxFLAGS_MEMBER(wxALWAYS_SHOW_SB )
  91     wxFLAGS_MEMBER(wxVSCROLL)
  92     wxFLAGS_MEMBER(wxHSCROLL)
  93
  94     wxFLAGS_MEMBER(wxLB_SINGLE)
  95     wxFLAGS_MEMBER(wxLB_MULTIPLE)
  96     wxFLAGS_MEMBER(wxLB_EXTENDED)
  97     wxFLAGS_MEMBER(wxLB_HSCROLL)
  98     wxFLAGS_MEMBER(wxLB_ALWAYS_SB)
  99     wxFLAGS_MEMBER(wxLB_NEEDED_SB)
 100     wxFLAGS_MEMBER(wxLB_SORT)
 101     wxFLAGS_MEMBER(wxLB_OWNERDRAW)
 102
 103 wxEND_FLAGS( wxCheckListBoxStyle )
 104
 105 IMPLEMENT_DYNAMIC_CLASS_XTI(wxCheckListBox, wxListBox,"wx/checklst.h")
 106
 107 wxBEGIN_PROPERTIES_TABLE(wxCheckListBox)
 108     wxEVENT_PROPERTY( Toggle , wxEVT_COMMAND_CHECKLISTBOX_TOGGLED , wxCommandEvent )
 109     wxPROPERTY_FLAGS( WindowStyle , wxCheckListBoxStyle , long , SetWindowStyleFlag , GetWindowStyleFlag , EMPTY_MACROVALUE , wxLB_OWNERDRAW /*flags*/ , wxT("Helpstring") , wxT("group")) // style
 110 wxEND_PROPERTIES_TABLE()
 111
 112 wxBEGIN_HANDLERS_TABLE(wxCheckListBox)
 113 wxEND_HANDLERS_TABLE()
 114
 115 wxCONSTRUCTOR_4( wxCheckListBox , wxWindow* , Parent , wxWindowID , Id , wxPoint , Position , wxSize , Size )
 116
 117 #else
 118 IMPLEMENT_DYNAMIC_CLASS(wxCheckListBox, wxListBox)
 119 #endif
 120
 121 // ----------------------------------------------------------------------------
 122 // declaration and implementation of wxCheckListBoxItem class
 123 // ----------------------------------------------------------------------------
 124
 125 class wxCheckListBoxItem : public wxOwnerDrawn
 126 {
 127 friend class WXDLLIMPEXP_FWD_CORE wxCheckListBox;
 128 public:
 129     // ctor
 130     wxCheckListBoxItem(wxCheckListBox *pParent, size_t nIndex);
 131
 132     // drawing functions
 133     virtual bool OnDrawItem(wxDC& dc, const wxRect& rc, wxODAction act, wxODStatus stat);
 134
 135     // simple accessors and operations
 136     bool IsChecked() const { return m_bChecked; }
 137
 138     void Check(bool bCheck);
 139     void Toggle() { Check(!IsChecked()); }
 140
 141     void SendEvent();
 142
 143 private:
 144     bool            m_bChecked;
 145     wxCheckListBox *m_pParent;
 146     size_t          m_nIndex;
 147
 148     DECLARE_NO_COPY_CLASS(wxCheckListBoxItem)
 149 };
 150
 151 wxCheckListBoxItem::wxCheckListBoxItem(wxCheckListBox *pParent, size_t nIndex)
 152                   : wxOwnerDrawn(wxEmptyString, true)   // checkable
 153 {
 154     m_bChecked = false;
 155     m_pParent  = pParent;
 156     m_nIndex   = nIndex;
 157
 158     // we don't initialize m_nCheckHeight/Width vars because it's
 159     // done in OnMeasure while they are used only in OnDraw and we
 160     // know that there will always be OnMeasure before OnDraw
 161
 162     SetMarginWidth(::GetSystemMetrics(SM_CXMENUCHECK) - 2);
 163
 164     SetBackgroundColour(pParent->GetBackgroundColour());
 165 }
 166
 167 bool wxCheckListBoxItem::OnDrawItem(wxDC& dc, const wxRect& rc,
 168                                     wxODAction act, wxODStatus stat)
 169 {
 170     // first draw the label
 171     if ( IsChecked() )
 172         stat = (wxOwnerDrawn::wxODStatus)(stat | wxOwnerDrawn::wxODChecked);
 173
 174     if ( !wxOwnerDrawn::OnDrawItem(dc, rc, act, stat) )
 175         return false;
 176
 177     // now draw the check mark part
 178     HDC hdc = GetHdcOf(dc);
 179
 180     int nBmpWidth  = ::GetSystemMetrics(SM_CXMENUCHECK),
 181         nBmpHeight = ::GetSystemMetrics(SM_CYMENUCHECK);
 182
 183
 184     // first create bitmap in a memory DC
 185     MemoryHDC hdcMem(hdc);
 186     CompatibleBitmap hBmpCheck(hdc, nBmpWidth, nBmpHeight);
 187
 188     // then draw a check mark into it
 189     {
 190         SelectInHDC selBmp(hdcMem, hBmpCheck);
 191
 192         int flags = wxCONTROL_FLAT;
 193         if ( IsChecked() )
 194             flags |= wxCONTROL_CHECKED;
 195
 196         wxDCTemp dcMem(hdcMem);
 197         wxRendererNative::Get().DrawCheckBox(
 198                 m_pParent, dcMem, wxRect(0, 0, nBmpWidth, nBmpHeight), flags);
 199     } // select hBmpCheck out of hdcMem
 200
 201     // shift check mark 2 pixel to the right and bottom, looks better like this
 202     int x = rc.GetX() + 2,
 203         y = rc.GetY() + 2;
 204
 205     // finally draw bitmap to screen: uses image list functions to blend
 206     // the bitmap with the background colour (better for the selected items)
 207     HIMAGELIST himl = ImageList_Create(nBmpWidth, nBmpHeight,
 208                                        ILC_COLOR32 | ILC_MASK, 1, 1);
 209     ImageList_Add(himl, hBmpCheck, NULL);
 210
 211     UINT fStyle = stat & wxOwnerDrawn::wxODSelected ? ILD_SELECTED : ILD_NORMAL;
 212     ImageList_Draw(himl, 0, hdc, x, y, fStyle);
 213
 214     ImageList_Destroy(himl);
 215
 216     return true;
 217 }
 218
 219 // change the state of the item and redraw it
 220 void wxCheckListBoxItem::Check(bool check)
 221 {
 222     m_bChecked = check;
 223
 224     // index may be changed because new items were added/deleted
 225     if ( m_pParent->GetItemIndex(this) != (int)m_nIndex )
 226     {
 227         // update it
 228         int index = m_pParent->GetItemIndex(this);
 229
 230         wxASSERT_MSG( index != wxNOT_FOUND, wxT("what does this item do here?") );
 231
 232         m_nIndex = (size_t)index;
 233     }
 234
 235     HWND hwndListbox = (HWND)m_pParent->GetHWND();
 236
 237     RECT rcUpdate;
 238
 239     if ( ::SendMessage(hwndListbox, LB_GETITEMRECT,
 240                        m_nIndex, (LPARAM)&rcUpdate) == LB_ERR )
 241     {
 242         wxLogDebug(wxT("LB_GETITEMRECT failed"));
 243     }
 244
 245     ::InvalidateRect(hwndListbox, &rcUpdate, FALSE);
 246 }
 247
 248 // send an "item checked" event
 249 void wxCheckListBoxItem::SendEvent()
 250 {
 251     wxCommandEvent event(wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, m_pParent->GetId());
 252     event.SetInt(m_nIndex);
 253     event.SetEventObject(m_pParent);
 254     event.SetString(m_pParent->GetString(m_nIndex));
 255     m_pParent->ProcessCommand(event);
 256 }
 257
 258 // ----------------------------------------------------------------------------
 259 // implementation of wxCheckListBox class
 260 // ----------------------------------------------------------------------------
 261
 262 // define event table
 263 // ------------------
 264 BEGIN_EVENT_TABLE(wxCheckListBox, wxListBox)
 265   EVT_KEY_DOWN(wxCheckListBox::OnKeyDown)
 266   EVT_LEFT_DOWN(wxCheckListBox::OnLeftClick)
 267 END_EVENT_TABLE()
 268
 269 // control creation
 270 // ----------------
 271
 272 // def ctor: use Create() to really create the control
 273 wxCheckListBox::wxCheckListBox()
 274 {
 275 }
 276
 277 // ctor which creates the associated control
 278 wxCheckListBox::wxCheckListBox(wxWindow *parent, wxWindowID id,
 279                                const wxPoint& pos, const wxSize& size,
 280                                int nStrings, const wxString choices[],
 281                                long style, const wxValidator& val,
 282                                const wxString& name)
 283 {
 284     Create(parent, id, pos, size, nStrings, choices, style, val, name);
 285 }
 286
 287 wxCheckListBox::wxCheckListBox(wxWindow *parent, wxWindowID id,
 288                                const wxPoint& pos, const wxSize& size,
 289                                const wxArrayString& choices,
 290                                long style, const wxValidator& val,
 291                                const wxString& name)
 292 {
 293     Create(parent, id, pos, size, choices, style, val, name);
 294 }
 295
 296 bool wxCheckListBox::Create(wxWindow *parent, wxWindowID id,
 297                             const wxPoint& pos, const wxSize& size,
 298                             int n, const wxString choices[],
 299                             long style,
 300                             const wxValidator& validator, const wxString& name)
 301 {
 302     return wxListBox::Create(parent, id, pos, size, n, choices,
 303                              style | wxLB_OWNERDRAW, validator, name);
 304 }
 305
 306 bool wxCheckListBox::Create(wxWindow *parent, wxWindowID id,
 307                             const wxPoint& pos, const wxSize& size,
 308                             const wxArrayString& choices,
 309                             long style,
 310                             const wxValidator& validator, const wxString& name)
 311 {
 312     return wxListBox::Create(parent, id, pos, size, choices,
 313                              style | wxLB_OWNERDRAW, validator, name);
 314 }
 315
 316 // misc overloaded methods
 317 // -----------------------
 318
 319 void wxCheckListBox::Delete(unsigned int n)
 320 {
 321     wxCHECK_RET( IsValid(n),
 322                  wxT("invalid index in wxListBox::Delete") );
 323
 324     wxListBox::Delete(n);
 325
 326     // free memory
 327     delete m_aItems[n];
 328
 329     m_aItems.RemoveAt(n);
 330 }
 331
 332 bool wxCheckListBox::SetFont( const wxFont &font )
 333 {
 334     unsigned int i;
 335     for ( i = 0; i < m_aItems.GetCount(); i++ )
 336         m_aItems[i]->SetFont(font);
 337
 338     wxListBox::SetFont(font);
 339
 340     return true;
 341 }
 342
 343 // create/retrieve item
 344 // --------------------
 345
 346 // create a check list box item
 347 wxOwnerDrawn *wxCheckListBox::CreateLboxItem(size_t nIndex)
 348 {
 349   wxCheckListBoxItem *pItem = new wxCheckListBoxItem(this, nIndex);
 350   return pItem;
 351 }
 352
 353 // return item size
 354 // ----------------
 355 bool wxCheckListBox::MSWOnMeasure(WXMEASUREITEMSTRUCT *item)
 356 {
 357   if ( wxListBox::MSWOnMeasure(item) ) {
 358     MEASUREITEMSTRUCT *pStruct = (MEASUREITEMSTRUCT *)item;
 359
 360     // add place for the check mark
 361     pStruct->itemWidth  += wxOwnerDrawn::GetDefaultMarginWidth();
 362     pStruct->itemHeight += 1;
 363
 364     // save item height
 365     m_nItemHeight = pStruct->itemHeight;
 366
 367     return true;
 368   }
 369
 370   return false;
 371 }
 372
 373 // check items
 374 // -----------
 375
 376 bool wxCheckListBox::IsChecked(unsigned int uiIndex) const
 377 {
 378     wxCHECK_MSG( IsValid(uiIndex), false, _T("bad wxCheckListBox index") );
 379
 380     return GetItem(uiIndex)->IsChecked();
 381 }
 382
 383 void wxCheckListBox::Check(unsigned int uiIndex, bool bCheck)
 384 {
 385     wxCHECK_RET( IsValid(uiIndex), _T("bad wxCheckListBox index") );
 386
 387     GetItem(uiIndex)->Check(bCheck);
 388 }
 389
 390 // process events
 391 // --------------
 392
 393 void wxCheckListBox::OnKeyDown(wxKeyEvent& event)
 394 {
 395     // what do we do?
 396     enum
 397     {
 398         None,
 399         Toggle,
 400         Set,
 401         Clear
 402     } oper;
 403
 404     switch ( event.GetKeyCode() )
 405     {
 406         case WXK_SPACE:
 407             oper = Toggle;
 408             break;
 409
 410         case WXK_NUMPAD_ADD:
 411         case '+':
 412             oper = Set;
 413             break;
 414
 415         case WXK_NUMPAD_SUBTRACT:
 416         case '-':
 417             oper = Clear;
 418             break;
 419
 420         default:
 421             oper = None;
 422     }
 423
 424     if ( oper != None )
 425     {
 426         wxArrayInt selections;
 427         int count = 0;
 428         if ( HasMultipleSelection() )
 429         {
 430             count = GetSelections(selections);
 431         }
 432         else
 433         {
 434             int sel = GetSelection();
 435             if (sel != -1)
 436             {
 437                 count = 1;
 438                 selections.Add(sel);
 439             }
 440         }
 441
 442         for ( int i = 0; i < count; i++ )
 443         {
 444             wxCheckListBoxItem *item = GetItem(selections[i]);
 445             if ( !item )
 446             {
 447                 wxFAIL_MSG( _T("no wxCheckListBoxItem?") );
 448                 continue;
 449             }
 450
 451             switch ( oper )
 452             {
 453                 case Toggle:
 454                     item->Toggle();
 455                     break;
 456
 457                 case Set:
 458                 case Clear:
 459                     item->Check( oper == Set );
 460                     break;
 461
 462                 default:
 463                     wxFAIL_MSG( _T("what should this key do?") );
 464             }
 465
 466             // we should send an event as this has been done by the user and
 467             // not by the program
 468             item->SendEvent();
 469         }
 470     }
 471     else // nothing to do
 472     {
 473         event.Skip();
 474     }
 475 }
 476
 477 void wxCheckListBox::OnLeftClick(wxMouseEvent& event)
 478 {
 479     // clicking on the item selects it, clicking on the checkmark toggles
 480     if ( event.GetX() <= wxOwnerDrawn::GetDefaultMarginWidth() )
 481     {
 482         int nItem = HitTest(event.GetX(), event.GetY());
 483
 484         if ( nItem != wxNOT_FOUND )
 485         {
 486             // people expect to get "kill focus" event for the currently
 487             // focused control before getting events from the other controls
 488             // and, equally importantly, they may prevent the focus change from
 489             // taking place at all (e.g. because the old control contents is
 490             // invalid and needs to be corrected) in which case we shouldn't
 491             // generate this event at all
 492             SetFocus();
 493             if ( FindFocus() == this )
 494             {
 495                 wxCheckListBoxItem *item = GetItem(nItem);
 496                 item->Toggle();
 497                 item->SendEvent();
 498             }
 499         }
 500         //else: it's not an error, just click outside of client zone
 501     }
 502     else
 503     {
 504         // implement default behaviour: clicking on the item selects it
 505         event.Skip();
 506     }
 507 }
 508
 509 int wxCheckListBox::DoHitTestItem(wxCoord x, wxCoord y) const
 510 {
 511     int nItem = (int)::SendMessage
 512                              (
 513                               (HWND)GetHWND(),
 514                               LB_ITEMFROMPOINT,
 515                               0,
 516                               MAKELPARAM(x, y)
 517                              );
 518
 519     return nItem >= (int)m_noItems ? wxNOT_FOUND : nItem;
 520 }
 521
 522
 523 wxSize wxCheckListBox::DoGetBestSize() const
 524 {
 525     wxSize best = wxListBox::DoGetBestSize();
 526     best.x += wxOwnerDrawn::GetDefaultMarginWidth();  // add room for the checkbox
 527     CacheBestSize(best);
 528     return best;
 529 }
 530
 531 #endif