#include <memberlist.h>

Inheritance diagram for MemberList:

Public Member Functions
	MemberList (MemberListType lt)

MemberListType	listType () const

void	inSort (const MemberDef *md)

void	append (const MemberDef *md)

void	remove (const MemberDef *md)

void	sort ()

uint	count () const

int	findRef (const MemberDef *md) const

MemberDef *	getFirst () const

MemberDef *	take (uint index)

int	varCount () const

int	funcCount () const

int	enumCount () const

int	enumValueCount () const

int	typedefCount () const

int	protoCount () const

int	defineCount () const

int	friendCount () const

int	numDecMembers () const

int	numDocMembers () const

bool	needsSorting () const

void	countDecMembers (bool countEnumValues=FALSE, GroupDef *gd=0)

void	countDocMembers (bool countEnumValues=FALSE)

int	countInheritableMembers (ClassDef *inheritedFrom) const

void	writePlainDeclarations (OutputList &ol, ClassDef cd, NamespaceDef nd, FileDef fd, GroupDef gd, ClassDef inheritedFrom, const char inheritId)

void	writeDeclarations (OutputList &ol, ClassDef cd, NamespaceDef nd, FileDef fd, GroupDef gd, const char title, const char subtitle, bool showEnumValues=FALSE, bool showInline=FALSE, ClassDef *inheritedFrom=0, MemberListType lt=MemberListType_pubMethods)
	Writes the list of members to the output. More...

void	writeDocumentation (OutputList &ol, const char scopeName, Definition container, const char *title, bool showEnumValues=FALSE, bool showInline=FALSE)

void	writeSimpleDocumentation (OutputList &ol, Definition *container)

void	writeDocumentationPage (OutputList &ol, const char scopeName, Definition container)

void	writeTagFile (FTextStream &)

bool	declVisible () const

void	addMemberGroup (MemberGroup *mg)

void	setInGroup (bool inGroup)

void	setInFile (bool inFile)

void	addListReferences (Definition *def)

void	findSectionsInDocumentation ()

void	setNeedsSorting (bool b)

MemberGroupList *	getMemberGroupList () const

void	marshal (StorageIntf *s)

void	unmarshal (StorageIntf *s)

Static Public Member Functions
static QCString	listTypeAsString (MemberListType type)

Friends
class	MemberListIterator

Detailed Description

A list of MemberDef objects.

Member Function Documentation

§ count()

uint MemberList::count ( ) const

virtual

Returns the number of objects in the collection.

Reimplemented from QGList.

§ countDecMembers()

void MemberList::countDecMembers	(	bool	countEnumValues = `FALSE`,
		GroupDef *	gd = `0`
	)

Count the number of members in this list that are visible in the declaration part of a compound's documentation page.

§ writeDeclarations()

void MemberList::writeDeclarations	(	OutputList &	ol,
		ClassDef *	cd,
		NamespaceDef *	nd,
		FileDef *	fd,
		GroupDef *	gd,
		const char *	title,
		const char *	subtitle,
		bool	showEnumValues = `FALSE`,
		bool	showInline = `FALSE`,
		ClassDef *	inheritedFrom = `0`,
		MemberListType	lt = `MemberListType_pubMethods`
	)

Writes the list of members to the output.

Parameters

ol	Output list to write to
cd	non-null if this list is part of class documentation.
nd	non-null if this list is part of namespace documentation.
fd	non-null if this list is part of file documentation.
gd	non-null if this list is part of group documentation.
title	Title to use for the member list.
subtitle	Sub title to use for the member list.
showEnumValues	Obsolete, always set to FALSE.
showInline	if set to TRUE if title is rendered differently
inheritedFrom	if not 0, the list is shown inside the given class as inherited members, parameter cd points to the class containing the members.
lt	Type of list that is inherited from.

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

src/memberlist.h
src/memberlist.cpp

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

Member Function Documentation

§ count()

§ countDecMembers()

§ writeDeclarations()