gloox
1.0.28
|
#include <dataformfield.h>
Public Types | |
enum | FieldType { TypeBoolean , TypeFixed , TypeHidden , TypeJidMulti , TypeJidSingle , TypeListMulti , TypeListSingle , TypeTextMulti , TypeTextPrivate , TypeTextSingle , TypeNone , TypeInvalid } |
Public Member Functions | |
DataFormField (FieldType type=TypeTextSingle) | |
DataFormField (const std::string &name, const std::string &value=EmptyString, const std::string &label=EmptyString, FieldType type=TypeTextSingle) | |
DataFormField (const Tag *tag) | |
virtual | ~DataFormField () |
const StringMultiMap & | options () const |
virtual Tag * | tag () const |
const std::string & | name () const |
void | setName (const std::string &name) |
void | setOptions (const StringMultiMap &options) |
void | addOption (const std::string &label, const std::string &value) |
bool | required () const |
void | setRequired (bool required) |
const std::string & | label () const |
void | setLabel (const std::string &label) |
const std::string & | description () const |
void | setDescription (const std::string &desc) |
const std::string & | value () const |
void | setValue (const std::string &value) |
const StringList & | values () const |
void | setValues (const StringList &values) |
void | addValue (const std::string &value) |
FieldType | type () const |
operator bool () const | |
An abstraction of a single field in a XEP-0004 Data Form.
Definition at line 33 of file dataformfield.h.
enum FieldType |
Describes the possible types of a Data Form Field.
Enumerator | |
---|---|
TypeBoolean | The field enables an entity to gather or provide an either-or choice between two options. The default value is "false". |
TypeFixed | The field is intended for data description (e.g., human-readable text such as "section" headers) rather than data gathering or provision. The <value/> child SHOULD NOT contain newlines (the \n and \r characters); instead an application SHOULD generate multiple fixed fields, each with one <value/> child. |
TypeHidden | The field is not shown to the entity providing information, but instead is returned with the form. |
TypeJidMulti | The field enables an entity to gather or provide multiple Jabber IDs. |
TypeJidSingle | The field enables an entity to gather or provide a single Jabber ID. |
TypeListMulti | The field enables an entity to gather or provide one or more options from among many. |
TypeListSingle | The field enables an entity to gather or provide one option from among many. |
TypeTextMulti | The field enables an entity to gather or provide multiple lines of text. |
TypeTextPrivate | The field enables an entity to gather or provide a single line or word of text, which shall be obscured in an interface (e.g., *****). |
TypeTextSingle | The field enables an entity to gather or provide a single line or word of text, which may be shown in an interface. This field type is the default and MUST be assumed if an entity receives a field type it does not understand. |
TypeNone | The field is child of either a <reported> or <item> element or has no type attribute. |
TypeInvalid | The field is invalid. Only possible if the field was created from a Tag not correctly describing a Data Form Field. |
Definition at line 40 of file dataformfield.h.
DataFormField | ( | FieldType | type = TypeTextSingle | ) |
Constructs a new DataForm field.
type | The type of the field. Default: text-single. |
Definition at line 26 of file dataformfield.cpp.
DataFormField | ( | const std::string & | name, |
const std::string & | value = EmptyString , |
||
const std::string & | label = EmptyString , |
||
FieldType | type = TypeTextSingle |
||
) |
Constructs a new DataForm field and fills it with the given values.
name | The field's name (the value of the 'var' attribute). |
value | The field's value. |
label | The field's label. |
type | The field's type. |
Definition at line 31 of file dataformfield.cpp.
DataFormField | ( | const Tag * | tag | ) |
Constructs a new Data Form Field from an existing tag that describes a field.
tag | The tag to parse. |
Definition at line 38 of file dataformfield.cpp.
|
virtual |
Virtual destructor.
Definition at line 84 of file dataformfield.cpp.
|
inline |
Adds a single option to the list of options.
label | The label of the option. |
value | The value of the option. |
Definition at line 146 of file dataformfield.h.
|
inline |
Adds a single value to the list of values.
value | The value to add. |
Definition at line 214 of file dataformfield.h.
|
inline |
Use this function to retrieve the description of this field.
Definition at line 177 of file dataformfield.h.
|
inline |
Use this function to retrieve the describing label of this field.
Definition at line 165 of file dataformfield.h.
|
inline |
Use this function to retrieve the name of the field (the content of the 'var' attribute).
Definition at line 122 of file dataformfield.h.
|
inline |
Converts to true if the FormBase is valid, false otherwise.
Definition at line 225 of file dataformfield.h.
|
inline |
Use this function to retrieve the optional values of a field.
Definition at line 108 of file dataformfield.h.
|
inline |
Use this function to determine whether or not this field is required.
Definition at line 153 of file dataformfield.h.
|
inline |
Use this function to set the description of this field.
desc | The description of this field. |
Definition at line 183 of file dataformfield.h.
|
inline |
Use this function to set the describing label of this field.
label | The describing label of this field. |
Definition at line 171 of file dataformfield.h.
|
inline |
Sets the name (the content of the 'var' attribute) of the field. The name identifies the field uniquely in the form.
name | The new name of the field. |
Definition at line 130 of file dataformfield.h.
|
inline |
Use this function to set the optional values of the field. The key of the map will be used as the label of the option, while the value will be used as ... the value. ;)
options | The optional values of a list* or *multi type of field. |
Definition at line 138 of file dataformfield.h.
|
inline |
Use this field to set this field to be required.
required | Whether or not this field is required. |
Definition at line 159 of file dataformfield.h.
|
inline |
Use this function to set the value of this field.
value | The new value of this field. |
Definition at line 195 of file dataformfield.h.
|
inline |
Use this function to set multiple values of this field, if it is of type 'text-multi'. If its not, use setValue() instead.
values | The new values of this field. |
Definition at line 208 of file dataformfield.h.
|
virtual |
Use this function to create a Tag representation of the form field. This is usually called by DataForm.
Definition at line 88 of file dataformfield.cpp.
|
inline |
Use this function to retrieve the type of this field.
Definition at line 220 of file dataformfield.h.
|
inline |
Use this function to retrieve the value of this field.
Definition at line 189 of file dataformfield.h.
|
inline |
Use this function to retrieve the values of this field, if its of type 'text-multi'.
Definition at line 201 of file dataformfield.h.