Enum HostNotification 

pub enum HostNotification {
    DirtyChanged(bool),
    OpenEditorRequested {
        name: Option<String>,
    },
    GroupEditStarted,
    GroupEditFinished,
    UnitSelectionChanged {
        unit_id: i32,
    },
    ProgramListChanged {
        list_id: i32,
        program_index: Option<i32>,
    },
    UnitByBusChanged,
    ProgressStarted {
        id: u64,
        kind: ProgressKind,
        description: Option<String>,
    },
    ProgressUpdated {
        id: u64,
        value: ProgressValue,
    },
    ProgressFinished {
        id: u64,
    },
    ContextMenuRequested {
        menu_id: u64,
        parameter_id: Option<u32>,
        x: i32,
        y: i32,
        items: Vec<ContextMenuItem>,
    },
}

A control-plane action requested by a plugin through its host callbacks.

Ordering

Notifications keep their order relative to each other, and so do the ParameterEdits from Plugin::take_parameter_edits — but the two streams are buffered independently, so their relative order is not preserved. In particular, the GroupEditStarted / GroupEditFinished bracket cannot be correlated with the edits that fell inside it: treat it as “the plugin is currently in a grouped gesture”, not as a delimiter around specific parameter edits.

Variants

DirtyChanged(bool)

The plugin changed whether its state needs saving.

OpenEditorRequested

The plugin asked the host to open an editor, optionally by view name.

Fields

name: Option<String>

Requested view name, or None for the default editor.

GroupEditStarted

The plugin began a grouped edit.

GroupEditFinished

The plugin finished a grouped edit.

UnitSelectionChanged

The plugin selected a different unit in its own UI.

Fields

unit_id: i32

Newly selected unit id.

ProgramListChanged

A program list, or one program in it, changed in the plugin.

Fields

list_id: i32

Program-list id.

program_index: Option<i32>

Changed program, or None when the whole list changed.

UnitByBusChanged

The plugin changed its bus/channel-to-unit assignments.

ProgressStarted

The plugin began a bounded progress operation.

Fields

id: u64

Host-assigned progress operation id.

kind: ProgressKind

Kind of work the plugin is performing.

description: Option<String>

Optional plugin-provided description.

ProgressUpdated

The plugin updated an existing progress operation.

Fields

id: u64

Host-assigned progress operation id.

value: ProgressValue

Normalized progress in the inclusive 0.0..=1.0 range.

ProgressFinished

The plugin finished an existing progress operation.

Fields

id: u64

Host-assigned progress operation id.

ContextMenuRequested

The plugin populated a context menu and asked the host to display it.

After showing the menu, call Plugin::execute_context_menu_item for the chosen entry, or Plugin::dismiss_context_menu if it was dismissed. Either call releases the plugin-owned menu targets retained for this popup.

Fields

menu_id: u64

Host-assigned popup id.

parameter_id: Option<u32>

Parameter the menu belongs to, or None for a view-wide menu.

x: i32

Horizontal popup coordinate in the plugin view.

y: i32

Vertical popup coordinate in the plugin view.

items: Vec<ContextMenuItem>

Menu entries in display order.

Trait Implementations

impl Clone for HostNotification

fn clone(&self) -> HostNotification

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HostNotification

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for HostNotification

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for HostNotification

impl PartialEq for HostNotification

fn eq(&self, other: &HostNotification) -> bool

Equality operator ==.

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

Inequality operator !=.

impl Serialize for HostNotification

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for HostNotification