objc2_app_kit/generated/
NSGraphicsContext.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-graphics")]
7#[cfg(target_vendor = "apple")]
8use objc2_core_graphics::*;
9#[cfg(feature = "objc2-core-image")]
10#[cfg(target_vendor = "apple")]
11use objc2_core_image::*;
12use objc2_foundation::*;
13
14use crate::*;
15
16/// [Apple's documentation](https://developer.apple.com/documentation/appkit/nsgraphicscontextattributekey?language=objc)
17// NS_TYPED_ENUM
18pub type NSGraphicsContextAttributeKey = NSString;
19
20extern "C" {
21    /// [Apple's documentation](https://developer.apple.com/documentation/appkit/nsgraphicscontextdestinationattributename?language=objc)
22    pub static NSGraphicsContextDestinationAttributeName: &'static NSGraphicsContextAttributeKey;
23}
24
25extern "C" {
26    /// [Apple's documentation](https://developer.apple.com/documentation/appkit/nsgraphicscontextrepresentationformatattributename?language=objc)
27    pub static NSGraphicsContextRepresentationFormatAttributeName:
28        &'static NSGraphicsContextAttributeKey;
29}
30
31/// [Apple's documentation](https://developer.apple.com/documentation/appkit/nsgraphicscontextrepresentationformatname?language=objc)
32// NS_TYPED_ENUM
33pub type NSGraphicsContextRepresentationFormatName = NSString;
34
35extern "C" {
36    /// [Apple's documentation](https://developer.apple.com/documentation/appkit/nsgraphicscontextpsformat?language=objc)
37    pub static NSGraphicsContextPSFormat: &'static NSGraphicsContextRepresentationFormatName;
38}
39
40extern "C" {
41    /// [Apple's documentation](https://developer.apple.com/documentation/appkit/nsgraphicscontextpdfformat?language=objc)
42    pub static NSGraphicsContextPDFFormat: &'static NSGraphicsContextRepresentationFormatName;
43}
44
45/// [Apple's documentation](https://developer.apple.com/documentation/appkit/nsimageinterpolation?language=objc)
46// NS_ENUM
47#[repr(transparent)]
48#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord)]
49pub struct NSImageInterpolation(pub NSUInteger);
50impl NSImageInterpolation {
51    #[doc(alias = "NSImageInterpolationDefault")]
52    pub const Default: Self = Self(0);
53    #[doc(alias = "NSImageInterpolationNone")]
54    pub const None: Self = Self(1);
55    #[doc(alias = "NSImageInterpolationLow")]
56    pub const Low: Self = Self(2);
57    #[doc(alias = "NSImageInterpolationMedium")]
58    pub const Medium: Self = Self(4);
59    #[doc(alias = "NSImageInterpolationHigh")]
60    pub const High: Self = Self(3);
61}
62
63unsafe impl Encode for NSImageInterpolation {
64    const ENCODING: Encoding = NSUInteger::ENCODING;
65}
66
67unsafe impl RefEncode for NSImageInterpolation {
68    const ENCODING_REF: Encoding = Encoding::Pointer(&Self::ENCODING);
69}
70
71extern_class!(
72    /// [Apple's documentation](https://developer.apple.com/documentation/appkit/nsgraphicscontext?language=objc)
73    #[unsafe(super(NSObject))]
74    #[derive(Debug, PartialEq, Eq, Hash)]
75    pub struct NSGraphicsContext;
76);
77
78extern_conformance!(
79    unsafe impl NSObjectProtocol for NSGraphicsContext {}
80);
81
82impl NSGraphicsContext {
83    extern_methods!(
84        #[unsafe(method(graphicsContextWithAttributes:))]
85        #[unsafe(method_family = none)]
86        pub unsafe fn graphicsContextWithAttributes(
87            attributes: &NSDictionary<NSGraphicsContextAttributeKey, AnyObject>,
88        ) -> Option<Retained<NSGraphicsContext>>;
89
90        #[cfg(all(feature = "NSBitmapImageRep", feature = "NSImageRep"))]
91        #[unsafe(method(graphicsContextWithBitmapImageRep:))]
92        #[unsafe(method_family = none)]
93        pub unsafe fn graphicsContextWithBitmapImageRep(
94            bitmap_rep: &NSBitmapImageRep,
95        ) -> Option<Retained<NSGraphicsContext>>;
96
97        #[cfg(feature = "objc2-core-graphics")]
98        #[cfg(target_vendor = "apple")]
99        #[unsafe(method(graphicsContextWithCGContext:flipped:))]
100        #[unsafe(method_family = none)]
101        pub unsafe fn graphicsContextWithCGContext_flipped(
102            graphics_port: &CGContext,
103            initial_flipped_state: bool,
104        ) -> Retained<NSGraphicsContext>;
105
106        #[unsafe(method(currentContext))]
107        #[unsafe(method_family = none)]
108        pub unsafe fn currentContext() -> Option<Retained<NSGraphicsContext>>;
109
110        /// Setter for [`currentContext`][Self::currentContext].
111        #[unsafe(method(setCurrentContext:))]
112        #[unsafe(method_family = none)]
113        pub unsafe fn setCurrentContext(current_context: Option<&NSGraphicsContext>);
114
115        #[unsafe(method(currentContextDrawingToScreen))]
116        #[unsafe(method_family = none)]
117        pub unsafe fn currentContextDrawingToScreen() -> bool;
118
119        #[unsafe(method(saveGraphicsState))]
120        #[unsafe(method_family = none)]
121        pub unsafe fn saveGraphicsState_class();
122
123        #[unsafe(method(restoreGraphicsState))]
124        #[unsafe(method_family = none)]
125        pub unsafe fn restoreGraphicsState_class();
126
127        #[unsafe(method(attributes))]
128        #[unsafe(method_family = none)]
129        pub unsafe fn attributes(
130            &self,
131        ) -> Option<Retained<NSDictionary<NSGraphicsContextAttributeKey, AnyObject>>>;
132
133        #[unsafe(method(isDrawingToScreen))]
134        #[unsafe(method_family = none)]
135        pub unsafe fn isDrawingToScreen(&self) -> bool;
136
137        #[unsafe(method(saveGraphicsState))]
138        #[unsafe(method_family = none)]
139        pub unsafe fn saveGraphicsState(&self);
140
141        #[unsafe(method(restoreGraphicsState))]
142        #[unsafe(method_family = none)]
143        pub unsafe fn restoreGraphicsState(&self);
144
145        #[unsafe(method(flushGraphics))]
146        #[unsafe(method_family = none)]
147        pub unsafe fn flushGraphics(&self);
148
149        #[cfg(feature = "objc2-core-graphics")]
150        #[cfg(target_vendor = "apple")]
151        #[unsafe(method(CGContext))]
152        #[unsafe(method_family = none)]
153        pub unsafe fn CGContext(&self) -> Retained<CGContext>;
154
155        #[unsafe(method(isFlipped))]
156        #[unsafe(method_family = none)]
157        pub unsafe fn isFlipped(&self) -> bool;
158    );
159}
160
161/// Methods declared on superclass `NSObject`.
162impl NSGraphicsContext {
163    extern_methods!(
164        #[unsafe(method(init))]
165        #[unsafe(method_family = init)]
166        pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>;
167
168        #[unsafe(method(new))]
169        #[unsafe(method_family = new)]
170        pub unsafe fn new() -> Retained<Self>;
171    );
172}
173
174/// NSGraphicsContext_RenderingOptions.
175impl NSGraphicsContext {
176    extern_methods!(
177        #[unsafe(method(shouldAntialias))]
178        #[unsafe(method_family = none)]
179        pub unsafe fn shouldAntialias(&self) -> bool;
180
181        /// Setter for [`shouldAntialias`][Self::shouldAntialias].
182        #[unsafe(method(setShouldAntialias:))]
183        #[unsafe(method_family = none)]
184        pub unsafe fn setShouldAntialias(&self, should_antialias: bool);
185
186        #[unsafe(method(imageInterpolation))]
187        #[unsafe(method_family = none)]
188        pub unsafe fn imageInterpolation(&self) -> NSImageInterpolation;
189
190        /// Setter for [`imageInterpolation`][Self::imageInterpolation].
191        #[unsafe(method(setImageInterpolation:))]
192        #[unsafe(method_family = none)]
193        pub unsafe fn setImageInterpolation(&self, image_interpolation: NSImageInterpolation);
194
195        #[unsafe(method(patternPhase))]
196        #[unsafe(method_family = none)]
197        pub unsafe fn patternPhase(&self) -> NSPoint;
198
199        /// Setter for [`patternPhase`][Self::patternPhase].
200        #[unsafe(method(setPatternPhase:))]
201        #[unsafe(method_family = none)]
202        pub unsafe fn setPatternPhase(&self, pattern_phase: NSPoint);
203
204        #[cfg(feature = "NSGraphics")]
205        #[unsafe(method(compositingOperation))]
206        #[unsafe(method_family = none)]
207        pub unsafe fn compositingOperation(&self) -> NSCompositingOperation;
208
209        #[cfg(feature = "NSGraphics")]
210        /// Setter for [`compositingOperation`][Self::compositingOperation].
211        #[unsafe(method(setCompositingOperation:))]
212        #[unsafe(method_family = none)]
213        pub unsafe fn setCompositingOperation(&self, compositing_operation: NSCompositingOperation);
214
215        #[cfg(feature = "NSGraphics")]
216        #[unsafe(method(colorRenderingIntent))]
217        #[unsafe(method_family = none)]
218        pub unsafe fn colorRenderingIntent(&self) -> NSColorRenderingIntent;
219
220        #[cfg(feature = "NSGraphics")]
221        /// Setter for [`colorRenderingIntent`][Self::colorRenderingIntent].
222        #[unsafe(method(setColorRenderingIntent:))]
223        #[unsafe(method_family = none)]
224        pub unsafe fn setColorRenderingIntent(
225            &self,
226            color_rendering_intent: NSColorRenderingIntent,
227        );
228    );
229}
230
231/// NSQuartzCoreAdditions.
232impl NSGraphicsContext {
233    extern_methods!(
234        #[cfg(feature = "objc2-core-image")]
235        #[cfg(target_vendor = "apple")]
236        #[unsafe(method(CIContext))]
237        #[unsafe(method_family = none)]
238        pub unsafe fn CIContext(&self) -> Option<Retained<CIContext>>;
239    );
240}
241
242/// NSGraphicsContextDeprecated.
243impl NSGraphicsContext {
244    extern_methods!(
245        #[deprecated = "This method has no effect"]
246        #[unsafe(method(setGraphicsState:))]
247        #[unsafe(method_family = none)]
248        pub unsafe fn setGraphicsState(g_state: NSInteger);
249
250        #[deprecated]
251        #[unsafe(method(focusStack))]
252        #[unsafe(method_family = none)]
253        pub unsafe fn focusStack(&self) -> Option<Retained<AnyObject>>;
254
255        #[deprecated]
256        #[unsafe(method(setFocusStack:))]
257        #[unsafe(method_family = none)]
258        pub unsafe fn setFocusStack(&self, stack: Option<&AnyObject>);
259
260        #[deprecated]
261        #[unsafe(method(graphicsContextWithGraphicsPort:flipped:))]
262        #[unsafe(method_family = none)]
263        pub unsafe fn graphicsContextWithGraphicsPort_flipped(
264            graphics_port: NonNull<c_void>,
265            initial_flipped_state: bool,
266        ) -> Retained<NSGraphicsContext>;
267
268        #[deprecated]
269        #[unsafe(method(graphicsPort))]
270        #[unsafe(method_family = none)]
271        pub unsafe fn graphicsPort(&self) -> NonNull<c_void>;
272
273        #[cfg(all(feature = "NSResponder", feature = "NSWindow"))]
274        #[deprecated = "Add instances of NSView to display content in a window"]
275        #[unsafe(method(graphicsContextWithWindow:))]
276        #[unsafe(method_family = none)]
277        pub unsafe fn graphicsContextWithWindow(window: &NSWindow) -> Retained<NSGraphicsContext>;
278    );
279}
objc2_app_kit/generated/NSGraphicsContext.rs

objc2_app_kit/generated/
NSGraphicsContext.rs
