Home | All Classes | Main Classes | Annotated | Grouped Classes | Functions

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 )

Related Functions

• QPair qMakePair ( T1 t1, T2 t2 )

Detailed Description

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. The qMakePair() convenience function makes it easy to create QPair objects.

See also Qt Template Library Classes, Implicitly and Explicitly Shared Classes, and Non-GUI Classes.

Member Type Documentation

QPair::first_type

QPair::second_type

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. For example:

        QMap<QString,QString> m;
        m.insert( qMakePair("Clinton", "Bill") );
    

The above code is equivalent to:

        QMap<QString,QString> m;
        QPair<QString,QString> p( "Clinton", "Bill" );
        m.insert( p );
    

This file is part of the Qt toolkit. Copyright © 1995-2003 Trolltech. All Rights Reserved.