Gtk.Actionable

Entities

Simple Types

Access Types

Subtypes

Constants

Subprograms

Description

This interface provides a convenient way of associating widgets with actions on a Gtk.Application_Window.Gtk_Application_Window or Gtk.Application.Gtk_Application.

It primarily consists of two properties: Gtk.Actionable.Gtk_Actionable:action-name and Gtk.Actionable.Gtk_Actionable: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 Gtk.Application_Window.Gtk_Application_Window or Gtk.Application.Gtk_Application, but other action groups that are added with gtk_widget_insert_action_group will be consulted as well.

"+"

function "+" (W : Gtk_Actionable) return Gtk_Actionable
Parameters
W
Return Value

Action_Name_Property

Action_Name_Property : constant Glib.Properties.Property_String;

Action_Target_Property

Action_Target_Property : constant Glib.Properties.Property_Object;

Type: Glib.Variant.Gvariant

Actionable_Interface_Descr

subtype Actionable_Interface_Descr is Glib.Object.Interface_Description;

Get_Action_Name

function Get_Action_Name (Self : Gtk_Actionable) return UTF8_String

Gets the action name for Actionable. See Gtk.Actionable.Set_Action_Name for more information. Since: gtk+ 3.4

Parameters
Self
Return Value

the action name, or null if none is set

Get_Action_Target_Value

function Get_Action_Target_Value
   (Self : Gtk_Actionable) return Glib.Variant.Gvariant

Gets the current target value of Actionable. See Gtk.Actionable.Set_Action_Target_Value for more information. Since: gtk+ 3.4

Parameters
Self
Return Value

the current target value

Get_Type

function Get_Type return Glib.GType
Return Value

Gtk_Actionable

type Gtk_Actionable is new Glib.Types.GType_Interface;

Null_Gtk_Actionable

Null_Gtk_Actionable : constant Gtk_Actionable;

Set_Action_Name

procedure Set_Action_Name
   (Self        : Gtk_Actionable;
    Action_Name : UTF8_String := "")

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 Gtk.Application_Window.Gtk_Application_Window. Names are of the form "win.save" or "app.quit" for actions on the containing Gtk.Application_Window.Gtk_Application_Window or its associated Gtk.Application.Gtk_Application, respectively. This is the same form used for actions in the Glib.Menu.Gmenu associated with the window. Since: gtk+ 3.4

Parameters
Self
Action_Name

an action name, or null

Set_Action_Target_Value

procedure Set_Action_Target_Value
   (Self         : Gtk_Actionable;
    Target_Value : Glib.Variant.Gvariant)

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 Gtk.Actionable.Gtk_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 Glib.Action.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). Since: gtk+ 3.4

Parameters
Self
Target_Value

a Glib.Variant.Gvariant to set as the target value, or null

Set_Detailed_Action_Name

procedure Set_Detailed_Action_Name
   (Self                 : Gtk_Actionable;
    Detailed_Action_Name : UTF8_String)

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.) Since: gtk+ 3.4

Parameters
Self
Detailed_Action_Name

the detailed action name

Set_Get_Action_Name

procedure Set_Get_Action_Name
  (Self    : Actionable_Interface_Descr;
   Handler : Virtual_Get_Action_Name)
Parameters
Self
Handler

Set_Get_Action_Target_Value

procedure Set_Get_Action_Target_Value
  (Self    : Actionable_Interface_Descr;
   Handler : Virtual_Get_Action_Target_Value)
Parameters
Self
Handler

Set_Set_Action_Name

procedure Set_Set_Action_Name
  (Self    : Actionable_Interface_Descr;
   Handler : Virtual_Set_Action_Name)
Parameters
Self
Handler

Set_Set_Action_Target_Value

procedure Set_Set_Action_Target_Value
  (Self    : Actionable_Interface_Descr;
   Handler : Virtual_Set_Action_Target_Value)

See Glib.Object.Add_Interface

Parameters
Self
Handler

Virtual_Get_Action_Name

type Virtual_Get_Action_Name is access function (Self : Gtk_Actionable) return Gtkada.Types.Chars_Ptr;

Gets the action name for Actionable. See Gtk.Actionable.Set_Action_Name for more information. Since: gtk+ 3.4

Parameters
Self
Return Value

the action name, or null if none is set

Virtual_Get_Action_Target_Value

type Virtual_Get_Action_Target_Value is access function (Self : Gtk_Actionable) return System.Address;

Gets the current target value of Actionable. See Gtk.Actionable.Set_Action_Target_Value for more information. Since: gtk+ 3.4

Parameters
Self
Return Value

the current target value

Virtual_Set_Action_Name

type Virtual_Set_Action_Name is access procedure
  (Self        : Gtk_Actionable;
   Action_Name : Gtkada.Types.Chars_Ptr);

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 Gtk.Application_Window.Gtk_Application_Window. Names are of the form "win.save" or "app.quit" for actions on the containing Gtk.Application_Window.Gtk_Application_Window or its associated Gtk.Application.Gtk_Application, respectively. This is the same form used for actions in the Glib.Menu.Gmenu associated with the window. Since: gtk+ 3.4

Parameters
Self
Action_Name

an action name, or null

Virtual_Set_Action_Target_Value

type Virtual_Set_Action_Target_Value is access procedure (Self : Gtk_Actionable; Target_Value : System.Address);

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 Gtk.Actionable.Gtk_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 Glib.Action.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). Since: gtk+ 3.4

Parameters
Self
Target_Value

a Glib.Variant.Gvariant to set as the target value, or null