Optionalproperties: Partial<Gtk.ToggleAction.ConstructorProps>Internal$signalsCompile-time signal type information.
This instance property is generated only for TypeScript type checking. It is not defined at runtime and should not be accessed in JS code.
Static$gtypeSince 2.10activeWhether the proxies for this action look like radio action proxies.
This is an appearance property and thus only applies if
Gtk.Activatable.use_action_appearance is true.
Whether the proxies for this action look like radio action proxies.
This is an appearance property and thus only applies if
Gtk.Activatable.use_action_appearance is true.
The GtkActionGroup this GtkAction is associated with, or NULL (for internal use).
since 3.10: Lookup the Gio.Action using g_action_map_lookup_action() instead
The GtkActionGroup this GtkAction is associated with, or NULL (for internal use).
since 3.10: Lookup the Gio.Action using g_action_map_lookup_action() instead
If true, the action's menu item proxies will ignore the Gtk.Settings.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.
since 3.10: There is no corresponding replacement when using Gio.Action
If true, the action's menu item proxies will ignore the Gtk.Settings.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.
since 3.10: There is no corresponding replacement when using Gio.Action
The Gio.Icon displayed in the Gtk.Action.
Note that the stock icon is preferred, if the Gtk.Action.stock_id property holds the id of an existing stock icon.
This is an appearance property and thus only applies if
Gtk.Activatable.use_action_appearance is true.
since 3.10: Use the "icon" attribute on a Gio.MenuItem instead
When TRUE, empty menu proxies for this action are hidden.
since 3.10: There is no corresponding replacement when using Gio.Action
When TRUE, empty menu proxies for this action are hidden.
since 3.10: There is no corresponding replacement when using Gio.Action
The name of the icon from the icon theme.
Note that the stock icon is preferred, if the Gtk.Action.stock_id property holds the id of an existing stock icon, and the Gio.Icon is preferred if the Gtk.Action.gicon property is set.
This is an appearance property and thus only applies if
Gtk.Activatable.use_action_appearance is true.
since 3.10: Use the "icon" attribute on a Gio.MenuItem instead
The name of the icon from the icon theme.
Note that the stock icon is preferred, if the Gtk.Action.stock_id property holds the id of an existing stock icon, and the Gio.Icon is preferred if the Gtk.Action.gicon property is set.
This is an appearance property and thus only applies if
Gtk.Activatable.use_action_appearance is true.
since 3.10: Use the "icon" attribute on a Gio.MenuItem instead
Whether the action is considered important. When TRUE, toolitem proxies for this action show text in GTK_TOOLBAR_BOTH_HORIZ mode.
since 3.10: There is no corresponding replacement when using Gio.Action
Whether the action is considered important. When TRUE, toolitem proxies for this action show text in GTK_TOOLBAR_BOTH_HORIZ mode.
since 3.10: There is no corresponding replacement when using Gio.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
Gtk.Activatable.use_action_appearance is true.
since 3.10: Use the "label" attribute on Gio.MenuItem instead
Whether the action is enabled.
since 3.10: Use Gio.Action.enabled and Gio.SimpleAction.enabled instead
A shorter label that may be used on toolbar buttons.
This is an appearance property and thus only applies if
Gtk.Activatable.use_action_appearance is true.
since 3.10: There is no corresponding replacement when using Gio.Action
A shorter label that may be used on toolbar buttons.
This is an appearance property and thus only applies if
Gtk.Activatable.use_action_appearance is true.
since 3.10: There is no corresponding replacement when using Gio.Action
The stock icon displayed in widgets representing this action.
This is an appearance property and thus only applies if
Gtk.Activatable.use_action_appearance is true.
since 3.10: There is no corresponding replacement when using Gio.Action
The stock icon displayed in widgets representing this action.
This is an appearance property and thus only applies if
Gtk.Activatable.use_action_appearance is true.
since 3.10: There is no corresponding replacement when using Gio.Action
Whether the action is visible.
since 3.10: There is no corresponding replacement when using Gio.Action
Whether the toolbar item is visible when the toolbar is in a horizontal orientation.
since 3.10: There is no corresponding replacement when using Gio.Action
When true, toolitem proxies for this action are represented in the
toolbar overflow menu.
since 3.10: There is no corresponding replacement when using Gio.Action
Whether the toolbar item is visible when the toolbar is in a vertical orientation.
since 3.10: There is no corresponding replacement when using Gio.Action
Whether the toolbar item is visible when the toolbar is in a horizontal orientation.
since 3.10: There is no corresponding replacement when using Gio.Action
When true, toolitem proxies for this action are represented in the
toolbar overflow menu.
since 3.10: There is no corresponding replacement when using Gio.Action
Whether the toolbar item is visible when the toolbar is in a vertical orientation.
since 3.10: There is no corresponding replacement when using Gio.Action
Creates a binding between source_property on source and target_property
on target.
Whenever the source_property is changed the target_property is
updated using the same value. For instance:
g_object_bind_property (action, "active", widget, "sensitive", 0);
Will result in the "sensitive" property of the widget GObject.Object instance to be updated with the same value of the "active" property of the action GObject.Object instance.
If flags contains GObject.BindingFlags.BIDIRECTIONAL then the binding will be mutual:
if target_property on target changes then the source_property on source
will be updated as well.
The binding will automatically be removed when either the source or the
target instances are finalized. To remove the binding without affecting the
source and the target you can just call g_object_unref() on the returned
GObject.Binding instance.
Removing the binding by calling g_object_unref() on it must only be done if
the binding, source and target are only used from a single thread and it
is clear that both source and target outlive the binding. Especially it
is not safe to rely on this if the binding, source or target can be
finalized from different threads. Keep another reference to the binding and
use g_binding_unbind() instead to be on the safe side.
A GObject.Object can have multiple bindings.
the property on source to bind
the target GObject.Object
the property on target to bind
flags to pass to GObject.Binding
the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.
Complete version of g_object_bind_property().
Creates a binding between source_property on source and target_property
on target, allowing you to set the transformation functions to be used by
the binding.
If flags contains GObject.BindingFlags.BIDIRECTIONAL then the binding will be mutual:
if target_property on target changes then the source_property on source
will be updated as well. The transform_from function is only used in case
of bidirectional bindings, otherwise it will be ignored
The binding will automatically be removed when either the source or the
target instances are finalized. This will release the reference that is
being held on the GObject.Binding instance; if you want to hold on to the
GObject.Binding instance, you will need to hold a reference to it.
To remove the binding, call g_binding_unbind().
A GObject.Object can have multiple bindings.
The same user_data parameter will be used for both transform_to
and transform_from transformation functions; the notify function will
be called once, when the binding is removed. If you need different data
for each transformation function, please use
g_object_bind_property_with_closures() instead.
the property on source to bind
the target GObject.Object
the property on target to bind
flags to pass to GObject.Binding
Optionaltransform_to: BindingTransformFuncthe transformation function from the source to the target, or null to use the default
Optionaltransform_from: BindingTransformFuncthe transformation function from the target to the source, or null to use the default
Optionalnotify: DestroyNotifya function to call when disposing the binding, to free resources used by the transformation functions, or null if not required
the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.
Creates a binding between source_property on source and target_property
on target, allowing you to set the transformation functions to be used by
the binding.
This function is the language bindings friendly version of
g_object_bind_property_full(), using GClosures instead of
function pointers.
the property on source to bind
the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.
Blocks a handler of an instance so it will not be called during any signal emissions
Handler ID of the handler to be blocked
SignalconnectSignalconnect_Constructs a child of buildable with the name name.
Gtk.Builder calls this function if a “constructor” has been specified in the UI definition.
Gtk.Builder used to construct this object
name of child to construct
the constructed child
This is similar to gtk_buildable_parser_finished() but is
called once for each custom tag handled by the buildable.
This is called at the end of each custom element handled by the buildable.
Gtk.Builder used to construct this object
child object or null for non-child tags
name of tag
Optionaldata: anyuser data that will be passed in to parser functions
This is called for each unknown element under <child>.
a Gtk.Builder used to construct this object
child object or null for non-child tags
name of tag
true if a object has a custom implementation, false if it doesn't.
Disconnects a handler from an instance so it will not be called during any future or currently ongoing emissions of the signal it has been connected to.
Handler ID of the handler to be disconnected
SignalemitThis function is intended for GObject.Object implementations to re-enforce
a [floating][floating-ref] object reference. Doing this is seldom
required: all GInitiallyUnowneds are created with a floating reference
which usually just needs to be sunken by calling g_object_ref_sink().
Increases the freeze count on object. If the freeze count is
non-zero, the emission of "notify" signals on object is
stopped. The signals are queued until the freeze count is decreased
to zero. Duplicate notifications are squashed so that at most one
GObject.Object::notify signal is emitted for each property modified while the
object is frozen.
This is necessary for accessors that modify multiple properties to prevent premature notification while the object is still being modified.
Returns the checked state of the toggle action.
the checked state of the toggle action
Gets a named field from the objects table of associations (see g_object_set_data()).
name of the key for that association
the data if found, or null if no such data exists.
Returns whether the action should have proxies like a radio action.
whether the action should have proxies like a radio action.
Gets the name of the buildable object.
Gtk.Builder sets the name based on the
[GtkBuilder UI definition][BUILDER-UI]
used to construct the buildable.
the name set with gtk_buildable_set_name()
Gets a property of an object.
The value can be:
In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling GObject.Value.unset.
Note that GObject.Object.get_property is really intended for language bindings, GObject.Object.get is much more convenient for C programming.
The name of the property to get
Return location for the property value. Can be an empty GObject.Value initialized by G_VALUE_INIT (auto-initialized with expected type since GLib 2.60), a GObject.Value initialized with the expected property type, or a GObject.Value initialized with a transformable type
This function gets back user data pointers stored via
g_object_set_qdata().
A GLib.Quark, naming the user data pointer
The user data pointer set, or null
Gets n_properties properties for an object.
Obtained properties will be set to values. All properties must be valid.
Warnings will be emitted and undefined behaviour may result if invalid
properties are passed in.
the names of each property to get
the values of each property to get
Checks whether object has a [floating][floating-ref] reference.
true if object has a floating reference
Emits a "notify" signal for the property property_name on object.
When possible, eg. when signaling a property change from within the class
that registered the property, you should use g_object_notify_by_pspec()
instead.
Note that emission of the notify signal may be blocked with
g_object_freeze_notify(). In this case, the signal emissions are queued
and will be emitted (in reverse order) when g_object_thaw_notify() is
called.
the name of a property installed on the class of object.
Emits a "notify" signal for the property specified by pspec on object.
This function omits the property name lookup, hence it is faster than
g_object_notify().
One way to avoid using g_object_notify() from within the
class that registered the properties, and using g_object_notify_by_pspec()
instead, is to store the GParamSpec used with
g_object_class_install_property() inside a static array, e.g.:
typedef enum
{
PROP_FOO = 1,
PROP_LAST
} MyObjectProperty;
static GParamSpec *properties[PROP_LAST];
static void
my_object_class_init (MyObjectClass *klass)
{
properties[PROP_FOO] = g_param_spec_int ("foo", NULL, NULL,
0, 100,
50,
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
g_object_class_install_property (gobject_class,
PROP_FOO,
properties[PROP_FOO]);
}
and then notify a change on the "foo" property with:
g_object_notify_by_pspec (self, properties[PROP_FOO]);
the GObject.ParamSpec of a property installed on the class of object.
Increases the reference count of object.
Since GLib 2.56, if GLIB_VERSION_MAX_ALLOWED is 2.56 or greater, the type
of object will be propagated to the return type (using the GCC typeof()
extension), so any casting the caller needs to do on the return type must be
explicit.
the same object
Increase the reference count of object, and possibly remove the
[floating][floating-ref] reference, if object has a floating reference.
In other words, if the object is floating, then this call "assumes ownership" of the floating reference, converting it to a normal reference by clearing the floating flag while leaving the reference count unchanged. If the object is not floating, then this call adds a new normal reference increasing the reference count by one.
Since GLib 2.56, the type of object will be propagated to the return type
under the same conditions as for g_object_ref().
object
Releases all references to other objects. This can be used to break reference cycles.
This function should only be called from object system implementations.
Sets multiple properties of an object at once. The properties argument should be a dictionary mapping property names to values.
Object containing the properties to set
Sets the checked state on the toggle action.
whether the action should be checked or not
Each object carries around a table of associations from strings to pointers. This function lets you set an association.
If the object already had an association with that name, the old association will be destroyed.
Internally, the key is converted to a GLib.Quark using g_quark_from_string().
This means a copy of key is kept permanently (even after object has been
finalized) — so it is recommended to only use a small, bounded set of values
for key in your program, to avoid the GLib.Quark storage growing unbounded.
name of the key
Optionaldata: anydata to associate with that key
Sets whether the action should have proxies like a radio action.
whether the action should have proxies like a radio action
Sets the name of the buildable object.
name to set
Sets a property on an object.
The name of the property to set
The value to set the property to
Remove a specified datum from the object's data associations, without invoking the association's destroy handler.
name of the key
the data if found, or null if no such data exists.
This function gets back user data pointers stored via
g_object_set_qdata() and removes the data from object
without invoking its destroy() function (if any was
set).
Usually, calling this function is only required to update
user data pointers with a destroy notifier, for example:
void
object_add_to_user_list (GObject *object,
const gchar *new_string)
{
// the quark, naming the object data
GQuark quark_string_list = g_quark_from_static_string ("my-string-list");
// retrieve the old string list
GList *list = g_object_steal_qdata (object, quark_string_list);
// prepend new string
list = g_list_prepend (list, g_strdup (new_string));
// this changed 'list', so we need to set it again
g_object_set_qdata_full (object, quark_string_list, list, free_string_list);
}
static void
free_string_list (gpointer data)
{
GList *node, *list = data;
for (node = list; node; node = node->next)
g_free (node->data);
g_list_free (list);
}
Using g_object_get_qdata() in the above example, instead of
g_object_steal_qdata() would have left the destroy function set,
and thus the partial string list would have been freed upon
g_object_set_qdata_full().
A GLib.Quark, naming the user data pointer
The user data pointer set, or null
Stops a signal's emission by the given signal name. This will prevent the default handler and any subsequent signal handlers from being invoked.
Name of the signal to stop emission of
Reverts the effect of a previous call to
g_object_freeze_notify(). The freeze count is decreased on object
and when it reaches zero, queued "notify" signals are emitted.
Duplicate notifications for each property are squashed so that at most one GObject.Object::notify signal is emitted for each property, in the reverse order in which they have been queued.
It is an error to call this function when the freeze count is zero.
Emits the “toggled” signal on the toggle action.
Unblocks a handler so it will be called again during any signal emissions
Handler ID of the handler to be unblocked
Decreases the reference count of object. When its reference count
drops to 0, the object is finalized (i.e. its memory is freed).
If the pointer to the GObject.Object may be reused in future (for example, if it is
an instance variable of another object), it is recommended to clear the
pointer to null rather than retain a dangling pointer to a potentially
invalid GObject.Object instance. Use g_clear_object() for this.
Virtualvfunc_Virtualvfunc_Constructs a child of buildable with the name name.
Gtk.Builder calls this function if a “constructor” has been specified in the UI definition.
Gtk.Builder used to construct this object
name of child to construct
Virtualvfunc_the constructed function is called by g_object_new() as the
final step of the object creation process. At the point of the call, all
construction properties have been set on the object. The purpose of this
call is to allow for object initialisation steps that can only be performed
after construction properties have been set. constructed implementors
should chain up to the constructed call of their parent class to allow it
to complete its initialisation.
Virtualvfunc_Virtualvfunc_This is called at the end of each custom element handled by the buildable.
Gtk.Builder used to construct this object
child object or null for non-child tags
name of tag
Optionaldata: anyuser data that will be passed in to parser functions
Virtualvfunc_This is called for each unknown element under <child>.
a Gtk.Builder used to construct this object
child object or null for non-child tags
name of tag
Virtualvfunc_Virtualvfunc_the dispose function is supposed to drop all references to other
objects, but keep the instance otherwise intact, so that client method
invocations still work. It may be run multiple times (due to reference
loops). Before returning, dispose should chain up to the dispose method
of the parent class.
Virtualvfunc_instance finalization function, should finish the finalization of
the instance begun in dispose and chain up to the finalize method of the
parent class.
Virtualvfunc_Virtualvfunc_Gets the name of the buildable object.
Gtk.Builder sets the name based on the
[GtkBuilder UI definition][BUILDER-UI]
used to construct the buildable.
Virtualvfunc_Virtualvfunc_Emits a "notify" signal for the property property_name on object.
When possible, eg. when signaling a property change from within the class
that registered the property, you should use g_object_notify_by_pspec()
instead.
Note that emission of the notify signal may be blocked with
g_object_freeze_notify(). In this case, the signal emissions are queued
and will be emitted (in reverse order) when g_object_thaw_notify() is
called.
Virtualvfunc_Virtualvfunc_Virtualvfunc_Sets the name of the buildable object.
name to set
Virtualvfunc_the generic setter for all properties of this type. Should be
overridden for every type with properties. If implementations of
set_property don't emit property change notification explicitly, this will
be done implicitly by the type system. However, if the notify signal is
emitted explicitly, the type system will not emit it a second time.
Virtualvfunc_Emits the “toggled” signal on the toggle action.
This function essentially limits the life time of the closure to
the life time of the object. That is, when the object is finalized,
the closure is invalidated by calling g_closure_invalidate() on
it, in order to prevent invocations of the closure with a finalized
(nonexisting) object. Also, g_object_ref() and g_object_unref() are
added as marshal guards to the closure, to ensure that an extra
reference count is held on object during invocation of the
closure. Usually, this function will be called on closures that
use this object as closure data.
GObject.Closure to watch
StaticnewOptionallabel: stringOptionaltooltip: stringOptionalstock_id: stringEmits 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.
Disable activation signals from the action
This is needed when updating the state of your proxy
Gtk.Activatable widget could result in calling gtk_action_activate(),
this is a convenience function to avoid recursing in those
cases (updating toggle state for instance).
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.
This function is intended for use by action implementations to create icons displayed in the proxy widgets.
the size of the icon (Gtk.IconSize) that should be created.
a widget that displays the icon for this action.
Undoes the effect of one call to gtk_action_connect_accelerator().
Returns the accel closure for this action.
the accel closure for this action. The returned closure is owned by GTK+ and must not be unreffed or modified.
Returns the accel path for this action.
the accel path for this action, or null if none is set. The returned string is owned by GTK+ and must not be freed or modified.
Returns whether action's menu item proxies will always
show their image, if available.
true if the menu item proxies will always show their image
Gets the icon name of action.
the icon name
Checks whether action is important or not
whether action is important
Gets the label text of action.
the label text
Returns the proxy widgets for an action.
See also gtk_activatable_get_related_action().
a GLib.SList of proxy widgets. The list is owned by GTK+ and must not be modified.
Returns whether the action itself is sensitive. Note that this doesn’t
necessarily mean effective sensitivity. See gtk_action_is_sensitive()
for that.
true if the action itself is sensitive.
Gets the short label text of action.
the short label text.
Gets the stock id of action.
the stock id
Gets the tooltip text of action.
the tooltip text
Returns whether the action itself is visible. Note that this doesn’t
necessarily mean effective visibility. See gtk_action_is_sensitive()
for that.
true if the action itself is visible.
Checks whether action is visible when horizontal
whether action is visible when horizontal
Checks whether action is visible when horizontal
whether action is visible when horizontal
Returns whether the action is effectively sensitive.
true if the action and its associated action group are both sensitive.
Returns whether the action is effectively visible.
true if the action and its associated action group are both visible.
Sets the Gtk.AccelGroup in which the accelerator for this action will be installed.
Optionalaccel_group: Gtk.AccelGroupa Gtk.AccelGroup or null
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 GLib.Quark. Therefore, if you
pass a static string, you can save some memory by interning it first with
g_intern_static_string().
the accelerator path
Sets whether action's menu item proxies will ignore the
Gtk.Settings.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.
true if menuitem proxies should always show their image
Sets the icon name on action
the icon name to set
Sets whether the action is important, this attribute is used primarily by toolbar items to decide whether to show a label or not.
true to make the action important
Sets the label of action.
the label text to set
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.
true to make the action sensitive
Sets a shorter label text on action.
the label text to set
Sets the stock id on action
the stock id
Sets the tooltip text on action
the tooltip text
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.
true to make the action visible
Sets whether action is visible when horizontal
whether the action is visible horizontally
Sets whether action is visible when vertical
whether the action is visible vertically
Reenable activation signals from the action
Virtualvfunc_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.
Virtualvfunc_Virtualvfunc_Virtualvfunc_Virtualvfunc_Virtualvfunc_Static_Staticcompat_Optionaldata: anyStaticfind_Staticinstall_Staticinstall_the id for the new property
the GObject.ParamSpec for the new property
Staticinterface_Find the GObject.ParamSpec with the given name for an
interface. Generally, the interface vtable passed in as g_iface
will be the default vtable from g_type_default_interface_ref(), or,
if you know the interface has already been loaded,
g_type_default_interface_peek().
any interface vtable for the interface, or the default vtable for the interface
name of a property to look up.
Staticinterface_Add a property to an interface; this is only useful for interfaces
that are added to GObject-derived types. Adding a property to an
interface forces all objects classes with that interface to have a
compatible property. The compatible property could be a newly
created GObject.ParamSpec, but normally
g_object_class_override_property() will be used so that the object
class only needs to provide an implementation and inherits the
property description, default value, bounds, and so forth from the
interface property.
This function is meant to be called from the interface's default
vtable initialization function (the class_init member of
GObject.TypeInfo.) It must not be called after after class_init has
been called for any object types implementing this interface.
If pspec is a floating reference, it will be consumed.
any interface vtable for the interface, or the default vtable for the interface.
the GObject.ParamSpec for the new property
Staticinterface_Lists the properties of an interface.Generally, the interface
vtable passed in as g_iface will be the default vtable from
g_type_default_interface_ref(), or, if you know the interface has
already been loaded, g_type_default_interface_peek().
any interface vtable for the interface, or the default vtable for the interface
Staticlist_StaticnewvStaticoverride_the new property ID
the name of a property registered in a parent class or in an interface of this class.
A Gtk.ToggleAction corresponds roughly to a Gtk.CheckMenuItem. It has an “active” state specifying whether the action has been checked or not.