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

#include <httpform.h>

Inheritance diagram for PHTTPSubForm:
PHTTPCompositeField PHTTPField PObject

Public Member Functions

 PHTTPSubForm (const PString &subFormName, const char *name, const char *title=NULL, PINDEX primaryField=0, PINDEX secondaryField=P_MAX_INDEX)
PHTTPFieldNewField () const
 Create a new field of the same class as the current field.
void GetHTMLTag (PHTML &html) const
 Convert the field to HTML form tag for inclusion into the HTTP page.
void GetHTMLHeading (PHTML &html) const
 Convert the field to HTML for inclusion into the HTTP page.
- Public Member Functions inherited from PHTTPCompositeField
 PHTTPCompositeField (const char *name, const char *title=NULL, const char *help=NULL, bool includeHeaders=false)
virtual void SetName (const PString &name)
 Set the name for the field.
virtual const PHTTPFieldLocateName (const PString &name) const
 Locate the field naem, recusing down for composite fields.
virtual void ExpandFieldNames (PString &text, PINDEX start, PINDEX &finish) const
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 &newValue)
 Set the value of the field.
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 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.
virtual PINDEX GetSize () const
 Get the number of sub-fields in the composite field.
void Append (PHTTPField *fld)
PHTTPFieldoperator[] (PINDEX idx) const
void RemoveAt (PINDEX idx)
void RemoveAll ()
- 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.
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 PString GetHTMLSelect (const PString &selection) const
 Convert the field input to HTML for inclusion into the HTTP page.
virtual PBoolean Validated (const PString &newVal, PStringStream &msg) const
 Validate the new field value 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

PString subFormName
PINDEX primary
PINDEX secondary
- Protected Attributes inherited from PHTTPCompositeField
PHTTPFields fields
bool m_includeHeaders
- 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

PHTTPSubForm::PHTTPSubForm ( const PString subFormName,
const char *  name,
const char *  title = NULL,
PINDEX  primaryField = 0,
PINDEX  secondaryField = P_MAX_INDEX 
)

Member Function Documentation

void PHTTPSubForm::GetHTMLHeading ( PHTML html) const
virtual

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

Reimplemented from PHTTPCompositeField.

void PHTTPSubForm::GetHTMLTag ( PHTML html) const
virtual

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

Reimplemented from PHTTPCompositeField.

PHTTPField* PHTTPSubForm::NewField ( ) const
virtual

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

Returns
New field object instance.

Reimplemented from PHTTPCompositeField.

Member Data Documentation

PINDEX PHTTPSubForm::primary
protected
PINDEX PHTTPSubForm::secondary
protected
PString PHTTPSubForm::subFormName
protected

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