PageContext::Private类 参考

类 PageContext::Private 继承关系图:

PageContext::Private 的协作图:

类
struct	Cachable

Public 成员函数
	Private (const PageDef *pd, bool isMainPage, bool isExample)
virtual	~Private ()
TemplateVariant	get (const QCString &n) const
StringVector	fields () const
TemplateVariant	title () const
TemplateVariant	relPath () const
TemplateVariant	highlight () const
TemplateVariant	subHighlight () const
TemplateVariant	example () const
Public 成员函数 继承自 DefinitionContext< PageContext::Private >
	DefinitionContext (const Definition *d)
virtual	~DefinitionContext ()

Private 成员函数
TemplateVariant	createExample () const

Private 属性
const PageDef *	m_pageDef
Cachable	m_cachable
bool	m_isMainPage
bool	m_isExample

静态 Private 属性
static const PropertyMap< PageContext::Private >	s_inst

额外继承的成员函数
Protected 成员函数 继承自 DefinitionContext< PageContext::Private >
TemplateVariant	fileName () const
TemplateVariant	anchor () const
TemplateVariant	sourceFileName () const
TemplateVariant	isLinkable () const
TemplateVariant	isLinkableInProject () const
TemplateVariant	name () const
TemplateVariant	bareName () const
TemplateVariant	details () const
TemplateVariant	brief () const
TemplateVariant	inbodyDocs () const
TemplateVariant	dynSectionId () const
TemplateVariant	sourceDef () const
TemplateVariant	navigationPath () const
TemplateVariant	partOfGroups () const
TemplateVariant	isReference () const
TemplateVariant	externalReference () const
TemplateVariant	language () const
TemplateVariant	compoundKind () const
QCString	relPathAsString () const
virtual TemplateVariant	relPath () const

详细描述

在文件 context.cpp 第 3270 行定义.

构造及析构函数说明

Private()

PageContext::Private::Private ( const PageDef *  pd, bool  isMainPage, bool  isExample  )

inline

在文件 context.cpp 第 3273 行定义.

      : DefinitionContext<PageContext::Private>(pd) , m_pageDef(pd), m_isMainPage(isMainPage),
        m_isExample(isExample)
    {
    }

~Private()

virtual PageContext::Private::~Private ( )

inlinevirtual

在文件 context.cpp 第 3278 行定义.

{}

成员函数说明

createExample()

TemplateVariant PageContext::Private::createExample ( ) const

inlineprivate

在文件 context.cpp 第 3344 行定义.

    {
      return m_isExample ?
          TemplateVariant(parseDoc(m_pageDef,m_pageDef->docFile(),m_pageDef->docLine(),
                  relPathAsString(),"\\include "+m_pageDef->name(),FALSE)) :
          TemplateVariant("");
    }

引用了 Definition::docFile(), Definition::docLine(), FALSE, m_isExample, m_pageDef, Definition::name(), parseDoc() , 以及 DefinitionContext< PageContext::Private >::relPathAsString().

example()

TemplateVariant PageContext::Private::example ( ) const

inline

在文件 context.cpp 第 3339 行定义.

    {
      return m_cachable.example.get(this);
    }

引用了 PageContext::Private::Cachable::example , 以及 m_cachable.

fields()

StringVector PageContext::Private::fields ( ) const

inline

在文件 context.cpp 第 3282 行定义.

{ return s_inst.fields(); }

引用了 PropertyMap< T >::fields() , 以及 s_inst.

get()

TemplateVariant PageContext::Private::get ( const QCString &  n ) const

inline

在文件 context.cpp 第 3281 行定义.

{ return s_inst.get(this,n); }

引用了 PropertyMap< T >::get() , 以及 s_inst.

highlight()

TemplateVariant PageContext::Private::highlight ( ) const

inline

在文件 context.cpp 第 3324 行定义.

    {
      if (m_isMainPage)
      {
        return "main";
      }
      else
      {
        return "pages";
      }
    }

引用了 m_isMainPage.

relPath()

TemplateVariant PageContext::Private::relPath ( ) const

inline

在文件 context.cpp 第 3319 行定义.

    {
      return m_isMainPage ? TemplateVariant("") :
                            TemplateVariant(DefinitionContext<PageContext::Private>::relPath());
    }

引用了 m_isMainPage.

subHighlight()

TemplateVariant PageContext::Private::subHighlight ( ) const

inline

在文件 context.cpp 第 3335 行定义.

    {
      return "";
    }

title()

TemplateVariant PageContext::Private::title ( ) const

inline

在文件 context.cpp 第 3285 行定义.

    {
      if (m_isMainPage)
      {
        QCString projectName = Config_getString(PROJECT_NAME);
        if (Doxygen::mainPage && !Doxygen::mainPage->title().isEmpty())
        {
          if (Doxygen::mainPage->title().lower()!="notitle")
          {
            return m_pageDef->title();
          }
          else
          {
            return "";
          }
        }
        else if (!projectName.isEmpty())
        {
          return projectName+" "+theTranslator->trDocumentation();
        }
        else
        {
          return theTranslator->trMainPage();
        }
      }
      else if (m_isExample)
      {
        return m_pageDef->name();
      }
      else
      {
        return m_pageDef->title();
      }
    }

引用了 Config_getString, QCString::isEmpty(), m_isExample, m_isMainPage, m_pageDef, Doxygen::mainPage, Definition::name(), theTranslator, PageDef::title(), Translator::trDocumentation() , 以及 Translator::trMainPage().

类成员变量说明

m_cachable

Cachable PageContext::Private::m_cachable

private

在文件 context.cpp 第 3357 行定义.

被这些函数引用 example().

m_isExample

bool PageContext::Private::m_isExample

private

在文件 context.cpp 第 3359 行定义.

被这些函数引用 createExample() , 以及 title().

m_isMainPage

bool PageContext::Private::m_isMainPage

private

在文件 context.cpp 第 3358 行定义.

被这些函数引用 highlight(), relPath() , 以及 title().

m_pageDef

const PageDef* PageContext::Private::m_pageDef

private

在文件 context.cpp 第 3352 行定义.

被这些函数引用 createExample() , 以及 title().

s_inst

const PropertyMap< PageContext::Private > PageContext::Private::s_inst

staticprivate

初始值:

{
  BASE_PROPERTIES,
  {  "title",       &Private::title },
  {  "highlight",   &Private::highlight },
  {  "subhighlight",&Private::subHighlight },
  {  "example",     &Private::example }
}

在文件 context.cpp 第 3360 行定义.

被这些函数引用 fields() , 以及 get().

---

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

• src/context.cpp