Struct rofi::Rofi

pub struct Rofi<'a, T>
where
    T: AsRef<str>,
{ /* private fields */ }

Rofi Window Builder

Rofi struct for displaying user interfaces. This struct is build after the non-consuming builder pattern. You can prepare a window, and draw it multiple times without reconstruction and reallocation. You can choose to return a handle to the child process RofiChild, which allows you to kill the process.

Implementations

impl<'a, T> Rofi<'a, T>

where T: AsRef<str>,

pub fn new(elements: &'a [T]) -> Self

Generate a new, unconfigured Rofi window based on the elements provided.

pub fn run(&self) -> Result<String, Error>

Show the window, and return the selected string, including pango formatting if available

pub fn run_index(&mut self) -> Result<usize, Error>

show the window, and return the index of the selected string This function will overwrite any subsequent calls to self.format.

pub fn set_sort(&mut self) -> &mut Self

Set sort flag

pub fn pango(&mut self) -> &mut Self

enable pango markup

pub fn password(&mut self) -> &mut Self

enable password mode

pub fn message_only( &mut self, message: impl Into<String> ) -> Result<&mut Self, Error>

enable message dialog mode (-e)

pub fn lines(&mut self, l: usize) -> &mut Self

Sets the number of lines. If this function is not called, use the number of lines provided in the elements vector.

pub fn width(&mut self, w: Width) -> Result<&mut Self, Error>

Set the width of the window (overwrite the theme settings)

pub fn case_sensitive(&mut self, sensitivity: bool) -> &mut Self

Sets the case sensitivity (disabled by default)

pub fn prompt(&mut self, prompt: impl Into<String>) -> &mut Self

Set the prompt of the rofi window

pub fn message(&mut self, message: impl Into<String>) -> &mut Self

Set the message of the rofi window (-mesg). Only available in dmenu mode. Docs: https://github.com/davatorium/rofi/blob/next/doc/rofi-dmenu.5.markdown#dmenu-specific-commandline-flags

pub fn theme(&mut self, theme: Option<impl Into<String>>) -> &mut Self

Set the rofi theme This will make sure that rofi uses ~/.config/rofi/{theme}.rasi

pub fn return_format(&mut self, format: Format) -> &mut Self

Set the return format of the rofi call. Default is Format::Text. If you call self.spawn_index later, the format will be overwritten with Format::Index.

pub fn kb_custom( &mut self, id: u32, shortcut: &str ) -> Result<&mut Self, String>

Set a custom keyboard shortcut. Rofi supports up to 19 custom keyboard shortcuts.

id must be in the [1,19] range and identifies the keyboard shortcut

shortcut can be any modifiers separated by "+", with a letter or number at the end. Ex: “Control+Shift+n”, “Alt+s”, “Control+Alt+Shift+1

https://github.com/davatorium/rofi/blob/next/source/keyb.c#L211

pub fn spawn(&self) -> Result<RofiChild<String>, Error>

Returns a child process with the pre-prepared rofi window The child will produce the exact output as provided in the elements vector.

pub fn spawn_index(&mut self) -> Result<RofiChild<usize>, Error>

Returns a child process with the pre-prepared rofi window. The child will produce the index of the chosen element in the vector. This function will overwrite any subsequent calls to self.format.

impl<'a> Rofi<'a, String>

pub fn new_message(message: impl Into<String>) -> Self

Generate a new, Rofi window in “message only” mode with the given message.

Trait Implementations

impl<'a, T> Clone for Rofi<'a, T>

where T: AsRef<str> + Clone,

fn clone(&self) -> Rofi<'a, T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, T> Debug for Rofi<'a, T>

where T: AsRef<str> + Debug,

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

Formats the value using the given formatter.