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

use std::ptr;

use crate::action::{sealed, PdfActionLike};
use crate::error::Result;
use crate::ffi;
use crate::handle::ObjectHandle;
use crate::types::PdfPoint;
use crate::util::{c_string, take_string};

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

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

    pub fn new(page_index: usize, point: PdfPoint, url: &str) -> Result<Self> {
        let url = c_string(url)?;
        let mut out_action = ptr::null_mut();
        let mut out_error = ptr::null_mut();
        let status = unsafe {
            ffi::pdf_action_remote_goto_new(
                page_index as u64,
                point.x,
                point.y,
                url.as_ptr(),
                &mut out_action,
                &mut out_error,
            )
        };
        crate::util::status_result(status, out_error)?;
        Ok(Self::from_handle(crate::util::required_handle(
            out_action,
            "PDFActionRemoteGoTo",
        )?))
    }

    #[must_use]
    pub fn page_index(&self) -> usize {
        unsafe { ffi::pdf_action_remote_goto_page_index(self.handle.as_ptr()) as usize }
    }

    pub fn set_page_index(&self, page_index: usize) {
        unsafe { ffi::pdf_action_remote_goto_set_page_index(self.handle.as_ptr(), page_index as u64) };
    }

    #[must_use]
    pub fn point(&self) -> PdfPoint {
        PdfPoint {
            x: unsafe { ffi::pdf_action_remote_goto_point_x(self.handle.as_ptr()) },
            y: unsafe { ffi::pdf_action_remote_goto_point_y(self.handle.as_ptr()) },
        }
    }

    pub fn set_point(&self, point: PdfPoint) {
        unsafe { ffi::pdf_action_remote_goto_set_point(self.handle.as_ptr(), point.x, point.y) };
    }

    #[must_use]
    pub fn url(&self) -> Option<String> {
        take_string(unsafe { ffi::pdf_action_remote_goto_url_string(self.handle.as_ptr()) })
    }

    pub fn set_url(&self, url: &str) -> Result<()> {
        let url = c_string(url)?;
        let mut out_error = ptr::null_mut();
        let status = unsafe {
            ffi::pdf_action_remote_goto_set_url(self.handle.as_ptr(), url.as_ptr(), &mut out_error)
        };
        crate::util::status_result(status, out_error)
    }

    #[must_use]
    pub fn action_type(&self) -> Option<String> {
        take_string(unsafe { ffi::pdf_action_remote_goto_type_string(self.handle.as_ptr()) })
    }

    pub(crate) fn as_handle_ptr(&self) -> *mut core::ffi::c_void {
        self.handle.as_ptr()
    }
}

impl sealed::Sealed for PdfActionRemoteGoTo {}

impl PdfActionLike for PdfActionRemoteGoTo {
    fn as_action_handle_ptr(&self) -> *mut core::ffi::c_void {
        self.as_handle_ptr()
    }
}