Fix r70318 to skip unhandled events.
[wxWidgets.git] / src / generic / datavgen.cpp
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/generic/datavgen.cpp
3 // Purpose: wxDataViewCtrl generic implementation
4 // Author: Robert Roebling
5 // Modified by: Francesco Montorsi, Guru Kathiresan, Bo Yang
6 // Id: $Id$
7 // Copyright: (c) 1998 Robert Roebling
8 // Licence: wxWindows licence
9 /////////////////////////////////////////////////////////////////////////////
10
11 // For compilers that support precompilation, includes "wx.h".
12 #include "wx/wxprec.h"
13
14 #ifdef __BORLANDC__
15 #pragma hdrstop
16 #endif
17
18 #if wxUSE_DATAVIEWCTRL
19
20 #include "wx/dataview.h"
21
22 #ifdef wxUSE_GENERICDATAVIEWCTRL
23
24 #ifndef WX_PRECOMP
25 #ifdef __WXMSW__
26 #include "wx/msw/private.h"
27 #include "wx/msw/wrapwin.h"
28 #include "wx/msw/wrapcctl.h" // include <commctrl.h> "properly"
29 #endif
30 #include "wx/sizer.h"
31 #include "wx/log.h"
32 #include "wx/dcclient.h"
33 #include "wx/timer.h"
34 #include "wx/settings.h"
35 #include "wx/msgdlg.h"
36 #include "wx/dcscreen.h"
37 #include "wx/frame.h"
38 #endif
39
40 #include "wx/stockitem.h"
41 #include "wx/popupwin.h"
42 #include "wx/renderer.h"
43 #include "wx/dcbuffer.h"
44 #include "wx/icon.h"
45 #include "wx/list.h"
46 #include "wx/listimpl.cpp"
47 #include "wx/imaglist.h"
48 #include "wx/headerctrl.h"
49 #include "wx/dnd.h"
50 #include "wx/stopwatch.h"
51 #include "wx/weakref.h"
52
53 //-----------------------------------------------------------------------------
54 // classes
55 //-----------------------------------------------------------------------------
56
57 class wxDataViewColumn;
58 class wxDataViewHeaderWindow;
59 class wxDataViewCtrl;
60
61 //-----------------------------------------------------------------------------
62 // classes
63 //-----------------------------------------------------------------------------
64
65 static const int SCROLL_UNIT_X = 15;
66
67 // the cell padding on the left/right
68 static const int PADDING_RIGHTLEFT = 3;
69
70 // the expander space margin
71 static const int EXPANDER_MARGIN = 4;
72
73 #ifdef __WXMSW__
74 static const int EXPANDER_OFFSET = 4;
75 #else
76 static const int EXPANDER_OFFSET = 1;
77 #endif
78
79 // Below is the compare stuff.
80 // For the generic implementation, both the leaf nodes and the nodes are sorted for
81 // fast search when needed
82 static wxDataViewModel* g_model;
83 static int g_column = -2;
84 static bool g_asending = true;
85
86 // ----------------------------------------------------------------------------
87 // helper functions
88 // ----------------------------------------------------------------------------
89
90 namespace
91 {
92
93 // Return the expander column or, if it is not set, the first column and also
94 // set it as the expander one for the future.
95 wxDataViewColumn* GetExpanderColumnOrFirstOne(wxDataViewCtrl* dataview)
96 {
97 wxDataViewColumn* expander = dataview->GetExpanderColumn();
98 if (!expander)
99 {
100 // TODO-RTL: last column for RTL support
101 expander = dataview->GetColumnAt( 0 );
102 dataview->SetExpanderColumn(expander);
103 }
104
105 return expander;
106 }
107
108 } // anonymous namespace
109
110 //-----------------------------------------------------------------------------
111 // wxDataViewColumn
112 //-----------------------------------------------------------------------------
113
114 void wxDataViewColumn::Init(int width, wxAlignment align, int flags)
115 {
116 m_width = width;
117 m_minWidth = 0;
118 m_align = align;
119 m_flags = flags;
120 m_sort = false;
121 m_sortAscending = true;
122 }
123
124 int wxDataViewColumn::GetWidth() const
125 {
126 switch ( m_width )
127 {
128 case wxCOL_WIDTH_DEFAULT:
129 return wxDVC_DEFAULT_WIDTH;
130
131 case wxCOL_WIDTH_AUTOSIZE:
132 wxCHECK_MSG( m_owner, wxDVC_DEFAULT_WIDTH, "no owner control" );
133 return m_owner->GetBestColumnWidth(m_owner->GetColumnIndex(this));
134
135 default:
136 return m_width;
137 }
138 }
139
140 void wxDataViewColumn::UpdateDisplay()
141 {
142 if (m_owner)
143 {
144 int idx = m_owner->GetColumnIndex( this );
145 m_owner->OnColumnChange( idx );
146 }
147 }
148
149 void wxDataViewColumn::SetSortOrder(bool ascending)
150 {
151 if ( !m_owner )
152 return;
153
154 // First unset the old sort column if any.
155 int oldSortKey = m_owner->GetSortingColumnIndex();
156 if ( oldSortKey != wxNOT_FOUND )
157 {
158 m_owner->GetColumn(oldSortKey)->UnsetAsSortKey();
159 }
160
161 // Now set this one as the new sort column.
162 const int idx = m_owner->GetColumnIndex(this);
163 m_owner->SetSortingColumnIndex(idx);
164
165 m_sort = true;
166 m_sortAscending = ascending;
167
168 // Call this directly instead of using UpdateDisplay() as we already have
169 // the column index, no need to look it up again.
170 m_owner->OnColumnChange(idx);
171 }
172
173 //-----------------------------------------------------------------------------
174 // wxDataViewHeaderWindow
175 //-----------------------------------------------------------------------------
176
177 class wxDataViewHeaderWindow : public wxHeaderCtrl
178 {
179 public:
180 wxDataViewHeaderWindow(wxDataViewCtrl *parent)
181 : wxHeaderCtrl(parent)
182 {
183 }
184
185 wxDataViewCtrl *GetOwner() const
186 { return static_cast<wxDataViewCtrl *>(GetParent()); }
187
188 protected:
189 // implement/override wxHeaderCtrl functions by forwarding them to the main
190 // control
191 virtual const wxHeaderColumn& GetColumn(unsigned int idx) const
192 {
193 return *(GetOwner()->GetColumn(idx));
194 }
195
196 virtual bool UpdateColumnWidthToFit(unsigned int idx, int widthTitle)
197 {
198 wxDataViewCtrl * const owner = GetOwner();
199
200 int widthContents = owner->GetBestColumnWidth(idx);
201 owner->GetColumn(idx)->SetWidth(wxMax(widthTitle, widthContents));
202 owner->OnColumnChange(idx);
203
204 return true;
205 }
206
207 private:
208 bool SendEvent(wxEventType type, unsigned int n)
209 {
210 wxDataViewCtrl * const owner = GetOwner();
211 wxDataViewEvent event(type, owner->GetId());
212
213 event.SetEventObject(owner);
214 event.SetColumn(n);
215 event.SetDataViewColumn(owner->GetColumn(n));
216 event.SetModel(owner->GetModel());
217
218 // for events created by wxDataViewHeaderWindow the
219 // row / value fields are not valid
220 return owner->ProcessWindowEvent(event);
221 }
222
223 void OnClick(wxHeaderCtrlEvent& event)
224 {
225 const unsigned idx = event.GetColumn();
226
227 if ( SendEvent(wxEVT_COMMAND_DATAVIEW_COLUMN_HEADER_CLICK, idx) )
228 return;
229
230 // default handling for the column click is to sort by this column or
231 // toggle its sort order
232 wxDataViewCtrl * const owner = GetOwner();
233 wxDataViewColumn * const col = owner->GetColumn(idx);
234 if ( !col->IsSortable() )
235 {
236 // no default handling for non-sortable columns
237 event.Skip();
238 return;
239 }
240
241 if ( col->IsSortKey() )
242 {
243 // already using this column for sorting, just change the order
244 col->ToggleSortOrder();
245 }
246 else // not using this column for sorting yet
247 {
248 col->SetSortOrder(true);
249 }
250
251 wxDataViewModel * const model = owner->GetModel();
252 if ( model )
253 model->Resort();
254
255 owner->OnColumnChange(idx);
256
257 SendEvent(wxEVT_COMMAND_DATAVIEW_COLUMN_SORTED, idx);
258 }
259
260 void OnRClick(wxHeaderCtrlEvent& event)
261 {
262 if ( !SendEvent(wxEVT_COMMAND_DATAVIEW_COLUMN_HEADER_RIGHT_CLICK,
263 event.GetColumn()) )
264 event.Skip();
265 }
266
267 void OnResize(wxHeaderCtrlEvent& event)
268 {
269 wxDataViewCtrl * const owner = GetOwner();
270
271 const unsigned col = event.GetColumn();
272 owner->GetColumn(col)->SetWidth(event.GetWidth());
273 GetOwner()->OnColumnChange(col);
274 }
275
276 void OnEndReorder(wxHeaderCtrlEvent& event)
277 {
278 wxDataViewCtrl * const owner = GetOwner();
279 owner->ColumnMoved(owner->GetColumn(event.GetColumn()),
280 event.GetNewOrder());
281 }
282
283 DECLARE_EVENT_TABLE()
284 wxDECLARE_NO_COPY_CLASS(wxDataViewHeaderWindow);
285 };
286
287 BEGIN_EVENT_TABLE(wxDataViewHeaderWindow, wxHeaderCtrl)
288 EVT_HEADER_CLICK(wxID_ANY, wxDataViewHeaderWindow::OnClick)
289 EVT_HEADER_RIGHT_CLICK(wxID_ANY, wxDataViewHeaderWindow::OnRClick)
290
291 EVT_HEADER_RESIZING(wxID_ANY, wxDataViewHeaderWindow::OnResize)
292 EVT_HEADER_END_RESIZE(wxID_ANY, wxDataViewHeaderWindow::OnResize)
293
294 EVT_HEADER_END_REORDER(wxID_ANY, wxDataViewHeaderWindow::OnEndReorder)
295 END_EVENT_TABLE()
296
297 //-----------------------------------------------------------------------------
298 // wxDataViewRenameTimer
299 //-----------------------------------------------------------------------------
300
301 class wxDataViewRenameTimer: public wxTimer
302 {
303 private:
304 wxDataViewMainWindow *m_owner;
305
306 public:
307 wxDataViewRenameTimer( wxDataViewMainWindow *owner );
308 void Notify();
309 };
310
311 //-----------------------------------------------------------------------------
312 // wxDataViewTreeNode
313 //-----------------------------------------------------------------------------
314
315 class wxDataViewTreeNode;
316 WX_DEFINE_ARRAY( wxDataViewTreeNode *, wxDataViewTreeNodes );
317
318 int LINKAGEMODE wxGenericTreeModelNodeCmp( wxDataViewTreeNode ** node1,
319 wxDataViewTreeNode ** node2);
320
321 class wxDataViewTreeNode
322 {
323 public:
324 wxDataViewTreeNode(wxDataViewTreeNode *parent, const wxDataViewItem& item)
325 : m_parent(parent),
326 m_item(item),
327 m_branchData(NULL)
328 {
329 }
330
331 ~wxDataViewTreeNode()
332 {
333 if ( m_branchData )
334 {
335 wxDataViewTreeNodes& nodes = m_branchData->children;
336 for ( wxDataViewTreeNodes::iterator i = nodes.begin();
337 i != nodes.end();
338 ++i )
339 {
340 delete *i;
341 }
342
343 delete m_branchData;
344 }
345 }
346
347 static wxDataViewTreeNode* CreateRootNode()
348 {
349 wxDataViewTreeNode *n = new wxDataViewTreeNode(NULL, wxDataViewItem());
350 n->SetHasChildren(true);
351 n->m_branchData->open = true;
352 return n;
353 }
354
355 wxDataViewTreeNode * GetParent() const { return m_parent; }
356
357 const wxDataViewTreeNodes& GetChildNodes() const
358 {
359 wxASSERT( m_branchData != NULL );
360 return m_branchData->children;
361 }
362
363 void InsertChild(wxDataViewTreeNode *node, unsigned index)
364 {
365 if ( !m_branchData )
366 m_branchData = new BranchNodeData;
367
368 m_branchData->children.Insert(node, index);
369
370 // TODO: insert into sorted array directly in O(log n) instead of resorting in O(n log n)
371 if (g_column >= -1)
372 m_branchData->children.Sort( &wxGenericTreeModelNodeCmp );
373 }
374
375 void RemoveChild(wxDataViewTreeNode *node)
376 {
377 wxCHECK_RET( m_branchData != NULL, "leaf node doesn't have children" );
378 m_branchData->children.Remove(node);
379 }
380
381 // returns position of child node for given item in children list or wxNOT_FOUND
382 int FindChildByItem(const wxDataViewItem& item) const
383 {
384 if ( !m_branchData )
385 return wxNOT_FOUND;
386
387 const wxDataViewTreeNodes& nodes = m_branchData->children;
388 const int len = nodes.size();
389 for ( int i = 0; i < len; i++ )
390 {
391 if ( nodes[i]->m_item == item )
392 return i;
393 }
394 return wxNOT_FOUND;
395 }
396
397 const wxDataViewItem & GetItem() const { return m_item; }
398 void SetItem( const wxDataViewItem & item ) { m_item = item; }
399
400 int GetIndentLevel() const
401 {
402 int ret = 0;
403 const wxDataViewTreeNode * node = this;
404 while( node->GetParent()->GetParent() != NULL )
405 {
406 node = node->GetParent();
407 ret ++;
408 }
409 return ret;
410 }
411
412 bool IsOpen() const
413 {
414 return m_branchData && m_branchData->open;
415 }
416
417 void ToggleOpen()
418 {
419 wxCHECK_RET( m_branchData != NULL, "can't open leaf node" );
420
421 int sum = 0;
422
423 const wxDataViewTreeNodes& nodes = m_branchData->children;
424 const int len = nodes.GetCount();
425 for ( int i = 0;i < len; i ++)
426 sum += 1 + nodes[i]->GetSubTreeCount();
427
428 if (m_branchData->open)
429 {
430 ChangeSubTreeCount(-sum);
431 m_branchData->open = !m_branchData->open;
432 }
433 else
434 {
435 m_branchData->open = !m_branchData->open;
436 ChangeSubTreeCount(+sum);
437 }
438 }
439
440 // "HasChildren" property corresponds to model's IsContainer(). Note that it may be true
441 // even if GetChildNodes() is empty; see below.
442 bool HasChildren() const
443 {
444 return m_branchData != NULL;
445 }
446
447 void SetHasChildren(bool has)
448 {
449 if ( !has )
450 {
451 wxDELETE(m_branchData);
452 }
453 else if ( m_branchData == NULL )
454 {
455 m_branchData = new BranchNodeData;
456 }
457 }
458
459 int GetSubTreeCount() const
460 {
461 return m_branchData ? m_branchData->subTreeCount : 0;
462 }
463
464 void ChangeSubTreeCount( int num )
465 {
466 wxASSERT( m_branchData != NULL );
467
468 if( !m_branchData->open )
469 return;
470
471 m_branchData->subTreeCount += num;
472 wxASSERT( m_branchData->subTreeCount >= 0 );
473
474 if( m_parent )
475 m_parent->ChangeSubTreeCount(num);
476 }
477
478 void Resort()
479 {
480 if ( !m_branchData )
481 return;
482
483 if (g_column >= -1)
484 {
485 wxDataViewTreeNodes& nodes = m_branchData->children;
486
487 nodes.Sort( &wxGenericTreeModelNodeCmp );
488 int len = nodes.GetCount();
489 for (int i = 0; i < len; i ++)
490 {
491 if ( nodes[i]->HasChildren() )
492 nodes[i]->Resort();
493 }
494 }
495 }
496
497
498 private:
499 wxDataViewTreeNode *m_parent;
500
501 // Corresponding model item.
502 wxDataViewItem m_item;
503
504 // Data specific to non-leaf (branch, inner) nodes. They are kept in a
505 // separate struct in order to conserve memory.
506 struct BranchNodeData
507 {
508 BranchNodeData()
509 : open(false),
510 subTreeCount(0)
511 {
512 }
513
514 // Child nodes. Note that this may be empty even if m_hasChildren in
515 // case this branch of the tree wasn't expanded and realized yet.
516 wxDataViewTreeNodes children;
517
518 // Is the branch node currently open (expanded)?
519 bool open;
520
521 // Total count of expanded (i.e. visible with the help of some
522 // scrolling) items in the subtree, but excluding this node. I.e. it is
523 // 0 for leaves and is the number of rows the subtree occupies for
524 // branch nodes.
525 int subTreeCount;
526 };
527
528 BranchNodeData *m_branchData;
529 };
530
531
532 int LINKAGEMODE wxGenericTreeModelNodeCmp( wxDataViewTreeNode ** node1,
533 wxDataViewTreeNode ** node2)
534 {
535 return g_model->Compare( (*node1)->GetItem(), (*node2)->GetItem(), g_column, g_asending );
536 }
537
538
539 //-----------------------------------------------------------------------------
540 // wxDataViewMainWindow
541 //-----------------------------------------------------------------------------
542
543 WX_DEFINE_SORTED_ARRAY_SIZE_T(unsigned int, wxDataViewSelection);
544
545 class wxDataViewMainWindow: public wxWindow
546 {
547 public:
548 wxDataViewMainWindow( wxDataViewCtrl *parent,
549 wxWindowID id,
550 const wxPoint &pos = wxDefaultPosition,
551 const wxSize &size = wxDefaultSize,
552 const wxString &name = wxT("wxdataviewctrlmainwindow") );
553 virtual ~wxDataViewMainWindow();
554
555 bool IsList() const { return GetModel()->IsListModel(); }
556 bool IsVirtualList() const { return m_root == NULL; }
557
558 // notifications from wxDataViewModel
559 bool ItemAdded( const wxDataViewItem &parent, const wxDataViewItem &item );
560 bool ItemDeleted( const wxDataViewItem &parent, const wxDataViewItem &item );
561 bool ItemChanged( const wxDataViewItem &item );
562 bool ValueChanged( const wxDataViewItem &item, unsigned int model_column );
563 bool Cleared();
564 void Resort()
565 {
566 if (!IsVirtualList())
567 {
568 SortPrepare();
569 m_root->Resort();
570 }
571 UpdateDisplay();
572 }
573
574 void SortPrepare()
575 {
576 g_model = GetModel();
577 wxDataViewColumn* col = GetOwner()->GetSortingColumn();
578 if( !col )
579 {
580 if (g_model->HasDefaultCompare())
581 g_column = -1;
582 else
583 g_column = -2;
584
585 g_asending = true;
586 return;
587 }
588 g_column = col->GetModelColumn();
589 g_asending = col->IsSortOrderAscending();
590 }
591
592 void SetOwner( wxDataViewCtrl* owner ) { m_owner = owner; }
593 wxDataViewCtrl *GetOwner() { return m_owner; }
594 const wxDataViewCtrl *GetOwner() const { return m_owner; }
595
596 wxDataViewModel* GetModel() { return GetOwner()->GetModel(); }
597 const wxDataViewModel* GetModel() const { return GetOwner()->GetModel(); }
598
599 #if wxUSE_DRAG_AND_DROP
600 wxBitmap CreateItemBitmap( unsigned int row, int &indent );
601 #endif // wxUSE_DRAG_AND_DROP
602 void OnPaint( wxPaintEvent &event );
603 void OnCharHook( wxKeyEvent &event );
604 void OnChar( wxKeyEvent &event );
605 void OnVerticalNavigation(unsigned int newCurrent, const wxKeyEvent& event);
606 void OnLeftKey();
607 void OnRightKey();
608 void OnMouse( wxMouseEvent &event );
609 void OnSetFocus( wxFocusEvent &event );
610 void OnKillFocus( wxFocusEvent &event );
611
612 void UpdateDisplay();
613 void RecalculateDisplay();
614 void OnInternalIdle();
615
616 void OnRenameTimer();
617
618 void ScrollWindow( int dx, int dy, const wxRect *rect = NULL );
619 void ScrollTo( int rows, int column );
620
621 unsigned GetCurrentRow() const { return m_currentRow; }
622 bool HasCurrentRow() { return m_currentRow != (unsigned int)-1; }
623 void ChangeCurrentRow( unsigned int row );
624 bool TryAdvanceCurrentColumn(wxDataViewTreeNode *node, bool forward);
625
626 wxDataViewColumn *GetCurrentColumn() const { return m_currentCol; }
627 void ClearCurrentColumn() { m_currentCol = NULL; }
628
629 bool IsSingleSel() const { return !GetParent()->HasFlag(wxDV_MULTIPLE); }
630 bool IsEmpty() { return GetRowCount() == 0; }
631
632 int GetCountPerPage() const;
633 int GetEndOfLastCol() const;
634 unsigned int GetFirstVisibleRow() const;
635
636 // I change this method to un const because in the tree view,
637 // the displaying number of the tree are changing along with the
638 // expanding/collapsing of the tree nodes
639 unsigned int GetLastVisibleRow();
640 unsigned int GetRowCount();
641
642 const wxDataViewSelection& GetSelections() const { return m_selection; }
643 void SetSelections( const wxDataViewSelection & sel )
644 { m_selection = sel; UpdateDisplay(); }
645 void Select( const wxArrayInt& aSelections );
646 void SelectAllRows( bool on );
647 void SelectRow( unsigned int row, bool on );
648 void SelectRows( unsigned int from, unsigned int to, bool on );
649 void ReverseRowSelection( unsigned int row );
650 bool IsRowSelected( unsigned int row );
651 void SendSelectionChangedEvent( const wxDataViewItem& item);
652
653 void RefreshRow( unsigned int row );
654 void RefreshRows( unsigned int from, unsigned int to );
655 void RefreshRowsAfter( unsigned int firstRow );
656
657 // returns the colour to be used for drawing the rules
658 wxColour GetRuleColour() const
659 {
660 return wxSystemSettings::GetColour(wxSYS_COLOUR_3DLIGHT);
661 }
662
663 wxRect GetLineRect( unsigned int row ) const;
664
665 int GetLineStart( unsigned int row ) const; // row * m_lineHeight in fixed mode
666 int GetLineHeight( unsigned int row ) const; // m_lineHeight in fixed mode
667 int GetLineAt( unsigned int y ) const; // y / m_lineHeight in fixed mode
668
669 void SetRowHeight( int lineHeight ) { m_lineHeight = lineHeight; }
670 int GetRowHeight() const { return m_lineHeight; }
671
672 // Some useful functions for row and item mapping
673 wxDataViewItem GetItemByRow( unsigned int row ) const;
674 int GetRowByItem( const wxDataViewItem & item ) const;
675
676 wxDataViewTreeNode * GetTreeNodeByRow( unsigned int row ) const;
677 // We did not need this temporarily
678 // wxDataViewTreeNode * GetTreeNodeByItem( const wxDataViewItem & item );
679
680 // Methods for building the mapping tree
681 void BuildTree( wxDataViewModel * model );
682 void DestroyTree();
683 void HitTest( const wxPoint & point, wxDataViewItem & item, wxDataViewColumn* &column );
684 wxRect GetItemRect( const wxDataViewItem & item, const wxDataViewColumn* column );
685
686 void Expand( unsigned int row );
687 void Collapse( unsigned int row );
688 bool IsExpanded( unsigned int row ) const;
689 bool HasChildren( unsigned int row ) const;
690
691 #if wxUSE_DRAG_AND_DROP
692 bool EnableDragSource( const wxDataFormat &format );
693 bool EnableDropTarget( const wxDataFormat &format );
694
695 void RemoveDropHint();
696 wxDragResult OnDragOver( wxDataFormat format, wxCoord x, wxCoord y, wxDragResult def );
697 bool OnDrop( wxDataFormat format, wxCoord x, wxCoord y );
698 wxDragResult OnData( wxDataFormat format, wxCoord x, wxCoord y, wxDragResult def );
699 void OnLeave();
700 #endif // wxUSE_DRAG_AND_DROP
701
702 void OnColumnsCountChanged();
703
704 // Called by wxDataViewCtrl and our own OnRenameTimer() to start edit the
705 // specified item in the given column.
706 void StartEditing(const wxDataViewItem& item, const wxDataViewColumn* col);
707
708 private:
709 int RecalculateCount();
710
711 // Return false only if the event was vetoed by its handler.
712 bool SendExpanderEvent(wxEventType type, const wxDataViewItem& item);
713
714 wxDataViewTreeNode * FindNode( const wxDataViewItem & item );
715
716 wxDataViewColumn *FindColumnForEditing(const wxDataViewItem& item, wxDataViewCellMode mode);
717
718 bool IsCellEditableInMode(const wxDataViewItem& item, const wxDataViewColumn *col, wxDataViewCellMode mode) const;
719
720 void DrawCellBackground( wxDataViewRenderer* cell, wxDC& dc, const wxRect& rect );
721
722 private:
723 wxDataViewCtrl *m_owner;
724 int m_lineHeight;
725 bool m_dirty;
726
727 wxDataViewColumn *m_currentCol;
728 unsigned int m_currentRow;
729 wxDataViewSelection m_selection;
730
731 wxDataViewRenameTimer *m_renameTimer;
732 bool m_lastOnSame;
733
734 bool m_hasFocus;
735 bool m_useCellFocus;
736 bool m_currentColSetByKeyboard;
737
738 #if wxUSE_DRAG_AND_DROP
739 int m_dragCount;
740 wxPoint m_dragStart;
741
742 bool m_dragEnabled;
743 wxDataFormat m_dragFormat;
744
745 bool m_dropEnabled;
746 wxDataFormat m_dropFormat;
747 bool m_dropHint;
748 unsigned int m_dropHintLine;
749 #endif // wxUSE_DRAG_AND_DROP
750
751 // for double click logic
752 unsigned int m_lineLastClicked,
753 m_lineBeforeLastClicked,
754 m_lineSelectSingleOnUp;
755
756 // the pen used to draw horiz/vertical rules
757 wxPen m_penRule;
758
759 // the pen used to draw the expander and the lines
760 wxPen m_penExpander;
761
762 // This is the tree structure of the model
763 wxDataViewTreeNode * m_root;
764 int m_count;
765
766 // This is the tree node under the cursor
767 wxDataViewTreeNode * m_underMouse;
768
769 // The control used for editing or NULL.
770 wxWeakRef<wxWindow> m_editorCtrl;
771
772 // Id m_editorCtrl is non-NULL, pointer to the associated renderer.
773 wxDataViewRenderer* m_editorRenderer;
774
775 private:
776 DECLARE_DYNAMIC_CLASS(wxDataViewMainWindow)
777 DECLARE_EVENT_TABLE()
778 };
779
780 // ---------------------------------------------------------
781 // wxGenericDataViewModelNotifier
782 // ---------------------------------------------------------
783
784 class wxGenericDataViewModelNotifier: public wxDataViewModelNotifier
785 {
786 public:
787 wxGenericDataViewModelNotifier( wxDataViewMainWindow *mainWindow )
788 { m_mainWindow = mainWindow; }
789
790 virtual bool ItemAdded( const wxDataViewItem & parent, const wxDataViewItem & item )
791 { return m_mainWindow->ItemAdded( parent , item ); }
792 virtual bool ItemDeleted( const wxDataViewItem &parent, const wxDataViewItem &item )
793 { return m_mainWindow->ItemDeleted( parent, item ); }
794 virtual bool ItemChanged( const wxDataViewItem & item )
795 { return m_mainWindow->ItemChanged(item); }
796 virtual bool ValueChanged( const wxDataViewItem & item , unsigned int col )
797 { return m_mainWindow->ValueChanged( item, col ); }
798 virtual bool Cleared()
799 { return m_mainWindow->Cleared(); }
800 virtual void Resort()
801 { m_mainWindow->Resort(); }
802
803 wxDataViewMainWindow *m_mainWindow;
804 };
805
806 // ---------------------------------------------------------
807 // wxDataViewRenderer
808 // ---------------------------------------------------------
809
810 IMPLEMENT_ABSTRACT_CLASS(wxDataViewRenderer, wxDataViewRendererBase)
811
812 wxDataViewRenderer::wxDataViewRenderer( const wxString &varianttype,
813 wxDataViewCellMode mode,
814 int align) :
815 wxDataViewCustomRendererBase( varianttype, mode, align )
816 {
817 m_align = align;
818 m_mode = mode;
819 m_ellipsizeMode = wxELLIPSIZE_MIDDLE;
820 m_dc = NULL;
821 }
822
823 wxDataViewRenderer::~wxDataViewRenderer()
824 {
825 delete m_dc;
826 }
827
828 wxDC *wxDataViewRenderer::GetDC()
829 {
830 if (m_dc == NULL)
831 {
832 if (GetOwner() == NULL)
833 return NULL;
834 if (GetOwner()->GetOwner() == NULL)
835 return NULL;
836 m_dc = new wxClientDC( GetOwner()->GetOwner() );
837 }
838
839 return m_dc;
840 }
841
842 void wxDataViewRenderer::SetAlignment( int align )
843 {
844 m_align=align;
845 }
846
847 int wxDataViewRenderer::GetAlignment() const
848 {
849 return m_align;
850 }
851
852 // ---------------------------------------------------------
853 // wxDataViewCustomRenderer
854 // ---------------------------------------------------------
855
856 IMPLEMENT_ABSTRACT_CLASS(wxDataViewCustomRenderer, wxDataViewRenderer)
857
858 wxDataViewCustomRenderer::wxDataViewCustomRenderer( const wxString &varianttype,
859 wxDataViewCellMode mode, int align ) :
860 wxDataViewRenderer( varianttype, mode, align )
861 {
862 }
863
864 // ---------------------------------------------------------
865 // wxDataViewTextRenderer
866 // ---------------------------------------------------------
867
868 IMPLEMENT_CLASS(wxDataViewTextRenderer, wxDataViewRenderer)
869
870 wxDataViewTextRenderer::wxDataViewTextRenderer( const wxString &varianttype,
871 wxDataViewCellMode mode, int align ) :
872 wxDataViewRenderer( varianttype, mode, align )
873 {
874 }
875
876 bool wxDataViewTextRenderer::SetValue( const wxVariant &value )
877 {
878 m_text = value.GetString();
879
880 return true;
881 }
882
883 bool wxDataViewTextRenderer::GetValue( wxVariant& WXUNUSED(value) ) const
884 {
885 return false;
886 }
887
888 bool wxDataViewTextRenderer::HasEditorCtrl() const
889 {
890 return true;
891 }
892
893 wxWindow* wxDataViewTextRenderer::CreateEditorCtrl( wxWindow *parent,
894 wxRect labelRect, const wxVariant &value )
895 {
896 wxTextCtrl* ctrl = new wxTextCtrl( parent, wxID_ANY, value,
897 wxPoint(labelRect.x,labelRect.y),
898 wxSize(labelRect.width,labelRect.height),
899 wxTE_PROCESS_ENTER );
900
901 // select the text in the control an place the cursor at the end
902 ctrl->SetInsertionPointEnd();
903 ctrl->SelectAll();
904
905 return ctrl;
906 }
907
908 bool wxDataViewTextRenderer::GetValueFromEditorCtrl( wxWindow *editor, wxVariant &value )
909 {
910 wxTextCtrl *text = (wxTextCtrl*) editor;
911 value = text->GetValue();
912 return true;
913 }
914
915 bool wxDataViewTextRenderer::Render(wxRect rect, wxDC *dc, int state)
916 {
917 RenderText(m_text, 0, rect, dc, state);
918 return true;
919 }
920
921 wxSize wxDataViewTextRenderer::GetSize() const
922 {
923 if (!m_text.empty())
924 return GetTextExtent(m_text);
925 else
926 return wxSize(wxDVC_DEFAULT_RENDERER_SIZE,wxDVC_DEFAULT_RENDERER_SIZE);
927 }
928
929 // ---------------------------------------------------------
930 // wxDataViewBitmapRenderer
931 // ---------------------------------------------------------
932
933 IMPLEMENT_CLASS(wxDataViewBitmapRenderer, wxDataViewRenderer)
934
935 wxDataViewBitmapRenderer::wxDataViewBitmapRenderer( const wxString &varianttype,
936 wxDataViewCellMode mode, int align ) :
937 wxDataViewRenderer( varianttype, mode, align )
938 {
939 }
940
941 bool wxDataViewBitmapRenderer::SetValue( const wxVariant &value )
942 {
943 if (value.GetType() == wxT("wxBitmap"))
944 m_bitmap << value;
945 if (value.GetType() == wxT("wxIcon"))
946 m_icon << value;
947
948 return true;
949 }
950
951 bool wxDataViewBitmapRenderer::GetValue( wxVariant& WXUNUSED(value) ) const
952 {
953 return false;
954 }
955
956 bool wxDataViewBitmapRenderer::Render( wxRect cell, wxDC *dc, int WXUNUSED(state) )
957 {
958 if (m_bitmap.IsOk())
959 dc->DrawBitmap( m_bitmap, cell.x, cell.y );
960 else if (m_icon.IsOk())
961 dc->DrawIcon( m_icon, cell.x, cell.y );
962
963 return true;
964 }
965
966 wxSize wxDataViewBitmapRenderer::GetSize() const
967 {
968 if (m_bitmap.IsOk())
969 return wxSize( m_bitmap.GetWidth(), m_bitmap.GetHeight() );
970 else if (m_icon.IsOk())
971 return wxSize( m_icon.GetWidth(), m_icon.GetHeight() );
972
973 return wxSize(wxDVC_DEFAULT_RENDERER_SIZE,wxDVC_DEFAULT_RENDERER_SIZE);
974 }
975
976 // ---------------------------------------------------------
977 // wxDataViewToggleRenderer
978 // ---------------------------------------------------------
979
980 IMPLEMENT_ABSTRACT_CLASS(wxDataViewToggleRenderer, wxDataViewRenderer)
981
982 wxDataViewToggleRenderer::wxDataViewToggleRenderer( const wxString &varianttype,
983 wxDataViewCellMode mode, int align ) :
984 wxDataViewRenderer( varianttype, mode, align )
985 {
986 m_toggle = false;
987 }
988
989 bool wxDataViewToggleRenderer::SetValue( const wxVariant &value )
990 {
991 m_toggle = value.GetBool();
992
993 return true;
994 }
995
996 bool wxDataViewToggleRenderer::GetValue( wxVariant &WXUNUSED(value) ) const
997 {
998 return false;
999 }
1000
1001 bool wxDataViewToggleRenderer::Render( wxRect cell, wxDC *dc, int WXUNUSED(state) )
1002 {
1003 int flags = 0;
1004 if (m_toggle)
1005 flags |= wxCONTROL_CHECKED;
1006 if (GetMode() != wxDATAVIEW_CELL_ACTIVATABLE ||
1007 GetEnabled() == false)
1008 flags |= wxCONTROL_DISABLED;
1009
1010 // check boxes we draw must always have the same, standard size (if it's
1011 // bigger than the cell size the checkbox will be truncated because the
1012 // caller had set the clipping rectangle to prevent us from drawing outside
1013 // the cell)
1014 cell.SetSize(GetSize());
1015
1016 wxRendererNative::Get().DrawCheckBox(
1017 GetOwner()->GetOwner(),
1018 *dc,
1019 cell,
1020 flags );
1021
1022 return true;
1023 }
1024
1025 bool wxDataViewToggleRenderer::WXActivateCell(const wxRect& WXUNUSED(cell),
1026 wxDataViewModel *model,
1027 const wxDataViewItem& item,
1028 unsigned int col,
1029 const wxMouseEvent *mouseEvent)
1030 {
1031 if ( mouseEvent )
1032 {
1033 // only react to clicks directly on the checkbox, not elsewhere in the same cell:
1034 if ( !wxRect(GetSize()).Contains(mouseEvent->GetPosition()) )
1035 return false;
1036 }
1037
1038 model->ChangeValue(!m_toggle, item, col);
1039 return true;
1040 }
1041
1042 wxSize wxDataViewToggleRenderer::GetSize() const
1043 {
1044 // the window parameter is not used by GetCheckBoxSize() so it's
1045 // safe to pass NULL
1046 return wxRendererNative::Get().GetCheckBoxSize(NULL);
1047 }
1048
1049 // ---------------------------------------------------------
1050 // wxDataViewProgressRenderer
1051 // ---------------------------------------------------------
1052
1053 IMPLEMENT_ABSTRACT_CLASS(wxDataViewProgressRenderer, wxDataViewRenderer)
1054
1055 wxDataViewProgressRenderer::wxDataViewProgressRenderer( const wxString &label,
1056 const wxString &varianttype, wxDataViewCellMode mode, int align ) :
1057 wxDataViewRenderer( varianttype, mode, align )
1058 {
1059 m_label = label;
1060 m_value = 0;
1061 }
1062
1063 bool wxDataViewProgressRenderer::SetValue( const wxVariant &value )
1064 {
1065 m_value = (long) value;
1066
1067 if (m_value < 0) m_value = 0;
1068 if (m_value > 100) m_value = 100;
1069
1070 return true;
1071 }
1072
1073 bool wxDataViewProgressRenderer::GetValue( wxVariant &value ) const
1074 {
1075 value = (long) m_value;
1076 return true;
1077 }
1078
1079 bool
1080 wxDataViewProgressRenderer::Render(wxRect rect, wxDC *dc, int WXUNUSED(state))
1081 {
1082 // deflate the rect to leave a small border between bars in adjacent rows
1083 wxRect bar = rect.Deflate(0, 1);
1084
1085 dc->SetBrush( *wxTRANSPARENT_BRUSH );
1086 dc->SetPen( *wxBLACK_PEN );
1087 dc->DrawRectangle( bar );
1088
1089 bar.width = (int)(bar.width * m_value / 100.);
1090 dc->SetPen( *wxTRANSPARENT_PEN );
1091
1092 const wxDataViewItemAttr& attr = GetAttr();
1093 dc->SetBrush( attr.HasColour() ? wxBrush(attr.GetColour())
1094 : *wxBLUE_BRUSH );
1095 dc->DrawRectangle( bar );
1096
1097 return true;
1098 }
1099
1100 wxSize wxDataViewProgressRenderer::GetSize() const
1101 {
1102 return wxSize(40,12);
1103 }
1104
1105 // ---------------------------------------------------------
1106 // wxDataViewIconTextRenderer
1107 // ---------------------------------------------------------
1108
1109 IMPLEMENT_CLASS(wxDataViewIconTextRenderer, wxDataViewRenderer)
1110
1111 wxDataViewIconTextRenderer::wxDataViewIconTextRenderer(
1112 const wxString &varianttype, wxDataViewCellMode mode, int align ) :
1113 wxDataViewRenderer( varianttype, mode, align )
1114 {
1115 SetMode(mode);
1116 SetAlignment(align);
1117 }
1118
1119 bool wxDataViewIconTextRenderer::SetValue( const wxVariant &value )
1120 {
1121 m_value << value;
1122 return true;
1123 }
1124
1125 bool wxDataViewIconTextRenderer::GetValue( wxVariant& WXUNUSED(value) ) const
1126 {
1127 return false;
1128 }
1129
1130 bool wxDataViewIconTextRenderer::Render(wxRect rect, wxDC *dc, int state)
1131 {
1132 int xoffset = 0;
1133
1134 const wxIcon& icon = m_value.GetIcon();
1135 if ( icon.IsOk() )
1136 {
1137 dc->DrawIcon(icon, rect.x, rect.y + (rect.height - icon.GetHeight())/2);
1138 xoffset = icon.GetWidth()+4;
1139 }
1140
1141 RenderText(m_value.GetText(), xoffset, rect, dc, state);
1142
1143 return true;
1144 }
1145
1146 wxSize wxDataViewIconTextRenderer::GetSize() const
1147 {
1148 if (!m_value.GetText().empty())
1149 {
1150 wxSize size = GetTextExtent(m_value.GetText());
1151
1152 if (m_value.GetIcon().IsOk())
1153 size.x += m_value.GetIcon().GetWidth() + 4;
1154 return size;
1155 }
1156 return wxSize(80,20);
1157 }
1158
1159 wxWindow* wxDataViewIconTextRenderer::CreateEditorCtrl(wxWindow *parent, wxRect labelRect, const wxVariant& value)
1160 {
1161 wxDataViewIconText iconText;
1162 iconText << value;
1163
1164 wxString text = iconText.GetText();
1165
1166 // adjust the label rect to take the width of the icon into account
1167 if (iconText.GetIcon().IsOk())
1168 {
1169 int w = iconText.GetIcon().GetWidth() + 4;
1170 labelRect.x += w;
1171 labelRect.width -= w;
1172 }
1173
1174 wxTextCtrl* ctrl = new wxTextCtrl( parent, wxID_ANY, text,
1175 wxPoint(labelRect.x,labelRect.y),
1176 wxSize(labelRect.width,labelRect.height),
1177 wxTE_PROCESS_ENTER );
1178
1179 // select the text in the control an place the cursor at the end
1180 ctrl->SetInsertionPointEnd();
1181 ctrl->SelectAll();
1182
1183 return ctrl;
1184 }
1185
1186 bool wxDataViewIconTextRenderer::GetValueFromEditorCtrl( wxWindow *editor, wxVariant& value )
1187 {
1188 wxTextCtrl *text = (wxTextCtrl*) editor;
1189
1190 wxDataViewIconText iconText(text->GetValue(), m_value.GetIcon());
1191 value << iconText;
1192 return true;
1193 }
1194
1195 //-----------------------------------------------------------------------------
1196 // wxDataViewDropTarget
1197 //-----------------------------------------------------------------------------
1198
1199 #if wxUSE_DRAG_AND_DROP
1200
1201 class wxBitmapCanvas: public wxWindow
1202 {
1203 public:
1204 wxBitmapCanvas( wxWindow *parent, const wxBitmap &bitmap, const wxSize &size ) :
1205 wxWindow( parent, wxID_ANY, wxPoint(0,0), size )
1206 {
1207 m_bitmap = bitmap;
1208 Connect( wxEVT_PAINT, wxPaintEventHandler(wxBitmapCanvas::OnPaint) );
1209 }
1210
1211 void OnPaint( wxPaintEvent &WXUNUSED(event) )
1212 {
1213 wxPaintDC dc(this);
1214 dc.DrawBitmap( m_bitmap, 0, 0);
1215 }
1216
1217 wxBitmap m_bitmap;
1218 };
1219
1220 class wxDataViewDropSource: public wxDropSource
1221 {
1222 public:
1223 wxDataViewDropSource( wxDataViewMainWindow *win, unsigned int row ) :
1224 wxDropSource( win )
1225 {
1226 m_win = win;
1227 m_row = row;
1228 m_hint = NULL;
1229 }
1230
1231 ~wxDataViewDropSource()
1232 {
1233 delete m_hint;
1234 }
1235
1236 virtual bool GiveFeedback( wxDragResult WXUNUSED(effect) )
1237 {
1238 wxPoint pos = wxGetMousePosition();
1239
1240 if (!m_hint)
1241 {
1242 int liney = m_win->GetLineStart( m_row );
1243 int linex = 0;
1244 m_win->GetOwner()->CalcUnscrolledPosition( 0, liney, NULL, &liney );
1245 m_win->ClientToScreen( &linex, &liney );
1246 m_dist_x = pos.x - linex;
1247 m_dist_y = pos.y - liney;
1248
1249 int indent = 0;
1250 wxBitmap ib = m_win->CreateItemBitmap( m_row, indent );
1251 m_dist_x -= indent;
1252 m_hint = new wxFrame( m_win->GetParent(), wxID_ANY, wxEmptyString,
1253 wxPoint(pos.x - m_dist_x, pos.y + 5 ),
1254 ib.GetSize(),
1255 wxFRAME_TOOL_WINDOW |
1256 wxFRAME_FLOAT_ON_PARENT |
1257 wxFRAME_NO_TASKBAR |
1258 wxNO_BORDER );
1259 new wxBitmapCanvas( m_hint, ib, ib.GetSize() );
1260 m_hint->Show();
1261 }
1262 else
1263 {
1264 m_hint->Move( pos.x - m_dist_x, pos.y + 5 );
1265 m_hint->SetTransparent( 128 );
1266 }
1267
1268 return false;
1269 }
1270
1271 wxDataViewMainWindow *m_win;
1272 unsigned int m_row;
1273 wxFrame *m_hint;
1274 int m_dist_x,m_dist_y;
1275 };
1276
1277
1278 class wxDataViewDropTarget: public wxDropTarget
1279 {
1280 public:
1281 wxDataViewDropTarget( wxDataObject *obj, wxDataViewMainWindow *win ) :
1282 wxDropTarget( obj )
1283 {
1284 m_win = win;
1285 }
1286
1287 virtual wxDragResult OnDragOver( wxCoord x, wxCoord y, wxDragResult def )
1288 {
1289 wxDataFormat format = GetMatchingPair();
1290 if (format == wxDF_INVALID)
1291 return wxDragNone;
1292 return m_win->OnDragOver( format, x, y, def);
1293 }
1294
1295 virtual bool OnDrop( wxCoord x, wxCoord y )
1296 {
1297 wxDataFormat format = GetMatchingPair();
1298 if (format == wxDF_INVALID)
1299 return false;
1300 return m_win->OnDrop( format, x, y );
1301 }
1302
1303 virtual wxDragResult OnData( wxCoord x, wxCoord y, wxDragResult def )
1304 {
1305 wxDataFormat format = GetMatchingPair();
1306 if (format == wxDF_INVALID)
1307 return wxDragNone;
1308 if (!GetData())
1309 return wxDragNone;
1310 return m_win->OnData( format, x, y, def );
1311 }
1312
1313 virtual void OnLeave()
1314 { m_win->OnLeave(); }
1315
1316 wxDataViewMainWindow *m_win;
1317 };
1318
1319 #endif // wxUSE_DRAG_AND_DROP
1320
1321 //-----------------------------------------------------------------------------
1322 // wxDataViewRenameTimer
1323 //-----------------------------------------------------------------------------
1324
1325 wxDataViewRenameTimer::wxDataViewRenameTimer( wxDataViewMainWindow *owner )
1326 {
1327 m_owner = owner;
1328 }
1329
1330 void wxDataViewRenameTimer::Notify()
1331 {
1332 m_owner->OnRenameTimer();
1333 }
1334
1335 //-----------------------------------------------------------------------------
1336 // wxDataViewMainWindow
1337 //-----------------------------------------------------------------------------
1338
1339 // The tree building helper, declared firstly
1340 static void BuildTreeHelper( const wxDataViewModel * model, const wxDataViewItem & item,
1341 wxDataViewTreeNode * node);
1342
1343 int LINKAGEMODE wxDataViewSelectionCmp( unsigned int row1, unsigned int row2 )
1344 {
1345 if (row1 > row2) return 1;
1346 if (row1 == row2) return 0;
1347 return -1;
1348 }
1349
1350 IMPLEMENT_ABSTRACT_CLASS(wxDataViewMainWindow, wxWindow)
1351
1352 BEGIN_EVENT_TABLE(wxDataViewMainWindow,wxWindow)
1353 EVT_PAINT (wxDataViewMainWindow::OnPaint)
1354 EVT_MOUSE_EVENTS (wxDataViewMainWindow::OnMouse)
1355 EVT_SET_FOCUS (wxDataViewMainWindow::OnSetFocus)
1356 EVT_KILL_FOCUS (wxDataViewMainWindow::OnKillFocus)
1357 EVT_CHAR_HOOK (wxDataViewMainWindow::OnCharHook)
1358 EVT_CHAR (wxDataViewMainWindow::OnChar)
1359 END_EVENT_TABLE()
1360
1361 wxDataViewMainWindow::wxDataViewMainWindow( wxDataViewCtrl *parent, wxWindowID id,
1362 const wxPoint &pos, const wxSize &size, const wxString &name ) :
1363 wxWindow( parent, id, pos, size, wxWANTS_CHARS|wxBORDER_NONE, name ),
1364 m_selection( wxDataViewSelectionCmp )
1365
1366 {
1367 SetOwner( parent );
1368
1369 m_editorRenderer = NULL;
1370
1371 m_lastOnSame = false;
1372 m_renameTimer = new wxDataViewRenameTimer( this );
1373
1374 // TODO: user better initial values/nothing selected
1375 m_currentCol = NULL;
1376 m_currentColSetByKeyboard = false;
1377 m_useCellFocus = false;
1378 m_currentRow = 0;
1379
1380 m_lineHeight = wxMax( 17, GetCharHeight() + 4 ); // 17 = mini icon height + 1
1381
1382 #if wxUSE_DRAG_AND_DROP
1383 m_dragCount = 0;
1384 m_dragStart = wxPoint(0,0);
1385
1386 m_dragEnabled = false;
1387 m_dropEnabled = false;
1388 m_dropHint = false;
1389 m_dropHintLine = (unsigned int) -1;
1390 #endif // wxUSE_DRAG_AND_DROP
1391
1392 m_lineLastClicked = (unsigned int) -1;
1393 m_lineBeforeLastClicked = (unsigned int) -1;
1394 m_lineSelectSingleOnUp = (unsigned int) -1;
1395
1396 m_hasFocus = false;
1397
1398 SetBackgroundColour( *wxWHITE );
1399
1400 SetBackgroundStyle(wxBG_STYLE_CUSTOM);
1401
1402 m_penRule = wxPen(GetRuleColour());
1403
1404 // compose a pen whichcan draw black lines
1405 // TODO: maybe there is something system colour to use
1406 m_penExpander = wxPen(wxColour(0,0,0));
1407
1408 m_root = wxDataViewTreeNode::CreateRootNode();
1409
1410 // Make m_count = -1 will cause the class recaculate the real displaying number of rows.
1411 m_count = -1;
1412 m_underMouse = NULL;
1413 UpdateDisplay();
1414 }
1415
1416 wxDataViewMainWindow::~wxDataViewMainWindow()
1417 {
1418 DestroyTree();
1419 delete m_renameTimer;
1420 }
1421
1422
1423 #if wxUSE_DRAG_AND_DROP
1424 bool wxDataViewMainWindow::EnableDragSource( const wxDataFormat &format )
1425 {
1426 m_dragFormat = format;
1427 m_dragEnabled = format != wxDF_INVALID;
1428
1429 return true;
1430 }
1431
1432 bool wxDataViewMainWindow::EnableDropTarget( const wxDataFormat &format )
1433 {
1434 m_dropFormat = format;
1435 m_dropEnabled = format != wxDF_INVALID;
1436
1437 if (m_dropEnabled)
1438 SetDropTarget( new wxDataViewDropTarget( new wxCustomDataObject( format ), this ) );
1439
1440 return true;
1441 }
1442
1443 void wxDataViewMainWindow::RemoveDropHint()
1444 {
1445 if (m_dropHint)
1446 {
1447 m_dropHint = false;
1448 RefreshRow( m_dropHintLine );
1449 m_dropHintLine = (unsigned int) -1;
1450 }
1451 }
1452
1453 wxDragResult wxDataViewMainWindow::OnDragOver( wxDataFormat format, wxCoord x,
1454 wxCoord y, wxDragResult def )
1455 {
1456 int xx = x;
1457 int yy = y;
1458 m_owner->CalcUnscrolledPosition( xx, yy, &xx, &yy );
1459 unsigned int row = GetLineAt( yy );
1460
1461 if ((row >= GetRowCount()) || (xx > GetEndOfLastCol()))
1462 {
1463 RemoveDropHint();
1464 return wxDragNone;
1465 }
1466
1467 wxDataViewItem item = GetItemByRow( row );
1468
1469 wxDataViewModel *model = GetModel();
1470
1471 wxDataViewEvent event( wxEVT_COMMAND_DATAVIEW_ITEM_DROP_POSSIBLE, m_owner->GetId() );
1472 event.SetEventObject( m_owner );
1473 event.SetItem( item );
1474 event.SetModel( model );
1475 event.SetDataFormat( format );
1476 if (!m_owner->HandleWindowEvent( event ))
1477 {
1478 RemoveDropHint();
1479 return wxDragNone;
1480 }
1481
1482 if (!event.IsAllowed())
1483 {
1484 RemoveDropHint();
1485 return wxDragNone;
1486 }
1487
1488
1489 if (m_dropHint && (row != m_dropHintLine))
1490 RefreshRow( m_dropHintLine );
1491 m_dropHint = true;
1492 m_dropHintLine = row;
1493 RefreshRow( row );
1494
1495 return def;
1496 }
1497
1498 bool wxDataViewMainWindow::OnDrop( wxDataFormat format, wxCoord x, wxCoord y )
1499 {
1500 RemoveDropHint();
1501
1502 int xx = x;
1503 int yy = y;
1504 m_owner->CalcUnscrolledPosition( xx, yy, &xx, &yy );
1505 unsigned int row = GetLineAt( yy );
1506
1507 if ((row >= GetRowCount()) || (xx > GetEndOfLastCol()))
1508 return false;
1509
1510 wxDataViewItem item = GetItemByRow( row );
1511
1512 wxDataViewModel *model = GetModel();
1513
1514 wxDataViewEvent event( wxEVT_COMMAND_DATAVIEW_ITEM_DROP_POSSIBLE, m_owner->GetId() );
1515 event.SetEventObject( m_owner );
1516 event.SetItem( item );
1517 event.SetModel( model );
1518 event.SetDataFormat( format );
1519 if (!m_owner->HandleWindowEvent( event ))
1520 return false;
1521
1522 if (!event.IsAllowed())
1523 return false;
1524
1525 return true;
1526 }
1527
1528 wxDragResult wxDataViewMainWindow::OnData( wxDataFormat format, wxCoord x, wxCoord y,
1529 wxDragResult def )
1530 {
1531 int xx = x;
1532 int yy = y;
1533 m_owner->CalcUnscrolledPosition( xx, yy, &xx, &yy );
1534 unsigned int row = GetLineAt( yy );
1535
1536 if ((row >= GetRowCount()) || (xx > GetEndOfLastCol()))
1537 return wxDragNone;
1538
1539 wxDataViewItem item = GetItemByRow( row );
1540
1541 wxDataViewModel *model = GetModel();
1542
1543 wxCustomDataObject *obj = (wxCustomDataObject *) GetDropTarget()->GetDataObject();
1544
1545 wxDataViewEvent event( wxEVT_COMMAND_DATAVIEW_ITEM_DROP, m_owner->GetId() );
1546 event.SetEventObject( m_owner );
1547 event.SetItem( item );
1548 event.SetModel( model );
1549 event.SetDataFormat( format );
1550 event.SetDataSize( obj->GetSize() );
1551 event.SetDataBuffer( obj->GetData() );
1552 if (!m_owner->HandleWindowEvent( event ))
1553 return wxDragNone;
1554
1555 if (!event.IsAllowed())
1556 return wxDragNone;
1557
1558 return def;
1559 }
1560
1561 void wxDataViewMainWindow::OnLeave()
1562 {
1563 RemoveDropHint();
1564 }
1565
1566 wxBitmap wxDataViewMainWindow::CreateItemBitmap( unsigned int row, int &indent )
1567 {
1568 int height = GetLineHeight( row );
1569 int width = 0;
1570 unsigned int cols = GetOwner()->GetColumnCount();
1571 unsigned int col;
1572 for (col = 0; col < cols; col++)
1573 {
1574 wxDataViewColumn *column = GetOwner()->GetColumnAt(col);
1575 if (column->IsHidden())
1576 continue; // skip it!
1577 width += column->GetWidth();
1578 }
1579
1580 indent = 0;
1581 if (!IsList())
1582 {
1583 wxDataViewTreeNode *node = GetTreeNodeByRow(row);
1584 indent = GetOwner()->GetIndent() * node->GetIndentLevel();
1585 indent = indent + m_lineHeight;
1586 // try to use the m_lineHeight as the expander space
1587 }
1588 width -= indent;
1589
1590 wxBitmap bitmap( width, height );
1591 wxMemoryDC dc( bitmap );
1592 dc.SetFont( GetFont() );
1593 dc.SetPen( *wxBLACK_PEN );
1594 dc.SetBrush( *wxWHITE_BRUSH );
1595 dc.DrawRectangle( 0,0,width,height );
1596
1597 wxDataViewModel *model = m_owner->GetModel();
1598
1599 wxDataViewColumn * const
1600 expander = GetExpanderColumnOrFirstOne(GetOwner());
1601
1602 int x = 0;
1603 for (col = 0; col < cols; col++)
1604 {
1605 wxDataViewColumn *column = GetOwner()->GetColumnAt( col );
1606 wxDataViewRenderer *cell = column->GetRenderer();
1607
1608 if (column->IsHidden())
1609 continue; // skip it!
1610
1611 width = column->GetWidth();
1612
1613 if (column == expander)
1614 width -= indent;
1615
1616 wxDataViewItem item = GetItemByRow( row );
1617 cell->PrepareForItem(model, item, column->GetModelColumn());
1618
1619 wxRect item_rect(x, 0, width, height);
1620 item_rect.Deflate(PADDING_RIGHTLEFT, 0);
1621
1622 // dc.SetClippingRegion( item_rect );
1623 cell->WXCallRender(item_rect, &dc, 0);
1624 // dc.DestroyClippingRegion();
1625
1626 x += width;
1627 }
1628
1629 return bitmap;
1630 }
1631
1632 #endif // wxUSE_DRAG_AND_DROP
1633
1634
1635 // Draw focus rect for individual cell. Unlike native focus rect, we render
1636 // this in foreground text color (typically white) to enhance contrast and
1637 // make it visible.
1638 static void DrawSelectedCellFocusRect(wxDC& dc, const wxRect& rect)
1639 {
1640 // (This code is based on wxRendererGeneric::DrawFocusRect and modified.)
1641
1642 // draw the pixels manually because the "dots" in wxPen with wxDOT style
1643 // may be short traits and not really dots
1644 //
1645 // note that to behave in the same manner as DrawRect(), we must exclude
1646 // the bottom and right borders from the rectangle
1647 wxCoord x1 = rect.GetLeft(),
1648 y1 = rect.GetTop(),
1649 x2 = rect.GetRight(),
1650 y2 = rect.GetBottom();
1651
1652 wxDCPenChanger pen(dc, wxSystemSettings::GetColour(wxSYS_COLOUR_HIGHLIGHTTEXT));
1653
1654 wxCoord z;
1655 for ( z = x1 + 1; z < x2; z += 2 )
1656 dc.DrawPoint(z, rect.GetTop());
1657
1658 wxCoord shift = z == x2 ? 0 : 1;
1659 for ( z = y1 + shift; z < y2; z += 2 )
1660 dc.DrawPoint(x2, z);
1661
1662 shift = z == y2 ? 0 : 1;
1663 for ( z = x2 - shift; z > x1; z -= 2 )
1664 dc.DrawPoint(z, y2);
1665
1666 shift = z == x1 ? 0 : 1;
1667 for ( z = y2 - shift; z > y1; z -= 2 )
1668 dc.DrawPoint(x1, z);
1669 }
1670
1671
1672 void wxDataViewMainWindow::OnPaint( wxPaintEvent &WXUNUSED(event) )
1673 {
1674 wxDataViewModel *model = GetModel();
1675 wxAutoBufferedPaintDC dc( this );
1676
1677 #ifdef __WXMSW__
1678 dc.SetBrush(GetOwner()->GetBackgroundColour());
1679 dc.SetPen( *wxTRANSPARENT_PEN );
1680 dc.DrawRectangle(GetClientSize());
1681 #endif
1682
1683 if ( IsEmpty() )
1684 {
1685 // No items to draw.
1686 return;
1687 }
1688
1689 // prepare the DC
1690 GetOwner()->PrepareDC( dc );
1691 dc.SetFont( GetFont() );
1692
1693 wxRect update = GetUpdateRegion().GetBox();
1694 m_owner->CalcUnscrolledPosition( update.x, update.y, &update.x, &update.y );
1695
1696 // compute which items needs to be redrawn
1697 unsigned int item_start = GetLineAt( wxMax(0,update.y) );
1698 unsigned int item_count =
1699 wxMin( (int)( GetLineAt( wxMax(0,update.y+update.height) ) - item_start + 1),
1700 (int)(GetRowCount( ) - item_start));
1701 unsigned int item_last = item_start + item_count;
1702
1703 // Send the event to wxDataViewCtrl itself.
1704 wxWindow * const parent = GetParent();
1705 wxDataViewEvent cache_event(wxEVT_COMMAND_DATAVIEW_CACHE_HINT, parent->GetId());
1706 cache_event.SetEventObject(parent);
1707 cache_event.SetCache(item_start, item_last - 1);
1708 parent->ProcessWindowEvent(cache_event);
1709
1710 // compute which columns needs to be redrawn
1711 unsigned int cols = GetOwner()->GetColumnCount();
1712 if ( !cols )
1713 {
1714 // we assume that we have at least one column below and painting an
1715 // empty control is unnecessary anyhow
1716 return;
1717 }
1718
1719 unsigned int col_start = 0;
1720 unsigned int x_start;
1721 for (x_start = 0; col_start < cols; col_start++)
1722 {
1723 wxDataViewColumn *col = GetOwner()->GetColumnAt(col_start);
1724 if (col->IsHidden())
1725 continue; // skip it!
1726
1727 unsigned int w = col->GetWidth();
1728 if (x_start+w >= (unsigned int)update.x)
1729 break;
1730
1731 x_start += w;
1732 }
1733
1734 unsigned int col_last = col_start;
1735 unsigned int x_last = x_start;
1736 for (; col_last < cols; col_last++)
1737 {
1738 wxDataViewColumn *col = GetOwner()->GetColumnAt(col_last);
1739 if (col->IsHidden())
1740 continue; // skip it!
1741
1742 if (x_last > (unsigned int)update.GetRight())
1743 break;
1744
1745 x_last += col->GetWidth();
1746 }
1747
1748 // Draw background of alternate rows specially if required
1749 if ( m_owner->HasFlag(wxDV_ROW_LINES) )
1750 {
1751 wxColour altRowColour = m_owner->m_alternateRowColour;
1752 if ( !altRowColour.IsOk() )
1753 {
1754 // Determine the alternate rows colour automatically from the
1755 // background colour.
1756 const wxColour bgColour = m_owner->GetBackgroundColour();
1757
1758 // Depending on the background, alternate row color
1759 // will be 3% more dark or 50% brighter.
1760 int alpha = bgColour.GetRGB() > 0x808080 ? 97 : 150;
1761 altRowColour = bgColour.ChangeLightness(alpha);
1762 }
1763
1764 dc.SetPen(*wxTRANSPARENT_PEN);
1765 dc.SetBrush(wxBrush(altRowColour));
1766
1767 for (unsigned int item = item_start; item < item_last; item++)
1768 {
1769 if ( item % 2 )
1770 {
1771 dc.DrawRectangle(x_start,
1772 GetLineStart(item),
1773 GetClientSize().GetWidth(),
1774 GetLineHeight(item));
1775 }
1776 }
1777 }
1778
1779 // Draw horizontal rules if required
1780 if ( m_owner->HasFlag(wxDV_HORIZ_RULES) )
1781 {
1782 dc.SetPen(m_penRule);
1783 dc.SetBrush(*wxTRANSPARENT_BRUSH);
1784
1785 for (unsigned int i = item_start; i <= item_last; i++)
1786 {
1787 int y = GetLineStart( i );
1788 dc.DrawLine(x_start, y, x_last, y);
1789 }
1790 }
1791
1792 // Draw vertical rules if required
1793 if ( m_owner->HasFlag(wxDV_VERT_RULES) )
1794 {
1795 dc.SetPen(m_penRule);
1796 dc.SetBrush(*wxTRANSPARENT_BRUSH);
1797
1798 // NB: Vertical rules are drawn in the last pixel of a column so that
1799 // they align perfectly with native MSW wxHeaderCtrl as well as for
1800 // consistency with MSW native list control. There's no vertical
1801 // rule at the most-left side of the control.
1802
1803 int x = x_start - 1;
1804 for (unsigned int i = col_start; i < col_last; i++)
1805 {
1806 wxDataViewColumn *col = GetOwner()->GetColumnAt(i);
1807 if (col->IsHidden())
1808 continue; // skip it
1809
1810 x += col->GetWidth();
1811
1812 dc.DrawLine(x, GetLineStart( item_start ),
1813 x, GetLineStart( item_last ) );
1814 }
1815 }
1816
1817 // redraw the background for the items which are selected/current
1818 for (unsigned int item = item_start; item < item_last; item++)
1819 {
1820 bool selected = m_selection.Index( item ) != wxNOT_FOUND;
1821
1822 if (selected || item == m_currentRow)
1823 {
1824 wxRect rect( x_start, GetLineStart( item ),
1825 x_last - x_start, GetLineHeight( item ) );
1826
1827 // draw selection and whole-item focus:
1828 if ( selected )
1829 {
1830 int flags = wxCONTROL_SELECTED;
1831 if (m_hasFocus)
1832 flags |= wxCONTROL_FOCUSED;
1833
1834 wxRendererNative::Get().DrawItemSelectionRect
1835 (
1836 this,
1837 dc,
1838 rect,
1839 flags
1840 );
1841 }
1842
1843 // draw keyboard focus rect if applicable
1844 if ( item == m_currentRow && m_hasFocus )
1845 {
1846 bool renderColumnFocus = false;
1847
1848 if ( m_useCellFocus && m_currentCol && m_currentColSetByKeyboard )
1849 {
1850 renderColumnFocus = true;
1851
1852 // If this is container node without columns, render full-row focus:
1853 if ( !IsList() )
1854 {
1855 wxDataViewTreeNode *node = GetTreeNodeByRow(item);
1856 if ( node->HasChildren() && !model->HasContainerColumns(node->GetItem()) )
1857 renderColumnFocus = false;
1858 }
1859 }
1860
1861 if ( renderColumnFocus )
1862 {
1863 for ( unsigned int i = col_start; i < col_last; i++ )
1864 {
1865 wxDataViewColumn *col = GetOwner()->GetColumnAt(i);
1866 if ( col->IsHidden() )
1867 continue;
1868
1869 rect.width = col->GetWidth();
1870
1871 if ( col == m_currentCol )
1872 {
1873 // make the rect more visible by adding a small
1874 // margin around it:
1875 rect.Deflate(1, 1);
1876
1877 if ( selected )
1878 {
1879 // DrawFocusRect() uses XOR and is all but
1880 // invisible against dark-blue background. Use
1881 // the same color used for selected text.
1882 DrawSelectedCellFocusRect(dc, rect);
1883 }
1884 else
1885 {
1886 wxRendererNative::Get().DrawFocusRect
1887 (
1888 this,
1889 dc,
1890 rect,
1891 0
1892 );
1893 }
1894 break;
1895 }
1896
1897 rect.x += rect.width;
1898 }
1899 }
1900 else
1901 {
1902 // render focus rectangle for the whole row
1903 wxRendererNative::Get().DrawFocusRect
1904 (
1905 this,
1906 dc,
1907 rect,
1908 selected ? (int)wxCONTROL_SELECTED : 0
1909 );
1910 }
1911 }
1912 }
1913 }
1914
1915 #if wxUSE_DRAG_AND_DROP
1916 if (m_dropHint)
1917 {
1918 wxRect rect( x_start, GetLineStart( m_dropHintLine ),
1919 x_last - x_start, GetLineHeight( m_dropHintLine ) );
1920 dc.SetPen( *wxBLACK_PEN );
1921 dc.SetBrush( *wxTRANSPARENT_BRUSH );
1922 dc.DrawRectangle( rect );
1923 }
1924 #endif // wxUSE_DRAG_AND_DROP
1925
1926 wxDataViewColumn * const
1927 expander = GetExpanderColumnOrFirstOne(GetOwner());
1928
1929 // redraw all cells for all rows which must be repainted and all columns
1930 wxRect cell_rect;
1931 cell_rect.x = x_start;
1932 for (unsigned int i = col_start; i < col_last; i++)
1933 {
1934 wxDataViewColumn *col = GetOwner()->GetColumnAt( i );
1935 wxDataViewRenderer *cell = col->GetRenderer();
1936 cell_rect.width = col->GetWidth();
1937
1938 if ( col->IsHidden() || cell_rect.width <= 0 )
1939 continue; // skip it!
1940
1941 for (unsigned int item = item_start; item < item_last; item++)
1942 {
1943 // get the cell value and set it into the renderer
1944 wxDataViewTreeNode *node = NULL;
1945 wxDataViewItem dataitem;
1946
1947 if (!IsVirtualList())
1948 {
1949 node = GetTreeNodeByRow(item);
1950 if( node == NULL )
1951 continue;
1952
1953 dataitem = node->GetItem();
1954
1955 // Skip all columns of "container" rows except the expander
1956 // column itself unless HasContainerColumns() overrides this.
1957 if ( col != expander &&
1958 model->IsContainer(dataitem) &&
1959 !model->HasContainerColumns(dataitem) )
1960 continue;
1961 }
1962 else
1963 {
1964 dataitem = wxDataViewItem( wxUIntToPtr(item+1) );
1965 }
1966
1967 cell->PrepareForItem(model, dataitem, col->GetModelColumn());
1968
1969 // update cell_rect
1970 cell_rect.y = GetLineStart( item );
1971 cell_rect.height = GetLineHeight( item );
1972
1973 // draw the background
1974 bool selected = m_selection.Index( item ) != wxNOT_FOUND;
1975 if ( !selected )
1976 DrawCellBackground( cell, dc, cell_rect );
1977
1978 // deal with the expander
1979 int indent = 0;
1980 if ((!IsList()) && (col == expander))
1981 {
1982 // Calculate the indent first
1983 indent = GetOwner()->GetIndent() * node->GetIndentLevel();
1984
1985 // we reserve m_lineHeight of horizontal space for the expander
1986 // but leave EXPANDER_MARGIN around the expander itself
1987 int exp_x = cell_rect.x + indent + EXPANDER_MARGIN;
1988
1989 indent += m_lineHeight;
1990
1991 // draw expander if needed and visible
1992 if ( node->HasChildren() && exp_x < cell_rect.GetRight() )
1993 {
1994 dc.SetPen( m_penExpander );
1995 dc.SetBrush( wxNullBrush );
1996
1997 int exp_size = m_lineHeight - 2*EXPANDER_MARGIN;
1998 int exp_y = cell_rect.y + (cell_rect.height - exp_size)/2
1999 + EXPANDER_MARGIN - EXPANDER_OFFSET;
2000
2001 const wxRect rect(exp_x, exp_y, exp_size, exp_size);
2002
2003 int flag = 0;
2004 if ( m_underMouse == node )
2005 flag |= wxCONTROL_CURRENT;
2006 if ( node->IsOpen() )
2007 flag |= wxCONTROL_EXPANDED;
2008
2009 // ensure that we don't overflow the cell (which might
2010 // happen if the column is very narrow)
2011 wxDCClipper clip(dc, cell_rect);
2012
2013 wxRendererNative::Get().DrawTreeItemButton( this, dc, rect, flag);
2014 }
2015
2016 // force the expander column to left-center align
2017 cell->SetAlignment( wxALIGN_CENTER_VERTICAL );
2018 }
2019
2020 wxRect item_rect = cell_rect;
2021 item_rect.Deflate(PADDING_RIGHTLEFT, 0);
2022
2023 // account for the tree indent (harmless if we're not indented)
2024 item_rect.x += indent;
2025 item_rect.width -= indent;
2026
2027 if ( item_rect.width <= 0 )
2028 continue;
2029
2030 int state = 0;
2031 if (m_hasFocus && selected)
2032 state |= wxDATAVIEW_CELL_SELECTED;
2033
2034 // TODO: it would be much more efficient to create a clipping
2035 // region for the entire column being rendered (in the OnPaint
2036 // of wxDataViewMainWindow) instead of a single clip region for
2037 // each cell. However it would mean that each renderer should
2038 // respect the given wxRect's top & bottom coords, eventually
2039 // violating only the left & right coords - however the user can
2040 // make its own renderer and thus we cannot be sure of that.
2041 wxDCClipper clip(dc, item_rect);
2042
2043 cell->WXCallRender(item_rect, &dc, state);
2044 }
2045
2046 cell_rect.x += cell_rect.width;
2047 }
2048 }
2049
2050
2051 void wxDataViewMainWindow::DrawCellBackground( wxDataViewRenderer* cell, wxDC& dc, const wxRect& rect )
2052 {
2053 wxRect rectBg( rect );
2054
2055 // don't overlap the horizontal rules
2056 if ( m_owner->HasFlag(wxDV_HORIZ_RULES) )
2057 {
2058 rectBg.x++;
2059 rectBg.width--;
2060 }
2061
2062 // don't overlap the vertical rules
2063 if ( m_owner->HasFlag(wxDV_VERT_RULES) )
2064 {
2065 rectBg.y++;
2066 rectBg.height--;
2067 }
2068
2069 cell->RenderBackground(&dc, rectBg);
2070 }
2071
2072 void wxDataViewMainWindow::OnRenameTimer()
2073 {
2074 // We have to call this here because changes may just have
2075 // been made and no screen update taken place.
2076 if ( m_dirty )
2077 {
2078 // TODO: use wxTheApp->SafeYieldFor(NULL, wxEVT_CATEGORY_UI) instead
2079 // (needs to be tested!)
2080 wxSafeYield();
2081 }
2082
2083 wxDataViewItem item = GetItemByRow( m_currentRow );
2084
2085 StartEditing( item, m_currentCol );
2086 }
2087
2088 void
2089 wxDataViewMainWindow::StartEditing(const wxDataViewItem& item,
2090 const wxDataViewColumn* col)
2091 {
2092 wxDataViewRenderer* renderer = col->GetRenderer();
2093 if ( !IsCellEditableInMode(item, col, wxDATAVIEW_CELL_EDITABLE) )
2094 return;
2095
2096 const wxRect itemRect = GetItemRect(item, col);
2097 if ( renderer->StartEditing(item, itemRect) )
2098 {
2099 // Save the renderer to be able to finish/cancel editing it later and
2100 // save the control to be able to detect if we're still editing it.
2101 m_editorRenderer = renderer;
2102 m_editorCtrl = renderer->GetEditorCtrl();
2103 }
2104 }
2105
2106 //-----------------------------------------------------------------------------
2107 // Helper class for do operation on the tree node
2108 //-----------------------------------------------------------------------------
2109 class DoJob
2110 {
2111 public:
2112 DoJob() { }
2113 virtual ~DoJob() { }
2114
2115 // The return value control how the tree-walker tranverse the tree
2116 enum
2117 {
2118 DONE, // Job done, stop traversing and return
2119 SKIP_SUBTREE, // Ignore the current node's subtree and continue
2120 CONTINUE // Job not done, continue
2121 };
2122
2123 virtual int operator() ( wxDataViewTreeNode * node ) = 0;
2124 };
2125
2126 bool Walker( wxDataViewTreeNode * node, DoJob & func )
2127 {
2128 wxCHECK_MSG( node, false, "can't walk NULL node" );
2129
2130 switch( func( node ) )
2131 {
2132 case DoJob::DONE:
2133 return true;
2134 case DoJob::SKIP_SUBTREE:
2135 return false;
2136 case DoJob::CONTINUE:
2137 break;
2138 }
2139
2140 if ( node->HasChildren() )
2141 {
2142 const wxDataViewTreeNodes& nodes = node->GetChildNodes();
2143
2144 for ( wxDataViewTreeNodes::const_iterator i = nodes.begin();
2145 i != nodes.end();
2146 ++i )
2147 {
2148 if ( Walker(*i, func) )
2149 return true;
2150 }
2151 }
2152
2153 return false;
2154 }
2155
2156 bool wxDataViewMainWindow::ItemAdded(const wxDataViewItem & parent, const wxDataViewItem & item)
2157 {
2158 if (IsVirtualList())
2159 {
2160 wxDataViewVirtualListModel *list_model =
2161 (wxDataViewVirtualListModel*) GetModel();
2162 m_count = list_model->GetCount();
2163 }
2164 else
2165 {
2166 SortPrepare();
2167
2168 wxDataViewTreeNode *parentNode = FindNode(parent);
2169
2170 if ( !parentNode )
2171 return false;
2172
2173 wxDataViewItemArray modelSiblings;
2174 GetModel()->GetChildren(parent, modelSiblings);
2175 const int modelSiblingsSize = modelSiblings.size();
2176
2177 int posInModel = modelSiblings.Index(item, /*fromEnd=*/true);
2178 wxCHECK_MSG( posInModel != wxNOT_FOUND, false, "adding non-existent item?" );
2179
2180 wxDataViewTreeNode *itemNode = new wxDataViewTreeNode(parentNode, item);
2181 itemNode->SetHasChildren(GetModel()->IsContainer(item));
2182
2183 parentNode->SetHasChildren(true);
2184
2185 const wxDataViewTreeNodes& nodeSiblings = parentNode->GetChildNodes();
2186 const int nodeSiblingsSize = nodeSiblings.size();
2187
2188 int nodePos = 0;
2189
2190 if ( posInModel == modelSiblingsSize - 1 )
2191 {
2192 nodePos = nodeSiblingsSize;
2193 }
2194 else if ( modelSiblingsSize == nodeSiblingsSize + 1 )
2195 {
2196 // This is the simple case when our node tree already matches the
2197 // model and only this one item is missing.
2198 nodePos = posInModel;
2199 }
2200 else
2201 {
2202 // It's possible that a larger discrepancy between the model and
2203 // our realization exists. This can happen e.g. when adding a bunch
2204 // of items to the model and then calling ItemsAdded() just once
2205 // afterwards. In this case, we must find the right position by
2206 // looking at sibling items.
2207
2208 // append to the end if we won't find a better position:
2209 nodePos = nodeSiblingsSize;
2210
2211 for ( int nextItemPos = posInModel + 1;
2212 nextItemPos < modelSiblingsSize;
2213 nextItemPos++ )
2214 {
2215 int nextNodePos = parentNode->FindChildByItem(modelSiblings[nextItemPos]);
2216 if ( nextNodePos != wxNOT_FOUND )
2217 {
2218 nodePos = nextNodePos;
2219 break;
2220 }
2221 }
2222 }
2223
2224 parentNode->ChangeSubTreeCount(+1);
2225 parentNode->InsertChild(itemNode, nodePos);
2226
2227 m_count = -1;
2228 }
2229
2230 GetOwner()->InvalidateColBestWidths();
2231 UpdateDisplay();
2232
2233 return true;
2234 }
2235
2236 bool wxDataViewMainWindow::ItemDeleted(const wxDataViewItem& parent,
2237 const wxDataViewItem& item)
2238 {
2239 if (IsVirtualList())
2240 {
2241 wxDataViewVirtualListModel *list_model =
2242 (wxDataViewVirtualListModel*) GetModel();
2243 m_count = list_model->GetCount();
2244
2245 if ( !m_selection.empty() )
2246 {
2247 const int row = GetRowByItem(item);
2248
2249 int rowIndexInSelection = wxNOT_FOUND;
2250
2251 const size_t selCount = m_selection.size();
2252 for ( size_t i = 0; i < selCount; i++ )
2253 {
2254 if ( m_selection[i] == (unsigned)row )
2255 rowIndexInSelection = i;
2256 else if ( m_selection[i] > (unsigned)row )
2257 m_selection[i]--;
2258 }
2259
2260 if ( rowIndexInSelection != wxNOT_FOUND )
2261 m_selection.RemoveAt(rowIndexInSelection);
2262 }
2263
2264 }
2265 else // general case
2266 {
2267 wxDataViewTreeNode *parentNode = FindNode(parent);
2268
2269 // Notice that it is possible that the item being deleted is not in the
2270 // tree at all, for example we could be deleting a never shown (because
2271 // collapsed) item in a tree model. So it's not an error if we don't know
2272 // about this item, just return without doing anything then.
2273 if ( !parentNode )
2274 return true;
2275
2276 wxCHECK_MSG( parentNode->HasChildren(), false, "parent node doesn't have children?" );
2277 const wxDataViewTreeNodes& parentsChildren = parentNode->GetChildNodes();
2278
2279 // We can't use FindNode() to find 'item', because it was already
2280 // removed from the model by the time ItemDeleted() is called, so we
2281 // have to do it manually. We keep track of its position as well for
2282 // later use.
2283 int itemPosInNode = 0;
2284 wxDataViewTreeNode *itemNode = NULL;
2285 for ( wxDataViewTreeNodes::const_iterator i = parentsChildren.begin();
2286 i != parentsChildren.end();
2287 ++i, ++itemPosInNode )
2288 {
2289 if( (*i)->GetItem() == item )
2290 {
2291 itemNode = *i;
2292 break;
2293 }
2294 }
2295
2296 // If the parent wasn't expanded, it's possible that we didn't have a
2297 // node corresponding to 'item' and so there's nothing left to do.
2298 if ( !itemNode )
2299 {
2300 // If this was the last child to be removed, it's possible the parent
2301 // node became a leaf. Let's ask the model about it.
2302 if ( parentNode->GetChildNodes().empty() )
2303 parentNode->SetHasChildren(GetModel()->IsContainer(parent));
2304
2305 return true;
2306 }
2307
2308 // Delete the item from wxDataViewTreeNode representation:
2309 const int itemsDeleted = 1 + itemNode->GetSubTreeCount();
2310
2311 parentNode->RemoveChild(itemNode);
2312 delete itemNode;
2313 parentNode->ChangeSubTreeCount(-itemsDeleted);
2314
2315 // Make the row number invalid and get a new valid one when user call GetRowCount
2316 m_count = -1;
2317
2318 // If this was the last child to be removed, it's possible the parent
2319 // node became a leaf. Let's ask the model about it.
2320 if ( parentNode->GetChildNodes().empty() )
2321 parentNode->SetHasChildren(GetModel()->IsContainer(parent));
2322
2323 // Update selection by removing 'item' and its entire children tree from the selection.
2324 if ( !m_selection.empty() )
2325 {
2326 // we can't call GetRowByItem() on 'item', as it's already deleted, so compute it from
2327 // the parent ('parentNode') and position in its list of children
2328 int itemRow;
2329 if ( itemPosInNode == 0 )
2330 {
2331 // 1st child, row number is that of the parent parentNode + 1
2332 itemRow = GetRowByItem(parentNode->GetItem()) + 1;
2333 }
2334 else
2335 {
2336 // row number is that of the sibling above 'item' + its subtree if any + 1
2337 const wxDataViewTreeNode *siblingNode = parentNode->GetChildNodes()[itemPosInNode - 1];
2338
2339 itemRow = GetRowByItem(siblingNode->GetItem()) +
2340 siblingNode->GetSubTreeCount() +
2341 1;
2342 }
2343
2344 wxDataViewSelection newsel(wxDataViewSelectionCmp);
2345
2346 const size_t numSelections = m_selection.size();
2347 for ( size_t i = 0; i < numSelections; ++i )
2348 {
2349 const int s = m_selection[i];
2350 if ( s < itemRow )
2351 newsel.push_back(s);
2352 else if ( s >= itemRow + itemsDeleted )
2353 newsel.push_back(s - itemsDeleted);
2354 // else: deleted item, remove from selection
2355 }
2356
2357 m_selection = newsel;
2358 }
2359 }
2360
2361 // Change the current row to the last row if the current exceed the max row number
2362 if( m_currentRow > GetRowCount() )
2363 ChangeCurrentRow(m_count - 1);
2364
2365 GetOwner()->InvalidateColBestWidths();
2366 UpdateDisplay();
2367
2368 return true;
2369 }
2370
2371 bool wxDataViewMainWindow::ItemChanged(const wxDataViewItem & item)
2372 {
2373 SortPrepare();
2374 g_model->Resort();
2375
2376 GetOwner()->InvalidateColBestWidths();
2377
2378 // Send event
2379 wxWindow *parent = GetParent();
2380 wxDataViewEvent le(wxEVT_COMMAND_DATAVIEW_ITEM_VALUE_CHANGED, parent->GetId());
2381 le.SetEventObject(parent);
2382 le.SetModel(GetModel());
2383 le.SetItem(item);
2384 parent->ProcessWindowEvent(le);
2385
2386 return true;
2387 }
2388
2389 bool wxDataViewMainWindow::ValueChanged( const wxDataViewItem & item, unsigned int model_column )
2390 {
2391 int view_column = -1;
2392 unsigned int n_col = m_owner->GetColumnCount();
2393 for (unsigned i = 0; i < n_col; i++)
2394 {
2395 wxDataViewColumn *column = m_owner->GetColumn( i );
2396 if (column->GetModelColumn() == model_column)
2397 {
2398 view_column = (int) i;
2399 break;
2400 }
2401 }
2402 if (view_column == -1)
2403 return false;
2404
2405 // NOTE: to be valid, we cannot use e.g. INT_MAX - 1
2406 /*#define MAX_VIRTUAL_WIDTH 100000
2407
2408 wxRect rect( 0, row*m_lineHeight, MAX_VIRTUAL_WIDTH, m_lineHeight );
2409 m_owner->CalcScrolledPosition( rect.x, rect.y, &rect.x, &rect.y );
2410 Refresh( true, &rect );
2411
2412 return true;
2413 */
2414 SortPrepare();
2415 g_model->Resort();
2416
2417 GetOwner()->InvalidateColBestWidth(view_column);
2418
2419 // Send event
2420 wxWindow *parent = GetParent();
2421 wxDataViewEvent le(wxEVT_COMMAND_DATAVIEW_ITEM_VALUE_CHANGED, parent->GetId());
2422 le.SetEventObject(parent);
2423 le.SetModel(GetModel());
2424 le.SetItem(item);
2425 le.SetColumn(view_column);
2426 le.SetDataViewColumn(GetOwner()->GetColumn(view_column));
2427 parent->ProcessWindowEvent(le);
2428
2429 return true;
2430 }
2431
2432 bool wxDataViewMainWindow::Cleared()
2433 {
2434 DestroyTree();
2435 m_selection.Clear();
2436
2437 SortPrepare();
2438 BuildTree( GetModel() );
2439
2440 GetOwner()->InvalidateColBestWidths();
2441 UpdateDisplay();
2442
2443 return true;
2444 }
2445
2446 void wxDataViewMainWindow::UpdateDisplay()
2447 {
2448 m_dirty = true;
2449 m_underMouse = NULL;
2450 }
2451
2452 void wxDataViewMainWindow::OnInternalIdle()
2453 {
2454 wxWindow::OnInternalIdle();
2455
2456 if (m_dirty)
2457 {
2458 RecalculateDisplay();
2459 m_dirty = false;
2460 }
2461 }
2462
2463 void wxDataViewMainWindow::RecalculateDisplay()
2464 {
2465 wxDataViewModel *model = GetModel();
2466 if (!model)
2467 {
2468 Refresh();
2469 return;
2470 }
2471
2472 int width = GetEndOfLastCol();
2473 int height = GetLineStart( GetRowCount() );
2474
2475 SetVirtualSize( width, height );
2476 GetOwner()->SetScrollRate( 10, m_lineHeight );
2477
2478 Refresh();
2479 }
2480
2481 void wxDataViewMainWindow::ScrollWindow( int dx, int dy, const wxRect *rect )
2482 {
2483 m_underMouse = NULL;
2484
2485 wxWindow::ScrollWindow( dx, dy, rect );
2486
2487 if (GetOwner()->m_headerArea)
2488 GetOwner()->m_headerArea->ScrollWindow( dx, 0 );
2489 }
2490
2491 void wxDataViewMainWindow::ScrollTo( int rows, int column )
2492 {
2493 m_underMouse = NULL;
2494
2495 int x, y;
2496 m_owner->GetScrollPixelsPerUnit( &x, &y );
2497 int sy = GetLineStart( rows )/y;
2498 int sx = -1;
2499 if( column != -1 )
2500 {
2501 wxRect rect = GetClientRect();
2502 int colnum = 0;
2503 int x_start, w = 0;
2504 int xx, yy, xe;
2505 m_owner->CalcUnscrolledPosition( rect.x, rect.y, &xx, &yy );
2506 for (x_start = 0; colnum < column; colnum++)
2507 {
2508 wxDataViewColumn *col = GetOwner()->GetColumnAt(colnum);
2509 if (col->IsHidden())
2510 continue; // skip it!
2511
2512 w = col->GetWidth();
2513 x_start += w;
2514 }
2515
2516 int x_end = x_start + w;
2517 xe = xx + rect.width;
2518 if( x_end > xe )
2519 {
2520 sx = ( xx + x_end - xe )/x;
2521 }
2522 if( x_start < xx )
2523 {
2524 sx = x_start/x;
2525 }
2526 }
2527 m_owner->Scroll( sx, sy );
2528 }
2529
2530 int wxDataViewMainWindow::GetCountPerPage() const
2531 {
2532 wxSize size = GetClientSize();
2533 return size.y / m_lineHeight;
2534 }
2535
2536 int wxDataViewMainWindow::GetEndOfLastCol() const
2537 {
2538 int width = 0;
2539 unsigned int i;
2540 for (i = 0; i < GetOwner()->GetColumnCount(); i++)
2541 {
2542 const wxDataViewColumn *c =
2543 const_cast<wxDataViewCtrl*>(GetOwner())->GetColumnAt( i );
2544
2545 if (!c->IsHidden())
2546 width += c->GetWidth();
2547 }
2548 return width;
2549 }
2550
2551 unsigned int wxDataViewMainWindow::GetFirstVisibleRow() const
2552 {
2553 int x = 0;
2554 int y = 0;
2555 m_owner->CalcUnscrolledPosition( x, y, &x, &y );
2556
2557 return GetLineAt( y );
2558 }
2559
2560 unsigned int wxDataViewMainWindow::GetLastVisibleRow()
2561 {
2562 wxSize client_size = GetClientSize();
2563 m_owner->CalcUnscrolledPosition( client_size.x, client_size.y,
2564 &client_size.x, &client_size.y );
2565
2566 // we should deal with the pixel here
2567 unsigned int row = GetLineAt(client_size.y) - 1;
2568
2569 return wxMin( GetRowCount()-1, row );
2570 }
2571
2572 unsigned int wxDataViewMainWindow::GetRowCount()
2573 {
2574 if ( m_count == -1 )
2575 {
2576 m_count = RecalculateCount();
2577 UpdateDisplay();
2578 }
2579 return m_count;
2580 }
2581
2582 void wxDataViewMainWindow::ChangeCurrentRow( unsigned int row )
2583 {
2584 m_currentRow = row;
2585
2586 // send event
2587 }
2588
2589 void wxDataViewMainWindow::SelectAllRows( bool on )
2590 {
2591 if (IsEmpty())
2592 return;
2593
2594 if (on)
2595 {
2596 m_selection.Clear();
2597 for (unsigned int i = 0; i < GetRowCount(); i++)
2598 m_selection.Add( i );
2599 Refresh();
2600 }
2601 else
2602 {
2603 unsigned int first_visible = GetFirstVisibleRow();
2604 unsigned int last_visible = GetLastVisibleRow();
2605 unsigned int i;
2606 for (i = 0; i < m_selection.GetCount(); i++)
2607 {
2608 unsigned int row = m_selection[i];
2609 if ((row >= first_visible) && (row <= last_visible))
2610 RefreshRow( row );
2611 }
2612 m_selection.Clear();
2613 }
2614 }
2615
2616 void wxDataViewMainWindow::SelectRow( unsigned int row, bool on )
2617 {
2618 if (m_selection.Index( row ) == wxNOT_FOUND)
2619 {
2620 if (on)
2621 {
2622 m_selection.Add( row );
2623 RefreshRow( row );
2624 }
2625 }
2626 else
2627 {
2628 if (!on)
2629 {
2630 m_selection.Remove( row );
2631 RefreshRow( row );
2632 }
2633 }
2634 }
2635
2636 void wxDataViewMainWindow::SelectRows( unsigned int from, unsigned int to, bool on )
2637 {
2638 if (from > to)
2639 {
2640 unsigned int tmp = from;
2641 from = to;
2642 to = tmp;
2643 }
2644
2645 unsigned int i;
2646 for (i = from; i <= to; i++)
2647 {
2648 if (m_selection.Index( i ) == wxNOT_FOUND)
2649 {
2650 if (on)
2651 m_selection.Add( i );
2652 }
2653 else
2654 {
2655 if (!on)
2656 m_selection.Remove( i );
2657 }
2658 }
2659 RefreshRows( from, to );
2660 }
2661
2662 void wxDataViewMainWindow::Select( const wxArrayInt& aSelections )
2663 {
2664 for (size_t i=0; i < aSelections.GetCount(); i++)
2665 {
2666 int n = aSelections[i];
2667
2668 m_selection.Add( n );
2669 RefreshRow( n );
2670 }
2671 }
2672
2673 void wxDataViewMainWindow::ReverseRowSelection( unsigned int row )
2674 {
2675 if (m_selection.Index( row ) == wxNOT_FOUND)
2676 m_selection.Add( row );
2677 else
2678 m_selection.Remove( row );
2679 RefreshRow( row );
2680 }
2681
2682 bool wxDataViewMainWindow::IsRowSelected( unsigned int row )
2683 {
2684 return (m_selection.Index( row ) != wxNOT_FOUND);
2685 }
2686
2687 void wxDataViewMainWindow::SendSelectionChangedEvent( const wxDataViewItem& item)
2688 {
2689 wxWindow *parent = GetParent();
2690 wxDataViewEvent le(wxEVT_COMMAND_DATAVIEW_SELECTION_CHANGED, parent->GetId());
2691
2692 le.SetEventObject(parent);
2693 le.SetModel(GetModel());
2694 le.SetItem( item );
2695
2696 parent->ProcessWindowEvent(le);
2697 }
2698
2699 void wxDataViewMainWindow::RefreshRow( unsigned int row )
2700 {
2701 wxRect rect( 0, GetLineStart( row ), GetEndOfLastCol(), GetLineHeight( row ) );
2702 m_owner->CalcScrolledPosition( rect.x, rect.y, &rect.x, &rect.y );
2703
2704 wxSize client_size = GetClientSize();
2705 wxRect client_rect( 0, 0, client_size.x, client_size.y );
2706 wxRect intersect_rect = client_rect.Intersect( rect );
2707 if (intersect_rect.width > 0)
2708 Refresh( true, &intersect_rect );
2709 }
2710
2711 void wxDataViewMainWindow::RefreshRows( unsigned int from, unsigned int to )
2712 {
2713 if (from > to)
2714 {
2715 unsigned int tmp = to;
2716 to = from;
2717 from = tmp;
2718 }
2719
2720 wxRect rect( 0, GetLineStart( from ), GetEndOfLastCol(), GetLineStart( (to-from+1) ) );
2721 m_owner->CalcScrolledPosition( rect.x, rect.y, &rect.x, &rect.y );
2722
2723 wxSize client_size = GetClientSize();
2724 wxRect client_rect( 0, 0, client_size.x, client_size.y );
2725 wxRect intersect_rect = client_rect.Intersect( rect );
2726 if (intersect_rect.width > 0)
2727 Refresh( true, &intersect_rect );
2728 }
2729
2730 void wxDataViewMainWindow::RefreshRowsAfter( unsigned int firstRow )
2731 {
2732 wxSize client_size = GetClientSize();
2733 int start = GetLineStart( firstRow );
2734 m_owner->CalcScrolledPosition( start, 0, &start, NULL );
2735 if (start > client_size.y) return;
2736
2737 wxRect rect( 0, start, client_size.x, client_size.y - start );
2738
2739 Refresh( true, &rect );
2740 }
2741
2742 wxRect wxDataViewMainWindow::GetLineRect( unsigned int row ) const
2743 {
2744 wxRect rect;
2745 rect.x = 0;
2746 rect.y = GetLineStart( row );
2747 rect.width = GetEndOfLastCol();
2748 rect.height = GetLineHeight( row );
2749
2750 return rect;
2751 }
2752
2753 int wxDataViewMainWindow::GetLineStart( unsigned int row ) const
2754 {
2755 const wxDataViewModel *model = GetModel();
2756
2757 if (GetOwner()->GetWindowStyle() & wxDV_VARIABLE_LINE_HEIGHT)
2758 {
2759 // TODO make more efficient
2760
2761 int start = 0;
2762
2763 unsigned int r;
2764 for (r = 0; r < row; r++)
2765 {
2766 const wxDataViewTreeNode* node = GetTreeNodeByRow(r);
2767 if (!node) return start;
2768
2769 wxDataViewItem item = node->GetItem();
2770
2771 unsigned int cols = GetOwner()->GetColumnCount();
2772 unsigned int col;
2773 int height = m_lineHeight;
2774 for (col = 0; col < cols; col++)
2775 {
2776 const wxDataViewColumn *column = GetOwner()->GetColumn(col);
2777 if (column->IsHidden())
2778 continue; // skip it!
2779
2780 if ((col != 0) &&
2781 model->IsContainer(item) &&
2782 !model->HasContainerColumns(item))
2783 continue; // skip it!
2784
2785 wxDataViewRenderer *renderer =
2786 const_cast<wxDataViewRenderer*>(column->GetRenderer());
2787 renderer->PrepareForItem(model, item, column->GetModelColumn());
2788
2789 height = wxMax( height, renderer->GetSize().y );
2790 }
2791
2792 start += height;
2793 }
2794
2795 return start;
2796 }
2797 else
2798 {
2799 return row * m_lineHeight;
2800 }
2801 }
2802
2803 int wxDataViewMainWindow::GetLineAt( unsigned int y ) const
2804 {
2805 const wxDataViewModel *model = GetModel();
2806
2807 // check for the easy case first
2808 if ( !GetOwner()->HasFlag(wxDV_VARIABLE_LINE_HEIGHT) )
2809 return y / m_lineHeight;
2810
2811 // TODO make more efficient
2812 unsigned int row = 0;
2813 unsigned int yy = 0;
2814 for (;;)
2815 {
2816 const wxDataViewTreeNode* node = GetTreeNodeByRow(row);
2817 if (!node)
2818 {
2819 // not really correct...
2820 return row + ((y-yy) / m_lineHeight);
2821 }
2822
2823 wxDataViewItem item = node->GetItem();
2824
2825 unsigned int cols = GetOwner()->GetColumnCount();
2826 unsigned int col;
2827 int height = m_lineHeight;
2828 for (col = 0; col < cols; col++)
2829 {
2830 const wxDataViewColumn *column = GetOwner()->GetColumn(col);
2831 if (column->IsHidden())
2832 continue; // skip it!
2833
2834 if ((col != 0) &&
2835 model->IsContainer(item) &&
2836 !model->HasContainerColumns(item))
2837 continue; // skip it!
2838
2839 wxDataViewRenderer *renderer =
2840 const_cast<wxDataViewRenderer*>(column->GetRenderer());
2841 renderer->PrepareForItem(model, item, column->GetModelColumn());
2842
2843 height = wxMax( height, renderer->GetSize().y );
2844 }
2845
2846 yy += height;
2847 if (y < yy)
2848 return row;
2849
2850 row++;
2851 }
2852 }
2853
2854 int wxDataViewMainWindow::GetLineHeight( unsigned int row ) const
2855 {
2856 const wxDataViewModel *model = GetModel();
2857
2858 if (GetOwner()->GetWindowStyle() & wxDV_VARIABLE_LINE_HEIGHT)
2859 {
2860 wxASSERT( !IsVirtualList() );
2861
2862 const wxDataViewTreeNode* node = GetTreeNodeByRow(row);
2863 // wxASSERT( node );
2864 if (!node) return m_lineHeight;
2865
2866 wxDataViewItem item = node->GetItem();
2867
2868 int height = m_lineHeight;
2869
2870 unsigned int cols = GetOwner()->GetColumnCount();
2871 unsigned int col;
2872 for (col = 0; col < cols; col++)
2873 {
2874 const wxDataViewColumn *column = GetOwner()->GetColumn(col);
2875 if (column->IsHidden())
2876 continue; // skip it!
2877
2878 if ((col != 0) &&
2879 model->IsContainer(item) &&
2880 !model->HasContainerColumns(item))
2881 continue; // skip it!
2882
2883 wxDataViewRenderer *renderer =
2884 const_cast<wxDataViewRenderer*>(column->GetRenderer());
2885 renderer->PrepareForItem(model, item, column->GetModelColumn());
2886
2887 height = wxMax( height, renderer->GetSize().y );
2888 }
2889
2890 return height;
2891 }
2892 else
2893 {
2894 return m_lineHeight;
2895 }
2896 }
2897
2898
2899 class RowToTreeNodeJob: public DoJob
2900 {
2901 public:
2902 RowToTreeNodeJob( unsigned int row , int current, wxDataViewTreeNode * node )
2903 {
2904 this->row = row;
2905 this->current = current;
2906 ret = NULL;
2907 parent = node;
2908 }
2909
2910 virtual int operator() ( wxDataViewTreeNode * node )
2911 {
2912 current ++;
2913 if( current == static_cast<int>(row))
2914 {
2915 ret = node;
2916 return DoJob::DONE;
2917 }
2918
2919 if( node->GetSubTreeCount() + current < static_cast<int>(row) )
2920 {
2921 current += node->GetSubTreeCount();
2922 return DoJob::SKIP_SUBTREE;
2923 }
2924 else
2925 {
2926 parent = node;
2927
2928 // If the current node has only leaf children, we can find the
2929 // desired node directly. This can speed up finding the node
2930 // in some cases, and will have a very good effect for list views.
2931 if ( node->HasChildren() &&
2932 (int)node->GetChildNodes().size() == node->GetSubTreeCount() )
2933 {
2934 const int index = static_cast<int>(row) - current - 1;
2935 ret = node->GetChildNodes()[index];
2936 return DoJob::DONE;
2937 }
2938
2939 return DoJob::CONTINUE;
2940 }
2941 }
2942
2943 wxDataViewTreeNode * GetResult() const
2944 { return ret; }
2945
2946 private:
2947 unsigned int row;
2948 int current;
2949 wxDataViewTreeNode * ret;
2950 wxDataViewTreeNode * parent;
2951 };
2952
2953 wxDataViewTreeNode * wxDataViewMainWindow::GetTreeNodeByRow(unsigned int row) const
2954 {
2955 wxASSERT( !IsVirtualList() );
2956
2957 RowToTreeNodeJob job( row , -2, m_root );
2958 Walker( m_root , job );
2959 return job.GetResult();
2960 }
2961
2962 wxDataViewItem wxDataViewMainWindow::GetItemByRow(unsigned int row) const
2963 {
2964 if (IsVirtualList())
2965 {
2966 return wxDataViewItem( wxUIntToPtr(row+1) );
2967 }
2968 else
2969 {
2970 wxDataViewTreeNode *node = GetTreeNodeByRow(row);
2971 return node ? node->GetItem() : wxDataViewItem();
2972 }
2973 }
2974
2975 bool
2976 wxDataViewMainWindow::SendExpanderEvent(wxEventType type,
2977 const wxDataViewItem& item)
2978 {
2979 wxWindow *parent = GetParent();
2980 wxDataViewEvent le(type, parent->GetId());
2981
2982 le.SetEventObject(parent);
2983 le.SetModel(GetModel());
2984 le.SetItem( item );
2985
2986 return !parent->ProcessWindowEvent(le) || le.IsAllowed();
2987 }
2988
2989 bool wxDataViewMainWindow::IsExpanded( unsigned int row ) const
2990 {
2991 if (IsList())
2992 return false;
2993
2994 wxDataViewTreeNode * node = GetTreeNodeByRow(row);
2995 if (!node)
2996 return false;
2997
2998 if (!node->HasChildren())
2999 return false;
3000
3001 return node->IsOpen();
3002 }
3003
3004 bool wxDataViewMainWindow::HasChildren( unsigned int row ) const
3005 {
3006 if (IsList())
3007 return false;
3008
3009 wxDataViewTreeNode * node = GetTreeNodeByRow(row);
3010 if (!node)
3011 return false;
3012
3013 if (!node->HasChildren())
3014 return false;
3015
3016 return true;
3017 }
3018
3019 void wxDataViewMainWindow::Expand( unsigned int row )
3020 {
3021 if (IsList())
3022 return;
3023
3024 wxDataViewTreeNode * node = GetTreeNodeByRow(row);
3025 if (!node)
3026 return;
3027
3028 if (!node->HasChildren())
3029 return;
3030
3031 if (!node->IsOpen())
3032 {
3033 if ( !SendExpanderEvent(wxEVT_COMMAND_DATAVIEW_ITEM_EXPANDING, node->GetItem()) )
3034 {
3035 // Vetoed by the event handler.
3036 return;
3037 }
3038
3039 node->ToggleOpen();
3040
3041 // build the children of current node
3042 if( node->GetChildNodes().empty() )
3043 {
3044 SortPrepare();
3045 ::BuildTreeHelper(GetModel(), node->GetItem(), node);
3046 }
3047
3048 // By expanding the node all row indices that are currently in the selection list
3049 // and are greater than our node have become invalid. So we have to correct that now.
3050 const unsigned rowAdjustment = node->GetSubTreeCount();
3051 for(unsigned i=0; i<m_selection.size(); ++i)
3052 {
3053 const unsigned testRow = m_selection[i];
3054 // all rows above us are not affected, so skip them
3055 if(testRow <= row)
3056 continue;
3057
3058 m_selection[i] += rowAdjustment;
3059 }
3060
3061 if(m_currentRow > row)
3062 ChangeCurrentRow(m_currentRow + rowAdjustment);
3063
3064 m_count = -1;
3065 UpdateDisplay();
3066 // Send the expanded event
3067 SendExpanderEvent(wxEVT_COMMAND_DATAVIEW_ITEM_EXPANDED,node->GetItem());
3068 }
3069 }
3070
3071 void wxDataViewMainWindow::Collapse(unsigned int row)
3072 {
3073 if (IsList())
3074 return;
3075
3076 wxDataViewTreeNode *node = GetTreeNodeByRow(row);
3077 if (!node)
3078 return;
3079
3080 if (!node->HasChildren())
3081 return;
3082
3083 if (node->IsOpen())
3084 {
3085 if ( !SendExpanderEvent(wxEVT_COMMAND_DATAVIEW_ITEM_COLLAPSING,node->GetItem()) )
3086 {
3087 // Vetoed by the event handler.
3088 return;
3089 }
3090
3091 // Find out if there are selected items below the current node.
3092 bool selectCollapsingRow = false;
3093 const unsigned rowAdjustment = node->GetSubTreeCount();
3094 unsigned maxRowToBeTested = row + rowAdjustment;
3095 for(unsigned i=0; i<m_selection.size(); ++i)
3096 {
3097 const unsigned testRow = m_selection[i];
3098 if(testRow > row && testRow <= maxRowToBeTested)
3099 {
3100 selectCollapsingRow = true;
3101 // get out as soon as we have found a node that is selected
3102 break;
3103 }
3104 }
3105
3106 node->ToggleOpen();
3107
3108 // If the node to be closed has selected items the user won't see those any longer.
3109 // We select the collapsing node in this case.
3110 if(selectCollapsingRow)
3111 {
3112 SelectAllRows(false);
3113 ChangeCurrentRow(row);
3114 SelectRow(row, true);
3115 SendSelectionChangedEvent(GetItemByRow(row));
3116 }
3117 else
3118 {
3119 // if there were no selected items below our node we still need to "fix" the
3120 // selection list to adjust for the changing of the row indices.
3121 // We actually do the opposite of what we are doing in Expand().
3122 for(unsigned i=0; i<m_selection.size(); ++i)
3123 {
3124 const unsigned testRow = m_selection[i];
3125 // all rows above us are not affected, so skip them
3126 if(testRow <= row)
3127 continue;
3128
3129 m_selection[i] -= rowAdjustment;
3130 }
3131
3132 // if the "current row" is being collapsed away we change it to the current row ;-)
3133 if(m_currentRow > row && m_currentRow <= maxRowToBeTested)
3134 ChangeCurrentRow(row);
3135 else if(m_currentRow > row)
3136 ChangeCurrentRow(m_currentRow - rowAdjustment);
3137 }
3138
3139 m_count = -1;
3140 UpdateDisplay();
3141 SendExpanderEvent(wxEVT_COMMAND_DATAVIEW_ITEM_COLLAPSED,node->GetItem());
3142 }
3143 }
3144
3145 wxDataViewTreeNode * wxDataViewMainWindow::FindNode( const wxDataViewItem & item )
3146 {
3147 const wxDataViewModel * model = GetModel();
3148 if( model == NULL )
3149 return NULL;
3150
3151 if (!item.IsOk())
3152 return m_root;
3153
3154 // Compose the parent-chain for the item we are looking for
3155 wxVector<wxDataViewItem> parentChain;
3156 wxDataViewItem it( item );
3157 while( it.IsOk() )
3158 {
3159 parentChain.push_back(it);
3160 it = model->GetParent(it);
3161 }
3162
3163 // Find the item along the parent-chain.
3164 // This algorithm is designed to speed up the node-finding method
3165 wxDataViewTreeNode* node = m_root;
3166 for( unsigned iter = parentChain.size()-1; ; --iter )
3167 {
3168 if( node->HasChildren() )
3169 {
3170 if( node->GetChildNodes().empty() )
3171 {
3172 // Even though the item is a container, it doesn't have any
3173 // child nodes in the control's representation yet. We have
3174 // to realize its subtree now.
3175 SortPrepare();
3176 ::BuildTreeHelper(model, node->GetItem(), node);
3177 }
3178
3179 const wxDataViewTreeNodes& nodes = node->GetChildNodes();
3180 bool found = false;
3181
3182 for (unsigned i = 0; i < nodes.GetCount(); ++i)
3183 {
3184 wxDataViewTreeNode* currentNode = nodes[i];
3185 if (currentNode->GetItem() == parentChain[iter])
3186 {
3187 if (currentNode->GetItem() == item)
3188 return currentNode;
3189
3190 node = currentNode;
3191 found = true;
3192 break;
3193 }
3194 }
3195 if (!found)
3196 return NULL;
3197 }
3198 else
3199 return NULL;
3200
3201 if ( !iter )
3202 break;
3203 }
3204 return NULL;
3205 }
3206
3207 void wxDataViewMainWindow::HitTest( const wxPoint & point, wxDataViewItem & item,
3208 wxDataViewColumn* &column )
3209 {
3210 wxDataViewColumn *col = NULL;
3211 unsigned int cols = GetOwner()->GetColumnCount();
3212 unsigned int colnum = 0;
3213 int x, y;
3214 m_owner->CalcUnscrolledPosition( point.x, point.y, &x, &y );
3215 for (unsigned x_start = 0; colnum < cols; colnum++)
3216 {
3217 col = GetOwner()->GetColumnAt(colnum);
3218 if (col->IsHidden())
3219 continue; // skip it!
3220
3221 unsigned int w = col->GetWidth();
3222 if (x_start+w >= (unsigned int)x)
3223 break;
3224
3225 x_start += w;
3226 }
3227
3228 column = col;
3229 item = GetItemByRow( GetLineAt( y ) );
3230 }
3231
3232 wxRect wxDataViewMainWindow::GetItemRect( const wxDataViewItem & item,
3233 const wxDataViewColumn* column )
3234 {
3235 int xpos = 0;
3236 int width = 0;
3237
3238 unsigned int cols = GetOwner()->GetColumnCount();
3239 // If column is null the loop will compute the combined width of all columns.
3240 // Otherwise, it will compute the x position of the column we are looking for.
3241 for (unsigned int i = 0; i < cols; i++)
3242 {
3243 wxDataViewColumn* col = GetOwner()->GetColumnAt( i );
3244
3245 if (col == column)
3246 break;
3247
3248 if (col->IsHidden())
3249 continue; // skip it!
3250
3251 xpos += col->GetWidth();
3252 width += col->GetWidth();
3253 }
3254
3255 if(column != 0)
3256 {
3257 // If we have a column, we need can get its width directly.
3258 if(column->IsHidden())
3259 width = 0;
3260 else
3261 width = column->GetWidth();
3262
3263 }
3264 else
3265 {
3266 // If we have no column, we reset the x position back to zero.
3267 xpos = 0;
3268 }
3269
3270 // we have to take an expander column into account and compute its indentation
3271 // to get the correct x position where the actual text is
3272 int indent = 0;
3273 int row = GetRowByItem(item);
3274 if (!IsList() &&
3275 (column == 0 || GetExpanderColumnOrFirstOne(GetOwner()) == column) )
3276 {
3277 wxDataViewTreeNode* node = GetTreeNodeByRow(row);
3278 indent = GetOwner()->GetIndent() * node->GetIndentLevel();
3279 indent = indent + m_lineHeight; // use m_lineHeight as the width of the expander
3280 }
3281
3282 wxRect itemRect( xpos + indent,
3283 GetLineStart( row ),
3284 width - indent,
3285 GetLineHeight( row ) );
3286
3287 GetOwner()->CalcScrolledPosition( itemRect.x, itemRect.y,
3288 &itemRect.x, &itemRect.y );
3289
3290 return itemRect;
3291 }
3292
3293 int wxDataViewMainWindow::RecalculateCount()
3294 {
3295 if (IsVirtualList())
3296 {
3297 wxDataViewVirtualListModel *list_model =
3298 (wxDataViewVirtualListModel*) GetModel();
3299
3300 return list_model->GetCount();
3301 }
3302 else
3303 {
3304 return m_root->GetSubTreeCount();
3305 }
3306 }
3307
3308 class ItemToRowJob : public DoJob
3309 {
3310 public:
3311 ItemToRowJob(const wxDataViewItem& item_, wxVector<wxDataViewItem>::reverse_iterator iter)
3312 : m_iter(iter),
3313 item(item_)
3314 {
3315 ret = -1;
3316 }
3317
3318 // Maybe binary search will help to speed up this process
3319 virtual int operator() ( wxDataViewTreeNode * node)
3320 {
3321 ret ++;
3322 if( node->GetItem() == item )
3323 {
3324 return DoJob::DONE;
3325 }
3326
3327 if( node->GetItem() == *m_iter )
3328 {
3329 m_iter++;
3330 return DoJob::CONTINUE;
3331 }
3332 else
3333 {
3334 ret += node->GetSubTreeCount();
3335 return DoJob::SKIP_SUBTREE;
3336 }
3337
3338 }
3339
3340 // the row number is begin from zero
3341 int GetResult() const
3342 { return ret -1; }
3343
3344 private:
3345 wxVector<wxDataViewItem>::reverse_iterator m_iter;
3346 wxDataViewItem item;
3347 int ret;
3348
3349 };
3350
3351 int wxDataViewMainWindow::GetRowByItem(const wxDataViewItem & item) const
3352 {
3353 const wxDataViewModel * model = GetModel();
3354 if( model == NULL )
3355 return -1;
3356
3357 if (IsVirtualList())
3358 {
3359 return wxPtrToUInt( item.GetID() ) -1;
3360 }
3361 else
3362 {
3363 if( !item.IsOk() )
3364 return -1;
3365
3366 // Compose the parent-chain of the item we are looking for
3367 wxVector<wxDataViewItem> parentChain;
3368 wxDataViewItem it( item );
3369 while( it.IsOk() )
3370 {
3371 parentChain.push_back(it);
3372 it = model->GetParent(it);
3373 }
3374
3375 // add an 'invalid' item to represent our 'invisible' root node
3376 parentChain.push_back(wxDataViewItem());
3377
3378 // the parent chain was created by adding the deepest parent first.
3379 // so if we want to start at the root node, we have to iterate backwards through the vector
3380 ItemToRowJob job( item, parentChain.rbegin() );
3381 Walker( m_root, job );
3382 return job.GetResult();
3383 }
3384 }
3385
3386 static void BuildTreeHelper( const wxDataViewModel * model, const wxDataViewItem & item,
3387 wxDataViewTreeNode * node)
3388 {
3389 if( !model->IsContainer( item ) )
3390 return;
3391
3392 wxDataViewItemArray children;
3393 unsigned int num = model->GetChildren( item, children);
3394
3395 for ( unsigned int index = 0; index < num; index++ )
3396 {
3397 wxDataViewTreeNode *n = new wxDataViewTreeNode(node, children[index]);
3398
3399 if( model->IsContainer(children[index]) )
3400 n->SetHasChildren( true );
3401
3402 node->InsertChild(n, index);
3403 }
3404
3405 wxASSERT( node->IsOpen() );
3406 node->ChangeSubTreeCount(+num);
3407 }
3408
3409 void wxDataViewMainWindow::BuildTree(wxDataViewModel * model)
3410 {
3411 DestroyTree();
3412
3413 if (GetModel()->IsVirtualListModel())
3414 {
3415 m_count = -1;
3416 return;
3417 }
3418
3419 m_root = wxDataViewTreeNode::CreateRootNode();
3420
3421 // First we define a invalid item to fetch the top-level elements
3422 wxDataViewItem item;
3423 SortPrepare();
3424 BuildTreeHelper( model, item, m_root);
3425 m_count = -1;
3426 }
3427
3428 void wxDataViewMainWindow::DestroyTree()
3429 {
3430 if (!IsVirtualList())
3431 {
3432 wxDELETE(m_root);
3433 m_count = 0;
3434 }
3435 }
3436
3437 wxDataViewColumn*
3438 wxDataViewMainWindow::FindColumnForEditing(const wxDataViewItem& item, wxDataViewCellMode mode)
3439 {
3440 // Edit the current column editable in 'mode'. If no column is focused
3441 // (typically because the user has full row selected), try to find the
3442 // first editable column (this would typically be a checkbox for
3443 // wxDATAVIEW_CELL_ACTIVATABLE and we don't want to force the user to set
3444 // focus on the checkbox column; or on the only editable text column).
3445
3446 wxDataViewColumn *candidate = m_currentCol;
3447
3448 if ( candidate &&
3449 !IsCellEditableInMode(item, candidate, mode) &&
3450 !m_currentColSetByKeyboard )
3451 {
3452 // If current column was set by mouse to something not editable (in
3453 // 'mode') and the user pressed Space/F2 to edit it, treat the
3454 // situation as if there was whole-row focus, because that's what is
3455 // visually indicated and the mouse click could very well be targeted
3456 // on the row rather than on an individual cell.
3457 //
3458 // But if it was done by keyboard, respect that even if the column
3459 // isn't editable, because focus is visually on that column and editing
3460 // something else would be surprising.
3461 candidate = NULL;
3462 }
3463
3464 if ( !candidate )
3465 {
3466 const unsigned cols = GetOwner()->GetColumnCount();
3467 for ( unsigned i = 0; i < cols; i++ )
3468 {
3469 wxDataViewColumn *c = GetOwner()->GetColumnAt(i);
3470 if ( c->IsHidden() )
3471 continue;
3472
3473 if ( IsCellEditableInMode(item, c, mode) )
3474 {
3475 candidate = c;
3476 break;
3477 }
3478 }
3479 }
3480
3481 // If on container item without columns, only the expander column
3482 // may be directly editable:
3483 if ( candidate &&
3484 GetOwner()->GetExpanderColumn() != candidate &&
3485 GetModel()->IsContainer(item) &&
3486 !GetModel()->HasContainerColumns(item) )
3487 {
3488 candidate = GetOwner()->GetExpanderColumn();
3489 }
3490
3491 if ( !candidate )
3492 return NULL;
3493
3494 if ( !IsCellEditableInMode(item, candidate, mode) )
3495 return NULL;
3496
3497 return candidate;
3498 }
3499
3500 bool wxDataViewMainWindow::IsCellEditableInMode(const wxDataViewItem& item,
3501 const wxDataViewColumn *col,
3502 wxDataViewCellMode mode) const
3503 {
3504 if ( col->GetRenderer()->GetMode() != mode )
3505 return false;
3506
3507 if ( !GetModel()->IsEnabled(item, col->GetModelColumn()) )
3508 return false;
3509
3510 return true;
3511 }
3512
3513 void wxDataViewMainWindow::OnCharHook(wxKeyEvent& event)
3514 {
3515 if ( m_editorCtrl )
3516 {
3517 // Handle any keys special for the in-place editor and return without
3518 // calling Skip() below.
3519 switch ( event.GetKeyCode() )
3520 {
3521 case WXK_ESCAPE:
3522 m_editorRenderer->CancelEditing();
3523 return;
3524
3525 case WXK_RETURN:
3526 m_editorRenderer->FinishEditing();
3527 return;
3528 }
3529 }
3530
3531 event.Skip();
3532 }
3533
3534 void wxDataViewMainWindow::OnChar( wxKeyEvent &event )
3535 {
3536 wxWindow * const parent = GetParent();
3537
3538 // propagate the char event upwards
3539 wxKeyEvent eventForParent(event);
3540 eventForParent.SetEventObject(parent);
3541 if ( parent->ProcessWindowEvent(eventForParent) )
3542 return;
3543
3544 if ( parent->HandleAsNavigationKey(event) )
3545 return;
3546
3547 // no item -> nothing to do
3548 if (!HasCurrentRow())
3549 {
3550 event.Skip();
3551 return;
3552 }
3553
3554 // don't use m_linesPerPage directly as it might not be computed yet
3555 const int pageSize = GetCountPerPage();
3556 wxCHECK_RET( pageSize, wxT("should have non zero page size") );
3557
3558 switch ( event.GetKeyCode() )
3559 {
3560 case WXK_RETURN:
3561 if ( event.HasModifiers() )
3562 {
3563 event.Skip();
3564 break;
3565 }
3566 else
3567 {
3568 // Enter activates the item, i.e. sends wxEVT_COMMAND_DATAVIEW_ITEM_ACTIVATED to
3569 // it. Only if that event is not handled do we activate column renderer (which
3570 // is normally done by Space) or even inline editing.
3571
3572 const wxDataViewItem item = GetItemByRow(m_currentRow);
3573
3574 wxDataViewEvent le(wxEVT_COMMAND_DATAVIEW_ITEM_ACTIVATED,
3575 parent->GetId());
3576 le.SetItem(item);
3577 le.SetEventObject(parent);
3578 le.SetModel(GetModel());
3579
3580 if ( parent->ProcessWindowEvent(le) )
3581 break;
3582 // else: fall through to WXK_SPACE handling
3583 }
3584
3585 case WXK_SPACE:
3586 if ( event.HasModifiers() )
3587 {
3588 event.Skip();
3589 break;
3590 }
3591 else
3592 {
3593 // Space toggles activatable items or -- if not activatable --
3594 // starts inline editing (this is normally done using F2 on
3595 // Windows, but Space is common everywhere else, so use it too
3596 // for greater cross-platform compatibility).
3597
3598 const wxDataViewItem item = GetItemByRow(m_currentRow);
3599
3600 // Activate the current activatable column. If not column is focused (typically
3601 // because the user has full row selected), try to find the first activatable
3602 // column (this would typically be a checkbox and we don't want to force the user
3603 // to set focus on the checkbox column).
3604 wxDataViewColumn *activatableCol = FindColumnForEditing(item, wxDATAVIEW_CELL_ACTIVATABLE);
3605
3606 if ( activatableCol )
3607 {
3608 const unsigned colIdx = activatableCol->GetModelColumn();
3609 const wxRect cell_rect = GetOwner()->GetItemRect(item, activatableCol);
3610
3611 wxDataViewRenderer *cell = activatableCol->GetRenderer();
3612 cell->PrepareForItem(GetModel(), item, colIdx);
3613 cell->WXActivateCell(cell_rect, GetModel(), item, colIdx, NULL);
3614
3615 break;
3616 }
3617 // else: fall through to WXK_F2 handling
3618 }
3619
3620 case WXK_F2:
3621 if ( event.HasModifiers() )
3622 {
3623 event.Skip();
3624 break;
3625 }
3626 else
3627 {
3628 if( !m_selection.empty() )
3629 {
3630 // Mimic Windows 7 behavior: edit the item that has focus
3631 // if it is selected and the first selected item if focus
3632 // is out of selection.
3633 int sel;
3634 if ( m_selection.Index(m_currentRow) != wxNOT_FOUND )
3635 sel = m_currentRow;
3636 else
3637 sel = m_selection[0];
3638
3639
3640 const wxDataViewItem item = GetItemByRow(sel);
3641
3642 // Edit the current column. If no column is focused
3643 // (typically because the user has full row selected), try
3644 // to find the first editable column.
3645 wxDataViewColumn *editableCol = FindColumnForEditing(item, wxDATAVIEW_CELL_EDITABLE);
3646
3647 if ( editableCol )
3648 GetOwner()->EditItem(item, editableCol);
3649 }
3650 }
3651 break;
3652
3653 case WXK_UP:
3654 if ( m_currentRow > 0 )
3655 OnVerticalNavigation( m_currentRow - 1, event );
3656 break;
3657
3658 case WXK_DOWN:
3659 if ( m_currentRow + 1 < GetRowCount() )
3660 OnVerticalNavigation( m_currentRow + 1, event );
3661 break;
3662 // Add the process for tree expanding/collapsing
3663 case WXK_LEFT:
3664 OnLeftKey();
3665 break;
3666
3667 case WXK_RIGHT:
3668 OnRightKey();
3669 break;
3670
3671 case WXK_END:
3672 {
3673 if (!IsEmpty())
3674 OnVerticalNavigation( GetRowCount() - 1, event );
3675 break;
3676 }
3677 case WXK_HOME:
3678 if (!IsEmpty())
3679 OnVerticalNavigation( 0, event );
3680 break;
3681
3682 case WXK_PAGEUP:
3683 {
3684 int steps = pageSize - 1;
3685 int index = m_currentRow - steps;
3686 if (index < 0)
3687 index = 0;
3688
3689 OnVerticalNavigation( index, event );
3690 }
3691 break;
3692
3693 case WXK_PAGEDOWN:
3694 {
3695 int steps = pageSize - 1;
3696 unsigned int index = m_currentRow + steps;
3697 unsigned int count = GetRowCount();
3698 if ( index >= count )
3699 index = count - 1;
3700
3701 OnVerticalNavigation( index, event );
3702 }
3703 break;
3704
3705 default:
3706 event.Skip();
3707 }
3708 }
3709
3710 void wxDataViewMainWindow::OnVerticalNavigation(unsigned int newCurrent, const wxKeyEvent& event)
3711 {
3712 wxCHECK_RET( newCurrent < GetRowCount(),
3713 wxT("invalid item index in OnVerticalNavigation()") );
3714
3715 // if there is no selection, we cannot move it anywhere
3716 if (!HasCurrentRow())
3717 return;
3718
3719 unsigned int oldCurrent = m_currentRow;
3720
3721 // in single selection we just ignore Shift as we can't select several
3722 // items anyhow
3723 if ( event.ShiftDown() && !IsSingleSel() )
3724 {
3725 RefreshRow( oldCurrent );
3726
3727 ChangeCurrentRow( newCurrent );
3728
3729 // select all the items between the old and the new one
3730 if ( oldCurrent > newCurrent )
3731 {
3732 newCurrent = oldCurrent;
3733 oldCurrent = m_currentRow;
3734 }
3735
3736 SelectRows( oldCurrent, newCurrent, true );
3737 if (oldCurrent!=newCurrent)
3738 SendSelectionChangedEvent(GetItemByRow(m_selection[0]));
3739 }
3740 else // !shift
3741 {
3742 RefreshRow( oldCurrent );
3743
3744 // all previously selected items are unselected unless ctrl is held
3745 if ( !event.ControlDown() )
3746 SelectAllRows(false);
3747
3748 ChangeCurrentRow( newCurrent );
3749
3750 if ( !event.ControlDown() )
3751 {
3752 SelectRow( m_currentRow, true );
3753 SendSelectionChangedEvent(GetItemByRow(m_currentRow));
3754 }
3755 else
3756 RefreshRow( m_currentRow );
3757 }
3758
3759 GetOwner()->EnsureVisible( m_currentRow, -1 );
3760 }
3761
3762 void wxDataViewMainWindow::OnLeftKey()
3763 {
3764 if ( IsList() )
3765 {
3766 TryAdvanceCurrentColumn(NULL, /*forward=*/false);
3767 }
3768 else
3769 {
3770 wxDataViewTreeNode* node = GetTreeNodeByRow(m_currentRow);
3771
3772 if ( TryAdvanceCurrentColumn(node, /*forward=*/false) )
3773 return;
3774
3775 // Because TryAdvanceCurrentColumn() return false, we are at the first
3776 // column or using whole-row selection. In this situation, we can use
3777 // the standard TreeView handling of the left key.
3778 if (node->HasChildren() && node->IsOpen())
3779 {
3780 Collapse(m_currentRow);
3781 }
3782 else
3783 {
3784 // if the node is already closed, we move the selection to its parent
3785 wxDataViewTreeNode *parent_node = node->GetParent();
3786
3787 if (parent_node)
3788 {
3789 int parent = GetRowByItem( parent_node->GetItem() );
3790 if ( parent >= 0 )
3791 {
3792 unsigned int row = m_currentRow;
3793 SelectRow( row, false);
3794 SelectRow( parent, true );
3795 ChangeCurrentRow( parent );
3796 GetOwner()->EnsureVisible( parent, -1 );
3797 SendSelectionChangedEvent( parent_node->GetItem() );
3798 }
3799 }
3800 }
3801 }
3802 }
3803
3804 void wxDataViewMainWindow::OnRightKey()
3805 {
3806 if ( IsList() )
3807 {
3808 TryAdvanceCurrentColumn(NULL, /*forward=*/true);
3809 }
3810 else
3811 {
3812 wxDataViewTreeNode* node = GetTreeNodeByRow(m_currentRow);
3813
3814 if ( node->HasChildren() )
3815 {
3816 if ( !node->IsOpen() )
3817 {
3818 Expand( m_currentRow );
3819 }
3820 else
3821 {
3822 // if the node is already open, we move the selection to the first child
3823 unsigned int row = m_currentRow;
3824 SelectRow( row, false );
3825 SelectRow( row + 1, true );
3826 ChangeCurrentRow( row + 1 );
3827 GetOwner()->EnsureVisible( row + 1, -1 );
3828 SendSelectionChangedEvent( GetItemByRow(row+1) );
3829 }
3830 }
3831 else
3832 {
3833 TryAdvanceCurrentColumn(node, /*forward=*/true);
3834 }
3835 }
3836 }
3837
3838 bool wxDataViewMainWindow::TryAdvanceCurrentColumn(wxDataViewTreeNode *node, bool forward)
3839 {
3840 if ( GetOwner()->GetColumnCount() == 0 )
3841 return false;
3842
3843 if ( !m_useCellFocus )
3844 return false;
3845
3846 if ( node )
3847 {
3848 // navigation shouldn't work in branch nodes without other columns:
3849 if ( node->HasChildren() && !GetModel()->HasContainerColumns(node->GetItem()) )
3850 return false;
3851 }
3852
3853 if ( m_currentCol == NULL || !m_currentColSetByKeyboard )
3854 {
3855 if ( forward )
3856 {
3857 m_currentCol = GetOwner()->GetColumnAt(1);
3858 m_currentColSetByKeyboard = true;
3859 RefreshRow(m_currentRow);
3860 return true;
3861 }
3862 else
3863 return false;
3864 }
3865
3866 int idx = GetOwner()->GetColumnIndex(m_currentCol) + (forward ? +1 : -1);
3867
3868 if ( idx >= (int)GetOwner()->GetColumnCount() )
3869 return false;
3870
3871 GetOwner()->EnsureVisible(m_currentRow, idx);
3872
3873 if ( idx < 1 )
3874 {
3875 // We are going to the left of the second column. Reset to whole-row
3876 // focus (which means first column would be edited).
3877 m_currentCol = NULL;
3878 RefreshRow(m_currentRow);
3879 return true;
3880 }
3881
3882 m_currentCol = GetOwner()->GetColumnAt(idx);
3883 m_currentColSetByKeyboard = true;
3884 RefreshRow(m_currentRow);
3885 return true;
3886 }
3887
3888 void wxDataViewMainWindow::OnMouse( wxMouseEvent &event )
3889 {
3890 if (event.GetEventType() == wxEVT_MOUSEWHEEL)
3891 {
3892 // let the base handle mouse wheel events.
3893 event.Skip();
3894 return;
3895 }
3896
3897 // set the focus to ourself if any of the mouse buttons are pressed
3898 if(event.ButtonDown() && !HasFocus())
3899 SetFocus();
3900
3901 int x = event.GetX();
3902 int y = event.GetY();
3903 m_owner->CalcUnscrolledPosition( x, y, &x, &y );
3904 wxDataViewColumn *col = NULL;
3905
3906 int xpos = 0;
3907 unsigned int cols = GetOwner()->GetColumnCount();
3908 unsigned int i;
3909 for (i = 0; i < cols; i++)
3910 {
3911 wxDataViewColumn *c = GetOwner()->GetColumnAt( i );
3912 if (c->IsHidden())
3913 continue; // skip it!
3914
3915 if (x < xpos + c->GetWidth())
3916 {
3917 col = c;
3918 break;
3919 }
3920 xpos += c->GetWidth();
3921 }
3922
3923 wxDataViewModel* const model = GetModel();
3924
3925 const unsigned int current = GetLineAt( y );
3926 const wxDataViewItem item = GetItemByRow(current);
3927
3928 // Handle right clicking here, before everything else as context menu
3929 // events should be sent even when we click outside of any item, unlike all
3930 // the other ones.
3931 if (event.RightUp())
3932 {
3933 wxWindow *parent = GetParent();
3934 wxDataViewEvent le(wxEVT_COMMAND_DATAVIEW_ITEM_CONTEXT_MENU, parent->GetId());
3935 le.SetEventObject(parent);
3936 le.SetModel(model);
3937
3938 if ( item.IsOk() && col )
3939 {
3940 le.SetItem( item );
3941 le.SetColumn( col->GetModelColumn() );
3942 le.SetDataViewColumn( col );
3943
3944 wxVariant value;
3945 model->GetValue( value, item, col->GetModelColumn() );
3946 le.SetValue(value);
3947 }
3948
3949 parent->ProcessWindowEvent(le);
3950 return;
3951 }
3952
3953 if (!col)
3954 {
3955 event.Skip();
3956 return;
3957 }
3958
3959 wxDataViewRenderer *cell = col->GetRenderer();
3960 if ((current >= GetRowCount()) || (x > GetEndOfLastCol()))
3961 {
3962 // Unselect all if below the last row ?
3963 event.Skip();
3964 return;
3965 }
3966
3967 wxDataViewColumn* const
3968 expander = GetExpanderColumnOrFirstOne(GetOwner());
3969
3970 // Test whether the mouse is hovering over the expander (a.k.a tree "+"
3971 // button) and also determine the offset of the real cell start, skipping
3972 // the indentation and the expander itself.
3973 bool hoverOverExpander = false;
3974 int itemOffset = 0;
3975 if ((!IsList()) && (expander == col))
3976 {
3977 wxDataViewTreeNode * node = GetTreeNodeByRow(current);
3978
3979 int indent = node->GetIndentLevel();
3980 itemOffset = GetOwner()->GetIndent()*indent;
3981
3982 if ( node->HasChildren() )
3983 {
3984 // we make the rectangle we are looking in a bit bigger than the actual
3985 // visual expander so the user can hit that little thing reliably
3986 wxRect rect(itemOffset,
3987 GetLineStart( current ) + (GetLineHeight(current) - m_lineHeight)/2,
3988 m_lineHeight, m_lineHeight);
3989
3990 if( rect.Contains(x, y) )
3991 {
3992 // So the mouse is over the expander
3993 hoverOverExpander = true;
3994 if (m_underMouse && m_underMouse != node)
3995 {
3996 // wxLogMessage("Undo the row: %d", GetRowByItem(m_underMouse->GetItem()));
3997 RefreshRow(GetRowByItem(m_underMouse->GetItem()));
3998 }
3999 if (m_underMouse != node)
4000 {
4001 // wxLogMessage("Do the row: %d", current);
4002 RefreshRow(current);
4003 }
4004 m_underMouse = node;
4005 }
4006 }
4007
4008 // Account for the expander as well, even if this item doesn't have it,
4009 // its parent does so it still counts for the offset.
4010 itemOffset += m_lineHeight;
4011 }
4012 if (!hoverOverExpander)
4013 {
4014 if (m_underMouse != NULL)
4015 {
4016 // wxLogMessage("Undo the row: %d", GetRowByItem(m_underMouse->GetItem()));
4017 RefreshRow(GetRowByItem(m_underMouse->GetItem()));
4018 m_underMouse = NULL;
4019 }
4020 }
4021
4022 #if wxUSE_DRAG_AND_DROP
4023 if (event.Dragging())
4024 {
4025 if (m_dragCount == 0)
4026 {
4027 // we have to report the raw, physical coords as we want to be
4028 // able to call HitTest(event.m_pointDrag) from the user code to
4029 // get the item being dragged
4030 m_dragStart = event.GetPosition();
4031 }
4032
4033 m_dragCount++;
4034
4035 if (m_dragCount != 3)
4036 return;
4037
4038 if (event.LeftIsDown())
4039 {
4040 m_owner->CalcUnscrolledPosition( m_dragStart.x, m_dragStart.y,
4041 &m_dragStart.x, &m_dragStart.y );
4042 unsigned int drag_item_row = GetLineAt( m_dragStart.y );
4043 wxDataViewItem itemDragged = GetItemByRow( drag_item_row );
4044
4045 // Notify cell about drag
4046 wxDataViewEvent event( wxEVT_COMMAND_DATAVIEW_ITEM_BEGIN_DRAG, m_owner->GetId() );
4047 event.SetEventObject( m_owner );
4048 event.SetItem( itemDragged );
4049 event.SetModel( model );
4050 if (!m_owner->HandleWindowEvent( event ))
4051 return;
4052
4053 if (!event.IsAllowed())
4054 return;
4055
4056 wxDataObject *obj = event.GetDataObject();
4057 if (!obj)
4058 return;
4059
4060 wxDataViewDropSource drag( this, drag_item_row );
4061 drag.SetData( *obj );
4062 /* wxDragResult res = */ drag.DoDragDrop();
4063 delete obj;
4064 }
4065 return;
4066 }
4067 else
4068 {
4069 m_dragCount = 0;
4070 }
4071 #endif // wxUSE_DRAG_AND_DROP
4072
4073 bool simulateClick = false;
4074
4075 if (event.ButtonDClick())
4076 {
4077 m_renameTimer->Stop();
4078 m_lastOnSame = false;
4079 }
4080
4081 bool ignore_other_columns =
4082 ((expander != col) &&
4083 (model->IsContainer(item)) &&
4084 (!model->HasContainerColumns(item)));
4085
4086 if (event.LeftDClick())
4087 {
4088 if(hoverOverExpander)
4089 {
4090 // a double click on the expander will be converted into a "simulated" normal click
4091 simulateClick = true;
4092 }
4093 else if ( current == m_lineLastClicked )
4094 {
4095 wxWindow *parent = GetParent();
4096 wxDataViewEvent le(wxEVT_COMMAND_DATAVIEW_ITEM_ACTIVATED, parent->GetId());
4097 le.SetItem( item );
4098 le.SetColumn( col->GetModelColumn() );
4099 le.SetDataViewColumn( col );
4100 le.SetEventObject(parent);
4101 le.SetModel(GetModel());
4102
4103 parent->ProcessWindowEvent(le);
4104 return;
4105 }
4106 else
4107 {
4108 // The first click was on another item, so don't interpret this as
4109 // a double click, but as a simple click instead
4110 simulateClick = true;
4111 }
4112 }
4113
4114 if (event.LeftUp() && !hoverOverExpander)
4115 {
4116 if (m_lineSelectSingleOnUp != (unsigned int)-1)
4117 {
4118 // select single line
4119 SelectAllRows( false );
4120 SelectRow( m_lineSelectSingleOnUp, true );
4121 SendSelectionChangedEvent( GetItemByRow(m_lineSelectSingleOnUp) );
4122 }
4123
4124 // If the user click the expander, we do not do editing even if the column
4125 // with expander are editable
4126 if (m_lastOnSame && !ignore_other_columns)
4127 {
4128 if ((col == m_currentCol) && (current == m_currentRow) &&
4129 IsCellEditableInMode(item, col, wxDATAVIEW_CELL_EDITABLE) )
4130 {
4131 m_renameTimer->Start( 100, true );
4132 }
4133 }
4134
4135 m_lastOnSame = false;
4136 m_lineSelectSingleOnUp = (unsigned int)-1;
4137 }
4138 else if(!event.LeftUp())
4139 {
4140 // This is necessary, because after a DnD operation in
4141 // from and to ourself, the up event is swallowed by the
4142 // DnD code. So on next non-up event (which means here and
4143 // now) m_lineSelectSingleOnUp should be reset.
4144 m_lineSelectSingleOnUp = (unsigned int)-1;
4145 }
4146
4147 if (event.RightDown())
4148 {
4149 m_lineBeforeLastClicked = m_lineLastClicked;
4150 m_lineLastClicked = current;
4151
4152 // If the item is already selected, do not update the selection.
4153 // Multi-selections should not be cleared if a selected item is clicked.
4154 if (!IsRowSelected(current))
4155 {
4156 SelectAllRows(false);
4157 const unsigned oldCurrent = m_currentRow;
4158 ChangeCurrentRow(current);
4159 SelectRow(m_currentRow,true);
4160 RefreshRow(oldCurrent);
4161 SendSelectionChangedEvent(GetItemByRow( m_currentRow ) );
4162 }
4163 }
4164 else if (event.MiddleDown())
4165 {
4166 }
4167
4168 if((event.LeftDown() || simulateClick) && hoverOverExpander)
4169 {
4170 wxDataViewTreeNode* node = GetTreeNodeByRow(current);
4171
4172 // hoverOverExpander being true tells us that our node must be
4173 // valid and have children.
4174 // So we don't need any extra checks.
4175 if( node->IsOpen() )
4176 Collapse(current);
4177 else
4178 Expand(current);
4179 }
4180 else if ((event.LeftDown() || simulateClick) && !hoverOverExpander)
4181 {
4182 m_lineBeforeLastClicked = m_lineLastClicked;
4183 m_lineLastClicked = current;
4184
4185 unsigned int oldCurrentRow = m_currentRow;
4186 bool oldWasSelected = IsRowSelected(m_currentRow);
4187
4188 bool cmdModifierDown = event.CmdDown();
4189 if ( IsSingleSel() || !(cmdModifierDown || event.ShiftDown()) )
4190 {
4191 if ( IsSingleSel() || !IsRowSelected(current) )
4192 {
4193 SelectAllRows( false );
4194 ChangeCurrentRow(current);
4195 SelectRow(m_currentRow,true);
4196 SendSelectionChangedEvent(GetItemByRow( m_currentRow ) );
4197 }
4198 else // multi sel & current is highlighted & no mod keys
4199 {
4200 m_lineSelectSingleOnUp = current;
4201 ChangeCurrentRow(current); // change focus
4202 }
4203 }
4204 else // multi sel & either ctrl or shift is down
4205 {
4206 if (cmdModifierDown)
4207 {
4208 ChangeCurrentRow(current);
4209 ReverseRowSelection(m_currentRow);
4210 SendSelectionChangedEvent(GetItemByRow(m_currentRow));
4211 }
4212 else if (event.ShiftDown())
4213 {
4214 ChangeCurrentRow(current);
4215
4216 unsigned int lineFrom = oldCurrentRow,
4217 lineTo = current;
4218
4219 if ( lineTo < lineFrom )
4220 {
4221 lineTo = lineFrom;
4222 lineFrom = m_currentRow;
4223 }
4224
4225 SelectRows(lineFrom, lineTo, true);
4226 SendSelectionChangedEvent(GetItemByRow(m_selection[0]) );
4227 }
4228 else // !ctrl, !shift
4229 {
4230 // test in the enclosing if should make it impossible
4231 wxFAIL_MSG( wxT("how did we get here?") );
4232 }
4233 }
4234
4235 if (m_currentRow != oldCurrentRow)
4236 RefreshRow( oldCurrentRow );
4237
4238 wxDataViewColumn *oldCurrentCol = m_currentCol;
4239
4240 // Update selection here...
4241 m_currentCol = col;
4242 m_currentColSetByKeyboard = false;
4243
4244 m_lastOnSame = !simulateClick && ((col == oldCurrentCol) &&
4245 (current == oldCurrentRow)) && oldWasSelected;
4246
4247 // Call ActivateCell() after everything else as under GTK+
4248 if ( IsCellEditableInMode(item, col, wxDATAVIEW_CELL_ACTIVATABLE) )
4249 {
4250 // notify cell about click
4251 cell->PrepareForItem(model, item, col->GetModelColumn());
4252
4253 wxRect cell_rect( xpos + itemOffset,
4254 GetLineStart( current ),
4255 col->GetWidth() - itemOffset,
4256 GetLineHeight( current ) );
4257
4258 // Report position relative to the cell's custom area, i.e.
4259 // no the entire space as given by the control but the one
4260 // used by the renderer after calculation of alignment etc.
4261
4262 // adjust the rectangle ourselves to account for the alignment
4263 wxRect rectItem = cell_rect;
4264 const int align = cell->GetAlignment();
4265 if ( align != wxDVR_DEFAULT_ALIGNMENT )
4266 {
4267 const wxSize size = cell->GetSize();
4268
4269 if ( size.x >= 0 && size.x < cell_rect.width )
4270 {
4271 if ( align & wxALIGN_CENTER_HORIZONTAL )
4272 rectItem.x += (cell_rect.width - size.x)/2;
4273 else if ( align & wxALIGN_RIGHT )
4274 rectItem.x += cell_rect.width - size.x;
4275 // else: wxALIGN_LEFT is the default
4276 }
4277
4278 if ( size.y >= 0 && size.y < cell_rect.height )
4279 {
4280 if ( align & wxALIGN_CENTER_VERTICAL )
4281 rectItem.y += (cell_rect.height - size.y)/2;
4282 else if ( align & wxALIGN_BOTTOM )
4283 rectItem.y += cell_rect.height - size.y;
4284 // else: wxALIGN_TOP is the default
4285 }
4286 }
4287
4288 wxMouseEvent event2(event);
4289 event2.m_x -= rectItem.x;
4290 event2.m_y -= rectItem.y;
4291 m_owner->CalcUnscrolledPosition(event2.m_x, event2.m_y, &event2.m_x, &event2.m_y);
4292
4293 /* ignore ret */ cell->WXActivateCell
4294 (
4295 cell_rect,
4296 model,
4297 item,
4298 col->GetModelColumn(),
4299 &event2
4300 );
4301 }
4302 }
4303 }
4304
4305 void wxDataViewMainWindow::OnSetFocus( wxFocusEvent &event )
4306 {
4307 m_hasFocus = true;
4308
4309 if (HasCurrentRow())
4310 Refresh();
4311
4312 event.Skip();
4313 }
4314
4315 void wxDataViewMainWindow::OnKillFocus( wxFocusEvent &event )
4316 {
4317 m_hasFocus = false;
4318
4319 if (HasCurrentRow())
4320 Refresh();
4321
4322 event.Skip();
4323 }
4324
4325 void wxDataViewMainWindow::OnColumnsCountChanged()
4326 {
4327 int editableCount = 0;
4328
4329 const unsigned cols = GetOwner()->GetColumnCount();
4330 for ( unsigned i = 0; i < cols; i++ )
4331 {
4332 wxDataViewColumn *c = GetOwner()->GetColumnAt(i);
4333 if ( c->IsHidden() )
4334 continue;
4335 if ( c->GetRenderer()->GetMode() != wxDATAVIEW_CELL_INERT )
4336 editableCount++;
4337 }
4338
4339 m_useCellFocus = (editableCount > 1);
4340
4341 UpdateDisplay();
4342 }
4343
4344 //-----------------------------------------------------------------------------
4345 // wxDataViewCtrl
4346 //-----------------------------------------------------------------------------
4347
4348 WX_DEFINE_LIST(wxDataViewColumnList)
4349
4350 IMPLEMENT_DYNAMIC_CLASS(wxDataViewCtrl, wxDataViewCtrlBase)
4351 BEGIN_EVENT_TABLE(wxDataViewCtrl, wxDataViewCtrlBase)
4352 EVT_SIZE(wxDataViewCtrl::OnSize)
4353 END_EVENT_TABLE()
4354
4355 wxDataViewCtrl::~wxDataViewCtrl()
4356 {
4357 if (m_notifier)
4358 GetModel()->RemoveNotifier( m_notifier );
4359
4360 m_cols.Clear();
4361 m_colsBestWidths.clear();
4362 }
4363
4364 void wxDataViewCtrl::Init()
4365 {
4366 m_cols.DeleteContents(true);
4367 m_notifier = NULL;
4368
4369 // No sorting column at start
4370 m_sortingColumnIdx = wxNOT_FOUND;
4371
4372 m_headerArea = NULL;
4373
4374 m_colsDirty = false;
4375 }
4376
4377 bool wxDataViewCtrl::Create(wxWindow *parent,
4378 wxWindowID id,
4379 const wxPoint& pos,
4380 const wxSize& size,
4381 long style,
4382 const wxValidator& validator,
4383 const wxString& name)
4384 {
4385 // if ( (style & wxBORDER_MASK) == 0)
4386 // style |= wxBORDER_SUNKEN;
4387
4388 Init();
4389
4390 if (!wxControl::Create( parent, id, pos, size,
4391 style | wxScrolledWindowStyle, validator, name))
4392 return false;
4393
4394 SetInitialSize(size);
4395
4396 #ifdef __WXMAC__
4397 MacSetClipChildren( true );
4398 #endif
4399
4400 m_clientArea = new wxDataViewMainWindow( this, wxID_ANY );
4401
4402 // We use the cursor keys for moving the selection, not scrolling, so call
4403 // this method to ensure wxScrollHelperEvtHandler doesn't catch all
4404 // keyboard events forwarded to us from wxListMainWindow.
4405 DisableKeyboardScrolling();
4406
4407 if (HasFlag(wxDV_NO_HEADER))
4408 m_headerArea = NULL;
4409 else
4410 m_headerArea = new wxDataViewHeaderWindow(this);
4411
4412 SetTargetWindow( m_clientArea );
4413
4414 wxBoxSizer *sizer = new wxBoxSizer( wxVERTICAL );
4415 if (m_headerArea)
4416 sizer->Add( m_headerArea, 0, wxGROW );
4417 sizer->Add( m_clientArea, 1, wxGROW );
4418 SetSizer( sizer );
4419
4420 return true;
4421 }
4422
4423 wxBorder wxDataViewCtrl::GetDefaultBorder() const
4424 {
4425 return wxBORDER_THEME;
4426 }
4427
4428 #ifdef __WXMSW__
4429 WXLRESULT wxDataViewCtrl::MSWWindowProc(WXUINT nMsg,
4430 WXWPARAM wParam,
4431 WXLPARAM lParam)
4432 {
4433 WXLRESULT rc = wxDataViewCtrlBase::MSWWindowProc(nMsg, wParam, lParam);
4434
4435 #ifndef __WXWINCE__
4436 // we need to process arrows ourselves for scrolling
4437 if ( nMsg == WM_GETDLGCODE )
4438 {
4439 rc |= DLGC_WANTARROWS;
4440 }
4441 #endif
4442
4443 return rc;
4444 }
4445 #endif
4446
4447 wxSize wxDataViewCtrl::GetSizeAvailableForScrollTarget(const wxSize& size)
4448 {
4449 wxSize newsize = size;
4450 if (!HasFlag(wxDV_NO_HEADER) && (m_headerArea))
4451 newsize.y -= m_headerArea->GetSize().y;
4452
4453 return newsize;
4454 }
4455
4456 void wxDataViewCtrl::OnSize( wxSizeEvent &WXUNUSED(event) )
4457 {
4458 // We need to override OnSize so that our scrolled
4459 // window a) does call Layout() to use sizers for
4460 // positioning the controls but b) does not query
4461 // the sizer for their size and use that for setting
4462 // the scrollable area as set that ourselves by
4463 // calling SetScrollbar() further down.
4464
4465 Layout();
4466
4467 AdjustScrollbars();
4468
4469 // We must redraw the headers if their height changed. Normally this
4470 // shouldn't happen as the control shouldn't let itself be resized beneath
4471 // its minimal height but avoid the display artefacts that appear if it
4472 // does happen, e.g. because there is really not enough vertical space.
4473 if ( !HasFlag(wxDV_NO_HEADER) && m_headerArea &&
4474 m_headerArea->GetSize().y <= m_headerArea->GetBestSize(). y )
4475 {
4476 m_headerArea->Refresh();
4477 }
4478 }
4479
4480 void wxDataViewCtrl::SetFocus()
4481 {
4482 if (m_clientArea)
4483 m_clientArea->SetFocus();
4484 }
4485
4486 bool wxDataViewCtrl::AssociateModel( wxDataViewModel *model )
4487 {
4488 if (!wxDataViewCtrlBase::AssociateModel( model ))
4489 return false;
4490
4491 m_notifier = new wxGenericDataViewModelNotifier( m_clientArea );
4492
4493 model->AddNotifier( m_notifier );
4494
4495 m_clientArea->DestroyTree();
4496
4497 m_clientArea->BuildTree(model);
4498
4499 m_clientArea->UpdateDisplay();
4500
4501 return true;
4502 }
4503
4504 #if wxUSE_DRAG_AND_DROP
4505
4506 bool wxDataViewCtrl::EnableDragSource( const wxDataFormat &format )
4507 {
4508 return m_clientArea->EnableDragSource( format );
4509 }
4510
4511 bool wxDataViewCtrl::EnableDropTarget( const wxDataFormat &format )
4512 {
4513 return m_clientArea->EnableDropTarget( format );
4514 }
4515
4516 #endif // wxUSE_DRAG_AND_DROP
4517
4518 bool wxDataViewCtrl::AppendColumn( wxDataViewColumn *col )
4519 {
4520 if (!wxDataViewCtrlBase::AppendColumn(col))
4521 return false;
4522
4523 m_cols.Append( col );
4524 m_colsBestWidths.push_back(0);
4525 OnColumnsCountChanged();
4526 return true;
4527 }
4528
4529 bool wxDataViewCtrl::PrependColumn( wxDataViewColumn *col )
4530 {
4531 if (!wxDataViewCtrlBase::PrependColumn(col))
4532 return false;
4533
4534 m_cols.Insert( col );
4535 m_colsBestWidths.insert(m_colsBestWidths.begin(), 0);
4536 OnColumnsCountChanged();
4537 return true;
4538 }
4539
4540 bool wxDataViewCtrl::InsertColumn( unsigned int pos, wxDataViewColumn *col )
4541 {
4542 if (!wxDataViewCtrlBase::InsertColumn(pos,col))
4543 return false;
4544
4545 m_cols.Insert( pos, col );
4546 m_colsBestWidths.insert(m_colsBestWidths.begin() + pos, 0);
4547 OnColumnsCountChanged();
4548 return true;
4549 }
4550
4551 void wxDataViewCtrl::OnColumnChange(unsigned int idx)
4552 {
4553 if ( m_headerArea )
4554 m_headerArea->UpdateColumn(idx);
4555
4556 m_clientArea->UpdateDisplay();
4557 }
4558
4559 void wxDataViewCtrl::OnColumnsCountChanged()
4560 {
4561 if (m_headerArea)
4562 m_headerArea->SetColumnCount(GetColumnCount());
4563
4564 m_clientArea->OnColumnsCountChanged();
4565 }
4566
4567 void wxDataViewCtrl::DoSetExpanderColumn()
4568 {
4569 m_clientArea->UpdateDisplay();
4570 }
4571
4572 void wxDataViewCtrl::DoSetIndent()
4573 {
4574 m_clientArea->UpdateDisplay();
4575 }
4576
4577 unsigned int wxDataViewCtrl::GetColumnCount() const
4578 {
4579 return m_cols.GetCount();
4580 }
4581
4582 bool wxDataViewCtrl::SetRowHeight( int lineHeight )
4583 {
4584 if ( !m_clientArea )
4585 return false;
4586
4587 m_clientArea->SetRowHeight(lineHeight);
4588
4589 return true;
4590 }
4591
4592 wxDataViewColumn* wxDataViewCtrl::GetColumn( unsigned int idx ) const
4593 {
4594 return m_cols[idx];
4595 }
4596
4597 wxDataViewColumn *wxDataViewCtrl::GetColumnAt(unsigned int pos) const
4598 {
4599 // columns can't be reordered if there is no header window which allows
4600 // to do this
4601 const unsigned idx = m_headerArea ? m_headerArea->GetColumnsOrder()[pos]
4602 : pos;
4603
4604 return GetColumn(idx);
4605 }
4606
4607 int wxDataViewCtrl::GetColumnIndex(const wxDataViewColumn *column) const
4608 {
4609 const unsigned count = m_cols.size();
4610 for ( unsigned n = 0; n < count; n++ )
4611 {
4612 if ( m_cols[n] == column )
4613 return n;
4614 }
4615
4616 return wxNOT_FOUND;
4617 }
4618
4619 unsigned int wxDataViewCtrl::GetBestColumnWidth(int idx) const
4620 {
4621 if ( m_colsBestWidths[idx] != 0 )
4622 return m_colsBestWidths[idx];
4623
4624 const int count = m_clientArea->GetRowCount();
4625 wxDataViewColumn *column = GetColumn(idx);
4626 wxDataViewRenderer *renderer =
4627 const_cast<wxDataViewRenderer*>(column->GetRenderer());
4628
4629 class MaxWidthCalculator
4630 {
4631 public:
4632 MaxWidthCalculator(const wxDataViewCtrl *dvc,
4633 wxDataViewMainWindow *clientArea,
4634 wxDataViewRenderer *renderer,
4635 const wxDataViewModel *model,
4636 unsigned column,
4637 int expanderSize)
4638 : m_width(0),
4639 m_dvc(dvc),
4640 m_clientArea(clientArea),
4641 m_renderer(renderer),
4642 m_model(model),
4643 m_column(column),
4644 m_expanderSize(expanderSize)
4645
4646 {
4647 m_isExpanderCol =
4648 !clientArea->IsList() &&
4649 (column == 0 ||
4650 GetExpanderColumnOrFirstOne(const_cast<wxDataViewCtrl*>(dvc)) == dvc->GetColumnAt(column));
4651 }
4652
4653 void UpdateWithWidth(int width)
4654 {
4655 m_width = wxMax(m_width, width);
4656 }
4657
4658 void UpdateWithRow(int row)
4659 {
4660 int indent = 0;
4661 wxDataViewItem item;
4662
4663 if ( m_isExpanderCol )
4664 {
4665 wxDataViewTreeNode *node = m_clientArea->GetTreeNodeByRow(row);
4666 item = node->GetItem();
4667 indent = m_dvc->GetIndent() * node->GetIndentLevel() + m_expanderSize;
4668 }
4669 else
4670 {
4671 item = m_clientArea->GetItemByRow(row);
4672 }
4673
4674 m_renderer->PrepareForItem(m_model, item, m_column);
4675 m_width = wxMax(m_width, m_renderer->GetSize().x + indent);
4676 }
4677
4678 int GetMaxWidth() const { return m_width; }
4679
4680 private:
4681 int m_width;
4682 const wxDataViewCtrl *m_dvc;
4683 wxDataViewMainWindow *m_clientArea;
4684 wxDataViewRenderer *m_renderer;
4685 const wxDataViewModel *m_model;
4686 unsigned m_column;
4687 bool m_isExpanderCol;
4688 int m_expanderSize;
4689 };
4690
4691 MaxWidthCalculator calculator(this, m_clientArea, renderer,
4692 GetModel(), column->GetModelColumn(),
4693 m_clientArea->GetRowHeight());
4694
4695 if ( m_headerArea )
4696 calculator.UpdateWithWidth(m_headerArea->GetColumnTitleWidth(*column));
4697
4698 // The code below deserves some explanation. For very large controls, we
4699 // simply can't afford to calculate sizes for all items, it takes too
4700 // long. So the best we can do is to check the first and the last N/2
4701 // items in the control for some sufficiently large N and calculate best
4702 // sizes from that. That can result in the calculated best width being too
4703 // small for some outliers, but it's better to get slightly imperfect
4704 // result than to wait several seconds after every update. To avoid highly
4705 // visible miscalculations, we also include all currently visible items
4706 // no matter what. Finally, the value of N is determined dynamically by
4707 // measuring how much time we spent on the determining item widths so far.
4708
4709 #if wxUSE_STOPWATCH
4710 int top_part_end = count;
4711 static const long CALC_TIMEOUT = 20/*ms*/;
4712 // don't call wxStopWatch::Time() too often
4713 static const unsigned CALC_CHECK_FREQ = 100;
4714 wxStopWatch timer;
4715 #else
4716 // use some hard-coded limit, that's the best we can do without timer
4717 int top_part_end = wxMin(500, count);
4718 #endif // wxUSE_STOPWATCH/!wxUSE_STOPWATCH
4719
4720 int row = 0;
4721
4722 for ( row = 0; row < top_part_end; row++ )
4723 {
4724 #if wxUSE_STOPWATCH
4725 if ( row % CALC_CHECK_FREQ == CALC_CHECK_FREQ-1 &&
4726 timer.Time() > CALC_TIMEOUT )
4727 break;
4728 #endif // wxUSE_STOPWATCH
4729 calculator.UpdateWithRow(row);
4730 }
4731
4732 // row is the first unmeasured item now; that's our value of N/2
4733
4734 if ( row < count )
4735 {
4736 top_part_end = row;
4737
4738 // add bottom N/2 items now:
4739 const int bottom_part_start = wxMax(row, count - row);
4740 for ( row = bottom_part_start; row < count; row++ )
4741 {
4742 calculator.UpdateWithRow(row);
4743 }
4744
4745 // finally, include currently visible items in the calculation:
4746 const wxPoint origin = CalcUnscrolledPosition(wxPoint(0, 0));
4747 int first_visible = m_clientArea->GetLineAt(origin.y);
4748 int last_visible = m_clientArea->GetLineAt(origin.y + GetClientSize().y);
4749
4750 first_visible = wxMax(first_visible, top_part_end);
4751 last_visible = wxMin(bottom_part_start, last_visible);
4752
4753 for ( row = first_visible; row < last_visible; row++ )
4754 {
4755 calculator.UpdateWithRow(row);
4756 }
4757
4758 wxLogTrace("dataview",
4759 "determined best size from %d top, %d bottom plus %d more visible items out of %d total",
4760 top_part_end,
4761 count - bottom_part_start,
4762 wxMax(0, last_visible - first_visible),
4763 count);
4764 }
4765
4766 int max_width = calculator.GetMaxWidth();
4767 if ( max_width > 0 )
4768 max_width += 2 * PADDING_RIGHTLEFT;
4769
4770 const_cast<wxDataViewCtrl*>(this)->m_colsBestWidths[idx] = max_width;
4771 return max_width;
4772 }
4773
4774 void wxDataViewCtrl::ColumnMoved(wxDataViewColumn * WXUNUSED(col),
4775 unsigned int WXUNUSED(new_pos))
4776 {
4777 // do _not_ reorder m_cols elements here, they should always be in the
4778 // order in which columns were added, we only display the columns in
4779 // different order
4780 m_clientArea->UpdateDisplay();
4781 }
4782
4783 bool wxDataViewCtrl::DeleteColumn( wxDataViewColumn *column )
4784 {
4785 wxDataViewColumnList::compatibility_iterator ret = m_cols.Find( column );
4786 if (!ret)
4787 return false;
4788
4789 m_colsBestWidths.erase(m_colsBestWidths.begin() + GetColumnIndex(column));
4790 m_cols.Erase(ret);
4791
4792 if ( m_clientArea->GetCurrentColumn() == column )
4793 m_clientArea->ClearCurrentColumn();
4794
4795 OnColumnsCountChanged();
4796
4797 return true;
4798 }
4799
4800 bool wxDataViewCtrl::ClearColumns()
4801 {
4802 SetExpanderColumn(NULL);
4803 m_cols.Clear();
4804 m_colsBestWidths.clear();
4805
4806 m_clientArea->ClearCurrentColumn();
4807
4808 OnColumnsCountChanged();
4809
4810 return true;
4811 }
4812
4813 void wxDataViewCtrl::InvalidateColBestWidth(int idx)
4814 {
4815 m_colsBestWidths[idx] = 0;
4816 m_colsDirty = true;
4817 }
4818
4819 void wxDataViewCtrl::InvalidateColBestWidths()
4820 {
4821 m_colsBestWidths.clear();
4822 m_colsBestWidths.resize(m_cols.size());
4823 m_colsDirty = true;
4824 }
4825
4826 void wxDataViewCtrl::UpdateColWidths()
4827 {
4828 if ( !m_headerArea )
4829 return;
4830
4831 const unsigned len = m_colsBestWidths.size();
4832 for ( unsigned i = 0; i < len; i++ )
4833 {
4834 if ( m_colsBestWidths[i] == 0 )
4835 m_headerArea->UpdateColumn(i);
4836 }
4837 }
4838
4839 void wxDataViewCtrl::OnInternalIdle()
4840 {
4841 wxDataViewCtrlBase::OnInternalIdle();
4842
4843 if ( m_colsDirty )
4844 {
4845 m_colsDirty = false;
4846 UpdateColWidths();
4847 }
4848 }
4849
4850 int wxDataViewCtrl::GetColumnPosition( const wxDataViewColumn *column ) const
4851 {
4852 unsigned int len = GetColumnCount();
4853 for ( unsigned int i = 0; i < len; i++ )
4854 {
4855 wxDataViewColumn * col = GetColumnAt(i);
4856 if (column==col)
4857 return i;
4858 }
4859
4860 return wxNOT_FOUND;
4861 }
4862
4863 wxDataViewColumn *wxDataViewCtrl::GetSortingColumn() const
4864 {
4865 return m_sortingColumnIdx == wxNOT_FOUND ? NULL
4866 : GetColumn(m_sortingColumnIdx);
4867 }
4868
4869 wxDataViewItem wxDataViewCtrl::DoGetCurrentItem() const
4870 {
4871 return GetItemByRow(m_clientArea->GetCurrentRow());
4872 }
4873
4874 void wxDataViewCtrl::DoSetCurrentItem(const wxDataViewItem& item)
4875 {
4876 const int row = m_clientArea->GetRowByItem(item);
4877
4878 const unsigned oldCurrent = m_clientArea->GetCurrentRow();
4879 if ( static_cast<unsigned>(row) != oldCurrent )
4880 {
4881 m_clientArea->ChangeCurrentRow(row);
4882 m_clientArea->RefreshRow(oldCurrent);
4883 m_clientArea->RefreshRow(row);
4884 }
4885 }
4886
4887 wxDataViewColumn *wxDataViewCtrl::GetCurrentColumn() const
4888 {
4889 return m_clientArea->GetCurrentColumn();
4890 }
4891
4892 int wxDataViewCtrl::GetSelectedItemsCount() const
4893 {
4894 return m_clientArea->GetSelections().size();
4895 }
4896
4897 int wxDataViewCtrl::GetSelections( wxDataViewItemArray & sel ) const
4898 {
4899 sel.Empty();
4900 const wxDataViewSelection& selections = m_clientArea->GetSelections();
4901
4902 const size_t len = selections.size();
4903 for ( size_t i = 0; i < len; i++ )
4904 {
4905 wxDataViewItem item = m_clientArea->GetItemByRow(selections[i]);
4906 if ( item.IsOk() )
4907 {
4908 sel.Add(item);
4909 }
4910 else
4911 {
4912 wxFAIL_MSG( "invalid item in selection - bad internal state" );
4913 }
4914 }
4915
4916 return sel.size();
4917 }
4918
4919 void wxDataViewCtrl::SetSelections( const wxDataViewItemArray & sel )
4920 {
4921 wxDataViewSelection selection(wxDataViewSelectionCmp);
4922
4923 wxDataViewItem last_parent;
4924
4925 int len = sel.GetCount();
4926 for( int i = 0; i < len; i ++ )
4927 {
4928 wxDataViewItem item = sel[i];
4929 wxDataViewItem parent = GetModel()->GetParent( item );
4930 if (parent)
4931 {
4932 if (parent != last_parent)
4933 ExpandAncestors(item);
4934 }
4935
4936 last_parent = parent;
4937 int row = m_clientArea->GetRowByItem( item );
4938 if( row >= 0 )
4939 selection.Add( static_cast<unsigned int>(row) );
4940 }
4941
4942 m_clientArea->SetSelections( selection );
4943 }
4944
4945 void wxDataViewCtrl::Select( const wxDataViewItem & item )
4946 {
4947 ExpandAncestors( item );
4948
4949 int row = m_clientArea->GetRowByItem( item );
4950 if( row >= 0 )
4951 {
4952 // Unselect all rows before select another in the single select mode
4953 if (m_clientArea->IsSingleSel())
4954 m_clientArea->SelectAllRows(false);
4955
4956 m_clientArea->SelectRow(row, true);
4957
4958 // Also set focus to the selected item
4959 m_clientArea->ChangeCurrentRow( row );
4960 }
4961 }
4962
4963 void wxDataViewCtrl::Unselect( const wxDataViewItem & item )
4964 {
4965 int row = m_clientArea->GetRowByItem( item );
4966 if( row >= 0 )
4967 m_clientArea->SelectRow(row, false);
4968 }
4969
4970 bool wxDataViewCtrl::IsSelected( const wxDataViewItem & item ) const
4971 {
4972 int row = m_clientArea->GetRowByItem( item );
4973 if( row >= 0 )
4974 {
4975 return m_clientArea->IsRowSelected(row);
4976 }
4977 return false;
4978 }
4979
4980 void wxDataViewCtrl::SetAlternateRowColour(const wxColour& colour)
4981 {
4982 m_alternateRowColour = colour;
4983 }
4984
4985 void wxDataViewCtrl::SelectAll()
4986 {
4987 m_clientArea->SelectAllRows(true);
4988 }
4989
4990 void wxDataViewCtrl::UnselectAll()
4991 {
4992 m_clientArea->SelectAllRows(false);
4993 }
4994
4995 void wxDataViewCtrl::EnsureVisible( int row, int column )
4996 {
4997 if( row < 0 )
4998 row = 0;
4999 if( row > (int) m_clientArea->GetRowCount() )
5000 row = m_clientArea->GetRowCount();
5001
5002 int first = m_clientArea->GetFirstVisibleRow();
5003 int last = m_clientArea->GetLastVisibleRow();
5004 if( row < first )
5005 m_clientArea->ScrollTo( row, column );
5006 else if( row > last )
5007 m_clientArea->ScrollTo( row - last + first, column );
5008 else
5009 m_clientArea->ScrollTo( first, column );
5010 }
5011
5012 void wxDataViewCtrl::EnsureVisible( const wxDataViewItem & item, const wxDataViewColumn * column )
5013 {
5014 ExpandAncestors( item );
5015
5016 m_clientArea->RecalculateDisplay();
5017
5018 int row = m_clientArea->GetRowByItem(item);
5019 if( row >= 0 )
5020 {
5021 if( column == NULL )
5022 EnsureVisible(row, -1);
5023 else
5024 EnsureVisible( row, GetColumnIndex(column) );
5025 }
5026
5027 }
5028
5029 void wxDataViewCtrl::HitTest( const wxPoint & point, wxDataViewItem & item,
5030 wxDataViewColumn* &column ) const
5031 {
5032 m_clientArea->HitTest(point, item, column);
5033 }
5034
5035 wxRect wxDataViewCtrl::GetItemRect( const wxDataViewItem & item,
5036 const wxDataViewColumn* column ) const
5037 {
5038 return m_clientArea->GetItemRect(item, column);
5039 }
5040
5041 wxDataViewItem wxDataViewCtrl::GetItemByRow( unsigned int row ) const
5042 {
5043 return m_clientArea->GetItemByRow( row );
5044 }
5045
5046 int wxDataViewCtrl::GetRowByItem( const wxDataViewItem & item ) const
5047 {
5048 return m_clientArea->GetRowByItem( item );
5049 }
5050
5051 void wxDataViewCtrl::Expand( const wxDataViewItem & item )
5052 {
5053 ExpandAncestors( item );
5054
5055 int row = m_clientArea->GetRowByItem( item );
5056 if (row != -1)
5057 m_clientArea->Expand(row);
5058 }
5059
5060 void wxDataViewCtrl::Collapse( const wxDataViewItem & item )
5061 {
5062 int row = m_clientArea->GetRowByItem( item );
5063 if (row != -1)
5064 m_clientArea->Collapse(row);
5065 }
5066
5067 bool wxDataViewCtrl::IsExpanded( const wxDataViewItem & item ) const
5068 {
5069 int row = m_clientArea->GetRowByItem( item );
5070 if (row != -1)
5071 return m_clientArea->IsExpanded(row);
5072 return false;
5073 }
5074
5075 void wxDataViewCtrl::EditItem(const wxDataViewItem& item, const wxDataViewColumn *column)
5076 {
5077 wxCHECK_RET( item.IsOk(), "invalid item" );
5078 wxCHECK_RET( column, "no column provided" );
5079
5080 m_clientArea->StartEditing(item, column);
5081 }
5082
5083 #endif // !wxUSE_GENERICDATAVIEWCTRL
5084
5085 #endif // wxUSE_DATAVIEWCTRL