Get the stock label when stock ID is used with empty label in Create()

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

diff --git a/src/msw/checklst.cpp b/src/msw/checklst.cpp
index d42b33424da5d16c5c02eb7643dd88bc99e1ff01..e13cc98cf284de9c01d072e50d39f0aba9001762 100644 (file)
--- a/src/msw/checklst.cpp
+++ b/src/msw/checklst.cpp
@@ -6,14 +6,18 @@
 // 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>

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

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

-// headers & declarations
+// declarations

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

-#ifdef __GNUG__
+// ----------------------------------------------------------------------------
+// headers
+// ----------------------------------------------------------------------------
+
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)

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


@@ -24,19 +28,102 @@
 #pragma hdrstop
 #endif
 
 #pragma hdrstop
 #endif
 

-#if wxUSE_OWNER_DRAWN
+#if wxUSE_CHECKLISTBOX && wxUSE_OWNER_DRAWN
+
+#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 <windows.h>
+    #include "wx/log.h"
+#endif

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

-#include "wx/msw/checklst.h"
+#include "wx/checklst.h"
+
+#include "wx/msw/wrapwin.h"
+#include <windowsx.h>
+
+#include "wx/msw/private.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)
+
+#if wxUSE_EXTENDED_RTTI
+WX_DEFINE_FLAGS( wxCheckListBoxStyle )
+
+wxBEGIN_FLAGS( wxCheckListBoxStyle )
+    // new style border flags, we put them first to
+    // use them for streaming out
+    wxFLAGS_MEMBER(wxBORDER_SIMPLE)
+    wxFLAGS_MEMBER(wxBORDER_SUNKEN)
+    wxFLAGS_MEMBER(wxBORDER_DOUBLE)
+    wxFLAGS_MEMBER(wxBORDER_RAISED)
+    wxFLAGS_MEMBER(wxBORDER_STATIC)
+    wxFLAGS_MEMBER(wxBORDER_NONE)
+
+    // old style border flags
+    wxFLAGS_MEMBER(wxSIMPLE_BORDER)
+    wxFLAGS_MEMBER(wxSUNKEN_BORDER)
+    wxFLAGS_MEMBER(wxDOUBLE_BORDER)
+    wxFLAGS_MEMBER(wxRAISED_BORDER)
+    wxFLAGS_MEMBER(wxSTATIC_BORDER)
+    wxFLAGS_MEMBER(wxBORDER)
+
+    // standard window styles
+    wxFLAGS_MEMBER(wxTAB_TRAVERSAL)
+    wxFLAGS_MEMBER(wxCLIP_CHILDREN)
+    wxFLAGS_MEMBER(wxTRANSPARENT_WINDOW)
+    wxFLAGS_MEMBER(wxWANTS_CHARS)
+    wxFLAGS_MEMBER(wxFULL_REPAINT_ON_RESIZE)
+    wxFLAGS_MEMBER(wxALWAYS_SHOW_SB )
+    wxFLAGS_MEMBER(wxVSCROLL)
+    wxFLAGS_MEMBER(wxHSCROLL)
+
+    wxFLAGS_MEMBER(wxLB_SINGLE)
+    wxFLAGS_MEMBER(wxLB_MULTIPLE)
+    wxFLAGS_MEMBER(wxLB_EXTENDED)
+    wxFLAGS_MEMBER(wxLB_HSCROLL)
+    wxFLAGS_MEMBER(wxLB_ALWAYS_SB)
+    wxFLAGS_MEMBER(wxLB_NEEDED_SB)
+    wxFLAGS_MEMBER(wxLB_SORT)
+    wxFLAGS_MEMBER(wxLB_OWNERDRAW)
+
+wxEND_FLAGS( wxCheckListBoxStyle )
+
+IMPLEMENT_DYNAMIC_CLASS_XTI(wxCheckListBox, wxListBox,"wx/checklst.h")
+
+wxBEGIN_PROPERTIES_TABLE(wxCheckListBox)
+    wxEVENT_PROPERTY( Toggle , wxEVT_COMMAND_CHECKLISTBOX_TOGGLED , wxCommandEvent )
+    wxPROPERTY_FLAGS( WindowStyle , wxCheckListBoxStyle , long , SetWindowStyleFlag , GetWindowStyleFlag , EMPTY_MACROVALUE , wxLB_OWNERDRAW /*flags*/ , wxT("Helpstring") , wxT("group")) // style
+wxEND_PROPERTIES_TABLE()
+
+wxBEGIN_HANDLERS_TABLE(wxCheckListBox)
+wxEND_HANDLERS_TABLE()
+
+wxCONSTRUCTOR_4( wxCheckListBox , wxWindow* , Parent , wxWindowID , Id , wxPoint , Position , wxSize , Size )
+
+#else
+IMPLEMENT_DYNAMIC_CLASS(wxCheckListBox, wxListBox)

 #endif
 
 // ----------------------------------------------------------------------------
 #endif
 
 // ----------------------------------------------------------------------------


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

+friend class WXDLLEXPORT wxCheckListBox;

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


@@ -52,21 +140,26 @@ public:
   // drawing functions
   virtual bool OnDrawItem(wxDC& dc, const wxRect& rc, wxODAction act, wxODStatus stat);
 
   // drawing functions
   virtual bool OnDrawItem(wxDC& dc, const wxRect& rc, wxODAction act, wxODStatus stat);
 

-  // simple accessors
-  bool IsChecked() const  { return m_bChecked;        }
-  void Check(bool bCheck) { m_bChecked = bCheck;      }
-  void Toggle();
+  // simple accessors and operations
+  bool IsChecked() const { return m_bChecked; }
+
+  void Check(bool bCheck);
+  void Toggle() { Check(!IsChecked()); }
+
+  void SendEvent();

 
 private:
 
 private:

+
+    DECLARE_NO_COPY_CLASS(wxCheckListBoxItem)

   bool            m_bChecked;
   wxCheckListBox *m_pParent;
   bool            m_bChecked;
   wxCheckListBox *m_pParent;

-  size_t            m_nIndex;
+  size_t          m_nIndex;

 };
 
 wxCheckListBoxItem::wxCheckListBoxItem(wxCheckListBox *pParent, size_t nIndex)
 };
 
 wxCheckListBoxItem::wxCheckListBoxItem(wxCheckListBox *pParent, size_t nIndex)

-                  : wxOwnerDrawn("", TRUE)   // checkable
+                  : wxOwnerDrawn(wxEmptyString, true)   // checkable

 {
 {

-  m_bChecked = FALSE;
+  m_bChecked = false;

   m_pParent  = pParent;
   m_nIndex   = nIndex;
 
   m_pParent  = pParent;
   m_nIndex   = nIndex;
 


@@ -75,18 +168,9 @@ 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());
 }
 

-/*
- * JACS - I've got the owner-draw stuff partially working with WIN16,
- * with a really horrible-looking cross for wxCheckListBox instead of a
- * check - could use a bitmap check-mark instead, defined in wx.rc.
- * Also there's a refresh problem whereby it doesn't always draw the
- * check until you click to the right of it, which is OK for WIN32.
- */
-

 bool wxCheckListBoxItem::OnDrawItem(wxDC& dc, const wxRect& rc,
                                     wxODAction act, wxODStatus stat)
 {
 bool wxCheckListBoxItem::OnDrawItem(wxDC& dc, const wxRect& rc,
                                     wxODAction act, wxODStatus stat)
 {


@@ -121,25 +205,17 @@ bool wxCheckListBoxItem::OnDrawItem(wxDC& dc, const wxRect& rc,
       HBITMAP hbmpOld = (HBITMAP)SelectObject(hdcMem, hbmpCheck);
 
       // then draw a check mark into it
       HBITMAP hbmpOld = (HBITMAP)SelectObject(hdcMem, hbmpCheck);
 
       // then draw a check mark into it

-      RECT rect = { 0, 0, nCheckWidth, nCheckHeight };

 
 

-#ifdef __WIN32__
-      DrawFrameControl(hdcMem, &rect, DFC_MENU, DFCS_MENUCHECK);
+      RECT rect;
+      rect.left   = 0;
+      rect.top    = 0;
+      rect.right  = nCheckWidth;
+      rect.bottom = nCheckHeight;
+
+#ifdef __WXWINCE__
+      DrawFrameControl(hdcMem, &rect, DFC_BUTTON, DFCS_BUTTONCHECK);

 #else
 #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);
-      ::SetROP2(hdcMem, R2_COPYPEN);
-      Rectangle(hdcMem, 0, 0, nCheckWidth, nCheckHeight);
-      MoveTo(hdcMem, 0, 0);
-      LineTo(hdcMem, nCheckWidth, nCheckHeight);
-      MoveTo(hdcMem, nCheckWidth, 0);
-      LineTo(hdcMem, 0, nCheckHeight);
-      ::SelectObject(hdcMem, hPenOld);
-      ::SelectObject(hdcMem, hBrushOld);
-      ::DeleteObject(blackPen);
+      DrawFrameControl(hdcMem, &rect, DFC_MENU, DFCS_MENUCHECK);

 #endif
 
       // finally copy it to screen DC and clean up
 #endif
 
       // finally copy it to screen DC and clean up


@@ -177,26 +253,48 @@ bool wxCheckListBoxItem::OnDrawItem(wxDC& dc, const wxRect& rc,
     }
     */
 
     }
     */
 

-    return TRUE;
+    return true;

   }
 
   }
 

-  return FALSE;
+  return false;

 }
 
 // change the state of the item and redraw it
 }
 
 // change the state of the item and redraw it

-void wxCheckListBoxItem::Toggle()
+void wxCheckListBoxItem::Check(bool check)

 {
 {

-  m_bChecked = !m_bChecked;
+    m_bChecked = check;
+
+    // index may be changed 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;
+    }

 
 

-  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);
+    HWND hwndListbox = (HWND)m_pParent->GetHWND();

 
 

-  wxCommandEvent event(wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, m_pParent->GetId());
-  event.SetInt(m_nIndex);
-  event.SetEventObject(m_pParent);
-  m_pParent->ProcessCommand(event);
+    RECT rcUpdate;
+
+    if ( ::SendMessage(hwndListbox, LB_GETITEMRECT,
+                       m_nIndex, (LPARAM)&rcUpdate) == LB_ERR )
+    {
+        wxLogDebug(wxT("LB_GETITEMRECT failed"));
+    }
+
+    ::InvalidateRect(hwndListbox, &rcUpdate, FALSE);
+}
+
+// send an "item checked" event
+void wxCheckListBoxItem::SendEvent()
+{
+    wxCommandEvent event(wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, m_pParent->GetId());
+    event.SetInt(m_nIndex);
+    event.SetEventObject(m_pParent);
+    m_pParent->ProcessCommand(event);

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


@@ -206,7 +304,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 +312,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,31 +321,77 @@ 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);
+    Create(parent, id, pos, size, nStrings, choices, style, val, name);
+}
+
+wxCheckListBox::wxCheckListBox(wxWindow *parent, wxWindowID id,
+                               const wxPoint& pos, const wxSize& size,
+                               const wxArrayString& choices,
+                               long style, const wxValidator& val,
+                               const wxString& name)
+{
+    Create(parent, id, pos, size, choices, style, val, name);
+}
+
+bool wxCheckListBox::Create(wxWindow *parent, wxWindowID id,
+                            const wxPoint& pos, const wxSize& size,
+                            int n, const wxString choices[],
+                            long style,
+                            const wxValidator& validator, const wxString& name)
+{
+    return wxListBox::Create(parent, id, pos, size, n, choices,
+                             style | wxLB_OWNERDRAW, validator, name);
+}
+
+bool wxCheckListBox::Create(wxWindow *parent, wxWindowID id,
+                            const wxPoint& pos, const wxSize& size,
+                            const wxArrayString& choices,
+                            long style,
+                            const wxValidator& validator, const wxString& name)
+{
+    return wxListBox::Create(parent, id, pos, size, choices,
+                             style | wxLB_OWNERDRAW, validator, name);
+}
+
+// misc overloaded methods
+// -----------------------
+
+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 )
+{
+    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 a check list box item
 }
 
 // create/retrieve item
 // --------------------
 
 // create a check list box item

-wxOwnerDrawn *wxCheckListBox::CreateItem(size_t nIndex)
+wxOwnerDrawn *wxCheckListBox::CreateLboxItem(size_t nIndex)

 {
   wxCheckListBoxItem *pItem = new wxCheckListBoxItem(this, 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)


@@ -261,10 +405,10 @@ bool wxCheckListBox::MSWOnMeasure(WXMEASUREITEMSTRUCT *item)
     // add place for the check mark
     pStruct->itemWidth += wxOwnerDrawn::GetDefaultMarginWidth();
 
     // add place for the check mark
     pStruct->itemWidth += wxOwnerDrawn::GetDefaultMarginWidth();
 

-    return TRUE;
+    return true;

   }
 
   }
 

-  return FALSE;
+  return false;

 }
 
 // check items
 }
 
 // check items


@@ -272,33 +416,116 @@ 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.GetKeyCode() )
+    {
+        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 = 0;
+        if ( HasMultipleSelection() )
+        {
+            count = GetSelections(selections);
+        }
+        else
+        {
+            int sel = GetSelection();
+            if (sel != -1)
+            {
+                count = 1;
+                selections.Add(sel);
+            }
+        }
+
+        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?") );
+            }
+
+            // we should send an event as this has been done by the user and
+            // not by the program
+            item->SendEvent();
+        }
+    }
+    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;
-    if ( nItem < (size_t)m_noItems )
-      GetItem(nItem)->Toggle();
+    int nItem = HitTest(event.GetX(), event.GetY());
+
+    if ( nItem != wxNOT_FOUND ) {
+      wxCheckListBoxItem *item = GetItem(nItem);
+      item->Toggle();
+      item->SendEvent();
+    }

     //else: it's not an error, just click outside of client zone
   }
   else {
     //else: it's not an error, just click outside of client zone
   }
   else {


@@ -307,5 +534,26 @@ void wxCheckListBox::OnLeftClick(wxMouseEvent& event)
   }
 }
 
   }
 }
 

+int wxCheckListBox::DoHitTestItem(wxCoord x, wxCoord y) const
+{
+    int nItem = (int)::SendMessage
+                             (
+                              (HWND)GetHWND(),
+                              LB_ITEMFROMPOINT,
+                              0,
+                              MAKELPARAM(x, y)
+                             );
+
+  return nItem >= m_noItems ? wxNOT_FOUND : nItem;
+}
+
+
+wxSize wxCheckListBox::DoGetBestSize() const
+{
+    wxSize best = wxListBox::DoGetBestSize();
+    best.x += wxOwnerDrawn::GetDefaultMarginWidth();  // add room for the checkbox
+    return best;
+}
+

 #endif
 
 #endif