icrate/generated/Foundation/
NSDateFormatter.rs

1//! This file has been automatically generated by `objc2`'s `header-translator`.
2//! DO NOT EDIT
3use crate::common::*;
4use crate::Foundation::*;
5
6ns_enum!(
7    #[underlying(NSUInteger)]
8    pub enum NSDateFormatterStyle {
9        NSDateFormatterNoStyle = 0,
10        NSDateFormatterShortStyle = 1,
11        NSDateFormatterMediumStyle = 2,
12        NSDateFormatterLongStyle = 3,
13        NSDateFormatterFullStyle = 4,
14    }
15);
16
17ns_enum!(
18    #[underlying(NSUInteger)]
19    pub enum NSDateFormatterBehavior {
20        NSDateFormatterBehaviorDefault = 0,
21        NSDateFormatterBehavior10_0 = 1000,
22        NSDateFormatterBehavior10_4 = 1040,
23    }
24);
25
26extern_class!(
27    #[derive(Debug, PartialEq, Eq, Hash)]
28    #[cfg(feature = "Foundation_NSDateFormatter")]
29    pub struct NSDateFormatter;
30
31    #[cfg(feature = "Foundation_NSDateFormatter")]
32    unsafe impl ClassType for NSDateFormatter {
33        #[inherits(NSObject)]
34        type Super = NSFormatter;
35        type Mutability = InteriorMutable;
36    }
37);
38
39#[cfg(feature = "Foundation_NSDateFormatter")]
40unsafe impl Send for NSDateFormatter {}
41
42#[cfg(feature = "Foundation_NSDateFormatter")]
43unsafe impl Sync for NSDateFormatter {}
44
45#[cfg(feature = "Foundation_NSDateFormatter")]
46unsafe impl NSCoding for NSDateFormatter {}
47
48#[cfg(feature = "Foundation_NSDateFormatter")]
49unsafe impl NSCopying for NSDateFormatter {}
50
51#[cfg(feature = "Foundation_NSDateFormatter")]
52unsafe impl NSObjectProtocol for NSDateFormatter {}
53
54extern_methods!(
55    #[cfg(feature = "Foundation_NSDateFormatter")]
56    unsafe impl NSDateFormatter {
57        #[method(formattingContext)]
58        pub unsafe fn formattingContext(&self) -> NSFormattingContext;
59
60        #[method(setFormattingContext:)]
61        pub unsafe fn setFormattingContext(&self, formatting_context: NSFormattingContext);
62
63        #[cfg(all(feature = "Foundation_NSError", feature = "Foundation_NSString"))]
64        #[method(getObjectValue:forString:range:error:_)]
65        pub unsafe fn getObjectValue_forString_range_error(
66            &self,
67            obj: Option<&mut Option<Id<AnyObject>>>,
68            string: &NSString,
69            rangep: *mut NSRange,
70        ) -> Result<(), Id<NSError>>;
71
72        #[cfg(all(feature = "Foundation_NSDate", feature = "Foundation_NSString"))]
73        #[method_id(@__retain_semantics Other stringFromDate:)]
74        pub unsafe fn stringFromDate(&self, date: &NSDate) -> Id<NSString>;
75
76        #[cfg(all(feature = "Foundation_NSDate", feature = "Foundation_NSString"))]
77        #[method_id(@__retain_semantics Other dateFromString:)]
78        pub unsafe fn dateFromString(&self, string: &NSString) -> Option<Id<NSDate>>;
79
80        #[cfg(all(feature = "Foundation_NSDate", feature = "Foundation_NSString"))]
81        #[method_id(@__retain_semantics Other localizedStringFromDate:dateStyle:timeStyle:)]
82        pub unsafe fn localizedStringFromDate_dateStyle_timeStyle(
83            date: &NSDate,
84            dstyle: NSDateFormatterStyle,
85            tstyle: NSDateFormatterStyle,
86        ) -> Id<NSString>;
87
88        #[cfg(all(feature = "Foundation_NSLocale", feature = "Foundation_NSString"))]
89        #[method_id(@__retain_semantics Other dateFormatFromTemplate:options:locale:)]
90        pub unsafe fn dateFormatFromTemplate_options_locale(
91            tmplate: &NSString,
92            opts: NSUInteger,
93            locale: Option<&NSLocale>,
94        ) -> Option<Id<NSString>>;
95
96        #[method(defaultFormatterBehavior)]
97        pub unsafe fn defaultFormatterBehavior() -> NSDateFormatterBehavior;
98
99        #[method(setDefaultFormatterBehavior:)]
100        pub unsafe fn setDefaultFormatterBehavior(
101            default_formatter_behavior: NSDateFormatterBehavior,
102        );
103
104        #[cfg(feature = "Foundation_NSString")]
105        #[method(setLocalizedDateFormatFromTemplate:)]
106        pub unsafe fn setLocalizedDateFormatFromTemplate(&self, date_format_template: &NSString);
107
108        #[cfg(feature = "Foundation_NSString")]
109        #[method_id(@__retain_semantics Other dateFormat)]
110        pub unsafe fn dateFormat(&self) -> Id<NSString>;
111
112        #[cfg(feature = "Foundation_NSString")]
113        #[method(setDateFormat:)]
114        pub unsafe fn setDateFormat(&self, date_format: Option<&NSString>);
115
116        #[method(dateStyle)]
117        pub unsafe fn dateStyle(&self) -> NSDateFormatterStyle;
118
119        #[method(setDateStyle:)]
120        pub unsafe fn setDateStyle(&self, date_style: NSDateFormatterStyle);
121
122        #[method(timeStyle)]
123        pub unsafe fn timeStyle(&self) -> NSDateFormatterStyle;
124
125        #[method(setTimeStyle:)]
126        pub unsafe fn setTimeStyle(&self, time_style: NSDateFormatterStyle);
127
128        #[cfg(feature = "Foundation_NSLocale")]
129        #[method_id(@__retain_semantics Other locale)]
130        pub unsafe fn locale(&self) -> Id<NSLocale>;
131
132        #[cfg(feature = "Foundation_NSLocale")]
133        #[method(setLocale:)]
134        pub unsafe fn setLocale(&self, locale: Option<&NSLocale>);
135
136        #[method(generatesCalendarDates)]
137        pub unsafe fn generatesCalendarDates(&self) -> bool;
138
139        #[method(setGeneratesCalendarDates:)]
140        pub unsafe fn setGeneratesCalendarDates(&self, generates_calendar_dates: bool);
141
142        #[method(formatterBehavior)]
143        pub unsafe fn formatterBehavior(&self) -> NSDateFormatterBehavior;
144
145        #[method(setFormatterBehavior:)]
146        pub unsafe fn setFormatterBehavior(&self, formatter_behavior: NSDateFormatterBehavior);
147
148        #[cfg(feature = "Foundation_NSTimeZone")]
149        #[method_id(@__retain_semantics Other timeZone)]
150        pub unsafe fn timeZone(&self) -> Id<NSTimeZone>;
151
152        #[cfg(feature = "Foundation_NSTimeZone")]
153        #[method(setTimeZone:)]
154        pub unsafe fn setTimeZone(&self, time_zone: Option<&NSTimeZone>);
155
156        #[cfg(feature = "Foundation_NSCalendar")]
157        #[method_id(@__retain_semantics Other calendar)]
158        pub unsafe fn calendar(&self) -> Id<NSCalendar>;
159
160        #[cfg(feature = "Foundation_NSCalendar")]
161        #[method(setCalendar:)]
162        pub unsafe fn setCalendar(&self, calendar: Option<&NSCalendar>);
163
164        #[method(isLenient)]
165        pub unsafe fn isLenient(&self) -> bool;
166
167        #[method(setLenient:)]
168        pub unsafe fn setLenient(&self, lenient: bool);
169
170        #[cfg(feature = "Foundation_NSDate")]
171        #[method_id(@__retain_semantics Other twoDigitStartDate)]
172        pub unsafe fn twoDigitStartDate(&self) -> Option<Id<NSDate>>;
173
174        #[cfg(feature = "Foundation_NSDate")]
175        #[method(setTwoDigitStartDate:)]
176        pub unsafe fn setTwoDigitStartDate(&self, two_digit_start_date: Option<&NSDate>);
177
178        #[cfg(feature = "Foundation_NSDate")]
179        #[method_id(@__retain_semantics Other defaultDate)]
180        pub unsafe fn defaultDate(&self) -> Option<Id<NSDate>>;
181
182        #[cfg(feature = "Foundation_NSDate")]
183        #[method(setDefaultDate:)]
184        pub unsafe fn setDefaultDate(&self, default_date: Option<&NSDate>);
185
186        #[cfg(all(feature = "Foundation_NSArray", feature = "Foundation_NSString"))]
187        #[method_id(@__retain_semantics Other eraSymbols)]
188        pub unsafe fn eraSymbols(&self) -> Id<NSArray<NSString>>;
189
190        #[cfg(all(feature = "Foundation_NSArray", feature = "Foundation_NSString"))]
191        #[method(setEraSymbols:)]
192        pub unsafe fn setEraSymbols(&self, era_symbols: Option<&NSArray<NSString>>);
193
194        #[cfg(all(feature = "Foundation_NSArray", feature = "Foundation_NSString"))]
195        #[method_id(@__retain_semantics Other monthSymbols)]
196        pub unsafe fn monthSymbols(&self) -> Id<NSArray<NSString>>;
197
198        #[cfg(all(feature = "Foundation_NSArray", feature = "Foundation_NSString"))]
199        #[method(setMonthSymbols:)]
200        pub unsafe fn setMonthSymbols(&self, month_symbols: Option<&NSArray<NSString>>);
201
202        #[cfg(all(feature = "Foundation_NSArray", feature = "Foundation_NSString"))]
203        #[method_id(@__retain_semantics Other shortMonthSymbols)]
204        pub unsafe fn shortMonthSymbols(&self) -> Id<NSArray<NSString>>;
205
206        #[cfg(all(feature = "Foundation_NSArray", feature = "Foundation_NSString"))]
207        #[method(setShortMonthSymbols:)]
208        pub unsafe fn setShortMonthSymbols(&self, short_month_symbols: Option<&NSArray<NSString>>);
209
210        #[cfg(all(feature = "Foundation_NSArray", feature = "Foundation_NSString"))]
211        #[method_id(@__retain_semantics Other weekdaySymbols)]
212        pub unsafe fn weekdaySymbols(&self) -> Id<NSArray<NSString>>;
213
214        #[cfg(all(feature = "Foundation_NSArray", feature = "Foundation_NSString"))]
215        #[method(setWeekdaySymbols:)]
216        pub unsafe fn setWeekdaySymbols(&self, weekday_symbols: Option<&NSArray<NSString>>);
217
218        #[cfg(all(feature = "Foundation_NSArray", feature = "Foundation_NSString"))]
219        #[method_id(@__retain_semantics Other shortWeekdaySymbols)]
220        pub unsafe fn shortWeekdaySymbols(&self) -> Id<NSArray<NSString>>;
221
222        #[cfg(all(feature = "Foundation_NSArray", feature = "Foundation_NSString"))]
223        #[method(setShortWeekdaySymbols:)]
224        pub unsafe fn setShortWeekdaySymbols(
225            &self,
226            short_weekday_symbols: Option<&NSArray<NSString>>,
227        );
228
229        #[cfg(feature = "Foundation_NSString")]
230        #[method_id(@__retain_semantics Other AMSymbol)]
231        pub unsafe fn AMSymbol(&self) -> Id<NSString>;
232
233        #[cfg(feature = "Foundation_NSString")]
234        #[method(setAMSymbol:)]
235        pub unsafe fn setAMSymbol(&self, am_symbol: Option<&NSString>);
236
237        #[cfg(feature = "Foundation_NSString")]
238        #[method_id(@__retain_semantics Other PMSymbol)]
239        pub unsafe fn PMSymbol(&self) -> Id<NSString>;
240
241        #[cfg(feature = "Foundation_NSString")]
242        #[method(setPMSymbol:)]
243        pub unsafe fn setPMSymbol(&self, pm_symbol: Option<&NSString>);
244
245        #[cfg(all(feature = "Foundation_NSArray", feature = "Foundation_NSString"))]
246        #[method_id(@__retain_semantics Other longEraSymbols)]
247        pub unsafe fn longEraSymbols(&self) -> Id<NSArray<NSString>>;
248
249        #[cfg(all(feature = "Foundation_NSArray", feature = "Foundation_NSString"))]
250        #[method(setLongEraSymbols:)]
251        pub unsafe fn setLongEraSymbols(&self, long_era_symbols: Option<&NSArray<NSString>>);
252
253        #[cfg(all(feature = "Foundation_NSArray", feature = "Foundation_NSString"))]
254        #[method_id(@__retain_semantics Other veryShortMonthSymbols)]
255        pub unsafe fn veryShortMonthSymbols(&self) -> Id<NSArray<NSString>>;
256
257        #[cfg(all(feature = "Foundation_NSArray", feature = "Foundation_NSString"))]
258        #[method(setVeryShortMonthSymbols:)]
259        pub unsafe fn setVeryShortMonthSymbols(
260            &self,
261            very_short_month_symbols: Option<&NSArray<NSString>>,
262        );
263
264        #[cfg(all(feature = "Foundation_NSArray", feature = "Foundation_NSString"))]
265        #[method_id(@__retain_semantics Other standaloneMonthSymbols)]
266        pub unsafe fn standaloneMonthSymbols(&self) -> Id<NSArray<NSString>>;
267
268        #[cfg(all(feature = "Foundation_NSArray", feature = "Foundation_NSString"))]
269        #[method(setStandaloneMonthSymbols:)]
270        pub unsafe fn setStandaloneMonthSymbols(
271            &self,
272            standalone_month_symbols: Option<&NSArray<NSString>>,
273        );
274
275        #[cfg(all(feature = "Foundation_NSArray", feature = "Foundation_NSString"))]
276        #[method_id(@__retain_semantics Other shortStandaloneMonthSymbols)]
277        pub unsafe fn shortStandaloneMonthSymbols(&self) -> Id<NSArray<NSString>>;
278
279        #[cfg(all(feature = "Foundation_NSArray", feature = "Foundation_NSString"))]
280        #[method(setShortStandaloneMonthSymbols:)]
281        pub unsafe fn setShortStandaloneMonthSymbols(
282            &self,
283            short_standalone_month_symbols: Option<&NSArray<NSString>>,
284        );
285
286        #[cfg(all(feature = "Foundation_NSArray", feature = "Foundation_NSString"))]
287        #[method_id(@__retain_semantics Other veryShortStandaloneMonthSymbols)]
288        pub unsafe fn veryShortStandaloneMonthSymbols(&self) -> Id<NSArray<NSString>>;
289
290        #[cfg(all(feature = "Foundation_NSArray", feature = "Foundation_NSString"))]
291        #[method(setVeryShortStandaloneMonthSymbols:)]
292        pub unsafe fn setVeryShortStandaloneMonthSymbols(
293            &self,
294            very_short_standalone_month_symbols: Option<&NSArray<NSString>>,
295        );
296
297        #[cfg(all(feature = "Foundation_NSArray", feature = "Foundation_NSString"))]
298        #[method_id(@__retain_semantics Other veryShortWeekdaySymbols)]
299        pub unsafe fn veryShortWeekdaySymbols(&self) -> Id<NSArray<NSString>>;
300
301        #[cfg(all(feature = "Foundation_NSArray", feature = "Foundation_NSString"))]
302        #[method(setVeryShortWeekdaySymbols:)]
303        pub unsafe fn setVeryShortWeekdaySymbols(
304            &self,
305            very_short_weekday_symbols: Option<&NSArray<NSString>>,
306        );
307
308        #[cfg(all(feature = "Foundation_NSArray", feature = "Foundation_NSString"))]
309        #[method_id(@__retain_semantics Other standaloneWeekdaySymbols)]
310        pub unsafe fn standaloneWeekdaySymbols(&self) -> Id<NSArray<NSString>>;
311
312        #[cfg(all(feature = "Foundation_NSArray", feature = "Foundation_NSString"))]
313        #[method(setStandaloneWeekdaySymbols:)]
314        pub unsafe fn setStandaloneWeekdaySymbols(
315            &self,
316            standalone_weekday_symbols: Option<&NSArray<NSString>>,
317        );
318
319        #[cfg(all(feature = "Foundation_NSArray", feature = "Foundation_NSString"))]
320        #[method_id(@__retain_semantics Other shortStandaloneWeekdaySymbols)]
321        pub unsafe fn shortStandaloneWeekdaySymbols(&self) -> Id<NSArray<NSString>>;
322
323        #[cfg(all(feature = "Foundation_NSArray", feature = "Foundation_NSString"))]
324        #[method(setShortStandaloneWeekdaySymbols:)]
325        pub unsafe fn setShortStandaloneWeekdaySymbols(
326            &self,
327            short_standalone_weekday_symbols: Option<&NSArray<NSString>>,
328        );
329
330        #[cfg(all(feature = "Foundation_NSArray", feature = "Foundation_NSString"))]
331        #[method_id(@__retain_semantics Other veryShortStandaloneWeekdaySymbols)]
332        pub unsafe fn veryShortStandaloneWeekdaySymbols(&self) -> Id<NSArray<NSString>>;
333
334        #[cfg(all(feature = "Foundation_NSArray", feature = "Foundation_NSString"))]
335        #[method(setVeryShortStandaloneWeekdaySymbols:)]
336        pub unsafe fn setVeryShortStandaloneWeekdaySymbols(
337            &self,
338            very_short_standalone_weekday_symbols: Option<&NSArray<NSString>>,
339        );
340
341        #[cfg(all(feature = "Foundation_NSArray", feature = "Foundation_NSString"))]
342        #[method_id(@__retain_semantics Other quarterSymbols)]
343        pub unsafe fn quarterSymbols(&self) -> Id<NSArray<NSString>>;
344
345        #[cfg(all(feature = "Foundation_NSArray", feature = "Foundation_NSString"))]
346        #[method(setQuarterSymbols:)]
347        pub unsafe fn setQuarterSymbols(&self, quarter_symbols: Option<&NSArray<NSString>>);
348
349        #[cfg(all(feature = "Foundation_NSArray", feature = "Foundation_NSString"))]
350        #[method_id(@__retain_semantics Other shortQuarterSymbols)]
351        pub unsafe fn shortQuarterSymbols(&self) -> Id<NSArray<NSString>>;
352
353        #[cfg(all(feature = "Foundation_NSArray", feature = "Foundation_NSString"))]
354        #[method(setShortQuarterSymbols:)]
355        pub unsafe fn setShortQuarterSymbols(
356            &self,
357            short_quarter_symbols: Option<&NSArray<NSString>>,
358        );
359
360        #[cfg(all(feature = "Foundation_NSArray", feature = "Foundation_NSString"))]
361        #[method_id(@__retain_semantics Other standaloneQuarterSymbols)]
362        pub unsafe fn standaloneQuarterSymbols(&self) -> Id<NSArray<NSString>>;
363
364        #[cfg(all(feature = "Foundation_NSArray", feature = "Foundation_NSString"))]
365        #[method(setStandaloneQuarterSymbols:)]
366        pub unsafe fn setStandaloneQuarterSymbols(
367            &self,
368            standalone_quarter_symbols: Option<&NSArray<NSString>>,
369        );
370
371        #[cfg(all(feature = "Foundation_NSArray", feature = "Foundation_NSString"))]
372        #[method_id(@__retain_semantics Other shortStandaloneQuarterSymbols)]
373        pub unsafe fn shortStandaloneQuarterSymbols(&self) -> Id<NSArray<NSString>>;
374
375        #[cfg(all(feature = "Foundation_NSArray", feature = "Foundation_NSString"))]
376        #[method(setShortStandaloneQuarterSymbols:)]
377        pub unsafe fn setShortStandaloneQuarterSymbols(
378            &self,
379            short_standalone_quarter_symbols: Option<&NSArray<NSString>>,
380        );
381
382        #[cfg(feature = "Foundation_NSDate")]
383        #[method_id(@__retain_semantics Other gregorianStartDate)]
384        pub unsafe fn gregorianStartDate(&self) -> Option<Id<NSDate>>;
385
386        #[cfg(feature = "Foundation_NSDate")]
387        #[method(setGregorianStartDate:)]
388        pub unsafe fn setGregorianStartDate(&self, gregorian_start_date: Option<&NSDate>);
389
390        #[method(doesRelativeDateFormatting)]
391        pub unsafe fn doesRelativeDateFormatting(&self) -> bool;
392
393        #[method(setDoesRelativeDateFormatting:)]
394        pub unsafe fn setDoesRelativeDateFormatting(&self, does_relative_date_formatting: bool);
395    }
396);
397
398extern_methods!(
399    /// Methods declared on superclass `NSObject`
400    #[cfg(feature = "Foundation_NSDateFormatter")]
401    unsafe impl NSDateFormatter {
402        #[method_id(@__retain_semantics Init init)]
403        pub unsafe fn init(this: Allocated<Self>) -> Id<Self>;
404
405        #[method_id(@__retain_semantics New new)]
406        pub unsafe fn new() -> Id<Self>;
407    }
408);
409
410extern_methods!(
411    /// NSDateFormatterCompatibility
412    #[cfg(feature = "Foundation_NSDateFormatter")]
413    unsafe impl NSDateFormatter {
414        #[cfg(feature = "Foundation_NSString")]
415        #[deprecated = "Create an NSDateFormatter with `init` and set the dateFormat property instead."]
416        #[method_id(@__retain_semantics Init initWithDateFormat:allowNaturalLanguage:)]
417        pub unsafe fn initWithDateFormat_allowNaturalLanguage(
418            this: Allocated<Self>,
419            format: &NSString,
420            flag: bool,
421        ) -> Id<Self>;
422
423        #[deprecated = "There is no replacement"]
424        #[method(allowsNaturalLanguage)]
425        pub unsafe fn allowsNaturalLanguage(&self) -> bool;
426    }
427);