1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: wxDataViewCtrl wxWidgets sample
4 // Author: Robert Roebling
5 // Modified by: Francesco Montorsi, Bo Yang
8 // Copyright: (c) Robert Roebling
9 // Licence: wxWindows license
10 /////////////////////////////////////////////////////////////////////////////
12 // For compilers that support precompilation, includes "wx/wx.h".
13 #include "wx/wxprec.h"
23 #include "wx/datetime.h"
24 #include "wx/splitter.h"
25 #include "wx/aboutdlg.h"
26 #include "wx/choicdlg.h"
27 #include "wx/numdlg.h"
28 #include "wx/dataview.h"
29 #include "wx/spinctrl.h"
32 #include "../sample.xpm"
38 #define DEFAULT_ALIGN wxALIGN_LEFT
39 #define DATAVIEW_DEFAULT_STYLE (wxDV_MULTIPLE|wxDV_HORIZ_RULES|wxDV_VERT_RULES)
43 // -------------------------------------
45 // -------------------------------------
48 Implement this data model
50 -------------------------------------------------------------
53 3: You are not alone Michael Jackson 1995
54 4: Take a bow Madonna 1994
56 6: Ninth Symphony Ludwig v. Beethoven 1824
57 7: German Requiem Johannes Brahms 1868
62 class MyMusicModelNode
;
63 WX_DEFINE_ARRAY_PTR( MyMusicModelNode
*, MyMusicModelNodes
);
65 class MyMusicModelNode
68 MyMusicModelNode( MyMusicModelNode
* parent
,
69 const wxString
&title
, const wxString
&artist
, const wxString
&year
)
75 m_isContainer
= false;
78 MyMusicModelNode( MyMusicModelNode
* parent
,
79 const wxString
&branch
)
88 size_t count
= m_children
.GetCount();
90 for (i
= 0; i
< count
; i
++)
92 MyMusicModelNode
*child
= m_children
[i
];
97 bool IsContainer() { return m_isContainer
; }
99 MyMusicModelNode
* GetParent() { return m_parent
; }
100 MyMusicModelNodes
&GetChildren() { return m_children
; }
101 MyMusicModelNode
* GetNthChild( unsigned int n
) { return m_children
.Item( n
); }
102 void Insert( MyMusicModelNode
* child
, unsigned int n
) { m_children
.Insert( child
, n
); }
103 void Append( MyMusicModelNode
* child
) { m_children
.Add( child
); }
104 unsigned int GetChildCount() { return m_children
.GetCount(); }
112 MyMusicModelNode
*m_parent
;
113 MyMusicModelNodes m_children
;
118 class MyMusicModel
: public wxDataViewModel
126 m_root
= new MyMusicModelNode( NULL
, "My Music" );
127 m_pop
= new MyMusicModelNode( m_root
, "Pop music" );
128 m_root
->Append( m_pop
);
129 m_pop
->Append( new MyMusicModelNode( m_pop
,
130 "You are not alone", "Michael Jackson", "1995" ) );
131 m_pop
->Append( new MyMusicModelNode( m_pop
,
132 "Take a bow", "Madonna", "1994" ) );
133 m_classical
= new MyMusicModelNode( m_root
, "Classical music" );
134 m_root
->Append( m_classical
);
135 m_classical
->Append( new MyMusicModelNode( m_classical
,
136 "Ninth symphony", "Ludwig van Beethoven", "1824" ) );
137 m_classical
->Append( new MyMusicModelNode( m_classical
,
138 "German Requiem", "Johannes Brahms", "1868" ) );
139 m_classicalMusicIsKnownToControl
= false;
142 // helper methods to change the model
144 void AddToClassical( const wxString
&title
, const wxString
&artist
, const wxString
&year
)
147 MyMusicModelNode
*child_node
=
148 new MyMusicModelNode( m_classical
, title
, artist
, year
);
150 m_classical
->Append( child_node
);
152 if (m_classicalMusicIsKnownToControl
)
155 wxDataViewItem
child( (void*) child_node
);
156 wxDataViewItem
parent( (void*) m_classical
);
157 ItemAdded( parent
, child
);
161 void Delete( const wxDataViewItem
&item
)
163 MyMusicModelNode
*node
= (MyMusicModelNode
*) item
.GetID();
164 wxDataViewItem
parent( node
->GetParent() );
167 ItemDeleted( parent
, item
);
168 //We must delete the node after we call ItemDeleted
169 //The reason is that:
170 //When we use wxSortedArray, the array find a node through binary search for speed.
171 //And when the array is searching for some node, it call the model's compare function.
172 //The compare function need the node to be compared. So we should delete the node later, here.
173 node
->GetParent()->GetChildren().Remove( node
);
177 // override sorting to always sort branches ascendingly
179 int Compare( const wxDataViewItem
&item1
, const wxDataViewItem
&item2
,
180 unsigned int column
, bool ascending
)
182 if (IsContainer(item1
) && IsContainer(item2
))
184 wxVariant value1
,value2
;
185 GetValue( value1
, item1
, 0 );
186 GetValue( value2
, item2
, 0 );
188 wxString str1
= value1
.GetString();
189 wxString str2
= value2
.GetString();
190 int res
= str1
.Cmp( str2
);
193 // items must be different
194 unsigned long litem1
= (unsigned long) item1
.GetID();
195 unsigned long litem2
= (unsigned long) item2
.GetID();
197 return litem1
-litem2
;
200 return wxDataViewModel::Compare( item1
, item2
, column
, ascending
);
203 // implementation of base class virtuals to define model
205 virtual unsigned int GetColumnCount() const
210 virtual wxString
GetColumnType( unsigned int col
) const
215 virtual void GetValue( wxVariant
&variant
,
216 const wxDataViewItem
&item
, unsigned int col
) const
218 MyMusicModelNode
*node
= (MyMusicModelNode
*) item
.GetID();
221 case 0: variant
= node
->m_title
; break;
222 case 1: variant
= node
->m_artist
; break;
223 case 2: variant
= node
->m_year
; break;
226 wxLogError( "MyMusicModel::GetValue: wrong column" );
227 wxMouseState state
= wxGetMouseState();
228 if (state
.ShiftDown())
237 virtual bool SetValue( const wxVariant
&variant
,
238 const wxDataViewItem
&item
, unsigned int col
)
240 MyMusicModelNode
*node
= (MyMusicModelNode
*) item
.GetID();
243 case 0: node
->m_title
= variant
.GetString(); break;
244 case 1: node
->m_artist
= variant
.GetString(); break;
245 case 2: node
->m_year
= variant
.GetString(); break;
246 default: wxLogError( "MyMusicModel::SetValue: wrong column" );
250 virtual wxDataViewItem
GetParent( const wxDataViewItem
&item
) const
252 // the invisble root node has no parent
254 return wxDataViewItem(0);
256 MyMusicModelNode
*node
= (MyMusicModelNode
*) item
.GetID();
258 // "MyMusic" also has no parent
260 return wxDataViewItem(0);
262 return wxDataViewItem( (void*) node
->GetParent() );
265 virtual bool IsContainer( const wxDataViewItem
&item
) const
267 // the invisble root node can have children (in
268 // our model always "MyMusic")
272 MyMusicModelNode
*node
= (MyMusicModelNode
*) item
.GetID();
273 return node
->IsContainer();
276 virtual wxDataViewItem
GetFirstChild( const wxDataViewItem
&parent
) const
278 MyMusicModelNode
*node
= (MyMusicModelNode
*) parent
.GetID();
280 return wxDataViewItem( (void*) m_root
);
282 if (node
->GetChildCount() == 0)
283 return wxDataViewItem( 0 );
285 if (node
== m_classical
)
287 MyMusicModel
*model
= (MyMusicModel
*)(const MyMusicModel
*) this;
288 model
->m_classicalMusicIsKnownToControl
= true;
291 MyMusicModelNode
*first_child
= node
->GetChildren().Item( 0 );
292 return wxDataViewItem( (void*) first_child
);
295 virtual wxDataViewItem
GetNextSibling( const wxDataViewItem
&item
) const
297 MyMusicModelNode
*node
= (MyMusicModelNode
*) item
.GetID();
299 // "MyMusic" has no siblings in our model
301 return wxDataViewItem(0);
303 MyMusicModelNode
*parent
= node
->GetParent();
304 int pos
= parent
->GetChildren().Index( node
);
306 // Something went wrong
307 if (pos
== wxNOT_FOUND
)
308 return wxDataViewItem(0);
311 if (pos
== parent
->GetChildCount()-1)
312 return wxDataViewItem(0);
314 node
= parent
->GetChildren().Item( pos
+1 );
315 return wxDataViewItem( (void*) node
);
319 MyMusicModelNode
* m_root
;
320 MyMusicModelNode
* m_pop
;
321 MyMusicModelNode
* m_classical
;
322 bool m_classicalMusicIsKnownToControl
;
325 class MyListModel
: public wxDataViewIndexListModel
329 wxDataViewIndexListModel( 100 )
332 for (i
= 0; i
< 100; i
++)
335 str
.Printf( "row number %d", i
);
340 // helper methods to change the model
342 void Prepend( const wxString
&text
)
344 m_array
.Insert( text
, 0 );
348 void DeleteItem( const wxDataViewItem
&item
)
350 unsigned int row
= GetRow( item
);
351 m_array
.RemoveAt( row
);
355 // implementation of base class virtuals to define model
357 virtual unsigned int GetColumnCount() const
362 virtual wxString
GetColumnType( unsigned int col
) const
367 virtual unsigned int GetRowCount()
369 return m_array
.GetCount();
372 virtual void GetValue( wxVariant
&variant
,
373 unsigned int row
, unsigned int col
) const
377 variant
= m_array
[ row
];
382 str
.Printf( "row %d col %d", row
, col
);
387 virtual bool SetValue( const wxVariant
&variant
,
388 unsigned int row
, unsigned int col
)
392 m_array
[row
] = variant
.GetString();
399 wxArrayString m_array
;
402 // -------------------------------------
404 // -------------------------------------
406 class MyApp
: public wxApp
413 // -------------------------------------
415 // -------------------------------------
417 class MyFrame
: public wxFrame
420 MyFrame(wxFrame
*frame
, wxChar
*title
, int x
, int y
, int w
, int h
);
423 void OnQuit(wxCommandEvent
& event
);
424 void OnAbout(wxCommandEvent
& event
);
426 void OnAddMozart(wxCommandEvent
& event
);
427 void OnDeleteMusic(wxCommandEvent
& event
);
429 void OnPrependList(wxCommandEvent
& event
);
430 void OnDeleteList(wxCommandEvent
& event
);
432 void OnValueChanged( wxDataViewEvent
&event
);
433 void OnItemAdded( wxDataViewEvent
&event
);
434 void OnItemDeleted( wxDataViewEvent
&event
);
436 void OnActivated( wxDataViewEvent
&event
);
437 void OnExpanding( wxDataViewEvent
&event
);
438 void OnExpanded( wxDataViewEvent
&event
);
439 void OnCollapsing( wxDataViewEvent
&event
);
440 void OnCollapsed( wxDataViewEvent
&event
);
441 void OnSelected( wxDataViewEvent
&event
);
443 void OnHeaderClick( wxDataViewEvent
&event
);
444 void OnHeaderRightClick( wxDataViewEvent
&event
);
445 void OnSorted( wxDataViewEvent
&event
);
447 void OnRightClick( wxMouseEvent
&event
);
448 void OnGoto( wxCommandEvent
&event
);
451 wxDataViewCtrl
* m_musicCtrl
;
452 wxObjectDataPtr
<MyMusicModel
> m_music_model
;
454 wxDataViewCtrl
* m_listCtrl
;
455 wxObjectDataPtr
<MyListModel
> m_list_model
;
457 wxDataViewColumn
* m_col
;
463 DECLARE_EVENT_TABLE()
466 // -------------------------------------
468 // -------------------------------------
472 bool MyApp::OnInit(void)
474 if ( !wxApp::OnInit() )
477 // build the first frame
479 new MyFrame(NULL
, wxT("wxDataViewCtrl feature test"), 40, 40, 700, 440);
492 // -------------------------------------
494 // -------------------------------------
499 ID_ABOUT
= wxID_ABOUT
,
505 ID_DELETE_MUSIC
= 101,
507 ID_PREPEND_LIST
= 200,
508 ID_DELETE_LIST
= 201,
512 BEGIN_EVENT_TABLE(MyFrame
, wxFrame
)
513 EVT_MENU( ID_ABOUT
, MyFrame::OnAbout
)
514 EVT_MENU( ID_EXIT
, MyFrame::OnQuit
)
515 EVT_BUTTON( ID_ADD_MOZART
, MyFrame::OnAddMozart
)
516 EVT_BUTTON( ID_DELETE_MUSIC
, MyFrame::OnDeleteMusic
)
517 EVT_BUTTON( ID_PREPEND_LIST
, MyFrame::OnPrependList
)
518 EVT_BUTTON( ID_DELETE_LIST
, MyFrame::OnDeleteList
)
519 EVT_BUTTON( ID_GOTO
, MyFrame::OnGoto
)
521 EVT_DATAVIEW_MODEL_ITEM_ADDED( ID_MUSIC_CTRL
, MyFrame::OnItemAdded
)
522 EVT_DATAVIEW_MODEL_ITEM_DELETED( ID_MUSIC_CTRL
, MyFrame::OnItemDeleted
)
523 EVT_DATAVIEW_MODEL_VALUE_CHANGED( ID_MUSIC_CTRL
, MyFrame::OnValueChanged
)
524 EVT_DATAVIEW_MODEL_ITEM_CHANGED( ID_MUSIC_CTRL
, MyFrame::OnValueChanged
)
526 EVT_DATAVIEW_ITEM_ACTIVATED(ID_MUSIC_CTRL
, MyFrame::OnActivated
)
527 EVT_DATAVIEW_ITEM_EXPANDING(ID_MUSIC_CTRL
, MyFrame::OnExpanding
)
528 EVT_DATAVIEW_ITEM_EXPANDED(ID_MUSIC_CTRL
, MyFrame::OnExpanded
)
529 EVT_DATAVIEW_ITEM_COLLAPSING(ID_MUSIC_CTRL
, MyFrame::OnCollapsing
)
530 EVT_DATAVIEW_ITEM_COLLAPSED(ID_MUSIC_CTRL
, MyFrame::OnCollapsed
)
531 EVT_DATAVIEW_ITEM_SELECTED(ID_MUSIC_CTRL
, MyFrame::OnSelected
)
533 EVT_DATAVIEW_COLUMN_HEADER_CLICK(ID_MUSIC_CTRL
, MyFrame::OnHeaderClick
)
534 EVT_DATAVIEW_COLUMN_HEADER_RIGHT_CLICKED(ID_MUSIC_CTRL
, MyFrame::OnHeaderRightClick
)
535 EVT_DATAVIEW_COLUMN_SORTED(ID_MUSIC_CTRL
, MyFrame::OnSorted
)
537 EVT_RIGHT_UP(MyFrame::OnRightClick
)
540 MyFrame::MyFrame(wxFrame
*frame
, wxChar
*title
, int x
, int y
, int w
, int h
):
541 wxFrame(frame
, wxID_ANY
, title
, wxPoint(x
, y
), wxSize(w
, h
))
546 SetIcon(wxICON(sample
));
550 wxMenu
*file_menu
= new wxMenu
;
551 file_menu
->Append(ID_ABOUT
, "&About");
552 file_menu
->AppendSeparator();
553 file_menu
->Append(ID_EXIT
, "E&xit");
555 wxMenuBar
*menu_bar
= new wxMenuBar
;
556 menu_bar
->Append(file_menu
, "&File");
558 SetMenuBar(menu_bar
);
561 wxBoxSizer
*main_sizer
= new wxBoxSizer( wxVERTICAL
);
563 wxBoxSizer
*data_sizer
= new wxBoxSizer( wxHORIZONTAL
);
567 m_musicCtrl
= new wxDataViewCtrl( this, ID_MUSIC_CTRL
, wxDefaultPosition
,
568 wxDefaultSize
, wxDV_MULTIPLE
);
570 m_music_model
= new MyMusicModel
;
571 m_musicCtrl
->AssociateModel( m_music_model
.get() );
573 wxDataViewColumn
*col
= m_musicCtrl
->AppendTextColumn( "Title", 0, wxDATAVIEW_CELL_INERT
, 200,
574 DEFAULT_ALIGN
, wxDATAVIEW_COL_SORTABLE
);
576 // Call this and sorting is enabled
577 // immediatly upon start up.
578 col
->SetSortOrder( true );
581 m_musicCtrl
->AppendTextColumn( "Artist", 1, wxDATAVIEW_CELL_EDITABLE
, 200,
582 DEFAULT_ALIGN
, wxDATAVIEW_COL_SORTABLE
);
583 m_musicCtrl
->AppendTextColumn( "Year", 2, wxDATAVIEW_CELL_INERT
, 50,
586 data_sizer
->Add( m_musicCtrl
, 3, wxGROW
);
592 m_listCtrl
= new wxDataViewCtrl( this, wxID_ANY
, wxDefaultPosition
,
593 wxDefaultSize
, wxDV_MULTIPLE
);
595 m_list_model
= new MyListModel
;
596 m_listCtrl
->AssociateModel( m_list_model
.get() );
598 m_listCtrl
->AppendTextColumn( "editable string", 0, wxDATAVIEW_CELL_EDITABLE
, 120 );
599 m_col
= m_listCtrl
->AppendTextColumn( "index", 1, wxDATAVIEW_CELL_INERT
, 120 );
601 data_sizer
->Add( m_listCtrl
, 2, wxGROW
);
605 main_sizer
->Add( data_sizer
, 2, wxGROW
);
607 wxBoxSizer
*button_sizer
= new wxBoxSizer( wxHORIZONTAL
);
609 button_sizer
->Add( new wxButton( this, ID_ADD_MOZART
, "Add Mozart"), 0, wxALL
, 10 );
610 button_sizer
->Add( new wxButton( this, ID_DELETE_MUSIC
, "Delete selected"), 0, wxALL
, 10 );
611 button_sizer
->Add( 10, 10, 1 );
612 button_sizer
->Add( new wxButton( this, ID_PREPEND_LIST
, "Prepend"), 0, wxALL
, 10 );
613 button_sizer
->Add( new wxButton( this, ID_DELETE_LIST
, "Delete selected"), 0, wxALL
, 10 );
614 button_sizer
->Add( new wxButton( this, ID_GOTO
, "Goto 50"), 0, wxALL
, 10 );
616 main_sizer
->Add( button_sizer
, 0, wxGROW
, 0 );
618 m_log
= new wxTextCtrl( this, -1, "", wxDefaultPosition
, wxDefaultSize
, wxTE_MULTILINE
);
619 m_logOld
= wxLog::SetActiveTarget(new wxLogTextCtrl(m_log
));
620 wxLogMessage("This is the log window");
622 main_sizer
->Add( m_log
, 1, wxGROW
);
624 SetSizer( main_sizer
);
627 void MyFrame::OnQuit(wxCommandEvent
& WXUNUSED(event
) )
632 void MyFrame::OnAddMozart(wxCommandEvent
& WXUNUSED(event
) )
634 m_music_model
->AddToClassical( "Kleine Nachtmusik", "Wolfgang Mozart", "1787" );
637 void MyFrame::OnDeleteMusic(wxCommandEvent
& WXUNUSED(event
) )
639 wxDataViewItemArray items
;
640 int len
= m_musicCtrl
->GetSelections( items
);
641 for( int i
= 0; i
< len
; i
++ )
643 m_music_model
->Delete( items
[i
] );
646 void MyFrame::OnPrependList( wxCommandEvent
& WXUNUSED(event
) )
648 m_list_model
->Prepend( "Test" );
651 void MyFrame::OnDeleteList( wxCommandEvent
& WXUNUSED(event
) )
653 wxDataViewItemArray items
;
654 int len
= m_listCtrl
->GetSelections( items
);
655 for( int i
= 0; i
< len
; i
++ )
657 m_list_model
->DeleteItem( items
[i
] );
660 void MyFrame::OnItemAdded( wxDataViewEvent
&event
)
665 wxLogMessage("wxEVT_COMMAND_DATAVIEW_MODEL_ITEM_ADDED, Item Id: %d",event
.GetItem().GetID());
668 void MyFrame::OnItemDeleted( wxDataViewEvent
&event
)
673 wxLogMessage( "EVT_DATAVIEW_MODEL_ITEM_DELETED, Item Id: %d", event
.GetItem().GetID() );
676 void MyFrame::OnValueChanged( wxDataViewEvent
&event
)
681 wxLogMessage( "EVT_DATAVIEW_MODEL_VALUE_CHANGED, Item Id: %d; Column: %d", event
.GetItem().GetID(), event
.GetColumn() );
684 void MyFrame::OnActivated( wxDataViewEvent
&event
)
689 wxLogMessage("wxEVT_COMMAND_DATAVIEW_ITEM_ACTIVATED, Item Id: %d; Column: %d", event
.GetItem().GetID(), event
.GetColumn());
692 void MyFrame::OnSelected( wxDataViewEvent
&event
)
697 wxLogMessage("wxEVT_COMMAND_DATAVIEW_ITEM_SELECTED, Item Id: %d", event
.GetItem().GetID() );
700 void MyFrame::OnExpanding( wxDataViewEvent
&event
)
705 wxLogMessage("wxEVT_COMMAND_DATAVIEW_ITEM_EXPANDING, Item Id: %d", event
.GetItem().GetID() );
708 void MyFrame::OnExpanded( wxDataViewEvent
&event
)
713 wxLogMessage("wxEVT_COMMAND_DATAVIEW_ITEM_EXPANDED, Item Id: %d", event
.GetItem().GetID() );
716 void MyFrame::OnCollapsing( wxDataViewEvent
&event
)
721 wxLogMessage("wxEVT_COMMAND_DATAVIEW_ITEM_COLLAPSING, Item Id: %d", event
.GetItem().GetID() );
724 void MyFrame::OnCollapsed( wxDataViewEvent
&event
)
729 wxLogMessage("wxEVT_COMMAND_DATAVIEW_ITEM_COLLAPSED, Item Id: %d", event
.GetItem().GetID() );
732 void MyFrame::OnHeaderClick( wxDataViewEvent
&event
)
737 wxLogMessage("wxEVT_COMMAND_DATAVIEW_COLUMN_HEADER_CLICK, Column: %d", event
.GetColumn());
740 void MyFrame::OnHeaderRightClick( wxDataViewEvent
&event
)
745 wxLogMessage("wxEVT_COMMAND_DATAVIEW_COLUMN_HEADER_RIGHT_CLICK, Column: %d", event
.GetColumn());
748 void MyFrame::OnSorted( wxDataViewEvent
&event
)
753 wxLogMessage("wxEVT_COMMAND_DATAVIEW_COLUMN_SORTED, Column: %d", event
.GetColumn());
756 void MyFrame::OnRightClick( wxMouseEvent
&event
)
761 wxLogMessage("wxEVT_MOUSE_RIGHT_UP, Click Point is X: %d, Y: %d", event
.GetX(), event
.GetY());
764 void MyFrame::OnGoto( wxCommandEvent
&event
)
766 wxDataViewItem item
= m_list_model
->GetItem( 50 );
767 m_listCtrl
->EnsureVisible(item
,m_col
);
770 void MyFrame::OnAbout(wxCommandEvent
& WXUNUSED(event
) )
772 wxAboutDialogInfo info
;
773 info
.SetName(_("DataView sample"));
774 info
.SetDescription(_("This sample demonstrates the dataview control handling"));
775 info
.SetCopyright(_T("(C) 2007 Robert Roebling"));