FTVHelp Class Reference

A class that generates a dynamic tree view side panel. More...

#include <src/ftvhelp.h>

Inheritance diagram for FTVHelp:

Collaboration diagram for FTVHelp:

Classes
struct	Private

Public Member Functions
	FTVHelp (bool LTI)
	~FTVHelp ()
void	initialize ()
void	finalize ()
void	incContentsDepth ()
void	decContentsDepth ()
void	addContentsItem (bool isDir, const DString &name, const DString &ref, const DString &file, const DString &anchor, bool separateIndex, bool addToNavIndex, const Definition *def, const DString &nameAsHtml=DString())
void	addIndexItem (const Definition *, const MemberDef *, const DString &, const DString &)
void	addIndexFile (const DString &)
void	addImageFile (const DString &)
void	addStyleSheetFile (const DString &)
void	generateTreeView ()
void	generateTreeViewInline (TextStream &t)
void	generateTreeViewScripts ()

Private Attributes
std::unique_ptr< Private >	p

Detailed Description

A class that generates a dynamic tree view side panel.

Definition at line 40 of file ftvhelp.h.

Constructor & Destructor Documentation

FTVHelp()

FTVHelp::FTVHelp

(

bool

TLI

)

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

Definition at line 123 of file ftvhelp.cpp.

: p(std::make_unique<Private>(TLI)) {}

References p.

Referenced by ~FTVHelp().

~FTVHelp()

FTVHelp::~FTVHelp ( )

default

References FTVHelp().

Member Function Documentation

addContentsItem()

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

virtual

Add a list item to the contents file.

Parameters

isDir	true if the item is a directory, false if it is a text
name	the name of the item.
nameAsHtml	the name of the item in HTML format.
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

Implements IndexIntf.

Definition at line 189 of file ftvhelp.cpp.

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

References p.

Referenced by writeClassTree(), writeClassTreeForList(), writeClassTreeInsideNamespaceElement(), writeClassTreeToOutput(), writeDirHierarchy(), writeDirTreeNode(), and writeNamespaceTreeElement().

addImageFile()

void FTVHelp::addImageFile ( const DString & )

inlinevirtual

Implements IndexIntf.

Definition at line 62 of file ftvhelp.h.

{}

addIndexFile()

void FTVHelp::addIndexFile ( const DString & )

inlinevirtual

Implements IndexIntf.

Definition at line 61 of file ftvhelp.h.

{}

addIndexItem()

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

inlinevirtual

Implements IndexIntf.

Definition at line 60 of file ftvhelp.h.

{}

addStyleSheetFile()

void FTVHelp::addStyleSheetFile ( const DString & )

inlinevirtual

Implements IndexIntf.

Definition at line 63 of file ftvhelp.h.

{}

decContentsDepth()

void FTVHelp::decContentsDepth ( )

virtual

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

See also

incContentsDepth()

Implements IndexIntf.

Definition at line 157 of file ftvhelp.cpp.

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

References ASSERT, p, and parent().

Referenced by writeClassTree(), writeClassTreeInsideNamespaceElement(), writeClassTreeToOutput(), writeDirTreeNode(), and writeNamespaceTreeElement().

finalize()

void FTVHelp::finalize ( )

virtual

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

See also

initialize()

Implements IndexIntf.

Definition at line 137 of file ftvhelp.cpp.

{
  generateTreeView();
}

References generateTreeView().

generateTreeView()

void FTVHelp::generateTreeView

(

)

Definition at line 950 of file ftvhelp.cpp.

{
  generateTreeViewScripts();
}

References generateTreeViewScripts().

Referenced by finalize().

generateTreeViewInline()

void FTVHelp::generateTreeViewInline

(

TextStream &

t

)

Definition at line 885 of file ftvhelp.cpp.

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

References Config_getBool, Config_getInt, p, theTranslator, and Translator::trDetailLevel().

Referenced by writeAnnotatedIndexGeneric(), writeConceptList(), writeFileIndex(), writeHierarchicalExceptionIndex(), writeHierarchicalIndex(), writeHierarchicalInterfaceIndex(), and writeNamespaceIndex().

generateTreeViewScripts()

void FTVHelp::generateTreeViewScripts

(

)

Definition at line 876 of file ftvhelp.cpp.

{
  DString htmlOutput = Config_getString(HTML_OUTPUT);
 
  // generate navtree.js & navtreeindex.js
  generateJSNavTree(p->indentNodes[0]);
}

References Config_getString, generateJSNavTree(), and p.

Referenced by generateTreeView().

incContentsDepth()

void FTVHelp::incContentsDepth ( )

virtual

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

See also

decContentsDepth()

Implements IndexIntf.

Definition at line 146 of file ftvhelp.cpp.

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

References p.

Referenced by writeClassTree(), writeClassTreeInsideNamespaceElement(), writeClassTreeToOutput(), writeDirTreeNode(), and writeNamespaceTreeElement().

initialize()

void FTVHelp::initialize ( )

virtual

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

See also

finalize()

Implements IndexIntf.

Definition at line 129 of file ftvhelp.cpp.

{
}

Member Data Documentation

p

std::unique_ptr<Private> FTVHelp::p

private

Definition at line 69 of file ftvhelp.h.

Referenced by addContentsItem(), decContentsDepth(), FTVHelp(), generateTreeViewInline(), generateTreeViewScripts(), and incContentsDepth().

---

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

• src/ftvhelp.h
• src/ftvhelp.cpp