PHTTPFieldArray Class Reference

#include <httpform.h>

Inheritance diagram for PHTTPFieldArray:

Collaboration diagram for PHTTPFieldArray:

Public Member Functions
	PHTTPFieldArray (PHTTPField *baseField, PBoolean ordered, PINDEX fixedSize=0)
	~PHTTPFieldArray ()
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 bool	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	LoadFromJSON (const PJSON::Base &json)
	Get the value of the JSON to the sub-field. More...
virtual void	SaveToJSON (PJSON::Base &json) const
	Set the value of the sub-field into the JSON. More...
virtual void	SetAllValues (const PStringToString &data)
	Set the value of the field in a list of fields. More...
virtual PINDEX	GetSize () const
	Get the number of sub-fields in the composite field. More...
void	SetSize (PINDEX newSize)
PStringArray	GetStrings (PConfig &cfg, const PStringArray &defaultValues)
void	SetStrings (PConfig &cfg, const PStringArray &values)
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. More...
virtual const PHTTPField *	LocateName (const PString &name) const
	Locate the field naem, recusing down for composite fields. 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	GetAllNames (PStringArray &names) const
	Retrieve all the names in the field and subfields. More...
virtual PBoolean	ValidateAll (const PStringToString &data, PStringStream &msg) const
	Validate the new field value in a list before SetValue() is called. 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
__inline unsigned	GetTraceContextIdentifier () const
	Get PTRACE context identifier. More...
__inline void	SetTraceContextIdentifier (unsigned id)
__inline void	SetTraceContextIdentifier (const PObject &obj)
__inline void	SetTraceContextIdentifier (const PObject *obj)
__inline void	CopyTraceContextIdentifier (PObject &obj) const
__inline void	CopyTraceContextIdentifier (PObject *obj) const
virtual	~PObject ()
__inline const char *	GetClass () const
__inline bool	IsClass (const char *name) const
__inline const PObject *	PTraceObjectInstance () const
virtual PObject *	Clone () const
	Create a copy of the class on the heap. More...
template<class CLS >
CLS *	CloneAs () const
	As for Clone() but converts to specified type. 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 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 Member Functions
void	AddBlankField ()
void	AddArrayControlBox (PHTML &html, PINDEX fld) const
void	SetArrayFieldName (PINDEX idx) const
PString	GetFieldNameForJSON () const
Protected Member Functions inherited from PObject
	PObject ()
	Constructor for PObject, made protected so cannot ever create one on its own. More...

Protected Attributes
PHTTPField *	m_baseField
bool	m_orderedArray
bool	m_canAddElements
Protected Attributes inherited from PHTTPCompositeField
PHTTPFields	m_fields
bool	m_includeHeaders
Protected Attributes inherited from PHTTPField
PCaselessString	m_baseName
PCaselessString	m_fullName
PString	m_title
PString	m_help
bool	m_notInHTML
Protected Attributes inherited from PObject
unsigned	m_traceContextIdentifier

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 __inline void	CopyTraceContextIdentifier (PObject &to, const PObject &from)
static __inline void	CopyTraceContextIdentifier (PObject &to, const PObject *from)
static __inline void	CopyTraceContextIdentifier (PObject *to, const PObject &from)
static __inline void	CopyTraceContextIdentifier (PObject *to, const PObject *from)
static __inline const char *	Class ()
static __inline const PObject *	PTraceObjectInstance (const char *)
static __inline const PObject *	PTraceObjectInstance (const PObject *obj)
template<typename T >
static Comparison	Compare2 (T v1, T v2)
	Compare two types, returning Comparison type. More...
static Comparison	InternalCompareObjectMemoryDirect (const PObject *obj1, const PObject *obj2, PINDEX size)
	Internal function caled from CompareObjectMemoryDirect() More...

Constructor & Destructor Documentation

PHTTPFieldArray::PHTTPFieldArray	(	PHTTPField *	baseField,
		PBoolean	ordered,
		PINDEX	fixedSize = 0
	)

PHTTPFieldArray::~PHTTPFieldArray

(

)

Member Function Documentation

void PHTTPFieldArray::AddArrayControlBox ( PHTML &  html, PINDEX  fld  ) const

protected

void PHTTPFieldArray::AddBlankField ( )

protected

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

virtual

Reimplemented from PHTTPCompositeField.

PString PHTTPFieldArray::GetFieldNameForJSON ( ) const

protected

virtual void PHTTPFieldArray::GetHTMLTag ( PHTML &  html ) const

virtual

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

Reimplemented from PHTTPCompositeField.

virtual PINDEX PHTTPFieldArray::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 from PHTTPCompositeField.

PStringArray PHTTPFieldArray::GetStrings	(	PConfig &	cfg,
		const PStringArray &	defaultValues
	)

Parameters

cfg	Config file to get strings from

virtual bool PHTTPFieldArray::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.

Returns

true if no configuration set and a default should be used.

Reimplemented from PHTTPCompositeField.

virtual void PHTTPFieldArray::LoadFromJSON ( const PJSON::Base &  json )

virtual

Get the value of the JSON to the sub-field.

If the field is not composite then it always sets the value as for the non-indexed version.

Returns

true if no configuration set and a default should be used.

Reimplemented from PHTTPCompositeField.

virtual PHTTPField* PHTTPFieldArray::NewField ( ) const

virtual

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

Returns

New field object instance.

Reimplemented from PHTTPCompositeField.

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

virtual void PHTTPFieldArray::SaveToJSON ( PJSON::Base &  json ) const

virtual

Set the value of the sub-field into the JSON.

If the field is not composite then it always sets the value as for the non-indexed version.

Reimplemented from PHTTPCompositeField.

virtual void PHTTPFieldArray::SetAllValues ( const PStringToString &  data )

virtual

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

Reimplemented from PHTTPCompositeField.

void PHTTPFieldArray::SetArrayFieldName ( PINDEX  idx ) const

protected

void PHTTPFieldArray::SetSize

(

PINDEX

newSize

)

void PHTTPFieldArray::SetStrings	(	PConfig &	cfg,
		const PStringArray &	values
	)

Parameters

cfg	Config file to Set strings to
values	Strings to set

Member Data Documentation

PHTTPField* PHTTPFieldArray::m_baseField

protected

bool PHTTPFieldArray::m_canAddElements

protected

bool PHTTPFieldArray::m_orderedArray

protected

---

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

• httpform.h