#include <dataformbase.h>
Public Types | |
typedef std::list < DataFormField * > | FieldList |
Public Member Functions | |
DataFormBase () | |
virtual | ~DataFormBase () |
bool | hasField (const std::string &field) |
DataFormField * | field (const std::string &field) |
FieldList & | fields () |
virtual void | setFields (FieldList &fields) |
virtual void | addField (DataFormField *field) |
DataFormField * | addField (DataFormField::DataFormFieldType type, const std::string &name, const std::string &value="", const std::string &label="") |
You shouldn't need to use this class directly. Use DataForm instead.
Definition at line 33 of file dataformbase.h.
typedef std::list<DataFormField*> FieldList |
A list of XEP-0004 Data Form Fields.
Definition at line 49 of file dataformbase.h.
DataFormBase | ( | ) |
Creates a new DataFormBase.
Definition at line 22 of file dataformbase.cpp.
~DataFormBase | ( | ) | [virtual] |
Virtual destructor.
Definition at line 26 of file dataformbase.cpp.
bool hasField | ( | const std::string & | field | ) |
Use this function to check whether this form contains a field with the given name.
field | The name of the field (the content of the 'var' attribute). |
Definition at line 36 of file dataformbase.cpp.
DataFormField * field | ( | const std::string & | field | ) |
Use this function to fetch a pointer to a field of the form. If no such field exists, 0 is returned.
field | The name of the field (the content of the 'var' attribute). |
Definition at line 48 of file dataformbase.cpp.
FieldList& fields | ( | ) | [inline] |
Use this function to retrieve the list of fields of a form.
Definition at line 70 of file dataformbase.h.
virtual void setFields | ( | FieldList & | fields | ) | [inline, virtual] |
Use this function to set the fields the form contains.
fields | The list of fields. |
Definition at line 77 of file dataformbase.h.
virtual void addField | ( | DataFormField * | field | ) | [inline, virtual] |
Use this function to add a single field to the list of existing fields.
field | The field to add. |
Definition at line 84 of file dataformbase.h.
DataFormField* addField | ( | DataFormField::DataFormFieldType | type, | |
const std::string & | name, | |||
const std::string & | value = "" , |
|||
const std::string & | label = "" | |||
) | [inline] |
Adds a single new Field and returns a pointer to that field.
type | The field's type. | |
name | The field's name (the value of the 'var' attribute). | |
value | The field's value. | |
label | The field's label. |
Definition at line 94 of file dataformbase.h.