My Project
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | Public Attributes | List of all members
SectionInfo Struct Reference

#include <section.h>

Public Types

enum  SectionType {
  Page = 0, Section = 1, Subsection = 2, Subsubsection = 3,
  Paragraph = 4, Anchor = 5, Table = 6
}
 

Public Member Functions

 SectionInfo (const char *f, const int lin, const char *l, const char *t, SectionType st, int lev, const char *r=0)
 
 SectionInfo (const SectionInfo &s)
 
 ~SectionInfo ()
 

Public Attributes

QCString label
 
QCString title
 
SectionType type
 
QCString ref
 
Definitiondefinition
 
QCString fileName
 
int lineNr
 
bool generated
 
int level
 

Detailed Description

Class representing a section in a page

Definition at line 27 of file section.h.

Member Enumeration Documentation

Enumerator
Page 
Section 
Subsection 
Subsubsection 
Paragraph 
Anchor 
Table 

Definition at line 29 of file section.h.

{ Page = 0,
Section = 1,
Subsection = 2,
Paragraph = 4,
Anchor = 5,
Table = 6
};

Constructor & Destructor Documentation

SectionInfo::SectionInfo ( const char *  f,
const int  lin,
const char *  l,
const char *  t,
SectionType  st,
int  lev,
const char *  r = 0 
)
inline

Definition at line 37 of file section.h.

:
label(l), title(t), type(st), ref(r), definition(0),
fileName(f), lineNr(lin), generated(FALSE), level(lev)
{
}
SectionInfo::SectionInfo ( const SectionInfo s)
inline

Definition at line 43 of file section.h.

References definition, fileName, generated, label, level, lineNr, ref, title, and type.

{
label=s.label.copy();
title=s.title.copy();
type =s.type;
ref=s.ref.copy();
fileName=s.fileName.copy();
}
SectionInfo::~SectionInfo ( )
inline

Definition at line 55 of file section.h.

{}

Member Data Documentation

Definition* SectionInfo::definition

Definition at line 60 of file section.h.

Referenced by Definition::addSectionsToDefinition(), resolveLink(), resolveUserReferences(), and SectionInfo().

QCString SectionInfo::fileName

Definition at line 61 of file section.h.

Referenced by addRelatedPage(), DocAnchor::DocAnchor(), DocHtmlCaption::DocHtmlCaption(), DocRef::DocRef(), findMainPage(), marshalSectionInfoList(), DocSection::parse(), DocSecRefItem::parse(), processBlocks(), resolveUserReferences(), SectionInfo(), Definition::writeDocAnchorsToTagFile(), and writeOneLineHeaderOrRuler().

bool SectionInfo::generated

Definition at line 63 of file section.h.

Referenced by resolveUserReferences(), SectionInfo(), and Definition::writeDocAnchorsToTagFile().

QCString SectionInfo::label

Definition at line 56 of file section.h.

Referenced by Definition::addSectionsToDefinition(), Definition::addSectionsToIndex(), Definition::Definition(), DocAnchor::DocAnchor(), DocHtmlCaption::DocHtmlCaption(), DocRef::DocRef(), marshalSectionInfoList(), DocSection::parse(), DocSecRefItem::parse(), resolveLink(), resolveUserReferences(), SectionInfo(), Definition::writeDocAnchorsToTagFile(), PageDef::writeDocumentation(), writeGroupTreeNode(), GroupDef::writePageDocumentation(), and Definition::writeToc().

int SectionInfo::level

Definition at line 64 of file section.h.

Referenced by marshalSectionInfoList(), and SectionInfo().

int SectionInfo::lineNr

Definition at line 62 of file section.h.

Referenced by addRelatedPage(), findMainPage(), marshalSectionInfoList(), processBlocks(), SectionInfo(), and writeOneLineHeaderOrRuler().

QCString SectionInfo::ref

Definition at line 59 of file section.h.

Referenced by DocRef::DocRef(), marshalSectionInfoList(), SectionInfo(), and Definition::writeDocAnchorsToTagFile().

QCString SectionInfo::title

Definition at line 57 of file section.h.

Referenced by Definition::addSectionsToIndex(), DocRef::DocRef(), generateDocbookForPage(), PerlModGenerator::generatePerlModForPage(), generateXMLForPage(), marshalSectionInfoList(), DocSection::parse(), SectionInfo(), Definition::writeDocAnchorsToTagFile(), PageDef::writeDocumentation(), GroupDef::writePageDocumentation(), and Definition::writeToc().

SectionType SectionInfo::type

Definition at line 58 of file section.h.

Referenced by Definition::addSectionsToIndex(), DocRef::DocRef(), Definition::hasSections(), marshalSectionInfoList(), SectionInfo(), PageDef::writeDocumentation(), and Definition::writeToc().


The documentation for this struct was generated from the following file: