samples/dataview/dataview.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        dataview.cpp
   3 // Purpose:     wxDataViewCtrl wxWidgets sample
   4 // Author:      Robert Roebling
   5 // Modified by: Francesco Montorsi
   6 // Created:     06/01/06
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Robert Roebling
   9 // Licence:     wxWindows license
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 // For compilers that support precompilation, includes "wx/wx.h".
  13 #include "wx/wxprec.h"
  14
  15 #ifdef __BORLANDC__
  16 #pragma hdrstop
  17 #endif
  18
  19 #ifndef WX_PRECOMP
  20     #include "wx/wx.h"
  21 #endif
  22
  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"
  30
  31 #ifndef __WXMSW__
  32     #include "../sample.xpm"
  33 #endif
  34
  35 #include "null.xpm"
  36
  37
  38 #define DEFAULT_ALIGN                   wxALIGN_LEFT
  39 #define DATAVIEW_DEFAULT_STYLE          (wxDV_MULTIPLE|wxDV_HORIZ_RULES|wxDV_VERT_RULES)
  40
  41
  42
  43 // -------------------------------------
  44 // MyMusicModel
  45 // -------------------------------------
  46
  47 /*
  48 Implement this data model
  49             Title               Artist               Year
  50 -------------------------------------------------------------
  51 1: My Music:
  52     2:  Pop music
  53         3:  You are not alone   Michael Jackson      1995
  54         4:  Take a bow          Madonna              1994
  55     5:  Classical music
  56         6:  Ninth Symphony      Ludwig v. Beethoven  1824
  57         7:  German Requiem      Johannes Brahms      1868
  58 */
  59
  60
  61
  62 class MyMusicModelNode;
  63 WX_DEFINE_ARRAY_PTR( MyMusicModelNode*, MyMusicModelNodes );
  64
  65 class MyMusicModelNode
  66 {
  67 public:
  68     MyMusicModelNode( MyMusicModelNode* parent,
  69                       const wxString &title, const wxString &artist, const wxString &year )
  70     {
  71         m_parent = parent;
  72         m_title = title;
  73         m_artist = artist;
  74         m_year = year;
  75         m_isContainer = false;
  76     }
  77
  78     MyMusicModelNode( MyMusicModelNode* parent,
  79                       const wxString &branch )
  80     {
  81         m_parent = parent;
  82         m_title = branch;
  83         m_isContainer = true;
  84     }
  85
  86     ~MyMusicModelNode()
  87     {
  88         size_t count = m_children.GetCount();
  89         size_t i;
  90         for (i = 0; i < count; i++)
  91         {
  92             MyMusicModelNode *child = m_children[i];
  93             delete child;
  94         }
  95     }
  96
  97     bool IsContainer()                                    { return m_isContainer; }
  98
  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(); }
 105
 106 public:
 107     wxString            m_title;
 108     wxString            m_artist;
 109     wxString            m_year;
 110
 111 private:
 112     MyMusicModelNode   *m_parent;
 113     MyMusicModelNodes   m_children;
 114     bool                m_isContainer;
 115 };
 116
 117
 118 class MyMusicModel: public wxDataViewModel
 119 {
 120 public:
 121
 122     // constructor
 123
 124     MyMusicModel()
 125     {
 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;
 140     }
 141
 142     // helper methods to change the model
 143
 144     void AddToClassical( const wxString &title, const wxString &artist, const wxString &year )
 145     {
 146         // add to data
 147         MyMusicModelNode *child_node =
 148             new MyMusicModelNode( m_classical, title, artist, year );
 149         m_classical->Append( child_node );
 150
 151         if (m_classicalMusicIsKnownToControl)
 152         {
 153             // notify control
 154             wxDataViewItem child( (void*) child_node );
 155             wxDataViewItem parent( (void*) m_classical );
 156             ItemAdded( parent, child );
 157         }
 158     }
 159
 160     void Delete( const wxDataViewItem &item )
 161     {
 162         MyMusicModelNode *node = (MyMusicModelNode*) item.GetID();
 163         wxDataViewItem parent( node->GetParent() );
 164
 165         // notify control
 166         ItemDeleted( parent, item );
 167         node->GetParent()->GetChildren().Remove( node );
 168         delete node;
 169     }
 170
 171     // override sorting to always sort branches ascendingly
 172
 173     int Compare( const wxDataViewItem &item1, const wxDataViewItem &item2,
 174                  unsigned int column, bool ascending )
 175     {
 176         if (IsContainer(item1) && IsContainer(item2))
 177         {
 178             wxVariant value1,value2;
 179             GetValue( value1, item1, 0 );
 180             GetValue( value2, item2, 0 );
 181
 182             wxString str1 = value1.GetString();
 183             wxString str2 = value2.GetString();
 184             int res = str1.Cmp( str2 );
 185             if (res) return res;
 186
 187             // items must be different
 188             unsigned long litem1 = (unsigned long) item1.GetID();
 189             unsigned long litem2 = (unsigned long) item2.GetID();
 190
 191             return litem1-litem2;
 192         }
 193
 194         return wxDataViewModel::Compare( item1, item2, column, ascending );
 195     }
 196
 197     // implementation of base class virtuals to define model
 198
 199     virtual unsigned int GetColumnCount() const
 200     {
 201         return 3;
 202     }
 203
 204     virtual wxString GetColumnType( unsigned int col ) const
 205     {
 206         return "string";
 207     }
 208
 209     virtual void GetValue( wxVariant &variant,
 210                            const wxDataViewItem &item, unsigned int col ) const
 211     {
 212         MyMusicModelNode *node = (MyMusicModelNode*) item.GetID();
 213         switch (col)
 214         {
 215             case 0: variant = node->m_title; break;
 216             case 1: variant = node->m_artist; break;
 217             case 2: variant = node->m_year; break;
 218             default: wxLogError( "MyMusicModel::GetValue: wrong column" );
 219         }
 220     }
 221
 222     virtual bool SetValue( const wxVariant &variant,
 223                            const wxDataViewItem &item, unsigned int col )
 224     {
 225         MyMusicModelNode *node = (MyMusicModelNode*) item.GetID();
 226         switch (col)
 227         {
 228             case 0: node->m_title = variant.GetString(); break;
 229             case 1: node->m_artist  = variant.GetString(); break;
 230             case 2: node->m_year  = variant.GetString(); break;
 231             default: wxLogError( "MyMusicModel::SetValue: wrong column" );
 232         }
 233     }
 234
 235     virtual wxDataViewItem GetParent( const wxDataViewItem &item ) const
 236     {
 237         // the invisble root node has no parent
 238         if (!item.IsOk())
 239             return wxDataViewItem(0);
 240
 241         MyMusicModelNode *node = (MyMusicModelNode*) item.GetID();
 242
 243         // "MyMusic" also has no parent
 244         if (node == m_root)
 245             return wxDataViewItem(0);
 246
 247         return wxDataViewItem( (void*) node->GetParent() );
 248     }
 249
 250     virtual bool IsContainer( const wxDataViewItem &item ) const
 251     {
 252         // the invisble root node can have children (in
 253         // our model always "MyMusic")
 254         if (!item.IsOk())
 255             return true;
 256
 257         MyMusicModelNode *node = (MyMusicModelNode*) item.GetID();
 258         return node->IsContainer();
 259     }
 260
 261     virtual wxDataViewItem GetFirstChild( const wxDataViewItem &parent ) const
 262     {
 263         MyMusicModelNode *node = (MyMusicModelNode*) parent.GetID();
 264         if (!node)
 265             return wxDataViewItem( (void*) m_root );
 266
 267         if (node->GetChildCount() == 0)
 268             return wxDataViewItem( 0 );
 269
 270         if (node == m_classical)
 271         {
 272             MyMusicModel *model = (MyMusicModel*)(const MyMusicModel*) this;
 273             model->m_classicalMusicIsKnownToControl = true;
 274         }
 275
 276         MyMusicModelNode *first_child = node->GetChildren().Item( 0 );
 277         return wxDataViewItem( (void*) first_child );
 278     }
 279
 280     virtual wxDataViewItem GetNextSibling( const wxDataViewItem &item ) const
 281     {
 282         MyMusicModelNode *node = (MyMusicModelNode*) item.GetID();
 283
 284         // "MyMusic" has no siblings in our model
 285         if (node == m_root)
 286             return wxDataViewItem(0);
 287
 288         MyMusicModelNode *parent = node->GetParent();
 289         int pos = parent->GetChildren().Index( node );
 290
 291         // Something went wrong
 292         if (pos == wxNOT_FOUND)
 293             return wxDataViewItem(0);
 294
 295         // No more children
 296         if (pos == parent->GetChildCount()-1)
 297             return wxDataViewItem(0);
 298
 299         node = parent->GetChildren().Item( pos+1 );
 300         return wxDataViewItem( (void*) node );
 301     }
 302
 303 private:
 304     MyMusicModelNode*   m_root;
 305     MyMusicModelNode*   m_pop;
 306     MyMusicModelNode*   m_classical;
 307     bool                m_classicalMusicIsKnownToControl;
 308 };
 309
 310 class MyListModel: public wxDataViewIndexListModel
 311 {
 312 public:
 313     MyListModel() :
 314         wxDataViewIndexListModel( 100 )
 315     {
 316         unsigned int i;
 317         for (i = 0; i < 100; i++)
 318         {
 319             wxString str;
 320             str.Printf( "row number %d", i );
 321             m_array.Add( str );
 322         }
 323     }
 324
 325     // helper methods to change the model
 326
 327     void Prepend( const wxString &text )
 328     {
 329         m_array.Insert( text, 0 );
 330         RowPrepended();
 331     }
 332
 333     void DeleteItem( const wxDataViewItem &item )
 334     {
 335         unsigned int row = GetRow( item );
 336         m_array.RemoveAt( row );
 337         RowDeleted( row );
 338     }
 339
 340     // implementation of base class virtuals to define model
 341
 342     virtual unsigned int GetColumnCount() const
 343     {
 344         return 2;
 345     }
 346
 347     virtual wxString GetColumnType( unsigned int col ) const
 348     {
 349         return "string";
 350     }
 351
 352     virtual unsigned int GetRowCount()
 353     {
 354         return m_array.GetCount();
 355     }
 356
 357     virtual void GetValue( wxVariant &variant,
 358                            unsigned int row, unsigned int col ) const
 359     {
 360         if (col==0)
 361         {
 362             variant = m_array[ row ];
 363         }
 364         else
 365         {
 366             wxString str;
 367             str.Printf( "row %d col %d", row, col );
 368             variant = str;
 369         }
 370     }
 371
 372     virtual bool SetValue( const wxVariant &variant,
 373                            unsigned int row, unsigned int col )
 374     {
 375         if (col == 0)
 376         {
 377             m_array[row] = variant.GetString();
 378             return true;
 379         }
 380
 381         return false;
 382     }
 383
 384     wxArrayString    m_array;
 385 };
 386
 387 // -------------------------------------
 388 // MyApp
 389 // -------------------------------------
 390
 391 class MyApp: public wxApp
 392 {
 393 public:
 394     bool OnInit(void);
 395     int OnExit();
 396 };
 397
 398 // -------------------------------------
 399 // MyFrame
 400 // -------------------------------------
 401
 402 class MyFrame : public wxFrame
 403 {
 404 public:
 405     MyFrame(wxFrame *frame, wxChar *title, int x, int y, int w, int h);
 406
 407 public:
 408     void OnQuit(wxCommandEvent& event);
 409     void OnAbout(wxCommandEvent& event);
 410
 411     void OnAddMozart(wxCommandEvent& event);
 412     void OnDeleteMusic(wxCommandEvent& event);
 413
 414     void OnPrependList(wxCommandEvent& event);
 415     void OnDeleteList(wxCommandEvent& event);
 416
 417     void OnValueChanged( wxDataViewEvent &event );
 418     void OnItemAdded( wxDataViewEvent &event );
 419     void OnItemDeleted( wxDataViewEvent &event );
 420
 421 private:
 422     wxDataViewCtrl* m_musicCtrl;
 423     wxObjectDataPtr<MyMusicModel> m_music_model;
 424
 425     wxDataViewCtrl* m_listCtrl;
 426     wxObjectDataPtr<MyListModel> m_list_model;
 427
 428     wxTextCtrl    * m_log;
 429
 430 private:
 431     DECLARE_EVENT_TABLE()
 432 };
 433
 434 // -------------------------------------
 435 // MyApp
 436 // -------------------------------------
 437
 438 IMPLEMENT_APP(MyApp)
 439
 440 bool MyApp::OnInit(void)
 441 {
 442     if ( !wxApp::OnInit() )
 443         return false;
 444
 445     // build the first frame
 446     MyFrame *frame =
 447         new MyFrame(NULL, wxT("wxDataViewCtrl feature test"), 10, 10, 700, 440);
 448     frame->Show(true);
 449
 450     SetTopWindow(frame);
 451     return true;
 452 }
 453
 454 int MyApp::OnExit()
 455 {
 456     return 0;
 457 }
 458
 459
 460 // -------------------------------------
 461 // MyFrame
 462 // -------------------------------------
 463
 464 enum
 465 {
 466     // file menu
 467     ID_ABOUT = wxID_ABOUT,
 468     ID_EXIT = wxID_EXIT,
 469
 470     ID_MUSIC_CTRL       = 50,
 471
 472     ID_ADD_MOZART       = 100,
 473     ID_DELETE_MUSIC     = 101,
 474
 475     ID_PREPEND_LIST     = 200,
 476     ID_DELETE_LIST      = 201
 477 };
 478
 479 BEGIN_EVENT_TABLE(MyFrame, wxFrame)
 480     EVT_MENU( ID_ABOUT, MyFrame::OnAbout )
 481     EVT_MENU( ID_EXIT, MyFrame::OnQuit )
 482     EVT_BUTTON( ID_ADD_MOZART, MyFrame::OnAddMozart )
 483     EVT_BUTTON( ID_DELETE_MUSIC, MyFrame::OnDeleteMusic )
 484     EVT_BUTTON( ID_PREPEND_LIST, MyFrame::OnPrependList )
 485     EVT_BUTTON( ID_DELETE_LIST, MyFrame::OnDeleteList )
 486     EVT_DATAVIEW_MODEL_ITEM_ADDED( ID_MUSIC_CTRL, MyFrame::OnItemAdded )
 487     EVT_DATAVIEW_MODEL_ITEM_DELETED( ID_MUSIC_CTRL, MyFrame::OnItemDeleted )
 488     EVT_DATAVIEW_MODEL_VALUE_CHANGED( ID_MUSIC_CTRL, MyFrame::OnValueChanged )
 489 END_EVENT_TABLE()
 490
 491 MyFrame::MyFrame(wxFrame *frame, wxChar *title, int x, int y, int w, int h):
 492   wxFrame(frame, wxID_ANY, title, wxPoint(x, y), wxSize(w, h))
 493 {
 494     m_log = NULL;
 495
 496     SetIcon(wxICON(sample));
 497
 498     // build the menus:
 499
 500     wxMenu *file_menu = new wxMenu;
 501     file_menu->Append(ID_ABOUT, "&About");
 502     file_menu->AppendSeparator();
 503     file_menu->Append(ID_EXIT, "E&xit");
 504
 505     wxMenuBar *menu_bar = new wxMenuBar;
 506     menu_bar->Append(file_menu, "&File");
 507
 508     SetMenuBar(menu_bar);
 509     CreateStatusBar();
 510
 511     wxBoxSizer *main_sizer = new wxBoxSizer( wxVERTICAL );
 512
 513     wxBoxSizer *data_sizer = new wxBoxSizer( wxHORIZONTAL );
 514
 515     // MyMusic
 516
 517     m_musicCtrl = new wxDataViewCtrl( this, ID_MUSIC_CTRL, wxDefaultPosition,
 518                                     wxDefaultSize );
 519
 520     m_music_model = new MyMusicModel;
 521     m_musicCtrl->AssociateModel( m_music_model.get() );
 522
 523     m_musicCtrl->AppendTextColumn( "Title", 0, wxDATAVIEW_CELL_INERT, 200,
 524                                      DEFAULT_ALIGN, wxDATAVIEW_COL_SORTABLE );
 525     m_musicCtrl->AppendTextColumn( "Artist", 1, wxDATAVIEW_CELL_EDITABLE, 200,
 526                                      DEFAULT_ALIGN, wxDATAVIEW_COL_SORTABLE );
 527     m_musicCtrl->AppendTextColumn( "Year", 2, wxDATAVIEW_CELL_INERT, 50,
 528                                      DEFAULT_ALIGN );
 529
 530     data_sizer->Add( m_musicCtrl, 3, wxGROW );
 531
 532 #if 1
 533
 534     // MyList
 535
 536     m_listCtrl = new wxDataViewCtrl( this, wxID_ANY, wxDefaultPosition,
 537                                      wxDefaultSize );
 538
 539     m_list_model = new MyListModel;
 540     m_listCtrl->AssociateModel( m_list_model.get() );
 541
 542     m_listCtrl->AppendTextColumn( "editable string", 0, wxDATAVIEW_CELL_EDITABLE, 120 );
 543     m_listCtrl->AppendTextColumn( "index", 1, wxDATAVIEW_CELL_INERT, 120 );
 544
 545     data_sizer->Add( m_listCtrl, 2, wxGROW );
 546
 547 #endif
 548
 549     main_sizer->Add( data_sizer, 2, wxGROW );
 550
 551     wxBoxSizer *button_sizer = new wxBoxSizer( wxHORIZONTAL );
 552
 553     button_sizer->Add( new wxButton( this, ID_ADD_MOZART, "Add Mozart"), 0, wxALL, 10 );
 554     button_sizer->Add( new wxButton( this, ID_DELETE_MUSIC, "Delete selected"), 0, wxALL, 10 );
 555     button_sizer->Add( 10, 10, 1 );
 556     button_sizer->Add( new wxButton( this, ID_PREPEND_LIST, "Prepend"), 0, wxALL, 10 );
 557     button_sizer->Add( new wxButton( this, ID_DELETE_LIST, "Delete selected"), 0, wxALL, 10 );
 558
 559     main_sizer->Add( button_sizer, 0, wxGROW, 0 );
 560
 561     m_log = new wxTextCtrl( this, -1, "", wxDefaultPosition, wxDefaultSize, wxTE_MULTILINE );
 562
 563     main_sizer->Add( m_log, 1, wxGROW );
 564
 565     SetSizer( main_sizer );
 566 }
 567
 568 void MyFrame::OnQuit(wxCommandEvent& WXUNUSED(event) )
 569 {
 570     Close(true);
 571 }
 572
 573 void MyFrame::OnAddMozart(wxCommandEvent& WXUNUSED(event) )
 574 {
 575     m_music_model->AddToClassical( "Kleine Nachtmusik", "Wolfgang Mozart", "1787" );
 576 }
 577
 578 void MyFrame::OnDeleteMusic(wxCommandEvent& WXUNUSED(event) )
 579 {
 580     wxDataViewItem item = m_musicCtrl->GetSelection();
 581     if (item.IsOk())
 582         m_music_model->Delete( item );
 583 }
 584
 585 void MyFrame::OnPrependList( wxCommandEvent& WXUNUSED(event) )
 586 {
 587     m_list_model->Prepend( "Test" );
 588 }
 589
 590 void MyFrame::OnDeleteList( wxCommandEvent& WXUNUSED(event) )
 591 {
 592     wxDataViewItem item = m_listCtrl->GetSelection();
 593     if (item.IsOk())
 594         m_list_model->DeleteItem( item );
 595 }
 596
 597 void MyFrame::OnItemAdded( wxDataViewEvent &event )
 598 {
 599     if (!m_log)
 600         return;
 601
 602     m_log->AppendText( "EVT_DATAVIEW_MODEL_ITEM_ADDED\n" );
 603 }
 604
 605 void MyFrame::OnItemDeleted( wxDataViewEvent &event )
 606 {
 607     if (!m_log)
 608         return;
 609
 610     m_log->AppendText( "EVT_DATAVIEW_MODEL_ITEM_DELETED\n" );
 611 }
 612
 613 void MyFrame::OnValueChanged( wxDataViewEvent &event )
 614 {
 615     if (!m_log)
 616         return;
 617
 618     m_log->AppendText( "EVT_DATAVIEW_MODEL_VALUE_CHANGED\n" );
 619 }
 620
 621 void MyFrame::OnAbout(wxCommandEvent& WXUNUSED(event) )
 622 {
 623     wxAboutDialogInfo info;
 624     info.SetName(_("DataView sample"));
 625     info.SetDescription(_("This sample demonstrates the dataview control handling"));
 626     info.SetCopyright(_T("(C) 2007 Robert Roebling"));
 627
 628     wxAboutBox(info);
 629 }
 630