__init__(self, **kwds)
(Constructor)

Constructor.

Creates an FLWM object.

• display (host:#.#) X display & screen to use
• visual (#) visual to use
• geometry (WxH+X+Y) limits windows to this area
• maximum (WxH) size of maximized windows
• exit - menu says Exit instead of logout
• bg - (color) Frame color
• abg - (color) Frame color for active windows
• fg - (color) Label color
• bg2 - (color) Text field color
• cursor - (#) Cursor number for root
• cfg - (color) Cursor color
• cbg - (color) Cursor outline color
• windowclass - class to use when windows get created. should be a subclass of pywm.window

addHandlers(self, **kwds)

Add a set of handlers for various events.

These are given as 'eventname=func' keywords.

• startup - when WM is started:
  • handler receives no arguments
• create - when a window is created (or unhidden):
  • handler is called with a single window arg
• destroy - when a window is destroyed (or hidden)
  • handler is called with a single window arg
• activate - when a window gets activated
  • handler is called with a single window arg
• deactivate - when a window is deactivated
  • handler is called with a single window arg
• keyevent - when a keystroke is received:
  • handler is called with keystroke
• buttonpress - when a mouse button gets clicked:
  • handler is called with button number
• resize - when a window gets resized:
  • handler is called with window as arg

bindKey(self, func, arg, key, shift, control, alt, meta)

Allows you to bind a Ctrl-Alt key combo to a function

• func - function to call when key gets pressed
• arg - an argument to pass to the function. Can be a number, string, list, tuple, dict or anything you like.
• key - key to bind - either:
  • a single character
  • one of 'f1'..'f12'
  • one of 'kp0'..'kp9', or 'kpenter'
  • one of 'enter', 'tab', 'backspace', 'intert', 'delete', 'home', 'end', 'pageup', 'pagedown', 'up', 'down', 'left', 'right'
• shift - whether shift key is added - 0 or 1
• control - whether control key is added - 0 or 1
• alt - whether alt key is added - 0 or 1
• meta - whether meta key is added - 0 or 1

When the key combination gets pressed, the function you give will get called with the argument you give.

cascadeWindows(self, spacing=30)

closeCurrent(self, arg=None)

getMousePos(self, arg=None)

getScreenSize(self, arg=None)

goNextDesk(self, arg=None)

goNextWindow(self, arg=None)

goPrevDesk(self, arg=None)

goPrevWindow(self, arg=None)

indexFromWindow(self, win)

launch(self, cmd)

Launch a new window in a separate process

• cmd - a command to run in the shell to create the window. Syntax of this is anything acceptable to os.system().

moveCurrent(self, direction)

Moves the current window in the specified direction.

• direction - the direction to move. One of:
  • n or north - move to top centre of screen
  • ne or northeast - move to top right of screen
  • e or east - move to centre right of screen
  • se or southeast - move to bottom right of screen
  • s or south - move to bottom centre of screen
  • sw or southwest - move to bottom left of screen
  • w or west - move to centre left of screen
  • nw or northwest - move to top oeft of screen
  • c or centre/center - move to centre of screen
  • up - move up a bit
  • down - move down a bit
  • left - move left a bit
  • right - move right a bit

on_activate(self, win)

on_buttonPress(self, button)

Called when a button click is received. Buttons 1, 2, 3, 4, 5 are left-click, right-click, middle-click, wheelscroll up and wheelscroll down, respectively.

If you override this, you should accept a single argument, 'button_num', and return 1 if you've handled it locally, or 0 if you want the WM to handle it instead.

on_create(self, win)

on_deactivate(self, win)

on_destroy(self, win)

Called when an existing window is being destroyed (or hidden)

on_enter(self, win)

Called when the mouse pointer enters a window

If overriding, just accept a single argument, hWin

on_keyEvent(self, key)

on_resize(self, win, x, y, w, h)

Called when the size of the window changes.

• hWin, x, y, w, h

on_startup(self)

Callback which is invoked when WM starts up.

Note that this callback fires *after* all the existing windows have been re-framed (and the on_create callbacks fired), and *before* the main WM event loop starts up.

pan(self, dx=None, dy=None)

Pans all the windows on the screen

• dx, dy - x,y offset for panning. default is to pan the windows such that the mouse position is used as the screen's new central point

panDown(self, amount=30)

Pans all the windows on the screen downwards

• amount - number of pixels to pan, default 30

panLeft(self, amount=30)

Pans all the windows on the screen to the left

• amount - number of pixels to pan, default 30

panRight(self, amount=30)

Pans all the windows on the screen to the right

• amount - number of pixels to pan, default 30

panUp(self, amount=30)

Pans all the windows on the screen upwards

• amount - number of pixels to pan, default 30

resizeCurrent(self, how)

Moves the current window in the specified direction.

• how - the resize mode:
  • 'taller' - grow vertically
  • 'shorter' - shrink vertically
  • 'wider - grow horizontally
  • 'narrower' - shrink horizontally
  • 'larger' - grow vertically and horizontally
  • 'smaller' - shrink vertically and horizontally

run(self)

Launch the window manager, and receive events via callbacks.

showMenu(self, arg=None)

toggleMaxCurrent(self, arg=None)

toggleMaxHeightCurrent(self, arg=None)

toggleMaxWidthCurrent(self, arg=None)

window(self, hWin)

Maps a window handle to a window object.

windowFromIndex(self, idx)

zoom(self, factor=1, xView=None, yView=None)

Zooms in or out by a given factor.

• factor = float - >1 to zoom in, <1 to zoom out
• xView, yView - x,y origin to use for the zooming, defaults to centre of screen

zoomIn(self, factor=1.1000000000000001, fromMouse=False)

Zooms in to the current view.

• factor - amount to zoom by, default 1.1
• fromMouse - whether to use themouse position as the viewpoint - if False (default), uses centre of screen as view point

zoomInMouse(self, factor=1.1000000000000001)

Zooms in to the current view, relative to mouse position

• factor - amount to zoom by, default 1.1

zoomOut(self, factor=0.88, fromMouse=False)

Zooms out from the current view.

• factor - amount to zoom by, default 0.88
• fromMouse - whether to use themouse position as the viewpoint - if False (default), uses centre of screen as view point

zoomOutMouse(self, factor=0.88)

Zooms out from the current view, relative to mouse position

• factor - amount to zoom by, default 0.88

_addWin(self, hWin)

Makes a window known to this wm object

_delWin(self, hWin)

Deletes a window's mapping from our dict.

Called by underlying handler of window delete events.