class QucHTMLSupport : public CorBase

low level HTML functions

Inheritance:


public members:

QucHTMLSupport ()
QucHTMLSupport ( const QucHTMLSupport & aRef )
const QucHTMLSupport & aRef
QucHTMLSupport & operator= ( const QucHTMLSupport & aRef )
const QucHTMLSupport & aRef
virtual ~QucHTMLSupport ()
CorString getLine (istream* aStream) const
void generateHeader ( CorString aTitle ) const
CorString aTitle
void generateFooter () const
char x2c ( const char* aToken )
const char* aToken
CorString decypher ( const CorString& aString )
const CorString& aString
void become ( const QucHTMLSupport & aRef )
const QucHTMLSupport & aRef

Documentation


SYNOPSIS

    #include <QucHTMLSupport.h>
  
    QucHTMLSupport myObject;
  

DESCRIPTION
This class provides very low level HTML support functions, like the decyphering and decoding of HTML strings.

CAUTIONS
<optional>

EXAMPLES
<optional>

SEE ALSO
CorBase
QucHTMLFormAnalyzer

QucHTMLSupport ()
Purpose
The default c'tor.

Preconditions

  • Itemize this section if necessary. Remove itemization otherwise.

Exceptions

  • Itemize this section if necessary. Remove itemization otherwise.

QucHTMLSupport ( const QucHTMLSupport & aRef )
Purpose
The copy c'tor creates a new instance from a reference.

Preconditions

Exceptions

Arguments

const QucHTMLSupport & aRef
the reference instance

QucHTMLSupport & operator= ( const QucHTMLSupport & aRef )
Purpose
The assignment operator makes this instance look like another one.

Preconditions

Returns
A reference to this instance.

Exceptions

Arguments

const QucHTMLSupport & aRef
the reference instance

virtual ~QucHTMLSupport ()
Purpose
The d'tor.

Preconditions

  • Itemize this section if necessary. Remove itemization otherwise.

Exceptions

  • Itemize this section if necessary. Remove itemization otherwise.

CorString getLine (istream* aStream) const
Purpose
Get a line from the input stream safely.

Preconditions

  • Itemize this section if necessary. Remove itemization otherwise.

Exceptions

  • Itemize this section if necessary. Remove itemization otherwise.

void generateHeader ( CorString aTitle ) const
Purpose
Generate an HTML header, with title.
See generateFooter().

Preconditions

  • Itemize this section if necessary. Remove itemization otherwise.

Exceptions

  • Itemize this section if necessary. Remove itemization otherwise.

Arguments

CorString aTitle
title of the page

void generateFooter () const
Purpose
This function provides the footer of an HTML page.
Together with the generateHeader() function, this one can be used to produce an empty HTML page.

Preconditions

  • Itemize this section if necessary. Remove itemization otherwise.

Exceptions

  • Itemize this section if necessary. Remove itemization otherwise.

char x2c ( const char* aToken )
Purpose
Demangle a special HTML token.

Preconditions

  • Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns a character representing the mangled ones.

Exceptions

  • Itemize this section if necessary. Remove itemization otherwise.

Arguments

const char* aToken
two byte HTML token sequence

CorString decypher ( const CorString& aString )
Purpose
Returns a decyphered version of an HTML string.

Preconditions

  • Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns a string.

Exceptions

  • Itemize this section if necessary. Remove itemization otherwise.

Arguments

const CorString& aString
string to decypher

void become ( const QucHTMLSupport & aRef )
Purpose
Make this instance look like a reference instance.

Preconditions

Exceptions

Arguments

const QucHTMLSupport & aRef
reference instance


direct child classes: QucHTMLFormAnalyser

alphabetic index hierarchy of classes


VLT-DFS Subsystem Core - User Manual 1.1 VLT-MAN-ESO-19000-0001

generated by doc++