gdkx11/auto/

x11_screen.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::{X11Visual, ffi};
use glib::{
    object::ObjectType as _,
    prelude::*,
    signal::{SignalHandlerId, connect_raw},
    translate::*,
};
use std::boxed::Box as Box_;
use x11::xlib;

glib::wrapper! {
    ///
    ///
    /// ## Signals
    ///
    ///
    /// #### `window-manager-changed`
    ///
    /// <details><summary><h4>Screen</h4></summary>
    ///
    ///
    /// #### `composited-changed`
    ///  The ::composited-changed signal is emitted when the composited
    /// status of the screen changes
    ///
    ///
    ///
    ///
    /// #### `monitors-changed`
    ///  The ::monitors-changed signal is emitted when the number, size
    /// or position of the monitors attached to the screen change.
    ///
    /// Only for X11 and OS X for now. A future implementation for Win32
    /// may be a possibility.
    ///
    ///
    ///
    ///
    /// #### `size-changed`
    ///  The ::size-changed signal is emitted when the pixel width or
    /// height of a screen changes.
    ///
    ///
    /// </details>
    ///
    /// # Implements
    ///
    /// [`trait@gdk::prelude::ScreenExt`]
    #[doc(alias = "GdkX11Screen")]
    pub struct X11Screen(Object<ffi::GdkX11Screen, ffi::GdkX11ScreenClass>) @extends gdk::Screen;

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

impl X11Screen {
    /// Returns the current workspace for `self` when running under a
    /// window manager that supports multiple workspaces, as described
    /// in the
    /// [Extended Window Manager Hints](http://www.freedesktop.org/Standards/wm-spec) specification.
    ///
    /// # Returns
    ///
    /// the current workspace, or 0 if workspaces are not supported
    #[doc(alias = "gdk_x11_screen_get_current_desktop")]
    #[doc(alias = "get_current_desktop")]
    pub fn current_desktop(&self) -> u32 {
        unsafe { ffi::gdk_x11_screen_get_current_desktop(self.to_glib_none().0) }
    }

    /// Gets the XID of the specified output/monitor.
    /// If the X server does not support version 1.2 of the RANDR
    /// extension, 0 is returned.
    /// ## `monitor_num`
    /// number of the monitor, between 0 and gdk_screen_get_n_monitors (screen)
    ///
    /// # Returns
    ///
    /// the XID of the monitor
    #[doc(alias = "gdk_x11_screen_get_monitor_output")]
    #[doc(alias = "get_monitor_output")]
    pub fn monitor_output(&self, monitor_num: i32) -> xlib::XID {
        unsafe { ffi::gdk_x11_screen_get_monitor_output(self.to_glib_none().0, monitor_num) }
    }

    /// Returns the number of workspaces for `self` when running under a
    /// window manager that supports multiple workspaces, as described
    /// in the
    /// [Extended Window Manager Hints](http://www.freedesktop.org/Standards/wm-spec) specification.
    ///
    /// # Returns
    ///
    /// the number of workspaces, or 0 if workspaces are not supported
    #[doc(alias = "gdk_x11_screen_get_number_of_desktops")]
    #[doc(alias = "get_number_of_desktops")]
    pub fn number_of_desktops(&self) -> u32 {
        unsafe { ffi::gdk_x11_screen_get_number_of_desktops(self.to_glib_none().0) }
    }

    /// Returns the index of a [`gdk::Screen`][crate::gdk::Screen].
    ///
    /// # Returns
    ///
    /// the position of `self` among the screens
    ///  of its display
    #[doc(alias = "gdk_x11_screen_get_screen_number")]
    #[doc(alias = "get_screen_number")]
    pub fn screen_number(&self) -> i32 {
        unsafe { ffi::gdk_x11_screen_get_screen_number(self.to_glib_none().0) }
    }

    /// Returns the name of the window manager for `self`.
    ///
    /// # Returns
    ///
    /// the name of the window manager screen `self`, or
    /// "unknown" if the window manager is unknown. The string is owned by GDK
    /// and should not be freed.
    #[doc(alias = "gdk_x11_screen_get_window_manager_name")]
    #[doc(alias = "get_window_manager_name")]
    pub fn window_manager_name(&self) -> Option<glib::GString> {
        unsafe {
            from_glib_none(ffi::gdk_x11_screen_get_window_manager_name(
                self.to_glib_none().0,
            ))
        }
    }

    /// Looks up the [`gdk::Visual`][crate::gdk::Visual] for a particular screen and X Visual ID.
    /// ## `xvisualid`
    /// an X Visual ID.
    ///
    /// # Returns
    ///
    /// the [`gdk::Visual`][crate::gdk::Visual] (owned by the screen
    ///  object), or [`None`] if the visual ID wasn’t found.
    #[doc(alias = "gdk_x11_screen_lookup_visual")]
    pub fn lookup_visual(&self, xvisualid: xlib::VisualID) -> Option<X11Visual> {
        unsafe {
            from_glib_none(ffi::gdk_x11_screen_lookup_visual(
                self.to_glib_none().0,
                xvisualid,
            ))
        }
    }

    /// This function is specific to the X11 backend of GDK, and indicates
    /// whether the window manager supports a certain hint from the
    /// [Extended Window Manager Hints](http://www.freedesktop.org/Standards/wm-spec) specification.
    ///
    /// When using this function, keep in mind that the window manager
    /// can change over time; so you shouldn’t use this function in
    /// a way that impacts persistent application state. A common bug
    /// is that your application can start up before the window manager
    /// does when the user logs in, and before the window manager starts
    /// [`supports_net_wm_hint()`][Self::supports_net_wm_hint()] will return [`false`] for every property.
    /// You can monitor the window_manager_changed signal on [`gdk::Screen`][crate::gdk::Screen] to detect
    /// a window manager change.
    /// ## `property`
    /// a property atom.
    ///
    /// # Returns
    ///
    /// [`true`] if the window manager supports `property`
    #[doc(alias = "gdk_x11_screen_supports_net_wm_hint")]
    pub fn supports_net_wm_hint(&self, property: &gdk::Atom) -> bool {
        unsafe {
            from_glib(ffi::gdk_x11_screen_supports_net_wm_hint(
                self.to_glib_none().0,
                property.to_glib_none().0,
            ))
        }
    }

    #[doc(alias = "window-manager-changed")]
    pub fn connect_window_manager_changed<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn window_manager_changed_trampoline<F: Fn(&X11Screen) + 'static>(
            this: *mut ffi::GdkX11Screen,
            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"window-manager-changed".as_ptr(),
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    window_manager_changed_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}