Struct TextInput 

pub struct TextInput<'a> {
    pub title: &'a str,
    pub message: &'a str,
    pub value: &'a str,
    pub mode: TextInputMode,
    pub owner: Option<&'a dyn HasWindowHandle>,
}

Text input dialog.

The text input dialog allows the user to enter text, which is returned as a string.

let name = rustydialogs::TextInput {
	title: "User Name",
	message: "Enter your name:",
	value: "",
	mode: rustydialogs::TextInputMode::SingleLine,
	owner: None,
}.show();

if let Some(name) = name {
	println!("Hello, {name}!");
}

Fields

title: &'a str

The title of the dialog.

message: &'a str

The message to display to the user.

value: &'a str

The initial value to display in the text input.

mode: TextInputMode

The mode of the text input, which determines the type of dialog shown and how the input is handled.

owner: Option<&'a dyn HasWindowHandle>

The owner window of the dialog.

Implementations

impl<'a> TextInput<'a>

pub fn show(&self) -> Option<String>

Show the dialog.

Returns Some(String) if the user provided input and confirmed the dialog, or None if the user cancelled the dialog.

Examples found in repository

examples/text_input.rs (line 16)

fn main() {
	let mode = match std::process::id() / 4 % 3 {
		0 => rustydialogs::TextInputMode::SingleLine,
		1 => rustydialogs::TextInputMode::MultiLine,
		_ => rustydialogs::TextInputMode::Password,
	};

	let input = rustydialogs::TextInput {
		title: "TextInput",
		message: "Enter some text:",
		value: "default value",
		mode,
		owner: None,
	};

	match input.show() {
		Some(value) => println!("TextInput: {value}"),
		None => println!("Canceled"),
	}
}

examples/tests.rs (line 326)

fn test_text_input() {
	println!("\n{}", Color("==== Testing TextInput ====", "120;190;255"));

	step("Enter `Hello, Rust!` and press OK.",
		Some("Hello, Rust!".to_string()),
		|| rustydialogs::TextInput {
			title: "[tests] TextInput",
			message: "Instruction: Enter `Hello, Rust!` and press OK.",
			value: "",
			mode: rustydialogs::TextInputMode::SingleLine,
			owner: None,
		}.show()
	);

	step("Enter `Password123` and press OK.",
		Some(String::from("Password123")),
		|| rustydialogs::TextInput {
			title: "[tests] TextInput",
			message: "Instruction: Enter `Password123` and press OK.",
			value: "",
			mode: rustydialogs::TextInputMode::Password,
			owner: None,
		}.show()
	);

	step("Enter these three lines and press OK.",
		Some(String::from("Line 1\nLine 2\nLine 3")),
		|| rustydialogs::TextInput {
			title: "[tests] TextInput",
			message: "Instruction: Enter these three lines and press OK.\nLine 1\nLine 2\nLine 3",
			value: "",
			mode: rustydialogs::TextInputMode::MultiLine,
			owner: None,
		}.show()
	);

	step("Dismiss the dialog.",
		None,
		|| rustydialogs::TextInput {
			title: "[tests] Dismiss TextInput",
			message: "Instruction: Dismiss the dialog (e.g. by pressing Esc or clicking the close button).",
			value: "",
			mode: rustydialogs::TextInputMode::SingleLine,
			owner: None,
		}.show()
	);
}

Trait Implementations

impl<'a> Clone for TextInput<'a>

fn clone(&self) -> TextInput<'a>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Copy for TextInput<'a>