Struct DisplayMenu

pub struct DisplayMenu<'a> {
    pub not_close: bool,
    pub target_client: Option<Cow<'a, str>>,
    pub target_pane: Option<Cow<'a, str>>,
    pub title: Option<Cow<'a, str>>,
    pub x: Option<usize>,
    pub y: Option<usize>,
    pub name: Option<Cow<'a, str>>,
    pub key: Option<Cow<'a, str>>,
    pub command: Option<Cow<'a, str>>,
}

Structure for displaying a menu on target-client

Manual

tmux ^3.2:

display-menu [-O] [-c target-client] [-t target-pane] [-T title] [-x position] [-y position] name key command ...
alias: menu

tmux ^3.0:

display-menu [-c target-client] [-t target-pane] [-T title] [-x position] [-y position] name key command ...
alias: menu

Fields

not_close: bool

[-O] - the menu does not close when the mouse button is released without an item selected

target_client: Option<Cow<'a, str>>

[-c target-client] - target-client

target_pane: Option<Cow<'a, str>>

[-t target-pane] - target-pane

title: Option<Cow<'a, str>>

[-T title] - title

x: Option<usize>

[-x position] - x position of the menu

y: Option<usize>

[-y position] - y position of the menu

name: Option<Cow<'a, str>>

name

key: Option<Cow<'a, str>>

key

command: Option<Cow<'a, str>>

command

Implementations

impl<'a> DisplayMenu<'a>

pub fn new() -> Self

pub fn not_close(self) -> Self

[-O] - the menu does not close when the mouse button is released without an item selected

pub fn target_client<S: Into<Cow<'a, str>>>(self, target_client: S) -> Self

[-c target-client] - target-client

pub fn target_pane<S: Into<Cow<'a, str>>>(self, target_pane: S) -> Self

[-t target-pane] - target-pane

pub fn title<S: Into<Cow<'a, str>>>(self, title: S) -> Self

[-T title] - title

pub fn x(self, x: usize) -> Self

[-x position] - x position of the menu

pub fn y(self, y: usize) -> Self

[-y position] - y position of the menu

pub fn name<S: Into<Cow<'a, str>>>(self, name: S) -> Self

name

pub fn key<S: Into<Cow<'a, str>>>(self, key: S) -> Self

key

pub fn command<S: Into<Cow<'a, str>>>(self, command: S) -> Self

pub fn build(self) -> TmuxCommand<'a>

Trait Implementations

impl<'a> Clone for DisplayMenu<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for DisplayMenu<'a>

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

Formats the value using the given formatter.

impl<'a> Default for DisplayMenu<'a>

fn default() -> DisplayMenu<'a>

Returns the “default value” for a type.

impl<'a> From<DisplayMenu<'a>> for TmuxCommand<'a>

fn from(item: DisplayMenu<'a>) -> Self

Converts to this type from the input type.

impl<'a> Hash for DisplayMenu<'a>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a> Ord for DisplayMenu<'a>

fn cmp(&self, other: &DisplayMenu<'a>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<'a> PartialEq for DisplayMenu<'a>

fn eq(&self, other: &DisplayMenu<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> PartialOrd for DisplayMenu<'a>

fn partial_cmp(&self, other: &DisplayMenu<'a>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a> Eq for DisplayMenu<'a>

impl<'a> StructuralPartialEq for DisplayMenu<'a>