--
-- ion/share/ioncore_tabnum.lua -- Ioncore tab numbering support
-- 
-- Copyright (c) Tuomo Valkonen 2007-2009.
--
-- See the included file LICENSE for details.
--

ioncore.tabnum={}

local framestate={}

local function do_show(frame)
    if obj_exists(frame) then
        frame:set_grattr('numbered', 'set')
        framestate[frame]='set'
    else
        framestate[frame]=nil
    end
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
            if obj_exists(f) then
                f:set_grattr('numbered', 'unset')
            end
        elseif obj_is(s, "WTimer") then
            s:reset()
        end
    end
end

ioncore.get_hook("ioncore_submap_ungrab_hook")
    :add(ioncore.tabnum.clear)