FTVHelp Class Reference

#include <ftvhelp.h>

Inheritance diagram for FTVHelp:

IndexIntf List of all members.

Public Member Functions

 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)
void addIndexItem (const char *, const char *, const char *, const char *, const char *, const MemberDef *)
void addIndexFile (const char *)

Detailed Description

A class that generates a dynamic tree view side panel.

Definition at line 58 of file ftvhelp.h.

Constructor & Destructor Documentation

FTVHelp::FTVHelp (  ) 

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

Definition at line 335 of file ftvhelp.cpp.

References MAX_INDENT.

Member Function Documentation

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 363 of file ftvhelp.cpp.

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 371 of file ftvhelp.cpp.

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 383 of file ftvhelp.cpp.

References MAX_INDENT.

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 395 of file ftvhelp.cpp.

References FTVNode::children.

void FTVHelp::addContentsItem ( bool  isDir,
const char *  name,
const char *  ref,
const char *  file,
const char *  anchor 
) [virtual]

Add a list item to the contents file.

Parameters:
isDir TRUE if the item is a directory, FALSE if it is a text
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.

Implements IndexIntf.

Definition at line 421 of file ftvhelp.cpp.

References FTVNode::parent.

void FTVHelp::addIndexItem ( const char *  ,
const char *  ,
const char *  ,
const char *  ,
const char *  ,
const MemberDef *   
) [inline, virtual]

Implements IndexIntf.

Definition at line 72 of file ftvhelp.h.

void FTVHelp::addIndexFile ( const char *   )  [inline, virtual]

Implements IndexIntf.

Definition at line 75 of file ftvhelp.h.

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


Generated on Mon Mar 31 10:59:00 2008 by  doxygen 1.5.1