:right-sidebar: True

WaylandDisplay
===================================================================

.. currentmodule:: gi.repository.GdkWayland





.. class:: WaylandDisplay(**properties: ~typing.Any)
   :no-contents-entry:


Superclasses: :class:`~gi.repository.Gdk.Display`, :class:`~gi.repository.GObject.Object`





The Wayland implementation of ``GdkDisplay``\.

Beyond the regular :obj:`~gi.repository.Gdk.Display` API, the Wayland implementation
provides access to Wayland objects such as the ``wl_display`` with
:obj:`~gi.repository.GdkWayland.WaylandDisplay.get_wl_display`\, the ``wl_compositor`` with
:obj:`~gi.repository.GdkWayland.WaylandDisplay.get_wl_compositor`\.

You can find out what Wayland globals are supported by a display
with :obj:`~gi.repository.GdkWayland.WaylandDisplay.query_registry`\.




Methods
-------

.. rst-class:: interim-class

.. class:: WaylandDisplay
   :no-index:


   .. method:: get_egl_display() -> ~typing.Any | None

      Retrieves the EGL display connection object for the given GDK display.


      .. versionadded:: 4.4








   .. method:: get_startup_notification_id() -> str | None

      Gets the startup notification ID for a Wayland display, or :const:`None`
      if no ID has been defined.





      .. deprecated:: 4.10.

         Please do not use it in newly written code






   .. method:: query_registry(global_: str) -> bool

      Returns :const:`True` if the interface was found in the display
      ``wl_registry.global`` handler.






      :param global_: 




   .. method:: set_cursor_theme(name: str, size: int) -> None

      Sets the cursor theme for the given ``display``\.





      .. deprecated:: 4.16

         Use the cursor-related properties of
           `GtkSettings <../gtk4/class.Settings.html>`__ to set the cursor theme



      :param name: the new cursor theme

      :param size: the size to use for cursors




   .. method:: set_startup_notification_id(startup_id: str) -> None

      Sets the startup notification ID for a display.

      This is usually taken from the value of the ``DESKTOP_STARTUP_ID``
      environment variable, but in some cases (such as the application not
      being launched using exec()) it can come from other sources.

      The startup ID is also what is used to signal that the startup is
      complete (for example, when opening a window or when calling
      :obj:`~gi.repository.Gdk.Display.notify_startup_complete`\).





      .. deprecated:: 4.10.

         Use :obj:`~gi.repository.Gdk.Toplevel.set_startup_id`



      :param startup_id: the startup notification ID (must be valid utf8)