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 () const

	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

std::string	id () const

QCString	title () const

QCString	intro () const

QCString	url () const

const LayoutNavEntryList &	children () const

LayoutNavEntryList &	children ()

void	setVisible (bool v)

bool	visible () const

void	clear ()

void	insertChild (size_t pos, std::unique_ptr< LayoutNavEntry > &&e)

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

void	updateVisibility (LayoutNavEntry *parent)

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

void	swap (LayoutNavEntry &other)

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 155 of file layout.h.

Member Enumeration Documentation

◆ Kind

enum LayoutNavEntry::Kind

Enumerator
NAV_SPECIFICATIONS

Definition at line 193 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 209 of file layout.h.

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

LayoutNavEntry::m_intro

QCString m_intro

Definition layout.h:251

LayoutNavEntry::m_visible

bool m_visible

Definition layout.h:248

LayoutNavEntry::parent

LayoutNavEntry * parent() const

Definition layout.h:212

LayoutNavEntry::m_baseFile

QCString m_baseFile

Definition layout.h:249

LayoutNavEntry::m_kind

Kind m_kind

Definition layout.h:247

LayoutNavEntry::intro

QCString intro() const

Definition layout.h:217

LayoutNavEntry::m_parent

LayoutNavEntry * m_parent

Definition layout.h:246

LayoutNavEntry::m_title

QCString m_title

Definition layout.h:250

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

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

◆ LayoutNavEntry() [2/2]

LayoutNavEntry::LayoutNavEntry ( )

inlineprivate

Definition at line 245 of file layout.h.

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

RefQualifierType::None

@ None

Definition arguments.h:48

References m_kind, m_parent, m_visible, and None.

Member Function Documentation

◆ appendChild()

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

Definition at line 121 of file layout.cpp.

{
  e->updateVisibility(this);
  m_children.push_back(std::move(e));
}

References m_children.

◆ baseFile()

QCString LayoutNavEntry::baseFile ( ) const

inline

Definition at line 214 of file layout.h.

214{ return m_baseFile; }

References m_baseFile.

Referenced by url(), and writeUserGroupStubPage().

◆ children() [1/2]

LayoutNavEntryList & LayoutNavEntry::children ( )

inline

Definition at line 220 of file layout.h.

220{ return m_children; }

References m_children.

◆ children() [2/2]

const LayoutNavEntryList & LayoutNavEntry::children ( ) const

inline

Definition at line 219 of file layout.h.

219{ return m_children; }

References m_children.

Referenced by findNavEntryRec(), mergeNavTreeNodesRec(), printNavLayout(), renderQuickLinksAsJs(), renderQuickLinksAsTabs(), renderQuickLinksAsTree(), writeDefaultQuickLinks(), writeIndexHierarchy(), and writeUserGroupStubPage().

◆ clear()

void LayoutNavEntry::clear ( )

inline

Definition at line 223 of file layout.h.

223{ m_children.clear(); }

References m_children.

◆ find()

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

Definition at line 133 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(), 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().

◆ id()

std::string LayoutNavEntry::id ( ) const

inline

Definition at line 215 of file layout.h.

215{ return navToString()+":"+m_baseFile.str(); }

LayoutNavEntry::navToString

std::string navToString() const

Definition layout.h:198

References m_baseFile, and navToString().

Referenced by findNavEntryRec(), and mergeNavTreeNodesRec().

◆ insertChild()

void LayoutNavEntry::insertChild	(	size_t	pos,
		std::unique_ptr< LayoutNavEntry > &&	e )

Definition at line 127 of file layout.cpp.

{
  e->updateVisibility(this);
  m_children.insert(m_children.begin()+pos,std::move(e));
}

References m_children.

Referenced by mergeNavTreeNodesRec().

◆ intro()

QCString LayoutNavEntry::intro ( ) const

inline

Definition at line 217 of file layout.h.

217{ 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 213 of file layout.h.

213{ return m_kind; }

References m_kind.

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

◆ navToString()

std::string LayoutNavEntry::navToString ( ) const

inline

Definition at line 198 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 id(), and printNavLayout().

◆ parent()

LayoutNavEntry * LayoutNavEntry::parent ( ) const

inline

Definition at line 212 of file layout.h.

212{ return m_parent; }

References LayoutNavEntry(), and m_parent.

Referenced by LayoutNavEntry(), renderQuickLinksAsTabs(), and updateVisibility().

◆ setVisible()

void LayoutNavEntry::setVisible ( bool v )

inline

Definition at line 221 of file layout.h.

221{ m_visible = v; }

References m_visible.

◆ swap()

void LayoutNavEntry::swap ( LayoutNavEntry & other )

inline

Definition at line 228 of file layout.h.

    {
      std::swap(m_parent,other.m_parent);
      std::swap(m_kind,other.m_kind);
      std::swap(m_visible,other.m_visible);
      std::swap(m_baseFile,other.m_baseFile);
      std::swap(m_title,other.m_title);
      std::swap(m_intro,other.m_intro);
      std::swap(m_children,other.m_children);
      // reparent children
      for (auto &child : m_children)
      {
        child->m_parent = this;
      }
    }

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

◆ title()

QCString LayoutNavEntry::title ( ) const

inline

Definition at line 216 of file layout.h.

216{ 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().

◆ updateVisibility()

void LayoutNavEntry::updateVisibility ( LayoutNavEntry * parent )

Definition at line 116 of file layout.cpp.

{
  m_visible = m_visible && (parent==nullptr || parent->visible());
}

References LayoutNavEntry(), m_visible, and parent().

◆ url()

QCString LayoutNavEntry::url ( ) const

Definition at line 151 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 '{}' in layout file '{}' could not be resolved\n",url.mid(5),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, DocRef::ref(), QCString::stripWhiteSpace(), TRUE, and url().

Referenced by url().

◆ visible()

bool LayoutNavEntry::visible ( ) const

inline

Friends And Related Symbol Documentation

◆ LayoutDocManager

friend class LayoutDocManager

friend

Definition at line 253 of file layout.h.

References LayoutDocManager.

Referenced by LayoutDocManager.

Member Data Documentation

◆ m_baseFile

QCString LayoutNavEntry::m_baseFile

private

Definition at line 249 of file layout.h.

Referenced by baseFile(), id(), LayoutNavEntry(), and swap().

◆ m_children

LayoutNavEntryList LayoutNavEntry::m_children

private

Definition at line 252 of file layout.h.

Referenced by appendChild(), children(), children(), clear(), find(), insertChild(), and swap().

◆ m_intro

QCString LayoutNavEntry::m_intro

private

Definition at line 251 of file layout.h.

Referenced by intro(), LayoutNavEntry(), and swap().

◆ m_kind

Kind LayoutNavEntry::m_kind

private

Definition at line 247 of file layout.h.

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

◆ m_parent

LayoutNavEntry* LayoutNavEntry::m_parent

private

Definition at line 246 of file layout.h.

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

◆ m_title

QCString LayoutNavEntry::m_title

private

Definition at line 250 of file layout.h.

Referenced by LayoutNavEntry(), swap(), and title().

◆ m_visible

bool LayoutNavEntry::m_visible

private

Definition at line 248 of file layout.h.

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

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

src/layout.h
src/layout.cpp

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Enumeration Documentation

◆ Kind

Constructor & Destructor Documentation

◆ LayoutNavEntry() [1/2]

◆ LayoutNavEntry() [2/2]

Member Function Documentation

◆ appendChild()

◆ baseFile()

◆ children() [1/2]

◆ children() [2/2]

◆ clear()

◆ find()

◆ id()

◆ insertChild()

◆ intro()

◆ kind()

◆ navToString()

◆ parent()

◆ setVisible()

◆ swap()

◆ title()

◆ updateVisibility()

◆ url()

◆ visible()

Friends And Related Symbol Documentation

◆ LayoutDocManager

Member Data Documentation

◆ m_baseFile

◆ m_children

◆ m_intro

◆ m_kind

◆ m_parent

◆ m_title

◆ m_visible