gio/
action_map.rs

Help
1// Take a look at the license at the top of the repository in the LICENSE file.
2
3use glib::{clone, prelude::*};
4
5use crate::{prelude::*, ActionEntry, ActionMap, SimpleAction};
6pub trait ActionMapExtManual: IsA<ActionMap> {
7    /// A convenience function for creating multiple [`SimpleAction`][crate::SimpleAction]
8    /// instances and adding them to a [`ActionMap`][crate::ActionMap].
9    ///
10    /// Each action is constructed as per one [`ActionEntry`][crate::ActionEntry].
11    ///
12    /// **⚠️ The following code is in c ⚠️**
13    ///
14    /// ```c
15    /// static void
16    /// activate_quit (GSimpleAction *simple,
17    ///                GVariant      *parameter,
18    ///                gpointer       user_data)
19    /// {
20    ///   exit (0);
21    /// }
22    ///
23    /// static void
24    /// activate_print_string (GSimpleAction *simple,
25    ///                        GVariant      *parameter,
26    ///                        gpointer       user_data)
27    /// {
28    ///   g_print ("%s\n", g_variant_get_string (parameter, NULL));
29    /// }
30    ///
31    /// static GActionGroup *
32    /// create_action_group (void)
33    /// {
34    ///   const GActionEntry entries[] = {
35    ///     { "quit",         activate_quit              },
36    ///     { "print-string", activate_print_string, "s" }
37    ///   };
38    ///   GSimpleActionGroup *group;
39    ///
40    ///   group = g_simple_action_group_new ();
41    ///   g_action_map_add_action_entries (G_ACTION_MAP (group), entries, G_N_ELEMENTS (entries), NULL);
42    ///
43    ///   return G_ACTION_GROUP (group);
44    /// }
45    /// ```
46    /// ## `entries`
47    /// a pointer to
48    ///   the first item in an array of [`ActionEntry`][crate::ActionEntry] structs
49    #[doc(alias = "g_action_map_add_action_entries")]
50    fn add_action_entries(&self, entries: impl IntoIterator<Item = ActionEntry<Self>>) {
51        for entry in entries.into_iter() {
52            let action = if let Some(state) = entry.state() {
53                SimpleAction::new_stateful(entry.name(), entry.parameter_type(), state)
54            } else {
55                SimpleAction::new(entry.name(), entry.parameter_type())
56            };
57            let action_map = self.as_ref();
58            if let Some(callback) = entry.activate {
59                action.connect_activate(clone!(
60                    #[weak]
61                    action_map,
62                    move |action, state| {
63                        // safe to unwrap as O: IsA<ActionMap>
64                        callback(action_map.downcast_ref::<Self>().unwrap(), action, state);
65                    }
66                ));
67            }
68            if let Some(callback) = entry.change_state {
69                action.connect_change_state(clone!(
70                    #[weak]
71                    action_map,
72                    move |action, state| {
73                        // safe to unwrap as O: IsA<ActionMap>
74                        callback(action_map.downcast_ref::<Self>().unwrap(), action, state);
75                    }
76                ));
77            }
78            self.as_ref().add_action(&action);
79        }
80    }
81}
82
83impl<O: IsA<ActionMap>> ActionMapExtManual for O {}
gio/action_map.rs

gio/
action_map.rs
