gtk/

message_dialog.rs

// Take a look at the license at the top of the repository in the LICENSE file.

use crate::DialogFlags;
use crate::MessageDialog;
use crate::MessageType;
use crate::Widget;
use crate::Window;
use crate::{ButtonsType, ffi};
use glib::object::{Cast, IsA};
use glib::translate::*;
use libc::c_char;
use std::ptr;

impl MessageDialog {
    /// Creates a new message dialog, which is a simple dialog with some text
    /// the user may want to see. When the user clicks a button a “response”
    /// signal is emitted with response IDs from [`ResponseType`][crate::ResponseType]. See
    /// [`Dialog`][crate::Dialog] for more details.
    /// ## `parent`
    /// transient parent, or [`None`] for none
    /// ## `flags`
    /// flags
    /// ## `type_`
    /// type of message
    /// ## `buttons`
    /// set of buttons to use
    /// ## `message_format`
    /// `printf()`-style format string, or [`None`]
    ///
    /// # Returns
    ///
    /// a new [`MessageDialog`][crate::MessageDialog]
    #[doc(alias = "gtk_message_dialog_new")]
    pub fn new<T: IsA<Window>>(
        parent: Option<&T>,
        flags: DialogFlags,
        type_: MessageType,
        buttons: ButtonsType,
        message: &str,
    ) -> MessageDialog {
        assert_initialized_main_thread!();
        unsafe {
            let message: Stash<*const c_char, _> = message.to_glib_none();
            Widget::from_glib_none(ffi::gtk_message_dialog_new(
                parent.map(|p| p.as_ref()).to_glib_none().0,
                flags.into_glib(),
                type_.into_glib(),
                buttons.into_glib(),
                c"%s".as_ptr() as *const c_char,
                message.0,
                ptr::null::<c_char>(),
            ))
            .unsafe_cast()
        }
    }

    /// Creates a new message dialog, which is a simple dialog with some text that
    /// is marked up with the [Pango text markup language][PangoMarkupFormat].
    /// When the user clicks a button a “response” signal is emitted with
    /// response IDs from [`ResponseType`][crate::ResponseType]. See [`Dialog`][crate::Dialog] for more details.
    ///
    /// Special XML characters in the `printf()` arguments passed to this
    /// function will automatically be escaped as necessary.
    /// (See `g_markup_printf_escaped()` for how this is implemented.)
    /// Usually this is what you want, but if you have an existing
    /// Pango markup string that you want to use literally as the
    /// label, then you need to use [`MessageDialogExt::set_markup()`][crate::prelude::MessageDialogExt::set_markup()]
    /// instead, since you can’t pass the markup string either
    /// as the format (it might contain “%” characters) or as a string
    /// argument.
    ///
    ///
    /// **⚠️ The following code is in C ⚠️**
    ///
    /// ```C
    ///  GtkWidget *dialog;
    ///  GtkDialogFlags flags = GTK_DIALOG_DESTROY_WITH_PARENT;
    ///  dialog = gtk_message_dialog_new (parent_window,
    ///                                   flags,
    ///                                   GTK_MESSAGE_ERROR,
    ///                                   GTK_BUTTONS_CLOSE,
    ///                                   NULL);
    ///  gtk_message_dialog_set_markup (GTK_MESSAGE_DIALOG (dialog),
    ///                                 markup);
    /// ```
    /// ## `parent`
    /// transient parent, or [`None`] for none
    /// ## `flags`
    /// flags
    /// ## `type_`
    /// type of message
    /// ## `buttons`
    /// set of buttons to use
    /// ## `message_format`
    /// `printf()`-style format string, or [`None`]
    ///
    /// # Returns
    ///
    /// a new [`MessageDialog`][crate::MessageDialog]
    #[doc(alias = "gtk_message_dialog_new_with_markup")]
    #[doc(alias = "new_with_markup")]
    pub fn with_markup<T: IsA<Window>>(
        parent: Option<&T>,
        flags: DialogFlags,
        type_: MessageType,
        buttons: ButtonsType,
        message: Option<&str>,
    ) -> MessageDialog {
        assert_initialized_main_thread!();
        unsafe {
            Widget::from_glib_none(ffi::gtk_message_dialog_new_with_markup(
                parent.map(|p| p.as_ref()).to_glib_none().0,
                flags.into_glib(),
                type_.into_glib(),
                buttons.into_glib(),
                message.to_glib_none().0,
            ))
            .unsafe_cast()
        }
    }
}

impl Default for MessageDialog {
    fn default() -> Self {
        assert_initialized_main_thread!();
        glib::Object::new()
    }
}

pub trait MessageDialogExtManual: IsA<MessageDialog> + 'static {
    /// Sets the secondary text of the message dialog to be `message_format` (with
    /// `printf()`-style), which is marked up with the
    /// [Pango text markup language][PangoMarkupFormat].
    ///
    /// Due to an oversight, this function does not escape special XML characters
    /// like [`MessageDialog::with_markup()`][crate::MessageDialog::with_markup()] does. Thus, if the arguments
    /// may contain special XML characters, you should use `g_markup_printf_escaped()`
    /// to escape it.
    ///
    ///
    ///
    /// **⚠️ The following code is in C ⚠️**
    ///
    /// ```C
    /// gchar *msg;
    ///
    /// msg = g_markup_printf_escaped (message_format, ...);
    /// gtk_message_dialog_format_secondary_markup (message_dialog,
    ///                                             "%s", msg);
    /// g_free (msg);
    /// ```
    /// ## `message_format`
    /// `printf()`-style markup string (see
    ///  [Pango markup format][PangoMarkupFormat]), or [`None`]
    #[doc(alias = "gtk_message_dialog_format_secondary_markup")]
    fn format_secondary_markup(&self, message: Option<&str>) {
        match message {
            Some(m) => unsafe {
                let message: Stash<*const c_char, _> = m.to_glib_none();
                ffi::gtk_message_dialog_format_secondary_markup(
                    self.as_ref().to_glib_none().0,
                    c"%s".as_ptr() as *const c_char,
                    message.0,
                    ptr::null::<c_char>(),
                )
            },
            None => unsafe {
                ffi::gtk_message_dialog_format_secondary_markup(
                    self.as_ref().to_glib_none().0,
                    ptr::null::<c_char>(),
                )
            },
        }
    }

    /// Sets the secondary text of the message dialog to be `message_format`
    /// (with `printf()`-style).
    /// ## `message_format`
    /// `printf()`-style format string, or [`None`]
    #[doc(alias = "gtk_message_dialog_format_secondary_text")]
    fn format_secondary_text(&self, message: Option<&str>) {
        match message {
            Some(m) => unsafe {
                let message: Stash<*const c_char, _> = m.to_glib_none();
                ffi::gtk_message_dialog_format_secondary_text(
                    self.as_ref().to_glib_none().0,
                    c"%s".as_ptr() as *const c_char,
                    message.0,
                    ptr::null::<c_char>(),
                )
            },
            None => unsafe {
                ffi::gtk_message_dialog_format_secondary_text(
                    self.as_ref().to_glib_none().0,
                    ptr::null::<c_char>(),
                )
            },
        }
    }
}

impl<O: IsA<MessageDialog>> MessageDialogExtManual for O {}