]>
Commit | Line | Data |
---|---|---|
1 | /////////////////////////////////////////////////////////////////////////////// | |
2 | // Name: checklst.h | |
3 | // Purpose: wxCheckListBox class - a listbox with checkable items | |
4 | // Author: William Osborne | |
5 | // Modified by: | |
6 | // Created: 10/13/04 | |
7 | // RCS-ID: $Id: | |
8 | // Copyright: (c) William Osborne | |
9 | // Licence: wxWindows licence | |
10 | /////////////////////////////////////////////////////////////////////////////// | |
11 | ||
12 | #ifndef __CHECKLST__H_ | |
13 | #define __CHECKLST__H_ | |
14 | ||
15 | #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) | |
16 | #pragma interface "checklst.h" | |
17 | #endif | |
18 | ||
19 | #if !wxUSE_OWNER_DRAWN | |
20 | #error "wxCheckListBox class requires owner-drawn functionality." | |
21 | #endif | |
22 | ||
23 | class WXDLLEXPORT wxOwnerDrawn; | |
24 | class WXDLLEXPORT wxCheckListBoxItem; // fwd decl, defined in checklst.cpp | |
25 | ||
26 | class WXDLLEXPORT wxCheckListBox : public wxCheckListBoxBase | |
27 | { | |
28 | public: | |
29 | // ctors | |
30 | wxCheckListBox(); | |
31 | wxCheckListBox(wxWindow *parent, wxWindowID id, | |
32 | const wxPoint& pos = wxDefaultPosition, | |
33 | const wxSize& size = wxDefaultSize, | |
34 | int nStrings = 0, | |
35 | const wxString choices[] = NULL, | |
36 | long style = 0, | |
37 | const wxValidator& validator = wxDefaultValidator, | |
38 | const wxString& name = wxListBoxNameStr); | |
39 | wxCheckListBox(wxWindow *parent, wxWindowID id, | |
40 | const wxPoint& pos, | |
41 | const wxSize& size, | |
42 | const wxArrayString& choices, | |
43 | long style = 0, | |
44 | const wxValidator& validator = wxDefaultValidator, | |
45 | const wxString& name = wxListBoxNameStr); | |
46 | ||
47 | bool Create(wxWindow *parent, wxWindowID id, | |
48 | const wxPoint& pos = wxDefaultPosition, | |
49 | const wxSize& size = wxDefaultSize, | |
50 | int n = 0, const wxString choices[] = NULL, | |
51 | long style = 0, | |
52 | const wxValidator& validator = wxDefaultValidator, | |
53 | const wxString& name = wxListBoxNameStr); | |
54 | bool Create(wxWindow *parent, wxWindowID id, | |
55 | const wxPoint& pos, | |
56 | const wxSize& size, | |
57 | const wxArrayString& choices, | |
58 | long style = 0, | |
59 | const wxValidator& validator = wxDefaultValidator, | |
60 | const wxString& name = wxListBoxNameStr); | |
61 | ||
62 | // override base class virtuals | |
63 | virtual void Delete(int n); | |
64 | ||
65 | virtual bool SetFont( const wxFont &font ); | |
66 | ||
67 | // items may be checked | |
68 | virtual bool IsChecked(size_t uiIndex) const; | |
69 | virtual void Check(size_t uiIndex, bool bCheck = TRUE); | |
70 | ||
71 | // return the index of the item at this position or wxNOT_FOUND | |
72 | int HitTest(const wxPoint& pt) const { return DoHitTestItem(pt.x, pt.y); } | |
73 | int HitTest(wxCoord x, wxCoord y) const { return DoHitTestItem(x, y); } | |
74 | ||
75 | // accessors | |
76 | size_t GetItemHeight() const { return m_nItemHeight; } | |
77 | ||
78 | protected: | |
79 | // we create our items ourselves and they have non-standard size, | |
80 | // so we need to override these functions | |
81 | virtual wxOwnerDrawn *CreateLboxItem(size_t n); | |
82 | virtual bool MSWOnMeasure(WXMEASUREITEMSTRUCT *item); | |
83 | ||
84 | // this can't be called DoHitTest() because wxWindow already has this method | |
85 | int DoHitTestItem(wxCoord x, wxCoord y) const; | |
86 | ||
87 | // pressing space or clicking the check box toggles the item | |
88 | void OnKeyDown(wxKeyEvent& event); | |
89 | void OnLeftClick(wxMouseEvent& event); | |
90 | ||
91 | private: | |
92 | size_t m_nItemHeight; // height of checklistbox items (the same for all) | |
93 | ||
94 | DECLARE_EVENT_TABLE() | |
95 | DECLARE_DYNAMIC_CLASS_NO_COPY(wxCheckListBox) | |
96 | }; | |
97 | ||
98 | #endif //_CHECKLST_H |