A unique name for the action
The label displayed in menu items and on buttons, or %NULL
A tooltip for this action, or %NULL
The stock icon to display in widgets representing this action, or %NULL
The value which gtk_radio_action_get_current_value() should return if this action is selected.
If the toggle action should be active in or not.
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.
The value property of the currently active member of the group to which this action belongs.
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.
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.
Sets a new group for a radio action.
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.
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.
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.
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.
The value is an arbitrary integer which can be used as a convenient way to determine which action in the group is currently active in an ::activate or ::changed signal handler. See gtk_radio_action_get_current_value() and #GtkRadioActionEntry for convenient ways to get and set this property.
When %TRUE, toolitem proxies for this action are represented in the toolbar overflow menu.
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.
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 instance to be updated with the same value of the "active" property of the action #GObject instance.
If flags contains %G_BINDING_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
#GBinding 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 can have multiple bindings.
the property on source to bind
the target #GObject
the property on target to bind
flags to pass to #GBinding
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 target #GObject
the property on target to bind
flags to pass to #GBinding
a #GClosure wrapping the transformation function from the source to the target, or %NULL to use the default
a #GClosure wrapping the transformation function from the target to the source, or %NULL to use the default
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).
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.
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.
This is similar to gtk_buildable_parser_finished() but is
called once for each custom tag handled by the buildable.
a #GtkBuilder
child object or %NULL for non-child tags
the name of the tag
user data created in custom_tag_start
This is called at the end of each custom element handled by the buildable.
#GtkBuilder used to construct this object
child object or %NULL for non-child tags
name of tag
user data that will be passed in to parser functions
This is called for each unknown element under <child>.
a #GtkBuilder used to construct this object
child object or %NULL for non-child tags
name of tag
Undoes the effect of one call to gtk_action_connect_accelerator().
This function is intended for #GObject 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::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 accel closure for this action.
Returns the accel path for this action.
Returns the checked state of the toggle action.
Returns whether action<!-- -->'s menu item proxies will ignore the
#GtkSettings:gtk-menu-images setting and always show their image,
if available.
Obtains the value property of the currently active member of
the group to which action belongs.
Gets a named field from the objects table of associations (see g_object_set_data()).
name of the key for that association
Returns whether the action should have proxies like a radio action.
Returns the list representing the radio group for this object. Note that the returned list is only valid until the next change to the group.
A common way to set up a group of radio group is the following: |[ GSList *group = NULL; GtkRadioAction *action;
while (/* more actions to add */) { action = gtk_radio_action_new (...);
gtk_radio_action_set_group (action, group);
group = gtk_radio_action_get_group (action);
}
Gets the icon name of action.
Checks whether action is important or not
Gets the label text of action.
Returns the name of the action.
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 g_value_unset().
Note that g_object_get_property() is really intended for language bindings, g_object_get() is much more convenient for C programming.
the name of the property to get
return location for the property value
This function gets back user data pointers stored via g_object_set_qdata().
A #GQuark, naming the user data pointer
Returns whether the action itself is sensitive. Note that this doesn't necessarily mean effective sensitivity. See gtk_action_is_sensitive() for that.
Gets the short label text of action.
Gets the stock id of action.
Gets the tooltip text of action.
Returns whether the action itself is visible. Note that this doesn't necessarily mean effective visibility. See gtk_action_is_sensitive() for that.
Checks whether action is visible when horizontal
Checks whether action is visible when horizontal
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.
Returns whether the action is effectively sensitive.
Returns whether the action is effectively visible.
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.:
enum
{
PROP_0,
PROP_FOO,
PROP_LAST
};
static GParamSpec *properties[PROP_LAST];
static void
my_object_class_init (MyObjectClass *klass)
{
properties[PROP_FOO] = g_param_spec_int ("foo", "Foo", "The foo",
0, 100,
50,
G_PARAM_READWRITE);
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 #GParamSpec of a property installed on the class of 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().
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 the #GtkAccelGroup in which the accelerator for this action will be installed.
a #GtkAccelGroup 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 #GQuark. 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 the checked state on the toggle action.
whether the action should be checked or not
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.
%TRUE if menuitem proxies should always show their image
Sets the currently active group member to the member with value
property current_value.
the new value
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 #GQuark 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 #GQuark storage growing unbounded.
name of the key
data 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 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 name of the buildable object.
name to set
Sets a property on an object.
the name of the property to set
the value
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
Remove a specified datum from the object's data associations, without invoking the association's destroy handler.
name of the key
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 #GQuark, naming the user data pointer
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::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.
Reenable activation signals from the action
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 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 instance. Use g_clear_object() for this.
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.
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.
This is similar to gtk_buildable_parser_finished() but is
called once for each custom tag handled by the buildable.
a #GtkBuilder
child object or %NULL for non-child tags
the name of the tag
user data created in custom_tag_start
This is called at the end of each custom element handled by the buildable.
#GtkBuilder used to construct this object
child object or %NULL for non-child tags
name of tag
user data that will be passed in to parser functions
This is called for each unknown element under <child>.
a #GtkBuilder used to construct this object
child object or %NULL for non-child tags
name of tag
Gets the name of the buildable object.
#GtkBuilder sets the name based on the the
GtkBuilder UI definition used to construct the `buildable`.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.
Sets the name of the buildable object.
name to set
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.
#GClosure to watch
Find the #GParamSpec 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.
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 #GParamSpec, 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
#GTypeInfo.) 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 #GParamSpec for the new property
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
Creates a new #GtkRadioAction object. To add the action to a #GtkActionGroup and set the accelerator for the action, call gtk_action_group_add_action_with_accel().
A unique name for the action
The label displayed in menu items and on buttons, or %NULL
A tooltip for this action, or %NULL
The stock icon to display in widgets representing this action, or %NULL
The value which gtk_radio_action_get_current_value() should return if this action is selected.
Creates a new #GtkToggleAction object. To add the action to a #GtkActionGroup and set the accelerator for the action, call gtk_action_group_add_action_with_accel().
A unique name for the action
The label displayed in menu items and on buttons, or %NULL
A tooltip for the action, or %NULL
The stock icon to display in widgets representing the action, or %NULL
Creates a new #GtkAction object. To add the action to a
#GtkActionGroup and set the accelerator for the action,
call gtk_action_group_add_action_with_accel().
See
A unique name for the action
the label displayed in menu items and on buttons, or %NULL
a tooltip for the action, or %NULL
the stock icon to display in widgets representing the action, or %NULL
Creates a new instance of a #GObject subtype and sets its properties.
Construction parameters (see %G_PARAM_CONSTRUCT, %G_PARAM_CONSTRUCT_ONLY) which are not explicitly specified are set to their default values.
the type id of the #GObject subtype to instantiate
an array of #GParameter
Creates a new #GtkRadioAction object. To add the action to a #GtkActionGroup and set the accelerator for the action, call gtk_action_group_add_action_with_accel().