objc2_foundation/generated/
NSDateComponentsFormatter.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::*;
6
7use crate::*;
8
9/// [Apple's documentation](https://developer.apple.com/documentation/foundation/nsdatecomponentsformatterunitsstyle?language=objc)
10// NS_ENUM
11#[repr(transparent)]
12#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord)]
13pub struct NSDateComponentsFormatterUnitsStyle(pub NSInteger);
14impl NSDateComponentsFormatterUnitsStyle {
15    #[doc(alias = "NSDateComponentsFormatterUnitsStylePositional")]
16    pub const Positional: Self = Self(0);
17    #[doc(alias = "NSDateComponentsFormatterUnitsStyleAbbreviated")]
18    pub const Abbreviated: Self = Self(1);
19    #[doc(alias = "NSDateComponentsFormatterUnitsStyleShort")]
20    pub const Short: Self = Self(2);
21    #[doc(alias = "NSDateComponentsFormatterUnitsStyleFull")]
22    pub const Full: Self = Self(3);
23    #[doc(alias = "NSDateComponentsFormatterUnitsStyleSpellOut")]
24    pub const SpellOut: Self = Self(4);
25    #[doc(alias = "NSDateComponentsFormatterUnitsStyleBrief")]
26    pub const Brief: Self = Self(5);
27}
28
29unsafe impl Encode for NSDateComponentsFormatterUnitsStyle {
30    const ENCODING: Encoding = NSInteger::ENCODING;
31}
32
33unsafe impl RefEncode for NSDateComponentsFormatterUnitsStyle {
34    const ENCODING_REF: Encoding = Encoding::Pointer(&Self::ENCODING);
35}
36
37/// [Apple's documentation](https://developer.apple.com/documentation/foundation/nsdatecomponentsformatterzeroformattingbehavior?language=objc)
38// NS_OPTIONS
39#[repr(transparent)]
40#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord)]
41pub struct NSDateComponentsFormatterZeroFormattingBehavior(pub NSUInteger);
42bitflags::bitflags! {
43    impl NSDateComponentsFormatterZeroFormattingBehavior: NSUInteger {
44        #[doc(alias = "NSDateComponentsFormatterZeroFormattingBehaviorNone")]
45        const None = 0;
46        #[doc(alias = "NSDateComponentsFormatterZeroFormattingBehaviorDefault")]
47        const Default = 1<<0;
48        #[doc(alias = "NSDateComponentsFormatterZeroFormattingBehaviorDropLeading")]
49        const DropLeading = 1<<1;
50        #[doc(alias = "NSDateComponentsFormatterZeroFormattingBehaviorDropMiddle")]
51        const DropMiddle = 1<<2;
52        #[doc(alias = "NSDateComponentsFormatterZeroFormattingBehaviorDropTrailing")]
53        const DropTrailing = 1<<3;
54        #[doc(alias = "NSDateComponentsFormatterZeroFormattingBehaviorDropAll")]
55        const DropAll = NSDateComponentsFormatterZeroFormattingBehavior::DropLeading.0|NSDateComponentsFormatterZeroFormattingBehavior::DropMiddle.0|NSDateComponentsFormatterZeroFormattingBehavior::DropTrailing.0;
56        #[doc(alias = "NSDateComponentsFormatterZeroFormattingBehaviorPad")]
57        const Pad = 1<<16;
58    }
59}
60
61unsafe impl Encode for NSDateComponentsFormatterZeroFormattingBehavior {
62    const ENCODING: Encoding = NSUInteger::ENCODING;
63}
64
65unsafe impl RefEncode for NSDateComponentsFormatterZeroFormattingBehavior {
66    const ENCODING_REF: Encoding = Encoding::Pointer(&Self::ENCODING);
67}
68
69extern_class!(
70    /// [Apple's documentation](https://developer.apple.com/documentation/foundation/nsdatecomponentsformatter?language=objc)
71    #[unsafe(super(NSFormatter, NSObject))]
72    #[derive(Debug, PartialEq, Eq, Hash)]
73    #[cfg(feature = "NSFormatter")]
74    pub struct NSDateComponentsFormatter;
75);
76
77#[cfg(feature = "NSFormatter")]
78unsafe impl Send for NSDateComponentsFormatter {}
79
80#[cfg(feature = "NSFormatter")]
81unsafe impl Sync for NSDateComponentsFormatter {}
82
83#[cfg(all(feature = "NSFormatter", feature = "NSObject"))]
84unsafe impl NSCoding for NSDateComponentsFormatter {}
85
86#[cfg(all(feature = "NSFormatter", feature = "NSObject"))]
87unsafe impl NSCopying for NSDateComponentsFormatter {}
88
89#[cfg(all(feature = "NSFormatter", feature = "NSObject"))]
90unsafe impl CopyingHelper for NSDateComponentsFormatter {
91    type Result = Self;
92}
93
94#[cfg(feature = "NSFormatter")]
95unsafe impl NSObjectProtocol for NSDateComponentsFormatter {}
96
97#[cfg(feature = "NSFormatter")]
98impl NSDateComponentsFormatter {
99    extern_methods!(
100        #[cfg(feature = "NSString")]
101        #[unsafe(method(stringForObjectValue:))]
102        #[unsafe(method_family = none)]
103        pub unsafe fn stringForObjectValue(
104            &self,
105            obj: Option<&AnyObject>,
106        ) -> Option<Retained<NSString>>;
107
108        #[cfg(all(feature = "NSCalendar", feature = "NSString"))]
109        #[unsafe(method(stringFromDateComponents:))]
110        #[unsafe(method_family = none)]
111        pub unsafe fn stringFromDateComponents(
112            &self,
113            components: &NSDateComponents,
114        ) -> Option<Retained<NSString>>;
115
116        #[cfg(all(feature = "NSDate", feature = "NSString"))]
117        #[unsafe(method(stringFromDate:toDate:))]
118        #[unsafe(method_family = none)]
119        pub unsafe fn stringFromDate_toDate(
120            &self,
121            start_date: &NSDate,
122            end_date: &NSDate,
123        ) -> Option<Retained<NSString>>;
124
125        #[cfg(all(feature = "NSDate", feature = "NSString"))]
126        #[unsafe(method(stringFromTimeInterval:))]
127        #[unsafe(method_family = none)]
128        pub unsafe fn stringFromTimeInterval(
129            &self,
130            ti: NSTimeInterval,
131        ) -> Option<Retained<NSString>>;
132
133        #[cfg(all(feature = "NSCalendar", feature = "NSString"))]
134        #[unsafe(method(localizedStringFromDateComponents:unitsStyle:))]
135        #[unsafe(method_family = none)]
136        pub unsafe fn localizedStringFromDateComponents_unitsStyle(
137            components: &NSDateComponents,
138            units_style: NSDateComponentsFormatterUnitsStyle,
139        ) -> Option<Retained<NSString>>;
140
141        #[unsafe(method(unitsStyle))]
142        #[unsafe(method_family = none)]
143        pub unsafe fn unitsStyle(&self) -> NSDateComponentsFormatterUnitsStyle;
144
145        /// Setter for [`unitsStyle`][Self::unitsStyle].
146        #[unsafe(method(setUnitsStyle:))]
147        #[unsafe(method_family = none)]
148        pub unsafe fn setUnitsStyle(&self, units_style: NSDateComponentsFormatterUnitsStyle);
149
150        #[cfg(feature = "NSCalendar")]
151        #[unsafe(method(allowedUnits))]
152        #[unsafe(method_family = none)]
153        pub unsafe fn allowedUnits(&self) -> NSCalendarUnit;
154
155        #[cfg(feature = "NSCalendar")]
156        /// Setter for [`allowedUnits`][Self::allowedUnits].
157        #[unsafe(method(setAllowedUnits:))]
158        #[unsafe(method_family = none)]
159        pub unsafe fn setAllowedUnits(&self, allowed_units: NSCalendarUnit);
160
161        #[unsafe(method(zeroFormattingBehavior))]
162        #[unsafe(method_family = none)]
163        pub unsafe fn zeroFormattingBehavior(
164            &self,
165        ) -> NSDateComponentsFormatterZeroFormattingBehavior;
166
167        /// Setter for [`zeroFormattingBehavior`][Self::zeroFormattingBehavior].
168        #[unsafe(method(setZeroFormattingBehavior:))]
169        #[unsafe(method_family = none)]
170        pub unsafe fn setZeroFormattingBehavior(
171            &self,
172            zero_formatting_behavior: NSDateComponentsFormatterZeroFormattingBehavior,
173        );
174
175        #[cfg(feature = "NSCalendar")]
176        #[unsafe(method(calendar))]
177        #[unsafe(method_family = none)]
178        pub unsafe fn calendar(&self) -> Option<Retained<NSCalendar>>;
179
180        #[cfg(feature = "NSCalendar")]
181        /// Setter for [`calendar`][Self::calendar].
182        #[unsafe(method(setCalendar:))]
183        #[unsafe(method_family = none)]
184        pub unsafe fn setCalendar(&self, calendar: Option<&NSCalendar>);
185
186        #[cfg(feature = "NSDate")]
187        #[unsafe(method(referenceDate))]
188        #[unsafe(method_family = none)]
189        pub unsafe fn referenceDate(&self) -> Option<Retained<NSDate>>;
190
191        #[cfg(feature = "NSDate")]
192        /// Setter for [`referenceDate`][Self::referenceDate].
193        #[unsafe(method(setReferenceDate:))]
194        #[unsafe(method_family = none)]
195        pub unsafe fn setReferenceDate(&self, reference_date: Option<&NSDate>);
196
197        #[unsafe(method(allowsFractionalUnits))]
198        #[unsafe(method_family = none)]
199        pub unsafe fn allowsFractionalUnits(&self) -> bool;
200
201        /// Setter for [`allowsFractionalUnits`][Self::allowsFractionalUnits].
202        #[unsafe(method(setAllowsFractionalUnits:))]
203        #[unsafe(method_family = none)]
204        pub unsafe fn setAllowsFractionalUnits(&self, allows_fractional_units: bool);
205
206        #[unsafe(method(maximumUnitCount))]
207        #[unsafe(method_family = none)]
208        pub unsafe fn maximumUnitCount(&self) -> NSInteger;
209
210        /// Setter for [`maximumUnitCount`][Self::maximumUnitCount].
211        #[unsafe(method(setMaximumUnitCount:))]
212        #[unsafe(method_family = none)]
213        pub unsafe fn setMaximumUnitCount(&self, maximum_unit_count: NSInteger);
214
215        #[unsafe(method(collapsesLargestUnit))]
216        #[unsafe(method_family = none)]
217        pub unsafe fn collapsesLargestUnit(&self) -> bool;
218
219        /// Setter for [`collapsesLargestUnit`][Self::collapsesLargestUnit].
220        #[unsafe(method(setCollapsesLargestUnit:))]
221        #[unsafe(method_family = none)]
222        pub unsafe fn setCollapsesLargestUnit(&self, collapses_largest_unit: bool);
223
224        #[unsafe(method(includesApproximationPhrase))]
225        #[unsafe(method_family = none)]
226        pub unsafe fn includesApproximationPhrase(&self) -> bool;
227
228        /// Setter for [`includesApproximationPhrase`][Self::includesApproximationPhrase].
229        #[unsafe(method(setIncludesApproximationPhrase:))]
230        #[unsafe(method_family = none)]
231        pub unsafe fn setIncludesApproximationPhrase(&self, includes_approximation_phrase: bool);
232
233        #[unsafe(method(includesTimeRemainingPhrase))]
234        #[unsafe(method_family = none)]
235        pub unsafe fn includesTimeRemainingPhrase(&self) -> bool;
236
237        /// Setter for [`includesTimeRemainingPhrase`][Self::includesTimeRemainingPhrase].
238        #[unsafe(method(setIncludesTimeRemainingPhrase:))]
239        #[unsafe(method_family = none)]
240        pub unsafe fn setIncludesTimeRemainingPhrase(&self, includes_time_remaining_phrase: bool);
241
242        #[unsafe(method(formattingContext))]
243        #[unsafe(method_family = none)]
244        pub unsafe fn formattingContext(&self) -> NSFormattingContext;
245
246        /// Setter for [`formattingContext`][Self::formattingContext].
247        #[unsafe(method(setFormattingContext:))]
248        #[unsafe(method_family = none)]
249        pub unsafe fn setFormattingContext(&self, formatting_context: NSFormattingContext);
250
251        #[cfg(feature = "NSString")]
252        #[unsafe(method(getObjectValue:forString:errorDescription:))]
253        #[unsafe(method_family = none)]
254        pub unsafe fn getObjectValue_forString_errorDescription(
255            &self,
256            obj: Option<&mut Option<Retained<AnyObject>>>,
257            string: &NSString,
258            error: Option<&mut Option<Retained<NSString>>>,
259        ) -> bool;
260    );
261}
262
263/// Methods declared on superclass `NSObject`.
264#[cfg(feature = "NSFormatter")]
265impl NSDateComponentsFormatter {
266    extern_methods!(
267        #[unsafe(method(init))]
268        #[unsafe(method_family = init)]
269        pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>;
270
271        #[unsafe(method(new))]
272        #[unsafe(method_family = new)]
273        pub unsafe fn new() -> Retained<Self>;
274    );
275}
objc2_foundation/generated/NSDateComponentsFormatter.rs

objc2_foundation/generated/
NSDateComponentsFormatter.rs
