-
Notifications
You must be signed in to change notification settings - Fork 17
/
MultiColumnList.cpp
2789 lines (2274 loc) · 83.3 KB
/
MultiColumnList.cpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/***********************************************************************
created: 13/4/2004
author: Paul D Turner
purpose: Implementation of MultiColumnList widget base class
*************************************************************************/
/***************************************************************************
* Copyright (C) 2004 - 2006 Paul D Turner & The CEGUI Development Team
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
* IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
* OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
* ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
* OTHER DEALINGS IN THE SOFTWARE.
***************************************************************************/
#include "CEGUI/widgets/MultiColumnList.h"
#include "CEGUI/Exceptions.h"
#include "CEGUI/widgets/Scrollbar.h"
#include "CEGUI/widgets/ListHeader.h"
#include "CEGUI/widgets/ListboxItem.h"
#include "CEGUI/Logger.h"
#include "CEGUI/TextUtils.h"
#include "CEGUI/PropertyHelper.h"
#include "CEGUI/CoordConverter.h"
#include "CEGUI/WindowManager.h"
#include <algorithm>
// Start of CEGUI namespace section
namespace CEGUI
{
const String MultiColumnList::EventNamespace("MultiColumnList");
const String MultiColumnList::WidgetTypeName("CEGUI/MultiColumnList");
/*************************************************************************
MultiColumnListWindowRenderer
*************************************************************************/
MultiColumnListWindowRenderer::MultiColumnListWindowRenderer(const String& name) :
WindowRenderer(name, MultiColumnList::EventNamespace)
{
}
/*************************************************************************
Constants
*************************************************************************/
// Event names
const String MultiColumnList::EventSelectionModeChanged( "SelectionModeChanged" );
const String MultiColumnList::EventNominatedSelectColumnChanged( "NominatedSelectColumnChanged" );
const String MultiColumnList::EventNominatedSelectRowChanged( "NominatedSelectRowChanged" );
const String MultiColumnList::EventVertScrollbarModeChanged( "VertScrollbarModeChanged" );
const String MultiColumnList::EventHorzScrollbarModeChanged( "HorzScrollbarModeChanged" );
const String MultiColumnList::EventSelectionChanged( "SelectionChanged" );
const String MultiColumnList::EventListContentsChanged( "ListContentsChanged" );
const String MultiColumnList::EventSortColumnChanged( "SortColumnChanged" );
const String MultiColumnList::EventSortDirectionChanged( "SortDirectionChanged" );
const String MultiColumnList::EventListColumnSized( "ListColumnSized" );
const String MultiColumnList::EventListColumnMoved( "ListColumnMoved" );
/*************************************************************************
Child Widget name suffix constants
*************************************************************************/
const String MultiColumnList::VertScrollbarName( "__auto_vscrollbar__" );
const String MultiColumnList::HorzScrollbarName( "__auto_hscrollbar__" );
const String MultiColumnList::ListHeaderName( "__auto_listheader__" );
/*************************************************************************
Constructor for the Multi-column list base class
*************************************************************************/
MultiColumnList::MultiColumnList(const String& type, const String& name) :
Window(type, name),
d_forceVertScroll(false),
d_forceHorzScroll(false),
d_nominatedSelectCol(0),
d_nominatedSelectRow(0),
d_lastSelected(0),
d_columnCount(0),
d_autoSizeColumnUsesHeader(false)
{
// add properties
addMultiColumnListProperties();
// set default selection mode
d_selectMode = CellSingle; // hack to ensure call below does what it should.
setSelectionMode(RowSingle);
}
/*************************************************************************
Destructor for the multi-column list base class.
*************************************************************************/
MultiColumnList::~MultiColumnList(void)
{
// delete any items we are supposed to
resetList_impl();
}
/*************************************************************************
Return whether user manipulation of the sort column and direction
is enabled.
*************************************************************************/
bool MultiColumnList::isUserSortControlEnabled(void) const
{
return getListHeader()->isSortingEnabled();
}
/*************************************************************************
Return whether the user may size column segments.
*************************************************************************/
bool MultiColumnList::isUserColumnSizingEnabled(void) const
{
return getListHeader()->isColumnSizingEnabled();
}
/*************************************************************************
Return whether the user may modify the order of the columns.
*************************************************************************/
bool MultiColumnList::isUserColumnDraggingEnabled(void) const
{
return getListHeader()->isColumnDraggingEnabled();
}
/*************************************************************************
Return the number of columns in the multi-column list
*************************************************************************/
uint MultiColumnList::getColumnCount(void) const
{
return d_columnCount;
}
/*************************************************************************
Return the number of rows in the multi-column list.
*************************************************************************/
uint MultiColumnList::getRowCount(void) const
{
return (uint)d_grid.size();
}
/*************************************************************************
Return the zero based index of the current sort column. There must
be at least one column to successfully call this method.
*************************************************************************/
uint MultiColumnList::getSortColumn(void) const
{
return getListHeader()->getSortColumn();
}
uint MultiColumnList::getSortColumnID(void) const
{
if (getColumnCount() > 0)
{
return getColumnID(getSortColumn());
}
return 0;
}
/*************************************************************************
Return the zero based column index of the column with the specified ID.
*************************************************************************/
uint MultiColumnList::getColumnWithID(uint col_id) const
{
return getListHeader()->getColumnFromID(col_id);
}
/*************************************************************************
Return the zero based index of the column whos header text matches
the specified text.
*************************************************************************/
uint MultiColumnList::getColumnWithHeaderText(const String& text) const
{
return getListHeader()->getColumnWithText(text);
}
/*************************************************************************
Return the total width of all column headers.
*************************************************************************/
UDim MultiColumnList::getTotalColumnHeadersWidth(void) const
{
const ListHeader* header = getListHeader();
UDim width(0,0);
for (uint i = 0; i < getColumnCount(); ++i)
width += header->getColumnWidth(i);
return width;
}
/*************************************************************************
Return the width of the specified column header.
*************************************************************************/
UDim MultiColumnList::getColumnHeaderWidth(uint col_idx) const
{
return getListHeader()->getColumnWidth(col_idx);
}
/*************************************************************************
Return the currently set sort direction.
*************************************************************************/
ListHeaderSegment::SortDirection MultiColumnList::getSortDirection(void) const
{
return getListHeader()->getSortDirection();
}
/*************************************************************************
Return the ListHeaderSegment object for the specified column
*************************************************************************/
ListHeaderSegment& MultiColumnList::getHeaderSegmentForColumn(uint col_idx) const
{
return getListHeader()->getSegmentFromColumn(col_idx);
}
/*************************************************************************
return index of row containing the given ListboxItem
*************************************************************************/
uint MultiColumnList::getItemRowIndex(const ListboxItem* item) const
{
for (uint i = 0; i < getRowCount(); ++i)
{
if (isListboxItemInRow(item, i))
{
return i;
}
}
// item is not attached to the list box, throw...
CEGUI_THROW(InvalidRequestException(
"the given ListboxItem is not attached to this MultiColumnList."));
}
/*************************************************************************
return the index of the column containing the given ListboxItem
*************************************************************************/
uint MultiColumnList::getItemColumnIndex(const ListboxItem* item) const
{
for (uint i = 0; i < getColumnCount(); ++i)
{
if (isListboxItemInColumn(item, i))
{
return i;
}
}
// item is not attached to the list box, throw...
CEGUI_THROW(InvalidRequestException(
"the given ListboxItem is not attached to this MultiColumnList."));
}
/*************************************************************************
return an MCLGridRef for the given ListboxItem.
*************************************************************************/
MCLGridRef MultiColumnList::getItemGridReference(const ListboxItem* item) const
{
return MCLGridRef(getItemRowIndex(item), getItemColumnIndex(item));
}
/*************************************************************************
return a ListboxItem pointer for the given reference.
May be NULL if position is blank. Throws on out of range.
*************************************************************************/
ListboxItem* MultiColumnList::getItemAtGridReference(const MCLGridRef& grid_ref) const
{
// check for invalid grid ref
if (grid_ref.column >= getColumnCount())
{
CEGUI_THROW(InvalidRequestException(
"the column given in the grid reference is out of range."));
}
else if (grid_ref.row >= getRowCount())
{
CEGUI_THROW(InvalidRequestException(
"the row given in the grid reference is out of range."));
}
else
{
return d_grid[grid_ref.row][grid_ref.column];
}
}
/*************************************************************************
return true if the given item is in the given column.
*************************************************************************/
bool MultiColumnList::isListboxItemInColumn(const ListboxItem* item, uint col_idx) const
{
// check for invalid index
if (col_idx >= getColumnCount())
{
CEGUI_THROW(InvalidRequestException(
"the column index given is out of range."));
}
else
{
for (uint i = 0; i < getRowCount(); ++i)
{
if (d_grid[i][col_idx] == item)
{
return true;
}
}
// Item was not in the column.
return false;
}
}
/*************************************************************************
return true if the given item is in the given row.
*************************************************************************/
bool MultiColumnList::isListboxItemInRow(const ListboxItem* item, uint row_idx) const
{
// check for invalid index
if (row_idx >= getRowCount())
{
CEGUI_THROW(InvalidRequestException(
"the row index given is out of range."));
}
else
{
for (uint i = 0; i < getColumnCount(); ++i)
{
if (d_grid[row_idx][i] == item)
{
return true;
}
}
// Item was not in the row.
return false;
}
}
/*************************************************************************
return true if the given item is somewhere in the list box.
*************************************************************************/
bool MultiColumnList::isListboxItemInList(const ListboxItem* item) const
{
for (uint i = 0; i < getRowCount(); ++i)
{
for (uint j = 0; j < getColumnCount(); ++j)
{
if (d_grid[i][j] == item)
{
return true;
}
}
}
return false;
}
/*************************************************************************
Search the items in column 'col_idx' and return the first item after
'start_item' that matches the specified text. If 'start_item' is NULL
searching start at (and includes) the first item in the column.
*************************************************************************/
ListboxItem* MultiColumnList::findColumnItemWithText(const String& text, uint col_idx, const ListboxItem* start_item) const
{
// ensure column is valid
if (col_idx >= getColumnCount())
{
CEGUI_THROW(InvalidRequestException(
"specified column index is out of range."));
}
// find start position for search
uint i = (!start_item) ? 0 : getItemRowIndex(start_item) + 1;
for ( ; i < getRowCount(); ++i)
{
// does this item match?
if (d_grid[i][col_idx]->getText() == text)
{
return d_grid[i][col_idx];
}
}
// no matching item.
return 0;
}
/*************************************************************************
Search the items in row 'row_idx' and return the first item after
'start_item' that matches the specified text. If 'start_item' is NULL
searching start at (and includes) the first item in the row.
*************************************************************************/
ListboxItem* MultiColumnList::findRowItemWithText(const String& text, uint row_idx, const ListboxItem* start_item) const
{
// ensure row is valid
if (row_idx >= getRowCount())
{
CEGUI_THROW(InvalidRequestException(
"specified row index is out of range."));
}
// find start position for search
uint i = (!start_item) ? 0 : getItemColumnIndex(start_item) + 1;
for ( ; i < getColumnCount(); ++i)
{
// does this item match?
if (d_grid[row_idx][i]->getText() == text)
{
return d_grid[row_idx][i];
}
}
// no matching item.
return 0;
}
/*************************************************************************
Search the list and return the first item after 'start_item' that
matches the specified text. If 'start_item' is NULL searching starts
at (and includes) the first item in the list.
Searching proceeds across the columns and down the rows.
*************************************************************************/
ListboxItem* MultiColumnList::findListItemWithText(const String& text, const ListboxItem* start_item) const
{
MCLGridRef startRef(0, 0);
// get position of start_item if it's not NULL
if (start_item)
{
startRef = getItemGridReference(start_item);
++startRef.column;
}
// perform the search
for (uint i = startRef.row; i < getRowCount(); ++i)
{
for (uint j = startRef.column; j < getColumnCount(); ++j)
{
// does this item match?
if (d_grid[i][j]->getText() == text)
{
return d_grid[i][j];
}
}
}
// No match
return 0;
}
/*************************************************************************
Scan the list (across columns for each row) and return the first
selected item.
*************************************************************************/
ListboxItem* MultiColumnList::getFirstSelectedItem(void) const
{
return getNextSelected(0);
}
/*************************************************************************
Search the list and return the first item after 'start_item' that
is selected. If 'start_item' is NULL searching starts at (and
includes) the first item in the list.
Searching proceeds across the columns and down the rows.
*************************************************************************/
ListboxItem* MultiColumnList::getNextSelected(const ListboxItem* start_item) const
{
MCLGridRef startRef(0, 0);
// get position of start_item if it's not NULL
if (start_item)
{
startRef = getItemGridReference(start_item);
if (++startRef.column == getColumnCount())
{
startRef.column = 0;
++startRef.row;
}
}
// perform the search
for (uint i = startRef.row; i < getRowCount(); ++i)
{
for (uint j = startRef.column; j < getColumnCount(); ++j)
{
// does this item match?
ListboxItem* item = d_grid[i][j];
if ((item != 0) && item->isSelected())
{
return d_grid[i][j];
}
}
}
// No match
return 0;
}
/*************************************************************************
Return the total number of selected items
*************************************************************************/
uint MultiColumnList::getSelectedCount(void) const
{
uint count = 0;
for (uint i = 0; i < getRowCount(); ++i)
{
for (uint j = 0; j < getColumnCount(); ++j)
{
ListboxItem* item = d_grid[i][j];
if ((item != 0) && item->isSelected())
{
++count;
}
}
}
return count;
}
/*************************************************************************
Return whether the item at the given grid position is selected.
*************************************************************************/
bool MultiColumnList::isItemSelected(const MCLGridRef& grid_ref) const
{
ListboxItem* item = getItemAtGridReference(grid_ref);
if (item)
{
return item->isSelected();
}
// if no item exists here, then it can't be selected.
return false;
}
/*************************************************************************
Return the ID of the nominated selection column
*************************************************************************/
uint MultiColumnList::getNominatedSelectionColumnID(void) const
{
if (getColumnCount() > 0)
{
return getListHeader()->getSegmentFromColumn(d_nominatedSelectCol).getID();
}
return 0;
}
/*************************************************************************
Return the nominated selection column
*************************************************************************/
uint MultiColumnList::getNominatedSelectionColumn(void) const
{
return d_nominatedSelectCol;
}
/*************************************************************************
Return the nominated selection row.
*************************************************************************/
uint MultiColumnList::getNominatedSelectionRow(void) const
{
return d_nominatedSelectRow;
}
/*************************************************************************
Return the active selection mode.
*************************************************************************/
MultiColumnList::SelectionMode MultiColumnList::getSelectionMode(void) const
{
return d_selectMode;
}
/*************************************************************************
Initialise the Window based object ready for use.
*************************************************************************/
void MultiColumnList::initialiseComponents(void)
{
// get the component sub-widgets
Scrollbar* vertScrollbar = getVertScrollbar();
Scrollbar* horzScrollbar = getHorzScrollbar();
ListHeader* header = getListHeader();
// subscribe some events
header->subscribeEvent(ListHeader::EventSegmentRenderOffsetChanged, Event::Subscriber(&CEGUI::MultiColumnList::handleHeaderScroll, this));
header->subscribeEvent(ListHeader::EventSegmentSequenceChanged, Event::Subscriber(&CEGUI::MultiColumnList::handleHeaderSegMove, this));
header->subscribeEvent(ListHeader::EventSegmentSized, Event::Subscriber(&CEGUI::MultiColumnList::handleColumnSizeChange, this));
header->subscribeEvent(ListHeader::EventSortColumnChanged , Event::Subscriber(&CEGUI::MultiColumnList::handleSortColumnChange, this));
header->subscribeEvent(ListHeader::EventSortDirectionChanged, Event::Subscriber(&CEGUI::MultiColumnList::handleSortDirectionChange, this));
header->subscribeEvent(ListHeader::EventSplitterDoubleClicked, Event::Subscriber(&CEGUI::MultiColumnList::handleHeaderSegDblClick, this));
horzScrollbar->subscribeEvent(Scrollbar::EventScrollPositionChanged, Event::Subscriber(&CEGUI::MultiColumnList::handleHorzScrollbar, this));
vertScrollbar->subscribeEvent(Scrollbar::EventScrollPositionChanged, Event::Subscriber(&CEGUI::MultiColumnList::handleVertScrollbar, this));
// final initialisation now widget is complete
setSortDirection(ListHeaderSegment::None);
// Perform initial layout
configureScrollbars();
performChildWindowLayout();
}
/*************************************************************************
Remove all items from the list.
*************************************************************************/
void MultiColumnList::resetList(void)
{
if (resetList_impl())
{
WindowEventArgs args(this);
onListContentsChanged(args);
}
}
/*************************************************************************
Add a column to the table.
*************************************************************************/
void MultiColumnList::addColumn(const String& text, uint col_id, const UDim& width)
{
insertColumn(text, col_id, width, getColumnCount());
}
/*************************************************************************
Add a column to the table.
*************************************************************************/
void MultiColumnList::addColumn(const String& value)
{
size_t idstart = value.rfind("id:");
size_t wstart = value.rfind("width:");
size_t capstart = value.find("text:");
// some defaults in case of missing data
String caption, id("0"), width("{0.33,0}");
// extract the caption field
if (capstart != String::npos)
{
capstart = value.find_first_of(":") + 1;
if (wstart == String::npos)
if (idstart == String::npos)
caption = value.substr(capstart);
else
caption = value.substr(capstart, idstart - capstart);
else
caption = value.substr(capstart, wstart - capstart);
// trim trailing whitespace
TextUtils::trimTrailingChars(caption, TextUtils::DefaultWhitespace);
}
// extract the width field
if (wstart != String::npos)
{
width = value.substr(wstart);
width = width.substr(width.find_first_of("{"));
width = width.substr(0, width.find_last_of("}") + 1);
}
// extract the id field.
if (idstart != String::npos)
{
id = value.substr(idstart);
id = id.substr(id.find_first_of(":") + 1);
}
// add the column accordingly
addColumn(caption, PropertyHelper<uint>::fromString(id), PropertyHelper<UDim>::fromString(width));
}
/*************************************************************************
Insert a column into the table.
*************************************************************************/
void MultiColumnList::insertColumn(const String& text, uint col_id, const UDim& width, uint position)
{
// if position is out of range, add item to end of current columns.
if (position > getColumnCount())
{
position = getColumnCount();
}
// set-up the header for the new column.
getListHeader()->insertColumn(text, col_id, width, position);
++d_columnCount;
// Set the font equal to that of our list
ListHeaderSegment& segment = getHeaderSegmentForColumn(position);
segment.setFont(d_font);
// ban properties from segment that we control from here.
segment.banPropertyFromXML("ID");
segment.banPropertyFromXML("Text");
segment.banPropertyFromXML("Font");
// Insert a blank entry at the appropriate position in each row.
for (uint i = 0; i < getRowCount(); ++i)
{
d_grid[i].d_items.insert(
d_grid[i].d_items.begin() + position,
static_cast<ListboxItem*>(0));
}
// update stored nominated selection column if that has changed.
if ((d_nominatedSelectCol >= position) && (getColumnCount() > 1))
{
d_nominatedSelectCol++;
}
// signal a change to the list contents
WindowEventArgs args(this);
onListContentsChanged(args);
}
/*************************************************************************
Remove a column from the table.
*************************************************************************/
void MultiColumnList::removeColumn(uint col_idx)
{
// ensure index is valid, and throw if not.
if (col_idx >= getColumnCount())
{
CEGUI_THROW(InvalidRequestException(
"the specified column index is out of range."));
}
else
{
// update stored column index values
if (d_nominatedSelectCol == col_idx)
{
d_nominatedSelectCol = 0;
}
// remove the column from each row
for (uint i = 0; i < getRowCount(); ++i)
{
// extract the item pointer.
ListboxItem* item = d_grid[i][col_idx];
// remove the column entry from the row
d_grid[i].d_items.erase(d_grid[i].d_items.begin() + col_idx);
// delete the ListboxItem as needed.
if ((item != 0) && item->isAutoDeleted())
{
delete item;
}
}
// remove header segment
getListHeader()->removeColumn(col_idx);
--d_columnCount;
// signal a change to the list contents
WindowEventArgs args(this);
onListContentsChanged(args);
}
}
/*************************************************************************
Remove a column from the table (via ID)
*************************************************************************/
void MultiColumnList::removeColumnWithID(uint col_id)
{
removeColumn(getColumnWithID(col_id));
}
/*************************************************************************
Move a column within the table
*************************************************************************/
void MultiColumnList::moveColumn(uint col_idx, uint position)
{
// move the segment on the header, events will ensure the items get moved also.
getListHeader()->moveColumn(col_idx, position);
}
/*************************************************************************
Move a column (with specified ID) within the table.
*************************************************************************/
void MultiColumnList::moveColumnWithID(uint col_id, uint position)
{
moveColumn(getColumnWithID(col_id), position);
}
/*************************************************************************
Add a row to the bottom of the table
*************************************************************************/
uint MultiColumnList::addRow(uint row_id)
{
return addRow(0, 0, row_id);
}
/*************************************************************************
Add a row to the bottom of the table
*************************************************************************/
uint MultiColumnList::addRow(ListboxItem* item, uint col_id, uint row_id)
{
uint col_idx = 0;
// Build the new row
ListRow row;
row.d_sortColumn = getSortColumn();
row.d_items.resize(getColumnCount(), 0);
row.d_rowID = row_id;
if (item)
{
// discover which column to initially set
col_idx = getColumnWithID(col_id);
// establish item ownership & enter item into column
item->setOwnerWindow(this);
row[col_idx] = item;
}
uint pos;
// if sorting is enabled, insert at an appropriate position
const ListHeaderSegment::SortDirection dir = getSortDirection();
if (dir != ListHeaderSegment::None)
{
// calculate where the row should be inserted
ListItemGrid::iterator ins_pos = dir == ListHeaderSegment::Descending ?
std::upper_bound(d_grid.begin(), d_grid.end(), row, pred_descend) :
std::upper_bound(d_grid.begin(), d_grid.end(), row);
// insert item and get final inserted position.
ListItemGrid::iterator final_pos = d_grid.insert(ins_pos, row);
// get final inserted position as an uint.
pos = (uint)std::distance(d_grid.begin(), final_pos);
}
// not sorted, just stick it on the end.
else
{
pos = getRowCount();
d_grid.push_back(row);
}
// signal a change to the list contents
WindowEventArgs args(this);
onListContentsChanged(args);
return pos;
}
/*************************************************************************
Insert a row into the table
*************************************************************************/
uint MultiColumnList::insertRow(uint row_idx, uint row_id)
{
return insertRow(0, 0, row_idx, row_id);
}
/*************************************************************************
Insert a row into the table
*************************************************************************/
uint MultiColumnList::insertRow(ListboxItem* item, uint col_id, uint row_idx, uint row_id)
{
// if sorting is enabled, use add instead of insert
if (getSortDirection() != ListHeaderSegment::None)
{
return addRow(item, col_id, row_id);
}
else
{
// Build the new row (empty)
ListRow row;
row.d_sortColumn = getSortColumn();
row.d_items.resize(getColumnCount(), 0);
row.d_rowID = row_id;
// if row index is too big, just insert at end.
if (row_idx > getRowCount())
{
row_idx = getRowCount();
}
d_grid.insert(d_grid.begin() + row_idx, row);
// set the initial item in the new row
setItem(item, col_id, row_idx);
// signal a change to the list contents
WindowEventArgs args(this);
onListContentsChanged(args);
return row_idx;
}
}
/*************************************************************************
Remove a row from the list.
*************************************************************************/
void MultiColumnList::removeRow(uint row_idx)
{
// ensure row exists
if (row_idx >= getRowCount())
{
CEGUI_THROW(InvalidRequestException(
"The specified row index is out of range."));
}
else
{
// delete items we are supposed to
for (uint i = 0; i < getColumnCount(); ++i)
{
ListboxItem* item = d_grid[row_idx][i];
if ((item != 0) && item->isAutoDeleted())
{
delete item;
}
}
// erase the row from the grid.
d_grid.erase(d_grid.begin() + row_idx);
// if we have erased the selection row, reset that to 0
if (d_nominatedSelectRow == row_idx)
{
d_nominatedSelectRow = 0;
}
// signal a change to the list contents
WindowEventArgs args(this);
onListContentsChanged(args);
}
}
/*************************************************************************
Replace the item at grid-ref 'position' with 'item'.