Type Definition rubrail::Touchbar

type Touchbar = Box<RustTouchbarDelegateWrapper>;

Controller for creating and using Touch Bar UIs

The Touchbar type provides the interface between Rust and the Apple Touch Bar system. It handles communication with the Touch Bar service, delegation of UI and touch events, and memory management of Objective-C objects. All creation and modification of Touch Bar UIs is done through it.

This implementation uses private Apple APIs to create an always-available menu to the Control Strip region, which can be accessed regardless of which application is in focus. Apps using it are not permitted in the App Store.

There should typically be one Touchbar type alocated per application. Rubrail does not enforce the singleton pattern automatically, so it is up to the application to guarantee that there is only one. Theoretically, one application can have multiple disjoint entries in the Touch Bar by creating more than one Touchbar, and Rubrail allows this though it is not tested.

See the documentation of the TTouchbar trait for usage.

Example

extern crate rubrail;
use rubrail::TTouchbar;
fn main() {
  let controller = rubrail::Touchbar::alloc("test");
}

Trait Implementations

impl TTouchbar for Touchbar

type T = Touchbar

A concrete implementation of TTouchbar

fn alloc(title: &str) -> Touchbar

Allocate a new Touch Bar interface

fn set_icon(&self, image: &str)

Set an icon to display in the Control Strip

fn create_bar(&mut self) -> BarId

Create a new horizontal bar UI

fn create_popover_item(
    &mut self,
    image: Option<&TouchbarImage>,
    text: Option<&str>,
    bar_id: &BarId
) -> ItemId

Create a button to open a 'popover' submenu.

fn add_items_to_bar(&mut self, bar_id: &BarId, items: Vec<ItemId>)

Adds a group of ordered items to a bar

fn set_bar_as_root(&mut self, bar_id: BarId)

Sets the given bar as the 'root' bar in the Control Strip

fn create_label(&mut self, text: &str) -> ItemId

Create a new label

fn update_label(&mut self, label_id: &ItemId, text: &str)

Changes the text in an existing label

fn update_label_width(&mut self, label_id: &ItemId, width: u32)

Changes the width of an existing label

fn create_text_scrubber(&mut self, data: Rc<dyn TScrubberData>) -> ItemId

Create a horizontally scrolling 'scrubber' of text

fn select_scrubber_item(&mut self, scrub_id: &ItemId, index: u32)

Selects the given index in a scrubber

fn refresh_scrubber(&mut self, scrub_id: &ItemId)

Inform a scrubber to redraw after a change to its backing data

fn add_item_swipe_gesture(&mut self, item_id: &ItemId, cb: SwipeCb)

Register a swipe gesture handler with a Touch Bar item

fn add_item_tap_gesture(
    &mut self,
    item_id: &ItemId,
    taps: u32,
    fingers: u32,
    cb: ButtonCb
)

Register a tap gesture handler with a Touch Bar item

fn create_spacer(&mut self, space: SpacerType) -> ItemId

Create space between items in a bar

fn create_image_from_path(&mut self, path: &str) -> TouchbarImage

Create an image from a file path

fn create_image_from_template(
    &mut self,
    template: ImageTemplate
) -> TouchbarImage

Create an image from a template

fn create_button(
    &mut self,
    image: Option<&TouchbarImage>,
    text: Option<&str>,
    cb: ButtonCb
) -> ItemId

Create a button that triggers a callback when pressed

fn update_button(
    &mut self,
    item: &ItemId,
    image: Option<&TouchbarImage>,
    text: Option<&str>
)

Changes the image and/or text of a button

fn update_button_width(&mut self, button_id: &ItemId, width: u32)

Changes the width of an existing button

fn create_slider(
    &mut self,
    min: f64,
    max: f64,
    label: Option<&str>,
    continuous: bool,
    cb: SliderCb
) -> ItemId

Create a slider item

fn update_slider(&mut self, id: &ItemId, value: f64)

Update the current position of a slider