![]() |
![]() |
![]() |
Poppler Reference Manual | ![]() |
---|---|---|---|---|
PopplerFormField; enum PopplerFormButtonType; enum PopplerFormChoiceType; enum PopplerFormFieldType; enum PopplerFormTextType; gint poppler_form_field_get_id (PopplerFormField *field); PopplerFormFieldType poppler_form_field_get_field_type (PopplerFormField *field); gboolean poppler_form_field_is_read_only (PopplerFormField *field); gdouble poppler_form_field_get_font_size (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); 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); PopplerFormChoiceType poppler_form_field_choice_get_choice_type (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); 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_set_text (PopplerFormField *field, const gchar *text); void poppler_form_field_choice_toggle_item (PopplerFormField *field, gint index); void poppler_form_field_choice_unselect_all (PopplerFormField *field); gboolean poppler_form_field_text_do_scroll (PopplerFormField *field); gboolean poppler_form_field_text_do_spell_check (PopplerFormField *field); gint poppler_form_field_text_get_max_len (PopplerFormField *field); gchar* poppler_form_field_text_get_text (PopplerFormField *field); PopplerFormTextType poppler_form_field_text_get_text_type (PopplerFormField *field); gboolean poppler_form_field_text_is_password (PopplerFormField *field); gboolean poppler_form_field_text_is_rich_text (PopplerFormField *field); void poppler_form_field_text_set_text (PopplerFormField *field, const gchar *text);
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_FIELD_UNKNOWN, POPPLER_FORM_FIELD_BUTTON, POPPLER_FORM_FIELD_TEXT, POPPLER_FORM_FIELD_CHOICE, POPPLER_FORM_FIELD_SIGNATURE } PopplerFormFieldType;
typedef enum { POPPLER_FORM_TEXT_NORMAL, POPPLER_FORM_TEXT_MULTILINE, POPPLER_FORM_TEXT_FILE_SELECT } PopplerFormTextType;
gint poppler_form_field_get_id (PopplerFormField *field);
Gets the id of field
field : | a PopplerFormField |
Returns : | the id of field |
PopplerFormFieldType poppler_form_field_get_field_type (PopplerFormField *field);
Gets the type of field
field : | a PopplerFormField |
Returns : | PopplerFormFieldType of field |
gboolean poppler_form_field_is_read_only (PopplerFormField *field);
Checks whether field is read only
field : | a PopplerFormField |
Returns : | TRUE if field is read only |
gdouble poppler_form_field_get_font_size (PopplerFormField *field);
Gets the font size of field
field : | a PopplerFormField |
Returns : | the font size of field |
PopplerFormButtonType poppler_form_field_button_get_button_type (PopplerFormField *field);
Gets the button type of field
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.
field : | 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.
field : | a PopplerFormField |
state : | TRUE or FALSE |
gboolean poppler_form_field_choice_can_select_multiple (PopplerFormField *field);
Checks whether field allows multiple choices to be selected
field : | a PopplerFormField |
Returns : | TRUE if field allows multiple choices to be selected |
gboolean poppler_form_field_choice_commit_on_change (PopplerFormField *field);
field : | |
Returns : |
gboolean poppler_form_field_choice_do_spell_check (PopplerFormField *field);
Checks whether spell checking should be done for the contents of field
field : | a PopplerFormField |
Returns : | TRUE if spell checking should be done for field |
PopplerFormChoiceType poppler_form_field_choice_get_choice_type (PopplerFormField *field);
Gets the choice type of field
field : | a PopplerFormField |
Returns : | PopplerFormChoiceType of field |
gchar* poppler_form_field_choice_get_item (PopplerFormField *field, gint index);
Returns the contents of the item on field at the given index
field : | a PopplerFormField |
index : | 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
field : | a PopplerFormField |
Returns : | the number of items on field |
gchar* poppler_form_field_choice_get_text (PopplerFormField *field);
Retrieves the contents of field.
field : | a PopplerFormField |
Returns : | a new allocated string. It must be freed with g_free() when done. |
gboolean poppler_form_field_choice_is_editable (PopplerFormField *field);
Checks whether field is editable
field : | a PopplerFormField |
Returns : | TRUE if field is 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
field : | a PopplerFormField |
index : | the index of the item |
Returns : | TRUE if item at index is currently selected |
void poppler_form_field_choice_select_item (PopplerFormField *field, gint index);
Selects the item at the given index on field
field : | a PopplerFormField |
index : | the index of the item |
void poppler_form_field_choice_set_text (PopplerFormField *field, const gchar *text);
field : | |
text : |
void poppler_form_field_choice_toggle_item (PopplerFormField *field, gint index);
Sets the text in field to the given value, replacing the current contents
field : | a PopplerFormField |
index : |
void poppler_form_field_choice_unselect_all (PopplerFormField *field);
Unselects all the items on field
field : | a PopplerFormField |
gboolean poppler_form_field_text_do_scroll (PopplerFormField *field);
field : | |
Returns : |
gboolean poppler_form_field_text_do_spell_check (PopplerFormField *field);
Checks whether spell checking should be done for the contents of field
field : | a PopplerFormField |
Returns : | TRUE if spell checking should be done for field |
gint poppler_form_field_text_get_max_len (PopplerFormField *field);
Retrieves the maximum allowed length of the text in field
field : | a PopplerFormField |
Returns : | the maximum allowed number of characters in field, or -1 if there is no maximum. |
gchar* poppler_form_field_text_get_text (PopplerFormField *field);
Retrieves the contents of field.
field : | a PopplerFormField |
Returns : | a new allocated string. It must be freed with g_free() when done. |
PopplerFormTextType poppler_form_field_text_get_text_type (PopplerFormField *field);
Gets the text type of field.
field : | a PopplerFormField |
Returns : | PopplerFormTextType of field |
gboolean poppler_form_field_text_is_password (PopplerFormField *field);
Checks whether content of field is a password and it must be hidden
field : | a PopplerFormField |
Returns : | TRUE if the content of field is a password |
gboolean poppler_form_field_text_is_rich_text (PopplerFormField *field);
Checks whether the contents of field are rich text
field : | a PopplerFormField |
Returns : | TRUE if the contents of field are rich text |
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.
field : | a PopplerFormField |
text : | the new text |