gdk4/auto/

display_manager.rs

// This file was generated by gir (https://github.com/gtk-rs/gir)
// from gir-files (https://github.com/gtk-rs/gir-files)
// DO NOT EDIT

use crate::{ffi, Display};
use glib::{
    prelude::*,
    signal::{connect_raw, SignalHandlerId},
    translate::*,
};
use std::boxed::Box as Box_;

glib::wrapper! {
    /// A singleton object that offers notification when displays appear or
    /// disappear.
    ///
    /// You can use [`get()`][Self::get()] to obtain the [`DisplayManager`][crate::DisplayManager]
    /// singleton, but that should be rarely necessary. Typically, initializing
    /// GTK opens a display that you can work with without ever accessing the
    /// [`DisplayManager`][crate::DisplayManager].
    ///
    /// The GDK library can be built with support for multiple backends.
    /// The [`DisplayManager`][crate::DisplayManager] object determines which backend is used
    /// at runtime.
    ///
    /// In the rare case that you need to influence which of the backends
    /// is being used, you can use [`set_allowed_backends()`][crate::set_allowed_backends()]. Note
    /// that you need to call this function before initializing GTK.
    ///
    /// ## Backend-specific code
    ///
    /// When writing backend-specific code that is supposed to work with
    /// multiple GDK backends, you have to consider both compile time and
    /// runtime. At compile time, use the `GDK_WINDOWING_X11`, `GDK_WINDOWING_WIN32`
    /// macros, etc. to find out which backends are present in the GDK library
    /// you are building your application against. At runtime, use type-check
    /// macros like GDK_IS_X11_DISPLAY() to find out which backend is in use:
    ///
    /// **⚠️ The following code is in c ⚠️**
    ///
    /// ```c
    /// #ifdef GDK_WINDOWING_X11
    ///   if (GDK_IS_X11_DISPLAY (display))
    ///     {
    ///       // make X11-specific calls here
    ///     }
    ///   else
    /// #endif
    /// #ifdef GDK_WINDOWING_MACOS
    ///   if (GDK_IS_MACOS_DISPLAY (display))
    ///     {
    ///       // make Quartz-specific calls here
    ///     }
    ///   else
    /// #endif
    ///   g_error ("Unsupported GDK backend");
    /// ```
    ///
    /// ## Properties
    ///
    ///
    /// #### `default-display`
    ///  The default display.
    ///
    /// Readable | Writeable
    ///
    /// ## Signals
    ///
    ///
    /// #### `display-opened`
    ///  Emitted when a display is opened.
    ///
    ///
    #[doc(alias = "GdkDisplayManager")]
    pub struct DisplayManager(Object<ffi::GdkDisplayManager>);

    match fn {
        type_ => || ffi::gdk_display_manager_get_type(),
    }
}

impl DisplayManager {
    /// Gets the default [`Display`][crate::Display].
    ///
    /// # Returns
    ///
    /// a [`Display`][crate::Display]
    #[doc(alias = "gdk_display_manager_get_default_display")]
    #[doc(alias = "get_default_display")]
    #[doc(alias = "default-display")]
    pub fn default_display(&self) -> Option<Display> {
        unsafe {
            from_glib_none(ffi::gdk_display_manager_get_default_display(
                self.to_glib_none().0,
            ))
        }
    }

    /// List all currently open displays.
    ///
    /// # Returns
    ///
    /// a newly
    ///   allocated `GSList` of [`Display`][crate::Display] objects
    #[doc(alias = "gdk_display_manager_list_displays")]
    pub fn list_displays(&self) -> Vec<Display> {
        unsafe {
            FromGlibPtrContainer::from_glib_container(ffi::gdk_display_manager_list_displays(
                self.to_glib_none().0,
            ))
        }
    }

    /// Opens a display.
    /// ## `name`
    /// the name of the display to open
    ///
    /// # Returns
    ///
    /// a [`Display`][crate::Display], or [`None`]
    ///   if the display could not be opened
    #[doc(alias = "gdk_display_manager_open_display")]
    pub fn open_display(&self, name: Option<&str>) -> Option<Display> {
        unsafe {
            from_glib_none(ffi::gdk_display_manager_open_display(
                self.to_glib_none().0,
                name.to_glib_none().0,
            ))
        }
    }

    /// Sets @display as the default display.
    /// ## `display`
    /// a [`Display`][crate::Display]
    #[doc(alias = "gdk_display_manager_set_default_display")]
    #[doc(alias = "default-display")]
    pub fn set_default_display(&self, display: &impl IsA<Display>) {
        unsafe {
            ffi::gdk_display_manager_set_default_display(
                self.to_glib_none().0,
                display.as_ref().to_glib_none().0,
            );
        }
    }

    /// Gets the singleton [`DisplayManager`][crate::DisplayManager] object.
    ///
    /// When called for the first time, this function consults the
    /// `GDK_BACKEND` environment variable to find out which of the
    /// supported GDK backends to use (in case GDK has been compiled
    /// with multiple backends).
    ///
    /// Applications can use [`set_allowed_backends()`][crate::set_allowed_backends()] to limit what
    /// backends will be used.
    ///
    /// # Returns
    ///
    /// The global [`DisplayManager`][crate::DisplayManager] singleton
    #[doc(alias = "gdk_display_manager_get")]
    pub fn get() -> DisplayManager {
        assert_initialized_main_thread!();
        unsafe { from_glib_none(ffi::gdk_display_manager_get()) }
    }

    /// Emitted when a display is opened.
    /// ## `display`
    /// the opened display
    #[doc(alias = "display-opened")]
    pub fn connect_display_opened<F: Fn(&Self, &Display) + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn display_opened_trampoline<
            F: Fn(&DisplayManager, &Display) + 'static,
        >(
            this: *mut ffi::GdkDisplayManager,
            display: *mut ffi::GdkDisplay,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(&from_glib_borrow(this), &from_glib_borrow(display))
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"display-opened\0".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    display_opened_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "default-display")]
    pub fn connect_default_display_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_default_display_trampoline<F: Fn(&DisplayManager) + 'static>(
            this: *mut ffi::GdkDisplayManager,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(&from_glib_borrow(this))
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"notify::default-display\0".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_default_display_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}