The QGList class is an internal class for implementing Qt collection classes. More...

#include <qglist.h>

Inheritance diagram for QGList:

Public Member Functions
uint	count () const

QDataStream &	read (QDataStream &)

QDataStream &	write (QDataStream &) const

Public Member Functions inherited from QCollection
bool	autoDelete () const

void	setAutoDelete (bool enable)

Protected Member Functions
	QGList (const QGList &)

QGList &	operator= (const QGList &)

bool	operator== (const QGList &) const

void	inSort (QCollection::Item)

void	append (QCollection::Item)

bool	insertAt (uint index, QCollection::Item)

void	relinkNode (QLNode *)

bool	removeNode (QLNode *)

bool	remove (QCollection::Item=0)

bool	removeRef (QCollection::Item=0)

bool	removeFirst ()

bool	removeLast ()

bool	removeAt (uint index)

QCollection::Item	takeNode (QLNode *)

QCollection::Item	take ()

QCollection::Item	takeAt (uint index)

QCollection::Item	takeFirst ()

QCollection::Item	takeLast ()

void	sort ()

void	clear ()

int	findRef (QCollection::Item, bool=TRUE)

int	find (QCollection::Item, bool=TRUE)

uint	containsRef (QCollection::Item) const

uint	contains (QCollection::Item) const

QCollection::Item	at (uint index)

int	at () const

QLNode *	currentNode () const

QCollection::Item	get () const

QCollection::Item	cfirst () const

QCollection::Item	clast () const

QCollection::Item	first ()

QCollection::Item	last ()

QCollection::Item	next ()

QCollection::Item	prev ()

void	toVector (QGVector *) const

virtual int	compareItems (QCollection::Item, QCollection::Item)

virtual QDataStream &	read (QDataStream &, QCollection::Item &)

virtual QDataStream &	write (QDataStream &, QCollection::Item) const

Protected Member Functions inherited from QCollection
	QCollection ()

	QCollection (const QCollection &)

virtual	~QCollection ()

virtual Item	newItem (Item)

virtual void	deleteItem (Item)

Friends
class	QGListIterator

class	QGVector

Additional Inherited Members
Public Types inherited from QCollection
typedef void *	Item

Protected Attributes inherited from QCollection
bool	del_item

Detailed Description

The QGList class is an internal class for implementing Qt collection classes.

QGList is a strictly internal class that acts as a base class for several collection classes; QList, QQueue and QStack.

QGList has some virtual functions that can be reimplemented to customize the subclasses.

compareItems() compares two collection/list items.
read() reads a collection/list item from a QDataStream.
write() writes a collection/list item to a QDataStream.

Normally, you do not have to reimplement any of these functions. If you still want to reimplement them, see the QStrList class (qstrlist.h), which is a good example.

Member Function Documentation

§ clear()

void QGList::clear ( )

protectedvirtual

Removes all objects from the collection. The objects will be deleted if auto-delete has been enabled.

See also: setAutoDelete()

Implements QCollection.

Reimplemented in QList< type >, QList< MemberName >, QList< MemberNameInfo >, QList< PageDef >, QList< DocNode >, QList< TagFileInfo >, QList< Grouping >, QList< ListItemInfo >, QList< QCString >, QList< Definition >, QList< MemberDef >, QList< TagPackageInfo >, QList< DirRelation >, QList< DotNode >, QList< HtmlAttrib >, QList< TagPageInfo >, QList< Entry >, QList< IndexIntf >, QList< MemberGroup >, QList< DiagramItem >, QList< DotGroupCollaboration::Link >, QList< TagDirInfo >, QList< EntryNav >, QList< IncludeInfo >, QList< DotFilePatcher >, QList< stat >, QList< TagNamespaceInfo >, QList< TemplateVariant >, QList< MemberInfo >, QList< TagGroupInfo >, QList< DotWorkerThread >, QList< ExprAst >, QList< TemplateNode >, QList< NamespaceDef >, QList< T >, QList< void >, QList< OutputGenerator >, QList< QDict< TemplateVariant > >, QList< GroupDef >, QList< IndexField >, QList< ListElem >, QList< DotConstString >, QList< DotRunner::CleanupItem >, QList< Formula >, QList< TemplateToken >, QList< GenericsCollection >, QList< DotGroupCollaboration::Edge >, QList< TagIncludeInfo >, QList< ActiveRowSpan >, QList< FilePair >, QList< ClassDef >, QList< IncludeEntry >, QList< GuardedNodes >, QList< Define >, QList< BaseClassDef >, QList< EdgeInfo >, QList< NodeDef >, QList< TagMemberInfo >, QList< DotRunner >, QList< RefItem >, QList< FileName >, QList< SearchDocEntry >, QList< FlowChart >, QList< SearchDefinitionList >, QList< SectionInfo >, QList< DocPara >, QList< ConfigOption >, QList< LayoutNavEntry >, QList< uint >, QList< AlphaIndexTableCell >, QList< DefineName >, QList< DirEntry >, QList< MemberList >, QList< LayoutDocEntry >, QList< Argument >, QList< TagAnchorInfo >, QList< FileList >, QList< FileDef >, QList< TagClassInfo >, QList< DotFilePatcher::Map >, QList< ArgumentList >, QList< FTVNode >, QList< BaseInfo >, QList< Mapping >, QList< TagEnumValueInfo >, QList< SearchIndexList >, QList< DiagramRow >, QList< AlphaIndexTableRows >, QList< NavIndexEntry >, QList< Example >, QList< DirDef >, QInternalList< type >, QInternalList< QGDictIterator >, QInternalList< QWaitConditionEvent >, QInternalList< QCacheItem >, QQueue< type >, QStack< type >, QQueue< DotRunner >, QStack< DocNode >, QStack< PerlModOutputStream >, QStack< TableState >, QStack< bool >, QStack< DocStyleChange >, and QStack< State >.

§ compareItems()

int QGList::compareItems	(	QCollection::Item	item1,
		QCollection::Item	item2
	)

protectedvirtual

This virtual function compares two list items.

Returns:

0 if item1 == item2
non-zero if item1 != item2

This function returns int rather than bool so that reimplementations can return three values and use it to sort by:

0 if item1 == item2
> 0 (positive integer) if item1 > item2
< 0 (negative integer) if item1 < item2

The QList::inSort() function requires that compareItems() is implemented as described here.

This function should not modify the list because some const functions call compareItems().

The default implementation compares the pointers:

Reimplemented in QSortedList< type >.

§ count()

uint QGList::count ( ) const

inlinevirtual

Returns the number of objects in the collection.

Implements QCollection.

Reimplemented in QList< type >, QList< MemberName >, QList< MemberNameInfo >, QList< PageDef >, QList< DocNode >, QList< TagFileInfo >, QList< Grouping >, QList< ListItemInfo >, QList< QCString >, QList< Definition >, QList< MemberDef >, QList< TagPackageInfo >, QList< DirRelation >, QList< DotNode >, QList< HtmlAttrib >, QList< TagPageInfo >, QList< Entry >, QList< IndexIntf >, QList< MemberGroup >, QList< DiagramItem >, QList< DotGroupCollaboration::Link >, QList< TagDirInfo >, QList< EntryNav >, QList< IncludeInfo >, QList< DotFilePatcher >, QList< stat >, QList< TagNamespaceInfo >, QList< TemplateVariant >, QList< MemberInfo >, QList< TagGroupInfo >, QList< DotWorkerThread >, QList< ExprAst >, QList< TemplateNode >, QList< NamespaceDef >, QList< T >, QList< void >, QList< OutputGenerator >, QList< QDict< TemplateVariant > >, QList< GroupDef >, QList< IndexField >, QList< ListElem >, QList< DotConstString >, QList< DotRunner::CleanupItem >, QList< Formula >, QList< TemplateToken >, QList< GenericsCollection >, QList< DotGroupCollaboration::Edge >, QList< TagIncludeInfo >, QList< ActiveRowSpan >, QList< FilePair >, QList< ClassDef >, QList< IncludeEntry >, QList< GuardedNodes >, QList< Define >, QList< BaseClassDef >, QList< EdgeInfo >, QList< NodeDef >, QList< TagMemberInfo >, QList< DotRunner >, QList< RefItem >, QList< FileName >, QList< SearchDocEntry >, QList< FlowChart >, QList< SearchDefinitionList >, QList< SectionInfo >, QList< DocPara >, QList< ConfigOption >, QList< LayoutNavEntry >, QList< uint >, QList< AlphaIndexTableCell >, QList< DefineName >, QList< DirEntry >, QList< MemberList >, QList< LayoutDocEntry >, QList< Argument >, QList< TagAnchorInfo >, QList< FileList >, QList< FileDef >, QList< TagClassInfo >, QList< DotFilePatcher::Map >, QList< ArgumentList >, QList< FTVNode >, QList< BaseInfo >, QList< Mapping >, QList< TagEnumValueInfo >, QList< SearchIndexList >, QList< DiagramRow >, QList< AlphaIndexTableRows >, QList< NavIndexEntry >, QList< Example >, QList< DirDef >, QInternalList< type >, QQueue< type >, QStack< type >, QInternalList< QGDictIterator >, QInternalList< QWaitConditionEvent >, QInternalList< QCacheItem >, QQueue< DotRunner >, QStack< DocNode >, QStack< PerlModOutputStream >, QStack< TableState >, QStack< bool >, QStack< DocStyleChange >, QStack< State >, and MemberList.

§ operator==()

bool QGList::operator== ( const QGList & list ) const

protected

Compares this list with list. Retruns TRUE if the lists contain the same data, else FALSE.

§ read()

QDataStream & QGList::read	(	QDataStream &	s,
		QCollection::Item &	item
	)

protectedvirtual

Reads a collection/list item from the stream s and returns a reference to the stream.

The default implementation sets item to 0.

See also: write()

§ sort()

void QGList::sort ( )

protected

Sorts the list by the result of the virtual compareItems() function.

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.

§ write()

QDataStream & QGList::write	(	QDataStream &	s,
		QCollection::Item
	)		const

protectedvirtual

Writes a collection/list item to the stream s and returns a reference to the stream.

The default implementation does nothing.

See also: read()

The documentation for this class was generated from the following files:

qtools/qglist.h
qtools/qglist.cpp

Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Function Documentation

§ clear()

§ compareItems()

§ count()

§ operator==()

§ read()

§ sort()

§ write()