Struct Configuration 

pub struct Configuration {

    pub primary_modifier: Option<Modifier>,
    pub custom_key_actions: Option<Vec<CustomKeyAction>>,
    pub default_action_overrides: Option<Vec<BuiltInKeyCommandOverride>>,
    pub inner_gaps: Option<Gaps>,
    pub outer_gaps: Option<Gaps>,
    pub startup_apps: Option<Vec<StartupApp>>,
    pub terminal: Option<String>,
    pub resize_jump: Option<i32>,
    pub environment_variables: Option<Vec<EnvironmentVariable>>,
    pub border: Option<BorderConfig>,
    pub workspaces: Option<Vec<WorkspaceConfig>>,
    pub animations: Option<Vec<AnimationDefinition>>,
    pub enable_animations: Option<bool>,
    pub move_modifier: Option<Vec<Modifier>>,
    pub drag_and_drop: Option<DragAndDropConfiguration>,
    pub mouse: Option<MouseConfiguration>,
    pub touchpad: Option<TouchpadConfiguration>,
    pub keyboard: Option<KeyboardConfiguration>,
    pub hover_click: Option<HoverClickConfiguration>,
    pub simulated_secondary_click: Option<SimulatedSecondaryClickConfiguration>,
    pub output_filter: Option<OutputFilterConfiguration>,
    pub cursor: Option<CursorConfiguration>,
    pub slow_keys: Option<SlowKeysConfiguration>,
    pub sticky_keys: Option<StickyKeysConfiguration>,
    pub magnifier: Option<MagnifierConfiguration>,
    pub workspace_back_and_forth: Option<bool>,
}

Configuration overrides that a plugin may return from [Plugin::configure].

Every field is optional. None means “do not override this value”. The compositor merges all loaded plugins’ results and then merges the combined result with the file-based configuration (plugin values win on conflict).

The plugins and includes keys of the compositor config cannot be set by plugins and are intentionally absent from this struct.

Fields

primary_modifier: Option<Modifier>

The primary modifier key (e.g. Modifier::Meta for the Super/Windows key).

custom_key_actions: Option<Vec<CustomKeyAction>>

Custom key bindings that run shell commands.

default_action_overrides: Option<Vec<BuiltInKeyCommandOverride>>

Overrides for built-in compositor key bindings.

inner_gaps: Option<Gaps>

Inner (between windows) gap size.

outer_gaps: Option<Gaps>

Outer (screen edge) gap size.

startup_apps: Option<Vec<StartupApp>>

Applications to launch on startup.

terminal: Option<String>

Override the default terminal emulator command.

resize_jump: Option<i32>

Pixel amount to jump when resizing with keyboard shortcuts.

environment_variables: Option<Vec<EnvironmentVariable>>

Extra environment variables to set in the compositor process.

border: Option<BorderConfig>

Window border appearance.

workspaces: Option<Vec<WorkspaceConfig>>

Workspace layout definitions.

animations: Option<Vec<AnimationDefinition>>

Animation definitions per event. Each entry names an event plus the definition.

enable_animations: Option<bool>

Whether animations are globally enabled.

move_modifier: Option<Vec<Modifier>>

The modifier keys used for window move operations. Use vec![Modifier::Primary] to follow the user’s primary modifier.

drag_and_drop: Option<DragAndDropConfiguration>

Drag-and-drop behaviour.

mouse: Option<MouseConfiguration>

Mouse pointer settings.

touchpad: Option<TouchpadConfiguration>

Touchpad settings.

keyboard: Option<KeyboardConfiguration>

Keyboard repeat rate, delay, and keymap.

hover_click: Option<HoverClickConfiguration>

Hover-click (dwell click) accessibility feature.

simulated_secondary_click: Option<SimulatedSecondaryClickConfiguration>

Simulated secondary click accessibility feature.

output_filter: Option<OutputFilterConfiguration>

Output (display) post-processing filter.

cursor: Option<CursorConfiguration>

Cursor appearance and focus behaviour.

slow_keys: Option<SlowKeysConfiguration>

Slow keys accessibility feature.

sticky_keys: Option<StickyKeysConfiguration>

Sticky keys accessibility feature.

magnifier: Option<MagnifierConfiguration>

Screen magnifier.

workspace_back_and_forth: Option<bool>

Whether switching to the current workspace goes back to the previous one.

Trait Implementations

impl Clone for Configuration

fn clone(&self) -> Configuration

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Configuration

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

Formats the value using the given formatter.

impl Default for Configuration

fn default() -> Configuration

Returns the “default value” for a type.

impl Serialize for Configuration

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

where __S: Serializer,

Serialize this value into the given Serde serializer.