wmii.WMIIClient

Module wmii :: Class WMIIClient

[show private | hide private]

Type WMIIClient

object --+    
         |    
  WMIIBase --+
             |
            WMIIClient

Encapsulates a single client (window).

There are numerous methods and properties available for manipulating the window - see below

Method Summary
	`__init__(self, wmii, id)` Wraps a client window.
	`__repr__(self)` return a sensible human-readable representation of client
	`_get_class_(self)` returns the X 'class'
	`addToTag(self, tagid)`
	`delFromTag(self, tagid)` removes client from given view (prompting if none)
	`float(self, tile)` toggles window between float and framed mode
	`floatToggle(self)` toggles the floating status of the window
	`fullscreenOff(self)` Turns fullscreen mode off
	`fullscreenOn(self, restore)` sets client to fullscreen, or restores from fullscreen if argument 'restore' is True
	`fullscreenToggle(self)` toggles fullscreen state
	`growDown(self, dh)` expand window dh pixels in height
	`growRight(self, dw)` expand window dw pixels to the right
	`kill(self)`
	`move(self, direction)` moves the window in the given direction in the current view - up, down, left or right
	`moveAbove(self)` Moves the window up in the column
	`moveBelow(self)` Moves the window down in the column
	`moveBottomLeft(self)` move window to bottom left of screen
	`moveBottomRight(self)` move window to bottom right of screen
	`moveBy(self, dx, dy)` move window by (dx, dy) pixels
	`moveDown(self, dy)` move window down by dx pixels
	`moveRight(self, dx)` move window to the right by dx pixels
	`moveToLeft(self)` Moves the window one column to the left
	`moveToNewTag(self, goThere)` moves this window to a new empty tag
	`moveToNextTag(self, goThere)` moves this window to previous tag
	`moveTopLeft(self)` move window to top left of screen
	`moveToPrevTag(self, goThere)` moves this window to previous tag
	`moveTopRight(self)` move window to top right of screen
	`moveToRight(self)` Moves the window one column to the right
	`moveToTag(self, tagid)` Move current window to given tag, or prompt for a tag if none given
	`tag(self, tagid)` adds a tag to this window (see 'untag')
	`tile(self)` puts the window into tile mode
	`untag(self, tagid)` removes a tag from this window (see 'tag')
Inherited from object
	`__delattr__(...)` x.__delattr__('name') <==> del x.name
	`__getattribute__(...)` x.__getattribute__('name') <==> x.name
	`__hash__(x)` x.__hash__() <==> hash(x)
	`__new__(T, S, ...)` T.__new__(S, ...) -> a new object with type S, a subtype of T
	`__reduce__(...)` helper for pickle
	`__reduce_ex__(...)` helper for pickle
	`__str__(x)` x.__str__() <==> str(x)

Property Summary
	`column`: Gets the id of the column in which this window is presently placed in the active view
	`geometry`: Gets/sets the client's geometry (x,y,w,h) on the current view
	`height`: Gets/sets the client's height on the current view
	`label`: Retrieves the label (titlebar text) of this window
	`position`: Gets/sets the client's position (x,y) on the current view
	`realid`: The real window id.
	`size`: Gets/sets the client's size (w,h) on the current view
	`tags`: Gets/sets the set of tags assigned to this window.
	`width`: Gets/sets the client's width on the current view
	`x`: Gets/sets the client's x position on the current view
	`y`: Gets/sets the client's y position on the current view

Method Details

init(self, wmii, id)
(Constructor)

Wraps a client window.

If instantiated with window id of 'sel', it will become a magic object that always refers to the currently selected window

Overrides:: __builtin__.object.__init__

repr(self)
(Representation operator)

return a sensible human-readable representation of client

Overrides:: __builtin__.object.__repr__

_get_class_(self)

returns the X 'class'

delFromTag(self, tagid=None)

removes client from given view (prompting if none)

float(self, tile=False)

toggles window between float and framed mode

floatToggle(self)

toggles the floating status of the window

fullscreenOff(self)

Turns fullscreen mode off

fullscreenOn(self, restore=False)

sets client to fullscreen, or restores from fullscreen if argument 'restore' is True

fullscreenToggle(self)

toggles fullscreen state

growDown(self, dh)

expand window dh pixels in height

growRight(self, dw)

expand window dw pixels to the right

move(self, direction)

moves the window in the given direction in the current view - up, down, left or right

moveAbove(self)

Moves the window up in the column

moveBelow(self)

Moves the window down in the column

moveBottomLeft(self)

move window to bottom left of screen

moveBottomRight(self)

move window to bottom right of screen

moveBy(self, dx, dy)

move window by (dx, dy) pixels

moveDown(self, dy)

move window down by dx pixels

moveRight(self, dx)

move window to the right by dx pixels

moveToLeft(self)

Moves the window one column to the left

moveToNewTag(self, goThere=False)

moves this window to a new empty tag

moveToNextTag(self, goThere=False)

moves this window to previous tag

moveTopLeft(self)

move window to top left of screen

moveToPrevTag(self, goThere=False)

moves this window to previous tag

moveTopRight(self)

move window to top right of screen

moveToRight(self)

Moves the window one column to the right

moveToTag(self, tagid=None)

Move current window to given tag, or prompt for a tag if none given

tag(self, tagid)

adds a tag to this window (see 'untag')

tile(self)

puts the window into tile mode

untag(self, tagid)

removes a tag from this window (see 'tag')

Property Details

column

Gets the id of the column in which this window is presently placed in the active view

geometry

Gets/sets the client's geometry (x,y,w,h) on the current view

height

Gets/sets the client's height on the current view

label

Retrieves the label (titlebar text) of this window

position

Gets/sets the client's position (x,y) on the current view

realid

The real window id. If this object was retrieved as the 'sel' attribute of the WMII instance, then the 'id' attribute will just be 'sel', meaning 'current window'. So the 'realid' attribute gives us a way to get the absolute window id

size

Gets/sets the client's size (w,h) on the current view

width

Gets/sets the client's width on the current view

x

Gets/sets the client's x position on the current view

y

Gets/sets the client's y position on the current view

Generated by Epydoc 2.1 on Tue Jun 12 22:49:29 2007

http://epydoc.sf.net