gdk/auto/

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::{Display, Visual, Window};
use glib::{
    prelude::*,
    signal::{connect_raw, SignalHandlerId},
    translate::*,
};
use std::{boxed::Box as Box_, fmt, mem::transmute};

glib::wrapper! {
    /// [`Screen`][crate::Screen] objects are the GDK representation of the screen on
    /// which windows can be displayed and on which the pointer moves.
    /// X originally identified screens with physical screens, but
    /// nowadays it is more common to have a single [`Screen`][crate::Screen] which
    /// combines several physical monitors (see `gdk_screen_get_n_monitors()`).
    ///
    /// GdkScreen is used throughout GDK and GTK+ to specify which screen
    /// the top level windows are to be displayed on. it is also used to
    /// query the screen specification and default settings such as
    /// the default visual ([`system_visual()`][Self::system_visual()]), the dimensions
    /// of the physical monitors (`gdk_screen_get_monitor_geometry()`), etc.
    ///
    /// ## Properties
    ///
    ///
    /// #### `font-options`
    ///  Readable | Writeable
    ///
    ///
    /// #### `resolution`
    ///  Readable | Writeable
    ///
    /// ## Signals
    ///
    ///
    /// #### `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.
    ///
    ///
    #[doc(alias = "GdkScreen")]
    pub struct Screen(Object<ffi::GdkScreen>);

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

impl Screen {
    /// Gets the display to which the `self` belongs.
    ///
    /// # Returns
    ///
    /// the display to which `self` belongs
    #[doc(alias = "gdk_screen_get_display")]
    #[doc(alias = "get_display")]
    pub fn display(&self) -> Display {
        unsafe { from_glib_none(ffi::gdk_screen_get_display(self.to_glib_none().0)) }
    }

    /// Gets the resolution for font handling on the screen; see
    /// [`set_resolution()`][Self::set_resolution()] for full details.
    ///
    /// # Returns
    ///
    /// the current resolution, or -1 if no resolution
    /// has been set.
    #[doc(alias = "gdk_screen_get_resolution")]
    #[doc(alias = "get_resolution")]
    pub fn resolution(&self) -> f64 {
        unsafe { ffi::gdk_screen_get_resolution(self.to_glib_none().0) }
    }

    /// Gets a visual to use for creating windows with an alpha channel.
    /// The windowing system on which GTK+ is running
    /// may not support this capability, in which case [`None`] will
    /// be returned. Even if a non-[`None`] value is returned, its
    /// possible that the window’s alpha channel won’t be honored
    /// when displaying the window on the screen: in particular, for
    /// X an appropriate windowing manager and compositing manager
    /// must be running to provide appropriate display.
    ///
    /// This functionality is not implemented in the Windows backend.
    ///
    /// For setting an overall opacity for a top-level window, see
    /// [`Window::set_opacity()`][crate::Window::set_opacity()].
    ///
    /// # Returns
    ///
    /// a visual to use for windows
    ///  with an alpha channel or [`None`] if the capability is not
    ///  available.
    #[doc(alias = "gdk_screen_get_rgba_visual")]
    #[doc(alias = "get_rgba_visual")]
    pub fn rgba_visual(&self) -> Option<Visual> {
        unsafe { from_glib_none(ffi::gdk_screen_get_rgba_visual(self.to_glib_none().0)) }
    }

    /// Gets the root window of `self`.
    ///
    /// # Returns
    ///
    /// the root window
    #[doc(alias = "gdk_screen_get_root_window")]
    #[doc(alias = "get_root_window")]
    pub fn root_window(&self) -> Option<Window> {
        unsafe { from_glib_none(ffi::gdk_screen_get_root_window(self.to_glib_none().0)) }
    }

    /// Get the system’s default visual for `self`.
    /// This is the visual for the root window of the display.
    /// The return value should not be freed.
    ///
    /// # Returns
    ///
    /// the system visual
    #[doc(alias = "gdk_screen_get_system_visual")]
    #[doc(alias = "get_system_visual")]
    pub fn system_visual(&self) -> Option<Visual> {
        unsafe { from_glib_none(ffi::gdk_screen_get_system_visual(self.to_glib_none().0)) }
    }

    /// Obtains a list of all toplevel windows known to GDK on the screen `self`.
    /// A toplevel window is a child of the root window (see
    /// `gdk_get_default_root_window()`).
    ///
    /// The returned list should be freed with `g_list_free()`, but
    /// its elements need not be freed.
    ///
    /// # Returns
    ///
    ///
    ///  list of toplevel windows, free with `g_list_free()`
    #[doc(alias = "gdk_screen_get_toplevel_windows")]
    #[doc(alias = "get_toplevel_windows")]
    pub fn toplevel_windows(&self) -> Vec<Window> {
        unsafe {
            FromGlibPtrContainer::from_glib_container(ffi::gdk_screen_get_toplevel_windows(
                self.to_glib_none().0,
            ))
        }
    }

    /// Returns a `GList` of `GdkWindows` representing the current
    /// window stack.
    ///
    /// On X11, this is done by inspecting the _NET_CLIENT_LIST_STACKING
    /// property on the root window, as described in the
    /// [Extended Window Manager Hints](http://www.freedesktop.org/Standards/wm-spec).
    /// If the window manager does not support the
    /// _NET_CLIENT_LIST_STACKING hint, this function returns [`None`].
    ///
    /// On other platforms, this function may return [`None`], depending on whether
    /// it is implementable on that platform.
    ///
    /// The returned list is newly allocated and owns references to the
    /// windows it contains, so it should be freed using `g_list_free()` and
    /// its windows unrefed using `g_object_unref()` when no longer needed.
    ///
    /// # Returns
    ///
    /// a
    ///  list of `GdkWindows` for the current window stack, or [`None`].
    #[doc(alias = "gdk_screen_get_window_stack")]
    #[doc(alias = "get_window_stack")]
    pub fn window_stack(&self) -> Vec<Window> {
        unsafe {
            FromGlibPtrContainer::from_glib_full(ffi::gdk_screen_get_window_stack(
                self.to_glib_none().0,
            ))
        }
    }

    /// Returns whether windows with an RGBA visual can reasonably
    /// be expected to have their alpha channel drawn correctly on
    /// the screen.
    ///
    /// On X11 this function returns whether a compositing manager is
    /// compositing `self`.
    ///
    /// # Returns
    ///
    /// Whether windows with RGBA visuals can reasonably be
    /// expected to have their alpha channels drawn correctly on the screen.
    #[doc(alias = "gdk_screen_is_composited")]
    pub fn is_composited(&self) -> bool {
        unsafe { from_glib(ffi::gdk_screen_is_composited(self.to_glib_none().0)) }
    }

    /// Lists the available visuals for the specified `self`.
    /// A visual describes a hardware image data format.
    /// For example, a visual might support 24-bit color, or 8-bit color,
    /// and might expect pixels to be in a certain format.
    ///
    /// Call `g_list_free()` on the return value when you’re finished with it.
    ///
    /// # Returns
    ///
    ///
    ///  a list of visuals; the list must be freed, but not its contents
    #[doc(alias = "gdk_screen_list_visuals")]
    pub fn list_visuals(&self) -> Vec<Visual> {
        unsafe {
            FromGlibPtrContainer::from_glib_container(ffi::gdk_screen_list_visuals(
                self.to_glib_none().0,
            ))
        }
    }

    /// Sets the default font options for the screen. These
    /// options will be set on any [`pango::Context`][crate::pango::Context]’s newly created
    /// with [`pango_context_get_for_screen()`][crate::pango_context_get_for_screen()]. Changing the
    /// default set of font options does not affect contexts that
    /// have already been created.
    /// ## `options`
    /// a [`cairo::FontOptions`][crate::cairo::FontOptions], or [`None`] to unset any
    ///  previously set default font options.
    #[doc(alias = "gdk_screen_set_font_options")]
    pub fn set_font_options(&self, options: Option<&cairo::FontOptions>) {
        unsafe {
            ffi::gdk_screen_set_font_options(self.to_glib_none().0, options.to_glib_none().0);
        }
    }

    /// Sets the resolution for font handling on the screen. This is a
    /// scale factor between points specified in a `PangoFontDescription`
    /// and cairo units. The default value is 96, meaning that a 10 point
    /// font will be 13 units high. (10 * 96. / 72. = 13.3).
    /// ## `dpi`
    /// the resolution in “dots per inch”. (Physical inches aren’t actually
    ///  involved; the terminology is conventional.)
    #[doc(alias = "gdk_screen_set_resolution")]
    pub fn set_resolution(&self, dpi: f64) {
        unsafe {
            ffi::gdk_screen_set_resolution(self.to_glib_none().0, dpi);
        }
    }

    /// Gets the default screen for the default display. (See
    /// gdk_display_get_default ()).
    ///
    /// # Returns
    ///
    /// a [`Screen`][crate::Screen], or [`None`] if
    ///  there is no default display.
    #[doc(alias = "gdk_screen_get_default")]
    #[doc(alias = "get_default")]
    #[allow(clippy::should_implement_trait)]
    pub fn default() -> Option<Screen> {
        assert_initialized_main_thread!();
        unsafe { from_glib_none(ffi::gdk_screen_get_default()) }
    }

    /// The ::composited-changed signal is emitted when the composited
    /// status of the screen changes
    #[doc(alias = "composited-changed")]
    pub fn connect_composited_changed<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn composited_changed_trampoline<F: Fn(&Screen) + 'static>(
            this: *mut ffi::GdkScreen,
            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"composited-changed\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    composited_changed_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    /// 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.
    #[doc(alias = "monitors-changed")]
    pub fn connect_monitors_changed<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn monitors_changed_trampoline<F: Fn(&Screen) + 'static>(
            this: *mut ffi::GdkScreen,
            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"monitors-changed\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    monitors_changed_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    /// The ::size-changed signal is emitted when the pixel width or
    /// height of a screen changes.
    #[doc(alias = "size-changed")]
    pub fn connect_size_changed<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn size_changed_trampoline<F: Fn(&Screen) + 'static>(
            this: *mut ffi::GdkScreen,
            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"size-changed\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    size_changed_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "font-options")]
    pub fn connect_font_options_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_font_options_trampoline<F: Fn(&Screen) + 'static>(
            this: *mut ffi::GdkScreen,
            _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::font-options\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    notify_font_options_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "resolution")]
    pub fn connect_resolution_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_resolution_trampoline<F: Fn(&Screen) + 'static>(
            this: *mut ffi::GdkScreen,
            _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::resolution\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    notify_resolution_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}

impl fmt::Display for Screen {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        f.write_str("Screen")
    }
}