doc the state functions better

[chaz/openbox] / scripts / callbacks.py

diff --git a/scripts/callbacks.py b/scripts/callbacks.py
index 0478e079a8954e0d024e42c0ec08612f4453c0ff..91f005a12b6924745ec72a75f08bb6ed9f9b1fbe 100644 (file)
--- 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(),