X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=theme.rst;h=04146e8fce0003e701d66566419fb4ec869bf65d;hb=cfd8d011eac9326dfd77d13170e628c087b35a1e;hp=72da4bcfb65c549c023dd38eaf13afb48964d2fc;hpb=826c5e117b2746ca665fdd10d4685beed78d367a;p=nageru-docs diff --git a/theme.rst b/theme.rst index 72da4bc..04146e8 100644 --- a/theme.rst +++ b/theme.rst @@ -345,3 +345,42 @@ so if you update the file on-disk, it will be available in Nageru without a restart. (If the file contains an error, the update will be ignored.) This allows you to e.g. have simple message overlays that you can change without restarting Nageru. + + +.. _menus: + +Theme menus +----------- + +Complicated themes, especially those dealing with :doc:`HTML inputs `, +may have needs for user control that go beyond those of transition buttons. +(An obvious example may be “reload the HTML file”.) For this reason, +themes can also set simple *theme menus*, which are always visible +no matter what inputs are chosen. + +If a theme chooses to set a theme menu, it will be available on the +main menu bar under “Theme”; if not, it will be hidden. You can set +the menu at startup or at any other point, using a simple series of +labels and function references:: + + function modify_aspect() + -- Your code goes here. + end + + function reload_html() + html_input:reload() + end + + ThemeMenu.set( + { "Change &aspect", modify_aspect }, + { "&Reload overlay", reload_html } + ) + +When the user chooses a menu entry, the given Lua function will +automatically be called. There are no arguments nor return values. + +There currently is no support for checkboxes, submenus, input boxes +or the likes. However, do note that since the theme is written in unrestricted +Lua, so you can use e.g. `lua-http `_ +to listen for external connections and accept more complicated inputs +from those.