~oif-team/ubuntu/natty/qt4-x11/xi2.1

« back to all changes in this revision

Viewing changes to doc/html/qmultihash.html

  • Committer: Bazaar Package Importer
  • Author(s): Alessandro Ghersi
  • Date: 2009-11-02 18:30:08 UTC
  • mfrom: (1.2.2 upstream)
  • mto: (15.2.5 experimental)
  • mto: This revision was merged to the branch mainline in revision 88.
  • Revision ID: james.westby@ubuntu.com-20091102183008-b6a4gcs128mvfb3m
Tags: upstream-4.6.0~beta1
ImportĀ upstreamĀ versionĀ 4.6.0~beta1

Show diffs side-by-side

added added

removed removed

Lines of Context:
2
2
<!DOCTYPE html
3
3
    PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
4
4
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5
 
<!-- /fasttmp/mkdist-qt-4.5.2-1245473805/qt-x11-opensource-src-4.5.2/src/corelib/tools/qhash.cpp -->
 
5
<!-- qhash.cpp -->
6
6
<head>
7
 
  <title>Qt 4.5: QMultiHash Class Reference</title>
 
7
  <title>Qt 4.6: QMultiHash Class Reference</title>
8
8
  <link href="classic.css" rel="stylesheet" type="text/css" />
9
9
</head>
10
10
<body>
 
11
<a name="//apple_ref/cpp/cl//QMultiHash" />
11
12
<table border="0" cellpadding="0" cellspacing="0" width="100%">
12
13
<tr>
13
 
<td align="left" valign="top" width="32"><a href="http://qtsoftware.com/products/qt"><img src="images/qt-logo.png" align="left" border="0" /></a></td>
14
 
<td width="1">&nbsp;&nbsp;</td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a>&nbsp;&middot; <a href="namespaces.html"><font color="#004faf">All&nbsp;Namespaces</font></a>&nbsp;&middot; <a href="classes.html"><font color="#004faf">All&nbsp;Classes</font></a>&nbsp;&middot; <a href="mainclasses.html"><font color="#004faf">Main&nbsp;Classes</font></a>&nbsp;&middot; <a href="groups.html"><font color="#004faf">Grouped&nbsp;Classes</font></a>&nbsp;&middot; <a href="modules.html"><font color="#004faf">Modules</font></a>&nbsp;&middot; <a href="functions.html"><font color="#004faf">Functions</font></a></td>
15
 
<td align="right" valign="top" width="230"></td></tr></table><h1 class="title">QMultiHash Class Reference<br /><span class="small-subtitle">[<a href="qtcore.html">QtCore</a> module]</span>
 
14
<td align="left" valign="top" width="32"><a href="http://qt.nokia.com/"><img src="images/qt-logo.png" align="left" border="0" /></a></td>
 
15
<td width="1">&nbsp;&nbsp;</td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a>&nbsp;&middot; <a href="classes.html"><font color="#004faf">All&nbsp;Classes</font></a>&nbsp;&middot; <a href="functions.html"><font color="#004faf">All&nbsp;Functions</font></a>&nbsp;&middot; <a href="overviews.html"><font color="#004faf">Overviews</font></a></td><td class="searchBar" align="right" valign="center"><form action="http://www.google.com/cse" id="cse-search-box"><div><input type="hidden" name="cx" value="000136343326384750312:dhbxnqlakyu" /><input type="hidden" name="ie" value="UTF-8" /><input type="text" name="q" size="31" /><input type="submit" name="sa" value="Search" /></div></form></td>
 
16
</tr></table><h1 class="title">QMultiHash Class Reference<br /><span class="small-subtitle">[<a href="qtcore.html">QtCore</a> module]</span>
16
17
</h1>
17
18
<p>The QMultiHash class is a convenience <a href="qhash.html">QHash</a> subclass that provides multi-valued hashes. <a href="#details">More...</a></p>
18
19
<pre> #include &lt;QMultiHash&gt;</pre><p>Inherits <a href="qhash.html">QHash&lt;Key, T&gt;</a>.</p>
19
 
<p><b>Note:</b> All the functions in this class are <a href="threads.html#reentrant">reentrant</a>.</p>
 
20
<p><b>Note:</b> All functions in this class are <a href="threads-reentrancy.html#reentrant">reentrant</a>.</p>
20
21
<ul>
21
22
<li><a href="qmultihash-members.html">List of all members, including inherited members</a></li>
22
23
</ul>
 
24
<hr />
23
25
<a name="public-functions"></a>
24
 
<h3>Public Functions</h3>
25
 
<ul>
26
 
<li><div class="fn"></div><b><a href="qmultihash.html#QMultiHash">QMultiHash</a></b> ()</li>
27
 
<li><div class="fn"></div><b><a href="qmultihash.html#QMultiHash-2">QMultiHash</a></b> ( const QHash&lt;Key, T&gt; &amp; <i>other</i> )</li>
28
 
<li><div class="fn"></div>QHash&lt;Key, T&gt;::const_iterator <b><a href="qmultihash.html#constFind">constFind</a></b> ( const Key &amp; <i>key</i>, const T &amp; <i>value</i> ) const</li>
29
 
<li><div class="fn"></div>QHash&lt;Key, T&gt;::const_iterator <b><a href="qmultihash.html#constFind-2">constFind</a></b> ( const Key &amp; <i>key</i> ) const</li>
30
 
<li><div class="fn"></div>bool <b><a href="qmultihash.html#contains">contains</a></b> ( const Key &amp; <i>key</i>, const T &amp; <i>value</i> ) const</li>
31
 
<li><div class="fn"></div>bool <b><a href="qmultihash.html#contains-2">contains</a></b> ( const Key &amp; <i>key</i> ) const</li>
32
 
<li><div class="fn"></div>int <b><a href="qmultihash.html#count">count</a></b> ( const Key &amp; <i>key</i>, const T &amp; <i>value</i> ) const</li>
33
 
<li><div class="fn"></div>int <b><a href="qmultihash.html#count-2">count</a></b> ( const Key &amp; <i>key</i> ) const</li>
34
 
<li><div class="fn"></div>int <b><a href="qmultihash.html#count-3">count</a></b> () const</li>
35
 
<li><div class="fn"></div>QHash&lt;Key, T&gt;::iterator <b><a href="qmultihash.html#find">find</a></b> ( const Key &amp; <i>key</i>, const T &amp; <i>value</i> )</li>
36
 
<li><div class="fn"></div>QHash&lt;Key, T&gt;::iterator <b><a href="qmultihash.html#find-2">find</a></b> ( const Key &amp; <i>key</i> )</li>
37
 
<li><div class="fn"></div>QHash&lt;Key, T&gt;::const_iterator <b><a href="qmultihash.html#find-3">find</a></b> ( const Key &amp; <i>key</i>, const T &amp; <i>value</i> ) const</li>
38
 
<li><div class="fn"></div>QHash&lt;Key, T&gt;::const_iterator <b><a href="qmultihash.html#find-4">find</a></b> ( const Key &amp; <i>key</i> ) const</li>
39
 
<li><div class="fn"></div>QHash&lt;Key, T&gt;::iterator <b><a href="qmultihash.html#insert">insert</a></b> ( const Key &amp; <i>key</i>, const T &amp; <i>value</i> )</li>
40
 
<li><div class="fn"></div>int <b><a href="qmultihash.html#remove">remove</a></b> ( const Key &amp; <i>key</i>, const T &amp; <i>value</i> )</li>
41
 
<li><div class="fn"></div>int <b><a href="qmultihash.html#remove-2">remove</a></b> ( const Key &amp; <i>key</i> )</li>
42
 
<li><div class="fn"></div>QHash&lt;Key, T&gt;::iterator <b><a href="qmultihash.html#replace">replace</a></b> ( const Key &amp; <i>key</i>, const T &amp; <i>value</i> )</li>
43
 
<li><div class="fn"></div>QMultiHash <b><a href="qmultihash.html#operator-2b">operator+</a></b> ( const QMultiHash &amp; <i>other</i> ) const</li>
44
 
<li><div class="fn"></div>QMultiHash &amp; <b><a href="qmultihash.html#operator-2b-eq">operator+=</a></b> ( const QMultiHash &amp; <i>other</i> )</li>
45
 
</ul>
46
 
<ul>
47
 
<li><div class="fn"></div>39 public functions inherited from <a href="qhash.html#public-functions">QHash</a></li>
 
26
<h2>Public Functions</h2>
 
27
<table class="alignedsummary" border="0" cellpadding="0" cellspacing="0" width="100%">
 
28
<tr><td class="memItemLeft" align="right" valign="top"></td><td class="memItemRight" valign="bottom"><b><a href="qmultihash.html#QMultiHash">QMultiHash</a></b> ()</td></tr>
 
29
<tr><td class="memItemLeft" align="right" valign="top"></td><td class="memItemRight" valign="bottom"><b><a href="qmultihash.html#QMultiHash-2">QMultiHash</a></b> ( const QHash&lt;Key, T&gt; &amp; <i>other</i> )</td></tr>
 
30
<tr><td class="memItemLeft" align="right" valign="top">QHash&lt;Key, T&gt;::const_iterator </td><td class="memItemRight" valign="bottom"><b><a href="qmultihash.html#constFind">constFind</a></b> ( const Key &amp; <i>key</i>, const T &amp; <i>value</i> ) const</td></tr>
 
31
<tr><td class="memItemLeft" align="right" valign="top">QHash&lt;Key, T&gt;::const_iterator </td><td class="memItemRight" valign="bottom"><b><a href="qmultihash.html#constFind-2">constFind</a></b> ( const Key &amp; <i>key</i> ) const</td></tr>
 
32
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><b><a href="qmultihash.html#contains">contains</a></b> ( const Key &amp; <i>key</i>, const T &amp; <i>value</i> ) const</td></tr>
 
33
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><b><a href="qmultihash.html#contains-2">contains</a></b> ( const Key &amp; <i>key</i> ) const</td></tr>
 
34
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><b><a href="qmultihash.html#count">count</a></b> ( const Key &amp; <i>key</i>, const T &amp; <i>value</i> ) const</td></tr>
 
35
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><b><a href="qmultihash.html#count-2">count</a></b> ( const Key &amp; <i>key</i> ) const</td></tr>
 
36
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><b><a href="qmultihash.html#count-3">count</a></b> () const</td></tr>
 
37
<tr><td class="memItemLeft" align="right" valign="top">QHash&lt;Key, T&gt;::iterator </td><td class="memItemRight" valign="bottom"><b><a href="qmultihash.html#find">find</a></b> ( const Key &amp; <i>key</i>, const T &amp; <i>value</i> )</td></tr>
 
38
<tr><td class="memItemLeft" align="right" valign="top">QHash&lt;Key, T&gt;::iterator </td><td class="memItemRight" valign="bottom"><b><a href="qmultihash.html#find-2">find</a></b> ( const Key &amp; <i>key</i> )</td></tr>
 
39
<tr><td class="memItemLeft" align="right" valign="top">QHash&lt;Key, T&gt;::const_iterator </td><td class="memItemRight" valign="bottom"><b><a href="qmultihash.html#find-3">find</a></b> ( const Key &amp; <i>key</i>, const T &amp; <i>value</i> ) const</td></tr>
 
40
<tr><td class="memItemLeft" align="right" valign="top">QHash&lt;Key, T&gt;::const_iterator </td><td class="memItemRight" valign="bottom"><b><a href="qmultihash.html#find-4">find</a></b> ( const Key &amp; <i>key</i> ) const</td></tr>
 
41
<tr><td class="memItemLeft" align="right" valign="top">QHash&lt;Key, T&gt;::iterator </td><td class="memItemRight" valign="bottom"><b><a href="qmultihash.html#insert">insert</a></b> ( const Key &amp; <i>key</i>, const T &amp; <i>value</i> )</td></tr>
 
42
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><b><a href="qmultihash.html#remove">remove</a></b> ( const Key &amp; <i>key</i>, const T &amp; <i>value</i> )</td></tr>
 
43
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><b><a href="qmultihash.html#remove-2">remove</a></b> ( const Key &amp; <i>key</i> )</td></tr>
 
44
<tr><td class="memItemLeft" align="right" valign="top">QHash&lt;Key, T&gt;::iterator </td><td class="memItemRight" valign="bottom"><b><a href="qmultihash.html#replace">replace</a></b> ( const Key &amp; <i>key</i>, const T &amp; <i>value</i> )</td></tr>
 
45
<tr><td class="memItemLeft" align="right" valign="top">QMultiHash </td><td class="memItemRight" valign="bottom"><b><a href="qmultihash.html#operator-2b">operator+</a></b> ( const QMultiHash &amp; <i>other</i> ) const</td></tr>
 
46
<tr><td class="memItemLeft" align="right" valign="top">QMultiHash &amp; </td><td class="memItemRight" valign="bottom"><b><a href="qmultihash.html#operator-2b-eq">operator+=</a></b> ( const QMultiHash &amp; <i>other</i> )</td></tr>
 
47
</table>
 
48
<ul>
 
49
<li><div bar="2" class="fn"></div>39 public functions inherited from <a href="qhash.html#public-functions">QHash</a></li>
48
50
</ul>
49
51
<a name="details"></a>
50
52
<hr />
76
78
     cout &lt;&lt; i.value() &lt;&lt; endl;
77
79
     ++i;
78
80
 }</pre>
79
 
<p>QMultiHash's key and value data types must be <a href="containers.html#assignable-data-types">assignable data types</a>. You cannot, for example, store a <a href="qwidget.html">QWidget</a> as a value; instead, store a <a href="qwidget.html">QWidget</a> *. In addition, QMultiHash's key type must provide operator==(), and there must also be a global <a href="qhash.html#qHash">qHash</a>() function that returns a hash value for an argument of the key's type. See the <a href="qhash.html">QHash</a> documentation for details.</p>
 
81
<p>QMultiHash's key and value data types must be <a href="containers.html#assignable-data-types">assignable data types</a>. You cannot, for example, store a <a href="qwidget.html">QWidget</a> as a value; instead, store a <a href="qwidget.html">QWidget</a> *. In addition, QMultiHash's key type must provide operator==(), and there must also be a global <a href="qxmlname.html#qHash">qHash</a>() function that returns a hash value for an argument of the key's type. See the <a href="qhash.html">QHash</a> documentation for details.</p>
80
82
<p>See also <a href="qhash.html">QHash</a>, <a href="qhashiterator.html">QHashIterator</a>, <a href="qmutablehashiterator.html">QMutableHashIterator</a>, and <a href="qmultimap.html">QMultiMap</a>.</p>
81
83
<hr />
82
84
<h2>Member Function Documentation</h2>
 
85
<a name="//apple_ref/cpp/instm/QMultiHash/QMultiHash" />
83
86
<h3 class="fn"><a name="QMultiHash"></a>QMultiHash::QMultiHash ()</h3>
84
87
<p>Constructs an empty hash.</p>
85
88
<h3 class="fn"><a name="QMultiHash-2"></a>QMultiHash::QMultiHash ( const <a href="qhash.html">QHash</a>&lt;Key, T&gt; &amp; <i>other</i> )</h3>
86
89
<p>Constructs a copy of <i>other</i> (which can be a <a href="qhash.html">QHash</a> or a <a href="qmultihash.html">QMultiHash</a>).</p>
87
90
<p>See also <a href="qhash.html#operator-eq">operator=</a>().</p>
 
91
<a name="//apple_ref/cpp/instm/QMultiHash/constFind" />
88
92
<h3 class="fn"><a name="constFind"></a><a href="qhash.html">QHash</a>&lt;Key, T&gt;::const_iterator QMultiHash::constFind ( const Key &amp; <i>key</i>, const T &amp; <i>value</i> ) const</h3>
89
93
<p>Returns an iterator pointing to the item with the <i>key</i> and the <i>value</i> in the hash.</p>
90
94
<p>If the hash contains no such item, the function returns <a href="qhash.html#constEnd">constEnd</a>().</p>
93
97
<h3 class="fn"><a name="constFind-2"></a><a href="qhash.html">QHash</a>&lt;Key, T&gt;::const_iterator QMultiHash::constFind ( const Key &amp; <i>key</i> ) const</h3>
94
98
<p>This is an overloaded function.</p>
95
99
<p>See also <a href="qhash.html#constFind">QHash::constFind</a>().</p>
 
100
<a name="//apple_ref/cpp/instm/QMultiHash/contains" />
96
101
<h3 class="fn"><a name="contains"></a>bool QMultiHash::contains ( const Key &amp; <i>key</i>, const T &amp; <i>value</i> ) const</h3>
97
102
<p>Returns true if the hash contains an item with the <i>key</i> and <i>value</i>; otherwise returns false.</p>
98
103
<p>This function was introduced in Qt 4.3.</p>
100
105
<h3 class="fn"><a name="contains-2"></a>bool QMultiHash::contains ( const Key &amp; <i>key</i> ) const</h3>
101
106
<p>This is an overloaded function.</p>
102
107
<p>See also <a href="qhash.html#contains">QHash::contains</a>().</p>
 
108
<a name="//apple_ref/cpp/instm/QMultiHash/count" />
103
109
<h3 class="fn"><a name="count"></a>int QMultiHash::count ( const Key &amp; <i>key</i>, const T &amp; <i>value</i> ) const</h3>
104
110
<p>Returns the number of items with the <i>key</i> and <i>value</i>.</p>
105
111
<p>This function was introduced in Qt 4.3.</p>
110
116
<h3 class="fn"><a name="count-3"></a>int QMultiHash::count () const</h3>
111
117
<p>This is an overloaded function.</p>
112
118
<p>See also <a href="qhash.html#count">QHash::count</a>().</p>
 
119
<a name="//apple_ref/cpp/instm/QMultiHash/find" />
113
120
<h3 class="fn"><a name="find"></a><a href="qhash.html">QHash</a>&lt;Key, T&gt;::iterator QMultiHash::find ( const Key &amp; <i>key</i>, const T &amp; <i>value</i> )</h3>
114
121
<p>Returns an iterator pointing to the item with the <i>key</i> and <i>value</i>. If the hash contains no such item, the function returns <a href="qhash.html#end">end</a>().</p>
115
122
<p>If the hash contains multiple items with the <i>key</i> and <i>value</i>, the iterator returned points to the most recently inserted item.</p>
124
131
<h3 class="fn"><a name="find-4"></a><a href="qhash.html">QHash</a>&lt;Key, T&gt;::const_iterator QMultiHash::find ( const Key &amp; <i>key</i> ) const</h3>
125
132
<p>This is an overloaded function.</p>
126
133
<p>See also <a href="qhash.html#find">QHash::find</a>().</p>
 
134
<a name="//apple_ref/cpp/instm/QMultiHash/insert" />
127
135
<h3 class="fn"><a name="insert"></a><a href="qhash.html">QHash</a>&lt;Key, T&gt;::iterator QMultiHash::insert ( const Key &amp; <i>key</i>, const T &amp; <i>value</i> )</h3>
128
136
<p>Inserts a new item with the <i>key</i> and a value of <i>value</i>.</p>
129
137
<p>If there is already an item with the same key in the hash, this function will simply create a new one. (This behavior is different from <a href="qmultihash.html#replace">replace</a>(), which overwrites the value of an existing item.)</p>
130
138
<p>See also <a href="qmultihash.html#replace">replace</a>().</p>
 
139
<a name="//apple_ref/cpp/instm/QMultiHash/remove" />
131
140
<h3 class="fn"><a name="remove"></a>int QMultiHash::remove ( const Key &amp; <i>key</i>, const T &amp; <i>value</i> )</h3>
132
141
<p>Removes all the items that have the <i>key</i> and the value <i>value</i> from the hash. Returns the number of items removed.</p>
133
142
<p>This function was introduced in Qt 4.3.</p>
135
144
<h3 class="fn"><a name="remove-2"></a>int QMultiHash::remove ( const Key &amp; <i>key</i> )</h3>
136
145
<p>This is an overloaded function.</p>
137
146
<p>See also <a href="qhash.html#remove">QHash::remove</a>().</p>
 
147
<a name="//apple_ref/cpp/instm/QMultiHash/replace" />
138
148
<h3 class="fn"><a name="replace"></a><a href="qhash.html">QHash</a>&lt;Key, T&gt;::iterator QMultiHash::replace ( const Key &amp; <i>key</i>, const T &amp; <i>value</i> )</h3>
139
149
<p>Inserts a new item with the <i>key</i> and a value of <i>value</i>.</p>
140
150
<p>If there is already an item with the <i>key</i>, that item's value is replaced with <i>value</i>.</p>
141
151
<p>If there are multiple items with the <i>key</i>, the most recently inserted item's value is replaced with <i>value</i>.</p>
142
152
<p>See also <a href="qmultihash.html#insert">insert</a>().</p>
 
153
<a name="//apple_ref/cpp/instm/QMultiHash/operator+" />
143
154
<h3 class="fn"><a name="operator-2b"></a>QMultiHash QMultiHash::operator+ ( const QMultiHash &amp; <i>other</i> ) const</h3>
144
155
<p>Returns a hash that contains all the items in this hash in addition to all the items in <i>other</i>. If a key is common to both hashes, the resulting hash will contain the key multiple times.</p>
145
156
<p>See also <a href="qmultihash.html#operator-2b-eq">operator+=</a>().</p>
 
157
<a name="//apple_ref/cpp/instm/QMultiHash/operator+=" />
146
158
<h3 class="fn"><a name="operator-2b-eq"></a>QMultiHash &amp; QMultiHash::operator+= ( const QMultiHash &amp; <i>other</i> )</h3>
147
159
<p>Inserts all the items in the <i>other</i> hash into this hash and returns a reference to this hash.</p>
148
160
<p>See also <a href="qmultihash.html#insert">insert</a>().</p>
149
161
<p /><address><hr /><div align="center">
150
162
<table width="100%" cellspacing="0" border="0"><tr class="address">
151
 
<td width="30%" align="left">Copyright &copy; 2009 Nokia Corporation and/or its subsidiary(-ies)</td>
152
 
<td width="40%" align="center"><a href="trademarks.html">Trademarks</a></td>
153
 
<td width="30%" align="right"><div align="right">Qt 4.5.2</div></td>
154
 
</tr></table></div></address></body>
 
163
<td width="40%" align="left">Copyright &copy; 2009 Nokia Corporation and/or its subsidiary(-ies)</td>
 
164
<td width="20%" align="center"><a href="trademarks.html">Trademarks</a></td>
 
165
<td width="40%" align="right"><div align="right">Qt 4.6.0</div></td>
 
166
<script type="text/javascript" src="http://www.google.com/jsapi"></script><script type="text/javascript">google.load("elements", "1", {packages: "transliteration"});</script><script type="text/javascript" src="http://www.google.com/coop/cse/t13n?form=cse-search-box&t13n_langs=en"></script><script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=cse-search-box&lang=en"></script></tr></table></div></address></body>
155
167
</html>