add comments at the top for the functions

[chaz/openbox] / scripts / focus.py

diff --git a/scripts/focus.py b/scripts/focus.py
index 81d6c8d7227c88ebe07e887ef21b321ecc975f1e..d2e851132b9f16262300748952578179e57abdb7 100644 (file)
--- a/scripts/focus.py
+++ b/scripts/focus.py
@@ -10,10 +10,20 @@ cycle_raise = 1                                                         ###
 # raise as you cycle in stacked mode                                    ###
 stacked_cycle_raise = 0                                                 ###
 # show a pop-up list of windows while cycling                           ###
-cycle_popup_list = 1
+stacked_cycle_popup_list = 1                                            ###
 # send focus somewhere when nothing is left with the focus, if possible ###
 fallback = 0                                                            ###
 ###                                                                     ###
+###                                                                     ###
+# Provides:                                                             ###
+# def focus_next_stacked(data, forward=1):                              ###
+# def focus_prev_stacked(data):                                         ###
+# def focus_next(data, num=1, forward=1):                               ###
+# def focus_prev(data, num=1):                                          ###
+###                                                                     ###
+# All of these functions call be used as callbacks for bindings         ###
+# directly.                                                             ###
+###                                                                     ###
 ###########################################################################
 
 import otk
@@ -211,8 +221,8 @@ def focus_next_stacked(data, forward=1):
         _cyc_screen = data.screen
         _doing_stacked = 1
 
-        global cycle_popup_list
-        if cycle_popup_list:
+        global stacked_cycle_popup_list
+        if stacked_cycle_popup_list:
             _create_popup_list(data)
 
         ob.kgrab(data.screen, _focus_stacked_ungrab)