FTVHelp Class Reference

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

#include <ftvhelp.h>

Inheritance diagram for FTVHelp:

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

Static Public Member Functions
static void	generateTreeViewImages ()

Detailed Description

A class that generates a dynamic tree view side panel.

Constructor & Destructor Documentation

FTVHelp()

FTVHelp::FTVHelp

(

bool

TLI

)

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

~FTVHelp()

FTVHelp::~FTVHelp

(

)

Destroys the ftv help object.

Member Function Documentation

addContentsItem()

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

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.
ref	the URL of to the item.
file	the file containing the definition of the item
anchor	the anchor within the file.
name	the name of the item.
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.

decContentsDepth()

void FTVHelp::decContentsDepth ( )

virtual

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

See also

incContentsDepth()

Implements IndexIntf.

finalize()

void FTVHelp::finalize ( )

virtual

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

See also

initialize()

Implements IndexIntf.

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.

initialize()

void FTVHelp::initialize ( )

virtual

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

See also

finalize()

Implements IndexIntf.

---

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

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