class QucHTMLFormAnalyser

class QucHTMLFormAnalyser : public QucHTMLSupport

a class that can generate and analyse HTML forms

Inheritance:

public members:

QucHTMLFormAnalyser ()

QucHTMLFormAnalyser ( const QucHTMLFormAnalyser & aRef )

const QucHTMLFormAnalyser &

aRef

QucHTMLFormAnalyser &

operator= ( const QucHTMLFormAnalyser & aRef )

const QucHTMLFormAnalyser &

aRef

virtual

~QucHTMLFormAnalyser ()

virtual void

generateForm () const

virtual void

generatePrimeForm () const

virtual void

generateResult () const

QucHTMLEvaluation

retrieveValues ()

void

analyse ( const CorString& aString )

const CorString&

aString

void

become ( const QucHTMLFormAnalyser & aRef )

const QucHTMLFormAnalyser &

aRef

void

setKeyAndValue ( CorString aString )

CorString

aString

void

setParseResult ( QucHTMLEvaluation anEvaluation )

QucHTMLEvaluation

anEvaluation

QucHTMLEvaluation

getParseResult () const

CorString

getFormData () const

virtual QucHTMLEvaluation

evaluateCheckBoxes ()

virtual QucHTMLEvaluation

evaluateRadioButtons ()

virtual QucHTMLEvaluation

evaluateChars ()

virtual QucHTMLEvaluation

evaluateDoubles ()

virtual QucHTMLEvaluation

evaluateInts ()

virtual QucHTMLEvaluation

evaluateTextArea ()

virtual QucHTMLEvaluation

parseCheckBox ( const CorString& aName, CorBool& aFlag )

const CorString&	aName
CorBool&	aFlag

virtual QucHTMLEvaluation

parseRadioB ( const CorString& aName, CorString& aValue )

const CorString&	aName
CorString&	aValue

virtual QucHTMLEvaluation

parseChar ( const CorString& aName, CorString& aValue )

const CorString&	aName
CorString&	aValue

virtual QucHTMLEvaluation

parseDouble ( const CorString& aName, double& aValue )

const CorString&	aName
double&	aValue

virtual QucHTMLEvaluation

parseInt ( const CorString& aName, int& aValue )

const CorString&	aName
int&	aValue

Inherited from QucHTMLSupport:

public members:

QucHTMLSupport & operator=( const QucHTMLSupport & aRef )

const QucHTMLSupport & aRef
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 <QucHTMLFormAnalyser.h>
  
    QucHTMLFormAnalyser myObject;
  
DESCRIPTION
This class provides the functionality to generate and analyse an HTML form.
CAUTIONS
<optional>
EXAMPLES
<optional>
SEE ALSO
<optional>
CorBase

QucHTMLFormAnalyser ()

Purpose
The default c'tor.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

QucHTMLFormAnalyser ( const QucHTMLFormAnalyser & aRef )

Purpose
The copy c'tor creates a new instance from a reference.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

Arguments

const QucHTMLFormAnalyser & aRef: the reference instance

QucHTMLFormAnalyser & operator= ( const QucHTMLFormAnalyser & aRef )

Purpose
The assignment operator makes this instance look like another one.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Returns
A reference to this instance.

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

Arguments

const QucHTMLFormAnalyser & aRef: the reference instance

virtual ~QucHTMLFormAnalyser ()

Purpose
The d'tor.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

virtual void generateForm () const

Purpose
Output the HTML form page.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

virtual void generatePrimeForm () const

Purpose
Output the HTML form page (without HTML header and footer).

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

virtual void generateResult () const

Purpose
Output the result of the HTML form page.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

QucHTMLEvaluation retrieveValues ()

Purpose
Get the form data into this instance.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns whether all the data could be parsed (QucTAG_EVALUATED) or whether there was an error (QucTAG_NOT_EVALUATED).

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

void analyse ( const CorString& aString )

Purpose
Analyse a string and store its values.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

Arguments

const CorString& aString: string to analyse

void become ( const QucHTMLFormAnalyser & aRef )

Purpose
This instance will look like a reference instance.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

Arguments

const QucHTMLFormAnalyser & aRef: reference instance

void setKeyAndValue ( CorString aString )

Purpose
Take a 'LHS = RHS' string and store <LHS> and <RHS> in key and value.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

Arguments

CorString aString: value pair

void setParseResult ( QucHTMLEvaluation anEvaluation )

Purpose
Set the parse result attribute.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

Arguments

QucHTMLEvaluation anEvaluation: new value

QucHTMLEvaluation getParseResult () const

Purpose
Query the parse result.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns the parse result attribute.

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

CorString getFormData () const

Purpose
Query all the data entered into the form.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns a string that holds all the data of the form.

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

virtual QucHTMLEvaluation evaluateCheckBoxes ()

Purpose
Evaluate a set of checkboxes in this form.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns whether all the data could be parsed (QucTAG_EVALUATED) or whether there was an error (QucTAG_NOT_EVALUATED).

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

virtual QucHTMLEvaluation evaluateRadioButtons ()

Purpose
Evaluate a set of radio buttons in this form.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns whether all the data could be parsed (QucTAG_EVALUATED) or whether there was an error (QucTAG_NOT_EVALUATED).

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

virtual QucHTMLEvaluation evaluateChars ()

Purpose
Evaluate a set of string fields in this form.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns whether all the data could be parsed (QucTAG_EVALUATED) or whether there was an error (QucTAG_NOT_EVALUATED).

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

virtual QucHTMLEvaluation evaluateDoubles ()

Purpose
Evaluate a set of double input fields in this form.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns whether all the data could be parsed (QucTAG_EVALUATED) or whether there was an error (QucTAG_NOT_EVALUATED).

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

virtual QucHTMLEvaluation evaluateInts ()

Purpose
Evaluate a set of integer input fields in this form.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns whether all the data could be parsed (QucTAG_EVALUATED) or whether there was an error (QucTAG_NOT_EVALUATED).

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

virtual QucHTMLEvaluation evaluateTextArea ()

Purpose
Evaluate a set of text area fields in this form.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns whether all the data could be parsed (QucTAG_EVALUATED) or whether there was an error (QucTAG_NOT_EVALUATED).

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

virtual QucHTMLEvaluation parseCheckBox ( const CorString& aName, CorBool& aFlag )

Purpose
Store the value of a keyword.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns whether all the data could be parsed (QucTAG_EVALUATED) or whether there was an error (QucTAG_NOT_EVALUATED).

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

Arguments

const CorString& aName: keyword
CorBool& aFlag: value

virtual QucHTMLEvaluation parseRadioB ( const CorString& aName, CorString& aValue )

Purpose
Store the value of a keyword.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns whether all the data could be parsed (QucTAG_EVALUATED) or whether there was an error (QucTAG_NOT_EVALUATED).

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

Arguments

const CorString& aName: keyword
CorString& aValue: Another value

virtual QucHTMLEvaluation parseChar ( const CorString& aName, CorString& aValue )

Purpose
Store the value of a keyword.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns whether all the data could be parsed (QucTAG_EVALUATED) or whether there was an error (QucTAG_NOT_EVALUATED).

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

Arguments

const CorString& aName: keyword
CorString& aValue: value

virtual QucHTMLEvaluation parseDouble ( const CorString& aName, double& aValue )

Purpose
Store the value of a keyword.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns whether all the data could be parsed (QucTAG_EVALUATED) or whether there was an error (QucTAG_NOT_EVALUATED).

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

Arguments

const CorString& aName: keyword
double& aValue: value

virtual QucHTMLEvaluation parseInt ( const CorString& aName, int& aValue )

Purpose
Store the value of a keyword.

Preconditions

Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns whether all the data could be parsed (QucTAG_EVALUATED) or whether there was an error (QucTAG_NOT_EVALUATED).

Exceptions

Itemize this section if necessary. Remove itemization otherwise.

Arguments

const CorString& aName: keyword
int& aValue: value

direct child classes: QucView

alphabetic index hierarchy of classes

VLT-DFS Subsystem Core - User Manual 1.1

VLT-MAN-ESO-19000-0001

generated by doc++