Back to Seed Clases

Gtk

Classes

Interfaces

Structs

Unions

Enums

GObject.Object
parent-child marker Gtk.Action

Class Gtk.Action

Import line:	Gtk = imports.gi.Gtk;
GIR File:	Gtk-3.0.gir
C documentation:	GtkAction
Class :	Action
Implements:	Gtk.Buildable
Extends:	GObject.Object

Actions represent operations that the user can be perform, along with
some information how it should be presented in the interface. Each action
provides methods to create icons, menu items and toolbar items
representing itself.
As well as the callback that is called when the action gets activated,
the following also gets associated with the action:

a name (not translated, for path lookup)
a label (translated, for display)
an accelerator
whether label indicates a stock id
a tooltip (optional, translated)
a toolbar label (optional, shorter than label)

The action will also have some state information:

visible (shown/hidden)
sensitive (enabled/disabled)

Apart from regular actions, there are toggle
actions, which can be toggled between two states and linkend="GtkRadioAction">radio actions, of which only one in a group
can be in the "active" state. Other actions can be implemented as GtkAction
subclasses.
Each action can have one or more proxy widgets. To act as an action proxy,
widget needs to implement GtkActivatable interface. Proxies mirror the state
of the action and should change when the action's state changes. Properties
that are always mirrored by proxies are GtkAction:sensitive and
GtkAction:visible. GtkAction:gicon, GtkAction:icon-name, GtkAction:label,
GtkAction:short-label and GtkAction:stock-id properties are only mirorred
if proxy widget has GtkActivatable:use-action-appearance property set to
TRUE.
When the proxy is activated, it should activate its action.

Properties
Properties		Defined By
	action_group : Gtk.ActionGroup	Gtk.Action
	always_show_image : gboolean If TRUE, the action's menu item proxies will ignore the GtkSettings:gtk-menu-images setting and always show their image, if available. If TRUE, the action's menu item proxies will ignore the GtkSettings:gtk-menu-images setting and always show their image, if available. Use this property if the menu item would be useless or hard to use without their image.	Gtk.Action
	gicon : Gio.Icon The GIcon displayed in the GtkAction. The GIcon displayed in the GtkAction. Note that the stock icon is preferred, if the GtkAction:stock-id property holds the id of an existing stock icon. This is an appearance property and thus only applies if GtkActivatable:use-action-appearance is TRUE.	Gtk.Action
	hide_if_empty : gboolean	Gtk.Action
	icon_name : String The name of the icon from the icon theme. The name of the icon from the icon theme. Note that the stock icon is preferred, if the GtkAction:stock-id property holds the id of an existing stock icon, and the GIcon is preferred if the GtkAction:gicon property is set. This is an appearance property and thus only applies if GtkActivatable:use-action-appearance is TRUE.	Gtk.Action
	is_important : gboolean	Gtk.Action
	label : String The label used for menu items and buttons that activate this action. The label used for menu items and buttons that activate this action. If the label is NULL, GTK+ uses the stock label specified via the stock-id property. This is an appearance property and thus only applies if GtkActivatable:use-action-appearance is TRUE.	Gtk.Action
	name : String	Gtk.Action
	object : GObject.Object read only	Gtk.Action
	private_data : Gtk.ActionPrivate read only	Gtk.Action
	sensitive : gboolean	Gtk.Action
	short_label : String A shorter label that may be used on toolbar buttons. A shorter label that may be used on toolbar buttons. This is an appearance property and thus only applies if GtkActivatable:use-action-appearance is TRUE.	Gtk.Action
	stock_id : String The stock icon displayed in widgets representing this action. The stock icon displayed in widgets representing this action. This is an appearance property and thus only applies if GtkActivatable:use-action-appearance is TRUE.	Gtk.Action
	tooltip : String	Gtk.Action
	visible : gboolean	Gtk.Action
	visible_horizontal : gboolean	Gtk.Action
	visible_overflown : gboolean When TRUE, toolitem proxies for this action are represented in the toolbar overflow menu. When TRUE, toolitem proxies for this action are represented in the toolbar overflow menu.	Gtk.Action
	visible_vertical : gboolean	Gtk.Action

Methods / Constructors
Method / Constructor		Defined By
	new Gtk.Action (Object *properties) Create a new Gtk.Action Create a new Gtk.Action Parameters: Object properties*
	new Gtk.Action.c_new (String *name, String label, String tooltip, String stock_id) : Gtk.Action Create a new Gtk.Action Create a new Gtk.Action Parameters: String name* Required (not null) A unique name for the action String label the label displayed in menu items and on buttons, or NULL String tooltip a tooltip for the action, or NULL String stock_id the stock icon to display in widgets representing the action, or NULL Returns: Gtk.Action a new GtkAction
	activate () : none Emits the "activate" signal on the specified action, if it isn't insensitive. Emits the "activate" signal on the specified action, if it isn't insensitive. This gets called by the proxy widgets when they get activated. It can also be used to manually activate an action. Returns: none	Gtk.Action
	add_child (Builder *builder, Object child, String type) : none Adds a child to buildable. Adds a child to buildable. type* is an optional string describing how the child should be added. Parameters: Gtk.Builder builder Required (not null) a GtkBuilder GObject.Object child Required (not null) child to add String type kind of child or NULL Returns: none	Gtk.Buildable
	block_activate () : none Disable activation signals from the action This is needed when updating the state of your proxy GtkActivatable widget could result in calling gtk_action_activate(), this is a convenience function to avoid recursing in those cases (updating toggle state for instance). Disable activation signals from the action This is needed when updating the state of your proxy GtkActivatable widget could result in calling gtk_action_activate(), this is a convenience function to avoid recursing in those cases (updating toggle state for instance). Returns: none	Gtk.Action
	connect_accelerator () : none Installs the accelerator for action if action has an accel path and group. Installs the accelerator for action if action has an accel path and group. See gtk_action_set_accel_path() and gtk_action_set_accel_group() Since multiple proxies may independently trigger the installation of the accelerator, the action counts the number of times this function has been called and doesn't remove the accelerator until gtk_action_disconnect_accelerator() has been called as many times. Returns: none	Gtk.Action
	construct_child (Builder *builder, String name) : GObject.Object Constructs a child of buildable* with the name name. Constructs a child of buildable with the name name. GtkBuilder calls this function if a "constructor" has been specified in the UI definition. Parameters: Gtk.Builder builder Required (not null) GtkBuilder used to construct this object String name Required (not null) name of child to construct Returns: GObject.Object the constructed child	Gtk.Buildable
	create_icon (gint32 *icon_size) : Gtk.Widget This function is intended for use by action implementations to create icons displayed in the proxy widgets. This function is intended for use by action implementations to create icons displayed in the proxy widgets. Parameters: gint32 icon_size* Required (not null) the size of the icon that should be created. Returns: Gtk.Widget a widget that displays the icon for this action.	Gtk.Action
	create_menu () : Gtk.Widget If action provides a GtkMenu widget as a submenu for the menu item or the toolbar item it creates, this function returns an instance of that menu. If action provides a GtkMenu widget as a submenu for the menu item or the toolbar item it creates, this function returns an instance of that menu. action, or NULL. Returns: Gtk.Widget the menu item provided by the	Gtk.Action
	create_menu_item () : Gtk.Widget Creates a menu item widget that proxies for the given action. Creates a menu item widget that proxies for the given action. Returns: Gtk.Widget a menu item connected to the action.	Gtk.Action
	create_tool_item () : Gtk.Widget Creates a toolbar item widget that proxies for the given action. Creates a toolbar item widget that proxies for the given action. Returns: Gtk.Widget a toolbar item connected to the action.	Gtk.Action
	custom_finished (Builder *builder, Object child, String tagname, void *data) : none This is similar to gtk_buildable_parser_finished() but is called once for each custom tag handled by the buildable. This is similar to gtk_buildable_parser_finished() but is called once for each custom tag handled by the buildable. Parameters: Gtk.Builder builder* Required (not null) a GtkBuilder GObject.Object child child object or NULL for non-child tags String tagname Required (not null) the name of the tag void* data Required (not null) user data created in custom_tag_start Returns: none	Gtk.Buildable
	custom_tag_end (Builder *builder, Object child, String tagname, void *data) : none This is called at the end of each custom element handled by the buildable. This is called at the end of each custom element handled by the buildable. Parameters: Gtk.Builder builder* Required (not null) GtkBuilder used to construct this object GObject.Object child child object or NULL for non-child tags String tagname Required (not null) name of tag void* data Required (not null) user data that will be passed in to parser functions Returns: none	Gtk.Buildable
	custom_tag_start (Builder *builder, Object child, String tagname, Object out_values) : gboolean This is called for each unknown element under <child>. This is called for each unknown element under <child>. if it doesn't. Parameters: Gtk.Builder builder* Required (not null) a GtkBuilder used to construct this object GObject.Object child child object or NULL for non-child tags String tagname Required (not null) name of tag Object out_values GLib.MarkupParser parser void* data Returns: gboolean TRUE if a object has a custom implementation, FALSE	Gtk.Buildable
	disconnect_accelerator () : none Undoes the effect of one call to gtk_action_connect_accelerator(). Undoes the effect of one call to gtk_action_connect_accelerator(). Returns: none	Gtk.Action
	get_accel_closure () : GObject.Closure Returns the accel closure for this action. Returns the accel closure for this action. returned closure is owned by GTK+ and must not be unreffed or modified. Returns: GObject.Closure the accel closure for this action. The	Gtk.Action
	get_accel_path () : String Returns the accel path for this action. Returns the accel path for this action. if none is set. The returned string is owned by GTK+ and must not be freed or modified. Returns: String the accel path for this action, or NULL	Gtk.Action
	get_always_show_image () : gboolean Returns whether action's menu item proxies will ignore the GtkSettings:gtk-menu-images setting and always show their image, if available. Returns whether action's menu item proxies will ignore the GtkSettings:gtk-menu-images setting and always show their image, if available. Returns: gboolean TRUE if the menu item proxies will always show their image	Gtk.Action
	get_gicon () : Gio.Icon Gets the gicon of action. Gets the gicon of action. Returns: Gio.Icon The action's GIcon if one is set.	Gtk.Action
	get_icon_name () : String Gets the icon name of action. Gets the icon name of action. Returns: String the icon name	Gtk.Action
	get_internal_child (Builder *builder, String childname) : GObject.Object Get the internal child called childname* of the buildable object. Get the internal child called childname of the buildable object. Parameters: Gtk.Builder builder Required (not null) a GtkBuilder String childname Required (not null) name of child Returns: GObject.Object the internal child of the buildable object	Gtk.Buildable
	get_is_important () : gboolean Checks whether action is important or not Checks whether action is important or not Returns: gboolean whether action is important	Gtk.Action
	get_label () : String Gets the label text of action. Gets the label text of action. Returns: String the label text	Gtk.Action
	get_name () : String Returns the name of the action. Returns the name of the action. be freed. Returns: String the name of the action. The string belongs to GTK+ and should not	Gtk.Action
	get_proxies () : Array Returns the proxy widgets for an action. Returns the proxy widgets for an action. See also gtk_activatable_get_related_action(). and must not be modified. Returns: Array a GSList of proxy widgets. The list is owned by GTK+	Gtk.Action
	get_sensitive () : gboolean Returns whether the action itself is sensitive. Returns whether the action itself is sensitive. Note that this doesn't necessarily mean effective sensitivity. See gtk_action_is_sensitive() for that. Returns: gboolean TRUE if the action itself is sensitive.	Gtk.Action
	get_short_label () : String Gets the short label text of action. Gets the short label text of action. Returns: String the short label text.	Gtk.Action
	get_stock_id () : String Gets the stock id of action. Gets the stock id of action. Returns: String the stock id	Gtk.Action
	get_tooltip () : String Gets the tooltip text of action. Gets the tooltip text of action. Returns: String the tooltip text	Gtk.Action
	get_visible () : gboolean Returns whether the action itself is visible. Returns whether the action itself is visible. Note that this doesn't necessarily mean effective visibility. See gtk_action_is_sensitive() for that. Returns: gboolean TRUE if the action itself is visible.	Gtk.Action
	get_visible_horizontal () : gboolean Checks whether action is visible when horizontal Checks whether action is visible when horizontal Returns: gboolean whether action is visible when horizontal	Gtk.Action
	get_visible_vertical () : gboolean Checks whether action is visible when horizontal Checks whether action is visible when horizontal Returns: gboolean whether action is visible when horizontal	Gtk.Action
	is_sensitive () : gboolean Returns whether the action is effectively sensitive. Returns whether the action is effectively sensitive. are both sensitive. Returns: gboolean TRUE if the action and its associated action group	Gtk.Action
	is_visible () : gboolean Returns whether the action is effectively visible. Returns whether the action is effectively visible. are both visible. Returns: gboolean TRUE if the action and its associated action group	Gtk.Action
	parser_finished (Builder *builder) : none Called when the builder finishes the parsing of a GtkBuilder UI definition. Called when the builder finishes the parsing of a GtkBuilder UI definition. Note that this will be called once for each time gtk_builder_add_from_file() or gtk_builder_add_from_string() is called on a builder. Parameters: Gtk.Builder builder* Required (not null) a GtkBuilder Returns: none	Gtk.Buildable
	set_accel_group (AccelGroup *accel_group) : none Sets the GtkAccelGroup* in which the accelerator for this action will be installed. Sets the GtkAccelGroup in which the accelerator for this action will be installed. Parameters: Gtk.AccelGroup accel_group a GtkAccelGroup or NULL Returns: none	Gtk.Action
	set_accel_path (String *accel_path) : none Sets the accel path for this action. Sets the accel path for this action. All proxy widgets associated with the action will have this accel path, so that their accelerators are consistent. Note that accel_path* string will be stored in a GQuark. Therefore, if you pass a static string, you can save some memory by interning it first with g_intern_static_string(). Parameters: String accel_path Required (not null) the accelerator path Returns: none	Gtk.Action
	set_always_show_image (gboolean *always_show) : none Sets whether action's menu item proxies will ignore the GtkSettings:gtk-menu-images setting and always show their image, if available. Sets whether action's menu item proxies will ignore the GtkSettings:gtk-menu-images setting and always show their image, if available. Use this if the menu item would be useless or hard to use without their image. Parameters: gboolean always_show* Required (not null) TRUE if menuitem proxies should always show their image Returns: none	Gtk.Action
	set_buildable_property (Builder *builder, String name, Value value) : none Sets the property name name* to value on the buildable object. Sets the property name name to value on the buildable object. Parameters: Gtk.Builder builder Required (not null) a GtkBuilder String name Required (not null) name of property GObject.Value value Required (not null) value of property Returns: none	Gtk.Buildable
	set_gicon (Icon *icon) : none Sets the icon of action. Sets the icon of action. Parameters: Gio.Icon icon* Required (not null) the GIcon to set Returns: none	Gtk.Action
	set_icon_name (String *icon_name) : none Sets the icon name on action* Sets the icon name on action Parameters: String icon_name Required (not null) the icon name to set Returns: none	Gtk.Action
	set_is_important (gboolean *is_important) : none Sets whether the action is important, this attribute is used primarily by toolbar items to decide whether to show a label or not. Sets whether the action is important, this attribute is used primarily by toolbar items to decide whether to show a label or not. Parameters: gboolean is_important* Required (not null) TRUE to make the action important Returns: none	Gtk.Action
	set_label (String *label) : none Sets the label of action. Sets the label of action. Parameters: String label* Required (not null) the label text to set Returns: none	Gtk.Action
	set_name (String *name) : none Sets the name of the buildable* object. Sets the name of the buildable object. Parameters: String name Required (not null) name to set Returns: none	Gtk.Buildable
	set_sensitive (gboolean *sensitive) : none Sets the ::sensitive property of the action to sensitive. Sets the ::sensitive property of the action to sensitive. Note that this doesn't necessarily mean effective sensitivity. See gtk_action_is_sensitive() for that. Parameters: gboolean sensitive* Required (not null) TRUE to make the action sensitive Returns: none	Gtk.Action
	set_short_label (String *short_label) : none Sets a shorter label text on action. Sets a shorter label text on action. Parameters: String short_label* Required (not null) the label text to set Returns: none	Gtk.Action
	set_stock_id (String *stock_id) : none Sets the stock id on action* Sets the stock id on action Parameters: String stock_id Required (not null) the stock id Returns: none	Gtk.Action
	set_tooltip (String *tooltip) : none Sets the tooltip text on action* Sets the tooltip text on action Parameters: String tooltip Required (not null) the tooltip text Returns: none	Gtk.Action
	set_visible (gboolean *visible) : none Sets the ::visible property of the action to visible. Sets the ::visible property of the action to visible. Note that this doesn't necessarily mean effective visibility. See gtk_action_is_visible() for that. Parameters: gboolean visible* Required (not null) TRUE to make the action visible Returns: none	Gtk.Action
	set_visible_horizontal (gboolean *visible_horizontal) : none Sets whether action* is visible when horizontal Sets whether action is visible when horizontal Parameters: gboolean visible_horizontal Required (not null) whether the action is visible horizontally Returns: none	Gtk.Action
	set_visible_vertical (gboolean *visible_vertical) : none Sets whether action* is visible when vertical Sets whether action is visible when vertical Parameters: gboolean visible_vertical Required (not null) whether the action is visible vertically Returns: none	Gtk.Action
	unblock_activate () : none Reenable activation signals from the action Reenable activation signals from the action Returns: none	Gtk.Action

Events - usage syntax: this.signals.EVENTNAME.connect( Function )
Event		Defined By
	activate (Action *self) : none The "activate" signal is emitted when the action is activated. The "activate" signal is emitted when the action is activated. Parameters: Gtk.Action self* Returns: {none}	Gtk.Action

Used by These Methods / Signals / Properties
Class / Namespace	Method / Signal / Properties
Gtk.ActionGroup Signal	connect_proxy (ActionGroup *self, Action action, Widget proxy*) : none The ::connect-proxy signal is emitted after connecting a proxy to an action in the group.
Gtk.ActionGroup Signal	disconnect_proxy (ActionGroup *self, Action action, Widget proxy*) : none The ::disconnect-proxy signal is emitted after disconnecting a proxy from an action in the group.
Gtk.ActionGroup Signal	post_activate (ActionGroup *self, Action action) : none The ::post-activate signal is emitted just after the action* in the This is intended for GtkUIManager to proxy the signal and provide global notification just after any action is activated.
Gtk.ActionGroup Signal	pre_activate (ActionGroup *self, Action action) : none The ::pre-activate signal is emitted just before the action* in the This is intended for GtkUIManager to proxy the signal and provide global notification just before any action is activated.
Gtk.ActionGroup Method	add_action (Action *action*) : none Adds an action object to the action group.
Gtk.ActionGroup Method	add_action_with_accel (Action *action, String accelerator*) : none Adds an action object to the action group and sets up the accelerator.
Gtk.ActionGroup Method	get_action (String *action_name*) : Gtk.Action Looks up an action in the action group by name.
Gtk.ActionGroup Method	remove_action (Action *action*) : none Removes an action object from the action group.
Gtk.Activatable Property	related_action : Gtk.Action The action that this activatable will activate and receive updates from for various states and possibly appearance.
Gtk.Activatable Method	do_set_related_action (Action *action) : none This is a utility function for GtkActivatable* implementors.
Gtk.Activatable Method	get_related_action () : Gtk.Action Gets the related GtkAction for activatable.
Gtk.Activatable Method	set_related_action (Action *action) : none Sets the related action on the activatable* object.
Gtk.Activatable Method	sync_action_properties (Action *action) : none This is called to update the activatable completely, this is called internally when the GtkActivatable::related-action property is set or unset and by the implementing class when GtkActivatable*::use-action-appearance changes.
Gtk.UIManager Signal	connect_proxy (UIManager *self, Action action, Widget proxy*) : none The ::connect-proxy signal is emitted after connecting a proxy to an action in the group.
Gtk.UIManager Signal	disconnect_proxy (UIManager *self, Action action, Widget proxy*) : none The ::disconnect-proxy signal is emitted after disconnecting a proxy from an action in the group.
Gtk.UIManager Signal	post_activate (UIManager *self, Action action) : none The ::post-activate signal is emitted just after the action* is activated.
Gtk.UIManager Signal	pre_activate (UIManager *self, Action action) : none The ::pre-activate signal is emitted just before the action* is activated.
Gtk.UIManager Method	get_action (String *path*) : Gtk.Action Looks up an action by following a path.