LayoutNavEntry结构体 参考

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

#include <layout.h>

LayoutNavEntry 的协作图:

Public 类型
enum	Kind {   None = -1, MainPage, Pages, Modules,   Namespaces, NamespaceList, NamespaceMembers, Concepts,   Classes, ClassList, ClassIndex, ClassHierarchy,   ClassMembers, Interfaces, InterfaceList, InterfaceIndex,   InterfaceHierarchy, Structs, StructList, StructIndex,   Exceptions, ExceptionList, ExceptionIndex, ExceptionHierarchy,   Files, FileList, FileGlobals, Examples,   User, UserGroup }

Public 成员函数
	LayoutNavEntry (LayoutNavEntry *parent, Kind k, bool vs, const QCString &bf, const QCString &tl, const QCString &intro, bool prepend=false)
LayoutNavEntry *	parent () const
Kind	kind () const
QCString	baseFile () const
QCString	title () const
QCString	intro () const
QCString	url () const
bool	visible ()
void	clear ()
void	addChild (LayoutNavEntry *e)
void	prependChild (LayoutNavEntry *e)
const LayoutNavEntryList &	children () const
LayoutNavEntry *	find (LayoutNavEntry::Kind k, const QCString &file=QCString()) const

Private 成员函数
	LayoutNavEntry ()

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

友元
class	LayoutDocManager

详细描述

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

在文件 layout.h 第 125 行定义.

成员枚举类型说明

Kind

enum LayoutNavEntry::Kind

枚举值
None
MainPage
Pages
Modules
Namespaces
NamespaceList
NamespaceMembers
Concepts
Classes
ClassList
ClassIndex
ClassHierarchy
ClassMembers
Interfaces
InterfaceList
InterfaceIndex
InterfaceHierarchy
Structs
StructList
StructIndex
Exceptions
ExceptionList
ExceptionIndex
ExceptionHierarchy
Files
FileList
FileGlobals
Examples
User
UserGroup

在文件 layout.h 第 128 行定义.

              {
      None = -1,
      MainPage,
      Pages,
      Modules,
      Namespaces,
      NamespaceList,
      NamespaceMembers,
      Concepts,
      Classes,
      ClassList,
      ClassIndex,
      ClassHierarchy,
      ClassMembers,
      Interfaces,
      InterfaceList,
      InterfaceIndex,
      InterfaceHierarchy,
      Structs,
      StructList,
      StructIndex,
      Exceptions,
      ExceptionList,
      ExceptionIndex,
      ExceptionHierarchy,
      Files,
      FileList,
      FileGlobals,
      Examples,
      User,
      UserGroup
    };

构造及析构函数说明

LayoutNavEntry() [1/2]

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

inline

在文件 layout.h 第 160 行定义.

      : m_parent(parent), m_kind(k), m_visible(vs), m_baseFile(bf), m_title(tl), m_intro(intro)
    {
      if (parent)
      {
        if (prepend) parent->prependChild(this); else parent->addChild(this);
      }
    }

引用了 addChild(), parent() , 以及 prependChild().

LayoutNavEntry() [2/2]

LayoutNavEntry::LayoutNavEntry ( )

inlineprivate

在文件 layout.h 第 183 行定义.

: m_parent(0), m_kind(None), m_visible(FALSE) {}

成员函数说明

addChild()

void LayoutNavEntry::addChild ( LayoutNavEntry *  e )

inline

在文件 layout.h 第 177 行定义.

{ m_children.push_back(std::unique_ptr<LayoutNavEntry>(e)); }

引用了 m_children.

被这些函数引用 LayoutNavEntry().

baseFile()

QCString LayoutNavEntry::baseFile ( ) const

inline

在文件 layout.h 第 171 行定义.

{ return m_baseFile; }

引用了 m_baseFile.

被这些函数引用 url() , 以及 writeUserGroupStubPage().

children()

const LayoutNavEntryList& LayoutNavEntry::children ( ) const

inline

在文件 layout.h 第 179 行定义.

{ return m_children; }

引用了 m_children.

被这些函数引用 renderQuickLinksAsJs(), renderQuickLinksAsTabs(), renderQuickLinksAsTree(), writeDefaultQuickLinks(), writeIndexHierarchy() , 以及 writeUserGroupStubPage().

clear()

void LayoutNavEntry::clear ( )

inline

在文件 layout.h 第 176 行定义.

{ m_children.clear(); }

引用了 m_children.

被这些函数引用 LayoutParser::startNavIndex().

find()

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

在文件 layout.cpp 第 107 行定义.

{
  LayoutNavEntry *result=0;
  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;
}

引用了 find(), kind() , 以及 m_children.

被这些函数引用 LayoutParser::endNavIndex(), find(), generateJSNavTree(), writeAlphabeticalExceptionIndex(), writeAlphabeticalIndex(), writeAlphabeticalInterfaceIndex(), writeAlphabeticalStructIndex(), writeAnnotatedIndexGeneric(), writeClassMemberIndex(), writeClassMemberIndexFiltered(), writeConceptIndex(), writeDefaultQuickLinks(), writeExampleIndex(), writeFileIndex(), writeFileMemberIndex(), writeFileMemberIndexFiltered(), writeGraphicalClassHierarchy(), writeGraphicalExceptionHierarchy(), writeGraphicalInterfaceHierarchy(), writeGroupIndex(), writeHierarchicalExceptionIndex(), writeHierarchicalIndex(), writeHierarchicalInterfaceIndex(), writeNamespaceIndex(), writeNamespaceMemberIndex(), writeNamespaceMemberIndexFiltered(), writePageIndex() , 以及 writePages().

intro()

QCString LayoutNavEntry::intro ( ) const

inline

在文件 layout.h 第 173 行定义.

{ return m_intro; }

引用了 m_intro.

被这些函数引用 writeAnnotatedIndexGeneric(), writeClassMemberIndexFiltered(), writeConceptIndex(), writeExampleIndex(), writeFileIndex(), writeFileMemberIndexFiltered(), writeGroupIndex(), writeHierarchicalExceptionIndex(), writeHierarchicalIndex(), writeHierarchicalInterfaceIndex(), writeNamespaceIndex(), writeNamespaceMemberIndexFiltered() , 以及 writePageIndex().

kind()

Kind LayoutNavEntry::kind ( ) const

inline

在文件 layout.h 第 170 行定义.

{ return m_kind; }

引用了 m_kind.

被这些函数引用 find() , 以及 url().

parent()

LayoutNavEntry* LayoutNavEntry::parent ( ) const

inline

在文件 layout.h 第 169 行定义.

{ return m_parent; }

引用了 m_parent.

被这些函数引用 LayoutParser::endNavEntry(), LayoutNavEntry() , 以及 renderQuickLinksAsTabs().

prependChild()

void LayoutNavEntry::prependChild ( LayoutNavEntry *  e )

inline

在文件 layout.h 第 178 行定义.

{ m_children.insert(m_children.begin(),std::unique_ptr<LayoutNavEntry>(e)); }

引用了 m_children.

被这些函数引用 LayoutNavEntry().

title()

QCString LayoutNavEntry::title ( ) const

inline

在文件 layout.h 第 172 行定义.

{ return m_title; }

引用了 m_title.

被这些函数引用 generateJSNavTree(), writeAlphabeticalExceptionIndex(), writeAlphabeticalIndex(), writeAlphabeticalInterfaceIndex(), writeAlphabeticalStructIndex(), writeAnnotatedIndexGeneric(), writeClassMemberIndex(), writeClassMemberIndexFiltered(), writeConceptIndex(), writeExampleIndex(), writeFileIndex(), writeFileMemberIndex(), writeFileMemberIndexFiltered(), writeGraphicalClassHierarchy(), writeGraphicalExceptionHierarchy(), writeGraphicalInterfaceHierarchy(), writeGroupIndex(), writeHierarchicalExceptionIndex(), writeHierarchicalIndex(), writeHierarchicalInterfaceIndex(), writeNamespaceIndex(), writeNamespaceMemberIndex(), writeNamespaceMemberIndexFiltered(), writePageIndex() , 以及 writeUserGroupStubPage().

url()

QCString LayoutNavEntry::url

(

)

const

在文件 layout.cpp 第 127 行定义.

{
  QCString url = baseFile().stripWhiteSpace();
  if ((kind()!=LayoutNavEntry::User && kind()!=LayoutNavEntry::UserGroup) ||
      (kind()==LayoutNavEntry::UserGroup && url.left(9)=="usergroup"))
  {
    url = addHtmlExtensionIfMissing(url);
  }
  else if (url.left(5)=="@ref " || url.left(5)=="\\ref ")
  {
    const Definition *d = 0;
    QCString anchor;
    bool found=FALSE;
    if (resolveLink(QCString(),url.mid(5).stripWhiteSpace(),TRUE,&d,anchor))
    {
      if (d && d->isLinkable())
      {
        url=addHtmlExtensionIfMissing(d->getOutputFileBase());
        if (!anchor.isEmpty())
        {
          url+="#"+anchor;
        }
        found=TRUE;
      }
    }
    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;
}

引用了 addHtmlExtensionIfMissing(), baseFile(), Config_getString, FALSE, Definition::getOutputFileBase(), QCString::isEmpty(), Definition::isLinkable(), kind(), QCString::left(), QCString::mid(), msg(), qPrint(), resolveLink(), QCString::stripWhiteSpace(), TRUE, User , 以及 UserGroup.

visible()

bool LayoutNavEntry::visible ( )

inline

在文件 layout.h 第 175 行定义.

{ return m_visible; }

引用了 m_visible.

被这些函数引用 writeAlphabeticalExceptionIndex(), writeAlphabeticalIndex(), writeAlphabeticalInterfaceIndex(), writeAlphabeticalStructIndex(), writeAnnotatedIndexGeneric(), writeClassMemberIndex(), writeClassMemberIndexFiltered(), writeConceptIndex(), writeExampleIndex(), writeFileIndex(), writeFileMemberIndex(), writeFileMemberIndexFiltered(), writeGroupIndex(), writeHierarchicalExceptionIndex(), writeHierarchicalIndex(), writeHierarchicalInterfaceIndex(), writeNamespaceIndex(), writeNamespaceMemberIndex(), writeNamespaceMemberIndexFiltered() , 以及 writePages().

友元及相关函数文档

LayoutDocManager

friend class LayoutDocManager

friend

在文件 layout.h 第 191 行定义.

类成员变量说明

m_baseFile

QCString LayoutNavEntry::m_baseFile

private

在文件 layout.h 第 187 行定义.

被这些函数引用 baseFile().

m_children

LayoutNavEntryList LayoutNavEntry::m_children

private

在文件 layout.h 第 190 行定义.

被这些函数引用 addChild(), children(), clear(), find() , 以及 prependChild().

m_intro

QCString LayoutNavEntry::m_intro

private

在文件 layout.h 第 189 行定义.

被这些函数引用 intro().

m_kind

Kind LayoutNavEntry::m_kind

private

在文件 layout.h 第 185 行定义.

被这些函数引用 kind().

m_parent

LayoutNavEntry* LayoutNavEntry::m_parent

private

在文件 layout.h 第 184 行定义.

被这些函数引用 parent().

m_title

QCString LayoutNavEntry::m_title

private

在文件 layout.h 第 188 行定义.

被这些函数引用 title().

m_visible

bool LayoutNavEntry::m_visible

private

在文件 layout.h 第 186 行定义.

被这些函数引用 visible().

---

该结构体的文档由以下文件生成:

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