Struct HelpButtonControl

pub struct HelpButtonControl {
    pub control_number: u8,
    pub display: String,
    pub tooltip: Option<String>,
}

A button in the toolbar that opens the help URL when clicked. The URL it opens is defined in Metadata::help_url.

Fields

control_number: u8

The control number, a unique identifier for this control.

display: String

Label of the button that opens the help URL.

tooltip: Option<String>

Tooltip shown when hovering over the UI element.

Implementations

impl HelpButtonControl

pub fn builder() -> HelpButtonControlBuilder<((), (), ())>

Create a builder for building HelpButtonControl. On the builder, call .control_number(...), .display(...), .tooltip(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of HelpButtonControl.

Trait Implementations

impl Debug for HelpButtonControl

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

Formats the value using the given formatter.

impl PrintSentence for HelpButtonControl

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

The extcap interface expects certain output “sentences” to stdout to communicate with Wireshark, like

fn print_sentence(&self)

Prints the extcap sentence to stdout.

impl ToolbarControl for HelpButtonControl

fn control_number(&self) -> u8

The control number, a unique identifier for this control.