DataFormBase Class Reference
An abstract base class for a XEP-0004 Data Form. More...
#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="") |
Detailed Description
An abstract base class for a XEP-0004 Data Form.You shouldn't need to use this class directly. Use DataForm instead.
- Since:
- 0.7
Definition at line 33 of file dataformbase.h.
Member Typedef Documentation
| typedef std::list<DataFormField*> FieldList |
A list of XEP-0004 Data Form Fields.
Definition at line 49 of file dataformbase.h.
Constructor & Destructor Documentation
| 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.
Member Function Documentation
| bool hasField | ( | const std::string & | field | ) |
Use this function to check whether this form contains a field with the given name.
- Parameters:
-
field The name of the field (the content of the 'var' attribute).
- Returns:
- Whether or not the form contains the named field.
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.
- Parameters:
-
field The name of the field (the content of the 'var' attribute).
- Returns:
- A copy of the field with the given name if it exists, 0 otherwise.
Definition at line 48 of file dataformbase.cpp.
| FieldList& fields | ( | ) | [inline] |
Use this function to retrieve the list of fields of a form.
- Returns:
- The list of fields the form contains.
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.
- Parameters:
-
fields The list of fields.
- Note:
- Any previously set fields will be deleted. Always set all fields, not a delta.
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.
- Parameters:
-
field The field to add.
- Since:
- 0.9
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.
- Parameters:
-
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.
- Since:
- 0.9.4
Definition at line 94 of file dataformbase.h.
The documentation for this class was generated from the following files:
