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 #if wxUSE_UIACTIONSIMULATOR && !defined(__WXGTK__)
 179     wxTestableFrame* frame = wxStaticCast(wxTheApp->GetTopWindow(),
 180                                           wxTestableFrame);
 181
 182     wxListCtrl* const list = GetList();
 183
 184     list->InsertColumn(0, "Column 0", wxLIST_FORMAT_LEFT, 60);
 185     list->InsertColumn(1, "Column 1", wxLIST_FORMAT_LEFT, 50);
 186     list->InsertColumn(2, "Column 2", wxLIST_FORMAT_LEFT, 40);
 187
 188     list->InsertItem(0, "Item 0");
 189     list->SetItem(0, 1, "first column");
 190     list->SetItem(0, 2, "second column");
 191
 192     EventCounter count(list, wxEVT_COMMAND_LIST_ITEM_SELECTED);
 193     EventCounter count1(list, wxEVT_COMMAND_LIST_ITEM_FOCUSED);
 194     EventCounter count2(list, wxEVT_COMMAND_LIST_ITEM_ACTIVATED);
 195     EventCounter count3(list, wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK);
 196
 197     wxUIActionSimulator sim;
 198
 199     wxRect pos;
 200     list->GetItemRect(0, pos);
 201
 202     //We move in slightly so we are not on the edge
 203     wxPoint point = list->ClientToScreen(pos.GetPosition()) + wxPoint(2, 2);
 204
 205     sim.MouseMove(point);
 206     wxYield();
 207
 208     sim.MouseClick();
 209     wxYield();
 210
 211     sim.MouseDblClick();
 212     wxYield();
 213
 214     sim.MouseClick(wxMOUSE_BTN_RIGHT);
 215     wxYield();
 216
 217     // when the first item was selected the focus changes to it, but not
 218     // on subsequent clicks
 219
 220     // FIXME: This test fails on MSW buildbot slaves although works fine on
 221     //        development machine, no idea why.
 222 #ifndef __WXMSW__
 223     CPPUNIT_ASSERT_EQUAL(1, frame->GetEventCount(wxEVT_COMMAND_LIST_ITEM_FOCUSED));
 224 #endif
 225
 226     CPPUNIT_ASSERT_EQUAL(1, frame->GetEventCount(wxEVT_COMMAND_LIST_ITEM_SELECTED));
 227     CPPUNIT_ASSERT_EQUAL(1, frame->GetEventCount(wxEVT_COMMAND_LIST_ITEM_ACTIVATED));
 228     CPPUNIT_ASSERT_EQUAL(1, frame->GetEventCount(wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK));
 229
 230     //tidy up when we are finished
 231     list->ClearAll();
 232 #endif // wxUSE_UIACTIONSIMULATOR
 233 }
 234
 235 void ListBaseTestCase::KeyDown()
 236 {
 237 #if wxUSE_UIACTIONSIMULATOR
 238     wxTestableFrame* frame = wxStaticCast(wxTheApp->GetTopWindow(),
 239                                           wxTestableFrame);
 240
 241     wxListCtrl* const list = GetList();
 242
 243     EventCounter count(list, wxEVT_COMMAND_LIST_KEY_DOWN);
 244
 245     wxUIActionSimulator sim;
 246
 247     list->SetFocus();
 248     sim.Text("aAbB");
 249     wxYield();
 250
 251     CPPUNIT_ASSERT_EQUAL(6, frame->GetEventCount());
 252 #endif
 253 }
 254
 255 void ListBaseTestCase::DeleteItems()
 256 {
 257 #ifndef __WXOSX__
 258     wxTestableFrame* frame = wxStaticCast(wxTheApp->GetTopWindow(),
 259                                           wxTestableFrame);
 260
 261     wxListCtrl* const list = GetList();
 262
 263     EventCounter count(list, wxEVT_COMMAND_LIST_DELETE_ITEM);
 264     EventCounter count1(list, wxEVT_COMMAND_LIST_DELETE_ALL_ITEMS);
 265
 266
 267     list->InsertColumn(0, "Column 0", wxLIST_FORMAT_LEFT, 60);
 268     list->InsertColumn(1, "Column 1", wxLIST_FORMAT_LEFT, 50);
 269     list->InsertColumn(2, "Column 2", wxLIST_FORMAT_LEFT, 40);
 270
 271     list->InsertItem(0, "Item 0");
 272     list->InsertItem(1, "Item 1");
 273     list->InsertItem(2, "Item 1");
 274
 275     list->DeleteItem(0);
 276     list->DeleteItem(0);
 277     list->DeleteAllItems();
 278
 279     //Add some new items to tests ClearAll with
 280     list->InsertColumn(0, "Column 0");
 281     list->InsertItem(0, "Item 0");
 282     list->InsertItem(1, "Item 1");
 283
 284     //Check that ClearAll actually sends a DELETE_ALL_ITEMS event
 285     list->ClearAll();
 286
 287     //ClearAll and DeleteAllItems shouldn't send an event if there was nothing
 288     //to clear
 289     list->ClearAll();
 290     list->DeleteAllItems();
 291
 292     CPPUNIT_ASSERT_EQUAL(2, frame->GetEventCount(wxEVT_COMMAND_LIST_DELETE_ITEM));
 293     CPPUNIT_ASSERT_EQUAL(2, frame->GetEventCount(wxEVT_COMMAND_LIST_DELETE_ALL_ITEMS));
 294 #endif
 295 }
 296
 297 void ListBaseTestCase::InsertItem()
 298 {
 299    wxTestableFrame* frame = wxStaticCast(wxTheApp->GetTopWindow(),
 300                                           wxTestableFrame);
 301
 302     wxListCtrl* const list = GetList();
 303
 304     EventCounter count(list, wxEVT_COMMAND_LIST_INSERT_ITEM);
 305
 306     list->InsertColumn(0, "Column 0", wxLIST_FORMAT_LEFT, 60);
 307
 308     wxListItem item;
 309     item.SetId(0);
 310     item.SetText("some text");
 311
 312     list->InsertItem(item);
 313     list->InsertItem(1, "more text");
 314
 315     CPPUNIT_ASSERT_EQUAL(2, frame->GetEventCount(wxEVT_COMMAND_LIST_INSERT_ITEM));
 316 }
 317
 318 void ListBaseTestCase::Find()
 319 {
 320     wxListCtrl* const list = GetList();
 321
 322     // set up for the test
 323     list->InsertColumn(0, "Column 0");
 324     list->InsertColumn(1, "Column 1");
 325
 326     list->InsertItem(0, "Item 0");
 327     list->SetItem(0, 1, "first column");
 328
 329     list->InsertItem(1, "Item 1");
 330     list->SetItem(1, 1, "first column");
 331
 332     list->InsertItem(2, "Item 40");
 333     list->SetItem(2, 1, "first column");
 334
 335     list->InsertItem(3, "ITEM 01");
 336     list->SetItem(3, 1, "first column");
 337
 338     CPPUNIT_ASSERT_EQUAL(1, list->FindItem(-1, "Item 1"));
 339     CPPUNIT_ASSERT_EQUAL(2, list->FindItem(-1, "Item 4", true));
 340     CPPUNIT_ASSERT_EQUAL(2, list->FindItem(1, "Item 40"));
 341     CPPUNIT_ASSERT_EQUAL(3, list->FindItem(2, "Item 0", true));
 342 }
 343
 344 void ListBaseTestCase::Visible()
 345 {
 346     wxListCtrl* const list = GetList();
 347
 348     list->InsertColumn(0, "Column 0");
 349
 350     int count = list->GetCountPerPage();
 351
 352     for( int i = 0; i < count + 10; i++ )
 353     {
 354         list->InsertItem(i, wxString::Format("string %d", i));
 355     }
 356
 357     CPPUNIT_ASSERT_EQUAL(count + 10, list->GetItemCount());
 358     CPPUNIT_ASSERT_EQUAL(0, list->GetTopItem());
 359
 360     list->EnsureVisible(count + 9);
 361
 362     CPPUNIT_ASSERT(list->GetTopItem() != 0);
 363 }
 364
 365 void ListBaseTestCase::ItemFormatting()
 366 {
 367     wxListCtrl* const list = GetList();
 368
 369     list->InsertColumn(0, "Column 0");
 370
 371     list->InsertItem(0, "Item 0");
 372     list->InsertItem(1, "Item 1");
 373     list->InsertItem(2, "Item 2");
 374
 375     list->SetTextColour(*wxYELLOW);
 376     list->SetBackgroundColour(*wxGREEN);
 377     list->SetItemTextColour(0, *wxRED);
 378     list->SetItemBackgroundColour(1, *wxBLUE);
 379
 380     CPPUNIT_ASSERT_EQUAL(*wxGREEN, list->GetBackgroundColour());
 381     CPPUNIT_ASSERT_EQUAL(*wxBLUE,list->GetItemBackgroundColour(1));
 382
 383     CPPUNIT_ASSERT_EQUAL(*wxYELLOW, list->GetTextColour());
 384     CPPUNIT_ASSERT_EQUAL(*wxRED, list->GetItemTextColour(0));
 385 }
 386
 387 void ListBaseTestCase::EditLabel()
 388 {
 389 #if wxUSE_UIACTIONSIMULATOR
 390     wxListCtrl* const list = GetList();
 391
 392     list->SetWindowStyleFlag(wxLC_REPORT | wxLC_EDIT_LABELS);
 393
 394     list->InsertColumn(0, "Column 0");
 395
 396     list->InsertItem(0, "Item 0");
 397     list->InsertItem(1, "Item 1");
 398
 399     wxTestableFrame* frame = wxStaticCast(wxTheApp->GetTopWindow(),
 400                                           wxTestableFrame);
 401
 402     EventCounter count(list, wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT);
 403     EventCounter count1(list, wxEVT_COMMAND_LIST_END_LABEL_EDIT);
 404
 405     wxUIActionSimulator sim;
 406
 407     list->EditLabel(0);
 408
 409     sim.Text("sometext");
 410     sim.Char(WXK_RETURN);
 411
 412     wxYield();
 413
 414     CPPUNIT_ASSERT_EQUAL(1, frame->GetEventCount(wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT));
 415     CPPUNIT_ASSERT_EQUAL(1, frame->GetEventCount(wxEVT_COMMAND_LIST_END_LABEL_EDIT));
 416 #endif
 417 }
 418
 419 void ListBaseTestCase::ImageList()
 420 {
 421     wxListCtrl* const list = GetList();
 422
 423     wxSize size(32, 32);
 424
 425     wxImageList* imglist = new wxImageList(size.x, size.y);
 426     imglist->Add(wxArtProvider::GetIcon(wxART_INFORMATION, wxART_OTHER, size));
 427     imglist->Add(wxArtProvider::GetIcon(wxART_QUESTION, wxART_OTHER, size));
 428     imglist->Add(wxArtProvider::GetIcon(wxART_WARNING, wxART_OTHER, size));
 429
 430     list->AssignImageList(imglist, wxIMAGE_LIST_NORMAL);
 431
 432     CPPUNIT_ASSERT_EQUAL(imglist, list->GetImageList(wxIMAGE_LIST_NORMAL));
 433 }
 434
 435 namespace
 436 {
 437     //From the sample but fixed so it actually inverts
 438     int wxCALLBACK
 439     MyCompareFunction(long item1, long item2, wxIntPtr WXUNUSED(sortData))
 440     {
 441         // inverse the order
 442         if (item1 < item2)
 443             return 1;
 444         if (item1 > item2)
 445             return -1;
 446
 447         return 0;
 448     }
 449
 450 }
 451
 452 void ListBaseTestCase::Sort()
 453 {
 454     wxListCtrl* const list = GetList();
 455
 456     list->InsertColumn(0, "Column 0");
 457
 458     list->InsertItem(0, "Item 0");
 459     list->SetItemData(0, 0);
 460     list->InsertItem(1, "Item 1");
 461     list->SetItemData(1, 1);
 462
 463     list->SortItems(MyCompareFunction, 0);
 464
 465     CPPUNIT_ASSERT_EQUAL("Item 1", list->GetItemText(0));
 466     CPPUNIT_ASSERT_EQUAL("Item 0", list->GetItemText(1));
 467 }
 468
 469 #endif //wxUSE_LISTCTRL