Fullscreen refactor (#9237)

Commonize fullscreen code across different devices. Add fullscreen toggle on SDL desktop targets. Expose the toggle to the dispatcher and map it to F11. Hide touchmenu when resizing.
2025-08-10 00:52:38 +00:00 · 2022-06-24 23:19:38 +02:00
parent 6fdb83017b
commit b7a27a3db3
12 changed files with 150 additions and 88 deletions
--- a/frontend/ui/elements/timeout_android.lua
+++ b/frontend/ui/elements/timeout_android.lua
@@ -0,0 +1,135 @@
+local isAndroid, android = pcall(require, "android")
+local ffi = require("ffi")
+local _ = require("gettext")
+local N_ = _.ngettext
+local T = require("ffi/util").template
+
+if not isAndroid then return end
+
+local system = ffi.C.AKEEP_SCREEN_ON_DISABLED
+local screenOn = ffi.C.AKEEP_SCREEN_ON_ENABLED
+local needs_wakelocks = android.needsWakelocks()
+
+-- custom timeouts (in milliseconds)
+local timeout_custom1 = 2 * 60 * 1000
+local timeout_custom2 = 5 * 60 * 1000
+local timeout_custom3 = 10 * 60 * 1000
+local timeout_custom4 = 15 * 60 * 1000
+local timeout_custom5 = 20 * 60 * 1000
+local timeout_custom6 = 25 * 60 * 1000
+local timeout_custom7 = 30 * 60 * 1000
+
+local function humanReadableTimeout(timeout)
+    local sec = timeout / 1000
+    if sec >= 60 then
+        return T(N_("1 minute", "%1 minutes", sec), sec / 60)
+    else
+        return T(N_("1 second", "%1 seconds", sec), sec)
+    end
+end
+
+local function canModifyTimeout(timeout)
+    if needs_wakelocks then return false end
+    if timeout == system or timeout == screenOn then
+        return true
+    else
+        return android.settings.hasPermission("settings")
+    end
+end
+
+local function timeoutEquals(timeout)
+    return timeout == android.timeout.get()
+end
+
+local function saveAndApplyTimeout(timeout)
+    G_reader_settings:saveSetting("android_screen_timeout", timeout)
+    android.timeout.set(timeout)
+end
+
+local function requestWriteSettings()
+    local text = _([[
+Allow KOReader to modify system settings?
+
+You will be prompted with a permission management screen. You'll need to give KOReader permission and then restart the program.]])
+
+    android.settings.requestPermission("settings", text, _("Allow"), _("Cancel"))
+end
+
+local TimeoutHelper = {}
+
+-- timeout menu table
+function TimeoutHelper:getTimeoutMenuTable()
+    local t = {
+            {
+                text = _("Use system settings"),
+                enabled_func = function() return canModifyTimeout(system) end,
+                checked_func = function() return timeoutEquals(system) end,
+                callback = function() saveAndApplyTimeout(system) end
+            },
+            {
+                text = humanReadableTimeout(timeout_custom1),
+                enabled_func = function() return canModifyTimeout(timeout_custom1) end,
+                checked_func = function() return timeoutEquals(timeout_custom1) end,
+                callback = function() saveAndApplyTimeout(timeout_custom1) end
+            },
+            {
+                text = humanReadableTimeout(timeout_custom2),
+                enabled_func = function() return canModifyTimeout(timeout_custom2) end,
+                checked_func = function() return timeoutEquals(timeout_custom2) end,
+                callback = function() saveAndApplyTimeout(timeout_custom2) end
+            },
+            {
+                text = humanReadableTimeout(timeout_custom3),
+                enabled_func = function() return canModifyTimeout(timeout_custom3) end,
+                checked_func = function() return timeoutEquals(timeout_custom3) end,
+                callback = function() saveAndApplyTimeout(timeout_custom3) end
+            },
+            {
+                text = humanReadableTimeout(timeout_custom4),
+                enabled_func = function() return canModifyTimeout(timeout_custom4) end,
+                checked_func = function() return timeoutEquals(timeout_custom4) end,
+                callback = function() saveAndApplyTimeout(timeout_custom4) end
+            },
+            {
+                text = humanReadableTimeout(timeout_custom5),
+                enabled_func = function() return canModifyTimeout(timeout_custom5) end,
+                checked_func = function() return timeoutEquals(timeout_custom5) end,
+                callback = function() saveAndApplyTimeout(timeout_custom5) end
+            },
+            {
+                text = humanReadableTimeout(timeout_custom6),
+                enabled_func = function() return canModifyTimeout(timeout_custom6) end,
+                checked_func = function() return timeoutEquals(timeout_custom6) end,
+                callback = function() saveAndApplyTimeout(timeout_custom6) end
+            },
+            {
+                text = humanReadableTimeout(timeout_custom7),
+                enabled_func = function() return canModifyTimeout(timeout_custom7) end,
+                checked_func = function() return timeoutEquals(timeout_custom7) end,
+                callback = function() saveAndApplyTimeout(timeout_custom7) end
+            },
+            {
+                text = _("Keep screen on"),
+                enabled_func = function() return canModifyTimeout(screenOn) end,
+                checked_func = function() return timeoutEquals(screenOn) end,
+                callback = function() saveAndApplyTimeout(screenOn) end
+            },
+        }
+
+    if not android.settings.hasPermission("settings") then
+        table.insert(t, 1, {
+            text = _("Allow system settings override"),
+            enabled_func = function() return not android.settings.hasPermission("settings") end,
+            checked_func = function() return android.settings.hasPermission("settings") end,
+            callback = function() requestWriteSettings() end,
+            separator = true,
+        })
+    end
+
+    return {
+        text = _("Screen Timeout"),
+        sub_item_table = t
+    }
+end
+
+return TimeoutHelper