Struct penrose::xcb::Api

pub struct Api { /* fields omitted */ }

A connection to the X server using the XCB C API

Implementations

impl Api

pub fn new() -> Result<Self>

Connect to the X server using the XCB API

Each Api contains and embedded xcb Connection which is used for making all api calls through to the X server. Some state is cached in the Api itself in order to prevent redundant calls through to the X server.

Creating a new Api instance will establish the underlying connection and if the xcb_keysyms feature is enabled, pull KeyCode mappings from the user system using xmodmap.

Trait Implementations

impl Debug for Api

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

Formats the value using the given formatter.

impl Drop for Api

pub fn drop(&mut self)

Executes the destructor for this type.

impl XcbApi for Api

pub fn atom(&self, name: &str) -> Result<u32>

Intern an atom by name, returning the corresponding id.

pub fn known_atom(&self, atom: Atom) -> u32

Fetch the id value of a known Atom variant.

pub fn delete_prop(&self, id: WinId, prop: Atom)

Delete a known property from a window

pub fn get_atom_prop(&self, id: WinId, atom: Atom) -> Result<u32>

Fetch an Atom property for a given window

pub fn get_str_prop(&self, id: WinId, name: &str) -> Result<String>

Fetch an String property for a given window

pub fn replace_prop(&self, id: WinId, prop: Atom, val: PropVal<'_>)

Replace a property value on a window.

pub fn create_window(
    &self,
    ty: WinType,
    reg: Region,
    managed: bool
) -> Result<WinId>

Create a new client window

pub fn configure_window(&self, id: WinId, conf: &[WinConfig])

Apply a set of config options to a window

pub fn destroy_window(&self, id: WinId)

Destroy the X server state for a given window

pub fn map_window(&self, id: WinId)

Send a XEvent::MapRequest for the target window

pub fn mark_focused_window(&self, id: WinId)

Mark the given window as currently having focus in the X server state

pub fn send_client_event(&self, id: WinId, atom_name: &str) -> Result<()>

Send an event to a client

pub fn set_window_attributes(&self, id: WinId, attrs: &[WinAttr])

Set attributes on the target window

pub fn unmap_window(&self, id: WinId)

Unmap the target window

pub fn window_geometry(&self, id: WinId) -> Result<Region>

Find the current size and position of the target window

pub fn current_screens(&self) -> Result<Vec<Screen>>

Query the randr API for current outputs and return the details as penrose Screen structs.

pub fn screen_sizes(&self) -> Result<Vec<Region>>

Query the randr API for current outputs and return the size of each screen

pub fn current_clients(&self) -> Result<Vec<WinId>>

The list of currently active clients known to the X server

pub fn cursor_position(&self) -> Point

The current (x, y) position of the cursor relative to the root window

pub fn flush(&self) -> bool

Flush pending actions to the X event loop

pub fn focused_client(&self) -> Result<WinId>

The client that the X server currently considers to be focused

pub fn grab_keys(&self, keys: &[&KeyCode])

Register intercepts for each given KeyCode

pub fn grab_mouse_buttons(&self, states: &[&MouseState])

Register intercepts for each given MouseState

pub fn root(&self) -> WinId

The current root window ID

pub fn set_randr_notify_mask(&self) -> Result<()>

Set a pre-defined notify mask for randr events to subscribe to

pub fn ungrab_keys(&self)

Drop all active intercepts for key combinations

pub fn ungrab_mouse_buttons(&self)

Drop all active intercepts for mouse states

pub fn wait_for_event(&self) -> Result<XEvent>

Block until the next event from the X event loop is ready then return it.

pub fn poll_for_event(&self) -> Result<Option<XEvent>>

Return the next event from the X event loop if there is one.

pub fn warp_cursor(&self, id: WinId, x: usize, y: usize)

Move the cursor to the given (x, y) position inside the specified window.