From bd0f3345a938b35ce6a12f6150373b0955b8dd12 Mon Sep 17 00:00:00 2001 From: Timothy Pearson Date: Sun, 10 Jul 2011 15:24:15 -0500 Subject: Add Qt3 development HEAD version --- doc/html/qpair.html | 126 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 126 insertions(+) create mode 100644 doc/html/qpair.html (limited to 'doc/html/qpair.html') 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 @@ + + + + + +QPair Class + + + + + + + +

QPair Class Reference

+ +

The QPair class is a value-based template class that provides a pair of elements. +More... +

#include <qpair.h> +

List of all member functions. +

Public Members

typedef T1 first_type
typedef T2 second_type
QPair ()
QPair ( const T1 & t1, const T2 & t2 )
QPair<T1, T2> & operator= ( const QPair<T1, T2> & other )

Related Functions

QPair qMakePair ( T1 t1, T2 t2 )

Detailed Description

+ + +The QPair class is a value-based template class that provides a pair of elements. +

+ + +

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. +

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 value based. If you're interested in pointer based +classes see, for example, QPtrList and QDict. +

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 (first and second) 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. +

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: +

A copy constructor +
An assignment operator +
A constructor that takes no arguments +

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. +

QPair uses an STL-like syntax to manipulate and address the +objects it contains. See the QTL + documentation for more information. +

Functions that need to return two values can use a QPair. +

Member Type Documentation

QPair::first_type

+The type of the first element in the pair. +

QPair::second_type

+The type of the second element in the pair. +

Member Function Documentation

QPair::QPair () +

+ +

Constructs an empty pair. The first and second elements are +default constructed. + +

QPair::QPair ( const T1 & t1, const T2 & t2 ) +

+ +

Constructs a pair and initializes the first element with t1 +and the second element with t2. + +

Related Functions

QPair qMakePair ( T1 t1, T2 t2 ) +

+ +

This is a template convenience function. It is used to create a +QPair<> object that contains t1 and t2. + + +

+ +

Trademarks +

Qt 3.3.8

+ -- cgit v1.2.1