added a comment about the default button handling

[wxWidgets.git] / src / msw / checklst.cpp

diff --git a/src/msw/checklst.cpp b/src/msw/checklst.cpp
index f0c2c0ee23dae6a96b757d5f844121276b959ccf..5aa72dd1e4196b5d723af61420746e4ef1f5ec7f 100644 (file)
--- a/src/msw/checklst.cpp
+++ b/src/msw/checklst.cpp
@@ -2,7 +2,7 @@
 // Name:        msw/checklst.cpp
 // Purpose:     implementation of wxCheckListBox class
 // Author:      Vadim Zeitlin
 // Name:        msw/checklst.cpp
 // Purpose:     implementation of wxCheckListBox class
 // Author:      Vadim Zeitlin

-// Modified by: 
+// Modified by:

 // Created:     16.11.97
 // RCS-ID:      $Id$
 // Copyright:   (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
 // Created:     16.11.97
 // RCS-ID:      $Id$
 // Copyright:   (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>


@@ -10,9 +10,13 @@
 ///////////////////////////////////////////////////////////////////////////////
 
 // ============================================================================
 ///////////////////////////////////////////////////////////////////////////////
 
 // ============================================================================

-// headers & declarations
+// declarations

 // ============================================================================
 
 // ============================================================================
 

+// ----------------------------------------------------------------------------
+// headers
+// ----------------------------------------------------------------------------
+

 #ifdef __GNUG__
 #pragma implementation "checklst.h"
 #endif
 #ifdef __GNUG__
 #pragma implementation "checklst.h"
 #endif


@@ -24,20 +28,44 @@
 #pragma hdrstop
 #endif
 
 #pragma hdrstop
 #endif
 

-#if USE_OWNER_DRAWN
+#if wxUSE_OWNER_DRAWN

 
 

-#include <windows.h>
+#ifndef WX_PRECOMP
+    #include "wx/object.h"
+    #include "wx/colour.h"
+    #include "wx/font.h"
+    #include "wx/bitmap.h"
+    #include "wx/window.h"
+    #include "wx/listbox.h"
+    #include "wx/dcmemory.h"
+
+    #include "wx/settings.h"
+
+    #include "wx/log.h"
+#endif

 
 #include "wx/ownerdrw.h"
 
 #include "wx/ownerdrw.h"

-#include "wx/msw/checklst.h"
+#include "wx/checklst.h"
+
+#include <windows.h>
+#include <windowsx.h>
+
+#if defined(__GNUWIN32_OLD__)
+    #include "wx/msw/gnuwin32/extra.h"
+#endif
+
+// ----------------------------------------------------------------------------
+// private functions
+// ----------------------------------------------------------------------------
+
+// get item (converted to right type)
+#define GetItem(n)    ((wxCheckListBoxItem *)(GetItem(n)))

 
 // ============================================================================
 // implementation
 // ============================================================================
 
 
 // ============================================================================
 // implementation
 // ============================================================================
 

-#if !USE_SHARED_LIBRARY
-  IMPLEMENT_DYNAMIC_CLASS(wxCheckListBox, wxListBox)
-#endif
+IMPLEMENT_DYNAMIC_CLASS(wxCheckListBox, wxListBox)

 
 // ----------------------------------------------------------------------------
 // declaration and implementation of wxCheckListBoxItem class
 
 // ----------------------------------------------------------------------------
 // declaration and implementation of wxCheckListBoxItem class


@@ -45,6 +73,7 @@
 
 class wxCheckListBoxItem : public wxOwnerDrawn
 {
 
 class wxCheckListBoxItem : public wxOwnerDrawn
 {

+friend class wxCheckListBox;

 public:
   // ctor
   wxCheckListBoxItem(wxCheckListBox *pParent, size_t nIndex);
 public:
   // ctor
   wxCheckListBoxItem(wxCheckListBox *pParent, size_t nIndex);


@@ -54,8 +83,8 @@ public:
 
   // simple accessors
   bool IsChecked() const  { return m_bChecked;        }
 
   // simple accessors
   bool IsChecked() const  { return m_bChecked;        }

-  void Check(bool bCheck) { m_bChecked = bCheck;      }
-  void Toggle();
+  void Check(bool bCheck);
+  void Toggle() { Check(!IsChecked()); }

 
 private:
   bool            m_bChecked;
 
 private:
   bool            m_bChecked;


@@ -75,7 +104,6 @@ wxCheckListBoxItem::wxCheckListBoxItem(wxCheckListBox *pParent, size_t nIndex)
   // know that there will always be OnMeasure before OnDraw
 
   // fix appearance
   // know that there will always be OnMeasure before OnDraw
 
   // fix appearance

-  SetFont(wxSystemSettings::GetSystemFont(wxSYS_ANSI_VAR_FONT));

   SetMarginWidth(GetDefaultMarginWidth());
 }
 
   SetMarginWidth(GetDefaultMarginWidth());
 }
 


@@ -87,7 +115,7 @@ wxCheckListBoxItem::wxCheckListBoxItem(wxCheckListBox *pParent, size_t nIndex)
  * check until you click to the right of it, which is OK for WIN32.
  */
 
  * check until you click to the right of it, which is OK for WIN32.
  */
 

-bool wxCheckListBoxItem::OnDrawItem(wxDC& dc, const wxRect& rc, 
+bool wxCheckListBoxItem::OnDrawItem(wxDC& dc, const wxRect& rc,

                                     wxODAction act, wxODStatus stat)
 {
   if ( IsChecked() )
                                     wxODAction act, wxODStatus stat)
 {
   if ( IsChecked() )


@@ -97,8 +125,8 @@ bool wxCheckListBoxItem::OnDrawItem(wxDC& dc, const wxRect& rc,
     // ## using native API for performance and precision
     size_t nCheckWidth  = GetDefaultMarginWidth(),
          nCheckHeight = m_pParent->GetItemHeight();
     // ## using native API for performance and precision
     size_t nCheckWidth  = GetDefaultMarginWidth(),
          nCheckHeight = m_pParent->GetItemHeight();

-          
-    int x = rc.GetX(), 
+
+    int x = rc.GetX(),

         y = rc.GetY();
 
     HDC hdc = (HDC)dc.GetHDC();
         y = rc.GetY();
 
     HDC hdc = (HDC)dc.GetHDC();


@@ -106,7 +134,7 @@ bool wxCheckListBoxItem::OnDrawItem(wxDC& dc, const wxRect& rc,
     // create pens
     HPEN hpenBack = CreatePen(PS_SOLID, 0, GetSysColor(COLOR_WINDOW)),
          hpenGray = CreatePen(PS_SOLID, 0, RGB(128, 128, 128)),
     // create pens
     HPEN hpenBack = CreatePen(PS_SOLID, 0, GetSysColor(COLOR_WINDOW)),
          hpenGray = CreatePen(PS_SOLID, 0, RGB(128, 128, 128)),

-         hpenPrev = SelectObject(hdc, hpenBack);
+         hpenPrev = (HPEN)SelectObject(hdc, hpenBack);

 
     // we erase the 1-pixel border
     Rectangle(hdc, x, y, x + nCheckWidth, y + nCheckHeight);
 
     // we erase the 1-pixel border
     Rectangle(hdc, x, y, x + nCheckWidth, y + nCheckHeight);


@@ -118,19 +146,23 @@ bool wxCheckListBoxItem::OnDrawItem(wxDC& dc, const wxRect& rc,
       // first create a monochrome bitmap in a memory DC
       HDC hdcMem = CreateCompatibleDC(hdc);
       HBITMAP hbmpCheck = CreateBitmap(nCheckWidth, nCheckHeight, 1, 1, 0);
       // first create a monochrome bitmap in a memory DC
       HDC hdcMem = CreateCompatibleDC(hdc);
       HBITMAP hbmpCheck = CreateBitmap(nCheckWidth, nCheckHeight, 1, 1, 0);

-      HBITMAP hbmpOld = SelectObject(hdcMem, hbmpCheck);
+      HBITMAP hbmpOld = (HBITMAP)SelectObject(hdcMem, hbmpCheck);

 
       // then draw a check mark into it
 
       // then draw a check mark into it

-      RECT rect = { 0, 0, nCheckWidth, nCheckHeight };
+#if defined(__WIN32__) && !defined(__SC__)
+      RECT rect;
+      rect.left   = 0;
+      rect.top    = 0;
+      rect.right  = nCheckWidth;
+      rect.bottom = nCheckHeight;

 
 

-#ifdef __WIN32__

       DrawFrameControl(hdcMem, &rect, DFC_MENU, DFCS_MENUCHECK);
 #else
       // In WIN16, draw a cross
       HPEN blackPen = CreatePen(PS_SOLID, 1, RGB(0, 0, 0));
       DrawFrameControl(hdcMem, &rect, DFC_MENU, DFCS_MENUCHECK);
 #else
       // In WIN16, draw a cross
       HPEN blackPen = CreatePen(PS_SOLID, 1, RGB(0, 0, 0));

-      HPEN whiteBrush = GetStockObject(WHITE_BRUSH);
-      HPEN hPenOld = ::SelectObject(hdcMem, blackPen);
-      HPEN hBrushOld = ::SelectObject(hdcMem, whiteBrush);
+      HPEN whiteBrush = (HPEN)GetStockObject(WHITE_BRUSH);
+      HPEN hPenOld = (HPEN)::SelectObject(hdcMem, blackPen);
+      HPEN hBrushOld = (HPEN)::SelectObject(hdcMem, whiteBrush);

       ::SetROP2(hdcMem, R2_COPYPEN);
       Rectangle(hdcMem, 0, 0, nCheckWidth, nCheckHeight);
       MoveTo(hdcMem, 0, 0);
       ::SetROP2(hdcMem, R2_COPYPEN);
       Rectangle(hdcMem, 0, 0, nCheckWidth, nCheckHeight);
       MoveTo(hdcMem, 0, 0);


@@ -143,7 +175,7 @@ bool wxCheckListBoxItem::OnDrawItem(wxDC& dc, const wxRect& rc,
 #endif
 
       // finally copy it to screen DC and clean up
 #endif
 
       // finally copy it to screen DC and clean up

-      BitBlt(hdc, x, y, nCheckWidth - 1, nCheckHeight, 
+      BitBlt(hdc, x, y, nCheckWidth - 1, nCheckHeight,

              hdcMem, 0, 0, SRCCOPY);
 
       SelectObject(hdcMem, hbmpOld);
              hdcMem, 0, 0, SRCCOPY);
 
       SelectObject(hdcMem, hbmpOld);


@@ -158,7 +190,7 @@ bool wxCheckListBoxItem::OnDrawItem(wxDC& dc, const wxRect& rc,
 
     // draw hollow gray rectangle
     (void)SelectObject(hdc, hpenGray);
 
     // draw hollow gray rectangle
     (void)SelectObject(hdc, hpenGray);

-    HBRUSH hbrPrev  = SelectObject(hdc, GetStockObject(NULL_BRUSH));
+    HBRUSH hbrPrev  = (HBRUSH)SelectObject(hdc, GetStockObject(NULL_BRUSH));

     Rectangle(hdc, x, y, x + nCheckWidth, y + nCheckHeight);
 
     // clean up
     Rectangle(hdc, x, y, x + nCheckWidth, y + nCheckHeight);
 
     // clean up


@@ -184,19 +216,48 @@ bool wxCheckListBoxItem::OnDrawItem(wxDC& dc, const wxRect& rc,
 }
 
 // change the state of the item and redraw it
 }
 
 // change the state of the item and redraw it

-void wxCheckListBoxItem::Toggle()
-{ 
-  m_bChecked = !m_bChecked;
-
-  size_t nHeight = m_pParent->GetItemHeight();
-  size_t y = m_nIndex * nHeight;
-  RECT rcUpdate = { 0, y, GetDefaultMarginWidth(), y + nHeight};
-  InvalidateRect((HWND)m_pParent->GetHWND(), &rcUpdate, FALSE);
-
-  wxCommandEvent event(wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, m_pParent->GetId());
-  event.SetInt(m_nIndex);
-  event.SetEventObject(m_pParent);
-  m_pParent->ProcessCommand(event);
+void wxCheckListBoxItem::Check(bool check)
+{
+    m_bChecked = check;
+
+    // index may be chanegd because new items were added/deleted
+    if ( m_pParent->GetItemIndex(this) != (int)m_nIndex )
+    {
+        // update it
+        int index = m_pParent->GetItemIndex(this);
+
+        wxASSERT_MSG( index != wxNOT_FOUND, wxT("what does this item do here?") );
+
+        m_nIndex = (size_t)index;
+    }
+
+    HWND hwndListbox = (HWND)m_pParent->GetHWND();
+
+    #ifdef __WIN32__
+        RECT rcUpdate;
+
+        if ( ::SendMessage(hwndListbox, LB_GETITEMRECT,
+                           m_nIndex, (LPARAM)&rcUpdate) == LB_ERR )
+        {
+            wxLogDebug(wxT("LB_GETITEMRECT failed"));
+        }
+    #else // Win16
+        // FIXME this doesn't work if the listbox is scrolled!
+        size_t nHeight = m_pParent->GetItemHeight();
+        size_t y = m_nIndex * nHeight;
+        RECT rcUpdate ;
+        rcUpdate.left   = 0 ;
+        rcUpdate.top    = y ;
+        rcUpdate.right  = GetDefaultMarginWidth() ;
+        rcUpdate.bottom = y + nHeight ;
+    #endif  // Win32/16
+
+    InvalidateRect(hwndListbox, &rcUpdate, FALSE);
+
+    wxCommandEvent event(wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, m_pParent->GetId());
+    event.SetInt(m_nIndex);
+    event.SetEventObject(m_pParent);
+    m_pParent->ProcessCommand(event);

 }
 
 // ----------------------------------------------------------------------------
 }
 
 // ----------------------------------------------------------------------------


@@ -206,7 +267,7 @@ void wxCheckListBoxItem::Toggle()
 // define event table
 // ------------------
 BEGIN_EVENT_TABLE(wxCheckListBox, wxListBox)
 // define event table
 // ------------------
 BEGIN_EVENT_TABLE(wxCheckListBox, wxListBox)

-  EVT_CHAR(wxCheckListBox::OnChar)
+  EVT_KEY_DOWN(wxCheckListBox::OnKeyDown)

   EVT_LEFT_DOWN(wxCheckListBox::OnLeftClick)
 END_EVENT_TABLE()
 
   EVT_LEFT_DOWN(wxCheckListBox::OnLeftClick)
 END_EVENT_TABLE()
 


@@ -214,7 +275,7 @@ END_EVENT_TABLE()
 // ----------------
 
 // def ctor: use Create() to really create the control
 // ----------------
 
 // def ctor: use Create() to really create the control

-wxCheckListBox::wxCheckListBox() : wxListBox()
+wxCheckListBox::wxCheckListBox()

 {
 }
 
 {
 }
 


@@ -223,13 +284,34 @@ wxCheckListBox::wxCheckListBox(wxWindow *parent, wxWindowID id,
                                const wxPoint& pos, const wxSize& size,
                                int nStrings, const wxString choices[],
                                long style, const wxValidator& val,
                                const wxPoint& pos, const wxSize& size,
                                int nStrings, const wxString choices[],
                                long style, const wxValidator& val,

-                               const wxString& name) // , const wxFont& font)
-                // don't use ctor with arguments! we must call Create()
-                // ourselves from here.
-              : wxListBox()
-//                , m_font(font)
+                               const wxString& name)
+{
+    Create(parent, id, pos, size, nStrings, choices,
+           style | wxLB_OWNERDRAW, val, name);
+}
+
+void wxCheckListBox::Delete(int N)
+{
+    wxCHECK_RET( N >= 0 && N < m_noItems,
+                 wxT("invalid index in wxListBox::Delete") );
+
+    wxListBox::Delete(N);
+
+    // free memory
+    delete m_aItems[N];
+
+    m_aItems.RemoveAt(N);
+}
+
+bool wxCheckListBox::SetFont( const wxFont &font )

 {
 {

-  Create(parent, id, pos, size, nStrings, choices, style|wxLB_OWNERDRAW, val, name);
+    size_t i;
+    for ( i = 0; i < m_aItems.GetCount(); i++ )
+        m_aItems[i]->SetFont(font);
+
+    wxListBox::SetFont(font);
+
+    return TRUE;

 }
 
 // create/retrieve item
 }
 
 // create/retrieve item


@@ -239,15 +321,9 @@ wxCheckListBox::wxCheckListBox(wxWindow *parent, wxWindowID id,
 wxOwnerDrawn *wxCheckListBox::CreateItem(size_t nIndex)
 {
   wxCheckListBoxItem *pItem = new wxCheckListBoxItem(this, nIndex);
 wxOwnerDrawn *wxCheckListBox::CreateItem(size_t nIndex)
 {
   wxCheckListBoxItem *pItem = new wxCheckListBoxItem(this, nIndex);

-  if ( m_windowFont.Ok() )
-    pItem->SetFont(m_windowFont);
-

   return pItem;
 }
 
   return pItem;
 }
 

-// get item (converted to right type)
-#define GetItem(n)    ((wxCheckListBoxItem *)(GetItem(n)))
-

 // return item size
 // ----------------
 bool wxCheckListBox::MSWOnMeasure(WXMEASUREITEMSTRUCT *item)
 // return item size
 // ----------------
 bool wxCheckListBox::MSWOnMeasure(WXMEASUREITEMSTRUCT *item)


@@ -272,31 +348,114 @@ bool wxCheckListBox::MSWOnMeasure(WXMEASUREITEMSTRUCT *item)
 
 bool wxCheckListBox::IsChecked(size_t uiIndex) const
 {
 
 bool wxCheckListBox::IsChecked(size_t uiIndex) const
 {

-  return GetItem(uiIndex)->IsChecked();
+    wxCHECK_MSG( uiIndex < (size_t)GetCount(), FALSE, _T("bad wxCheckListBox index") );
+
+    return GetItem(uiIndex)->IsChecked();

 }
 
 void wxCheckListBox::Check(size_t uiIndex, bool bCheck)
 {
 }
 
 void wxCheckListBox::Check(size_t uiIndex, bool bCheck)
 {

-  GetItem(uiIndex)->Check(bCheck);
+    wxCHECK_RET( uiIndex < (size_t)GetCount(), _T("bad wxCheckListBox index") );
+
+    GetItem(uiIndex)->Check(bCheck);

 }
 
 // process events
 // --------------
 
 }
 
 // process events
 // --------------
 

-void wxCheckListBox::OnChar(wxKeyEvent& event)
+void wxCheckListBox::OnKeyDown(wxKeyEvent& event)

 {
 {

-  if ( event.KeyCode() == WXK_SPACE )
-    GetItem(GetSelection())->Toggle();
-  else
-    wxListBox::OnChar(event);
+    // what do we do?
+    enum
+    {
+        None,
+        Toggle,
+        Set,
+        Clear
+    } oper;
+
+    switch ( event.KeyCode() )
+    {
+        case WXK_SPACE:
+            oper = Toggle;
+            break;
+
+        case WXK_NUMPAD_ADD:
+        case '+':
+            oper = Set;
+            break;
+
+        case WXK_NUMPAD_SUBTRACT:
+        case '-':
+            oper = Clear;
+            break;
+
+        default:
+            oper = None;
+    }
+
+    if ( oper != None )
+    {
+        wxArrayInt selections;
+        int count;
+        if ( HasMultipleSelection() )
+        {
+            count = GetSelections(selections);
+        }
+        else
+        {
+            count = 1;
+            selections.Add(GetSelection());
+        }
+
+        for ( int i = 0; i < count; i++ )
+        {
+            wxCheckListBoxItem *item = GetItem(selections[i]);
+            if ( !item )
+            {
+                wxFAIL_MSG( _T("no wxCheckListBoxItem?") );
+                continue;
+            }
+
+            switch ( oper )
+            {
+                case Toggle:
+                    item->Toggle();
+                    break;
+
+                case Set:
+                case Clear:
+                    item->Check( oper == Set );
+                    break;
+
+                default:
+                    wxFAIL_MSG( _T("what should this key do?") );
+            }
+        }
+    }
+    else // nothing to do
+    {
+        event.Skip();
+    }

 }
 
 void wxCheckListBox::OnLeftClick(wxMouseEvent& event)
 {
   // clicking on the item selects it, clicking on the checkmark toggles
   if ( event.GetX() <= wxOwnerDrawn::GetDefaultMarginWidth() ) {
 }
 
 void wxCheckListBox::OnLeftClick(wxMouseEvent& event)
 {
   // clicking on the item selects it, clicking on the checkmark toggles
   if ( event.GetX() <= wxOwnerDrawn::GetDefaultMarginWidth() ) {

-    // # better use LB_ITEMFROMPOINT perhaps?
-    size_t nItem = ((size_t)event.GetY()) / m_nItemHeight;
+    #ifdef __WIN32__
+      size_t nItem = (size_t)::SendMessage
+                               (
+                                (HWND)GetHWND(),
+                                LB_ITEMFROMPOINT,
+                                0,
+                                MAKELPARAM(event.GetX(), event.GetY())
+                               );
+    #else // Win16
+        // FIXME this doesn't work when the listbox is scrolled!
+        size_t nItem = ((size_t)event.GetY()) / m_nItemHeight;
+    #endif // Win32/16
+

     if ( nItem < (size_t)m_noItems )
       GetItem(nItem)->Toggle();
     //else: it's not an error, just click outside of client zone
     if ( nItem < (size_t)m_noItems )
       GetItem(nItem)->Toggle();
     //else: it's not an error, just click outside of client zone