ExampleTreeContext::Private Class Reference

Classes
struct	Cachable

Public Member Functions
	Private ()
TemplateVariant	get (const char *n) const
TemplateVariant	tree () const
TemplateVariant	fileName () const
TemplateVariant	relPath () const
TemplateVariant	highlight () const
TemplateVariant	subhighlight () const
TemplateVariant	title () const
TemplateVariant	maxDepth () const
TemplateVariant	preferredDepth () const

Private Attributes
SharedPtr< NestingContext >	m_exampleTree
Cachable	m_cache

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

Detailed Description

Definition at line 7721 of file context.cpp.

Constructor & Destructor Documentation

ExampleTreeContext::Private::Private ( )

inline

Definition at line 7724 of file context.cpp.

References NestingContext::addPages(), NestingContext::alloc(), Doxygen::exampleSDict, fileName(), highlight(), Config::init(), m_exampleTree, maxDepth(), preferredDepth(), relPath(), SharedPtr< T >::reset(), s_inst, subhighlight(), title(), and tree().

    {
      m_exampleTree.reset(NestingContext::alloc(0,0));
      // Add pages
      if (Doxygen::exampleSDict)
      {
        m_exampleTree->addPages(*Doxygen::exampleSDict,TRUE);
      }

      static bool init=FALSE;
      if (!init)
      {
        s_inst.addProperty("tree",          &Private::tree);
        s_inst.addProperty("fileName",      &Private::fileName);
        s_inst.addProperty("relPath",       &Private::relPath);
        s_inst.addProperty("highlight",     &Private::highlight);
        s_inst.addProperty("subhighlight",  &Private::subhighlight);
        s_inst.addProperty("title",         &Private::title);
        s_inst.addProperty("preferredDepth",&Private::preferredDepth);
        s_inst.addProperty("maxDepth",      &Private::maxDepth);
        init=TRUE;
      }
    }

Member Function Documentation

TemplateVariant ExampleTreeContext::Private::fileName ( ) const

inline

Definition at line 7755 of file context.cpp.

Referenced by Private().

    {
      return "examples";
    }

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

inline

Definition at line 7747 of file context.cpp.

References s_inst.

Referenced by ExampleTreeContext::get().

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

TemplateVariant ExampleTreeContext::Private::highlight ( ) const

inline

Definition at line 7763 of file context.cpp.

Referenced by Private().

    {
      return "examples";
    }

TemplateVariant ExampleTreeContext::Private::maxDepth ( ) const

inline

Definition at line 7775 of file context.cpp.

References computeMaxDepth(), SharedPtr< T >::get(), m_cache, m_exampleTree, ExampleTreeContext::Private::Cachable::maxDepth, and ExampleTreeContext::Private::Cachable::maxDepthComputed.

Referenced by preferredDepth(), and Private().

    {
      if (!m_cache.maxDepthComputed)
      {
        m_cache.maxDepth = computeMaxDepth(m_exampleTree.get());
        m_cache.maxDepthComputed=TRUE;
      }
      return m_cache.maxDepth;
    }

TemplateVariant ExampleTreeContext::Private::preferredDepth ( ) const

inline

Definition at line 7784 of file context.cpp.

References computePreferredDepth(), SharedPtr< T >::get(), m_cache, m_exampleTree, maxDepth(), ExampleTreeContext::Private::Cachable::preferredDepth, ExampleTreeContext::Private::Cachable::preferredDepthComputed, and TemplateVariant::toInt().

Referenced by Private().

    {
      if (!m_cache.preferredDepthComputed)
      {
        m_cache.preferredDepth = computePreferredDepth(m_exampleTree.get(),maxDepth().toInt());
        m_cache.preferredDepthComputed=TRUE;
      }
      return m_cache.preferredDepth;
    }

TemplateVariant ExampleTreeContext::Private::relPath ( ) const

inline

Definition at line 7759 of file context.cpp.

Referenced by Private().

    {
      return "";
    }

TemplateVariant ExampleTreeContext::Private::subhighlight ( ) const

inline

Definition at line 7767 of file context.cpp.

Referenced by Private().

    {
      return "";
    }

TemplateVariant ExampleTreeContext::Private::title ( ) const

inline

Definition at line 7771 of file context.cpp.

References theTranslator, and Translator::trExamples().

Referenced by Private().

    {
      return theTranslator->trExamples();
    }

TemplateVariant ExampleTreeContext::Private::tree ( ) const

inline

Definition at line 7751 of file context.cpp.

References SharedPtr< T >::get(), and m_exampleTree.

Referenced by Private().

    {
      return m_exampleTree.get();
    }

Member Data Documentation

Cachable ExampleTreeContext::Private::m_cache

mutableprivate

Definition at line 7803 of file context.cpp.

Referenced by maxDepth(), and preferredDepth().

SharedPtr<NestingContext> ExampleTreeContext::Private::m_exampleTree

private

Definition at line 7794 of file context.cpp.

Referenced by maxDepth(), preferredDepth(), Private(), and tree().

PropertyMapper< ExampleTreeContext::Private > ExampleTreeContext::Private::s_inst

staticprivate

Definition at line 7804 of file context.cpp.

Referenced by get(), and Private().

---

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

• context.cpp