-- Multi-Pane Display Graphics Element

local element = require("graphics.element")

---@class multipane_args
---@field panes table panes to swap between
---@field parent graphics_element
---@field id? string element id
---@field x? integer 1 if omitted
---@field y? integer auto incremented if omitted
---@field width? integer parent width if omitted
---@field height? integer parent height if omitted
---@field gframe? graphics_frame frame instead of x/y/width/height
---@field fg_bg? cpair foreground/background colors
---@field hidden? boolean true to hide on initial draw

-- new multipane element
---@nodiscard
---@param args multipane_args
---@return graphics_element element, element_id id
local function multipane(args)
    assert(type(args.panes) == "table", "graphics.elements.multipane: panes is a required field")

    -- create new graphics element base object
    local e = element.new(args)

    -- select which pane is shown
    ---@param value integer pane to show
    function e.set_value(value)
        if (e.value ~= value) and (value > 0) and (value <= #args.panes) then
            e.value = value

            for i = 1, #args.panes do args.panes[i].hide() end
            args.panes[value].show()
        end
    end

    e.set_value(1)

    return e.complete()
end

return multipane