#include <httpform.h>
Public Member Functions | |
PHTTPField (const char *bname, const char *title, const char *help) | |
virtual Comparison | Compare (const PObject &obj) const |
const PCaselessString & | GetName () const |
const PCaselessString & | GetBaseName () const |
virtual void | SetName (const PString &newName) |
virtual const PHTTPField * | LocateName (const PString &name) const |
const PString & | GetTitle () const |
const PString & | GetHelp () const |
void | SetHelp (const PString &text) |
void | SetHelp (const PString &hotLinkURL, const PString &linkText) |
void | SetHelp (const PString &hotLinkURL, const PString &imageURL, const PString &imageText) |
virtual PHTTPField * | NewField () const =0 |
virtual void | ExpandFieldNames (PString &text, PINDEX start, PINDEX &finish) const |
virtual void | GetHTMLTag (PHTML &html) const =0 |
virtual PString | GetHTMLInput (const PString &input) const |
virtual PString | GetHTMLSelect (const PString &selection) const |
virtual void | GetHTMLHeading (PHTML &html) const |
virtual PString | GetValue (BOOL dflt=FALSE) const =0 |
virtual void | SetValue (const PString &newValue)=0 |
virtual void | LoadFromConfig (PConfig &cfg) |
virtual void | SaveToConfig (PConfig &cfg) const |
virtual BOOL | Validated (const PString &newVal, PStringStream &msg) const |
virtual void | GetAllNames (PStringList &list) const |
virtual void | SetAllValues (const PStringToString &data) |
virtual BOOL | ValidateAll (const PStringToString &data, PStringStream &msg) const |
BOOL | NotYetInHTML () const |
void | SetInHTML () |
Protected Attributes | |
PCaselessString | baseName |
PCaselessString | fullName |
PString | title |
PString | help |
BOOL | notInHTML |
This class is the abstract base class for fields in a PHTTPForm# resource type.
PHTTPField::PHTTPField | ( | const char * | bname, | |
const char * | title, | |||
const char * | help | |||
) |
virtual Comparison PHTTPField::Compare | ( | const PObject & | obj | ) | const [virtual] |
Compare the fields using the field names.
virtual void PHTTPField::ExpandFieldNames | ( | PString & | text, | |
PINDEX | start, | |||
PINDEX & | finish | |||
) | const [virtual] |
Reimplemented in PHTTPCompositeField, and PHTTPFieldArray.
virtual void PHTTPField::GetAllNames | ( | PStringList & | list | ) | const [virtual] |
Retrieve all the names in the field and subfields.
Reimplemented in PHTTPCompositeField.
const PCaselessString& PHTTPField::GetBaseName | ( | ) | const [inline] |
const PString& PHTTPField::GetHelp | ( | ) | const [inline] |
Get the title of the field.
virtual void PHTTPField::GetHTMLHeading | ( | PHTML & | html | ) | const [virtual] |
Convert the field to HTML for inclusion into the HTTP page.
Reimplemented in PHTTPCompositeField, and PHTTPSubForm.
Convert the field input to HTML for inclusion into the HTTP page.
Reimplemented in PHTTPCompositeField, PHTTPBooleanField, and PHTTPRadioField.
Convert the field input to HTML for inclusion into the HTTP page.
virtual void PHTTPField::GetHTMLTag | ( | PHTML & | html | ) | const [pure virtual] |
Convert the field to HTML form tag for inclusion into the HTTP page.
Implemented in PHTTPCompositeField, PHTTPSubForm, PHTTPFieldArray, PHTTPStringField, PHTTPPasswordField, PHTTPIntegerField, PHTTPBooleanField, PHTTPRadioField, and PHTTPSelectField.
const PCaselessString& PHTTPField::GetName | ( | ) | const [inline] |
const PString& PHTTPField::GetTitle | ( | ) | const [inline] |
Get the title of the field.
virtual PString PHTTPField::GetValue | ( | BOOL | dflt = FALSE |
) | const [pure virtual] |
Get the string value of the field.
Implemented in PHTTPCompositeField, PHTTPStringField, PHTTPPasswordField, PHTTPIntegerField, PHTTPBooleanField, PHTTPRadioField, and PHTTPSelectField.
virtual void PHTTPField::LoadFromConfig | ( | PConfig & | cfg | ) | [virtual] |
Get the value of the PConfig to the sub-field. If the field is not composite then it always sets the value as for the non-indexed version.
Reimplemented in PHTTPCompositeField, PHTTPFieldArray, PHTTPIntegerField, and PHTTPBooleanField.
virtual const PHTTPField* PHTTPField::LocateName | ( | const PString & | name | ) | const [virtual] |
Locate the field naem, recusing down for composite fields.
Reimplemented in PHTTPCompositeField.
virtual PHTTPField* PHTTPField::NewField | ( | ) | const [pure virtual] |
Create a new field of the same class as the current field.
Implemented in PHTTPCompositeField, PHTTPSubForm, PHTTPFieldArray, PHTTPStringField, PHTTPPasswordField, PHTTPIntegerField, PHTTPBooleanField, PHTTPRadioField, and PHTTPSelectField.
BOOL PHTTPField::NotYetInHTML | ( | ) | const [inline] |
References notInHTML.
virtual void PHTTPField::SaveToConfig | ( | PConfig & | cfg | ) | const [virtual] |
Set the value of the sub-field into the PConfig. If the field is not composite then it always sets the value as for the non-indexed version.
Reimplemented in PHTTPCompositeField, PHTTPFieldArray, PHTTPIntegerField, and PHTTPBooleanField.
virtual void PHTTPField::SetAllValues | ( | const PStringToString & | data | ) | [virtual] |
Set the value of the field in a list of fields.
Reimplemented in PHTTPCompositeField, and PHTTPFieldArray.
void PHTTPField::SetHelp | ( | const PString & | hotLinkURL, | |
const PString & | imageURL, | |||
const PString & | imageText | |||
) |
void PHTTPField::SetHelp | ( | const PString & | text | ) | [inline] |
void PHTTPField::SetInHTML | ( | ) | [inline] |
References notInHTML.
virtual void PHTTPField::SetName | ( | const PString & | newName | ) | [virtual] |
Set the name for the field.
Reimplemented in PHTTPCompositeField.
virtual void PHTTPField::SetValue | ( | const PString & | newValue | ) | [pure virtual] |
Set the value of the field.
Implemented in PHTTPCompositeField, PHTTPStringField, PHTTPPasswordField, PHTTPIntegerField, PHTTPBooleanField, PHTTPRadioField, and PHTTPSelectField.
virtual BOOL PHTTPField::ValidateAll | ( | const PStringToString & | data, | |
PStringStream & | msg | |||
) | const [virtual] |
Validate the new field value in a list before SetValue()# is called.
Reimplemented in PHTTPCompositeField.
virtual BOOL PHTTPField::Validated | ( | const PString & | newVal, | |
PStringStream & | msg | |||
) | const [virtual] |
Validate the new field value before SetValue()# is called.
Reimplemented in PHTTPIntegerField.
PCaselessString PHTTPField::baseName [protected] |
Referenced by GetBaseName().
PCaselessString PHTTPField::fullName [protected] |
Referenced by GetName().
PString PHTTPField::help [protected] |
BOOL PHTTPField::notInHTML [protected] |
Referenced by NotYetInHTML(), and SetInHTML().
PString PHTTPField::title [protected] |