summaryrefslogtreecommitdiff
path: root/luals-stubs/theme.lua
blob: 2956e8abe99321d7121775bd60d1052109c16445 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
-- SPDX-FileCopyrightText: 2023 jacqueline <me@jacqueline.id.au>
--
-- SPDX-License-Identifier: GPL-3.0-only

--- @meta

--- @class theme
local theme = {}

--- Loads a theme from a filename, this can be either builtin (ie, located in
--- "/lua/") or on the sdcard (in, '/sdcard/.themes/')
--- If successful, the filename will be saved to non-volatile storage.
--- Returns whether the theme was successfully loaded 
--- @param filename string
--- @return boolean
function theme.load_theme(filename) end

--- Sets a theme directly from a table. Does not persist between restarts. 
--- @param theme
function theme.set(theme) end

--- Set the subject (similar in concept to a css class) of an object. 
--- This will set any styles within the theme associated with that subject
--- on the given object
--- @param obj Object The object to set a particular style on
--- @param style string The name of the style to apply to this object
function theme.set_subject(obj, subject_name) end

--- Returns the filename of the saved theme
--- @return string 
function theme.theme_filename() end

return theme