A class that generates a dynamic tree view side panel. 更多...

#include <ftvhelp.h>

类 FTVHelp 继承关系图:

FTVHelp 的协作图:

Public 成员函数
	FTVHelp (bool LTI)

	~FTVHelp ()

void	initialize ()

void	finalize ()

void	incContentsDepth ()

void	decContentsDepth ()

void	addContentsItem (bool isDir, const QCString &name, const QCString &ref, const QCString &file, const QCString &anchor, bool separateIndex, bool addToNavIndex, const Definition *def)

void	addIndexItem (const Definition , const MemberDef , const QCString &, const QCString &)

void	addIndexFile (const QCString &)

void	addImageFile (const QCString &)

void	addStyleSheetFile (const QCString &)

void	generateTreeView ()

void	generateTreeViewInline (TextStream &t)

void	generateTreeViewScripts ()

Public 成员函数继承自 IndexIntf
virtual	~IndexIntf ()

静态 Public 成员函数
static void	generateTreeViewImages ()

Private 成员函数
void	generateTree (TextStream &t, const std::vector< FTVNode * > &nl, int level, int maxLevel, int &index)

QCString	generateIndentLabel (FTVNode *n, int level)

void	generateIndent (TextStream &t, FTVNode *n, bool opened)

void	generateLink (TextStream &t, FTVNode *n)

Private 属性
std::vector< std::vector< FTVNode * > >	m_indentNodes

int	m_indent

bool	m_topLevelIndex

详细描述

A class that generates a dynamic tree view side panel.

在文件 ftvhelp.h 第 36 行定义.

构造及析构函数说明

◆ FTVHelp()

FTVHelp::FTVHelp ( bool TLI )

Constructs an ftv help object. The object has to be initialized before it can be used.

在文件 ftvhelp.cpp 第 126 行定义.

 {
   /* initial depth */
   m_indentNodes.resize(1);
   m_indent=0;
   m_topLevelIndex = TLI;
 }

引用了 m_indent, m_indentNodes , 以及 m_topLevelIndex.

◆ ~FTVHelp()

FTVHelp::~FTVHelp ( )

Destroys the ftv help object.

在文件 ftvhelp.cpp 第 135 行定义.

 {
   for (auto &idx : m_indentNodes)
   {
     for (auto &n : idx)
     {
       delete n;
     }
     idx.clear();
   }
   m_indentNodes.clear();
 }

引用了 m_indentNodes.

成员函数说明

◆ addContentsItem()

void FTVHelp::addContentsItem	(	bool	isDir,
		const QCString &	name,
		const QCString &	ref,
		const QCString &	file,
		const QCString &	anchor,
		bool	separateIndex,
		bool	addToNavIndex,
		const Definition *	def
	)

virtual

Add a list item to the contents file.

参数

isDir	TRUE if the item is a directory, FALSE if it is a text
name	the name of the item.
ref	the URL of to the item.
file	the file containing the definition of the item
anchor	the anchor within the file.
separateIndex	put the entries in a separate index file
addToNavIndex	add this entry to the quick navigation index
def	Definition corresponding to this entry

实现了 IndexIntf.

在文件 ftvhelp.cpp 第 210 行定义.

 {
   //printf("%p: m_indent=%d addContentsItem(%s,%s,%s,%s)\n",this,m_indent,name,ref,file,anchor);
   std::vector<FTVNode*> &nl = m_indentNodes[m_indent];
   FTVNode *newNode = new FTVNode(isDir,ref,file,anchor,name,separateIndex,addToNavIndex,def);
   if (!nl.empty())
   {
     nl.back()->isLast=FALSE;
   }
   nl.push_back(newNode);
   newNode->index = static_cast<int>(nl.size()-1);
   if (m_indent>0)
   {
     std::vector<FTVNode*> &pnl = m_indentNodes[m_indent-1];
     if (!pnl.empty())
     {
       newNode->parent = pnl.back();
     }
   }
 }

引用了 FALSE, FTVNode::index, m_indent, m_indentNodes , 以及 FTVNode::parent.

被这些函数引用 writeClassTree(), writeClassTreeForList(), writeClassTreeInsideNamespaceElement(), writeClassTreeToOutput(), writeConceptList(), writeConceptRootList(), writeConceptTreeInsideNamespaceElement(), writeDirHierarchy(), writeDirTreeNode(), writeGroupTreeNode(), writeNamespaceTreeElement() , 以及 writePages().

◆ addImageFile()

void FTVHelp::addImageFile ( const QCString & )

inlinevirtual

实现了 IndexIntf.

在文件 ftvhelp.h 第 55 行定义.

55 {}

◆ addIndexFile()

void FTVHelp::addIndexFile ( const QCString & )

inlinevirtual

实现了 IndexIntf.

在文件 ftvhelp.h 第 54 行定义.

54 {}

◆ addIndexItem()

void FTVHelp::addIndexItem	(	const Definition *	,
		const MemberDef *	,
		const QCString &	,
		const QCString &
	)

inlinevirtual

实现了 IndexIntf.

在文件 ftvhelp.h 第 53 行定义.

53 {}

◆ addStyleSheetFile()

void FTVHelp::addStyleSheetFile ( const QCString & )

inlinevirtual

实现了 IndexIntf.

在文件 ftvhelp.h 第 56 行定义.

56 {}

◆ decContentsDepth()

void FTVHelp::decContentsDepth ( )

virtual

Decrease the level of the contents hierarchy. This will end the current sublist.

参见: incContentsDepth()

实现了 IndexIntf.

在文件 ftvhelp.cpp 第 179 行定义.

 {
   //printf("%p: decContentsDepth() indent=%d\n",this,m_indent);
   ASSERT(m_indent>0);
   if (m_indent>0)
   {
     m_indent--;
     std::vector<FTVNode*> &nl = m_indentNodes[m_indent];
     if (!nl.empty())
     {
       FTVNode *parent = nl.back();
       std::vector<FTVNode*> &children = m_indentNodes[m_indent+1];
       for (const auto &child : children)
       {
         parent->children.push_back(child);
       }
       children.clear();
     }
   }
 }

引用了 ASSERT, FTVNode::children, m_indent , 以及 m_indentNodes.

被这些函数引用 writeClassTree(), writeClassTreeInsideNamespaceElement(), writeClassTreeToOutput(), writeConceptTreeInsideNamespaceElement(), writeDirTreeNode(), writeGroupTreeNode(), writeNamespaceTreeElement() , 以及 writePages().

◆ finalize()

void FTVHelp::finalize ( )

virtual

Finalizes the FTV help. This will finish and close the contents file (index.js).

参见: initialize()

实现了 IndexIntf.

在文件 ftvhelp.cpp 第 159 行定义.

 {
   generateTreeView();
 }

引用了 generateTreeView().

◆ generateIndent()

void FTVHelp::generateIndent	(	TextStream &	t,
		FTVNode *	n,
		bool	opened
	)

private

在文件 ftvhelp.cpp 第 282 行定义.

 {
   int indent=0;
   FTVNode *p = n->parent;
   while (p) { indent++; p=p->parent; }
   if (n->isDir)
   {
     QCString dir = opened ? "&#9660;" : "&#9658;";
     t << "<span style=\"width:" << (indent*16) << "px;display:inline-block;\">&#160;</span>"
       << "<span id=\"arr_" << generateIndentLabel(n,0) << "\" class=\"arrow\" ";
     t << "onclick=\"toggleFolder('" << generateIndentLabel(n,0) << "')\"";
     t << ">" << dir
       << "</span>";
   }
   else
   {
     t << "<span style=\"width:" << ((indent+1)*16) << "px;display:inline-block;\">&#160;</span>";
   }
 }

引用了 generateIndentLabel(), FTVNode::isDir , 以及 FTVNode::parent.

被这些函数引用 generateTree().

◆ generateIndentLabel()

QCString FTVHelp::generateIndentLabel	(	FTVNode *	n,
		int	level
	)

private

在文件 ftvhelp.cpp 第 271 行定义.

 {
   QCString result;
   if (n->parent)
   {
     result=generateIndentLabel(n->parent,level+1);
   }
   result+=QCString().setNum(n->index)+"_";
   return result;
 }

引用了 FTVNode::index, FTVNode::parent , 以及 QCString::setNum().

被这些函数引用 generateIndent() , 以及 generateTree().

◆ generateLink()

void FTVHelp::generateLink	(	TextStream &	t,
		FTVNode *	n
	)

private

在文件 ftvhelp.cpp 第 302 行定义.

 {
   //printf("FTVHelp::generateLink(ref=%s,file=%s,anchor=%s\n",
   //    qPrint(n->ref),qPrint(n->file),qPrint(n->anchor));
   bool setTarget = FALSE;
   if (n->file.isEmpty()) // no link
   {
     t << "<b>" << convertToHtml(n->name) << "</b>";
   }
   else // link into other frame
   {
     if (!n->ref.isEmpty()) // link to entity imported via tag file
     {
       t << "<a class=\"elRef\" ";
       QCString result = externalLinkTarget();
       if (result != "") setTarget = TRUE;
       t << result;
     }
     else // local link
     {
       t << "<a class=\"el\" ";
     }
     t << "href=\"";
     t << externalRef("",n->ref,TRUE);
     t << node2URL(n);
     if (!setTarget)
     {
       if (m_topLevelIndex)
         t << "\" target=\"basefrm\">";
       else
         t << "\" target=\"_self\">";
     }
     else
     {
       t << "\">";
     }
     t << convertToHtml(n->name);
     t << "</a>";
     if (!n->ref.isEmpty())
     {
       t << "&#160;[external]";
     }
   }
 }

引用了 convertToHtml(), externalLinkTarget(), externalRef(), FALSE, FTVNode::file, QCString::isEmpty(), m_topLevelIndex, FTVNode::name, node2URL(), FTVNode::ref , 以及 TRUE.

被这些函数引用 generateTree().

◆ generateTree()

void FTVHelp::generateTree	(	TextStream &	t,
		const std::vector< FTVNode * > &	nl,
		int	level,
		int	maxLevel,
		int &	index
	)

private

在文件 ftvhelp.cpp 第 386 行定义.

 {
   for (const auto &n : nl)
   {
     t << "<tr id=\"row_" << generateIndentLabel(n,0) << "\"";
     if ((index&1)==0) // even row
       t << " class=\"even\"";
     if (level>=maxLevel) // item invisible by default
       t << " style=\"display:none;\"";
     else // item visible by default
       index++;
     t << "><td class=\"entry\">";
     bool nodeOpened = level+1<maxLevel;
     generateIndent(t,n,nodeOpened);
     if (n->isDir)
     {
       if (n->def && n->def->definitionType()==Definition::TypeGroup)
       {
         // no icon
       }
       else if (n->def && n->def->definitionType()==Definition::TypePage)
       {
         // no icon
       }
       else if (n->def && n->def->definitionType()==Definition::TypeNamespace)
       {
         if (n->def->getLanguage() == SrcLangExt_Slice)
         {
           t << "<span class=\"icona\"><span class=\"icon\">M</span></span>";
         }
         else
         {
           t << "<span class=\"icona\"><span class=\"icon\">N</span></span>";
         }
       }
       else if (n->def && n->def->definitionType()==Definition::TypeClass)
       {
         char icon=compoundIcon(toClassDef(n->def));
         t << "<span class=\"icona\"><span class=\"icon\">" << icon << "</span></span>";
       }
       else
       {
         t << "<span id=\"img_" << generateIndentLabel(n,0)
           << "\" class=\"iconf"
           << (nodeOpened?"open":"closed")
           << "\" onclick=\"toggleFolder('" << generateIndentLabel(n,0)
           << "')\">&#160;</span>";
       }
       generateLink(t,n);
       t << "</td><td class=\"desc\">";
       if (n->def)
       {
         generateBriefDoc(t,n->def);
       }
       t << "</td></tr>\n";
       folderId++;
       generateTree(t,n->children,level+1,maxLevel,index);
     }
     else // leaf node
     {
       const FileDef *srcRef=0;
       if (n->def && n->def->definitionType()==Definition::TypeFile &&
           (toFileDef(n->def))->generateSourceFile())
       {
         srcRef = toFileDef(n->def);
       }
       if (srcRef)
       {
         t << "<a href=\"" << addHtmlExtensionIfMissing(srcRef->getSourceFileBase())
           << "\">";
       }
       if (n->def && n->def->definitionType()==Definition::TypeGroup)
       {
         // no icon
       }
       else if (n->def && n->def->definitionType()==Definition::TypePage)
       {
         // no icon
       }
       else if (n->def && n->def->definitionType()==Definition::TypeNamespace)
       {
         if (n->def->getLanguage() == SrcLangExt_Slice)
         {
           t << "<span class=\"icona\"><span class=\"icon\">M</span></span>";
         }
         else
         {
           t << "<span class=\"icona\"><span class=\"icon\">N</span></span>";
         }
       }
       else if (n->def && n->def->definitionType()==Definition::TypeClass)
       {
         char icon=compoundIcon(toClassDef(n->def));
         t << "<span class=\"icona\"><span class=\"icon\">" << icon << "</span></span>";
       }
       else if (n->def && n->def->definitionType()==Definition::TypeConcept)
       {
         t << "<span class=\"icona\"><span class=\"icon\">R</span></span>";
       }
       else if (n->def && n->def->definitionType()==Definition::TypeDir)
       {
         t << "<span class=\"iconfclosed\"></span>";
       }
       else
       {
         t << "<span class=\"icondoc\"></span>";
       }
       if (srcRef)
       {
         t << "</a>";
       }
       generateLink(t,n);
       t << "</td><td class=\"desc\">";
       if (n->def)
       {
         generateBriefDoc(t,n->def);
       }
       t << "</td></tr>\n";
     }
   }
 }

引用了 addHtmlExtensionIfMissing(), compoundIcon(), folderId, generateBriefDoc(), generateIndent(), generateIndentLabel(), generateLink(), FileDef::getSourceFileBase(), SrcLangExt_Slice, toClassDef(), toFileDef(), Definition::TypeClass, Definition::TypeConcept, Definition::TypeDir, Definition::TypeFile, Definition::TypeGroup, Definition::TypeNamespace , 以及 Definition::TypePage.

被这些函数引用 generateTreeViewInline().

◆ generateTreeView()

void FTVHelp::generateTreeView ( )

在文件 ftvhelp.cpp 第 848 行定义.

 {
   generateTreeViewImages();
   generateTreeViewScripts();
 }

引用了 generateTreeViewImages() , 以及 generateTreeViewScripts().

被这些函数引用 finalize().

◆ generateTreeViewImages()

void FTVHelp::generateTreeViewImages ( )

static

在文件 ftvhelp.cpp 第 763 行定义.

 {
   QCString dname=Config_getString(HTML_OUTPUT);
   const ResourceMgr &rm = ResourceMgr::instance();
   rm.copyResource("doc.luma",dname);
   rm.copyResource("folderopen.luma",dname);
   rm.copyResource("folderclosed.luma",dname);
   rm.copyResource("splitbar.lum",dname);
 }

引用了 Config_getString, ResourceMgr::copyResource() , 以及 ResourceMgr::instance().

被这些函数引用 generateOutput() , 以及 generateTreeView().

◆ generateTreeViewInline()

void FTVHelp::generateTreeViewInline ( TextStream & t )

在文件 ftvhelp.cpp 第 787 行定义.

 {
   int preferredNumEntries = Config_getInt(HTML_INDEX_NUM_ENTRIES);
   t << "<div class=\"directory\">\n";
   int d=1, depth=1;
   for (const auto &n : m_indentNodes[0])
   {
     if (!n->children.empty())
     {
       d = n->computeTreeDepth(2);
       if (d>depth) depth=d;
     }
   }
   int preferredDepth = depth;
   // write level selector
   if (depth>1)
   {
     t << "<div class=\"levels\">[";
     t << theTranslator->trDetailLevel();
     t << " ";
     for (int i=1;i<=depth;i++)
     {
       t << "<span onclick=\"javascript:toggleLevel(" << i << ");\">" << i << "</span>";
     }
     t << "]</div>";
  
     if (preferredNumEntries>0)
     {
       preferredDepth=1;
       for (int i=1;i<=depth;i++)
       {
         int num=0;
         for (const auto &n : m_indentNodes[0])
         {
           num+=n->numNodesAtLevel(0,i);
         }
         if (num<=preferredNumEntries)
         {
           preferredDepth=i;
         }
         else
         {
           break;
         }
       }
     }
   }
   //printf("preferred depth=%d\n",preferredDepth);
  
   if (!m_indentNodes[0].empty())
   {
     t << "<table class=\"directory\">\n";
     int index=0;
     generateTree(t,m_indentNodes[0],0,preferredDepth,index);
     t << "</table>\n";
   }
  
   t << "</div><!-- directory -->\n";
 }

引用了 Config_getInt, generateTree(), m_indentNodes, theTranslator , 以及 Translator::trDetailLevel().

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

◆ generateTreeViewScripts()

void FTVHelp::generateTreeViewScripts ( )

在文件 ftvhelp.cpp 第 774 行定义.

 {
   QCString htmlOutput = Config_getString(HTML_OUTPUT);
  
   // generate navtree.js & navtreeindex.js
   generateJSNavTree(m_indentNodes[0]);
  
   // copy resize.js & navtree.css
   ResourceMgr::instance().copyResource("resize.js",htmlOutput);
   ResourceMgr::instance().copyResource("navtree.css",htmlOutput);
 }

引用了 Config_getString, ResourceMgr::copyResource(), generateJSNavTree(), ResourceMgr::instance() , 以及 m_indentNodes.

被这些函数引用 generateTreeView().

◆ incContentsDepth()

void FTVHelp::incContentsDepth ( )

virtual

Increase the level of the contents hierarchy. This will start a new sublist in contents file.

参见: decContentsDepth()

实现了 IndexIntf.

在文件 ftvhelp.cpp 第 168 行定义.

 {
   //printf("%p: incContentsDepth() indent=%d\n",this,m_indent);
   m_indent++;
   m_indentNodes.resize(m_indent+1);
 }

引用了 m_indent , 以及 m_indentNodes.

被这些函数引用 writeClassTree(), writeClassTreeInsideNamespaceElement(), writeClassTreeToOutput(), writeConceptTreeInsideNamespaceElement(), writeDirTreeNode(), writeGroupTreeNode(), writeNamespaceTreeElement() , 以及 writePages().

◆ initialize()

void FTVHelp::initialize ( )

virtual

This will create a folder tree view table of contents file (tree.js).

参见: finalize()

实现了 IndexIntf.

在文件 ftvhelp.cpp 第 151 行定义.

152 {

153 }

类成员变量说明

◆ m_indent

int FTVHelp::m_indent

private

在文件 ftvhelp.h 第 67 行定义.

被这些函数引用 addContentsItem(), decContentsDepth(), FTVHelp() , 以及 incContentsDepth().

◆ m_indentNodes

std::vector< std::vector<FTVNode*> > FTVHelp::m_indentNodes

private

在文件 ftvhelp.h 第 66 行定义.

被这些函数引用 addContentsItem(), decContentsDepth(), FTVHelp(), generateTreeViewInline(), generateTreeViewScripts(), incContentsDepth() , 以及 ~FTVHelp().

◆ m_topLevelIndex

bool FTVHelp::m_topLevelIndex

private

在文件 ftvhelp.h 第 68 行定义.

被这些函数引用 FTVHelp() , 以及 generateLink().

该类的文档由以下文件生成:

src/ftvhelp.h
src/ftvhelp.cpp

Public 成员函数

静态 Public 成员函数

Private 成员函数

Private 属性

详细描述

构造及析构函数说明

◆ FTVHelp()

◆ ~FTVHelp()

成员函数说明

◆ addContentsItem()

◆ addImageFile()

◆ addIndexFile()

◆ addIndexItem()

◆ addStyleSheetFile()

◆ decContentsDepth()

◆ finalize()

◆ generateIndent()

◆ generateIndentLabel()

◆ generateLink()

◆ generateTree()

◆ generateTreeView()

◆ generateTreeViewImages()

◆ generateTreeViewInline()

◆ generateTreeViewScripts()

◆ incContentsDepth()

◆ initialize()

类成员变量说明

◆ m_indent

◆ m_indentNodes

◆ m_topLevelIndex