PageContext::Private Class Reference

Inheritance diagram for PageContext::Private:

Classes
struct	Cachable

Public Member Functions
	Private (PageDef *pd, bool isMainPage, bool isExample)
virtual	~Private ()
TemplateVariant	get (const char *n) const
TemplateVariant	title () const
TemplateVariant	relPath () const
TemplateVariant	highlight () const
TemplateVariant	subHighlight () const
TemplateVariant	example () const
Public Member Functions inherited from DefinitionContext< PageContext::Private >
	DefinitionContext (Definition *d)
void	addBaseProperties (PropertyMapper< PageContext::Private > &inst)
TemplateVariant	fileName () const
TemplateVariant	anchor () const
TemplateVariant	sourceFileName () const
TemplateVariant	isLinkable () const
TemplateVariant	isLinkableInProject () const
TemplateVariant	name () const
TemplateVariant	bareName () const
QCString	relPathAsString () const
TemplateVariant	details () const
TemplateVariant	brief () const
TemplateVariant	inbodyDocs () const
TemplateVariant	dynSectionId () const
TemplateVariant	language () const
TemplateVariant	compoundKind () const
TemplateVariant	sourceDef () const
void	fillPath (Definition *def, TemplateList *list) const
TemplateVariant	navigationPath () const
TemplateVariant	isReference () const
TemplateVariant	externalReference () const

Private Member Functions
Cachable &	getCache () const

Private Attributes
PageDef *	m_pageDef
bool	m_isMainPage
bool	m_isExample

Static Private Attributes
static PropertyMapper < PageContext::Private >	s_inst

Detailed Description

Definition at line 3582 of file context.cpp.

Constructor & Destructor Documentation

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

inline

Definition at line 3585 of file context.cpp.

References DefinitionContext< PageContext::Private >::addBaseProperties(), Definition::cookie(), example(), highlight(), Config::init(), s_inst, Definition::setCookie(), subHighlight(), and title().

      : DefinitionContext<PageContext::Private>(pd) , m_pageDef(pd), m_isMainPage(isMainPage),
        m_isExample(isExample)
    {
      static bool init=FALSE;
      if (!init)
      {
        addBaseProperties(s_inst);
        s_inst.addProperty("title",       &Private::title);
        s_inst.addProperty("highlight",   &Private::highlight);
        s_inst.addProperty("subhighlight",&Private::subHighlight);
        s_inst.addProperty("example",     &Private::example);
        init=TRUE;
      }
      if (!pd->cookie()) { pd->setCookie(new PageContext::Private::Cachable(pd)); }
    }

virtual PageContext::Private::~Private ( )

inlinevirtual

Definition at line 3601 of file context.cpp.

{}

Member Function Documentation

TemplateVariant PageContext::Private::example ( ) const

inline

Definition at line 3654 of file context.cpp.

References Definition::docFile(), Definition::docLine(), PageContext::Private::Cachable::example, PageContext::Private::Cachable::exampleOutputFormat, g_globals, getCache(), m_isExample, m_pageDef, Definition::name(), ContextGlobals::outputFormat, parseDoc(), DefinitionContext< PageContext::Private >::relPathAsString(), and ScopedPtr< T >::reset().

Referenced by Private().

    {
      if (m_isExample)
      {
        Cachable &cache = getCache();
        if (!cache.example || g_globals.outputFormat!=cache.exampleOutputFormat)
        {
          cache.example.reset(new TemplateVariant(
                parseDoc(m_pageDef,m_pageDef->docFile(),m_pageDef->docLine(),
                  relPathAsString(),"\\include "+m_pageDef->name(),FALSE)));
          cache.exampleOutputFormat = g_globals.outputFormat;
        }
        return *cache.example;
      }
      else
      {
        return TemplateVariant("");
      }
    }

TemplateVariant PageContext::Private::get ( const char *  n ) const

inline

Definition at line 3602 of file context.cpp.

References s_inst.

Referenced by PageContext::get().

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

Cachable& PageContext::Private::getCache ( ) const

inlineprivate

Definition at line 3682 of file context.cpp.

References Definition::cookie(), and m_pageDef.

Referenced by example().

    {
      Cachable *c = static_cast<Cachable*>(m_pageDef->cookie());
      assert(c!=0);
      return *c;
    }

TemplateVariant PageContext::Private::highlight ( ) const

inline

Definition at line 3639 of file context.cpp.

References m_isMainPage.

Referenced by Private().

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

TemplateVariant PageContext::Private::relPath ( ) const

inlinevirtual

Reimplemented from DefinitionContext< PageContext::Private >.

Definition at line 3628 of file context.cpp.

References m_isMainPage, and DefinitionContext< T >::relPath().

    {
      if (m_isMainPage)
      {
        return "";
      }
      else
      {
        return DefinitionContext<PageContext::Private>::relPath();
      }
    }

TemplateVariant PageContext::Private::subHighlight ( ) const

inline

Definition at line 3650 of file context.cpp.

Referenced by Private().

    {
      return "";
    }

TemplateVariant PageContext::Private::title ( ) const

inline

Definition at line 3606 of file context.cpp.

References m_isExample, m_isMainPage, m_pageDef, mainPageHasTitle(), Definition::name(), theTranslator, PageDef::title(), and Translator::trMainPage().

Referenced by Private().

    {
      if (m_isMainPage)
      {
        if (mainPageHasTitle())
        {
          return m_pageDef->title();
        }
        else
        {
          return theTranslator->trMainPage();
        }
      }
      else if (m_isExample)
      {
        return m_pageDef->name();
      }
      else
      {
        return m_pageDef->title();
      }
    }

Member Data Documentation

bool PageContext::Private::m_isExample

private

Definition at line 3689 of file context.cpp.

Referenced by example(), and title().

bool PageContext::Private::m_isMainPage

private

Definition at line 3688 of file context.cpp.

Referenced by highlight(), relPath(), and title().

PageDef* PageContext::Private::m_pageDef

private

Definition at line 3674 of file context.cpp.

Referenced by example(), getCache(), and title().

PropertyMapper< PageContext::Private > PageContext::Private::s_inst

staticprivate

Definition at line 3690 of file context.cpp.

Referenced by get(), and Private().

---

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

• context.cpp