1 ///////////////////////////////////////////////////////////////////////////////
2 // Name: wx/selstore.h
3 // Purpose: wxSelectionStore stores selected items in a control
4 // Author: Vadim Zeitlin
5 // Modified by:
6 // Created: 08.06.03 (extracted from src/generic/listctrl.cpp)
7 // Copyright: (c) 2000-2003 Vadim Zeitlin <vadim@wxwidgets.org>
8 // Licence: wxWindows licence
9 ///////////////////////////////////////////////////////////////////////////////
10
11 #ifndef _WX_SELSTORE_H_
12 #define _WX_SELSTORE_H_
13
14 #include "wx/dynarray.h"
15
16 // ----------------------------------------------------------------------------
17 // wxSelectedIndices is just a sorted array of indices
18 // ----------------------------------------------------------------------------
19
wxUIntCmp(unsigned n1,unsigned n2)20 inline int CMPFUNC_CONV wxUIntCmp(unsigned n1, unsigned n2)
21 {
22 return (int)(n1 - n2);
23 }
24
25 WX_DEFINE_SORTED_EXPORTED_ARRAY_CMP_INT(unsigned, wxUIntCmp, wxSelectedIndices);
26
27 // ----------------------------------------------------------------------------
28 // wxSelectionStore is used to store the selected items in the virtual
29 // controls, i.e. it is well suited for storing even when the control contains
30 // a huge (practically infinite) number of items.
31 //
32 // Of course, internally it still has to store the selected items somehow (as
33 // an array currently) but the advantage is that it can handle the selection
34 // of all items (common operation) efficiently and that it could be made even
35 // smarter in the future (e.g. store the selections as an array of ranges +
36 // individual items) without changing its API.
37 // ----------------------------------------------------------------------------
38
39 class WXDLLIMPEXP_CORE wxSelectionStore
40 {
41 public:
wxSelectionStore()42 wxSelectionStore() : m_itemsSel(wxUIntCmp) { Init(); }
43
44 // set the total number of items we handle
45 void SetItemCount(unsigned count);
46
47 // special case of SetItemCount(0)
Clear()48 void Clear() { m_itemsSel.Clear(); m_count = 0; m_defaultState = false; }
49
50 // must be called when a new item is inserted/added
OnItemAdd(unsigned WXUNUSED (item))51 void OnItemAdd(unsigned WXUNUSED(item)) { wxFAIL_MSG( wxT("TODO") ); }
52
53 // must be called when an item is deleted
54 void OnItemDelete(unsigned item);
55
56 // select one item, use SelectRange() insted if possible!
57 //
58 // returns true if the items selection really changed
59 bool SelectItem(unsigned item, bool select = true);
60
61 // select the range of items (inclusive)
62 //
63 // return true and fill the itemsChanged array with the indices of items
64 // which have changed state if "few" of them did, otherwise return false
65 // (meaning that too many items changed state to bother counting them
66 // individually)
67 bool SelectRange(unsigned itemFrom, unsigned itemTo,
68 bool select = true,
69 wxArrayInt *itemsChanged = NULL);
70
71 // return true if the given item is selected
72 bool IsSelected(unsigned item) const;
73
74 // return the total number of selected items
GetSelectedCount()75 unsigned GetSelectedCount() const
76 {
77 return m_defaultState ? m_count - m_itemsSel.GetCount()
78 : m_itemsSel.GetCount();
79 }
80
81 private:
82 // (re)init
Init()83 void Init() { m_count = 0; m_defaultState = false; }
84
85 // the total number of items we handle
86 unsigned m_count;
87
88 // the default state: normally, false (i.e. off) but maybe set to true if
89 // there are more selected items than non selected ones - this allows to
90 // handle selection of all items efficiently
91 bool m_defaultState;
92
93 // the array of items whose selection state is different from default
94 wxSelectedIndices m_itemsSel;
95
96 wxDECLARE_NO_COPY_CLASS(wxSelectionStore);
97 };
98
99 #endif // _WX_SELSTORE_H_
100
101