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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
//! Defines the [PdfFormCheckboxField] struct, exposing functionality related to a single
//! form field of type `PdfFormFieldType::Checkbox`.
use crate::bindgen::{FPDF_ANNOTATION, FPDF_FORMHANDLE};
use crate::bindings::PdfiumLibraryBindings;
use crate::error::PdfiumError;
use crate::form_field_private::internal::PdfFormFieldPrivate;
/// A single `PdfFormField` of type `PdfFormFieldType::Checkbox`. The form field object defines
/// an interactive checkbox widget that can be toggled by the user.
///
/// 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 PdfFormCheckboxField<'a> {
form_handle: FPDF_FORMHANDLE,
annotation_handle: FPDF_ANNOTATION,
bindings: &'a dyn PdfiumLibraryBindings,
}
impl<'a> PdfFormCheckboxField<'a> {
#[inline]
pub(crate) fn from_pdfium(
form_handle: FPDF_FORMHANDLE,
annotation_handle: FPDF_ANNOTATION,
bindings: &'a dyn PdfiumLibraryBindings,
) -> Self {
PdfFormCheckboxField {
form_handle,
annotation_handle,
bindings,
}
}
/// Returns the [PdfiumLibraryBindings] used by this [PdfFormCheckboxField] object.
#[inline]
pub fn bindings(&self) -> &'a dyn PdfiumLibraryBindings {
self.bindings
}
/// Returns the index of this [PdfFormCheckboxField] in its control group.
///
/// Control groups are used to group related interactive fields together. Checkboxes and
/// radio buttons can be grouped such that only a single button can be selected within
/// the control group. Each field within the group has a unique group index.
#[inline]
pub fn index_in_group(&self) -> u32 {
self.index_in_group_impl()
}
/// Returns the value set for the control group containing this [PdfFormCheckboxField].
///
/// Control groups are used to group related interactive fields together. Checkboxes and
/// radio buttons can be grouped such that only a single button can be selected within
/// the control group. In this case, a single value can be shared by the group, indicating
/// the value of the currently selected field within the group.
#[inline]
pub fn group_value(&self) -> Option<String> {
self.value_impl()
}
/// Returns `true` if this [PdfFormCheckboxField] object has its checkbox checked.
#[inline]
pub fn is_checked(&self) -> Result<bool, PdfiumError> {
// The PDF Reference manual, version 1.7, states that an appearance stream of "Yes"
// can be used to indicate a selected checkbox. Pdfium's FPDFAnnot_IsChecked()
// function doesn't check for this; so if FPDFAnnot_IsChecked() comes back with
// anything other than Ok(true), we also check the appearance stream.
match self.is_checked_impl() {
Ok(true) => Ok(true),
Ok(false) => match self.group_value() {
Some(value) => Ok(value == "Yes"),
_ => Ok(false),
},
Err(err) => match self.group_value() {
Some(value) => Ok(value == "Yes"),
_ => Err(err),
},
}
}
}
impl<'a> PdfFormFieldPrivate<'a> for PdfFormCheckboxField<'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
}
}