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 license
  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 #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/ownerdrw.h"
  40 #include "wx/settings.h"
  41 #include "wx/dcmemory.h"
  42 #include "wx/msw/checklst.h"
  43
  44 #include <windows.h>
  45 #include <windowsx.h>
  46
  47 #ifdef __GNUWIN32__
  48 #include "wx/msw/gnuwin32/extra.h"
  49 #endif
  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 #if !USE_SHARED_LIBRARY
  63   IMPLEMENT_DYNAMIC_CLASS(wxCheckListBox, wxListBox)
  64 #endif
  65
  66 // ----------------------------------------------------------------------------
  67 // declaration and implementation of wxCheckListBoxItem class
  68 // ----------------------------------------------------------------------------
  69
  70 class wxCheckListBoxItem : public wxOwnerDrawn
  71 {
  72 friend class wxCheckListBox;
  73 public:
  74   // ctor
  75   wxCheckListBoxItem(wxCheckListBox *pParent, size_t nIndex);
  76
  77   // drawing functions
  78   virtual bool OnDrawItem(wxDC& dc, const wxRect& rc, wxODAction act, wxODStatus stat);
  79
  80   // simple accessors
  81   bool IsChecked() const  { return m_bChecked;        }
  82   void Check(bool bCheck);
  83   void Toggle() { Check(!IsChecked()); }
  84
  85 private:
  86   bool            m_bChecked;
  87   wxCheckListBox *m_pParent;
  88   size_t            m_nIndex;
  89 };
  90
  91 wxCheckListBoxItem::wxCheckListBoxItem(wxCheckListBox *pParent, size_t nIndex)
  92                   : wxOwnerDrawn("", TRUE)   // checkable
  93 {
  94   m_bChecked = FALSE;
  95   m_pParent  = pParent;
  96   m_nIndex   = nIndex;
  97
  98   // we don't initialize m_nCheckHeight/Width vars because it's
  99   // done in OnMeasure while they are used only in OnDraw and we
 100   // know that there will always be OnMeasure before OnDraw
 101
 102   // fix appearance
 103   SetFont(wxSystemSettings::GetSystemFont(wxSYS_ANSI_VAR_FONT));
 104   SetMarginWidth(GetDefaultMarginWidth());
 105 }
 106
 107 /*
 108  * JACS - I've got the owner-draw stuff partially working with WIN16,
 109  * with a really horrible-looking cross for wxCheckListBox instead of a
 110  * check - could use a bitmap check-mark instead, defined in wx.rc.
 111  * Also there's a refresh problem whereby it doesn't always draw the
 112  * check until you click to the right of it, which is OK for WIN32.
 113  */
 114
 115 bool wxCheckListBoxItem::OnDrawItem(wxDC& dc, const wxRect& rc,
 116                                     wxODAction act, wxODStatus stat)
 117 {
 118   if ( IsChecked() )
 119     stat = (wxOwnerDrawn::wxODStatus)(stat | wxOwnerDrawn::wxODChecked);
 120
 121   if ( wxOwnerDrawn::OnDrawItem(dc, rc, act, stat) ) {
 122     // ## using native API for performance and precision
 123     size_t nCheckWidth  = GetDefaultMarginWidth(),
 124          nCheckHeight = m_pParent->GetItemHeight();
 125
 126     int x = rc.GetX(),
 127         y = rc.GetY();
 128
 129     HDC hdc = (HDC)dc.GetHDC();
 130
 131     // create pens
 132     HPEN hpenBack = CreatePen(PS_SOLID, 0, GetSysColor(COLOR_WINDOW)),
 133          hpenGray = CreatePen(PS_SOLID, 0, RGB(128, 128, 128)),
 134          hpenPrev = (HPEN)SelectObject(hdc, hpenBack);
 135
 136     // we erase the 1-pixel border
 137     Rectangle(hdc, x, y, x + nCheckWidth, y + nCheckHeight);
 138
 139     // shift check mark 1 pixel to the right (it looks better like this)
 140     x++;
 141
 142     if ( IsChecked() ) {
 143       // first create a monochrome bitmap in a memory DC
 144       HDC hdcMem = CreateCompatibleDC(hdc);
 145       HBITMAP hbmpCheck = CreateBitmap(nCheckWidth, nCheckHeight, 1, 1, 0);
 146       HBITMAP hbmpOld = (HBITMAP)SelectObject(hdcMem, hbmpCheck);
 147
 148       // then draw a check mark into it
 149       RECT rect = { 0, 0, nCheckWidth, nCheckHeight };
 150
 151 #ifdef __WIN32__
 152 #ifndef __SC__
 153       DrawFrameControl(hdcMem, &rect, DFC_MENU, DFCS_MENUCHECK);
 154 #endif
 155 #else
 156       // In WIN16, draw a cross
 157       HPEN blackPen = CreatePen(PS_SOLID, 1, RGB(0, 0, 0));
 158       HPEN whiteBrush = GetStockObject(WHITE_BRUSH);
 159       HPEN hPenOld = ::SelectObject(hdcMem, blackPen);
 160       HPEN hBrushOld = ::SelectObject(hdcMem, whiteBrush);
 161       ::SetROP2(hdcMem, R2_COPYPEN);
 162       Rectangle(hdcMem, 0, 0, nCheckWidth, nCheckHeight);
 163       MoveTo(hdcMem, 0, 0);
 164       LineTo(hdcMem, nCheckWidth, nCheckHeight);
 165       MoveTo(hdcMem, nCheckWidth, 0);
 166       LineTo(hdcMem, 0, nCheckHeight);
 167       ::SelectObject(hdcMem, hPenOld);
 168       ::SelectObject(hdcMem, hBrushOld);
 169       ::DeleteObject(blackPen);
 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 chanegd 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, "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("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 = { 0, y, GetDefaultMarginWidth(), y + nHeight};
 244     #endif  // Win32/16
 245
 246     InvalidateRect(hwndListbox, &rcUpdate, FALSE);
 247
 248     wxCommandEvent event(wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, m_pParent->GetId());
 249     event.SetInt(m_nIndex);
 250     event.SetEventObject(m_pParent);
 251     m_pParent->ProcessCommand(event);
 252 }
 253
 254 // ----------------------------------------------------------------------------
 255 // implementation of wxCheckListBox class
 256 // ----------------------------------------------------------------------------
 257
 258 // define event table
 259 // ------------------
 260 BEGIN_EVENT_TABLE(wxCheckListBox, wxListBox)
 261   EVT_CHAR(wxCheckListBox::OnChar)
 262   EVT_LEFT_DOWN(wxCheckListBox::OnLeftClick)
 263 END_EVENT_TABLE()
 264
 265 // control creation
 266 // ----------------
 267
 268 // def ctor: use Create() to really create the control
 269 wxCheckListBox::wxCheckListBox() : wxListBox()
 270 {
 271 }
 272
 273 // ctor which creates the associated control
 274 wxCheckListBox::wxCheckListBox(wxWindow *parent, wxWindowID id,
 275                                const wxPoint& pos, const wxSize& size,
 276                                int nStrings, const wxString choices[],
 277                                long style, const wxValidator& val,
 278                                const wxString& name)
 279               : wxListBox()
 280 {
 281     Create(parent, id, pos, size, nStrings, choices,
 282            style | wxLB_OWNERDRAW, val, name);
 283 }
 284
 285 void wxCheckListBox::Delete(int N)
 286 {
 287     wxCHECK_RET( N >= 0 && N < m_noItems,
 288                  "invalid index in wxListBox::Delete" );
 289
 290     wxListBox::Delete(N);
 291
 292     // free memory
 293     delete m_aItems[N];
 294
 295     m_aItems.Remove(N);
 296 }
 297
 298 void wxCheckListBox::InsertItems(int nItems, const wxString items[], int pos)
 299 {
 300     wxCHECK_RET( pos >= 0 && pos <= m_noItems,
 301                  "invalid index in wxCheckListBox::InsertItems" );
 302
 303     wxListBox::InsertItems(nItems, items, pos);
 304
 305     int i;
 306     for ( i = 0; i < nItems; i++ ) {
 307         wxOwnerDrawn *pNewItem = CreateItem((size_t)(pos + i));
 308         pNewItem->SetName(items[i]);
 309         m_aItems.Insert(pNewItem, (size_t)(pos + i));
 310         ListBox_SetItemData((HWND)GetHWND(), i + pos, pNewItem);
 311     }
 312 }
 313
 314 // create/retrieve item
 315 // --------------------
 316
 317 // create a check list box item
 318 wxOwnerDrawn *wxCheckListBox::CreateItem(size_t nIndex)
 319 {
 320   wxCheckListBoxItem *pItem = new wxCheckListBoxItem(this, nIndex);
 321   if ( m_windowFont.Ok() )
 322     pItem->SetFont(m_windowFont);
 323
 324   return pItem;
 325 }
 326
 327 // return item size
 328 // ----------------
 329 bool wxCheckListBox::MSWOnMeasure(WXMEASUREITEMSTRUCT *item)
 330 {
 331   if ( wxListBox::MSWOnMeasure(item) ) {
 332     MEASUREITEMSTRUCT *pStruct = (MEASUREITEMSTRUCT *)item;
 333
 334     // save item height
 335     m_nItemHeight = pStruct->itemHeight;
 336
 337     // add place for the check mark
 338     pStruct->itemWidth += wxOwnerDrawn::GetDefaultMarginWidth();
 339
 340     return TRUE;
 341   }
 342
 343   return FALSE;
 344 }
 345
 346 // check items
 347 // -----------
 348
 349 bool wxCheckListBox::IsChecked(size_t uiIndex) const
 350 {
 351   return GetItem(uiIndex)->IsChecked();
 352 }
 353
 354 void wxCheckListBox::Check(size_t uiIndex, bool bCheck)
 355 {
 356   GetItem(uiIndex)->Check(bCheck);
 357 }
 358
 359 // process events
 360 // --------------
 361
 362 void wxCheckListBox::OnChar(wxKeyEvent& event)
 363 {
 364   if ( event.KeyCode() == WXK_SPACE )
 365     GetItem(GetSelection())->Toggle();
 366   else
 367     wxListBox::OnChar(event);
 368 }
 369
 370 void wxCheckListBox::OnLeftClick(wxMouseEvent& event)
 371 {
 372   // clicking on the item selects it, clicking on the checkmark toggles
 373   if ( event.GetX() <= wxOwnerDrawn::GetDefaultMarginWidth() ) {
 374     #ifdef __WIN32__
 375       size_t nItem = (size_t)::SendMessage
 376                                (
 377                                 (HWND)GetHWND(),
 378                                 LB_ITEMFROMPOINT,
 379                                 0,
 380                                 MAKELPARAM(event.GetX(), event.GetY())
 381                                );
 382     #else // Win16
 383         // FIXME this doesn't work when the listbox is scrolled!
 384         size_t nItem = ((size_t)event.GetY()) / m_nItemHeight;
 385     #endif // Win32/16
 386
 387     if ( nItem < (size_t)m_noItems )
 388       GetItem(nItem)->Toggle();
 389     //else: it's not an error, just click outside of client zone
 390   }
 391   else {
 392     // implement default behaviour: clicking on the item selects it
 393     event.Skip();
 394   }
 395 }
 396
 397 #endif
 398