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