icrate/generated/Foundation/
NSLocale.rs

1//! This file has been automatically generated by `objc2`'s `header-translator`.
2//! DO NOT EDIT
3use crate::common::*;
4use crate::Foundation::*;
5
6typed_enum!(
7    pub type NSLocaleKey = NSString;
8);
9
10extern_class!(
11    #[derive(Debug, PartialEq, Eq, Hash)]
12    #[cfg(feature = "Foundation_NSLocale")]
13    pub struct NSLocale;
14
15    #[cfg(feature = "Foundation_NSLocale")]
16    unsafe impl ClassType for NSLocale {
17        type Super = NSObject;
18        type Mutability = InteriorMutable;
19    }
20);
21
22#[cfg(feature = "Foundation_NSLocale")]
23unsafe impl Send for NSLocale {}
24
25#[cfg(feature = "Foundation_NSLocale")]
26unsafe impl Sync for NSLocale {}
27
28#[cfg(feature = "Foundation_NSLocale")]
29unsafe impl NSCoding for NSLocale {}
30
31#[cfg(feature = "Foundation_NSLocale")]
32unsafe impl NSCopying for NSLocale {}
33
34#[cfg(feature = "Foundation_NSLocale")]
35unsafe impl NSObjectProtocol for NSLocale {}
36
37#[cfg(feature = "Foundation_NSLocale")]
38unsafe impl NSSecureCoding for NSLocale {}
39
40extern_methods!(
41    #[cfg(feature = "Foundation_NSLocale")]
42    unsafe impl NSLocale {
43        #[method_id(@__retain_semantics Other objectForKey:)]
44        pub unsafe fn objectForKey(&self, key: &NSLocaleKey) -> Option<Id<AnyObject>>;
45
46        #[cfg(feature = "Foundation_NSString")]
47        #[method_id(@__retain_semantics Other displayNameForKey:value:)]
48        pub unsafe fn displayNameForKey_value(
49            &self,
50            key: &NSLocaleKey,
51            value: &AnyObject,
52        ) -> Option<Id<NSString>>;
53
54        #[cfg(feature = "Foundation_NSString")]
55        #[method_id(@__retain_semantics Init initWithLocaleIdentifier:)]
56        pub unsafe fn initWithLocaleIdentifier(
57            this: Allocated<Self>,
58            string: &NSString,
59        ) -> Id<Self>;
60
61        #[cfg(feature = "Foundation_NSCoder")]
62        #[method_id(@__retain_semantics Init initWithCoder:)]
63        pub unsafe fn initWithCoder(this: Allocated<Self>, coder: &NSCoder) -> Option<Id<Self>>;
64    }
65);
66
67extern_methods!(
68    /// NSExtendedLocale
69    #[cfg(feature = "Foundation_NSLocale")]
70    unsafe impl NSLocale {
71        #[cfg(feature = "Foundation_NSString")]
72        #[method_id(@__retain_semantics Other localeIdentifier)]
73        pub unsafe fn localeIdentifier(&self) -> Id<NSString>;
74
75        #[cfg(feature = "Foundation_NSString")]
76        #[method_id(@__retain_semantics Other localizedStringForLocaleIdentifier:)]
77        pub unsafe fn localizedStringForLocaleIdentifier(
78            &self,
79            locale_identifier: &NSString,
80        ) -> Id<NSString>;
81
82        #[cfg(feature = "Foundation_NSString")]
83        #[method_id(@__retain_semantics Other languageCode)]
84        pub unsafe fn languageCode(&self) -> Id<NSString>;
85
86        #[cfg(feature = "Foundation_NSString")]
87        #[method_id(@__retain_semantics Other localizedStringForLanguageCode:)]
88        pub unsafe fn localizedStringForLanguageCode(
89            &self,
90            language_code: &NSString,
91        ) -> Option<Id<NSString>>;
92
93        #[cfg(feature = "Foundation_NSString")]
94        #[method_id(@__retain_semantics Other languageIdentifier)]
95        pub unsafe fn languageIdentifier(&self) -> Id<NSString>;
96
97        #[cfg(feature = "Foundation_NSString")]
98        #[deprecated]
99        #[method_id(@__retain_semantics Other countryCode)]
100        pub unsafe fn countryCode(&self) -> Option<Id<NSString>>;
101
102        #[cfg(feature = "Foundation_NSString")]
103        #[method_id(@__retain_semantics Other localizedStringForCountryCode:)]
104        pub unsafe fn localizedStringForCountryCode(
105            &self,
106            country_code: &NSString,
107        ) -> Option<Id<NSString>>;
108
109        #[cfg(feature = "Foundation_NSString")]
110        #[method_id(@__retain_semantics Other regionCode)]
111        pub unsafe fn regionCode(&self) -> Option<Id<NSString>>;
112
113        #[cfg(feature = "Foundation_NSString")]
114        #[method_id(@__retain_semantics Other scriptCode)]
115        pub unsafe fn scriptCode(&self) -> Option<Id<NSString>>;
116
117        #[cfg(feature = "Foundation_NSString")]
118        #[method_id(@__retain_semantics Other localizedStringForScriptCode:)]
119        pub unsafe fn localizedStringForScriptCode(
120            &self,
121            script_code: &NSString,
122        ) -> Option<Id<NSString>>;
123
124        #[cfg(feature = "Foundation_NSString")]
125        #[method_id(@__retain_semantics Other variantCode)]
126        pub unsafe fn variantCode(&self) -> Option<Id<NSString>>;
127
128        #[cfg(feature = "Foundation_NSString")]
129        #[method_id(@__retain_semantics Other localizedStringForVariantCode:)]
130        pub unsafe fn localizedStringForVariantCode(
131            &self,
132            variant_code: &NSString,
133        ) -> Option<Id<NSString>>;
134
135        #[cfg(feature = "Foundation_NSCharacterSet")]
136        #[method_id(@__retain_semantics Other exemplarCharacterSet)]
137        pub unsafe fn exemplarCharacterSet(&self) -> Id<NSCharacterSet>;
138
139        #[cfg(feature = "Foundation_NSString")]
140        #[method_id(@__retain_semantics Other calendarIdentifier)]
141        pub unsafe fn calendarIdentifier(&self) -> Id<NSString>;
142
143        #[cfg(feature = "Foundation_NSString")]
144        #[method_id(@__retain_semantics Other localizedStringForCalendarIdentifier:)]
145        pub unsafe fn localizedStringForCalendarIdentifier(
146            &self,
147            calendar_identifier: &NSString,
148        ) -> Option<Id<NSString>>;
149
150        #[cfg(feature = "Foundation_NSString")]
151        #[method_id(@__retain_semantics Other collationIdentifier)]
152        pub unsafe fn collationIdentifier(&self) -> Option<Id<NSString>>;
153
154        #[cfg(feature = "Foundation_NSString")]
155        #[method_id(@__retain_semantics Other localizedStringForCollationIdentifier:)]
156        pub unsafe fn localizedStringForCollationIdentifier(
157            &self,
158            collation_identifier: &NSString,
159        ) -> Option<Id<NSString>>;
160
161        #[method(usesMetricSystem)]
162        pub unsafe fn usesMetricSystem(&self) -> bool;
163
164        #[cfg(feature = "Foundation_NSString")]
165        #[method_id(@__retain_semantics Other decimalSeparator)]
166        pub unsafe fn decimalSeparator(&self) -> Id<NSString>;
167
168        #[cfg(feature = "Foundation_NSString")]
169        #[method_id(@__retain_semantics Other groupingSeparator)]
170        pub unsafe fn groupingSeparator(&self) -> Id<NSString>;
171
172        #[cfg(feature = "Foundation_NSString")]
173        #[method_id(@__retain_semantics Other currencySymbol)]
174        pub unsafe fn currencySymbol(&self) -> Id<NSString>;
175
176        #[cfg(feature = "Foundation_NSString")]
177        #[method_id(@__retain_semantics Other currencyCode)]
178        pub unsafe fn currencyCode(&self) -> Option<Id<NSString>>;
179
180        #[cfg(feature = "Foundation_NSString")]
181        #[method_id(@__retain_semantics Other localizedStringForCurrencyCode:)]
182        pub unsafe fn localizedStringForCurrencyCode(
183            &self,
184            currency_code: &NSString,
185        ) -> Option<Id<NSString>>;
186
187        #[cfg(feature = "Foundation_NSString")]
188        #[method_id(@__retain_semantics Other collatorIdentifier)]
189        pub unsafe fn collatorIdentifier(&self) -> Id<NSString>;
190
191        #[cfg(feature = "Foundation_NSString")]
192        #[method_id(@__retain_semantics Other localizedStringForCollatorIdentifier:)]
193        pub unsafe fn localizedStringForCollatorIdentifier(
194            &self,
195            collator_identifier: &NSString,
196        ) -> Option<Id<NSString>>;
197
198        #[cfg(feature = "Foundation_NSString")]
199        #[method_id(@__retain_semantics Other quotationBeginDelimiter)]
200        pub unsafe fn quotationBeginDelimiter(&self) -> Id<NSString>;
201
202        #[cfg(feature = "Foundation_NSString")]
203        #[method_id(@__retain_semantics Other quotationEndDelimiter)]
204        pub unsafe fn quotationEndDelimiter(&self) -> Id<NSString>;
205
206        #[cfg(feature = "Foundation_NSString")]
207        #[method_id(@__retain_semantics Other alternateQuotationBeginDelimiter)]
208        pub unsafe fn alternateQuotationBeginDelimiter(&self) -> Id<NSString>;
209
210        #[cfg(feature = "Foundation_NSString")]
211        #[method_id(@__retain_semantics Other alternateQuotationEndDelimiter)]
212        pub unsafe fn alternateQuotationEndDelimiter(&self) -> Id<NSString>;
213    }
214);
215
216extern_methods!(
217    /// NSLocaleCreation
218    #[cfg(feature = "Foundation_NSLocale")]
219    unsafe impl NSLocale {
220        #[method_id(@__retain_semantics Other autoupdatingCurrentLocale)]
221        pub unsafe fn autoupdatingCurrentLocale() -> Id<NSLocale>;
222
223        #[method_id(@__retain_semantics Other currentLocale)]
224        pub unsafe fn currentLocale() -> Id<NSLocale>;
225
226        #[method_id(@__retain_semantics Other systemLocale)]
227        pub unsafe fn systemLocale() -> Id<NSLocale>;
228
229        #[cfg(feature = "Foundation_NSString")]
230        #[method_id(@__retain_semantics Other localeWithLocaleIdentifier:)]
231        pub unsafe fn localeWithLocaleIdentifier(ident: &NSString) -> Id<Self>;
232    }
233);
234
235ns_enum!(
236    #[underlying(NSUInteger)]
237    pub enum NSLocaleLanguageDirection {
238        NSLocaleLanguageDirectionUnknown = 0,
239        NSLocaleLanguageDirectionLeftToRight = 1,
240        NSLocaleLanguageDirectionRightToLeft = 2,
241        NSLocaleLanguageDirectionTopToBottom = 3,
242        NSLocaleLanguageDirectionBottomToTop = 4,
243    }
244);
245
246extern_methods!(
247    /// NSLocaleGeneralInfo
248    #[cfg(feature = "Foundation_NSLocale")]
249    unsafe impl NSLocale {
250        #[cfg(all(feature = "Foundation_NSArray", feature = "Foundation_NSString"))]
251        #[method_id(@__retain_semantics Other availableLocaleIdentifiers)]
252        pub unsafe fn availableLocaleIdentifiers() -> Id<NSArray<NSString>>;
253
254        #[cfg(all(feature = "Foundation_NSArray", feature = "Foundation_NSString"))]
255        #[method_id(@__retain_semantics Other ISOLanguageCodes)]
256        pub unsafe fn ISOLanguageCodes() -> Id<NSArray<NSString>>;
257
258        #[cfg(all(feature = "Foundation_NSArray", feature = "Foundation_NSString"))]
259        #[method_id(@__retain_semantics Other ISOCountryCodes)]
260        pub unsafe fn ISOCountryCodes() -> Id<NSArray<NSString>>;
261
262        #[cfg(all(feature = "Foundation_NSArray", feature = "Foundation_NSString"))]
263        #[method_id(@__retain_semantics Other ISOCurrencyCodes)]
264        pub unsafe fn ISOCurrencyCodes() -> Id<NSArray<NSString>>;
265
266        #[cfg(all(feature = "Foundation_NSArray", feature = "Foundation_NSString"))]
267        #[method_id(@__retain_semantics Other commonISOCurrencyCodes)]
268        pub unsafe fn commonISOCurrencyCodes() -> Id<NSArray<NSString>>;
269
270        #[cfg(all(feature = "Foundation_NSArray", feature = "Foundation_NSString"))]
271        #[method_id(@__retain_semantics Other preferredLanguages)]
272        pub unsafe fn preferredLanguages() -> Id<NSArray<NSString>>;
273
274        #[cfg(all(feature = "Foundation_NSDictionary", feature = "Foundation_NSString"))]
275        #[method_id(@__retain_semantics Other componentsFromLocaleIdentifier:)]
276        pub unsafe fn componentsFromLocaleIdentifier(
277            string: &NSString,
278        ) -> Id<NSDictionary<NSString, NSString>>;
279
280        #[cfg(all(feature = "Foundation_NSDictionary", feature = "Foundation_NSString"))]
281        #[method_id(@__retain_semantics Other localeIdentifierFromComponents:)]
282        pub unsafe fn localeIdentifierFromComponents(
283            dict: &NSDictionary<NSString, NSString>,
284        ) -> Id<NSString>;
285
286        #[cfg(feature = "Foundation_NSString")]
287        #[method_id(@__retain_semantics Other canonicalLocaleIdentifierFromString:)]
288        pub unsafe fn canonicalLocaleIdentifierFromString(string: &NSString) -> Id<NSString>;
289
290        #[cfg(feature = "Foundation_NSString")]
291        #[method_id(@__retain_semantics Other canonicalLanguageIdentifierFromString:)]
292        pub unsafe fn canonicalLanguageIdentifierFromString(string: &NSString) -> Id<NSString>;
293
294        #[cfg(feature = "Foundation_NSString")]
295        #[method_id(@__retain_semantics Other localeIdentifierFromWindowsLocaleCode:)]
296        pub unsafe fn localeIdentifierFromWindowsLocaleCode(lcid: u32) -> Option<Id<NSString>>;
297
298        #[cfg(feature = "Foundation_NSString")]
299        #[method(windowsLocaleCodeFromLocaleIdentifier:)]
300        pub unsafe fn windowsLocaleCodeFromLocaleIdentifier(locale_identifier: &NSString) -> u32;
301
302        #[cfg(feature = "Foundation_NSString")]
303        #[method(characterDirectionForLanguage:)]
304        pub unsafe fn characterDirectionForLanguage(
305            iso_lang_code: &NSString,
306        ) -> NSLocaleLanguageDirection;
307
308        #[cfg(feature = "Foundation_NSString")]
309        #[method(lineDirectionForLanguage:)]
310        pub unsafe fn lineDirectionForLanguage(
311            iso_lang_code: &NSString,
312        ) -> NSLocaleLanguageDirection;
313    }
314);
315
316extern_static!(NSCurrentLocaleDidChangeNotification: &'static NSNotificationName);
317
318extern_static!(NSLocaleIdentifier: &'static NSLocaleKey);
319
320extern_static!(NSLocaleLanguageCode: &'static NSLocaleKey);
321
322extern_static!(NSLocaleCountryCode: &'static NSLocaleKey);
323
324extern_static!(NSLocaleScriptCode: &'static NSLocaleKey);
325
326extern_static!(NSLocaleVariantCode: &'static NSLocaleKey);
327
328extern_static!(NSLocaleExemplarCharacterSet: &'static NSLocaleKey);
329
330extern_static!(NSLocaleCalendar: &'static NSLocaleKey);
331
332extern_static!(NSLocaleCollationIdentifier: &'static NSLocaleKey);
333
334extern_static!(NSLocaleUsesMetricSystem: &'static NSLocaleKey);
335
336extern_static!(NSLocaleMeasurementSystem: &'static NSLocaleKey);
337
338extern_static!(NSLocaleDecimalSeparator: &'static NSLocaleKey);
339
340extern_static!(NSLocaleGroupingSeparator: &'static NSLocaleKey);
341
342extern_static!(NSLocaleCurrencySymbol: &'static NSLocaleKey);
343
344extern_static!(NSLocaleCurrencyCode: &'static NSLocaleKey);
345
346extern_static!(NSLocaleCollatorIdentifier: &'static NSLocaleKey);
347
348extern_static!(NSLocaleQuotationBeginDelimiterKey: &'static NSLocaleKey);
349
350extern_static!(NSLocaleQuotationEndDelimiterKey: &'static NSLocaleKey);
351
352extern_static!(NSLocaleAlternateQuotationBeginDelimiterKey: &'static NSLocaleKey);
353
354extern_static!(NSLocaleAlternateQuotationEndDelimiterKey: &'static NSLocaleKey);
355
356extern_static!(NSGregorianCalendar: &'static NSString);
357
358extern_static!(NSBuddhistCalendar: &'static NSString);
359
360extern_static!(NSChineseCalendar: &'static NSString);
361
362extern_static!(NSHebrewCalendar: &'static NSString);
363
364extern_static!(NSIslamicCalendar: &'static NSString);
365
366extern_static!(NSIslamicCivilCalendar: &'static NSString);
367
368extern_static!(NSJapaneseCalendar: &'static NSString);
369
370extern_static!(NSRepublicOfChinaCalendar: &'static NSString);
371
372extern_static!(NSPersianCalendar: &'static NSString);
373
374extern_static!(NSIndianCalendar: &'static NSString);
375
376extern_static!(NSISO8601Calendar: &'static NSString);