#include <dataformitem.h>
Public Member Functions | |
| DataFormItem () | |
| DataFormItem (Tag *tag) | |
| virtual | ~DataFormItem () |
| virtual Tag * | tag () const |
 Public Member Functions inherited from DataFormBase | |
| 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="") |
| Public Member Functions inherited from DataFormField | |
| DataFormField (DataFormFieldType type=FieldTypeTextSingle) | |
| DataFormField (const std::string &name, const std::string &value="", const std::string &label="", DataFormFieldType type=FieldTypeTextSingle) | |
| DataFormField (Tag *tag) | |
| virtual | ~DataFormField () |
| virtual StringMap & | options () |
| virtual const std::string & | name () const |
| virtual void | setName (const std::string &name) |
| virtual void | setOptions (const StringMap &options) |
| virtual void | addOption (const std::string &label, const std::string &value) |
| virtual bool | required () const |
| virtual void | setRequired (bool required) |
| virtual DataFormFieldType | type () const |
| virtual const std::string & | label () const |
| virtual void | setLabel (const std::string &label) |
| virtual const std::string & | description () const |
| virtual void | setDescription (const std::string &desc) |
| virtual const std::string & | value () const |
| virtual void | setValue (const std::string &value) |
| virtual const StringList & | values () const |
| virtual void | setValues (const StringList &values) |
| virtual void | addValue (const std::string &value) |
Additional Inherited Members | |
| Public Types inherited from DataFormBase | |
| typedef std::list < DataFormField * > | FieldList |
| Public Types inherited from DataFormField | |
| enum | DataFormFieldType { FieldTypeBoolean, FieldTypeFixed, FieldTypeHidden, FieldTypeJidMulti, FieldTypeJidSingle, FieldTypeListMulti, FieldTypeListSingle, FieldTypeTextMulti, FieldTypeTextPrivate, FieldTypeTextSingle, FieldTypeItem, FieldTypeReported, FieldTypeInvalid, FieldTypeNone } |
Detailed Description
An abstraction of an <item> element in a XEP-0004 Data Form of type result.
There are some constraints regarding usage of this element you should be aware of. Check XEP-0004 section 3.4. This class does not enforce correct usage at this point.
- Since
- 0.7
Definition at line 32 of file dataformitem.h.
Constructor & Destructor Documentation
| DataFormItem | ( | ) |
Creates an empty 'item' element you can add fields to.
Definition at line 21 of file dataformitem.cpp.
| DataFormItem | ( | Tag * | tag | ) |
Creates a 'item' element and fills it with the 'field' elements contained in the given Tag. The Tag's root element must be a 'item' element. Its child element should be 'field' elements.
- Parameters
-
tag The tag to read the 'field' elements from.
- Since
- 0.8.5
Definition at line 26 of file dataformitem.cpp.
|
virtual |
Virtual destructor.
Definition at line 41 of file dataformitem.cpp.
Member Function Documentation
|
virtual |
Use this function to create a Tag representation of the form field. This is usually called by DataForm.
- Returns
- A Tag hierarchically describing the form field, or NULL if the field is invalid (i.e. created from a Tag not correctly describing a Data Form Field).
Reimplemented from DataFormField.
Definition at line 45 of file dataformitem.cpp.
The documentation for this class was generated from the following files:
