mirror of
https://github.com/Insality/druid.git
synced 2025-06-27 10:27:47 +02:00
98 lines
2.5 KiB
Lua
Executable File
98 lines
2.5 KiB
Lua
Executable File
-- Copyright (c) 2021 Maksim Tuprikov <insality@gmail.com>. This code is licensed under MIT license
|
|
|
|
--- Druid checkbox component
|
|
--
|
|
-- <a href="https://insality.github.io/druid/druid/index.html?example=general_checkboxes" target="_blank"><b>Example Link</b></a>
|
|
-- @module Checkbox
|
|
-- @within BaseComponent
|
|
-- @alias druid.checkbox
|
|
|
|
--- On change state callback(self, state)
|
|
-- @tfield DruidEvent on_change_state @{DruidEvent}
|
|
|
|
--- Visual node
|
|
-- @tfield node node
|
|
|
|
--- Button trigger node
|
|
-- @tfield node|nil click_node
|
|
|
|
--- Button component from click_node
|
|
-- @tfield Button button @{Button}
|
|
|
|
---
|
|
|
|
local Event = require("druid.event")
|
|
local component = require("druid.component")
|
|
|
|
local Checkbox = component.create("checkbox")
|
|
|
|
|
|
local function on_click(self)
|
|
self:set_state(not self.state)
|
|
end
|
|
|
|
|
|
--- Component style params.
|
|
-- You can override this component styles params in druid styles table
|
|
-- or create your own style
|
|
-- @table style
|
|
-- @tfield function on_change_state (self, node, state)
|
|
function Checkbox.on_style_change(self, style)
|
|
self.style = {}
|
|
|
|
self.style.on_change_state = style.on_change_state or function(_, node, state)
|
|
gui.set_enabled(node, state)
|
|
end
|
|
end
|
|
|
|
|
|
--- The @{Checkbox} constructor
|
|
-- @tparam Checkbox self @{Checkbox}
|
|
-- @tparam node node Gui node
|
|
-- @tparam function callback Checkbox callback
|
|
-- @tparam node|nil click_node Trigger node, by default equals to node. Default: node
|
|
-- @tparam boolean|nil initial_state The initial state of checkbox, default - false
|
|
function Checkbox.init(self, node, callback, click_node, initial_state)
|
|
self.druid = self:get_druid()
|
|
self.node = self:get_node(node)
|
|
self.click_node = self:get_node(click_node or node)
|
|
|
|
self.button = self.druid:new_button(self.click_node or self.node, on_click)
|
|
self:set_state(initial_state, true, true)
|
|
|
|
self.on_change_state = Event(callback)
|
|
end
|
|
|
|
|
|
function Checkbox.on_layout_change(self)
|
|
self:set_state(self.state, true)
|
|
end
|
|
|
|
|
|
--- Set checkbox state
|
|
-- @tparam Checkbox self @{Checkbox}
|
|
-- @tparam boolean|nil state Checkbox state
|
|
-- @tparam boolean|nil is_silent Don't trigger on_change_state if true
|
|
-- @tparam boolean|nil is_instant If instant checkbox change
|
|
function Checkbox.set_state(self, state, is_silent, is_instant)
|
|
self.state = state
|
|
self.style.on_change_state(self, self.node, state, is_instant)
|
|
|
|
if not is_silent then
|
|
self.on_change_state:trigger(self:get_context(), state)
|
|
end
|
|
|
|
return self
|
|
end
|
|
|
|
|
|
--- Return checkbox state
|
|
-- @tparam Checkbox self @{Checkbox}
|
|
-- @treturn boolean Checkbox state
|
|
function Checkbox.get_state(self)
|
|
return self.state
|
|
end
|
|
|
|
|
|
return Checkbox
|