[svn-upgrade] Integrating new upstream version, ion3 (20070506)

[ion3.git] / ioncore / ioncore_tabnum.lua

diff --git a/ioncore/ioncore_tabnum.lua b/ioncore/ioncore_tabnum.lua
new file mode 100644 (file)
index 0000000..e9161b8
--- /dev/null
+++ b/ioncore/ioncore_tabnum.lua
@@ -0,0 +1,49 @@
+--
+-- ion/share/ioncore_tabnum.lua -- Ioncore tab numbering support
+-- 
+-- Copyright (c) Tuomo Valkonen 2007.
+--
+-- See the included file LICENSE for details.
+--
+
+ioncore.tabnum={}
+
+local framestate={}
+
+local function do_show(frame)
+    frame:set_grattr('numbered', 'set')
+    framestate[frame]='set'
+end
+
+--DOC
+-- Show tab numbers on \var{frame}, clearing them when submap
+-- grab is released the next time. If \var{delay} is given, in
+-- milliseconds, the numbers are not actually displayed until this
+-- time has passed.
+function ioncore.tabnum.show(frame, delay)
+    if delay and delay>0 then
+        local tmr=ioncore.create_timer()
+        framestate[frame]=tmr
+        tmr:set(delay, function() do_show(frame) end)
+    else
+        do_show(frame)
+    end
+end
+
+--DOC
+-- Clear all tab numbers set by \fnref{ioncore.tabnum.show}.
+function ioncore.tabnum.clear()
+    local st=framestate
+    framestate={}
+    
+    for f, s in pairs(st) do
+        if s=='set' then
+            f:set_grattr('numbered', 'unset')
+        elseif obj_is(s, "WTimer") then
+            s:reset()
+        end
+    end
+end
+
+ioncore.get_hook("ioncore_submap_ungrab_hook")
+    :add(ioncore.tabnum.clear)