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
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
// 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::Action;
use glib::object::ObjectType as ObjectType_;
use glib::signal::connect_raw;
use glib::signal::SignalHandlerId;
use glib::translate::*;
use std::boxed::Box as Box_;
use std::fmt;
use std::mem::transmute;

glib::wrapper! {
    /// A [`SimpleAction`][crate::SimpleAction] is the obvious simple implementation of the [`Action`][crate::Action]
    /// interface. This is the easiest way to create an action for purposes of
    /// adding it to a [`SimpleActionGroup`][crate::SimpleActionGroup].
    ///
    /// See also `GtkAction`.
    ///
    /// # Implements
    ///
    /// [`trait@glib::ObjectExt`], [`ActionExt`][trait@crate::prelude::ActionExt]
    #[doc(alias = "GSimpleAction")]
    pub struct SimpleAction(Object<ffi::GSimpleAction>) @implements Action;

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

impl SimpleAction {
    /// Creates a new action.
    ///
    /// The created action is stateless. See [`new_stateful()`][Self::new_stateful()] to create
    /// an action that has state.
    /// ## `name`
    /// the name of the action
    /// ## `parameter_type`
    /// the type of parameter that will be passed to
    ///  handlers for the `signal::SimpleAction::activate` signal, or [`None`] for no parameter
    ///
    /// # Returns
    ///
    /// a new [`SimpleAction`][crate::SimpleAction]
    #[doc(alias = "g_simple_action_new")]
    pub fn new(name: &str, parameter_type: Option<&glib::VariantTy>) -> SimpleAction {
        unsafe {
            from_glib_full(ffi::g_simple_action_new(
                name.to_glib_none().0,
                parameter_type.to_glib_none().0,
            ))
        }
    }

    /// Creates a new stateful action.
    ///
    /// All future state values must have the same [`glib::VariantType`][crate::glib::VariantType] as the initial
    /// `state`.
    ///
    /// If the `state` [`glib::Variant`][struct@crate::glib::Variant] is floating, it is consumed.
    /// ## `name`
    /// the name of the action
    /// ## `parameter_type`
    /// the type of the parameter that will be passed to
    ///  handlers for the `signal::SimpleAction::activate` signal, or [`None`] for no parameter
    /// ## `state`
    /// the initial state of the action
    ///
    /// # Returns
    ///
    /// a new [`SimpleAction`][crate::SimpleAction]
    #[doc(alias = "g_simple_action_new_stateful")]
    pub fn new_stateful(
        name: &str,
        parameter_type: Option<&glib::VariantTy>,
        state: &glib::Variant,
    ) -> SimpleAction {
        unsafe {
            from_glib_full(ffi::g_simple_action_new_stateful(
                name.to_glib_none().0,
                parameter_type.to_glib_none().0,
                state.to_glib_none().0,
            ))
        }
    }

    /// Sets the action as enabled or not.
    ///
    /// An action must be enabled in order to be activated or in order to
    /// have its state changed from outside callers.
    ///
    /// This should only be called by the implementor of the action. Users
    /// of the action should not attempt to modify its enabled flag.
    /// ## `enabled`
    /// whether the action is enabled
    #[doc(alias = "g_simple_action_set_enabled")]
    pub fn set_enabled(&self, enabled: bool) {
        unsafe {
            ffi::g_simple_action_set_enabled(self.to_glib_none().0, enabled.into_glib());
        }
    }

    /// Sets the state of the action.
    ///
    /// This directly updates the 'state' property to the given value.
    ///
    /// This should only be called by the implementor of the action. Users
    /// of the action should not attempt to directly modify the 'state'
    /// property. Instead, they should call [`ActionExt::change_state()`][crate::prelude::ActionExt::change_state()] to
    /// request the change.
    ///
    /// If the `value` GVariant is floating, it is consumed.
    /// ## `value`
    /// the new [`glib::Variant`][struct@crate::glib::Variant] for the state
    #[doc(alias = "g_simple_action_set_state")]
    pub fn set_state(&self, value: &glib::Variant) {
        unsafe {
            ffi::g_simple_action_set_state(self.to_glib_none().0, value.to_glib_none().0);
        }
    }

    /// Sets the state hint for the action.
    ///
    /// See [`ActionExt::state_hint()`][crate::prelude::ActionExt::state_hint()] for more information about
    /// action state hints.
    /// ## `state_hint`
    /// a [`glib::Variant`][struct@crate::glib::Variant] representing the state hint
    #[doc(alias = "g_simple_action_set_state_hint")]
    pub fn set_state_hint(&self, state_hint: Option<&glib::Variant>) {
        unsafe {
            ffi::g_simple_action_set_state_hint(self.to_glib_none().0, state_hint.to_glib_none().0);
        }
    }

    /// Indicates that the action was just activated.
    ///
    /// `parameter` will always be of the expected type, i.e. the parameter type
    /// specified when the action was created. If an incorrect type is given when
    /// activating the action, this signal is not emitted.
    ///
    /// Since GLib 2.40, if no handler is connected to this signal then the
    /// default behaviour for boolean-stated actions with a [`None`] parameter
    /// type is to toggle them via the `signal::SimpleAction::change-state` signal.
    /// For stateful actions where the state type is equal to the parameter
    /// type, the default is to forward them directly to
    /// `signal::SimpleAction::change-state`. This should allow almost all users
    /// of [`SimpleAction`][crate::SimpleAction] to connect only one handler or the other.
    /// ## `parameter`
    /// the parameter to the activation, or [`None`] if it has
    ///  no parameter
    #[doc(alias = "activate")]
    pub fn connect_activate<F: Fn(&Self, Option<&glib::Variant>) + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn activate_trampoline<
            F: Fn(&SimpleAction, Option<&glib::Variant>) + 'static,
        >(
            this: *mut ffi::GSimpleAction,
            parameter: *mut glib::ffi::GVariant,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(
                &from_glib_borrow(this),
                Option::<glib::Variant>::from_glib_borrow(parameter)
                    .as_ref()
                    .as_ref(),
            )
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"activate\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    activate_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    /// Indicates that the action just received a request to change its
    /// state.
    ///
    /// `value` will always be of the correct state type, i.e. the type of the
    /// initial state passed to [`new_stateful()`][Self::new_stateful()]. If an incorrect
    /// type is given when requesting to change the state, this signal is not
    /// emitted.
    ///
    /// If no handler is connected to this signal then the default
    /// behaviour is to call [`set_state()`][Self::set_state()] to set the state
    /// to the requested value. If you connect a signal handler then no
    /// default action is taken. If the state should change then you must
    /// call [`set_state()`][Self::set_state()] from the handler.
    ///
    /// An example of a 'change-state' handler:
    ///
    ///
    /// **⚠️ The following code is in C ⚠️**
    ///
    /// ```C
    /// static void
    /// change_volume_state (GSimpleAction *action,
    ///                      GVariant      *value,
    ///                      gpointer       user_data)
    /// {
    ///   gint requested;
    ///
    ///   requested = g_variant_get_int32 (value);
    ///
    ///   // Volume only goes from 0 to 10
    ///   if (0 <= requested && requested <= 10)
    ///     g_simple_action_set_state (action, value);
    /// }
    /// ```
    ///
    /// The handler need not set the state to the requested value.
    /// It could set it to any value at all, or take some other action.
    /// ## `value`
    /// the requested value for the state
    #[doc(alias = "change-state")]
    pub fn connect_change_state<F: Fn(&Self, Option<&glib::Variant>) + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn change_state_trampoline<
            F: Fn(&SimpleAction, Option<&glib::Variant>) + 'static,
        >(
            this: *mut ffi::GSimpleAction,
            value: *mut glib::ffi::GVariant,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(
                &from_glib_borrow(this),
                Option::<glib::Variant>::from_glib_borrow(value)
                    .as_ref()
                    .as_ref(),
            )
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"change-state\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    change_state_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}

impl fmt::Display for SimpleAction {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        f.write_str("SimpleAction")
    }
}