Struct poppler::FormField

pub struct FormField { /* private fields */ }

GLib type: GObject with reference counted clone semantics.

Implementations

impl FormField

pub fn button_get_button_type(&self) -> FormButtonType

Gets the button type of self

Returns

FormButtonType of self

pub fn button_get_state(&self) -> bool

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

Returns

current state of self

pub fn button_set_state(&self, state: bool)

Sets the status of self. Set to true if you want the FormField to be ‘pressed in’, and false to raise it.

state

true or false

pub fn choice_can_select_multiple(&self) -> bool

Checks whether self allows multiple choices to be selected

Returns

true if self allows multiple choices to be selected

pub fn choice_commit_on_change(&self) -> bool

pub fn choice_do_spell_check(&self) -> bool

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

Returns

true if spell checking should be done for self

pub fn choice_get_choice_type(&self) -> FormChoiceType

Gets the choice type of self

Returns

FormChoiceType of self

pub fn choice_get_item(&self, index: i32) -> Option<GString>

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

index

the index of the item

Returns

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

pub fn choice_get_n_items(&self) -> i32

Returns the number of items on self

Returns

the number of items on self

pub fn choice_get_text(&self) -> Option<GString>

Retrieves the contents of self.

Returns

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

pub fn choice_is_editable(&self) -> bool

Checks whether self is editable

Returns

true if self is editable

pub fn choice_is_item_selected(&self, index: i32) -> bool

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

index

the index of the item

Returns

true if item at index is currently selected

pub fn choice_select_item(&self, index: i32)

Selects the item at the given index on self

index

the index of the item

pub fn choice_set_text(&self, text: &str)

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

text

the new text

pub fn choice_toggle_item(&self, index: i32)

Changes the state of the item at the given index

index

the index of the item

pub fn choice_unselect_all(&self)

Unselects all the items on self

pub fn alternate_ui_name(&self) -> Option<GString>

Available on crate feature v0_88 only.

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

Returns

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

pub fn field_type(&self) -> FormFieldType

Gets the type of self

Returns

FormFieldType of self

pub fn font_size(&self) -> f64

Gets the font size of self

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

Returns

the font size of self

pub fn id(&self) -> i32

Gets the id of self

Returns

the id of self

pub fn mapping_name(&self) -> Option<GString>

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

Returns

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

pub fn name(&self) -> Option<GString>

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

Returns

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

pub fn partial_name(&self) -> Option<GString>

Gets the partial name of self.

Returns

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

pub fn is_read_only(&self) -> bool

Checks whether self is read only

Returns

true if self is read only

pub fn signature_validate_async<P: FnOnce(Result<SignatureInfo, Error>) + 'static>( &self, flags: SignatureValidationFlags, cancellable: Option<&impl IsA<Cancellable>>, callback: P, )

Available on crate feature v21_12 only.

Asynchronously validates the cryptographic signature contained in signature_field.

flags

SignatureValidationFlags flags influencing process of validation of the field signature

cancellable

optional [gio::Cancellable][crate::gio::Cancellable] object

callback

a GAsyncReadyCallback to call when the signature is validated

pub fn signature_validate_future( &self, flags: SignatureValidationFlags, ) -> Pin<Box_<dyn Future<Output = Result<SignatureInfo, Error>> + 'static>>

Available on crate feature v21_12 only.

pub fn signature_validate_sync( &self, flags: SignatureValidationFlags, cancellable: Option<&impl IsA<Cancellable>>, ) -> Result<SignatureInfo, Error>

Available on crate feature v21_12 only.

Synchronously validates the cryptographic signature contained in signature_field.

flags

SignatureValidationFlags flags influencing process of validation of the field signature

cancellable

optional [gio::Cancellable][crate::gio::Cancellable] object

Returns

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

pub fn text_do_scroll(&self) -> bool

pub fn text_do_spell_check(&self) -> bool

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

Returns

true if spell checking should be done for self

pub fn text_get_max_len(&self) -> i32

Retrieves the maximum allowed length of the text in self

Returns

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

pub fn text_get_text(&self) -> Option<GString>

Retrieves the contents of self.

Returns

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

pub fn text_get_text_type(&self) -> FormTextType

Gets the text type of self.

Returns

FormTextType of self

pub fn text_is_password(&self) -> bool

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

Returns

true if the content of self is a password

pub fn text_is_rich_text(&self) -> bool

Checks whether the contents of self are rich text

Returns

true if the contents of self are rich text

pub fn text_set_text(&self, text: &str)

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

text

the new text

Trait Implementations

impl Clone for FormField

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FormField

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl HasParamSpec for FormField

type ParamSpec = ParamSpecObject

type SetValue = FormField

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, FormField>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for FormField

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Hashes the memory address of this object.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for FormField

fn cmp(&self, other: &Self) -> Ordering

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl ParentClassIs for FormField

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for FormField

fn eq(&self, other: &OT) -> bool

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for FormField

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for FormField

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for FormField