gdk/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::{Display, ffi};
use glib::{
    object::ObjectType as _,
    prelude::*,
    signal::{SignalHandlerId, connect_raw},
    translate::*,
};
use std::boxed::Box as Box_;

glib::wrapper! {
    ///
    /// `ifdef` GDK_WINDOWING_X11
    ///  if (GDK_IS_X11_DISPLAY (display))
    ///  {
    ///  // make X11-specific calls here
    ///  }
    ///  else
    /// `endif`
    /// `ifdef` GDK_WINDOWING_QUARTZ
    ///  if (GDK_IS_QUARTZ_DISPLAY (display))
    ///  {
    ///  // make Quartz-specific calls here
    ///  }
    ///  else
    /// `endif`
    ///  g_error ("Unsupported GDK backend");
    /// ]|
    ///
    /// ## Properties
    ///
    ///
    /// #### `default-display`
    ///  Readable | Writable
    ///
    /// ## Signals
    ///
    ///
    /// #### `display-opened`
    ///  The ::display-opened signal is 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], or [`None`] if
    ///  there is no default 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. Free with `g_slist_free()`
    ///  when you are done with it.
    #[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: &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: &Display) {
        unsafe {
            ffi::gdk_display_manager_set_default_display(
                self.to_glib_none().0,
                display.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 can be used.
    ///
    /// # Returns
    ///
    /// The global [`DisplayManager`][crate::DisplayManager] singleton;
    ///  `gdk_parse_args()`, `gdk_init()`, or `gdk_init_check()` must have
    ///  been called first.
    #[doc(alias = "gdk_display_manager_get")]
    pub fn get() -> DisplayManager {
        assert_initialized_main_thread!();
        unsafe { from_glib_none(ffi::gdk_display_manager_get()) }
    }

    /// The ::display-opened signal is 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,
        ) {
            unsafe {
                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 _,
                c"display-opened".as_ptr(),
                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,
        ) {
            unsafe {
                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 _,
                c"notify::default-display".as_ptr(),
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_default_display_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}