libadwaita/auto/

application.rs

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

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

glib::wrapper! {
    /// A base class for Adwaita applications.
    ///
    /// [`Application`][crate::Application] handles library initialization by calling [`init()`][crate::init()] in the
    /// default [`startup`][struct@crate::gio::Application#startup] signal handler, in turn chaining up
    /// as required by [`gtk::Application`][crate::gtk::Application]. Therefore, any subclass of
    /// [`Application`][crate::Application] should always chain up its `startup` handler before using
    /// any Adwaita or GTK API.
    ///
    /// ## Automatic Resources
    ///
    /// [`Application`][crate::Application] will automatically load certain resources located in the
    /// application's resource base path (see
    /// [`ApplicationExtManual::set_resource_base_path()`][crate::gio::prelude::ApplicationExtManual::set_resource_base_path()], if they're present.
    ///
    /// ### Shortcuts Dialog
    ///
    /// If there's a resource located at `shortcuts-dialog.ui` which defines an
    /// [`ShortcutsDialog`][crate::ShortcutsDialog] with the ID `shortcuts_dialog`, [`Application`][crate::Application]
    /// will set up an `app.shortcuts` action that creates and presents this dialog,
    /// as well as a <kbd>Ctrl</kbd><kbd>?</kbd> accelerator for it.
    ///
    /// ### Stylesheet
    ///
    /// If there's a resource located at `style.css`, [`Application`][crate::Application] will load
    /// styles from it. This can be used to add custom styles to the application.
    ///
    /// #### Additional styles (deprecated)
    ///
    /// [`Application`][crate::Application] will also load the following stylesheets conditionally:
    ///
    /// - `style-dark.css` when [`dark`][struct@crate::StyleManager#dark] is `TRUE`.
    ///
    /// - `style-hc.css` when the system high contrast preference is enabled.
    ///
    /// - `style-hc-dark.css` when the system high contrast preference is enabled and
    ///   [`dark`][struct@crate::StyleManager#dark] is `TRUE`.
    ///
    /// :::warning
    ///     These resources are deprecated since 1.9.
    ///
    ///     Use `style.css` with the following media queries instead:
    ///
    ///     - `prefers-color-scheme: dark` for styles used only for dark appearance.
    ///     - `prefers-contrast: more` for styles used only when the system high
    ///       contrast preference is enabled.
    ///
    /// ## Properties
    ///
    ///
    /// #### `style-manager`
    ///  The style manager for this application.
    ///
    /// This is a convenience property allowing to access [`StyleManager`][crate::StyleManager] through
    /// property bindings or expressions.
    ///
    /// Readable
    /// <details><summary><h4>Application</h4></summary>
    ///
    ///
    /// #### `active-window`
    ///  The currently focused window of the application.
    ///
    /// Readable
    ///
    ///
    /// #### `autosave-interval`
    ///  The number of seconds between automatic state saves. Defaults to 15.
    /// A value of 0 will opt out of automatic state saving.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `menubar`
    ///  The menu model to be used for the application's menu bar.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `register-session`
    ///  Set this property to true to register with the session manager.
    ///
    /// This will make GTK track the session state (such as the
    /// [`screensaver-active`][struct@crate::gtk::Application#screensaver-active] property).
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `screensaver-active`
    ///  This property is true if GTK believes that the screensaver
    /// is currently active.
    ///
    /// Tracking the screensaver state is currently only supported on
    /// Linux.
    ///
    /// Readable
    ///
    ///
    /// #### `support-save`
    ///  Set this property to true if the application supports
    /// state saving and restoring.
    ///
    /// Readable | Writeable
    /// </details>
    /// <details><summary><h4>Application</h4></summary>
    ///
    ///
    /// #### `action-group`
    ///  The group of actions that the application exports.
    ///
    /// Writeable
    ///
    ///
    /// #### `application-id`
    ///  The unique identifier for the application.
    ///
    /// Readable | Writeable | Construct
    ///
    ///
    /// #### `flags`
    ///  Flags specifying the behaviour of the application.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `inactivity-timeout`
    ///  Time (in milliseconds) to stay alive after becoming idle.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `is-busy`
    ///  Whether the application is currently marked as busy through
    /// g_application_mark_busy() or g_application_bind_busy_property().
    ///
    /// Readable
    ///
    ///
    /// #### `is-registered`
    ///  Whether [`ApplicationExtManual::register()`][crate::gio::prelude::ApplicationExtManual::register()] has been called.
    ///
    /// Readable
    ///
    ///
    /// #### `is-remote`
    ///  Whether this application instance is remote.
    ///
    /// Readable
    ///
    ///
    /// #### `resource-base-path`
    ///  The base resource path for the application.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `version`
    ///  The human-readable version number of the application.
    ///
    /// Readable | Writeable
    /// </details>
    ///
    /// # Implements
    ///
    /// [`AdwApplicationExt`][trait@crate::prelude::AdwApplicationExt], [`trait@gtk::prelude::ApplicationExt`], [`trait@gio::prelude::ApplicationExt`], [`trait@glib::ObjectExt`], [`trait@gio::prelude::ActionGroupExt`], [`trait@gio::prelude::ActionMapExt`]
    #[doc(alias = "AdwApplication")]
    pub struct Application(Object<ffi::AdwApplication, ffi::AdwApplicationClass>) @extends gtk::Application, gio::Application, @implements gio::ActionGroup, gio::ActionMap;

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

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

    // rustdoc-stripper-ignore-next
    /// Creates a new builder-pattern struct instance to construct [`Application`] objects.
    ///
    /// This method returns an instance of [`ApplicationBuilder`](crate::builders::ApplicationBuilder) which can be used to create [`Application`] objects.
    pub fn builder() -> ApplicationBuilder {
        ApplicationBuilder::new()
    }
}

// rustdoc-stripper-ignore-next
/// A [builder-pattern] type to construct [`Application`] objects.
///
/// [builder-pattern]: https://doc.rust-lang.org/1.0.0/style/ownership/builders.html
#[must_use = "The builder must be built to be used"]
pub struct ApplicationBuilder {
    builder: glib::object::ObjectBuilder<'static, Application>,
}

impl ApplicationBuilder {
    fn new() -> Self {
        Self {
            builder: glib::object::Object::builder(),
        }
    }

    /// The number of seconds between automatic state saves. Defaults to 15.
    /// A value of 0 will opt out of automatic state saving.
    #[cfg(feature = "gtk_v4_22")]
    #[cfg_attr(docsrs, doc(cfg(feature = "gtk_v4_22")))]
    pub fn autosave_interval(self, autosave_interval: u32) -> Self {
        Self {
            builder: self
                .builder
                .property("autosave-interval", autosave_interval),
        }
    }

    /// The menu model to be used for the application's menu bar.
    pub fn menubar(self, menubar: &impl IsA<gio::MenuModel>) -> Self {
        Self {
            builder: self.builder.property("menubar", menubar.clone().upcast()),
        }
    }

    /// Set this property to true to register with the session manager.
    ///
    /// This will make GTK track the session state (such as the
    /// [`screensaver-active`][struct@crate::gtk::Application#screensaver-active] property).
    /// This property is ignored. GTK always registers
    /// with the session manager
    #[cfg_attr(feature = "gtk_v4_22", deprecated = "Since 4.22")]
    pub fn register_session(self, register_session: bool) -> Self {
        Self {
            builder: self.builder.property("register-session", register_session),
        }
    }

    /// Set this property to true if the application supports
    /// state saving and restoring.
    #[cfg(feature = "gtk_v4_22")]
    #[cfg_attr(docsrs, doc(cfg(feature = "gtk_v4_22")))]
    pub fn support_save(self, support_save: bool) -> Self {
        Self {
            builder: self.builder.property("support-save", support_save),
        }
    }

    /// The unique identifier for the application.
    pub fn application_id(self, application_id: impl Into<glib::GString>) -> Self {
        Self {
            builder: self
                .builder
                .property("application-id", application_id.into()),
        }
    }

    /// Flags specifying the behaviour of the application.
    pub fn flags(self, flags: gio::ApplicationFlags) -> Self {
        Self {
            builder: self.builder.property("flags", flags),
        }
    }

    /// Time (in milliseconds) to stay alive after becoming idle.
    pub fn inactivity_timeout(self, inactivity_timeout: u32) -> Self {
        Self {
            builder: self
                .builder
                .property("inactivity-timeout", inactivity_timeout),
        }
    }

    /// The base resource path for the application.
    pub fn resource_base_path(self, resource_base_path: impl Into<glib::GString>) -> Self {
        Self {
            builder: self
                .builder
                .property("resource-base-path", resource_base_path.into()),
        }
    }

    /// The human-readable version number of the application.
    #[cfg(feature = "gio_v2_80")]
    #[cfg_attr(docsrs, doc(cfg(feature = "gio_v2_80")))]
    pub fn version(self, version: impl Into<glib::GString>) -> Self {
        Self {
            builder: self.builder.property("version", version.into()),
        }
    }

    // rustdoc-stripper-ignore-next
    /// Build the [`Application`].
    #[must_use = "Building the object from the builder is usually expensive and is not expected to have side effects"]
    pub fn build(self) -> Application {
        let ret = self.builder.build();
        {
            Application::register_startup_hook(&ret);
        }
        ret
    }
}

/// Trait containing all [`struct@Application`] methods.
///
/// # Implementors
///
/// [`Application`][struct@crate::Application]
pub trait AdwApplicationExt: IsA<Application> + 'static {
    /// Gets the style manager for @self.
    ///
    /// This is a convenience property allowing to access [`StyleManager`][crate::StyleManager] through
    /// property bindings or expressions.
    ///
    /// # Returns
    ///
    /// the style manager
    #[doc(alias = "adw_application_get_style_manager")]
    #[doc(alias = "get_style_manager")]
    #[doc(alias = "style-manager")]
    fn style_manager(&self) -> StyleManager {
        unsafe {
            from_glib_none(ffi::adw_application_get_style_manager(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    #[doc(alias = "style-manager")]
    fn connect_style_manager_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_style_manager_trampoline<
            P: IsA<Application>,
            F: Fn(&P) + 'static,
        >(
            this: *mut ffi::AdwApplication,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                let f: &F = &*(f as *const F);
                f(Application::from_glib_borrow(this).unsafe_cast_ref())
            }
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"notify::style-manager".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_style_manager_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}

impl<O: IsA<Application>> AdwApplicationExt for O {}