diff options
Diffstat (limited to 'doc/html/qpair.html')
| -rw-r--r-- | doc/html/qpair.html | 126 |
1 files changed, 126 insertions, 0 deletions
diff --git a/doc/html/qpair.html b/doc/html/qpair.html new file mode 100644 index 0000000..d0f7512 --- /dev/null +++ b/doc/html/qpair.html @@ -0,0 +1,126 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<!-- /home/espenr/tmp/qt-3.3.8-espenr-2499/qt-x11-free-3.3.8/doc/qpair.doc:40 --> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title>QPair Class</title> +<style type="text/css"><!-- +fn { margin-left: 1cm; text-indent: -1cm; } +a:link { color: #004faf; text-decoration: none } +a:visited { color: #672967; text-decoration: none } +body { background: #ffffff; color: black; } +--></style> +</head> +<body> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> +<tr bgcolor="#E5E5E5"> +<td 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="mainclasses.html"> +<font color="#004faf">Main Classes</font></a> + | <a href="annotated.html"> +<font color="#004faf">Annotated</font></a> + | <a href="groups.html"> +<font color="#004faf">Grouped Classes</font></a> + | <a href="functions.html"> +<font color="#004faf">Functions</font></a> +</td> +<td align="right" valign="center"><img src="logo32.png" align="right" width="64" height="32" border="0"></td></tr></table><h1 align=center>QPair Class Reference</h1> + +<p>The QPair class is a value-based template class that provides a pair of elements. +<a href="#details">More...</a> +<p><tt>#include <<a href="qpair-h.html">qpair.h</a>></tt> +<p><a href="qpair-members.html">List of all member functions.</a> +<h2>Public Members</h2> +<ul> +<li class=fn>typedef T1 <a href="#first_type"><b>first_type</b></a></li> +<li class=fn>typedef T2 <a href="#second_type"><b>second_type</b></a></li> +<li class=fn><a href="#QPair"><b>QPair</b></a> ()</li> +<li class=fn><a href="#QPair-2"><b>QPair</b></a> ( const T1 & t1, const T2 & t2 )</li> +<li class=fn>QPair<T1, T2> & <b>operator=</b> ( const QPair<T1, T2> & other )</li> +</ul> +<h2>Related Functions</h2> +<ul> +<li class=fn>QPair <a href="#qMakePair"><b>qMakePair</b></a> ( T1 t1, T2 t2 )</li> +</ul> +<hr><a name="details"></a><h2>Detailed Description</h2> + + +The QPair class is a value-based template class that provides a pair of elements. +<p> + + +<p> QPair is a Qt implementation of an STL-like pair. It can be used +in your application if the standard pair<> is not available on +your target platforms. +<p> QPair<T1, T2> defines a template instance to create a pair of +values that contains two values of type T1 and T2. Please note +that QPair does not store pointers to the two elements; it holds a +copy of every member. This is why these kinds of classes are +called <em>value based</em>. If you're interested in <em>pointer based</em> +classes see, for example, <a href="qptrlist.html">QPtrList</a> and <a href="qdict.html">QDict</a>. +<p> QPair holds one copy of type T1 and one copy of type T2, but does +not provide iterators to access these elements. Instead, the two +elements (<tt>first</tt> and <tt>second</tt>) are public member variables of +the pair. QPair owns the contained elements. For more relaxed +ownership semantics, see <a href="qptrcollection.html">QPtrCollection</a> and friends which are +pointer-based containers. +<p> Some classes cannot be used within a QPair: for example, all +classes derived from <a href="qobject.html">QObject</a> and thus all classes that implement +widgets. Only "values" can be used in a QPair. To qualify as a +value the class must provide: +<p> <ul> +<li> A copy constructor +<li> An assignment operator +<li> A constructor that takes no arguments +</ul> +<p> Note that C++ defaults to field-by-field assignment operators and +copy constructors if no explicit version is supplied. In many +cases this is sufficient. +<p> QPair uses an STL-like syntax to manipulate and address the +objects it contains. See the <a href="qtl.html">QTL + documentation</a> for more information. +<p> Functions that need to return two values can use a QPair. +<p>See also <a href="qtl.html">Qt Template Library Classes</a>, <a href="shared.html">Implicitly and Explicitly Shared Classes</a>, and <a href="tools.html">Non-GUI Classes</a>. + +<hr><h2>Member Type Documentation</h2> +<h3 class=fn><a name="first_type"></a>QPair::first_type</h3> +The type of the first element in the pair. +<h3 class=fn><a name="second_type"></a>QPair::second_type</h3> +The type of the second element in the pair. +<hr><h2>Member Function Documentation</h2> +<h3 class=fn><a name="QPair"></a>QPair::QPair () +</h3> + +<p> Constructs an empty pair. The <tt>first</tt> and <tt>second</tt> elements are +default constructed. + +<h3 class=fn><a name="QPair-2"></a>QPair::QPair ( const T1 & t1, const T2 & t2 ) +</h3> + +<p> Constructs a pair and initializes the <tt>first</tt> element with <em>t1</em> +and the <tt>second</tt> element with <em>t2</em>. + +<hr><h2>Related Functions</h2> +<h3 class=fn><a href="qpair.html">QPair</a> <a name="qMakePair"></a>qMakePair ( T1 t1, T2 t2 ) +</h3> + +<p> +<p> This is a template convenience function. It is used to create a +QPair<> object that contains <em>t1</em> and <em>t2</em>. + +<!-- eof --> +<hr><p> +This file is part of the <a href="index.html">Qt toolkit</a>. +Copyright © 1995-2007 +<a href="http://www.trolltech.com/">Trolltech</a>. All Rights Reserved.<p><address><hr><div align=center> +<table width=100% cellspacing=0 border=0><tr> +<td>Copyright © 2007 +<a href="troll.html">Trolltech</a><td align=center><a href="trademarks.html">Trademarks</a> +<td align=right><div align=right>Qt 3.3.8</div> +</table></div></address></body> +</html> |