ActionableIF

This interface provides a convenient way of associating widgets with actions on a GtkApplicationWindow or GtkApplication.

It primarily consists of two properties: "action-name" and "action-target". There are also some convenience APIs for setting these properties.

This interface is presently only meaningful if used on a widget that is (or will be) located inside of a GtkApplicationWindow and can only be used to associate the widget with actions on that window, or its associated GtkApplication.

Members

Functions

getActionName
string getActionName()

Gets the action name for actionable. See gtk_actionable_set_action_name() for more information.

getActionTargetValue
Variant getActionTargetValue()

Gets the current target value of actionabe. See gtk_actionable_set_action_target_value() for more information.

getActionableTStruct
GtkActionable* getActionableTStruct()
Undocumented in source.
getStruct
void* getStruct()

the main Gtk struct as a void*

setActionName
void setActionName(string actionName)

Specifies the name of the action with which this widget should be associated. If action_name is NULL 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 GtkApplicationWindow or its associated GtkApplication, respectively. This is the same form used for actions in the GMenu associated with the window.

setActionTargetValue
void setActionTargetValue(Variant targetValue)

Sets the target value of an actionable widget. If target_value is NULL 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 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).

setDetailedActionName
void setDetailedActionName(string detailedActionName)

Sets the action-name and associated string target value of an actionable widget. This allows for the effect of both gtk_actionable_set_action_name() and gtk_actionable_set_action_target_value() in the common case that the target is string-valued. detailed_action_name is a string of the form "action::target" where action is the action name and target is the string to use as the target.

Meta