1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
//! Defines the [PdfFormListBoxField] struct, exposing functionality related to a single
//! form field of type `PdfFormFieldType::ListBox`.
use crate::bindgen::{FPDF_ANNOTATION, FPDF_FORMHANDLE};
use crate::bindings::PdfiumLibraryBindings;
use crate::form_field_options::PdfFormFieldOptions;
use crate::form_field_private::internal::PdfFormFieldPrivate;
/// A single `PdfFormField` of type `PdfFormFieldType::ListBox`. The form field object defines
/// an interactive drop-down list widget that allows the user to select a value from
/// a list of options.
///
/// Form fields in Pdfium are wrapped inside page annotations of type `PdfPageAnnotationType::Widget`
/// or `PdfPageAnnotationType::XfaWidget`. User-specified values can be retrieved directly from
/// each form field object by unwrapping the form field from the annotation, or in bulk from the
/// `PdfForm::field_values()` function.
pub struct PdfFormListBoxField<'a> {
form_handle: FPDF_FORMHANDLE,
annotation_handle: FPDF_ANNOTATION,
options: PdfFormFieldOptions<'a>,
bindings: &'a dyn PdfiumLibraryBindings,
}
impl<'a> PdfFormListBoxField<'a> {
#[inline]
pub(crate) fn from_pdfium(
form_handle: FPDF_FORMHANDLE,
annotation_handle: FPDF_ANNOTATION,
bindings: &'a dyn PdfiumLibraryBindings,
) -> Self {
PdfFormListBoxField {
form_handle,
annotation_handle,
options: PdfFormFieldOptions::from_pdfium(form_handle, annotation_handle, bindings),
bindings,
}
}
/// Returns the [PdfiumLibraryBindings] used by this [PdfFormListBoxField] object.
#[inline]
pub fn bindings(&self) -> &'a dyn PdfiumLibraryBindings {
self.bindings
}
/// Returns the collection of selectable options in this [PdfFormListBoxField].
pub fn options(&self) -> &PdfFormFieldOptions {
&self.options
}
/// Returns the displayed label for the currently selected option in this [PdfFormListBoxField] object, if any.
#[inline]
pub fn value(&self) -> Option<String> {
self.options()
.iter()
.find(|option| option.is_set())
.and_then(|option| option.label().cloned())
}
}
impl<'a> PdfFormFieldPrivate<'a> for PdfFormListBoxField<'a> {
#[inline]
fn form_handle(&self) -> &FPDF_FORMHANDLE {
&self.form_handle
}
#[inline]
fn annotation_handle(&self) -> &FPDF_ANNOTATION {
&self.annotation_handle
}
#[inline]
fn bindings(&self) -> &dyn PdfiumLibraryBindings {
self.bindings
}
}