← Back to branch summary

~ubuntu-branches/ubuntu/intrepid/poppler/intrepid-security

« back to all changes in this revision

Viewing changes to glib/reference/xml/poppler-form-field.xml

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2007-09-04 10:36:25 UTC
  • mfrom: (1.1.9 upstream)
  • Revision ID: james.westby@ubuntu.com-20070904103625-pov79pxaif6r0t2r
Tags: 0.6-0ubuntu1
* New upstream version:
  - CairoOutputDev fixes
  - Allow pdftoppm to read/write from stdin/stdout
  - API work on Qt4 frontend
  - Fix pdfimages produces inverted image for black & white image
  - Fix error on the NFKC text matching routine
  - Add support for word and line selections
  - Do not enforce %%EOF at the end of file
  - Pad zeroes instead of aborting when rendering 1-bit images
    and the stream is too short
  - Update glib bindings documentation
* debian/control, debian/libpoppler2.install, debian/libpoppler-glib2.install,
  debian/libpoppler-qt2.install, debian/libpoppler-qt4-2.install, 
  debian/rules:
  - updated for soname change
* debian/libpoppler-glib-dev.install:
  - install new test-poppler-glib
* debian/patches/006_pthreads_ldflags.patch:
  - updated

Show diffs side-by-side

added added

removed removed

Lines of Context:
glib/reference/xml/poppler-form-field.xml
 
1
<?xml version="1.0"?>
 
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
 
3
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
 
4
<refentry id="poppler-poppler-form-field">
 
5
<refmeta>
 
6
<refentrytitle role="top_of_page">PopplerFormField</refentrytitle>
 
7
<manvolnum>3</manvolnum>
 
8
<refmiscinfo>POPPLER Library</refmiscinfo>
 
9
</refmeta>
 
10
 
 
11
<refnamediv>
 
12
<refname>PopplerFormField</refname>
 
13
<refpurpose></refpurpose>
 
14
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
 
15
</refnamediv>
 
16
 
 
17
<refsynopsisdiv role="synopsis">
 
18
<title role="synopsis.title">Synopsis</title>
 
19
<anchor id="PopplerFormField"/>
 
20
<synopsis>
 
21
 
 
22
 
 
23
 
 
24
                    <link linkend="PopplerFormField-struct">PopplerFormField</link>;
 
25
enum                <link linkend="PopplerFormButtonType">PopplerFormButtonType</link>;
 
26
enum                <link linkend="PopplerFormChoiceType">PopplerFormChoiceType</link>;
 
27
enum                <link linkend="PopplerFormFieldType">PopplerFormFieldType</link>;
 
28
enum                <link linkend="PopplerFormTextType">PopplerFormTextType</link>;
 
29
<link linkend="gint">gint</link>                <link linkend="poppler-form-field-get-id">poppler_form_field_get_id</link>           (<link linkend="PopplerFormField">PopplerFormField</link> *field);
 
30
<link linkend="PopplerFormFieldType">PopplerFormFieldType</link> <link linkend="poppler-form-field-get-field-type">poppler_form_field_get_field_type</link>  (<link linkend="PopplerFormField">PopplerFormField</link> *field);
 
31
<link linkend="gboolean">gboolean</link>            <link linkend="poppler-form-field-is-read-only">poppler_form_field_is_read_only</link>     (<link linkend="PopplerFormField">PopplerFormField</link> *field);
 
32
<link linkend="gdouble">gdouble</link>             <link linkend="poppler-form-field-get-font-size">poppler_form_field_get_font_size</link>    (<link linkend="PopplerFormField">PopplerFormField</link> *field);
 
33
<link linkend="PopplerFormButtonType">PopplerFormButtonType</link> <link linkend="poppler-form-field-button-get-button-type">poppler_form_field_button_get_button_type</link>
 
34
                                                        (<link linkend="PopplerFormField">PopplerFormField</link> *field);
 
35
<link linkend="gboolean">gboolean</link>            <link linkend="poppler-form-field-button-get-state">poppler_form_field_button_get_state</link> (<link linkend="PopplerFormField">PopplerFormField</link> *field);
 
36
<link linkend="void">void</link>                <link linkend="poppler-form-field-button-set-state">poppler_form_field_button_set_state</link> (<link linkend="PopplerFormField">PopplerFormField</link> *field,
 
37
                                                         <link linkend="gboolean">gboolean</link> state);
 
38
<link linkend="gboolean">gboolean</link>            <link linkend="poppler-form-field-choice-can-select-multiple">poppler_form_field_choice_can_select_multiple</link>
 
39
                                                        (<link linkend="PopplerFormField">PopplerFormField</link> *field);
 
40
<link linkend="gboolean">gboolean</link>            <link linkend="poppler-form-field-choice-commit-on-change">poppler_form_field_choice_commit_on_change</link>
 
41
                                                        (<link linkend="PopplerFormField">PopplerFormField</link> *field);
 
42
<link linkend="gboolean">gboolean</link>            <link linkend="poppler-form-field-choice-do-spell-check">poppler_form_field_choice_do_spell_check</link>
 
43
                                                        (<link linkend="PopplerFormField">PopplerFormField</link> *field);
 
44
<link linkend="PopplerFormChoiceType">PopplerFormChoiceType</link> <link linkend="poppler-form-field-choice-get-choice-type">poppler_form_field_choice_get_choice_type</link>
 
45
                                                        (<link linkend="PopplerFormField">PopplerFormField</link> *field);
 
46
<link linkend="gchar">gchar</link>*              <link linkend="poppler-form-field-choice-get-item">poppler_form_field_choice_get_item</link>  (<link linkend="PopplerFormField">PopplerFormField</link> *field,
 
47
                                                         <link linkend="gint">gint</link> index);
 
48
<link linkend="gint">gint</link>                <link linkend="poppler-form-field-choice-get-n-items">poppler_form_field_choice_get_n_items</link>
 
49
                                                        (<link linkend="PopplerFormField">PopplerFormField</link> *field);
 
50
<link linkend="gchar">gchar</link>*              <link linkend="poppler-form-field-choice-get-text">poppler_form_field_choice_get_text</link>  (<link linkend="PopplerFormField">PopplerFormField</link> *field);
 
51
<link linkend="gboolean">gboolean</link>            <link linkend="poppler-form-field-choice-is-editable">poppler_form_field_choice_is_editable</link>
 
52
                                                        (<link linkend="PopplerFormField">PopplerFormField</link> *field);
 
53
<link linkend="gboolean">gboolean</link>            <link linkend="poppler-form-field-choice-is-item-selected">poppler_form_field_choice_is_item_selected</link>
 
54
                                                        (<link linkend="PopplerFormField">PopplerFormField</link> *field,
 
55
                                                         <link linkend="gint">gint</link> index);
 
56
<link linkend="void">void</link>                <link linkend="poppler-form-field-choice-select-item">poppler_form_field_choice_select_item</link>
 
57
                                                        (<link linkend="PopplerFormField">PopplerFormField</link> *field,
 
58
                                                         <link linkend="gint">gint</link> index);
 
59
<link linkend="void">void</link>                <link linkend="poppler-form-field-choice-set-text">poppler_form_field_choice_set_text</link>  (<link linkend="PopplerFormField">PopplerFormField</link> *field,
 
60
                                                         const <link linkend="gchar">gchar</link> *text);
 
61
<link linkend="void">void</link>                <link linkend="poppler-form-field-choice-toggle-item">poppler_form_field_choice_toggle_item</link>
 
62
                                                        (<link linkend="PopplerFormField">PopplerFormField</link> *field,
 
63
                                                         <link linkend="gint">gint</link> index);
 
64
<link linkend="void">void</link>                <link linkend="poppler-form-field-choice-unselect-all">poppler_form_field_choice_unselect_all</link>
 
65
                                                        (<link linkend="PopplerFormField">PopplerFormField</link> *field);
 
66
<link linkend="gboolean">gboolean</link>            <link linkend="poppler-form-field-text-do-scroll">poppler_form_field_text_do_scroll</link>   (<link linkend="PopplerFormField">PopplerFormField</link> *field);
 
67
<link linkend="gboolean">gboolean</link>            <link linkend="poppler-form-field-text-do-spell-check">poppler_form_field_text_do_spell_check</link>
 
68
                                                        (<link linkend="PopplerFormField">PopplerFormField</link> *field);
 
69
<link linkend="gint">gint</link>                <link linkend="poppler-form-field-text-get-max-len">poppler_form_field_text_get_max_len</link> (<link linkend="PopplerFormField">PopplerFormField</link> *field);
 
70
<link linkend="gchar">gchar</link>*              <link linkend="poppler-form-field-text-get-text">poppler_form_field_text_get_text</link>    (<link linkend="PopplerFormField">PopplerFormField</link> *field);
 
71
<link linkend="PopplerFormTextType">PopplerFormTextType</link> <link linkend="poppler-form-field-text-get-text-type">poppler_form_field_text_get_text_type</link>
 
72
                                                        (<link linkend="PopplerFormField">PopplerFormField</link> *field);
 
73
<link linkend="gboolean">gboolean</link>            <link linkend="poppler-form-field-text-is-password">poppler_form_field_text_is_password</link> (<link linkend="PopplerFormField">PopplerFormField</link> *field);
 
74
<link linkend="gboolean">gboolean</link>            <link linkend="poppler-form-field-text-is-rich-text">poppler_form_field_text_is_rich_text</link>
 
75
                                                        (<link linkend="PopplerFormField">PopplerFormField</link> *field);
 
76
<link linkend="void">void</link>                <link linkend="poppler-form-field-text-set-text">poppler_form_field_text_set_text</link>    (<link linkend="PopplerFormField">PopplerFormField</link> *field,
 
77
                                                         const <link linkend="gchar">gchar</link> *text);
 
78
 
 
79
</synopsis>
 
80
</refsynopsisdiv>
 
81
 
 
82
<refsect1 role="object_hierarchy">
 
83
<title role="object_hierarchy.title">Object Hierarchy</title>
 
84
<synopsis>
 
85
 
 
86
  <link linkend="GObject">GObject</link>
 
87
   +----PopplerFormField
 
88
</synopsis>
 
89
 
 
90
</refsect1>
 
91
 
 
92
 
 
93
 
 
94
 
 
95
 
 
96
 
 
97
 
 
98
 
 
99
<refsect1 role="desc">
 
100
<title role="desc.title">Description</title>
 
101
<para>
 
102
 
 
103
</para>
 
104
</refsect1>
 
105
 
 
106
<refsect1 role="details">
 
107
<title role="details.title">Details</title>
 
108
<refsect2>
 
109
<title><anchor id="PopplerFormField-struct" role="struct"/>PopplerFormField</title>
 
110
<indexterm><primary>PopplerFormField</primary></indexterm><programlisting>typedef struct _PopplerFormField PopplerFormField;</programlisting>
 
111
<para>
 
112
 
 
113
</para></refsect2>
 
114
<refsect2>
 
115
<title><anchor id="PopplerFormButtonType" role="enum"/>enum PopplerFormButtonType</title>
 
116
<indexterm><primary>PopplerFormButtonType</primary></indexterm><programlisting>typedef enum
 
117
{
 
118
  POPPLER_FORM_BUTTON_PUSH,
 
119
  POPPLER_FORM_BUTTON_CHECK,
 
120
  POPPLER_FORM_BUTTON_RADIO
 
121
} PopplerFormButtonType;
 
122
</programlisting>
 
123
<para>
 
124
 
 
125
</para></refsect2>
 
126
<refsect2>
 
127
<title><anchor id="PopplerFormChoiceType" role="enum"/>enum PopplerFormChoiceType</title>
 
128
<indexterm><primary>PopplerFormChoiceType</primary></indexterm><programlisting>typedef enum
 
129
{
 
130
  POPPLER_FORM_CHOICE_COMBO,
 
131
  POPPLER_FORM_CHOICE_LIST
 
132
} PopplerFormChoiceType;
 
133
</programlisting>
 
134
<para>
 
135
 
 
136
</para></refsect2>
 
137
<refsect2>
 
138
<title><anchor id="PopplerFormFieldType" role="enum"/>enum PopplerFormFieldType</title>
 
139
<indexterm><primary>PopplerFormFieldType</primary></indexterm><programlisting>typedef enum
 
140
{
 
141
  POPPLER_FORM_FIELD_UNKNOWN,
 
142
  POPPLER_FORM_FIELD_BUTTON,
 
143
  POPPLER_FORM_FIELD_TEXT,
 
144
  POPPLER_FORM_FIELD_CHOICE,
 
145
  POPPLER_FORM_FIELD_SIGNATURE
 
146
} PopplerFormFieldType;
 
147
</programlisting>
 
148
<para>
 
149
 
 
150
</para></refsect2>
 
151
<refsect2>
 
152
<title><anchor id="PopplerFormTextType" role="enum"/>enum PopplerFormTextType</title>
 
153
<indexterm><primary>PopplerFormTextType</primary></indexterm><programlisting>typedef enum
 
154
{
 
155
  POPPLER_FORM_TEXT_NORMAL,
 
156
  POPPLER_FORM_TEXT_MULTILINE,
 
157
  POPPLER_FORM_TEXT_FILE_SELECT
 
158
} PopplerFormTextType;
 
159
</programlisting>
 
160
<para>
 
161
 
 
162
</para></refsect2>
 
163
<refsect2>
 
164
<title><anchor id="poppler-form-field-get-id" role="function"/>poppler_form_field_get_id ()</title>
 
165
<indexterm><primary>poppler_form_field_get_id</primary></indexterm><programlisting><link linkend="gint">gint</link>                poppler_form_field_get_id           (<link linkend="PopplerFormField">PopplerFormField</link> *field);</programlisting>
 
166
<para>
 
167
Gets the id of <parameter>field</parameter></para>
 
168
<para>
 
169
 
 
170
</para><variablelist role="params">
 
171
<varlistentry><term><parameter>field</parameter>&nbsp;:</term>
 
172
<listitem><simpara> a <link linkend="PopplerFormField"><type>PopplerFormField</type></link>
 
173
</simpara></listitem></varlistentry>
 
174
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the id of <parameter>field</parameter>
 
175
</simpara></listitem></varlistentry>
 
176
</variablelist></refsect2>
 
177
<refsect2>
 
178
<title><anchor id="poppler-form-field-get-field-type" role="function"/>poppler_form_field_get_field_type ()</title>
 
179
<indexterm><primary>poppler_form_field_get_field_type</primary></indexterm><programlisting><link linkend="PopplerFormFieldType">PopplerFormFieldType</link> poppler_form_field_get_field_type  (<link linkend="PopplerFormField">PopplerFormField</link> *field);</programlisting>
 
180
<para>
 
181
Gets the type of <parameter>field</parameter></para>
 
182
<para>
 
183
 
 
184
</para><variablelist role="params">
 
185
<varlistentry><term><parameter>field</parameter>&nbsp;:</term>
 
186
<listitem><simpara> a <link linkend="PopplerFormField"><type>PopplerFormField</type></link>
 
187
</simpara></listitem></varlistentry>
 
188
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="PopplerFormFieldType"><type>PopplerFormFieldType</type></link> of <parameter>field</parameter>
 
189
</simpara></listitem></varlistentry>
 
190
</variablelist></refsect2>
 
191
<refsect2>
 
192
<title><anchor id="poppler-form-field-is-read-only" role="function"/>poppler_form_field_is_read_only ()</title>
 
193
<indexterm><primary>poppler_form_field_is_read_only</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            poppler_form_field_is_read_only     (<link linkend="PopplerFormField">PopplerFormField</link> *field);</programlisting>
 
194
<para>
 
195
Checks whether <parameter>field</parameter> is read only</para>
 
196
<para>
 
197
 
 
198
</para><variablelist role="params">
 
199
<varlistentry><term><parameter>field</parameter>&nbsp;:</term>
 
200
<listitem><simpara> a <link linkend="PopplerFormField"><type>PopplerFormField</type></link>
 
201
</simpara></listitem></varlistentry>
 
202
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>field</parameter> is read only
 
203
</simpara></listitem></varlistentry>
 
204
</variablelist></refsect2>
 
205
<refsect2>
 
206
<title><anchor id="poppler-form-field-get-font-size" role="function"/>poppler_form_field_get_font_size ()</title>
 
207
<indexterm><primary>poppler_form_field_get_font_size</primary></indexterm><programlisting><link linkend="gdouble">gdouble</link>             poppler_form_field_get_font_size    (<link linkend="PopplerFormField">PopplerFormField</link> *field);</programlisting>
 
208
<para>
 
209
Gets the font size of <parameter>field</parameter></para>
 
210
<para>
 
211
 
 
212
</para><variablelist role="params">
 
213
<varlistentry><term><parameter>field</parameter>&nbsp;:</term>
 
214
<listitem><simpara> a <link linkend="PopplerFormField"><type>PopplerFormField</type></link>
 
215
</simpara></listitem></varlistentry>
 
216
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the font size of <parameter>field</parameter>
 
217
</simpara></listitem></varlistentry>
 
218
</variablelist></refsect2>
 
219
<refsect2>
 
220
<title><anchor id="poppler-form-field-button-get-button-type" role="function"/>poppler_form_field_button_get_button_type ()</title>
 
221
<indexterm><primary>poppler_form_field_button_get_button_type</primary></indexterm><programlisting><link linkend="PopplerFormButtonType">PopplerFormButtonType</link> poppler_form_field_button_get_button_type
 
222
                                                        (<link linkend="PopplerFormField">PopplerFormField</link> *field);</programlisting>
 
223
<para>
 
224
Gets the button type of <parameter>field</parameter></para>
 
225
<para>
 
226
 
 
227
</para><variablelist role="params">
 
228
<varlistentry><term><parameter>field</parameter>&nbsp;:</term>
 
229
<listitem><simpara> a <link linkend="PopplerFormField"><type>PopplerFormField</type></link>
 
230
</simpara></listitem></varlistentry>
 
231
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="PopplerFormButtonType"><type>PopplerFormButtonType</type></link> of <parameter>field</parameter>
 
232
</simpara></listitem></varlistentry>
 
233
</variablelist></refsect2>
 
234
<refsect2>
 
235
<title><anchor id="poppler-form-field-button-get-state" role="function"/>poppler_form_field_button_get_state ()</title>
 
236
<indexterm><primary>poppler_form_field_button_get_state</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            poppler_form_field_button_get_state (<link linkend="PopplerFormField">PopplerFormField</link> *field);</programlisting>
 
237
<para>
 
238
Queries a <link linkend="PopplerFormField"><type>PopplerFormField</type></link> and returns its current state. Returns <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if
 
239
<parameter>field</parameter> is pressed in and <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> if it is raised.</para>
 
240
<para>
 
241
 
 
242
</para><variablelist role="params">
 
243
<varlistentry><term><parameter>field</parameter>&nbsp;:</term>
 
244
<listitem><simpara> a <link linkend="PopplerFormField"><type>PopplerFormField</type></link>
 
245
</simpara></listitem></varlistentry>
 
246
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> current state of <parameter>field</parameter>
 
247
</simpara></listitem></varlistentry>
 
248
</variablelist></refsect2>
 
249
<refsect2>
 
250
<title><anchor id="poppler-form-field-button-set-state" role="function"/>poppler_form_field_button_set_state ()</title>
 
251
<indexterm><primary>poppler_form_field_button_set_state</primary></indexterm><programlisting><link linkend="void">void</link>                poppler_form_field_button_set_state (<link linkend="PopplerFormField">PopplerFormField</link> *field,
 
252
                                                         <link linkend="gboolean">gboolean</link> state);</programlisting>
 
253
<para>
 
254
Sets the status of <parameter>field</parameter>. Set to <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if you want the <link linkend="PopplerFormField"><type>PopplerFormField</type></link>
 
255
to be 'pressed in', and <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> to raise it.</para>
 
256
<para>
 
257
 
 
258
</para><variablelist role="params">
 
259
<varlistentry><term><parameter>field</parameter>&nbsp;:</term>
 
260
<listitem><simpara> a <link linkend="PopplerFormField"><type>PopplerFormField</type></link>
 
261
</simpara></listitem></varlistentry>
 
262
<varlistentry><term><parameter>state</parameter>&nbsp;:</term>
 
263
<listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> or <link linkend="FALSE:CAPS"><literal>FALSE</literal></link>
 
264
</simpara></listitem></varlistentry>
 
265
</variablelist></refsect2>
 
266
<refsect2>
 
267
<title><anchor id="poppler-form-field-choice-can-select-multiple" role="function"/>poppler_form_field_choice_can_select_multiple ()</title>
 
268
<indexterm><primary>poppler_form_field_choice_can_select_multiple</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            poppler_form_field_choice_can_select_multiple
 
269
                                                        (<link linkend="PopplerFormField">PopplerFormField</link> *field);</programlisting>
 
270
<para>
 
271
Checks whether <parameter>field</parameter> allows multiple choices to be selected</para>
 
272
<para>
 
273
 
 
274
</para><variablelist role="params">
 
275
<varlistentry><term><parameter>field</parameter>&nbsp;:</term>
 
276
<listitem><simpara> a <link linkend="PopplerFormField"><type>PopplerFormField</type></link>
 
277
</simpara></listitem></varlistentry>
 
278
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>field</parameter> allows multiple choices to be selected
 
279
</simpara></listitem></varlistentry>
 
280
</variablelist></refsect2>
 
281
<refsect2>
 
282
<title><anchor id="poppler-form-field-choice-commit-on-change" role="function"/>poppler_form_field_choice_commit_on_change ()</title>
 
283
<indexterm><primary>poppler_form_field_choice_commit_on_change</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            poppler_form_field_choice_commit_on_change
 
284
                                                        (<link linkend="PopplerFormField">PopplerFormField</link> *field);</programlisting>
 
285
<para>
 
286
 
 
287
</para><variablelist role="params">
 
288
<varlistentry><term><parameter>field</parameter>&nbsp;:</term>
 
289
<listitem><simpara>
 
290
</simpara></listitem></varlistentry>
 
291
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
292
 
 
293
 
 
294
</simpara></listitem></varlistentry>
 
295
</variablelist></refsect2>
 
296
<refsect2>
 
297
<title><anchor id="poppler-form-field-choice-do-spell-check" role="function"/>poppler_form_field_choice_do_spell_check ()</title>
 
298
<indexterm><primary>poppler_form_field_choice_do_spell_check</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            poppler_form_field_choice_do_spell_check
 
299
                                                        (<link linkend="PopplerFormField">PopplerFormField</link> *field);</programlisting>
 
300
<para>
 
301
Checks whether spell checking should be done for the contents of <parameter>field</parameter></para>
 
302
<para>
 
303
 
 
304
</para><variablelist role="params">
 
305
<varlistentry><term><parameter>field</parameter>&nbsp;:</term>
 
306
<listitem><simpara> a <link linkend="PopplerFormField"><type>PopplerFormField</type></link>
 
307
</simpara></listitem></varlistentry>
 
308
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if spell checking should be done for <parameter>field</parameter>
 
309
</simpara></listitem></varlistentry>
 
310
</variablelist></refsect2>
 
311
<refsect2>
 
312
<title><anchor id="poppler-form-field-choice-get-choice-type" role="function"/>poppler_form_field_choice_get_choice_type ()</title>
 
313
<indexterm><primary>poppler_form_field_choice_get_choice_type</primary></indexterm><programlisting><link linkend="PopplerFormChoiceType">PopplerFormChoiceType</link> poppler_form_field_choice_get_choice_type
 
314
                                                        (<link linkend="PopplerFormField">PopplerFormField</link> *field);</programlisting>
 
315
<para>
 
316
Gets the choice type of <parameter>field</parameter></para>
 
317
<para>
 
318
 
 
319
</para><variablelist role="params">
 
320
<varlistentry><term><parameter>field</parameter>&nbsp;:</term>
 
321
<listitem><simpara> a <link linkend="PopplerFormField"><type>PopplerFormField</type></link>
 
322
</simpara></listitem></varlistentry>
 
323
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="PopplerFormChoiceType"><type>PopplerFormChoiceType</type></link> of <parameter>field</parameter>
 
324
</simpara></listitem></varlistentry>
 
325
</variablelist></refsect2>
 
326
<refsect2>
 
327
<title><anchor id="poppler-form-field-choice-get-item" role="function"/>poppler_form_field_choice_get_item ()</title>
 
328
<indexterm><primary>poppler_form_field_choice_get_item</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*              poppler_form_field_choice_get_item  (<link linkend="PopplerFormField">PopplerFormField</link> *field,
 
329
                                                         <link linkend="gint">gint</link> index);</programlisting>
 
330
<para>
 
331
Returns the contents of the item on <parameter>field</parameter> at the given index</para>
 
332
<para>
 
333
 
 
334
</para><variablelist role="params">
 
335
<varlistentry><term><parameter>field</parameter>&nbsp;:</term>
 
336
<listitem><simpara> a <link linkend="PopplerFormField"><type>PopplerFormField</type></link>
 
337
</simpara></listitem></varlistentry>
 
338
<varlistentry><term><parameter>index</parameter>&nbsp;:</term>
 
339
<listitem><simpara> the index of the item
 
340
</simpara></listitem></varlistentry>
 
341
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a new allocated string. It must be freed with <link linkend="g-free"><function>g_free()</function></link> when done.
 
342
</simpara></listitem></varlistentry>
 
343
</variablelist></refsect2>
 
344
<refsect2>
 
345
<title><anchor id="poppler-form-field-choice-get-n-items" role="function"/>poppler_form_field_choice_get_n_items ()</title>
 
346
<indexterm><primary>poppler_form_field_choice_get_n_items</primary></indexterm><programlisting><link linkend="gint">gint</link>                poppler_form_field_choice_get_n_items
 
347
                                                        (<link linkend="PopplerFormField">PopplerFormField</link> *field);</programlisting>
 
348
<para>
 
349
Returns the number of items on <parameter>field</parameter></para>
 
350
<para>
 
351
 
 
352
</para><variablelist role="params">
 
353
<varlistentry><term><parameter>field</parameter>&nbsp;:</term>
 
354
<listitem><simpara> a <link linkend="PopplerFormField"><type>PopplerFormField</type></link>
 
355
</simpara></listitem></varlistentry>
 
356
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the number of items on <parameter>field</parameter>
 
357
</simpara></listitem></varlistentry>
 
358
</variablelist></refsect2>
 
359
<refsect2>
 
360
<title><anchor id="poppler-form-field-choice-get-text" role="function"/>poppler_form_field_choice_get_text ()</title>
 
361
<indexterm><primary>poppler_form_field_choice_get_text</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*              poppler_form_field_choice_get_text  (<link linkend="PopplerFormField">PopplerFormField</link> *field);</programlisting>
 
362
<para>
 
363
Retrieves the contents of <parameter>field</parameter>.</para>
 
364
<para>
 
365
 
 
366
</para><variablelist role="params">
 
367
<varlistentry><term><parameter>field</parameter>&nbsp;:</term>
 
368
<listitem><simpara> a <link linkend="PopplerFormField"><type>PopplerFormField</type></link>
 
369
</simpara></listitem></varlistentry>
 
370
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a new allocated string. It must be freed with <link linkend="g-free"><function>g_free()</function></link> when done.
 
371
</simpara></listitem></varlistentry>
 
372
</variablelist></refsect2>
 
373
<refsect2>
 
374
<title><anchor id="poppler-form-field-choice-is-editable" role="function"/>poppler_form_field_choice_is_editable ()</title>
 
375
<indexterm><primary>poppler_form_field_choice_is_editable</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            poppler_form_field_choice_is_editable
 
376
                                                        (<link linkend="PopplerFormField">PopplerFormField</link> *field);</programlisting>
 
377
<para>
 
378
Checks whether <parameter>field</parameter> is editable</para>
 
379
<para>
 
380
 
 
381
</para><variablelist role="params">
 
382
<varlistentry><term><parameter>field</parameter>&nbsp;:</term>
 
383
<listitem><simpara> a <link linkend="PopplerFormField"><type>PopplerFormField</type></link>
 
384
</simpara></listitem></varlistentry>
 
385
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>field</parameter> is editable
 
386
</simpara></listitem></varlistentry>
 
387
</variablelist></refsect2>
 
388
<refsect2>
 
389
<title><anchor id="poppler-form-field-choice-is-item-selected" role="function"/>poppler_form_field_choice_is_item_selected ()</title>
 
390
<indexterm><primary>poppler_form_field_choice_is_item_selected</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            poppler_form_field_choice_is_item_selected
 
391
                                                        (<link linkend="PopplerFormField">PopplerFormField</link> *field,
 
392
                                                         <link linkend="gint">gint</link> index);</programlisting>
 
393
<para>
 
394
Checks whether the item at the given index on <parameter>field</parameter> is currently selected</para>
 
395
<para>
 
396
 
 
397
</para><variablelist role="params">
 
398
<varlistentry><term><parameter>field</parameter>&nbsp;:</term>
 
399
<listitem><simpara> a <link linkend="PopplerFormField"><type>PopplerFormField</type></link>
 
400
</simpara></listitem></varlistentry>
 
401
<varlistentry><term><parameter>index</parameter>&nbsp;:</term>
 
402
<listitem><simpara> the index of the item
 
403
</simpara></listitem></varlistentry>
 
404
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if item at <parameter>index</parameter> is currently selected
 
405
</simpara></listitem></varlistentry>
 
406
</variablelist></refsect2>
 
407
<refsect2>
 
408
<title><anchor id="poppler-form-field-choice-select-item" role="function"/>poppler_form_field_choice_select_item ()</title>
 
409
<indexterm><primary>poppler_form_field_choice_select_item</primary></indexterm><programlisting><link linkend="void">void</link>                poppler_form_field_choice_select_item
 
410
                                                        (<link linkend="PopplerFormField">PopplerFormField</link> *field,
 
411
                                                         <link linkend="gint">gint</link> index);</programlisting>
 
412
<para>
 
413
Selects the item at the given index on <parameter>field</parameter></para>
 
414
<para>
 
415
 
 
416
</para><variablelist role="params">
 
417
<varlistentry><term><parameter>field</parameter>&nbsp;:</term>
 
418
<listitem><simpara> a <link linkend="PopplerFormField"><type>PopplerFormField</type></link>
 
419
</simpara></listitem></varlistentry>
 
420
<varlistentry><term><parameter>index</parameter>&nbsp;:</term>
 
421
<listitem><simpara> the index of the item
 
422
</simpara></listitem></varlistentry>
 
423
</variablelist></refsect2>
 
424
<refsect2>
 
425
<title><anchor id="poppler-form-field-choice-set-text" role="function"/>poppler_form_field_choice_set_text ()</title>
 
426
<indexterm><primary>poppler_form_field_choice_set_text</primary></indexterm><programlisting><link linkend="void">void</link>                poppler_form_field_choice_set_text  (<link linkend="PopplerFormField">PopplerFormField</link> *field,
 
427
                                                         const <link linkend="gchar">gchar</link> *text);</programlisting>
 
428
<para>
 
429
 
 
430
</para><variablelist role="params">
 
431
<varlistentry><term><parameter>field</parameter>&nbsp;:</term>
 
432
<listitem><simpara>
 
433
</simpara></listitem></varlistentry>
 
434
<varlistentry><term><parameter>text</parameter>&nbsp;:</term>
 
435
<listitem><simpara>
 
436
 
 
437
 
 
438
</simpara></listitem></varlistentry>
 
439
</variablelist></refsect2>
 
440
<refsect2>
 
441
<title><anchor id="poppler-form-field-choice-toggle-item" role="function"/>poppler_form_field_choice_toggle_item ()</title>
 
442
<indexterm><primary>poppler_form_field_choice_toggle_item</primary></indexterm><programlisting><link linkend="void">void</link>                poppler_form_field_choice_toggle_item
 
443
                                                        (<link linkend="PopplerFormField">PopplerFormField</link> *field,
 
444
                                                         <link linkend="gint">gint</link> index);</programlisting>
 
445
<para>
 
446
Sets the text in <parameter>field</parameter> to the given value, replacing the current contents</para>
 
447
<para>
 
448
 
 
449
</para><variablelist role="params">
 
450
<varlistentry><term><parameter>field</parameter>&nbsp;:</term>
 
451
<listitem><simpara> a <link linkend="PopplerFormField"><type>PopplerFormField</type></link>
 
452
</simpara></listitem></varlistentry>
 
453
<varlistentry><term><parameter>index</parameter>&nbsp;:</term>
 
454
<listitem><simpara>
 
455
 
 
456
 
 
457
</simpara></listitem></varlistentry>
 
458
</variablelist></refsect2>
 
459
<refsect2>
 
460
<title><anchor id="poppler-form-field-choice-unselect-all" role="function"/>poppler_form_field_choice_unselect_all ()</title>
 
461
<indexterm><primary>poppler_form_field_choice_unselect_all</primary></indexterm><programlisting><link linkend="void">void</link>                poppler_form_field_choice_unselect_all
 
462
                                                        (<link linkend="PopplerFormField">PopplerFormField</link> *field);</programlisting>
 
463
<para>
 
464
Unselects all the items on <parameter>field</parameter></para>
 
465
<para>
 
466
 
 
467
</para><variablelist role="params">
 
468
<varlistentry><term><parameter>field</parameter>&nbsp;:</term>
 
469
<listitem><simpara> a <link linkend="PopplerFormField"><type>PopplerFormField</type></link>
 
470
</simpara></listitem></varlistentry>
 
471
</variablelist></refsect2>
 
472
<refsect2>
 
473
<title><anchor id="poppler-form-field-text-do-scroll" role="function"/>poppler_form_field_text_do_scroll ()</title>
 
474
<indexterm><primary>poppler_form_field_text_do_scroll</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            poppler_form_field_text_do_scroll   (<link linkend="PopplerFormField">PopplerFormField</link> *field);</programlisting>
 
475
<para>
 
476
 
 
477
</para><variablelist role="params">
 
478
<varlistentry><term><parameter>field</parameter>&nbsp;:</term>
 
479
<listitem><simpara>
 
480
</simpara></listitem></varlistentry>
 
481
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
482
 
 
483
 
 
484
</simpara></listitem></varlistentry>
 
485
</variablelist></refsect2>
 
486
<refsect2>
 
487
<title><anchor id="poppler-form-field-text-do-spell-check" role="function"/>poppler_form_field_text_do_spell_check ()</title>
 
488
<indexterm><primary>poppler_form_field_text_do_spell_check</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            poppler_form_field_text_do_spell_check
 
489
                                                        (<link linkend="PopplerFormField">PopplerFormField</link> *field);</programlisting>
 
490
<para>
 
491
Checks whether spell checking should be done for the contents of <parameter>field</parameter></para>
 
492
<para>
 
493
 
 
494
</para><variablelist role="params">
 
495
<varlistentry><term><parameter>field</parameter>&nbsp;:</term>
 
496
<listitem><simpara> a <link linkend="PopplerFormField"><type>PopplerFormField</type></link>
 
497
</simpara></listitem></varlistentry>
 
498
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if spell checking should be done for <parameter>field</parameter>
 
499
</simpara></listitem></varlistentry>
 
500
</variablelist></refsect2>
 
501
<refsect2>
 
502
<title><anchor id="poppler-form-field-text-get-max-len" role="function"/>poppler_form_field_text_get_max_len ()</title>
 
503
<indexterm><primary>poppler_form_field_text_get_max_len</primary></indexterm><programlisting><link linkend="gint">gint</link>                poppler_form_field_text_get_max_len (<link linkend="PopplerFormField">PopplerFormField</link> *field);</programlisting>
 
504
<para>
 
505
Retrieves the maximum allowed length of the text in <parameter>field</parameter></para>
 
506
<para>
 
507
 
 
508
</para><variablelist role="params">
 
509
<varlistentry><term><parameter>field</parameter>&nbsp;:</term>
 
510
<listitem><simpara> a <link linkend="PopplerFormField"><type>PopplerFormField</type></link>
 
511
</simpara></listitem></varlistentry>
 
512
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the maximum allowed number of characters in <parameter>field</parameter>, or -1 if there is no maximum.
 
513
</simpara></listitem></varlistentry>
 
514
</variablelist></refsect2>
 
515
<refsect2>
 
516
<title><anchor id="poppler-form-field-text-get-text" role="function"/>poppler_form_field_text_get_text ()</title>
 
517
<indexterm><primary>poppler_form_field_text_get_text</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*              poppler_form_field_text_get_text    (<link linkend="PopplerFormField">PopplerFormField</link> *field);</programlisting>
 
518
<para>
 
519
Retrieves the contents of <parameter>field</parameter>.</para>
 
520
<para>
 
521
 
 
522
</para><variablelist role="params">
 
523
<varlistentry><term><parameter>field</parameter>&nbsp;:</term>
 
524
<listitem><simpara> a <link linkend="PopplerFormField"><type>PopplerFormField</type></link>
 
525
</simpara></listitem></varlistentry>
 
526
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a new allocated string. It must be freed with <link linkend="g-free"><function>g_free()</function></link> when done.
 
527
</simpara></listitem></varlistentry>
 
528
</variablelist></refsect2>
 
529
<refsect2>
 
530
<title><anchor id="poppler-form-field-text-get-text-type" role="function"/>poppler_form_field_text_get_text_type ()</title>
 
531
<indexterm><primary>poppler_form_field_text_get_text_type</primary></indexterm><programlisting><link linkend="PopplerFormTextType">PopplerFormTextType</link> poppler_form_field_text_get_text_type
 
532
                                                        (<link linkend="PopplerFormField">PopplerFormField</link> *field);</programlisting>
 
533
<para>
 
534
Gets the text type of <parameter>field</parameter>.</para>
 
535
<para>
 
536
 
 
537
</para><variablelist role="params">
 
538
<varlistentry><term><parameter>field</parameter>&nbsp;:</term>
 
539
<listitem><simpara> a <link linkend="PopplerFormField"><type>PopplerFormField</type></link>
 
540
</simpara></listitem></varlistentry>
 
541
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="PopplerFormTextType"><type>PopplerFormTextType</type></link> of <parameter>field</parameter>
 
542
</simpara></listitem></varlistentry>
 
543
</variablelist></refsect2>
 
544
<refsect2>
 
545
<title><anchor id="poppler-form-field-text-is-password" role="function"/>poppler_form_field_text_is_password ()</title>
 
546
<indexterm><primary>poppler_form_field_text_is_password</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            poppler_form_field_text_is_password (<link linkend="PopplerFormField">PopplerFormField</link> *field);</programlisting>
 
547
<para>
 
548
Checks whether content of <parameter>field</parameter> is a password and it must be hidden</para>
 
549
<para>
 
550
 
 
551
</para><variablelist role="params">
 
552
<varlistentry><term><parameter>field</parameter>&nbsp;:</term>
 
553
<listitem><simpara> a <link linkend="PopplerFormField"><type>PopplerFormField</type></link>
 
554
</simpara></listitem></varlistentry>
 
555
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the content of <parameter>field</parameter> is a password
 
556
</simpara></listitem></varlistentry>
 
557
</variablelist></refsect2>
 
558
<refsect2>
 
559
<title><anchor id="poppler-form-field-text-is-rich-text" role="function"/>poppler_form_field_text_is_rich_text ()</title>
 
560
<indexterm><primary>poppler_form_field_text_is_rich_text</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            poppler_form_field_text_is_rich_text
 
561
                                                        (<link linkend="PopplerFormField">PopplerFormField</link> *field);</programlisting>
 
562
<para>
 
563
Checks whether the contents of <parameter>field</parameter> are rich text</para>
 
564
<para>
 
565
 
 
566
</para><variablelist role="params">
 
567
<varlistentry><term><parameter>field</parameter>&nbsp;:</term>
 
568
<listitem><simpara> a <link linkend="PopplerFormField"><type>PopplerFormField</type></link>
 
569
</simpara></listitem></varlistentry>
 
570
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the contents of <parameter>field</parameter> are rich text
 
571
</simpara></listitem></varlistentry>
 
572
</variablelist></refsect2>
 
573
<refsect2>
 
574
<title><anchor id="poppler-form-field-text-set-text" role="function"/>poppler_form_field_text_set_text ()</title>
 
575
<indexterm><primary>poppler_form_field_text_set_text</primary></indexterm><programlisting><link linkend="void">void</link>                poppler_form_field_text_set_text    (<link linkend="PopplerFormField">PopplerFormField</link> *field,
 
576
                                                         const <link linkend="gchar">gchar</link> *text);</programlisting>
 
577
<para>
 
578
Sets the text in <parameter>field</parameter> to the given value, replacing the current contents.</para>
 
579
<para>
 
580
 
 
581
</para><variablelist role="params">
 
582
<varlistentry><term><parameter>field</parameter>&nbsp;:</term>
 
583
<listitem><simpara> a <link linkend="PopplerFormField"><type>PopplerFormField</type></link>
 
584
</simpara></listitem></varlistentry>
 
585
<varlistentry><term><parameter>text</parameter>&nbsp;:</term>
 
586
<listitem><simpara> the new text
 
587
</simpara></listitem></varlistentry>
 
588
</variablelist></refsect2>
 
589
 
 
590
</refsect1>
 
591
 
 
592
 
 
593
 
 
594
 
 
595
</refentry>