Struct rofi::Rofi

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

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 Vec<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 pango(&mut self) -> &mut Self

enable pango markup

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

enable password mode

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

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

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 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 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.

Trait Implementations

impl<'a, T: Debug> Debug for Rofi<'a, T> where
    T: AsRef<str>, 

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

Formats the value using the given formatter.