<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="poppler-poppler-form-field">
<refmeta>
<refentrytitle role="top_of_page" id="poppler-poppler-form-field.top_of_page">PopplerFormField</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>POPPLER Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>PopplerFormField</refname>
<refpurpose></refpurpose>
</refnamediv>

<refsynopsisdiv id="poppler-poppler-form-field.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<anchor id="PopplerFormField"/>
<synopsis>
                    <link linkend="PopplerFormField-struct">PopplerFormField</link>;
enum                <link linkend="PopplerFormButtonType">PopplerFormButtonType</link>;
enum                <link linkend="PopplerFormChoiceType">PopplerFormChoiceType</link>;
enum                <link linkend="PopplerFormFieldType">PopplerFormFieldType</link>;
enum                <link linkend="PopplerFormTextType">PopplerFormTextType</link>;
<link linkend="gint">gint</link>                <link linkend="poppler-form-field-get-id">poppler_form_field_get_id</link>           (<link linkend="PopplerFormField">PopplerFormField</link> *field);
<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);
<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);
<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);
<link linkend="PopplerFormButtonType">PopplerFormButtonType</link>  <link linkend="poppler-form-field-button-get-button-type">poppler_form_field_button_get_button_type</link>
                                                        (<link linkend="PopplerFormField">PopplerFormField</link> *field);
<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);
<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,
                                                         <link linkend="gboolean">gboolean</link> state);
<link linkend="gboolean">gboolean</link>            <link linkend="poppler-form-field-choice-can-select-multiple">poppler_form_field_choice_can_select_multiple</link>
                                                        (<link linkend="PopplerFormField">PopplerFormField</link> *field);
<link linkend="gboolean">gboolean</link>            <link linkend="poppler-form-field-choice-commit-on-change">poppler_form_field_choice_commit_on_change</link>
                                                        (<link linkend="PopplerFormField">PopplerFormField</link> *field);
<link linkend="gboolean">gboolean</link>            <link linkend="poppler-form-field-choice-do-spell-check">poppler_form_field_choice_do_spell_check</link>
                                                        (<link linkend="PopplerFormField">PopplerFormField</link> *field);
<link linkend="PopplerFormChoiceType">PopplerFormChoiceType</link>  <link linkend="poppler-form-field-choice-get-choice-type">poppler_form_field_choice_get_choice_type</link>
                                                        (<link linkend="PopplerFormField">PopplerFormField</link> *field);
<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,
                                                         <link linkend="gint">gint</link> index);
<link linkend="gint">gint</link>                <link linkend="poppler-form-field-choice-get-n-items">poppler_form_field_choice_get_n_items</link>
                                                        (<link linkend="PopplerFormField">PopplerFormField</link> *field);
<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);
<link linkend="gboolean">gboolean</link>            <link linkend="poppler-form-field-choice-is-editable">poppler_form_field_choice_is_editable</link>
                                                        (<link linkend="PopplerFormField">PopplerFormField</link> *field);
<link linkend="gboolean">gboolean</link>            <link linkend="poppler-form-field-choice-is-item-selected">poppler_form_field_choice_is_item_selected</link>
                                                        (<link linkend="PopplerFormField">PopplerFormField</link> *field,
                                                         <link linkend="gint">gint</link> index);
<link linkend="void">void</link>                <link linkend="poppler-form-field-choice-select-item">poppler_form_field_choice_select_item</link>
                                                        (<link linkend="PopplerFormField">PopplerFormField</link> *field,
                                                         <link linkend="gint">gint</link> index);
<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,
                                                         const <link linkend="gchar">gchar</link> *text);
<link linkend="void">void</link>                <link linkend="poppler-form-field-choice-toggle-item">poppler_form_field_choice_toggle_item</link>
                                                        (<link linkend="PopplerFormField">PopplerFormField</link> *field,
                                                         <link linkend="gint">gint</link> index);
<link linkend="void">void</link>                <link linkend="poppler-form-field-choice-unselect-all">poppler_form_field_choice_unselect_all</link>
                                                        (<link linkend="PopplerFormField">PopplerFormField</link> *field);
<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);
<link linkend="gboolean">gboolean</link>            <link linkend="poppler-form-field-text-do-spell-check">poppler_form_field_text_do_spell_check</link>
                                                        (<link linkend="PopplerFormField">PopplerFormField</link> *field);
<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);
<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);
<link linkend="PopplerFormTextType">PopplerFormTextType</link>  <link linkend="poppler-form-field-text-get-text-type">poppler_form_field_text_get_text_type</link>
                                                        (<link linkend="PopplerFormField">PopplerFormField</link> *field);
<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);
<link linkend="gboolean">gboolean</link>            <link linkend="poppler-form-field-text-is-rich-text">poppler_form_field_text_is_rich_text</link>
                                                        (<link linkend="PopplerFormField">PopplerFormField</link> *field);
<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,
                                                         const <link linkend="gchar">gchar</link> *text);
</synopsis>
</refsynopsisdiv>

<refsect1 id="poppler-poppler-form-field.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
  <link linkend="GObject">GObject</link>
   +----PopplerFormField
</synopsis>
</refsect1>








<refsect1 id="poppler-poppler-form-field.description" role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>

<refsect1 id="poppler-poppler-form-field.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="PopplerFormField-struct" role="struct">
<title>PopplerFormField</title>
<indexterm zone="PopplerFormField-struct"><primary sortas="PopplerFormField">PopplerFormField</primary></indexterm><programlisting>typedef struct _PopplerFormField PopplerFormField;</programlisting>
<para>
</para></refsect2>
<refsect2 id="PopplerFormButtonType" role="enum">
<title>enum PopplerFormButtonType</title>
<indexterm zone="PopplerFormButtonType"><primary sortas="PopplerFormButtonType">PopplerFormButtonType</primary></indexterm><programlisting>typedef enum
{
  POPPLER_FORM_BUTTON_PUSH,
  POPPLER_FORM_BUTTON_CHECK,
  POPPLER_FORM_BUTTON_RADIO
} PopplerFormButtonType;
</programlisting>
<para>
</para></refsect2>
<refsect2 id="PopplerFormChoiceType" role="enum">
<title>enum PopplerFormChoiceType</title>
<indexterm zone="PopplerFormChoiceType"><primary sortas="PopplerFormChoiceType">PopplerFormChoiceType</primary></indexterm><programlisting>typedef enum
{
  POPPLER_FORM_CHOICE_COMBO,
  POPPLER_FORM_CHOICE_LIST
} PopplerFormChoiceType;
</programlisting>
<para>
</para></refsect2>
<refsect2 id="PopplerFormFieldType" role="enum">
<title>enum PopplerFormFieldType</title>
<indexterm zone="PopplerFormFieldType"><primary sortas="PopplerFormFieldType">PopplerFormFieldType</primary></indexterm><programlisting>typedef enum
{
  POPPLER_FORM_FIELD_UNKNOWN,
  POPPLER_FORM_FIELD_BUTTON,
  POPPLER_FORM_FIELD_TEXT,
  POPPLER_FORM_FIELD_CHOICE,
  POPPLER_FORM_FIELD_SIGNATURE
} PopplerFormFieldType;
</programlisting>
<para>
</para></refsect2>
<refsect2 id="PopplerFormTextType" role="enum">
<title>enum PopplerFormTextType</title>
<indexterm zone="PopplerFormTextType"><primary sortas="PopplerFormTextType">PopplerFormTextType</primary></indexterm><programlisting>typedef enum
{
  POPPLER_FORM_TEXT_NORMAL,
  POPPLER_FORM_TEXT_MULTILINE,
  POPPLER_FORM_TEXT_FILE_SELECT
} PopplerFormTextType;
</programlisting>
<para>
</para></refsect2>
<refsect2 id="poppler-form-field-get-id" role="function">
<title>poppler_form_field_get_id ()</title>
<indexterm zone="poppler-form-field-get-id"><primary sortas="poppler_form_field_get_id">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>
<para>
Gets the id of <parameter>field</parameter></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>field</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="PopplerFormField"><type>PopplerFormField</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the id of <parameter>field</parameter>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="poppler-form-field-get-field-type" role="function">
<title>poppler_form_field_get_field_type ()</title>
<indexterm zone="poppler-form-field-get-field-type"><primary sortas="poppler_form_field_get_field_type">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>
<para>
Gets the type of <parameter>field</parameter></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>field</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="PopplerFormField"><type>PopplerFormField</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="PopplerFormFieldType"><type>PopplerFormFieldType</type></link> of <parameter>field</parameter>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="poppler-form-field-is-read-only" role="function">
<title>poppler_form_field_is_read_only ()</title>
<indexterm zone="poppler-form-field-is-read-only"><primary sortas="poppler_form_field_is_read_only">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>
<para>
Checks whether <parameter>field</parameter> is read only</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>field</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="PopplerFormField"><type>PopplerFormField</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if <parameter>field</parameter> is read only
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="poppler-form-field-get-font-size" role="function">
<title>poppler_form_field_get_font_size ()</title>
<indexterm zone="poppler-form-field-get-font-size"><primary sortas="poppler_form_field_get_font_size">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>
<para>
Gets the font size of <parameter>field</parameter></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>field</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="PopplerFormField"><type>PopplerFormField</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the font size of <parameter>field</parameter>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="poppler-form-field-button-get-button-type" role="function">
<title>poppler_form_field_button_get_button_type ()</title>
<indexterm zone="poppler-form-field-button-get-button-type"><primary sortas="poppler_form_field_button_get_button_type">poppler_form_field_button_get_button_type</primary></indexterm><programlisting><link linkend="PopplerFormButtonType">PopplerFormButtonType</link>  poppler_form_field_button_get_button_type
                                                        (<link linkend="PopplerFormField">PopplerFormField</link> *field);</programlisting>
<para>
Gets the button type of <parameter>field</parameter></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>field</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="PopplerFormField"><type>PopplerFormField</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="PopplerFormButtonType"><type>PopplerFormButtonType</type></link> of <parameter>field</parameter>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="poppler-form-field-button-get-state" role="function">
<title>poppler_form_field_button_get_state ()</title>
<indexterm zone="poppler-form-field-button-get-state"><primary sortas="poppler_form_field_button_get_state">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>
<para>
Queries a <link linkend="PopplerFormField"><type>PopplerFormField</type></link> and returns its current state. Returns <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if
<parameter>field</parameter> is pressed in and <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> if it is raised.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>field</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="PopplerFormField"><type>PopplerFormField</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> current state of <parameter>field</parameter>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="poppler-form-field-button-set-state" role="function">
<title>poppler_form_field_button_set_state ()</title>
<indexterm zone="poppler-form-field-button-set-state"><primary sortas="poppler_form_field_button_set_state">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,
                                                         <link linkend="gboolean">gboolean</link> state);</programlisting>
<para>
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>
to be 'pressed in', and <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> to raise it.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>field</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="PopplerFormField"><type>PopplerFormField</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>state</parameter>&#160;:</term>
<listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> or <link linkend="FALSE--CAPS"><literal>FALSE</literal></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="poppler-form-field-choice-can-select-multiple" role="function">
<title>poppler_form_field_choice_can_select_multiple ()</title>
<indexterm zone="poppler-form-field-choice-can-select-multiple"><primary sortas="poppler_form_field_choice_can_select_multiple">poppler_form_field_choice_can_select_multiple</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            poppler_form_field_choice_can_select_multiple
                                                        (<link linkend="PopplerFormField">PopplerFormField</link> *field);</programlisting>
<para>
Checks whether <parameter>field</parameter> allows multiple choices to be selected</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>field</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="PopplerFormField"><type>PopplerFormField</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if <parameter>field</parameter> allows multiple choices to be selected
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="poppler-form-field-choice-commit-on-change" role="function">
<title>poppler_form_field_choice_commit_on_change ()</title>
<indexterm zone="poppler-form-field-choice-commit-on-change"><primary sortas="poppler_form_field_choice_commit_on_change">poppler_form_field_choice_commit_on_change</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            poppler_form_field_choice_commit_on_change
                                                        (<link linkend="PopplerFormField">PopplerFormField</link> *field);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>field</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="poppler-form-field-choice-do-spell-check" role="function">
<title>poppler_form_field_choice_do_spell_check ()</title>
<indexterm zone="poppler-form-field-choice-do-spell-check"><primary sortas="poppler_form_field_choice_do_spell_check">poppler_form_field_choice_do_spell_check</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            poppler_form_field_choice_do_spell_check
                                                        (<link linkend="PopplerFormField">PopplerFormField</link> *field);</programlisting>
<para>
Checks whether spell checking should be done for the contents of <parameter>field</parameter></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>field</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="PopplerFormField"><type>PopplerFormField</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if spell checking should be done for <parameter>field</parameter>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="poppler-form-field-choice-get-choice-type" role="function">
<title>poppler_form_field_choice_get_choice_type ()</title>
<indexterm zone="poppler-form-field-choice-get-choice-type"><primary sortas="poppler_form_field_choice_get_choice_type">poppler_form_field_choice_get_choice_type</primary></indexterm><programlisting><link linkend="PopplerFormChoiceType">PopplerFormChoiceType</link>  poppler_form_field_choice_get_choice_type
                                                        (<link linkend="PopplerFormField">PopplerFormField</link> *field);</programlisting>
<para>
Gets the choice type of <parameter>field</parameter></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>field</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="PopplerFormField"><type>PopplerFormField</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="PopplerFormChoiceType"><type>PopplerFormChoiceType</type></link> of <parameter>field</parameter>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="poppler-form-field-choice-get-item" role="function">
<title>poppler_form_field_choice_get_item ()</title>
<indexterm zone="poppler-form-field-choice-get-item"><primary sortas="poppler_form_field_choice_get_item">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,
                                                         <link linkend="gint">gint</link> index);</programlisting>
<para>
Returns the contents of the item on <parameter>field</parameter> at the given index</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>field</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="PopplerFormField"><type>PopplerFormField</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>index</parameter>&#160;:</term>
<listitem><simpara> the index of the item
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a new allocated string. It must be freed with <link linkend="g-free"><function>g_free()</function></link> when done.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="poppler-form-field-choice-get-n-items" role="function">
<title>poppler_form_field_choice_get_n_items ()</title>
<indexterm zone="poppler-form-field-choice-get-n-items"><primary sortas="poppler_form_field_choice_get_n_items">poppler_form_field_choice_get_n_items</primary></indexterm><programlisting><link linkend="gint">gint</link>                poppler_form_field_choice_get_n_items
                                                        (<link linkend="PopplerFormField">PopplerFormField</link> *field);</programlisting>
<para>
Returns the number of items on <parameter>field</parameter></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>field</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="PopplerFormField"><type>PopplerFormField</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the number of items on <parameter>field</parameter>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="poppler-form-field-choice-get-text" role="function">
<title>poppler_form_field_choice_get_text ()</title>
<indexterm zone="poppler-form-field-choice-get-text"><primary sortas="poppler_form_field_choice_get_text">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>
<para>
Retrieves the contents of <parameter>field</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>field</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="PopplerFormField"><type>PopplerFormField</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a new allocated string. It must be freed with <link linkend="g-free"><function>g_free()</function></link> when done.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="poppler-form-field-choice-is-editable" role="function">
<title>poppler_form_field_choice_is_editable ()</title>
<indexterm zone="poppler-form-field-choice-is-editable"><primary sortas="poppler_form_field_choice_is_editable">poppler_form_field_choice_is_editable</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            poppler_form_field_choice_is_editable
                                                        (<link linkend="PopplerFormField">PopplerFormField</link> *field);</programlisting>
<para>
Checks whether <parameter>field</parameter> is editable</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>field</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="PopplerFormField"><type>PopplerFormField</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if <parameter>field</parameter> is editable
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="poppler-form-field-choice-is-item-selected" role="function">
<title>poppler_form_field_choice_is_item_selected ()</title>
<indexterm zone="poppler-form-field-choice-is-item-selected"><primary sortas="poppler_form_field_choice_is_item_selected">poppler_form_field_choice_is_item_selected</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            poppler_form_field_choice_is_item_selected
                                                        (<link linkend="PopplerFormField">PopplerFormField</link> *field,
                                                         <link linkend="gint">gint</link> index);</programlisting>
<para>
Checks whether the item at the given index on <parameter>field</parameter> is currently selected</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>field</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="PopplerFormField"><type>PopplerFormField</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>index</parameter>&#160;:</term>
<listitem><simpara> the index of the item
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if item at <parameter>index</parameter> is currently selected
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="poppler-form-field-choice-select-item" role="function">
<title>poppler_form_field_choice_select_item ()</title>
<indexterm zone="poppler-form-field-choice-select-item"><primary sortas="poppler_form_field_choice_select_item">poppler_form_field_choice_select_item</primary></indexterm><programlisting><link linkend="void">void</link>                poppler_form_field_choice_select_item
                                                        (<link linkend="PopplerFormField">PopplerFormField</link> *field,
                                                         <link linkend="gint">gint</link> index);</programlisting>
<para>
Selects the item at the given index on <parameter>field</parameter></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>field</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="PopplerFormField"><type>PopplerFormField</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>index</parameter>&#160;:</term>
<listitem><simpara> the index of the item
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="poppler-form-field-choice-set-text" role="function">
<title>poppler_form_field_choice_set_text ()</title>
<indexterm zone="poppler-form-field-choice-set-text"><primary sortas="poppler_form_field_choice_set_text">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,
                                                         const <link linkend="gchar">gchar</link> *text);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>field</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>text</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="poppler-form-field-choice-toggle-item" role="function">
<title>poppler_form_field_choice_toggle_item ()</title>
<indexterm zone="poppler-form-field-choice-toggle-item"><primary sortas="poppler_form_field_choice_toggle_item">poppler_form_field_choice_toggle_item</primary></indexterm><programlisting><link linkend="void">void</link>                poppler_form_field_choice_toggle_item
                                                        (<link linkend="PopplerFormField">PopplerFormField</link> *field,
                                                         <link linkend="gint">gint</link> index);</programlisting>
<para>
Sets the text in <parameter>field</parameter> to the given value, replacing the current contents</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>field</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="PopplerFormField"><type>PopplerFormField</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>index</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="poppler-form-field-choice-unselect-all" role="function">
<title>poppler_form_field_choice_unselect_all ()</title>
<indexterm zone="poppler-form-field-choice-unselect-all"><primary sortas="poppler_form_field_choice_unselect_all">poppler_form_field_choice_unselect_all</primary></indexterm><programlisting><link linkend="void">void</link>                poppler_form_field_choice_unselect_all
                                                        (<link linkend="PopplerFormField">PopplerFormField</link> *field);</programlisting>
<para>
Unselects all the items on <parameter>field</parameter></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>field</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="PopplerFormField"><type>PopplerFormField</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="poppler-form-field-text-do-scroll" role="function">
<title>poppler_form_field_text_do_scroll ()</title>
<indexterm zone="poppler-form-field-text-do-scroll"><primary sortas="poppler_form_field_text_do_scroll">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>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>field</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="poppler-form-field-text-do-spell-check" role="function">
<title>poppler_form_field_text_do_spell_check ()</title>
<indexterm zone="poppler-form-field-text-do-spell-check"><primary sortas="poppler_form_field_text_do_spell_check">poppler_form_field_text_do_spell_check</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            poppler_form_field_text_do_spell_check
                                                        (<link linkend="PopplerFormField">PopplerFormField</link> *field);</programlisting>
<para>
Checks whether spell checking should be done for the contents of <parameter>field</parameter></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>field</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="PopplerFormField"><type>PopplerFormField</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if spell checking should be done for <parameter>field</parameter>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="poppler-form-field-text-get-max-len" role="function">
<title>poppler_form_field_text_get_max_len ()</title>
<indexterm zone="poppler-form-field-text-get-max-len"><primary sortas="poppler_form_field_text_get_max_len">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>
<para>
Retrieves the maximum allowed length of the text in <parameter>field</parameter></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>field</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="PopplerFormField"><type>PopplerFormField</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the maximum allowed number of characters in <parameter>field</parameter>, or -1 if there is no maximum.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="poppler-form-field-text-get-text" role="function">
<title>poppler_form_field_text_get_text ()</title>
<indexterm zone="poppler-form-field-text-get-text"><primary sortas="poppler_form_field_text_get_text">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>
<para>
Retrieves the contents of <parameter>field</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>field</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="PopplerFormField"><type>PopplerFormField</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a new allocated string. It must be freed with <link linkend="g-free"><function>g_free()</function></link> when done.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="poppler-form-field-text-get-text-type" role="function">
<title>poppler_form_field_text_get_text_type ()</title>
<indexterm zone="poppler-form-field-text-get-text-type"><primary sortas="poppler_form_field_text_get_text_type">poppler_form_field_text_get_text_type</primary></indexterm><programlisting><link linkend="PopplerFormTextType">PopplerFormTextType</link>  poppler_form_field_text_get_text_type
                                                        (<link linkend="PopplerFormField">PopplerFormField</link> *field);</programlisting>
<para>
Gets the text type of <parameter>field</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>field</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="PopplerFormField"><type>PopplerFormField</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="PopplerFormTextType"><type>PopplerFormTextType</type></link> of <parameter>field</parameter>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="poppler-form-field-text-is-password" role="function">
<title>poppler_form_field_text_is_password ()</title>
<indexterm zone="poppler-form-field-text-is-password"><primary sortas="poppler_form_field_text_is_password">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>
<para>
Checks whether content of <parameter>field</parameter> is a password and it must be hidden</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>field</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="PopplerFormField"><type>PopplerFormField</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if the content of <parameter>field</parameter> is a password
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="poppler-form-field-text-is-rich-text" role="function">
<title>poppler_form_field_text_is_rich_text ()</title>
<indexterm zone="poppler-form-field-text-is-rich-text"><primary sortas="poppler_form_field_text_is_rich_text">poppler_form_field_text_is_rich_text</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            poppler_form_field_text_is_rich_text
                                                        (<link linkend="PopplerFormField">PopplerFormField</link> *field);</programlisting>
<para>
Checks whether the contents of <parameter>field</parameter> are rich text</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>field</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="PopplerFormField"><type>PopplerFormField</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if the contents of <parameter>field</parameter> are rich text
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="poppler-form-field-text-set-text" role="function">
<title>poppler_form_field_text_set_text ()</title>
<indexterm zone="poppler-form-field-text-set-text"><primary sortas="poppler_form_field_text_set_text">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,
                                                         const <link linkend="gchar">gchar</link> *text);</programlisting>
<para>
Sets the text in <parameter>field</parameter> to the given value, replacing the current contents.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>field</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="PopplerFormField"><type>PopplerFormField</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>text</parameter>&#160;:</term>
<listitem><simpara> the new text
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>




</refentry>
