diff options
| author | ailurux <ailuruxx@gmail.com> | 2024-03-20 13:42:03 +1100 |
|---|---|---|
| committer | ailurux <ailuruxx@gmail.com> | 2024-03-20 13:42:03 +1100 |
| commit | 51dfb5b3e30caf823c2355ff957c01864f35f9f6 (patch) | |
| tree | 1f0e41397259c6e206aba136ad5070b9de30e1b1 /luals-stubs/backstack.lua | |
| parent | 170c23b832eed6dad2b118e50164464cc93e5c4c (diff) | |
| parent | a05d93a1e26181237a76da5ce398c6b08497d591 (diff) | |
| download | tangara-fw-51dfb5b3e30caf823c2355ff957c01864f35f9f6.tar.gz | |
Merge branch 'main' into themes
Diffstat (limited to 'luals-stubs/backstack.lua')
| -rw-r--r-- | luals-stubs/backstack.lua | 13 |
1 files changed, 11 insertions, 2 deletions
diff --git a/luals-stubs/backstack.lua b/luals-stubs/backstack.lua index 2e4eccb3..b39fcbf2 100644 --- a/luals-stubs/backstack.lua +++ b/luals-stubs/backstack.lua @@ -1,11 +1,20 @@ --- @meta +--- The `backstack` module contains functions that can be used to implement a +--- basic stack-based navigation hierarchy. See also the `screen` module, which +--- provides a class prototype meant for use with this module. --- @class backstack local backstack = {} ---- @param constructor function -function backstack.push(constructor) end +--- Displays the given screen to the user. If there was already a screen being +--- displayed, then the current screen is removed from the display, and added +--- to the backstack. +--- @param screen screen The screen to display. +function backstack.push(screen) end +--- Removes the current screen from the display, then replaces it with the +--- screen that is at the top of the backstack. This function does nothing if +--- there are no other screens in the stack. function backstack.pop() end return backstack |