Struct SettingsDialog 

pub struct SettingsDialog {
    pub is_open: bool,
    pub templates: TemplateStore<ChartSettingsState>,
    pub execution_sounds: Vec<String>,
    /* private fields */
}

Modal settings dialog with tabbed interface.

Edits chart display settings, event category visibility and the host trading and alert-overlay preferences.

Fields

is_open: bool

Whether the dialog is currently open

templates: TemplateStore<ChartSettingsState>

Host-readable chart templates and their optional storage connection.

execution_sounds: Vec<String>

The local sounds the host can play, by name, offered on the Trading and Alerts tabs. The host plays the chosen one; see Trading::take_execution_sound. Without any, the tab offers no choice.

Implementations

impl SettingsDialog

pub fn new() -> Self

Create a SettingsDialog with default settings.

pub fn set_control_visible(&mut self, control: Control, visible: bool)

Shows or hides control: Templates (the template button and menu; Reset to defaults then takes the button’s place). The dialog ignores the other controls.

pub fn set_feed_capabilities( &mut self, capabilities: Option<&FeedCapabilities>, instrument: Option<&Instrument>, )

Restrict Order flow controls to services explicitly declared for the chart’s instrument. Pass Chart::feed_capabilities and Chart::instrument again when they change. A missing instrument or a non-positive, non-finite or missing tick size hides the tab. Before the first call, all layers are offered. Hidden controls retain their saved values.

pub fn open(&mut self, settings: ChartSettingsState)

Open the dialog with the supplied state.

pub fn close(&mut self)

Close the dialog.

pub fn settings(&self) -> &ChartSettingsState

Read the display settings being edited.

pub fn show(&mut self, ctx: &Context, theme: &Theme) -> SettingsAction

Show the dialog and return the requested action.

Trait Implementations

impl Default for SettingsDialog

fn default() -> Self

Returns the “default value” for a type.