Struct DialogBox

pub struct DialogBox { /* private fields */ }

A struct representing a dialog box.

This struct provides a simple interface for creating and showing different types of dialog boxes, such as message boxes or question boxes. Once a dialog box is created using the DialogBox::new method, it can be shown to the user using the DialogBox::show method.

Examples

Showing a simple dialog box:

use my_{DialogBox, DialogType};

let mut dialog_box = DialogBox::new("My App", "Hello World", DialogType::Simple);
dialog_box.show();

Safety

Showing the same dialog box more than once is undefined behavior and depending on the platform, may or may not raise an error.

FFI

Corresponds to NvdDialogBox.

Implementations

impl DialogBox

pub fn new<S: AsRef<str>>( title: S, msg: S, dialog_type: DialogType, ) -> Result<Self, Error>

Creates a new instance of DialogBox with the given title, msg and dialog_type.

Arguments

• title - The title of the dialog box.

• msg - The message to display in the dialog box.

• dialog_type - The type of dialog box to display, either Simple, Warning or Error.

Returns

Returns Ok(DialogBox) if the dialog box was successfully created, otherwise returns Err(Error) with the error converted from NvDialog’s error code.

Panics

This function will panic if CString::new fails to convert the given title or msg to a null-terminated byte string.

Examples found in repository

examples/dialog.rs (lines 31-35)

fn main() {
    nvdialog_rs::init().expect("failed to initialize nvdialog");

    let mut dialog_box = DialogBox::new(
        "Hello World (from Rust!)",
        "A very basic dialog box from Rust.",
        DialogType::Simple,
    )
    .expect("Error");
    dialog_box.show()
}

examples/file-dialog.rs (line 46)

fn main() {
    nvdialog_rs::init().expect("Can't initialize NvDialog");
    let mut file_dialog = FileDialog::new(
        String::from("Select an image"),
        FileDialogType::OpenFile,
        Some(vec![
            "png".to_owned(),
            "jpg".to_owned(),
            "jpeg".to_owned(),
            "ico".to_owned(),
            "webp".to_owned(),
        ]),
    );

    if let Some(file) = file_dialog.retrieve_filename() {
        DialogBox::new("File chosen", &file.to_str().unwrap(), DialogType::Simple)
            .expect("Can't create dialog")
            .show()
    } else {
        DialogBox::new("Error", "No file chosen", DialogType::Error)
            .expect("Can't create dialog")
            .show()
    }
}

pub fn set_accept_label<S: AsRef<str>>(&mut self, label: S)

pub fn show(&mut self)

Displays the dialog box on the screen.

This function shows the dialog box on the screen, allowing the user to interact with it. It should be called after setting any necessary options and buttons on the dialog. This function is unsafe, because it uses FFI to call C code that might not be safe.

Examples found in repository

examples/dialog.rs (line 37)

fn main() {
    nvdialog_rs::init().expect("failed to initialize nvdialog");

    let mut dialog_box = DialogBox::new(
        "Hello World (from Rust!)",
        "A very basic dialog box from Rust.",
        DialogType::Simple,
    )
    .expect("Error");
    dialog_box.show()
}

examples/file-dialog.rs (line 48)

fn main() {
    nvdialog_rs::init().expect("Can't initialize NvDialog");
    let mut file_dialog = FileDialog::new(
        String::from("Select an image"),
        FileDialogType::OpenFile,
        Some(vec![
            "png".to_owned(),
            "jpg".to_owned(),
            "jpeg".to_owned(),
            "ico".to_owned(),
            "webp".to_owned(),
        ]),
    );

    if let Some(file) = file_dialog.retrieve_filename() {
        DialogBox::new("File chosen", &file.to_str().unwrap(), DialogType::Simple)
            .expect("Can't create dialog")
            .show()
    } else {
        DialogBox::new("Error", "No file chosen", DialogType::Error)
            .expect("Can't create dialog")
            .show()
    }
}

Trait Implementations

impl Drop for DialogBox

fn drop(&mut self)

Executes the destructor for this type.