gtk4/auto/
at_context.rs

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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
// This file was generated by gir (https://github.com/gtk-rs/gir)
// from gir-files (https://github.com/gtk-rs/gir-files)
// DO NOT EDIT

use crate::{ffi, Accessible, AccessibleRole};
use glib::{
    prelude::*,
    signal::{connect_raw, SignalHandlerId},
    translate::*,
};
use std::boxed::Box as Box_;

glib::wrapper! {
    /// [`ATContext`][crate::ATContext] is an abstract class provided by GTK to communicate to
    /// platform-specific assistive technologies API.
    ///
    /// Each platform supported by GTK implements a [`ATContext`][crate::ATContext] subclass, and
    /// is responsible for updating the accessible state in response to state
    /// changes in [`Accessible`][crate::Accessible].
    ///
    /// This is an Abstract Base Class, you cannot instantiate it.
    ///
    /// ## Properties
    ///
    ///
    /// #### `accessible`
    ///  The [`Accessible`][crate::Accessible] that created the [`ATContext`][crate::ATContext] instance.
    ///
    /// Readable | Writeable | Construct Only
    ///
    ///
    /// #### `accessible-role`
    ///  The accessible role used by the AT context.
    ///
    /// Depending on the given role, different states and properties can be
    /// set or retrieved.
    ///
    /// Readable | Writeable | Construct
    ///
    ///
    /// #### `display`
    ///  The [`gdk::Display`][crate::gdk::Display] for the [`ATContext`][crate::ATContext].
    ///
    /// Readable | Writeable
    ///
    /// ## Signals
    ///
    ///
    /// #### `state-change`
    ///  Emitted when the attributes of the accessible for the
    /// [`ATContext`][crate::ATContext] instance change.
    ///
    ///
    ///
    /// # Implements
    ///
    /// [`trait@glib::ObjectExt`]
    #[doc(alias = "GtkATContext")]
    pub struct ATContext(Object<ffi::GtkATContext, ffi::GtkATContextClass>);

    match fn {
        type_ => || ffi::gtk_at_context_get_type(),
    }
}

impl ATContext {
    /// Creates a new [`ATContext`][crate::ATContext] instance for the given accessible role,
    /// accessible instance, and display connection.
    ///
    /// The [`ATContext`][crate::ATContext] implementation being instantiated will depend on the
    /// platform.
    /// ## `accessible_role`
    /// the accessible role used by the [`ATContext`][crate::ATContext]
    /// ## `accessible`
    /// the [`Accessible`][crate::Accessible] implementation using the [`ATContext`][crate::ATContext]
    /// ## `display`
    /// the [`gdk::Display`][crate::gdk::Display] used by the [`ATContext`][crate::ATContext]
    ///
    /// # Returns
    ///
    /// the [`ATContext`][crate::ATContext]
    #[doc(alias = "gtk_at_context_create")]
    pub fn create(
        accessible_role: AccessibleRole,
        accessible: &impl IsA<Accessible>,
        display: &impl IsA<gdk::Display>,
    ) -> Option<ATContext> {
        skip_assert_initialized!();
        unsafe {
            from_glib_full(ffi::gtk_at_context_create(
                accessible_role.into_glib(),
                accessible.as_ref().to_glib_none().0,
                display.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Retrieves the [`Accessible`][crate::Accessible] using this context.
    ///
    /// # Returns
    ///
    /// a [`Accessible`][crate::Accessible]
    #[doc(alias = "gtk_at_context_get_accessible")]
    #[doc(alias = "get_accessible")]
    pub fn accessible(&self) -> Accessible {
        unsafe { from_glib_none(ffi::gtk_at_context_get_accessible(self.to_glib_none().0)) }
    }

    /// Retrieves the accessible role of this context.
    ///
    /// # Returns
    ///
    /// a [`AccessibleRole`][crate::AccessibleRole]
    #[doc(alias = "gtk_at_context_get_accessible_role")]
    #[doc(alias = "get_accessible_role")]
    #[doc(alias = "accessible-role")]
    pub fn accessible_role(&self) -> AccessibleRole {
        unsafe {
            from_glib(ffi::gtk_at_context_get_accessible_role(
                self.to_glib_none().0,
            ))
        }
    }

    /// The accessible role used by the AT context.
    ///
    /// Depending on the given role, different states and properties can be
    /// set or retrieved.
    #[doc(alias = "accessible-role")]
    pub fn set_accessible_role(&self, accessible_role: AccessibleRole) {
        ObjectExt::set_property(self, "accessible-role", accessible_role)
    }

    /// The [`gdk::Display`][crate::gdk::Display] for the [`ATContext`][crate::ATContext].
    pub fn display(&self) -> Option<gdk::Display> {
        ObjectExt::property(self, "display")
    }

    /// The [`gdk::Display`][crate::gdk::Display] for the [`ATContext`][crate::ATContext].
    pub fn set_display<P: IsA<gdk::Display>>(&self, display: Option<&P>) {
        ObjectExt::set_property(self, "display", display)
    }

    /// Emitted when the attributes of the accessible for the
    /// [`ATContext`][crate::ATContext] instance change.
    #[doc(alias = "state-change")]
    pub fn connect_state_change<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn state_change_trampoline<F: Fn(&ATContext) + 'static>(
            this: *mut ffi::GtkATContext,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(&from_glib_borrow(this))
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"state-change\0".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    state_change_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "accessible-role")]
    pub fn connect_accessible_role_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_accessible_role_trampoline<F: Fn(&ATContext) + 'static>(
            this: *mut ffi::GtkATContext,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(&from_glib_borrow(this))
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"notify::accessible-role\0".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_accessible_role_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "display")]
    pub fn connect_display_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_display_trampoline<F: Fn(&ATContext) + 'static>(
            this: *mut ffi::GtkATContext,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(&from_glib_borrow(this))
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"notify::display\0".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_display_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}