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 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Crazy Eddies GUI System: CEGUI::ItemListBase Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.4 -->
<script type="text/javascript">
function hasClass(ele,cls) {
return ele.className.match(new RegExp('(\\s|^)'+cls+'(\\s|$)'));
}
function addClass(ele,cls) {
if (!this.hasClass(ele,cls)) ele.className += " "+cls;
}
function removeClass(ele,cls) {
if (hasClass(ele,cls)) {
var reg = new RegExp('(\\s|^)'+cls+'(\\s|$)');
ele.className=ele.className.replace(reg,' ');
}
}
function toggleVisibility(linkObj) {
var base = linkObj.getAttribute('id');
var summary = document.getElementById(base + '-summary');
var content = document.getElementById(base + '-content');
var trigger = document.getElementById(base + '-trigger');
if ( hasClass(linkObj,'closed') ) {
summary.style.display = 'none';
content.style.display = 'block';
trigger.src = 'open.png';
removeClass(linkObj,'closed');
addClass(linkObj,'opened');
} else if ( hasClass(linkObj,'opened') ) {
summary.style.display = 'block';
content.style.display = 'none';
trigger.src = 'closed.png';
removeClass(linkObj,'opened');
addClass(linkObj,'closed');
}
return false;
}
</script>
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Crazy Eddies GUI System <span id="projectnumber">0.7.6</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceCEGUI.html">CEGUI</a> </li>
<li class="navelem"><a class="el" href="classCEGUI_1_1ItemListBase.html">ItemListBase</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-attribs">Static Public Attributes</a> |
<a href="#pro-types">Protected Types</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> </div>
<div class="headertitle">
<div class="title">CEGUI::ItemListBase Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="CEGUI::ItemListBase" --><!-- doxytag: inherits="CEGUI::Window" -->
<p>Base class for item list widgets.
<a href="classCEGUI_1_1ItemListBase.html#details">More...</a></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png"/> Inheritance diagram for CEGUI::ItemListBase:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classCEGUI_1_1ItemListBase__inherit__graph.gif" border="0" usemap="#CEGUI_1_1ItemListBase_inherit__map" alt="Inheritance graph"/></div>
<map name="CEGUI_1_1ItemListBase_inherit__map" id="CEGUI_1_1ItemListBase_inherit__map">
<area shape="rect" id="node5" href="classCEGUI_1_1MenuBase.html" title="Abstract base class for menus." alt="" coords="13,160,147,189"/><area shape="rect" id="node2" href="classCEGUI_1_1Window.html" title="An abstract base class providing common functionality and specifying the required interface for deriv..." alt="" coords="20,5,140,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div id="dynsection-1" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-1-trigger" src="closed.png"/> Collaboration diagram for CEGUI::ItemListBase:</div>
<div id="dynsection-1-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-1-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classCEGUI_1_1ItemListBase__coll__graph.gif" border="0" usemap="#CEGUI_1_1ItemListBase_coll__map" alt="Collaboration graph"/></div>
<map name="CEGUI_1_1ItemListBase_coll__map" id="CEGUI_1_1ItemListBase_coll__map">
<area shape="rect" id="node7" href="classCEGUI_1_1ItemEntry.html" title="Base class for item type widgets." alt="" coords="21,219,152,249"/><area shape="rect" id="node2" href="classCEGUI_1_1Window.html" title="An abstract base class providing common functionality and specifying the required interface for deriv..." alt="" coords="5,17,125,46"/><area shape="rect" id="node5" href="classCEGUI_1_1ItemListBaseProperties_1_1SortMode.html" title="Property to access the sorting mode." alt="" coords="279,17,551,46"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classCEGUI_1_1ItemListBase-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemListBase.html#a6a3084e3d292a36b773915d2f3781e03">SortMode</a> { <b>Ascending</b>,
<b>Descending</b>,
<b>UserSort</b>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sort modes for <a class="el" href="classCEGUI_1_1ItemListBase.html" title="Base class for item list widgets.">ItemListBase</a>. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a563c54418daca22ac66d232d777535a1"></a><!-- doxytag: member="CEGUI::ItemListBase::SortCallback" ref="a563c54418daca22ac66d232d777535a1" args=")(const ItemEntry *a, const ItemEntry *b)" -->
typedef bool(* </td><td class="memItemRight" valign="bottom"><b>SortCallback</b> )(const <a class="el" href="classCEGUI_1_1ItemEntry.html">ItemEntry</a> *a, const <a class="el" href="classCEGUI_1_1ItemEntry.html">ItemEntry</a> *b)</td></tr>
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemListBase.html#a0bbcb2311f08a37a7eda909b050f4384">getItemCount</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return number of items attached to the list. <a href="#a0bbcb2311f08a37a7eda909b050f4384"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCEGUI_1_1ItemEntry.html">ItemEntry</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemListBase.html#af4115ac7fb39d3b1a0ca65628f73c6a4">getItemFromIndex</a> (size_t index) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the item at index position <em>index</em>. <a href="#af4115ac7fb39d3b1a0ca65628f73c6a4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemListBase.html#aad07854c7f4563620b29ce12ee1ff3d3">getItemIndex</a> (const <a class="el" href="classCEGUI_1_1ItemEntry.html">ItemEntry</a> *item) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the index of <a class="el" href="classCEGUI_1_1ItemEntry.html" title="Base class for item type widgets.">ItemEntry</a> <em>item</em>. <a href="#aad07854c7f4563620b29ce12ee1ff3d3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCEGUI_1_1ItemEntry.html">ItemEntry</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemListBase.html#a3f762755a797e6eb63650aaad6e3d0c2">findItemWithText</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &text, const <a class="el" href="classCEGUI_1_1ItemEntry.html">ItemEntry</a> *start_item)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Search the list for an item with the specified text. <a href="#a3f762755a797e6eb63650aaad6e3d0c2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemListBase.html#a8d61d61c849a1c3b49f2ad586186240c">isItemInList</a> (const <a class="el" href="classCEGUI_1_1ItemEntry.html">ItemEntry</a> *item) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return whether the specified <a class="el" href="classCEGUI_1_1ItemEntry.html" title="Base class for item type widgets.">ItemEntry</a> is in the List. <a href="#a8d61d61c849a1c3b49f2ad586186240c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemListBase.html#ae697a469381e934e3e7b3e056dfb19b4">isAutoResizeEnabled</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return whether this window is automatically resized to fit its content. <a href="#ae697a469381e934e3e7b3e056dfb19b4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a80ea1272b09a8ea9e2a462350be8d28d"></a><!-- doxytag: member="CEGUI::ItemListBase::isSortEnabled" ref="a80ea1272b09a8ea9e2a462350be8d28d" args="(void) const " -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemListBase.html#a80ea1272b09a8ea9e2a462350be8d28d">isSortEnabled</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns 'true' if the list is sorted. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a81ab23c5289ec5b96b70b8a9f06ca068"></a><!-- doxytag: member="CEGUI::ItemListBase::getSortMode" ref="a81ab23c5289ec5b96b70b8a9f06ca068" args="(void) const " -->
<a class="el" href="classCEGUI_1_1ItemListBase.html#a6a3084e3d292a36b773915d2f3781e03">SortMode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemListBase.html#a81ab23c5289ec5b96b70b8a9f06ca068">getSortMode</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get sort mode. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab5c0e1386a8b4287d4576e8bff23fd18"></a><!-- doxytag: member="CEGUI::ItemListBase::getSortCallback" ref="ab5c0e1386a8b4287d4576e8bff23fd18" args="(void) const " -->
SortCallback </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemListBase.html#ab5c0e1386a8b4287d4576e8bff23fd18">getSortCallback</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get user sorting callback. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemListBase.html#ab61cc9fea4017e9a5e131910810d741f">initialiseComponents</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialise the <a class="el" href="classCEGUI_1_1Window.html" title="An abstract base class providing common functionality and specifying the required interface for deriv...">Window</a> based object ready for use. <a href="#ab61cc9fea4017e9a5e131910810d741f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemListBase.html#a0497f057d9812428695aef79c9b74821">resetList</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove all items from the list. <a href="#a0497f057d9812428695aef79c9b74821"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemListBase.html#a6bd80691bfd31ee45728009ea4766fe5">addItem</a> (<a class="el" href="classCEGUI_1_1ItemEntry.html">ItemEntry</a> *item)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add the given <a class="el" href="classCEGUI_1_1ItemEntry.html" title="Base class for item type widgets.">ItemEntry</a> to the list. <a href="#a6bd80691bfd31ee45728009ea4766fe5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemListBase.html#ae832829305cd74623251ebb9c4205be8">insertItem</a> (<a class="el" href="classCEGUI_1_1ItemEntry.html">ItemEntry</a> *item, const <a class="el" href="classCEGUI_1_1ItemEntry.html">ItemEntry</a> *position)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Insert an item into the list before a specified item already in the list. <a href="#ae832829305cd74623251ebb9c4205be8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemListBase.html#aab926eef41ef5237b4d43b94c2f90493">removeItem</a> (<a class="el" href="classCEGUI_1_1ItemEntry.html">ItemEntry</a> *item)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Removes the given item from the list. If the item is has the 'DestroyedByParent' property set to 'true', the item will be deleted. <a href="#aab926eef41ef5237b4d43b94c2f90493"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemListBase.html#a82d413c2452f2525ee66a926d092f4b0">handleUpdatedItemData</a> (bool resort=false)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Causes the list to update it's internal state after changes have been made to one or more attached <a class="el" href="classCEGUI_1_1ItemEntry.html" title="Base class for item type widgets.">ItemEntry</a> objects. <a href="#a82d413c2452f2525ee66a926d092f4b0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemListBase.html#a71e1e9e306927638107e2e68f44761c0">setAutoResizeEnabled</a> (bool setting)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set whether or not this <a class="el" href="classCEGUI_1_1ItemListBase.html" title="Base class for item list widgets.">ItemListBase</a> widget should automatically resize to fit its content. <a href="#a71e1e9e306927638107e2e68f44761c0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemListBase.html#aba54956f9081bb6f200fc7bae4b0be01">sizeToContent</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Resize the <a class="el" href="classCEGUI_1_1ItemListBase.html" title="Base class for item list widgets.">ItemListBase</a> to exactly fit the content that is attached to it. Return a <a class="el" href="classCEGUI_1_1Rect.html" title="Class encapsulating operations on a Rectangle.">Rect</a> object describing, in un-clipped pixels, the window relative area that is to be used for rendering items. <a href="#aba54956f9081bb6f200fc7bae4b0be01"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a559d0ee84f321f6f130b904d3dd54a87"></a><!-- doxytag: member="CEGUI::ItemListBase::endInitialisation" ref="a559d0ee84f321f6f130b904d3dd54a87" args="(void)" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemListBase.html#a559d0ee84f321f6f130b904d3dd54a87">endInitialisation</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Triggers a ListContentsChanged event. These are not fired during initialisation for optimization purposes. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemListBase.html#aaeb51915c5bfc94120f82cbd8604d312">performChildWindowLayout</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">method called to perform extended laying out of attached child windows. <a href="#aaeb51915c5bfc94120f82cbd8604d312"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCEGUI_1_1Rect.html">Rect</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemListBase.html#a7dabc104f8c245a7880927fc0a0498c7">getItemRenderArea</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a <a class="el" href="classCEGUI_1_1Rect.html" title="Class encapsulating operations on a Rectangle.">Rect</a> object describing, in un-clipped pixels, the window relative area that is to be used for rendering list items. <a href="#a7dabc104f8c245a7880927fc0a0498c7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCEGUI_1_1Window.html">Window</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemListBase.html#a5e8cd16b6af211de87473dad423b442d">getContentPane</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a pointer to the window that all items are directed too. <a href="#a5e8cd16b6af211de87473dad423b442d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aac5e4c857b7d4c6f6698b06a5182c72b"></a><!-- doxytag: member="CEGUI::ItemListBase::notifyItemClicked" ref="aac5e4c857b7d4c6f6698b06a5182c72b" args="(ItemEntry *)" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemListBase.html#aac5e4c857b7d4c6f6698b06a5182c72b">notifyItemClicked</a> (<a class="el" href="classCEGUI_1_1ItemEntry.html">ItemEntry</a> *)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Notify this <a class="el" href="classCEGUI_1_1ItemListBase.html" title="Base class for item list widgets.">ItemListBase</a> that the given item was just clicked. Internal function - NOT to be used from client code. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a37e270427af2f21f74bda2decee30f33"></a><!-- doxytag: member="CEGUI::ItemListBase::notifyItemSelectState" ref="a37e270427af2f21f74bda2decee30f33" args="(ItemEntry *, bool)" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemListBase.html#a37e270427af2f21f74bda2decee30f33">notifyItemSelectState</a> (<a class="el" href="classCEGUI_1_1ItemEntry.html">ItemEntry</a> *, bool)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Notify this <a class="el" href="classCEGUI_1_1ItemListBase.html" title="Base class for item list widgets.">ItemListBase</a> that the given item just changed selection state. Internal function - NOT to be used from client code. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a71978ca11c280f236281bb69e8297d81"></a><!-- doxytag: member="CEGUI::ItemListBase::setSortEnabled" ref="a71978ca11c280f236281bb69e8297d81" args="(bool setting)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemListBase.html#a71978ca11c280f236281bb69e8297d81">setSortEnabled</a> (bool setting)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set whether the list should be sorted (by text). <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemListBase.html#a2eb1f293144075272e99bf35cb139eeb">setSortMode</a> (<a class="el" href="classCEGUI_1_1ItemListBase.html#a6a3084e3d292a36b773915d2f3781e03">SortMode</a> mode)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set mode to be used when sorting the list. <a href="#a2eb1f293144075272e99bf35cb139eeb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemListBase.html#a3a032277e8a573d620f8ad83792f7450">setSortCallback</a> (SortCallback cb)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a user callback as sorting function. <a href="#a3a032277e8a573d620f8ad83792f7450"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemListBase.html#a9806e0ffa070bf4fcba0d6adc77f8a2f">sortList</a> (bool relayout=true)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sort the list. <a href="#a9806e0ffa070bf4fcba0d6adc77f8a2f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2530db0102f715201211519e35a37d04"></a><!-- doxytag: member="CEGUI::ItemListBase::ItemListBase" ref="a2530db0102f715201211519e35a37d04" args="(const String &type, const String &name)" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemListBase.html#a2530db0102f715201211519e35a37d04">ItemListBase</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &type, const <a class="el" href="classCEGUI_1_1String.html">String</a> &name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor for <a class="el" href="classCEGUI_1_1ItemListBase.html" title="Base class for item list widgets.">ItemListBase</a> base class. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a66d7e3dd3987885738476032091ede57"></a><!-- doxytag: member="CEGUI::ItemListBase::~ItemListBase" ref="a66d7e3dd3987885738476032091ede57" args="(void)" -->
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemListBase.html#a66d7e3dd3987885738476032091ede57">~ItemListBase</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor for <a class="el" href="classCEGUI_1_1ItemListBase.html" title="Base class for item list widgets.">ItemListBase</a> base class. <br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ada9205b9fa6e6646b154e06c63ef976b"></a><!-- doxytag: member="CEGUI::ItemListBase::EventNamespace" ref="ada9205b9fa6e6646b154e06c63ef976b" args="" -->
static const <a class="el" href="classCEGUI_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemListBase.html#ada9205b9fa6e6646b154e06c63ef976b">EventNamespace</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Namespace for global events. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="classCEGUI_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemListBase.html#aa651e77d54a364cdefbed8173a99bb03">EventListContentsChanged</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="classCEGUI_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemListBase.html#a6371266a94ea9ac0b3817361acda234e">EventSortEnabledChanged</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="classCEGUI_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemListBase.html#aafc973d59eda516c0253ca9ba1e06fad">EventSortModeChanged</a></td></tr>
<tr><td colspan="2"><h2><a name="pro-types"></a>
Protected Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab047c9d170e0410c7cbe2eb776c843ea"></a><!-- doxytag: member="CEGUI::ItemListBase::ItemEntryList" ref="ab047c9d170e0410c7cbe2eb776c843ea" args="" -->
typedef std::vector< <a class="el" href="classCEGUI_1_1ItemEntry.html">ItemEntry</a> * > </td><td class="memItemRight" valign="bottom"><b>ItemEntryList</b></td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemListBase.html#a81a3434ff1cdb42c611e314476c795d9">sizeToContent_impl</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Resize the <a class="el" href="classCEGUI_1_1ItemListBase.html" title="Base class for item list widgets.">ItemListBase</a> to exactly fit the content that is attached to it. Return a <a class="el" href="classCEGUI_1_1Rect.html" title="Class encapsulating operations on a Rectangle.">Rect</a> object describing, in un-clipped pixels, the window relative area that is to be used for rendering items. <a href="#a81a3434ff1cdb42c611e314476c795d9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classCEGUI_1_1Size.html">Size</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemListBase.html#a55be4e05c1e8fecb6af897329f460ed6">getContentSize</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the <a class="el" href="classCEGUI_1_1Size.html" title="Class that holds the size (width & height) of something.">Size</a> in unclipped pixels of the content attached to this <a class="el" href="classCEGUI_1_1ItemListBase.html" title="Base class for item list widgets.">ItemListBase</a> that is attached to it. <a href="#a55be4e05c1e8fecb6af897329f460ed6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemListBase.html#a00677a8723e74b898ba03ee4265d9dcc">layoutItemWidgets</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a <a class="el" href="classCEGUI_1_1Rect.html" title="Class encapsulating operations on a Rectangle.">Rect</a> object describing, in un-clipped pixels, the window relative area that is to be used for rendering list items. <a href="#a00677a8723e74b898ba03ee4265d9dcc"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemListBase.html#a9251553ac8afb0bdc31c0775cc26d3e7">resetList_impl</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove all items from the list. <a href="#a9251553ac8afb0bdc31c0775cc26d3e7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemListBase.html#a9c26c62516fd505f667c8a7c19338691">testClassName_impl</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &class_name) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return whether this window was inherited from the given class name at some point in the inheritance hierarchy. <a href="#a9c26c62516fd505f667c8a7c19338691"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemListBase.html#a8a0cfed62ec404eebf39616062f4a56e">validateWindowRenderer</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &name) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Function used in checking if a <a class="el" href="classCEGUI_1_1WindowRenderer.html" title="Base-class for the assignable WindowRenderer object.">WindowRenderer</a> is valid for this window. <a href="#a8a0cfed62ec404eebf39616062f4a56e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a579f4b24e93ffdcd164d3f821f5201be"></a><!-- doxytag: member="CEGUI::ItemListBase::getRealSortCallback" ref="a579f4b24e93ffdcd164d3f821f5201be" args="(void) const " -->
SortCallback </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemListBase.html#a579f4b24e93ffdcd164d3f821f5201be">getRealSortCallback</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the SortCallback that's really going to be used for the sorting operation. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adcce0d3182092cf99d7a9276f74bf4b4"></a><!-- doxytag: member="CEGUI::ItemListBase::onListContentsChanged" ref="adcce0d3182092cf99d7a9276f74bf4b4" args="(WindowEventArgs &e)" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemListBase.html#adcce0d3182092cf99d7a9276f74bf4b4">onListContentsChanged</a> (<a class="el" href="classCEGUI_1_1WindowEventArgs.html">WindowEventArgs</a> &e)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Handler called internally when the list contents are changed. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aed3db628da5d4bc43189884f4969f8b5"></a><!-- doxytag: member="CEGUI::ItemListBase::onSortEnabledChanged" ref="aed3db628da5d4bc43189884f4969f8b5" args="(WindowEventArgs &e)" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemListBase.html#aed3db628da5d4bc43189884f4969f8b5">onSortEnabledChanged</a> (<a class="el" href="classCEGUI_1_1WindowEventArgs.html">WindowEventArgs</a> &e)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Handler called internally when sorting gets enabled. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4974573730f81b1c7bcd60aa11cdb048"></a><!-- doxytag: member="CEGUI::ItemListBase::onSortModeChanged" ref="a4974573730f81b1c7bcd60aa11cdb048" args="(WindowEventArgs &e)" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemListBase.html#a4974573730f81b1c7bcd60aa11cdb048">onSortModeChanged</a> (<a class="el" href="classCEGUI_1_1WindowEventArgs.html">WindowEventArgs</a> &e)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Handler called internally when the sorting mode is changed. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemListBase.html#a079e46df6899c268c5b0f47e12440236">onParentSized</a> (<a class="el" href="classCEGUI_1_1WindowEventArgs.html">WindowEventArgs</a> &e)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Handler called when this window's parent window has been resized. If this window is the root / GUI Sheet window, this call will be made when the display size changes. <a href="#a079e46df6899c268c5b0f47e12440236"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">ItemEntryList </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemListBase.html#abfddf64d087ac68a19733c328c4456f7">d_listItems</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">list of items in the list. <a href="#abfddf64d087ac68a19733c328c4456f7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a28ae3c42295890fc4c10d948d9245a0d"></a><!-- doxytag: member="CEGUI::ItemListBase::d_autoResize" ref="a28ae3c42295890fc4c10d948d9245a0d" args="" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemListBase.html#a28ae3c42295890fc4c10d948d9245a0d">d_autoResize</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Pointer to the content pane (for items), 0 if we're not using one. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3df0f184934cabe9eb4877b2ee38523e"></a><!-- doxytag: member="CEGUI::ItemListBase::d_pane" ref="a3df0f184934cabe9eb4877b2ee38523e" args="" -->
<a class="el" href="classCEGUI_1_1Window.html">Window</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemListBase.html#a3df0f184934cabe9eb4877b2ee38523e">d_pane</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">True if this <a class="el" href="classCEGUI_1_1ItemListBase.html" title="Base class for item list widgets.">ItemListBase</a> is sorted. False if not. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afb888af7167a4e7a3c791cf821f52929"></a><!-- doxytag: member="CEGUI::ItemListBase::d_sortEnabled" ref="afb888af7167a4e7a3c791cf821f52929" args="" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemListBase.html#afb888af7167a4e7a3c791cf821f52929">d_sortEnabled</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The current sorting mode applied if sorting is enabled. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6f30bfaf519592c2a9c9d5c80c01ace1"></a><!-- doxytag: member="CEGUI::ItemListBase::d_sortMode" ref="a6f30bfaf519592c2a9c9d5c80c01ace1" args="" -->
<a class="el" href="classCEGUI_1_1ItemListBase.html#a6a3084e3d292a36b773915d2f3781e03">SortMode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemListBase.html#a6f30bfaf519592c2a9c9d5c80c01ace1">d_sortMode</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The user sort callback or 0 if none. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad7bab12b6bb27f56cafdbb3e5e2e9a87"></a><!-- doxytag: member="CEGUI::ItemListBase::d_sortCallback" ref="ad7bab12b6bb27f56cafdbb3e5e2e9a87" args="" -->
SortCallback </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ItemListBase.html#ad7bab12b6bb27f56cafdbb3e5e2e9a87">d_sortCallback</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">True if the list needs to be resorted. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae3555cc1b327251fc406d4b4032bea7b"></a><!-- doxytag: member="CEGUI::ItemListBase::d_resort" ref="ae3555cc1b327251fc406d4b4032bea7b" args="" -->
bool </td><td class="memItemRight" valign="bottom"><b>d_resort</b></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Base class for item list widgets. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a6bd80691bfd31ee45728009ea4766fe5"></a><!-- doxytag: member="CEGUI::ItemListBase::addItem" ref="a6bd80691bfd31ee45728009ea4766fe5" args="(ItemEntry *item)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::ItemListBase::addItem </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1ItemEntry.html">ItemEntry</a> * </td>
<td class="paramname"><em>item</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Add the given <a class="el" href="classCEGUI_1_1ItemEntry.html" title="Base class for item type widgets.">ItemEntry</a> to the list. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">item</td><td>Pointer to the <a class="el" href="classCEGUI_1_1ItemEntry.html" title="Base class for item type widgets.">ItemEntry</a> to be added to the list. Note that it is the passed object that is added to the list, a copy is not made. If this parameter is NULL, nothing happens.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
</div>
</div>
<a class="anchor" id="a3f762755a797e6eb63650aaad6e3d0c2"></a><!-- doxytag: member="CEGUI::ItemListBase::findItemWithText" ref="a3f762755a797e6eb63650aaad6e3d0c2" args="(const String &text, const ItemEntry *start_item)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCEGUI_1_1ItemEntry.html">ItemEntry</a>* CEGUI::ItemListBase::findItemWithText </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>text</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1ItemEntry.html">ItemEntry</a> * </td>
<td class="paramname"><em>start_item</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Search the list for an item with the specified text. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">text</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object containing the text to be searched for.</td></tr>
<tr><td class="paramname">start_item</td><td><a class="el" href="classCEGUI_1_1ItemEntry.html" title="Base class for item type widgets.">ItemEntry</a> where the search is to begin, the search will not include <em>item</em>. If <em>item</em> is NULL, the search will begin from the first item in the list.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Pointer to the first <a class="el" href="classCEGUI_1_1ItemEntry.html" title="Base class for item type widgets.">ItemEntry</a> in the list after <em>item</em> that has text matching <em>text</em>. If no item matches the criteria NULL is returned.</dd></dl>
<dl><dt><b>Exceptions:</b></dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classCEGUI_1_1InvalidRequestException.html" title="Exception class used when some impossible request was made of the system.">InvalidRequestException</a></td><td>thrown if <em>item</em> is not attached to this list box. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a5e8cd16b6af211de87473dad423b442d"></a><!-- doxytag: member="CEGUI::ItemListBase::getContentPane" ref="a5e8cd16b6af211de87473dad423b442d" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCEGUI_1_1Window.html">Window</a>* CEGUI::ItemListBase::getContentPane </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns a pointer to the window that all items are directed too. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A pointer to the content pane window, or 'this' if children are added directly to this window. </dd></dl>
</div>
</div>
<a class="anchor" id="a55be4e05c1e8fecb6af897329f460ed6"></a><!-- doxytag: member="CEGUI::ItemListBase::getContentSize" ref="a55be4e05c1e8fecb6af897329f460ed6" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classCEGUI_1_1Size.html">Size</a> CEGUI::ItemListBase::getContentSize </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [protected, pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the <a class="el" href="classCEGUI_1_1Size.html" title="Class that holds the size (width & height) of something.">Size</a> in unclipped pixels of the content attached to this <a class="el" href="classCEGUI_1_1ItemListBase.html" title="Base class for item list widgets.">ItemListBase</a> that is attached to it. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="classCEGUI_1_1Size.html" title="Class that holds the size (width & height) of something.">Size</a> object describing in unclipped pixels the size of the content ItemEntries attached to this menu. </dd></dl>
<p>Implemented in <a class="el" href="classCEGUI_1_1ItemListbox.html#a8b8d9b09809eba41dfa5216e1dd91cb1">CEGUI::ItemListbox</a>, <a class="el" href="classCEGUI_1_1Menubar.html#abb7cd07521c74634bb33013375e232e4">CEGUI::Menubar</a>, and <a class="el" href="classCEGUI_1_1PopupMenu.html#a3d96ac686a00cbadf68d42d9ec4d68ff">CEGUI::PopupMenu</a>.</p>
</div>
</div>
<a class="anchor" id="a0bbcb2311f08a37a7eda909b050f4384"></a><!-- doxytag: member="CEGUI::ItemListBase::getItemCount" ref="a0bbcb2311f08a37a7eda909b050f4384" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t CEGUI::ItemListBase::getItemCount </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return number of items attached to the list. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the number of items currently attached to this list. </dd></dl>
</div>
</div>
<a class="anchor" id="af4115ac7fb39d3b1a0ca65628f73c6a4"></a><!-- doxytag: member="CEGUI::ItemListBase::getItemFromIndex" ref="af4115ac7fb39d3b1a0ca65628f73c6a4" args="(size_t index) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCEGUI_1_1ItemEntry.html">ItemEntry</a>* CEGUI::ItemListBase::getItemFromIndex </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>index</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the item at index position <em>index</em>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">index</td><td>Zero based index of the item to be returned.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Pointer to the <a class="el" href="classCEGUI_1_1ItemEntry.html" title="Base class for item type widgets.">ItemEntry</a> at index position <em>index</em> in the list.</dd></dl>
<dl><dt><b>Exceptions:</b></dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classCEGUI_1_1InvalidRequestException.html" title="Exception class used when some impossible request was made of the system.">InvalidRequestException</a></td><td>thrown if <em>index</em> is out of range. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aad07854c7f4563620b29ce12ee1ff3d3"></a><!-- doxytag: member="CEGUI::ItemListBase::getItemIndex" ref="aad07854c7f4563620b29ce12ee1ff3d3" args="(const ItemEntry *item) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t CEGUI::ItemListBase::getItemIndex </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1ItemEntry.html">ItemEntry</a> * </td>
<td class="paramname"><em>item</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the index of <a class="el" href="classCEGUI_1_1ItemEntry.html" title="Base class for item type widgets.">ItemEntry</a> <em>item</em>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">item</td><td>Pointer to a <a class="el" href="classCEGUI_1_1ItemEntry.html" title="Base class for item type widgets.">ItemEntry</a> whos zero based index is to be returned.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Zero based index indicating the position of <a class="el" href="classCEGUI_1_1ItemEntry.html" title="Base class for item type widgets.">ItemEntry</a> <em>item</em> in the list.</dd></dl>
<dl><dt><b>Exceptions:</b></dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classCEGUI_1_1InvalidRequestException.html" title="Exception class used when some impossible request was made of the system.">InvalidRequestException</a></td><td>thrown if <em>item</em> is not attached to this list. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a7dabc104f8c245a7880927fc0a0498c7"></a><!-- doxytag: member="CEGUI::ItemListBase::getItemRenderArea" ref="a7dabc104f8c245a7880927fc0a0498c7" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCEGUI_1_1Rect.html">Rect</a> CEGUI::ItemListBase::getItemRenderArea </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return a <a class="el" href="classCEGUI_1_1Rect.html" title="Class encapsulating operations on a Rectangle.">Rect</a> object describing, in un-clipped pixels, the window relative area that is to be used for rendering list items. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="classCEGUI_1_1Rect.html" title="Class encapsulating operations on a Rectangle.">Rect</a> object describing the window relative area of the that is to be used for rendering the items. </dd></dl>
</div>
</div>
<a class="anchor" id="a82d413c2452f2525ee66a926d092f4b0"></a><!-- doxytag: member="CEGUI::ItemListBase::handleUpdatedItemData" ref="a82d413c2452f2525ee66a926d092f4b0" args="(bool resort=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::ItemListBase::handleUpdatedItemData </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>resort</em> = <code>false</code></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Causes the list to update it's internal state after changes have been made to one or more attached <a class="el" href="classCEGUI_1_1ItemEntry.html" title="Base class for item type widgets.">ItemEntry</a> objects. </p>
<p>It should not be necessary to call this from client code, as the ItemEntries themselves call it if their parent is an <a class="el" href="classCEGUI_1_1ItemListBase.html" title="Base class for item list widgets.">ItemListBase</a>.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">resort</td><td>'true' to redo the list sorting as well. 'false' to only do layout and perhaps auto resize. (defaults to 'false')</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
</div>
</div>
<a class="anchor" id="ab61cc9fea4017e9a5e131910810d741f"></a><!-- doxytag: member="CEGUI::ItemListBase::initialiseComponents" ref="ab61cc9fea4017e9a5e131910810d741f" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void CEGUI::ItemListBase::initialiseComponents </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Initialise the <a class="el" href="classCEGUI_1_1Window.html" title="An abstract base class providing common functionality and specifying the required interface for deriv...">Window</a> based object ready for use. </p>
<dl class="note"><dt><b>Note:</b></dt><dd>This must be called for every window created. Normally this is handled automatically by the <a class="el" href="classCEGUI_1_1WindowFactory.html" title="Abstract class that defines the required interface for all WindowFactory objects.">WindowFactory</a> for each <a class="el" href="classCEGUI_1_1Window.html" title="An abstract base class providing common functionality and specifying the required interface for deriv...">Window</a> type.</dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing </dd></dl>
<p>Reimplemented from <a class="el" href="classCEGUI_1_1Window.html#a15d1b3c2be063277773eb28e33a2ee84">CEGUI::Window</a>.</p>
<p>Reimplemented in <a class="el" href="classCEGUI_1_1ItemListbox.html#a7ff27cd96add3373ac69fe7b08ca4f38">CEGUI::ItemListbox</a>, and <a class="el" href="classCEGUI_1_1ScrolledItemListBase.html#a8b5cf75ac98200ad3c425589ff6d7d4d">CEGUI::ScrolledItemListBase</a>.</p>
</div>
</div>
<a class="anchor" id="ae832829305cd74623251ebb9c4205be8"></a><!-- doxytag: member="CEGUI::ItemListBase::insertItem" ref="ae832829305cd74623251ebb9c4205be8" args="(ItemEntry *item, const ItemEntry *position)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::ItemListBase::insertItem </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1ItemEntry.html">ItemEntry</a> * </td>
<td class="paramname"><em>item</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1ItemEntry.html">ItemEntry</a> * </td>
<td class="paramname"><em>position</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Insert an item into the list before a specified item already in the list. </p>
<p>Note that if the list is sorted, the item may not end up in the requested position.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">item</td><td>Pointer to the <a class="el" href="classCEGUI_1_1ItemEntry.html" title="Base class for item type widgets.">ItemEntry</a> to be inserted. Note that it is the passed object that is added to the list, a copy is not made. If this parameter is NULL, nothing happens.</td></tr>
<tr><td class="paramname">position</td><td>Pointer to a <a class="el" href="classCEGUI_1_1ItemEntry.html" title="Base class for item type widgets.">ItemEntry</a> that <em>item</em> is to be inserted before. If this parameter is NULL, the item is inserted at the start of the list.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
</div>
</div>
<a class="anchor" id="ae697a469381e934e3e7b3e056dfb19b4"></a><!-- doxytag: member="CEGUI::ItemListBase::isAutoResizeEnabled" ref="ae697a469381e934e3e7b3e056dfb19b4" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool CEGUI::ItemListBase::isAutoResizeEnabled </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return whether this window is automatically resized to fit its content. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if automatic resizing is enabled, false if it is disabled. </dd></dl>
</div>
</div>
<a class="anchor" id="a8d61d61c849a1c3b49f2ad586186240c"></a><!-- doxytag: member="CEGUI::ItemListBase::isItemInList" ref="a8d61d61c849a1c3b49f2ad586186240c" args="(const ItemEntry *item) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool CEGUI::ItemListBase::isItemInList </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1ItemEntry.html">ItemEntry</a> * </td>
<td class="paramname"><em>item</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return whether the specified <a class="el" href="classCEGUI_1_1ItemEntry.html" title="Base class for item type widgets.">ItemEntry</a> is in the List. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if <a class="el" href="classCEGUI_1_1ItemEntry.html" title="Base class for item type widgets.">ItemEntry</a> <em>item</em> is in the list, false if <a class="el" href="classCEGUI_1_1ItemEntry.html" title="Base class for item type widgets.">ItemEntry</a> <em>item</em> is not in the list. </dd></dl>
</div>
</div>
<a class="anchor" id="a00677a8723e74b898ba03ee4265d9dcc"></a><!-- doxytag: member="CEGUI::ItemListBase::layoutItemWidgets" ref="a00677a8723e74b898ba03ee4265d9dcc" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void CEGUI::ItemListBase::layoutItemWidgets </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [protected, pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return a <a class="el" href="classCEGUI_1_1Rect.html" title="Class encapsulating operations on a Rectangle.">Rect</a> object describing, in un-clipped pixels, the window relative area that is to be used for rendering list items. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="classCEGUI_1_1Rect.html" title="Class encapsulating operations on a Rectangle.">Rect</a> object describing the window relative area of the that is to be used for rendering the items.</dd></dl>
<p>Setup size and position for the item widgets attached to this <a class="el" href="classCEGUI_1_1ItemListBase.html" title="Base class for item list widgets.">ItemListBase</a></p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
<p>Implemented in <a class="el" href="classCEGUI_1_1ItemListbox.html#a632c4cfb9665fdcef81d78e46d90fd36">CEGUI::ItemListbox</a>, <a class="el" href="classCEGUI_1_1Menubar.html#a225d8f570d998ad59f93167f3313c7e6">CEGUI::Menubar</a>, and <a class="el" href="classCEGUI_1_1PopupMenu.html#af623844a7a70c77ce37c6c5143f22f2a">CEGUI::PopupMenu</a>.</p>
</div>
</div>
<a class="anchor" id="a079e46df6899c268c5b0f47e12440236"></a><!-- doxytag: member="CEGUI::ItemListBase::onParentSized" ref="a079e46df6899c268c5b0f47e12440236" args="(WindowEventArgs &e)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void CEGUI::ItemListBase::onParentSized </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1WindowEventArgs.html">WindowEventArgs</a> & </td>
<td class="paramname"><em>e</em></td><td>)</td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Handler called when this window's parent window has been resized. If this window is the root / GUI Sheet window, this call will be made when the display size changes. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">e</td><td><a class="el" href="classCEGUI_1_1WindowEventArgs.html" title="EventArgs based class that is used for objects passed to handlers triggered for events concerning som...">WindowEventArgs</a> object whose 'window' pointer field is set the the window that caused the event; this is typically either this window's parent window, or NULL to indicate the screen size has changed. </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented from <a class="el" href="classCEGUI_1_1Window.html#ae60146da602ae57482380def270dc283">CEGUI::Window</a>.</p>
</div>
</div>
<a class="anchor" id="aaeb51915c5bfc94120f82cbd8604d312"></a><!-- doxytag: member="CEGUI::ItemListBase::performChildWindowLayout" ref="aaeb51915c5bfc94120f82cbd8604d312" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void CEGUI::ItemListBase::performChildWindowLayout </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>method called to perform extended laying out of attached child windows. </p>
<p>The system may call this at various times (like when it is resized for example), and it may be invoked directly where required.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
<p>Reimplemented from <a class="el" href="classCEGUI_1_1Window.html#a7d66a971fadf54e311872aaba11d3087">CEGUI::Window</a>.</p>
</div>
</div>
<a class="anchor" id="aab926eef41ef5237b4d43b94c2f90493"></a><!-- doxytag: member="CEGUI::ItemListBase::removeItem" ref="aab926eef41ef5237b4d43b94c2f90493" args="(ItemEntry *item)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::ItemListBase::removeItem </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1ItemEntry.html">ItemEntry</a> * </td>
<td class="paramname"><em>item</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Removes the given item from the list. If the item is has the 'DestroyedByParent' property set to 'true', the item will be deleted. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">item</td><td>Pointer to the <a class="el" href="classCEGUI_1_1ItemEntry.html" title="Base class for item type widgets.">ItemEntry</a> that is to be removed. If <em>item</em> is not attached to this list then nothing will happen.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
</div>
</div>
<a class="anchor" id="a0497f057d9812428695aef79c9b74821"></a><!-- doxytag: member="CEGUI::ItemListBase::resetList" ref="a0497f057d9812428695aef79c9b74821" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::ItemListBase::resetList </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Remove all items from the list. </p>
<p>Note that this will cause items, which does not have the 'DestroyedByParent' property set to 'false', to be deleted. </p>
</div>
</div>
<a class="anchor" id="a9251553ac8afb0bdc31c0775cc26d3e7"></a><!-- doxytag: member="CEGUI::ItemListBase::resetList_impl" ref="a9251553ac8afb0bdc31c0775cc26d3e7" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool CEGUI::ItemListBase::resetList_impl </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Remove all items from the list. </p>
<dl class="note"><dt><b>Note:</b></dt><dd>Note that this will cause items with the 'DestroyedByParent' property set to 'true', to be deleted.</dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
<li>true if the list contents were changed.</li>
<li>false if the list contents were not changed (list already empty). </li>
</ul>
</dd></dl>
</div>
</div>
<a class="anchor" id="a71e1e9e306927638107e2e68f44761c0"></a><!-- doxytag: member="CEGUI::ItemListBase::setAutoResizeEnabled" ref="a71e1e9e306927638107e2e68f44761c0" args="(bool setting)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::ItemListBase::setAutoResizeEnabled </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>setting</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set whether or not this <a class="el" href="classCEGUI_1_1ItemListBase.html" title="Base class for item list widgets.">ItemListBase</a> widget should automatically resize to fit its content. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">setting</td><td>Boolean value that if true enables automatic resizing, if false disables automatic resizing.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
</div>
</div>
<a class="anchor" id="a3a032277e8a573d620f8ad83792f7450"></a><!-- doxytag: member="CEGUI::ItemListBase::setSortCallback" ref="a3a032277e8a573d620f8ad83792f7450" args="(SortCallback cb)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::ItemListBase::setSortCallback </td>
<td>(</td>
<td class="paramtype">SortCallback </td>
<td class="paramname"><em>cb</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set a user callback as sorting function. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">mode</td><td>SortCallback </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a2eb1f293144075272e99bf35cb139eeb"></a><!-- doxytag: member="CEGUI::ItemListBase::setSortMode" ref="a2eb1f293144075272e99bf35cb139eeb" args="(SortMode mode)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::ItemListBase::setSortMode </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1ItemListBase.html#a6a3084e3d292a36b773915d2f3781e03">SortMode</a> </td>
<td class="paramname"><em>mode</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set mode to be used when sorting the list. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">mode</td><td>SortMode enum. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aba54956f9081bb6f200fc7bae4b0be01"></a><!-- doxytag: member="CEGUI::ItemListBase::sizeToContent" ref="aba54956f9081bb6f200fc7bae4b0be01" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void CEGUI::ItemListBase::sizeToContent </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Resize the <a class="el" href="classCEGUI_1_1ItemListBase.html" title="Base class for item list widgets.">ItemListBase</a> to exactly fit the content that is attached to it. Return a <a class="el" href="classCEGUI_1_1Rect.html" title="Class encapsulating operations on a Rectangle.">Rect</a> object describing, in un-clipped pixels, the window relative area that is to be used for rendering items. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing </dd></dl>
</div>
</div>
<a class="anchor" id="a81a3434ff1cdb42c611e314476c795d9"></a><!-- doxytag: member="CEGUI::ItemListBase::sizeToContent_impl" ref="a81a3434ff1cdb42c611e314476c795d9" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void CEGUI::ItemListBase::sizeToContent_impl </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Resize the <a class="el" href="classCEGUI_1_1ItemListBase.html" title="Base class for item list widgets.">ItemListBase</a> to exactly fit the content that is attached to it. Return a <a class="el" href="classCEGUI_1_1Rect.html" title="Class encapsulating operations on a Rectangle.">Rect</a> object describing, in un-clipped pixels, the window relative area that is to be used for rendering items. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing </dd></dl>
</div>
</div>
<a class="anchor" id="a9806e0ffa070bf4fcba0d6adc77f8a2f"></a><!-- doxytag: member="CEGUI::ItemListBase::sortList" ref="a9806e0ffa070bf4fcba0d6adc77f8a2f" args="(bool relayout=true)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::ItemListBase::sortList </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>relayout</em> = <code>true</code></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sort the list. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">relayout</td><td>True if the item layout should be redone after the sorting. False to only sort the internal list. Nothing more.</td></tr>
</table>
</dd>
</dl>
<p>This parameter defaults to true and should generally not be used in client code. </p>
</div>
</div>
<a class="anchor" id="a9c26c62516fd505f667c8a7c19338691"></a><!-- doxytag: member="CEGUI::ItemListBase::testClassName_impl" ref="a9c26c62516fd505f667c8a7c19338691" args="(const String &class_name) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool CEGUI::ItemListBase::testClassName_impl </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>class_name</em></td><td>)</td>
<td> const<code> [inline, protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return whether this window was inherited from the given class name at some point in the inheritance hierarchy. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">class_name</td><td>The class name that is to be checked.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if this window was inherited from <em>class_name</em>. false if not. </dd></dl>
<p>Reimplemented from <a class="el" href="classCEGUI_1_1Window.html#a2b58cf00b4790c9cb08acfc18d5d3b0b">CEGUI::Window</a>.</p>
<p>Reimplemented in <a class="el" href="classCEGUI_1_1ItemListbox.html#a11c85f7abb6010a055e928ae2c5f9645">CEGUI::ItemListbox</a>, <a class="el" href="classCEGUI_1_1Menubar.html#a72ba244d28b1d1663ac7f48852d6f9a1">CEGUI::Menubar</a>, <a class="el" href="classCEGUI_1_1MenuBase.html#a305654b984ca2f384d70f86b07adc6d9">CEGUI::MenuBase</a>, <a class="el" href="classCEGUI_1_1PopupMenu.html#ad0fbad7b1a623da5c809e5d15e0b58fd">CEGUI::PopupMenu</a>, and <a class="el" href="classCEGUI_1_1ScrolledItemListBase.html#abec44d48bbc7cf23c4e24314a4a91959">CEGUI::ScrolledItemListBase</a>.</p>
<p>References <a class="el" href="classCEGUI_1_1Window.html#a2b58cf00b4790c9cb08acfc18d5d3b0b">CEGUI::Window::testClassName_impl()</a>.</p>
<p>Referenced by <a class="el" href="classCEGUI_1_1ScrolledItemListBase.html#abec44d48bbc7cf23c4e24314a4a91959">CEGUI::ScrolledItemListBase::testClassName_impl()</a>, and <a class="el" href="classCEGUI_1_1MenuBase.html#a305654b984ca2f384d70f86b07adc6d9">CEGUI::MenuBase::testClassName_impl()</a>.</p>
</div>
</div>
<a class="anchor" id="a8a0cfed62ec404eebf39616062f4a56e"></a><!-- doxytag: member="CEGUI::ItemListBase::validateWindowRenderer" ref="a8a0cfed62ec404eebf39616062f4a56e" args="(const String &name) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool CEGUI::ItemListBase::validateWindowRenderer </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>name</em></td><td>)</td>
<td> const<code> [inline, protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Function used in checking if a <a class="el" href="classCEGUI_1_1WindowRenderer.html" title="Base-class for the assignable WindowRenderer object.">WindowRenderer</a> is valid for this window. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Returns true if the given <a class="el" href="classCEGUI_1_1WindowRenderer.html" title="Base-class for the assignable WindowRenderer object.">WindowRenderer</a> class name is valid for this window. False if not. </dd></dl>
<p>Reimplemented from <a class="el" href="classCEGUI_1_1Window.html#a27804e1e76bbbf4af45dfb23c24afa1a">CEGUI::Window</a>.</p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="abfddf64d087ac68a19733c328c4456f7"></a><!-- doxytag: member="CEGUI::ItemListBase::d_listItems" ref="abfddf64d087ac68a19733c328c4456f7" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ItemEntryList <a class="el" href="classCEGUI_1_1ItemListBase.html#abfddf64d087ac68a19733c328c4456f7">CEGUI::ItemListBase::d_listItems</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>list of items in the list. </p>
<p>True if this <a class="el" href="classCEGUI_1_1ItemListBase.html" title="Base class for item list widgets.">ItemListBase</a> widget should automatically resize to fit its content. False if not. </p>
</div>
</div>
<a class="anchor" id="aa651e77d54a364cdefbed8173a99bb03"></a><!-- doxytag: member="CEGUI::ItemListBase::EventListContentsChanged" ref="aa651e77d54a364cdefbed8173a99bb03" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classCEGUI_1_1String.html">String</a> <a class="el" href="classCEGUI_1_1ItemListBase.html#aa651e77d54a364cdefbed8173a99bb03">CEGUI::ItemListBase::EventListContentsChanged</a><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> fired when the contents of the list is changed. Handlers are passed a const <a class="el" href="classCEGUI_1_1WindowEventArgs.html" title="EventArgs based class that is used for objects passed to handlers triggered for events concerning som...">WindowEventArgs</a> reference with <a class="el" href="classCEGUI_1_1WindowEventArgs.html#a5817b522882b9648d445a20b8c354966" title="pointer to a Window object of relevance to the event.">WindowEventArgs::window</a> set to the <a class="el" href="classCEGUI_1_1ItemListBase.html" title="Base class for item list widgets.">ItemListBase</a> whose contents has changed. </p>
</div>
</div>
<a class="anchor" id="a6371266a94ea9ac0b3817361acda234e"></a><!-- doxytag: member="CEGUI::ItemListBase::EventSortEnabledChanged" ref="a6371266a94ea9ac0b3817361acda234e" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classCEGUI_1_1String.html">String</a> <a class="el" href="classCEGUI_1_1ItemListBase.html#a6371266a94ea9ac0b3817361acda234e">CEGUI::ItemListBase::EventSortEnabledChanged</a><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> fired when the sort enabled state of the list is changed. Handlers are passed a const <a class="el" href="classCEGUI_1_1WindowEventArgs.html" title="EventArgs based class that is used for objects passed to handlers triggered for events concerning som...">WindowEventArgs</a> reference with <a class="el" href="classCEGUI_1_1WindowEventArgs.html#a5817b522882b9648d445a20b8c354966" title="pointer to a Window object of relevance to the event.">WindowEventArgs::window</a> set to the <a class="el" href="classCEGUI_1_1ItemListBase.html" title="Base class for item list widgets.">ItemListBase</a> whose sort enabled mode has been changed. </p>
</div>
</div>
<a class="anchor" id="aafc973d59eda516c0253ca9ba1e06fad"></a><!-- doxytag: member="CEGUI::ItemListBase::EventSortModeChanged" ref="aafc973d59eda516c0253ca9ba1e06fad" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classCEGUI_1_1String.html">String</a> <a class="el" href="classCEGUI_1_1ItemListBase.html#aafc973d59eda516c0253ca9ba1e06fad">CEGUI::ItemListBase::EventSortModeChanged</a><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> fired when the sort mode of the list is changed. Handlers are passed a const <a class="el" href="classCEGUI_1_1WindowEventArgs.html" title="EventArgs based class that is used for objects passed to handlers triggered for events concerning som...">WindowEventArgs</a> reference with <a class="el" href="classCEGUI_1_1WindowEventArgs.html#a5817b522882b9648d445a20b8c354966" title="pointer to a Window object of relevance to the event.">WindowEventArgs::window</a> set to the <a class="el" href="classCEGUI_1_1ItemListBase.html" title="Base class for item list widgets.">ItemListBase</a> whose sorting mode has been changed. </p>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Sun Jan 22 2012 16:07:41 for Crazy Eddies GUI System by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>
|