diff options
Diffstat (limited to 'doc/man/man3/qpair.3qt')
| -rw-r--r-- | doc/man/man3/qpair.3qt | 100 |
1 files changed, 100 insertions, 0 deletions
diff --git a/doc/man/man3/qpair.3qt b/doc/man/man3/qpair.3qt new file mode 100644 index 000000000..6637eb5fc --- /dev/null +++ b/doc/man/man3/qpair.3qt @@ -0,0 +1,100 @@ +'\" t +.TH QPair 3qt "2 February 2007" "Trolltech AS" \" -*- nroff -*- +.\" Copyright 1992-2007 Trolltech ASA. All rights reserved. See the +.\" license file included in the distribution for a complete license +.\" statement. +.\" +.ad l +.nh +.SH NAME +QPair \- Value-based template class that provides a pair of elements +.SH SYNOPSIS +\fC#include <qpair.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "typedef T1 \fBfirst_type\fR" +.br +.ti -1c +.BI "typedef T2 \fBsecond_type\fR" +.br +.ti -1c +.BI "\fBQPair\fR ()" +.br +.ti -1c +.BI "\fBQPair\fR ( const T1 & t1, const T2 & t2 )" +.br +.ti -1c +.BI "QPair<T1, T2> & \fBoperator=\fR ( const QPair<T1, T2> & other )" +.br +.in -1c +.SH RELATED FUNCTION DOCUMENTATION +.in +1c +.ti -1c +.BI "QPair \fBqMakePair\fR ( T1 t1, T2 t2 )" +.br +.in -1c +.SH DESCRIPTION +The QPair class is a value-based template class that provides a pair of elements. +.PP +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. +.PP +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 \fIvalue based\fR. If you're interested in \fIpointer based\fR classes see, for example, QPtrList and QDict. +.PP +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 (\fCfirst\fR and \fCsecond\fR) are public member variables of the pair. QPair owns the contained elements. For more relaxed ownership semantics, see QPtrCollection and friends which are pointer-based containers. +.PP +Some classes cannot be used within a QPair: for example, all classes derived from QObject and thus all classes that implement widgets. Only "values" can be used in a QPair. To qualify as a value the class must provide: +.TP +A copy constructor +.TP +An assignment operator +.TP +A constructor that takes no arguments +.PP +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. +.PP +QPair uses an STL-like syntax to manipulate and address the objects it contains. See the QTL documentation for more information. +.PP +Functions that need to return two values can use a QPair. +.PP +See also Qt Template Library Classes, Implicitly and Explicitly Shared Classes, and Non-GUI Classes. +.SS "Member Type Documentation" +.SH "QPair::first_type" +The type of the first element in the pair. +.SH "QPair::second_type" +The type of the second element in the pair. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QPair::QPair ()" +Constructs an empty pair. The \fCfirst\fR and \fCsecond\fR elements are default constructed. +.SH "QPair::QPair ( const T1 & t1, const T2 & t2 )" +Constructs a pair and initializes the \fCfirst\fR element with \fIt1\fR and the \fCsecond\fR element with \fIt2\fR. +.SH RELATED FUNCTION DOCUMENTATION +.SH "QPair qMakePair ( T1 t1, T2 t2 )" +This is a template convenience function. It is used to create a +QPair<> object that contains \fIt1\fR and \fIt2\fR. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qpair.html +.BR http://www.trolltech.com/faq/tech.html +.SH COPYRIGHT +Copyright 1992-2007 Trolltech ASA, http://www.trolltech.com. See the +license file included in the distribution for a complete license +statement. +.SH AUTHOR +Generated automatically from the source code. +.SH BUGS +If you find a bug in Qt, please report it as described in +.BR http://doc.trolltech.com/bughowto.html . +Good bug reports help us to help you. Thank you. +.P +The definitive Qt documentation is provided in HTML format; it is +located at $QTDIR/doc/html and can be read using Qt Assistant or with +a web browser. This man page is provided as a convenience for those +users who prefer man pages, although this format is not officially +supported by Trolltech. +.P +If you find errors in this manual page, please report them to +.BR qt-bugs@trolltech.com . +Please include the name of the manual page (qpair.3qt) and the Qt +version (3.3.8). |