objc2_pdf_kit/generated/
PDFAppearanceCharacteristics.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-app-kit")]
7#[cfg(target_os = "macos")]
8use objc2_app_kit::*;
9use objc2_foundation::*;
10
11use crate::*;
12
13/// [Apple's documentation](https://developer.apple.com/documentation/pdfkit/pdfappearancecharacteristicskey?language=objc)
14// NS_TYPED_ENUM
15pub type PDFAppearanceCharacteristicsKey = NSString;
16
17extern "C" {
18    /// [Apple's documentation](https://developer.apple.com/documentation/pdfkit/pdfappearancecharacteristicskeybackgroundcolor?language=objc)
19    pub static PDFAppearanceCharacteristicsKeyBackgroundColor:
20        &'static PDFAppearanceCharacteristicsKey;
21}
22
23extern "C" {
24    /// [Apple's documentation](https://developer.apple.com/documentation/pdfkit/pdfappearancecharacteristicskeybordercolor?language=objc)
25    pub static PDFAppearanceCharacteristicsKeyBorderColor: &'static PDFAppearanceCharacteristicsKey;
26}
27
28extern "C" {
29    /// [Apple's documentation](https://developer.apple.com/documentation/pdfkit/pdfappearancecharacteristicskeyrotation?language=objc)
30    pub static PDFAppearanceCharacteristicsKeyRotation: &'static PDFAppearanceCharacteristicsKey;
31}
32
33extern "C" {
34    /// [Apple's documentation](https://developer.apple.com/documentation/pdfkit/pdfappearancecharacteristicskeycaption?language=objc)
35    pub static PDFAppearanceCharacteristicsKeyCaption: &'static PDFAppearanceCharacteristicsKey;
36}
37
38extern "C" {
39    /// [Apple's documentation](https://developer.apple.com/documentation/pdfkit/pdfappearancecharacteristicskeyrollovercaption?language=objc)
40    pub static PDFAppearanceCharacteristicsKeyRolloverCaption:
41        &'static PDFAppearanceCharacteristicsKey;
42}
43
44extern "C" {
45    /// [Apple's documentation](https://developer.apple.com/documentation/pdfkit/pdfappearancecharacteristicskeydowncaption?language=objc)
46    pub static PDFAppearanceCharacteristicsKeyDownCaption: &'static PDFAppearanceCharacteristicsKey;
47}
48
49extern_class!(
50    /// [Apple's documentation](https://developer.apple.com/documentation/pdfkit/pdfappearancecharacteristics?language=objc)
51    #[unsafe(super(NSObject))]
52    #[derive(Debug, PartialEq, Eq, Hash)]
53    pub struct PDFAppearanceCharacteristics;
54);
55
56extern_conformance!(
57    unsafe impl NSCopying for PDFAppearanceCharacteristics {}
58);
59
60unsafe impl CopyingHelper for PDFAppearanceCharacteristics {
61    type Result = Self;
62}
63
64extern_conformance!(
65    unsafe impl NSObjectProtocol for PDFAppearanceCharacteristics {}
66);
67
68impl PDFAppearanceCharacteristics {
69    extern_methods!(
70        #[cfg(feature = "PDFAnnotationUtilities")]
71        #[unsafe(method(controlType))]
72        #[unsafe(method_family = none)]
73        pub unsafe fn controlType(&self) -> PDFWidgetControlType;
74
75        #[cfg(feature = "PDFAnnotationUtilities")]
76        /// Setter for [`controlType`][Self::controlType].
77        #[unsafe(method(setControlType:))]
78        #[unsafe(method_family = none)]
79        pub unsafe fn setControlType(&self, control_type: PDFWidgetControlType);
80
81        #[cfg(feature = "objc2-app-kit")]
82        #[cfg(target_os = "macos")]
83        #[unsafe(method(backgroundColor))]
84        #[unsafe(method_family = none)]
85        pub unsafe fn backgroundColor(&self) -> Option<Retained<NSColor>>;
86
87        #[cfg(feature = "objc2-app-kit")]
88        #[cfg(target_os = "macos")]
89        /// Setter for [`backgroundColor`][Self::backgroundColor].
90        ///
91        /// This is [copied][objc2_foundation::NSCopying::copy] when set.
92        #[unsafe(method(setBackgroundColor:))]
93        #[unsafe(method_family = none)]
94        pub unsafe fn setBackgroundColor(&self, background_color: Option<&NSColor>);
95
96        #[cfg(feature = "objc2-app-kit")]
97        #[cfg(target_os = "macos")]
98        #[unsafe(method(borderColor))]
99        #[unsafe(method_family = none)]
100        pub unsafe fn borderColor(&self) -> Option<Retained<NSColor>>;
101
102        #[cfg(feature = "objc2-app-kit")]
103        #[cfg(target_os = "macos")]
104        /// Setter for [`borderColor`][Self::borderColor].
105        ///
106        /// This is [copied][objc2_foundation::NSCopying::copy] when set.
107        #[unsafe(method(setBorderColor:))]
108        #[unsafe(method_family = none)]
109        pub unsafe fn setBorderColor(&self, border_color: Option<&NSColor>);
110
111        #[unsafe(method(rotation))]
112        #[unsafe(method_family = none)]
113        pub unsafe fn rotation(&self) -> NSInteger;
114
115        /// Setter for [`rotation`][Self::rotation].
116        #[unsafe(method(setRotation:))]
117        #[unsafe(method_family = none)]
118        pub unsafe fn setRotation(&self, rotation: NSInteger);
119
120        #[unsafe(method(caption))]
121        #[unsafe(method_family = none)]
122        pub unsafe fn caption(&self) -> Option<Retained<NSString>>;
123
124        /// Setter for [`caption`][Self::caption].
125        ///
126        /// This is [copied][objc2_foundation::NSCopying::copy] when set.
127        #[unsafe(method(setCaption:))]
128        #[unsafe(method_family = none)]
129        pub unsafe fn setCaption(&self, caption: Option<&NSString>);
130
131        #[unsafe(method(rolloverCaption))]
132        #[unsafe(method_family = none)]
133        pub unsafe fn rolloverCaption(&self) -> Option<Retained<NSString>>;
134
135        /// Setter for [`rolloverCaption`][Self::rolloverCaption].
136        ///
137        /// This is [copied][objc2_foundation::NSCopying::copy] when set.
138        #[unsafe(method(setRolloverCaption:))]
139        #[unsafe(method_family = none)]
140        pub unsafe fn setRolloverCaption(&self, rollover_caption: Option<&NSString>);
141
142        #[unsafe(method(downCaption))]
143        #[unsafe(method_family = none)]
144        pub unsafe fn downCaption(&self) -> Option<Retained<NSString>>;
145
146        /// Setter for [`downCaption`][Self::downCaption].
147        ///
148        /// This is [copied][objc2_foundation::NSCopying::copy] when set.
149        #[unsafe(method(setDownCaption:))]
150        #[unsafe(method_family = none)]
151        pub unsafe fn setDownCaption(&self, down_caption: Option<&NSString>);
152
153        #[unsafe(method(appearanceCharacteristicsKeyValues))]
154        #[unsafe(method_family = none)]
155        pub unsafe fn appearanceCharacteristicsKeyValues(&self) -> Retained<NSDictionary>;
156    );
157}
158
159/// Methods declared on superclass `NSObject`.
160impl PDFAppearanceCharacteristics {
161    extern_methods!(
162        #[unsafe(method(init))]
163        #[unsafe(method_family = init)]
164        pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>;
165
166        #[unsafe(method(new))]
167        #[unsafe(method_family = new)]
168        pub unsafe fn new() -> Retained<Self>;
169    );
170}