blob: c0a7bf0b75ff7f53f756f2dc6020a03ef88eec0d (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
|
/******************************************************************************
*
* Copyright (C) 1997-2020 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 PAGEDEF_H
#define PAGEDEF_H
#include "definition.h"
#include "sortdict.h"
class PageLinkedRefMap;
class OutputList;
class FTextStream;
/** @brief A model of a page symbol. */
class PageDef : public DefinitionMutable, public Definition
{
public:
virtual ~PageDef() {}
// setters
virtual void setFileName(const char *name) = 0;
virtual void setLocalToc(const LocalToc &tl) = 0;
virtual void setShowLineNo(bool) = 0;
// getters
virtual DefType definitionType() const = 0;
virtual bool isLinkableInProject() const = 0;
virtual bool isLinkable() const = 0;
virtual QCString getOutputFileBase() const = 0;
virtual QCString anchor() const = 0;
virtual void findSectionsInDocumentation() = 0;
virtual QCString title() const = 0;
virtual const GroupDef *getGroupDef() const = 0;
virtual const PageLinkedRefMap &getSubPages() const = 0;
virtual void addInnerCompound(const Definition *) = 0;
virtual bool visibleInIndex() const = 0;
virtual bool documentedPage() const = 0;
virtual bool hasSubPages() const = 0;
virtual bool hasParentPage() const = 0;
virtual bool hasTitle() const = 0;
virtual LocalToc localToc() const = 0;
virtual void setPageScope(Definition *) = 0;
virtual Definition *getPageScope() const = 0;
virtual QCString displayName(bool=TRUE) const = 0;
virtual bool showLineNo() const = 0;
virtual void writeDocumentation(OutputList &) = 0;
virtual void writeTagFile(FTextStream &) = 0;
virtual void setNestingLevel(int) = 0;
virtual void writePageDocumentation(OutputList &) const = 0;
};
PageDef *createPageDef(const char *f,int l,const char *n,const char *d,const char *t);
// --- Cast functions
PageDef *toPageDef(Definition *d);
const PageDef *toPageDef(const Definition *d);
// ------------------
class PageLinkedMap : public LinkedMap<PageDef>
{
};
class PageLinkedRefMap : public LinkedRefMap<const PageDef>
{
};
#endif
|
