Class (GI Class)

GdkWayland-4.0GdkWaylandWaylandToplevel

The Wayland implementation of Gdk.Toplevel.

Beyond the Gdk.Toplevel API, the Wayland implementation has API to set up cross-process parent-child relationships between surfaces with GdkWayland.WaylandToplevel.export_handle and GdkWayland.WaylandToplevel.set_transient_for_exported.

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors - Inherited from Gdk.Surface

Accessors - Inherited from Gdk.Toplevel

Methods

Methods - Inherited from GdkWayland.WaylandSurface

Constructors

Properties

Compile-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.

Accessors - Inherited from Gdk.Surface

Accessors - Inherited from Gdk.Toplevel

  • get deletable(): boolean

    Whether the window manager should allow to close the surface.

    Returns boolean

  • set deletable(val: boolean): void

    Whether the window manager should allow to close the surface.

    Parameters

    • val: boolean

    Returns void

  • get gravity(): Gdk.Gravity

    The 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.

    Returns Gdk.Gravity

    4.20

  • set gravity(val: Gdk.Gravity): void

    The 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.

    Parameters

    Returns void

    4.20

  • get shortcuts_inhibited(): boolean

    Whether the surface should inhibit keyboard shortcuts.

    Returns boolean

  • get shortcutsInhibited(): boolean

    Whether the surface should inhibit keyboard shortcuts.

    Returns boolean

Methods

  • Begins an interactive move operation.

    You might use this function to implement draggable titlebars.

    Parameters

    • device: Gdk.Device

      the device used for the operation

    • button: number

      the button being used to drag, or 0 for a keyboard-initiated drag

    • x: number

      surface X coordinate of mouse click that began the drag

    • y: number

      surface Y coordinate of mouse click that began the drag

    • timestamp: number

      timestamp of mouse click that began the drag (use Gdk.Event.get_time)

    Returns void

  • Begins an interactive resize operation.

    You might use this function to implement a “window resize grip.”

    Parameters

    • edge: Gdk.SurfaceEdge

      the edge or corner from which the drag is started

    • device: Gdk.Device

      the device used for the operation

    • button: number

      the button being used to drag, or 0 for a keyboard-initiated drag

    • x: number

      surface X coordinate of mouse click that began the drag

    • y: number

      surface Y coordinate of mouse click that began the drag

    • timestamp: number

      timestamp of mouse click that began the drag (use Gdk.Event.get_time)

    Returns void

  • 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.

    Parameters

    • content: cairo.Content

      the content for the new surface

    • width: number

      width of the new surface

    • height: number

      height of the new surface

    Returns default.Surface

    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.

    Returns void

  • Destroy a handle that was obtained with gdk_wayland_toplevel_export_handle().

    Note that this API depends on an unstable Wayland protocol, and thus may require changes in the future.

    Parameters

    • handle: string

      the handle to drop

    Returns void

  • Asynchronously obtains a handle for a surface that can be passed to other processes.

    When the handle has been obtained, callback will be called.

    It is an error to call this function on a surface that is already exported.

    When the handle is no longer needed, GdkWayland.WaylandToplevel.unexport_handle should be called to clean up resources.

    The main purpose for obtaining a handle is to mark a surface from another surface as transient for this one, see GdkWayland.WaylandToplevel.set_transient_for_exported.

    Before 4.12, this API could not safely be used multiple times, since there was no reference counting for handles. Starting with 4.12, every call to this function obtains a new handle, and every call to GdkWayland.WaylandToplevel.drop_exported_handle drops just the handle that it is given.

    Note that this API depends on an unstable Wayland protocol, and thus may require changes in the future.

    Parameters

    Returns boolean

    true if the handle has been requested, false if an error occurred.

  • 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.

    Returns number

    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.

    Returns number

    the scale factor

  • 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.

    Parameters

    • Optionalevent: Gdk.Event

      the Gdk.Event that is triggering the inhibit request, or null if none is available

    Returns void

  • 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.

    Parameters

    Returns void

  • 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.

    Parameters

    • decorated: boolean

      true to request decorations

    Returns void

  • 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.

    Parameters

    • deletable: boolean

      true to request a delete button

    Returns void

  • 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.

    Parameters

    • surfaces: Gdk.Texture[]

      A list of textures to use as icon, of different sizes

    Returns void

  • 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.

    Parameters

    Returns void

  • 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.

    Parameters

    • modal: boolean

      true if the surface is modal, false otherwise.

    Returns void

  • 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.

    Parameters

    • Optionalregion: default.Region

      a region, or null to make the entire surface opaque

    Returns void

  • Marks toplevel as transient for the surface to which the given parent_handle_str refers.

    Typically, the handle will originate from a GdkWayland.WaylandToplevel.export_handle call in another process.

    Note that this API depends on an unstable Wayland protocol, and thus may require changes in the future.

    Parameters

    • parent_handle_str: string

      an exported handle for a surface

    Returns boolean

    true if the surface has been marked as transient, false if an error occurred.

  • 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.

    Parameters

    Returns boolean

    true if the window menu was shown and false otherwise.

Methods - Inherited from GdkWayland.WaylandSurface

  • 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.

    Parameters

    Returns 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.

    Parameters

    • source_property: string

      the property on source to bind

    • target: GObject.Object

      the target GObject.Object

    • target_property: string

      the property on target to bind

    • flags: GObject.BindingFlags

      flags to pass to GObject.Binding

    • Optionaltransform_to: BindingTransformFunc

      the transformation function from the source to the target, or null to use the default

    • Optionaltransform_from: BindingTransformFunc

      the transformation function from the target to the source, or null to use the default

    • Optionalnotify: DestroyNotify

      a function to call when disposing the binding, to free resources used by the transformation functions, or null if not required

    Returns 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.

  • 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.

    Parameters

    Returns 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.

  • 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.

    Parameters

    • id: number

      Handler ID of the handler to be disconnected

    Returns void

  • 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.

    Returns void

  • Gets a property of an object.

    The value can be:

    • an empty GObject.Value initialized by G_VALUE_INIT, which will be automatically initialized with the expected type of the property (since GLib 2.60)
    • a GObject.Value initialized with the expected type of the property
    • a GObject.Value initialized with a type to which the expected type of the property can be transformed

    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.

    Parameters

    • property_name: string

      The name of the property to get

    • value: any

      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

    Returns any

  • 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.

    Parameters

    • names: string[]

      the names of each property to get

    • values: any[]

      the values of each property to get

    Returns void

  • 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.

    Parameters

    • property_name: string

      the name of a property installed on the class of object.

    Returns void

  • 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]);
    

    Parameters

    Returns void

  • 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.

    Returns GObject.Object

    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().

    Returns GObject.Object

    object

  • Sets multiple properties of an object at once. The properties argument should be a dictionary mapping property names to values.

    Parameters

    • properties: { [key: string]: any }

      Object containing the properties to set

    Returns void

  • 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.

    Parameters

    • key: string

      name of the key

    • Optionaldata: any

      data to associate with that key

    Returns void

  • 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().

    Parameters

    • quark: number

      A GLib.Quark, naming the user data pointer

    Returns any

    The user data pointer set, or null

  • 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.

    Returns void

  • 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.

    Returns void

  • 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.

    Returns void

  • 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.

    Returns void

  • 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.

    Parameters

    Returns void

  • 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.

    Parameters

    Returns void

  • 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.

    Parameters

    Returns void

  • 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.

    Parameters

    Returns void

Interfaces

ConstructorProps
SignalSignatures