Struct penrose::core::config::Config

pub struct Config { /* fields omitted */ }

The main user facing configuration details.

See ConfigBuilder for details of what can be overwritten.

Example

use penrose::Config;

let config = Config::default();

assert_eq!(config.border_px(), &2);
assert_eq!(config.focused_border(), &0xcc241d);

Implementations

impl Config

pub fn builder(&self) -> ConfigBuilder

Make a new associated builder struct containing the field values of this struct

pub fn workspaces(&self) -> &Vec<String>

Obtain a reference to the initial available workspaces.

Constraints

You must provide at least one workspace per screen

pub fn floating_classes(&self) -> &Vec<String>

Obtain a reference to the window classes that will always be considered floating

pub fn layouts(&self) -> &Vec<Layout>

Obtain a reference to the Layout functions to be used by each Workspace

Constraints

You must provide at least one layout function

pub fn focused_border(&self) -> &u32

Obtain a reference to the focused border color as a hex literal

pub fn unfocused_border(&self) -> &u32

Obtain a reference to the unfocused border color as a hex literal

pub fn border_px(&self) -> &u32

Obtain a reference to the border width of each window in pixels

pub fn gap_px(&self) -> &u32

Obtain a reference to the gap between tiled windows in pixels

pub fn main_ratio_step(&self) -> &f32

Obtain a reference to the percentage of the screen to grow the main region by when incrementing

pub fn show_bar(&self) -> &bool

Obtain a reference to whether or not space should be reserved for a status bar

pub fn top_bar(&self) -> &bool

Obtain a reference to whether or not the reserved space for a status bar is at the top of the sceen

pub fn bar_height(&self) -> &u32

Obtain a reference to the height of the space to be reserved for a status bar in pixels

impl Config

pub fn ws_range(&self) -> Range<usize>

Create a range from 1 -> n_workspaces for use in keybindings

Trait Implementations

impl Clone for Config

pub fn clone(&self) -> Config

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

pub fn default() -> Self

Returns the "default value" for a type.

impl PartialEq<Config> for Config

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for Config