X-Git-Url: https://git.dogcows.com/gitweb?a=blobdiff_plain;f=scripts%2Fcallbacks.py;h=7ff673550cfb9cffe2f1139d065a36ecd97e6f7b;hb=4a79f7c4390b420a0993a0f3059924c3839cd445;hp=0478e079a8954e0d024e42c0ec08612f4453c0ff;hpb=2d6698683a3db220dc698d1c6aa1c89502b227cc;p=chaz%2Fopenbox

diff --git a/scripts/callbacks.py b/scripts/callbacks.py
index 0478e079..7ff67355 100644
--- a/scripts/callbacks.py
+++ b/scripts/callbacks.py
@@ -2,44 +2,49 @@
 ### Functions that can be used as callbacks for mouse/keyboard bindings  ###
 ############################################################################
 
-#############################################################################
-### Options that can be modified to change the default hooks' behaviors.  ###
-###                                                                       ###
-#############################################################################
-
 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(),