Struct Help 

pub struct Help { /* private fields */ }

A help popup where you can show markdown text and controls as a table.

Implementations

impl Help

pub fn title(&self) -> Option<&str>

pub fn new(title: impl Into<String>) -> Help

Create a new help popup.

pub fn new_without_title() -> Help

Create a new help popup.

pub fn horizontal_spacing(self, horizontal_spacing: f32) -> Help

Minimum distance between key and value

pub fn docs_link(self, docs_link: impl Into<String>) -> Help

Add a docs link, to be shown in the top right corner.

pub fn markdown(self, markdown: impl Into<String>) -> Help

Add a markdown section.

pub fn controls(self, controls: Vec<ControlRow>) -> Help

Add a controls section.

pub fn control( self, label: impl Into<String>, items: impl IntoAtoms<'static>, ) -> Help

Add a single control row to the last controls section.

Split any + or / into an extra IconTextItem, like this:

re_ui::Help::new("Example").control("Pan", ("click", "+", "drag"));

pub fn control_separator(self) -> Help

Create a new empty control section.

pub fn ui(self, ui: &mut Ui)

Show the help popup. Usually you want to show this in egui::Response::on_hover_ui.

Trait Implementations

impl Clone for Help

fn clone(&self) -> Help

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Help

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

Formats the value using the given formatter.