LayoutNavEntry Struct Reference

Base class for the layout of a navigation item at the top of the HTML pages. More...

#include <src/layout.h>

Collaboration diagram for LayoutNavEntry:

Public Types
enum	Kind { NAV_SPECIFICATIONS }

Public Member Functions
std::string	navToString ()
	LayoutNavEntry (LayoutNavEntry *parent, Kind k, bool vs, const QCString &bf, const QCString &tl, const QCString &intro)
LayoutNavEntry *	parent () const
Kind	kind () const
QCString	baseFile () const
QCString	title () const
QCString	intro () const
QCString	url () const
void	setVisible (bool v)
bool	visible ()
void	clear ()
void	addChild (std::unique_ptr< LayoutNavEntry > &&e)
void	prependChild (std::unique_ptr< LayoutNavEntry > &&e)
const LayoutNavEntryList &	children () const
LayoutNavEntry *	find (LayoutNavEntry::Kind k, const QCString &file=QCString()) const

Private Member Functions
	LayoutNavEntry ()

Private Attributes
LayoutNavEntry *	m_parent
Kind	m_kind
bool	m_visible
QCString	m_baseFile
QCString	m_title
QCString	m_intro
LayoutNavEntryList	m_children

Friends
class	LayoutDocManager

Detailed Description

Base class for the layout of a navigation item at the top of the HTML pages.

Definition at line 139 of file layout.h.

Member Enumeration Documentation

Kind

enum LayoutNavEntry::Kind

Enumerator
NAV_SPECIFICATIONS

Definition at line 177 of file layout.h.

              {
#define NSPEC(x,y) x y,
      NAV_SPECIFICATIONS
#undef NSPEC
    };

Constructor & Destructor Documentation

LayoutNavEntry() [1/2]

LayoutNavEntry::LayoutNavEntry ( LayoutNavEntry * parent, Kind k, bool vs, const QCString & bf, const QCString & tl, const QCString & intro )

inline

Definition at line 193 of file layout.h.

      : m_parent(parent), m_kind(k), m_visible(vs), m_baseFile(bf), m_title(tl), m_intro(intro) {}

References intro(), LayoutNavEntry(), m_baseFile, m_intro, m_kind, m_parent, m_title, m_visible, and parent().

Referenced by find(), LayoutNavEntry(), and parent().

LayoutNavEntry() [2/2]

LayoutNavEntry::LayoutNavEntry ( )

inlineprivate

Definition at line 213 of file layout.h.

: m_parent(nullptr), m_kind(None), m_visible(true) {}

References m_kind, m_parent, m_visible, and None.

Member Function Documentation

addChild()

void LayoutNavEntry::addChild ( std::unique_ptr< LayoutNavEntry > && e )

inline

Definition at line 205 of file layout.h.

    { m_children.push_back(std::move(e)); }

References m_children.

baseFile()

QCString LayoutNavEntry::baseFile ( ) const

inline

Definition at line 198 of file layout.h.

{ return m_baseFile; }

References m_baseFile.

Referenced by url(), and writeUserGroupStubPage().

children()

const LayoutNavEntryList & LayoutNavEntry::children ( ) const

inline

Definition at line 209 of file layout.h.

{ return m_children; }

References m_children.

Referenced by printNavLayout(), LayoutParser::recurseNavEntryChildren(), renderQuickLinksAsJs(), renderQuickLinksAsTabs(), renderQuickLinksAsTree(), writeDefaultQuickLinks(), writeIndexHierarchy(), and writeUserGroupStubPage().

clear()

void LayoutNavEntry::clear ( )

inline

Definition at line 204 of file layout.h.

{ m_children.clear(); }

References m_children.

find()

LayoutNavEntry * LayoutNavEntry::find	(	LayoutNavEntry::Kind	k,
		const QCString &	file = QCString() ) const

Definition at line 122 of file layout.cpp.

{
  LayoutNavEntry *result=nullptr;
  for (const auto &entry : m_children)
  {
    // depth first search, needed to find the entry furthest from the
    // root in case an entry is in the tree twice
    result = entry->find(kind,file);
    if (result) return result;
    if (entry->kind()==kind && (file==QCString() || entry->baseFile()==file))
    {
      return entry.get();
    }
  }
  return result;
}

References find(), kind(), LayoutNavEntry(), and m_children.

Referenced by find(), generateJSNavTree(), LayoutParser::startTop(), writeAlphabeticalExceptionIndex(), writeAlphabeticalIndex(), writeAlphabeticalInterfaceIndex(), writeAlphabeticalStructIndex(), writeAnnotatedIndexGeneric(), writeClassMemberIndex(), writeClassMemberIndexFiltered(), writeConceptIndex(), writeDefaultQuickLinks(), writeExampleIndex(), writeFileIndex(), writeFileMemberIndex(), writeFileMemberIndexFiltered(), writeGraphicalClassHierarchy(), writeGraphicalExceptionHierarchy(), writeGraphicalInterfaceHierarchy(), writeHierarchicalExceptionIndex(), writeHierarchicalIndex(), writeHierarchicalInterfaceIndex(), writeIndex(), writeModuleIndex(), writeModuleMemberIndex(), writeModuleMemberIndexFiltered(), writeNamespaceIndex(), writeNamespaceMemberIndex(), writeNamespaceMemberIndexFiltered(), writePageIndex(), writePages(), and writeTopicIndex().

intro()

QCString LayoutNavEntry::intro ( ) const

inline

Definition at line 200 of file layout.h.

{ return m_intro; }

References m_intro.

Referenced by LayoutNavEntry(), writeAnnotatedIndexGeneric(), writeClassMemberIndexFiltered(), writeConceptIndex(), writeExampleIndex(), writeFileIndex(), writeFileMemberIndexFiltered(), writeHierarchicalExceptionIndex(), writeHierarchicalIndex(), writeHierarchicalInterfaceIndex(), writeModuleIndex(), writeModuleMemberIndexFiltered(), writeNamespaceIndex(), writeNamespaceMemberIndexFiltered(), writePageIndex(), and writeTopicIndex().

kind()

Kind LayoutNavEntry::kind ( ) const

inline

Definition at line 197 of file layout.h.

{ return m_kind; }

References m_kind.

Referenced by find(), navToString(), and url().

navToString()

std::string LayoutNavEntry::navToString ( )

inline

Definition at line 182 of file layout.h.

    {
      switch (kind())
      {
#define NSPEC(x,y) case x: return #x; break;
      NAV_SPECIFICATIONS
#undef NSPEC
        default: return "unknown"; // to satisfy compiler
      }
    }

References kind(), and NAV_SPECIFICATIONS.

Referenced by printNavLayout().

parent()

LayoutNavEntry * LayoutNavEntry::parent ( ) const

inline

Definition at line 196 of file layout.h.

{ return m_parent; }

References LayoutNavEntry(), and m_parent.

Referenced by LayoutNavEntry(), and renderQuickLinksAsTabs().

prependChild()

void LayoutNavEntry::prependChild ( std::unique_ptr< LayoutNavEntry > && e )

inline

Definition at line 207 of file layout.h.

    { m_children.insert(m_children.begin(),std::move(e)); }

References m_children.

setVisible()

void LayoutNavEntry::setVisible ( bool v )

inline

Definition at line 202 of file layout.h.

{ m_visible = v; }

References m_visible.

title()

QCString LayoutNavEntry::title ( ) const

inline

Definition at line 199 of file layout.h.

{ return m_title; }

References m_title.

Referenced by generateJSNavTree(), printNavLayout(), writeAlphabeticalExceptionIndex(), writeAlphabeticalIndex(), writeAlphabeticalInterfaceIndex(), writeAlphabeticalStructIndex(), writeAnnotatedIndexGeneric(), writeClassMemberIndex(), writeClassMemberIndexFiltered(), writeConceptIndex(), writeExampleIndex(), writeFileIndex(), writeFileMemberIndex(), writeFileMemberIndexFiltered(), writeGraphicalClassHierarchy(), writeGraphicalExceptionHierarchy(), writeGraphicalInterfaceHierarchy(), writeHierarchicalExceptionIndex(), writeHierarchicalIndex(), writeHierarchicalInterfaceIndex(), writeModuleIndex(), writeModuleMemberIndex(), writeModuleMemberIndexFiltered(), writeNamespaceIndex(), writeNamespaceMemberIndex(), writeNamespaceMemberIndexFiltered(), writePageIndex(), writeTopicIndex(), and writeUserGroupStubPage().

url()

QCString LayoutNavEntry::url

(

)

const

Definition at line 140 of file layout.cpp.

{
  QCString url = baseFile().stripWhiteSpace();
  if ((kind()!=LayoutNavEntry::User && kind()!=LayoutNavEntry::UserGroup) ||
      (kind()==LayoutNavEntry::UserGroup && url.startsWith("usergroup")))
  {
    addHtmlExtensionIfMissing(url);
  }
  else if (url.startsWith("@ref ") || url.startsWith("\\ref "))
  {
    bool found=false;
    QCString relPath = "";
    QCString context = QCString();
    auto parser { createDocParser() };
    auto dfAst  { createRef( *parser.get(), url.mid(5).stripWhiteSpace(), context ) };
    auto dfAstImpl = dynamic_cast<const DocNodeAST*>(dfAst.get());
    const DocRef *df = std::get_if<DocRef>(&dfAstImpl->root);
    if (!df->file().isEmpty() || !df->anchor().isEmpty())
    {
      found = true;
      url=externalRef(relPath,df->ref(),TRUE);
      if (!df->file().isEmpty())
      {
        QCString fn = df->file();
        addHtmlExtensionIfMissing(fn);
        url += fn;
      }
      if (!df->anchor().isEmpty())
      {
        url += "#" + df->anchor();
      }
    }
    if (!found)
    {
      msg("explicit link request to '%s' in layout file '%s' could not be resolved\n",qPrint(url.mid(5)),qPrint(Config_getString(LAYOUT_FILE)));
    }
  }
  //printf("LayoutNavEntry::url()=%s\n",qPrint(url));
  return url;
}

References addHtmlExtensionIfMissing(), DocRef::anchor(), baseFile(), Config_getString, createDocParser(), createRef(), externalRef(), DocRef::file(), found, QCString::isEmpty(), kind(), msg(), qPrint(), DocRef::ref(), QCString::stripWhiteSpace(), TRUE, and url().

Referenced by url().

visible()

bool LayoutNavEntry::visible ( )

inline

Definition at line 203 of file layout.h.

{ return m_visible; }

References m_visible.

Referenced by printNavLayout(), LayoutParser::recurseNavEntryChildren(), writeAlphabeticalExceptionIndex(), writeAlphabeticalIndex(), writeAlphabeticalInterfaceIndex(), writeAlphabeticalStructIndex(), writeAnnotatedIndexGeneric(), writeClassMemberIndex(), writeClassMemberIndexFiltered(), writeConceptIndex(), writeExampleIndex(), writeFileIndex(), writeFileMemberIndex(), writeFileMemberIndexFiltered(), writeHierarchicalExceptionIndex(), writeHierarchicalIndex(), writeHierarchicalInterfaceIndex(), writeModuleIndex(), writeModuleMemberIndex(), writeModuleMemberIndexFiltered(), writeNamespaceIndex(), writeNamespaceMemberIndex(), writeNamespaceMemberIndexFiltered(), writePages(), and writeTopicIndex().

Friends And Related Symbol Documentation

LayoutDocManager

friend class LayoutDocManager

friend

Definition at line 221 of file layout.h.

References LayoutDocManager.

Referenced by LayoutDocManager.

Member Data Documentation

m_baseFile

QCString LayoutNavEntry::m_baseFile

private

Definition at line 217 of file layout.h.

Referenced by baseFile(), and LayoutNavEntry().

m_children

LayoutNavEntryList LayoutNavEntry::m_children

private

Definition at line 220 of file layout.h.

Referenced by addChild(), children(), clear(), find(), and prependChild().

m_intro

QCString LayoutNavEntry::m_intro

private

Definition at line 219 of file layout.h.

Referenced by intro(), and LayoutNavEntry().

m_kind

Kind LayoutNavEntry::m_kind

private

Definition at line 215 of file layout.h.

Referenced by kind(), LayoutNavEntry(), and LayoutNavEntry().

m_parent

LayoutNavEntry* LayoutNavEntry::m_parent

private

Definition at line 214 of file layout.h.

Referenced by LayoutNavEntry(), LayoutNavEntry(), and parent().

m_title

QCString LayoutNavEntry::m_title

private

Definition at line 218 of file layout.h.

Referenced by LayoutNavEntry(), and title().

m_visible

bool LayoutNavEntry::m_visible

private

Definition at line 216 of file layout.h.

Referenced by LayoutNavEntry(), LayoutNavEntry(), setVisible(), and visible().

---

The documentation for this struct was generated from the following files:

• src/layout.h
• src/layout.cpp