Trait gtk::prelude::ActionableExt

source · [−]
pub trait ActionableExt: 'static {
    fn action_name(&self) -> Option<GString>;
    fn action_target_value(&self) -> Option<Variant>;
    fn set_action_name(&self, action_name: Option<&str>);
    fn set_action_target_value(&self, target_value: Option<&Variant>);
    fn set_detailed_action_name(&self, detailed_action_name: &str);
    fn connect_action_name_notify<F: Fn(&Self) + 'static>(
        &self,
        f: F
    ) -> SignalHandlerId;
    fn connect_action_target_notify<F: Fn(&Self) + 'static>(
        &self,
        f: F
    ) -> SignalHandlerId;
}
Expand description

Trait containing all Actionable methods.

Implementors

Actionable, Button, CheckButton, CheckMenuItem, ColorButton, FontButton, LinkButton, ListBoxRow, LockButton, MenuButton, MenuItem, MenuToolButton, ModelButton, RadioButton, RadioMenuItem, RadioToolButton, ScaleButton, SeparatorMenuItem, Switch, ToggleButton, ToggleToolButton, ToolButton, VolumeButton

Required Methods

Gets the action name for self.

See set_action_name() for more information.

Returns

the action name, or None if none is set

Gets the current target value of self.

See set_action_target_value() for more information.

Returns

the current target value

Specifies the name of the action with which this widget should be associated. If action_name is None then the widget will be unassociated from any previous action.

Usually this function is used when the widget is located (or will be located) within the hierarchy of a ApplicationWindow.

Names are of the form “win.save” or “app.quit” for actions on the containing ApplicationWindow or its associated Application, respectively. This is the same form used for actions in the gio::Menu associated with the window.

action_name

an action name, or None

Sets the target value of an actionable widget.

If target_value is None then the target value is unset.

The target value has two purposes. First, it is used as the parameter to activation of the action associated with the Actionable widget. Second, it is used to determine if the widget should be rendered as “active” — the widget is active if the state is equal to the given target.

Consider the example of associating a set of buttons with a GAction with string state in a typical “radio button” situation. Each button will be associated with the same action, but with a different target value for that action. Clicking on a particular button will activate the action with the target of that button, which will typically cause the action’s state to change to that value. Since the action’s state is now equal to the target value of the button, the button will now be rendered as active (and the other buttons, with different targets, rendered inactive).

target_value

a glib::Variant to set as the target value, or None

Sets the action-name and associated string target value of an actionable widget.

detailed_action_name is a string in the format accepted by g_action_parse_detailed_name().

(Note that prior to version 3.22.25, this function is only usable for actions with a simple “s” target, and detailed_action_name must be of the form "action::target" where action is the action name and target is the string to use as the target.)

detailed_action_name

the detailed action name

Implementors