Module Checkbox

Druid checkbox component

Functions

init(self, node, callback[, click_node=node[, initial_state=false]]) Component init function
set_state(self, state, is_silent, is_instant) Set checkbox state
get_state(self) Return checkbox state

Tables

style Component style params.

Fields

on_change_state On change state callback(self, state)
node Visual node
click_node Button trigger node
button Button component from click_node


Functions

init(self, node, callback[, click_node=node[, initial_state=false]])
Component init function

Parameters:

  • self Checkbox
  • node node Gui node
  • callback function Checkbox callback
  • click_node node Trigger node, by default equals to node (default node)
  • initial_state boolean The initial state of checkbox, default - false (default false)
set_state(self, state, is_silent, is_instant)
Set checkbox state

Parameters:

  • self Checkbox
  • state bool Checkbox state
  • is_silent bool Don't trigger on_change_state if true
  • is_instant bool If instant checkbox change
get_state(self)
Return checkbox state

Parameters:

  • self Checkbox

Returns:

    bool Checkbox state

Tables

style
Component style params. You can override this component styles params in druid styles table or create your own style

Fields:

  • on_change_state function (self, node, state)

Fields

on_change_state
On change state callback(self, state)
  • on_change_state druid_event
node
Visual node
click_node
Button trigger node
  • click_node node (default node)
button
Button component from click_node
  • button Button
generated by LDoc 1.4.6 Last updated 2022-02-12 17:16:44