The mouse pointer for the GdkSurface.
Whether the window manager should add decorations.
Whether the window manager should allow to close the surface.
The GdkDisplay connection of the surface.
The GdkFrameClock of the surface.
The fullscreen mode of the surface.
The height of the surface, in pixels.
A list of textures to use as icon.
Whether the surface is mapped.
Whether the surface is modal.
The scale factor of the surface.
Whether the surface should inhibit keyboard shortcuts.
The startup ID of the surface.
See [classGdk.AppLaunchContext] for more information about
startup feedback.
The state of the toplevel.
The title of the surface.
The transient parent of the surface.
The width of the surface in pixels.
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 [methodGdk.Display.beep].
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 [methodGdk.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 [methodGdk.Event.get_time])
Creates a binding between source_property on source and target_property
on target.
Whenever the source_property is changed the target_property is
updated using the same value. For instance:
g_object_bind_property (action, "active", widget, "sensitive", 0);
Will result in the "sensitive" property of the widget #GObject instance to be updated with the same value of the "active" property of the action #GObject instance.
If flags contains %G_BINDING_BIDIRECTIONAL then the binding will be mutual:
if target_property on target changes then the source_property on source
will be updated as well.
The binding will automatically be removed when either the source or the
target instances are finalized. To remove the binding without affecting the
source and the target you can just call g_object_unref() on the returned
#GBinding instance.
Removing the binding by calling g_object_unref() on it must only be done if
the binding, source and target are only used from a single thread and it
is clear that both source and target outlive the binding. Especially it
is not safe to rely on this if the binding, source or target can be
finalized from different threads. Keep another reference to the binding and
use g_binding_unbind() instead to be on the safe side.
A #GObject can have multiple bindings.
the property on source to bind
the target #GObject
the property on target to bind
flags to pass to #GBinding
Creates a binding between source_property on source and target_property
on target, allowing you to set the transformation functions to be used by
the binding.
This function is the language bindings friendly version of g_object_bind_property_full(), using #GClosures instead of function pointers.
the property on source to bind
the target #GObject
the property on target to bind
flags to pass to #GBinding
a #GClosure wrapping the transformation function from the source to the target, or %NULL to use the default
a #GClosure wrapping the transformation function from the target to the source, or %NULL to use the default
Creates a new GdkCairoContext for rendering on surface.
Creates a new GdkGLContext for the GdkSurface.
The context is disconnected from any particular surface or surface.
If the creation of the GdkGLContext failed, error will be set.
Before using the returned GdkGLContext, you will need to
call [methodGdk.GLContext.make_current] or [methodGdk.GLContext.realize].
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.
the content for the new surface
width of the new surface
height of the new surface
Creates a new GdkVulkanContext for rendering on surface.
If the creation of the GdkVulkanContext failed, error will be set.
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.
Sets keyboard focus to surface.
In most cases, [methodGtk.Window.present_with_time] should be
used on a [classGtk.Window], rather than calling this function.
timestamp of the event triggering the surface focus
This function is intended for #GObject implementations to re-enforce a [floating][floating-ref] object reference. Doing this is seldom required: all #GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling g_object_ref_sink().
Increases the freeze count on object. If the freeze count is
non-zero, the emission of "notify" signals on object is
stopped. The signals are queued until the freeze count is decreased
to zero. Duplicate notifications are squashed so that at most one
#GObject::notify signal is emitted for each property modified while the
object is frozen.
This is necessary for accessors that modify multiple properties to prevent premature notification while the object is still being modified.
Gets a named field from the objects table of associations (see g_object_set_data()).
name of the key for that association
Retrieves a GdkCursor pointer for the device currently set on the
specified GdkSurface.
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 [methodGdk.Surface.set_cursor] to unset the cursor of the surface.
Obtains the current device position and modifier state.
The position is given in coordinates relative to the upper
left corner of 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.
Returns the height of the given surface.
Surface size is reported in ”application pixels”, not
”device pixels” (see [methodGdk.Surface.get_scale_factor]).
Checks whether the surface has been mapped.
A surface is mapped with [methodGdk.Toplevel.present]
or [methodGdk.Popup.present].
Gets a property of an object.
The value can be:
In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling g_value_unset().
Note that g_object_get_property() is really intended for language bindings, g_object_get() is much more convenient for C programming.
the name of the property to get
return location for the property value
This function gets back user data pointers stored via g_object_set_qdata().
A #GQuark, naming the user data pointer
Returns 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 of a surface may change during runtime.
Gets the bitwise or of the currently active surface state flags,
from the GdkToplevelState enumeration.
Returns the width of the given surface.
Surface size is reported in ”application pixels”, not
”device pixels” (see [methodGdk.Surface.get_scale_factor]).
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 [methodGtk.Widget.hide].
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 [methodGdk.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 [propertyGdk.Toplevel:shortcuts-inhibited] property.
Check to see if a surface is destroyed.
Checks whether object has a [floating][floating-ref] reference.
Asks to lower the toplevel below other windows.
The windowing system may choose to ignore the request.
Asks to minimize the toplevel.
The windowing system may choose to ignore the request.
Emits a "notify" signal for the property property_name on object.
When possible, eg. when signaling a property change from within the class that registered the property, you should use g_object_notify_by_pspec() instead.
Note that emission of the notify signal may be blocked with g_object_freeze_notify(). In this case, the signal emissions are queued and will be emitted (in reverse order) when g_object_thaw_notify() is called.
the name of a property installed on the class of object.
Emits a "notify" signal for the property specified by pspec on object.
This function omits the property name lookup, hence it is faster than g_object_notify().
One way to avoid using g_object_notify() from within the class that registered the properties, and using g_object_notify_by_pspec() instead, is to store the GParamSpec used with g_object_class_install_property() inside a static array, e.g.:
enum
{
PROP_0,
PROP_FOO,
PROP_LAST
};
static GParamSpec *properties[PROP_LAST];
static void
my_object_class_init (MyObjectClass *klass)
{
properties[PROP_FOO] = g_param_spec_int ("foo", "Foo", "The foo",
0, 100,
50,
G_PARAM_READWRITE);
g_object_class_install_property (gobject_class,
PROP_FOO,
properties[PROP_FOO]);
}
and then notify a change on the "foo" property with:
g_object_notify_by_pspec (self, properties[PROP_FOO]);
the #GParamSpec of a property installed on the class of object.
Present toplevel after having processed the GdkToplevelLayout rules.
If the toplevel was previously not showing, it will be showed,
otherwise it will change layout according to layout.
GDK may emit the [signalGdk.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 GdkToplevelLayout object used to layout
Forces a [signalGdk.Surface::render] signal emission for surface
to be scheduled.
This function is useful for implementations that track invalid regions on their own.
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().
Request a layout phase from the surface's frame clock.
See [methodGdk.FrameClock.request_phase].
Restore default system keyboard shortcuts which were previously inhibited.
This undoes the effect of [methodGdk.Toplevel.inhibit_system_shortcuts].
Releases all references to other objects. This can be used to break reference cycles.
This function should only be called from object system implementations.
Sets the default mouse pointer for a GdkSurface.
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 [ctorGdk.Cursor.new_from_name] or [ctorGdk.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 #GQuark using g_quark_from_string().
This means a copy of key is kept permanently (even after object has been
finalized) — so it is recommended to only use a small, bounded set of values
for key in your program, to avoid the #GQuark storage growing unbounded.
name of the key
data to associate with that key
Sets 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 specific GdkCursor 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 [ctorGdk.Cursor.new_from_name] or [ctorGdk.Cursor.new_from_texture]
to create the cursor. To make the cursor invisible, use %GDK_BLANK_CURSOR.
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.
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 [methodGdk.Display.supports_input_shapes] to find out if
a particular backend supports input regions.
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 [methodGdk.Toplevel.set_transient_for].
%TRUE if the surface is modal, %FALSE otherwise.
Marks a region of the GdkSurface 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
[vfuncGtk.Widget.css_changed] handler.
Sets a property on an object.
the name of the property to set
the value
Sets the startup notification ID.
When using GTK, typically you should use
[methodGtk.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 [methodGtk.Window.set_transient_for] if you’re using
[classGtk.Window] or [classGtk.Dialog].
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.
Remove a specified datum from the object's data associations, without invoking the association's destroy handler.
name of the key
This function gets back user data pointers stored via
g_object_set_qdata() and removes the data from object
without invoking its destroy() function (if any was
set).
Usually, calling this function is only required to update
user data pointers with a destroy notifier, for example:
void
object_add_to_user_list (GObject *object,
const gchar *new_string)
{
// the quark, naming the object data
GQuark quark_string_list = g_quark_from_static_string ("my-string-list");
// retrieve the old string list
GList *list = g_object_steal_qdata (object, quark_string_list);
// prepend new string
list = g_list_prepend (list, g_strdup (new_string));
// this changed 'list', so we need to set it again
g_object_set_qdata_full (object, quark_string_list, list, free_string_list);
}
static void
free_string_list (gpointer data)
{
GList *node, *list = data;
for (node = list; node; node = node->next)
g_free (node->data);
g_list_free (list);
}
Using g_object_get_qdata() in the above example, instead of g_object_steal_qdata() would have left the destroy function set, and thus the partial string list would have been freed upon g_object_set_qdata_full().
A #GQuark, naming the user data pointer
Returns whether the desktop environment supports tiled window states.
Reverts the effect of a previous call to
g_object_freeze_notify(). The freeze count is decreased on object
and when it reaches zero, queued "notify" signals are emitted.
Duplicate notifications for each property are squashed so that at most one #GObject::notify signal is emitted for each property, in the reverse order in which they have been queued.
It is an error to call this function when the freeze count is zero.
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).
the target surface
coordinates to translate
coordinates to translate
Decreases the reference count of object. When its reference count
drops to 0, the object is finalized (i.e. its memory is freed).
If the pointer to the #GObject may be reused in future (for example, if it is an instance variable of another object), it is recommended to clear the pointer to %NULL rather than retain a dangling pointer to a potentially invalid #GObject instance. Use g_clear_object() for this.
This function essentially limits the life time of the closure to
the life time of the object. That is, when the object is finalized,
the closure is invalidated by calling g_closure_invalidate() on
it, in order to prevent invocations of the closure with a finalized
(nonexisting) object. Also, g_object_ref() and g_object_unref() are
added as marshal guards to the closure, to ensure that an extra
reference count is held on object during invocation of the
closure. Usually, this function will be called on closures that
use this object as closure data.
#GClosure to watch
Find the #GParamSpec with the given name for an
interface. Generally, the interface vtable passed in as g_iface
will be the default vtable from g_type_default_interface_ref(), or,
if you know the interface has already been loaded,
g_type_default_interface_peek().
any interface vtable for the interface, or the default vtable for the interface
name of a property to look up.
Add a property to an interface; this is only useful for interfaces that are added to GObject-derived types. Adding a property to an interface forces all objects classes with that interface to have a compatible property. The compatible property could be a newly created #GParamSpec, but normally g_object_class_override_property() will be used so that the object class only needs to provide an implementation and inherits the property description, default value, bounds, and so forth from the interface property.
This function is meant to be called from the interface's default
vtable initialization function (the class_init member of
#GTypeInfo.) It must not be called after after class_init has
been called for any object types implementing this interface.
If pspec is a floating reference, it will be consumed.
any interface vtable for the interface, or the default vtable for the interface.
the #GParamSpec for the new property
Lists the properties of an interface.Generally, the interface
vtable passed in as g_iface will be the default vtable from
g_type_default_interface_ref(), or, if you know the interface has
already been loaded, g_type_default_interface_peek().
any interface vtable for the interface, or the default vtable for the interface
Creates a new instance of a #GObject subtype and sets its properties.
Construction parameters (see %G_PARAM_CONSTRUCT, %G_PARAM_CONSTRUCT_ONLY) which are not explicitly specified are set to their default values.
the type id of the #GObject subtype to instantiate
an array of #GParameter
A
GdkToplevelis a freestanding toplevel surface.The
GdkToplevelinterface 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.