DataFormItem Class Reference

An abstraction of an <item> element in a XEP-0004 Data Form of type result. More...

#include <dataformitem.h>

Inherits gloox::DataFormBase, and gloox::DataFormField.

Collaboration diagram for DataFormItem:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 DataFormItem ()
 DataFormItem (Tag *tag)
virtual ~DataFormItem ()
virtual Tagtag () const

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.

Author:
Jakob Schroeter <js@camaya.net>
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.

~DataFormItem (  )  [virtual]

Virtual destructor.

Definition at line 41 of file dataformitem.cpp.


Member Function Documentation

Tag * tag (  )  const [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:

Generated on Mon Dec 7 13:28:24 2009 for gloox by  doxygen 1.6.1