Q3ValueList Class Reference

 #include <Q3ValueList>

 class Employee
 {
 public:
     Employee(): sn(0) {}
     Employee( const QString& forename, const QString& surname, int salary )
         : fn(forename), sn(surname), sal(salary)
     {}

     QString forename() const { return fn; }
     QString surname() const { return sn; }
     int salary() const { return sal; }
     void setSalary( int salary ) { sal = salary; }

 private:
     QString fn;
     QString sn;
     int sal;
 };

 typedef Q3ValueList<Employee> EmployeeList;
 EmployeeList list;

 list.append( Employee("John", "Doe", 50000) );
 list.append( Employee("Jane", "Williams", 80000) );
 list.append( Employee("Tom", "Jones", 60000) );

 Employee mary( "Mary", "Hawthorne", 90000 );
 list.append( mary );
 mary.setSalary( 100000 );

 EmployeeList::iterator it;
 for ( it = list.begin(); it != list.end(); ++it )
     cout << (*it).surname().latin1() << ", " <<
             (*it).forename().latin1() << " earns " <<
             (*it).salary() << endl;

 // Output:
 // Doe, John earns 50000
 // Williams, Jane earns 80000
 // Hawthorne, Mary earns 90000
 // Jones, Tom earns 60000

 Q3ValueList<int> list;
 list.append( 1 );
 list.append( 2 );
 list.append( 3 );
 ...
 if ( !list.empty() ) {
     // OK, modify the first item
     int& i = list.first();
     i = 18;
 }
 ...
 Q3ValueList<double> dlist;
 double d = dlist.last(); // undefined

Member Function Documentation

Q3ValueList::Q3ValueList ()

Constructs an empty list.

Q3ValueList::Q3ValueList ( const Q3ValueList<T> & l )

Constructs a copy of l.

Q3ValueList::Q3ValueList ( const QLinkedList<T> & l )

Constructs a copy of l.

Q3ValueList::Q3ValueList ( const QList<T> & l )

Constructs a copy of l.

Q3ValueList::Q3ValueList ( const std::list<T> & l )

Contructs a copy of l.

This constructor is provided for compatibility with STL containers.

Q3ValueList::~Q3ValueList ()

Destroys the list. References to the values in the list and all iterators of this list become invalidated. Note that it is impossible for an iterator to check whether or not it is valid: Q3ValueList is highly tuned for performance, not for error checking.

Q3ValueList<T>::Iterator Q3ValueList::append ( const T & x )

Inserts x at the end of the list.

See also insert() and prepend().

Q3ValueList<T>::ConstIterator Q3ValueList::at ( Q3ValueList<T>::size_type i ) const

Returns an iterator pointing to the item at position i in the list, or an undefined value if the index is out of range.

Warning: This function uses a linear search and can be extremely slow for large lists. Q3ValueList is not optimized for random item access. If you need random access use a different container, such as Q3ValueVector.

Q3ValueList<T>::Iterator Q3ValueList::at ( Q3ValueList<T>::size_type i )

This is an overloaded function.

Returns an iterator pointing to the item at position i in the list, or an undefined value if the index is out of range.

Q3ValueList<T>::size_type Q3ValueList::contains ( const T & x ) const

Returns the number of occurrences of the value x in the list.

Q3ValueList<T>::ConstIterator Q3ValueList::fromLast () const

Returns an iterator to the last item in the list, or end() if there is no last item.

Use the end() function instead. For example:

 Q3ValueList<int> l;
 ...
 Q3ValueList<int>::iterator it = l.end();
 --it;
 if ( it != end() )
     // ...

Q3ValueList<T>::Iterator Q3ValueList::fromLast ()

This is an overloaded function.

Returns an iterator to the last item in the list, or end() if there is no last item.

Use the end() function instead. For example:

 Q3ValueList<int> l;
 ...
 Q3ValueList<int>::iterator it = l.end();
 --it;
 if ( it != end() )
     // ...

Q3ValueList<T>::Iterator Q3ValueList::insert ( Q3ValueList<T>::Iterator it, const T & x )

Inserts the value x in front of the item pointed to by the iterator, it.

Returns an iterator pointing at the inserted item.

See also append() and prepend().

void Q3ValueList::insert ( Q3ValueList<T>::Iterator pos, Q3ValueList<T>::size_type n, const T & x )

This is an overloaded function.

Inserts n copies of x before position pos.

Q3ValueList<T>::Iterator Q3ValueList::prepend ( const T & x )

Inserts x at the beginning of the list.

See also insert() and append().

Q3ValueList<T>::Iterator Q3ValueList::remove ( Q3ValueList<T>::Iterator it )

Removes the item pointed to by it from the list. No iterators other than it or other iterators pointing at the same item as it are invalidated. Returns an iterator to the next item after it, or end() if there is no such item.

See also clear().

int Q3ValueList::remove ( const T & x )

This is an overloaded function.

Removes all items that have value x and returns the number of removed items.

Q3ValueList::operator QList<T> () const

Automatically converts a Q3ValueList<T> into a QList<T>.

bool Q3ValueList::operator!= ( const Q3ValueList<T> & l ) const

Compares both lists.

Returns TRUE if this list and l are unequal; otherwise returns FALSE.

Q3ValueList<T> Q3ValueList::operator+ ( const Q3ValueList<T> & l ) const

Creates a new list and fills it with the items of this list. Then the items of l are appended. Returns the new list.

Q3ValueList<T> & Q3ValueList::operator+= ( const Q3ValueList<T> & l )

Appends the items of l to this list. Returns a reference to this list.

Q3ValueList<T> & Q3ValueList::operator+= ( const T & x )

This is an overloaded function.

Appends the value x to the list. Returns a reference to the list.

Q3ValueList<T> & Q3ValueList::operator<< ( const T & x )

Adds the value x to the end of the list.

Returns a reference to the list.

Q3ValueList<T> & Q3ValueList::operator= ( const Q3ValueList<T> & l )

Assigns l to this list and returns a reference to this list.

All iterators of the current list become invalidated by this operation. The cost of such an assignment is O(1) since Q3ValueList is implicitly shared.

Q3ValueList<T> & Q3ValueList::operator= ( const QList<T> & l )

Assigns l to this list and returns a reference to this list.

All iterators of the current list become invalidated by this operation.

Q3ValueList<T> & Q3ValueList::operator= ( const std::list<T> & l )

This is an overloaded function.

Assigns the contents of l to the list.

All iterators of the current list become invalidated by this operation.

bool Q3ValueList::operator== ( const Q3ValueList<T> & l ) const

Compares both lists.

Returns TRUE if this list and l are equal; otherwise returns FALSE.

bool Q3ValueList::operator== ( const std::list<T> & l ) const

This is an overloaded function.

Returns TRUE if this list and l are equal; otherwise returns FALSE.

This operator is provided for compatibility with STL containers.

const T & Q3ValueList::operator[] ( Q3ValueList<T>::size_type i ) const

Returns a const reference to the item with index i in the list. It is up to you to check whether this item really exists. You can do that easily with the count() function. However this operator does not check whether i is in range and will deliver undefined results if it does not exist.

Warning: This function uses a linear search and can be extremely slow for large lists. Q3ValueList is not optimized for random item access. If you need random access use a different container, such as Q3ValueVector.

T & Q3ValueList::operator[] ( Q3ValueList<T>::size_type i )

This is an overloaded function.

Returns a non-const reference to the item with index i.