plugins.settings
local settings = require "plugins.settings"
config
(field) config: table
core
(field) core: table
default_keybindings
(field) default_keybindings: table
plugin_sections
(field) plugin_sections: table
plugins
(field) plugins: table
sections
(field) sections: table
type
(field) type: table<string, integer>
Enumeration for the different types of settings.
ui
(field) ui: settings.ui
settings.option
Represents a setting to render on a settings pane.
default
(field) default: boolean|string|number|table<integer, integer>|table<integer, string>
Default value of the option
description
(field) description: string
Description of the option eg: "Modifies the document indentation"
exists
(field) exists: boolean
filters
(field) filters: table<integer, string>
Lua patterns used on FILE or DIRECTORY to filter browser results and also force the selection to match one of the filters.
font_error
(field) font_error: boolean
Flag set to true when loading user defined fonts fail
fonts_list
(field) fonts_list: table<string, renderer.font>
Optionally used for FONT to store the generated font group.
get_value
(field) get_value: fun(value: any):any|nil
Optional function that is used to manipulate the current value on retrieval.
icon
(field) icon: string
The icon set for a BUTTON
label
(field) label: string
Title displayed to the user eg: "My Option"
max
(field) max: number
Used for NUMBER to indiciate the maximum number allowed
min
(field) min: number
Used for NUMBER to indicate the minimum number allowed
on_apply
(field) on_apply: fun(value: any)|nil
on_click
(field) on_click: string|fun(button: string, x: integer, y: integer)|nil
Command or function executed when a BUTTON is clicked
path
(field) path: string
Config path in the config table, eg: section.myoption, myoption, etc...
set_value
(field) set_value: fun(value: any):any|nil
Optional function that is used to manipulate the saved value on save.
step
(field) step: number
Used for NUMBER to indiciate the increment/decrement amount
type
(field) type: integer|`settings.type.BUTTON`|`settings.type.COLOR`|`settings.type.DIRECTORY`|`settings.type.FILE`...(+6)
Type of option that will be used to render an appropriate control
values
(field) values: table
Used in a SELECTION to provide the list of valid options
settings.ui
NEWLINE
(field) NEWLINE: integer
Indicates on a widget.styledtext that a new line follows.
__index
(field) __index: core.object
about
(field) about: widget
A base widget
animations
(field) animations: widget.animation[]
background_color
(field) background_color: renderer.color
Array of bytes that represents a color used by the rendering functions.
border
(field) border: widget.border
Represents the border of a widget.
captured_widget
(field) captured_widget: widget
Widget that captured mouse events
child_active
(field) child_active: widget|nil
A base widget
childs
(field) childs: table<integer, widget>
clickable
(field) clickable: boolean
colors
(field) colors: widget
A base widget
context
(field) context: 'application'|'session'
core
(field) core: widget
A base widget
core_sections
(field) core_sections: widget.foldingbook
current_scale
(field) current_scale: number
cursor
(field) cursor: 'arrow'|'hand'|'ibeam'|'sizeh'|'sizev'
defer_draw
(field) defer_draw: boolean
draggable
(field) draggable: boolean
dragged
(field) dragged: boolean
explicit_update
(field) explicit_update: boolean
font
(field) font: string|renderer.font|widget.fontreference
Represents a reference to a font stored elsewhere.
force_events
(field) force_events: table
foreground_color
(field) foreground_color: renderer.color
Array of bytes that represents a color used by the rendering functions.
h_scrollbar
(field) h_scrollbar: widget.scrollbar
has_focus
(field) has_focus: boolean
hovered_scrollbar
(field) hovered_scrollbar: boolean
input_text
(field) input_text: boolean
is_scrolling
(field) is_scrolling: boolean
keybinds
(field) keybinds: widget
A base widget
label
(field) label: string|table<integer, string|integer|renderer.color|renderer.font|widget.fontreference>
mouse
(field) mouse: widget.position
Represents the position of a widget.
mouse_is_hovering
(field) mouse_is_hovering: boolean
mouse_is_pressed
(field) mouse_is_pressed: boolean
mouse_pressed_outside
(field) mouse_pressed_outside: boolean
name
(field) name: string
next_zindex
(field) next_zindex: integer
notebook
(field) notebook: widget.notebook
parent
(field) parent: widget|nil
A base widget
perform_update_size_position
(field) perform_update_size_position: boolean
plugin_sections
(field) plugin_sections: widget.foldingbook
plugins
(field) plugins: widget
A base widget
position
(field) position: widget.position
Represents the position of a widget.