qtools/qsortedlist.doc

   1 /****************************************************************************
   2 **
   3 **
   4 ** QSortedList documentation
   5 **
   6 ** Copyright (C) 1992-2000 Trolltech AS.  All rights reserved.
   7 **
   8 ** This file is part of the Qt GUI Toolkit.
   9 **
  10 ** This file may be distributed under the terms of the Q Public License
  11 ** as defined by Trolltech AS of Norway and appearing in the file
  12 ** LICENSE.QPL included in the packaging of this file.
  13 **
  14 ** This file may be distributed and/or modified under the terms of the
  15 ** GNU General Public License version 2 as published by the Free Software
  16 ** Foundation and appearing in the file LICENSE.GPL included in the
  17 ** packaging of this file.
  18 **
  19 ** Licensees holding valid Qt Enterprise Edition or Qt Professional Edition
  20 ** licenses may use this file in accordance with the Qt Commercial License
  21 ** Agreement provided with the Software.
  22 **
  23 ** This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
  24 ** WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
  25 **
  26 ** See http://www.trolltech.com/pricing.html or email sales@trolltech.com for
  27 **   information about Qt Commercial License Agreements.
  28 ** See http://www.trolltech.com/qpl/ for QPL licensing information.
  29 ** See http://www.trolltech.com/gpl/ for GPL licensing information.
  30 **
  31 ** Contact info@trolltech.com if any conditions of this licensing are
  32 ** not clear to you.
  33 **
  34 **********************************************************************/
  35
  36
  37 /*****************************************************************************
  38   QSortedList documentation
  39  *****************************************************************************/
  40
  41 /*!
  42   \class QSortedList qsortedlist.h
  43   \brief The QSortedList class provides a list sorted by operator< and operator==
  44
  45   \ingroup collection
  46   \ingroup tools
  47
  48   If you want to sort a QList you have to reimplement the
  49   QGList::compareItems() method.  If the elements of your list support
  50   operator<() and operator==() then you can use QSortedList instead.
  51   Its compareItems() calls operator<() and operator==() and returns an
  52   appropriate result.
  53
  54   Otherwise, this is as QList.
  55
  56   \sa QList, \link collection.html Collection Classes\endlink
  57 */
  58
  59
  60 /*!
  61   \fn QSortedList::QSortedList()
  62   Constructs an empty list.
  63 */
  64
  65 /*!
  66   \fn QSortedList::QSortedList( const QSortedList<type> &list )
  67   Constructs a copy of \e list.
  68
  69   Each item in \e list is copied to this new list.
  70 */
  71
  72 /*!
  73   \fn QSortedList::~QSortedList()
  74   Removes all items from the list and destroys the list.
  75
  76   All list iterators that access this list will be reset.
  77 */
  78
  79 /*!
  80   \fn QSortedList<type>& QSortedList::operator=(const QSortedList<type>& list)
  81   Assigns \e list to this list and returns a reference to this list.
  82
  83   This list is first cleared, then each item in \e list is
  84   appended to this list.  Only the pointers are copied
  85   (shallow copy), unless newItem() has been reimplemented().
  86 */
  87
  88 /*!
  89    \fn int QSortedList::compareItems( QCollection::Item s1, QCollection::Item s2 )
  90
  91    \reimp
  92
  93    This reimplementation uses operator< and operator== to compare.
  94 */