Struct UserCmd 

pub struct UserCmd {

    pub default_inner_gap: Option<u32>,
    pub ig_left: Option<u32>,
    pub ig_right: Option<u32>,
    pub ig_bottom: Option<u32>,
    pub ig_top: Option<u32>,
    pub default_outer_gap: Option<u32>,
    pub og_left: Option<u32>,
    pub og_right: Option<u32>,
    pub og_bottom: Option<u32>,
    pub og_top: Option<u32>,
    pub default_split_perc: Option<f32>,
    pub hsplit_perc: Option<f32>,
    pub vsplit_perc: Option<f32>,
    pub start_hsplit: bool,
    pub start_vsplit: bool,
    pub inc_hsplit: Option<f32>,
    pub inc_vsplit: Option<f32>,
    pub dec_vsplit: Option<f32>,
    pub dec_hsplit: Option<f32>,
    pub reverse: bool,
}

Fields

default_inner_gap: Option<u32>

The number of pixels to pad each inner edge of a window by default.

ig_left: Option<u32>

The number of pixels to pad the left inner edge of each window. This Overrides default_inner_gap. Optional

ig_right: Option<u32>

The number of pixels to pad the right inner edge of each window. This Overrides default_inner_gap. Optional

ig_bottom: Option<u32>

The number of pixels to pad the bottom inner edge of each window. This Overrides default_inner_gap. Optional

ig_top: Option<u32>

The number of pixels to pad the top inner edge of each window. This Overrides default_inner_gap. Optional

default_outer_gap: Option<u32>

The default size of the gap between windows and the edge of the screen.

og_left: Option<u32>

The number of pixels to place between the left screen edge and any windows. Overrides default_outer_gap for the left side. Optional.

og_right: Option<u32>

The number of pixels to place between the right screen edge and any windows. Overrides default_outer_gap for the right side. Optional.

og_bottom: Option<u32>

The number of pixels to place between the bottom screen edge and any windows. Overrides default_outer_gap for the bottom side. Optional.

og_top: Option<u32>

The number of pixels to place between the top screen edge and any windows. Overrides default_outer_gap for the top side. Optional.

default_split_perc: Option<f32>

The default percentage of available area that the primary window should occupy after any split takes place.

hsplit_perc: Option<f32>

The percentage of available area that the primary window should occupy after a horizontal split. This will override the value of default_split_perc only for horizontal splits.

vsplit_perc: Option<f32>

The percentage of available area that the primary window should occupy after a vertical split. This will override the value of default_split_perc only for vertical splits.

start_hsplit: bool

Set the first split to horizontal

start_vsplit: bool

Set the first split to vertical

inc_hsplit: Option<f32>

Increase the hsplit percentage by a certain amount.

inc_vsplit: Option<f32>

Increase the vsplit percentage by a certain amount.

dec_vsplit: Option<f32>

Decrease the vsplit percentage by a certain amount.

dec_hsplit: Option<f32>

Decrease the hsplit percentage by a certain amount.

reverse: bool

Reverse the order of the views as well as the order they are added.

Implementations

impl UserCmd

pub fn handle_outer_gaps(&self, layout: &mut BSPLayout)

pub fn handle_inner_gaps(&self, layout: &mut BSPLayout)

pub fn handle_ch_split(&self, layout: &mut BSPLayout)

pub fn handle_start_split( &self, layout: &mut BSPLayout, ) -> Result<(), BSPLayoutError>

pub fn handle_set_split(&self, layout: &mut BSPLayout)

pub fn handle_reverse(&self, layout: &mut BSPLayout)

Trait Implementations

impl Args for UserCmd

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

impl CommandFactory for UserCmd

fn command<'b>() -> Command

Build a Command that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a Command that can update self.

impl FromArgMatches for UserCmd

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for UserCmd

fn parse() -> Self

Parse from std::env::args_os(), exit on error.

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, exit on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, exit on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.