Optionalproperties: Partial<Gtk.HeaderBarAccessible.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$gtypeCreates 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_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.
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.
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
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 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.
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_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_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_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_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.
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
Adds a relationship of the specified type with the specified target.
The Atk.RelationType of the relation
The Atk.Object which is to be the target of the relation.
TRUE if the relationship is added.
This function specifies the callback function to be called when the widget corresponding to a GtkAccessible is destroyed.
Checks whether the specified point is within the extent of the component.
Toolkit implementor note: ATK provides a default implementation for this virtual method. In general there are little reason to re-implement it.
true or false indicating whether the specified point is within the extent of the component or not
Gets the accessible id of the accessible.
a character string representing the accessible id of the object, or NULL if no such string was set.
Returns the alpha value (i.e. the opacity) for this
component, on a scale from 0 (fully transparent) to 1.0
(fully opaque).
An alpha value from 0 to 1.0, inclusive.
Get a list of properties applied to this object as a whole, as an Atk.AttributeSet consisting of name-value pairs. As such these attributes may be considered weakly-typed properties or annotations, as distinct from strongly-typed object data available via other get/set methods. Not all objects have explicit "name-value pair" Atk.AttributeSet properties.
an Atk.AttributeSet consisting of all explicit properties/annotations applied to the object, or an empty set if the object has no name-value pair attributes assigned to it. This #atkattributeset should be freed by a call to atk_attribute_set_free().
Gets the accessible description of the accessible.
a character string representing the accessible description of the accessible.
Gets the rectangle which gives the extent of the component.
If the extent can not be obtained (e.g. a non-embedded plug or missing support), all of x, y, width, height are set to -1.
Gets the help text associated with the accessible.
a character string representing the help text or the object, or NULL if no such string was set.
Gets the 0-based index of this accessible in its parent; returns -1 if the accessible does not have an accessible parent.
an integer which is the index of the accessible in its parent
Gets the zorder of the component. The value G_MININT will be returned if the layer of the component is not ATK_LAYER_MDI or ATK_LAYER_WINDOW.
a gint which is the zorder of the component, i.e. the depth at which the component is shown in relation to other components in the same container.
Gets the number of accessible children of the accessible.
an integer representing the number of accessible children of the accessible.
Gets the accessible name of the accessible.
a character string representing the accessible name of the object.
Gets a UTF-8 string indicating the POSIX-style LC_MESSAGES locale
of accessible.
a UTF-8 string indicating the POSIX-style LC_MESSAGES locale of accessible.
Gets the accessible parent of the accessible. By default this is
the one assigned with atk_object_set_parent(), but it is assumed
that ATK implementors have ways to get the parent of the object
without the need of assigning it manually with
atk_object_set_parent(), and will return it with this method.
If you are only interested on the parent assigned with
atk_object_set_parent(), use atk_object_peek_parent().
an Atk.Object representing the accessible parent of the accessible
Gets the position of component in the form of
a point specifying component's top-left corner.
If the position can not be obtained (e.g. a non-embedded plug or missing support), x and y are set to -1.
Gets the size of the component in terms of width and height.
If the size can not be obtained (e.g. a non-embedded plug or missing support), width and height are set to -1.
Gets the Gtk.Widget corresponding to the Gtk.Accessible. The returned widget does not have a reference added, so you do not need to unref it.
pointer to the Gtk.Widget corresponding to the Gtk.Accessible, or null.
Grabs focus for this component.
true if successful, false otherwise.
This function is called when implementing subclasses of Atk.Object. It does initialization required for the new object. It is intended that this function should called only in the ..._new() functions used to create an instance of a subclass of Atk.Object
Optionaldata: anya gpointer which identifies the object for which the AtkObject was created.
Emits a state-change signal for the specified state.
Note that as a general rule when the state of an existing object changes, emitting a notification is expected.
an Atk.State whose state is changed
a gboolean which indicates whether the state is being set on or off
Gets the accessible parent of the accessible, if it has been
manually assigned with atk_object_set_parent. Otherwise, this
function returns null.
This method is intended as an utility for ATK implementors, and not
to be exposed to accessible tools. See atk_object_get_parent() for
further reference.
an Atk.Object representing the accessible parent of the accessible if assigned
Gets a reference to the specified accessible child of the object. The accessible children are 0-based so the first accessible child is at index 0, the second at index 1 and so on.
a gint representing the position of the child, starting from 0
an Atk.Object representing the specified accessible child of the accessible.
Gets the Atk.RelationSet associated with the object.
an Atk.RelationSet representing the relation set of the object.
Gets a reference to the state set of the accessible; the caller must unreference it when it is no longer needed.
a reference to an Atk.StateSet which is the state set of the accessible
Remove the handler specified by handler_id from the list of
functions to be executed when this object receives focus events
(in or out).
the handler id of the focus handler to be removed from component
Removes a property change handler.
a guint which identifies the handler to be removed.
Removes a relationship of the specified type with the specified target.
The Atk.RelationType of the relation
The Atk.Object which is the target of the relation to be removed.
TRUE if the relationship is removed.
Makes component visible on the screen by scrolling all necessary parents.
Contrary to atk_component_set_position, this does not actually move
component in its parent, this only makes the parents scroll so that the
object shows up on the screen, given its current position within the parents.
specify where the object should be made visible.
whether scrolling was successful.
Move the top-left of component to a given position of the screen by
scrolling all necessary parents.
whether scrolling was successful.
Sets the accessible ID of the accessible. This is not meant to be presented to the user, but to be an ID which is stable over application development. Typically, this is the gtkbuilder ID. Such an ID will be available for instance to identify a given well-known accessible object for tailored screen reading, or for automatic regression testing.
a character string to be set as the accessible id
Sets the accessible description of the accessible. You can't set the description to NULL. This is reserved for the initial value. In this aspect NULL is similar to ATK_ROLE_UNKNOWN. If you want to set the name to a empty value you can use "".
a character string to be set as the accessible description
Sets the help text associated with the accessible. This can be used to expose context-sensitive information to help a user understand how to interact with the object. You can't set the help text to NULL. This is reserved for the initial value. If you want to set the name to an empty value, you can use "".
a character string to be set as the accessible's help text
Sets the accessible name of the accessible. You can't set the name to NULL. This is reserved for the initial value. In this aspect NULL is similar to ATK_ROLE_UNKNOWN. If you want to set the name to a empty value you can use "".
a character string to be set as the accessible name
Sets the accessible parent of the accessible. parent can be NULL.
an Atk.Object to be set as the accessible parent
Sets the position of component.
Contrary to atk_component_scroll_to, this does not trigger any scrolling,
this just moves component in its parent.
true or false whether or not the position was set or not
Set the size of the component in terms of width and height.
width to set for component
height to set for component
true or false whether the size was set or not
Sets the Gtk.Widget corresponding to the Gtk.Accessible.
accessible will not hold a reference to widget.
It is the caller’s responsibility to ensure that when widget
is destroyed, the widget is unset by calling this function
again with widget set to null.
Optionalwidget: Gtk.Widgeta Gtk.Widget or null to unset
Virtualvfunc_Optionalchild: anyVirtualvfunc_Virtualvfunc_Optionalchanged_child: anyVirtualvfunc_This function specifies the callback function to be called when the widget corresponding to a GtkAccessible is destroyed.
Virtualvfunc_Checks whether the specified point is within the extent of the component.
Toolkit implementor note: ATK provides a default implementation for this virtual method. In general there are little reason to re-implement it.
Virtualvfunc_The signal handler which is executed when there is a focus event for an object. This virtual function is deprecated since 2.9.4 and it should not be overriden. Use the Atk.Object.SignalSignatures.state_change | Atk.Object::state-change "focused" signal instead.
Virtualvfunc_Returns the alpha value (i.e. the opacity) for this
component, on a scale from 0 (fully transparent) to 1.0
(fully opaque).
Virtualvfunc_Get a list of properties applied to this object as a whole, as an Atk.AttributeSet consisting of name-value pairs. As such these attributes may be considered weakly-typed properties or annotations, as distinct from strongly-typed object data available via other get/set methods. Not all objects have explicit "name-value pair" Atk.AttributeSet properties.
Virtualvfunc_Gets the accessible description of the accessible.
Virtualvfunc_Gets the rectangle which gives the extent of the component.
If the extent can not be obtained (e.g. a non-embedded plug or missing support), all of x, y, width, height are set to -1.
Virtualvfunc_Gets the 0-based index of this accessible in its parent; returns -1 if the accessible does not have an accessible parent.
Virtualvfunc_Virtualvfunc_Gets the zorder of the component. The value G_MININT will be returned if the layer of the component is not ATK_LAYER_MDI or ATK_LAYER_WINDOW.
Virtualvfunc_Virtualvfunc_Gets the accessible name of the accessible.
Virtualvfunc_Gets a UTF-8 string indicating the POSIX-style LC_MESSAGES locale
of accessible.
Virtualvfunc_Gets the accessible parent of the accessible. By default this is
the one assigned with atk_object_set_parent(), but it is assumed
that ATK implementors have ways to get the parent of the object
without the need of assigning it manually with
atk_object_set_parent(), and will return it with this method.
If you are only interested on the parent assigned with
atk_object_set_parent(), use atk_object_peek_parent().
Virtualvfunc_Gets the position of component in the form of
a point specifying component's top-left corner.
If the position can not be obtained (e.g. a non-embedded plug or missing support), x and y are set to -1.
Virtualvfunc_Virtualvfunc_Gets the size of the component in terms of width and height.
If the size can not be obtained (e.g. a non-embedded plug or missing support), width and height are set to -1.
Virtualvfunc_Grabs focus for this component.
Virtualvfunc_This function is called when implementing subclasses of Atk.Object. It does initialization required for the new object. It is intended that this function should called only in the ..._new() functions used to create an instance of a subclass of Atk.Object
Optionaldata: anya gpointer which identifies the object for which the AtkObject was created.
Virtualvfunc_Virtualvfunc_Virtualvfunc_Gets the Atk.RelationSet associated with the object.
Virtualvfunc_Virtualvfunc_Remove the handler specified by handler_id from the list of
functions to be executed when this object receives focus events
(in or out).
the handler id of the focus handler to be removed from component
Virtualvfunc_Removes a property change handler.
a guint which identifies the handler to be removed.
Virtualvfunc_Makes component visible on the screen by scrolling all necessary parents.
Contrary to atk_component_set_position, this does not actually move
component in its parent, this only makes the parents scroll so that the
object shows up on the screen, given its current position within the parents.
specify where the object should be made visible.
Virtualvfunc_Move the top-left of component to a given position of the screen by
scrolling all necessary parents.
Virtualvfunc_Sets the accessible description of the accessible. You can't set the description to NULL. This is reserved for the initial value. In this aspect NULL is similar to ATK_ROLE_UNKNOWN. If you want to set the name to a empty value you can use "".
a character string to be set as the accessible description
Virtualvfunc_Virtualvfunc_Sets the accessible name of the accessible. You can't set the name to NULL. This is reserved for the initial value. In this aspect NULL is similar to ATK_ROLE_UNKNOWN. If you want to set the name to a empty value you can use "".
a character string to be set as the accessible name
Virtualvfunc_Sets the accessible parent of the accessible. parent can be NULL.
an Atk.Object to be set as the accessible parent
Virtualvfunc_Sets the position of component.
Contrary to atk_component_scroll_to, this does not trigger any scrolling,
this just moves component in its parent.
Virtualvfunc_Virtualvfunc_Set the size of the component in terms of width and height.
width to set for component
height to set for component
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.
Since
3.24.11