]> git.saurik.com Git - wxWidgets.git/blob - include/wx/osx/dataview.h
adding comment
[wxWidgets.git] / include / wx / osx / dataview.h
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: wx/osx/dataview.h
3 // Purpose: wxDataViewCtrl native implementation header for OSX
4 // Author:
5 // Id: $Id$
6 // Copyright: (c) 2009
7 // Licence: wxWindows licence
8 /////////////////////////////////////////////////////////////////////////////
9
10 #ifndef _WX_DATAVIEWCTRL_OSX_H_
11 #define _WX_DATAVIEWCTRL_OSX_H_
12
13 #ifdef __WXMAC_CLASSIC__
14 # error "Native wxDataViewCtrl for classic environment not defined. Please use generic control."
15 #endif
16
17 // --------------------------------------------------------
18 // Class declarations to mask native types
19 // --------------------------------------------------------
20 class wxDataViewColumnNativeData; // class storing environment dependent data for the native implementation
21 class wxDataViewWidgetImpl; // class used as a common interface for carbon and cocoa implementation
22
23 // ---------------------------------------------------------
24 // wxDataViewColumn
25 // ---------------------------------------------------------
26
27 class WXDLLIMPEXP_ADV wxDataViewColumn: public wxDataViewColumnBase
28 {
29 public:
30 // constructors / destructor
31 wxDataViewColumn(const wxString& title,
32 wxDataViewRenderer* renderer,
33 unsigned int model_column,
34 int width = wxDVC_DEFAULT_WIDTH,
35 wxAlignment align = wxALIGN_CENTER,
36 int flags = wxDATAVIEW_COL_RESIZABLE);
37 wxDataViewColumn(const wxBitmap& bitmap,
38 wxDataViewRenderer* renderer,
39 unsigned int model_column,
40 int width = wxDVC_DEFAULT_WIDTH,
41 wxAlignment align = wxALIGN_CENTER,
42 int flags = wxDATAVIEW_COL_RESIZABLE);
43 virtual ~wxDataViewColumn();
44
45 // implement wxHeaderColumnBase pure virtual methods
46 virtual wxAlignment GetAlignment() const { return m_alignment; }
47 virtual int GetFlags() const { return m_flags; }
48 virtual int GetMaxWidth() const { return m_maxWidth; }
49 virtual int GetMinWidth() const { return m_minWidth; }
50 virtual wxString GetTitle() const { return m_title; }
51 virtual int GetWidth() const;
52 virtual bool IsSortOrderAscending() const { return m_ascending; }
53 virtual bool IsSortKey() const;
54 virtual bool IsHidden() const;
55
56 virtual void SetAlignment (wxAlignment align);
57 virtual void SetBitmap (wxBitmap const& bitmap);
58 virtual void SetFlags (int flags) { SetIndividualFlags(flags); }
59 virtual void SetHidden (bool hidden);
60 virtual void SetMaxWidth (int maxWidth);
61 virtual void SetMinWidth (int minWidth);
62 virtual void SetReorderable(bool reorderable);
63 virtual void SetResizeable (bool resizable);
64 virtual void SetSortable (bool sortable);
65 virtual void SetSortOrder (bool ascending);
66 virtual void SetTitle (wxString const& title);
67 virtual void SetWidth (int width);
68
69 // implementation only
70 wxDataViewColumnNativeData* GetNativeData() const
71 {
72 return m_NativeDataPtr;
73 }
74
75 void SetNativeData(wxDataViewColumnNativeData* newNativeDataPtr); // class takes ownership of pointer
76 int GetWidthVariable() const
77 {
78 return m_width;
79 }
80 void SetWidthVariable(int NewWidth)
81 {
82 m_width = NewWidth;
83 }
84 void SetSortOrderVariable(bool NewOrder)
85 {
86 m_ascending = NewOrder;
87 }
88
89 private:
90 // common part of all ctors
91 void InitCommon(int width, wxAlignment align, int flags)
92 {
93 m_ascending = true;
94 m_flags = flags & ~wxDATAVIEW_COL_HIDDEN; // TODO
95 m_maxWidth = 30000;
96 m_minWidth = 0;
97 m_alignment = align;
98 SetWidth(width);
99 }
100
101 bool m_ascending; // sorting order
102
103 int m_flags; // flags for the column
104 int m_maxWidth; // maximum width for the column
105 int m_minWidth; // minimum width for the column
106 int m_width; // column width
107
108 wxAlignment m_alignment; // column header alignment
109
110 wxDataViewColumnNativeData* m_NativeDataPtr; // storing environment dependent data for the native implementation
111
112 wxString m_title; // column title
113 };
114
115 //
116 // type definitions related to wxDataViewColumn
117 //
118 WX_DEFINE_ARRAY(wxDataViewColumn*,wxDataViewColumnPtrArrayType);
119
120 // ---------------------------------------------------------
121 // wxDataViewCtrl
122 // ---------------------------------------------------------
123 class WXDLLIMPEXP_ADV wxDataViewCtrl: public wxDataViewCtrlBase
124 {
125 public:
126 // Constructors / destructor:
127 wxDataViewCtrl()
128 {
129 Init();
130 }
131 wxDataViewCtrl(wxWindow *parent,
132 wxWindowID winid,
133 const wxPoint& pos = wxDefaultPosition,
134 const wxSize& size = wxDefaultSize,
135 long style = 0,
136 const wxValidator& validator = wxDefaultValidator,
137 const wxString& name = wxDataViewCtrlNameStr )
138 {
139 Init();
140 Create(parent, winid, pos, size, style, validator, name);
141 }
142
143 ~wxDataViewCtrl();
144
145 bool Create(wxWindow *parent,
146 wxWindowID winid,
147 const wxPoint& pos = wxDefaultPosition,
148 const wxSize& size = wxDefaultSize,
149 long style = 0,
150 const wxValidator& validator = wxDefaultValidator,
151 const wxString& name = wxDataViewCtrlNameStr);
152
153 virtual wxWindow* GetMainWindow() // not used for the native implementation
154 {
155 return this;
156 }
157
158 // inherited methods from wxDataViewCtrlBase:
159 virtual bool AssociateModel(wxDataViewModel* model);
160
161 virtual bool AppendColumn (wxDataViewColumn* columnPtr);
162 virtual bool ClearColumns ();
163 virtual bool DeleteColumn (wxDataViewColumn* columnPtr);
164 virtual wxDataViewColumn* GetColumn (unsigned int pos) const;
165 virtual unsigned int GetColumnCount () const;
166 virtual int GetColumnPosition(const wxDataViewColumn* columnPtr) const;
167 virtual wxDataViewColumn* GetSortingColumn () const;
168 virtual bool InsertColumn (unsigned int pos, wxDataViewColumn *col);
169 virtual bool PrependColumn (wxDataViewColumn* columnPtr);
170
171 virtual void Collapse( const wxDataViewItem& item);
172 virtual void EnsureVisible(const wxDataViewItem& item, const wxDataViewColumn* columnPtr=NULL);
173 virtual void Expand(const wxDataViewItem& item);
174 virtual bool IsExpanded(const wxDataViewItem & item) const;
175
176 virtual unsigned int GetCount() const;
177 virtual wxRect GetItemRect(const wxDataViewItem& item,
178 const wxDataViewColumn* columnPtr = NULL) const;
179 virtual int GetSelectedItemsCount() const;
180 virtual int GetSelections(wxDataViewItemArray& sel) const;
181
182 virtual void HitTest(const wxPoint& point, wxDataViewItem& item, wxDataViewColumn*& columnPtr) const;
183
184 virtual bool IsSelected(const wxDataViewItem& item) const;
185
186 virtual void SelectAll();
187 virtual void Select(const wxDataViewItem& item);
188 virtual void SetSelections(const wxDataViewItemArray& sel);
189
190 virtual void Unselect(const wxDataViewItem& item);
191 virtual void UnselectAll();
192
193 //
194 // implementation
195 //
196 // returns a pointer to the native implementation
197 wxDataViewWidgetImpl* GetDataViewPeer() const;
198
199 // adds all children of the passed parent to the control; if 'parentItem' is invalid the root(s) is/are added:
200 void AddChildren(wxDataViewItem const& parentItem);
201
202 // finishes editing of custom items; if no custom item is currently edited the method does nothing
203 void FinishCustomItemEditing();
204
205 virtual void EditItem(const wxDataViewItem& item, const wxDataViewColumn *column);
206
207 // returns the n-th pointer to a column;
208 // this method is different from GetColumn(unsigned int pos) because here 'n' is not a position in the control but the n-th
209 // position in the internal list/array of column pointers
210 wxDataViewColumn* GetColumnPtr(size_t n) const
211 {
212 return m_ColumnPtrs[n];
213 }
214 // returns the current being rendered item of the customized renderer (this item is only valid during editing)
215 wxDataViewItem const& GetCustomRendererItem() const
216 {
217 return m_CustomRendererItem;
218 }
219 // returns a pointer to a customized renderer (this pointer is only valid during editing)
220 wxDataViewCustomRenderer* GetCustomRendererPtr() const
221 {
222 return m_CustomRendererPtr;
223 }
224
225 // checks if currently a delete process is running
226 bool IsDeleting() const
227 {
228 return m_Deleting;
229 }
230
231 // with CG, we need to get the context from an kEventControlDraw event
232 // unfortunately, the DataBrowser callbacks don't provide the context
233 // and we need it, so we need to set/remove it before and after draw
234 // events so we can access it in the callbacks.
235 void MacSetDrawingContext(void* context)
236 {
237 m_cgContext = context;
238 }
239 void* MacGetDrawingContext() const
240 {
241 return m_cgContext;
242 }
243
244 // sets the currently being edited item of the custom renderer
245 void SetCustomRendererItem(wxDataViewItem const& NewItem)
246 {
247 m_CustomRendererItem = NewItem;
248 }
249 // sets the custom renderer
250 void SetCustomRendererPtr(wxDataViewCustomRenderer* NewCustomRendererPtr)
251 {
252 m_CustomRendererPtr = NewCustomRendererPtr;
253 }
254 // sets the flag indicating a deletion process:
255 void SetDeleting(bool deleting)
256 {
257 m_Deleting = deleting;
258 }
259
260 virtual wxDataViewColumn *GetCurrentColumn() const;
261
262 virtual wxVisualAttributes GetDefaultAttributes() const
263 {
264 return GetClassDefaultAttributes(GetWindowVariant());
265 }
266
267 static wxVisualAttributes
268 GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
269
270 protected:
271 // inherited methods from wxDataViewCtrlBase
272 virtual void DoSetExpanderColumn();
273 virtual void DoSetIndent();
274
275 virtual wxSize DoGetBestSize() const;
276
277 // event handling
278 void OnSize(wxSizeEvent &event);
279 void OnMouse(wxMouseEvent &event);
280
281 private:
282 // initializing of local variables:
283 void Init();
284
285 virtual wxDataViewItem DoGetCurrentItem() const;
286 virtual void DoSetCurrentItem(const wxDataViewItem& item);
287
288 //
289 // variables
290 //
291 bool m_Deleting; // flag indicating if a delete process is running; this flag is necessary because the notifier indicating an item deletion in the model may be called
292 // after the actual deletion of the item; then, native callback functions/delegates may try to update data of variables that are already deleted;
293 // if this flag is set all native variable update requests will be ignored
294
295 void* m_cgContext; // pointer to core graphics context
296
297 wxDataViewCustomRenderer* m_CustomRendererPtr; // pointer to a valid custom renderer while editing; this class does NOT own the pointer
298
299 wxDataViewItem m_CustomRendererItem; // currently edited item by the customrenderer; it is invalid while not editing a custom item
300
301 wxDataViewColumnPtrArrayType m_ColumnPtrs; // all column pointers are stored in an array
302
303 wxDataViewModelNotifier* m_ModelNotifier; // stores the model notifier for the control (does not own the notifier)
304
305 // wxWidget internal stuff:
306 DECLARE_DYNAMIC_CLASS(wxDataViewCtrl)
307 DECLARE_NO_COPY_CLASS(wxDataViewCtrl)
308 DECLARE_EVENT_TABLE()
309 };
310
311 #endif // _WX_DATAVIEWCTRL_OSX_H_
312