summaryrefslogtreecommitdiffstats
path: root/doc/html/tqpair.html
blob: 5058b3a6a03ed06fb40b4af365706a44c43bbe39 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>TQPair 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&nbsp;Classes</font></a>
 | <a href="mainclasses.html">
<font color="#004faf">Main&nbsp;Classes</font></a>
 | <a href="annotated.html">
<font color="#004faf">Annotated</font></a>
 | <a href="groups.html">
<font color="#004faf">Grouped&nbsp;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>TQPair Class Reference</h1>

<p>The TQPair class is a value-based template class that provides a pair of elements.
<a href="#details">More...</a>
<p><tt>#include &lt;<a href="tqpair-h.html">tqpair.h</a>&gt;</tt>
<p><a href="tqpair-members.html">List of all member functions.</a>
<h2>Public Members</h2>
<ul>
<li class=fn>typedef T1&nbsp;<a href="#first_type"><b>first_type</b></a></li>
<li class=fn>typedef T2&nbsp;<a href="#second_type"><b>second_type</b></a></li>
<li class=fn><a href="#TQPair"><b>TQPair</b></a> ()</li>
<li class=fn><a href="#TQPair-2"><b>TQPair</b></a> ( const&nbsp;T1&nbsp;&amp;&nbsp;t1, const&nbsp;T2&nbsp;&amp;&nbsp;t2 )</li>
<li class=fn>TQPair&lt;T1, T2&gt; &amp; <b>operator=</b> ( const&nbsp;TQPair&lt;T1,&nbsp;T2&gt;&nbsp;&amp;&nbsp;other )</li>
</ul>
<h2>Related Functions</h2>
<ul>
<li class=fn>TQPair <a href="#qMakePair"><b>qMakePair</b></a> ( T1&nbsp;t1, T2&nbsp;t2 )</li>
</ul>
<hr><a name="details"></a><h2>Detailed Description</h2>


The TQPair class is a value-based template class that provides a pair of elements.
<p> 


<p> TQPair is a TQt implementation of an STL-like pair. It can be used
in your application if the standard pair&lt;&gt; is not available on
your target platforms.
<p> TQPair&lt;T1, T2&gt; defines a template instance to create a pair of
values that contains two values of type T1 and T2. Please note
that TQPair 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="tqptrlist.html">TQPtrList</a> and <a href="tqdict.html">TQDict</a>.
<p> TQPair 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. TQPair owns the contained elements. For more relaxed
ownership semantics, see <a href="tqptrcollection.html">TQPtrCollection</a> and friends which are
pointer-based containers.
<p> Some classes cannot be used within a TQPair: for example, all
classes derived from <a href="tqobject.html">TQObject</a> and thus all classes that implement
widgets. Only "values" can be used in a TQPair. 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> TQPair uses an STL-like syntax to manipulate and address the
objects it contains. See the <a href="tqtl.html">TQTL
    documentation</a> for more information.
<p> Functions that need to return two values can use a TQPair.
<p>See also <a href="tqtl.html">TQt 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>TQPair::first_type</h3> 
The type of the first element in the pair. 
<h3 class=fn><a name="second_type"></a>TQPair::second_type</h3> 
The type of the second element in the pair. 
<hr><h2>Member Function Documentation</h2>
<h3 class=fn><a name="TQPair"></a>TQPair::TQPair ()
</h3>

<p> Constructs an empty pair. The <tt>first</tt> and <tt>second</tt> elements are
default constructed. 

<h3 class=fn><a name="TQPair-2"></a>TQPair::TQPair ( const&nbsp;T1&nbsp;&amp;&nbsp;t1, const&nbsp;T2&nbsp;&amp;&nbsp;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="tqpair.html">TQPair</a> <a name="qMakePair"></a>qMakePair ( T1&nbsp;t1, T2&nbsp;t2 )
</h3>

<p> 
<p> This is a template convenience function. It is used to create a
TQPair&lt;&gt; object that contains <em>t1</em> and <em>t2</em>.

<!-- eof -->
<hr><p>
This file is part of the <a href="index.html">TQt toolkit</a>.
Copyright &copy; 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 &copy; 2007
<a href="troll.html">Trolltech</a><td align=center><a href="trademarks.html">Trademarks</a>
<td align=right><div align=right>TQt 3.3.8</div>
</table></div></address></body>
</html>