Optionalproperties: Partial<Gtk.Settings.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$gtypeWhether buttons in dialogs should use the alternative button order.
Controls the direction of the sort indicators in sorted list and tree views.
By default an arrow pointing down means the column is sorted
in ascending order. When set to true, this order will be inverted.
Whether the application prefers to use a dark theme.
If a GTK theme includes a dark variant, it will be used instead of the configured theme.
Some applications benefit from minimizing the amount of light pollution that interferes with the content. Good candidates for dark themes are photo and video editors that make the actual content get all the attention and minimize the distraction of the chrome.
Dark themes should not be used for documents, where large spaces are white/light and the dark chrome creates too much contrast (web browser, text editor...).
since 4.20: Use Gtk.CssProvider properties instead
The aspect ratio of the text caret.
Whether the cursor should blink.
Also see the Gtk.Settings.gtk_cursor_blink_timeout setting, which allows more flexible control over cursor blinking.
Length of the cursor blink cycle, in milliseconds.
Time after which the cursor stops blinking, in seconds.
The timer is reset after each user interaction.
Setting this to zero has the same effect as setting
Gtk.Settings.gtk_cursor_blink to false.
Name of the cursor theme to use.
Use null to use the default theme.
The size to use for cursors.
0 means to use the default size.
Determines which buttons should be put in the titlebar of client-side decorated windows, and whether they should be placed on the left or right.
The format of the string is button names, separated by commas. A colon separates the buttons that should appear on the left from those on the right. Recognized button names are minimize, maximize, close, icon (the window icon) and menu (a menu button for the fallback app menu).
For example, "menu:minimize,maximize,close" specifies a menu on the left, and minimize, maximize and close buttons on the right.
Note that buttons will only be shown when they are meaningful. E.g. a menu button only appears when the desktop shell does not show the app menu, and a close button only appears on a window that can be closed.
Also note that the setting can be overridden with the Gtk.HeaderBar.decoration_layout property.
Whether builtin GTK dialogs such as the file chooser, the color chooser or the font chooser will use a header bar at the top to show action widgets, or an action area at the bottom.
This setting does not affect custom dialogs using Gtk.Dialog directly, or message dialogs.
The number of pixels the cursor can move before dragging.
The maximum distance allowed between two clicks for them to be considered a double click, in pixels.
The maximum time to allow between two clicks for them to be considered a double click, in milliseconds.
Whether menu items should have visible accelerators which can be activated.
Whether to enable toolkit-wide animations.
Whether to play any event sounds at all.
See the Sound Theme Specifications for more information on event sounds and sound themes.
GTK itself does not support event sounds, you have to use a loadable module like the one that comes with libcanberra.
Whether to play event sounds as feedback to user input.
See the Sound Theme Specifications for more information on event sounds and sound themes.
GTK itself does not support event sounds, you have to use a loadable module like the one that comes with libcanberra.
Whether a middle click on a mouse should paste the 'PRIMARY' clipboard content at the cursor location.
How long to show the last input character in hidden entries.
This value is in milliseconds. 0 disables showing the last char. 600 is a good value for enabling it.
Whether to select the contents of an entry when it is focused.
When true, keyboard navigation and other input-related errors
will cause a beep.
Since the error bell is implemented using gdk_surface_beep(), the
windowing system may offer ways to configure the error bell in many
ways, such as flashing the window or similar visual effects.
The default font to use.
GTK uses the family name and size from this string.
Since 4.16gtk_How GTK font rendering is set up.
When set to Gtk.FontRendering.MANUAL, GTK respects the low-level font-related settings (Gtk.Settings.gtk_hint_font_metrics, Gtk.Settings.gtk_xft_antialias, Gtk.Settings.gtk_xft_hinting, Gtk.Settings.gtk_xft_hintstyle and Gtk.Settings.gtk_xft_rgba) as much as practical.
When set to Gtk.FontRendering.AUTOMATIC, GTK will consider factors such as screen resolution and scale in deciding how to render fonts.
Timestamp of the current fontconfig configuration.
Since 4.6gtk_Name of the icon theme to use.
See Gtk.IconTheme for details about how GTK handles icon themes.
Which IM (input method) module should be used by default.
This is the input method that will be used if the user has not explicitly chosen another input method from the IM context menu. This also can be a colon-separated list of input methods, which GTK will try in turn until it finds one available on the system.
See Gtk.IMContext.
Since 4.20gtk_The color scheme used for rendering the user interface.
This setting communicates the system-wide preference. The color scheme that is actually used when applying CSS styles can be set with the Gtk.CssProvider.prefers_color_scheme property.
Since 4.20gtk_The level of contrast to use for the user interface.
This setting communicates the system-wide preference. The contrast level that is actually used when applying CSS styles can be set with the Gtk.CssProvider.prefers_contrast property.
Whether GTK should make sure that text can be navigated with a caret, even if it is not editable.
This is useful when using a screen reader.
Whether to select the contents of a selectable label when it is focused.
The time for a button or touch press to be considered a “long press”.
See Gtk.GestureLongPress.
Whether scrolled windows may use overlaid scrolling indicators.
If this is set to false, scrolled windows will have permanent
scrollbars.
If the value of this setting is true, clicking the primary button in a
Gtk.Range trough will move the slider, and hence set the range’s value, to
the point that you clicked.
If it is false, a primary click will cause the slider/value to move
by the range’s page-size towards the point clicked.
Whichever action you choose for the primary button, the other action will be available by holding Shift and primary-clicking, or clicking the middle mouse button.
A comma-separated list of print backends to use in the print dialog.
Available print backends depend on the GTK installation, and may include "file", "cups", "lpr" or "papi".
A command to run for displaying the print preview.
The command should contain a %f placeholder, which will get
replaced by the path to the pdf file. The command may also
contain a %s placeholder, which will get replaced by the
path to a file containing the print settings in the format
produced by Gtk.PrintSettings.to_file.
The preview application is responsible for removing the pdf file and the print settings file when it is done.
Whether GTK should keep track of items inside the recently used resources list.
If set to false, the list will always be empty.
The maximum age, in days, of the items inside the recently used resources list.
Items older than this setting will be excised from the list. If set to 0, the list will always be empty; if set to -1, no item will be removed.
Since 4.14gtk_The XDG sound theme to use for event sounds.
See the Sound Theme Specifications for more information on event sounds and sound themes.
GTK itself does not support event sounds, you have to use a loadable module like the one that comes with libcanberra.
Whether two cursors should be displayed for mixed left-to-right and right-to-left text.
Name of the theme to load.
See Gtk.CssProvider for details about how GTK finds the CSS stylesheet for a theme.
Determines the action to take when a double-click occurs on the titlebar of client-side decorated windows.
Recognized actions are minimize, toggle-maximize, menu, lower or none.
Determines the action to take when a middle-click occurs on the titlebar of client-side decorated windows.
Recognized actions are minimize, toggle-maximize, menu, lower or none.
Determines the action to take when a right-click occurs on the titlebar of client-side decorated windows.
Recognized actions are minimize, toggle-maximize, menu, lower or none.
Whether to antialias fonts.
The values are 0 for no, 1 for yes, or -1 for the system default.
The font resolution, in 1024 * dots/inch.
-1 to use the default value.
Whether to enable font hinting.
The values are 0 for no, 1 for yes, or -1 for the system default.
What degree of font hinting to use.
The possible vaues are hintnone, hintslight, hintmedium, hintfull.
The type of subpixel antialiasing to use.
The possible values are none, rgb, bgr, vrgb, vbgr.
Note that GSK does not support subpixel antialiasing, and this setting has no effect on font rendering in GTK.
Whether buttons in dialogs should use the alternative button order.
Controls the direction of the sort indicators in sorted list and tree views.
By default an arrow pointing down means the column is sorted
in ascending order. When set to true, this order will be inverted.
Whether the application prefers to use a dark theme.
If a GTK theme includes a dark variant, it will be used instead of the configured theme.
Some applications benefit from minimizing the amount of light pollution that interferes with the content. Good candidates for dark themes are photo and video editors that make the actual content get all the attention and minimize the distraction of the chrome.
Dark themes should not be used for documents, where large spaces are white/light and the dark chrome creates too much contrast (web browser, text editor...).
since 4.20: Use Gtk.CssProvider properties instead
The aspect ratio of the text caret.
Whether the cursor should blink.
Also see the Gtk.Settings.gtk_cursor_blink_timeout setting, which allows more flexible control over cursor blinking.
Length of the cursor blink cycle, in milliseconds.
Time after which the cursor stops blinking, in seconds.
The timer is reset after each user interaction.
Setting this to zero has the same effect as setting
Gtk.Settings.gtk_cursor_blink to false.
Name of the cursor theme to use.
Use null to use the default theme.
The size to use for cursors.
0 means to use the default size.
Determines which buttons should be put in the titlebar of client-side decorated windows, and whether they should be placed on the left or right.
The format of the string is button names, separated by commas. A colon separates the buttons that should appear on the left from those on the right. Recognized button names are minimize, maximize, close, icon (the window icon) and menu (a menu button for the fallback app menu).
For example, "menu:minimize,maximize,close" specifies a menu on the left, and minimize, maximize and close buttons on the right.
Note that buttons will only be shown when they are meaningful. E.g. a menu button only appears when the desktop shell does not show the app menu, and a close button only appears on a window that can be closed.
Also note that the setting can be overridden with the Gtk.HeaderBar.decoration_layout property.
Whether builtin GTK dialogs such as the file chooser, the color chooser or the font chooser will use a header bar at the top to show action widgets, or an action area at the bottom.
This setting does not affect custom dialogs using Gtk.Dialog directly, or message dialogs.
The number of pixels the cursor can move before dragging.
The maximum distance allowed between two clicks for them to be considered a double click, in pixels.
The maximum time to allow between two clicks for them to be considered a double click, in milliseconds.
Whether menu items should have visible accelerators which can be activated.
Whether to enable toolkit-wide animations.
Whether to play any event sounds at all.
See the Sound Theme Specifications for more information on event sounds and sound themes.
GTK itself does not support event sounds, you have to use a loadable module like the one that comes with libcanberra.
Whether to play event sounds as feedback to user input.
See the Sound Theme Specifications for more information on event sounds and sound themes.
GTK itself does not support event sounds, you have to use a loadable module like the one that comes with libcanberra.
Whether a middle click on a mouse should paste the 'PRIMARY' clipboard content at the cursor location.
How long to show the last input character in hidden entries.
This value is in milliseconds. 0 disables showing the last char. 600 is a good value for enabling it.
Whether to select the contents of an entry when it is focused.
When true, keyboard navigation and other input-related errors
will cause a beep.
Since the error bell is implemented using gdk_surface_beep(), the
windowing system may offer ways to configure the error bell in many
ways, such as flashing the window or similar visual effects.
Timestamp of the current fontconfig configuration.
The default font to use.
GTK uses the family name and size from this string.
Since 4.16gtkHow GTK font rendering is set up.
When set to Gtk.FontRendering.MANUAL, GTK respects the low-level font-related settings (Gtk.Settings.gtk_hint_font_metrics, Gtk.Settings.gtk_xft_antialias, Gtk.Settings.gtk_xft_hinting, Gtk.Settings.gtk_xft_hintstyle and Gtk.Settings.gtk_xft_rgba) as much as practical.
When set to Gtk.FontRendering.AUTOMATIC, GTK will consider factors such as screen resolution and scale in deciding how to render fonts.
Since 4.6gtkName of the icon theme to use.
See Gtk.IconTheme for details about how GTK handles icon themes.
Which IM (input method) module should be used by default.
This is the input method that will be used if the user has not explicitly chosen another input method from the IM context menu. This also can be a colon-separated list of input methods, which GTK will try in turn until it finds one available on the system.
See Gtk.IMContext.
Since 4.20gtkThe color scheme used for rendering the user interface.
This setting communicates the system-wide preference. The color scheme that is actually used when applying CSS styles can be set with the Gtk.CssProvider.prefers_color_scheme property.
Since 4.20gtkThe level of contrast to use for the user interface.
This setting communicates the system-wide preference. The contrast level that is actually used when applying CSS styles can be set with the Gtk.CssProvider.prefers_contrast property.
Whether GTK should make sure that text can be navigated with a caret, even if it is not editable.
This is useful when using a screen reader.
Whether to select the contents of a selectable label when it is focused.
The time for a button or touch press to be considered a “long press”.
See Gtk.GestureLongPress.
Whether scrolled windows may use overlaid scrolling indicators.
If this is set to false, scrolled windows will have permanent
scrollbars.
If the value of this setting is true, clicking the primary button in a
Gtk.Range trough will move the slider, and hence set the range’s value, to
the point that you clicked.
If it is false, a primary click will cause the slider/value to move
by the range’s page-size towards the point clicked.
Whichever action you choose for the primary button, the other action will be available by holding Shift and primary-clicking, or clicking the middle mouse button.
A comma-separated list of print backends to use in the print dialog.
Available print backends depend on the GTK installation, and may include "file", "cups", "lpr" or "papi".
A command to run for displaying the print preview.
The command should contain a %f placeholder, which will get
replaced by the path to the pdf file. The command may also
contain a %s placeholder, which will get replaced by the
path to a file containing the print settings in the format
produced by Gtk.PrintSettings.to_file.
The preview application is responsible for removing the pdf file and the print settings file when it is done.
Whether GTK should keep track of items inside the recently used resources list.
If set to false, the list will always be empty.
The maximum age, in days, of the items inside the recently used resources list.
Items older than this setting will be excised from the list. If set to 0, the list will always be empty; if set to -1, no item will be removed.
Since 4.14gtkThe XDG sound theme to use for event sounds.
See the Sound Theme Specifications for more information on event sounds and sound themes.
GTK itself does not support event sounds, you have to use a loadable module like the one that comes with libcanberra.
Whether two cursors should be displayed for mixed left-to-right and right-to-left text.
Name of the theme to load.
See Gtk.CssProvider for details about how GTK finds the CSS stylesheet for a theme.
Determines the action to take when a double-click occurs on the titlebar of client-side decorated windows.
Recognized actions are minimize, toggle-maximize, menu, lower or none.
Determines the action to take when a middle-click occurs on the titlebar of client-side decorated windows.
Recognized actions are minimize, toggle-maximize, menu, lower or none.
Determines the action to take when a right-click occurs on the titlebar of client-side decorated windows.
Recognized actions are minimize, toggle-maximize, menu, lower or none.
Whether to antialias fonts.
The values are 0 for no, 1 for yes, or -1 for the system default.
The font resolution, in 1024 * dots/inch.
-1 to use the default value.
Whether to enable font hinting.
The values are 0 for no, 1 for yes, or -1 for the system default.
What degree of font hinting to use.
The possible vaues are hintnone, hintslight, hintmedium, hintfull.
The type of subpixel antialiasing to use.
The possible values are none, rgb, bgr, vrgb, vbgr.
Note that GSK does not support subpixel antialiasing, and this setting has no effect on font rendering in GTK.
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_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
Undoes the effect of calling g_object_set() to install an
application-specific value for a setting.
After this call, the setting will again follow the session-wide value for this setting.
the name of the setting to reset
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
Staticget_Gets the Gtk.Settings object for the default display, creating it if necessary.
Staticget_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.
Provides a mechanism to share global settings between applications.
On the X window system, this sharing is realized by an XSettings manager that is usually part of the desktop environment, along with utilities that let the user change these settings.
On Wayland, the settings are obtained either via a settings portal, or by reading desktop settings from Gio.Settings.
On macOS, the settings are obtained from
NSUserDefaults.In the absence of these sharing mechanisms, GTK reads default values for settings from
settings.inifiles in/etc/gtk-4.0,$XDG_CONFIG_DIRS/gtk-4.0and$XDG_CONFIG_HOME/gtk-4.0. These files must be valid key files (see GLib.KeyFile), and have a section called Settings. Themes can also provide default values for settings by installing asettings.inifile next to theirgtk.cssfile.Applications can override system-wide settings by setting the property of the Gtk.Settings object with
g_object_set(). This should be restricted to special cases though; Gtk.Settings are not meant as an application configuration facility.There is one Gtk.Settings instance per display. It can be obtained with Gtk.Settings.get_for_display, but in many cases, it is more convenient to use Gtk.Widget.get_settings.