objc2-app-kit 0.3.2

Bindings to the AppKit framework
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157

//! This file has been automatically generated by `objc2`'s `header-translator`.
//! DO NOT EDIT
use core::ffi::*;
use core::ptr::NonNull;
use objc2::__framework_prelude::*;
use objc2_foundation::*;

use crate::*;

/// [Apple's documentation](https://developer.apple.com/documentation/appkit/nstextinputsourceidentifier?language=objc)
pub type NSTextInputSourceIdentifier = NSString;

extern_class!(
    /// [Apple's documentation](https://developer.apple.com/documentation/appkit/nstextinputcontext?language=objc)
    #[unsafe(super(NSObject))]
    #[thread_kind = MainThreadOnly]
    #[derive(Debug, PartialEq, Eq, Hash)]
    pub struct NSTextInputContext;
);

extern_conformance!(
    unsafe impl NSObjectProtocol for NSTextInputContext {}
);

impl NSTextInputContext {
    extern_methods!(
        #[unsafe(method(currentInputContext))]
        #[unsafe(method_family = none)]
        pub fn currentInputContext(mtm: MainThreadMarker) -> Option<Retained<NSTextInputContext>>;

        #[cfg(feature = "NSTextInputClient")]
        #[unsafe(method(initWithClient:))]
        #[unsafe(method_family = init)]
        pub fn initWithClient(
            this: Allocated<Self>,
            client: &ProtocolObject<dyn NSTextInputClient>,
        ) -> Retained<Self>;

        #[unsafe(method(init))]
        #[unsafe(method_family = init)]
        pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>;

        #[cfg(feature = "NSTextInputClient")]
        /// ** Properties ****
        #[unsafe(method(client))]
        #[unsafe(method_family = none)]
        pub fn client(&self) -> Retained<ProtocolObject<dyn NSTextInputClient>>;

        #[unsafe(method(acceptsGlyphInfo))]
        #[unsafe(method_family = none)]
        pub fn acceptsGlyphInfo(&self) -> bool;

        /// Setter for [`acceptsGlyphInfo`][Self::acceptsGlyphInfo].
        #[unsafe(method(setAcceptsGlyphInfo:))]
        #[unsafe(method_family = none)]
        pub fn setAcceptsGlyphInfo(&self, accepts_glyph_info: bool);

        #[unsafe(method(allowedInputSourceLocales))]
        #[unsafe(method_family = none)]
        pub fn allowedInputSourceLocales(&self) -> Option<Retained<NSArray<NSString>>>;

        /// Setter for [`allowedInputSourceLocales`][Self::allowedInputSourceLocales].
        ///
        /// This is [copied][objc2_foundation::NSCopying::copy] when set.
        #[unsafe(method(setAllowedInputSourceLocales:))]
        #[unsafe(method_family = none)]
        pub fn setAllowedInputSourceLocales(
            &self,
            allowed_input_source_locales: Option<&NSArray<NSString>>,
        );

        /// ** Activation ****
        #[unsafe(method(activate))]
        #[unsafe(method_family = none)]
        pub fn activate(&self);

        #[unsafe(method(deactivate))]
        #[unsafe(method_family = none)]
        pub fn deactivate(&self);

        #[cfg(feature = "NSEvent")]
        /// ** Input source interface ***
        #[unsafe(method(handleEvent:))]
        #[unsafe(method_family = none)]
        pub fn handleEvent(&self, event: &NSEvent) -> bool;

        #[unsafe(method(discardMarkedText))]
        #[unsafe(method_family = none)]
        pub fn discardMarkedText(&self);

        #[unsafe(method(invalidateCharacterCoordinates))]
        #[unsafe(method_family = none)]
        pub fn invalidateCharacterCoordinates(&self);

        #[unsafe(method(textInputClientWillStartScrollingOrZooming))]
        #[unsafe(method_family = none)]
        pub fn textInputClientWillStartScrollingOrZooming(&self);

        #[unsafe(method(textInputClientDidEndScrollingOrZooming))]
        #[unsafe(method_family = none)]
        pub fn textInputClientDidEndScrollingOrZooming(&self);

        #[unsafe(method(textInputClientDidUpdateSelection))]
        #[unsafe(method_family = none)]
        pub fn textInputClientDidUpdateSelection(&self);

        #[unsafe(method(textInputClientDidScroll))]
        #[unsafe(method_family = none)]
        pub fn textInputClientDidScroll(&self);

        /// ** Text Input sources handling ***
        #[unsafe(method(keyboardInputSources))]
        #[unsafe(method_family = none)]
        pub fn keyboardInputSources(
            &self,
        ) -> Option<Retained<NSArray<NSTextInputSourceIdentifier>>>;

        #[unsafe(method(selectedKeyboardInputSource))]
        #[unsafe(method_family = none)]
        pub fn selectedKeyboardInputSource(&self) -> Option<Retained<NSTextInputSourceIdentifier>>;

        /// Setter for [`selectedKeyboardInputSource`][Self::selectedKeyboardInputSource].
        ///
        /// This is [copied][objc2_foundation::NSCopying::copy] when set.
        #[unsafe(method(setSelectedKeyboardInputSource:))]
        #[unsafe(method_family = none)]
        pub fn setSelectedKeyboardInputSource(
            &self,
            selected_keyboard_input_source: Option<&NSTextInputSourceIdentifier>,
        );

        /// ** Text Input source attributes ***
        #[unsafe(method(localizedNameForInputSource:))]
        #[unsafe(method_family = none)]
        pub fn localizedNameForInputSource(
            input_source_identifier: &NSTextInputSourceIdentifier,
            mtm: MainThreadMarker,
        ) -> Option<Retained<NSString>>;
    );
}

/// Methods declared on superclass `NSObject`.
impl NSTextInputContext {
    extern_methods!(
        #[unsafe(method(new))]
        #[unsafe(method_family = new)]
        pub unsafe fn new(mtm: MainThreadMarker) -> Retained<Self>;
    );
}

extern "C" {
    /// ** Notifications ***
    ///
    /// See also [Apple's documentation](https://developer.apple.com/documentation/appkit/nstextinputcontextkeyboardselectiondidchangenotification?language=objc)
    pub static NSTextInputContextKeyboardSelectionDidChangeNotification:
        &'static NSNotificationName;
}