objc2_foundation/generated/
NSEnergyFormatter.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/nsenergyformatterunit?language=objc)
10// NS_ENUM
11#[repr(transparent)]
12#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord)]
13pub struct NSEnergyFormatterUnit(pub NSInteger);
14impl NSEnergyFormatterUnit {
15    #[doc(alias = "NSEnergyFormatterUnitJoule")]
16    pub const Joule: Self = Self(11);
17    #[doc(alias = "NSEnergyFormatterUnitKilojoule")]
18    pub const Kilojoule: Self = Self(14);
19    #[doc(alias = "NSEnergyFormatterUnitCalorie")]
20    pub const Calorie: Self = Self((7 << 8) + 1);
21    #[doc(alias = "NSEnergyFormatterUnitKilocalorie")]
22    pub const Kilocalorie: Self = Self((7 << 8) + 2);
23}
24
25unsafe impl Encode for NSEnergyFormatterUnit {
26    const ENCODING: Encoding = NSInteger::ENCODING;
27}
28
29unsafe impl RefEncode for NSEnergyFormatterUnit {
30    const ENCODING_REF: Encoding = Encoding::Pointer(&Self::ENCODING);
31}
32
33extern_class!(
34    /// [Apple's documentation](https://developer.apple.com/documentation/foundation/nsenergyformatter?language=objc)
35    #[unsafe(super(NSFormatter, NSObject))]
36    #[derive(Debug, PartialEq, Eq, Hash)]
37    #[cfg(feature = "NSFormatter")]
38    pub struct NSEnergyFormatter;
39);
40
41#[cfg(all(feature = "NSFormatter", feature = "NSObject"))]
42extern_conformance!(
43    unsafe impl NSCoding for NSEnergyFormatter {}
44);
45
46#[cfg(all(feature = "NSFormatter", feature = "NSObject"))]
47extern_conformance!(
48    unsafe impl NSCopying for NSEnergyFormatter {}
49);
50
51#[cfg(all(feature = "NSFormatter", feature = "NSObject"))]
52unsafe impl CopyingHelper for NSEnergyFormatter {
53    type Result = Self;
54}
55
56#[cfg(feature = "NSFormatter")]
57extern_conformance!(
58    unsafe impl NSObjectProtocol for NSEnergyFormatter {}
59);
60
61#[cfg(feature = "NSFormatter")]
62impl NSEnergyFormatter {
63    extern_methods!(
64        #[cfg(feature = "NSNumberFormatter")]
65        #[unsafe(method(numberFormatter))]
66        #[unsafe(method_family = none)]
67        pub unsafe fn numberFormatter(&self) -> Retained<NSNumberFormatter>;
68
69        #[cfg(feature = "NSNumberFormatter")]
70        /// Setter for [`numberFormatter`][Self::numberFormatter].
71        #[unsafe(method(setNumberFormatter:))]
72        #[unsafe(method_family = none)]
73        pub unsafe fn setNumberFormatter(&self, number_formatter: Option<&NSNumberFormatter>);
74
75        #[unsafe(method(unitStyle))]
76        #[unsafe(method_family = none)]
77        pub unsafe fn unitStyle(&self) -> NSFormattingUnitStyle;
78
79        /// Setter for [`unitStyle`][Self::unitStyle].
80        #[unsafe(method(setUnitStyle:))]
81        #[unsafe(method_family = none)]
82        pub unsafe fn setUnitStyle(&self, unit_style: NSFormattingUnitStyle);
83
84        #[unsafe(method(isForFoodEnergyUse))]
85        #[unsafe(method_family = none)]
86        pub unsafe fn isForFoodEnergyUse(&self) -> bool;
87
88        /// Setter for [`isForFoodEnergyUse`][Self::isForFoodEnergyUse].
89        #[unsafe(method(setForFoodEnergyUse:))]
90        #[unsafe(method_family = none)]
91        pub unsafe fn setForFoodEnergyUse(&self, for_food_energy_use: bool);
92
93        #[cfg(feature = "NSString")]
94        #[unsafe(method(stringFromValue:unit:))]
95        #[unsafe(method_family = none)]
96        pub unsafe fn stringFromValue_unit(
97            &self,
98            value: c_double,
99            unit: NSEnergyFormatterUnit,
100        ) -> Retained<NSString>;
101
102        #[cfg(feature = "NSString")]
103        #[unsafe(method(stringFromJoules:))]
104        #[unsafe(method_family = none)]
105        pub unsafe fn stringFromJoules(&self, number_in_joules: c_double) -> Retained<NSString>;
106
107        #[cfg(feature = "NSString")]
108        #[unsafe(method(unitStringFromValue:unit:))]
109        #[unsafe(method_family = none)]
110        pub unsafe fn unitStringFromValue_unit(
111            &self,
112            value: c_double,
113            unit: NSEnergyFormatterUnit,
114        ) -> Retained<NSString>;
115
116        #[cfg(feature = "NSString")]
117        #[unsafe(method(unitStringFromJoules:usedUnit:))]
118        #[unsafe(method_family = none)]
119        pub unsafe fn unitStringFromJoules_usedUnit(
120            &self,
121            number_in_joules: c_double,
122            unitp: *mut NSEnergyFormatterUnit,
123        ) -> Retained<NSString>;
124
125        #[cfg(feature = "NSString")]
126        #[unsafe(method(getObjectValue:forString:errorDescription:))]
127        #[unsafe(method_family = none)]
128        pub unsafe fn getObjectValue_forString_errorDescription(
129            &self,
130            obj: Option<&mut Option<Retained<AnyObject>>>,
131            string: &NSString,
132            error: Option<&mut Option<Retained<NSString>>>,
133        ) -> bool;
134    );
135}
136
137/// Methods declared on superclass `NSObject`.
138#[cfg(feature = "NSFormatter")]
139impl NSEnergyFormatter {
140    extern_methods!(
141        #[unsafe(method(init))]
142        #[unsafe(method_family = init)]
143        pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>;
144
145        #[unsafe(method(new))]
146        #[unsafe(method_family = new)]
147        pub unsafe fn new() -> Retained<Self>;
148    );
149}
objc2_foundation/generated/NSEnergyFormatter.rs

objc2_foundation/generated/
NSEnergyFormatter.rs
