Design of htmlTool
1 Name
Classname: htmlTool
Inherits: ostream(publ)
Declaration:
class htmlTool
htmlTool();
~htmlTool();
..
};
Based On:
iostream.h and cgi/Defs.H
Properties:
htmlTool is a class designed for creating html-document easily. It can be used as any ostream.
2 Purpose
The htmlTool class purpose is to make it easier to create HTML-documents, which very often are necessary when you create CGI-programs. The class also contains some extensions for any ostream when you use the cgi-library, which are incredibly useful. (Take my word).
3 Description
3.1 Methods
3.1.1 Basic Methods
void constructor htmlTool()
Description:
Initializes the class to use stdout for output.
void constructor htmlTool(ostream &dest)
Description:
Initializes the class to use dest for output.
void destructor ~htmlTool(void )
Description:
Closes the outputstream used
3.1.2 Methods which prints to the htmlTool
void method gotoURL(const char *redirectUrl)
void method headerStatus(int status, const char *statusMessage)
void method printHeader(void )
Description:
Should be used initially if you plan to write an HTML-document
void method printPlainHeader(void )
void method headerContentType(const char *mimeType)
void method html(void )
Description:
First time called, it prints an opening-tag, and second time called gives you a closing-tag. Most (if not all) methods which correspond to an HTML-element and takes no argument works this way. (e.g title just below)
void method title(void )
void method title(const char *content)
Description:
As with most other methods, this method prints the content surrounded by it's HTML-element. Here it is TITLE.
void method head(void )
void method body(const char *bodyInfo=NULL)
void method foot(void )
void method address(void )
void method address(const char *content)
void method comment(void )
void method comment(const char *content)
void method put(char *text)
void method put(const char *text)
void method put(int i)
void method put(long l)
void method put(float f)
void method put(double d)
void method ul(void )
void method ol(void )
void method li(void )
void method dl(void )
void method dd(void )
void method dt(void )
void method link(const char *location, const char *description)
void method image(const char *imageFile, const char *altText=NULL)
void method br(void )
void method hr(void )
void method hr(int percent)
void method hr(int percent, int size)
void method lf(void )
void method p(void )
void method p1(void )
void method h1(void )
void method h1(const char *content)
void method h2(void )
void method h2(const char *content)
void method h3(void )
void method h3(const char *content)
void method h4(void )
void method h4(const char *content)
void method h5(void )
void method h5(const char *content)
void method h6(void )
void method h6(const char *content)
void method b(void )
void method b(const char *content)
void method i(void )
void method i(const char *content)
void method fixed(void )
void method fixed(const char *content)
void method underline(void )
void method underline(const char *content)
void method define(void )
void method define(const char *content)
void method em(void )
void method em(const char *content)
void method cite(void )
void method cite(const char *content)
void method code(void )
void method code(const char *content)
void method kbd(void )
void method kbd(const char *content)
void method samp(void )
void method samp(const char *content)
void method var(void )
void method var(const char *content)
void method strong(void )
void method strong(const char *content)
void method strike(void )
void method strike(const char *content)
void method block(void )
void method block(const char *content)
void method pre(void )
void method pre(const char *content)
void method center(void )
void method center(const char *content)
void method big(void )
void method big(const char *content)
void method small(void )
void method small(const char *content)
void method sub(void )
void method sub(const char *content)
void method sup(void )
void method sup(const char *content)
void method subscript(void )
void method subscript(const char *content)
void method superscript(void )
void method superscript(const char *content)
void method font(char action, int =1)
ostream &method br(ostream &outs)
Description:
A genial construction. Lets you use br where you would use endl in an ostream. Producing a lineshift-HTML-tag and flushing it. The same goes for those below. Check also test.cpp for several examples.
ostream &method hr(ostream &outs)
ostream &method p(ostream &outs)
ostream &method li(ostream &outs)
ostream &method dd(ostream &outs)
3.1.3 Protected Methods
ostream &method outputtag(int &type, const char *value)
Description:
For internal use
void method outputtag(const char *value, const char *type)
Description:
For internal use
void method initvars(void )
Description:
For internal use
4 Maintenance
Information about bugs, errors, problems, etc. should be sent to stig@ii.uib.no
Written by: Stig Erik Sandø
Version: Document created with SDS v0.20