<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<!-- qmap.cpp -->
<head>
<title>Qt 4.6: QMap Class Reference</title>
<link href="classic.css" rel="stylesheet" type="text/css" />
</head>
<body>
<a name="//apple_ref/cpp/cl//QMap"></a>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<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>
<td width="1"> </td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a> · <a href="classes.html"><font color="#004faf">All Classes</font></a> · <a href="functions.html"><font color="#004faf">All Functions</font></a> · <a href="overviews.html"><font color="#004faf">Overviews</font></a></td></tr></table><h1 class="title">QMap Class Reference<br /><span class="small-subtitle">[<a href="qtcore.html">QtCore</a> module]</span>
</h1>
<p>The QMap class is a template class that provides a skip-list-based dictionary. <a href="#details">More...</a></p>
<pre> #include <QMap></pre><p>Inherited by <a href="qmultimap.html">QMultiMap</a>.</p>
<p><b>Note:</b> All functions in this class are <a href="threads-reentrancy.html#reentrant">reentrant</a>.</p>
<ul>
<li><a href="qmap-members.html">List of all members, including inherited members</a></li>
<li><a href="qmap-qt3.html">Qt 3 support members</a></li>
</ul>
<hr />
<a name="public-types"></a>
<h2>Public Types</h2>
<table class="alignedsummary" border="0" cellpadding="0" cellspacing="0" width="100%">
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><b><a href="qmap-const-iterator.html">const_iterator</a></b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><b><a href="qmap-iterator.html">iterator</a></b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef </td><td class="memItemRight" valign="bottom"><b><a href="qmap.html#ConstIterator-typedef">ConstIterator</a></b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef </td><td class="memItemRight" valign="bottom"><b><a href="qmap.html#Iterator-typedef">Iterator</a></b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef </td><td class="memItemRight" valign="bottom"><b><a href="qmap.html#difference_type-typedef">difference_type</a></b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef </td><td class="memItemRight" valign="bottom"><b><a href="qmap.html#key_type-typedef">key_type</a></b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef </td><td class="memItemRight" valign="bottom"><b><a href="qmap.html#mapped_type-typedef">mapped_type</a></b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef </td><td class="memItemRight" valign="bottom"><b><a href="qmap.html#size_type-typedef">size_type</a></b></td></tr>
</table>
<hr />
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary" border="0" cellpadding="0" cellspacing="0" width="100%">
<tr><td class="memItemLeft" align="right" valign="top"></td><td class="memItemRight" valign="bottom"><b><a href="qmap.html#QMap">QMap</a></b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"></td><td class="memItemRight" valign="bottom"><b><a href="qmap.html#QMap-2">QMap</a></b> ( const QMap<Key, T> & <i>other</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"></td><td class="memItemRight" valign="bottom"><b><a href="qmap.html#QMap-3">QMap</a></b> ( const std::map<Key, T> & <i>other</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"></td><td class="memItemRight" valign="bottom"><b><a href="qmap.html#dtor.QMap">~QMap</a></b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">iterator </td><td class="memItemRight" valign="bottom"><b><a href="qmap.html#begin">begin</a></b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const_iterator </td><td class="memItemRight" valign="bottom"><b><a href="qmap.html#begin-2">begin</a></b> () const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qmap.html#clear">clear</a></b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const_iterator </td><td class="memItemRight" valign="bottom"><b><a href="qmap.html#constBegin">constBegin</a></b> () const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const_iterator </td><td class="memItemRight" valign="bottom"><b><a href="qmap.html#constEnd">constEnd</a></b> () const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const_iterator </td><td class="memItemRight" valign="bottom"><b><a href="qmap.html#constFind">constFind</a></b> ( const Key & <i>key</i> ) const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><b><a href="qmap.html#contains">contains</a></b> ( const Key & <i>key</i> ) const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><b><a href="qmap.html#count">count</a></b> ( const Key & <i>key</i> ) const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><b><a href="qmap.html#count-2">count</a></b> () const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><b><a href="qmap.html#empty">empty</a></b> () const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">iterator </td><td class="memItemRight" valign="bottom"><b><a href="qmap.html#end">end</a></b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const_iterator </td><td class="memItemRight" valign="bottom"><b><a href="qmap.html#end-2">end</a></b> () const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">iterator </td><td class="memItemRight" valign="bottom"><b><a href="qmap.html#erase">erase</a></b> ( iterator <i>pos</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">iterator </td><td class="memItemRight" valign="bottom"><b><a href="qmap.html#find">find</a></b> ( const Key & <i>key</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const_iterator </td><td class="memItemRight" valign="bottom"><b><a href="qmap.html#find-2">find</a></b> ( const Key & <i>key</i> ) const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">iterator </td><td class="memItemRight" valign="bottom"><b><a href="qmap.html#insert">insert</a></b> ( const Key & <i>key</i>, const T & <i>value</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">iterator </td><td class="memItemRight" valign="bottom"><b><a href="qmap.html#insertMulti">insertMulti</a></b> ( const Key & <i>key</i>, const T & <i>value</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><b><a href="qmap.html#isEmpty">isEmpty</a></b> () const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const Key </td><td class="memItemRight" valign="bottom"><b><a href="qmap.html#key">key</a></b> ( const T & <i>value</i> ) const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const Key </td><td class="memItemRight" valign="bottom"><b><a href="qmap.html#key-2">key</a></b> ( const T & <i>value</i>, const Key & <i>defaultKey</i> ) const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QList<Key> </td><td class="memItemRight" valign="bottom"><b><a href="qmap.html#keys">keys</a></b> () const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QList<Key> </td><td class="memItemRight" valign="bottom"><b><a href="qmap.html#keys-2">keys</a></b> ( const T & <i>value</i> ) const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">iterator </td><td class="memItemRight" valign="bottom"><b><a href="qmap.html#lowerBound">lowerBound</a></b> ( const Key & <i>key</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const_iterator </td><td class="memItemRight" valign="bottom"><b><a href="qmap.html#lowerBound-2">lowerBound</a></b> ( const Key & <i>key</i> ) const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><b><a href="qmap.html#remove">remove</a></b> ( const Key & <i>key</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><b><a href="qmap.html#size">size</a></b> () const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">T </td><td class="memItemRight" valign="bottom"><b><a href="qmap.html#take">take</a></b> ( const Key & <i>key</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::map<Key, T> </td><td class="memItemRight" valign="bottom"><b><a href="qmap.html#toStdMap">toStdMap</a></b> () const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QList<Key> </td><td class="memItemRight" valign="bottom"><b><a href="qmap.html#uniqueKeys">uniqueKeys</a></b> () const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QMap<Key, T> & </td><td class="memItemRight" valign="bottom"><b><a href="qmap.html#unite">unite</a></b> ( const QMap<Key, T> & <i>other</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">iterator </td><td class="memItemRight" valign="bottom"><b><a href="qmap.html#upperBound">upperBound</a></b> ( const Key & <i>key</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const_iterator </td><td class="memItemRight" valign="bottom"><b><a href="qmap.html#upperBound-2">upperBound</a></b> ( const Key & <i>key</i> ) const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const T </td><td class="memItemRight" valign="bottom"><b><a href="qmap.html#value">value</a></b> ( const Key & <i>key</i> ) const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const T </td><td class="memItemRight" valign="bottom"><b><a href="qmap.html#value-2">value</a></b> ( const Key & <i>key</i>, const T & <i>defaultValue</i> ) const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QList<T> </td><td class="memItemRight" valign="bottom"><b><a href="qmap.html#values">values</a></b> () const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QList<T> </td><td class="memItemRight" valign="bottom"><b><a href="qmap.html#values-2">values</a></b> ( const Key & <i>key</i> ) const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><b><a href="qmap.html#operator-not-eq">operator!=</a></b> ( const QMap<Key, T> & <i>other</i> ) const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QMap<Key, T> & </td><td class="memItemRight" valign="bottom"><b><a href="qmap.html#operator-eq">operator=</a></b> ( const QMap<Key, T> & <i>other</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><b><a href="qmap.html#operator-eq-eq">operator==</a></b> ( const QMap<Key, T> & <i>other</i> ) const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">T & </td><td class="memItemRight" valign="bottom"><b><a href="qmap.html#operator-5b-5d">operator[]</a></b> ( const Key & <i>key</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const T </td><td class="memItemRight" valign="bottom"><b><a href="qmap.html#operator-5b-5d-2">operator[]</a></b> ( const Key & <i>key</i> ) const</td></tr>
</table>
<hr />
<a name="related-non-members"></a>
<h2>Related Non-Members</h2>
<table class="alignedsummary" border="0" cellpadding="0" cellspacing="0" width="100%">
<tr><td class="memItemLeft" align="right" valign="top">QDataStream & </td><td class="memItemRight" valign="bottom"><b><a href="qmap.html#operator-lt-lt-78">operator<<</a></b> ( QDataStream & <i>out</i>, const QMap<Key, T> & <i>map</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QDataStream & </td><td class="memItemRight" valign="bottom"><b><a href="qmap.html#operator-gt-gt-45">operator>></a></b> ( QDataStream & <i>in</i>, QMap<Key, T> & <i>map</i> )</td></tr>
</table>
<a name="details"></a>
<hr />
<h2>Detailed Description</h2>
<p>The QMap class is a template class that provides a skip-list-based dictionary.</p>
<p>QMap<Key, T> is one of Qt's generic <a href="containers.html#container-classes">container classes</a>. It stores (key, value) pairs and provides fast lookup of the value associated with a key.</p>
<p>QMap and <a href="qhash.html">QHash</a> provide very similar functionality. The differences are:</p>
<ul>
<li><a href="qhash.html">QHash</a> provides faster lookups than QMap. (See <a href="containers.html#algorithmic-complexity">Algorithmic Complexity</a> for details.)</li>
<li>When iterating over a <a href="qhash.html">QHash</a>, the items are arbitrarily ordered. With QMap, the items are always sorted by key.</li>
<li>The key type of a <a href="qhash.html">QHash</a> must provide operator==() and a global qHash(Key) function. The key type of a QMap must provide operator<() specifying a total order.</li>
</ul>
<p>Here's an example QMap with <a href="qstring.html">QString</a> keys and <tt>int</tt> values:</p>
<pre> QMap<QString, int> map;</pre>
<p>To insert a (key, value) pair into the map, you can use operator[]():</p>
<pre> map["one"] = 1;
map["three"] = 3;
map["seven"] = 7;</pre>
<p>This inserts the following three (key, value) pairs into the QMap: ("one", 1), ("three", 3), and ("seven", 7). Another way to insert items into the map is to use <a href="qmap.html#insert">insert</a>():</p>
<pre> map.insert("twelve", 12);</pre>
<p>To look up a value, use operator[]() or <a href="qmap.html#value">value</a>():</p>
<pre> int num1 = map["thirteen"];
int num2 = map.value("thirteen");</pre>
<p>If there is no item with the specified key in the map, these functions return a <a href="containers.html#default-constructed-values">default-constructed value</a>.</p>
<p>If you want to check whether the map contains a certain key, use <a href="qmap.html#contains">contains</a>():</p>
<pre> int timeout = 30;
if (map.contains("TIMEOUT"))
timeout = map.value("TIMEOUT");</pre>
<p>There is also a <a href="qmap.html#value">value</a>() overload that uses its second argument as a default value if there is no item with the specified key:</p>
<pre> int timeout = map.value("TIMEOUT", 30);</pre>
<p>In general, we recommend that you use <a href="qmap.html#contains">contains</a>() and <a href="qmap.html#value">value</a>() rather than operator[]() for looking up a key in a map. The reason is that operator[]() silently inserts an item into the map if no item exists with the same key (unless the map is const). For example, the following code snippet will create 1000 items in memory:</p>
<pre><span class="comment"> // WRONG</span>
QMap<int, QWidget *> map;
...
for (int i = 0; i < 1000; ++i) {
if (map[i] == okButton)
cout << "Found button at index " << i << endl;
}</pre>
<p>To avoid this problem, replace <tt>map[i]</tt> with <tt>map.value(i)</tt> in the code above.</p>
<p>If you want to navigate through all the (key, value) pairs stored in a QMap, you can use an iterator. QMap provides both <a href="containers.html#java-style-iterators">Java-style iterators</a> (<a href="qmapiterator.html">QMapIterator</a> and <a href="qmutablemapiterator.html">QMutableMapIterator</a>) and <a href="containers.html#stl-style-iterators">STL-style iterators</a> (<a href="qmap-const-iterator.html">QMap::const_iterator</a> and <a href="qmap-iterator.html">QMap::iterator</a>). Here's how to iterate over a QMap<<a href="qstring.html">QString</a>, int> using a Java-style iterator:</p>
<pre> QMapIterator<QString, int> i(map);
while (i.hasNext()) {
i.next();
cout << i.key() << ": " << i.value() << endl;
}</pre>
<p>Here's the same code, but using an STL-style iterator this time:</p>
<pre> QMap<QString, int>::const_iterator i = map.constBegin();
while (i != map.constEnd()) {
cout << i.key() << ": " << i.value() << endl;
++i;
}</pre>
<p>The items are traversed in ascending key order.</p>
<p>Normally, a QMap allows only one value per key. If you call <a href="qmap.html#insert">insert</a>() with a key that already exists in the QMap, the previous value will be erased. For example:</p>
<pre> map.insert("plenty", 100);
map.insert("plenty", 2000);
<span class="comment"> // map.value("plenty") == 2000</span></pre>
<p>However, you can store multiple values per key by using <a href="qmap.html#insertMulti">insertMulti</a>() instead of <a href="qmap.html#insert">insert</a>() (or using the convenience subclass <a href="qmultimap.html">QMultiMap</a>). If you want to retrieve all the values for a single key, you can use values(const Key &key), which returns a <a href="qlist.html">QList</a><T>:</p>
<pre> QList<int> values = map.values("plenty");
for (int i = 0; i < values.size(); ++i)
cout << values.at(i) << endl;</pre>
<p>The items that share the same key are available from most recently to least recently inserted. Another approach is to call <a href="qmap.html#find">find</a>() to get the STL-style iterator for the first item with a key and iterate from there:</p>
<pre> QMap<QString, int>::iterator i = map.find("plenty");
while (i != map.end() && i.key() == "plenty") {
cout << i.value() << endl;
++i;
}</pre>
<p>If you only need to extract the values from a map (not the keys), you can also use <a href="containers.html#foreach">foreach</a>:</p>
<pre> QMap<QString, int> map;
...
foreach (int value, map)
cout << value << endl;</pre>
<p>Items can be removed from the map in several ways. One way is to call <a href="qmap.html#remove">remove</a>(); this will remove any item with the given key. Another way is to use <a href="qmutablemapiterator.html#remove">QMutableMapIterator::remove</a>(). In addition, you can clear the entire map using <a href="qmap.html#clear">clear</a>().</p>
<p>QMap's key and value data types must be <a href="containers.html#assignable-data-types">assignable data types</a>. This covers most data types you are likely to encounter, but the compiler won't let you, for example, store a <a href="qwidget.html">QWidget</a> as a value; instead, store a <a href="qwidget.html">QWidget</a> *. In addition, QMap's key type must provide operator<(). QMap uses it to keep its items sorted, and assumes that two keys <tt>x</tt> and <tt>y</tt> are equal if neither <tt>x < y</tt> nor <tt>y < x</tt> is true.</p>
<p>Example:</p>
<pre> #ifndef EMPLOYEE_H
#define EMPLOYEE_H
class Employee
{
public:
Employee() {}
Employee(const QString &name, const QDate &dateOfBirth);
...
private:
QString myName;
QDate myDateOfBirth;
};
inline bool operator<(const Employee &e1, const Employee &e2)
{
if (e1.name() != e2.name())
return e1.name() < e2.name();
return e1.dateOfBirth() < e2.dateOfBirth();
}
#endif <span class="comment">// EMPLOYEE_H</span></pre>
<p>In the example, we start by comparing the employees' names. If they're equal, we compare their dates of birth to break the tie.</p>
<p>See also <a href="qmapiterator.html">QMapIterator</a>, <a href="qmutablemapiterator.html">QMutableMapIterator</a>, <a href="qhash.html">QHash</a>, and <a href="qset.html">QSet</a>.</p>
<hr />
<h2>Member Type Documentation</h2>
<a name="//apple_ref/cpp/tdef/QMap/ConstIterator"></a>
<h3 class="fn"><a name="ConstIterator-typedef"></a>typedef QMap::ConstIterator</h3>
<p>Qt-style synonym for <a href="qmap-const-iterator.html">QMap::const_iterator</a>.</p>
<a name="//apple_ref/cpp/tdef/QMap/Iterator"></a>
<h3 class="fn"><a name="Iterator-typedef"></a>typedef QMap::Iterator</h3>
<p>Qt-style synonym for <a href="qmap-iterator.html">QMap::iterator</a>.</p>
<a name="//apple_ref/cpp/tdef/QMap/difference_type"></a>
<h3 class="fn"><a name="difference_type-typedef"></a>typedef QMap::difference_type</h3>
<p>Typedef for ptrdiff_t. Provided for STL compatibility.</p>
<a name="//apple_ref/cpp/tdef/QMap/key_type"></a>
<h3 class="fn"><a name="key_type-typedef"></a>typedef QMap::key_type</h3>
<p>Typedef for Key. Provided for STL compatibility.</p>
<a name="//apple_ref/cpp/tdef/QMap/mapped_type"></a>
<h3 class="fn"><a name="mapped_type-typedef"></a>typedef QMap::mapped_type</h3>
<p>Typedef for T. Provided for STL compatibility.</p>
<a name="//apple_ref/cpp/tdef/QMap/size_type"></a>
<h3 class="fn"><a name="size_type-typedef"></a>typedef QMap::size_type</h3>
<p>Typedef for int. Provided for STL compatibility.</p>
<hr />
<h2>Member Function Documentation</h2>
<a name="//apple_ref/cpp/instm/QMap/QMap"></a>
<h3 class="fn"><a name="QMap"></a>QMap::QMap ()</h3>
<p>Constructs an empty map.</p>
<p>See also <a href="qmap.html#clear">clear</a>().</p>
<h3 class="fn"><a name="QMap-2"></a>QMap::QMap ( const QMap<Key, T> & <i>other</i> )</h3>
<p>Constructs a copy of <i>other</i>.</p>
<p>This operation occurs in <a href="containers.html#constant-time">constant time</a>, because <a href="qmap.html">QMap</a> is <a href="implicit-sharing.html#implicitly-shared">implicitly shared</a>. This makes returning a <a href="qmap.html">QMap</a> from a function very fast. If a shared instance is modified, it will be copied (copy-on-write), and this takes <a href="containers.html#linear-time">linear time</a>.</p>
<p>See also <a href="qmap.html#operator-eq">operator=</a>().</p>
<h3 class="fn"><a name="QMap-3"></a>QMap::QMap ( const std::map<Key, T> & <i>other</i> )</h3>
<p>Constructs a copy of <i>other</i>.</p>
<p>This function is only available if Qt is configured with STL compatibility enabled.</p>
<p>See also <a href="qmap.html#toStdMap">toStdMap</a>().</p>
<a name="//apple_ref/cpp/instm/QMap/~QMap"></a>
<h3 class="fn"><a name="dtor.QMap"></a>QMap::~QMap ()</h3>
<p>Destroys the map. References to the values in the map, and all iterators over this map, become invalid.</p>
<a name="//apple_ref/cpp/instm/QMap/begin"></a>
<h3 class="fn"><a name="begin"></a><a href="qmap-iterator.html">iterator</a> QMap::begin ()</h3>
<p>Returns an <a href="containers.html#stl-style-iterators">STL-style iterator</a> pointing to the first item in the map.</p>
<p>See also <a href="qmap.html#constBegin">constBegin</a>() and <a href="qmap.html#end">end</a>().</p>
<h3 class="fn"><a name="begin-2"></a><a href="qmap-const-iterator.html">const_iterator</a> QMap::begin () const</h3>
<p>This is an overloaded function.</p>
<a name="//apple_ref/cpp/instm/QMap/clear"></a>
<h3 class="fn"><a name="clear"></a>void QMap::clear ()</h3>
<p>Removes all items from the map.</p>
<p>See also <a href="qmap.html#remove">remove</a>().</p>
<a name="//apple_ref/cpp/instm/QMap/constBegin"></a>
<h3 class="fn"><a name="constBegin"></a><a href="qmap-const-iterator.html">const_iterator</a> QMap::constBegin () const</h3>
<p>Returns a const <a href="containers.html#stl-style-iterators">STL-style iterator</a> pointing to the first item in the map.</p>
<p>See also <a href="qmap.html#begin">begin</a>() and <a href="qmap.html#constEnd">constEnd</a>().</p>
<a name="//apple_ref/cpp/instm/QMap/constEnd"></a>
<h3 class="fn"><a name="constEnd"></a><a href="qmap-const-iterator.html">const_iterator</a> QMap::constEnd () const</h3>
<p>Returns a const <a href="containers.html#stl-style-iterators">STL-style iterator</a> pointing to the imaginary item after the last item in the map.</p>
<p>See also <a href="qmap.html#constBegin">constBegin</a>() and <a href="qmap.html#end">end</a>().</p>
<a name="//apple_ref/cpp/instm/QMap/constFind"></a>
<h3 class="fn"><a name="constFind"></a><a href="qmap-const-iterator.html">const_iterator</a> QMap::constFind ( const Key & <i>key</i> ) const</h3>
<p>Returns an const iterator pointing to the item with key <i>key</i> in the map.</p>
<p>If the map contains no item with key <i>key</i>, the function returns <a href="qmap.html#constEnd">constEnd</a>().</p>
<p>This function was introduced in Qt 4.1.</p>
<p>See also <a href="qmap.html#find">find</a>() and <a href="qmultimap.html#constFind">QMultiMap::constFind</a>().</p>
<a name="//apple_ref/cpp/instm/QMap/contains"></a>
<h3 class="fn"><a name="contains"></a>bool QMap::contains ( const Key & <i>key</i> ) const</h3>
<p>Returns true if the map contains an item with key <i>key</i>; otherwise returns false.</p>
<p>See also <a href="qmap.html#count">count</a>() and <a href="qmultimap.html#contains">QMultiMap::contains</a>().</p>
<a name="//apple_ref/cpp/instm/QMap/count"></a>
<h3 class="fn"><a name="count"></a>int QMap::count ( const Key & <i>key</i> ) const</h3>
<p>Returns the number of items associated with key <i>key</i>.</p>
<p>See also <a href="qmap.html#contains">contains</a>(), <a href="qmap.html#insertMulti">insertMulti</a>(), and <a href="qmultimap.html#count">QMultiMap::count</a>().</p>
<h3 class="fn"><a name="count-2"></a>int QMap::count () const</h3>
<p>This is an overloaded function.</p>
<p>Same as <a href="qmap.html#size">size</a>().</p>
<a name="//apple_ref/cpp/instm/QMap/empty"></a>
<h3 class="fn"><a name="empty"></a>bool QMap::empty () const</h3>
<p>This function is provided for STL compatibility. It is equivalent to <a href="qmap.html#isEmpty">isEmpty</a>(), returning true if the map is empty; otherwise returning false.</p>
<a name="//apple_ref/cpp/instm/QMap/end"></a>
<h3 class="fn"><a name="end"></a><a href="qmap-iterator.html">iterator</a> QMap::end ()</h3>
<p>Returns an <a href="containers.html#stl-style-iterators">STL-style iterator</a> pointing to the imaginary item after the last item in the map.</p>
<p>See also <a href="qmap.html#begin">begin</a>() and <a href="qmap.html#constEnd">constEnd</a>().</p>
<h3 class="fn"><a name="end-2"></a><a href="qmap-const-iterator.html">const_iterator</a> QMap::end () const</h3>
<p>This is an overloaded function.</p>
<a name="//apple_ref/cpp/instm/QMap/erase"></a>
<h3 class="fn"><a name="erase"></a><a href="qmap-iterator.html">iterator</a> QMap::erase ( <a href="qmap-iterator.html">iterator</a> <i>pos</i> )</h3>
<p>Removes the (key, value) pair pointed to by the iterator <i>pos</i> from the map, and returns an iterator to the next item in the map.</p>
<p>See also <a href="qmap.html#remove">remove</a>().</p>
<a name="//apple_ref/cpp/instm/QMap/find"></a>
<h3 class="fn"><a name="find"></a><a href="qmap-iterator.html">iterator</a> QMap::find ( const Key & <i>key</i> )</h3>
<p>Returns an iterator pointing to the item with key <i>key</i> in the map.</p>
<p>If the map contains no item with key <i>key</i>, the function returns <a href="qmap.html#end">end</a>().</p>
<p>If the map contains multiple items with key <i>key</i>, this function returns an iterator that points to the most recently inserted value. The other values are accessible by incrementing the iterator. For example, here's some code that iterates over all the items with the same key:</p>
<pre> QMap<QString, int> map;
...
QMap<QString, int>::const_iterator i = map.find("HDR");
while (i != map.end() && i.key() == "HDR") {
cout << i.value() << endl;
++i;
}</pre>
<p>See also <a href="qmap.html#constFind">constFind</a>(), <a href="qmap.html#value">value</a>(), <a href="qmap.html#values">values</a>(), <a href="qmap.html#lowerBound">lowerBound</a>(), <a href="qmap.html#upperBound">upperBound</a>(), and <a href="qmultimap.html#find">QMultiMap::find</a>().</p>
<h3 class="fn"><a name="find-2"></a><a href="qmap-const-iterator.html">const_iterator</a> QMap::find ( const Key & <i>key</i> ) const</h3>
<p>This is an overloaded function.</p>
<a name="//apple_ref/cpp/instm/QMap/insert"></a>
<h3 class="fn"><a name="insert"></a><a href="qmap-iterator.html">iterator</a> QMap::insert ( const Key & <i>key</i>, const T & <i>value</i> )</h3>
<p>Inserts a new item with the key <i>key</i> and a value of <i>value</i>.</p>
<p>If there is already an item with the key <i>key</i>, that item's value is replaced with <i>value</i>.</p>
<p>If there are multiple items with the key <i>key</i>, the most recently inserted item's value is replaced with <i>value</i>.</p>
<p>See also <a href="qmap.html#insertMulti">insertMulti</a>().</p>
<a name="//apple_ref/cpp/instm/QMap/insertMulti"></a>
<h3 class="fn"><a name="insertMulti"></a><a href="qmap-iterator.html">iterator</a> QMap::insertMulti ( const Key & <i>key</i>, const T & <i>value</i> )</h3>
<p>Inserts a new item with the key <i>key</i> and a value of <i>value</i>.</p>
<p>If there is already an item with the same key in the map, this function will simply create a new one. (This behavior is different from <a href="qmap.html#insert">insert</a>(), which overwrites the value of an existing item.)</p>
<p>See also <a href="qmap.html#insert">insert</a>() and <a href="qmap.html#values">values</a>().</p>
<a name="//apple_ref/cpp/instm/QMap/isEmpty"></a>
<h3 class="fn"><a name="isEmpty"></a>bool QMap::isEmpty () const</h3>
<p>Returns true if the map contains no items; otherwise returns false.</p>
<p>See also <a href="qmap.html#size">size</a>().</p>
<a name="//apple_ref/cpp/instm/QMap/key"></a>
<h3 class="fn"><a name="key"></a>const Key QMap::key ( const T & <i>value</i> ) const</h3>
<p>Returns the first key with value <i>value</i>.</p>
<p>If the map contains no item with value <i>value</i>, the function returns a <a href="containers.html#default-constructed-values">default-constructed key</a>.</p>
<p>This function can be slow (<a href="containers.html#linear-time">linear time</a>), because <a href="qmap.html">QMap</a>'s internal data structure is optimized for fast lookup by key, not by value.</p>
<p>See also <a href="qmap.html#value">value</a>() and <a href="qmap.html#keys">keys</a>().</p>
<h3 class="fn"><a name="key-2"></a>const Key QMap::key ( const T & <i>value</i>, const Key & <i>defaultKey</i> ) const</h3>
<p>This is an overloaded function.</p>
<p>Returns the first key with value <i>value</i>, or <i>defaultKey</i> if the map contains no item with value <i>value</i>.</p>
<p>This function can be slow (<a href="containers.html#linear-time">linear time</a>), because <a href="qmap.html">QMap</a>'s internal data structure is optimized for fast lookup by key, not by value.</p>
<p>This function was introduced in Qt 4.3.</p>
<a name="//apple_ref/cpp/instm/QMap/keys"></a>
<h3 class="fn"><a name="keys"></a><a href="qlist.html">QList</a><Key> QMap::keys () const</h3>
<p>Returns a list containing all the keys in the map in ascending order. Keys that occur multiple times in the map (because items were inserted with <a href="qmap.html#insertMulti">insertMulti</a>(), or <a href="qmap.html#unite">unite</a>() was used) also occur multiple times in the list.</p>
<p>To obtain a list of unique keys, where each key from the map only occurs once, use <a href="qmap.html#uniqueKeys">uniqueKeys</a>().</p>
<p>The order is guaranteed to be the same as that used by <a href="qmap.html#values">values</a>().</p>
<p>See also <a href="qmap.html#uniqueKeys">uniqueKeys</a>(), <a href="qmap.html#values">values</a>(), and <a href="qmap.html#key">key</a>().</p>
<h3 class="fn"><a name="keys-2"></a><a href="qlist.html">QList</a><Key> QMap::keys ( const T & <i>value</i> ) const</h3>
<p>This is an overloaded function.</p>
<p>Returns a list containing all the keys associated with value <i>value</i> in ascending order.</p>
<p>This function can be slow (<a href="containers.html#linear-time">linear time</a>), because <a href="qmap.html">QMap</a>'s internal data structure is optimized for fast lookup by key, not by value.</p>
<a name="//apple_ref/cpp/instm/QMap/lowerBound"></a>
<h3 class="fn"><a name="lowerBound"></a><a href="qmap-iterator.html">iterator</a> QMap::lowerBound ( const Key & <i>key</i> )</h3>
<p>Returns an iterator pointing to the first item with key <i>key</i> in the map. If the map contains no item with key <i>key</i>, the function returns an iterator to the nearest item with a greater key.</p>
<p>Example:</p>
<pre> QMap<int, QString> map;
map.insert(1, "one");
map.insert(5, "five");
map.insert(10, "ten");
map.lowerBound(0); <span class="comment">// returns iterator to (1, "one")</span>
map.lowerBound(1); <span class="comment">// returns iterator to (1, "one")</span>
map.lowerBound(2); <span class="comment">// returns iterator to (5, "five")</span>
map.lowerBound(10); <span class="comment">// returns iterator to (10, "ten")</span>
map.lowerBound(999); <span class="comment">// returns end()</span></pre>
<p>If the map contains multiple items with key <i>key</i>, this function returns an iterator that points to the most recently inserted value. The other values are accessible by incrementing the iterator. For example, here's some code that iterates over all the items with the same key:</p>
<pre> QMap<QString, int> map;
...
QMap<QString, int>::const_iterator i = map.lowerBound("HDR");
QMap<QString, int>::const_iterator upperBound = map.upperBound("HDR");
while (i != upperBound) {
cout << i.value() << endl;
++i;
}</pre>
<p>See also <a href="qtalgorithms.html#qLowerBound">qLowerBound</a>(), <a href="qmap.html#upperBound">upperBound</a>(), and <a href="qmap.html#find">find</a>().</p>
<h3 class="fn"><a name="lowerBound-2"></a><a href="qmap-const-iterator.html">const_iterator</a> QMap::lowerBound ( const Key & <i>key</i> ) const</h3>
<p>This is an overloaded function.</p>
<a name="//apple_ref/cpp/instm/QMap/remove"></a>
<h3 class="fn"><a name="remove"></a>int QMap::remove ( const Key & <i>key</i> )</h3>
<p>Removes all the items that have the key <i>key</i> from the map. Returns the number of items removed which is usually 1 but will be 0 if the key isn't in the map, or > 1 if <a href="qmap.html#insertMulti">insertMulti</a>() has been used with the <i>key</i>.</p>
<p>See also <a href="qmap.html#clear">clear</a>(), <a href="qmap.html#take">take</a>(), and <a href="qmultimap.html#remove">QMultiMap::remove</a>().</p>
<a name="//apple_ref/cpp/instm/QMap/size"></a>
<h3 class="fn"><a name="size"></a>int QMap::size () const</h3>
<p>Returns the number of (key, value) pairs in the map.</p>
<p>See also <a href="qmap.html#isEmpty">isEmpty</a>() and <a href="qmap.html#count">count</a>().</p>
<a name="//apple_ref/cpp/instm/QMap/take"></a>
<h3 class="fn"><a name="take"></a>T QMap::take ( const Key & <i>key</i> )</h3>
<p>Removes the item with the key <i>key</i> from the map and returns the value associated with it.</p>
<p>If the item does not exist in the map, the function simply returns a <a href="containers.html#default-constructed-values">default-constructed value</a>. If there are multiple items for <i>key</i> in the map, only the most recently inserted one is removed and returned.</p>
<p>If you don't use the return value, <a href="qmap.html#remove">remove</a>() is more efficient.</p>
<p>See also <a href="qmap.html#remove">remove</a>().</p>
<a name="//apple_ref/cpp/instm/QMap/toStdMap"></a>
<h3 class="fn"><a name="toStdMap"></a>std::map<Key, T> QMap::toStdMap () const</h3>
<p>Returns an STL map equivalent to this <a href="qmap.html">QMap</a>.</p>
<p>This function is only available if Qt is configured with STL compatibility enabled.</p>
<a name="//apple_ref/cpp/instm/QMap/uniqueKeys"></a>
<h3 class="fn"><a name="uniqueKeys"></a><a href="qlist.html">QList</a><Key> QMap::uniqueKeys () const</h3>
<p>Returns a list containing all the keys in the map in ascending order. Keys that occur multiple times in the map (because items were inserted with <a href="qmap.html#insertMulti">insertMulti</a>(), or <a href="qmap.html#unite">unite</a>() was used) occur only once in the returned list.</p>
<p>This function was introduced in Qt 4.2.</p>
<p>See also <a href="qmap.html#keys">keys</a>() and <a href="qmap.html#values">values</a>().</p>
<a name="//apple_ref/cpp/instm/QMap/unite"></a>
<h3 class="fn"><a name="unite"></a>QMap<Key, T> & QMap::unite ( const QMap<Key, T> & <i>other</i> )</h3>
<p>Inserts all the items in the <i>other</i> map into this map. If a key is common to both maps, the resulting map will contain the key multiple times.</p>
<p>See also <a href="qmap.html#insertMulti">insertMulti</a>().</p>
<a name="//apple_ref/cpp/instm/QMap/upperBound"></a>
<h3 class="fn"><a name="upperBound"></a><a href="qmap-iterator.html">iterator</a> QMap::upperBound ( const Key & <i>key</i> )</h3>
<p>Returns an iterator pointing to the item that immediately follows the last item with key <i>key</i> in the map. If the map contains no item with key <i>key</i>, the function returns an iterator to the nearest item with a greater key.</p>
<p>Example:</p>
<pre> QMap<int, QString> map;
map.insert(1, "one");
map.insert(5, "five");
map.insert(10, "ten");
map.upperBound(0); <span class="comment">// returns iterator to (1, "one")</span>
map.upperBound(1); <span class="comment">// returns iterator to (5, "five")</span>
map.upperBound(2); <span class="comment">// returns iterator to (5, "five")</span>
map.upperBound(10); <span class="comment">// returns end()</span>
map.upperBound(999); <span class="comment">// returns end()</span></pre>
<p>See also <a href="qtalgorithms.html#qUpperBound">qUpperBound</a>(), <a href="qmap.html#lowerBound">lowerBound</a>(), and <a href="qmap.html#find">find</a>().</p>
<h3 class="fn"><a name="upperBound-2"></a><a href="qmap-const-iterator.html">const_iterator</a> QMap::upperBound ( const Key & <i>key</i> ) const</h3>
<p>This is an overloaded function.</p>
<a name="//apple_ref/cpp/instm/QMap/value"></a>
<h3 class="fn"><a name="value"></a>const T QMap::value ( const Key & <i>key</i> ) const</h3>
<p>Returns the value associated with the key <i>key</i>.</p>
<p>If the map contains no item with key <i>key</i>, the function returns a <a href="containers.html#default-constructed-values">default-constructed value</a>. If there are multiple items for <i>key</i> in the map, the value of the most recently inserted one is returned.</p>
<p>See also <a href="qmap.html#key">key</a>(), <a href="qmap.html#values">values</a>(), <a href="qmap.html#contains">contains</a>(), and <a href="qmap.html#operator-5b-5d">operator[]</a>().</p>
<h3 class="fn"><a name="value-2"></a>const T QMap::value ( const Key & <i>key</i>, const T & <i>defaultValue</i> ) const</h3>
<p>This is an overloaded function.</p>
<p>If the map contains no item with key <i>key</i>, the function returns <i>defaultValue</i>.</p>
<a name="//apple_ref/cpp/instm/QMap/values"></a>
<h3 class="fn"><a name="values"></a><a href="qlist.html">QList</a><T> QMap::values () const</h3>
<p>Returns a list containing all the values in the map, in ascending order of their keys. If a key is associated with multiple values, all of its values will be in the list, and not just the most recently inserted one.</p>
<p>See also <a href="qmap.html#keys">keys</a>() and <a href="qmap.html#value">value</a>().</p>
<h3 class="fn"><a name="values-2"></a><a href="qlist.html">QList</a><T> QMap::values ( const Key & <i>key</i> ) const</h3>
<p>This is an overloaded function.</p>
<p>Returns a list containing all the values associated with key <i>key</i>, from the most recently inserted to the least recently inserted one.</p>
<p>See also <a href="qmap.html#count">count</a>() and <a href="qmap.html#insertMulti">insertMulti</a>().</p>
<a name="//apple_ref/cpp/instm/QMap/operator!="></a>
<h3 class="fn"><a name="operator-not-eq"></a>bool QMap::operator!= ( const QMap<Key, T> & <i>other</i> ) const</h3>
<p>Returns true if <i>other</i> is not equal to this map; otherwise returns false.</p>
<p>Two maps are considered equal if they contain the same (key, value) pairs.</p>
<p>This function requires the value type to implement <tt>operator==()</tt>.</p>
<p>See also <a href="qmap.html#operator-eq-eq">operator==</a>().</p>
<a name="//apple_ref/cpp/instm/QMap/operator="></a>
<h3 class="fn"><a name="operator-eq"></a>QMap<Key, T> & QMap::operator= ( const QMap<Key, T> & <i>other</i> )</h3>
<p>Assigns <i>other</i> to this map and returns a reference to this map.</p>
<a name="//apple_ref/cpp/instm/QMap/operator=="></a>
<h3 class="fn"><a name="operator-eq-eq"></a>bool QMap::operator== ( const QMap<Key, T> & <i>other</i> ) const</h3>
<p>Returns true if <i>other</i> is equal to this map; otherwise returns false.</p>
<p>Two maps are considered equal if they contain the same (key, value) pairs.</p>
<p>This function requires the value type to implement <tt>operator==()</tt>.</p>
<p>See also <a href="qmap.html#operator-not-eq">operator!=</a>().</p>
<a name="//apple_ref/cpp/instm/QMap/operator[]"></a>
<h3 class="fn"><a name="operator-5b-5d"></a>T & QMap::operator[] ( const Key & <i>key</i> )</h3>
<p>Returns the value associated with the key <i>key</i> as a modifiable reference.</p>
<p>If the map contains no item with key <i>key</i>, the function inserts a <a href="containers.html#default-constructed-values">default-constructed value</a> into the map with key <i>key</i>, and returns a reference to it. If the map contains multiple items with key <i>key</i>, this function returns a reference to the most recently inserted value.</p>
<p>See also <a href="qmap.html#insert">insert</a>() and <a href="qmap.html#value">value</a>().</p>
<h3 class="fn"><a name="operator-5b-5d-2"></a>const T QMap::operator[] ( const Key & <i>key</i> ) const</h3>
<p>This is an overloaded function.</p>
<p>Same as <a href="qmap.html#value">value</a>().</p>
<hr />
<h2>Related Non-Members</h2>
<h3 class="fn"><a name="operator-lt-lt-78"></a><a href="qdatastream.html">QDataStream</a> & operator<< ( <a href="qdatastream.html">QDataStream</a> & <i>out</i>, const QMap<Key, T> & <i>map</i> )</h3>
<p>Writes the map <i>map</i> to stream <i>out</i>.</p>
<p>This function requires the key and value types to implement <tt>operator<<()</tt>.</p>
<p>See also <a href="datastreamformat.html">Format of the QDataStream operators</a>.</p>
<h3 class="fn"><a name="operator-gt-gt-45"></a><a href="qdatastream.html">QDataStream</a> & operator>> ( <a href="qdatastream.html">QDataStream</a> & <i>in</i>, QMap<Key, T> & <i>map</i> )</h3>
<p>Reads a map from stream <i>in</i> into <i>map</i>.</p>
<p>This function requires the key and value types to implement <tt>operator>>()</tt>.</p>
<p>See also <a href="datastreamformat.html">Format of the QDataStream operators</a>.</p>
<p /><address><hr /><div align="center">
<table width="100%" cellspacing="0" border="0"><tr class="address">
<td width="40%" align="left">Copyright © 2010 Nokia Corporation and/or its subsidiary(-ies)</td>
<td width="20%" align="center"><a href="trademarks.html">Trademarks</a></td>
<td width="40%" align="right"><div align="right">Qt 4.6.3</div></td>
</tr></table></div></address></body>
</html>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
8e6051afcdb111a0317a58fb64c2abf5
>
files
>
4478
