objc2_web_kit/generated/
WKSnapshotConfiguration.rs

1//! This file has been automatically generated by `objc2`'s `header-translator`.
2//! DO NOT EDIT
3use core::ffi::*;
4use core::ptr::NonNull;
5use objc2::__framework_prelude::*;
6#[cfg(feature = "objc2-core-foundation")]
7use objc2_core_foundation::*;
8use objc2_foundation::*;
9
10use crate::*;
11
12extern_class!(
13    /// [Apple's documentation](https://developer.apple.com/documentation/webkit/wksnapshotconfiguration?language=objc)
14    #[unsafe(super(NSObject))]
15    #[thread_kind = MainThreadOnly]
16    #[derive(Debug, PartialEq, Eq, Hash)]
17    pub struct WKSnapshotConfiguration;
18);
19
20extern_conformance!(
21    unsafe impl NSCopying for WKSnapshotConfiguration {}
22);
23
24unsafe impl CopyingHelper for WKSnapshotConfiguration {
25    type Result = Self;
26}
27
28extern_conformance!(
29    unsafe impl NSObjectProtocol for WKSnapshotConfiguration {}
30);
31
32impl WKSnapshotConfiguration {
33    extern_methods!(
34        #[cfg(feature = "objc2-core-foundation")]
35        /// The rect to snapshot in view coordinates.
36        ///
37        /// This rect should be contained within WKWebView's bounds. If the rect is set to the
38        /// null rect, the view's bounds will be used. The initial value is the null rect.
39        #[unsafe(method(rect))]
40        #[unsafe(method_family = none)]
41        pub unsafe fn rect(&self) -> CGRect;
42
43        #[cfg(feature = "objc2-core-foundation")]
44        /// Setter for [`rect`][Self::rect].
45        #[unsafe(method(setRect:))]
46        #[unsafe(method_family = none)]
47        pub unsafe fn setRect(&self, rect: CGRect);
48
49        /// Specify a custom width to control the size of image you get back. The height will be
50        /// computed to maintain the aspect ratio established by rect.
51        ///
52        /// snapshotWidth represents the width in points. If the snapshotWidth is nil, rect's
53        /// width will be used.
54        #[unsafe(method(snapshotWidth))]
55        #[unsafe(method_family = none)]
56        pub unsafe fn snapshotWidth(&self) -> Option<Retained<NSNumber>>;
57
58        /// Setter for [`snapshotWidth`][Self::snapshotWidth].
59        ///
60        /// This is [copied][objc2_foundation::NSCopying::copy] when set.
61        #[unsafe(method(setSnapshotWidth:))]
62        #[unsafe(method_family = none)]
63        pub unsafe fn setSnapshotWidth(&self, snapshot_width: Option<&NSNumber>);
64
65        /// A Boolean value that specifies whether the snapshot should be taken after recent
66        /// changes have been incorporated. The value NO will capture the screen in its current state,
67        /// which might not include recent changes.
68        ///
69        /// The default value is YES.
70        #[unsafe(method(afterScreenUpdates))]
71        #[unsafe(method_family = none)]
72        pub unsafe fn afterScreenUpdates(&self) -> bool;
73
74        /// Setter for [`afterScreenUpdates`][Self::afterScreenUpdates].
75        #[unsafe(method(setAfterScreenUpdates:))]
76        #[unsafe(method_family = none)]
77        pub unsafe fn setAfterScreenUpdates(&self, after_screen_updates: bool);
78    );
79}
80
81/// Methods declared on superclass `NSObject`.
82impl WKSnapshotConfiguration {
83    extern_methods!(
84        #[unsafe(method(init))]
85        #[unsafe(method_family = init)]
86        pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>;
87
88        #[unsafe(method(new))]
89        #[unsafe(method_family = new)]
90        pub unsafe fn new(mtm: MainThreadMarker) -> Retained<Self>;
91    );
92}
objc2_web_kit/generated/WKSnapshotConfiguration.rs

objc2_web_kit/generated/
WKSnapshotConfiguration.rs
