ClassTreeContext::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_classTree
Cachable	m_cache

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

Detailed Description

Definition at line 6692 of file context.cpp.

Constructor & Destructor Documentation

ClassTreeContext::Private::Private ( )

inline

Definition at line 6695 of file context.cpp.

    {
      m_classTree.reset(NestingContext::alloc(0,0));
      if (Doxygen::namespaceSDict)
      {
        m_classTree->addNamespaces(*Doxygen::namespaceSDict,TRUE,TRUE);
      }
      if (Doxygen::classSDict)
      {
        m_classTree->addClasses(*Doxygen::classSDict,TRUE);
      }
      //%% Nesting tree
      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 ClassTreeContext::Private::fileName ( ) const

inline

Definition at line 6729 of file context.cpp.

    {
      return "annotated";
    }

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

inline

Definition at line 6721 of file context.cpp.

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

TemplateVariant ClassTreeContext::Private::highlight ( ) const

inline

Definition at line 6737 of file context.cpp.

    {
      return "classes";
    }

TemplateVariant ClassTreeContext::Private::maxDepth ( ) const

inline

Definition at line 6762 of file context.cpp.

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

TemplateVariant ClassTreeContext::Private::preferredDepth ( ) const

inline

Definition at line 6771 of file context.cpp.

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

TemplateVariant ClassTreeContext::Private::relPath ( ) const

inline

Definition at line 6733 of file context.cpp.

    {
      return "";
    }

TemplateVariant ClassTreeContext::Private::subhighlight ( ) const

inline

Definition at line 6741 of file context.cpp.

    {
      return "classlist";
    }

TemplateVariant ClassTreeContext::Private::title ( ) const

inline

Definition at line 6745 of file context.cpp.

    {
      static bool fortranOpt = Config_getBool("OPTIMIZE_FOR_FORTRAN");
      static bool vhdlOpt    = Config_getBool("OPTIMIZE_OUTPUT_VHDL");
      if (fortranOpt)
      {
        return theTranslator->trCompoundListFortran();
      }
      else if (vhdlOpt)
      {
        return VhdlDocGen::trDesignUnitList();
      }
      else
      {
        return theTranslator->trClasses();
      }
    }

TemplateVariant ClassTreeContext::Private::tree ( ) const

inline

Definition at line 6725 of file context.cpp.

    {
      return m_classTree.get();
    }

Member Data Documentation

Cachable ClassTreeContext::Private::m_cache

mutableprivate

Definition at line 6791 of file context.cpp.

SharedPtr<NestingContext> ClassTreeContext::Private::m_classTree

private

Definition at line 6781 of file context.cpp.

PropertyMapper< ClassTreeContext::Private > ClassTreeContext::Private::s_inst

staticprivate

Definition at line 6792 of file context.cpp.

---

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

• doxygen-1.8.11/src/context.cpp