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

[UX] Sort footer elements (#5389)

Browse Source 
Close: #5329 

- new option for footer - `Sort items`
- new widget `SortWidget`
This commit is contained in:
Robert
2019-09-17 14:50:03 +02:00
committed by Frans de Jonge
parent e315d8690d
commit a7c358b080
4 changed files with 579 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

103
frontend/apps/reader/modules/readerfooter.lua
View File

@@ -62,13 +62,6 @@ local symbol_prefix = {
}
}
local MODE_NB = 0
local MODE_INDEX = {}
for k,v in pairs(MODE) do
MODE_INDEX[v] = k
MODE_NB = MODE_NB + 1
end
-- functions that generates footer text for each mode
local footerTextGeneratorMap = {
empty = function() return "" end,
@@ -218,6 +211,33 @@ function ReaderFooter:init()
item_prefix = "icons"
}
if not self.settings.order then
self.mode_nb = 0
self.mode_index = {}
local mode_tbl = {}
for k,v in pairs(MODE) do
mode_tbl[v] = k
end
local mode_name
for i = 0, #mode_tbl do
mode_name = mode_tbl[i]
if mode_name == "wifi_status" and not Device:isAndroid() then
do end -- luacheck: ignore 541
elseif mode_name == "frontlight" and not Device:hasFrontlight() then
do end -- luacheck: ignore 541
else
self.mode_index[self.mode_nb] = mode_name
self.mode_nb = self.mode_nb + 1
end
end
else
self.mode_index = self.settings.order
self.mode_nb = #self.mode_index
end
self.mode_list = {}
for i = 0, #self.mode_index do
self.mode_list[self.mode_index[i]] = i
end
if self.settings.disabled then
-- footer featuren disabled completely, stop initialization now
self:disableFooter()
@@ -227,7 +247,7 @@ function ReaderFooter:init()
self.pageno = self.view.state.page
self.has_no_mode = true
self.reclaim_height = self.settings.reclaim_height or false
for _, m in ipairs(MODE_INDEX) do
for _, m in ipairs(self.mode_index) do
if self.settings[m] then
self.has_no_mode = false
break
@@ -265,12 +285,12 @@ function ReaderFooter:init()
self.mode = G_reader_settings:readSetting("reader_footer_mode") or self.mode
if self.has_no_mode and self.settings.disable_progress_bar then
self.mode = MODE.off
self.mode = self.mode_list.off
self.view.footer_visible = false
self:resetLayout()
end
if self.settings.all_at_once then
self.view.footer_visible = (self.mode ~= MODE.off)
self.view.footer_visible = (self.mode ~= self.mode_list.off)
self:updateFooterTextGenerator()
else
self:applyFooterMode()
@@ -414,18 +434,19 @@ function ReaderFooter:disableFooter()
self.onPosUpdate = function() end
self.onUpdatePos = function() end
self.onSetStatusLine = function() end
self.mode = MODE.off
self.mode = self.mode_list.off
self.view.footer_visible = false
end
function ReaderFooter:updateFooterTextGenerator()
local footerTextGenerators = {}
for _, m in pairs(MODE_INDEX) do
for i, m in pairs(self.mode_index) do
if self.settings[m] then
table.insert(footerTextGenerators,
footerTextGeneratorMap[m])
if not self.settings.all_at_once then
-- if not show all at once, then one is enough
self.mode = i
break
end
end
@@ -520,7 +541,7 @@ function ReaderFooter:addToMainMenu(menu_items)
local prev_has_no_mode = self.has_no_mode
local prev_reclaim_height = self.reclaim_height
self.has_no_mode = true
for mode_num, m in pairs(MODE_INDEX) do
for mode_num, m in pairs(self.mode_index) do
if self.settings[m] then
first_enabled_mode_num = mode_num
self.has_no_mode = false
@@ -532,7 +553,7 @@ function ReaderFooter:addToMainMenu(menu_items)
if self.has_no_mode then
self.ui:handleEvent(Event:new("SetPageBottomMargin", self.view.document.configurable.b_page_margin))
self.genFooterText = footerTextGeneratorMap.empty
self.mode = MODE.off
self.mode = self.mode_list.off
elseif prev_has_no_mode then
self.ui:handleEvent(Event:new("SetPageBottomMargin", self.view.document.configurable.b_page_margin))
G_reader_settings:saveSetting("reader_footer_mode", first_enabled_mode_num)
@@ -544,7 +565,7 @@ function ReaderFooter:addToMainMenu(menu_items)
should_update = callback(self)
elseif self.settings.all_at_once then
should_update = self:updateFooterTextGenerator()
elseif (MODE[option] == self.mode and self.settings[option] == false)
elseif (self.mode_list[option] == self.mode and self.settings[option] == false)
or (prev_has_no_mode ~= self.has_no_mode) then
-- current mode got disabled, redraw footer with other
-- enabled modes. if all modes are disabled, then only show
@@ -565,6 +586,32 @@ function ReaderFooter:addToMainMenu(menu_items)
table.insert(sub_items, {
text = _("Settings"),
sub_item_table = {
{
text = _("Sort items"),
callback = function()
local item_table = {}
for i=1, #self.mode_index do
table.insert(item_table, {text = self:textOptionTitles(self.mode_index[i]), label = self.mode_index[i]})
end
local SortWidget = require("ui/widget/sortwidget")
local sort_item
sort_item = SortWidget:new{
title = _("Sort footer items"),
item_table = item_table,
callback = function()
for i=1, #sort_item.item_table do
self.mode_index[i] = sort_item.item_table[i].label
end
self.settings.order = self.mode_index
G_reader_settings:saveSetting("footer", self.settings)
self:updateFooterTextGenerator()
self:updateFooter()
UIManager:setDirty(nil, "ui")
end
}
UIManager:show(sort_item)
end,
},
getMinibarOption("all_at_once", self.updateFooterTextGenerator),
getMinibarOption("reclaim_height"),
{
@@ -1071,7 +1118,7 @@ function ReaderFooter:applyFooterMode(mode)
-- 9 for memory usage
-- 10 for wifi status
if mode ~= nil then self.mode = mode end
self.view.footer_visible = (self.mode ~= MODE.off)
self.view.footer_visible = (self.mode ~= self.mode_list.off)
-- If all-at-once is enabled, just hide, but the text will keep being processed...
if self.settings.all_at_once then
@@ -1083,7 +1130,7 @@ function ReaderFooter:applyFooterMode(mode)
return
end
local mode_name = MODE_INDEX[self.mode]
local mode_name = self.mode_index[self.mode]
if not self.settings[mode_name] or self.has_no_mode then
-- all modes disabled, only show progress bar
mode_name = "empty"
@@ -1093,7 +1140,7 @@ end
function ReaderFooter:onEnterFlippingMode()
self.orig_mode = self.mode
self:applyFooterMode(MODE.page_progress)
self:applyFooterMode(self.mode_list.page_progress)
end
function ReaderFooter:onExitFlippingMode()
@@ -1115,19 +1162,19 @@ function ReaderFooter:onTapFooter(ges)
else
if self.settings.all_at_once or self.has_no_mode then
if self.mode >= 1 then
self.mode = MODE.off
self.mode = self.mode_list.off
else
self.mode = MODE.page_progress
self.mode = self.mode_list.page_progress
end
else
self.mode = (self.mode + 1) % MODE_NB
for i, m in ipairs(MODE_INDEX) do
if self.mode == MODE.off then break end
self.mode = (self.mode + 1) % self.mode_nb
for i, m in ipairs(self.mode_index) do
if self.mode == self.mode_list.off then break end
if self.mode == i then
if self.settings[m] then
break
else
self.mode = (self.mode + 1) % MODE_NB
self.mode = (self.mode + 1) % self.mode_nb
end
end
end
@@ -1140,7 +1187,7 @@ function ReaderFooter:onTapFooter(ges)
end
function ReaderFooter:onHoldFooter()
if self.mode == MODE.off then return end
if self.mode == self.mode_list.off then return end
self.ui:handleEvent(Event:new("ShowSkimtoDialog"))
return true
end
@@ -1150,12 +1197,12 @@ function ReaderFooter:setVisible(visible)
-- If it was off, just do as if we tap'ed on it (so we don't
-- duplicate onTapFooter() code - not if flipping_visible as in
-- this case, a ges.pos argument to onTapFooter(ges) is required)
if self.mode == MODE.off and not self.view.flipping_visible then
if self.mode == self.mode_list.off and not self.view.flipping_visible then
self:onTapFooter()
end
self.view.footer_visible = (self.mode ~= MODE.off)
self.view.footer_visible = (self.mode ~= self.mode_list.off)
else
self:applyFooterMode(MODE.off)
self:applyFooterMode(self.mode_list.off)
end
end