1
<refentry id="libevdocument-ev-document-forms">
3
<refentrytitle role="top_of_page" id="libevdocument-ev-document-forms.top_of_page">ev-document-forms</refentrytitle>
4
<manvolnum>3</manvolnum>
5
<refmiscinfo>LIBEVDOCUMENT Library</refmiscinfo>
9
<refname>ev-document-forms</refname>
10
<refpurpose></refpurpose>
11
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
14
<refsynopsisdiv id="libevdocument-ev-document-forms.synopsis" role="synopsis">
15
<title role="synopsis.title">Synopsis</title>
16
<anchor id="EvDocumentForms"/>
18
#define <link linkend="EV-DOCUMENT-FORMS-IFACE:CAPS">EV_DOCUMENT_FORMS_IFACE</link> (k)
19
#define <link linkend="EV-IS-DOCUMENT-FORMS-IFACE:CAPS">EV_IS_DOCUMENT_FORMS_IFACE</link> (k)
20
<link linkend="EvDocumentForms-struct">EvDocumentForms</link>;
21
<link linkend="EvDocumentFormsIface">EvDocumentFormsIface</link>;
22
<link linkend="GList">GList</link>* <link linkend="ev-document-forms-get-form-fields">ev_document_forms_get_form_fields</link> (<link linkend="EvDocumentForms">EvDocumentForms</link> *document_forms,
23
<link linkend="EvPage">EvPage</link> *page);
24
<link linkend="gchar">gchar</link>* <link linkend="ev-document-forms-form-field-text-get-text">ev_document_forms_form_field_text_get_text</link>
25
(<link linkend="EvDocumentForms">EvDocumentForms</link> *document_forms,
26
<link linkend="EvFormField">EvFormField</link> *field);
27
<link linkend="void">void</link> <link linkend="ev-document-forms-form-field-text-set-text">ev_document_forms_form_field_text_set_text</link>
28
(<link linkend="EvDocumentForms">EvDocumentForms</link> *document_forms,
29
<link linkend="EvFormField">EvFormField</link> *field,
30
const <link linkend="gchar">gchar</link> *text);
31
<link linkend="gboolean">gboolean</link> <link linkend="ev-document-forms-form-field-button-get-state">ev_document_forms_form_field_button_get_state</link>
32
(<link linkend="EvDocumentForms">EvDocumentForms</link> *document_forms,
33
<link linkend="EvFormField">EvFormField</link> *field);
34
<link linkend="void">void</link> <link linkend="ev-document-forms-form-field-button-set-state">ev_document_forms_form_field_button_set_state</link>
35
(<link linkend="EvDocumentForms">EvDocumentForms</link> *document_forms,
36
<link linkend="EvFormField">EvFormField</link> *field,
37
<link linkend="gboolean">gboolean</link> state);
38
<link linkend="gchar">gchar</link>* <link linkend="ev-document-forms-form-field-choice-get-item">ev_document_forms_form_field_choice_get_item</link>
39
(<link linkend="EvDocumentForms">EvDocumentForms</link> *document_forms,
40
<link linkend="EvFormField">EvFormField</link> *field,
41
<link linkend="gint">gint</link> index);
42
<link linkend="gint">gint</link> <link linkend="ev-document-forms-form-field-choice-get-n-items">ev_document_forms_form_field_choice_get_n_items</link>
43
(<link linkend="EvDocumentForms">EvDocumentForms</link> *document_forms,
44
<link linkend="EvFormField">EvFormField</link> *field);
45
<link linkend="gboolean">gboolean</link> <link linkend="ev-document-forms-form-field-choice-is-item-selected">ev_document_forms_form_field_choice_is_item_selected</link>
46
(<link linkend="EvDocumentForms">EvDocumentForms</link> *document_forms,
47
<link linkend="EvFormField">EvFormField</link> *field,
48
<link linkend="gint">gint</link> index);
49
<link linkend="void">void</link> <link linkend="ev-document-forms-form-field-choice-select-item">ev_document_forms_form_field_choice_select_item</link>
50
(<link linkend="EvDocumentForms">EvDocumentForms</link> *document_forms,
51
<link linkend="EvFormField">EvFormField</link> *field,
52
<link linkend="gint">gint</link> index);
53
<link linkend="void">void</link> <link linkend="ev-document-forms-form-field-choice-toggle-item">ev_document_forms_form_field_choice_toggle_item</link>
54
(<link linkend="EvDocumentForms">EvDocumentForms</link> *document_forms,
55
<link linkend="EvFormField">EvFormField</link> *field,
56
<link linkend="gint">gint</link> index);
57
<link linkend="void">void</link> <link linkend="ev-document-forms-form-field-choice-unselect-all">ev_document_forms_form_field_choice_unselect_all</link>
58
(<link linkend="EvDocumentForms">EvDocumentForms</link> *document_forms,
59
<link linkend="EvFormField">EvFormField</link> *field);
60
<link linkend="void">void</link> <link linkend="ev-document-forms-form-field-choice-set-text">ev_document_forms_form_field_choice_set_text</link>
61
(<link linkend="EvDocumentForms">EvDocumentForms</link> *document_forms,
62
<link linkend="EvFormField">EvFormField</link> *field,
63
const <link linkend="gchar">gchar</link> *text);
64
<link linkend="gchar">gchar</link>* <link linkend="ev-document-forms-form-field-choice-get-text">ev_document_forms_form_field_choice_get_text</link>
65
(<link linkend="EvDocumentForms">EvDocumentForms</link> *document_forms,
66
<link linkend="EvFormField">EvFormField</link> *field);
70
<refsect1 id="libevdocument-ev-document-forms.object-hierarchy" role="object_hierarchy">
71
<title role="object_hierarchy.title">Object Hierarchy</title>
73
<link linkend="GInterface">GInterface</link>
86
<refsect1 id="libevdocument-ev-document-forms.description" role="desc">
87
<title role="desc.title">Description</title>
93
<refsect1 id="libevdocument-ev-document-forms.details" role="details">
94
<title role="details.title">Details</title>
95
<refsect2 id="EV-DOCUMENT-FORMS-IFACE:CAPS" role="macro">
96
<title>EV_DOCUMENT_FORMS_IFACE()</title>
97
<indexterm zone="EV-DOCUMENT-FORMS-IFACE:CAPS"><primary>EV_DOCUMENT_FORMS_IFACE</primary></indexterm><programlisting>#define EV_DOCUMENT_FORMS_IFACE(k) (G_TYPE_CHECK_CLASS_CAST((k), EV_TYPE_DOCUMENT_FORMS, EvDocumentFormsIface))
101
</para><variablelist role="params">
102
<varlistentry><term><parameter>k</parameter> :</term>
106
</simpara></listitem></varlistentry>
107
</variablelist></refsect2>
108
<refsect2 id="EV-IS-DOCUMENT-FORMS-IFACE:CAPS" role="macro">
109
<title>EV_IS_DOCUMENT_FORMS_IFACE()</title>
110
<indexterm zone="EV-IS-DOCUMENT-FORMS-IFACE:CAPS"><primary>EV_IS_DOCUMENT_FORMS_IFACE</primary></indexterm><programlisting>#define EV_IS_DOCUMENT_FORMS_IFACE(k) (G_TYPE_CHECK_CLASS_TYPE ((k), EV_TYPE_DOCUMENT_FORMS))
114
</para><variablelist role="params">
115
<varlistentry><term><parameter>k</parameter> :</term>
119
</simpara></listitem></varlistentry>
120
</variablelist></refsect2>
121
<refsect2 id="EvDocumentForms-struct" role="struct">
122
<title>EvDocumentForms</title>
123
<indexterm zone="EvDocumentForms-struct"><primary>EvDocumentForms</primary></indexterm><programlisting>typedef struct _EvDocumentForms EvDocumentForms;</programlisting>
127
<refsect2 id="EvDocumentFormsIface" role="struct">
128
<title>EvDocumentFormsIface</title>
129
<indexterm zone="EvDocumentFormsIface"><primary>EvDocumentFormsIface</primary></indexterm><programlisting>typedef struct {
130
GTypeInterface base_iface;
133
GList *(* get_form_fields) (EvDocumentForms *document_forms,
135
gchar *(* form_field_text_get_text) (EvDocumentForms *document_forms,
137
void (* form_field_text_set_text) (EvDocumentForms *document_forms,
140
gboolean (* form_field_button_get_state) (EvDocumentForms *document_forms,
142
void (* form_field_button_set_state) (EvDocumentForms *document_forms,
145
gchar *(* form_field_choice_get_item) (EvDocumentForms *document_forms,
148
gint (* form_field_choice_get_n_items) (EvDocumentForms *document_forms,
150
gboolean (* form_field_choice_is_item_selected) (EvDocumentForms *document_forms,
153
void (* form_field_choice_select_item) (EvDocumentForms *document_forms,
156
void (* form_field_choice_toggle_item) (EvDocumentForms *document_forms,
159
void (* form_field_choice_unselect_all) (EvDocumentForms *document_forms,
161
void (* form_field_choice_set_text) (EvDocumentForms *document_forms,
164
gchar *(* form_field_choice_get_text) (EvDocumentForms *document_forms,
166
} EvDocumentFormsIface;
171
<refsect2 id="ev-document-forms-get-form-fields" role="function">
172
<title>ev_document_forms_get_form_fields ()</title>
173
<indexterm zone="ev-document-forms-get-form-fields"><primary>ev_document_forms_get_form_fields</primary></indexterm><programlisting><link linkend="GList">GList</link>* ev_document_forms_get_form_fields (<link linkend="EvDocumentForms">EvDocumentForms</link> *document_forms,
174
<link linkend="EvPage">EvPage</link> *page);</programlisting>
177
</para><variablelist role="params">
178
<varlistentry><term><parameter>document_forms</parameter> :</term>
180
</simpara></listitem></varlistentry>
181
<varlistentry><term><parameter>page</parameter> :</term>
183
</simpara></listitem></varlistentry>
184
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
187
</simpara></listitem></varlistentry>
188
</variablelist></refsect2>
189
<refsect2 id="ev-document-forms-form-field-text-get-text" role="function">
190
<title>ev_document_forms_form_field_text_get_text ()</title>
191
<indexterm zone="ev-document-forms-form-field-text-get-text"><primary>ev_document_forms_form_field_text_get_text</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* ev_document_forms_form_field_text_get_text
192
(<link linkend="EvDocumentForms">EvDocumentForms</link> *document_forms,
193
<link linkend="EvFormField">EvFormField</link> *field);</programlisting>
196
</para><variablelist role="params">
197
<varlistentry><term><parameter>document_forms</parameter> :</term>
199
</simpara></listitem></varlistentry>
200
<varlistentry><term><parameter>field</parameter> :</term>
202
</simpara></listitem></varlistentry>
203
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
206
</simpara></listitem></varlistentry>
207
</variablelist></refsect2>
208
<refsect2 id="ev-document-forms-form-field-text-set-text" role="function">
209
<title>ev_document_forms_form_field_text_set_text ()</title>
210
<indexterm zone="ev-document-forms-form-field-text-set-text"><primary>ev_document_forms_form_field_text_set_text</primary></indexterm><programlisting><link linkend="void">void</link> ev_document_forms_form_field_text_set_text
211
(<link linkend="EvDocumentForms">EvDocumentForms</link> *document_forms,
212
<link linkend="EvFormField">EvFormField</link> *field,
213
const <link linkend="gchar">gchar</link> *text);</programlisting>
216
</para><variablelist role="params">
217
<varlistentry><term><parameter>document_forms</parameter> :</term>
219
</simpara></listitem></varlistentry>
220
<varlistentry><term><parameter>field</parameter> :</term>
222
</simpara></listitem></varlistentry>
223
<varlistentry><term><parameter>text</parameter> :</term>
227
</simpara></listitem></varlistentry>
228
</variablelist></refsect2>
229
<refsect2 id="ev-document-forms-form-field-button-get-state" role="function">
230
<title>ev_document_forms_form_field_button_get_state ()</title>
231
<indexterm zone="ev-document-forms-form-field-button-get-state"><primary>ev_document_forms_form_field_button_get_state</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> ev_document_forms_form_field_button_get_state
232
(<link linkend="EvDocumentForms">EvDocumentForms</link> *document_forms,
233
<link linkend="EvFormField">EvFormField</link> *field);</programlisting>
236
</para><variablelist role="params">
237
<varlistentry><term><parameter>document_forms</parameter> :</term>
239
</simpara></listitem></varlistentry>
240
<varlistentry><term><parameter>field</parameter> :</term>
242
</simpara></listitem></varlistentry>
243
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
246
</simpara></listitem></varlistentry>
247
</variablelist></refsect2>
248
<refsect2 id="ev-document-forms-form-field-button-set-state" role="function">
249
<title>ev_document_forms_form_field_button_set_state ()</title>
250
<indexterm zone="ev-document-forms-form-field-button-set-state"><primary>ev_document_forms_form_field_button_set_state</primary></indexterm><programlisting><link linkend="void">void</link> ev_document_forms_form_field_button_set_state
251
(<link linkend="EvDocumentForms">EvDocumentForms</link> *document_forms,
252
<link linkend="EvFormField">EvFormField</link> *field,
253
<link linkend="gboolean">gboolean</link> state);</programlisting>
256
</para><variablelist role="params">
257
<varlistentry><term><parameter>document_forms</parameter> :</term>
259
</simpara></listitem></varlistentry>
260
<varlistentry><term><parameter>field</parameter> :</term>
262
</simpara></listitem></varlistentry>
263
<varlistentry><term><parameter>state</parameter> :</term>
267
</simpara></listitem></varlistentry>
268
</variablelist></refsect2>
269
<refsect2 id="ev-document-forms-form-field-choice-get-item" role="function">
270
<title>ev_document_forms_form_field_choice_get_item ()</title>
271
<indexterm zone="ev-document-forms-form-field-choice-get-item"><primary>ev_document_forms_form_field_choice_get_item</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* ev_document_forms_form_field_choice_get_item
272
(<link linkend="EvDocumentForms">EvDocumentForms</link> *document_forms,
273
<link linkend="EvFormField">EvFormField</link> *field,
274
<link linkend="gint">gint</link> index);</programlisting>
277
</para><variablelist role="params">
278
<varlistentry><term><parameter>document_forms</parameter> :</term>
280
</simpara></listitem></varlistentry>
281
<varlistentry><term><parameter>field</parameter> :</term>
283
</simpara></listitem></varlistentry>
284
<varlistentry><term><parameter>index</parameter> :</term>
286
</simpara></listitem></varlistentry>
287
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
290
</simpara></listitem></varlistentry>
291
</variablelist></refsect2>
292
<refsect2 id="ev-document-forms-form-field-choice-get-n-items" role="function">
293
<title>ev_document_forms_form_field_choice_get_n_items ()</title>
294
<indexterm zone="ev-document-forms-form-field-choice-get-n-items"><primary>ev_document_forms_form_field_choice_get_n_items</primary></indexterm><programlisting><link linkend="gint">gint</link> ev_document_forms_form_field_choice_get_n_items
295
(<link linkend="EvDocumentForms">EvDocumentForms</link> *document_forms,
296
<link linkend="EvFormField">EvFormField</link> *field);</programlisting>
299
</para><variablelist role="params">
300
<varlistentry><term><parameter>document_forms</parameter> :</term>
302
</simpara></listitem></varlistentry>
303
<varlistentry><term><parameter>field</parameter> :</term>
305
</simpara></listitem></varlistentry>
306
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
309
</simpara></listitem></varlistentry>
310
</variablelist></refsect2>
311
<refsect2 id="ev-document-forms-form-field-choice-is-item-selected" role="function">
312
<title>ev_document_forms_form_field_choice_is_item_selected ()</title>
313
<indexterm zone="ev-document-forms-form-field-choice-is-item-selected"><primary>ev_document_forms_form_field_choice_is_item_selected</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> ev_document_forms_form_field_choice_is_item_selected
314
(<link linkend="EvDocumentForms">EvDocumentForms</link> *document_forms,
315
<link linkend="EvFormField">EvFormField</link> *field,
316
<link linkend="gint">gint</link> index);</programlisting>
319
</para><variablelist role="params">
320
<varlistentry><term><parameter>document_forms</parameter> :</term>
322
</simpara></listitem></varlistentry>
323
<varlistentry><term><parameter>field</parameter> :</term>
325
</simpara></listitem></varlistentry>
326
<varlistentry><term><parameter>index</parameter> :</term>
328
</simpara></listitem></varlistentry>
329
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
332
</simpara></listitem></varlistentry>
333
</variablelist></refsect2>
334
<refsect2 id="ev-document-forms-form-field-choice-select-item" role="function">
335
<title>ev_document_forms_form_field_choice_select_item ()</title>
336
<indexterm zone="ev-document-forms-form-field-choice-select-item"><primary>ev_document_forms_form_field_choice_select_item</primary></indexterm><programlisting><link linkend="void">void</link> ev_document_forms_form_field_choice_select_item
337
(<link linkend="EvDocumentForms">EvDocumentForms</link> *document_forms,
338
<link linkend="EvFormField">EvFormField</link> *field,
339
<link linkend="gint">gint</link> index);</programlisting>
342
</para><variablelist role="params">
343
<varlistentry><term><parameter>document_forms</parameter> :</term>
345
</simpara></listitem></varlistentry>
346
<varlistentry><term><parameter>field</parameter> :</term>
348
</simpara></listitem></varlistentry>
349
<varlistentry><term><parameter>index</parameter> :</term>
353
</simpara></listitem></varlistentry>
354
</variablelist></refsect2>
355
<refsect2 id="ev-document-forms-form-field-choice-toggle-item" role="function">
356
<title>ev_document_forms_form_field_choice_toggle_item ()</title>
357
<indexterm zone="ev-document-forms-form-field-choice-toggle-item"><primary>ev_document_forms_form_field_choice_toggle_item</primary></indexterm><programlisting><link linkend="void">void</link> ev_document_forms_form_field_choice_toggle_item
358
(<link linkend="EvDocumentForms">EvDocumentForms</link> *document_forms,
359
<link linkend="EvFormField">EvFormField</link> *field,
360
<link linkend="gint">gint</link> index);</programlisting>
363
</para><variablelist role="params">
364
<varlistentry><term><parameter>document_forms</parameter> :</term>
366
</simpara></listitem></varlistentry>
367
<varlistentry><term><parameter>field</parameter> :</term>
369
</simpara></listitem></varlistentry>
370
<varlistentry><term><parameter>index</parameter> :</term>
374
</simpara></listitem></varlistentry>
375
</variablelist></refsect2>
376
<refsect2 id="ev-document-forms-form-field-choice-unselect-all" role="function">
377
<title>ev_document_forms_form_field_choice_unselect_all ()</title>
378
<indexterm zone="ev-document-forms-form-field-choice-unselect-all"><primary>ev_document_forms_form_field_choice_unselect_all</primary></indexterm><programlisting><link linkend="void">void</link> ev_document_forms_form_field_choice_unselect_all
379
(<link linkend="EvDocumentForms">EvDocumentForms</link> *document_forms,
380
<link linkend="EvFormField">EvFormField</link> *field);</programlisting>
383
</para><variablelist role="params">
384
<varlistentry><term><parameter>document_forms</parameter> :</term>
386
</simpara></listitem></varlistentry>
387
<varlistentry><term><parameter>field</parameter> :</term>
391
</simpara></listitem></varlistentry>
392
</variablelist></refsect2>
393
<refsect2 id="ev-document-forms-form-field-choice-set-text" role="function">
394
<title>ev_document_forms_form_field_choice_set_text ()</title>
395
<indexterm zone="ev-document-forms-form-field-choice-set-text"><primary>ev_document_forms_form_field_choice_set_text</primary></indexterm><programlisting><link linkend="void">void</link> ev_document_forms_form_field_choice_set_text
396
(<link linkend="EvDocumentForms">EvDocumentForms</link> *document_forms,
397
<link linkend="EvFormField">EvFormField</link> *field,
398
const <link linkend="gchar">gchar</link> *text);</programlisting>
401
</para><variablelist role="params">
402
<varlistentry><term><parameter>document_forms</parameter> :</term>
404
</simpara></listitem></varlistentry>
405
<varlistentry><term><parameter>field</parameter> :</term>
407
</simpara></listitem></varlistentry>
408
<varlistentry><term><parameter>text</parameter> :</term>
412
</simpara></listitem></varlistentry>
413
</variablelist></refsect2>
414
<refsect2 id="ev-document-forms-form-field-choice-get-text" role="function">
415
<title>ev_document_forms_form_field_choice_get_text ()</title>
416
<indexterm zone="ev-document-forms-form-field-choice-get-text"><primary>ev_document_forms_form_field_choice_get_text</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* ev_document_forms_form_field_choice_get_text
417
(<link linkend="EvDocumentForms">EvDocumentForms</link> *document_forms,
418
<link linkend="EvFormField">EvFormField</link> *field);</programlisting>
421
</para><variablelist role="params">
422
<varlistentry><term><parameter>document_forms</parameter> :</term>
424
</simpara></listitem></varlistentry>
425
<varlistentry><term><parameter>field</parameter> :</term>
427
</simpara></listitem></varlistentry>
428
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
431
</simpara></listitem></varlistentry>
432
</variablelist></refsect2>