Struct WindowFilter

pub struct WindowFilter {
    pub window_index: IntegerRange,
    pub desktop_index: IntegerRange,
    pub window_title: TextPattern,
    pub process_name: TextPattern,
    pub action: FilterAction,
    pub target_desktop: i64,
}

Specifies how to filter all windows to select a subset and also what action should be applied to the selected windows.

Fields

window_index: IntegerRange

This index is lower if the window was recently accessed. Limiting this index is therefore a way to only affect recently used windows.

Note: uses zero-based indexing.

desktop_index: IntegerRange

The index of the virtual desktop that window should be on. If the window is pinned then that is always allowed.

Note: uses zero-based indexing.

window_title: TextPattern

The text in the title bar of a window.

process_name: TextPattern

The name of the process that created and owns a window.

action: FilterAction

The action to preform on windows that match all the conditions in this filter.

target_desktop: i64

If the action specifies that the window should move then this specifies the desktop it should be moved to.

Note: uses zero-based indexing.

Implementations

impl WindowFilter

pub fn deserialize_from_xml(xml: &str) -> Result<Vec<Self>, Box<dyn Error>>

pub fn serialize_to_xml( filters: &[WindowFilter], ) -> Result<String, Box<dyn Error>>

pub fn find_first_action<'a>( filters: &'a [Self], window_index: i32, window: &WindowInfo, ) -> Option<&'a Self>

pub fn check_window(&self, window_index: i32, window: &WindowInfo) -> bool

Check if this filter/rule applies to a specific widow.

The window_index should use zero-based indexing.

pub fn display_target_desktop(&self) -> impl Display

Display a short string with information about the action and the targeted desktop. (Displays target desktop with one-based indexing.)

Trait Implementations

impl Clone for WindowFilter

fn clone(&self) -> WindowFilter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WindowFilter

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

Formats the value using the given formatter.

impl Default for WindowFilter

fn default() -> WindowFilter

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for WindowFilter

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Ord for WindowFilter

fn cmp(&self, other: &WindowFilter) -> 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 WindowFilter

fn eq(&self, other: &WindowFilter) -> 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 WindowFilter

fn partial_cmp(&self, other: &WindowFilter) -> 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 WindowFilter

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 WindowFilter

impl StructuralPartialEq for WindowFilter