pdfkit-rs 0.2.1

Safe Rust bindings for Apple's PDFKit framework — documents, pages, selections, outlines, annotations, destinations, actions, and view state on macOS
Documentation 
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
101
102
103
104
105
106
107
108
109
110
111

use std::ptr;

use crate::error::Result;
use crate::ffi;
use crate::handle::ObjectHandle;
use crate::types::{PdfAppearanceCharacteristicsInfo, PdfColor, PdfWidgetControlType};
use crate::util::{option_c_string, parse_json};

#[derive(Debug, Clone)]
pub struct PdfAppearanceCharacteristics {
    handle: ObjectHandle,
}

impl PdfAppearanceCharacteristics {
    pub(crate) fn from_handle(handle: ObjectHandle) -> Self {
        Self { handle }
    }

    pub fn new() -> Result<Self> {
        let mut out_value = ptr::null_mut();
        let mut out_error = ptr::null_mut();
        let status = unsafe {
            ffi::pdf_appearance_characteristics_new(&mut out_value, &mut out_error)
        };
        crate::util::status_result(status, out_error)?;
        Ok(Self::from_handle(crate::util::required_handle(
            out_value,
            "PDFAppearanceCharacteristics",
        )?))
    }

    pub fn info(&self) -> Result<PdfAppearanceCharacteristicsInfo> {
        parse_json(
            unsafe { ffi::pdf_appearance_characteristics_info_json(self.handle.as_ptr()) },
            "PDFAppearanceCharacteristics",
        )
    }

    pub fn set_control_type(&self, control_type: PdfWidgetControlType) -> Result<()> {
        let mut out_error = ptr::null_mut();
        let status = unsafe {
            ffi::pdf_appearance_characteristics_set_control_type(
                self.handle.as_ptr(),
                control_type as i32,
                &mut out_error,
            )
        };
        crate::util::status_result(status, out_error)
    }

    pub fn set_rotation(&self, rotation: i32) {
        unsafe { ffi::pdf_appearance_characteristics_set_rotation(self.handle.as_ptr(), rotation) };
    }

    pub fn set_caption(&self, caption: Option<&str>) -> Result<()> {
        let caption = option_c_string(caption)?;
        unsafe {
            ffi::pdf_appearance_characteristics_set_caption(
                self.handle.as_ptr(),
                caption.as_ref().map_or(ptr::null(), |value| value.as_ptr()),
            );
        };
        Ok(())
    }

    pub fn set_rollover_caption(&self, caption: Option<&str>) -> Result<()> {
        let caption = option_c_string(caption)?;
        unsafe {
            ffi::pdf_appearance_characteristics_set_rollover_caption(
                self.handle.as_ptr(),
                caption.as_ref().map_or(ptr::null(), |value| value.as_ptr()),
            );
        };
        Ok(())
    }

    pub fn set_down_caption(&self, caption: Option<&str>) -> Result<()> {
        let caption = option_c_string(caption)?;
        unsafe {
            ffi::pdf_appearance_characteristics_set_down_caption(
                self.handle.as_ptr(),
                caption.as_ref().map_or(ptr::null(), |value| value.as_ptr()),
            );
        };
        Ok(())
    }

    pub fn set_background_color(&self, color: PdfColor) {
        unsafe {
            ffi::pdf_appearance_characteristics_set_background_color(
                self.handle.as_ptr(),
                color.red,
                color.green,
                color.blue,
                color.alpha,
            );
        };
    }

    pub fn set_border_color(&self, color: PdfColor) {
        unsafe {
            ffi::pdf_appearance_characteristics_set_border_color(
                self.handle.as_ptr(),
                color.red,
                color.green,
                color.blue,
                color.alpha,
            );
        };
    }
}