PTLib  Version 2.10.10
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
PHTTPRadioField Class Reference

#include <httpform.h>

Inheritance diagram for PHTTPRadioField:
PHTTPField PObject

Public Member Functions

 PHTTPRadioField (const char *name, const PStringArray &valueArray, PINDEX initVal=0, const char *help=NULL)
 PHTTPRadioField (const char *name, const PStringArray &valueArray, const PStringArray &titleArray, PINDEX initVal=0, const char *help=NULL)
 PHTTPRadioField (const char *name, PINDEX count, const char *const *valueStrings, PINDEX initVal=0, const char *help=NULL)
 PHTTPRadioField (const char *name, PINDEX count, const char *const *valueStrings, const char *const *titleStrings, PINDEX initVal=0, const char *help=NULL)
 PHTTPRadioField (const char *name, const char *groupTitle, const PStringArray &valueArray, PINDEX initVal=0, const char *help=NULL)
 PHTTPRadioField (const char *name, const char *groupTitle, const PStringArray &valueArray, const PStringArray &titleArray, PINDEX initVal=0, const char *help=NULL)
 PHTTPRadioField (const char *name, const char *groupTitle, PINDEX count, const char *const *valueStrings, PINDEX initVal=0, const char *help=NULL)
 PHTTPRadioField (const char *name, const char *groupTitle, PINDEX count, const char *const *valueStrings, const char *const *titleStrings, PINDEX initVal=0, const char *help=NULL)
virtual PHTTPFieldNewField () const
 Create a new field of the same class as the current field.
virtual void GetHTMLTag (PHTML &html) const
 Convert the field to HTML form tag for inclusion into the HTTP page.
virtual PString GetHTMLInput (const PString &input) const
 Convert the field input to HTML for inclusion into the HTTP page.
virtual PString GetValue (PBoolean dflt=false) const
 Get the string value of the field.
virtual void SetValue (const PString &newVal)
 Set the value of the field.
- Public Member Functions inherited from PHTTPField
 PHTTPField (const char *bname, const char *title, const char *help)
virtual Comparison Compare (const PObject &obj) const
 Compare the fields using the field names.
const PCaselessStringGetName () const
 Get the identifier name of the field.
const PCaselessStringGetBaseName () const
 Get the identifier name of the field.
virtual void SetName (const PString &newName)
 Set the name for the field.
virtual const PHTTPFieldLocateName (const PString &name) const
 Locate the field naem, recusing down for composite fields.
const PStringGetTitle () const
 Get the title of the field.
const PStringGetHelp () const
 Get the title of the field.
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 void ExpandFieldNames (PString &text, PINDEX start, PINDEX &finish) const
virtual PString GetHTMLSelect (const PString &selection) const
 Convert the field input to HTML for inclusion into the HTTP page.
virtual void GetHTMLHeading (PHTML &html) const
 Convert the field to HTML for inclusion into the HTTP page.
virtual void LoadFromConfig (PConfig &cfg)
 Get the value of the PConfig to the sub-field.
virtual void SaveToConfig (PConfig &cfg) const
 Set the value of the sub-field into the PConfig.
virtual PBoolean Validated (const PString &newVal, PStringStream &msg) const
 Validate the new field value before SetValue() is called.
virtual void GetAllNames (PStringArray &names) const
 Retrieve all the names in the field and subfields.
virtual void SetAllValues (const PStringToString &data)
 Set the value of the field in a list of fields.
virtual PBoolean ValidateAll (const PStringToString &data, PStringStream &msg) const
 Validate the new field value in a list before SetValue() is called.
PBoolean NotYetInHTML () const
void SetInHTML ()
- Public Member Functions inherited from PObject
virtual ~PObject ()
virtual PObjectClone () const
 Create a copy of the class on the heap.
virtual PINDEX HashFunction () const
 This function yields a hash value required by the PDictionary class.
virtual Comparison CompareObjectMemoryDirect (const PObject &obj) const
 Determine the byte wise comparison of two objects.
bool operator== (const PObject &obj) const
 Compare the two objects.
bool operator!= (const PObject &obj) const
 Compare the two objects.
bool operator< (const PObject &obj) const
 Compare the two objects.
bool operator> (const PObject &obj) const
 Compare the two objects.
bool operator<= (const PObject &obj) const
 Compare the two objects.
bool operator>= (const PObject &obj) const
 Compare the two objects.
virtual const char * GetClass (unsigned ancestor=0) const
 Get the current dynamic type of the object instance.
PBoolean IsClass (const char *cls) const
virtual PBoolean InternalIsDescendant (const char *clsName) const
 Determine if the dynamic type of the current instance is a descendent of the specified class.
virtual void PrintOn (ostream &strm) const
 Output the contents of the object to the stream.
virtual void ReadFrom (istream &strm)
 Input the contents of the object from the stream.

Protected Attributes

PStringArray values
PStringArray titles
PString value
PString initialValue
- Protected Attributes inherited from PHTTPField
PCaselessString baseName
PCaselessString fullName
PString title
PString help
PBoolean notInHTML

Additional Inherited Members

- Public Types inherited from PObject
enum  Comparison { LessThan = -1, EqualTo = 0, GreaterThan = 1 }
 Result of the comparison operation performed by the Compare() function. More...
- Static Public Member Functions inherited from PObject
static Comparison InternalCompareObjectMemoryDirect (const PObject *obj1, const PObject *obj2, PINDEX size)
 Internal function caled from CompareObjectMemoryDirect()
static const char * Class ()
 Get the name of the class as a C string.
- Protected Member Functions inherited from PObject
 PObject ()
 Constructor for PObject, made protected so cannot ever create one on its own.
- Friends inherited from PObject

Constructor & Destructor Documentation

PHTTPRadioField::PHTTPRadioField ( const char *  name,
const PStringArray valueArray,
PINDEX  initVal = 0,
const char *  help = NULL 
)
PHTTPRadioField::PHTTPRadioField ( const char *  name,
const PStringArray valueArray,
const PStringArray titleArray,
PINDEX  initVal = 0,
const char *  help = NULL 
)
PHTTPRadioField::PHTTPRadioField ( const char *  name,
PINDEX  count,
const char *const *  valueStrings,
PINDEX  initVal = 0,
const char *  help = NULL 
)
PHTTPRadioField::PHTTPRadioField ( const char *  name,
PINDEX  count,
const char *const *  valueStrings,
const char *const *  titleStrings,
PINDEX  initVal = 0,
const char *  help = NULL 
)
PHTTPRadioField::PHTTPRadioField ( const char *  name,
const char *  groupTitle,
const PStringArray valueArray,
PINDEX  initVal = 0,
const char *  help = NULL 
)
PHTTPRadioField::PHTTPRadioField ( const char *  name,
const char *  groupTitle,
const PStringArray valueArray,
const PStringArray titleArray,
PINDEX  initVal = 0,
const char *  help = NULL 
)
PHTTPRadioField::PHTTPRadioField ( const char *  name,
const char *  groupTitle,
PINDEX  count,
const char *const *  valueStrings,
PINDEX  initVal = 0,
const char *  help = NULL 
)
PHTTPRadioField::PHTTPRadioField ( const char *  name,
const char *  groupTitle,
PINDEX  count,
const char *const *  valueStrings,
const char *const *  titleStrings,
PINDEX  initVal = 0,
const char *  help = NULL 
)

Member Function Documentation

virtual PString PHTTPRadioField::GetHTMLInput ( const PString input) const
virtual

Convert the field input to HTML for inclusion into the HTTP page.

Reimplemented from PHTTPField.

virtual void PHTTPRadioField::GetHTMLTag ( PHTML html) const
virtual

Convert the field to HTML form tag for inclusion into the HTTP page.

Parameters
htmlHTML to receive the field info.

Implements PHTTPField.

virtual PString PHTTPRadioField::GetValue ( PBoolean  dflt = false) const
virtual

Get the string value of the field.

Returns
String for field value.

Implements PHTTPField.

virtual PHTTPField* PHTTPRadioField::NewField ( ) const
virtual

Create a new field of the same class as the current field.

Returns
New field object instance.

Implements PHTTPField.

virtual void PHTTPRadioField::SetValue ( const PString newValue)
virtual

Set the value of the field.

Implements PHTTPField.

Member Data Documentation

PString PHTTPRadioField::initialValue
protected
PStringArray PHTTPRadioField::titles
protected
PString PHTTPRadioField::value
protected
PStringArray PHTTPRadioField::values
protected

The documentation for this class was generated from the following file: