Class: Poppler::FormField

Inherits:

Object

• Object
• Poppler::FormField

Defined in:

(unknown)

Instance Method Summary

• #action ⇒ Poppler::Action

  Retrieves the action (Poppler::Action) that shall be performed when field is activated, or nil.

• #alternate_ui_name ⇒ String

  Gets the alternate ui name of field.

• #button_get_button_type ⇒ Poppler::FormButtonType

  Gets the button type of field.

• #button_get_state ⇒ Boolean

  Queries a Poppler::FormField and returns its current state.

• #button_set_state(state) ⇒ nil

  Sets the status of field.

• #choice_can_select_multiple ⇒ Boolean

  Checks whether field allows multiple choices to be selected.

• #choice_commit_on_change ⇒ Boolean
• #choice_do_spell_check ⇒ Boolean

  Checks whether spell checking should be done for the contents of field.

• #choice_get_choice_type ⇒ Poppler::FormChoiceType

  Gets the choice type of field.

• #choice_get_item(index) ⇒ String

  Returns the contents of the item on field at the given index.

• #choice_get_n_items ⇒ Integer

  Returns the number of items on field.

• #choice_get_text ⇒ String

  Retrieves the contents of field.

• #choice_is_editable ⇒ Boolean

  Checks whether field is editable.

• #choice_is_item_selected(index) ⇒ Boolean

  Checks whether the item at the given index on field is currently selected.

• #choice_select_item(index) ⇒ nil

  Selects the item at the given index on field.

• #choice_set_text(text) ⇒ nil

  Sets the text in field to the given value, replacing the current contents.

• #choice_toggle_item(index) ⇒ nil

  Changes the state of the item at the given index.

• #choice_unselect_all ⇒ nil

  Unselects all the items on field.

• #field_type ⇒ Poppler::FormFieldType

  Gets the type of field.

• #font_size ⇒ Float

  Gets the font size of field.

• #get_additional_action(type) ⇒ Poppler::Action

  Retrieves the action (Poppler::Action) that shall be performed when an additional action is triggered on field, or nil.

• #id ⇒ Integer

  Gets the id of field.

• #is_read_only ⇒ Boolean

  Checks whether field is read only.

• #mapping_name ⇒ String

  Gets the mapping name of field that is used when exporting interactive form field data from the document.

• #name ⇒ String

  Gets the fully qualified name of field.

• #partial_name ⇒ String

  Gets the partial name of field.

• #signature_validate_async(flags, cancellable, callback, user_data) ⇒ nil

  Asynchronously validates the cryptographic signature contained in signature_field.

• #signature_validate_finish(result) ⇒ Poppler::SignatureInfo

  Finishes validation of the cryptographic signature contained in signature_field.

• #signature_validate_sync(flags, cancellable) ⇒ Poppler::SignatureInfo

  Synchronously validates the cryptographic signature contained in signature_field.

• #text_do_scroll ⇒ Boolean
• #text_do_spell_check ⇒ Boolean

  Checks whether spell checking should be done for the contents of field.

• #text_get_max_len ⇒ Integer

  Retrieves the maximum allowed length of the text in field.

• #text_get_text ⇒ String

  Retrieves the contents of field.

• #text_get_text_type ⇒ Poppler::FormTextType

  Gets the text type of field.

• #text_is_password ⇒ Boolean

  Checks whether content of field is a password and it must be hidden.

• #text_is_rich_text ⇒ Boolean

  Checks whether the contents of field are rich text.

• #text_set_text(text) ⇒ nil

  Sets the text in field to the given value, replacing the current contents.

Instance Method Details

#action ⇒ Poppler::Action

Retrieves the action (Poppler::Action) that shall be performed when field is activated, or nil

Returns:

• (Poppler::Action) —

  the action to perform. The returned object is owned by field and should not be freed

#alternate_ui_name ⇒ String

Gets the alternate ui name of field. This name is also commonly used by pdf producers/readers to show it as a tooltip when field area is hovered by a pointing device (eg. mouse).

Returns:

• (String) —

  a new allocated string. It must be freed with g_free() when done.

#button_get_button_type ⇒ Poppler::FormButtonType

Gets the button type of field

Returns:

• (Poppler::FormButtonType) —

  Poppler::FormButtonType of field

#button_get_state ⇒ Boolean

Queries a Poppler::FormField and returns its current state. Returns true if field is pressed in and false if it is raised.

Returns:

• (Boolean) —

  current state of field

#button_set_state(state) ⇒ nil

Sets the status of field. Set to true if you want the Poppler::FormField to be 'pressed in', and false to raise it.

Parameters:

• state (Boolean) —

  true or false

Returns:

• (nil)

#choice_can_select_multiple ⇒ Boolean

Checks whether field allows multiple choices to be selected

Returns:

• (Boolean) —

  true if field allows multiple choices to be selected

#choice_commit_on_change ⇒ Boolean

Returns:

• (Boolean)

#choice_do_spell_check ⇒ Boolean

Checks whether spell checking should be done for the contents of field

Returns:

• (Boolean) —

  true if spell checking should be done for field

#choice_get_choice_type ⇒ Poppler::FormChoiceType

Gets the choice type of field

Returns:

• (Poppler::FormChoiceType) —

  Poppler::FormChoiceType of field

#choice_get_item(index) ⇒ String

Returns the contents of the item on field at the given index

Parameters:

• index (Integer) —

  the index of the item

Returns:

• (String) —

  a new allocated string. It must be freed with g_free() when done.

#choice_get_n_items ⇒ Integer

Returns the number of items on field

Returns:

• (Integer) —

  the number of items on field

#choice_get_text ⇒ String

Retrieves the contents of field.

Returns:

• (String) —

  a new allocated string. It must be freed with g_free() when done.

#choice_is_editable ⇒ Boolean

Checks whether field is editable

Returns:

• (Boolean) —

  true if field is editable

#choice_is_item_selected(index) ⇒ Boolean

Checks whether the item at the given index on field is currently selected

Parameters:

• index (Integer) —

  the index of the item

Returns:

• (Boolean) —

  true if item at index is currently selected

#choice_select_item(index) ⇒ nil

Selects the item at the given index on field

Parameters:

• index (Integer) —

  the index of the item

Returns:

• (nil)

#choice_set_text(text) ⇒ nil

Sets the text in field to the given value, replacing the current contents

Parameters:

• text (String) —

  the new text

Returns:

• (nil)

#choice_toggle_item(index) ⇒ nil

Changes the state of the item at the given index

Parameters:

• index (Integer) —

  the index of the item

Returns:

• (nil)

#choice_unselect_all ⇒ nil

Unselects all the items on field

Returns:

• (nil)

#field_type ⇒ Poppler::FormFieldType

Gets the type of field

Returns:

• (Poppler::FormFieldType) —

  Poppler::FormFieldType of field

#font_size ⇒ Float

Gets the font size of field

WARNING: This function always returns 0. Contact the poppler mailing list if you're interested in implementing it properly

Returns:

• (Float) —

  the font size of field

#get_additional_action(type) ⇒ Poppler::Action

Retrieves the action (Poppler::Action) that shall be performed when an additional action is triggered on field, or nil.

Parameters:

• type (Poppler::AdditionalActionType) —

  the type of additional action

Returns:

• (Poppler::Action) —

  the action to perform. The returned object is owned by field and should not be freed.

#id ⇒ Integer

Gets the id of field

Returns:

• (Integer) —

  the id of field

#is_read_only ⇒ Boolean

Checks whether field is read only

Returns:

• (Boolean) —

  true if field is read only

#mapping_name ⇒ String

Gets the mapping name of field that is used when exporting interactive form field data from the document

Returns:

• (String) —

  a new allocated string. It must be freed with g_free() when done.

#name ⇒ String

Gets the fully qualified name of field. It's constructed by concatenating the partial field names of the field and all of its ancestors.

Returns:

• (String) —

  a new allocated string. It must be freed with g_free() when done.

#partial_name ⇒ String

Gets the partial name of field.

Returns:

• (String) —

  a new allocated string. It must be freed with g_free() when done.

#signature_validate_async(flags, cancellable, callback, user_data) ⇒ nil

Asynchronously validates the cryptographic signature contained in signature_field.

Parameters:

• flags (Poppler::SignatureValidationFlags) —

  Poppler::SignatureValidationFlags flags influencing process of validation of the field signature

• cancellable (Gio::Cancellable) —

  optional #GCancellable object

• callback (Gio::AsyncReadyCallback) —

  a GAsync::ReadyCallback to call when the signature is validated

• user_data (GObject) —

  the data to pass to callback function

Returns:

• (nil)

#signature_validate_finish(result) ⇒ Poppler::SignatureInfo

Finishes validation of the cryptographic signature contained in signature_field. See poppler_form_field_signature_validate_async().

Parameters:

• result (Gio::AsyncResult) —

  a GAsync::Result

Returns:

• (Poppler::SignatureInfo) —

  a Poppler::SignatureInfo structure containing signature metadata and validation status Free the returned structure with poppler_signature_info_free().

#signature_validate_sync(flags, cancellable) ⇒ Poppler::SignatureInfo

Synchronously validates the cryptographic signature contained in signature_field.

Parameters:

• flags (Poppler::SignatureValidationFlags) —

  Poppler::SignatureValidationFlags flags influencing process of validation of the field signature

• cancellable (Gio::Cancellable) —

  optional #GCancellable object

Returns:

• (Poppler::SignatureInfo) —

  a Poppler::SignatureInfo structure containing signature metadata and validation status Free the returned structure with poppler_signature_info_free().

#text_do_scroll ⇒ Boolean

Returns:

• (Boolean)

#text_do_spell_check ⇒ Boolean

Checks whether spell checking should be done for the contents of field

Returns:

• (Boolean) —

  true if spell checking should be done for field

#text_get_max_len ⇒ Integer

Retrieves the maximum allowed length of the text in field

Returns:

• (Integer) —

  the maximum allowed number of characters in field, or -1 if there is no maximum.

#text_get_text ⇒ String

Retrieves the contents of field.

Returns:

• (String) —

  a new allocated string. It must be freed with g_free() when done.

#text_get_text_type ⇒ Poppler::FormTextType

Gets the text type of field.

Returns:

• (Poppler::FormTextType) —

  Poppler::FormTextType of field

#text_is_password ⇒ Boolean

Checks whether content of field is a password and it must be hidden

Returns:

• (Boolean) —

  true if the content of field is a password

#text_is_rich_text ⇒ Boolean

Checks whether the contents of field are rich text

Returns:

• (Boolean) —

  true if the contents of field are rich text

#text_set_text(text) ⇒ nil

Sets the text in field to the given value, replacing the current contents.

Parameters:

• text (String) —

  the new text

Returns:

• (nil)