| wocky Reference Manual | ||||
|---|---|---|---|---|
| Top | Description | Object Hierarchy | Properties | ||||
enum WockyDataFormFieldType; WockyDataForm; WockyDataFormClass; WockyDataFormPrivate; enum WockyDataFormError; GQuark wocky_data_form_error_quark (void); #define WOCKY_DATA_FORM_ERROR WockyDataForm * wocky_data_form_new_from_form (WockyNode *node,GError **error); gboolean wocky_data_form_set_type (WockyDataForm *self,const gchar *form_type); gboolean wocky_data_form_set_boolean (WockyDataForm *self,const gchar *field_name,gboolean field_value,gboolean create_if_missing); gboolean wocky_data_form_set_string (WockyDataForm *self,const gchar *field_name,const gchar *field_value,gboolean create_if_missing); gboolean wocky_data_form_set_strv (WockyDataForm *self,const gchar *field_name,const gchar * const *field_values,gboolean create_if_missing); void wocky_data_form_submit (WockyDataForm *self,WockyNode *node); gboolean wocky_data_form_parse_result (WockyDataForm *self,WockyNode *node,GError **error); const gchar * wocky_data_form_get_title (WockyDataForm *self); const gchar * wocky_data_form_get_instructions (WockyDataForm *self);
"instructions" gchar* : Read / Write / Construct Only "title" gchar* : Read / Write / Construct Only
typedef enum
{
WOCKY_DATA_FORM_FIELD_TYPE_UNSPECIFIED, /*< skip >*/
WOCKY_DATA_FORM_FIELD_TYPE_BOOLEAN,
WOCKY_DATA_FORM_FIELD_TYPE_FIXED,
WOCKY_DATA_FORM_FIELD_TYPE_HIDDEN,
WOCKY_DATA_FORM_FIELD_TYPE_JID_MULTI,
WOCKY_DATA_FORM_FIELD_TYPE_JID_SINGLE,
WOCKY_DATA_FORM_FIELD_TYPE_LIST_MULTI,
WOCKY_DATA_FORM_FIELD_TYPE_LIST_SINGLE,
WOCKY_DATA_FORM_FIELD_TYPE_TEXT_MULTI,
WOCKY_DATA_FORM_FIELD_TYPE_TEXT_PRIVATE,
WOCKY_DATA_FORM_FIELD_TYPE_TEXT_SINGLE
} WockyDataFormFieldType;
typedef enum {
WOCKY_DATA_FORM_ERROR_NOT_FORM,
WOCKY_DATA_FORM_ERROR_WRONG_TYPE,
} WockyDataFormError;
WockyDataForm * wocky_data_form_new_from_form (WockyNode *node,GError **error);
|
|
|
|
Returns : |
gboolean wocky_data_form_set_type (WockyDataForm *self,const gchar *form_type);
Creates a hidden FORM_TYPE field in self and sets its value to form_type.
This is intended only to be used on empty forms created for blind
submission.
|
a WockyDataForm |
|
the URI to use as the FORM_TYPE field; may not be NULL
|
Returns : |
TRUE if the form's type was set; FALSE if the form already had a
type.
|
gboolean wocky_data_form_set_boolean (WockyDataForm *self,const gchar *field_name,gboolean field_value,gboolean create_if_missing);
|
a data form |
|
the name of a boolean field of self
|
|
the value to fill in for field_name
|
|
if no field named field_name exists, create it
|
Returns : |
TRUE if the field was successfully filled in; FALSE if the field
did not exist or does not accept a boolean
|
gboolean wocky_data_form_set_string (WockyDataForm *self,const gchar *field_name,const gchar *field_value,gboolean create_if_missing);
|
|
|
|
|
|
|
|
Returns : |
gboolean wocky_data_form_set_strv (WockyDataForm *self,const gchar *field_name,const gchar * const *field_values,gboolean create_if_missing);
|
|
|
|
|
|
|
|
Returns : |
void wocky_data_form_submit (WockyDataForm *self,WockyNode *node);
Adds a node tree which submits self based on the current values set on
self's fields.
|
a data form |
|
a node to which to add a form submission |
gboolean wocky_data_form_parse_result (WockyDataForm *self,WockyNode *node,GError **error);
|
|
|
|
|
|
Returns : |
const gchar * wocky_data_form_get_title (WockyDataForm *self);
|
|
Returns : |
const gchar * wocky_data_form_get_instructions (WockyDataForm *self);
|
|
Returns : |