gtk4/auto/
named_action.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
// 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, ShortcutAction};
use glib::translate::*;

glib::wrapper! {
    /// A [`ShortcutAction`][crate::ShortcutAction] that activates an action by name.
    ///
    /// ## Properties
    ///
    ///
    /// #### `action-name`
    ///  The name of the action to activate.
    ///
    /// Readable | Writeable | Construct Only
    ///
    /// # Implements
    ///
    /// [`ShortcutActionExt`][trait@crate::prelude::ShortcutActionExt], [`trait@glib::ObjectExt`]
    #[doc(alias = "GtkNamedAction")]
    pub struct NamedAction(Object<ffi::GtkNamedAction, ffi::GtkNamedActionClass>) @extends ShortcutAction;

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

impl NamedAction {
    /// Creates an action that when activated, activates
    /// the named action on the widget.
    ///
    /// It also passes the given arguments to it.
    ///
    /// See [`WidgetExt::insert_action_group()`][crate::prelude::WidgetExt::insert_action_group()] for
    /// how to add actions to widgets.
    /// ## `name`
    /// the detailed name of the action
    ///
    /// # Returns
    ///
    /// a new [`ShortcutAction`][crate::ShortcutAction]
    #[doc(alias = "gtk_named_action_new")]
    pub fn new(name: &str) -> NamedAction {
        assert_initialized_main_thread!();
        unsafe { from_glib_full(ffi::gtk_named_action_new(name.to_glib_none().0)) }
    }

    /// Returns the name of the action that will be activated.
    ///
    /// # Returns
    ///
    /// the name of the action to activate
    #[doc(alias = "gtk_named_action_get_action_name")]
    #[doc(alias = "get_action_name")]
    #[doc(alias = "action-name")]
    pub fn action_name(&self) -> glib::GString {
        unsafe { from_glib_none(ffi::gtk_named_action_get_action_name(self.to_glib_none().0)) }
    }
}