class XDo::Window

• XDo::Window
• Reference
• Object

Overview

Represents an XDo view of an X11 window.

win.move_mouse 0, 0
puts "typing inside #{win["WM_NAME"]}"
win.type "hello!"

Defined in:

Constructors

• .new(xdo_p, window)

Instance Method Summary

• #==(other)

  Returns true if other has the same X11 window ID (WID).

• #[](property : String)

  Get the value associated with the property property.

• #[]=(property : String, value : String)

  Set the window's property property to value.

• #activate!

  Activates the window.

• #child

  Attempt to find the window's child.

• #class=(klass : String)

  Set the window's class (WM_CLASS class name) to klass.

• #class_name=(name : String)

  Set the window's class name (WM_CLASS instance name) to name.

• #click(button : Button, repeat, delay = DEFAULT_DELAY)

  Click the given mouse button repeat times, with delay between each click.

• #click(button : Button)

  Click the given mouse button on this window (mouse-down + mouse-up)

• #close!

  Closes a window without trying to kill its client.

• #desktop

  Get the window's desktop number.

• #focus!

  Focuses the window.

• #keys(keys : String, delay = DEFAULT_DELAY)

  Send some keys (down + up) to the window, with delay between them.

• #keys_down(keys : String, delay = DEFAULT_DELAY)

  Send some key press (down) events for the given keys, with delay between them.

• #keys_raw(keys : Array(LibXDo::Charcodemap), *, pressed : Bool, modifier = 0, delay = DEFAULT_DELAY)

  Send some key events by specifying keysyms and modifiers directly, with delay between them.

• #keys_up(keys : String, delay = DEFAULT_DELAY)

  Send some key release (up) events for the given keys, with delay between them.

• #kill!

  Kills a window and the client owning it.

• #location

  Get the window's location, consisting of a tuple of width, height, and Screen object

• #map!

  Maps the window, making it visible if previously unmapped.

• #minimize!

  Minimizes the window.

• #mouse_down(button : Button)

  Send a mouse-down event for the given mouse button to this window.

• #mouse_up(button : Button)

  Send a mouse-up event for the given mouse button to this window.

• #move(x, y)

  Attempt to move the window to x, y on the screen.

• #move(desktop)

  Attempt to move the window to desktop.

• #move_mouse(x, y)

  Move the mouse relative to this window.

• #name

  Get the window's name (WM_NAME), if any.

• #on_active(*, want_active = true, &)

  Wait for the window to become active or inactive, per want_active.

• #on_focus(*, want_focus = true, &)

  Wait for the window to gain or lose focus, per want_focus.

• #on_map_state(state : WindowMapState, &)

  Wait for the window's map state to become state.

• #on_size_change(&)

  Wait for the window's dimensions to change, and yield self.

• #on_size_from(width, height, use_hints = false, &)

  Wait for the window's dimensions to change from width x height to something else.

• #on_size_to(width, height, use_hints = false, &)

  Wait for the window's dimensions to change to width x height from something else.

• #override_redirect=(override_redirect : Bool)

  Set the window's override-redirect flag.

• #parent

  Attempt to find the window's parent.

• #pid

  Return the process ID associated with the window, or 0 if not found.

• #raise!

  Raises the window (bringing it to the foreground).

• #resize(width, height, flags : ResizeFlag = ResizeFlag::Pixels)

  Attempt to change the window's size to width x height, scaled by flags.

• #size

  Return the size of the window as a tuple of width and height.

• #translate_with_hint(width, height)

  Attempt to apply the window's sizing hints with the given width and height.

• #type(text : String, delay = DEFAULT_DELAY)

  Send some text to the window, with delay between the keystrokes.

• #unmap!

  Unmaps the window, making it invisible.

• #urgent=(urgent : Bool)

  Set the window's urgency hint.

• #wait_for_active(*, want_active = true)

  Wait for the window to become active or inactive, per want_active.

• #wait_for_focus(*, want_focus = true)

  Wait for the window to gain or lose focus, per want_focus.

• #wait_for_map_state(state : WindowMapState)

  Wait for the window's map state to become state.

• #wait_for_size_from(width, height, use_hints = false)

  Wait for the window's dimensions to change from width x height to something else.

• #wait_for_size_to(width, height, use_hints = false)

  Wait for the window's dimensions to change to width x height from something else.

• #window : LibXDo::Window

Constructor Detail

Instance Method Detail

# change the window's title-bar name
win["WM_NAME"] = "my custom window name"

# switch to the window's desktop and raise it
win.activate!

win.class = "my-custom-class"

win.class_name = "my-custom-instance"

desktop = win.desktop

win.keys "Ctrl+s"

win.keys_down "Ctrl+o"

key1 = XDo::LibXDo::Charcodemap.new
key1.code = 38
key1.modmask = 1
key2 = XDo::LibXDo::Charcodemap.new
key2.code = 56
keys = [key1, key2]
# Sends `AB`
win.keys_raw keys, pressed: true
win.keys_raw keys, pressed: false

win.keys_up "Ctrl+o"

x, y, screen = win.location

# try to put the window in the upper left corner
win.move 0, 0

# try to move the window to desktop #3
win.move 3

window.on_size_change do
  puts "my new size is: #{window.size}"
end

win.override_redirect = true

# make the window 100px by 100px
win.resize 100, 100

# make the window 500 by 500 size-hint units
win.resize 500, 500, ResizeFlag::UseHints

width, height = win.size

win.translate_with_hint 100, 100

win.type "hello from Crystal!"

# tell the WM to indicate the window's urgency to the user
win.urgent = true