gtk4/auto/

app_chooser_dialog.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
#![allow(deprecated)]

use crate::{
    ffi, Accessible, AppChooser, Buildable, ConstraintTarget, Dialog, DialogFlags, Native, Root,
    ShortcutManager, Widget, Window,
};
use glib::{
    prelude::*,
    signal::{connect_raw, SignalHandlerId},
    translate::*,
};
use std::boxed::Box as Box_;

glib::wrapper! {
    /// The application selection widgets should be
    ///   implemented according to the design of each platform and/or
    ///   application requiring them.
    /// [`AppChooserDialog`][crate::AppChooserDialog] shows a [`AppChooserWidget`][crate::AppChooserWidget] inside a [`Dialog`][crate::Dialog].
    ///
    /// <picture>
    ///   <source srcset="appchooserdialog-dark.png" media="(prefers-color-scheme: dark)">
    ///   <img alt="An example GtkAppChooserDialog" src="appchooserdialog.png">
    /// </picture>
    ///
    /// Note that [`AppChooserDialog`][crate::AppChooserDialog] does not have any interesting methods
    /// of its own. Instead, you should get the embedded [`AppChooserWidget`][crate::AppChooserWidget]
    /// using [`widget()`][Self::widget()] and call its methods if
    /// the generic [`AppChooser`][crate::AppChooser] interface is not sufficient for
    /// your needs.
    ///
    /// To set the heading that is shown above the [`AppChooserWidget`][crate::AppChooserWidget],
    /// use [`set_heading()`][Self::set_heading()].
    ///
    /// ## CSS nodes
    ///
    /// [`AppChooserDialog`][crate::AppChooserDialog] has a single CSS node with the name `window` and style
    /// class `.appchooser`.
    ///
    /// ## Properties
    ///
    ///
    /// #### `gfile`
    ///  The GFile used by the [`AppChooserDialog`][crate::AppChooserDialog].
    ///
    /// The dialog's [`AppChooserWidget`][crate::AppChooserWidget] content type will
    /// be guessed from the file, if present.
    ///
    /// Readable | Writeable | Construct Only
    ///
    ///
    /// #### `heading`
    ///  The text to show at the top of the dialog.
    ///
    /// The string may contain Pango markup.
    ///
    /// Readable | Writeable
    /// <details><summary><h4>Dialog</h4></summary>
    ///
    ///
    /// #### `use-header-bar`
    ///  [`true`] if the dialog uses a headerbar for action buttons
    /// instead of the action-area.
    ///
    /// For technical reasons, this property is declared as an integer
    /// property, but you should only set it to [`true`] or [`false`].
    ///
    /// ## Creating a dialog with headerbar
    ///
    /// Builtin [`Dialog`][crate::Dialog] subclasses such as [`ColorChooserDialog`][crate::ColorChooserDialog]
    /// set this property according to platform conventions (using the
    /// [`gtk-dialogs-use-header`][struct@crate::Settings#gtk-dialogs-use-header] setting).
    ///
    /// Here is how you can achieve the same:
    ///
    /// **⚠️ The following code is in c ⚠️**
    ///
    /// ```c
    /// g_object_get (settings, "gtk-dialogs-use-header", &header, NULL);
    /// dialog = g_object_new (GTK_TYPE_DIALOG, header, TRUE, NULL);
    /// ```
    ///
    /// Readable | Writeable | Construct Only
    /// </details>
    /// <details><summary><h4>Window</h4></summary>
    ///
    ///
    /// #### `application`
    ///  The [`Application`][crate::Application] associated with the window.
    ///
    /// The application will be kept alive for at least as long as it
    /// has any windows associated with it (see g_application_hold()
    /// for a way to keep it alive without windows).
    ///
    /// Normally, the connection between the application and the window
    /// will remain until the window is destroyed, but you can explicitly
    /// remove it by setting the this property to `NULL`.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `child`
    ///  The child widget.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `decorated`
    ///  Whether the window should have a frame (also known as *decorations*).
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `default-height`
    ///  The default height of the window.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `default-widget`
    ///  The default widget.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `default-width`
    ///  The default width of the window.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `deletable`
    ///  Whether the window frame should have a close button.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `destroy-with-parent`
    ///  If this window should be destroyed when the parent is destroyed.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `display`
    ///  The display that will display this window.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `focus-visible`
    ///  Whether 'focus rectangles' are currently visible in this window.
    ///
    /// This property is maintained by GTK based on user input
    /// and should not be set by applications.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `focus-widget`
    ///  The focus widget.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `fullscreened`
    ///  Whether the window is fullscreen.
    ///
    /// Setting this property is the equivalent of calling
    /// [`GtkWindowExt::fullscreen()`][crate::prelude::GtkWindowExt::fullscreen()] or [`GtkWindowExt::unfullscreen()`][crate::prelude::GtkWindowExt::unfullscreen()];
    /// either operation is asynchronous, which means you will need to
    /// connect to the ::notify signal in order to know whether the
    /// operation was successful.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `gravity`
    ///  The gravity to use when resizing the window programmatically.
    ///
    /// Gravity describes which point of the window we want to keep
    /// fixed (meaning that the window will grow in the opposite direction).
    /// For example, a gravity of `GTK_WINDOW_GRAVITY_TOP_RIGHT` means that we
    /// want the to fix top right corner of the window.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `handle-menubar-accel`
    ///  Whether the window frame should handle <kbd>F10</kbd> for activating
    /// menubars.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `hide-on-close`
    ///  If this window should be hidden instead of destroyed when the user clicks
    /// the close button.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `icon-name`
    ///  Specifies the name of the themed icon to use as the window icon.
    ///
    /// See [`IconTheme`][crate::IconTheme] for more details.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `is-active`
    ///  Whether the toplevel is the currently active window.
    ///
    /// Readable
    ///
    ///
    /// #### `maximized`
    ///  Whether the window is maximized.
    ///
    /// Setting this property is the equivalent of calling
    /// [`GtkWindowExt::maximize()`][crate::prelude::GtkWindowExt::maximize()] or [`GtkWindowExt::unmaximize()`][crate::prelude::GtkWindowExt::unmaximize()];
    /// either operation is asynchronous, which means you will need to
    /// connect to the ::notify signal in order to know whether the
    /// operation was successful.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `mnemonics-visible`
    ///  Whether mnemonics are currently visible in this window.
    ///
    /// This property is maintained by GTK based on user input,
    /// and should not be set by applications.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `modal`
    ///  If true, the window is modal.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `resizable`
    ///  If true, users can resize the window.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `startup-id`
    ///  A write-only property for setting window's startup notification identifier.
    ///
    /// Writeable
    ///
    ///
    /// #### `suspended`
    ///  Whether the window is suspended.
    ///
    /// See [`GtkWindowExt::is_suspended()`][crate::prelude::GtkWindowExt::is_suspended()] for details about what suspended means.
    ///
    /// Readable
    ///
    ///
    /// #### `title`
    ///  The title of the window.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `titlebar`
    ///  The titlebar widget.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `transient-for`
    ///  The transient parent of the window.
    ///
    /// Readable | Writeable | Construct
    /// </details>
    /// <details><summary><h4>Widget</h4></summary>
    ///
    ///
    /// #### `can-focus`
    ///  Whether the widget or any of its descendents can accept
    /// the input focus.
    ///
    /// This property is meant to be set by widget implementations,
    /// typically in their instance init function.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `can-target`
    ///  Whether the widget can receive pointer events.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `css-classes`
    ///  A list of css classes applied to this widget.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `css-name`
    ///  The name of this widget in the CSS tree.
    ///
    /// This property is meant to be set by widget implementations,
    /// typically in their instance init function.
    ///
    /// Readable | Writeable | Construct Only
    ///
    ///
    /// #### `cursor`
    ///  The cursor used by @widget.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `focus-on-click`
    ///  Whether the widget should grab focus when it is clicked with the mouse.
    ///
    /// This property is only relevant for widgets that can take focus.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `focusable`
    ///  Whether this widget itself will accept the input focus.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `halign`
    ///  How to distribute horizontal space if widget gets extra space.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `has-default`
    ///  Whether the widget is the default widget.
    ///
    /// Readable
    ///
    ///
    /// #### `has-focus`
    ///  Whether the widget has the input focus.
    ///
    /// Readable
    ///
    ///
    /// #### `has-tooltip`
    ///  Enables or disables the emission of the [`query-tooltip`][struct@crate::Widget#query-tooltip]
    /// signal on @widget.
    ///
    /// A true value indicates that @widget can have a tooltip, in this case
    /// the widget will be queried using [`query-tooltip`][struct@crate::Widget#query-tooltip] to
    /// determine whether it will provide a tooltip or not.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `height-request`
    ///  Overrides for height request of the widget.
    ///
    /// If this is -1, the natural request will be used.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `hexpand`
    ///  Whether to expand horizontally.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `hexpand-set`
    ///  Whether to use the `hexpand` property.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `layout-manager`
    ///  The [`LayoutManager`][crate::LayoutManager] instance to use to compute
    /// the preferred size of the widget, and allocate its children.
    ///
    /// This property is meant to be set by widget implementations,
    /// typically in their instance init function.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `limit-events`
    ///  Makes this widget act like a modal dialog, with respect to
    /// event delivery.
    ///
    /// Global event controllers will not handle events with targets
    /// inside the widget, unless they are set up to ignore propagation
    /// limits. See [`EventControllerExt::set_propagation_limit()`][crate::prelude::EventControllerExt::set_propagation_limit()].
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `margin-bottom`
    ///  Margin on bottom side of widget.
    ///
    /// This property adds margin outside of the widget's normal size
    /// request, the margin will be added in addition to the size from
    /// [`WidgetExt::set_size_request()`][crate::prelude::WidgetExt::set_size_request()] for example.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `margin-end`
    ///  Margin on end of widget, horizontally.
    ///
    /// This property supports left-to-right and right-to-left text
    /// directions.
    ///
    /// This property adds margin outside of the widget's normal size
    /// request, the margin will be added in addition to the size from
    /// [`WidgetExt::set_size_request()`][crate::prelude::WidgetExt::set_size_request()] for example.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `margin-start`
    ///  Margin on start of widget, horizontally.
    ///
    /// This property supports left-to-right and right-to-left text
    /// directions.
    ///
    /// This property adds margin outside of the widget's normal size
    /// request, the margin will be added in addition to the size from
    /// [`WidgetExt::set_size_request()`][crate::prelude::WidgetExt::set_size_request()] for example.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `margin-top`
    ///  Margin on top side of widget.
    ///
    /// This property adds margin outside of the widget's normal size
    /// request, the margin will be added in addition to the size from
    /// [`WidgetExt::set_size_request()`][crate::prelude::WidgetExt::set_size_request()] for example.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `name`
    ///  The name of the widget.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `opacity`
    ///  The requested opacity of the widget.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `overflow`
    ///  How content outside the widget's content area is treated.
    ///
    /// This property is meant to be set by widget implementations,
    /// typically in their instance init function.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `parent`
    ///  The parent widget of this widget.
    ///
    /// Readable
    ///
    ///
    /// #### `receives-default`
    ///  Whether the widget will receive the default action when it is focused.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `root`
    ///  The [`Root`][crate::Root] widget of the widget tree containing this widget.
    ///
    /// This will be `NULL` if the widget is not contained in a root widget.
    ///
    /// Readable
    ///
    ///
    /// #### `scale-factor`
    ///  The scale factor of the widget.
    ///
    /// Readable
    ///
    ///
    /// #### `sensitive`
    ///  Whether the widget responds to input.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `tooltip-markup`
    ///  Sets the text of tooltip to be the given string, which is marked up
    /// with Pango markup.
    ///
    /// Also see [`Tooltip::set_markup()`][crate::Tooltip::set_markup()].
    ///
    /// This is a convenience property which will take care of getting the
    /// tooltip shown if the given string is not `NULL`:
    /// [`has-tooltip`][struct@crate::Widget#has-tooltip] will automatically be set to true
    /// and there will be taken care of [`query-tooltip`][struct@crate::Widget#query-tooltip] in
    /// the default signal handler.
    ///
    /// Note that if both [`tooltip-text`][struct@crate::Widget#tooltip-text] and
    /// [`tooltip-markup`][struct@crate::Widget#tooltip-markup] are set, the last one wins.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `tooltip-text`
    ///  Sets the text of tooltip to be the given string.
    ///
    /// Also see [`Tooltip::set_text()`][crate::Tooltip::set_text()].
    ///
    /// This is a convenience property which will take care of getting the
    /// tooltip shown if the given string is not `NULL`:
    /// [`has-tooltip`][struct@crate::Widget#has-tooltip] will automatically be set to true
    /// and there will be taken care of [`query-tooltip`][struct@crate::Widget#query-tooltip] in
    /// the default signal handler.
    ///
    /// Note that if both [`tooltip-text`][struct@crate::Widget#tooltip-text] and
    /// [`tooltip-markup`][struct@crate::Widget#tooltip-markup] are set, the last one wins.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `valign`
    ///  How to distribute vertical space if widget gets extra space.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `vexpand`
    ///  Whether to expand vertically.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `vexpand-set`
    ///  Whether to use the `vexpand` property.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `visible`
    ///  Whether the widget is visible.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `width-request`
    ///  Overrides for width request of the widget.
    ///
    /// If this is -1, the natural request will be used.
    ///
    /// Readable | Writeable
    /// </details>
    /// <details><summary><h4>Accessible</h4></summary>
    ///
    ///
    /// #### `accessible-role`
    ///  The accessible role of the given [`Accessible`][crate::Accessible] implementation.
    ///
    /// The accessible role cannot be changed once set.
    ///
    /// Readable | Writeable
    /// </details>
    /// <details><summary><h4>AppChooser</h4></summary>
    ///
    ///
    /// #### `content-type`
    ///  The content type of the [`AppChooser`][crate::AppChooser] object.
    ///
    /// See `GContentType` for more information about content types.
    ///
    /// Readable | Writeable | Construct Only
    /// </details>
    ///
    /// # Implements
    ///
    /// [`DialogExt`][trait@crate::prelude::DialogExt], [`GtkWindowExt`][trait@crate::prelude::GtkWindowExt], [`WidgetExt`][trait@crate::prelude::WidgetExt], [`trait@glib::ObjectExt`], [`AccessibleExt`][trait@crate::prelude::AccessibleExt], [`BuildableExt`][trait@crate::prelude::BuildableExt], [`ConstraintTargetExt`][trait@crate::prelude::ConstraintTargetExt], [`NativeExt`][trait@crate::prelude::NativeExt], [`RootExt`][trait@crate::prelude::RootExt], [`ShortcutManagerExt`][trait@crate::prelude::ShortcutManagerExt], [`AppChooserExt`][trait@crate::prelude::AppChooserExt], [`DialogExtManual`][trait@crate::prelude::DialogExtManual], [`WidgetExtManual`][trait@crate::prelude::WidgetExtManual], [`AccessibleExtManual`][trait@crate::prelude::AccessibleExtManual]
    #[doc(alias = "GtkAppChooserDialog")]
    pub struct AppChooserDialog(Object<ffi::GtkAppChooserDialog>) @extends Dialog, Window, Widget, @implements Accessible, Buildable, ConstraintTarget, Native, Root, ShortcutManager, AppChooser;

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

impl AppChooserDialog {
    /// Creates a new [`AppChooserDialog`][crate::AppChooserDialog] for the provided `GFile`.
    ///
    /// The dialog will show applications that can open the file.
    ///
    /// # Deprecated since 4.10
    ///
    /// This widget will be removed in GTK 5
    /// ## `parent`
    /// a [`Window`][crate::Window]
    /// ## `flags`
    /// flags for this dialog
    /// ## `file`
    /// a `GFile`
    ///
    /// # Returns
    ///
    /// a newly created [`AppChooserDialog`][crate::AppChooserDialog]
    #[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
    #[allow(deprecated)]
    #[doc(alias = "gtk_app_chooser_dialog_new")]
    pub fn new(
        parent: Option<&impl IsA<Window>>,
        flags: DialogFlags,
        file: &impl IsA<gio::File>,
    ) -> AppChooserDialog {
        assert_initialized_main_thread!();
        unsafe {
            Widget::from_glib_none(ffi::gtk_app_chooser_dialog_new(
                parent.map(|p| p.as_ref()).to_glib_none().0,
                flags.into_glib(),
                file.as_ref().to_glib_none().0,
            ))
            .unsafe_cast()
        }
    }

    /// Creates a new [`AppChooserDialog`][crate::AppChooserDialog] for the provided content type.
    ///
    /// The dialog will show applications that can open the content type.
    ///
    /// # Deprecated since 4.10
    ///
    /// This widget will be removed in GTK 5
    /// ## `parent`
    /// a [`Window`][crate::Window]
    /// ## `flags`
    /// flags for this dialog
    /// ## `content_type`
    /// a content type string
    ///
    /// # Returns
    ///
    /// a newly created [`AppChooserDialog`][crate::AppChooserDialog]
    #[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
    #[allow(deprecated)]
    #[doc(alias = "gtk_app_chooser_dialog_new_for_content_type")]
    #[doc(alias = "new_for_content_type")]
    pub fn for_content_type(
        parent: Option<&impl IsA<Window>>,
        flags: DialogFlags,
        content_type: &str,
    ) -> AppChooserDialog {
        assert_initialized_main_thread!();
        unsafe {
            Widget::from_glib_none(ffi::gtk_app_chooser_dialog_new_for_content_type(
                parent.map(|p| p.as_ref()).to_glib_none().0,
                flags.into_glib(),
                content_type.to_glib_none().0,
            ))
            .unsafe_cast()
        }
    }

    /// Returns the text to display at the top of the dialog.
    ///
    /// # Deprecated since 4.10
    ///
    /// This widget will be removed in GTK 5
    ///
    /// # Returns
    ///
    /// the text to display at the top of the dialog,
    ///   or [`None`], in which case a default text is displayed
    #[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
    #[allow(deprecated)]
    #[doc(alias = "gtk_app_chooser_dialog_get_heading")]
    #[doc(alias = "get_heading")]
    pub fn heading(&self) -> Option<glib::GString> {
        unsafe {
            from_glib_none(ffi::gtk_app_chooser_dialog_get_heading(
                self.to_glib_none().0,
            ))
        }
    }

    /// Returns the [`AppChooserWidget`][crate::AppChooserWidget] of this dialog.
    ///
    /// # Deprecated since 4.10
    ///
    /// This widget will be removed in GTK 5
    ///
    /// # Returns
    ///
    /// the [`AppChooserWidget`][crate::AppChooserWidget] of @self
    #[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
    #[allow(deprecated)]
    #[doc(alias = "gtk_app_chooser_dialog_get_widget")]
    #[doc(alias = "get_widget")]
    pub fn widget(&self) -> Widget {
        unsafe {
            from_glib_none(ffi::gtk_app_chooser_dialog_get_widget(
                self.to_glib_none().0,
            ))
        }
    }

    /// Sets the text to display at the top of the dialog.
    ///
    /// If the heading is not set, the dialog displays a default text.
    ///
    /// # Deprecated since 4.10
    ///
    /// This widget will be removed in GTK 5
    /// ## `heading`
    /// a string containing Pango markup
    #[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
    #[allow(deprecated)]
    #[doc(alias = "gtk_app_chooser_dialog_set_heading")]
    #[doc(alias = "heading")]
    pub fn set_heading(&self, heading: &str) {
        unsafe {
            ffi::gtk_app_chooser_dialog_set_heading(
                self.to_glib_none().0,
                heading.to_glib_none().0,
            );
        }
    }

    /// The GFile used by the [`AppChooserDialog`][crate::AppChooserDialog].
    ///
    /// The dialog's [`AppChooserWidget`][crate::AppChooserWidget] content type will
    /// be guessed from the file, if present.
    pub fn gfile(&self) -> Option<gio::File> {
        ObjectExt::property(self, "gfile")
    }

    #[doc(alias = "heading")]
    pub fn connect_heading_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_heading_trampoline<F: Fn(&AppChooserDialog) + 'static>(
            this: *mut ffi::GtkAppChooserDialog,
            _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 _,
                c"notify::heading".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_heading_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}