<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Wt: Wt::WItemSelectionModel Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Wt
 <span id="projectnumber">3.2.3</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.5.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceWt.html">Wt</a> </li>
<li class="navelem"><a class="el" href="classWt_1_1WItemSelectionModel.html">WItemSelectionModel</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">Wt::WItemSelectionModel Class Reference<div class="ingroups"><a class="el" href="group__modelview.html">Model/view system</a></div></div> </div>
</div>
<div class="contents">
<!-- doxytag: class="Wt::WItemSelectionModel" --><!-- doxytag: inherits="Wt::WObject" -->
<p>A class that represents a selection for a <a class="el" href="classWt_1_1WAbstractItemView.html" title="An abstract base class for item Views.">WAbstractItemView</a>.
<a href="classWt_1_1WItemSelectionModel.html#details">More...</a></p>
<p><code>#include <Wt/WItemSelectionModel></code></p>
<div class="dynheader">
Inheritance diagram for Wt::WItemSelectionModel:</div>
<div class="dyncontent">
<div class="center"><img src="classWt_1_1WItemSelectionModel__inherit__graph.png" border="0" usemap="#Wt_1_1WItemSelectionModel_inherit__map" alt="Inheritance graph"/></div>
<map name="Wt_1_1WItemSelectionModel_inherit__map" id="Wt_1_1WItemSelectionModel_inherit__map">
<area shape="rect" href="classWt_1_1WObject.html" title="A base class for objects that participate in the signal/slot system." alt="" coords="44,5,140,32"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classWt_1_1WItemSelectionModel-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a42fb83302389cc2942cc09a198c0ee00"></a><!-- doxytag: member="Wt::WItemSelectionModel::model" ref="a42fb83302389cc2942cc09a198c0ee00" args="() const " -->
<a class="el" href="classWt_1_1WAbstractItemModel.html">WAbstractItemModel</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WItemSelectionModel.html#a42fb83302389cc2942cc09a198c0ee00">model</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the <a class="el" href="classWt_1_1WAbstractItemModel.html" title="An abstract model for use with Wt's view classes.">WAbstractItemModel</a>. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">WModelIndexSet </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WItemSelectionModel.html#a4c366757fa7e6b5b6519d34e3c2ac084">selectedIndexes</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the set of selected items. <a href="#a4c366757fa7e6b5b6519d34e3c2ac084"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WItemSelectionModel.html#a96e391104f8846557ed95f5a93f4f452">isSelected</a> (const <a class="el" href="classWt_1_1WModelIndex.html">WModelIndex</a> &index) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns wheter an item is selected. <a href="#a96e391104f8846557ed95f5a93f4f452"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WItemSelectionModel.html#acbf2a0659f9b5f04becbf5dd02aff9b3">setSelectionBehavior</a> (<a class="el" href="namespaceWt.html#a04aecd34ae0810219e82208a9890de13">SelectionBehavior</a> behavior)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the selection behaviour. <a href="#acbf2a0659f9b5f04becbf5dd02aff9b3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceWt.html#a04aecd34ae0810219e82208a9890de13">SelectionBehavior</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WItemSelectionModel.html#a7bddf47881159cdd36651891954f3a39">selectionBehavior</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the selection behaviour. <a href="#a7bddf47881159cdd36651891954f3a39"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WItemSelectionModel.html#a36e3f0be90d7b31e2b8a2ed317472d29">mimeType</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the selection mime type. <a href="#a36e3f0be90d7b31e2b8a2ed317472d29"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>A class that represents a selection for a <a class="el" href="classWt_1_1WAbstractItemView.html" title="An abstract base class for item Views.">WAbstractItemView</a>. </p>
<p>This model is currently only used by <a class="el" href="classWt_1_1WTreeView.html" title="A view class that displays a model as a tree or tree table.">WTreeView</a>, and plays only a role in drag & drop of an item selection.</p>
<p>When an item selection is dragged from a view widget, the generated drop events will have as source object (see <a class="el" href="classWt_1_1WDropEvent.html#adfe27a00e34b7322a52bc7dc73d4d5af" title="Returns the source of the drag&drop operation.">WDropEvent::source()</a>) this selection model.</p>
<p>Although this class does not (yet) allow you to modify the selection, note that manipulations to the model may modify the selection (row insertions and removals may shift the selection, and row deletions may shrink the selection).</p>
<dl class="note"><dt><b>Note:</b></dt><dd>Currently this class cannot be shared between multiple views.</dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WTreeView.html" title="A view class that displays a model as a tree or tree table.">WTreeView</a>, <a class="el" href="classWt_1_1WTableView.html" title="An MVC View widget for tabular data.">WTableView</a>, <a class="el" href="classWt_1_1WAbstractItemModel.html" title="An abstract model for use with Wt's view classes.">WAbstractItemModel</a> </dd></dl>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a96e391104f8846557ed95f5a93f4f452"></a><!-- doxytag: member="Wt::WItemSelectionModel::isSelected" ref="a96e391104f8846557ed95f5a93f4f452" args="(const WModelIndex &index) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Wt::WItemSelectionModel::isSelected </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classWt_1_1WModelIndex.html">WModelIndex</a> & </td>
<td class="paramname"><em>index</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns wheter an item is selected. </p>
<p>When selection operates on rows (<a class="el" href="namespaceWt.html#a04aecd34ae0810219e82208a9890de13af392e7f86ea1d0807e54de5739011239">SelectRows</a>), this method returns true for each element in a selected row.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WItemSelectionModel.html#a4c366757fa7e6b5b6519d34e3c2ac084" title="Returns the set of selected items.">selectedIndexes()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a36e3f0be90d7b31e2b8a2ed317472d29"></a><!-- doxytag: member="Wt::WItemSelectionModel::mimeType" ref="a36e3f0be90d7b31e2b8a2ed317472d29" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string Wt::WItemSelectionModel::mimeType </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the selection mime type. </p>
<p>This should return the mime type for the current selection, or an emtpy string if the selection cannot be dragged.</p>
<p>The default implementation returns the mime type based on MimeTypeRole data if all selected items indicate the same mime type, or the model <a class="el" href="classWt_1_1WItemSelectionModel.html#a36e3f0be90d7b31e2b8a2ed317472d29" title="Returns the selection mime type.">mimeType()</a> otherwise.</p>
<p>If one or more items indicate that they cannot be dragged, then an empty string is returned. </p>
</div>
</div>
<a class="anchor" id="a4c366757fa7e6b5b6519d34e3c2ac084"></a><!-- doxytag: member="Wt::WItemSelectionModel::selectedIndexes" ref="a4c366757fa7e6b5b6519d34e3c2ac084" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">WModelIndexSet Wt::WItemSelectionModel::selectedIndexes </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the set of selected items. </p>
<p>The model indexes are returned as a set, topologically ordered (in the order they appear in the view).</p>
<p>When selection operates on rows (<a class="el" href="namespaceWt.html#a04aecd34ae0810219e82208a9890de13af392e7f86ea1d0807e54de5739011239">SelectRows</a>), this method only returns the model index of first column's element of the selected rows. </p>
</div>
</div>
<a class="anchor" id="a7bddf47881159cdd36651891954f3a39"></a><!-- doxytag: member="Wt::WItemSelectionModel::selectionBehavior" ref="a7bddf47881159cdd36651891954f3a39" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceWt.html#a04aecd34ae0810219e82208a9890de13">SelectionBehavior</a> Wt::WItemSelectionModel::selectionBehavior </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the selection behaviour. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WItemSelectionModel.html#acbf2a0659f9b5f04becbf5dd02aff9b3" title="Sets the selection behaviour.">setSelectionBehavior()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="acbf2a0659f9b5f04becbf5dd02aff9b3"></a><!-- doxytag: member="Wt::WItemSelectionModel::setSelectionBehavior" ref="acbf2a0659f9b5f04becbf5dd02aff9b3" args="(SelectionBehavior behavior)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WItemSelectionModel::setSelectionBehavior </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceWt.html#a04aecd34ae0810219e82208a9890de13">SelectionBehavior</a> </td>
<td class="paramname"><em>behavior</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the selection behaviour. </p>
<p>By default, the selection contains rows (<a class="el" href="namespaceWt.html#a04aecd34ae0810219e82208a9890de13af392e7f86ea1d0807e54de5739011239">SelectRows</a>), in which case model indexes will always be have column 0, but represent the whole row.</p>
<p>Alternatively, you can allow selection for individual items (<a class="el" href="namespaceWt.html#a04aecd34ae0810219e82208a9890de13afcf79c96af1f3bd64b7b143fd1ec1126">SelectItems</a>). </p>
</div>
</div>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<hr size="1"><address style="text-align: right; margin: 3px"><small>
Generated on Thu Nov 1 2012 for <a href="http://www.webtoolkit.eu/wt">the
C++ Web Toolkit (Wt)</a> by <a
href="http://www.doxygen.org/index.html"><img src="doxygen.png"
alt="doxygen" border="0" style="vertical-align: middle; display:
inline-block; height: 2em"></a> 1.7.5.1</small></address>
</body>
</html>
