Main Page | Class Hierarchy | Class List | File List | Class Members | File Members

PHTTPCompositeField Class Reference

#include <httpform.h>

Inheritance diagram for PHTTPCompositeField:

PHTTPField PObject PHTTPFieldArray PHTTPSubForm List of all members.

Public Member Functions

 PHTTPCompositeField (const char *name, const char *title=NULL, const char *help=NULL)
virtual void SetName (const PString &name)
virtual const PHTTPFieldLocateName (const PString &name) const
virtual PHTTPFieldNewField () const
virtual void ExpandFieldNames (PString &text, PINDEX start, PINDEX &finish) const
virtual void GetHTMLTag (PHTML &html) const
virtual PString GetHTMLInput (const PString &input) const
virtual void GetHTMLHeading (PHTML &html) const
virtual PString GetValue (BOOL dflt=FALSE) const
virtual void SetValue (const PString &newValue)
virtual void LoadFromConfig (PConfig &cfg)
virtual void SaveToConfig (PConfig &cfg) const
virtual void GetAllNames (PStringList &list) const
virtual void SetAllValues (const PStringToString &data)
virtual BOOL ValidateAll (const PStringToString &data, PStringStream &msg) const
virtual PINDEX GetSize () const
void Append (PHTTPField *fld)
PHTTPFieldoperator[] (PINDEX idx) const
void RemoveAt (PINDEX idx)
void RemoveAll ()

Protected Attributes

PHTTPFieldList fields

Constructor & Destructor Documentation

PHTTPCompositeField::PHTTPCompositeField const char *  name,
const char *  title = NULL,
const char *  help = NULL
 


Member Function Documentation

void PHTTPCompositeField::Append PHTTPField fld  ) 
 

virtual void PHTTPCompositeField::ExpandFieldNames PString text,
PINDEX  start,
PINDEX &  finish
const [virtual]
 

Reimplemented from PHTTPField.

Reimplemented in PHTTPFieldArray.

virtual void PHTTPCompositeField::GetAllNames PStringList list  )  const [virtual]
 

Retrieve all the names in the field and subfields.

Returns:
List of strings for each subfield.

Reimplemented from PHTTPField.

virtual void PHTTPCompositeField::GetHTMLHeading PHTML html  )  const [virtual]
 

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

Reimplemented from PHTTPField.

Reimplemented in PHTTPSubForm.

virtual PString PHTTPCompositeField::GetHTMLInput const PString input  )  const [virtual]
 

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

Reimplemented from PHTTPField.

virtual void PHTTPCompositeField::GetHTMLTag PHTML html  )  const [virtual]
 

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

Implements PHTTPField.

Reimplemented in PHTTPSubForm, and PHTTPFieldArray.

virtual PINDEX PHTTPCompositeField::GetSize  )  const [virtual]
 

Get the number of sub-fields in the composite field. Note that this is the total including any composite sub-fields, ie, it is the size of the whole tree of primitive fields.

Returns:
Returns field count.

Reimplemented in PHTTPFieldArray.

virtual PString PHTTPCompositeField::GetValue BOOL  dflt = FALSE  )  const [virtual]
 

Get the string value of the field.

Returns:
String for field value.

Implements PHTTPField.

virtual void PHTTPCompositeField::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 from PHTTPField.

Reimplemented in PHTTPFieldArray.

virtual const PHTTPField* PHTTPCompositeField::LocateName const PString name  )  const [virtual]
 

Locate the field naem, recusing down for composite fields.

Returns:
Pointer to located field, or NULL if not found.

Reimplemented from PHTTPField.

virtual PHTTPField* PHTTPCompositeField::NewField  )  const [virtual]
 

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

Returns:
New field object instance.

Implements PHTTPField.

Reimplemented in PHTTPSubForm, and PHTTPFieldArray.

PHTTPField& PHTTPCompositeField::operator[] PINDEX  idx  )  const [inline]
 

void PHTTPCompositeField::RemoveAll  )  [inline]
 

void PHTTPCompositeField::RemoveAt PINDEX  idx  )  [inline]
 

virtual void PHTTPCompositeField::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 from PHTTPField.

Reimplemented in PHTTPFieldArray.

virtual void PHTTPCompositeField::SetAllValues const PStringToString data  )  [virtual]
 

Set the value of the field in a list of fields.

Reimplemented from PHTTPField.

Reimplemented in PHTTPFieldArray.

virtual void PHTTPCompositeField::SetName const PString name  )  [virtual]
 

Set the name for the field.

Reimplemented from PHTTPField.

virtual void PHTTPCompositeField::SetValue const PString newValue  )  [virtual]
 

Set the value of the field.

Implements PHTTPField.

virtual BOOL PHTTPCompositeField::ValidateAll const PStringToString data,
PStringStream msg
const [virtual]
 

Validate the new field value in a list before #SetValue()# is called.

Returns:
BOOL if the all the new field values are OK.

Reimplemented from PHTTPField.


Member Data Documentation

PHTTPFieldList PHTTPCompositeField::fields [protected]
 


The documentation for this class was generated from the following file:
Generated on Sat Jul 24 15:35:58 2004 for PWLib by doxygen 1.3.7