objc2_core_spotlight/generated/
CSSearchQuery.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::*;
6use objc2_foundation::*;
7
8use crate::*;
9
10extern "C" {
11    /// [Apple's documentation](https://developer.apple.com/documentation/corespotlight/cssearchqueryerrordomain?language=objc)
12    pub static CSSearchQueryErrorDomain: &'static NSErrorDomain;
13}
14
15/// [Apple's documentation](https://developer.apple.com/documentation/corespotlight/cssearchqueryerrorcode?language=objc)
16// NS_ENUM
17#[repr(transparent)]
18#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord)]
19pub struct CSSearchQueryErrorCode(pub NSInteger);
20impl CSSearchQueryErrorCode {
21    #[doc(alias = "CSSearchQueryErrorCodeUnknown")]
22    pub const Unknown: Self = Self(-2000);
23    #[doc(alias = "CSSearchQueryErrorCodeIndexUnreachable")]
24    pub const IndexUnreachable: Self = Self(-2001);
25    #[doc(alias = "CSSearchQueryErrorCodeInvalidQuery")]
26    pub const InvalidQuery: Self = Self(-2002);
27    #[doc(alias = "CSSearchQueryErrorCodeCancelled")]
28    pub const Cancelled: Self = Self(-2003);
29}
30
31unsafe impl Encode for CSSearchQueryErrorCode {
32    const ENCODING: Encoding = NSInteger::ENCODING;
33}
34
35unsafe impl RefEncode for CSSearchQueryErrorCode {
36    const ENCODING_REF: Encoding = Encoding::Pointer(&Self::ENCODING);
37}
38
39/// [Apple's documentation](https://developer.apple.com/documentation/corespotlight/cssearchquerysourceoptions?language=objc)
40// NS_OPTIONS
41#[repr(transparent)]
42#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord)]
43pub struct CSSearchQuerySourceOptions(pub NSUInteger);
44bitflags::bitflags! {
45    impl CSSearchQuerySourceOptions: NSUInteger {
46        #[doc(alias = "CSSearchQuerySourceOptionDefault")]
47        const Default = 0;
48        #[doc(alias = "CSSearchQuerySourceOptionAllowMail")]
49        const AllowMail = 1<<0;
50    }
51}
52
53unsafe impl Encode for CSSearchQuerySourceOptions {
54    const ENCODING: Encoding = NSUInteger::ENCODING;
55}
56
57unsafe impl RefEncode for CSSearchQuerySourceOptions {
58    const ENCODING_REF: Encoding = Encoding::Pointer(&Self::ENCODING);
59}
60
61extern_class!(
62    /// [Apple's documentation](https://developer.apple.com/documentation/corespotlight/cssearchquerycontext?language=objc)
63    #[unsafe(super(NSObject))]
64    #[derive(Debug, PartialEq, Eq, Hash)]
65    pub struct CSSearchQueryContext;
66);
67
68extern_conformance!(
69    unsafe impl NSCoding for CSSearchQueryContext {}
70);
71
72extern_conformance!(
73    unsafe impl NSCopying for CSSearchQueryContext {}
74);
75
76unsafe impl CopyingHelper for CSSearchQueryContext {
77    type Result = Self;
78}
79
80extern_conformance!(
81    unsafe impl NSObjectProtocol for CSSearchQueryContext {}
82);
83
84extern_conformance!(
85    unsafe impl NSSecureCoding for CSSearchQueryContext {}
86);
87
88impl CSSearchQueryContext {
89    extern_methods!(
90        #[unsafe(method(fetchAttributes))]
91        #[unsafe(method_family = none)]
92        pub unsafe fn fetchAttributes(&self) -> Retained<NSArray<NSString>>;
93
94        /// Setter for [`fetchAttributes`][Self::fetchAttributes].
95        #[unsafe(method(setFetchAttributes:))]
96        #[unsafe(method_family = none)]
97        pub unsafe fn setFetchAttributes(&self, fetch_attributes: &NSArray<NSString>);
98
99        #[unsafe(method(filterQueries))]
100        #[unsafe(method_family = none)]
101        pub unsafe fn filterQueries(&self) -> Retained<NSArray<NSString>>;
102
103        /// Setter for [`filterQueries`][Self::filterQueries].
104        ///
105        /// This is [copied][objc2_foundation::NSCopying::copy] when set.
106        #[unsafe(method(setFilterQueries:))]
107        #[unsafe(method_family = none)]
108        pub unsafe fn setFilterQueries(&self, filter_queries: &NSArray<NSString>);
109
110        #[unsafe(method(keyboardLanguage))]
111        #[unsafe(method_family = none)]
112        pub unsafe fn keyboardLanguage(&self) -> Option<Retained<NSString>>;
113
114        /// Setter for [`keyboardLanguage`][Self::keyboardLanguage].
115        #[unsafe(method(setKeyboardLanguage:))]
116        #[unsafe(method_family = none)]
117        pub unsafe fn setKeyboardLanguage(&self, keyboard_language: Option<&NSString>);
118
119        #[unsafe(method(sourceOptions))]
120        #[unsafe(method_family = none)]
121        pub unsafe fn sourceOptions(&self) -> CSSearchQuerySourceOptions;
122
123        /// Setter for [`sourceOptions`][Self::sourceOptions].
124        #[unsafe(method(setSourceOptions:))]
125        #[unsafe(method_family = none)]
126        pub unsafe fn setSourceOptions(&self, source_options: CSSearchQuerySourceOptions);
127    );
128}
129
130/// Methods declared on superclass `NSObject`.
131impl CSSearchQueryContext {
132    extern_methods!(
133        #[unsafe(method(init))]
134        #[unsafe(method_family = init)]
135        pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>;
136
137        #[unsafe(method(new))]
138        #[unsafe(method_family = new)]
139        pub unsafe fn new() -> Retained<Self>;
140    );
141}
142
143extern_class!(
144    /// [Apple's documentation](https://developer.apple.com/documentation/corespotlight/cssearchquery?language=objc)
145    #[unsafe(super(NSObject))]
146    #[derive(Debug, PartialEq, Eq, Hash)]
147    pub struct CSSearchQuery;
148);
149
150extern_conformance!(
151    unsafe impl NSObjectProtocol for CSSearchQuery {}
152);
153
154impl CSSearchQuery {
155    extern_methods!(
156        #[unsafe(method(init))]
157        #[unsafe(method_family = init)]
158        pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>;
159
160        #[unsafe(method(initWithQueryString:queryContext:))]
161        #[unsafe(method_family = init)]
162        pub unsafe fn initWithQueryString_queryContext(
163            this: Allocated<Self>,
164            query_string: &NSString,
165            query_context: Option<&CSSearchQueryContext>,
166        ) -> Retained<Self>;
167
168        #[deprecated = "Use initWithQueryString:queryContext instead"]
169        #[unsafe(method(initWithQueryString:attributes:))]
170        #[unsafe(method_family = init)]
171        pub unsafe fn initWithQueryString_attributes(
172            this: Allocated<Self>,
173            query_string: &NSString,
174            attributes: Option<&NSArray<NSString>>,
175        ) -> Retained<Self>;
176
177        #[unsafe(method(isCancelled))]
178        #[unsafe(method_family = none)]
179        pub unsafe fn isCancelled(&self) -> bool;
180
181        #[unsafe(method(foundItemCount))]
182        #[unsafe(method_family = none)]
183        pub unsafe fn foundItemCount(&self) -> NSUInteger;
184
185        #[cfg(all(feature = "CSSearchableItem", feature = "block2"))]
186        /// # Safety
187        ///
188        /// The returned block's argument must be a valid pointer.
189        #[unsafe(method(foundItemsHandler))]
190        #[unsafe(method_family = none)]
191        pub unsafe fn foundItemsHandler(
192            &self,
193        ) -> *mut block2::DynBlock<dyn Fn(NonNull<NSArray<CSSearchableItem>>)>;
194
195        #[cfg(all(feature = "CSSearchableItem", feature = "block2"))]
196        /// Setter for [`foundItemsHandler`][Self::foundItemsHandler].
197        ///
198        /// This is [copied][objc2_foundation::NSCopying::copy] when set.
199        #[unsafe(method(setFoundItemsHandler:))]
200        #[unsafe(method_family = none)]
201        pub unsafe fn setFoundItemsHandler(
202            &self,
203            found_items_handler: Option<
204                &block2::DynBlock<dyn Fn(NonNull<NSArray<CSSearchableItem>>)>,
205            >,
206        );
207
208        #[cfg(feature = "block2")]
209        /// # Safety
210        ///
211        /// The returned block's argument must be a valid pointer or null.
212        #[unsafe(method(completionHandler))]
213        #[unsafe(method_family = none)]
214        pub unsafe fn completionHandler(&self) -> *mut block2::DynBlock<dyn Fn(*mut NSError)>;
215
216        #[cfg(feature = "block2")]
217        /// Setter for [`completionHandler`][Self::completionHandler].
218        ///
219        /// This is [copied][objc2_foundation::NSCopying::copy] when set.
220        #[unsafe(method(setCompletionHandler:))]
221        #[unsafe(method_family = none)]
222        pub unsafe fn setCompletionHandler(
223            &self,
224            completion_handler: Option<&block2::DynBlock<dyn Fn(*mut NSError)>>,
225        );
226
227        #[unsafe(method(protectionClasses))]
228        #[unsafe(method_family = none)]
229        pub unsafe fn protectionClasses(&self) -> Retained<NSArray<NSFileProtectionType>>;
230
231        /// Setter for [`protectionClasses`][Self::protectionClasses].
232        ///
233        /// This is [copied][objc2_foundation::NSCopying::copy] when set.
234        #[unsafe(method(setProtectionClasses:))]
235        #[unsafe(method_family = none)]
236        pub unsafe fn setProtectionClasses(
237            &self,
238            protection_classes: &NSArray<NSFileProtectionType>,
239        );
240
241        #[unsafe(method(start))]
242        #[unsafe(method_family = none)]
243        pub unsafe fn start(&self);
244
245        #[unsafe(method(cancel))]
246        #[unsafe(method_family = none)]
247        pub unsafe fn cancel(&self);
248    );
249}
250
251/// Methods declared on superclass `NSObject`.
252impl CSSearchQuery {
253    extern_methods!(
254        #[unsafe(method(new))]
255        #[unsafe(method_family = new)]
256        pub unsafe fn new() -> Retained<Self>;
257    );
258}
objc2_core_spotlight/generated/CSSearchQuery.rs

objc2_core_spotlight/generated/
CSSearchQuery.rs
