← Back to branch summary

~ubuntu-branches/debian/wheezy/cegui-mk2/wheezy

« back to all changes in this revision

Viewing changes to docs/classCEGUI_1_1Listbox.html

  • Committer: Package Import Robot
  • Author(s): Muammar El Khatib
  • Date: 2011-10-13 12:43:12 UTC
  • mfrom: (10.1.5 experimental)
  • Revision ID: package-import@ubuntu.com-20111013124312-qch0o3fayloxgxu3
Tags: 0.7.5-7
http://bugs.debian.org/645109
Moved to unstable. (Closes: #645109)

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/classCEGUI_1_1Listbox.html
 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 
2
<html xmlns="http://www.w3.org/1999/xhtml">
 
3
<head>
 
4
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
 
5
<title>Crazy Eddies GUI System: CEGUI::Listbox Class Reference</title>
 
6
<link href="tabs.css" rel="stylesheet" type="text/css"/>
 
7
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
 
8
</head>
 
9
<body>
 
10
<!-- Generated by Doxygen 1.7.2 -->
 
11
<script type="text/javascript">
 
12
function hasClass(ele,cls) {
 
13
  return ele.className.match(new RegExp('(\\s|^)'+cls+'(\\s|$)'));
 
14
}
 
15
 
 
16
function addClass(ele,cls) {
 
17
  if (!this.hasClass(ele,cls)) ele.className += " "+cls;
 
18
}
 
19
 
 
20
function removeClass(ele,cls) {
 
21
  if (hasClass(ele,cls)) {
 
22
    var reg = new RegExp('(\\s|^)'+cls+'(\\s|$)');
 
23
    ele.className=ele.className.replace(reg,' ');
 
24
  }
 
25
}
 
26
 
 
27
function toggleVisibility(linkObj) {
 
28
 var base = linkObj.getAttribute('id');
 
29
 var summary = document.getElementById(base + '-summary');
 
30
 var content = document.getElementById(base + '-content');
 
31
 var trigger = document.getElementById(base + '-trigger');
 
32
 if ( hasClass(linkObj,'closed') ) {
 
33
   summary.style.display = 'none';
 
34
   content.style.display = 'block';
 
35
   trigger.src = 'open.png';
 
36
   removeClass(linkObj,'closed');
 
37
   addClass(linkObj,'opened');
 
38
 } else if ( hasClass(linkObj,'opened') ) {
 
39
   summary.style.display = 'block';
 
40
   content.style.display = 'none';
 
41
   trigger.src = 'closed.png';
 
42
   removeClass(linkObj,'opened');
 
43
   addClass(linkObj,'closed');
 
44
 }
 
45
 return false;
 
46
}
 
47
</script>
 
48
<div class="navigation" id="top">
 
49
  <div class="tabs">
 
50
    <ul class="tablist">
 
51
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
 
52
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
 
53
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
 
54
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
 
55
      <li><a href="files.html"><span>Files</span></a></li>
 
56
    </ul>
 
57
  </div>
 
58
  <div class="tabs2">
 
59
    <ul class="tablist">
 
60
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
 
61
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
 
62
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
 
63
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
 
64
    </ul>
 
65
  </div>
 
66
  <div class="navpath">
 
67
    <ul>
 
68
      <li><a class="el" href="namespaceCEGUI.html">CEGUI</a>      </li>
 
69
      <li><a class="el" href="classCEGUI_1_1Listbox.html">Listbox</a>      </li>
 
70
    </ul>
 
71
  </div>
 
72
</div>
 
73
<div class="header">
 
74
  <div class="summary">
 
75
<a href="#pub-methods">Public Member Functions</a> &#124;
 
76
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
 
77
<a href="#pro-types">Protected Types</a> &#124;
 
78
<a href="#pro-methods">Protected Member Functions</a> &#124;
 
79
<a href="#pro-attribs">Protected Attributes</a> &#124;
 
80
<a href="#friends">Friends</a>  </div>
 
81
  <div class="headertitle">
 
82
<h1>CEGUI::Listbox Class Reference</h1>  </div>
 
83
</div>
 
84
<div class="contents">
 
85
<!-- doxytag: class="CEGUI::Listbox" --><!-- doxytag: inherits="CEGUI::Window" -->
 
86
<p>Base class for standard <a class="el" href="classCEGUI_1_1Listbox.html" title="Base class for standard Listbox widget.">Listbox</a> widget.  
 
87
<a href="#_details">More...</a></p>
 
88
<!-- startSectionHeader --><div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
 
89
  <img id="dynsection-0-trigger" src="closed.png"/> Inheritance diagram for CEGUI::Listbox:<!-- endSectionHeader --></div>
 
90
<!-- startSectionSummary --><div id="dynsection-0-summary" class="dynsummary" style="display:block;">
 
91
<!-- endSectionSummary --></div>
 
92
<!-- startSectionContent --><div id="dynsection-0-content" class="dyncontent" style="display:none;">
 
93
<div class="center"><img src="classCEGUI_1_1Listbox__inherit__graph.gif" border="0" usemap="#CEGUI_1_1Listbox_inherit__map" alt="Inheritance graph"/></div>
 
94
<map name="CEGUI_1_1Listbox_inherit__map" id="CEGUI_1_1Listbox_inherit__map">
 
95
<area shape="rect" id="node5" href="classCEGUI_1_1ComboDropList.html" title="Base class for the combo box drop down list. This is a specialisation of the Listbox class..." alt="" coords="5,160,173,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="31,5,148,35"/></map>
 
96
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center><!-- endSectionContent --></div>
 
97
<!-- startSectionHeader --><div id="dynsection-1" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
 
98
  <img id="dynsection-1-trigger" src="closed.png"/> Collaboration diagram for CEGUI::Listbox:<!-- endSectionHeader --></div>
 
99
<!-- startSectionSummary --><div id="dynsection-1-summary" class="dynsummary" style="display:block;">
 
100
<!-- endSectionSummary --></div>
 
101
<!-- startSectionContent --><div id="dynsection-1-content" class="dyncontent" style="display:none;">
 
102
<div class="center"><img src="classCEGUI_1_1Listbox__coll__graph.gif" border="0" usemap="#CEGUI_1_1Listbox_coll__map" alt="Collaboration graph"/></div>
 
103
<map name="CEGUI_1_1Listbox_coll__map" id="CEGUI_1_1Listbox_coll__map">
 
104
<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="101,81,219,111"/><area shape="rect" id="node5" href="classCEGUI_1_1ListboxProperties_1_1ForceHorzScrollbar.html" title="Property to access the &#39;always show&#39; setting for the horizontal scroll bar of the list box..." alt="" coords="5,135,315,164"/><area shape="rect" id="node7" href="classCEGUI_1_1ListboxProperties_1_1ForceVertScrollbar.html" title="Property to access the &#39;always show&#39; setting for the vertical scroll bar of the list box..." alt="" coords="8,188,312,217"/></map>
 
105
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center><!-- endSectionContent --></div>
 
106
 
 
107
<p><a href="classCEGUI_1_1Listbox-members.html">List of all members.</a></p>
 
108
<table class="memberdecls">
 
109
<tr><td colspan="2"><h2><a name="pub-methods"></a>
 
110
Public Member Functions</h2></td></tr>
 
111
<tr><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Listbox.html#ac27fb510288515009d43ec7cfb42bfcf">getItemCount</a> (void) const </td></tr>
 
112
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Return number of items attached to the list box.  <a href="#ac27fb510288515009d43ec7cfb42bfcf"></a><br/></td></tr>
 
113
<tr><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Listbox.html#afe5e12f55912979d9c563b6d1d5292ad">getSelectedCount</a> (void) const </td></tr>
 
114
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the number of selected items in the list box.  <a href="#afe5e12f55912979d9c563b6d1d5292ad"></a><br/></td></tr>
 
115
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCEGUI_1_1ListboxItem.html">ListboxItem</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Listbox.html#a9622ad2ae98d3e58fac555d8fee17191">getFirstSelectedItem</a> (void) const </td></tr>
 
116
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a pointer to the first selected item.  <a href="#a9622ad2ae98d3e58fac555d8fee17191"></a><br/></td></tr>
 
117
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCEGUI_1_1ListboxItem.html">ListboxItem</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Listbox.html#a93ab5ca738ed2b94ac14e464a45a2e6a">getNextSelected</a> (const <a class="el" href="classCEGUI_1_1ListboxItem.html">ListboxItem</a> *start_item) const </td></tr>
 
118
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a pointer to the next selected item after item <em>start_item</em>.  <a href="#a93ab5ca738ed2b94ac14e464a45a2e6a"></a><br/></td></tr>
 
119
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCEGUI_1_1ListboxItem.html">ListboxItem</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Listbox.html#a7ff0dfdb9797c09d2b3803d0976672f2">getListboxItemFromIndex</a> (size_t index) const </td></tr>
 
120
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the item at index position <em>index</em>.  <a href="#a7ff0dfdb9797c09d2b3803d0976672f2"></a><br/></td></tr>
 
121
<tr><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Listbox.html#aaea9cf33ecf30eb1c3e2e8421748761e">getItemIndex</a> (const <a class="el" href="classCEGUI_1_1ListboxItem.html">ListboxItem</a> *item) const </td></tr>
 
122
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the index of <a class="el" href="classCEGUI_1_1ListboxItem.html" title="Base class for list box items.">ListboxItem</a> <em>item</em>.  <a href="#aaea9cf33ecf30eb1c3e2e8421748761e"></a><br/></td></tr>
 
123
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Listbox.html#ac482b699cf93aed09b7dd6fe130aabeb">isSortEnabled</a> (void) const </td></tr>
 
124
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">return whether list sorting is enabled  <a href="#ac482b699cf93aed09b7dd6fe130aabeb"></a><br/></td></tr>
 
125
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Listbox.html#a0bd0e1f4dbf1b445b9fb8d0290ef5b1e">isMultiselectEnabled</a> (void) const </td></tr>
 
126
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">return whether multi-select is enabled  <a href="#a0bd0e1f4dbf1b445b9fb8d0290ef5b1e"></a><br/></td></tr>
 
127
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a52601e01f9cfbc0d16a5bc6ebe895866"></a><!-- doxytag: member="CEGUI::Listbox::isItemTooltipsEnabled" ref="a52601e01f9cfbc0d16a5bc6ebe895866" args="(void) const " -->
 
128
bool&#160;</td><td class="memItemRight" valign="bottom"><b>isItemTooltipsEnabled</b> (void) const </td></tr>
 
129
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Listbox.html#ad0dddf7866aaf0ff6862315702fb859d">isItemSelected</a> (size_t index) const </td></tr>
 
130
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">return whether the string at index position <em>index</em> is selected  <a href="#ad0dddf7866aaf0ff6862315702fb859d"></a><br/></td></tr>
 
131
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCEGUI_1_1ListboxItem.html">ListboxItem</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Listbox.html#a8e543ad0432bbdda06781d82a70ac0f3">findItemWithText</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &amp;text, const <a class="el" href="classCEGUI_1_1ListboxItem.html">ListboxItem</a> *start_item)</td></tr>
 
132
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Search the list for an item with the specified text.  <a href="#a8e543ad0432bbdda06781d82a70ac0f3"></a><br/></td></tr>
 
133
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Listbox.html#aac747ba199d28ffe28ac4227b30c099e">isListboxItemInList</a> (const <a class="el" href="classCEGUI_1_1ListboxItem.html">ListboxItem</a> *item) const </td></tr>
 
134
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Return whether the specified <a class="el" href="classCEGUI_1_1ListboxItem.html" title="Base class for list box items.">ListboxItem</a> is in the List.  <a href="#aac747ba199d28ffe28ac4227b30c099e"></a><br/></td></tr>
 
135
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Listbox.html#a3570630d416062b28be786825c06e981">isVertScrollbarAlwaysShown</a> (void) const </td></tr>
 
136
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Return whether the vertical scroll bar is always shown.  <a href="#a3570630d416062b28be786825c06e981"></a><br/></td></tr>
 
137
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Listbox.html#afe2f4f39ffefe869f13c287c271b40bd">isHorzScrollbarAlwaysShown</a> (void) const </td></tr>
 
138
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Return whether the horizontal scroll bar is always shown.  <a href="#afe2f4f39ffefe869f13c287c271b40bd"></a><br/></td></tr>
 
139
<tr><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Listbox.html#a31a4dc42adca5d28af5f463c3a6efdda">initialiseComponents</a> (void)</td></tr>
 
140
<tr><td class="mdescLeft">&#160;</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="#a31a4dc42adca5d28af5f463c3a6efdda"></a><br/></td></tr>
 
141
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Listbox.html#a3f086468a0fe012ce5b2bba7b06bafa5">resetList</a> (void)</td></tr>
 
142
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Remove all items from the list.  <a href="#a3f086468a0fe012ce5b2bba7b06bafa5"></a><br/></td></tr>
 
143
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Listbox.html#a86b3e614b9e70bb0e89c368ddbd17316">addItem</a> (<a class="el" href="classCEGUI_1_1ListboxItem.html">ListboxItem</a> *item)</td></tr>
 
144
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Add the given <a class="el" href="classCEGUI_1_1ListboxItem.html" title="Base class for list box items.">ListboxItem</a> to the list.  <a href="#a86b3e614b9e70bb0e89c368ddbd17316"></a><br/></td></tr>
 
145
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Listbox.html#a20611491f79faea7b40c72030e038d92">insertItem</a> (<a class="el" href="classCEGUI_1_1ListboxItem.html">ListboxItem</a> *item, const <a class="el" href="classCEGUI_1_1ListboxItem.html">ListboxItem</a> *position)</td></tr>
 
146
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Insert an item into the list box before a specified item already in the list.  <a href="#a20611491f79faea7b40c72030e038d92"></a><br/></td></tr>
 
147
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Listbox.html#a4bf421907b4219fc77a3139da0694c92">removeItem</a> (const <a class="el" href="classCEGUI_1_1ListboxItem.html">ListboxItem</a> *item)</td></tr>
 
148
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Removes the given item from the list box. If the item is has the auto delete state set, the item will be deleted.  <a href="#a4bf421907b4219fc77a3139da0694c92"></a><br/></td></tr>
 
149
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Listbox.html#a855f4d1bbe53cbab8ed95ab5b1312852">clearAllSelections</a> (void)</td></tr>
 
150
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Clear the selected state for all items.  <a href="#a855f4d1bbe53cbab8ed95ab5b1312852"></a><br/></td></tr>
 
151
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Listbox.html#a84de1c2932171a099884d2e249d43bf2">setSortingEnabled</a> (bool setting)</td></tr>
 
152
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Set whether the list should be sorted.  <a href="#a84de1c2932171a099884d2e249d43bf2"></a><br/></td></tr>
 
153
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Listbox.html#aff52444a6878a69eb209cf6e9f80521b">setMultiselectEnabled</a> (bool setting)</td></tr>
 
154
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Set whether the list should allow multiple selections or just a single selection.  <a href="#aff52444a6878a69eb209cf6e9f80521b"></a><br/></td></tr>
 
155
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Listbox.html#aa28e1d66f95d88abffaece0226b7b2d3">setShowVertScrollbar</a> (bool setting)</td></tr>
 
156
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Set whether the vertical scroll bar should always be shown.  <a href="#aa28e1d66f95d88abffaece0226b7b2d3"></a><br/></td></tr>
 
157
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Listbox.html#a1aad9c0cf940542fea921ba25620aee2">setShowHorzScrollbar</a> (bool setting)</td></tr>
 
158
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Set whether the horizontal scroll bar should always be shown.  <a href="#a1aad9c0cf940542fea921ba25620aee2"></a><br/></td></tr>
 
159
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acfef3ded566c19f989cebd338626d0ac"></a><!-- doxytag: member="CEGUI::Listbox::setItemTooltipsEnabled" ref="acfef3ded566c19f989cebd338626d0ac" args="(bool setting)" -->
 
160
void&#160;</td><td class="memItemRight" valign="bottom"><b>setItemTooltipsEnabled</b> (bool setting)</td></tr>
 
161
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Listbox.html#a21ebdb1cfb45f1c12d913ce0173bc058">setItemSelectState</a> (<a class="el" href="classCEGUI_1_1ListboxItem.html">ListboxItem</a> *item, bool state)</td></tr>
 
162
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the select state of an attached <a class="el" href="classCEGUI_1_1ListboxItem.html" title="Base class for list box items.">ListboxItem</a>.  <a href="#a21ebdb1cfb45f1c12d913ce0173bc058"></a><br/></td></tr>
 
163
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Listbox.html#a895946c8082b13c05a286ded90208591">setItemSelectState</a> (size_t item_index, bool state)</td></tr>
 
164
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the select state of an attached <a class="el" href="classCEGUI_1_1ListboxItem.html" title="Base class for list box items.">ListboxItem</a>.  <a href="#a895946c8082b13c05a286ded90208591"></a><br/></td></tr>
 
165
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Listbox.html#a8903860958694541f87997ce776d0eaa">handleUpdatedItemData</a> (void)</td></tr>
 
166
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Causes the list box to update it's internal state after changes have been made to one or more attached <a class="el" href="classCEGUI_1_1ListboxItem.html" title="Base class for list box items.">ListboxItem</a> objects.  <a href="#a8903860958694541f87997ce776d0eaa"></a><br/></td></tr>
 
167
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Listbox.html#a138911afbeead634f3f5d6b7d376c809">ensureItemIsVisible</a> (size_t item_index)</td></tr>
 
168
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Ensure the item at the specified index is visible within the list box.  <a href="#a138911afbeead634f3f5d6b7d376c809"></a><br/></td></tr>
 
169
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Listbox.html#a63d408d2bcbefda06fbc8b6ebbd9dca7">ensureItemIsVisible</a> (const <a class="el" href="classCEGUI_1_1ListboxItem.html">ListboxItem</a> *item)</td></tr>
 
170
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Ensure the item at the specified index is visible within the list box.  <a href="#a63d408d2bcbefda06fbc8b6ebbd9dca7"></a><br/></td></tr>
 
171
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classCEGUI_1_1Rect.html">Rect</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Listbox.html#ab1b48abe760fd1bcf0269b79b2e99555">getListRenderArea</a> (void) const </td></tr>
 
172
<tr><td class="mdescLeft">&#160;</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="#ab1b48abe760fd1bcf0269b79b2e99555"></a><br/></td></tr>
 
173
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCEGUI_1_1Scrollbar.html">Scrollbar</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Listbox.html#aa8bdb140ffab153cb3506756f7ca2707">getVertScrollbar</a> () const </td></tr>
 
174
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a pointer to the vertical scrollbar component widget for this <a class="el" href="classCEGUI_1_1Listbox.html" title="Base class for standard Listbox widget.">Listbox</a>.  <a href="#aa8bdb140ffab153cb3506756f7ca2707"></a><br/></td></tr>
 
175
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCEGUI_1_1Scrollbar.html">Scrollbar</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Listbox.html#ad2dae35017cb934b938facf39ea56b41">getHorzScrollbar</a> () const </td></tr>
 
176
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a pointer to the horizontal scrollbar component widget for this <a class="el" href="classCEGUI_1_1Listbox.html" title="Base class for standard Listbox widget.">Listbox</a>.  <a href="#ad2dae35017cb934b938facf39ea56b41"></a><br/></td></tr>
 
177
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a452cdfd0790c65801165e0536437c76d"></a><!-- doxytag: member="CEGUI::Listbox::getTotalItemsHeight" ref="a452cdfd0790c65801165e0536437c76d" args="(void) const " -->
 
178
float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Listbox.html#a452cdfd0790c65801165e0536437c76d">getTotalItemsHeight</a> (void) const </td></tr>
 
179
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the sum of all item heights. <br/></td></tr>
 
180
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a264076b821d3bc95fb0276a3a9d9a42a"></a><!-- doxytag: member="CEGUI::Listbox::getWidestItemWidth" ref="a264076b821d3bc95fb0276a3a9d9a42a" args="(void) const " -->
 
181
float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Listbox.html#a264076b821d3bc95fb0276a3a9d9a42a">getWidestItemWidth</a> (void) const </td></tr>
 
182
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the width of the widest item. <br/></td></tr>
 
183
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCEGUI_1_1ListboxItem.html">ListboxItem</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Listbox.html#aa94cde3135645116f321d232f3919fb4">getItemAtPoint</a> (const <a class="el" href="classCEGUI_1_1Vector2.html">Point</a> &amp;pt) const </td></tr>
 
184
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a pointer to the <a class="el" href="classCEGUI_1_1ListboxItem.html" title="Base class for list box items.">ListboxItem</a> attached to this <a class="el" href="classCEGUI_1_1Listbox.html" title="Base class for standard Listbox widget.">Listbox</a> at the given screen pixel co-ordinate.  <a href="#aa94cde3135645116f321d232f3919fb4"></a><br/></td></tr>
 
185
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abf26f89bd4c11f7105fc3829792a5709"></a><!-- doxytag: member="CEGUI::Listbox::Listbox" ref="abf26f89bd4c11f7105fc3829792a5709" args="(const String &amp;type, const String &amp;name)" -->
 
186
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Listbox.html#abf26f89bd4c11f7105fc3829792a5709">Listbox</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &amp;type, const <a class="el" href="classCEGUI_1_1String.html">String</a> &amp;name)</td></tr>
 
187
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor for <a class="el" href="classCEGUI_1_1Listbox.html" title="Base class for standard Listbox widget.">Listbox</a> base class. <br/></td></tr>
 
188
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a28788370a870e00dfd98ebd24d882317"></a><!-- doxytag: member="CEGUI::Listbox::~Listbox" ref="a28788370a870e00dfd98ebd24d882317" args="(void)" -->
 
189
virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Listbox.html#a28788370a870e00dfd98ebd24d882317">~Listbox</a> (void)</td></tr>
 
190
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor for <a class="el" href="classCEGUI_1_1Listbox.html" title="Base class for standard Listbox widget.">Listbox</a> base class. <br/></td></tr>
 
191
<tr><td colspan="2"><h2><a name="pub-static-attribs"></a>
 
192
Static Public Attributes</h2></td></tr>
 
193
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acc300c28ae8ce655c452afa4b09da0db"></a><!-- doxytag: member="CEGUI::Listbox::EventNamespace" ref="acc300c28ae8ce655c452afa4b09da0db" args="" -->
 
194
static const <a class="el" href="classCEGUI_1_1String.html">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Listbox.html#acc300c28ae8ce655c452afa4b09da0db">EventNamespace</a></td></tr>
 
195
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Namespace for global events. <br/></td></tr>
 
196
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7f2becb073ff225fba6845f36eb7a5be"></a><!-- doxytag: member="CEGUI::Listbox::WidgetTypeName" ref="a7f2becb073ff225fba6845f36eb7a5be" args="" -->
 
197
static const <a class="el" href="classCEGUI_1_1String.html">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Listbox.html#a7f2becb073ff225fba6845f36eb7a5be">WidgetTypeName</a></td></tr>
 
198
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight"><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> factory name. <br/></td></tr>
 
199
<tr><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="classCEGUI_1_1String.html">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Listbox.html#a5637852660132d350794ff4b6732adab">EventListContentsChanged</a></td></tr>
 
200
<tr><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="classCEGUI_1_1String.html">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Listbox.html#afa8eb049e685967f9639ecd81c44bccb">EventSelectionChanged</a></td></tr>
 
201
<tr><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="classCEGUI_1_1String.html">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Listbox.html#af33bcee37ec79863bb3f818466bbcb33">EventSortModeChanged</a></td></tr>
 
202
<tr><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="classCEGUI_1_1String.html">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Listbox.html#aa5ca97065346dc98f56a35c0e390180a">EventMultiselectModeChanged</a></td></tr>
 
203
<tr><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="classCEGUI_1_1String.html">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Listbox.html#ab6439b5d836b09c44ff941a15ee188b9">EventVertScrollbarModeChanged</a></td></tr>
 
204
<tr><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="classCEGUI_1_1String.html">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Listbox.html#abc2bd4a37317867eb6c2509e2695d116">EventHorzScrollbarModeChanged</a></td></tr>
 
205
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3ba9b33426cabc35f79cbcebbd835673"></a><!-- doxytag: member="CEGUI::Listbox::VertScrollbarNameSuffix" ref="a3ba9b33426cabc35f79cbcebbd835673" args="" -->
 
206
static const <a class="el" href="classCEGUI_1_1String.html">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Listbox.html#a3ba9b33426cabc35f79cbcebbd835673">VertScrollbarNameSuffix</a></td></tr>
 
207
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Widget name suffix for the vertical scrollbar component. <br/></td></tr>
 
208
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adb7ad46671788f16e61dc576f74755f6"></a><!-- doxytag: member="CEGUI::Listbox::HorzScrollbarNameSuffix" ref="adb7ad46671788f16e61dc576f74755f6" args="" -->
 
209
static const <a class="el" href="classCEGUI_1_1String.html">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Listbox.html#adb7ad46671788f16e61dc576f74755f6">HorzScrollbarNameSuffix</a></td></tr>
 
210
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Widget name suffix for the horizontal scrollbar component. <br/></td></tr>
 
211
<tr><td colspan="2"><h2><a name="pro-types"></a>
 
212
Protected Types</h2></td></tr>
 
213
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3cbc4f47da1c7670d32dba75066ff6f8"></a><!-- doxytag: member="CEGUI::Listbox::LBItemList" ref="a3cbc4f47da1c7670d32dba75066ff6f8" args="" -->
 
214
typedef std::vector<br class="typebreak"/>
 
215
&lt; <a class="el" href="classCEGUI_1_1ListboxItem.html">ListboxItem</a> * &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>LBItemList</b></td></tr>
 
216
<tr><td colspan="2"><h2><a name="pro-methods"></a>
 
217
Protected Member Functions</h2></td></tr>
 
218
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Listbox.html#a7bf07d3fb3d377e9cfdf7abccb0a7639">configureScrollbars</a> (void)</td></tr>
 
219
<tr><td class="mdescLeft">&#160;</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="#a7bf07d3fb3d377e9cfdf7abccb0a7639"></a><br/></td></tr>
 
220
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aee569f4a1019442507c5b9c6f019087e"></a><!-- doxytag: member="CEGUI::Listbox::selectRange" ref="aee569f4a1019442507c5b9c6f019087e" args="(size_t start, size_t end)" -->
 
221
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Listbox.html#aee569f4a1019442507c5b9c6f019087e">selectRange</a> (size_t start, size_t end)</td></tr>
 
222
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">select all strings between positions <em>start</em> and <em>end</em>. (inclusive) including <em>end</em>. <br/></td></tr>
 
223
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Listbox.html#ac9f702445fa0e838a3b94d3e2c54a41d">clearAllSelections_impl</a> (void)</td></tr>
 
224
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Clear the selected state for all items (implementation)  <a href="#ac9f702445fa0e838a3b94d3e2c54a41d"></a><br/></td></tr>
 
225
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Listbox.html#ab81a40b1c41433102b12de0600fc0567">resetList_impl</a> (void)</td></tr>
 
226
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Remove all items from the list.  <a href="#ab81a40b1c41433102b12de0600fc0567"></a><br/></td></tr>
 
227
<tr><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Listbox.html#a0038b304b9174e6f39aae7189707d40d">testClassName_impl</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &amp;class_name) const </td></tr>
 
228
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Return whether this window was inherited from the given class name at some point in the inheritance hierarchy.  <a href="#a0038b304b9174e6f39aae7189707d40d"></a><br/></td></tr>
 
229
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a769fa144cc16b9314f24d80345bb0ef7"></a><!-- doxytag: member="CEGUI::Listbox::handle_scrollChange" ref="a769fa144cc16b9314f24d80345bb0ef7" args="(const EventArgs &amp;args)" -->
 
230
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Listbox.html#a769fa144cc16b9314f24d80345bb0ef7">handle_scrollChange</a> (const <a class="el" href="classCEGUI_1_1EventArgs.html">EventArgs</a> &amp;args)</td></tr>
 
231
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Internal handler that is triggered when the user interacts with the scrollbars. <br/></td></tr>
 
232
<tr><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Listbox.html#aa7c00b73d01592fc01b8a7fca9df4c56">validateWindowRenderer</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &amp;name) const </td></tr>
 
233
<tr><td class="mdescLeft">&#160;</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="#aa7c00b73d01592fc01b8a7fca9df4c56"></a><br/></td></tr>
 
234
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa7c0ead346cdc1ce7ed89d0979abd19b"></a><!-- doxytag: member="CEGUI::Listbox::resortList" ref="aa7c0ead346cdc1ce7ed89d0979abd19b" args="()" -->
 
235
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Listbox.html#aa7c0ead346cdc1ce7ed89d0979abd19b">resortList</a> ()</td></tr>
 
236
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Causes the internal list to be (re)sorted. <br/></td></tr>
 
237
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6a0337ae71ad608d00e8c476b066c700"></a><!-- doxytag: member="CEGUI::Listbox::onListContentsChanged" ref="a6a0337ae71ad608d00e8c476b066c700" args="(WindowEventArgs &amp;e)" -->
 
238
virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Listbox.html#a6a0337ae71ad608d00e8c476b066c700">onListContentsChanged</a> (<a class="el" href="classCEGUI_1_1WindowEventArgs.html">WindowEventArgs</a> &amp;e)</td></tr>
 
239
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Handler called internally when the list contents are changed. <br/></td></tr>
 
240
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afe05bd6d7b7bb68db3031253f46aa7b3"></a><!-- doxytag: member="CEGUI::Listbox::onSelectionChanged" ref="afe05bd6d7b7bb68db3031253f46aa7b3" args="(WindowEventArgs &amp;e)" -->
 
241
virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Listbox.html#afe05bd6d7b7bb68db3031253f46aa7b3">onSelectionChanged</a> (<a class="el" href="classCEGUI_1_1WindowEventArgs.html">WindowEventArgs</a> &amp;e)</td></tr>
 
242
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Handler called internally when the currently selected item or items changes. <br/></td></tr>
 
243
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aca69c5e34cd5b4110a1814740b442cea"></a><!-- doxytag: member="CEGUI::Listbox::onSortModeChanged" ref="aca69c5e34cd5b4110a1814740b442cea" args="(WindowEventArgs &amp;e)" -->
 
244
virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Listbox.html#aca69c5e34cd5b4110a1814740b442cea">onSortModeChanged</a> (<a class="el" href="classCEGUI_1_1WindowEventArgs.html">WindowEventArgs</a> &amp;e)</td></tr>
 
245
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Handler called internally when the sort mode setting changes. <br/></td></tr>
 
246
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0b56f57a0b9846b214f0d40486d77713"></a><!-- doxytag: member="CEGUI::Listbox::onMultiselectModeChanged" ref="a0b56f57a0b9846b214f0d40486d77713" args="(WindowEventArgs &amp;e)" -->
 
247
virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Listbox.html#a0b56f57a0b9846b214f0d40486d77713">onMultiselectModeChanged</a> (<a class="el" href="classCEGUI_1_1WindowEventArgs.html">WindowEventArgs</a> &amp;e)</td></tr>
 
248
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Handler called internally when the multi-select mode setting changes. <br/></td></tr>
 
249
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a809aa41cbbae894ac0c4f377cdb4ca5b"></a><!-- doxytag: member="CEGUI::Listbox::onVertScrollbarModeChanged" ref="a809aa41cbbae894ac0c4f377cdb4ca5b" args="(WindowEventArgs &amp;e)" -->
 
250
virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Listbox.html#a809aa41cbbae894ac0c4f377cdb4ca5b">onVertScrollbarModeChanged</a> (<a class="el" href="classCEGUI_1_1WindowEventArgs.html">WindowEventArgs</a> &amp;e)</td></tr>
 
251
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Handler called internally when the forced display of the vertical scroll bar setting changes. <br/></td></tr>
 
252
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa5b44de06458b8438af9d10b5cc4a74e"></a><!-- doxytag: member="CEGUI::Listbox::onHorzScrollbarModeChanged" ref="aa5b44de06458b8438af9d10b5cc4a74e" args="(WindowEventArgs &amp;e)" -->
 
253
virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Listbox.html#aa5b44de06458b8438af9d10b5cc4a74e">onHorzScrollbarModeChanged</a> (<a class="el" href="classCEGUI_1_1WindowEventArgs.html">WindowEventArgs</a> &amp;e)</td></tr>
 
254
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Handler called internally when the forced display of the horizontal scroll bar setting changes. <br/></td></tr>
 
255
<tr><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Listbox.html#ac96223dd6d25af0e3c8d8ff2745e3d13">onSized</a> (<a class="el" href="classCEGUI_1_1WindowEventArgs.html">WindowEventArgs</a> &amp;e)</td></tr>
 
256
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Handler called when the window's size changes.  <a href="#ac96223dd6d25af0e3c8d8ff2745e3d13"></a><br/></td></tr>
 
257
<tr><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Listbox.html#a28a206ab1bd912843155dfedc8af6f8f">onMouseButtonDown</a> (<a class="el" href="classCEGUI_1_1MouseEventArgs.html">MouseEventArgs</a> &amp;e)</td></tr>
 
258
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Handler called when a mouse button has been depressed within this window's area.  <a href="#a28a206ab1bd912843155dfedc8af6f8f"></a><br/></td></tr>
 
259
<tr><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Listbox.html#ace000a7ac20ef6333e8d4d585ed4d04f">onMouseWheel</a> (<a class="el" href="classCEGUI_1_1MouseEventArgs.html">MouseEventArgs</a> &amp;e)</td></tr>
 
260
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Handler called when the mouse wheel (z-axis) position changes within this window's area.  <a href="#ace000a7ac20ef6333e8d4d585ed4d04f"></a><br/></td></tr>
 
261
<tr><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Listbox.html#af00477dcc392f47d45ec8559f5911e51">onMouseMove</a> (<a class="el" href="classCEGUI_1_1MouseEventArgs.html">MouseEventArgs</a> &amp;e)</td></tr>
 
262
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Handler called when the mouse cursor has been moved within this window's area.  <a href="#af00477dcc392f47d45ec8559f5911e51"></a><br/></td></tr>
 
263
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
 
264
Protected Attributes</h2></td></tr>
 
265
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab1d30d4731096d131cb6de25e38df5b3"></a><!-- doxytag: member="CEGUI::Listbox::d_sorted" ref="ab1d30d4731096d131cb6de25e38df5b3" args="" -->
 
266
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Listbox.html#ab1d30d4731096d131cb6de25e38df5b3">d_sorted</a></td></tr>
 
267
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">true if list is sorted <br/></td></tr>
 
268
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab3944cda62effe3149df982067650613"></a><!-- doxytag: member="CEGUI::Listbox::d_multiselect" ref="ab3944cda62effe3149df982067650613" args="" -->
 
269
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Listbox.html#ab3944cda62effe3149df982067650613">d_multiselect</a></td></tr>
 
270
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">true if multi-select is enabled <br/></td></tr>
 
271
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af09c1a4cbcc69ad8fa87da93509d3630"></a><!-- doxytag: member="CEGUI::Listbox::d_forceVertScroll" ref="af09c1a4cbcc69ad8fa87da93509d3630" args="" -->
 
272
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Listbox.html#af09c1a4cbcc69ad8fa87da93509d3630">d_forceVertScroll</a></td></tr>
 
273
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">true if vertical scrollbar should always be displayed <br/></td></tr>
 
274
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aadb6b273b2f99d26d1639dded99ede1a"></a><!-- doxytag: member="CEGUI::Listbox::d_forceHorzScroll" ref="aadb6b273b2f99d26d1639dded99ede1a" args="" -->
 
275
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Listbox.html#aadb6b273b2f99d26d1639dded99ede1a">d_forceHorzScroll</a></td></tr>
 
276
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">true if horizontal scrollbar should always be displayed <br/></td></tr>
 
277
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5f1a29ca109ffc4d72a38d74182fd087"></a><!-- doxytag: member="CEGUI::Listbox::d_itemTooltips" ref="a5f1a29ca109ffc4d72a38d74182fd087" args="" -->
 
278
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Listbox.html#a5f1a29ca109ffc4d72a38d74182fd087">d_itemTooltips</a></td></tr>
 
279
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">true if each item should have an individual tooltip <br/></td></tr>
 
280
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a32c2142ea7b23c22f765b0bd48569981"></a><!-- doxytag: member="CEGUI::Listbox::d_listItems" ref="a32c2142ea7b23c22f765b0bd48569981" args="" -->
 
281
LBItemList&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Listbox.html#a32c2142ea7b23c22f765b0bd48569981">d_listItems</a></td></tr>
 
282
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">list of items in the list box. <br/></td></tr>
 
283
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abb45ab75c5f301f61d0d45128c2d6e98"></a><!-- doxytag: member="CEGUI::Listbox::d_lastSelected" ref="abb45ab75c5f301f61d0d45128c2d6e98" args="" -->
 
284
<a class="el" href="classCEGUI_1_1ListboxItem.html">ListboxItem</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Listbox.html#abb45ab75c5f301f61d0d45128c2d6e98">d_lastSelected</a></td></tr>
 
285
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">holds pointer to the last selected item (used in range selections) <br/></td></tr>
 
286
<tr><td colspan="2"><h2><a name="friends"></a>
 
287
Friends</h2></td></tr>
 
288
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ace277e6463fea54a9347ecc366a5e43f"></a><!-- doxytag: member="CEGUI::Listbox::ListboxWindowRenderer" ref="ace277e6463fea54a9347ecc366a5e43f" args="" -->
 
289
class&#160;</td><td class="memItemRight" valign="bottom"><b>ListboxWindowRenderer</b></td></tr>
 
290
</table>
 
291
<hr/><a name="_details"></a><h2>Detailed Description</h2>
 
292
<p>Base class for standard <a class="el" href="classCEGUI_1_1Listbox.html" title="Base class for standard Listbox widget.">Listbox</a> widget. </p>
 
293
<hr/><h2>Member Function Documentation</h2>
 
294
<a class="anchor" id="a86b3e614b9e70bb0e89c368ddbd17316"></a><!-- doxytag: member="CEGUI::Listbox::addItem" ref="a86b3e614b9e70bb0e89c368ddbd17316" args="(ListboxItem *item)" -->
 
295
<div class="memitem">
 
296
<div class="memproto">
 
297
      <table class="memname">
 
298
        <tr>
 
299
          <td class="memname">void CEGUI::Listbox::addItem </td>
 
300
          <td>(</td>
 
301
          <td class="paramtype"><a class="el" href="classCEGUI_1_1ListboxItem.html">ListboxItem</a> *&#160;</td>
 
302
          <td class="paramname"> <em>item</em>&#160;)</td>
 
303
          <td></td>
 
304
        </tr>
 
305
      </table>
 
306
</div>
 
307
<div class="memdoc">
 
308
 
 
309
<p>Add the given <a class="el" href="classCEGUI_1_1ListboxItem.html" title="Base class for list box items.">ListboxItem</a> to the list. </p>
 
310
<dl><dt><b>Parameters:</b></dt><dd>
 
311
  <table class="params">
 
312
    <tr><td class="paramname">item</td><td>Pointer to the <a class="el" href="classCEGUI_1_1ListboxItem.html" title="Base class for list box items.">ListboxItem</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>
 
313
  </table>
 
314
  </dd>
 
315
</dl>
 
316
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
 
317
 
 
318
</div>
 
319
</div>
 
320
<a class="anchor" id="a855f4d1bbe53cbab8ed95ab5b1312852"></a><!-- doxytag: member="CEGUI::Listbox::clearAllSelections" ref="a855f4d1bbe53cbab8ed95ab5b1312852" args="(void)" -->
 
321
<div class="memitem">
 
322
<div class="memproto">
 
323
      <table class="memname">
 
324
        <tr>
 
325
          <td class="memname">void CEGUI::Listbox::clearAllSelections </td>
 
326
          <td>(</td>
 
327
          <td class="paramtype">void&#160;</td>
 
328
          <td class="paramname">&#160;)</td>
 
329
          <td></td>
 
330
        </tr>
 
331
      </table>
 
332
</div>
 
333
<div class="memdoc">
 
334
 
 
335
<p>Clear the selected state for all items. </p>
 
336
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
 
337
 
 
338
</div>
 
339
</div>
 
340
<a class="anchor" id="ac9f702445fa0e838a3b94d3e2c54a41d"></a><!-- doxytag: member="CEGUI::Listbox::clearAllSelections_impl" ref="ac9f702445fa0e838a3b94d3e2c54a41d" args="(void)" -->
 
341
<div class="memitem">
 
342
<div class="memproto">
 
343
      <table class="memname">
 
344
        <tr>
 
345
          <td class="memname">bool CEGUI::Listbox::clearAllSelections_impl </td>
 
346
          <td>(</td>
 
347
          <td class="paramtype">void&#160;</td>
 
348
          <td class="paramname">&#160;)</td>
 
349
          <td><code> [protected]</code></td>
 
350
        </tr>
 
351
      </table>
 
352
</div>
 
353
<div class="memdoc">
 
354
 
 
355
<p>Clear the selected state for all items (implementation) </p>
 
356
<dl class="return"><dt><b>Returns:</b></dt><dd>true if some selections were cleared, false nothing was changed. </dd></dl>
 
357
 
 
358
</div>
 
359
</div>
 
360
<a class="anchor" id="a7bf07d3fb3d377e9cfdf7abccb0a7639"></a><!-- doxytag: member="CEGUI::Listbox::configureScrollbars" ref="a7bf07d3fb3d377e9cfdf7abccb0a7639" args="(void)" -->
 
361
<div class="memitem">
 
362
<div class="memproto">
 
363
      <table class="memname">
 
364
        <tr>
 
365
          <td class="memname">void CEGUI::Listbox::configureScrollbars </td>
 
366
          <td>(</td>
 
367
          <td class="paramtype">void&#160;</td>
 
368
          <td class="paramname">&#160;)</td>
 
369
          <td><code> [protected]</code></td>
 
370
        </tr>
 
371
      </table>
 
372
</div>
 
373
<div class="memdoc">
 
374
 
 
375
<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>
 
376
<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 area of 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> to be used for rendering list box items.</dd></dl>
 
377
<p>display required integrated scroll bars according to current state of the list box and update their values. </p>
 
378
 
 
379
</div>
 
380
</div>
 
381
<a class="anchor" id="a138911afbeead634f3f5d6b7d376c809"></a><!-- doxytag: member="CEGUI::Listbox::ensureItemIsVisible" ref="a138911afbeead634f3f5d6b7d376c809" args="(size_t item_index)" -->
 
382
<div class="memitem">
 
383
<div class="memproto">
 
384
      <table class="memname">
 
385
        <tr>
 
386
          <td class="memname">void CEGUI::Listbox::ensureItemIsVisible </td>
 
387
          <td>(</td>
 
388
          <td class="paramtype">size_t&#160;</td>
 
389
          <td class="paramname"> <em>item_index</em>&#160;)</td>
 
390
          <td></td>
 
391
        </tr>
 
392
      </table>
 
393
</div>
 
394
<div class="memdoc">
 
395
 
 
396
<p>Ensure the item at the specified index is visible within the list box. </p>
 
397
<dl><dt><b>Parameters:</b></dt><dd>
 
398
  <table class="params">
 
399
    <tr><td class="paramname">item_index</td><td>Zero based index of the item to be made visible in the list box. If this value is out of range, the list is always scrolled to the bottom.</td></tr>
 
400
  </table>
 
401
  </dd>
 
402
</dl>
 
403
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
 
404
 
 
405
</div>
 
406
</div>
 
407
<a class="anchor" id="a63d408d2bcbefda06fbc8b6ebbd9dca7"></a><!-- doxytag: member="CEGUI::Listbox::ensureItemIsVisible" ref="a63d408d2bcbefda06fbc8b6ebbd9dca7" args="(const ListboxItem *item)" -->
 
408
<div class="memitem">
 
409
<div class="memproto">
 
410
      <table class="memname">
 
411
        <tr>
 
412
          <td class="memname">void CEGUI::Listbox::ensureItemIsVisible </td>
 
413
          <td>(</td>
 
414
          <td class="paramtype">const <a class="el" href="classCEGUI_1_1ListboxItem.html">ListboxItem</a> *&#160;</td>
 
415
          <td class="paramname"> <em>item</em>&#160;)</td>
 
416
          <td></td>
 
417
        </tr>
 
418
      </table>
 
419
</div>
 
420
<div class="memdoc">
 
421
 
 
422
<p>Ensure the item at the specified index is visible within the list box. </p>
 
423
<dl><dt><b>Parameters:</b></dt><dd>
 
424
  <table class="params">
 
425
    <tr><td class="paramname">item</td><td>Pointer to the <a class="el" href="classCEGUI_1_1ListboxItem.html" title="Base class for list box items.">ListboxItem</a> to be made visible in the list box.</td></tr>
 
426
  </table>
 
427
  </dd>
 
428
</dl>
 
429
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing.</dd></dl>
 
430
<dl><dt><b>Exceptions:</b></dt><dd>
 
431
  <table class="exception">
 
432
    <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>
 
433
  </table>
 
434
  </dd>
 
435
</dl>
 
436
 
 
437
</div>
 
438
</div>
 
439
<a class="anchor" id="a8e543ad0432bbdda06781d82a70ac0f3"></a><!-- doxytag: member="CEGUI::Listbox::findItemWithText" ref="a8e543ad0432bbdda06781d82a70ac0f3" args="(const String &amp;text, const ListboxItem *start_item)" -->
 
440
<div class="memitem">
 
441
<div class="memproto">
 
442
      <table class="memname">
 
443
        <tr>
 
444
          <td class="memname"><a class="el" href="classCEGUI_1_1ListboxItem.html">ListboxItem</a>* CEGUI::Listbox::findItemWithText </td>
 
445
          <td>(</td>
 
446
          <td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> &amp;&#160;</td>
 
447
          <td class="paramname"> <em>text</em>, </td>
 
448
        </tr>
 
449
        <tr>
 
450
          <td class="paramkey"></td>
 
451
          <td></td>
 
452
          <td class="paramtype">const <a class="el" href="classCEGUI_1_1ListboxItem.html">ListboxItem</a> *&#160;</td>
 
453
          <td class="paramname"> <em>start_item</em>&#160;</td>
 
454
        </tr>
 
455
        <tr>
 
456
          <td></td>
 
457
          <td>)</td>
 
458
          <td></td><td></td>
 
459
        </tr>
 
460
      </table>
 
461
</div>
 
462
<div class="memdoc">
 
463
 
 
464
<p>Search the list for an item with the specified text. </p>
 
465
<dl><dt><b>Parameters:</b></dt><dd>
 
466
  <table class="params">
 
467
    <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>
 
468
    <tr><td class="paramname">start_item</td><td><a class="el" href="classCEGUI_1_1ListboxItem.html" title="Base class for list box items.">ListboxItem</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>
 
469
  </table>
 
470
  </dd>
 
471
</dl>
 
472
<dl class="return"><dt><b>Returns:</b></dt><dd>Pointer to the first <a class="el" href="classCEGUI_1_1ListboxItem.html" title="Base class for list box items.">ListboxItem</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>
 
473
<dl><dt><b>Exceptions:</b></dt><dd>
 
474
  <table class="exception">
 
475
    <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>
 
476
  </table>
 
477
  </dd>
 
478
</dl>
 
479
 
 
480
</div>
 
481
</div>
 
482
<a class="anchor" id="a9622ad2ae98d3e58fac555d8fee17191"></a><!-- doxytag: member="CEGUI::Listbox::getFirstSelectedItem" ref="a9622ad2ae98d3e58fac555d8fee17191" args="(void) const " -->
 
483
<div class="memitem">
 
484
<div class="memproto">
 
485
      <table class="memname">
 
486
        <tr>
 
487
          <td class="memname"><a class="el" href="classCEGUI_1_1ListboxItem.html">ListboxItem</a>* CEGUI::Listbox::getFirstSelectedItem </td>
 
488
          <td>(</td>
 
489
          <td class="paramtype">void&#160;</td>
 
490
          <td class="paramname">&#160;)</td>
 
491
          <td> const</td>
 
492
        </tr>
 
493
      </table>
 
494
</div>
 
495
<div class="memdoc">
 
496
 
 
497
<p>Return a pointer to the first selected item. </p>
 
498
<dl class="return"><dt><b>Returns:</b></dt><dd>Pointer to a <a class="el" href="classCEGUI_1_1ListboxItem.html" title="Base class for list box items.">ListboxItem</a> based object that is the first selected item in the list. will return NULL if no item is selected. </dd></dl>
 
499
 
 
500
</div>
 
501
</div>
 
502
<a class="anchor" id="ad2dae35017cb934b938facf39ea56b41"></a><!-- doxytag: member="CEGUI::Listbox::getHorzScrollbar" ref="ad2dae35017cb934b938facf39ea56b41" args="() const " -->
 
503
<div class="memitem">
 
504
<div class="memproto">
 
505
      <table class="memname">
 
506
        <tr>
 
507
          <td class="memname"><a class="el" href="classCEGUI_1_1Scrollbar.html">Scrollbar</a>* CEGUI::Listbox::getHorzScrollbar </td>
 
508
          <td>(</td>
 
509
          <td class="paramname">&#160;)</td>
 
510
          <td> const</td>
 
511
        </tr>
 
512
      </table>
 
513
</div>
 
514
<div class="memdoc">
 
515
 
 
516
<p>Return a pointer to the horizontal scrollbar component widget for this <a class="el" href="classCEGUI_1_1Listbox.html" title="Base class for standard Listbox widget.">Listbox</a>. </p>
 
517
<dl class="return"><dt><b>Returns:</b></dt><dd>Pointer to a <a class="el" href="classCEGUI_1_1Scrollbar.html" title="Base scroll bar class.">Scrollbar</a> object.</dd></dl>
 
518
<dl><dt><b>Exceptions:</b></dt><dd>
 
519
  <table class="exception">
 
520
    <tr><td class="paramname"><a class="el" href="classCEGUI_1_1UnknownObjectException.html" title="Exception class used when a request was made for an unknown object.">UnknownObjectException</a></td><td>Thrown if the horizontal <a class="el" href="classCEGUI_1_1Scrollbar.html" title="Base scroll bar class.">Scrollbar</a> component does not exist. </td></tr>
 
521
  </table>
 
522
  </dd>
 
523
</dl>
 
524
 
 
525
</div>
 
526
</div>
 
527
<a class="anchor" id="aa94cde3135645116f321d232f3919fb4"></a><!-- doxytag: member="CEGUI::Listbox::getItemAtPoint" ref="aa94cde3135645116f321d232f3919fb4" args="(const Point &amp;pt) const " -->
 
528
<div class="memitem">
 
529
<div class="memproto">
 
530
      <table class="memname">
 
531
        <tr>
 
532
          <td class="memname"><a class="el" href="classCEGUI_1_1ListboxItem.html">ListboxItem</a>* CEGUI::Listbox::getItemAtPoint </td>
 
533
          <td>(</td>
 
534
          <td class="paramtype">const <a class="el" href="classCEGUI_1_1Vector2.html">Point</a> &amp;&#160;</td>
 
535
          <td class="paramname"> <em>pt</em>&#160;)</td>
 
536
          <td> const</td>
 
537
        </tr>
 
538
      </table>
 
539
</div>
 
540
<div class="memdoc">
 
541
 
 
542
<p>Return a pointer to the <a class="el" href="classCEGUI_1_1ListboxItem.html" title="Base class for list box items.">ListboxItem</a> attached to this <a class="el" href="classCEGUI_1_1Listbox.html" title="Base class for standard Listbox widget.">Listbox</a> at the given screen pixel co-ordinate. </p>
 
543
<dl class="return"><dt><b>Returns:</b></dt><dd>Pointer to the <a class="el" href="classCEGUI_1_1ListboxItem.html" title="Base class for list box items.">ListboxItem</a> attached to this <a class="el" href="classCEGUI_1_1Listbox.html" title="Base class for standard Listbox widget.">Listbox</a> that is at screen position <em>pt</em>, or 0 if no <a class="el" href="classCEGUI_1_1ListboxItem.html" title="Base class for list box items.">ListboxItem</a> attached to this <a class="el" href="classCEGUI_1_1Listbox.html" title="Base class for standard Listbox widget.">Listbox</a> is at that position. </dd></dl>
 
544
 
 
545
</div>
 
546
</div>
 
547
<a class="anchor" id="ac27fb510288515009d43ec7cfb42bfcf"></a><!-- doxytag: member="CEGUI::Listbox::getItemCount" ref="ac27fb510288515009d43ec7cfb42bfcf" args="(void) const " -->
 
548
<div class="memitem">
 
549
<div class="memproto">
 
550
      <table class="memname">
 
551
        <tr>
 
552
          <td class="memname">size_t CEGUI::Listbox::getItemCount </td>
 
553
          <td>(</td>
 
554
          <td class="paramtype">void&#160;</td>
 
555
          <td class="paramname">&#160;)</td>
 
556
          <td> const<code> [inline]</code></td>
 
557
        </tr>
 
558
      </table>
 
559
</div>
 
560
<div class="memdoc">
 
561
 
 
562
<p>Return number of items attached to the list box. </p>
 
563
<dl class="return"><dt><b>Returns:</b></dt><dd>the number of items currently attached to this list box. </dd></dl>
 
564
 
 
565
</div>
 
566
</div>
 
567
<a class="anchor" id="aaea9cf33ecf30eb1c3e2e8421748761e"></a><!-- doxytag: member="CEGUI::Listbox::getItemIndex" ref="aaea9cf33ecf30eb1c3e2e8421748761e" args="(const ListboxItem *item) const " -->
 
568
<div class="memitem">
 
569
<div class="memproto">
 
570
      <table class="memname">
 
571
        <tr>
 
572
          <td class="memname">size_t CEGUI::Listbox::getItemIndex </td>
 
573
          <td>(</td>
 
574
          <td class="paramtype">const <a class="el" href="classCEGUI_1_1ListboxItem.html">ListboxItem</a> *&#160;</td>
 
575
          <td class="paramname"> <em>item</em>&#160;)</td>
 
576
          <td> const</td>
 
577
        </tr>
 
578
      </table>
 
579
</div>
 
580
<div class="memdoc">
 
581
 
 
582
<p>Return the index of <a class="el" href="classCEGUI_1_1ListboxItem.html" title="Base class for list box items.">ListboxItem</a> <em>item</em>. </p>
 
583
<dl><dt><b>Parameters:</b></dt><dd>
 
584
  <table class="params">
 
585
    <tr><td class="paramname">item</td><td>Pointer to a <a class="el" href="classCEGUI_1_1ListboxItem.html" title="Base class for list box items.">ListboxItem</a> whos zero based index is to be returned.</td></tr>
 
586
  </table>
 
587
  </dd>
 
588
</dl>
 
589
<dl class="return"><dt><b>Returns:</b></dt><dd>Zero based index indicating the position of <a class="el" href="classCEGUI_1_1ListboxItem.html" title="Base class for list box items.">ListboxItem</a> <em>item</em> in the list box.</dd></dl>
 
590
<dl><dt><b>Exceptions:</b></dt><dd>
 
591
  <table class="exception">
 
592
    <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>
 
593
  </table>
 
594
  </dd>
 
595
</dl>
 
596
 
 
597
</div>
 
598
</div>
 
599
<a class="anchor" id="a7ff0dfdb9797c09d2b3803d0976672f2"></a><!-- doxytag: member="CEGUI::Listbox::getListboxItemFromIndex" ref="a7ff0dfdb9797c09d2b3803d0976672f2" args="(size_t index) const " -->
 
600
<div class="memitem">
 
601
<div class="memproto">
 
602
      <table class="memname">
 
603
        <tr>
 
604
          <td class="memname"><a class="el" href="classCEGUI_1_1ListboxItem.html">ListboxItem</a>* CEGUI::Listbox::getListboxItemFromIndex </td>
 
605
          <td>(</td>
 
606
          <td class="paramtype">size_t&#160;</td>
 
607
          <td class="paramname"> <em>index</em>&#160;)</td>
 
608
          <td> const</td>
 
609
        </tr>
 
610
      </table>
 
611
</div>
 
612
<div class="memdoc">
 
613
 
 
614
<p>Return the item at index position <em>index</em>. </p>
 
615
<dl><dt><b>Parameters:</b></dt><dd>
 
616
  <table class="params">
 
617
    <tr><td class="paramname">index</td><td>Zero based index of the item to be returned.</td></tr>
 
618
  </table>
 
619
  </dd>
 
620
</dl>
 
621
<dl class="return"><dt><b>Returns:</b></dt><dd>Pointer to the <a class="el" href="classCEGUI_1_1ListboxItem.html" title="Base class for list box items.">ListboxItem</a> at index position <em>index</em> in the list box.</dd></dl>
 
622
<dl><dt><b>Exceptions:</b></dt><dd>
 
623
  <table class="exception">
 
624
    <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>
 
625
  </table>
 
626
  </dd>
 
627
</dl>
 
628
 
 
629
</div>
 
630
</div>
 
631
<a class="anchor" id="ab1b48abe760fd1bcf0269b79b2e99555"></a><!-- doxytag: member="CEGUI::Listbox::getListRenderArea" ref="ab1b48abe760fd1bcf0269b79b2e99555" args="(void) const " -->
 
632
<div class="memitem">
 
633
<div class="memproto">
 
634
      <table class="memname">
 
635
        <tr>
 
636
          <td class="memname">virtual <a class="el" href="classCEGUI_1_1Rect.html">Rect</a> CEGUI::Listbox::getListRenderArea </td>
 
637
          <td>(</td>
 
638
          <td class="paramtype">void&#160;</td>
 
639
          <td class="paramname">&#160;)</td>
 
640
          <td> const<code> [virtual]</code></td>
 
641
        </tr>
 
642
      </table>
 
643
</div>
 
644
<div class="memdoc">
 
645
 
 
646
<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>
 
647
<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 area of 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> to be used for rendering list box items. </dd></dl>
 
648
 
 
649
</div>
 
650
</div>
 
651
<a class="anchor" id="a93ab5ca738ed2b94ac14e464a45a2e6a"></a><!-- doxytag: member="CEGUI::Listbox::getNextSelected" ref="a93ab5ca738ed2b94ac14e464a45a2e6a" args="(const ListboxItem *start_item) const " -->
 
652
<div class="memitem">
 
653
<div class="memproto">
 
654
      <table class="memname">
 
655
        <tr>
 
656
          <td class="memname"><a class="el" href="classCEGUI_1_1ListboxItem.html">ListboxItem</a>* CEGUI::Listbox::getNextSelected </td>
 
657
          <td>(</td>
 
658
          <td class="paramtype">const <a class="el" href="classCEGUI_1_1ListboxItem.html">ListboxItem</a> *&#160;</td>
 
659
          <td class="paramname"> <em>start_item</em>&#160;)</td>
 
660
          <td> const</td>
 
661
        </tr>
 
662
      </table>
 
663
</div>
 
664
<div class="memdoc">
 
665
 
 
666
<p>Return a pointer to the next selected item after item <em>start_item</em>. </p>
 
667
<dl><dt><b>Parameters:</b></dt><dd>
 
668
  <table class="params">
 
669
    <tr><td class="paramname">start_item</td><td>Pointer to the <a class="el" href="classCEGUI_1_1ListboxItem.html" title="Base class for list box items.">ListboxItem</a> where the search for the next selected item is to begin. If this parameter is NULL, the search will begin with the first item in the list box.</td></tr>
 
670
  </table>
 
671
  </dd>
 
672
</dl>
 
673
<dl class="return"><dt><b>Returns:</b></dt><dd>Pointer to a <a class="el" href="classCEGUI_1_1ListboxItem.html" title="Base class for list box items.">ListboxItem</a> based object that is the next selected item in the list after the item specified by <em>start_item</em>. Will return NULL if no further items were selected.</dd></dl>
 
674
<dl><dt><b>Exceptions:</b></dt><dd>
 
675
  <table class="exception">
 
676
    <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>start_item</em> is not attached to this list box. </td></tr>
 
677
  </table>
 
678
  </dd>
 
679
</dl>
 
680
 
 
681
</div>
 
682
</div>
 
683
<a class="anchor" id="afe5e12f55912979d9c563b6d1d5292ad"></a><!-- doxytag: member="CEGUI::Listbox::getSelectedCount" ref="afe5e12f55912979d9c563b6d1d5292ad" args="(void) const " -->
 
684
<div class="memitem">
 
685
<div class="memproto">
 
686
      <table class="memname">
 
687
        <tr>
 
688
          <td class="memname">size_t CEGUI::Listbox::getSelectedCount </td>
 
689
          <td>(</td>
 
690
          <td class="paramtype">void&#160;</td>
 
691
          <td class="paramname">&#160;)</td>
 
692
          <td> const</td>
 
693
        </tr>
 
694
      </table>
 
695
</div>
 
696
<div class="memdoc">
 
697
 
 
698
<p>Return the number of selected items in the list box. </p>
 
699
<dl class="return"><dt><b>Returns:</b></dt><dd>Total number of attached items that are in the selected state. </dd></dl>
 
700
 
 
701
</div>
 
702
</div>
 
703
<a class="anchor" id="aa8bdb140ffab153cb3506756f7ca2707"></a><!-- doxytag: member="CEGUI::Listbox::getVertScrollbar" ref="aa8bdb140ffab153cb3506756f7ca2707" args="() const " -->
 
704
<div class="memitem">
 
705
<div class="memproto">
 
706
      <table class="memname">
 
707
        <tr>
 
708
          <td class="memname"><a class="el" href="classCEGUI_1_1Scrollbar.html">Scrollbar</a>* CEGUI::Listbox::getVertScrollbar </td>
 
709
          <td>(</td>
 
710
          <td class="paramname">&#160;)</td>
 
711
          <td> const</td>
 
712
        </tr>
 
713
      </table>
 
714
</div>
 
715
<div class="memdoc">
 
716
 
 
717
<p>Return a pointer to the vertical scrollbar component widget for this <a class="el" href="classCEGUI_1_1Listbox.html" title="Base class for standard Listbox widget.">Listbox</a>. </p>
 
718
<dl class="return"><dt><b>Returns:</b></dt><dd>Pointer to a <a class="el" href="classCEGUI_1_1Scrollbar.html" title="Base scroll bar class.">Scrollbar</a> object.</dd></dl>
 
719
<dl><dt><b>Exceptions:</b></dt><dd>
 
720
  <table class="exception">
 
721
    <tr><td class="paramname"><a class="el" href="classCEGUI_1_1UnknownObjectException.html" title="Exception class used when a request was made for an unknown object.">UnknownObjectException</a></td><td>Thrown if the vertical <a class="el" href="classCEGUI_1_1Scrollbar.html" title="Base scroll bar class.">Scrollbar</a> component does not exist. </td></tr>
 
722
  </table>
 
723
  </dd>
 
724
</dl>
 
725
 
 
726
</div>
 
727
</div>
 
728
<a class="anchor" id="a8903860958694541f87997ce776d0eaa"></a><!-- doxytag: member="CEGUI::Listbox::handleUpdatedItemData" ref="a8903860958694541f87997ce776d0eaa" args="(void)" -->
 
729
<div class="memitem">
 
730
<div class="memproto">
 
731
      <table class="memname">
 
732
        <tr>
 
733
          <td class="memname">void CEGUI::Listbox::handleUpdatedItemData </td>
 
734
          <td>(</td>
 
735
          <td class="paramtype">void&#160;</td>
 
736
          <td class="paramname">&#160;)</td>
 
737
          <td></td>
 
738
        </tr>
 
739
      </table>
 
740
</div>
 
741
<div class="memdoc">
 
742
 
 
743
<p>Causes the list box to update it's internal state after changes have been made to one or more attached <a class="el" href="classCEGUI_1_1ListboxItem.html" title="Base class for list box items.">ListboxItem</a> objects. </p>
 
744
<p>Client code must call this whenever it has made any changes to <a class="el" href="classCEGUI_1_1ListboxItem.html" title="Base class for list box items.">ListboxItem</a> objects already attached to the list box. If you are just adding items, or removed items to update them prior to re-adding them, there is no need to call this method.</p>
 
745
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
 
746
 
 
747
</div>
 
748
</div>
 
749
<a class="anchor" id="a31a4dc42adca5d28af5f463c3a6efdda"></a><!-- doxytag: member="CEGUI::Listbox::initialiseComponents" ref="a31a4dc42adca5d28af5f463c3a6efdda" args="(void)" -->
 
750
<div class="memitem">
 
751
<div class="memproto">
 
752
      <table class="memname">
 
753
        <tr>
 
754
          <td class="memname">virtual void CEGUI::Listbox::initialiseComponents </td>
 
755
          <td>(</td>
 
756
          <td class="paramtype">void&#160;</td>
 
757
          <td class="paramname">&#160;)</td>
 
758
          <td><code> [virtual]</code></td>
 
759
        </tr>
 
760
      </table>
 
761
</div>
 
762
<div class="memdoc">
 
763
 
 
764
<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>
 
765
<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>
 
766
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing </dd></dl>
 
767
 
 
768
<p>Reimplemented from <a class="el" href="classCEGUI_1_1Window.html#a15d1b3c2be063277773eb28e33a2ee84">CEGUI::Window</a>.</p>
 
769
 
 
770
<p>Reimplemented in <a class="el" href="classCEGUI_1_1ComboDropList.html#aeb064f89fda76d6178a22135f20d6b68">CEGUI::ComboDropList</a>.</p>
 
771
 
 
772
</div>
 
773
</div>
 
774
<a class="anchor" id="a20611491f79faea7b40c72030e038d92"></a><!-- doxytag: member="CEGUI::Listbox::insertItem" ref="a20611491f79faea7b40c72030e038d92" args="(ListboxItem *item, const ListboxItem *position)" -->
 
775
<div class="memitem">
 
776
<div class="memproto">
 
777
      <table class="memname">
 
778
        <tr>
 
779
          <td class="memname">void CEGUI::Listbox::insertItem </td>
 
780
          <td>(</td>
 
781
          <td class="paramtype"><a class="el" href="classCEGUI_1_1ListboxItem.html">ListboxItem</a> *&#160;</td>
 
782
          <td class="paramname"> <em>item</em>, </td>
 
783
        </tr>
 
784
        <tr>
 
785
          <td class="paramkey"></td>
 
786
          <td></td>
 
787
          <td class="paramtype">const <a class="el" href="classCEGUI_1_1ListboxItem.html">ListboxItem</a> *&#160;</td>
 
788
          <td class="paramname"> <em>position</em>&#160;</td>
 
789
        </tr>
 
790
        <tr>
 
791
          <td></td>
 
792
          <td>)</td>
 
793
          <td></td><td></td>
 
794
        </tr>
 
795
      </table>
 
796
</div>
 
797
<div class="memdoc">
 
798
 
 
799
<p>Insert an item into the list box before a specified item already in the list. </p>
 
800
<p>Note that if the list is sorted, the item may not end up in the requested position.</p>
 
801
<dl><dt><b>Parameters:</b></dt><dd>
 
802
  <table class="params">
 
803
    <tr><td class="paramname">item</td><td>Pointer to the <a class="el" href="classCEGUI_1_1ListboxItem.html" title="Base class for list box items.">ListboxItem</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>
 
804
    <tr><td class="paramname">position</td><td>Pointer to a <a class="el" href="classCEGUI_1_1ListboxItem.html" title="Base class for list box items.">ListboxItem</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>
 
805
  </table>
 
806
  </dd>
 
807
</dl>
 
808
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing.</dd></dl>
 
809
<dl><dt><b>Exceptions:</b></dt><dd>
 
810
  <table class="exception">
 
811
    <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 no <a class="el" href="classCEGUI_1_1ListboxItem.html" title="Base class for list box items.">ListboxItem</a> <em>position</em> is attached to this list box. </td></tr>
 
812
  </table>
 
813
  </dd>
 
814
</dl>
 
815
 
 
816
</div>
 
817
</div>
 
818
<a class="anchor" id="afe2f4f39ffefe869f13c287c271b40bd"></a><!-- doxytag: member="CEGUI::Listbox::isHorzScrollbarAlwaysShown" ref="afe2f4f39ffefe869f13c287c271b40bd" args="(void) const " -->
 
819
<div class="memitem">
 
820
<div class="memproto">
 
821
      <table class="memname">
 
822
        <tr>
 
823
          <td class="memname">bool CEGUI::Listbox::isHorzScrollbarAlwaysShown </td>
 
824
          <td>(</td>
 
825
          <td class="paramtype">void&#160;</td>
 
826
          <td class="paramname">&#160;)</td>
 
827
          <td> const</td>
 
828
        </tr>
 
829
      </table>
 
830
</div>
 
831
<div class="memdoc">
 
832
 
 
833
<p>Return whether the horizontal scroll bar is always shown. </p>
 
834
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
 
835
<li>true if the scroll bar will always be shown even if it is not required.</li>
 
836
<li>false if the scroll bar will only be shown when it is required. </li>
 
837
</ul>
 
838
</dd></dl>
 
839
 
 
840
</div>
 
841
</div>
 
842
<a class="anchor" id="ad0dddf7866aaf0ff6862315702fb859d"></a><!-- doxytag: member="CEGUI::Listbox::isItemSelected" ref="ad0dddf7866aaf0ff6862315702fb859d" args="(size_t index) const " -->
 
843
<div class="memitem">
 
844
<div class="memproto">
 
845
      <table class="memname">
 
846
        <tr>
 
847
          <td class="memname">bool CEGUI::Listbox::isItemSelected </td>
 
848
          <td>(</td>
 
849
          <td class="paramtype">size_t&#160;</td>
 
850
          <td class="paramname"> <em>index</em>&#160;)</td>
 
851
          <td> const</td>
 
852
        </tr>
 
853
      </table>
 
854
</div>
 
855
<div class="memdoc">
 
856
 
 
857
<p>return whether the string at index position <em>index</em> is selected </p>
 
858
<dl><dt><b>Parameters:</b></dt><dd>
 
859
  <table class="params">
 
860
    <tr><td class="paramname">index</td><td>Zero based index of the item to be examined.</td></tr>
 
861
  </table>
 
862
  </dd>
 
863
</dl>
 
864
<dl class="return"><dt><b>Returns:</b></dt><dd>true if the item at <em>index</em> is selected, false if the item at <em>index</em> is not selected.</dd></dl>
 
865
<dl><dt><b>Exceptions:</b></dt><dd>
 
866
  <table class="exception">
 
867
    <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>
 
868
  </table>
 
869
  </dd>
 
870
</dl>
 
871
 
 
872
</div>
 
873
</div>
 
874
<a class="anchor" id="aac747ba199d28ffe28ac4227b30c099e"></a><!-- doxytag: member="CEGUI::Listbox::isListboxItemInList" ref="aac747ba199d28ffe28ac4227b30c099e" args="(const ListboxItem *item) const " -->
 
875
<div class="memitem">
 
876
<div class="memproto">
 
877
      <table class="memname">
 
878
        <tr>
 
879
          <td class="memname">bool CEGUI::Listbox::isListboxItemInList </td>
 
880
          <td>(</td>
 
881
          <td class="paramtype">const <a class="el" href="classCEGUI_1_1ListboxItem.html">ListboxItem</a> *&#160;</td>
 
882
          <td class="paramname"> <em>item</em>&#160;)</td>
 
883
          <td> const</td>
 
884
        </tr>
 
885
      </table>
 
886
</div>
 
887
<div class="memdoc">
 
888
 
 
889
<p>Return whether the specified <a class="el" href="classCEGUI_1_1ListboxItem.html" title="Base class for list box items.">ListboxItem</a> is in the List. </p>
 
890
<dl class="return"><dt><b>Returns:</b></dt><dd>true if <a class="el" href="classCEGUI_1_1ListboxItem.html" title="Base class for list box items.">ListboxItem</a> <em>item</em> is in the list, false if <a class="el" href="classCEGUI_1_1ListboxItem.html" title="Base class for list box items.">ListboxItem</a> <em>item</em> is not in the list. </dd></dl>
 
891
 
 
892
</div>
 
893
</div>
 
894
<a class="anchor" id="a0bd0e1f4dbf1b445b9fb8d0290ef5b1e"></a><!-- doxytag: member="CEGUI::Listbox::isMultiselectEnabled" ref="a0bd0e1f4dbf1b445b9fb8d0290ef5b1e" args="(void) const " -->
 
895
<div class="memitem">
 
896
<div class="memproto">
 
897
      <table class="memname">
 
898
        <tr>
 
899
          <td class="memname">bool CEGUI::Listbox::isMultiselectEnabled </td>
 
900
          <td>(</td>
 
901
          <td class="paramtype">void&#160;</td>
 
902
          <td class="paramname">&#160;)</td>
 
903
          <td> const<code> [inline]</code></td>
 
904
        </tr>
 
905
      </table>
 
906
</div>
 
907
<div class="memdoc">
 
908
 
 
909
<p>return whether multi-select is enabled </p>
 
910
<dl class="return"><dt><b>Returns:</b></dt><dd>true if multi-select is enabled, false if multi-select is not enabled. </dd></dl>
 
911
 
 
912
</div>
 
913
</div>
 
914
<a class="anchor" id="ac482b699cf93aed09b7dd6fe130aabeb"></a><!-- doxytag: member="CEGUI::Listbox::isSortEnabled" ref="ac482b699cf93aed09b7dd6fe130aabeb" args="(void) const " -->
 
915
<div class="memitem">
 
916
<div class="memproto">
 
917
      <table class="memname">
 
918
        <tr>
 
919
          <td class="memname">bool CEGUI::Listbox::isSortEnabled </td>
 
920
          <td>(</td>
 
921
          <td class="paramtype">void&#160;</td>
 
922
          <td class="paramname">&#160;)</td>
 
923
          <td> const<code> [inline]</code></td>
 
924
        </tr>
 
925
      </table>
 
926
</div>
 
927
<div class="memdoc">
 
928
 
 
929
<p>return whether list sorting is enabled </p>
 
930
<dl class="return"><dt><b>Returns:</b></dt><dd>true if the list is sorted, false if the list is not sorted </dd></dl>
 
931
 
 
932
</div>
 
933
</div>
 
934
<a class="anchor" id="a3570630d416062b28be786825c06e981"></a><!-- doxytag: member="CEGUI::Listbox::isVertScrollbarAlwaysShown" ref="a3570630d416062b28be786825c06e981" args="(void) const " -->
 
935
<div class="memitem">
 
936
<div class="memproto">
 
937
      <table class="memname">
 
938
        <tr>
 
939
          <td class="memname">bool CEGUI::Listbox::isVertScrollbarAlwaysShown </td>
 
940
          <td>(</td>
 
941
          <td class="paramtype">void&#160;</td>
 
942
          <td class="paramname">&#160;)</td>
 
943
          <td> const</td>
 
944
        </tr>
 
945
      </table>
 
946
</div>
 
947
<div class="memdoc">
 
948
 
 
949
<p>Return whether the vertical scroll bar is always shown. </p>
 
950
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
 
951
<li>true if the scroll bar will always be shown even if it is not required.</li>
 
952
<li>false if the scroll bar will only be shown when it is required. </li>
 
953
</ul>
 
954
</dd></dl>
 
955
 
 
956
</div>
 
957
</div>
 
958
<a class="anchor" id="a28a206ab1bd912843155dfedc8af6f8f"></a><!-- doxytag: member="CEGUI::Listbox::onMouseButtonDown" ref="a28a206ab1bd912843155dfedc8af6f8f" args="(MouseEventArgs &amp;e)" -->
 
959
<div class="memitem">
 
960
<div class="memproto">
 
961
      <table class="memname">
 
962
        <tr>
 
963
          <td class="memname">virtual void CEGUI::Listbox::onMouseButtonDown </td>
 
964
          <td>(</td>
 
965
          <td class="paramtype"><a class="el" href="classCEGUI_1_1MouseEventArgs.html">MouseEventArgs</a> &amp;&#160;</td>
 
966
          <td class="paramname"> <em>e</em>&#160;)</td>
 
967
          <td><code> [protected, virtual]</code></td>
 
968
        </tr>
 
969
      </table>
 
970
</div>
 
971
<div class="memdoc">
 
972
 
 
973
<p>Handler called when a mouse button has been depressed within this window's area. </p>
 
974
<dl><dt><b>Parameters:</b></dt><dd>
 
975
  <table class="params">
 
976
    <tr><td class="paramname">e</td><td><a class="el" href="classCEGUI_1_1MouseEventArgs.html" title="EventArgs based class that is used for objects passed to input event handlers concerning mouse input...">MouseEventArgs</a> object. All fields are valid. </td></tr>
 
977
  </table>
 
978
  </dd>
 
979
</dl>
 
980
 
 
981
<p>Reimplemented from <a class="el" href="classCEGUI_1_1Window.html#abb30780cd259d8328df6ff0809f8ce4a">CEGUI::Window</a>.</p>
 
982
 
 
983
<p>Reimplemented in <a class="el" href="classCEGUI_1_1ComboDropList.html#aaee9645fb1c2dae229a472ea49520f05">CEGUI::ComboDropList</a>.</p>
 
984
 
 
985
</div>
 
986
</div>
 
987
<a class="anchor" id="af00477dcc392f47d45ec8559f5911e51"></a><!-- doxytag: member="CEGUI::Listbox::onMouseMove" ref="af00477dcc392f47d45ec8559f5911e51" args="(MouseEventArgs &amp;e)" -->
 
988
<div class="memitem">
 
989
<div class="memproto">
 
990
      <table class="memname">
 
991
        <tr>
 
992
          <td class="memname">virtual void CEGUI::Listbox::onMouseMove </td>
 
993
          <td>(</td>
 
994
          <td class="paramtype"><a class="el" href="classCEGUI_1_1MouseEventArgs.html">MouseEventArgs</a> &amp;&#160;</td>
 
995
          <td class="paramname"> <em>e</em>&#160;)</td>
 
996
          <td><code> [protected, virtual]</code></td>
 
997
        </tr>
 
998
      </table>
 
999
</div>
 
1000
<div class="memdoc">
 
1001
 
 
1002
<p>Handler called when the mouse cursor has been moved within this window's area. </p>
 
1003
<dl><dt><b>Parameters:</b></dt><dd>
 
1004
  <table class="params">
 
1005
    <tr><td class="paramname">e</td><td><a class="el" href="classCEGUI_1_1MouseEventArgs.html" title="EventArgs based class that is used for objects passed to input event handlers concerning mouse input...">MouseEventArgs</a> object. All fields are valid. </td></tr>
 
1006
  </table>
 
1007
  </dd>
 
1008
</dl>
 
1009
 
 
1010
<p>Reimplemented from <a class="el" href="classCEGUI_1_1Window.html#a6ed7a299dff48cf855256983b86c971d">CEGUI::Window</a>.</p>
 
1011
 
 
1012
<p>Reimplemented in <a class="el" href="classCEGUI_1_1ComboDropList.html#a2748e7191189ad868d12f34ff517fbdb">CEGUI::ComboDropList</a>.</p>
 
1013
 
 
1014
</div>
 
1015
</div>
 
1016
<a class="anchor" id="ace000a7ac20ef6333e8d4d585ed4d04f"></a><!-- doxytag: member="CEGUI::Listbox::onMouseWheel" ref="ace000a7ac20ef6333e8d4d585ed4d04f" args="(MouseEventArgs &amp;e)" -->
 
1017
<div class="memitem">
 
1018
<div class="memproto">
 
1019
      <table class="memname">
 
1020
        <tr>
 
1021
          <td class="memname">virtual void CEGUI::Listbox::onMouseWheel </td>
 
1022
          <td>(</td>
 
1023
          <td class="paramtype"><a class="el" href="classCEGUI_1_1MouseEventArgs.html">MouseEventArgs</a> &amp;&#160;</td>
 
1024
          <td class="paramname"> <em>e</em>&#160;)</td>
 
1025
          <td><code> [protected, virtual]</code></td>
 
1026
        </tr>
 
1027
      </table>
 
1028
</div>
 
1029
<div class="memdoc">
 
1030
 
 
1031
<p>Handler called when the mouse wheel (z-axis) position changes within this window's area. </p>
 
1032
<dl><dt><b>Parameters:</b></dt><dd>
 
1033
  <table class="params">
 
1034
    <tr><td class="paramname">e</td><td><a class="el" href="classCEGUI_1_1MouseEventArgs.html" title="EventArgs based class that is used for objects passed to input event handlers concerning mouse input...">MouseEventArgs</a> object. All fields are valid. </td></tr>
 
1035
  </table>
 
1036
  </dd>
 
1037
</dl>
 
1038
 
 
1039
<p>Reimplemented from <a class="el" href="classCEGUI_1_1Window.html#a56aa0b4041705f88b3191c2d5adac79b">CEGUI::Window</a>.</p>
 
1040
 
 
1041
</div>
 
1042
</div>
 
1043
<a class="anchor" id="ac96223dd6d25af0e3c8d8ff2745e3d13"></a><!-- doxytag: member="CEGUI::Listbox::onSized" ref="ac96223dd6d25af0e3c8d8ff2745e3d13" args="(WindowEventArgs &amp;e)" -->
 
1044
<div class="memitem">
 
1045
<div class="memproto">
 
1046
      <table class="memname">
 
1047
        <tr>
 
1048
          <td class="memname">virtual void CEGUI::Listbox::onSized </td>
 
1049
          <td>(</td>
 
1050
          <td class="paramtype"><a class="el" href="classCEGUI_1_1WindowEventArgs.html">WindowEventArgs</a> &amp;&#160;</td>
 
1051
          <td class="paramname"> <em>e</em>&#160;)</td>
 
1052
          <td><code> [protected, virtual]</code></td>
 
1053
        </tr>
 
1054
      </table>
 
1055
</div>
 
1056
<div class="memdoc">
 
1057
 
 
1058
<p>Handler called when the window's size changes. </p>
 
1059
<dl><dt><b>Parameters:</b></dt><dd>
 
1060
  <table class="params">
 
1061
    <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 to the window that triggered the event. For this event the trigger window is always 'this'. </td></tr>
 
1062
  </table>
 
1063
  </dd>
 
1064
</dl>
 
1065
 
 
1066
<p>Reimplemented from <a class="el" href="classCEGUI_1_1Window.html#ac43cc38973c4e547ca8e481700da8178">CEGUI::Window</a>.</p>
 
1067
 
 
1068
</div>
 
1069
</div>
 
1070
<a class="anchor" id="a4bf421907b4219fc77a3139da0694c92"></a><!-- doxytag: member="CEGUI::Listbox::removeItem" ref="a4bf421907b4219fc77a3139da0694c92" args="(const ListboxItem *item)" -->
 
1071
<div class="memitem">
 
1072
<div class="memproto">
 
1073
      <table class="memname">
 
1074
        <tr>
 
1075
          <td class="memname">void CEGUI::Listbox::removeItem </td>
 
1076
          <td>(</td>
 
1077
          <td class="paramtype">const <a class="el" href="classCEGUI_1_1ListboxItem.html">ListboxItem</a> *&#160;</td>
 
1078
          <td class="paramname"> <em>item</em>&#160;)</td>
 
1079
          <td></td>
 
1080
        </tr>
 
1081
      </table>
 
1082
</div>
 
1083
<div class="memdoc">
 
1084
 
 
1085
<p>Removes the given item from the list box. If the item is has the auto delete state set, the item will be deleted. </p>
 
1086
<dl><dt><b>Parameters:</b></dt><dd>
 
1087
  <table class="params">
 
1088
    <tr><td class="paramname">item</td><td>Pointer to the <a class="el" href="classCEGUI_1_1ListboxItem.html" title="Base class for list box items.">ListboxItem</a> that is to be removed. If <em>item</em> is not attached to this list box then nothing will happen.</td></tr>
 
1089
  </table>
 
1090
  </dd>
 
1091
</dl>
 
1092
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
 
1093
 
 
1094
</div>
 
1095
</div>
 
1096
<a class="anchor" id="a3f086468a0fe012ce5b2bba7b06bafa5"></a><!-- doxytag: member="CEGUI::Listbox::resetList" ref="a3f086468a0fe012ce5b2bba7b06bafa5" args="(void)" -->
 
1097
<div class="memitem">
 
1098
<div class="memproto">
 
1099
      <table class="memname">
 
1100
        <tr>
 
1101
          <td class="memname">void CEGUI::Listbox::resetList </td>
 
1102
          <td>(</td>
 
1103
          <td class="paramtype">void&#160;</td>
 
1104
          <td class="paramname">&#160;)</td>
 
1105
          <td></td>
 
1106
        </tr>
 
1107
      </table>
 
1108
</div>
 
1109
<div class="memdoc">
 
1110
 
 
1111
<p>Remove all items from the list. </p>
 
1112
<p>Note that this will cause 'AutoDelete' items to be deleted. </p>
 
1113
 
 
1114
</div>
 
1115
</div>
 
1116
<a class="anchor" id="ab81a40b1c41433102b12de0600fc0567"></a><!-- doxytag: member="CEGUI::Listbox::resetList_impl" ref="ab81a40b1c41433102b12de0600fc0567" args="(void)" -->
 
1117
<div class="memitem">
 
1118
<div class="memproto">
 
1119
      <table class="memname">
 
1120
        <tr>
 
1121
          <td class="memname">bool CEGUI::Listbox::resetList_impl </td>
 
1122
          <td>(</td>
 
1123
          <td class="paramtype">void&#160;</td>
 
1124
          <td class="paramname">&#160;)</td>
 
1125
          <td><code> [protected]</code></td>
 
1126
        </tr>
 
1127
      </table>
 
1128
</div>
 
1129
<div class="memdoc">
 
1130
 
 
1131
<p>Remove all items from the list. </p>
 
1132
<dl class="note"><dt><b>Note:</b></dt><dd>Note that this will cause 'AutoDelete' items to be deleted.</dd></dl>
 
1133
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
 
1134
<li>true if the list contents were changed.</li>
 
1135
<li>false if the list contents were not changed (list already empty). </li>
 
1136
</ul>
 
1137
</dd></dl>
 
1138
 
 
1139
</div>
 
1140
</div>
 
1141
<a class="anchor" id="a895946c8082b13c05a286ded90208591"></a><!-- doxytag: member="CEGUI::Listbox::setItemSelectState" ref="a895946c8082b13c05a286ded90208591" args="(size_t item_index, bool state)" -->
 
1142
<div class="memitem">
 
1143
<div class="memproto">
 
1144
      <table class="memname">
 
1145
        <tr>
 
1146
          <td class="memname">void CEGUI::Listbox::setItemSelectState </td>
 
1147
          <td>(</td>
 
1148
          <td class="paramtype">size_t&#160;</td>
 
1149
          <td class="paramname"> <em>item_index</em>, </td>
 
1150
        </tr>
 
1151
        <tr>
 
1152
          <td class="paramkey"></td>
 
1153
          <td></td>
 
1154
          <td class="paramtype">bool&#160;</td>
 
1155
          <td class="paramname"> <em>state</em>&#160;</td>
 
1156
        </tr>
 
1157
        <tr>
 
1158
          <td></td>
 
1159
          <td>)</td>
 
1160
          <td></td><td></td>
 
1161
        </tr>
 
1162
      </table>
 
1163
</div>
 
1164
<div class="memdoc">
 
1165
 
 
1166
<p>Set the select state of an attached <a class="el" href="classCEGUI_1_1ListboxItem.html" title="Base class for list box items.">ListboxItem</a>. </p>
 
1167
<p>This is the recommended way of selecting and deselecting items attached to a list box as it respects the multi-select mode setting. It is possible to modify the setting on ListboxItems directly, but that approach does not respect the settings of the list box.</p>
 
1168
<dl><dt><b>Parameters:</b></dt><dd>
 
1169
  <table class="params">
 
1170
    <tr><td class="paramname">item_index</td><td>The zero based index of the <a class="el" href="classCEGUI_1_1ListboxItem.html" title="Base class for list box items.">ListboxItem</a> to be affected. This must be a valid index (0 &lt;= index &lt; <a class="el" href="classCEGUI_1_1Listbox.html#ac27fb510288515009d43ec7cfb42bfcf" title="Return number of items attached to the list box.">getItemCount()</a>)</td></tr>
 
1171
    <tr><td class="paramname">state</td><td>true to select the item, false to de-select the item.</td></tr>
 
1172
  </table>
 
1173
  </dd>
 
1174
</dl>
 
1175
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing.</dd></dl>
 
1176
<dl><dt><b>Exceptions:</b></dt><dd>
 
1177
  <table class="exception">
 
1178
    <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_index</em> is out of range for the list box </td></tr>
 
1179
  </table>
 
1180
  </dd>
 
1181
</dl>
 
1182
 
 
1183
</div>
 
1184
</div>
 
1185
<a class="anchor" id="a21ebdb1cfb45f1c12d913ce0173bc058"></a><!-- doxytag: member="CEGUI::Listbox::setItemSelectState" ref="a21ebdb1cfb45f1c12d913ce0173bc058" args="(ListboxItem *item, bool state)" -->
 
1186
<div class="memitem">
 
1187
<div class="memproto">
 
1188
      <table class="memname">
 
1189
        <tr>
 
1190
          <td class="memname">void CEGUI::Listbox::setItemSelectState </td>
 
1191
          <td>(</td>
 
1192
          <td class="paramtype"><a class="el" href="classCEGUI_1_1ListboxItem.html">ListboxItem</a> *&#160;</td>
 
1193
          <td class="paramname"> <em>item</em>, </td>
 
1194
        </tr>
 
1195
        <tr>
 
1196
          <td class="paramkey"></td>
 
1197
          <td></td>
 
1198
          <td class="paramtype">bool&#160;</td>
 
1199
          <td class="paramname"> <em>state</em>&#160;</td>
 
1200
        </tr>
 
1201
        <tr>
 
1202
          <td></td>
 
1203
          <td>)</td>
 
1204
          <td></td><td></td>
 
1205
        </tr>
 
1206
      </table>
 
1207
</div>
 
1208
<div class="memdoc">
 
1209
 
 
1210
<p>Set the select state of an attached <a class="el" href="classCEGUI_1_1ListboxItem.html" title="Base class for list box items.">ListboxItem</a>. </p>
 
1211
<p>This is the recommended way of selecting and deselecting items attached to a list box as it respects the multi-select mode setting. It is possible to modify the setting on ListboxItems directly, but that approach does not respect the settings of the list box.</p>
 
1212
<dl><dt><b>Parameters:</b></dt><dd>
 
1213
  <table class="params">
 
1214
    <tr><td class="paramname">item</td><td>The <a class="el" href="classCEGUI_1_1ListboxItem.html" title="Base class for list box items.">ListboxItem</a> to be affected. This item must be attached to the list box.</td></tr>
 
1215
    <tr><td class="paramname">state</td><td>true to select the item, false to de-select the item.</td></tr>
 
1216
  </table>
 
1217
  </dd>
 
1218
</dl>
 
1219
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing.</dd></dl>
 
1220
<dl><dt><b>Exceptions:</b></dt><dd>
 
1221
  <table class="exception">
 
1222
    <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>
 
1223
  </table>
 
1224
  </dd>
 
1225
</dl>
 
1226
 
 
1227
</div>
 
1228
</div>
 
1229
<a class="anchor" id="aff52444a6878a69eb209cf6e9f80521b"></a><!-- doxytag: member="CEGUI::Listbox::setMultiselectEnabled" ref="aff52444a6878a69eb209cf6e9f80521b" args="(bool setting)" -->
 
1230
<div class="memitem">
 
1231
<div class="memproto">
 
1232
      <table class="memname">
 
1233
        <tr>
 
1234
          <td class="memname">void CEGUI::Listbox::setMultiselectEnabled </td>
 
1235
          <td>(</td>
 
1236
          <td class="paramtype">bool&#160;</td>
 
1237
          <td class="paramname"> <em>setting</em>&#160;)</td>
 
1238
          <td></td>
 
1239
        </tr>
 
1240
      </table>
 
1241
</div>
 
1242
<div class="memdoc">
 
1243
 
 
1244
<p>Set whether the list should allow multiple selections or just a single selection. </p>
 
1245
<dl><dt><b>Parameters:</b></dt><dd>
 
1246
  <table class="params">
 
1247
    <tr><td class="paramname">setting</td><td>true if the widget should allow multiple items to be selected, false if the widget should only allow a single selection.</td></tr>
 
1248
  </table>
 
1249
  </dd>
 
1250
</dl>
 
1251
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
 
1252
 
 
1253
</div>
 
1254
</div>
 
1255
<a class="anchor" id="a1aad9c0cf940542fea921ba25620aee2"></a><!-- doxytag: member="CEGUI::Listbox::setShowHorzScrollbar" ref="a1aad9c0cf940542fea921ba25620aee2" args="(bool setting)" -->
 
1256
<div class="memitem">
 
1257
<div class="memproto">
 
1258
      <table class="memname">
 
1259
        <tr>
 
1260
          <td class="memname">void CEGUI::Listbox::setShowHorzScrollbar </td>
 
1261
          <td>(</td>
 
1262
          <td class="paramtype">bool&#160;</td>
 
1263
          <td class="paramname"> <em>setting</em>&#160;)</td>
 
1264
          <td></td>
 
1265
        </tr>
 
1266
      </table>
 
1267
</div>
 
1268
<div class="memdoc">
 
1269
 
 
1270
<p>Set whether the horizontal scroll bar should always be shown. </p>
 
1271
<dl><dt><b>Parameters:</b></dt><dd>
 
1272
  <table class="params">
 
1273
    <tr><td class="paramname">setting</td><td>true if the horizontal scroll bar should be shown even when it is not required. false if the horizontal scroll bar should only be shown when it is required.</td></tr>
 
1274
  </table>
 
1275
  </dd>
 
1276
</dl>
 
1277
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
 
1278
 
 
1279
</div>
 
1280
</div>
 
1281
<a class="anchor" id="aa28e1d66f95d88abffaece0226b7b2d3"></a><!-- doxytag: member="CEGUI::Listbox::setShowVertScrollbar" ref="aa28e1d66f95d88abffaece0226b7b2d3" args="(bool setting)" -->
 
1282
<div class="memitem">
 
1283
<div class="memproto">
 
1284
      <table class="memname">
 
1285
        <tr>
 
1286
          <td class="memname">void CEGUI::Listbox::setShowVertScrollbar </td>
 
1287
          <td>(</td>
 
1288
          <td class="paramtype">bool&#160;</td>
 
1289
          <td class="paramname"> <em>setting</em>&#160;)</td>
 
1290
          <td></td>
 
1291
        </tr>
 
1292
      </table>
 
1293
</div>
 
1294
<div class="memdoc">
 
1295
 
 
1296
<p>Set whether the vertical scroll bar should always be shown. </p>
 
1297
<dl><dt><b>Parameters:</b></dt><dd>
 
1298
  <table class="params">
 
1299
    <tr><td class="paramname">setting</td><td>true if the vertical scroll bar should be shown even when it is not required. false if the vertical scroll bar should only be shown when it is required.</td></tr>
 
1300
  </table>
 
1301
  </dd>
 
1302
</dl>
 
1303
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
 
1304
 
 
1305
</div>
 
1306
</div>
 
1307
<a class="anchor" id="a84de1c2932171a099884d2e249d43bf2"></a><!-- doxytag: member="CEGUI::Listbox::setSortingEnabled" ref="a84de1c2932171a099884d2e249d43bf2" args="(bool setting)" -->
 
1308
<div class="memitem">
 
1309
<div class="memproto">
 
1310
      <table class="memname">
 
1311
        <tr>
 
1312
          <td class="memname">void CEGUI::Listbox::setSortingEnabled </td>
 
1313
          <td>(</td>
 
1314
          <td class="paramtype">bool&#160;</td>
 
1315
          <td class="paramname"> <em>setting</em>&#160;)</td>
 
1316
          <td></td>
 
1317
        </tr>
 
1318
      </table>
 
1319
</div>
 
1320
<div class="memdoc">
 
1321
 
 
1322
<p>Set whether the list should be sorted. </p>
 
1323
<dl><dt><b>Parameters:</b></dt><dd>
 
1324
  <table class="params">
 
1325
    <tr><td class="paramname">setting</td><td>true if the list should be sorted, false if the list should not be sorted.</td></tr>
 
1326
  </table>
 
1327
  </dd>
 
1328
</dl>
 
1329
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
 
1330
 
 
1331
</div>
 
1332
</div>
 
1333
<a class="anchor" id="a0038b304b9174e6f39aae7189707d40d"></a><!-- doxytag: member="CEGUI::Listbox::testClassName_impl" ref="a0038b304b9174e6f39aae7189707d40d" args="(const String &amp;class_name) const " -->
 
1334
<div class="memitem">
 
1335
<div class="memproto">
 
1336
      <table class="memname">
 
1337
        <tr>
 
1338
          <td class="memname">virtual bool CEGUI::Listbox::testClassName_impl </td>
 
1339
          <td>(</td>
 
1340
          <td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> &amp;&#160;</td>
 
1341
          <td class="paramname"> <em>class_name</em>&#160;)</td>
 
1342
          <td> const<code> [inline, protected, virtual]</code></td>
 
1343
        </tr>
 
1344
      </table>
 
1345
</div>
 
1346
<div class="memdoc">
 
1347
 
 
1348
<p>Return whether this window was inherited from the given class name at some point in the inheritance hierarchy. </p>
 
1349
<dl><dt><b>Parameters:</b></dt><dd>
 
1350
  <table class="params">
 
1351
    <tr><td class="paramname">class_name</td><td>The class name that is to be checked.</td></tr>
 
1352
  </table>
 
1353
  </dd>
 
1354
</dl>
 
1355
<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>
 
1356
 
 
1357
<p>Reimplemented from <a class="el" href="classCEGUI_1_1Window.html#a2b58cf00b4790c9cb08acfc18d5d3b0b">CEGUI::Window</a>.</p>
 
1358
 
 
1359
<p>Reimplemented in <a class="el" href="classCEGUI_1_1ComboDropList.html#a8d4176e66c3a1f87cf95c85c4d162b7d">CEGUI::ComboDropList</a>.</p>
 
1360
 
 
1361
<p>References <a class="el" href="classCEGUI_1_1Window.html#a2b58cf00b4790c9cb08acfc18d5d3b0b">CEGUI::Window::testClassName_impl()</a>.</p>
 
1362
 
 
1363
<p>Referenced by <a class="el" href="classCEGUI_1_1ComboDropList.html#a8d4176e66c3a1f87cf95c85c4d162b7d">CEGUI::ComboDropList::testClassName_impl()</a>.</p>
 
1364
 
 
1365
</div>
 
1366
</div>
 
1367
<a class="anchor" id="aa7c00b73d01592fc01b8a7fca9df4c56"></a><!-- doxytag: member="CEGUI::Listbox::validateWindowRenderer" ref="aa7c00b73d01592fc01b8a7fca9df4c56" args="(const String &amp;name) const " -->
 
1368
<div class="memitem">
 
1369
<div class="memproto">
 
1370
      <table class="memname">
 
1371
        <tr>
 
1372
          <td class="memname">virtual bool CEGUI::Listbox::validateWindowRenderer </td>
 
1373
          <td>(</td>
 
1374
          <td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> &amp;&#160;</td>
 
1375
          <td class="paramname"> <em>name</em>&#160;)</td>
 
1376
          <td> const<code> [inline, protected, virtual]</code></td>
 
1377
        </tr>
 
1378
      </table>
 
1379
</div>
 
1380
<div class="memdoc">
 
1381
 
 
1382
<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>
 
1383
<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>
 
1384
 
 
1385
<p>Reimplemented from <a class="el" href="classCEGUI_1_1Window.html#a27804e1e76bbbf4af45dfb23c24afa1a">CEGUI::Window</a>.</p>
 
1386
 
 
1387
</div>
 
1388
</div>
 
1389
<hr/><h2>Member Data Documentation</h2>
 
1390
<a class="anchor" id="abc2bd4a37317867eb6c2509e2695d116"></a><!-- doxytag: member="CEGUI::Listbox::EventHorzScrollbarModeChanged" ref="abc2bd4a37317867eb6c2509e2695d116" args="" -->
 
1391
<div class="memitem">
 
1392
<div class="memproto">
 
1393
      <table class="memname">
 
1394
        <tr>
 
1395
          <td class="memname">const <a class="el" href="classCEGUI_1_1String.html">String</a> <a class="el" href="classCEGUI_1_1Listbox.html#abc2bd4a37317867eb6c2509e2695d116">CEGUI::Listbox::EventHorzScrollbarModeChanged</a><code> [static]</code></td>
 
1396
        </tr>
 
1397
      </table>
 
1398
</div>
 
1399
<div class="memdoc">
 
1400
<p><a class="el" href="classCEGUI_1_1Event.html" title="Defines an &#39;event&#39; which can be subscribed to by interested parties.">Event</a> fired when the mode setting that forces the display of the horizontal scroll bar for the <a class="el" href="classCEGUI_1_1Listbox.html" title="Base class for standard Listbox widget.">Listbox</a> 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_1Listbox.html" title="Base class for standard Listbox widget.">Listbox</a> whose horizontal scrollbar mode has been changed. </p>
 
1401
 
 
1402
</div>
 
1403
</div>
 
1404
<a class="anchor" id="a5637852660132d350794ff4b6732adab"></a><!-- doxytag: member="CEGUI::Listbox::EventListContentsChanged" ref="a5637852660132d350794ff4b6732adab" args="" -->
 
1405
<div class="memitem">
 
1406
<div class="memproto">
 
1407
      <table class="memname">
 
1408
        <tr>
 
1409
          <td class="memname">const <a class="el" href="classCEGUI_1_1String.html">String</a> <a class="el" href="classCEGUI_1_1Listbox.html#a5637852660132d350794ff4b6732adab">CEGUI::Listbox::EventListContentsChanged</a><code> [static]</code></td>
 
1410
        </tr>
 
1411
      </table>
 
1412
</div>
 
1413
<div class="memdoc">
 
1414
<p><a class="el" href="classCEGUI_1_1Event.html" title="Defines an &#39;event&#39; 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_1Listbox.html" title="Base class for standard Listbox widget.">Listbox</a> whose content is changed. </p>
 
1415
 
 
1416
</div>
 
1417
</div>
 
1418
<a class="anchor" id="aa5ca97065346dc98f56a35c0e390180a"></a><!-- doxytag: member="CEGUI::Listbox::EventMultiselectModeChanged" ref="aa5ca97065346dc98f56a35c0e390180a" args="" -->
 
1419
<div class="memitem">
 
1420
<div class="memproto">
 
1421
      <table class="memname">
 
1422
        <tr>
 
1423
          <td class="memname">const <a class="el" href="classCEGUI_1_1String.html">String</a> <a class="el" href="classCEGUI_1_1Listbox.html#aa5ca97065346dc98f56a35c0e390180a">CEGUI::Listbox::EventMultiselectModeChanged</a><code> [static]</code></td>
 
1424
        </tr>
 
1425
      </table>
 
1426
</div>
 
1427
<div class="memdoc">
 
1428
<p><a class="el" href="classCEGUI_1_1Event.html" title="Defines an &#39;event&#39; which can be subscribed to by interested parties.">Event</a> fired when the multi-select mode setting changes for the <a class="el" href="classCEGUI_1_1Listbox.html" title="Base class for standard Listbox widget.">Listbox</a>. 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_1Listbox.html" title="Base class for standard Listbox widget.">Listbox</a> whose multi-select mode has been changed. </p>
 
1429
 
 
1430
</div>
 
1431
</div>
 
1432
<a class="anchor" id="afa8eb049e685967f9639ecd81c44bccb"></a><!-- doxytag: member="CEGUI::Listbox::EventSelectionChanged" ref="afa8eb049e685967f9639ecd81c44bccb" args="" -->
 
1433
<div class="memitem">
 
1434
<div class="memproto">
 
1435
      <table class="memname">
 
1436
        <tr>
 
1437
          <td class="memname">const <a class="el" href="classCEGUI_1_1String.html">String</a> <a class="el" href="classCEGUI_1_1Listbox.html#afa8eb049e685967f9639ecd81c44bccb">CEGUI::Listbox::EventSelectionChanged</a><code> [static]</code></td>
 
1438
        </tr>
 
1439
      </table>
 
1440
</div>
 
1441
<div class="memdoc">
 
1442
<p><a class="el" href="classCEGUI_1_1Event.html" title="Defines an &#39;event&#39; which can be subscribed to by interested parties.">Event</a> fired when there is a change to the currently selected item(s) within the list. 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 Litbox that has had a change in the selected items. </p>
 
1443
 
 
1444
</div>
 
1445
</div>
 
1446
<a class="anchor" id="af33bcee37ec79863bb3f818466bbcb33"></a><!-- doxytag: member="CEGUI::Listbox::EventSortModeChanged" ref="af33bcee37ec79863bb3f818466bbcb33" args="" -->
 
1447
<div class="memitem">
 
1448
<div class="memproto">
 
1449
      <table class="memname">
 
1450
        <tr>
 
1451
          <td class="memname">const <a class="el" href="classCEGUI_1_1String.html">String</a> <a class="el" href="classCEGUI_1_1Listbox.html#af33bcee37ec79863bb3f818466bbcb33">CEGUI::Listbox::EventSortModeChanged</a><code> [static]</code></td>
 
1452
        </tr>
 
1453
      </table>
 
1454
</div>
 
1455
<div class="memdoc">
 
1456
<p><a class="el" href="classCEGUI_1_1Event.html" title="Defines an &#39;event&#39; which can be subscribed to by interested parties.">Event</a> fired when the sort mode setting changes for the <a class="el" href="classCEGUI_1_1Listbox.html" title="Base class for standard Listbox widget.">Listbox</a>. 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_1Listbox.html" title="Base class for standard Listbox widget.">Listbox</a> whose sort mode has been changed. </p>
 
1457
 
 
1458
</div>
 
1459
</div>
 
1460
<a class="anchor" id="ab6439b5d836b09c44ff941a15ee188b9"></a><!-- doxytag: member="CEGUI::Listbox::EventVertScrollbarModeChanged" ref="ab6439b5d836b09c44ff941a15ee188b9" args="" -->
 
1461
<div class="memitem">
 
1462
<div class="memproto">
 
1463
      <table class="memname">
 
1464
        <tr>
 
1465
          <td class="memname">const <a class="el" href="classCEGUI_1_1String.html">String</a> <a class="el" href="classCEGUI_1_1Listbox.html#ab6439b5d836b09c44ff941a15ee188b9">CEGUI::Listbox::EventVertScrollbarModeChanged</a><code> [static]</code></td>
 
1466
        </tr>
 
1467
      </table>
 
1468
</div>
 
1469
<div class="memdoc">
 
1470
<p><a class="el" href="classCEGUI_1_1Event.html" title="Defines an &#39;event&#39; which can be subscribed to by interested parties.">Event</a> fired when the mode setting that forces the display of the vertical scroll bar for the <a class="el" href="classCEGUI_1_1Listbox.html" title="Base class for standard Listbox widget.">Listbox</a> 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_1Listbox.html" title="Base class for standard Listbox widget.">Listbox</a> whose vertical scrollbar mode has been changed. </p>
 
1471
 
 
1472
</div>
 
1473
</div>
 
1474
</div>
 
1475
<hr class="footer"/><address class="footer"><small>Generated on Fri Nov 19 2010 12:01:22 for Crazy Eddies GUI System by&#160;
 
1476
<a href="http://www.doxygen.org/index.html">
 
1477
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.2 </small></address>
 
1478
</body>
 
1479
</html>