Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

THelpTopic Class Reference

Part of the help system. More...

#include <helpbase.h>

Inheritance diagram for THelpTopic::

TObject TStreamable List of all members.

Public Methods

 THelpTopic ()
 THelpTopic (StreamableInit)
virtual ~THelpTopic ()
void addCrossRef (TCrossRef ref)
void addParagraph (TParagraph *p)
void getCrossRef (int i, TPoint &loc, uchar &length, int &ref)
char* getLine (int line, char *buffer, int buflen)
int getNumCrossRefs ()
int numLines ()
void setCrossRef (int i, TCrossRef &ref)
void setNumCrossRefs (int i)
void setWidth (int aWidth)

Static Public Methods

TStreamablebuild ()

Public Attributes

TParagraphparagraphs
int numRefs
TCrossRefcrossRefs

Static Public Attributes

const char* const name

Protected Methods

virtual void write (opstream &os)
virtual void* read (ipstream &is)

Detailed Description

Part of the help system.

Definition at line 91 of file helpbase.h.


Constructor & Destructor Documentation

THelpTopic::THelpTopic ( )
 

Undocumented.

THelpTopic::THelpTopic ( StreamableInit ) [inline]
 

Undocumented.

Definition at line 101 of file helpbase.h.

THelpTopic::~THelpTopic ( ) [virtual]
 

Undocumented.


Member Function Documentation

void THelpTopic::addCrossRef ( TCrossRef ref )
 

Undocumented.

void THelpTopic::addParagraph ( TParagraph * p )
 

Undocumented.

TStreamable * THelpTopic::build ( ) [static]
 

Undocumented.

void THelpTopic::getCrossRef ( int i,
TPoint & loc,
uchar & length,
int & ref )
 

Undocumented.

char * THelpTopic::getLine ( int line,
char * buffer,
int buflen )
 

Undocumented.

int THelpTopic::getNumCrossRefs ( )
 

Undocumented.

int THelpTopic::numLines ( )
 

Undocumented.

void * THelpTopic::read ( ipstream & is ) [protected, virtual]
 

This pure virtual function must be overridden (or redeclared as pure virtual) in every derived class. The overriding read() function for each streamable class must read the necessary data members from the ipstream object `is'. read() is usually implemented by calling the base class's read() (if any), then extracting any additional data members for the derived class.

Reimplemented from TStreamable.

void THelpTopic::setCrossRef ( int i,
TCrossRef & ref )
 

Undocumented.

void THelpTopic::setNumCrossRefs ( int i )
 

Undocumented.

void THelpTopic::setWidth ( int aWidth )
 

Undocumented.

void THelpTopic::write ( opstream & os ) [protected, virtual]
 

This pure virtual function must be overridden (or redeclared as pure virtual) in every derived class. The overriding write() function for each streamable class must write the necessary data members to the opstream object `os'. write() is usually implemented by calling the base class's write() (if any), then inserting any additional data members for the derived class.

Reimplemented from TStreamable.


Member Data Documentation

TCrossRef * THelpTopic::crossRefs
 

Undocumented.

Definition at line 153 of file helpbase.h.

const char *const THelpTopic::name [static]
 

Undocumented.

Definition at line 174 of file helpbase.h.

int THelpTopic::numRefs
 

Undocumented.

Definition at line 149 of file helpbase.h.

TParagraph * THelpTopic::paragraphs
 

Undocumented.

Definition at line 145 of file helpbase.h.


The documentation for this class was generated from the following file:
Generated at Sat Sep 22 20:19:26 2001 for TVision by doxygen1.2.8.1 written by Dimitri van Heesch, © 1997-2001