Struct penrose::contrib::extensions::scratchpad::Scratchpad

pub struct Scratchpad { /* fields omitted */ }

Spawn and manage a single Client which can then be shown above the current layout.

The get_hook method must be called to pass the associated Hook to your WindowManager before calling init in order to register the necessary hooks to spawn, capture and manage the embedded client. The client is spawned when 'toggle' is called and there is no existing client, after that 'toggle' will show/hide the client on the active screen. If the client is removed, calling 'toggle' again will spawn a new client in the same way.

Implementations

impl Scratchpad

pub fn new<S>(prog: S, w: f32, h: f32) -> Scratchpad where
    S: Into<String>, 

Create a new Scratchpad for holding 'prog'. 'w' and 'h' are the percentage width and height of the active screen that you want the client to take up when visible. NOTE: this function will panic if 'w' or 'h' are not within the range 0.0 - 1.0

pub fn get_hook(&self) -> Box<Self>

Construct the associated Hook for adding to the WindowManager.

NOTE: If the hook is not registered, Scratchpad will not be able to capture and manage spawned Client windows.

pub fn toggle<X: XConn>(&self) -> KeyEventHandler<X>

Show / hide the bound client. If there is no client currently, then spawn one.

Trait Implementations

impl Clone for Scratchpad

pub fn clone(&self) -> Scratchpad

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Scratchpad

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

Formats the value using the given formatter.

impl<X: XConn> Hook<X> for Scratchpad

pub fn new_client(
    &mut self,
    wm: &mut WindowManager<X>,
    c: &mut Client
) -> Result<()>

Trigger Point

pub fn remove_client(
    &mut self,
    _: &mut WindowManager<X>,
    id: WinId
) -> Result<()>

Trigger Point

pub fn layout_applied(
    &mut self,
    wm: &mut WindowManager<X>,
    _: usize,
    screen_index: usize
) -> Result<()>

Trigger Point

pub fn startup(&mut self, wm: &mut WindowManager<X>) -> Result<()>

Trigger Point

pub fn client_added_to_workspace(
    &mut self,
    wm: &mut WindowManager<X>,
    id: WinId,
    wix: usize
) -> Result<()>

Trigger Point

pub fn client_name_updated(
    &mut self,
    wm: &mut WindowManager<X>,
    id: WinId,
    name: &str,
    is_root: bool
) -> Result<()>

Trigger Point

pub fn layout_change(
    &mut self,
    wm: &mut WindowManager<X>,
    workspace_index: usize,
    screen_index: usize
) -> Result<()>

Trigger Point

pub fn workspace_change(
    &mut self,
    wm: &mut WindowManager<X>,
    previous_workspace: usize,
    new_workspace: usize
) -> Result<()>

Trigger Point

pub fn workspaces_updated(
    &mut self,
    wm: &mut WindowManager<X>,
    names: &[&str],
    active: usize
) -> Result<()>

Trigger Point

pub fn screen_change(
    &mut self,
    wm: &mut WindowManager<X>,
    screen_index: usize
) -> Result<()>

Trigger Point

pub fn screens_updated(
    &mut self,
    wm: &mut WindowManager<X>,
    dimensions: &[Region]
) -> Result<()>

Trigger Point

pub fn randr_notify(&mut self, wm: &mut WindowManager<X>) -> Result<()>

Trigger Point

pub fn focus_change(
    &mut self,
    wm: &mut WindowManager<X>,
    id: WinId
) -> Result<()>

Trigger Point

pub fn event_handled(&mut self, wm: &mut WindowManager<X>) -> Result<()>

Trigger Point

impl PartialEq<Scratchpad> for Scratchpad

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

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

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

This method tests for !=.

impl StructuralPartialEq for Scratchpad