Struct UiSettings

pub struct UiSettings {

    pub version: u64,
    pub auto_start: AutoStart,
    pub smooth_switch_desktops: bool,
    pub request_admin_at_startup: bool,
    pub stop_flashing_windows_after_applying_filter: bool,
    pub tray_icon_type: TrayIconType,
    pub quick_switch_menu: QuickSwitchMenu,
    pub quick_switch_menu_shortcuts: Arc<BTreeMap<String, u32>>,
    pub quick_switch_menu_shortcuts_only_in_root: bool,
    pub quick_switch_hotkey: Arc<str>,
    pub open_menu_at_mouse_pos_hotkey: Arc<str>,
    pub left_click: TrayClickAction,
    pub middle_click: TrayClickAction,
    pub config_window: ConfigWindowInfo,
    pub filters: Arc<[WindowFilter]>,
}

Fields

version: u64

auto_start: AutoStart

Autostart this program when Windows is started.

smooth_switch_desktops: bool

If this is enabled then we will attempt to switch virtual desktops using animations. This is done by opening a transparent window on a different virtual desktop and then focusing on it.

request_admin_at_startup: bool

Elevated permission is useful to move windows owned by elevated programs. If this setting is enabled the program will ask for admin rights every time it is started, making it easy to always have them.

stop_flashing_windows_after_applying_filter: bool

Some windows might be trying to grab the user’s attention and will be flashing in the taskbar. These taskbar items will remain visible even if the window is moved to another virtual desktop. If this setting is enabled we will attempt to stop windows from flashing in the taskbar after moving them.

tray_icon_type: TrayIconType

The type of icon to show in the system tray.

quick_switch_menu: QuickSwitchMenu

Fancy context menu items that allows switching to a desktop by entering its one-based index via context menu keyboard shortcuts.

quick_switch_menu_shortcuts: Arc<BTreeMap<String, u32>>

Extra context menu items that have custom access keys to allow fast switching to specific desktops. Usually this is used if you have more than 9 desktops because then pressing 1 could be interpreted as the start of 10 and so it is useful to have another key that brings you to the first desktop.

quick_switch_menu_shortcuts_only_in_root: bool

Determines if the extra shortcut menu items should be shown even in submenus of the quick switch menu. Usually it is enough to only have them in the top most “quick switch” context menu.

quick_switch_hotkey: Arc<str>

Global keyboard shortcut for opening the quick switch menu. Will be parsed as a [global_hotkey::hotkey::HotKey].

open_menu_at_mouse_pos_hotkey: Arc<str>

Global keyboard shortcut for opening the context menu at the mouse’s current position. Quite useful when the keyboard shortcut is used by a macro triggered by a mouse button.

left_click: TrayClickAction

middle_click: TrayClickAction

Middle clicks are registered as left clicks for at least some versions of Windows 11.

config_window: ConfigWindowInfo

Info about last location of the configuration window.

filters: Arc<[WindowFilter]>

Filters/rules that specify which windows should be moved and to what virtual desktop.

Implementations

impl UiSettings

const CURRENT_VERSION: u64 = 2u64

fn migrate(&mut self)

Ensure settings are the newest version. Some work might have been done previously by UiSettingsFallback::maybe_migrate if initial parsing failed.

Trait Implementations

impl Clone for UiSettings

fn clone(&self) -> UiSettings

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UiSettings

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

Formats the value using the given formatter.

impl Default for UiSettings

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for UiSettings

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<UiSettingsFallback> for UiSettings

fn from(value: UiSettingsFallback) -> Self

Converts to this type from the input type.

impl Ord for UiSettings

fn cmp(&self, other: &UiSettings) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for UiSettings

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for UiSettings

fn partial_cmp(&self, other: &UiSettings) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for UiSettings

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for UiSettings

impl StructuralPartialEq for UiSettings