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")]
40unsafe impl NSCoding for NSScriptCommand {}
41
42unsafe impl NSObjectProtocol for NSScriptCommand {}
43
44impl NSScriptCommand {
45    extern_methods!(
46        #[cfg(feature = "NSScriptCommandDescription")]
47        #[unsafe(method(initWithCommandDescription:))]
48        #[unsafe(method_family = init)]
49        pub unsafe fn initWithCommandDescription(
50            this: Allocated<Self>,
51            command_def: &NSScriptCommandDescription,
52        ) -> Retained<Self>;
53
54        #[cfg(feature = "NSCoder")]
55        #[unsafe(method(initWithCoder:))]
56        #[unsafe(method_family = init)]
57        pub unsafe fn initWithCoder(
58            this: Allocated<Self>,
59            in_coder: &NSCoder,
60        ) -> Option<Retained<Self>>;
61
62        #[cfg(feature = "NSScriptCommandDescription")]
63        #[unsafe(method(commandDescription))]
64        #[unsafe(method_family = none)]
65        pub unsafe fn commandDescription(&self) -> Retained<NSScriptCommandDescription>;
66
67        #[unsafe(method(directParameter))]
68        #[unsafe(method_family = none)]
69        pub unsafe fn directParameter(&self) -> Option<Retained<AnyObject>>;
70
71        /// Setter for [`directParameter`][Self::directParameter].
72        #[unsafe(method(setDirectParameter:))]
73        #[unsafe(method_family = none)]
74        pub unsafe fn setDirectParameter(&self, direct_parameter: Option<&AnyObject>);
75
76        #[cfg(feature = "NSScriptObjectSpecifiers")]
77        #[unsafe(method(receiversSpecifier))]
78        #[unsafe(method_family = none)]
79        pub unsafe fn receiversSpecifier(&self) -> Option<Retained<NSScriptObjectSpecifier>>;
80
81        #[cfg(feature = "NSScriptObjectSpecifiers")]
82        /// Setter for [`receiversSpecifier`][Self::receiversSpecifier].
83        #[unsafe(method(setReceiversSpecifier:))]
84        #[unsafe(method_family = none)]
85        pub unsafe fn setReceiversSpecifier(
86            &self,
87            receivers_specifier: Option<&NSScriptObjectSpecifier>,
88        );
89
90        #[unsafe(method(evaluatedReceivers))]
91        #[unsafe(method_family = none)]
92        pub unsafe fn evaluatedReceivers(&self) -> Option<Retained<AnyObject>>;
93
94        #[cfg(all(feature = "NSDictionary", feature = "NSString"))]
95        #[unsafe(method(arguments))]
96        #[unsafe(method_family = none)]
97        pub unsafe fn arguments(&self) -> Option<Retained<NSDictionary<NSString, AnyObject>>>;
98
99        #[cfg(all(feature = "NSDictionary", feature = "NSString"))]
100        /// Setter for [`arguments`][Self::arguments].
101        #[unsafe(method(setArguments:))]
102        #[unsafe(method_family = none)]
103        pub unsafe fn setArguments(&self, arguments: Option<&NSDictionary<NSString, AnyObject>>);
104
105        #[cfg(all(feature = "NSDictionary", feature = "NSString"))]
106        #[unsafe(method(evaluatedArguments))]
107        #[unsafe(method_family = none)]
108        pub unsafe fn evaluatedArguments(
109            &self,
110        ) -> Option<Retained<NSDictionary<NSString, AnyObject>>>;
111
112        #[unsafe(method(isWellFormed))]
113        #[unsafe(method_family = none)]
114        pub unsafe fn isWellFormed(&self) -> bool;
115
116        #[unsafe(method(performDefaultImplementation))]
117        #[unsafe(method_family = none)]
118        pub unsafe fn performDefaultImplementation(&self) -> Option<Retained<AnyObject>>;
119
120        #[unsafe(method(executeCommand))]
121        #[unsafe(method_family = none)]
122        pub unsafe fn executeCommand(&self) -> Option<Retained<AnyObject>>;
123
124        #[unsafe(method(scriptErrorNumber))]
125        #[unsafe(method_family = none)]
126        pub unsafe fn scriptErrorNumber(&self) -> NSInteger;
127
128        /// Setter for [`scriptErrorNumber`][Self::scriptErrorNumber].
129        #[unsafe(method(setScriptErrorNumber:))]
130        #[unsafe(method_family = none)]
131        pub unsafe fn setScriptErrorNumber(&self, script_error_number: NSInteger);
132
133        #[cfg(feature = "NSAppleEventDescriptor")]
134        #[unsafe(method(scriptErrorOffendingObjectDescriptor))]
135        #[unsafe(method_family = none)]
136        pub unsafe fn scriptErrorOffendingObjectDescriptor(
137            &self,
138        ) -> Option<Retained<NSAppleEventDescriptor>>;
139
140        #[cfg(feature = "NSAppleEventDescriptor")]
141        /// Setter for [`scriptErrorOffendingObjectDescriptor`][Self::scriptErrorOffendingObjectDescriptor].
142        #[unsafe(method(setScriptErrorOffendingObjectDescriptor:))]
143        #[unsafe(method_family = none)]
144        pub unsafe fn setScriptErrorOffendingObjectDescriptor(
145            &self,
146            script_error_offending_object_descriptor: Option<&NSAppleEventDescriptor>,
147        );
148
149        #[cfg(feature = "NSAppleEventDescriptor")]
150        #[unsafe(method(scriptErrorExpectedTypeDescriptor))]
151        #[unsafe(method_family = none)]
152        pub unsafe fn scriptErrorExpectedTypeDescriptor(
153            &self,
154        ) -> Option<Retained<NSAppleEventDescriptor>>;
155
156        #[cfg(feature = "NSAppleEventDescriptor")]
157        /// Setter for [`scriptErrorExpectedTypeDescriptor`][Self::scriptErrorExpectedTypeDescriptor].
158        #[unsafe(method(setScriptErrorExpectedTypeDescriptor:))]
159        #[unsafe(method_family = none)]
160        pub unsafe fn setScriptErrorExpectedTypeDescriptor(
161            &self,
162            script_error_expected_type_descriptor: Option<&NSAppleEventDescriptor>,
163        );
164
165        #[cfg(feature = "NSString")]
166        #[unsafe(method(scriptErrorString))]
167        #[unsafe(method_family = none)]
168        pub unsafe fn scriptErrorString(&self) -> Option<Retained<NSString>>;
169
170        #[cfg(feature = "NSString")]
171        /// Setter for [`scriptErrorString`][Self::scriptErrorString].
172        #[unsafe(method(setScriptErrorString:))]
173        #[unsafe(method_family = none)]
174        pub unsafe fn setScriptErrorString(&self, script_error_string: Option<&NSString>);
175
176        #[unsafe(method(currentCommand))]
177        #[unsafe(method_family = none)]
178        pub unsafe fn currentCommand() -> Option<Retained<NSScriptCommand>>;
179
180        #[cfg(feature = "NSAppleEventDescriptor")]
181        #[unsafe(method(appleEvent))]
182        #[unsafe(method_family = none)]
183        pub unsafe fn appleEvent(&self) -> Option<Retained<NSAppleEventDescriptor>>;
184
185        #[unsafe(method(suspendExecution))]
186        #[unsafe(method_family = none)]
187        pub unsafe fn suspendExecution(&self);
188
189        #[unsafe(method(resumeExecutionWithResult:))]
190        #[unsafe(method_family = none)]
191        pub unsafe fn resumeExecutionWithResult(&self, result: Option<&AnyObject>);
192    );
193}
194
195/// Methods declared on superclass `NSObject`.
196impl NSScriptCommand {
197    extern_methods!(
198        #[unsafe(method(init))]
199        #[unsafe(method_family = init)]
200        pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>;
201
202        #[unsafe(method(new))]
203        #[unsafe(method_family = new)]
204        pub unsafe fn new() -> Retained<Self>;
205    );
206}
objc2_foundation/generated/NSScriptCommand.rs

objc2_foundation/generated/
NSScriptCommand.rs
