Back to Seed Clases

Gtk

Classes

Interfaces

Structs

Unions

DitherInfo

Enums

GObject.Object
parent-child marker Gtk.Action
Gtk.ToggleAction

Class Gtk.ToggleAction

Import line:	Gtk = imports.gi.Gtk;
GIR File:	Gtk-2.0.gir
C documentation:	GtkToggleAction
Class :	ToggleAction
Implements:	Gtk.Buildable
Extends:	Gtk.Action
	Show / Hide Inherited methods, properties and signals

Properties
Properties		Defined By
	action_group : Gtk.ActionGroup	Gtk.Action
	active : Boolean If the toggle action should be active in or not. If the toggle action should be active in or not.	Gtk.ToggleAction
	always_show_image : Boolean 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
	draw_as_radio : Boolean Whether the proxies for this action look like radio action proxies. Whether the proxies for this action look like radio action proxies. This is an appearance property and thus only applies if GtkActivatable:use-action-appearance is TRUE.	Gtk.ToggleAction
	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 : Boolean	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 : Boolean	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
	parent : Gtk.Action read only	Gtk.ToggleAction
	private_data : Gtk.ToggleActionPrivate read only	Gtk.ToggleAction
	sensitive : Boolean	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 : Boolean	Gtk.Action
	visible_horizontal : Boolean	Gtk.Action
	visible_overflown : Boolean 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 : Boolean	Gtk.Action

Methods / Constructors
Method / Constructor		Defined By
	new Gtk.ToggleAction (Object *properties) Create a new Gtk.ToggleAction Create a new Gtk.ToggleAction Parameters: Object properties*
	new Gtk.ToggleAction.c_new (String *name, String label, String tooltip, String stock_id) : Gtk.ToggleAction Create a new Gtk.ToggleAction Create a new Gtk.ToggleAction Parameters: String name* Required (not null) 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 Required (not null) action, or NULL Returns: Gtk.ToggleAction
	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) GObject.Object child Required (not null) 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
	block_activate_from (Widget *proxy) : none Disables calls to the gtk_action_activate() function by signals on the given proxy widget. Disables calls to the gtk_action_activate() function by signals on the given proxy widget. This is used to break notification loops for things like check or radio actions. This function is intended for use by action implementations. action directly so this doesnt apply anymore. Parameters: Gtk.Widget proxy* Required (not null) 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
	connect_proxy (Widget *proxy) : none Connects a widget to an action object as a proxy. Connects a widget to an action object as a proxy. Synchronises various properties of the action with the widget (such as label text, icon, tooltip, etc), and attaches a callback so that the action gets activated when the proxy widget does. If the widget is already connected to an action, it is disconnected first. Parameters: Gtk.Widget proxy* Required (not null) 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) String name Required (not null) Returns: GObject.Object	Gtk.Buildable
	create_icon (Number *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: Number icon_size* Required (not null) the size of the icon that should be created. Returns: Gtk.Widget	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. Returns: Gtk.Widget	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	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	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) GObject.Object child child object or NULL for non-child tags String tagname Required (not null) void* data Required (not null) 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) GObject.Object child child object or NULL for non-child tags String tagname Required (not null) void* data Required (not null) Returns: none	Gtk.Buildable
	custom_tag_start (Builder *builder, Object child, String tagname, MarkupParser parser, void *data) : Boolean 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) GObject.Object child child object or NULL for non-child tags String tagname Required (not null) GLib.MarkupParser parser Required (not null) void* data Required (not null) to parser functions Returns: Boolean	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
	disconnect_proxy (Widget *proxy) : none Disconnects a proxy widget from an action. Disconnects a proxy widget from an action. Does not destroy the widget, however. Parameters: Gtk.Widget proxy* Required (not null) Returns: none	Gtk.Action
	get_accel_closure () : GObject.Closure Returns the accel closure for this action. Returns the accel closure for this action. owned by GTK+ and must not be unreffed or modified. Returns: GObject.Closure	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	Gtk.Action
	get_active () : Boolean Returns the checked state of the toggle action. Returns the checked state of the toggle action. Returns: Boolean	Gtk.ToggleAction
	get_always_show_image () : Boolean 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: Boolean	Gtk.Action
	get_draw_as_radio () : Boolean Returns whether the action should have proxies like a radio action. Returns whether the action should have proxies like a radio action. Returns: Boolean	Gtk.ToggleAction
	get_gicon () : Gio.Icon Gets the gicon of action. Gets the gicon of action. Returns: Gio.Icon	Gtk.Action
	get_icon_name () : String Gets the icon name of action. Gets the icon name of action. Returns: String	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) String childname Required (not null) Returns: GObject.Object	Gtk.Buildable
	get_is_important () : Boolean Checks whether action is important or not Checks whether action is important or not Returns: Boolean	Gtk.Action
	get_label () : String Gets the label text of action. Gets the label text of action. Returns: String	Gtk.Action
	get_name () : String Returns the name of the action. Returns the name of the action. be freed. Returns: String	Gtk.Action
	get_proxies () : Array Returns the proxy widgets for an action. Returns the proxy widgets for an action. See also gtk_widget_get_action(). and must not be modified. Returns: Array a GSList of proxy widgets. The list is owned by GTK+	Gtk.Action
	get_sensitive () : Boolean 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: Boolean	Gtk.Action
	get_short_label () : String Gets the short label text of action. Gets the short label text of action. Returns: String	Gtk.Action
	get_stock_id () : String Gets the stock id of action. Gets the stock id of action. Returns: String	Gtk.Action
	get_tooltip () : String Gets the tooltip text of action. Gets the tooltip text of action. Returns: String	Gtk.Action
	get_visible () : Boolean 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: Boolean	Gtk.Action
	get_visible_horizontal () : Boolean Checks whether action is visible when horizontal Checks whether action is visible when horizontal Returns: Boolean	Gtk.Action
	get_visible_vertical () : Boolean Checks whether action is visible when horizontal Checks whether action is visible when horizontal Returns: Boolean	Gtk.Action
	is_sensitive () : Boolean Returns whether the action is effectively sensitive. Returns whether the action is effectively sensitive. are both sensitive. Returns: Boolean	Gtk.Action
	is_visible () : Boolean Returns whether the action is effectively visible. Returns whether the action is effectively visible. are both visible. Returns: Boolean	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) 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) Returns: none	Gtk.Action
	set_active (Boolean *is_active) : none Sets the checked state on the toggle action. Sets the checked state on the toggle action. Parameters: Boolean is_active* Required (not null) Returns: none	Gtk.ToggleAction
	set_always_show_image (Boolean *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: Boolean always_show* Required (not null) 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) String name Required (not null) GObject.Value value Required (not null) Returns: none	Gtk.Buildable
	set_draw_as_radio (Boolean *draw_as_radio) : none Sets whether the action should have proxies like a radio action. Sets whether the action should have proxies like a radio action. Parameters: Boolean draw_as_radio* Required (not null) action Returns: none	Gtk.ToggleAction
	set_gicon (Icon *icon) : none Sets the icon of action. Sets the icon of action. Parameters: Gio.Icon icon* Required (not null) 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) Returns: none	Gtk.Action
	set_is_important (Boolean *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: Boolean is_important* Required (not null) 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) 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) Returns: none	Gtk.Buildable
	set_sensitive (Boolean *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: Boolean sensitive* Required (not null) 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) 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) 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) Returns: none	Gtk.Action
	set_visible (Boolean *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: Boolean visible* Required (not null) Returns: none	Gtk.Action
	set_visible_horizontal (Boolean *visible_horizontal) : none Sets whether action* is visible when horizontal Sets whether action is visible when horizontal Parameters: Boolean visible_horizontal Required (not null) Returns: none	Gtk.Action
	set_visible_vertical (Boolean *visible_vertical) : none Sets whether action* is visible when vertical Sets whether action is visible when vertical Parameters: Boolean visible_vertical Required (not null) Returns: none	Gtk.Action
	toggled () : none Emits the "toggled" signal on the toggle action. Emits the "toggled" signal on the toggle action. Returns: none	Gtk.ToggleAction
	unblock_activate () : none Reenable activation signals from the action Reenable activation signals from the action Returns: none	Gtk.Action
	unblock_activate_from (Widget *proxy) : none Re-enables calls to the gtk_action_activate() function by signals on the given proxy widget. Re-enables calls to the gtk_action_activate() function by signals on the given proxy widget. This undoes the blocking done by gtk_action_block_activate_from(). This function is intended for use by action implementations. action directly so this doesnt apply anymore. Parameters: Gtk.Widget proxy* Required (not null) 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
	toggled (ToggleAction *self) : none Parameters: Gtk.ToggleAction self* Returns: {none}	Gtk.ToggleAction

Un-official Seed Documentation

Gtk

Classes

Interfaces

Structs

Unions

Enums

Class Gtk.ToggleAction