MemberList Class Reference

#include <memberlist.h>

Inheritance diagram for MemberList:

List of all members.

Public Types
enum	ListType {   privateLists = 0x0800, detailedLists = 0x1000, declarationLists = 0x2000, documentationLists = 0x4000,   pubMethods = 0, proMethods = 1, pacMethods = 2, priMethods = 3 + privateLists,   pubStaticMethods = 4, proStaticMethods = 5, pacStaticMethods = 6, priStaticMethods = 7 + privateLists,   pubSlots = 8, proSlots = 9, priSlots = 10 + privateLists, pubAttribs = 11,   proAttribs = 12, pacAttribs = 13, priAttribs = 14 + privateLists, pubStaticAttribs = 15,   proStaticAttribs = 16, pacStaticAttribs = 17, priStaticAttribs = 18 + privateLists, pubTypes = 19,   proTypes = 20, pacTypes = 21, priTypes = 22 + privateLists, related = 23,   signals = 24, friends = 25, dcopMethods = 26, properties = 27,   events = 28, typedefMembers = 29 + detailedLists, enumMembers = 30 + detailedLists, enumValMembers = 31 + detailedLists,   functionMembers = 32 + detailedLists, relatedMembers = 33 + detailedLists, variableMembers = 34 + detailedLists, propertyMembers = 35 + detailedLists,   eventMembers = 36 + detailedLists, constructors = 37 + detailedLists, allMembersList = 38, decDefineMembers = 39 + declarationLists,   decProtoMembers = 40 + declarationLists, decTypedefMembers = 41 + declarationLists, decEnumMembers = 42 + declarationLists, decFuncMembers = 43 + declarationLists,   decVarMembers = 44 + declarationLists, decEnumValMembers = 45 + declarationLists, decPubSlotMembers = 46 + declarationLists, decProSlotMembers = 47 + declarationLists,   decPriSlotMembers = 48 + declarationLists, decSignalMembers = 49 + declarationLists, decEventMembers = 50 + declarationLists, decFriendMembers = 51 + declarationLists,   decPropMembers = 52 + declarationLists, docDefineMembers = 53 + documentationLists, docProtoMembers = 54 + documentationLists, docTypedefMembers = 55 + documentationLists,   docEnumMembers = 56 + documentationLists, docFuncMembers = 57 + documentationLists, docVarMembers = 58 + documentationLists, docEnumValMembers = 59 + documentationLists,   docPubSlotMembers = 60 + documentationLists, docProSlotMembers = 61 + documentationLists, docPriSlotMembers = 62 + documentationLists, docSignalMembers = 63 + documentationLists,   docEventMembers = 64 + documentationLists, docFriendMembers = 65 + documentationLists, docPropMembers = 66 + documentationLists, redefinedBy = 67,   enumFields = 68, memberGroup = 69 }
Public Member Functions
	MemberList ()
	MemberList (ListType lt)
	~MemberList ()
ListType	listType () const
bool	insert (uint index, const MemberDef *md)
void	inSort (const MemberDef *md)
void	append (const MemberDef *md)
int	compareItems (GCI item1, GCI item2)
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
void	countDecMembers (bool countEnumValues=FALSE)
void	countDocMembers (bool countEnumValues=FALSE)
void	writePlainDeclarations (OutputList &ol, ClassDef *cd, NamespaceDef *nd, FileDef *fd, GroupDef *gd)
void	writeDeclarations (OutputList &ol, ClassDef *cd, NamespaceDef *nd, FileDef *fd, GroupDef *gd, const char *title, const char *subtitle, bool showEnumValues=FALSE)
void	writeDocumentation (OutputList &ol, const char *scopeName, Definition *container, const char *title, bool showEnumValues=FALSE)
void	writeDocumentationPage (OutputList &ol, const char *scopeName, Definition *container)
void	addMemberGroup (MemberGroup *mg)
void	setInGroup (bool inGroup)
void	setInFile (bool inFile)
void	addListReferences (Definition *def)
void	findSectionsInDocumentation ()
MemberGroupList *	getMemberGroupList () const
void	marshal (StorageIntf *s)
void	unmarshal (StorageIntf *s)

---

Detailed Description

Definition at line 30 of file memberlist.h.

---

Member Enumeration Documentation

enum MemberList::ListType

Enumerator:

privateLists
detailedLists
declarationLists
documentationLists
pubMethods
proMethods
pacMethods
priMethods
pubStaticMethods
proStaticMethods
pacStaticMethods
priStaticMethods
pubSlots
proSlots
priSlots
pubAttribs
proAttribs
pacAttribs
priAttribs
pubStaticAttribs
proStaticAttribs
pacStaticAttribs
priStaticAttribs
pubTypes
proTypes
pacTypes
priTypes
related
signals
friends
dcopMethods
properties
events
typedefMembers
enumMembers
enumValMembers
functionMembers
relatedMembers
variableMembers
propertyMembers
eventMembers
constructors
allMembersList
decDefineMembers
decProtoMembers
decTypedefMembers
decEnumMembers
decFuncMembers
decVarMembers
decEnumValMembers
decPubSlotMembers
decProSlotMembers
decPriSlotMembers
decSignalMembers
decEventMembers
decFriendMembers
decPropMembers
docDefineMembers
docProtoMembers
docTypedefMembers
docEnumMembers
docFuncMembers
docVarMembers
docEnumValMembers
docPubSlotMembers
docProSlotMembers
docPriSlotMembers
docSignalMembers
docEventMembers
docFriendMembers
docPropMembers
redefinedBy
enumFields
memberGroup

Definition at line 33 of file memberlist.h.

---

Constructor & Destructor Documentation

MemberList::MemberList

(

)

Definition at line 30 of file memberlist.cpp.

MemberList::MemberList

(

ListType

lt

)

Definition at line 34 of file memberlist.cpp.

MemberList::~MemberList

(

)

Definition at line 43 of file memberlist.cpp.

---

Member Function Documentation

ListType MemberList::listType

(

)

const [inline]

Definition at line 120 of file memberlist.h.

Referenced by NamespaceDef::addListReferences(), GroupDef::addListReferences(), FileDef::addListReferences(), ClassDef::addListReferences(), NamespaceDef::addMembersToMemberGroup(), GroupDef::addMembersToMemberGroup(), FileDef::addMembersToMemberGroup(), ClassDef::addMembersToMemberGroup(), ClassDef::computeAnchors(), NamespaceDef::findSectionsInDocumentation(), GroupDef::findSectionsInDocumentation(), FileDef::findSectionsInDocumentation(), ClassDef::findSectionsInDocumentation(), NamespaceDef::getMemberList(), GroupDef::getMemberList(), FileDef::getMemberList(), ClassDef::getMemberList(), NamespaceDef::writeMemberPages(), GroupDef::writeMemberPages(), FileDef::writeMemberPages(), and ClassDef::writeMemberPages().

bool MemberList::insert	(	uint	index,
		const MemberDef *	md
	)

Definition at line 155 of file memberlist.cpp.

void MemberList::inSort

(

const MemberDef *

md

)

Definition at line 160 of file memberlist.cpp.

Referenced by MemberDef::insertReimplementedBy().

void MemberList::append

(

const MemberDef *

md

)

Definition at line 165 of file memberlist.cpp.

Referenced by MemberDef::insertEnumField(), NamespaceDef::insertMember(), MemberGroup::insertMember(), GroupDef::insertMember(), FileDef::insertMember(), and unmarshalMemberList().

int MemberList::compareItems	(	GCI	item1,
		GCI	item2
	)

Definition at line 48 of file memberlist.cpp.

References MemberDef::name.

int MemberList::varCount

(

)

const [inline]

Definition at line 125 of file memberlist.h.

Referenced by MemberGroup::varCount().

int MemberList::funcCount

(

)

const [inline]

Definition at line 126 of file memberlist.h.

Referenced by MemberGroup::funcCount().

int MemberList::enumCount

(

)

const [inline]

Definition at line 127 of file memberlist.h.

Referenced by MemberGroup::enumCount().

int MemberList::enumValueCount

(

)

const [inline]

Definition at line 128 of file memberlist.h.

Referenced by MemberGroup::enumValueCount().

int MemberList::typedefCount

(

)

const [inline]

Definition at line 129 of file memberlist.h.

Referenced by MemberGroup::typedefCount().

int MemberList::protoCount

(

)

const [inline]

Definition at line 130 of file memberlist.h.

Referenced by MemberGroup::protoCount().

int MemberList::defineCount

(

)

const [inline]

Definition at line 131 of file memberlist.h.

Referenced by MemberGroup::defineCount().

int MemberList::friendCount

(

)

const [inline]

Definition at line 132 of file memberlist.h.

Referenced by MemberGroup::friendCount().

int MemberList::numDecMembers

(

)

const [inline]

Definition at line 133 of file memberlist.h.

Referenced by MemberGroup::countDecMembers(), MemberGroup::numDecMembers(), writeDeclarations(), and writePlainDeclarations().

int MemberList::numDocMembers

(

)

const [inline]

Definition at line 134 of file memberlist.h.

Referenced by MemberGroup::countDocMembers(), NamespaceDef::countMembers(), MemberGroup::numDocMembers(), and writeDocumentation().

void MemberList::countDecMembers

(

bool

countEnumValues = FALSE

)

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

Definition at line 58 of file memberlist.cpp.

References MemberDef::argsString(), Config_getBool, MemberGroup::countDecMembers(), MemberDef::DCOP, MemberDef::Define, MemberGroup::defineCount(), MemberGroup::enumCount(), MemberDef::Enumeration, MemberDef::EnumValue, MemberGroup::enumValueCount(), err(), MemberDef::Event, MemberDef::Friend, MemberGroup::friendCount(), MemberGroup::funcCount(), MemberDef::Function, MemberDef::getClassDef(), MemberDef::hasDocumentation(), MemberDef::initializer(), MemberDef::isBriefSectionVisible(), MemberDef::isRelated(), MemberDef::memberType(), MemberDef::name, MemberGroup::numDecMembers(), MemberDef::Property, MemberGroup::protoCount(), MemberDef::Prototype, MemberDef::Signal, MemberDef::Slot, MemberDef::Typedef, MemberGroup::typedefCount(), MemberGroup::varCount(), and MemberDef::Variable.

Referenced by MemberGroup::countDecMembers(), writeDeclarations(), and writePlainDeclarations().

void MemberList::countDocMembers

(

bool

countEnumValues = FALSE

)

Definition at line 127 of file memberlist.cpp.

References MemberGroup::countDocMembers(), MemberDef::EnumValue, MemberDef::isDetailedSectionVisible(), MemberDef::memberType(), and MemberGroup::numDocMembers().

Referenced by MemberGroup::countDocMembers(), NamespaceDef::countMembers(), and writeDocumentation().

void MemberList::writePlainDeclarations	(	OutputList &	ol,
		ClassDef *	cd,
		NamespaceDef *	nd,
		FileDef *	fd,
		GroupDef *	gd
	)

Definition at line 175 of file memberlist.cpp.

References MemberDef::anonymousDeclShown(), Definition::briefDescription(), Definition::briefFile(), Definition::briefLine(), Config_getBool, countDecMembers(), MemberDef::DCOP, MemberDef::Define, OutputList::disableAllBut(), OutputList::docify(), OutputList::enableAll(), OutputList::endMemberDescription(), OutputList::endMemberItem(), OutputList::endMemberList(), OutputList::endTextLink(), MemberDef::Enumeration, MemberDef::EnumValue, MemberDef::Event, MemberDef::Friend, MemberDef::fromAnonymousScope(), MemberDef::Function, OutputGenerator::Html, OutputList::insertMemberAlign(), MemberDef::isBriefSectionVisible(), MemberDef::memberType(), MemberDef::name, numDecMembers(), OutputList::parseDoc(), OutputList::parseText(), OutputList::popGeneratorState(), MemberDef::Property, MemberDef::Prototype, OutputList::pushGeneratorState(), QCString, MemberDef::setAnonymousEnumType(), MemberDef::setFromAnonymousScope(), MemberDef::Signal, MemberDef::Slot, OutputList::startMemberDescription(), OutputList::startMemberItem(), OutputList::startMemberList(), OutputList::startTextLink(), theTranslator, Translator::trMore(), MemberDef::Typedef, MemberDef::typeString(), MemberDef::Variable, MemberDef::warnIfUndocumented(), MemberDef::writeDeclaration(), MemberDef::writeEnumDeclaration(), and OutputList::writeString().

Referenced by writeDeclarations(), and MemberGroup::writePlainDeclarations().

void MemberList::writeDeclarations	(	OutputList &	ol,
		ClassDef *	cd,
		NamespaceDef *	nd,
		FileDef *	fd,
		GroupDef *	gd,
		const char *	title,
		const char *	subtitle,
		bool	showEnumValues = FALSE
	)

Definition at line 316 of file memberlist.cpp.

References countDecMembers(), MemberGroup::documentation(), OutputList::endMemberGroup(), OutputList::endMemberGroupDocs(), OutputList::endMemberGroupHeader(), OutputList::endMemberHeader(), OutputList::endMemberSubtitle(), MemberGroup::header(), numDecMembers(), OutputList::parseDoc(), OutputList::parseText(), OutputList::startMemberGroup(), OutputList::startMemberGroupDocs(), OutputList::startMemberGroupHeader(), OutputList::startMemberHeader(), OutputList::startMemberSubtitle(), MemberGroup::writePlainDeclarations(), and writePlainDeclarations().

Referenced by MemberGroup::writeDeclarations().

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

Definition at line 375 of file memberlist.cpp.

References countDocMembers(), OutputList::endGroupHeader(), OutputList::endMemberDocList(), numDocMembers(), OutputList::parseText(), OutputList::startGroupHeader(), OutputList::startMemberDocList(), MemberGroup::writeDocumentation(), MemberDef::writeDocumentation(), and OutputList::writeRuler().

Referenced by MemberGroup::writeDocumentation().

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

Definition at line 412 of file memberlist.cpp.

References endFile(), MemberDef::getOutputFileBase(), MemberDef::name, QCString, MemberDef::qualifiedName(), startFile(), MemberDef::writeDocumentation(), MemberGroup::writeDocumentationPage(), Definition::writeNavigationPath(), Definition::writeQuickMemberLinks(), and OutputList::writeString().

Referenced by MemberGroup::writeDocumentationPage(), NamespaceDef::writeMemberPages(), GroupDef::writeMemberPages(), FileDef::writeMemberPages(), and ClassDef::writeMemberPages().

void MemberList::addMemberGroup

(

MemberGroup *

mg

)

Definition at line 453 of file memberlist.cpp.

Referenced by MemberGroup::addToDeclarationSection().

void MemberList::setInGroup

(

bool

inGroup

)

[inline]

Definition at line 147 of file memberlist.h.

Referenced by MemberGroup::setInGroup().

void MemberList::setInFile

(

bool

inFile

)

[inline]

Definition at line 148 of file memberlist.h.

void MemberList::addListReferences

(

Definition *

def

)

Definition at line 463 of file memberlist.cpp.

References MemberDef::addListReference(), MemberGroup::addListReferences(), DefinitionIntf::definitionType(), MemberDef::Enumeration, MemberDef::enumFieldList(), enumFields, MemberDef::getGroupDef(), MemberDef::memberType(), and DefinitionIntf::TypeGroup.

Referenced by NamespaceDef::addListReferences(), MemberGroup::addListReferences(), GroupDef::addListReferences(), FileDef::addListReferences(), and ClassDef::addListReferences().

void MemberList::findSectionsInDocumentation

(

)

Definition at line 495 of file memberlist.cpp.

References MemberGroup::findSectionsInDocumentation(), and MemberDef::findSectionsInDocumentation().

Referenced by NamespaceDef::findSectionsInDocumentation(), MemberGroup::findSectionsInDocumentation(), GroupDef::findSectionsInDocumentation(), FileDef::findSectionsInDocumentation(), and ClassDef::findSectionsInDocumentation().

MemberGroupList* MemberList::getMemberGroupList

(

)

const [inline]

Definition at line 151 of file memberlist.h.

Referenced by VhdlDocGen::writeVHDLDeclarations().

void MemberList::marshal

(

StorageIntf *

s

)

Definition at line 514 of file memberlist.cpp.

References MemberGroup::marshal(), marshalBool(), marshalInt(), marshalUInt(), and NULL_LIST.

Referenced by marshalMemberList().

void MemberList::unmarshal

(

StorageIntf *

s

)

Definition at line 545 of file memberlist.cpp.

References NULL_LIST, unmarshalBool(), unmarshalInt(), and unmarshalUInt().

Referenced by unmarshalMemberList().

---

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

• memberlist.h
• memberlist.cpp

---

• ソフトウェア開発
• ホームページ制作
• Tcl版
• STLport版
• Dradnats C++ Library
• 要約文庫