Public Member Functions | List of all members
DataFormReported Class Reference

#include <dataformreported.h>

Inheritance diagram for DataFormReported:
Inheritance graph
Collaboration diagram for DataFormReported:
Collaboration graph

Public Member Functions

 DataFormReported ()
 DataFormReported (Tag *tag)
virtual ~DataFormReported ()
virtual Tagtag () const
- Public Member Functions inherited from DataFormBase
 DataFormBase ()
virtual ~DataFormBase ()
bool hasField (const std::string &field)
DataFormFieldfield (const std::string &field)
FieldListfields ()
virtual void setFields (FieldList &fields)
virtual void addField (DataFormField *field)
DataFormFieldaddField (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 StringMapoptions ()
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 StringListvalues () 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 * > 
- 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 <reported> 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.

Jakob Schroeter

Definition at line 34 of file dataformreported.h.

Constructor & Destructor Documentation

Creates an empty 'reported' element you can add fields to.

Definition at line 21 of file dataformreported.cpp.

DataFormReported ( Tag tag)

Creates a 'reported' element and fills it with the 'field' elements contained in the given Tag. The Tag's root element must be a 'reported' element. Its child element should be 'field' elements.

tagThe tag to read the 'field' elements from.

Definition at line 26 of file dataformreported.cpp.

~DataFormReported ( )

Virtual destructor.

Definition at line 41 of file dataformreported.cpp.

Member Function Documentation

Tag * tag ( ) const

Use this function to create a Tag representation of the form field. This is usually called by DataForm.

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 dataformreported.cpp.

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