summaryrefslogtreecommitdiffstats
path: root/src/groupdef.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/groupdef.h')
-rw-r--r--src/groupdef.h168
1 files changed, 0 insertions, 168 deletions
diff --git a/src/groupdef.h b/src/groupdef.h
deleted file mode 100644
index 1f594a0..0000000
--- a/src/groupdef.h
+++ /dev/null
@@ -1,168 +0,0 @@
-/******************************************************************************
- *
- *
- *
- * Copyright (C) 1997-2005 by Dimitri van Heesch.
- *
- * Permission to use, copy, modify, and distribute this software and its
- * documentation under the terms of the GNU General Public License is hereby
- * granted. No representations are made about the suitability of this software
- * for any purpose. It is provided "as is" without express or implied warranty.
- * See the GNU General Public License for more details.
- *
- * Documents produced by Doxygen are derivative works derived from the
- * input used in their production; they are not affected by this license.
- *
- */
-
-#ifndef GROUPDEF_H
-#define GROUPDEF_H
-
-#include "qtbc.h"
-#include "sortdict.h"
-#include "definition.h"
-#include "memberlist.h"
-#include "memberdef.h"
-#include "htmlhelp.h"
-
-class FileList;
-class ClassSDict;
-class FileDef;
-class ClassDef;
-class NamespaceDef;
-class GroupList;
-class OutputList;
-class NamespaceSDict;
-class MemberGroupSDict;
-class MemberNameInfoSDict;
-class PageSDict;
-class PageDef;
-class DirDef;
-class DirList;
-
-class GroupDef : public Definition
-{
- public:
- GroupDef(const char *fileName,int line,const char *name,const char *title,const char *refFileName=0);
- ~GroupDef();
- DefType definitionType() const { return TypeGroup; }
- QCString getOutputFileBase() const;
- const char *groupTitle() const { return title; }
- void setGroupTitle( const char *newtitle );
- bool hasGroupTitle( ) { return titleSet; }
- void addFile(const FileDef *def);
- void addClass(const ClassDef *def);
- void addNamespace(const NamespaceDef *def);
- void addGroup(const GroupDef *def);
- void addParentGroup(const GroupDef *def);
- void addPage(PageDef *def);
- void addExample(const PageDef *def);
- void addDir(const DirDef *dd);
- bool insertMember(MemberDef *def,bool docOnly=FALSE);
- void removeMember(MemberDef *md);
- bool containsGroup(const GroupDef *def); // true if def is already a subgroup
- void writeDetailedDocumentation(OutputList &ol);
- void writeDocumentation(OutputList &ol);
- void writeMemberDocumentation(OutputList &ol);
- void writeMemberPages(OutputList &ol);
- void writeQuickMemberLinks(OutputList &ol,MemberDef *currentMd) const;
- int countMembers() const;
- bool isLinkableInProject() const
- {
- return !isReference();
- }
- bool isLinkable() const
- {
- return TRUE;
- }
- bool isASubGroup() const;
- void computeAnchors();
-
- void addMembersToMemberGroup();
- void distributeMemberGroupDocumentation();
- void findSectionsInDocumentation();
-
- void addListReferences();
-
- bool visited; // number of times accessed for output - KPW
-
- friend void writeGroupTreeNode(OutputList&, GroupDef*, int);
- // make accessible for writing tree view of group in index.cpp - KPW
-
- // members in the declaration part of the documentation
- MemberList decDefineMembers;
- MemberList decProtoMembers;
- MemberList decTypedefMembers;
- MemberList decEnumMembers;
- MemberList decEnumValMembers;
- MemberList decFuncMembers;
- MemberList decVarMembers;
-
- // members in the documentation part of the documentation
- MemberList docDefineMembers;
- MemberList docProtoMembers;
- MemberList docTypedefMembers;
- MemberList docEnumMembers;
- MemberList docFuncMembers;
- MemberList docVarMembers;
-
- /* user defined member groups */
- MemberGroupSDict *memberGroupSDict;
-
- FileList * getFiles() const { return fileList; }
- ClassSDict * getClasses() const { return classSDict; }
- NamespaceSDict * getNamespaces() const { return namespaceSDict; }
- GroupList * getSubGroups() const { return groupList; }
- PageSDict * getPages() const { return pageDict; }
- DirList * getDirs() const { return dirList; }
- MemberList* getMembers() const { return allMemberList; }
-
- protected:
- void addMemberListToGroup(MemberList *,bool (MemberDef::*)() const);
-
- private:
- QCString title; // title of the group
- bool titleSet; // true if title is not the same as the name
- QCString fileName; // base name of the generated file
- FileList *fileList; // list of files in the group
- ClassSDict *classSDict; // list of classes in the group
- NamespaceSDict *namespaceSDict; // list of namespaces in the group
- GroupList *groupList; // list of sub groups.
- PageSDict *pageDict; // list of pages in the group
- PageSDict *exampleDict; // list of examples in the group
- DirList *dirList; // list of directories in the group
-
- MemberList *allMemberList;
- MemberNameInfoSDict *allMemberNameInfoSDict;
-
-
-};
-
-class GroupSDict : public SDict<GroupDef>
-{
- public:
- GroupSDict(uint size) : SDict<GroupDef>(size) {}
- virtual ~GroupSDict() {}
-};
-
-class GroupList : public QList<GroupDef>
-{
-};
-
-class GroupListIterator : public QListIterator<GroupDef>
-{
- public:
- GroupListIterator(const GroupList &l) : QListIterator<GroupDef>(l) {}
- virtual ~GroupListIterator() {}
-};
-
-void addClassToGroups(Entry *root,ClassDef *cd);
-void addNamespaceToGroups(Entry *root,NamespaceDef *nd);
-void addGroupToGroups(Entry *root,GroupDef *subGroup);
-void addMemberToGroups(Entry *root,MemberDef *md);
-void addPageToGroups(Entry *root,PageDef *pd);
-void addExampleToGroups(Entry *root,PageDef *eg);
-void addDirToGroups(Entry *root,DirDef *dd);
-
-#endif
-