objc2_app_kit/generated/
NSFontCollection.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
10/// [Apple's documentation](https://developer.apple.com/documentation/appkit/nsfontcollectionvisibility?language=objc)
11// NS_OPTIONS
12#[repr(transparent)]
13#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord)]
14pub struct NSFontCollectionVisibility(pub NSUInteger);
15bitflags::bitflags! {
16    impl NSFontCollectionVisibility: NSUInteger {
17        #[doc(alias = "NSFontCollectionVisibilityProcess")]
18        const Process = 1<<0;
19        #[doc(alias = "NSFontCollectionVisibilityUser")]
20        const User = 1<<1;
21        #[doc(alias = "NSFontCollectionVisibilityComputer")]
22        const Computer = 1<<2;
23    }
24}
25
26unsafe impl Encode for NSFontCollectionVisibility {
27    const ENCODING: Encoding = NSUInteger::ENCODING;
28}
29
30unsafe impl RefEncode for NSFontCollectionVisibility {
31    const ENCODING_REF: Encoding = Encoding::Pointer(&Self::ENCODING);
32}
33
34/// [Apple's documentation](https://developer.apple.com/documentation/appkit/nsfontcollectionmatchingoptionkey?language=objc)
35// NS_TYPED_ENUM
36pub type NSFontCollectionMatchingOptionKey = NSString;
37
38extern "C" {
39    /// [Apple's documentation](https://developer.apple.com/documentation/appkit/nsfontcollectionincludedisabledfontsoption?language=objc)
40    pub static NSFontCollectionIncludeDisabledFontsOption:
41        &'static NSFontCollectionMatchingOptionKey;
42}
43
44extern "C" {
45    /// [Apple's documentation](https://developer.apple.com/documentation/appkit/nsfontcollectionremoveduplicatesoption?language=objc)
46    pub static NSFontCollectionRemoveDuplicatesOption: &'static NSFontCollectionMatchingOptionKey;
47}
48
49extern "C" {
50    /// [Apple's documentation](https://developer.apple.com/documentation/appkit/nsfontcollectiondisallowautoactivationoption?language=objc)
51    pub static NSFontCollectionDisallowAutoActivationOption:
52        &'static NSFontCollectionMatchingOptionKey;
53}
54
55/// [Apple's documentation](https://developer.apple.com/documentation/appkit/nsfontcollectionname?language=objc)
56// NS_TYPED_EXTENSIBLE_ENUM
57pub type NSFontCollectionName = NSString;
58
59extern_class!(
60    /// [Apple's documentation](https://developer.apple.com/documentation/appkit/nsfontcollection?language=objc)
61    #[unsafe(super(NSObject))]
62    #[derive(Debug, PartialEq, Eq, Hash)]
63    pub struct NSFontCollection;
64);
65
66extern_conformance!(
67    unsafe impl NSCoding for NSFontCollection {}
68);
69
70extern_conformance!(
71    unsafe impl NSCopying for NSFontCollection {}
72);
73
74unsafe impl CopyingHelper for NSFontCollection {
75    type Result = Self;
76}
77
78extern_conformance!(
79    unsafe impl NSMutableCopying for NSFontCollection {}
80);
81
82unsafe impl MutableCopyingHelper for NSFontCollection {
83    type Result = NSMutableFontCollection;
84}
85
86extern_conformance!(
87    unsafe impl NSObjectProtocol for NSFontCollection {}
88);
89
90impl NSFontCollection {
91    extern_methods!(
92        #[cfg(feature = "NSFontDescriptor")]
93        #[unsafe(method(fontCollectionWithDescriptors:))]
94        #[unsafe(method_family = none)]
95        pub unsafe fn fontCollectionWithDescriptors(
96            query_descriptors: &NSArray<NSFontDescriptor>,
97        ) -> Retained<NSFontCollection>;
98
99        #[unsafe(method(fontCollectionWithAllAvailableDescriptors))]
100        #[unsafe(method_family = none)]
101        pub unsafe fn fontCollectionWithAllAvailableDescriptors() -> Retained<NSFontCollection>;
102
103        #[unsafe(method(fontCollectionWithLocale:))]
104        #[unsafe(method_family = none)]
105        pub unsafe fn fontCollectionWithLocale(
106            locale: &NSLocale,
107        ) -> Option<Retained<NSFontCollection>>;
108
109        #[unsafe(method(showFontCollection:withName:visibility:error:_))]
110        #[unsafe(method_family = none)]
111        pub unsafe fn showFontCollection_withName_visibility_error(
112            collection: &NSFontCollection,
113            name: &NSFontCollectionName,
114            visibility: NSFontCollectionVisibility,
115        ) -> Result<(), Retained<NSError>>;
116
117        #[unsafe(method(hideFontCollectionWithName:visibility:error:_))]
118        #[unsafe(method_family = none)]
119        pub unsafe fn hideFontCollectionWithName_visibility_error(
120            name: &NSFontCollectionName,
121            visibility: NSFontCollectionVisibility,
122        ) -> Result<(), Retained<NSError>>;
123
124        #[unsafe(method(renameFontCollectionWithName:visibility:toName:error:_))]
125        #[unsafe(method_family = none)]
126        pub unsafe fn renameFontCollectionWithName_visibility_toName_error(
127            old_name: &NSFontCollectionName,
128            visibility: NSFontCollectionVisibility,
129            new_name: &NSFontCollectionName,
130        ) -> Result<(), Retained<NSError>>;
131
132        #[unsafe(method(allFontCollectionNames))]
133        #[unsafe(method_family = none)]
134        pub unsafe fn allFontCollectionNames() -> Retained<NSArray<NSFontCollectionName>>;
135
136        #[unsafe(method(fontCollectionWithName:))]
137        #[unsafe(method_family = none)]
138        pub unsafe fn fontCollectionWithName(
139            name: &NSFontCollectionName,
140        ) -> Option<Retained<NSFontCollection>>;
141
142        #[unsafe(method(fontCollectionWithName:visibility:))]
143        #[unsafe(method_family = none)]
144        pub unsafe fn fontCollectionWithName_visibility(
145            name: &NSFontCollectionName,
146            visibility: NSFontCollectionVisibility,
147        ) -> Option<Retained<NSFontCollection>>;
148
149        #[cfg(feature = "NSFontDescriptor")]
150        #[unsafe(method(queryDescriptors))]
151        #[unsafe(method_family = none)]
152        pub unsafe fn queryDescriptors(&self) -> Option<Retained<NSArray<NSFontDescriptor>>>;
153
154        #[cfg(feature = "NSFontDescriptor")]
155        #[unsafe(method(exclusionDescriptors))]
156        #[unsafe(method_family = none)]
157        pub unsafe fn exclusionDescriptors(&self) -> Option<Retained<NSArray<NSFontDescriptor>>>;
158
159        #[cfg(feature = "NSFontDescriptor")]
160        #[unsafe(method(matchingDescriptors))]
161        #[unsafe(method_family = none)]
162        pub unsafe fn matchingDescriptors(&self) -> Option<Retained<NSArray<NSFontDescriptor>>>;
163
164        #[cfg(feature = "NSFontDescriptor")]
165        #[unsafe(method(matchingDescriptorsWithOptions:))]
166        #[unsafe(method_family = none)]
167        pub unsafe fn matchingDescriptorsWithOptions(
168            &self,
169            options: Option<&NSDictionary<NSFontCollectionMatchingOptionKey, NSNumber>>,
170        ) -> Option<Retained<NSArray<NSFontDescriptor>>>;
171
172        #[cfg(feature = "NSFontDescriptor")]
173        #[unsafe(method(matchingDescriptorsForFamily:))]
174        #[unsafe(method_family = none)]
175        pub unsafe fn matchingDescriptorsForFamily(
176            &self,
177            family: &NSString,
178        ) -> Option<Retained<NSArray<NSFontDescriptor>>>;
179
180        #[cfg(feature = "NSFontDescriptor")]
181        #[unsafe(method(matchingDescriptorsForFamily:options:))]
182        #[unsafe(method_family = none)]
183        pub unsafe fn matchingDescriptorsForFamily_options(
184            &self,
185            family: &NSString,
186            options: Option<&NSDictionary<NSFontCollectionMatchingOptionKey, NSNumber>>,
187        ) -> Option<Retained<NSArray<NSFontDescriptor>>>;
188    );
189}
190
191/// Methods declared on superclass `NSObject`.
192impl NSFontCollection {
193    extern_methods!(
194        #[unsafe(method(init))]
195        #[unsafe(method_family = init)]
196        pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>;
197
198        #[unsafe(method(new))]
199        #[unsafe(method_family = new)]
200        pub unsafe fn new() -> Retained<Self>;
201    );
202}
203
204extern_class!(
205    /// [Apple's documentation](https://developer.apple.com/documentation/appkit/nsmutablefontcollection?language=objc)
206    #[unsafe(super(NSFontCollection, NSObject))]
207    #[derive(Debug, PartialEq, Eq, Hash)]
208    pub struct NSMutableFontCollection;
209);
210
211extern_conformance!(
212    unsafe impl NSCoding for NSMutableFontCollection {}
213);
214
215extern_conformance!(
216    unsafe impl NSCopying for NSMutableFontCollection {}
217);
218
219unsafe impl CopyingHelper for NSMutableFontCollection {
220    type Result = NSFontCollection;
221}
222
223extern_conformance!(
224    unsafe impl NSMutableCopying for NSMutableFontCollection {}
225);
226
227unsafe impl MutableCopyingHelper for NSMutableFontCollection {
228    type Result = Self;
229}
230
231extern_conformance!(
232    unsafe impl NSObjectProtocol for NSMutableFontCollection {}
233);
234
235impl NSMutableFontCollection {
236    extern_methods!(
237        #[cfg(feature = "NSFontDescriptor")]
238        #[unsafe(method(fontCollectionWithDescriptors:))]
239        #[unsafe(method_family = none)]
240        pub unsafe fn fontCollectionWithDescriptors(
241            query_descriptors: &NSArray<NSFontDescriptor>,
242        ) -> Retained<NSMutableFontCollection>;
243
244        #[unsafe(method(fontCollectionWithAllAvailableDescriptors))]
245        #[unsafe(method_family = none)]
246        pub unsafe fn fontCollectionWithAllAvailableDescriptors(
247        ) -> Retained<NSMutableFontCollection>;
248
249        #[unsafe(method(fontCollectionWithLocale:))]
250        #[unsafe(method_family = none)]
251        pub unsafe fn fontCollectionWithLocale(
252            locale: &NSLocale,
253        ) -> Retained<NSMutableFontCollection>;
254
255        #[unsafe(method(fontCollectionWithName:))]
256        #[unsafe(method_family = none)]
257        pub unsafe fn fontCollectionWithName(
258            name: &NSFontCollectionName,
259        ) -> Option<Retained<NSMutableFontCollection>>;
260
261        #[unsafe(method(fontCollectionWithName:visibility:))]
262        #[unsafe(method_family = none)]
263        pub unsafe fn fontCollectionWithName_visibility(
264            name: &NSFontCollectionName,
265            visibility: NSFontCollectionVisibility,
266        ) -> Option<Retained<NSMutableFontCollection>>;
267
268        #[cfg(feature = "NSFontDescriptor")]
269        #[unsafe(method(queryDescriptors))]
270        #[unsafe(method_family = none)]
271        pub unsafe fn queryDescriptors(&self) -> Option<Retained<NSArray<NSFontDescriptor>>>;
272
273        #[cfg(feature = "NSFontDescriptor")]
274        /// Setter for [`queryDescriptors`][Self::queryDescriptors].
275        #[unsafe(method(setQueryDescriptors:))]
276        #[unsafe(method_family = none)]
277        pub unsafe fn setQueryDescriptors(
278            &self,
279            query_descriptors: Option<&NSArray<NSFontDescriptor>>,
280        );
281
282        #[cfg(feature = "NSFontDescriptor")]
283        #[unsafe(method(exclusionDescriptors))]
284        #[unsafe(method_family = none)]
285        pub unsafe fn exclusionDescriptors(&self) -> Option<Retained<NSArray<NSFontDescriptor>>>;
286
287        #[cfg(feature = "NSFontDescriptor")]
288        /// Setter for [`exclusionDescriptors`][Self::exclusionDescriptors].
289        #[unsafe(method(setExclusionDescriptors:))]
290        #[unsafe(method_family = none)]
291        pub unsafe fn setExclusionDescriptors(
292            &self,
293            exclusion_descriptors: Option<&NSArray<NSFontDescriptor>>,
294        );
295
296        #[cfg(feature = "NSFontDescriptor")]
297        #[unsafe(method(addQueryForDescriptors:))]
298        #[unsafe(method_family = none)]
299        pub unsafe fn addQueryForDescriptors(&self, descriptors: &NSArray<NSFontDescriptor>);
300
301        #[cfg(feature = "NSFontDescriptor")]
302        #[unsafe(method(removeQueryForDescriptors:))]
303        #[unsafe(method_family = none)]
304        pub unsafe fn removeQueryForDescriptors(&self, descriptors: &NSArray<NSFontDescriptor>);
305    );
306}
307
308/// Methods declared on superclass `NSObject`.
309impl NSMutableFontCollection {
310    extern_methods!(
311        #[unsafe(method(init))]
312        #[unsafe(method_family = init)]
313        pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>;
314
315        #[unsafe(method(new))]
316        #[unsafe(method_family = new)]
317        pub unsafe fn new() -> Retained<Self>;
318    );
319}
320
321extern "C" {
322    /// [Apple's documentation](https://developer.apple.com/documentation/appkit/nsfontcollectiondidchangenotification?language=objc)
323    pub static NSFontCollectionDidChangeNotification: &'static NSNotificationName;
324}
325
326/// [Apple's documentation](https://developer.apple.com/documentation/appkit/nsfontcollectionuserinfokey?language=objc)
327// NS_TYPED_ENUM
328pub type NSFontCollectionUserInfoKey = NSString;
329
330extern "C" {
331    /// [Apple's documentation](https://developer.apple.com/documentation/appkit/nsfontcollectionactionkey?language=objc)
332    pub static NSFontCollectionActionKey: &'static NSFontCollectionUserInfoKey;
333}
334
335extern "C" {
336    /// [Apple's documentation](https://developer.apple.com/documentation/appkit/nsfontcollectionnamekey?language=objc)
337    pub static NSFontCollectionNameKey: &'static NSFontCollectionUserInfoKey;
338}
339
340extern "C" {
341    /// [Apple's documentation](https://developer.apple.com/documentation/appkit/nsfontcollectionoldnamekey?language=objc)
342    pub static NSFontCollectionOldNameKey: &'static NSFontCollectionUserInfoKey;
343}
344
345extern "C" {
346    /// [Apple's documentation](https://developer.apple.com/documentation/appkit/nsfontcollectionvisibilitykey?language=objc)
347    pub static NSFontCollectionVisibilityKey: &'static NSFontCollectionUserInfoKey;
348}
349
350/// [Apple's documentation](https://developer.apple.com/documentation/appkit/nsfontcollectionactiontypekey?language=objc)
351// NS_TYPED_ENUM
352pub type NSFontCollectionActionTypeKey = NSString;
353
354extern "C" {
355    /// [Apple's documentation](https://developer.apple.com/documentation/appkit/nsfontcollectionwasshown?language=objc)
356    pub static NSFontCollectionWasShown: &'static NSFontCollectionActionTypeKey;
357}
358
359extern "C" {
360    /// [Apple's documentation](https://developer.apple.com/documentation/appkit/nsfontcollectionwashidden?language=objc)
361    pub static NSFontCollectionWasHidden: &'static NSFontCollectionActionTypeKey;
362}
363
364extern "C" {
365    /// [Apple's documentation](https://developer.apple.com/documentation/appkit/nsfontcollectionwasrenamed?language=objc)
366    pub static NSFontCollectionWasRenamed: &'static NSFontCollectionActionTypeKey;
367}
368
369extern "C" {
370    /// [Apple's documentation](https://developer.apple.com/documentation/appkit/nsfontcollectionallfonts?language=objc)
371    pub static NSFontCollectionAllFonts: &'static NSFontCollectionName;
372}
373
374extern "C" {
375    /// [Apple's documentation](https://developer.apple.com/documentation/appkit/nsfontcollectionuser?language=objc)
376    pub static NSFontCollectionUser: &'static NSFontCollectionName;
377}
378
379extern "C" {
380    /// [Apple's documentation](https://developer.apple.com/documentation/appkit/nsfontcollectionfavorites?language=objc)
381    pub static NSFontCollectionFavorites: &'static NSFontCollectionName;
382}
383
384extern "C" {
385    /// [Apple's documentation](https://developer.apple.com/documentation/appkit/nsfontcollectionrecentlyused?language=objc)
386    pub static NSFontCollectionRecentlyUsed: &'static NSFontCollectionName;
387}