atk/auto/

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

glib::wrapper! {
    /// The ATK Interface provided by UI components that represent a top-level window.
    ///
    /// [`Window`][crate::Window] should be implemented by the UI elements that represent
    /// a top-level window, such as the main window of an application or
    /// dialog.
    ///
    /// See [class[`Object`][crate::Object]]
    ///
    /// ## Signals
    ///
    ///
    /// #### `activate`
    ///  The signal [`activate`][struct@crate::Window#activate] is emitted when a window
    /// becomes the active window of the application or session.
    ///
    ///
    ///
    ///
    /// #### `create`
    ///  The signal [`create`][struct@crate::Window#create] is emitted when a new window
    /// is created.
    ///
    ///
    ///
    ///
    /// #### `deactivate`
    ///  The signal [`deactivate`][struct@crate::Window#deactivate] is emitted when a window is
    /// no longer the active window of the application or session.
    ///
    ///
    ///
    ///
    /// #### `destroy`
    ///  The signal [`destroy`][struct@crate::Window#destroy] is emitted when a window is
    /// destroyed.
    ///
    ///
    ///
    ///
    /// #### `maximize`
    ///  The signal [`maximize`][struct@crate::Window#maximize] is emitted when a window
    /// is maximized.
    ///
    ///
    ///
    ///
    /// #### `minimize`
    ///  The signal [`minimize`][struct@crate::Window#minimize] is emitted when a window
    /// is minimized.
    ///
    ///
    ///
    ///
    /// #### `move`
    ///  The signal [`move`][struct@crate::Window#move] is emitted when a window
    /// is moved.
    ///
    ///
    ///
    ///
    /// #### `resize`
    ///  The signal [`resize`][struct@crate::Window#resize] is emitted when a window
    /// is resized.
    ///
    ///
    ///
    ///
    /// #### `restore`
    ///  The signal [`restore`][struct@crate::Window#restore] is emitted when a window
    /// is restored.
    ///
    ///
    /// <details><summary><h4>Object</h4></summary>
    ///
    ///
    /// #### `active-descendant-changed`
    ///  The "active-descendant-changed" signal is emitted by an object
    /// which has the state ATK_STATE_MANAGES_DESCENDANTS when the focus
    /// object in the object changes. For instance, a table will emit the
    /// signal when the cell in the table which has focus changes.
    ///
    /// Detailed
    ///
    ///
    /// #### `announcement`
    ///  The "announcement" signal can be emitted to pass an announcement on to
    /// be read by a screen reader.
    ///
    /// Depcrecated (2.50): Use AtkObject::notification instead.
    ///
    ///
    ///
    ///
    /// #### `children-changed`
    ///  The signal "children-changed" is emitted when a child is added or
    /// removed form an object. It supports two details: "add" and
    /// "remove"
    ///
    /// Detailed
    ///
    ///
    /// #### `focus-event`
    ///  The signal "focus-event" is emitted when an object gained or lost
    /// focus.
    ///
    ///
    ///
    ///
    /// #### `notification`
    ///  The "notification" signal can be emitted to pass an announcement on to
    /// be read by a screen reader.
    ///
    ///
    ///
    ///
    /// #### `property-change`
    ///  The signal "property-change" is emitted when an object's property
    /// value changes. `arg1` contains an `AtkPropertyValues` with the name
    /// and the new value of the property whose value has changed. Note
    /// that, as with GObject notify, getting this signal does not
    /// guarantee that the value of the property has actually changed; it
    /// may also be emitted when the setter of the property is called to
    /// reinstate the previous value.
    ///
    /// Toolkit implementor note: ATK implementors should use
    /// [`ObjectExt::notify()`][crate::glib::prelude::ObjectExt::notify()] to emit property-changed
    /// notifications. [`property-changed`][struct@crate::Object#property-changed] is needed by the
    /// implementation of `atk_add_global_event_listener()` because GObject
    /// notify doesn't support emission hooks.
    ///
    /// Detailed
    ///
    ///
    /// #### `state-change`
    ///  The "state-change" signal is emitted when an object's state
    /// changes. The detail value identifies the state type which has
    /// changed.
    ///
    /// Detailed
    ///
    ///
    /// #### `visible-data-changed`
    ///  The "visible-data-changed" signal is emitted when the visual
    /// appearance of the object changed.
    ///
    ///
    /// </details>
    ///
    /// # Implements
    ///
    /// [`AtkWindowExt`][trait@crate::prelude::AtkWindowExt], [`AtkObjectExt`][trait@crate::prelude::AtkObjectExt], [`trait@glib::ObjectExt`]
    #[doc(alias = "AtkWindow")]
    pub struct Window(Interface<ffi::AtkWindow, ffi::AtkWindowIface>) @requires Object;

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

impl Window {
    pub const NONE: Option<&'static Window> = None;
}

mod sealed {
    pub trait Sealed {}
    impl<T: super::IsA<super::Window>> Sealed for T {}
}

/// Trait containing all [`struct@Window`] methods.
///
/// # Implementors
///
/// [`NoOpObject`][struct@crate::NoOpObject], [`Window`][struct@crate::Window]
pub trait AtkWindowExt: IsA<Window> + sealed::Sealed + 'static {
    /// The signal [`activate`][struct@crate::Window#activate] is emitted when a window
    /// becomes the active window of the application or session.
    #[doc(alias = "activate")]
    fn connect_activate<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn activate_trampoline<P: IsA<Window>, F: Fn(&P) + 'static>(
            this: *mut ffi::AtkWindow,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(Window::from_glib_borrow(this).unsafe_cast_ref())
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"activate\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    activate_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    /// The signal [`create`][struct@crate::Window#create] is emitted when a new window
    /// is created.
    #[doc(alias = "create")]
    fn connect_create<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn create_trampoline<P: IsA<Window>, F: Fn(&P) + 'static>(
            this: *mut ffi::AtkWindow,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(Window::from_glib_borrow(this).unsafe_cast_ref())
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"create\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    create_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    /// The signal [`deactivate`][struct@crate::Window#deactivate] is emitted when a window is
    /// no longer the active window of the application or session.
    #[doc(alias = "deactivate")]
    fn connect_deactivate<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn deactivate_trampoline<P: IsA<Window>, F: Fn(&P) + 'static>(
            this: *mut ffi::AtkWindow,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(Window::from_glib_borrow(this).unsafe_cast_ref())
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"deactivate\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    deactivate_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    /// The signal [`destroy`][struct@crate::Window#destroy] is emitted when a window is
    /// destroyed.
    #[doc(alias = "destroy")]
    fn connect_destroy<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn destroy_trampoline<P: IsA<Window>, F: Fn(&P) + 'static>(
            this: *mut ffi::AtkWindow,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(Window::from_glib_borrow(this).unsafe_cast_ref())
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"destroy\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    destroy_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    /// The signal [`maximize`][struct@crate::Window#maximize] is emitted when a window
    /// is maximized.
    #[doc(alias = "maximize")]
    fn connect_maximize<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn maximize_trampoline<P: IsA<Window>, F: Fn(&P) + 'static>(
            this: *mut ffi::AtkWindow,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(Window::from_glib_borrow(this).unsafe_cast_ref())
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"maximize\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    maximize_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    /// The signal [`minimize`][struct@crate::Window#minimize] is emitted when a window
    /// is minimized.
    #[doc(alias = "minimize")]
    fn connect_minimize<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn minimize_trampoline<P: IsA<Window>, F: Fn(&P) + 'static>(
            this: *mut ffi::AtkWindow,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(Window::from_glib_borrow(this).unsafe_cast_ref())
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"minimize\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    minimize_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    /// The signal [`move`][struct@crate::Window#move] is emitted when a window
    /// is moved.
    #[doc(alias = "move")]
    fn connect_move<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn move_trampoline<P: IsA<Window>, F: Fn(&P) + 'static>(
            this: *mut ffi::AtkWindow,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(Window::from_glib_borrow(this).unsafe_cast_ref())
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"move\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    move_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    /// The signal [`resize`][struct@crate::Window#resize] is emitted when a window
    /// is resized.
    #[doc(alias = "resize")]
    fn connect_resize<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn resize_trampoline<P: IsA<Window>, F: Fn(&P) + 'static>(
            this: *mut ffi::AtkWindow,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(Window::from_glib_borrow(this).unsafe_cast_ref())
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"resize\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    resize_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    /// The signal [`restore`][struct@crate::Window#restore] is emitted when a window
    /// is restored.
    #[doc(alias = "restore")]
    fn connect_restore<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn restore_trampoline<P: IsA<Window>, F: Fn(&P) + 'static>(
            this: *mut ffi::AtkWindow,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(Window::from_glib_borrow(this).unsafe_cast_ref())
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"restore\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    restore_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}

impl<O: IsA<Window>> AtkWindowExt for O {}

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