Actionable#
- class Actionable(*args, **kwargs)#
Implementations: Button
, CheckButton
, LinkButton
, ListBoxRow
, LockButton
, Switch
, ToggleButton
The GtkActionable
interface provides a convenient way of associating
widgets with actions.
It primarily consists of two properties: action_name
and action_target
. There are also some convenience
APIs for setting these properties.
The action will be looked up in action groups that are found among
the widgets ancestors. Most commonly, these will be the actions with
the “win.” or “app.” prefix that are associated with the
GtkApplicationWindow
or GtkApplication
, but other action groups that
are added with insert_action_group
will be consulted
as well.
Methods#
- class Actionable
-
- set_action_name(action_name: str | None = None) None #
Specifies the name of the action with which this widget should be associated.
If
action_name
isNone
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
GtkApplicationWindow
.Names are of the form “win.save” or “app.quit” for actions on the containing
ApplicationWindow
or its associatedApplication
, respectively. This is the same form used for actions in theMenu
associated with the window.- Parameters:
action_name – an action name
- set_action_target_value(target_value: Variant | None = None) None #
Sets the target value of an actionable widget.
If
target_value
isNone
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
GtkActionable
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
Action
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).- Parameters:
target_value – a
Variant
to set as the target value
- set_detailed_action_name(detailed_action_name: str) None #
Sets the action-name and associated string target value of an actionable widget.
detailed_action_name
is a string in the format accepted byparse_detailed_name
.- Parameters:
detailed_action_name – the detailed action name
Properties#
Virtual Methods#
- class Actionable
-
- do_set_action_name(action_name: str | None = None) None #
Specifies the name of the action with which this widget should be associated.
If
action_name
isNone
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
GtkApplicationWindow
.Names are of the form “win.save” or “app.quit” for actions on the containing
ApplicationWindow
or its associatedApplication
, respectively. This is the same form used for actions in theMenu
associated with the window.- Parameters:
action_name – an action name
- do_set_action_target_value(target_value: Variant | None = None) None #
Sets the target value of an actionable widget.
If
target_value
isNone
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
GtkActionable
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
Action
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).- Parameters:
target_value – a
Variant
to set as the target value