renun/koreader
1
0
Fork 0
mirror of https://github.com/koreader/koreader.git synced 2025-08-10 00:52:38 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Refresh AltStatusBar once a minute, if there are changes

Browse Source
This commit is contained in:
zwim
2021-01-29 18:39:08 +01:00
committed by poire-z
parent 49e2d91afb
commit 3118d0dba0
4 changed files with 150 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

167
frontend/apps/reader/modules/readercoptlistener.lua
View File

@@ -1,8 +1,10 @@
local Event = require("ui/event")
local Device = require("device")
local EventListener = require("ui/widget/eventlistener")
local Geom = require("ui/geometry")
local InfoMessage = require("ui/widget/infomessage")
local UIManager = require("ui/uimanager")
local logger = require("logger")
local T = require("ffi/util").template
local _ = require("gettext")
@@ -22,6 +24,7 @@ function ReaderCoptListener:onReadSettings(config)
-- crengine top status bar can only show author and title together
self.title = G_reader_settings:readSetting("cre_header_title") or 1
self.clock = G_reader_settings:readSetting("cre_header_clock") or 1
self.header_auto_refresh = G_reader_settings:readSetting("cre_header_auto_refresh") or 1
self.page_number = G_reader_settings:readSetting("cre_header_page_number") or 1
self.page_count = G_reader_settings:readSetting("cre_header_page_count") or 1
self.reading_percent = G_reader_settings:readSetting("cre_header_reading_percent") or 0
@@ -43,6 +46,20 @@ function ReaderCoptListener:onReadSettings(config)
-- Enable or disable crengine header status line (note that for crengine, 0=header enabled, 1=header disabled)
local status_line = config:readSetting("copt_status_line") or G_reader_settings:readSetting("copt_status_line") or 1
self.ui:handleEvent(Event:new("SetStatusLine", status_line))
self.old_battery_level = Device:getPowerDevice():getCapacity()
-- Have this ready in case auto-refresh is enabled, now or later
self.headerRefresh = function()
-- Only draw it if something has changed
local new_battery_level = Device:getPowerDevice():getCapacity()
if self.clock == 1 or (self.battery == 1 and new_battery_level ~= self.old_battery_level) then
self.old_battery_level = new_battery_level
self:updateHeader()
end
self:rescheduleHeaderRefreshIfNeeded() -- schedule (or not) next refresh
end
self:rescheduleHeaderRefreshIfNeeded() -- schedule (or not) first refresh
end
function ReaderCoptListener:onSetFontSize(font_size)
@@ -53,10 +70,65 @@ function ReaderCoptListener:onTimeFormatChanged()
self.ui.document._document:setIntProperty("window.status.clock.12hours", G_reader_settings:isTrue("twelve_hour_clock") and 1 or 0)
end
function ReaderCoptListener:updateHeader()
-- Have crengine display accurate time and battery on its next drawing
self.ui.rolling:updateBatteryState()
self.ui.document:resetBufferCache() -- be sure next repaint is a redrawing
-- Force a repaint (we could avoid it if the top menu is shown as it
-- would fully cover the header, but let's not bother)
UIManager:setDirty(self.view.dialog, "ui",
Geom:new{
x = 0, y = 0,
w = Device.screen:getWidth(),
h = self.ui.document:getHeaderHeight(),
}
)
end
function ReaderCoptListener:unscheduleHeaderRefresh()
if not self.headerRefresh then return end -- not yet set up
UIManager:unschedule(self.headerRefresh)
logger.dbg("ReaderCoptListener.headerRefresh unscheduled")
end
function ReaderCoptListener:rescheduleHeaderRefreshIfNeeded()
if not self.headerRefresh then return end -- not yet set up
local unscheduled = UIManager:unschedule(self.headerRefresh) -- unschedule if already scheduled
-- Only schedule an update if the header is actually visible
if self.header_auto_refresh == 1
and self.document.configurable.status_line == 0 -- top bar enabled
and self.view.view_mode == "page" -- not in scroll mode (which would disable the header)
and (self.clock == 1 or self.battery == 1) then -- something shown can change in next minute
UIManager:scheduleIn(61 - tonumber(os.date("%S")), self.headerRefresh)
if not unscheduled then
logger.dbg("ReaderCoptListener.headerRefresh scheduled")
else
logger.dbg("ReaderCoptListener.headerRefresh rescheduled")
end
elseif unscheduled then
logger.dbg("ReaderCoptListener.headerRefresh unscheduled")
end
end
-- Schedule or stop scheluding on these events, as they may change what is shown:
ReaderCoptListener.onSetStatusLine = ReaderCoptListener.rescheduleHeaderRefreshIfNeeded
-- configurable.status_line is set before this event is triggered
ReaderCoptListener.onSetViewMode = ReaderCoptListener.rescheduleHeaderRefreshIfNeeded
-- ReaderView:onSetViewMode(), which sets view.view_mode, is called before
-- ReaderCoptListener.onSetViewMode, so we'll get the updated value
ReaderCoptListener.onResume = ReaderCoptListener.rescheduleHeaderRefreshIfNeeded
-- Unschedule on these events
ReaderCoptListener.onCloseDocument = ReaderCoptListener.unscheduleHeaderRefresh
ReaderCoptListener.onSuspend = ReaderCoptListener.unscheduleHeaderRefresh
function ReaderCoptListener:setAndSave(setting, property, value)
self.ui.document._document:setIntProperty(property, value)
G_reader_settings:saveSetting(setting, value)
UIManager:broadcastEvent(Event:new("SetStatusLine", self.document.configurable.status_line, true))
-- Have crengine redraw it (even if hidden by the menu at this time)
self:updateHeader()
-- And see if we should auto-refresh
self:rescheduleHeaderRefreshIfNeeded()
end
local about_text = _([[
@@ -81,6 +153,18 @@ function ReaderCoptListener:getAltStatusBarMenu()
end,
separator = true,
},
{
text = _("Auto refresh"),
checked_func = function()
return self.header_auto_refresh == 1
end,
callback = function()
self.header_auto_refresh = self.header_auto_refresh == 0 and 1 or 0
G_reader_settings:saveSetting("cre_header_auto_refresh", self.header_auto_refresh)
self:rescheduleHeaderRefreshIfNeeded()
end,
separator = true
},
{
text = _("Book author and title"),
checked_func = function()
@@ -131,29 +215,6 @@ function ReaderCoptListener:getAltStatusBarMenu()
self:setAndSave("cre_header_reading_percent", "window.status.pos.percent", self.reading_percent)
end,
},
{
text = _("Battery status"),
checked_func = function()
return self.battery == 1
end,
callback = function()
self.battery = self.battery == 0 and 1 or 0
self:setAndSave("cre_header_battery", "window.status.battery", self.battery)
end,
},
{
text = _("Battery percentage"),
enabled_func = function()
return self.battery == 1
end,
checked_func = function()
return self.battery_percent == 1
end,
callback = function()
self.battery_percent = self.battery_percent == 0 and 1 or 0
self:setAndSave("cre_header_battery_percent", "window.status.battery.percent", self.battery_percent)
end,
},
{
text = _("Chapter marks"),
checked_func = function()
@@ -163,6 +224,60 @@ function ReaderCoptListener:getAltStatusBarMenu()
self.chapter_marks = self.chapter_marks == 0 and 1 or 0
self:setAndSave("cre_header_chapter_marks", "crengine.page.header.chapter.marks", self.chapter_marks)
end,
},
{
text_func = function()
local status = _("off")
if self.battery == 1 then
if self.battery_percent == 1 then
status = _("percentage")
else
status = _("icon")
end
end
return T(_("Battery status (%1)"), status)
end,
sub_item_table = {
{
text = _("Battery icon"),
checked_func = function()
return self.battery == 1 and self.battery_percent == 0
end,
callback = function()
if self.battery == 0 then -- self.battery_percent don't care
self.battery = 1
self.battery_percent = 0
elseif self.battery == 1 and self.battery_percent == 1 then
self.battery = 1
self.battery_percent = 0
else
self.battery = 0
self.battery_percent = 0
end
self:setAndSave("cre_header_battery", "window.status.battery", self.battery)
self:setAndSave("cre_header_battery_percent", "window.status.battery.percent", self.battery_percent)
end,
},
{
text = _("Battery percentage"),
checked_func = function()
return self.battery == 1 and self.battery_percent == 1
end,
callback = function()
if self.battery == 0 then -- self.battery_percent don't care
self.battery = 1
self.battery_percent = 1
elseif self.battery == 1 and self.battery_percent == 0 then
self.battery_percent = 1
else
self.battery = 0
self.battery_percent = 0
end
self:setAndSave("cre_header_battery", "window.status.battery", self.battery)
self:setAndSave("cre_header_battery_percent", "window.status.battery.percent", self.battery_percent)
end,
},
},
separator = true,
},
{
@@ -182,6 +297,10 @@ function ReaderCoptListener:getAltStatusBarMenu()
title_text = _("Size of top status bar"),
ok_text = _("Set size"),
callback = function(spin)
-- This could change the header height, and as we refresh only on the
-- new height, we could get part of a previous taller status bar
-- still displayed. But as all this is covered by this menu that
-- we keep open, no need to handle this case.
self:setAndSave("cre_header_status_font_size", "crengine.page.header.font.size", spin.value)
if touchmenu_instance then touchmenu_instance:updateItems() end
end

1
frontend/apps/reader/modules/readerview.lua
View File

@@ -864,7 +864,6 @@ function ReaderView:onSetViewMode(new_mode)
self.ui.document:setViewMode(new_mode)
self.ui:handleEvent(Event:new("ChangeViewMode"))
end
return true
end
--Refresh after changing a variable done by koptoptions.lua since all of them

4
frontend/document/credocument.lua
View File

@@ -1331,6 +1331,9 @@ end
-- no-op that will be wrapped by setupCallCache
function CreDocument:resetCallCache() end
-- no-op that will be wrapped by setupCallCache
function CreDocument:resetBufferCache() end
-- Optimise usage of some of the above methods by caching their results,
-- either globally, or per page/pos for those whose result may depend on
-- current page number or y-position.
@@ -1562,6 +1565,7 @@ function CreDocument:setupCallCache()
elseif name == "getWordFromPosition" then add_buffer_trash = true
elseif name == "getTextFromPositions" then add_buffer_trash = true
elseif name == "findText" then add_buffer_trash = true
elseif name == "resetBufferCache" then add_buffer_trash = true
-- These may change page/pos
elseif name == "gotoPage" then set_tag = "page" ; set_arg = 2 ; set_arg2 = 3

3
frontend/ui/uimanager.lua
View File

@@ -579,11 +579,14 @@ UIManager:scheduleIn(10, self.anonymousFunction)
UIManager:unschedule(self.anonymousFunction)
]]
function UIManager:unschedule(action)
local removed = false
for i = #self._task_queue, 1, -1 do
if self._task_queue[i].action == action then
table.remove(self._task_queue, i)
removed = true
end
end
return removed
end
dbg:guard(UIManager, 'unschedule',
function(self, action) assert(action ~= nil) end)