YimMenu/docs/lua/classes/checkbox.md

# Class: checkbox

## Inherit from 1 class: base_text_element

Class representing a gui checkbox.

## Functions (2)

### `is_enabled()`

- **Returns:**
  - `boolean`: Is the checkbox checked?

**Example Usage:**
```lua
boolean = checkbox:is_enabled()
```

### `set_enabled(enabled)`

- **Parameters:**
  - `enabled` (boolean): The desired enabled state of the checkbox.

**Example Usage:**
```lua
checkbox:set_enabled(enabled)
```
Lua doc (#1552) 2023-07-02 00:59:02 +02:00			`# Class: checkbox`

			`## Inherit from 1 class: base_text_element`

			`Class representing a gui checkbox.`

			`## Functions (2)`

			### `is_enabled()`

			`- Returns:`
			- `boolean`: Is the checkbox checked?

Lua: can make new tabs from lua scripts, doc generation for available tabs to use (#1593) * lua api: add globals.get_uint and globals.set_uint * lua doc: remove duplicate function check as we can overload so it doesn't make sense * lua doc gen: add support for parsing the tabs enum * gui: custom lua tabs don't have a `func` rendering function but can still have elements to draw * lua doc: update generated doc * chore: code style * chore: minor spelling mistake * chore: code style * gui_service: add runtime removal of tabs * refactor: make it so that it's less likely defining tabs and their translation key in a wrong way. * lua api: ability to add custom tabs to the gui from lua 2023-07-05 00:30:57 +02:00			`Example Usage:`
Lua doc (#1552) 2023-07-02 00:59:02 +02:00			```lua
			`boolean = checkbox:is_enabled()`
			```

			### `set_enabled(enabled)`

			`- Parameters:`
			- `enabled` (boolean): The desired enabled state of the checkbox.

Lua: can make new tabs from lua scripts, doc generation for available tabs to use (#1593) * lua api: add globals.get_uint and globals.set_uint * lua doc: remove duplicate function check as we can overload so it doesn't make sense * lua doc gen: add support for parsing the tabs enum * gui: custom lua tabs don't have a `func` rendering function but can still have elements to draw * lua doc: update generated doc * chore: code style * chore: minor spelling mistake * chore: code style * gui_service: add runtime removal of tabs * refactor: make it so that it's less likely defining tabs and their translation key in a wrong way. * lua api: ability to add custom tabs to the gui from lua 2023-07-05 00:30:57 +02:00			`Example Usage:`
Lua doc (#1552) 2023-07-02 00:59:02 +02:00			```lua
			`checkbox:set_enabled(enabled)`
			```