Struct AboutDialog 

pub struct AboutDialog { /* private fields */ }

A struct for a dialog to show about your application.

Dialogs like this are used in the traditional Help > About dialogs found in most programs. In this case, this AboutDialog uses, like the rest of the library, the OS’ native toolkit to show it. This may create inconsistency in some situations, for example in web apps.

Examples

Basic about dialog:

use nvdialog_rs::AboutDialog;

let dialog = AboutDialog::new()
                .name("App Name".into())
                .description("A short description for your app".into())
                .version("0.1.0")
                .build();

dialog.show()

Implementations

impl AboutDialog

pub fn new() -> Self

Examples found in repository

examples/about-dialog.rs (line 21)

fn main() {
    nvdialog_rs::init().expect("failed to initialize libnvdialog");
    let extensions = ["png", "jpeg", "jpg", "ico", "webp"];
    let filedlg = FileDialog::new(
        "Choose the icon for the dialog",
        FileDialogType::OpenFile,
        Some(extensions),
    );
    let filename = filedlg.retrieve_filename().unwrap_or_else(|| {
        eprintln!("No filename given!");
        abort()
    });
    let img = Image::from_filename(filename).unwrap_or_else(|e| {
        eprintln!("Failed to read image! {}", e.to_string());
        abort();
    });

    let dialog = AboutDialog::new()
        .name("NvDialog Example")
        .description(
            "An example of using nvdialog-rs and NvdAboutDialog, with a custom user-picked icon",
        )
        .icon(img)
        .build();

    dialog.show();
}

pub fn name<S: ToString>(self, name: S) -> Self

Examples found in repository

examples/about-dialog.rs (line 22)

fn main() {
    nvdialog_rs::init().expect("failed to initialize libnvdialog");
    let extensions = ["png", "jpeg", "jpg", "ico", "webp"];
    let filedlg = FileDialog::new(
        "Choose the icon for the dialog",
        FileDialogType::OpenFile,
        Some(extensions),
    );
    let filename = filedlg.retrieve_filename().unwrap_or_else(|| {
        eprintln!("No filename given!");
        abort()
    });
    let img = Image::from_filename(filename).unwrap_or_else(|e| {
        eprintln!("Failed to read image! {}", e.to_string());
        abort();
    });

    let dialog = AboutDialog::new()
        .name("NvDialog Example")
        .description(
            "An example of using nvdialog-rs and NvdAboutDialog, with a custom user-picked icon",
        )
        .icon(img)
        .build();

    dialog.show();
}

pub fn description<S: ToString>(self, description: S) -> Self

Examples found in repository

examples/about-dialog.rs (lines 23-25)

fn main() {
    nvdialog_rs::init().expect("failed to initialize libnvdialog");
    let extensions = ["png", "jpeg", "jpg", "ico", "webp"];
    let filedlg = FileDialog::new(
        "Choose the icon for the dialog",
        FileDialogType::OpenFile,
        Some(extensions),
    );
    let filename = filedlg.retrieve_filename().unwrap_or_else(|| {
        eprintln!("No filename given!");
        abort()
    });
    let img = Image::from_filename(filename).unwrap_or_else(|e| {
        eprintln!("Failed to read image! {}", e.to_string());
        abort();
    });

    let dialog = AboutDialog::new()
        .name("NvDialog Example")
        .description(
            "An example of using nvdialog-rs and NvdAboutDialog, with a custom user-picked icon",
        )
        .icon(img)
        .build();

    dialog.show();
}

pub fn version<S: ToString>(self, version: S) -> Self

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

Examples found in repository

examples/about-dialog.rs (line 26)

fn main() {
    nvdialog_rs::init().expect("failed to initialize libnvdialog");
    let extensions = ["png", "jpeg", "jpg", "ico", "webp"];
    let filedlg = FileDialog::new(
        "Choose the icon for the dialog",
        FileDialogType::OpenFile,
        Some(extensions),
    );
    let filename = filedlg.retrieve_filename().unwrap_or_else(|| {
        eprintln!("No filename given!");
        abort()
    });
    let img = Image::from_filename(filename).unwrap_or_else(|e| {
        eprintln!("Failed to read image! {}", e.to_string());
        abort();
    });

    let dialog = AboutDialog::new()
        .name("NvDialog Example")
        .description(
            "An example of using nvdialog-rs and NvdAboutDialog, with a custom user-picked icon",
        )
        .icon(img)
        .build();

    dialog.show();
}

pub fn build(self) -> Self

Examples found in repository

examples/about-dialog.rs (line 27)

fn main() {
    nvdialog_rs::init().expect("failed to initialize libnvdialog");
    let extensions = ["png", "jpeg", "jpg", "ico", "webp"];
    let filedlg = FileDialog::new(
        "Choose the icon for the dialog",
        FileDialogType::OpenFile,
        Some(extensions),
    );
    let filename = filedlg.retrieve_filename().unwrap_or_else(|| {
        eprintln!("No filename given!");
        abort()
    });
    let img = Image::from_filename(filename).unwrap_or_else(|e| {
        eprintln!("Failed to read image! {}", e.to_string());
        abort();
    });

    let dialog = AboutDialog::new()
        .name("NvDialog Example")
        .description(
            "An example of using nvdialog-rs and NvdAboutDialog, with a custom user-picked icon",
        )
        .icon(img)
        .build();

    dialog.show();
}

Trait Implementations

impl Drop for AboutDialog

fn drop(&mut self)

Executes the destructor for this type.

impl Object for AboutDialog

type NativeType = _NvdAboutDialog

The type of the underlying native object, created by NvDialog. It will be used as a pointer to provide compatibility with the NvDialog API.

type ReturnValue = ()

The value that should be returned from Self::show. It should match the value that the dialog returns when it is presented to the user.

fn get_raw(&self) -> *mut Self::NativeType

Returns the raw object created by NvDialog internally. This should never return null.

fn show(&self)

Presents the dialog to the user. If Self::ReturnValue is not () then it will also return that value. Sometimes this serves as an alias to the type’s implementation of the analogous function. If you cannot afford the overhead, you can use that instead.

fn free(&mut self)

Frees the underlying native object. This should not be usually called manually, instead the Drop implementation should handle it when the time is correct. Be wary, if you do call this, you might run into double freeing errors.