Prerelease This site documents an alpha of libtmux. Its structure, URLs and APIs are subject to change.

Rust API

Rust documentation

server.Server.display_menu

Rust
  • Python
  • TypeScript Unavailable
  • Rust
  • Go
  • Java Unavailable
  • .NET Unavailable
  • C++ Unavailable
  • Swift Unavailable

View as Markdown

Module
server
Declared in
Server
Package
libtmux
Source
crates/libtmux/src/server/interactive.rs
Other languages
Python TypeScript Go Java .NET C++ Swift
display_menu ( self , client : Option<&Client> , title : &str , items : impl IntoIterator<Item = MenuItem> ) → Result<(), Error>
method [source]
method [source]
display_menu

Show a menu over a client.

Items appear in the order given. This needs a client with a terminal.

Like Self::command_prompt , this waits for the person: tmux holds the invocation until an item is chosen or the menu is dismissed, and the dispatch timeout is what ends the wait when nobody does.

Errors

Returns Error::ServerMismatch when the client belongs to another server, or an error when no suitable client exists, when tmux refuses an item, and when the dispatch timeout expires before anyone chooses.

In other ports Show a menu over a client

0 declared, 0 inherited

Esc

Type to search.