Html Class Reference

Class responsbile for all operations that pertain to creating the web pages. More...

#include <Html.h>

List of all members.

Public Member Functions

void createLink (string urlToLinkTo, string urlDisplayName, string urlToLinkFrom)
 Creates the html web link on the web page.
void createTemplateLink (string urlToLinkTo, string templateString, string urlToLinkFrom)
 Adds a template string to the web page instead of a link.
 Html ()
 Creates the html directory and writes out the default style sheet if they do not exist.
void writeDefaultStyleSheet (const string &fileName)
 Write out the hardcoded default style sheet.
void writeHtmlFooter (ofstream &file)
 Writes the html footer.
void writeHtmlHeader (ofstream &file)
 Writes out the html header given the file handle to write with.
void writeWebPages ()
 Write out all the web pages stored from the links in m_links.

Private Attributes

string m_directoryName
 The directory name where all the html pages are being written to.
MapWebPageMapStringLinks m_links
 Map of web pages to a map of strings to links.
string m_topCaption
 The top caption of the web page.


Detailed Description

Class responsbile for all operations that pertain to creating the web pages.

This class processes the head of the web page, the foot of the webpage, methods for creating the links on the webpage, writing out the style sheet, and for writing out the entire web page.


Constructor & Destructor Documentation

Html  ) 
 

Creates the html directory and writes out the default style sheet if they do not exist.


Member Function Documentation

void createLink string  urlToLinkTo,
string  urlDisplayName,
string  urlToLinkFrom
 

Creates the html web link on the web page.

Parameters:
urlToLinkTo The html link we want to add to the web page.
urlDisplayName The name of the link we want to give it to display on the web page
urlToLinkFrom The web page we are linking from.

void createTemplateLink string  urlToLinkTo,
string  templateString,
string  urlToLinkFrom
 

Adds a template string to the web page instead of a link.

Parameters:
urlToLinkTo The html link we want to add to the web page that leads to the template string.
templateString the string to display by its self on the web page.
urlToLinkFrom The web page we are linking from.

void writeDefaultStyleSheet const string &  fileName  ) 
 

Write out the hardcoded default style sheet.

Parameters:
fileName The file to write the style sheet to.

void writeHtmlFooter ofstream &  file  ) 
 

Writes the html footer.

Parameters:
file The file to write to

void writeHtmlHeader ofstream &  file  ) 
 

Writes out the html header given the file handle to write with.

Parameters:
file The file to write to
Uses m_topicCaption for the top caption of the web page.

void writeWebPages  ) 
 

Write out all the web pages stored from the links in m_links.


Member Data Documentation

string m_directoryName [private]
 

The directory name where all the html pages are being written to.

MapWebPageMapStringLinks m_links [private]
 

Map of web pages to a map of strings to links.

It's a map of web pages and their links. This is the main data structure of webpages and their links.

string m_topCaption [private]
 

The top caption of the web page.


The documentation for this class was generated from the following files:
Generated on Thu Sep 7 22:05:52 2006 for RebeccaAIML by  doxygen 1.4.5