qlist.3qt

Trolltech公司发布的基于C++图形开发环境

Calling this function is must faster than contains(), because contains() compares \fIitem\fR with each list item using compareItems(). This function only compares the pointers.
.PP
Does not affect the current list item.
.PP
See also contains().
.SH "uint QList::count () const \fC[virtual]\fR"
Returns the number of items in the list.
.PP
See also isEmpty().
.PP
Reimplemented from QCollection.
.SH "type * QList::current () const"
Returns a pointer to the current list item. The current item may be null (implies that the current index is -1).
.PP
See also at().
.SH "QLNode * QList::currentNode () const"
Returns a pointer to the current list node.
.PP
The node can be kept and removed later using removeNode(). The advantage is that the item can be removed directly without searching the list.
.PP
\fBWarning:\fR Do not call this function unless you are an expert.
.PP
See also removeNode(), takeNode() and current().
.SH "int QList::find ( const type * item )"
Finds the first occurrence of \fIitem\fR in the list.
.PP
If the item is found, the list sets the current item to point to the found item and returns the index of this item. If the item is not found, the list sets the current item to null, the current index to -1 and returns -1.
.PP
The compareItems() function is called when searching for the item in the list. If compareItems() is not reimplemented, it is more efficient to call findRef().
.PP
See also findNext(), findRef(), compareItems() and current().
.SH "int QList::findNext ( const type * item )"
Finds the next occurrence of \fIitem\fR in the list, starting from the current list item.
.PP
If the item is found, the list sets the current item to point to the found item and returns the index of this item. If the item is not found, the list sets the current item to null, the current index to -1 and returns -1.
.PP
The compareItems() function is called when searching for the item in the list. If compareItems() is not reimplemented, it is more efficient to call findNextRef().
.PP
See also find(), findNextRef(), compareItems() and current().
.SH "int QList::findNextRef ( const type * item )"
Finds the next occurrence of \fIitem\fR in the list, starting from the current list item.
.PP
If the item is found, the list sets the current item to point to the found item and returns the index of this item. If the item is not found, the list sets the current item to null, the current index to -1 and returns -1.
.PP
Calling this function is must faster than findNext(), because findNext() compares \fIitem\fR with each list item using compareItems(). This function only compares the pointers.
.PP
See also findRef(), findNext() and current().
.SH "int QList::findRef ( const type * item )"
Finds the first occurrence of \fIitem\fR in the list.
.PP
If the item is found, the list sets the current item to point to the found item and returns the index of this item. If the item is not found, the list sets the current item to null, the current index to -1 and returns -1.
.PP
Calling this function is must faster than find(), because find() compares \fIitem\fR with each list item using compareItems(). This function only compares the pointers.
.PP
See also findNextRef(), find() and current().
.SH "type * QList::first ()"
Returns a pointer to the first item in the list and makes this the current list item, or null if the list is empty.
.PP
See also getFirst(), last(), next(), prev() and current().
.PP
Examples:
.(l
grapher/grapher.cpp
.)l
.SH "type * QList::getFirst () const"
Returns a pointer to the first item in the list, or null if the list is empty.
.PP
Does not affect the current list item.
.PP
See also first() and getLast().
.SH "type * QList::getLast () const"
Returns a pointer to the last item in the list, or null if the list is empty.
.PP
Does not affect the current list item.
.PP
See also last() and getFirst().
.SH "void QList::inSort ( const type * item )"
Inserts the \fIitem\fR at its sorted position in the list.
.PP
The sort order depends on the virtual QGList::compareItems() function. All items must be inserted with inSort() to maintain the sorting order.
.PP
The inserted item becomes the current list item.
.PP
The \fIitem\fR must not be a null pointer.
.PP
Please note that inSort is slow. If you want to insert lots of items in a list and sort after inserting then you should use sort(). inSort() takes up to O(n) compares. That means inserting n items in your list will need O(n^2) compares while sort() only needs O(n*logn) for the same task. So you inSort() only if you already have a pre-sorted list and want to insert only few additional items.
.PP
See also insert(), QGList::compareItems(), current() and sort().
.SH "bool QList::insert ( uint index, const type * item )"
Inserts the \fIitem\fR at the position \fIindex\fR in the list.
.PP
Returns TRUE if successful, or FALSE if \fIindex\fR is out of range. The valid range is \fC0 .. count()\fR inclusive. The item is appended if \fIindex\fR == count().
.PP
The inserted item becomes the current list item.
.PP
The \fIitem\fR must not be a null pointer.
.PP
See also append() and current().
.SH "bool QList::isEmpty () const"
Returns TRUE if the list is empty, i.e. count() == 0. Returns FALSE otherwise.
.PP
See also count().
.SH "type * QList::last ()"
Returns a pointer to the last item in the list and makes this the current list item, or null if the list is empty.
.PP
See also getLast(), first(), next(), prev() and current().
.SH "type * QList::next ()"
Returns a pointer to the item succeeding the current item. Returns null if the current item is null or equal to the last item.
.PP
Makes the succeeding item current. If the current item before this function call was the last item, the current item will be set to null. If the current item was null, this function does nothing.
.PP
See also first(), last(), prev() and current().
.PP
Examples:
.(l
grapher/grapher.cpp
.)l
.SH "QList<type> & QList::operator= ( const QList<type> & list )"
Assigns \fIlist\fR to this list and returns a reference to this list.
.PP
This list is first cleared, then each item in \fIlist\fR is appended to this list. Only the pointers are copied (shallow copy), unless newItem() has been reimplemented().
.SH "bool QList::operator== ( const QList<type> & list ) const"
Compares this list with \fIlist.\fR Retruns TRUE if the lists contain the same data, else FALSE.
.SH "void QList::prepend ( const type * item )"
Inserts the \fIitem\fR at the start of the list.
.PP
The inserted item becomes the current list item. This is equivalent to \fCinsert(0,item).\fR
.PP
The \fIitem\fR must not be a null pointer.
.PP
See also append(), insert() and current().
.SH "type * QList::prev ()"
Returns a pointer to the item preceding the current item. Returns null if the current item is null or equal to the first item.
.PP
Makes the preceding item current. If the current item before this function call was the first item, the current item will be set to null. If the current item was null, this function does nothing.
.PP
See also first(), last(), next() and current().
.SH "bool QList::remove ()"
Removes the current list item.
.PP
Returns TRUE if successful, or FALSE if the current item is null.
.PP
The removed item is deleted if auto-deletion is enabled.
.PP
The item after the removed item becomes the new current list item if the removed item is not the last item in the list. If the last item is removed, the new last item becomes the current item. The current item is set to null if the list becomes empty.
.PP
All list iterators that refer to the removed item will be set to point to the new current item.
.PP
See also take(), clear(), setAutoDelete(), current() and removeRef().
.SH "bool QList::remove ( const type * item )"
Removes the first occurrence of \fIitem\fR from the list.
.PP
Returns TRUE if successful, or FALSE if the item could not be found in the list.
.PP
The removed item is deleted if auto-deletion is enabled.
.PP
The compareItems() function is called when searching for the item in the list. If compareItems() is not reimplemented, it is more efficient to call removeRef().
.PP
The item after the removed item becomes the new current list item if the removed item is not the last item in the list. If the last item is removed, the new last item becomes the current item. The current item is set to null if the list becomes empty.
.PP
All list iterators that refer to the removed item will be set to point to the new current item.
.PP
See also removeRef(), take(), clear(), setAutoDelete(), compareItems() and current().
.SH "bool QList::remove ( uint index )"
Removes the item at position \fIindex\fR in the list.
.PP
Returns TRUE if successful, or FALSE if \fIindex\fR is out of range. The valid range is \fC0 .. (count() - 1)\fR inclusive.
.PP
The removed item is deleted if auto-deletion is enabled.
.PP
The item after the removed item becomes the new current list item if the removed item is not the last item in the list. If the last item is removed, the new last item becomes the current item. The current item is set to null if the list becomes empty.
.PP
All list iterators that refer to the removed item will be set to point to the new current item.
.PP
See also take(), clear(), setAutoDelete(), current() and removeRef().
.SH "bool QList::removeFirst ()"
Removes the first item from the list. Returns TRUE if successful, or FALSE if the list is empty.
.PP
The removed item is deleted if auto-deletion is enabled.
.PP
The first item in the list becomes the new current list item. The current item is set to null if the list becomes empty.
.PP
All list iterators that refer to the removed item will be set to point to the new current item.
.PP
See also removeLast(), setAutoDelete(), current() and remove().
.SH "bool QList::removeLast ()"
Removes the last item from the list. Returns TRUE if successful, or FALSE if the list is empty.
.PP
The removed item is deleted if auto-deletion is enabled.
.PP
The last item in the list becomes the new current list item. The current item is set to null if the list becomes empty.
.PP
All list iterators that refer to the removed item will be set to point to the new current item.
.PP
See also removeFirst(), setAutoDelete() and current().
.SH "void QList::removeNode ( QLNode * node )"
Removes the \fInode\fR from the list.
.PP
This node must exist in the list, otherwise the program may crash.
.PP
The removed item is deleted if auto-deletion is enabled.
.PP
The first item in the list will become the new current list item. The current item is set to null if the list becomes empty.
.PP
All list iterators that refer to the removed item will be set to point to the item succeeding this item, or the preceding item if the removed item was the last item.
.PP
\fBWarning:\fR Do not call this function unless you are an expert.
.PP
See also takeNode(), currentNode(), remove() and removeRef().
.SH "bool QList::removeRef ( const type * item )"
Removes the first occurrence of \fIitem\fR from the list.
.PP
Returns TRUE if successful, or FALSE if the item cannot be found in the list.
.PP
The removed item is deleted if auto-deletion is enabled.
.PP
The list is scanned until the pointer \fIitem\fR is found. It is removed if it is found.
.PP
Equivalent to:
.PP
.nf
.br
    if ( list.findRef(item) != -1 )
.br
        list.remove();
.fi
.PP
The item after the removed item becomes the new current list item if the removed item is not the last item in the list. If the last item is removed, the new last item becomes the current item. The current item is set to null if the list becomes empty.
.PP
All list iterators that refer to the removed item will be set to point to the new current item.
.PP
See also remove(), clear(), setAutoDelete() and current().
.SH "void QList::sort ()"
Sorts the list by the result of the virtual compareItems() function.
.PP
The Heap-Sort algorithm is used for sorting. It sorts n items with O(n*log n) compares. This is the asymptotic optimal solution of the sorting problem.
.PP
If the items in your list support operator< and operator== then you might be better off with QSortedList since it implements the compareItems() function for you using these two operators.
.PP
See also inSort().
.SH "type * QList::take ()"
Takes the current item out of the list without deleting it (even if auto-deletion is enabled). Returns a pointer to the item taken out of the list, or null if the current item is null.
.PP
The item after the taken item becomes the new current list item if the taken item is not the last item in the list. If the last item is taken, the new last item becomes the current item. The current item is set to null if the list becomes empty.
.PP
All list iterators that refer to the taken item will be set to point to the new current item.
.PP
See also remove(), clear() and current().
.SH "type * QList::take ( uint index )"
Takes the item at position \fIindex\fR out of the list without deleting it (even if auto-deletion is enabled).
.PP
Returns a pointer to the item taken out of the list, or null if the index is out of range. The valid range is \fC0 .. (count() - 1)\fR inclusive.
.PP
The item after the taken item becomes the new current list item if the taken item is not the last item in the list. If the last item is taken, the new last item becomes the current item. The current item is set to null if the list becomes empty.
.PP
All list iterators that refer to the taken item will be set to point to the new current item.
.PP
See also remove(), clear() and current().
.SH "type * QList::takeNode ( QLNode * node )"
Takes the \fInode\fR out of the list without deleting its item (even if auto-deletion is enabled). Returns a pointer to the item taken out of the list.
.PP
This node must exist in the list, otherwise the program may crash.
.PP
The first item in the list becomes the new current list item.
.PP
All list iterators that refer to the taken item will be set to point to the item succeeding this item, or the preceding item if the taken item was the last item.
.PP
\fBWarning:\fR Do not call this function unless you are an expert.
.PP
See also removeNode() and currentNode().
.SH "void QList::toVector ( QGVector * vec ) const"
Stores all list items in the vector \fIvec.\fR
.PP
The vector must be have the same item type, otherwise the result
will be undefined.
.SH "SEE ALSO"
.BR http://doc.trolltech.com/qlist.html
.BR http://www.trolltech.com/faq/tech.html
.SH COPYRIGHT
Copyright 1992-2001 Trolltech AS, 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 make our job much simpler. Thank you.
.P
In case of content or formattting problems with this manual page, please
report them to
.BR [e-mail] .
Please include the name of the manual page (qlist.3qt) and the Qt
version (2.3.10).