objc2_core_spotlight/generated/
CSSearchableItemAttributeSet_General.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#[cfg(feature = "objc2-uniform-type-identifiers")]
8use objc2_uniform_type_identifiers::*;
9
10use crate::*;
11
12/// CSGeneral.
13#[cfg(feature = "CSSearchableItemAttributeSet")]
14impl CSSearchableItemAttributeSet {
15    extern_methods!(
16        #[unsafe(method(displayName))]
17        #[unsafe(method_family = none)]
18        pub unsafe fn displayName(&self) -> Option<Retained<NSString>>;
19
20        /// Setter for [`displayName`][Self::displayName].
21        ///
22        /// This is [copied][objc2_foundation::NSCopying::copy] when set.
23        #[unsafe(method(setDisplayName:))]
24        #[unsafe(method_family = none)]
25        pub unsafe fn setDisplayName(&self, display_name: Option<&NSString>);
26
27        #[unsafe(method(alternateNames))]
28        #[unsafe(method_family = none)]
29        pub unsafe fn alternateNames(&self) -> Option<Retained<NSArray<NSString>>>;
30
31        /// Setter for [`alternateNames`][Self::alternateNames].
32        ///
33        /// This is [copied][objc2_foundation::NSCopying::copy] when set.
34        #[unsafe(method(setAlternateNames:))]
35        #[unsafe(method_family = none)]
36        pub unsafe fn setAlternateNames(&self, alternate_names: Option<&NSArray<NSString>>);
37
38        #[unsafe(method(path))]
39        #[unsafe(method_family = none)]
40        pub unsafe fn path(&self) -> Option<Retained<NSString>>;
41
42        /// Setter for [`path`][Self::path].
43        ///
44        /// This is [copied][objc2_foundation::NSCopying::copy] when set.
45        #[unsafe(method(setPath:))]
46        #[unsafe(method_family = none)]
47        pub unsafe fn setPath(&self, path: Option<&NSString>);
48
49        #[unsafe(method(contentURL))]
50        #[unsafe(method_family = none)]
51        pub unsafe fn contentURL(&self) -> Option<Retained<NSURL>>;
52
53        /// Setter for [`contentURL`][Self::contentURL].
54        #[unsafe(method(setContentURL:))]
55        #[unsafe(method_family = none)]
56        pub unsafe fn setContentURL(&self, content_url: Option<&NSURL>);
57
58        #[unsafe(method(thumbnailURL))]
59        #[unsafe(method_family = none)]
60        pub unsafe fn thumbnailURL(&self) -> Option<Retained<NSURL>>;
61
62        /// Setter for [`thumbnailURL`][Self::thumbnailURL].
63        #[unsafe(method(setThumbnailURL:))]
64        #[unsafe(method_family = none)]
65        pub unsafe fn setThumbnailURL(&self, thumbnail_url: Option<&NSURL>);
66
67        #[unsafe(method(thumbnailData))]
68        #[unsafe(method_family = none)]
69        pub unsafe fn thumbnailData(&self) -> Option<Retained<NSData>>;
70
71        /// Setter for [`thumbnailData`][Self::thumbnailData].
72        ///
73        /// This is [copied][objc2_foundation::NSCopying::copy] when set.
74        #[unsafe(method(setThumbnailData:))]
75        #[unsafe(method_family = none)]
76        pub unsafe fn setThumbnailData(&self, thumbnail_data: Option<&NSData>);
77
78        #[unsafe(method(darkThumbnailURL))]
79        #[unsafe(method_family = none)]
80        pub unsafe fn darkThumbnailURL(&self) -> Option<Retained<NSURL>>;
81
82        /// Setter for [`darkThumbnailURL`][Self::darkThumbnailURL].
83        #[unsafe(method(setDarkThumbnailURL:))]
84        #[unsafe(method_family = none)]
85        pub unsafe fn setDarkThumbnailURL(&self, dark_thumbnail_url: Option<&NSURL>);
86
87        #[unsafe(method(relatedUniqueIdentifier))]
88        #[unsafe(method_family = none)]
89        pub unsafe fn relatedUniqueIdentifier(&self) -> Option<Retained<NSString>>;
90
91        /// Setter for [`relatedUniqueIdentifier`][Self::relatedUniqueIdentifier].
92        ///
93        /// This is [copied][objc2_foundation::NSCopying::copy] when set.
94        #[unsafe(method(setRelatedUniqueIdentifier:))]
95        #[unsafe(method_family = none)]
96        pub unsafe fn setRelatedUniqueIdentifier(
97            &self,
98            related_unique_identifier: Option<&NSString>,
99        );
100
101        #[unsafe(method(weakRelatedUniqueIdentifier))]
102        #[unsafe(method_family = none)]
103        pub unsafe fn weakRelatedUniqueIdentifier(&self) -> Option<Retained<NSString>>;
104
105        /// Setter for [`weakRelatedUniqueIdentifier`][Self::weakRelatedUniqueIdentifier].
106        ///
107        /// This is [copied][objc2_foundation::NSCopying::copy] when set.
108        #[unsafe(method(setWeakRelatedUniqueIdentifier:))]
109        #[unsafe(method_family = none)]
110        pub unsafe fn setWeakRelatedUniqueIdentifier(
111            &self,
112            weak_related_unique_identifier: Option<&NSString>,
113        );
114
115        #[unsafe(method(metadataModificationDate))]
116        #[unsafe(method_family = none)]
117        pub unsafe fn metadataModificationDate(&self) -> Option<Retained<NSDate>>;
118
119        /// Setter for [`metadataModificationDate`][Self::metadataModificationDate].
120        #[unsafe(method(setMetadataModificationDate:))]
121        #[unsafe(method_family = none)]
122        pub unsafe fn setMetadataModificationDate(
123            &self,
124            metadata_modification_date: Option<&NSDate>,
125        );
126
127        #[unsafe(method(contentType))]
128        #[unsafe(method_family = none)]
129        pub unsafe fn contentType(&self) -> Option<Retained<NSString>>;
130
131        /// Setter for [`contentType`][Self::contentType].
132        ///
133        /// This is [copied][objc2_foundation::NSCopying::copy] when set.
134        #[unsafe(method(setContentType:))]
135        #[unsafe(method_family = none)]
136        pub unsafe fn setContentType(&self, content_type: Option<&NSString>);
137
138        #[unsafe(method(contentTypeTree))]
139        #[unsafe(method_family = none)]
140        pub unsafe fn contentTypeTree(&self) -> Option<Retained<NSArray<NSString>>>;
141
142        /// Setter for [`contentTypeTree`][Self::contentTypeTree].
143        ///
144        /// This is [copied][objc2_foundation::NSCopying::copy] when set.
145        #[unsafe(method(setContentTypeTree:))]
146        #[unsafe(method_family = none)]
147        pub unsafe fn setContentTypeTree(&self, content_type_tree: Option<&NSArray<NSString>>);
148
149        #[unsafe(method(keywords))]
150        #[unsafe(method_family = none)]
151        pub unsafe fn keywords(&self) -> Option<Retained<NSArray<NSString>>>;
152
153        /// Setter for [`keywords`][Self::keywords].
154        ///
155        /// This is [copied][objc2_foundation::NSCopying::copy] when set.
156        #[unsafe(method(setKeywords:))]
157        #[unsafe(method_family = none)]
158        pub unsafe fn setKeywords(&self, keywords: Option<&NSArray<NSString>>);
159
160        #[unsafe(method(title))]
161        #[unsafe(method_family = none)]
162        pub unsafe fn title(&self) -> Option<Retained<NSString>>;
163
164        /// Setter for [`title`][Self::title].
165        ///
166        /// This is [copied][objc2_foundation::NSCopying::copy] when set.
167        #[unsafe(method(setTitle:))]
168        #[unsafe(method_family = none)]
169        pub unsafe fn setTitle(&self, title: Option<&NSString>);
170
171        #[unsafe(method(version))]
172        #[unsafe(method_family = none)]
173        pub unsafe fn version(&self) -> Option<Retained<NSString>>;
174
175        /// Setter for [`version`][Self::version].
176        ///
177        /// This is [copied][objc2_foundation::NSCopying::copy] when set.
178        #[unsafe(method(setVersion:))]
179        #[unsafe(method_family = none)]
180        pub unsafe fn setVersion(&self, version: Option<&NSString>);
181
182        #[unsafe(method(isUserCreated))]
183        #[unsafe(method_family = none)]
184        pub unsafe fn isUserCreated(&self) -> Option<Retained<NSNumber>>;
185
186        /// Setter for [`isUserCreated`][Self::isUserCreated].
187        #[unsafe(method(setUserCreated:))]
188        #[unsafe(method_family = none)]
189        pub unsafe fn setUserCreated(&self, user_created: Option<&NSNumber>);
190
191        #[unsafe(method(isUserOwned))]
192        #[unsafe(method_family = none)]
193        pub unsafe fn isUserOwned(&self) -> Option<Retained<NSNumber>>;
194
195        /// Setter for [`isUserOwned`][Self::isUserOwned].
196        #[unsafe(method(setUserOwned:))]
197        #[unsafe(method_family = none)]
198        pub unsafe fn setUserOwned(&self, user_owned: Option<&NSNumber>);
199
200        #[unsafe(method(isUserCurated))]
201        #[unsafe(method_family = none)]
202        pub unsafe fn isUserCurated(&self) -> Option<Retained<NSNumber>>;
203
204        /// Setter for [`isUserCurated`][Self::isUserCurated].
205        #[unsafe(method(setUserCurated:))]
206        #[unsafe(method_family = none)]
207        pub unsafe fn setUserCurated(&self, user_curated: Option<&NSNumber>);
208
209        #[unsafe(method(rankingHint))]
210        #[unsafe(method_family = none)]
211        pub unsafe fn rankingHint(&self) -> Option<Retained<NSNumber>>;
212
213        /// Setter for [`rankingHint`][Self::rankingHint].
214        #[unsafe(method(setRankingHint:))]
215        #[unsafe(method_family = none)]
216        pub unsafe fn setRankingHint(&self, ranking_hint: Option<&NSNumber>);
217
218        #[unsafe(method(domainIdentifier))]
219        #[unsafe(method_family = none)]
220        pub unsafe fn domainIdentifier(&self) -> Option<Retained<NSString>>;
221
222        /// Setter for [`domainIdentifier`][Self::domainIdentifier].
223        ///
224        /// This is [copied][objc2_foundation::NSCopying::copy] when set.
225        #[unsafe(method(setDomainIdentifier:))]
226        #[unsafe(method_family = none)]
227        pub unsafe fn setDomainIdentifier(&self, domain_identifier: Option<&NSString>);
228    );
229}
230
231/// CSActionExtras.
232#[cfg(feature = "CSSearchableItemAttributeSet")]
233impl CSSearchableItemAttributeSet {
234    extern_methods!(
235        #[unsafe(method(supportsPhoneCall))]
236        #[unsafe(method_family = none)]
237        pub unsafe fn supportsPhoneCall(&self) -> Option<Retained<NSNumber>>;
238
239        /// Setter for [`supportsPhoneCall`][Self::supportsPhoneCall].
240        #[unsafe(method(setSupportsPhoneCall:))]
241        #[unsafe(method_family = none)]
242        pub unsafe fn setSupportsPhoneCall(&self, supports_phone_call: Option<&NSNumber>);
243
244        #[unsafe(method(supportsNavigation))]
245        #[unsafe(method_family = none)]
246        pub unsafe fn supportsNavigation(&self) -> Option<Retained<NSNumber>>;
247
248        /// Setter for [`supportsNavigation`][Self::supportsNavigation].
249        #[unsafe(method(setSupportsNavigation:))]
250        #[unsafe(method_family = none)]
251        pub unsafe fn setSupportsNavigation(&self, supports_navigation: Option<&NSNumber>);
252
253        #[unsafe(method(actionIdentifiers))]
254        #[unsafe(method_family = none)]
255        pub unsafe fn actionIdentifiers(&self) -> Retained<NSArray<NSString>>;
256
257        /// Setter for [`actionIdentifiers`][Self::actionIdentifiers].
258        ///
259        /// This is [copied][objc2_foundation::NSCopying::copy] when set.
260        #[unsafe(method(setActionIdentifiers:))]
261        #[unsafe(method_family = none)]
262        pub unsafe fn setActionIdentifiers(&self, action_identifiers: &NSArray<NSString>);
263
264        #[cfg(feature = "objc2-uniform-type-identifiers")]
265        #[unsafe(method(sharedItemContentType))]
266        #[unsafe(method_family = none)]
267        pub unsafe fn sharedItemContentType(&self) -> Option<Retained<UTType>>;
268
269        #[cfg(feature = "objc2-uniform-type-identifiers")]
270        /// Setter for [`sharedItemContentType`][Self::sharedItemContentType].
271        ///
272        /// This is [copied][objc2_foundation::NSCopying::copy] when set.
273        #[unsafe(method(setSharedItemContentType:))]
274        #[unsafe(method_family = none)]
275        pub unsafe fn setSharedItemContentType(&self, shared_item_content_type: Option<&UTType>);
276    );
277}
278
279/// CSContainment.
280#[cfg(feature = "CSSearchableItemAttributeSet")]
281impl CSSearchableItemAttributeSet {
282    extern_methods!(
283        #[unsafe(method(containerTitle))]
284        #[unsafe(method_family = none)]
285        pub unsafe fn containerTitle(&self) -> Option<Retained<NSString>>;
286
287        /// Setter for [`containerTitle`][Self::containerTitle].
288        ///
289        /// This is [copied][objc2_foundation::NSCopying::copy] when set.
290        #[unsafe(method(setContainerTitle:))]
291        #[unsafe(method_family = none)]
292        pub unsafe fn setContainerTitle(&self, container_title: Option<&NSString>);
293
294        #[unsafe(method(containerDisplayName))]
295        #[unsafe(method_family = none)]
296        pub unsafe fn containerDisplayName(&self) -> Option<Retained<NSString>>;
297
298        /// Setter for [`containerDisplayName`][Self::containerDisplayName].
299        ///
300        /// This is [copied][objc2_foundation::NSCopying::copy] when set.
301        #[unsafe(method(setContainerDisplayName:))]
302        #[unsafe(method_family = none)]
303        pub unsafe fn setContainerDisplayName(&self, container_display_name: Option<&NSString>);
304
305        #[unsafe(method(containerIdentifier))]
306        #[unsafe(method_family = none)]
307        pub unsafe fn containerIdentifier(&self) -> Option<Retained<NSString>>;
308
309        /// Setter for [`containerIdentifier`][Self::containerIdentifier].
310        ///
311        /// This is [copied][objc2_foundation::NSCopying::copy] when set.
312        #[unsafe(method(setContainerIdentifier:))]
313        #[unsafe(method_family = none)]
314        pub unsafe fn setContainerIdentifier(&self, container_identifier: Option<&NSString>);
315
316        #[unsafe(method(containerOrder))]
317        #[unsafe(method_family = none)]
318        pub unsafe fn containerOrder(&self) -> Option<Retained<NSNumber>>;
319
320        /// Setter for [`containerOrder`][Self::containerOrder].
321        #[unsafe(method(setContainerOrder:))]
322        #[unsafe(method_family = none)]
323        pub unsafe fn setContainerOrder(&self, container_order: Option<&NSNumber>);
324    );
325}
326
327/// CSItemProvider.
328#[cfg(feature = "CSSearchableItemAttributeSet")]
329impl CSSearchableItemAttributeSet {
330    extern_methods!(
331        #[unsafe(method(providerDataTypeIdentifiers))]
332        #[unsafe(method_family = none)]
333        pub unsafe fn providerDataTypeIdentifiers(&self) -> Option<Retained<NSArray<NSString>>>;
334
335        /// Setter for [`providerDataTypeIdentifiers`][Self::providerDataTypeIdentifiers].
336        ///
337        /// This is [copied][objc2_foundation::NSCopying::copy] when set.
338        #[unsafe(method(setProviderDataTypeIdentifiers:))]
339        #[unsafe(method_family = none)]
340        pub unsafe fn setProviderDataTypeIdentifiers(
341            &self,
342            provider_data_type_identifiers: Option<&NSArray<NSString>>,
343        );
344
345        #[unsafe(method(providerFileTypeIdentifiers))]
346        #[unsafe(method_family = none)]
347        pub unsafe fn providerFileTypeIdentifiers(&self) -> Option<Retained<NSArray<NSString>>>;
348
349        /// Setter for [`providerFileTypeIdentifiers`][Self::providerFileTypeIdentifiers].
350        ///
351        /// This is [copied][objc2_foundation::NSCopying::copy] when set.
352        #[unsafe(method(setProviderFileTypeIdentifiers:))]
353        #[unsafe(method_family = none)]
354        pub unsafe fn setProviderFileTypeIdentifiers(
355            &self,
356            provider_file_type_identifiers: Option<&NSArray<NSString>>,
357        );
358
359        #[unsafe(method(providerInPlaceFileTypeIdentifiers))]
360        #[unsafe(method_family = none)]
361        pub unsafe fn providerInPlaceFileTypeIdentifiers(
362            &self,
363        ) -> Option<Retained<NSArray<NSString>>>;
364
365        /// Setter for [`providerInPlaceFileTypeIdentifiers`][Self::providerInPlaceFileTypeIdentifiers].
366        ///
367        /// This is [copied][objc2_foundation::NSCopying::copy] when set.
368        #[unsafe(method(setProviderInPlaceFileTypeIdentifiers:))]
369        #[unsafe(method_family = none)]
370        pub unsafe fn setProviderInPlaceFileTypeIdentifiers(
371            &self,
372            provider_in_place_file_type_identifiers: Option<&NSArray<NSString>>,
373        );
374    );
375}