#84 improved element creation process for adding children

graphics/elements/indicators/data.lua

@@ -35,6 +35,7 @@ end
 ---@field lu_colors? cpair label foreground color (a), unit foreground color (b)
 ---@field value any default value
 ---@field parent graphics_element
+---@field id? string element id
 ---@field x? integer 1 if omitted
 ---@field y? integer 1 if omitted
 ---@field width integer length
@@ -42,6 +43,7 @@ end
 
 -- new data indicator
 ---@param args data_indicator_args
+---@return graphics_element element, element_id id
 local function data(args)
     assert(type(args.label) == "string", "graphics.elements.indicators.data: label is a required field")
     assert(type(args.format) == "string", "graphics.elements.indicators.data: format is a required field")
@@ -91,7 +93,7 @@ local function data(args)
     -- initial value draw
     e.on_update(args.value)
 
-    return e.get()
+    return e.complete()
 end
 
 return data

graphics/elements/indicators/hbar.lua

@@ -8,6 +8,7 @@ local element = require("graphics.element")
 ---@field show_percent? boolean whether or not to show the percent
 ---@field bar_fg_bg? cpair bar foreground/background colors if showing percent
 ---@field parent graphics_element
+---@field id? string element id
 ---@field x? integer 1 if omitted
 ---@field y? integer 1 if omitted
 ---@field width? integer parent width if omitted
@@ -17,6 +18,8 @@ local element = require("graphics.element")
 
 -- new horizontal bar
 ---@param args hbar_args
+---@return graphics_element element, element_id id
+---@return graphics_element element, element_id id
 local function hbar(args)
     -- properties/state
     local last_num_bars = -1
@@ -96,7 +99,7 @@ local function hbar(args)
     -- initialize to 0
     e.on_update(0)
 
-    return e.get()
+    return e.complete()
 end
 
 return hbar

graphics/elements/indicators/icon.lua

@@ -14,12 +14,14 @@ local element = require("graphics.element")
 ---@field value? integer default state, defaults to 1
 ---@field min_label_width? integer label length if omitted
 ---@field parent graphics_element
+---@field id? string element id
 ---@field x? integer 1 if omitted
 ---@field y? integer 1 if omitted
 ---@field fg_bg? cpair foreground/background colors
 
 -- new icon indicator
 ---@param args icon_indicator_args
+---@return graphics_element element, element_id id
 local function icon(args)
     assert(type(args.label) == "string", "graphics.elements.indicators.icon: label is a required field")
     assert(type(args.states) == "table", "graphics.elements.indicators.icon: states is a required field")
@@ -60,7 +62,7 @@ local function icon(args)
     -- initial icon draw
     e.on_update(args.value or 1)
 
-    return e.get()
+    return e.complete()
 end
 
 return icon

graphics/elements/indicators/light.lua

@@ -9,12 +9,14 @@ local element = require("graphics.element")
 ---@field colors cpair on/off colors (a/b respectively)
 ---@field min_label_width? integer label length if omitted
 ---@field parent graphics_element
+---@field id? string element id
 ---@field x? integer 1 if omitted
 ---@field y? integer 1 if omitted
 ---@field fg_bg? cpair foreground/background colors
 
 -- new indicator light
 ---@param args indicator_light_args
+---@return graphics_element element, element_id id
 local function indicator_light(args)
     assert(type(args.label) == "string", "graphics.elements.indicators.light: label is a required field")
     assert(type(args.colors) == "table", "graphics.elements.indicators.light: colors is a required field")
@@ -43,7 +45,7 @@ local function indicator_light(args)
     e.on_update(false)
     e.window.write(args.label)
 
-    return e.get()
+    return e.complete()
 end
 
 return indicator_light

graphics/elements/indicators/state.lua

@@ -13,6 +13,7 @@ local element = require("graphics.element")
 ---@field value? integer default state, defaults to 1
 ---@field min_width? integer max state text length if omitted
 ---@field parent graphics_element
+---@field id? string element id
 ---@field x? integer 1 if omitted
 ---@field y? integer 1 if omitted
 ---@field height? integer 1 if omitted, must be an odd number
@@ -20,6 +21,7 @@ local element = require("graphics.element")
 
 -- new state indicator
 ---@param args state_indicator_args
+---@return graphics_element element, element_id id
 local function state_indicator(args)
     assert(type(args.states) == "table", "graphics.elements.indicators.state: states is a required field")
 
@@ -70,7 +72,7 @@ local function state_indicator(args)
     -- initial draw
     e.on_update(args.value or 1)
 
-    return e.get()
+    return e.complete()
 end
 
 return state_indicator

graphics/elements/indicators/vbar.lua

@@ -6,6 +6,7 @@ local element = require("graphics.element")
 
 ---@class vbar_args
 ---@field parent graphics_element
+---@field id? string element id
 ---@field x? integer 1 if omitted
 ---@field y? integer 1 if omitted
 ---@field width? integer parent width if omitted
@@ -15,6 +16,7 @@ local element = require("graphics.element")
 
 -- new vertical bar
 ---@param args vbar_args
+---@return graphics_element element, element_id id
 local function vbar(args)
     -- properties/state
     local last_num_bars = -1
@@ -76,7 +78,7 @@ local function vbar(args)
         end
     end
 
-    return e.get()
+    return e.complete()
 end
 
 return vbar