diff options
| author | Dana Jansens <danakj@orodu.net> | 2003-01-31 23:54:05 +0000 |
|---|---|---|
| committer | Dana Jansens <danakj@orodu.net> | 2003-01-31 23:54:05 +0000 |
| commit | d11291df3e9ef0173139a97bf6c77471ab3a4119 (patch) | |
| tree | 48f1cf13bb3e397e43457ed48d25b284b2b3395c /scripts/callbacks.py | |
| parent | 785957de805156d8f1a35e1e4e02473af9539062 (diff) | |
doc the state functions better
Diffstat (limited to 'scripts/callbacks.py')
| -rw-r--r-- | scripts/callbacks.py | 20 |
1 files changed, 15 insertions, 5 deletions
diff --git a/scripts/callbacks.py b/scripts/callbacks.py index 0478e079..91f005a1 100644 --- a/scripts/callbacks.py +++ b/scripts/callbacks.py @@ -11,35 +11,45 @@ import ob import otk def state_above(data, add=2): - """Toggles, adds or removes the 'above' state on a window.""" + """Toggles, adds or removes the 'above' state on a window. + The second paramater should one of: 0 - removes the state, 1 - adds the + state, 2 - toggles the state.""" if not data.client: return ob.send_client_msg(otk.display.screenInfo(data.screen).rootWindow(), otk.Property_atoms().net_wm_state, data.client.window(), add, otk.Property_atoms().net_wm_state_above) def state_below(data, add=2): - """Toggles, adds or removes the 'below' state on a window.""" + """Toggles, adds or removes the 'below' state on a window. + The second paramater should one of: 0 - removes the state, 1 - adds the + state, 2 - toggles the state.""" if not data.client: return ob.send_client_msg(otk.display.screenInfo(data.screen).rootWindow(), otk.Property_atoms().net_wm_state, data.client.window(), add, otk.Property_atoms().net_wm_state_below) def state_shaded(data, add=2): - """Toggles, adds or removes the 'shaded' state on a window.""" + """Toggles, adds or removes the 'shaded' state on a window. + The second paramater should one of: 0 - removes the state, 1 - adds the + state, 2 - toggles the state.""" if not data.client: return ob.send_client_msg(otk.display.screenInfo(data.screen).rootWindow(), otk.Property_atoms().net_wm_state, data.client.window(), add, otk.Property_atoms().net_wm_state_shaded) def state_skip_taskbar(data, add=2): - """Toggles, adds or removes the 'skip_taskbar' state on a window.""" + """Toggles, adds or removes the 'skip_taskbar' state on a window. + The second paramater should one of: 0 - removes the state, 1 - adds the + state, 2 - toggles the state.""" if not data.client: return ob.send_client_msg(otk.display.screenInfo(data.screen).rootWindow(), otk.Property_atoms().net_wm_state, data.client.window(), add, otk.Property_atoms().net_wm_state_skip_taskbar) def state_skip_pager(data, add=2): - """Toggles, adds or removes the 'skip_pager' state on a window.""" + """Toggles, adds or removes the 'skip_pager' state on a window. + The second paramater should one of: 0 - removes the state, 1 - adds the + state, 2 - toggles the state.""" if not data.client: return ob.send_client_msg(otk.display.screenInfo(data.screen).rootWindow(), otk.Property_atoms().net_wm_state, data.client.window(), |