objc2_foundation/generated/
NSScriptCommand.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
7use crate::*;
8
9/// [Apple's documentation](https://developer.apple.com/documentation/foundation/nsnoscripterror?language=objc)
10pub const NSNoScriptError: NSInteger = 0;
11/// [Apple's documentation](https://developer.apple.com/documentation/foundation/nsreceiverevaluationscripterror?language=objc)
12pub const NSReceiverEvaluationScriptError: NSInteger = 1;
13/// [Apple's documentation](https://developer.apple.com/documentation/foundation/nskeyspecifierevaluationscripterror?language=objc)
14pub const NSKeySpecifierEvaluationScriptError: NSInteger = 2;
15/// [Apple's documentation](https://developer.apple.com/documentation/foundation/nsargumentevaluationscripterror?language=objc)
16pub const NSArgumentEvaluationScriptError: NSInteger = 3;
17/// [Apple's documentation](https://developer.apple.com/documentation/foundation/nsreceiverscanthandlecommandscripterror?language=objc)
18pub const NSReceiversCantHandleCommandScriptError: NSInteger = 4;
19/// [Apple's documentation](https://developer.apple.com/documentation/foundation/nsrequiredargumentsmissingscripterror?language=objc)
20pub const NSRequiredArgumentsMissingScriptError: NSInteger = 5;
21/// [Apple's documentation](https://developer.apple.com/documentation/foundation/nsargumentswrongscripterror?language=objc)
22pub const NSArgumentsWrongScriptError: NSInteger = 6;
23/// [Apple's documentation](https://developer.apple.com/documentation/foundation/nsunknownkeyscripterror?language=objc)
24pub const NSUnknownKeyScriptError: NSInteger = 7;
25/// [Apple's documentation](https://developer.apple.com/documentation/foundation/nsinternalscripterror?language=objc)
26pub const NSInternalScriptError: NSInteger = 8;
27/// [Apple's documentation](https://developer.apple.com/documentation/foundation/nsoperationnotsupportedforkeyscripterror?language=objc)
28pub const NSOperationNotSupportedForKeyScriptError: NSInteger = 9;
29/// [Apple's documentation](https://developer.apple.com/documentation/foundation/nscannotcreatescriptcommanderror?language=objc)
30pub const NSCannotCreateScriptCommandError: NSInteger = 10;
31
32extern_class!(
33    /// [Apple's documentation](https://developer.apple.com/documentation/foundation/nsscriptcommand?language=objc)
34    #[unsafe(super(NSObject))]
35    #[derive(Debug, PartialEq, Eq, Hash)]
36    pub struct NSScriptCommand;
37);
38
39#[cfg(feature = "NSObject")]
40extern_conformance!(
41    unsafe impl NSCoding for NSScriptCommand {}
42);
43
44extern_conformance!(
45    unsafe impl NSObjectProtocol for NSScriptCommand {}
46);
47
48impl NSScriptCommand {
49    extern_methods!(
50        #[cfg(feature = "NSScriptCommandDescription")]
51        #[unsafe(method(initWithCommandDescription:))]
52        #[unsafe(method_family = init)]
53        pub unsafe fn initWithCommandDescription(
54            this: Allocated<Self>,
55            command_def: &NSScriptCommandDescription,
56        ) -> Retained<Self>;
57
58        #[cfg(feature = "NSCoder")]
59        #[unsafe(method(initWithCoder:))]
60        #[unsafe(method_family = init)]
61        pub unsafe fn initWithCoder(
62            this: Allocated<Self>,
63            in_coder: &NSCoder,
64        ) -> Option<Retained<Self>>;
65
66        #[cfg(feature = "NSScriptCommandDescription")]
67        #[unsafe(method(commandDescription))]
68        #[unsafe(method_family = none)]
69        pub unsafe fn commandDescription(&self) -> Retained<NSScriptCommandDescription>;
70
71        #[unsafe(method(directParameter))]
72        #[unsafe(method_family = none)]
73        pub unsafe fn directParameter(&self) -> Option<Retained<AnyObject>>;
74
75        /// Setter for [`directParameter`][Self::directParameter].
76        #[unsafe(method(setDirectParameter:))]
77        #[unsafe(method_family = none)]
78        pub unsafe fn setDirectParameter(&self, direct_parameter: Option<&AnyObject>);
79
80        #[cfg(feature = "NSScriptObjectSpecifiers")]
81        #[unsafe(method(receiversSpecifier))]
82        #[unsafe(method_family = none)]
83        pub unsafe fn receiversSpecifier(&self) -> Option<Retained<NSScriptObjectSpecifier>>;
84
85        #[cfg(feature = "NSScriptObjectSpecifiers")]
86        /// Setter for [`receiversSpecifier`][Self::receiversSpecifier].
87        #[unsafe(method(setReceiversSpecifier:))]
88        #[unsafe(method_family = none)]
89        pub unsafe fn setReceiversSpecifier(
90            &self,
91            receivers_specifier: Option<&NSScriptObjectSpecifier>,
92        );
93
94        #[unsafe(method(evaluatedReceivers))]
95        #[unsafe(method_family = none)]
96        pub unsafe fn evaluatedReceivers(&self) -> Option<Retained<AnyObject>>;
97
98        #[cfg(all(feature = "NSDictionary", feature = "NSString"))]
99        #[unsafe(method(arguments))]
100        #[unsafe(method_family = none)]
101        pub unsafe fn arguments(&self) -> Option<Retained<NSDictionary<NSString, AnyObject>>>;
102
103        #[cfg(all(feature = "NSDictionary", feature = "NSString"))]
104        /// Setter for [`arguments`][Self::arguments].
105        #[unsafe(method(setArguments:))]
106        #[unsafe(method_family = none)]
107        pub unsafe fn setArguments(&self, arguments: Option<&NSDictionary<NSString, AnyObject>>);
108
109        #[cfg(all(feature = "NSDictionary", feature = "NSString"))]
110        #[unsafe(method(evaluatedArguments))]
111        #[unsafe(method_family = none)]
112        pub unsafe fn evaluatedArguments(
113            &self,
114        ) -> Option<Retained<NSDictionary<NSString, AnyObject>>>;
115
116        #[unsafe(method(isWellFormed))]
117        #[unsafe(method_family = none)]
118        pub unsafe fn isWellFormed(&self) -> bool;
119
120        #[unsafe(method(performDefaultImplementation))]
121        #[unsafe(method_family = none)]
122        pub unsafe fn performDefaultImplementation(&self) -> Option<Retained<AnyObject>>;
123
124        #[unsafe(method(executeCommand))]
125        #[unsafe(method_family = none)]
126        pub unsafe fn executeCommand(&self) -> Option<Retained<AnyObject>>;
127
128        #[unsafe(method(scriptErrorNumber))]
129        #[unsafe(method_family = none)]
130        pub unsafe fn scriptErrorNumber(&self) -> NSInteger;
131
132        /// Setter for [`scriptErrorNumber`][Self::scriptErrorNumber].
133        #[unsafe(method(setScriptErrorNumber:))]
134        #[unsafe(method_family = none)]
135        pub unsafe fn setScriptErrorNumber(&self, script_error_number: NSInteger);
136
137        #[cfg(feature = "NSAppleEventDescriptor")]
138        #[unsafe(method(scriptErrorOffendingObjectDescriptor))]
139        #[unsafe(method_family = none)]
140        pub unsafe fn scriptErrorOffendingObjectDescriptor(
141            &self,
142        ) -> Option<Retained<NSAppleEventDescriptor>>;
143
144        #[cfg(feature = "NSAppleEventDescriptor")]
145        /// Setter for [`scriptErrorOffendingObjectDescriptor`][Self::scriptErrorOffendingObjectDescriptor].
146        #[unsafe(method(setScriptErrorOffendingObjectDescriptor:))]
147        #[unsafe(method_family = none)]
148        pub unsafe fn setScriptErrorOffendingObjectDescriptor(
149            &self,
150            script_error_offending_object_descriptor: Option<&NSAppleEventDescriptor>,
151        );
152
153        #[cfg(feature = "NSAppleEventDescriptor")]
154        #[unsafe(method(scriptErrorExpectedTypeDescriptor))]
155        #[unsafe(method_family = none)]
156        pub unsafe fn scriptErrorExpectedTypeDescriptor(
157            &self,
158        ) -> Option<Retained<NSAppleEventDescriptor>>;
159
160        #[cfg(feature = "NSAppleEventDescriptor")]
161        /// Setter for [`scriptErrorExpectedTypeDescriptor`][Self::scriptErrorExpectedTypeDescriptor].
162        #[unsafe(method(setScriptErrorExpectedTypeDescriptor:))]
163        #[unsafe(method_family = none)]
164        pub unsafe fn setScriptErrorExpectedTypeDescriptor(
165            &self,
166            script_error_expected_type_descriptor: Option<&NSAppleEventDescriptor>,
167        );
168
169        #[cfg(feature = "NSString")]
170        #[unsafe(method(scriptErrorString))]
171        #[unsafe(method_family = none)]
172        pub unsafe fn scriptErrorString(&self) -> Option<Retained<NSString>>;
173
174        #[cfg(feature = "NSString")]
175        /// Setter for [`scriptErrorString`][Self::scriptErrorString].
176        #[unsafe(method(setScriptErrorString:))]
177        #[unsafe(method_family = none)]
178        pub unsafe fn setScriptErrorString(&self, script_error_string: Option<&NSString>);
179
180        #[unsafe(method(currentCommand))]
181        #[unsafe(method_family = none)]
182        pub unsafe fn currentCommand() -> Option<Retained<NSScriptCommand>>;
183
184        #[cfg(feature = "NSAppleEventDescriptor")]
185        #[unsafe(method(appleEvent))]
186        #[unsafe(method_family = none)]
187        pub unsafe fn appleEvent(&self) -> Option<Retained<NSAppleEventDescriptor>>;
188
189        #[unsafe(method(suspendExecution))]
190        #[unsafe(method_family = none)]
191        pub unsafe fn suspendExecution(&self);
192
193        #[unsafe(method(resumeExecutionWithResult:))]
194        #[unsafe(method_family = none)]
195        pub unsafe fn resumeExecutionWithResult(&self, result: Option<&AnyObject>);
196    );
197}
198
199/// Methods declared on superclass `NSObject`.
200impl NSScriptCommand {
201    extern_methods!(
202        #[unsafe(method(init))]
203        #[unsafe(method_family = init)]
204        pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>;
205
206        #[unsafe(method(new))]
207        #[unsafe(method_family = new)]
208        pub unsafe fn new() -> Retained<Self>;
209    );
210}
objc2_foundation/generated/NSScriptCommand.rs

objc2_foundation/generated/
NSScriptCommand.rs
