SectionManager类 参考

singleton class that owns the list of all sections 更多...

#include <section.h>

类 SectionManager 继承关系图:

SectionManager 的协作图:

Public 成员函数
SectionInfo *	add (const SectionInfo &si)
	Add a new section given the data of an existing section. 更多...
SectionInfo *	add (const QCString &label, const QCString &fileName, int lineNr, const QCString &title, SectionType type, int level, const QCString &ref=QCString())
	Add a new section Return a non-owning pointer to the newly added section 更多...
SectionInfo *	replace (const QCString &label, const QCString &fileName, int lineNr, const QCString &title, SectionType type, int level, const QCString &ref=QCString())
	Replace an existing section with a new one Return a non-owning pointer to the newly added section 更多...
Public 成员函数 继承自 LinkedMap< SectionInfo >
const SectionInfo *	find (const std::string &key) const
	Find an object given the key. 更多...
const SectionInfo *	find (const QCString &key) const
	Find an object given the key. 更多...
const SectionInfo *	find (const char *key) const
	Find an object given the key. 更多...
SectionInfo *	find (const char *key)
	A non-const wrapper for find() const 更多...
SectionInfo *	find (const QCString &key)
	A non-const wrapper for find() const 更多...
SectionInfo *	find (const std::string &key)
	A non-const wrapper for find() const 更多...
SectionInfo *	add (const char *k, Args &&... args)
	Adds a new object to the ordered vector if it was not added already. 更多...
SectionInfo *	add (const QCString &k, Args &&... args)
SectionInfo *	add (const char *k, Ptr &&ptr)
	Adds an existing object to the ordered vector (unless another object was already added under the same key). 更多...
SectionInfo *	add (const QCString &k, Ptr &&ptr)
SectionInfo *	prepend (const char *k, Args &&... args)
	Prepends a new object to the ordered vector if it was not added already. 更多...
SectionInfo *	prepend (const QCString &key, Args &&... args)
bool	del (const QCString &key)
	Removes an object from the container and deletes it. 更多...
Ptr &	operator[] (size_t pos)
const Ptr &	operator[] (size_t pos) const
iterator	begin ()
const_iterator	begin () const
iterator	end ()
const_iterator	end () const
reverse_iterator	rbegin ()
const_reverse_iterator	rbegin () const
reverse_iterator	rend ()
const_reverse_iterator	rend () const
bool	empty () const
size_t	size () const
void	clear ()

静态 Public 成员函数
static SectionManager &	instance ()
	returns a reference to the singleton 更多...

Private 成员函数
	SectionManager ()
	SectionManager (const SectionManager &other)=delete
SectionManager &	operator= (const SectionManager &other)=delete

额外继承的成员函数
Public 类型 继承自 LinkedMap< SectionInfo >
using	Ptr = std::unique_ptr< SectionInfo >
using	Vec = std::vector< Ptr >
using	iterator = typename Vec::iterator
using	const_iterator = typename Vec::const_iterator
using	reverse_iterator = typename Vec::reverse_iterator
using	const_reverse_iterator = typename Vec::const_reverse_iterator

详细描述

singleton class that owns the list of all sections

在文件 section.h 第 130 行定义.

构造及析构函数说明

SectionManager() [1/2]

SectionManager::SectionManager ( )

inlineprivate

在文件 section.h 第 179 行定义.

{}

SectionManager() [2/2]

SectionManager::SectionManager ( const SectionManager &  other )

privatedelete

成员函数说明

add() [1/2]

SectionInfo* SectionManager::add ( const QCString &  label, const QCString &  fileName, int  lineNr, const QCString &  title, SectionType  type, int  level, const QCString &  ref = QCString()  )

inline

Add a new section Return a non-owning pointer to the newly added section

在文件 section.h 第 143 行定义.

    {
      return LinkedMap<SectionInfo>::add(label.data(),fileName,lineNr,title,type,level,ref);
    }

引用了 LinkedMap< T, Hash, KeyEqual, Map >::add() , 以及 QCString::data().

add() [2/2]

SectionInfo* SectionManager::add ( const SectionInfo &  si )

inline

Add a new section given the data of an existing section.

Returns a non-owning pointer to the newly added section.

在文件 section.h 第 135 行定义.

    {
      return LinkedMap<SectionInfo>::add(si.label(),si.fileName(),
                      si.lineNr(),si.title(),si.type(),si.level(),si.ref());
    }

引用了 LinkedMap< T, Hash, KeyEqual, Map >::add(), SectionInfo::fileName(), SectionInfo::label(), SectionInfo::level(), SectionInfo::lineNr(), SectionInfo::ref(), SectionInfo::title() , 以及 SectionInfo::type().

被这些函数引用 TagFileParser::addDocAnchors(), addRelatedPage(), DefinitionImpl::addSectionsToDefinition() , 以及 findMainPage().

instance()

static SectionManager& SectionManager::instance ( )

inlinestatic

returns a reference to the singleton

在文件 section.h 第 172 行定义.

    {
      static SectionManager sm;
      return sm;
    }

被这些函数引用 TagFileParser::addDocAnchors(), addRelatedPage(), DefinitionImpl::addSectionsToDefinition(), cleanUpDoxygen(), clearAll(), DocAnchor::DocAnchor(), DocHtmlCaption::DocHtmlCaption(), DocRef::DocRef(), findMainPage(), PerlModGenerator::generatePerlModForPage(), generateXMLForPage(), DocSection::parse(), DocSecRefItem::parse(), DocRoot::parse(), resolveLink(), resolveUserReferences(), PageDefImpl::writeDocumentation(), writeGroupTreeNode(), PageDefImpl::writePageDocumentation() , 以及 GroupDefImpl::writePageDocumentation().

operator=()

SectionManager& SectionManager::operator= ( const SectionManager &  other )

privatedelete

replace()

SectionInfo* SectionManager::replace ( const QCString &  label, const QCString &  fileName, int  lineNr, const QCString &  title, SectionType  type, int  level, const QCString &  ref = QCString()  )

inline

Replace an existing section with a new one Return a non-owning pointer to the newly added section

在文件 section.h 第 151 行定义.

    {
      SectionInfo *si = LinkedMap<SectionInfo>::find(label.data());
      if (si)
      {
        si->setFileName(fileName);
        si->setLineNr(lineNr);
        si->setTitle(title);
        si->setType(type);
        si->setLevel(level);
        si->setReference(ref);
        return si;
      }
      else
      {
        return LinkedMap<SectionInfo>::add(label.data(),fileName,lineNr,title,type,level,ref);
      }
    }

引用了 LinkedMap< T, Hash, KeyEqual, Map >::add(), QCString::data(), LinkedMap< T, Hash, KeyEqual, Map >::find(), SectionInfo::setFileName(), SectionInfo::setLevel(), SectionInfo::setLineNr(), SectionInfo::setReference(), SectionInfo::setTitle() , 以及 SectionInfo::setType().

被这些函数引用 addRelatedPage() , 以及 findMainPage().

---

该类的文档由以下文件生成:

• src/section.h