Struct MessageBox

pub struct MessageBox<'a, T> { /* private fields */ }

A builder for a modal dialog box that contains a system icon, a set of buttons, and a brief application-specific message, such as status or error information.

The type of the message box is specified by T (See Options for available options).

Implementations

impl<'a, T> MessageBox<'a, T>

pub fn new(text: &'a str) -> Self

Creates a new message box with a specified text to be displayed. If the string consists of more than one line, you can separate the lines using a carriage return and/or linefeed character between each line.

pub fn icon(self, icon: Icon) -> Self

The Icon to be displayed in this message box.

pub fn title(self, title: &'a str) -> Self

The dialog box title. If this parameter is null, the default title is Error.

Examples found in repository

examples/simple.rs (line 5)

fn main() -> Result<()> {
    win_msgbox::information::<Okay>("Ferris landed on Mars.")
        .title("Landing Module")
        .show()?;
    Ok(())
}

examples/topmost.rs (line 8)

fn main() -> Result<()> {
    win_msgbox::information::<Okay>(
        "This is some longer paragraph to demonstrate how\nthe text is right justified.",
    )
    .right()
    .title("Cool Demo App")
    .show()?;
    Ok(())
}

examples/options.rs (line 8)

fn main() -> Result<()> {
    let response = win_msgbox::error::<CancelTryAgainContinue>("Couldn't download resource")
        .title("Download Error")
        .show()?;

    match response {
        Cancel => println!("Cancelling downlaod..."),
        TryAgain => println!("Attempting redownload..."),
        Continue => println!("Skipping resource"),
    }

    Ok(())
}

pub fn hwnd(self, hwnd: HWND) -> Self

A handle to the owner window of the message box to be created. If this parameter is 0, the message box has no owner window (default).

pub fn modal(self, modal: Modal) -> Self

Set the modality of the dialog box. See Modal for options.

pub fn default_button(self, btn: DefaultButton) -> Self

Set the default button of the dialog box. See DefaultButton for options.

pub fn default_desktop_only(self) -> Self

Same as desktop of the interactive window station. For more information, see Window Stations. If the current input desktop is not the default desktop, show does not return until the user switches to the default desktop.

pub fn right(self) -> Self

The text is right-justified.

Examples found in repository

examples/topmost.rs (line 7)

fn main() -> Result<()> {
    win_msgbox::information::<Okay>(
        "This is some longer paragraph to demonstrate how\nthe text is right justified.",
    )
    .right()
    .title("Cool Demo App")
    .show()?;
    Ok(())
}

pub fn rtl_reading(self) -> Self

Displays message and caption text using right-to-left reading order on Hebrew and Arabic systems.

pub fn set_foreground(self) -> Self

The message box becomes the foreground window. Internally, the system calls the SetForegroundWindow function for the message box.

pub fn topmost(self) -> Self

The message box is created with the WS_EX_TOPMOST window style.

pub fn service_notification(self) -> Self

The caller is a service notifying the user of an event. The function displays a message box on the current active desktop, even if there is no user logged on to the computer.

Terminal Services: If the calling thread has an impersonation token, the function directs the message box to the session specified in the impersonation token.

If this is called, hwnd must not be called - it must remain 0. his is so that the message box can appear on a desktop other than the desktop corresponding to the hwnd.

For information on security considerations in regard to using this flag, see Interactive Services. In particular, be aware that this flag can produce interactive content on a locked desktop and should therefore be used for only a very limited set of scenarios, such as resource exhaustion.

pub fn with_help(self) -> Self

Adds a Help button to the message box. When the user clicks the Help button or presses F1, the system sends a WM_HELP message to the owner.

impl<T: Options> MessageBox<'_, T>

pub fn show(self) -> Result<T>

Shows the message box, returning the option the user clicked on.

If a message box has a Cancel button, the function returns the Cancel value if either the ESC key is pressed or the Cancel button is selected.

If the message box has no Cancel button, pressing ESC will no effect - unless an Ok button is present.

If an Ok button is displayed and the user presses ESC, the return value will be Ok.

Examples found in repository

examples/simple.rs (line 6)

fn main() -> Result<()> {
    win_msgbox::information::<Okay>("Ferris landed on Mars.")
        .title("Landing Module")
        .show()?;
    Ok(())
}

examples/topmost.rs (line 9)

fn main() -> Result<()> {
    win_msgbox::information::<Okay>(
        "This is some longer paragraph to demonstrate how\nthe text is right justified.",
    )
    .right()
    .title("Cool Demo App")
    .show()?;
    Ok(())
}

examples/options.rs (line 9)

fn main() -> Result<()> {
    let response = win_msgbox::error::<CancelTryAgainContinue>("Couldn't download resource")
        .title("Download Error")
        .show()?;

    match response {
        Cancel => println!("Cancelling downlaod..."),
        TryAgain => println!("Attempting redownload..."),
        Continue => println!("Skipping resource"),
    }

    Ok(())
}

impl<'a, T> MessageBox<'a, T>

pub fn exclamation(text: &'a str) -> Self

Creates a new message box where its icon is set to Exclamation.

pub fn warning(text: &'a str) -> Self

Creates a new message box where its icon is set to Warning.

pub fn information(text: &'a str) -> Self

Creates a new message box where its icon is set to Information.

pub fn asterisk(text: &'a str) -> Self

Creates a new message box where its icon is set to Asterisk.

pub fn question(text: &'a str) -> Self

Creates a new message box where its icon is set to Question.

pub fn stop(text: &'a str) -> Self

Creates a new message box where its icon is set to Stop.

pub fn error(text: &'a str) -> Self

Creates a new message box where its icon is set to Error.

pub fn hand(text: &'a str) -> Self

Creates a new message box where its icon is set to Hand.

Trait Implementations

impl<T> Debug for MessageBox<'_, T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.