cc-mek-scada/graphics/elements/controls/checkbox.lua

-- Checkbox Graphics Element

local core    = require("graphics.core")
local element = require("graphics.element")

---@class checkbox_args
---@field label string checkbox text
---@field box_fg_bg cpair colors for checkbox
---@field callback? function function to call on press
---@field parent graphics_element
---@field id? string element id
---@field x? integer 1 if omitted
---@field y? integer auto incremented if omitted
---@field fg_bg? cpair foreground/background colors
---@field hidden? boolean true to hide on initial draw

-- new checkbox control
---@param args checkbox_args
---@return graphics_element element, element_id id
local function checkbox(args)
    assert(type(args.label) == "string", "graphics.elements.controls.checkbox: label is a required field")
    assert(type(args.box_fg_bg) == "table", "graphics.elements.controls.checkbox: box_fg_bg is a required field")

    args.can_focus = true
    args.height = 1
    args.width = 3 + string.len(args.label)

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

    e.value = false

    -- show the button state
    local function draw()
        e.w_set_cur(1, 1)

        if e.value then
            -- show as selected
            e.w_set_fgd(args.box_fg_bg.bkg)
            e.w_set_bkg(args.box_fg_bg.fgd)
            e.w_write("\x88")
            e.w_set_fgd(args.box_fg_bg.fgd)
            e.w_set_bkg(e.fg_bg.bkg)
            e.w_write("\x95")
        else
            -- show as unselected
            e.w_set_fgd(e.fg_bg.bkg)
            e.w_set_bkg(args.box_fg_bg.bkg)
            e.w_write("\x88")
            e.w_set_fgd(args.box_fg_bg.bkg)
            e.w_set_bkg(e.fg_bg.bkg)
            e.w_write("\x95")
        end
    end

    -- write label text
    local function draw_label()
        if e.enabled and e.is_focused() then
            e.w_set_cur(3, 1)
            e.w_set_fgd(e.fg_bg.bkg)
            e.w_set_bkg(e.fg_bg.fgd)
            e.w_write(args.label)
        else
            e.w_set_cur(3, 1)
            e.w_set_fgd(e.fg_bg.fgd)
            e.w_set_bkg(e.fg_bg.bkg)
            e.w_write(args.label)
        end
    end

    -- handle mouse interaction
    ---@param event mouse_interaction mouse event
    function e.handle_mouse(event)
        if e.enabled and core.events.was_clicked(event.type) and e.in_frame_bounds(event.current.x, event.current.y) then
            e.value = not e.value
            draw()
            if type(args.callback) == "function" then args.callback(e.value) end
        end
    end

    -- handle keyboard interaction
    ---@param event key_interaction key event
    function e.handle_key(event)
        if event.type == core.events.KEY_CLICK.DOWN then
            if event.key == keys.space or event.key == keys.enter or event.key == keys.numPadEnter then
                e.value = not e.value
                draw()
                if type(args.callback) == "function" then args.callback(e.value) end
            end
        end
    end

    -- set the value
    ---@param val integer new value
    function e.set_value(val)
        e.value = val
        draw()
    end

    -- handle focus
    e.on_focused = draw_label
    e.on_unfocused = draw_label

    -- handle enable
    e.on_enabled = draw_label
    e.on_disabled = draw_label

    -- initial draw
    draw()
    draw_label()

    return e.complete()
end

return checkbox