summaryrefslogtreecommitdiff
path: root/ldoc-stubs/backstack.lua
blob: d4807d37ca81320a93154d4becd6ee939d9402ab (plain)
1
2
3
4
5
6
7
8
9
10
11
12
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