///////////////////////////////////////////////////////////////////////////////
-// Name: msw/checklst.cpp
+// Name: src/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>
-// Licence: wxWindows license
+// Licence: wxWindows licence
///////////////////////////////////////////////////////////////////////////////
// ============================================================================
-// headers & declarations
+// declarations
// ============================================================================
-#ifdef __GNUG__
-#pragma implementation "checklst.h"
-#endif
+// ----------------------------------------------------------------------------
+// headers
+// ----------------------------------------------------------------------------
// For compilers that support precompilation, includes "wx.h".
#include "wx/wxprec.h"
#ifdef __BORLANDC__
-#pragma hdrstop
+ #pragma hdrstop
#endif
-#if USE_OWNER_DRAWN
-
-#include <windows.h>
+#if wxUSE_CHECKLISTBOX && wxUSE_OWNER_DRAWN
+
+#include "wx/checklst.h"
+
+#ifndef WX_PRECOMP
+ #include "wx/msw/wrapwin.h"
+ #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/msw/checklst.h"
+
+#include <windowsx.h>
+
+#include "wx/msw/private.h"
+
+// ----------------------------------------------------------------------------
+// private functions
+// ----------------------------------------------------------------------------
+
+// get item (converted to right type)
+#define GetItem(n) ((wxCheckListBoxItem *)(GetItem(n)))
// ============================================================================
// 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
// ----------------------------------------------------------------------------
class wxCheckListBoxItem : public wxOwnerDrawn
{
+friend class WXDLLEXPORT wxCheckListBox;
public:
- // ctor
- wxCheckListBoxItem(wxCheckListBox *pParent, size_t nIndex);
+ // ctor
+ wxCheckListBoxItem(wxCheckListBox *pParent, size_t nIndex);
+
+ // 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 and operations
+ 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()); }
+
+ void SendEvent();
private:
- bool m_bChecked;
- wxCheckListBox *m_pParent;
- size_t m_nIndex;
+ bool m_bChecked;
+ wxCheckListBox *m_pParent;
+ size_t m_nIndex;
+
+ DECLARE_NO_COPY_CLASS(wxCheckListBoxItem)
};
wxCheckListBoxItem::wxCheckListBoxItem(wxCheckListBox *pParent, size_t nIndex)
- : wxOwnerDrawn("", TRUE) // checkable
+ : wxOwnerDrawn(wxEmptyString, true) // checkable
{
- m_bChecked = FALSE;
- m_pParent = pParent;
- m_nIndex = nIndex;
-
- // we don't initialize m_nCheckHeight/Width vars because it's
- // done in OnMeasure while they are used only in OnDraw and we
- // know that there will always be OnMeasure before OnDraw
-
- // fix appearance
- SetFont(wxSystemSettings::GetSystemFont(wxSYS_ANSI_VAR_FONT));
- SetMarginWidth(GetDefaultMarginWidth());
+ m_bChecked = false;
+ m_pParent = pParent;
+ m_nIndex = nIndex;
+
+ // we don't initialize m_nCheckHeight/Width vars because it's
+ // done in OnMeasure while they are used only in OnDraw and we
+ // know that there will always be OnMeasure before OnDraw
+
+ // fix appearance for check list boxes: they don't look quite the same as
+ // menu icons
+ SetMarginWidth(::GetSystemMetrics(SM_CXMENUCHECK) -
+ 2*wxSystemSettings::GetMetric(wxSYS_EDGE_X) + 1);
+ SetBackgroundColour(pParent->GetBackgroundColour());
}
-/*
- * 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,
+bool wxCheckListBoxItem::OnDrawItem(wxDC& dc, const wxRect& rc,
wxODAction act, wxODStatus stat)
{
- if ( IsChecked() )
- stat = (wxOwnerDrawn::wxODStatus)(stat | wxOwnerDrawn::wxODChecked);
+ // first draw the label
+ if ( IsChecked() )
+ stat = (wxOwnerDrawn::wxODStatus)(stat | wxOwnerDrawn::wxODChecked);
- if ( wxOwnerDrawn::OnDrawItem(dc, rc, act, stat) ) {
- // ## using native API for performance and precision
+ if ( !wxOwnerDrawn::OnDrawItem(dc, rc, act, stat) )
+ return false;
+
+
+ // now draw the check mark part
size_t nCheckWidth = GetDefaultMarginWidth(),
- nCheckHeight = m_pParent->GetItemHeight();
-
- int x = rc.GetX(),
+ nCheckHeight = m_pParent->GetItemHeight();
+
+ int x = rc.GetX(),
y = rc.GetY();
HDC hdc = (HDC)dc.GetHDC();
- // create pens
- HPEN hpenBack = CreatePen(PS_SOLID, 0, GetSysColor(COLOR_WINDOW)),
- hpenGray = CreatePen(PS_SOLID, 0, RGB(128, 128, 128)),
- hpenPrev = SelectObject(hdc, hpenBack);
+ // create pens, brushes &c
+ COLORREF colBg = ::GetSysColor(COLOR_WINDOW);
+ AutoHPEN hpenBack(colBg),
+ hpenGray(RGB(0xc0, 0xc0, 0xc0));
- // we erase the 1-pixel border
- Rectangle(hdc, x, y, x + nCheckWidth, y + nCheckHeight);
-
- // shift check mark 1 pixel to the right (it looks better like this)
- x++;
+ SelectInHDC selPen(hdc, (HGDIOBJ)hpenBack);
+ AutoHBRUSH hbrBack(colBg);
+ SelectInHDC selBrush(hdc, hbrBack);
- if ( IsChecked() ) {
- // 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);
+ // erase the background: it could have been filled with the selected colour
+ Rectangle(hdc, x, y, x + nCheckWidth + 1, rc.GetBottom() + 1);
- // then draw a check mark into it
- RECT rect = { 0, 0, nCheckWidth, nCheckHeight };
+ // shift check mark 1 pixel to the right, looks better like this
+ x++;
-#ifdef __WIN32__
- DrawFrameControl(hdcMem, &rect, DFC_MENU, DFCS_MENUCHECK);
+ if ( IsChecked() )
+ {
+ // first create a monochrome bitmap in a memory DC
+ MemoryHDC hdcMem(hdc);
+ MonoBitmap hbmpCheck(nCheckWidth, nCheckHeight);
+ SelectInHDC selBmp(hdcMem, hbmpCheck);
+
+ // then draw a check mark into it
+ RECT rect = { 0, 0, nCheckWidth, nCheckHeight };
+ ::DrawFrameControl(hdcMem, &rect,
+#ifdef __WXWINCE__
+ DFC_BUTTON, DFCS_BUTTONCHECK
#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);
+ DFC_MENU, DFCS_MENUCHECK
#endif
+ );
- // finally copy it to screen DC and clean up
- BitBlt(hdc, x, y, nCheckWidth - 1, nCheckHeight,
- hdcMem, 0, 0, SRCCOPY);
-
- SelectObject(hdcMem, hbmpOld);
- DeleteObject(hbmpCheck);
- DeleteDC(hdcMem);
+ // finally copy it to screen DC
+ ::BitBlt(hdc, x, y, nCheckWidth, nCheckHeight, hdcMem, 0, 0, SRCCOPY);
}
// now we draw the smaller rectangle
nCheckHeight -= 2;
// draw hollow gray rectangle
- (void)SelectObject(hdc, hpenGray);
- HBRUSH hbrPrev = SelectObject(hdc, GetStockObject(NULL_BRUSH));
+ (void)::SelectObject(hdc, (HGDIOBJ)hpenGray);
+
+ SelectInHDC selBrush2(hdc, ::GetStockObject(NULL_BRUSH));
Rectangle(hdc, x, y, x + nCheckWidth, y + nCheckHeight);
- // clean up
- (void)SelectObject(hdc, hpenPrev);
- (void)SelectObject(hdc, hbrPrev);
+ return true;
+}
+
+// change the state of the item and redraw it
+void wxCheckListBoxItem::Check(bool check)
+{
+ m_bChecked = check;
- DeleteObject(hpenBack);
- DeleteObject(hpenGray);
+ // 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);
- /*
- dc.DrawRectangle(x, y, nCheckWidth, nCheckHeight);
+ wxASSERT_MSG( index != wxNOT_FOUND, wxT("what does this item do here?") );
- if ( IsChecked() ) {
- dc.DrawLine(x, y, x + nCheckWidth, y + nCheckHeight);
- dc.DrawLine(x, y + nCheckHeight, x + nCheckWidth, y);
+ m_nIndex = (size_t)index;
}
- */
- return TRUE;
- }
+ HWND hwndListbox = (HWND)m_pParent->GetHWND();
+
+ RECT rcUpdate;
+
+ if ( ::SendMessage(hwndListbox, LB_GETITEMRECT,
+ m_nIndex, (LPARAM)&rcUpdate) == LB_ERR )
+ {
+ wxLogDebug(wxT("LB_GETITEMRECT failed"));
+ }
- return FALSE;
+ ::InvalidateRect(hwndListbox, &rcUpdate, FALSE);
}
-// 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);
+// 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);
}
// ----------------------------------------------------------------------------
// 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()
// ----------------
// def ctor: use Create() to really create the control
-wxCheckListBox::wxCheckListBox() : wxListBox()
+wxCheckListBox::wxCheckListBox()
{
}
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(unsigned int n)
+{
+ wxCHECK_RET( IsValid(n),
+ 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 )
+{
+ unsigned int 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
-wxOwnerDrawn *wxCheckListBox::CreateItem(size_t nIndex)
+wxOwnerDrawn *wxCheckListBox::CreateLboxItem(size_t nIndex)
{
wxCheckListBoxItem *pItem = new wxCheckListBoxItem(this, nIndex);
- if ( m_windowFont.Ok() )
- pItem->SetFont(m_windowFont);
-
return pItem;
}
-// get item (converted to right type)
-#define GetItem(n) ((wxCheckListBoxItem *)(GetItem(n)))
-
// return item size
// ----------------
bool wxCheckListBox::MSWOnMeasure(WXMEASUREITEMSTRUCT *item)
// add place for the check mark
pStruct->itemWidth += wxOwnerDrawn::GetDefaultMarginWidth();
- return TRUE;
+ return true;
}
- return FALSE;
+ return false;
}
// check items
// -----------
-bool wxCheckListBox::IsChecked(size_t uiIndex) const
+bool wxCheckListBox::IsChecked(unsigned int uiIndex) const
{
- return GetItem(uiIndex)->IsChecked();
+ wxCHECK_MSG( IsValid(uiIndex), false, _T("bad wxCheckListBox index") );
+
+ return GetItem(uiIndex)->IsChecked();
}
-void wxCheckListBox::Check(size_t uiIndex, bool bCheck)
+void wxCheckListBox::Check(unsigned int uiIndex, bool bCheck)
{
- GetItem(uiIndex)->Check(bCheck);
+ wxCHECK_RET( IsValid(uiIndex), _T("bad wxCheckListBox index") );
+
+ GetItem(uiIndex)->Check(bCheck);
}
// 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() ) {
- // # better use LB_ITEMFROMPOINT perhaps?
- size_t nItem = ((size_t)event.GetY()) / m_nItemHeight;
- if ( nItem < (size_t)m_noItems )
- GetItem(nItem)->Toggle();
- //else: it's not an error, just click outside of client zone
- }
- else {
- // implement default behaviour: clicking on the item selects it
- event.Skip();
- }
+ // clicking on the item selects it, clicking on the checkmark toggles
+ if ( event.GetX() <= wxOwnerDrawn::GetDefaultMarginWidth() )
+ {
+ 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
+ {
+ // implement default behaviour: clicking on the item selects it
+ event.Skip();
+ }
}
-#endif
+int wxCheckListBox::DoHitTestItem(wxCoord x, wxCoord y) const
+{
+ int nItem = (int)::SendMessage
+ (
+ (HWND)GetHWND(),
+ LB_ITEMFROMPOINT,
+ 0,
+ MAKELPARAM(x, y)
+ );
+
+ return nItem >= (int)m_noItems ? wxNOT_FOUND : nItem;
+}
+
+wxSize wxCheckListBox::DoGetBestSize() const
+{
+ wxSize best = wxListBox::DoGetBestSize();
+ best.x += wxOwnerDrawn::GetDefaultMarginWidth(); // add room for the checkbox
+ CacheBestSize(best);
+ return best;
+}
+
+#endif