objc2_ui_kit/generated/
UIAccessibilityElement.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#[cfg(feature = "objc2-core-foundation")]
7use objc2_core_foundation::*;
8use objc2_foundation::*;
9
10use crate::*;
11
12extern_class!(
13    /// [Apple's documentation](https://developer.apple.com/documentation/uikit/uiaccessibilityelement?language=objc)
14    #[unsafe(super(UIResponder, NSObject))]
15    #[thread_kind = MainThreadOnly]
16    #[derive(Debug, PartialEq, Eq, Hash)]
17    #[cfg(feature = "UIResponder")]
18    pub struct UIAccessibilityElement;
19);
20
21#[cfg(feature = "UIResponder")]
22extern_conformance!(
23    unsafe impl NSObjectProtocol for UIAccessibilityElement {}
24);
25
26#[cfg(all(feature = "UIAccessibilityIdentification", feature = "UIResponder"))]
27extern_conformance!(
28    unsafe impl UIAccessibilityIdentification for UIAccessibilityElement {}
29);
30
31#[cfg(feature = "UIResponder")]
32extern_conformance!(
33    unsafe impl UIResponderStandardEditActions for UIAccessibilityElement {}
34);
35
36#[cfg(feature = "UIResponder")]
37impl UIAccessibilityElement {
38    extern_methods!(
39        /// # Safety
40        ///
41        /// `container` should be of the correct type.
42        #[unsafe(method(initWithAccessibilityContainer:))]
43        #[unsafe(method_family = init)]
44        pub unsafe fn initWithAccessibilityContainer(
45            this: Allocated<Self>,
46            container: &AnyObject,
47        ) -> Retained<Self>;
48
49        #[unsafe(method(accessibilityContainer))]
50        #[unsafe(method_family = none)]
51        pub fn accessibilityContainer(&self) -> Option<Retained<AnyObject>>;
52
53        /// Setter for [`accessibilityContainer`][Self::accessibilityContainer].
54        ///
55        /// This is a [weak property][objc2::topics::weak_property].
56        ///
57        /// # Safety
58        ///
59        /// `accessibility_container` should be of the correct type.
60        #[unsafe(method(setAccessibilityContainer:))]
61        #[unsafe(method_family = none)]
62        pub unsafe fn setAccessibilityContainer(&self, accessibility_container: Option<&AnyObject>);
63
64        #[unsafe(method(isAccessibilityElement))]
65        #[unsafe(method_family = none)]
66        pub fn isAccessibilityElement(&self) -> bool;
67
68        /// Setter for [`isAccessibilityElement`][Self::isAccessibilityElement].
69        #[unsafe(method(setIsAccessibilityElement:))]
70        #[unsafe(method_family = none)]
71        pub fn setIsAccessibilityElement(&self, is_accessibility_element: bool);
72
73        #[unsafe(method(accessibilityLabel))]
74        #[unsafe(method_family = none)]
75        pub fn accessibilityLabel(&self) -> Option<Retained<NSString>>;
76
77        /// Setter for [`accessibilityLabel`][Self::accessibilityLabel].
78        #[unsafe(method(setAccessibilityLabel:))]
79        #[unsafe(method_family = none)]
80        pub fn setAccessibilityLabel(&self, accessibility_label: Option<&NSString>);
81
82        #[unsafe(method(accessibilityHint))]
83        #[unsafe(method_family = none)]
84        pub fn accessibilityHint(&self) -> Option<Retained<NSString>>;
85
86        /// Setter for [`accessibilityHint`][Self::accessibilityHint].
87        #[unsafe(method(setAccessibilityHint:))]
88        #[unsafe(method_family = none)]
89        pub fn setAccessibilityHint(&self, accessibility_hint: Option<&NSString>);
90
91        #[unsafe(method(accessibilityValue))]
92        #[unsafe(method_family = none)]
93        pub fn accessibilityValue(&self) -> Option<Retained<NSString>>;
94
95        /// Setter for [`accessibilityValue`][Self::accessibilityValue].
96        #[unsafe(method(setAccessibilityValue:))]
97        #[unsafe(method_family = none)]
98        pub fn setAccessibilityValue(&self, accessibility_value: Option<&NSString>);
99
100        #[cfg(feature = "objc2-core-foundation")]
101        #[unsafe(method(accessibilityFrame))]
102        #[unsafe(method_family = none)]
103        pub fn accessibilityFrame(&self) -> CGRect;
104
105        #[cfg(feature = "objc2-core-foundation")]
106        /// Setter for [`accessibilityFrame`][Self::accessibilityFrame].
107        #[unsafe(method(setAccessibilityFrame:))]
108        #[unsafe(method_family = none)]
109        pub fn setAccessibilityFrame(&self, accessibility_frame: CGRect);
110
111        #[cfg(feature = "UIAccessibilityConstants")]
112        #[unsafe(method(accessibilityTraits))]
113        #[unsafe(method_family = none)]
114        pub fn accessibilityTraits(&self) -> UIAccessibilityTraits;
115
116        #[cfg(feature = "UIAccessibilityConstants")]
117        /// Setter for [`accessibilityTraits`][Self::accessibilityTraits].
118        #[unsafe(method(setAccessibilityTraits:))]
119        #[unsafe(method_family = none)]
120        pub fn setAccessibilityTraits(&self, accessibility_traits: UIAccessibilityTraits);
121
122        #[cfg(feature = "objc2-core-foundation")]
123        #[unsafe(method(accessibilityFrameInContainerSpace))]
124        #[unsafe(method_family = none)]
125        pub fn accessibilityFrameInContainerSpace(&self) -> CGRect;
126
127        #[cfg(feature = "objc2-core-foundation")]
128        /// Setter for [`accessibilityFrameInContainerSpace`][Self::accessibilityFrameInContainerSpace].
129        #[unsafe(method(setAccessibilityFrameInContainerSpace:))]
130        #[unsafe(method_family = none)]
131        pub fn setAccessibilityFrameInContainerSpace(
132            &self,
133            accessibility_frame_in_container_space: CGRect,
134        );
135    );
136}
137
138/// Methods declared on superclass `NSObject`.
139#[cfg(feature = "UIResponder")]
140impl UIAccessibilityElement {
141    extern_methods!(
142        #[unsafe(method(init))]
143        #[unsafe(method_family = init)]
144        pub fn init(this: Allocated<Self>) -> Retained<Self>;
145
146        #[unsafe(method(new))]
147        #[unsafe(method_family = new)]
148        pub fn new(mtm: MainThreadMarker) -> Retained<Self>;
149    );
150}