diff options
| author | jacqueline <me@jacqueline.id.au> | 2024-01-05 17:15:47 +1100 |
|---|---|---|
| committer | jacqueline <me@jacqueline.id.au> | 2024-01-05 17:15:47 +1100 |
| commit | e12a68a74d9527d4becde122da4ff1ad6550564e (patch) | |
| tree | 1d987e513efe693bc48817acbc0e89d7db044828 /ldoc-stubs/backstack.lua | |
| parent | aa1dd3d522aa60c2e8ec31ccc49b3459b4f0f8e2 (diff) | |
| download | tangara-fw-e12a68a74d9527d4becde122da4ff1ad6550564e.tar.gz | |
split lua stubs into one set for ldoc, and one set for lua-ls
Diffstat (limited to 'ldoc-stubs/backstack.lua')
| -rw-r--r-- | ldoc-stubs/backstack.lua | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/ldoc-stubs/backstack.lua b/ldoc-stubs/backstack.lua new file mode 100644 index 00000000..d4807d37 --- /dev/null +++ b/ldoc-stubs/backstack.lua @@ -0,0 +1,13 @@ +--- Module for adding and removing screens from the system's backstack. +-- @module backstack + +local backstack = {} + +--- Pushes a new screen onto the backstack. +-- @tparam function constructor Called to create the UI for the new screen. A new default root object and group will be set before calling this function. The function provided should return a table holding any bindings used by this screen; the returned value is retained so long as this screen is present in the backstack. +function backstack.push(constructor) end + +--- Removes the currently active screen, and instead shows the screen underneath it on the backstack. Does nothing if this is the only existing screen. +function backstack.pop() end + +return backstack |
