tests/controls/listbasetest.cpp

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        tests/controls/listbasetest.cpp
   3 // Purpose:     Base class for wxListCtrl and wxListView tests
   4 // Author:      Steven Lamerton
   5 // Created:     2010-07-20
   6 // RCS-ID:      $Id$
   7 // Copyright:   (c) 2008 Vadim Zeitlin <vadim@wxwidgets.org>,
   8 //              (c) 2010 Steven Lamerton
   9 ///////////////////////////////////////////////////////////////////////////////
  10
  11 #include "testprec.h"
  12
  13 #if wxUSE_LISTCTRL
  14
  15 #ifdef __BORLANDC__
  16     #pragma hdrstop
  17 #endif
  18
  19 #ifndef WX_PRECOMP
  20     #include "wx/app.h"
  21 #endif // WX_PRECOMP
  22
  23 #include "wx/listctrl.h"
  24 #include "listbasetest.h"
  25 #include "testableframe.h"
  26 #include "asserthelper.h"
  27 #include "wx/uiaction.h"
  28 #include "wx/imaglist.h"
  29 #include "wx/artprov.h"
  30
  31 void ListBaseTestCase::ColumnsOrder()
  32 {
  33 #ifdef wxHAS_LISTCTRL_COLUMN_ORDER
  34     wxListCtrl* const list = GetList();
  35
  36     int n;
  37     wxListItem li;
  38     li.SetMask(wxLIST_MASK_TEXT);
  39
  40     // first set up some columns
  41     static const int NUM_COLS = 3;
  42
  43     list->InsertColumn(0, "Column 0");
  44     list->InsertColumn(1, "Column 1");
  45     list->InsertColumn(2, "Column 2");
  46
  47     // and a couple of test items too
  48     list->InsertItem(0, "Item 0");
  49     list->SetItem(0, 1, "first in first");
  50
  51     list->InsertItem(1, "Item 1");
  52     list->SetItem(1, 2, "second in second");
  53
  54
  55     // check that the order is natural in the beginning
  56     const wxArrayInt orderOrig = list->GetColumnsOrder();
  57     for ( n = 0; n < NUM_COLS; n++ )
  58         CPPUNIT_ASSERT_EQUAL( n, orderOrig[n] );
  59
  60     // then rearrange them: using { 2, 0, 1 } order means that column 2 is
  61     // shown first, then column 0 and finally column 1
  62     wxArrayInt order(3);
  63     order[0] = 2;
  64     order[1] = 0;
  65     order[2] = 1;
  66     list->SetColumnsOrder(order);
  67
  68     // check that we get back the same order as we set
  69     const wxArrayInt orderNew = list->GetColumnsOrder();
  70     for ( n = 0; n < NUM_COLS; n++ )
  71         CPPUNIT_ASSERT_EQUAL( order[n], orderNew[n] );
  72
  73     // and the order -> index mappings for individual columns
  74     for ( n = 0; n < NUM_COLS; n++ )
  75         CPPUNIT_ASSERT_EQUAL( order[n], list->GetColumnIndexFromOrder(n) );
  76
  77     // and also the reverse mapping
  78     CPPUNIT_ASSERT_EQUAL( 1, list->GetColumnOrder(0) );
  79     CPPUNIT_ASSERT_EQUAL( 2, list->GetColumnOrder(1) );
  80     CPPUNIT_ASSERT_EQUAL( 0, list->GetColumnOrder(2) );
  81
  82
  83     // finally check that accessors still use indices, not order
  84     CPPUNIT_ASSERT( list->GetColumn(0, li) );
  85     CPPUNIT_ASSERT_EQUAL( "Column 0", li.GetText() );
  86
  87     li.SetId(0);
  88     li.SetColumn(1);
  89     CPPUNIT_ASSERT( list->GetItem(li) );
  90     CPPUNIT_ASSERT_EQUAL( "first in first", li.GetText() );
  91
  92     li.SetId(1);
  93     li.SetColumn(2);
  94     CPPUNIT_ASSERT( list->GetItem(li) );
  95     CPPUNIT_ASSERT_EQUAL( "second in second", li.GetText() );
  96
  97     //tidy up when we are finished
  98     list->ClearAll();
  99 #endif // wxHAS_LISTCTRL_COLUMN_ORDER
 100 }
 101
 102
 103
 104 void ListBaseTestCase::ItemRect()
 105 {
 106     wxListCtrl* const list = GetList();
 107
 108     // set up for the test
 109     list->InsertColumn(0, "Column 0", wxLIST_FORMAT_LEFT, 60);
 110     list->InsertColumn(1, "Column 1", wxLIST_FORMAT_LEFT, 50);
 111     list->InsertColumn(2, "Column 2", wxLIST_FORMAT_LEFT, 40);
 112
 113     list->InsertItem(0, "Item 0");
 114     list->SetItem(0, 1, "first column");
 115     list->SetItem(0, 1, "second column");
 116
 117     // do test
 118     wxRect r;
 119     WX_ASSERT_FAILS_WITH_ASSERT( list->GetItemRect(1, r) );
 120     CPPUNIT_ASSERT( list->GetItemRect(0, r) );
 121     CPPUNIT_ASSERT_EQUAL( 150, r.GetWidth() );
 122
 123     CPPUNIT_ASSERT( list->GetSubItemRect(0, 0, r) );
 124     CPPUNIT_ASSERT_EQUAL( 60, r.GetWidth() );
 125
 126     CPPUNIT_ASSERT( list->GetSubItemRect(0, 1, r) );
 127     CPPUNIT_ASSERT_EQUAL( 50, r.GetWidth() );
 128
 129     CPPUNIT_ASSERT( list->GetSubItemRect(0, 2, r) );
 130     CPPUNIT_ASSERT_EQUAL( 40, r.GetWidth() );
 131
 132     WX_ASSERT_FAILS_WITH_ASSERT( list->GetSubItemRect(0, 3, r) );
 133
 134     //tidy up when we are finished
 135     list->ClearAll();
 136 }
 137
 138 void ListBaseTestCase::ItemText()
 139 {
 140     wxListCtrl* const list = GetList();
 141
 142     list->InsertColumn(0, "First");
 143     list->InsertColumn(1, "Second");
 144
 145     list->InsertItem(0, "0,0");
 146     CPPUNIT_ASSERT_EQUAL( "0,0", list->GetItemText(0) );
 147     CPPUNIT_ASSERT_EQUAL( "", list->GetItemText(0, 1) );
 148
 149     list->SetItem(0, 1, "0,1");
 150     CPPUNIT_ASSERT_EQUAL( "0,1", list->GetItemText(0, 1) );
 151 }
 152
 153 void ListBaseTestCase::ChangeMode()
 154 {
 155     wxListCtrl* const list = GetList();
 156
 157     list->InsertColumn(0, "Header");
 158     list->InsertItem(0, "First");
 159     list->InsertItem(1, "Second");
 160     CPPUNIT_ASSERT_EQUAL( 2, list->GetItemCount() );
 161
 162     // check that switching the mode preserves the items
 163     list->SetWindowStyle(wxLC_ICON);
 164     CPPUNIT_ASSERT_EQUAL( 2, list->GetItemCount() );
 165     CPPUNIT_ASSERT_EQUAL( "First", list->GetItemText(0) );
 166
 167     // and so does switching back
 168     list->SetWindowStyle(wxLC_REPORT);
 169     CPPUNIT_ASSERT_EQUAL( 2, list->GetItemCount() );
 170     CPPUNIT_ASSERT_EQUAL( "First", list->GetItemText(0) );
 171
 172     //tidy up when we are finished
 173     list->ClearAll();
 174 }
 175
 176 void ListBaseTestCase::ItemClick()
 177 {
 178     // FIXME: This test fail under wxGTK because we get 3 FOCUSED events and
 179     //        2 SELECTED ones instead of the one of each we expect for some
 180     //        reason, this needs to be debugged as it may indicate a bug in the
 181     //        generic wxListCtrl implementation.
 182 #if wxUSE_UIACTIONSIMULATOR && !defined(__WXGTK__)
 183
 184 #ifdef __WXMSW__
 185     // FIXME: This test fails on MSW buildbot slaves although works fine on
 186     //        development machine, no idea why. It seems to be a problem with
 187     //        wxUIActionSimulator rather the wxListCtrl control itself however.
 188     if ( IsAutomaticTest() )
 189         return;
 190 #endif // __WXMSW__
 191
 192     wxListCtrl* const list = GetList();
 193
 194     list->InsertColumn(0, "Column 0", wxLIST_FORMAT_LEFT, 60);
 195     list->InsertColumn(1, "Column 1", wxLIST_FORMAT_LEFT, 50);
 196     list->InsertColumn(2, "Column 2", wxLIST_FORMAT_LEFT, 40);
 197
 198     list->InsertItem(0, "Item 0");
 199     list->SetItem(0, 1, "first column");
 200     list->SetItem(0, 2, "second column");
 201
 202     EventCounter selected(list, wxEVT_COMMAND_LIST_ITEM_SELECTED);
 203     EventCounter focused(list, wxEVT_COMMAND_LIST_ITEM_FOCUSED);
 204     EventCounter activated(list, wxEVT_COMMAND_LIST_ITEM_ACTIVATED);
 205     EventCounter rclick(list, wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK);
 206
 207     wxUIActionSimulator sim;
 208
 209     wxRect pos;
 210     list->GetItemRect(0, pos);
 211
 212     //We move in slightly so we are not on the edge
 213     wxPoint point = list->ClientToScreen(pos.GetPosition()) + wxPoint(2, 2);
 214
 215     sim.MouseMove(point);
 216     wxYield();
 217
 218     sim.MouseClick();
 219     wxYield();
 220
 221     sim.MouseDblClick();
 222     wxYield();
 223
 224     sim.MouseClick(wxMOUSE_BTN_RIGHT);
 225     wxYield();
 226
 227     // when the first item was selected the focus changes to it, but not
 228     // on subsequent clicks
 229     CPPUNIT_ASSERT_EQUAL(1, focused.GetCount());
 230     CPPUNIT_ASSERT_EQUAL(1, selected.GetCount());
 231     CPPUNIT_ASSERT_EQUAL(1, activated.GetCount());
 232     CPPUNIT_ASSERT_EQUAL(1, rclick.GetCount());
 233
 234     //tidy up when we are finished
 235     list->ClearAll();
 236 #endif // wxUSE_UIACTIONSIMULATOR
 237 }
 238
 239 void ListBaseTestCase::KeyDown()
 240 {
 241 #if wxUSE_UIACTIONSIMULATOR
 242     wxListCtrl* const list = GetList();
 243
 244     EventCounter keydown(list, wxEVT_COMMAND_LIST_KEY_DOWN);
 245
 246     wxUIActionSimulator sim;
 247
 248     list->SetFocus();
 249     sim.Text("aAbB");
 250     wxYield();
 251
 252     CPPUNIT_ASSERT_EQUAL(6, keydown.GetCount());
 253 #endif
 254 }
 255
 256 void ListBaseTestCase::DeleteItems()
 257 {
 258 #ifndef __WXOSX__
 259     wxListCtrl* const list = GetList();
 260
 261     EventCounter deleteitem(list, wxEVT_COMMAND_LIST_DELETE_ITEM);
 262     EventCounter deleteall(list, wxEVT_COMMAND_LIST_DELETE_ALL_ITEMS);
 263
 264
 265     list->InsertColumn(0, "Column 0", wxLIST_FORMAT_LEFT, 60);
 266     list->InsertColumn(1, "Column 1", wxLIST_FORMAT_LEFT, 50);
 267     list->InsertColumn(2, "Column 2", wxLIST_FORMAT_LEFT, 40);
 268
 269     list->InsertItem(0, "Item 0");
 270     list->InsertItem(1, "Item 1");
 271     list->InsertItem(2, "Item 1");
 272
 273     list->DeleteItem(0);
 274     list->DeleteItem(0);
 275     list->DeleteAllItems();
 276
 277     //Add some new items to tests ClearAll with
 278     list->InsertColumn(0, "Column 0");
 279     list->InsertItem(0, "Item 0");
 280     list->InsertItem(1, "Item 1");
 281
 282     //Check that ClearAll actually sends a DELETE_ALL_ITEMS event
 283     list->ClearAll();
 284
 285     //ClearAll and DeleteAllItems shouldn't send an event if there was nothing
 286     //to clear
 287     list->ClearAll();
 288     list->DeleteAllItems();
 289
 290     CPPUNIT_ASSERT_EQUAL(2, deleteitem.GetCount());
 291     CPPUNIT_ASSERT_EQUAL(2, deleteall.GetCount());
 292 #endif
 293 }
 294
 295 void ListBaseTestCase::InsertItem()
 296 {
 297     wxListCtrl* const list = GetList();
 298
 299     EventCounter insert(list, wxEVT_COMMAND_LIST_INSERT_ITEM);
 300
 301     list->InsertColumn(0, "Column 0", wxLIST_FORMAT_LEFT, 60);
 302
 303     wxListItem item;
 304     item.SetId(0);
 305     item.SetText("some text");
 306
 307     list->InsertItem(item);
 308     list->InsertItem(1, "more text");
 309
 310     CPPUNIT_ASSERT_EQUAL(2, insert.GetCount());
 311 }
 312
 313 void ListBaseTestCase::Find()
 314 {
 315     wxListCtrl* const list = GetList();
 316
 317     // set up for the test
 318     list->InsertColumn(0, "Column 0");
 319     list->InsertColumn(1, "Column 1");
 320
 321     list->InsertItem(0, "Item 0");
 322     list->SetItem(0, 1, "first column");
 323
 324     list->InsertItem(1, "Item 1");
 325     list->SetItem(1, 1, "first column");
 326
 327     list->InsertItem(2, "Item 40");
 328     list->SetItem(2, 1, "first column");
 329
 330     list->InsertItem(3, "ITEM 01");
 331     list->SetItem(3, 1, "first column");
 332
 333     CPPUNIT_ASSERT_EQUAL(1, list->FindItem(-1, "Item 1"));
 334     CPPUNIT_ASSERT_EQUAL(2, list->FindItem(-1, "Item 4", true));
 335     CPPUNIT_ASSERT_EQUAL(2, list->FindItem(1, "Item 40"));
 336     CPPUNIT_ASSERT_EQUAL(3, list->FindItem(2, "Item 0", true));
 337 }
 338
 339 void ListBaseTestCase::Visible()
 340 {
 341     wxListCtrl* const list = GetList();
 342
 343     list->InsertColumn(0, "Column 0");
 344
 345     int count = list->GetCountPerPage();
 346
 347     for( int i = 0; i < count + 10; i++ )
 348     {
 349         list->InsertItem(i, wxString::Format("string %d", i));
 350     }
 351
 352     CPPUNIT_ASSERT_EQUAL(count + 10, list->GetItemCount());
 353     CPPUNIT_ASSERT_EQUAL(0, list->GetTopItem());
 354
 355     list->EnsureVisible(count + 9);
 356
 357     CPPUNIT_ASSERT(list->GetTopItem() != 0);
 358 }
 359
 360 void ListBaseTestCase::ItemFormatting()
 361 {
 362     wxListCtrl* const list = GetList();
 363
 364     list->InsertColumn(0, "Column 0");
 365
 366     list->InsertItem(0, "Item 0");
 367     list->InsertItem(1, "Item 1");
 368     list->InsertItem(2, "Item 2");
 369
 370     list->SetTextColour(*wxYELLOW);
 371     list->SetBackgroundColour(*wxGREEN);
 372     list->SetItemTextColour(0, *wxRED);
 373     list->SetItemBackgroundColour(1, *wxBLUE);
 374
 375     CPPUNIT_ASSERT_EQUAL(*wxGREEN, list->GetBackgroundColour());
 376     CPPUNIT_ASSERT_EQUAL(*wxBLUE,list->GetItemBackgroundColour(1));
 377
 378     CPPUNIT_ASSERT_EQUAL(*wxYELLOW, list->GetTextColour());
 379     CPPUNIT_ASSERT_EQUAL(*wxRED, list->GetItemTextColour(0));
 380 }
 381
 382 void ListBaseTestCase::EditLabel()
 383 {
 384 #if wxUSE_UIACTIONSIMULATOR
 385     wxListCtrl* const list = GetList();
 386
 387     list->SetWindowStyleFlag(wxLC_REPORT | wxLC_EDIT_LABELS);
 388
 389     list->InsertColumn(0, "Column 0");
 390
 391     list->InsertItem(0, "Item 0");
 392     list->InsertItem(1, "Item 1");
 393
 394     EventCounter beginedit(list, wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT);
 395     EventCounter endedit(list, wxEVT_COMMAND_LIST_END_LABEL_EDIT);
 396
 397     wxUIActionSimulator sim;
 398
 399     list->EditLabel(0);
 400
 401     sim.Text("sometext");
 402     sim.Char(WXK_RETURN);
 403
 404     wxYield();
 405
 406     CPPUNIT_ASSERT_EQUAL(1, beginedit.GetCount());
 407     CPPUNIT_ASSERT_EQUAL(1, endedit.GetCount());
 408 #endif
 409 }
 410
 411 void ListBaseTestCase::ImageList()
 412 {
 413     wxListCtrl* const list = GetList();
 414
 415     wxSize size(32, 32);
 416
 417     wxImageList* imglist = new wxImageList(size.x, size.y);
 418     imglist->Add(wxArtProvider::GetIcon(wxART_INFORMATION, wxART_OTHER, size));
 419     imglist->Add(wxArtProvider::GetIcon(wxART_QUESTION, wxART_OTHER, size));
 420     imglist->Add(wxArtProvider::GetIcon(wxART_WARNING, wxART_OTHER, size));
 421
 422     list->AssignImageList(imglist, wxIMAGE_LIST_NORMAL);
 423
 424     CPPUNIT_ASSERT_EQUAL(imglist, list->GetImageList(wxIMAGE_LIST_NORMAL));
 425 }
 426
 427 namespace
 428 {
 429     //From the sample but fixed so it actually inverts
 430     int wxCALLBACK
 431     MyCompareFunction(long item1, long item2, wxIntPtr WXUNUSED(sortData))
 432     {
 433         // inverse the order
 434         if (item1 < item2)
 435             return 1;
 436         if (item1 > item2)
 437             return -1;
 438
 439         return 0;
 440     }
 441
 442 }
 443
 444 void ListBaseTestCase::Sort()
 445 {
 446     wxListCtrl* const list = GetList();
 447
 448     list->InsertColumn(0, "Column 0");
 449
 450     list->InsertItem(0, "Item 0");
 451     list->SetItemData(0, 0);
 452     list->InsertItem(1, "Item 1");
 453     list->SetItemData(1, 1);
 454
 455     list->SortItems(MyCompareFunction, 0);
 456
 457     CPPUNIT_ASSERT_EQUAL("Item 1", list->GetItemText(0));
 458     CPPUNIT_ASSERT_EQUAL("Item 0", list->GetItemText(1));
 459 }
 460
 461 #endif //wxUSE_LISTCTRL