|  |  |  | Poppler Reference Manual |  | 
|---|---|---|---|---|
| Top | Description | Object Hierarchy | ||||
#include <poppler.h>
                    PopplerFormField;
enum                PopplerFormFieldType;
enum                PopplerFormButtonType;
enum                PopplerFormChoiceType;
enum                PopplerFormTextType;
PopplerFormFieldType poppler_form_field_get_field_type  (PopplerFormField *field);
gint                poppler_form_field_get_id           (PopplerFormField *field);
gboolean            poppler_form_field_is_read_only     (PopplerFormField *field);
gdouble             poppler_form_field_get_font_size    (PopplerFormField *field);
gchar *             poppler_form_field_get_partial_name (PopplerFormField *field);
gchar *             poppler_form_field_get_mapping_name (PopplerFormField *field);
gchar *             poppler_form_field_get_name         (PopplerFormField *field);
PopplerAction *     poppler_form_field_get_action       (PopplerFormField *field);
PopplerFormButtonType poppler_form_field_button_get_button_type
                                                        (PopplerFormField *field);
gboolean            poppler_form_field_button_get_state (PopplerFormField *field);
void                poppler_form_field_button_set_state (PopplerFormField *field,
                                                         gboolean state);
PopplerFormChoiceType poppler_form_field_choice_get_choice_type
                                                        (PopplerFormField *field);
gboolean            poppler_form_field_choice_can_select_multiple
                                                        (PopplerFormField *field);
gboolean            poppler_form_field_choice_commit_on_change
                                                        (PopplerFormField *field);
gboolean            poppler_form_field_choice_do_spell_check
                                                        (PopplerFormField *field);
gchar *             poppler_form_field_choice_get_item  (PopplerFormField *field,
                                                         gint index);
gint                poppler_form_field_choice_get_n_items
                                                        (PopplerFormField *field);
gchar *             poppler_form_field_choice_get_text  (PopplerFormField *field);
void                poppler_form_field_choice_set_text  (PopplerFormField *field,
                                                         const gchar *text);
gboolean            poppler_form_field_choice_is_editable
                                                        (PopplerFormField *field);
gboolean            poppler_form_field_choice_is_item_selected
                                                        (PopplerFormField *field,
                                                         gint index);
void                poppler_form_field_choice_select_item
                                                        (PopplerFormField *field,
                                                         gint index);
void                poppler_form_field_choice_toggle_item
                                                        (PopplerFormField *field,
                                                         gint index);
void                poppler_form_field_choice_unselect_all
                                                        (PopplerFormField *field);
PopplerFormTextType poppler_form_field_text_get_text_type
                                                        (PopplerFormField *field);
gchar *             poppler_form_field_text_get_text    (PopplerFormField *field);
void                poppler_form_field_text_set_text    (PopplerFormField *field,
                                                         const gchar *text);
gint                poppler_form_field_text_get_max_len (PopplerFormField *field);
gboolean            poppler_form_field_text_do_scroll   (PopplerFormField *field);
gboolean            poppler_form_field_text_do_spell_check
                                                        (PopplerFormField *field);
gboolean            poppler_form_field_text_is_password (PopplerFormField *field);
gboolean            poppler_form_field_text_is_rich_text
                                                        (PopplerFormField *field);
typedef enum {
  POPPLER_FORM_FIELD_UNKNOWN,
  POPPLER_FORM_FIELD_BUTTON,
  POPPLER_FORM_FIELD_TEXT,
  POPPLER_FORM_FIELD_CHOICE,
  POPPLER_FORM_FIELD_SIGNATURE
} PopplerFormFieldType;
typedef enum {
  POPPLER_FORM_BUTTON_PUSH,
  POPPLER_FORM_BUTTON_CHECK,
  POPPLER_FORM_BUTTON_RADIO
} PopplerFormButtonType;
typedef enum {
  POPPLER_FORM_CHOICE_COMBO,
  POPPLER_FORM_CHOICE_LIST
} PopplerFormChoiceType;
typedef enum {
  POPPLER_FORM_TEXT_NORMAL,
  POPPLER_FORM_TEXT_MULTILINE,
  POPPLER_FORM_TEXT_FILE_SELECT
} PopplerFormTextType;
PopplerFormFieldType poppler_form_field_get_field_type  (PopplerFormField *field);
Gets the type of field
| 
 | a PopplerFormField | 
| Returns : | PopplerFormFieldType of field | 
gint                poppler_form_field_get_id           (PopplerFormField *field);
Gets the id of field
| 
 | a PopplerFormField | 
| Returns : | the id of field | 
gboolean            poppler_form_field_is_read_only     (PopplerFormField *field);
Checks whether field is read only
| 
 | a PopplerFormField | 
| Returns : | TRUEiffieldis read only | 
gdouble             poppler_form_field_get_font_size    (PopplerFormField *field);
Gets the font size of field
| 
 | a PopplerFormField | 
| Returns : | the font size of field | 
gchar *             poppler_form_field_get_partial_name (PopplerFormField *field);
Gets the partial name of field.
| 
 | a PopplerFormField | 
| Returns : | a new allocated string. It must be freed with g_free()when done. | 
Since 0.16
gchar *             poppler_form_field_get_mapping_name (PopplerFormField *field);
Gets the mapping name of field that is used when
exporting interactive form field data from the document
| 
 | a PopplerFormField | 
| Returns : | a new allocated string. It must be freed with g_free()when done. | 
Since 0.16
gchar *             poppler_form_field_get_name         (PopplerFormField *field);
Gets the fully qualified name of field. It's constructed by concatenating
the partial field names of the field and all of its ancestors.
| 
 | a PopplerFormField | 
| Returns : | a new allocated string. It must be freed with g_free()when done. | 
Since 0.16
PopplerAction *     poppler_form_field_get_action       (PopplerFormField *field);
Retrieves the action (PopplerAction) that shall be
performed when field is activated, or NULL
| 
 | a PopplerFormField | 
| Returns : | the action to perform. The returned
object is owned by fieldand should not be freed. [transfer none] | 
Since 0.18
PopplerFormButtonType poppler_form_field_button_get_button_type
                                                        (PopplerFormField *field);
Gets the button type of field
| 
 | a PopplerFormField | 
| Returns : | PopplerFormButtonType of field | 
gboolean            poppler_form_field_button_get_state (PopplerFormField *field);
Queries a PopplerFormField and returns its current state. Returns TRUE if
field is pressed in and FALSE if it is raised.
| 
 | a PopplerFormField | 
| Returns : | current state of field | 
void poppler_form_field_button_set_state (PopplerFormField *field,gboolean state);
Sets the status of field. Set to TRUE if you want the PopplerFormField
to be 'pressed in', and FALSE to raise it.
| 
 | a PopplerFormField | 
| 
 | TRUEorFALSE | 
PopplerFormChoiceType poppler_form_field_choice_get_choice_type
                                                        (PopplerFormField *field);
Gets the choice type of field
| 
 | a PopplerFormField | 
| Returns : | PopplerFormChoiceType of field | 
gboolean            poppler_form_field_choice_can_select_multiple
                                                        (PopplerFormField *field);
Checks whether field allows multiple choices to be selected
| 
 | a PopplerFormField | 
| Returns : | TRUEiffieldallows multiple choices to be selected | 
gboolean            poppler_form_field_choice_commit_on_change
                                                        (PopplerFormField *field);
gboolean            poppler_form_field_choice_do_spell_check
                                                        (PopplerFormField *field);
Checks whether spell checking should be done for the contents of field
| 
 | a PopplerFormField | 
| Returns : | TRUEif spell checking should be done forfield | 
gchar * poppler_form_field_choice_get_item (PopplerFormField *field,gint index);
Returns the contents of the item on field at the given index
| 
 | a PopplerFormField | 
| 
 | the index of the item | 
| Returns : | a new allocated string. It must be freed with g_free()when done. | 
gint                poppler_form_field_choice_get_n_items
                                                        (PopplerFormField *field);
Returns the number of items on field
| 
 | a PopplerFormField | 
| Returns : | the number of items on field | 
gchar *             poppler_form_field_choice_get_text  (PopplerFormField *field);
Retrieves the contents of field.
| 
 | a PopplerFormField | 
| Returns : | a new allocated string. It must be freed with g_free()when done. | 
void poppler_form_field_choice_set_text (PopplerFormField *field,const gchar *text);
Sets the text in field to the given value, replacing the current contents
| 
 | a PopplerFormField | 
| 
 | the new text | 
gboolean            poppler_form_field_choice_is_editable
                                                        (PopplerFormField *field);
Checks whether field is editable
| 
 | a PopplerFormField | 
| Returns : | TRUEiffieldis editable | 
gboolean poppler_form_field_choice_is_item_selected (PopplerFormField *field,gint index);
Checks whether the item at the given index on field is currently selected
| 
 | a PopplerFormField | 
| 
 | the index of the item | 
| Returns : | TRUEif item atindexis currently selected | 
void poppler_form_field_choice_select_item (PopplerFormField *field,gint index);
Selects the item at the given index on field
| 
 | a PopplerFormField | 
| 
 | the index of the item | 
void poppler_form_field_choice_toggle_item (PopplerFormField *field,gint index);
Changes the state of the item at the given index
| 
 | a PopplerFormField | 
| 
 | the index of the item | 
void                poppler_form_field_choice_unselect_all
                                                        (PopplerFormField *field);
Unselects all the items on field
| 
 | a PopplerFormField | 
PopplerFormTextType poppler_form_field_text_get_text_type
                                                        (PopplerFormField *field);
Gets the text type of field.
| 
 | a PopplerFormField | 
| Returns : | PopplerFormTextType of field | 
gchar *             poppler_form_field_text_get_text    (PopplerFormField *field);
Retrieves the contents of field.
| 
 | a PopplerFormField | 
| Returns : | a new allocated string. It must be freed with g_free()when done. | 
void poppler_form_field_text_set_text (PopplerFormField *field,const gchar *text);
Sets the text in field to the given value, replacing the current contents.
| 
 | a PopplerFormField | 
| 
 | the new text | 
gint                poppler_form_field_text_get_max_len (PopplerFormField *field);
Retrieves the maximum allowed length of the text in field
| 
 | a PopplerFormField | 
| Returns : | the maximum allowed number of characters in field, or -1 if there is no maximum. | 
gboolean            poppler_form_field_text_do_scroll   (PopplerFormField *field);
gboolean            poppler_form_field_text_do_spell_check
                                                        (PopplerFormField *field);
Checks whether spell checking should be done for the contents of field
| 
 | a PopplerFormField | 
| Returns : | TRUEif spell checking should be done forfield | 
gboolean            poppler_form_field_text_is_password (PopplerFormField *field);
Checks whether content of field is a password and it must be hidden
| 
 | a PopplerFormField | 
| Returns : | TRUEif the content offieldis a password | 
gboolean            poppler_form_field_text_is_rich_text
                                                        (PopplerFormField *field);
Checks whether the contents of field are rich text
| 
 | a PopplerFormField | 
| Returns : | TRUEif the contents offieldare rich text |