#include <httpform.h>

Inheritance diagram for PHTTPCompositeField:

Public Member Functions
	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. More...

virtual const PHTTPField *	LocateName (const PString &name) const
	Locate the field naem, recusing down for composite fields. More...

virtual PHTTPField *	NewField () const
	Create a new field of the same class as the current field. More...

virtual void	ExpandFieldNames (PString &text, PINDEX start, PINDEX &finish) const

virtual void	GetHTMLTag (PHTML &html) const
	Convert the field to HTML form tag for inclusion into the HTTP page. More...

virtual PString	GetHTMLInput (const PString &input) const
	Convert the field input to HTML for inclusion into the HTTP page. More...

virtual void	GetHTMLHeading (PHTML &html) const
	Convert the field to HTML for inclusion into the HTTP page. More...

virtual PString	GetValue (PBoolean dflt=false) const
	Get the string value of the field. More...

virtual void	SetValue (const PString &newValue)
	Set the value of the field. More...

virtual void	LoadFromConfig (PConfig &cfg)
	Get the value of the PConfig to the sub-field. More...

virtual void	SaveToConfig (PConfig &cfg) const
	Set the value of the sub-field into the PConfig. More...

virtual void	GetAllNames (PStringArray &names) const
	Retrieve all the names in the field and subfields. More...

virtual void	SetAllValues (const PStringToString &data)
	Set the value of the field in a list of fields. More...

virtual PBoolean	ValidateAll (const PStringToString &data, PStringStream &msg) const
	Validate the new field value in a list before `SetValue()` is called. More...

virtual PINDEX	GetSize () const
	Get the number of sub-fields in the composite field. More...

void	Append (PHTTPField *fld)

PHTTPField &	operator[] (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. More...

const PCaselessString &	GetName () const
	Get the identifier name of the field. More...

const PCaselessString &	GetBaseName () const
	Get the identifier name of the field. More...

const PString &	GetTitle () const
	Get the title of the field. More...

const PString &	GetHelp () const
	Get the title of the field. More...

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. More...

virtual PBoolean	Validated (const PString &newVal, PStringStream &msg) const
	Validate the new field value before `SetValue()` is called. More...

PBoolean	NotYetInHTML () const

void	SetInHTML ()

Public Member Functions inherited from PObject
virtual	~PObject ()

virtual PObject *	Clone () const
	Create a copy of the class on the heap. More...

virtual PINDEX	HashFunction () const
	This function yields a hash value required by the `PDictionary` class. More...

virtual Comparison	CompareObjectMemoryDirect (const PObject &obj) const
	Determine the byte wise comparison of two objects. More...

bool	operator== (const PObject &obj) const
	Compare the two objects. More...

bool	operator!= (const PObject &obj) const
	Compare the two objects. More...

bool	operator< (const PObject &obj) const
	Compare the two objects. More...

bool	operator> (const PObject &obj) const
	Compare the two objects. More...

bool	operator<= (const PObject &obj) const
	Compare the two objects. More...

bool	operator>= (const PObject &obj) const
	Compare the two objects. More...

virtual const char *	GetClass (unsigned ancestor=0) const
	Get the current dynamic type of the object instance. More...

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. More...

virtual void	PrintOn (ostream &strm) const
	Output the contents of the object to the stream. More...

virtual void	ReadFrom (istream &strm)
	Input the contents of the object from the stream. More...

Protected Attributes
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() More...

static const char *	Class ()
	Get the name of the class as a C string. More...

Protected Member Functions inherited from PObject
	PObject ()
	Constructor for PObject, made protected so cannot ever create one on its own. More...

Constructor & Destructor Documentation

§ PHTTPCompositeField()

PHTTPCompositeField::PHTTPCompositeField	(	const char *	name,
		const char *	title = `NULL`,
		const char *	help = `NULL`,
		bool	includeHeaders = `false`
	)

Member Function Documentation

§ Append()

void PHTTPCompositeField::Append ( PHTTPField * fld )

§ ExpandFieldNames()

virtual void PHTTPCompositeField::ExpandFieldNames	(	PString &	text,
		PINDEX	start,
		PINDEX &	finish
	)		const

virtual

Reimplemented from PHTTPField.

Reimplemented in PHTTPFieldArray.

§ GetAllNames()

virtual void PHTTPCompositeField::GetAllNames ( PStringArray & names ) const

virtual

Retrieve all the names in the field and subfields.

Returns: Array of strings for each subfield.

Reimplemented from PHTTPField.

§ GetHTMLHeading()

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.

§ GetHTMLInput()

virtual PString PHTTPCompositeField::GetHTMLInput ( const PString & input ) const

virtual

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

Reimplemented from PHTTPField.

§ GetHTMLTag()

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 PHTTPFieldArray, and PHTTPSubForm.

§ GetSize()

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.

§ GetValue()

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

virtual

Get the string value of the field.

Returns: String for field value.

Implements PHTTPField.

§ LoadFromConfig()

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.

§ LocateName()

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.

§ NewField()

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 PHTTPFieldArray, and PHTTPSubForm.

§ operator[]()

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

inline

§ RemoveAll()

void PHTTPCompositeField::RemoveAll ( )

inline

§ RemoveAt()

void PHTTPCompositeField::RemoveAt ( PINDEX idx )

inline

§ SaveToConfig()

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.

§ SetAllValues()

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.

§ SetName()

virtual void PHTTPCompositeField::SetName ( const PString & newName )

virtual

Set the name for the field.

Reimplemented from PHTTPField.

§ SetValue()

virtual void PHTTPCompositeField::SetValue ( const PString & newValue )

virtual

Set the value of the field.

Implements PHTTPField.

§ ValidateAll()

virtual PBoolean PHTTPCompositeField::ValidateAll	(	const PStringToString &	data,
		PStringStream &	msg
	)		const

virtual

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

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

Reimplemented from PHTTPField.

Member Data Documentation

§ fields

PHTTPFields PHTTPCompositeField::fields

protected

§ m_includeHeaders

bool PHTTPCompositeField::m_includeHeaders

protected

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

httpform.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

§ PHTTPCompositeField()

Member Function Documentation

§ Append()

§ ExpandFieldNames()

§ GetAllNames()

§ GetHTMLHeading()

§ GetHTMLInput()

§ GetHTMLTag()

§ GetSize()

§ GetValue()

§ LoadFromConfig()

§ LocateName()

§ NewField()

§ operator[]()

§ RemoveAll()

§ RemoveAt()

§ SaveToConfig()

§ SetAllValues()

§ SetName()

§ SetValue()

§ ValidateAll()

Member Data Documentation

§ fields

§ m_includeHeaders