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.
Read-OnlySince 4.20capabilitiesWhether the window manager should add decorations.
Whether the window manager should allow to close the surface.
The fullscreen mode of the surface.
The fullscreen mode of the surface.
Since 4.20gravityThe gravity to use when resizing a surface programmatically.
Gravity describes which point of the surface we want to keep
fixed (meaning that the surface will grow in the opposite direction).
For example, a gravity of GDK_GRAVITY_NORTH_EAST means that we
want to fix top right corner of the surface.
This property is just a hint that may affect the result when negotiating toplevel sizes with the windowing system. It does not affect interactive resizes started with Gdk.Toplevel.begin_resize.
A list of textures to use as icon.
A list of textures to use as icon.
Whether the surface is modal.
Read-Onlyshortcuts_Whether the surface should inhibit keyboard shortcuts.
Read-OnlyshortcutsWhether the surface should inhibit keyboard shortcuts.
The startup ID of the surface.
See Gdk.AppLaunchContext for more information about startup feedback.
The startup ID of the surface.
See Gdk.AppLaunchContext for more information about startup feedback.
Read-OnlystateThe state of the toplevel.
The title of the surface.
The mouse pointer for the Gdk.Surface.
The Gdk.Display connection of the surface.
The Gdk.FrameClock of the surface.
The Gdk.FrameClock of the surface.
The height of the surface, in pixels.
Whether the surface is mapped.
The scale factor of the surface.
The scale factor is the next larger integer, compared to Gdk.Surface.scale.
The scale factor of the surface.
The scale factor is the next larger integer, compared to Gdk.Surface.scale.
The width of the surface in pixels.
Begins an interactive move operation.
You might use this function to implement draggable titlebars.
the device used for the operation
the button being used to drag, or 0 for a keyboard-initiated drag
surface X coordinate of mouse click that began the drag
surface Y coordinate of mouse click that began the drag
timestamp of mouse click that began the drag (use Gdk.Event.get_time)
Begins an interactive resize operation.
You might use this function to implement a “window resize grip.”
the edge or corner from which the drag is started
the device used for the operation
the button being used to drag, or 0 for a keyboard-initiated drag
surface X coordinate of mouse click that began the drag
surface Y coordinate of mouse click that began the drag
timestamp of mouse click that began the drag (use Gdk.Event.get_time)
Sets keyboard focus to surface.
In most cases, gtk_window_present_with_time() should be used on a GtkWindow, rather than calling this function.
timestamp of the event triggering the surface focus
The capabilities that are available for this toplevel.
the capabilities of the Gdk.Toplevel.
Gets the bitwise or of the currently active surface state flags, from the Gdk.ToplevelState enumeration.
surface state bitfield
Requests that the toplevel inhibit the system shortcuts.
This is asking the desktop environment/windowing system to let all keyboard events reach the surface, as long as it is focused, instead of triggering system actions.
If granted, the rerouting remains active until the default shortcuts processing is restored with Gdk.Toplevel.restore_system_shortcuts, or the request is revoked by the desktop environment, windowing system or the user.
A typical use case for this API is remote desktop or virtual machine viewers which need to inhibit the default system keyboard shortcuts so that the remote session or virtual host gets those instead of the local environment.
The windowing system or desktop environment may ask the user to grant or deny the request or even choose to ignore the request entirely.
The caller can be notified whenever the request is granted or revoked by listening to the Gdk.Toplevel.shortcuts_inhibited property.
Asks to lower the toplevel below other windows.
The windowing system may choose to ignore the request.
true if the surface was lowered
Asks to minimize the toplevel.
The windowing system may choose to ignore the request.
true if the surface was minimized
Present toplevel after having processed the Gdk.ToplevelLayout rules.
If the toplevel was previously not showing, it will be showed,
otherwise it will change layout according to layout.
GDK may emit the Gdk.Toplevel::compute-size signal to let
the user of this toplevel compute the preferred size of the toplevel
surface.
Presenting is asynchronous and the specified layout parameters are not guaranteed to be respected.
the Gdk.ToplevelLayout object used to layout
Restore default system keyboard shortcuts which were previously inhibited.
This undoes the effect of Gdk.Toplevel.inhibit_system_shortcuts.
Sets the toplevel to be decorated.
Setting decorated to false hints the desktop environment
that the surface has its own, client-side decorations and
does not need to have window decorations added.
true to request decorations
Sets the toplevel to be deletable.
Setting deletable to true hints the desktop environment
that it should offer the user a way to close the surface.
true to request a delete button
Sets a list of icons for the surface.
One of these will be used to represent the surface in iconic form. The icon may be shown in window lists or task bars. Which icon size is shown depends on the window manager. The window manager can scale the icon but setting several size icons can give better image quality.
Note that some platforms don't support surface icons.
Sets the toplevel to be modal.
The application can use this hint to tell the window manager that a certain surface has modal behaviour. The window manager can use this information to handle modal surfaces in a special way.
You should only use this on surfaces for which you have previously called Gdk.Toplevel.set_transient_for.
true if the surface is modal, false otherwise.
Sets the startup notification ID.
When using GTK, typically you should use gtk_window_set_startup_id() instead of this low-level function.
a string with startup-notification identifier
Sets the title of a toplevel surface.
The title maybe be displayed in the titlebar, in lists of windows, etc.
title of surface
Sets a transient-for parent.
Indicates to the window manager that surface is a transient
dialog associated with the application surface parent. This
allows the window manager to do things like center surface
on parent and keep surface above parent.
See gtk_window_set_transient_for() if you’re using GtkWindow.
another toplevel Gdk.Surface
Asks the windowing system to show the window menu.
The window menu is the menu shown when right-clicking the titlebar on traditional windows managed by the window manager. This is useful for windows using client-side decorations, activating it with a right-click on the window decorations.
true if the window menu was shown and false otherwise.
Returns whether the desktop environment supports tiled window states.
true if the desktop environment supports tiled window states
Performs a title bar gesture.
whether the gesture was performed
Emits a short beep associated to surface.
If the display of surface does not support per-surface beeps,
emits a short beep on the display just as Gdk.Display.beep.
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 target GObject.Object
the property on target to bind
flags to pass to GObject.Binding
a GObject.Closure wrapping the transformation function from the source to the target, or null to use the default
a GObject.Closure wrapping the transformation function from the target to the source, or null to use the default
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_Creates a new Gdk.CairoContext for rendering on surface.
the newly created Gdk.CairoContext
Creates a new Gdk.GLContext for the Gdk.Surface.
The context is disconnected from any particular surface or surface.
If the creation of the Gdk.GLContext failed, error will be set.
Before using the returned Gdk.GLContext, you will need to
call Gdk.GLContext.make_current or Gdk.GLContext.realize.
the newly created Gdk.GLContext
Create a new Cairo surface that is as compatible as possible with the
given surface.
For example the new surface will have the same fallback resolution
and font options as surface. Generally, the new surface will also
use the same backend as surface, unless that is not possible for
some reason. The type of the returned surface may be examined with
cairo_surface_get_type().
Initially the surface contents are all 0 (transparent if contents have transparency, black otherwise.)
This function always returns a valid pointer, but it will return a
pointer to a “nil” surface if other is already in an error state
or any other error occurs.
a pointer to the newly allocated surface. The caller owns the surface and should call cairo_surface_destroy() when done with it.
Destroys the window system resources associated with surface and
decrements surface's reference count.
The window system resources for all children of surface are also
destroyed, but the children’s reference counts are not decremented.
Note that a surface will not be destroyed automatically when its reference count reaches zero. You must call this function yourself before that happens.
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 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.
Retrieves a Gdk.Cursor pointer for the cursor currently set on the Gdk.Surface.
If the return value is null then there is no custom cursor set on
the surface, and it is using the cursor for its parent surface.
Use Gdk.Surface.set_cursor to unset the cursor of the surface.
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.
Retrieves a Gdk.Cursor pointer for the device currently set on the
specified Gdk.Surface.
If the return value is null then there is no custom cursor set on the
specified surface, and it is using the cursor for its parent surface.
Use Gdk.Surface.set_cursor to unset the cursor of the surface.
a pointer Gdk.Device
Obtains the current device position and modifier state.
The position is given in coordinates relative to the upper
left corner of surface.
pointer Gdk.Device to query to
true if the device is over the surface
Gets the Gdk.Display associated with a Gdk.Surface.
the Gdk.Display associated with surface
Gets the frame clock for the surface.
The frame clock for a surface never changes unless the surface is reparented to a new toplevel surface.
the frame clock
Returns the height of the given surface.
Surface size is reported in ”application pixels”, not ”device pixels” (see Gdk.Surface.get_scale_factor).
The height of surface
Checks whether the surface has been mapped.
A surface is mapped with Gdk.Toplevel.present or Gdk.Popup.present.
true if the surface is mapped
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
Returns the internal scale that maps from surface coordinates to the actual device pixels.
When the scale is bigger than 1, the windowing system prefers to get buffers with a resolution that is bigger than the surface size (e.g. to show the surface on a high-resolution display, or in a magnifier).
Compare with Gdk.Surface.get_scale_factor, which returns the next larger integer.
The scale may change during the lifetime of the surface.
the scale
Returns the internal scale factor that maps from surface coordinates to the actual device pixels.
On traditional systems this is 1, but on very high density outputs this can be a higher value (often 2). A higher value means that drawing is automatically scaled up to a higher resolution, so any code doing drawing will automatically look nicer. However, if you are supplying pixel-based data the scale value can be used to determine whether to use a pixel resource with higher resolution data.
The scale factor may change during the lifetime of the surface.
the scale factor
Returns the width of the given surface.
Surface size is reported in ”application pixels”, not ”device pixels” (see Gdk.Surface.get_scale_factor).
The width of surface
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
Hide the surface.
For toplevel surfaces, withdraws them, so they will no longer be known to the window manager; for all surfaces, unmaps them, so they won’t be displayed. Normally done automatically as part of gtk_widget_hide().
Check to see if a surface is destroyed.
true if the surface is destroyed
Checks whether object has a floating 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.
Forces a Gdk.Surface::render signal emission for surface
to be scheduled.
This function is useful for implementations that track invalid regions on their own.
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 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
Request a layout phase from the surface's frame clock.
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 default mouse pointer for a Gdk.Surface.
Passing null for the cursor argument means that surface will use
the cursor of its parent surface. Most surfaces should use this default.
Note that cursor must be for the same display as surface.
Use Gdk.Cursor.new_from_name or Gdk.Cursor.new_from_texture
to create the cursor. To make the cursor invisible, use GDK_BLANK_CURSOR.
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 specific Gdk.Cursor for a given device when it gets inside surface.
Passing null for the cursor argument means that surface will use the
cursor of its parent surface. Most surfaces should use this default.
Use Gdk.Cursor.new_from_name or Gdk.Cursor.new_from_texture
to create the cursor. To make the cursor invisible, use GDK_BLANK_CURSOR.
a pointer Gdk.Device
Apply the region to the surface for the purpose of event handling.
Mouse events which happen while the pointer position corresponds
to an unset bit in the mask will be passed on the surface below
surface.
An input region is typically used with RGBA surfaces. The alpha channel of the surface defines which pixels are invisible and allows for nicely antialiased borders, and the input region controls where the surface is “clickable”.
Use Gdk.Display.supports_input_shapes to find out if a particular backend supports input regions.
Marks a region of the Gdk.Surface as opaque.
For optimisation purposes, compositing window managers may like to not draw obscured regions of surfaces, or turn off blending during for these regions. With RGB windows with no transparency, this is just the shape of the window, but with ARGB32 windows, the compositor does not know what regions of the window are transparent or not.
This function only works for toplevel surfaces.
GTK will update this property automatically if the surface background
is opaque, as we know where the opaque regions are. If your surface
background is not opaque, please update this property in your
GtkWidgetClass.css_changed handler.
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.
Translates coordinates between two surfaces.
Note that this only works if to and from are popups or
transient-for to the same toplevel (directly or indirectly).
true if the coordinates were successfully translated
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
A freestanding toplevel surface.
The Gdk.Toplevel interface provides useful APIs for interacting with the windowing system, such as controlling maximization and size of the surface, setting icons and transient parents for dialogs.