Archives/koreader
2
0
Fork 0
mirror of https://github.com/koreader/koreader synced 2024-11-11 19:11:14 +00:00
Code Issues Projects Releases Wiki Activity
3dbcccb1a8
koreader/frontend/dispatcher.lua

978 lines
45 KiB
Lua
Raw Normal View History

Dispatcher: allow registering actions at runtime
2020-10-12 03:06:04 +00:00
--[[--
ldoc fixes
2020-10-12 15:20:16 +00:00
This module is responsible for dispatching events.
To add a new action an entry must be added to `settingsList` & `dispatcher_menu_order`
This can also be done at runtime via @{registerAction}().
`settingsList` contains the list of dispatchable settings.
Each setting contains:
* category: one of:
* none: a direct event call
* arg: a event that expects a gesture object or an argument
* absolutenumber: event that sets a number
* incrementalnumber: event that increments a number & accepts a gesture object
* string: event with a list of arguments to chose from
Dispatcher: initial Kopt support
2021-05-14 22:13:27 +00:00
* configurable: like string but instead of an event it updates the configurable (used by kopt)
ldoc fixes
2020-10-12 15:20:16 +00:00
* event: what to call.
* title: for use in ui.
Dispatcher: Revamp sections and item order
2021-09-10 20:11:24 +00:00
* section: under which menu to display (currently: general, device, screen, filemanager, reader, rolling, paging)
ldoc fixes
2020-10-12 15:20:16 +00:00
and optionally
* min/max: for number
Dispatcher: Make font size actions consistent with ConfigDialog's NumberPicker (#7626)
2021-05-05 18:48:42 +00:00
* step: for number
ldoc fixes
2020-10-12 15:20:16 +00:00
* default
* args: allowed values for string.
* toggle: display name for args
* separator: put a separator after in the menu list
[doc] Fix random typo (#7676)
2021-05-13 15:57:48 +00:00
* configurable: can be parsed from cre/kopt and used to set `document.configurable`. Should not be set manually
Dispatcher: allow registering actions at runtime
2020-10-12 03:06:04 +00:00
--]]--
[plugin] Dispatcher: for profiles & gestures (#6106) add a Dispatcher module that allows for dispatching multiple events at once. This will allow for profiles & for gestures that do multiple things. it has 2 methods: Execute which is given a kv table of settings to change and fires an event for each of them. addSubMenu adds a menu item to a menu to allow for modifying which events are called it also has settingsList which is a master table of all allowed setting and their corresponding info (it is mostly from ReaderGesture and needs a lot of work) to allow for a new setting all one has to do is add a entry to settingsList with a corresponding event and it will work out of the box. the profile plugin is right now still a stub, just to test Dispatcher. the plan is to finish it and eventually refactor ReaderGesture to rely on this. This also needs effort to move many functions out of reader gesture into events where they belong.
2020-06-19 21:38:53 +00:00
local CreOptions = require("ui/data/creoptions")
Dispatcher: initial Kopt support
2021-05-14 22:13:27 +00:00
local KoptOptions = require("ui/data/koptoptions")
Dispatcher: use sections (#6364) use `device` `filemanager` `rolling` and `paging` sections to organize the dispatcher menu and allow the user to know when the action will apply add events from ReaderGesture allow profiles in FM
2020-07-14 21:39:03 +00:00
local Device = require("device")
[plugin] Dispatcher: for profiles & gestures (#6106) add a Dispatcher module that allows for dispatching multiple events at once. This will allow for profiles & for gestures that do multiple things. it has 2 methods: Execute which is given a kv table of settings to change and fires an event for each of them. addSubMenu adds a menu item to a menu to allow for modifying which events are called it also has settingsList which is a master table of all allowed setting and their corresponding info (it is mostly from ReaderGesture and needs a lot of work) to allow for a new setting all one has to do is add a entry to settingsList with a corresponding event and it will work out of the box. the profile plugin is right now still a stub, just to test Dispatcher. the plan is to finish it and eventually refactor ReaderGesture to rely on this. This also needs effort to move many functions out of reader gesture into events where they belong.
2020-06-19 21:38:53 +00:00
local Event = require("ui/event")
Notifications: options to show none/some/more (#7718) Notification: adds some functions so it can be used as a notification manager. Have various bits of code emitting events that may generate notifications advertize themselves as the source for following notifications. Add a menu to allow selecting some subsets of sources to show or hide.
2021-05-20 21:14:11 +00:00
local Notification = require("ui/widget/notification")
Paged documents: rework zoom options (#6885) - Move zoom options from top menu to bottom config - Add option to manually define zoom (relative to page width) and overlap (in percent) - Add options to zoom to columns or rows, possibly with overlap. Add panning direction options when page forward in these modes
2020-11-28 16:18:57 +00:00
local ReaderZooming = require("apps/reader/modules/readerzooming")
[plugin] Dispatcher: for profiles & gestures (#6106) add a Dispatcher module that allows for dispatching multiple events at once. This will allow for profiles & for gestures that do multiple things. it has 2 methods: Execute which is given a kv table of settings to change and fires an event for each of them. addSubMenu adds a menu item to a menu to allow for modifying which events are called it also has settingsList which is a master table of all allowed setting and their corresponding info (it is mostly from ReaderGesture and needs a lot of work) to allow for a new setting all one has to do is add a entry to settingsList with a corresponding event and it will work out of the box. the profile plugin is right now still a stub, just to test Dispatcher. the plan is to finish it and eventually refactor ReaderGesture to rely on this. This also needs effort to move many functions out of reader gesture into events where they belong.
2020-06-19 21:38:53 +00:00
local UIManager = require("ui/uimanager")
Dispatcher:removeAction() Gestures: use sub_item_table_func to allow the menu to refresh on change
2021-09-10 20:14:07 +00:00
local util = require("util")
[plugin] Dispatcher: for profiles & gestures (#6106) add a Dispatcher module that allows for dispatching multiple events at once. This will allow for profiles & for gestures that do multiple things. it has 2 methods: Execute which is given a kv table of settings to change and fires an event for each of them. addSubMenu adds a menu item to a menu to allow for modifying which events are called it also has settingsList which is a master table of all allowed setting and their corresponding info (it is mostly from ReaderGesture and needs a lot of work) to allow for a new setting all one has to do is add a entry to settingsList with a corresponding event and it will work out of the box. the profile plugin is right now still a stub, just to test Dispatcher. the plan is to finish it and eventually refactor ReaderGesture to rely on this. This also needs effort to move many functions out of reader gesture into events where they belong.
2020-06-19 21:38:53 +00:00
local _ = require("gettext")
Dispatcher: show selected number (#6472) followup to #6441
2020-08-17 07:55:03 +00:00
local C_ = _.pgettext
local T = require("ffi/util").template
[plugin] Dispatcher: for profiles & gestures (#6106) add a Dispatcher module that allows for dispatching multiple events at once. This will allow for profiles & for gestures that do multiple things. it has 2 methods: Execute which is given a kv table of settings to change and fires an event for each of them. addSubMenu adds a menu item to a menu to allow for modifying which events are called it also has settingsList which is a master table of all allowed setting and their corresponding info (it is mostly from ReaderGesture and needs a lot of work) to allow for a new setting all one has to do is add a entry to settingsList with a corresponding event and it will work out of the box. the profile plugin is right now still a stub, just to test Dispatcher. the plan is to finish it and eventually refactor ReaderGesture to rely on this. This also needs effort to move many functions out of reader gesture into events where they belong.
2020-06-19 21:38:53 +00:00
local Dispatcher = {
initialized = false,
}
ldoc fixes
2020-10-12 15:20:16 +00:00
-- See above for description.
[plugin] Dispatcher: for profiles & gestures (#6106) add a Dispatcher module that allows for dispatching multiple events at once. This will allow for profiles & for gestures that do multiple things. it has 2 methods: Execute which is given a kv table of settings to change and fires an event for each of them. addSubMenu adds a menu item to a menu to allow for modifying which events are called it also has settingsList which is a master table of all allowed setting and their corresponding info (it is mostly from ReaderGesture and needs a lot of work) to allow for a new setting all one has to do is add a entry to settingsList with a corresponding event and it will work out of the box. the profile plugin is right now still a stub, just to test Dispatcher. the plan is to finish it and eventually refactor ReaderGesture to rely on this. This also needs effort to move many functions out of reader gesture into events where they belong.
2020-06-19 21:38:53 +00:00
local settingsList = {
Dispatcher: Revamp sections and item order
2021-09-10 20:11:24 +00:00
-- Screen & Lights
show_frontlight_dialog = {category="none", event="ShowFlDialog", title=_("Show frontlight dialog"), screen=true, condition=Device:hasFrontlight()},
toggle_frontlight = {category="none", event="ToggleFrontlight", title=_("Toggle frontlight"), screen=true, condition=Device:hasFrontlight()},
set_frontlight = {category="absolutenumber", event="SetFlIntensity", min=0, max=Device:getPowerDevice().fl_max, title=_("Set frontlight brightness to %1"), screen=true, condition=Device:hasFrontlight()},
increase_frontlight = {category="incrementalnumber", event="IncreaseFlIntensity", min=1, max=Device:getPowerDevice().fl_max, title=_("Increase frontlight brightness by %1"), screen=true, condition=Device:hasFrontlight()},
decrease_frontlight = {category="incrementalnumber", event="DecreaseFlIntensity", min=1, max=Device:getPowerDevice().fl_max, title=_("Decrease frontlight brightness by %1"), screen=true, condition=Device:hasFrontlight()},
set_frontlight_warmth = {category="absolutenumber", event="SetFlWarmth", min=0, max=100, title=_("Set frontlight warmth to %1"), screen=true, condition=Device:hasNaturalLight()},
increase_frontlight_warmth = {category="incrementalnumber", event="IncreaseFlWarmth", min=1, max=Device:getPowerDevice().fl_warmth_max, title=_("Increase frontlight warmth by %1"), screen=true, condition=Device:hasNaturalLight()},
decrease_frontlight_warmth = {category="incrementalnumber", event="DecreaseFlWarmth", min=1, max=Device:getPowerDevice().fl_warmth_max, title=_("Decrease frontlight warmth by %1"), screen=true, condition=Device:hasNaturalLight(), separator=true},
full_refresh = {category="none", event="FullRefresh", title=_("Full screen refresh"), screen=true},
night_mode = {category="none", event="ToggleNightMode", title=_("Toggle night mode"), screen=true},
set_night_mode = {category="string", event="SetNightMode", title=_("Set night mode"), screen=true, args={true, false}, toggle={_("On"), _("Off")}, separator=true},
set_refresh_rate = {category="absolutenumber", event="SetBothRefreshRates", min=-1, max=200, title=_("Flash every %1 pages (always)"), screen=true, condition=Device:hasEinkScreen()},
set_day_refresh_rate = {category="absolutenumber", event="SetDayRefreshRate", min=-1, max=200, title=_("Flash every %1 pages (not in night mode)"), screen=true, condition=Device:hasEinkScreen()},
set_night_refresh_rate = {category="absolutenumber", event="SetNightRefreshRate", min=-1, max=200, title=_("Flash every %1 pages (in night mode)"), screen=true, condition=Device:hasEinkScreen()},
set_flash_on_chapter_boundaries = {category="string", event="SetFlashOnChapterBoundaries", title=_("Always flash on chapter boundaries"), screen=true, condition=Device:hasEinkScreen(), args={true, false}, toggle={_("On"), _("Off")}},
toggle_flash_on_chapter_boundaries = {category="none", event="ToggleFlashOnChapterBoundaries", title=_("Toggle flashing on chapter boundaries"), screen=true, condition=Device:hasEinkScreen()},
set_no_flash_on_second_chapter_page = {category="string", event="SetNoFlashOnSecondChapterPage", title=_("Never flash on chapter's 2nd page"), screen=true, condition=Device:hasEinkScreen(), args={true, false}, toggle={_("On"), _("Off")}},
toggle_no_flash_on_second_chapter_page = {category="none", event="ToggleNoFlashOnSecondChapterPage", title=_("Toggle flashing on chapter's 2nd page"), screen=true, condition=Device:hasEinkScreen(), separator=true},
Dispatcher: use sections (#6364) use `device` `filemanager` `rolling` and `paging` sections to organize the dispatcher menu and allow the user to know when the action will apply add events from ReaderGesture allow profiles in FM
2020-07-14 21:39:03 +00:00
-- Device settings
Dispatcher: some formatting cleanup, rewording and re-ordering
2021-05-10 10:44:55 +00:00
toggle_gsensor = {category="none", event="ToggleGSensor", title=_("Toggle accelerometer"), device=true, condition=Device:canToggleGSensor()},
wifi_on = {category="none", event="InfoWifiOn", title=_("Turn on Wi-Fi"), device=true, condition=Device:hasWifiToggle()},
wifi_off = {category="none", event="InfoWifiOff", title=_("Turn off Wi-Fi"), device=true, condition=Device:hasWifiToggle()},
NetworkManager: Make sure we show an IM at the *start* of a Wi-Fi toggle action (#9064) Ensures the worst-case scenario has minimal visual feedback.
2022-05-06 17:19:55 +00:00
toggle_wifi = {category="none", event="ToggleWifi", title=_("Toggle Wi-Fi"), device=true, condition=Device:hasWifiToggle()},
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.
2022-06-24 21:19:38 +00:00
toggle_fullscreen = {category="none", event="ToggleFullscreen", title=_("Toggle Fullscreen"), device=true, condition=not Device:isAlwaysFullscreen()},
NetworkManager: Make sure we show an IM at the *start* of a Wi-Fi toggle action (#9064) Ensures the worst-case scenario has minimal visual feedback.
2022-05-06 17:19:55 +00:00
show_network_info = {category="none", event="ShowNetworkInfo", title=_("Show network info"), device=true, separator=true},
Screensaver: add option to require a gesture after resume (#9316)
2022-07-11 11:50:28 +00:00
exit_screensaver = {category="none", event="ExitScreensaver", title=_("Exit screensaver"), device=true},
Dispatcher: some formatting cleanup, rewording and re-ordering
2021-05-10 10:44:55 +00:00
restart = {category="none", event="Restart", title=_("Restart KOReader"), device=true, condition=Device:canRestart()},
[UIManager] Outsource device specific event handlers (was: some nits) (#9448)
2022-09-10 11:45:31 +00:00
suspend = {category="none", event="RequestSuspend", title=_("Suspend"), device=true},
reboot = {category="none", event="RequestReboot", title=_("Reboot the device"), device=true, condition=Device:canReboot()},
poweroff = {category="none", event="RequestPowerOff", title=_("Power off"), device=true, condition=Device:canPowerOff(), separator=true},
exit = {category="none", event="Exit", title=_("Exit KOReader"), device=true},
Dispatcher: some formatting cleanup, rewording and re-ordering
2021-05-10 10:44:55 +00:00
toggle_hold_corners = {category="none", event="IgnoreHoldCorners", title=_("Toggle hold corners"), device=true, separator=true},
toggle_rotation = {category="none", event="SwapRotation", title=_("Toggle orientation"), device=true},
invert_rotation = {category="none", event="InvertRotation", title=_("Invert rotation"), device=true},
GestureDetector: Full refactor for almost-sane(TM) MT gesture handling (#9463) Should hopefully make two-contact gestures *much* more reliable, among other things. See the PR for all the details ;).
2022-09-04 00:38:27 +00:00
iterate_rotation = {category="none", event="IterateRotation", title=_("Rotate by 90° CW"), device=true},
iterate_rotation_ccw = {category="none", event="IterateRotation", arg=true, title=_("Rotate by 90° CCW"), device=true, separator=true},
Dispatcher: Revamp sections and item order
2021-09-10 20:11:24 +00:00
-- General
reading_progress = {category="none", event="ShowReaderProgress", title=_("Reading progress"), general=true},
history = {category="none", event="ShowHist", title=_("History"), general=true},
open_previous_document = {category="none", event="OpenLastDoc", title=_("Open previous document"), general=true},
filemanager = {category="none", event="Home", title=_("File browser"), general=true, separator=true},
dictionary_lookup = {category="none", event="ShowDictionaryLookup", title=_("Dictionary lookup"), general=true},
wikipedia_lookup = {category="none", event="ShowWikipediaLookup", title=_("Wikipedia lookup"), general=true},
fulltext_search = {category="none", event="ShowFulltextSearchInput", title=_("Fulltext search"), general=true},
file_search = {category="none", event="ShowFileSearch", title=_("File search"), general=true, separator=true},
show_menu = {category="none", event="ShowMenu", title=_("Show menu"), general=true},
favorites = {category="none", event="ShowColl", arg="favorites", title=_("Favorites"), general=true},
screenshot = {category="none", event="Screenshot", title=_("Screenshot"), general=true, separator=true},
Dispatcher: use sections (#6364) use `device` `filemanager` `rolling` and `paging` sections to organize the dispatcher menu and allow the user to know when the action will apply add events from ReaderGesture allow profiles in FM
2020-07-14 21:39:03 +00:00
-- filemanager settings
Dispatcher: some formatting cleanup, rewording and re-ordering
2021-05-10 10:44:55 +00:00
folder_up = {category="none", event="FolderUp", title=_("Folder up"), filemanager=true},
show_plus_menu = {category="none", event="ShowPlusMenu", title=_("Show plus menu"), filemanager=true},
File manager: group operations (#8536) Copy/Move/Delete for group of files. "Select files" button in the filemanager Plus menu.
2021-12-16 11:12:25 +00:00
toggle_select_mode = {category="none", event="ToggleSelectMode", title=_("Toggle select mode"), filemanager=true},
Dispatcher: some formatting cleanup, rewording and re-ordering
2021-05-10 10:44:55 +00:00
refresh_content = {category="none", event="RefreshContent", title=_("Refresh content"), filemanager=true},
folder_shortcuts = {category="none", event="ShowFolderShortcutsDialog", title=_("Folder shortcuts"), filemanager=true, separator=true},
Dispatcher: use sections (#6364) use `device` `filemanager` `rolling` and `paging` sections to organize the dispatcher menu and allow the user to know when the action will apply add events from ReaderGesture allow profiles in FM
2020-07-14 21:39:03 +00:00
-- reader settings
Dispatcher: Revamp sections and item order
2021-09-10 20:11:24 +00:00
toggle_status_bar = {category="none", event="TapFooter", title=_("Toggle status bar"), reader=true, separator=true},
prev_chapter = {category="none", event="GotoPrevChapter", title=_("Previous chapter"), reader=true},
next_chapter = {category="none", event="GotoNextChapter", title=_("Next chapter"), reader=true},
first_page = {category="none", event="GoToBeginning", title=_("First page"), reader=true},
last_page = {category="none", event="GoToEnd", title=_("Last page"), reader=true},
prev_bookmark = {category="none", event="GotoPreviousBookmarkFromPage", title=_("Previous bookmark"), reader=true},
next_bookmark = {category="none", event="GotoNextBookmarkFromPage", title=_("Next bookmark"), reader=true},
go_to = {category="none", event="ShowGotoDialog", title=_("Go to page"), filemanager=true, reader=true},
skim = {category="none", event="ShowSkimtoDialog", title=_("Skim document"), reader=true},
back = {category="none", event="Back", title=_("Back"), reader=true},
previous_location = {category="none", event="GoBackLink", arg=true, title=_("Back to previous location"), reader=true},
latest_bookmark = {category="none", event="GoToLatestBookmark", title=_("Go to latest bookmark"), reader=true},
follow_nearest_link = {category="arg", event="GoToPageLink", arg={pos={x=0,y=0}}, title=_("Follow nearest link"), reader=true},
follow_nearest_internal_link = {category="arg", event="GoToInternalPageLink", arg={pos={x=0,y=0}}, title=_("Follow nearest internal link"), reader=true},
clear_location_history = {category="none", event="ClearLocationStack", arg=true, title=_("Clear location history"), reader=true, separator=true},
toc = {category="none", event="ShowToc", title=_("Table of contents"), reader=true},
Add Book map and Page browser features - Book map: shows a map of content, including TOC, boomarks, read pages, non-linear flows... - Page browser: shows thumbnails of pages. - ReaderThumbnail: new Reader module that provides a service for generating thumbnails of book pages. It makes available these 2 new fullscreen widgets. - ReaderBookmark, ReaderLink, Statistics: add methods to return new views of bookmarks, previous locations and read pages, that are needed by BookMapWidget. - ReaderToc: compute TOC max_depth. - ReaderBookmark, ReaderHighlight: send events on bookmark add/update/remove so thumbnails of the pages impacted can be trashed.
2022-01-04 20:58:56 +00:00
book_map = {category="none", event="ShowBookMap", title=_("Book map"), reader=true, condition=Device:isTouchDevice()},
page_browser = {category="none", event="ShowPageBrowser", title=_("Page browser"), reader=true, condition=Device:isTouchDevice()},
Dispatcher: Revamp sections and item order
2021-09-10 20:11:24 +00:00
bookmarks = {category="none", event="ShowBookmark", title=_("Bookmarks"), reader=true},
Bookmark search (#8504) From bookmark list, main menu and with a gesture.
2021-12-04 17:37:00 +00:00
bookmark_search = {category="none", event="SearchBookmark", title=_("Bookmark search"), reader=true},
Dispatcher: Revamp sections and item order
2021-09-10 20:11:24 +00:00
book_status = {category="none", event="ShowBookStatus", title=_("Book status"), reader=true},
book_info = {category="none", event="ShowBookInfo", title=_("Book information"), reader=true},
book_description = {category="none", event="ShowBookDescription", title=_("Book description"), reader=true},
book_cover = {category="none", event="ShowBookCover", title=_("Book cover"), reader=true, separator=true},
show_config_menu = {category="none", event="ShowConfigMenu", title=_("Show bottom menu"), reader=true},
toggle_bookmark = {category="none", event="ToggleBookmark", title=_("Toggle bookmark"), reader=true},
Page turn animations: add to dispatcher (#9160) For real this time :) See #9123 https://www.mobileread.com/forums/showthread.php?p=4226937#post4226937
2022-06-02 21:59:29 +00:00
toggle_page_change_animation = {category="none", event="TogglePageChangeAnimation", title=_("Toggle page turn animations"), reader=true, condition=Device:canDoSwipeAnimation()},
Dispatcher: Revamp sections and item order
2021-09-10 20:11:24 +00:00
toggle_inverse_reading_order = {category="none", event="ToggleReadingOrder", title=_("Toggle page turn direction"), reader=true, separator=true},
Add "Invert page turn buttons" to Dispatcher (#9494) Fix #9492
2022-09-08 02:19:34 +00:00
swap_page_turn_buttons = {category="none", event="SwapPageTurnButtons", title=_("Invert page turn buttons"), reader=true, condition=Device:hasKeys(), separator=true},
Dispatcher: Revamp sections and item order
2021-09-10 20:11:24 +00:00
cycle_highlight_action = {category="none", event="CycleHighlightAction", title=_("Cycle highlight action"), reader=true},
cycle_highlight_style = {category="none", event="CycleHighlightStyle", title=_("Cycle highlight style"), reader=true},
page_jmp = {category="absolutenumber", event="GotoViewRel", min=-100, max=100, title=_("Go %1 pages"), reader=true},
Dispatcher: some formatting cleanup, rewording and re-ordering
2021-05-10 10:44:55 +00:00
panel_zoom_toggle = {category="none", event="TogglePanelZoomSetting", title=_("Toggle panel zoom"), paging=true, separator=true},
Dispatcher: use sections (#6364) use `device` `filemanager` `rolling` and `paging` sections to organize the dispatcher menu and allow the user to know when the action will apply add events from ReaderGesture allow profiles in FM
2020-07-14 21:39:03 +00:00
-- rolling reader settings
Dispatcher: Set font Closes: #8531
2021-12-16 20:31:22 +00:00
set_font = {category="string", event="SetFont", title=_("Set font"), rolling=true, args_func=require("fontlist").getFontArgFunc,},
Dispatcher: some formatting cleanup, rewording and re-ordering
2021-05-10 10:44:55 +00:00
increase_font = {category="incrementalnumber", event="IncreaseFontSize", min=0.5, max=255, step=0.5, title=_("Increase font size by %1"), rolling=true},
decrease_font = {category="incrementalnumber", event="DecreaseFontSize", min=0.5, max=255, step=0.5, title=_("Decrease font size by %1"), rolling=true},
Dispatcher: use sections (#6364) use `device` `filemanager` `rolling` and `paging` sections to organize the dispatcher menu and allow the user to know when the action will apply add events from ReaderGesture allow profiles in FM
2020-07-14 21:39:03 +00:00
-- paging reader settings
Dispatcher: some formatting cleanup, rewording and re-ordering
2021-05-10 10:44:55 +00:00
toggle_page_flipping = {category="none", event="TogglePageFlipping", title=_("Toggle page flipping"), paging=true},
toggle_reflow = {category="none", event="ToggleReflow", title=_("Toggle reflow"), paging=true},
zoom = {category="string", event="SetZoomMode", title=_("Zoom mode"), args=ReaderZooming.available_zoom_modes, toggle=ReaderZooming.available_zoom_modes, paging=true},
Paged documents: rework zoom options (#6885) - Move zoom options from top menu to bottom config - Add option to manually define zoom (relative to page width) and overlap (in percent) - Add options to zoom to columns or rows, possibly with overlap. Add panning direction options when page forward in these modes
2020-11-28 16:18:57 +00:00
zoom_factor_change = {category="none", event="ZoomFactorChange", title=_("Change zoom factor"), paging=true, separator=true},
Dispatcher: use sections (#6364) use `device` `filemanager` `rolling` and `paging` sections to organize the dispatcher menu and allow the user to know when the action will apply add events from ReaderGesture allow profiles in FM
2020-07-14 21:39:03 +00:00
-- parsed from CreOptions
-- the rest of the table elements are built from their counterparts in CreOptions
Dispatcher: Revamp sections and item order
2021-09-10 20:11:24 +00:00
rotation_mode = {category="string", device=true},
Dispatcher: some formatting cleanup, rewording and re-ordering
2021-05-10 10:44:55 +00:00
visible_pages = {category="string", rolling=true, separator=true},
Dispatcher: fix horizontal margins (#8344) Regression from #8287
2021-10-19 09:50:31 +00:00
h_page_margins = {category="string", rolling=true},
Dispatcher: use sections (#6364) use `device` `filemanager` `rolling` and `paging` sections to organize the dispatcher menu and allow the user to know when the action will apply add events from ReaderGesture allow profiles in FM
2020-07-14 21:39:03 +00:00
sync_t_b_page_margins = {category="string", rolling=true},
t_page_margin = {category="absolutenumber", rolling=true},
Dispatcher: some formatting cleanup, rewording and re-ordering
2021-05-10 10:44:55 +00:00
b_page_margin = {category="absolutenumber", rolling=true, separator=true},
Dispatcher: use sections (#6364) use `device` `filemanager` `rolling` and `paging` sections to organize the dispatcher menu and allow the user to know when the action will apply add events from ReaderGesture allow profiles in FM
2020-07-14 21:39:03 +00:00
view_mode = {category="string", rolling=true},
block_rendering_mode = {category="string", rolling=true},
render_dpi = {category="string", rolling=true},
Dispatcher: some formatting cleanup, rewording and re-ordering
2021-05-10 10:44:55 +00:00
line_spacing = {category="absolutenumber", rolling=true, separator=true},
Dispatcher: Make font size actions consistent with ConfigDialog's NumberPicker (#7626)
2021-05-05 18:48:42 +00:00
font_size = {category="absolutenumber", title=_("Set font size to %1"), rolling=true, step=0.5},
Dispatcher: some of these are actually strings not numbers partialy revert 4c0d11c6d92a3183fe31035e51b2b32eb6ad29d3 Fixes: #8534
2021-12-16 15:48:53 +00:00
font_base_weight = {category="string", rolling=true},
font_gamma = {category="string", rolling=true},
Dispatcher: use sections (#6364) use `device` `filemanager` `rolling` and `paging` sections to organize the dispatcher menu and allow the user to know when the action will apply add events from ReaderGesture allow profiles in FM
2020-07-14 21:39:03 +00:00
font_hinting = {category="string", rolling=true},
Dispatcher: some formatting cleanup, rewording and re-ordering
2021-05-10 10:44:55 +00:00
font_kerning = {category="string", rolling=true, separator=true},
Dispatcher: use sections (#6364) use `device` `filemanager` `rolling` and `paging` sections to organize the dispatcher menu and allow the user to know when the action will apply add events from ReaderGesture allow profiles in FM
2020-07-14 21:39:03 +00:00
status_line = {category="string", rolling=true},
embedded_css = {category="string", rolling=true},
embedded_fonts = {category="string", rolling=true},
smooth_scaling = {category="string", rolling=true},
nightmode_images = {category="string", rolling=true},
Dispatcher: initial Kopt support
2021-05-14 22:13:27 +00:00
-- parsed from KoptOptions
kopt_trim_page = {category="string", paging=true},
kopt_page_margin = {category="string", paging=true},
Dispatcher: use absolutenumber in more places
2021-10-01 21:06:59 +00:00
kopt_zoom_overlap_h = {category="absolutenumber", paging=true},
kopt_zoom_overlap_v = {category="absolutenumber", paging=true},
Dispatcher: initial Kopt support
2021-05-14 22:13:27 +00:00
kopt_zoom_mode_type = {category="string", paging=true},
kopt_zoom_range_number = {category="string", paging=true},
kopt_zoom_factor = {category="string", paging=true},
kopt_zoom_mode_genus = {category="string", paging=true},
kopt_zoom_direction = {category="string", paging=true},
kopt_page_scroll = {category="string", paging=true},
kopt_page_gap_height = {category="string", paging=true},
kopt_full_screen = {category="string", paging=true},
kopt_line_spacing = {category="configurable", paging=true},
kopt_justification = {category="configurable", paging=true},
kopt_font_size = {category="string", paging=true, title=_("Font Size")},
kopt_font_fine_tune = {category="string", paging=true},
kopt_word_spacing = {category="configurable", paging=true},
kopt_text_wrap = {category="string", paging=true},
Dispatcher: use absolutenumber in more places
2021-10-01 21:06:59 +00:00
kopt_contrast = {category="absolutenumber", paging=true},
Dispatcher: initial Kopt support
2021-05-14 22:13:27 +00:00
kopt_page_opt = {category="configurable", paging=true},
kopt_hw_dithering = {category="configurable", paging=true, condition=Device:hasEinkScreen() and Device:canHWDither()},
Don't show SW dither toggle on devices w/ HW dithering
2022-02-05 19:20:15 +00:00
kopt_sw_dithering = {category="configurable", paging=true, condition=Device:hasEinkScreen() and not Device:canHWDither() and Device.screen.fb_bpp == 8},
Dispatcher: initial Kopt support
2021-05-14 22:13:27 +00:00
kopt_quality = {category="configurable", paging=true},
kopt_doc_language = {category="string", paging=true},
kopt_forced_ocr = {category="configurable", paging=true},
kopt_writing_direction = {category="configurable", paging=true},
kopt_defect_size = {category="string", paging=true, condition=false},
Dispatcher: use absolutenumber in more places
2021-10-01 21:06:59 +00:00
kopt_auto_straighten = {category="absolutenumber", paging=true},
Dispatcher: initial Kopt support
2021-05-14 22:13:27 +00:00
kopt_detect_indent = {category="configurable", paging=true, condition=false},
kopt_max_columns = {category="configurable", paging=true},
Dispatcher: Fixes, Sort & QuickMenu Fix condition check, simplify getNameFromItem Allow sorting Dispatcher items and displaying them as a QuickMenu
2022-09-19 02:22:41 +00:00
settings = nil, -- reserved for per instance dispatcher settings
Dispatcher: use sections (#6364) use `device` `filemanager` `rolling` and `paging` sections to organize the dispatcher menu and allow the user to know when the action will apply add events from ReaderGesture allow profiles in FM
2020-07-14 21:39:03 +00:00
}
-- array for item order in menu
local dispatcher_menu_order = {
-- device
"reading_progress",
"open_previous_document",
Dispatcher: Revamp sections and item order
2021-09-10 20:11:24 +00:00
"history",
Dispatcher: use sections (#6364) use `device` `filemanager` `rolling` and `paging` sections to organize the dispatcher menu and allow the user to know when the action will apply add events from ReaderGesture allow profiles in FM
2020-07-14 21:39:03 +00:00
"favorites",
"filemanager",
"dictionary_lookup",
"wikipedia_lookup",
"fulltext_search",
"file_search",
Dispatcher: Revamp sections and item order
2021-09-10 20:11:24 +00:00
"show_menu",
"screenshot",
Screensaver: add option to require a gesture after resume (#9316)
2022-07-11 11:50:28 +00:00
"exit_screensaver",
Dispatcher: use sections (#6364) use `device` `filemanager` `rolling` and `paging` sections to organize the dispatcher menu and allow the user to know when the action will apply add events from ReaderGesture allow profiles in FM
2020-07-14 21:39:03 +00:00
"suspend",
"exit",
"restart",
"reboot",
"poweroff",
Dispatcher: Revamp sections and item order
2021-09-10 20:11:24 +00:00
"toggle_hold_corners",
"toggle_gsensor",
"rotation_mode",
"toggle_rotation",
"invert_rotation",
"iterate_rotation",
GestureDetector: Full refactor for almost-sane(TM) MT gesture handling (#9463) Should hopefully make two-contact gestures *much* more reliable, among other things. See the PR for all the details ;).
2022-09-04 00:38:27 +00:00
"iterate_rotation_ccw",
Dispatcher: Revamp sections and item order
2021-09-10 20:11:24 +00:00
"wifi_on",
"wifi_off",
"toggle_wifi",
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.
2022-06-24 21:19:38 +00:00
"toggle_fullscreen",
NetworkManager: Make sure we show an IM at the *start* of a Wi-Fi toggle action (#9064) Ensures the worst-case scenario has minimal visual feedback.
2022-05-06 17:19:55 +00:00
"show_network_info",
Dispatcher: Revamp sections and item order
2021-09-10 20:11:24 +00:00
Dispatcher: use sections (#6364) use `device` `filemanager` `rolling` and `paging` sections to organize the dispatcher menu and allow the user to know when the action will apply add events from ReaderGesture allow profiles in FM
2020-07-14 21:39:03 +00:00
"show_frontlight_dialog",
"toggle_frontlight",
Add Set Frontlight/Set Frontlight Warmth to dispatcher (#6440) Add Set Frontlight/Set Frontlight warmth events to dispatcher. This allows users to set day/night profiles with different fl/warmth values as requested in #6444
2020-07-29 21:48:28 +00:00
"set_frontlight",
Dispatcher: use sections (#6364) use `device` `filemanager` `rolling` and `paging` sections to organize the dispatcher menu and allow the user to know when the action will apply add events from ReaderGesture allow profiles in FM
2020-07-14 21:39:03 +00:00
"increase_frontlight",
"decrease_frontlight",
Add Set Frontlight/Set Frontlight Warmth to dispatcher (#6440) Add Set Frontlight/Set Frontlight warmth events to dispatcher. This allows users to set day/night profiles with different fl/warmth values as requested in #6444
2020-07-29 21:48:28 +00:00
"set_frontlight_warmth",
Dispatcher: use sections (#6364) use `device` `filemanager` `rolling` and `paging` sections to organize the dispatcher menu and allow the user to know when the action will apply add events from ReaderGesture allow profiles in FM
2020-07-14 21:39:03 +00:00
"increase_frontlight_warmth",
"decrease_frontlight_warmth",
Dispatcher: Revamp sections and item order
2021-09-10 20:11:24 +00:00
"night_mode",
"set_night_mode",
Dispatcher: use sections (#6364) use `device` `filemanager` `rolling` and `paging` sections to organize the dispatcher menu and allow the user to know when the action will apply add events from ReaderGesture allow profiles in FM
2020-07-14 21:39:03 +00:00
Dispatcher: Revamp sections and item order
2021-09-10 20:11:24 +00:00
"full_refresh",
A few e-Ink flash rate QoL tweaks (#6528) * Add an option to *always* flash on chapter boundaries * Optionally, in flash on chapter boundaries mode, also flash on the *second* page of a chapter. (There's often a large river at the top of the page on a chapter's first page) * In CRe, request a flashing update when there is significant image content on the page. * Register all refresh rate related options in Dispatcher, making them available in Gestures & Profiles.
2020-08-21 12:33:08 +00:00
"set_refresh_rate",
"set_day_refresh_rate",
"set_night_refresh_rate",
"set_flash_on_chapter_boundaries",
"toggle_flash_on_chapter_boundaries",
"set_no_flash_on_second_chapter_page",
"toggle_no_flash_on_second_chapter_page",
Dispatcher: use sections (#6364) use `device` `filemanager` `rolling` and `paging` sections to organize the dispatcher menu and allow the user to know when the action will apply add events from ReaderGesture allow profiles in FM
2020-07-14 21:39:03 +00:00
-- filemanager
"folder_up",
"show_plus_menu",
File manager: group operations (#8536) Copy/Move/Delete for group of files. "Select files" button in the filemanager Plus menu.
2021-12-16 11:12:25 +00:00
"toggle_select_mode",
FM: Make "Refresh content" an actual Event/Gesture (#7592) * And enable it by default in the FM as the "hold on top-right corner" Gesture, instead of the onHold handler of the "+" button.
2021-05-05 18:43:43 +00:00
"refresh_content",
Dispatcher: use sections (#6364) use `device` `filemanager` `rolling` and `paging` sections to organize the dispatcher menu and allow the user to know when the action will apply add events from ReaderGesture allow profiles in FM
2020-07-14 21:39:03 +00:00
"folder_shortcuts",
-- reader
Dispatcher: Revamp sections and item order
2021-09-10 20:11:24 +00:00
"show_config_menu",
Dispatcher: add "Toggle status bar" action (#7606)
2021-04-26 19:45:34 +00:00
"toggle_status_bar",
Dispatcher: use sections (#6364) use `device` `filemanager` `rolling` and `paging` sections to organize the dispatcher menu and allow the user to know when the action will apply add events from ReaderGesture allow profiles in FM
2020-07-14 21:39:03 +00:00
"prev_chapter",
"next_chapter",
"first_page",
"last_page",
Dispatcher: some formatting cleanup, rewording and re-ordering
2021-05-10 10:44:55 +00:00
"page_jmp",
Dispatcher: use sections (#6364) use `device` `filemanager` `rolling` and `paging` sections to organize the dispatcher menu and allow the user to know when the action will apply add events from ReaderGesture allow profiles in FM
2020-07-14 21:39:03 +00:00
"go_to",
"skim",
Dispatcher: some formatting cleanup, rewording and re-ordering
2021-05-10 10:44:55 +00:00
"prev_bookmark",
"next_bookmark",
"latest_bookmark",
Dispatcher: use sections (#6364) use `device` `filemanager` `rolling` and `paging` sections to organize the dispatcher menu and allow the user to know when the action will apply add events from ReaderGesture allow profiles in FM
2020-07-14 21:39:03 +00:00
"back",
"previous_location",
"follow_nearest_link",
"follow_nearest_internal_link",
"clear_location_history",
"toc",
Add Book map and Page browser features - Book map: shows a map of content, including TOC, boomarks, read pages, non-linear flows... - Page browser: shows thumbnails of pages. - ReaderThumbnail: new Reader module that provides a service for generating thumbnails of book pages. It makes available these 2 new fullscreen widgets. - ReaderBookmark, ReaderLink, Statistics: add methods to return new views of bookmarks, previous locations and read pages, that are needed by BookMapWidget. - ReaderToc: compute TOC max_depth. - ReaderBookmark, ReaderHighlight: send events on bookmark add/update/remove so thumbnails of the pages impacted can be trashed.
2022-01-04 20:58:56 +00:00
"book_map",
"page_browser",
Dispatcher: use sections (#6364) use `device` `filemanager` `rolling` and `paging` sections to organize the dispatcher menu and allow the user to know when the action will apply add events from ReaderGesture allow profiles in FM
2020-07-14 21:39:03 +00:00
"bookmarks",
Bookmark search (#8504) From bookmark list, main menu and with a gesture.
2021-12-04 17:37:00 +00:00
"bookmark_search",
Dispatcher: use sections (#6364) use `device` `filemanager` `rolling` and `paging` sections to organize the dispatcher menu and allow the user to know when the action will apply add events from ReaderGesture allow profiles in FM
2020-07-14 21:39:03 +00:00
"book_status",
"book_info",
"book_description",
"book_cover",
Dispatcher: Set font Closes: #8531
2021-12-16 20:31:22 +00:00
"set_font",
Dispatcher: use sections (#6364) use `device` `filemanager` `rolling` and `paging` sections to organize the dispatcher menu and allow the user to know when the action will apply add events from ReaderGesture allow profiles in FM
2020-07-14 21:39:03 +00:00
"increase_font",
"decrease_font",
"font_size",
Dispatcher: crengine contrast (gamma)
2020-09-21 21:51:12 +00:00
"font_gamma",
bump crengine: more granular font weights (#7616) Includes: - MathML: a few minor fixes - (Upstream) lvtext: fix possible index out of range - Fonts: RegisterExternalFont() should take a documentId - Fonts: fix: letter-spacing should not be applied on diacritic - (Upstream) Fonts: more granular synthetic weights - Fonts: synthesized weights: tweak some comments - Fonts: keep hinting with synthetic weight - Fonts: fix synthesized weight inconsitencies - Fonts: fix getFontFileNameAndFaceIndex() - Fonts: adds LVFontMan::RegularizeRegisteredFontsWeights() - Fonts: handle synth_weight tweaks in glyph/glyphinfo slots - (Upstream) Fonts: fix some compiler warnings - Fix hyphenation on Armenian and Georgian text Update the bottom menu widget "Font Weight" to allow more granular weights than the previous "regular | bold". Also bump thirdparty/luasec to v1.0.1.
2021-04-28 23:37:53 +00:00
"font_base_weight",
Dispatcher: use sections (#6364) use `device` `filemanager` `rolling` and `paging` sections to organize the dispatcher menu and allow the user to know when the action will apply add events from ReaderGesture allow profiles in FM
2020-07-14 21:39:03 +00:00
"font_hinting",
"font_kerning",
"toggle_bookmark",
Page turn animations: add to dispatcher (#9160) For real this time :) See #9123 https://www.mobileread.com/forums/showthread.php?p=4226937#post4226937
2022-06-02 21:59:29 +00:00
"toggle_page_change_animation",
Dispatcher: use sections (#6364) use `device` `filemanager` `rolling` and `paging` sections to organize the dispatcher menu and allow the user to know when the action will apply add events from ReaderGesture allow profiles in FM
2020-07-14 21:39:03 +00:00
"toggle_page_flipping",
"toggle_reflow",
"toggle_inverse_reading_order",
Add "Invert page turn buttons" to Dispatcher (#9494) Fix #9492
2022-09-08 02:19:34 +00:00
"swap_page_turn_buttons",
Dispatcher: use sections (#6364) use `device` `filemanager` `rolling` and `paging` sections to organize the dispatcher menu and allow the user to know when the action will apply add events from ReaderGesture allow profiles in FM
2020-07-14 21:39:03 +00:00
"zoom",
Paged documents: rework zoom options (#6885) - Move zoom options from top menu to bottom config - Add option to manually define zoom (relative to page width) and overlap (in percent) - Add options to zoom to columns or rows, possibly with overlap. Add panning direction options when page forward in these modes
2020-11-28 16:18:57 +00:00
"zoom_factor_change",
Dispatcher: use sections (#6364) use `device` `filemanager` `rolling` and `paging` sections to organize the dispatcher menu and allow the user to know when the action will apply add events from ReaderGesture allow profiles in FM
2020-07-14 21:39:03 +00:00
"cycle_highlight_action",
"cycle_highlight_style",
[feat] Comics: zoom to panel (#6511) This pull requests aims to provide convenient way to zoom in comics. The idea is when user holds/double taps (not decided yet) on a manga/comic panel, it gets cut out from the rest of the image and zoomed. More details in koreader/koreader-base#1148. Depends on koreader/koreader-base#1159
2020-09-24 13:17:37 +00:00
"panel_zoom_toggle",
Dispatcher: use sections (#6364) use `device` `filemanager` `rolling` and `paging` sections to organize the dispatcher menu and allow the user to know when the action will apply add events from ReaderGesture allow profiles in FM
2020-07-14 21:39:03 +00:00
"visible_pages",
"h_page_margins",
"sync_t_b_page_margins",
"t_page_margin",
"b_page_margin",
"view_mode",
"block_rendering_mode",
"render_dpi",
"line_spacing",
"status_line",
"embedded_css",
"embedded_fonts",
"smooth_scaling",
"nightmode_images",
Dispatcher: initial Kopt support
2021-05-14 22:13:27 +00:00
"kopt_trim_page",
"kopt_page_margin",
"kopt_zoom_overlap_h",
"kopt_zoom_overlap_v",
"kopt_zoom_mode_type",
--"kopt_zoom_range_number", -- can't figure out how this name text func works
"kopt_zoom_factor",
"kopt_zoom_mode_genus",
"kopt_zoom_direction",
"kopt_page_scroll",
"kopt_page_gap_height",
"kopt_full_screen",
"kopt_line_spacing",
"kopt_justification",
"kopt_font_size",
"kopt_font_fine_tune",
"kopt_word_spacing",
"kopt_text_wrap",
"kopt_contrast",
"kopt_page_opt",
"kopt_hw_dithering",
KOptOptions: Allow toggling SW dithering Fix #8748
2022-02-05 18:49:13 +00:00
"kopt_sw_dithering",
Dispatcher: initial Kopt support
2021-05-14 22:13:27 +00:00
"kopt_quality",
"kopt_doc_language",
"kopt_forced_ocr",
"kopt_writing_direction",
"kopt_defect_size",
"kopt_auto_straighten",
"kopt_detect_indent",
"kopt_max_columns",
[plugin] Dispatcher: for profiles & gestures (#6106) add a Dispatcher module that allows for dispatching multiple events at once. This will allow for profiles & for gestures that do multiple things. it has 2 methods: Execute which is given a kv table of settings to change and fires an event for each of them. addSubMenu adds a menu item to a menu to allow for modifying which events are called it also has settingsList which is a master table of all allowed setting and their corresponding info (it is mostly from ReaderGesture and needs a lot of work) to allow for a new setting all one has to do is add a entry to settingsList with a corresponding event and it will work out of the box. the profile plugin is right now still a stub, just to test Dispatcher. the plan is to finish it and eventually refactor ReaderGesture to rely on this. This also needs effort to move many functions out of reader gesture into events where they belong.
2020-06-19 21:38:53 +00:00
}
--[[--
add settings from CreOptions / KoptOptions
--]]--
function Dispatcher:init()
Gestures/Profiles: make sure dispatcher is initalized even when the menu is not opened. this was causing a crash when the event name was parsed from creoptions
2020-09-22 00:05:02 +00:00
if Dispatcher.initialized then return end
Dispatcher: initial Kopt support
2021-05-14 22:13:27 +00:00
local parseoptions = function(base, i, prefix)
for y=1, #base[i].options do
[plugin] Dispatcher: for profiles & gestures (#6106) add a Dispatcher module that allows for dispatching multiple events at once. This will allow for profiles & for gestures that do multiple things. it has 2 methods: Execute which is given a kv table of settings to change and fires an event for each of them. addSubMenu adds a menu item to a menu to allow for modifying which events are called it also has settingsList which is a master table of all allowed setting and their corresponding info (it is mostly from ReaderGesture and needs a lot of work) to allow for a new setting all one has to do is add a entry to settingsList with a corresponding event and it will work out of the box. the profile plugin is right now still a stub, just to test Dispatcher. the plan is to finish it and eventually refactor ReaderGesture to rely on this. This also needs effort to move many functions out of reader gesture into events where they belong.
2020-06-19 21:38:53 +00:00
local option = base[i].options[y]
Dispatcher: initial Kopt support
2021-05-14 22:13:27 +00:00
local name = prefix and prefix .. option.name or option.name
if settingsList[name] ~= nil then
Dispatcher: update document.configurable (#7116) So ConfigDialog knows about changed settings and properly reflects their states.
2021-01-07 22:19:23 +00:00
if option.name ~= nil and option.values ~= nil then
Dispatcher: initial Kopt support
2021-05-14 22:13:27 +00:00
settingsList[name].configurable = {name = option.name, values = option.values}
Dispatcher: update document.configurable (#7116) So ConfigDialog knows about changed settings and properly reflects their states.
2021-01-07 22:19:23 +00:00
end
Dispatcher: initial Kopt support
2021-05-14 22:13:27 +00:00
if settingsList[name].event == nil then
settingsList[name].event = option.event
[plugin] Dispatcher: for profiles & gestures (#6106) add a Dispatcher module that allows for dispatching multiple events at once. This will allow for profiles & for gestures that do multiple things. it has 2 methods: Execute which is given a kv table of settings to change and fires an event for each of them. addSubMenu adds a menu item to a menu to allow for modifying which events are called it also has settingsList which is a master table of all allowed setting and their corresponding info (it is mostly from ReaderGesture and needs a lot of work) to allow for a new setting all one has to do is add a entry to settingsList with a corresponding event and it will work out of the box. the profile plugin is right now still a stub, just to test Dispatcher. the plan is to finish it and eventually refactor ReaderGesture to rely on this. This also needs effort to move many functions out of reader gesture into events where they belong.
2020-06-19 21:38:53 +00:00
end
Dispatcher: initial Kopt support
2021-05-14 22:13:27 +00:00
if settingsList[name].title == nil then
settingsList[name].title = option.name_text
[plugin] Dispatcher: for profiles & gestures (#6106) add a Dispatcher module that allows for dispatching multiple events at once. This will allow for profiles & for gestures that do multiple things. it has 2 methods: Execute which is given a kv table of settings to change and fires an event for each of them. addSubMenu adds a menu item to a menu to allow for modifying which events are called it also has settingsList which is a master table of all allowed setting and their corresponding info (it is mostly from ReaderGesture and needs a lot of work) to allow for a new setting all one has to do is add a entry to settingsList with a corresponding event and it will work out of the box. the profile plugin is right now still a stub, just to test Dispatcher. the plan is to finish it and eventually refactor ReaderGesture to rely on this. This also needs effort to move many functions out of reader gesture into events where they belong.
2020-06-19 21:38:53 +00:00
end
Dispatcher: initial Kopt support
2021-05-14 22:13:27 +00:00
if settingsList[name].category == "string" or settingsList[name].category == "configurable" then
if settingsList[name].toggle == nil then
settingsList[name].toggle = option.toggle or option.labels
if settingsList[name].toggle == nil then
settingsList[name].toggle = {}
Dispatcher: fix table (#6324) accessing the table via reference rather than copying the values was breaking the configdialog
2020-06-28 10:18:45 +00:00
for z=1,#option.values do
if type(option.values[z]) == "table" then
Dispatcher: initial Kopt support
2021-05-14 22:13:27 +00:00
settingsList[name].toggle[z] = option.values[z][1]
else
settingsList[name].toggle[z] = option.values[z]
Dispatcher: fix table (#6324) accessing the table via reference rather than copying the values was breaking the configdialog
2020-06-28 10:18:45 +00:00
end
[plugin] Dispatcher: for profiles & gestures (#6106) add a Dispatcher module that allows for dispatching multiple events at once. This will allow for profiles & for gestures that do multiple things. it has 2 methods: Execute which is given a kv table of settings to change and fires an event for each of them. addSubMenu adds a menu item to a menu to allow for modifying which events are called it also has settingsList which is a master table of all allowed setting and their corresponding info (it is mostly from ReaderGesture and needs a lot of work) to allow for a new setting all one has to do is add a entry to settingsList with a corresponding event and it will work out of the box. the profile plugin is right now still a stub, just to test Dispatcher. the plan is to finish it and eventually refactor ReaderGesture to rely on this. This also needs effort to move many functions out of reader gesture into events where they belong.
2020-06-19 21:38:53 +00:00
end
end
end
Dispatcher: initial Kopt support
2021-05-14 22:13:27 +00:00
if settingsList[name].args == nil then
settingsList[name].args = option.args or option.values
[plugin] Dispatcher: for profiles & gestures (#6106) add a Dispatcher module that allows for dispatching multiple events at once. This will allow for profiles & for gestures that do multiple things. it has 2 methods: Execute which is given a kv table of settings to change and fires an event for each of them. addSubMenu adds a menu item to a menu to allow for modifying which events are called it also has settingsList which is a master table of all allowed setting and their corresponding info (it is mostly from ReaderGesture and needs a lot of work) to allow for a new setting all one has to do is add a entry to settingsList with a corresponding event and it will work out of the box. the profile plugin is right now still a stub, just to test Dispatcher. the plan is to finish it and eventually refactor ReaderGesture to rely on this. This also needs effort to move many functions out of reader gesture into events where they belong.
2020-06-19 21:38:53 +00:00
end
Dispatcher: initial Kopt support
2021-05-14 22:13:27 +00:00
elseif settingsList[name].category == "absolutenumber" then
if settingsList[name].min == nil then
Dispatcher: use absolutenumber in more places
2021-10-01 21:06:59 +00:00
settingsList[name].min = option.args and option.args[1] or option.values[1]
[plugin] Dispatcher: for profiles & gestures (#6106) add a Dispatcher module that allows for dispatching multiple events at once. This will allow for profiles & for gestures that do multiple things. it has 2 methods: Execute which is given a kv table of settings to change and fires an event for each of them. addSubMenu adds a menu item to a menu to allow for modifying which events are called it also has settingsList which is a master table of all allowed setting and their corresponding info (it is mostly from ReaderGesture and needs a lot of work) to allow for a new setting all one has to do is add a entry to settingsList with a corresponding event and it will work out of the box. the profile plugin is right now still a stub, just to test Dispatcher. the plan is to finish it and eventually refactor ReaderGesture to rely on this. This also needs effort to move many functions out of reader gesture into events where they belong.
2020-06-19 21:38:53 +00:00
end
Dispatcher: initial Kopt support
2021-05-14 22:13:27 +00:00
if settingsList[name].max == nil then
Dispatcher: use absolutenumber in more places
2021-10-01 21:06:59 +00:00
settingsList[name].max = option.args and option.args[#option.args] or option.values[#option.values]
[plugin] Dispatcher: for profiles & gestures (#6106) add a Dispatcher module that allows for dispatching multiple events at once. This will allow for profiles & for gestures that do multiple things. it has 2 methods: Execute which is given a kv table of settings to change and fires an event for each of them. addSubMenu adds a menu item to a menu to allow for modifying which events are called it also has settingsList which is a master table of all allowed setting and their corresponding info (it is mostly from ReaderGesture and needs a lot of work) to allow for a new setting all one has to do is add a entry to settingsList with a corresponding event and it will work out of the box. the profile plugin is right now still a stub, just to test Dispatcher. the plan is to finish it and eventually refactor ReaderGesture to rely on this. This also needs effort to move many functions out of reader gesture into events where they belong.
2020-06-19 21:38:53 +00:00
end
Dispatcher: initial Kopt support
2021-05-14 22:13:27 +00:00
if settingsList[name].default == nil then
settingsList[name].default = option.default_value
[plugin] Dispatcher: for profiles & gestures (#6106) add a Dispatcher module that allows for dispatching multiple events at once. This will allow for profiles & for gestures that do multiple things. it has 2 methods: Execute which is given a kv table of settings to change and fires an event for each of them. addSubMenu adds a menu item to a menu to allow for modifying which events are called it also has settingsList which is a master table of all allowed setting and their corresponding info (it is mostly from ReaderGesture and needs a lot of work) to allow for a new setting all one has to do is add a entry to settingsList with a corresponding event and it will work out of the box. the profile plugin is right now still a stub, just to test Dispatcher. the plan is to finish it and eventually refactor ReaderGesture to rely on this. This also needs effort to move many functions out of reader gesture into events where they belong.
2020-06-19 21:38:53 +00:00
end
end
end
end
end
for i=1,#CreOptions do
parseoptions(CreOptions, i)
end
Dispatcher: initial Kopt support
2021-05-14 22:13:27 +00:00
for i=1,#KoptOptions do
parseoptions(KoptOptions, i, "kopt_")
end
Dispatcher: allow registering actions at runtime
2020-10-12 03:06:04 +00:00
UIManager:broadcastEvent(Event:new("DispatcherRegisterActions"))
[plugin] Dispatcher: for profiles & gestures (#6106) add a Dispatcher module that allows for dispatching multiple events at once. This will allow for profiles & for gestures that do multiple things. it has 2 methods: Execute which is given a kv table of settings to change and fires an event for each of them. addSubMenu adds a menu item to a menu to allow for modifying which events are called it also has settingsList which is a master table of all allowed setting and their corresponding info (it is mostly from ReaderGesture and needs a lot of work) to allow for a new setting all one has to do is add a entry to settingsList with a corresponding event and it will work out of the box. the profile plugin is right now still a stub, just to test Dispatcher. the plan is to finish it and eventually refactor ReaderGesture to rely on this. This also needs effort to move many functions out of reader gesture into events where they belong.
2020-06-19 21:38:53 +00:00
Dispatcher.initialized = true
end
Dispatcher: allow registering actions at runtime
2020-10-12 03:06:04 +00:00
--[[--
ldoc fixes
2020-10-12 15:20:16 +00:00
Adds settings at runtime.
@usage
function Hello:onDispatcherRegisterActions()
Dispatcher: Revamp sections and item order
2021-09-10 20:11:24 +00:00
Dispatcher:registerAction("helloworld_action", {category="none", event="HelloWorld", title=_("Hello World"), general=true})
ldoc fixes
2020-10-12 15:20:16 +00:00
end
function Hello:init()
self:onDispatcherRegisterActions()
end
@param name the key to use in the table
@param value a table per settingsList above
Dispatcher: allow registering actions at runtime
2020-10-12 03:06:04 +00:00
--]]--
function Dispatcher:registerAction(name, value)
if settingsList[name] == nil then
settingsList[name] = value
table.insert(dispatcher_menu_order, name)
end
return true
end
Dispatcher:removeAction() Gestures: use sub_item_table_func to allow the menu to refresh on change
2021-09-10 20:14:07 +00:00
--[[--
Removes settings at runtime.
@param name the key to use in the table
--]]--
function Dispatcher:removeAction(name)
local k = util.arrayContains(dispatcher_menu_order, name)
if k then
table.remove(dispatcher_menu_order, k)
settingsList[name] = nil
end
return true
end
Dispatcher: Fixes, Sort & QuickMenu Fix condition check, simplify getNameFromItem Allow sorting Dispatcher items and displaying them as a QuickMenu
2022-09-19 02:22:41 +00:00
local function iter_func(settings)
if settings and settings.settings and settings.settings.order then
return ipairs(settings.settings.order)
else
return pairs(settings)
end
end
Dispatcher: get name from item & add separators to menu & fixes
2020-07-28 18:49:55 +00:00
-- Returns a display name for the item.
Dispatcher: Fixes, Sort & QuickMenu Fix condition check, simplify getNameFromItem Allow sorting Dispatcher items and displaying them as a QuickMenu
2022-09-19 02:22:41 +00:00
function Dispatcher:getNameFromItem(item, settings)
Dispatcher: allow registering actions at runtime
2020-10-12 03:06:04 +00:00
if settingsList[item] == nil then
return _("Unknown item")
end
Dispatcher: get name from item & add separators to menu & fixes
2020-07-28 18:49:55 +00:00
local amount
Dispatcher: Fixes, Sort & QuickMenu Fix condition check, simplify getNameFromItem Allow sorting Dispatcher items and displaying them as a QuickMenu
2022-09-19 02:22:41 +00:00
if settings ~= nil and settings[item] ~= nil then
amount = settings[item]
Dispatcher: get name from item & add separators to menu & fixes
2020-07-28 18:49:55 +00:00
end
Dispatcher: show selected number (#6472) followup to #6441
2020-08-17 07:55:03 +00:00
if amount == nil
or (amount == 0 and settingsList[item].category == "incrementalnumber")
then
amount = C_("Number placeholder", "#")
Dispatcher: get name from item & add separators to menu & fixes
2020-07-28 18:49:55 +00:00
end
return T(settingsList[item].title, amount)
end
Dispatcher: Fixes, Sort & QuickMenu Fix condition check, simplify getNameFromItem Allow sorting Dispatcher items and displaying them as a QuickMenu
2022-09-19 02:22:41 +00:00
-- Add the item to the end of the execution order.
-- If item or the order is nil all items will be added.
function Dispatcher:_addToOrder(location, settings, item)
if location[settings] then
if not location[settings].settings then location[settings].settings = {} end
if not location[settings].settings.order or item == nil then
location[settings].settings.order = {}
for k in pairs(location[settings]) do
if settingsList[k] ~= nil then
table.insert(location[settings].settings.order, k)
end
end
else
Dispatcher: Fix subtle bug with modified items being added twice to the sort index (#9628) Discovered by @poire-z in https://github.com/koreader/koreader/pull/9531#issuecomment-1274839234
2022-10-12 21:17:10 +00:00
if not util.arrayContains(location[settings].settings.order, item) then
table.insert(location[settings].settings.order, item)
end
Dispatcher: Fixes, Sort & QuickMenu Fix condition check, simplify getNameFromItem Allow sorting Dispatcher items and displaying them as a QuickMenu
2022-09-19 02:22:41 +00:00
end
end
end
-- Remove the item from the execution order.
-- If item is nil all items will be removed.
-- If the resulting order is empty it will be nilled
function Dispatcher:_removeFromOrder(location, settings, item)
if location[settings] and location[settings].settings then
if location[settings].settings.order then
if item then
local k = util.arrayContains(location[settings].settings.order, item)
if k then table.remove(location[settings].settings.order, k) end
else
location[settings].settings.order = {}
end
if next(location[settings].settings.order) == nil then
location[settings].settings.order = nil
if next(location[settings].settings) == nil then
location[settings].settings = nil
end
end
end
end
end
-- Get a textual representation of the enabled actions to display in a menu item.
function Dispatcher:menuTextFunc(settings)
local action_name = _("Pass through")
if settings then
local count = util.tableSize(settings)
if count == 0 then return _("Nothing") end
if count > 1 and settings.settings ~= nil then
count = count - 1
end
if count == 1 then
local item = next(settings)
if item == "settings" then item = next(settings, item) end
action_name = Dispatcher:getNameFromItem(item, settings)
else
action_name = _("Many")
end
end
return action_name
end
-- Get a list of all enabled actions to display in a menu.
function Dispatcher:getDisplayList(settings)
local item_table = {}
if not settings then return item_table end
for item, v in iter_func(settings) do
if type(item) == "number" then item = v end
if settingsList[item] ~= nil and (settingsList[item].condition == nil or settingsList[item].condition == true) then
table.insert(item_table, {text = Dispatcher:getNameFromItem(item, settings), key = item})
end
end
return item_table
end
-- Display a SortWidget to sort the enable actions execution order.
function Dispatcher:_sortActions(caller, location, settings, touchmenu_instance)
local display_list = Dispatcher:getDisplayList(location[settings])
local SortWidget = require("ui/widget/sortwidget")
local sort_widget
sort_widget = SortWidget:new{
title = _("Sort"),
item_table = display_list,
callback = function()
if location[settings] and next(location[settings]) ~= nil then
if not location[settings].settings then
location[settings].settings = {}
end
location[settings].settings.order = {}
for i, v in ipairs(sort_widget.item_table) do
location[settings].settings.order[i] = v.key
end
end
if touchmenu_instance then touchmenu_instance:updateItems() end
caller.updated = true
end
}
UIManager:show(sort_widget)
end
function Dispatcher:_addItem(caller, menu, location, settings, section)
Dispatcher: use sections (#6364) use `device` `filemanager` `rolling` and `paging` sections to organize the dispatcher menu and allow the user to know when the action will apply add events from ReaderGesture allow profiles in FM
2020-07-14 21:39:03 +00:00
for _, k in ipairs(dispatcher_menu_order) do
if settingsList[k][section] == true and
(settingsList[k].condition == nil or settingsList[k].condition)
then
if settingsList[k].category == "none" or settingsList[k].category == "arg" then
[plugin] Dispatcher: for profiles & gestures (#6106) add a Dispatcher module that allows for dispatching multiple events at once. This will allow for profiles & for gestures that do multiple things. it has 2 methods: Execute which is given a kv table of settings to change and fires an event for each of them. addSubMenu adds a menu item to a menu to allow for modifying which events are called it also has settingsList which is a master table of all allowed setting and their corresponding info (it is mostly from ReaderGesture and needs a lot of work) to allow for a new setting all one has to do is add a entry to settingsList with a corresponding event and it will work out of the box. the profile plugin is right now still a stub, just to test Dispatcher. the plan is to finish it and eventually refactor ReaderGesture to rely on this. This also needs effort to move many functions out of reader gesture into events where they belong.
2020-06-19 21:38:53 +00:00
table.insert(menu, {
Dispatcher: indentation
2021-05-25 14:12:16 +00:00
text = settingsList[k].title,
checked_func = function()
return location[settings] ~= nil and location[settings][k] ~= nil
end,
callback = function(touchmenu_instance)
if location[settings] == nil then
location[settings] = {}
end
if location[settings][k] then
location[settings][k] = nil
Dispatcher: Fixes, Sort & QuickMenu Fix condition check, simplify getNameFromItem Allow sorting Dispatcher items and displaying them as a QuickMenu
2022-09-19 02:22:41 +00:00
Dispatcher:_removeFromOrder(location, settings, k)
Dispatcher: indentation
2021-05-25 14:12:16 +00:00
else
location[settings][k] = true
Dispatcher: Fixes, Sort & QuickMenu Fix condition check, simplify getNameFromItem Allow sorting Dispatcher items and displaying them as a QuickMenu
2022-09-19 02:22:41 +00:00
Dispatcher:_addToOrder(location, settings, k)
Dispatcher: indentation
2021-05-25 14:12:16 +00:00
end
caller.updated = true
if touchmenu_instance then touchmenu_instance:updateItems() end
[plugin] Dispatcher: for profiles & gestures (#6106) add a Dispatcher module that allows for dispatching multiple events at once. This will allow for profiles & for gestures that do multiple things. it has 2 methods: Execute which is given a kv table of settings to change and fires an event for each of them. addSubMenu adds a menu item to a menu to allow for modifying which events are called it also has settingsList which is a master table of all allowed setting and their corresponding info (it is mostly from ReaderGesture and needs a lot of work) to allow for a new setting all one has to do is add a entry to settingsList with a corresponding event and it will work out of the box. the profile plugin is right now still a stub, just to test Dispatcher. the plan is to finish it and eventually refactor ReaderGesture to rely on this. This also needs effort to move many functions out of reader gesture into events where they belong.
2020-06-19 21:38:53 +00:00
end,
Dispatcher: indentation
2021-05-25 14:12:16 +00:00
separator = settingsList[k].separator,
})
[plugin] Dispatcher: for profiles & gestures (#6106) add a Dispatcher module that allows for dispatching multiple events at once. This will allow for profiles & for gestures that do multiple things. it has 2 methods: Execute which is given a kv table of settings to change and fires an event for each of them. addSubMenu adds a menu item to a menu to allow for modifying which events are called it also has settingsList which is a master table of all allowed setting and their corresponding info (it is mostly from ReaderGesture and needs a lot of work) to allow for a new setting all one has to do is add a entry to settingsList with a corresponding event and it will work out of the box. the profile plugin is right now still a stub, just to test Dispatcher. the plan is to finish it and eventually refactor ReaderGesture to rely on this. This also needs effort to move many functions out of reader gesture into events where they belong.
2020-06-19 21:38:53 +00:00
elseif settingsList[k].category == "absolutenumber" then
table.insert(menu, {
text_func = function()
Dispatcher: Fixes, Sort & QuickMenu Fix condition check, simplify getNameFromItem Allow sorting Dispatcher items and displaying them as a QuickMenu
2022-09-19 02:22:41 +00:00
return Dispatcher:getNameFromItem(k, location[settings])
[plugin] Dispatcher: for profiles & gestures (#6106) add a Dispatcher module that allows for dispatching multiple events at once. This will allow for profiles & for gestures that do multiple things. it has 2 methods: Execute which is given a kv table of settings to change and fires an event for each of them. addSubMenu adds a menu item to a menu to allow for modifying which events are called it also has settingsList which is a master table of all allowed setting and their corresponding info (it is mostly from ReaderGesture and needs a lot of work) to allow for a new setting all one has to do is add a entry to settingsList with a corresponding event and it will work out of the box. the profile plugin is right now still a stub, just to test Dispatcher. the plan is to finish it and eventually refactor ReaderGesture to rely on this. This also needs effort to move many functions out of reader gesture into events where they belong.
2020-06-19 21:38:53 +00:00
end,
checked_func = function()
simplify Dispatcher (#6435) there is no need to pass the caller rather just the table where the setting is located. passing the setting alone is not enough as sometimes it is nil and then you do not get a reference to its location
2020-07-28 01:26:56 +00:00
return location[settings] ~= nil and location[settings][k] ~= nil
[plugin] Dispatcher: for profiles & gestures (#6106) add a Dispatcher module that allows for dispatching multiple events at once. This will allow for profiles & for gestures that do multiple things. it has 2 methods: Execute which is given a kv table of settings to change and fires an event for each of them. addSubMenu adds a menu item to a menu to allow for modifying which events are called it also has settingsList which is a master table of all allowed setting and their corresponding info (it is mostly from ReaderGesture and needs a lot of work) to allow for a new setting all one has to do is add a entry to settingsList with a corresponding event and it will work out of the box. the profile plugin is right now still a stub, just to test Dispatcher. the plan is to finish it and eventually refactor ReaderGesture to rely on this. This also needs effort to move many functions out of reader gesture into events where they belong.
2020-06-19 21:38:53 +00:00
end,
callback = function(touchmenu_instance)
local SpinWidget = require("ui/widget/spinwidget")
Cleanup for #7626
2021-05-13 02:38:52 +00:00
local precision
Dispatcher: Make font size actions consistent with ConfigDialog's NumberPicker (#7626)
2021-05-05 18:48:42 +00:00
if settingsList[k].step and math.floor(settingsList[k].step) ~= settingsList[k].step then
Cleanup for #7626
2021-05-13 02:38:52 +00:00
precision = "%0.1f"
Dispatcher: Make font size actions consistent with ConfigDialog's NumberPicker (#7626)
2021-05-05 18:48:42 +00:00
end
[plugin] Dispatcher: for profiles & gestures (#6106) add a Dispatcher module that allows for dispatching multiple events at once. This will allow for profiles & for gestures that do multiple things. it has 2 methods: Execute which is given a kv table of settings to change and fires an event for each of them. addSubMenu adds a menu item to a menu to allow for modifying which events are called it also has settingsList which is a master table of all allowed setting and their corresponding info (it is mostly from ReaderGesture and needs a lot of work) to allow for a new setting all one has to do is add a entry to settingsList with a corresponding event and it will work out of the box. the profile plugin is right now still a stub, just to test Dispatcher. the plan is to finish it and eventually refactor ReaderGesture to rely on this. This also needs effort to move many functions out of reader gesture into events where they belong.
2020-06-19 21:38:53 +00:00
local items = SpinWidget:new{
Dispatcher: get name from item & add separators to menu & fixes
2020-07-28 18:49:55 +00:00
value = location[settings] ~= nil and location[settings][k] or settingsList[k].default or 0,
[plugin] Dispatcher: for profiles & gestures (#6106) add a Dispatcher module that allows for dispatching multiple events at once. This will allow for profiles & for gestures that do multiple things. it has 2 methods: Execute which is given a kv table of settings to change and fires an event for each of them. addSubMenu adds a menu item to a menu to allow for modifying which events are called it also has settingsList which is a master table of all allowed setting and their corresponding info (it is mostly from ReaderGesture and needs a lot of work) to allow for a new setting all one has to do is add a entry to settingsList with a corresponding event and it will work out of the box. the profile plugin is right now still a stub, just to test Dispatcher. the plan is to finish it and eventually refactor ReaderGesture to rely on this. This also needs effort to move many functions out of reader gesture into events where they belong.
2020-06-19 21:38:53 +00:00
value_min = settingsList[k].min,
Dispatcher: Make font size actions consistent with ConfigDialog's NumberPicker (#7626)
2021-05-05 18:48:42 +00:00
value_step = settingsList[k].step or 1,
Cleanup for #7626
2021-05-13 02:38:52 +00:00
precision = precision,
Dispatcher: increase hold_step for usability
2021-01-11 17:14:10 +00:00
value_hold_step = 5,
[plugin] Dispatcher: for profiles & gestures (#6106) add a Dispatcher module that allows for dispatching multiple events at once. This will allow for profiles & for gestures that do multiple things. it has 2 methods: Execute which is given a kv table of settings to change and fires an event for each of them. addSubMenu adds a menu item to a menu to allow for modifying which events are called it also has settingsList which is a master table of all allowed setting and their corresponding info (it is mostly from ReaderGesture and needs a lot of work) to allow for a new setting all one has to do is add a entry to settingsList with a corresponding event and it will work out of the box. the profile plugin is right now still a stub, just to test Dispatcher. the plan is to finish it and eventually refactor ReaderGesture to rely on this. This also needs effort to move many functions out of reader gesture into events where they belong.
2020-06-19 21:38:53 +00:00
value_max = settingsList[k].max,
Dispatcher: Make font size actions consistent with ConfigDialog's NumberPicker (#7626)
2021-05-05 18:48:42 +00:00
default_value = settingsList[k].default,
Dispatcher: Fixes, Sort & QuickMenu Fix condition check, simplify getNameFromItem Allow sorting Dispatcher items and displaying them as a QuickMenu
2022-09-19 02:22:41 +00:00
title_text = Dispatcher:getNameFromItem(k, location[settings]),
SpinWidget in Dispatcher fix (#8558) Enable SpinWidget OK button in dispatcher for unchanged value.
2021-12-16 11:55:05 +00:00
ok_always_enabled = true,
[plugin] Dispatcher: for profiles & gestures (#6106) add a Dispatcher module that allows for dispatching multiple events at once. This will allow for profiles & for gestures that do multiple things. it has 2 methods: Execute which is given a kv table of settings to change and fires an event for each of them. addSubMenu adds a menu item to a menu to allow for modifying which events are called it also has settingsList which is a master table of all allowed setting and their corresponding info (it is mostly from ReaderGesture and needs a lot of work) to allow for a new setting all one has to do is add a entry to settingsList with a corresponding event and it will work out of the box. the profile plugin is right now still a stub, just to test Dispatcher. the plan is to finish it and eventually refactor ReaderGesture to rely on this. This also needs effort to move many functions out of reader gesture into events where they belong.
2020-06-19 21:38:53 +00:00
callback = function(spin)
Dispatcher: get name from item & add separators to menu & fixes
2020-07-28 18:49:55 +00:00
if location[settings] == nil then
location[settings] = {}
end
simplify Dispatcher (#6435) there is no need to pass the caller rather just the table where the setting is located. passing the setting alone is not enough as sometimes it is nil and then you do not get a reference to its location
2020-07-28 01:26:56 +00:00
location[settings][k] = spin.value
Dispatcher: Fixes, Sort & QuickMenu Fix condition check, simplify getNameFromItem Allow sorting Dispatcher items and displaying them as a QuickMenu
2022-09-19 02:22:41 +00:00
Dispatcher:_addToOrder(location, settings, k)
Dispatcher Gestures Profiles: only flush settings when changed (#6471)
2020-08-04 22:19:28 +00:00
caller.updated = true
[plugin] Dispatcher: for profiles & gestures (#6106) add a Dispatcher module that allows for dispatching multiple events at once. This will allow for profiles & for gestures that do multiple things. it has 2 methods: Execute which is given a kv table of settings to change and fires an event for each of them. addSubMenu adds a menu item to a menu to allow for modifying which events are called it also has settingsList which is a master table of all allowed setting and their corresponding info (it is mostly from ReaderGesture and needs a lot of work) to allow for a new setting all one has to do is add a entry to settingsList with a corresponding event and it will work out of the box. the profile plugin is right now still a stub, just to test Dispatcher. the plan is to finish it and eventually refactor ReaderGesture to rely on this. This also needs effort to move many functions out of reader gesture into events where they belong.
2020-06-19 21:38:53 +00:00
if touchmenu_instance then
touchmenu_instance:updateItems()
end
end
}
UIManager:show(items)
end,
hold_callback = function(touchmenu_instance)
Dispatcher: get name from item & add separators to menu & fixes
2020-07-28 18:49:55 +00:00
if location[settings] ~= nil and location[settings][k] ~= nil then
location[settings][k] = nil
Dispatcher: Fixes, Sort & QuickMenu Fix condition check, simplify getNameFromItem Allow sorting Dispatcher items and displaying them as a QuickMenu
2022-09-19 02:22:41 +00:00
Dispatcher:_removeFromOrder(location, settings, k)
Dispatcher Gestures Profiles: only flush settings when changed (#6471)
2020-08-04 22:19:28 +00:00
caller.updated = true
Dispatcher: get name from item & add separators to menu & fixes
2020-07-28 18:49:55 +00:00
end
[plugin] Dispatcher: for profiles & gestures (#6106) add a Dispatcher module that allows for dispatching multiple events at once. This will allow for profiles & for gestures that do multiple things. it has 2 methods: Execute which is given a kv table of settings to change and fires an event for each of them. addSubMenu adds a menu item to a menu to allow for modifying which events are called it also has settingsList which is a master table of all allowed setting and their corresponding info (it is mostly from ReaderGesture and needs a lot of work) to allow for a new setting all one has to do is add a entry to settingsList with a corresponding event and it will work out of the box. the profile plugin is right now still a stub, just to test Dispatcher. the plan is to finish it and eventually refactor ReaderGesture to rely on this. This also needs effort to move many functions out of reader gesture into events where they belong.
2020-06-19 21:38:53 +00:00
if touchmenu_instance then touchmenu_instance:updateItems() end
end,
Dispatcher: use sections (#6364) use `device` `filemanager` `rolling` and `paging` sections to organize the dispatcher menu and allow the user to know when the action will apply add events from ReaderGesture allow profiles in FM
2020-07-14 21:39:03 +00:00
separator = settingsList[k].separator,
[plugin] Dispatcher: for profiles & gestures (#6106) add a Dispatcher module that allows for dispatching multiple events at once. This will allow for profiles & for gestures that do multiple things. it has 2 methods: Execute which is given a kv table of settings to change and fires an event for each of them. addSubMenu adds a menu item to a menu to allow for modifying which events are called it also has settingsList which is a master table of all allowed setting and their corresponding info (it is mostly from ReaderGesture and needs a lot of work) to allow for a new setting all one has to do is add a entry to settingsList with a corresponding event and it will work out of the box. the profile plugin is right now still a stub, just to test Dispatcher. the plan is to finish it and eventually refactor ReaderGesture to rely on this. This also needs effort to move many functions out of reader gesture into events where they belong.
2020-06-19 21:38:53 +00:00
})
elseif settingsList[k].category == "incrementalnumber" then
table.insert(menu, {
text_func = function()
Dispatcher: Fixes, Sort & QuickMenu Fix condition check, simplify getNameFromItem Allow sorting Dispatcher items and displaying them as a QuickMenu
2022-09-19 02:22:41 +00:00
return Dispatcher:getNameFromItem(k, location[settings])
[plugin] Dispatcher: for profiles & gestures (#6106) add a Dispatcher module that allows for dispatching multiple events at once. This will allow for profiles & for gestures that do multiple things. it has 2 methods: Execute which is given a kv table of settings to change and fires an event for each of them. addSubMenu adds a menu item to a menu to allow for modifying which events are called it also has settingsList which is a master table of all allowed setting and their corresponding info (it is mostly from ReaderGesture and needs a lot of work) to allow for a new setting all one has to do is add a entry to settingsList with a corresponding event and it will work out of the box. the profile plugin is right now still a stub, just to test Dispatcher. the plan is to finish it and eventually refactor ReaderGesture to rely on this. This also needs effort to move many functions out of reader gesture into events where they belong.
2020-06-19 21:38:53 +00:00
end,
checked_func = function()
simplify Dispatcher (#6435) there is no need to pass the caller rather just the table where the setting is located. passing the setting alone is not enough as sometimes it is nil and then you do not get a reference to its location
2020-07-28 01:26:56 +00:00
return location[settings] ~= nil and location[settings][k] ~= nil
[plugin] Dispatcher: for profiles & gestures (#6106) add a Dispatcher module that allows for dispatching multiple events at once. This will allow for profiles & for gestures that do multiple things. it has 2 methods: Execute which is given a kv table of settings to change and fires an event for each of them. addSubMenu adds a menu item to a menu to allow for modifying which events are called it also has settingsList which is a master table of all allowed setting and their corresponding info (it is mostly from ReaderGesture and needs a lot of work) to allow for a new setting all one has to do is add a entry to settingsList with a corresponding event and it will work out of the box. the profile plugin is right now still a stub, just to test Dispatcher. the plan is to finish it and eventually refactor ReaderGesture to rely on this. This also needs effort to move many functions out of reader gesture into events where they belong.
2020-06-19 21:38:53 +00:00
end,
callback = function(touchmenu_instance)
Dispatcher: use sections (#6364) use `device` `filemanager` `rolling` and `paging` sections to organize the dispatcher menu and allow the user to know when the action will apply add events from ReaderGesture allow profiles in FM
2020-07-14 21:39:03 +00:00
local _ = require("gettext")
Cleanup for #7626
2021-05-13 02:38:52 +00:00
local precision
Dispatcher: Make font size actions consistent with ConfigDialog's NumberPicker (#7626)
2021-05-05 18:48:42 +00:00
if settingsList[k].step and math.floor(settingsList[k].step) ~= settingsList[k].step then
Cleanup for #7626
2021-05-13 02:38:52 +00:00
precision = "%0.1f"
Dispatcher: Make font size actions consistent with ConfigDialog's NumberPicker (#7626)
2021-05-05 18:48:42 +00:00
end
[plugin] Dispatcher: for profiles & gestures (#6106) add a Dispatcher module that allows for dispatching multiple events at once. This will allow for profiles & for gestures that do multiple things. it has 2 methods: Execute which is given a kv table of settings to change and fires an event for each of them. addSubMenu adds a menu item to a menu to allow for modifying which events are called it also has settingsList which is a master table of all allowed setting and their corresponding info (it is mostly from ReaderGesture and needs a lot of work) to allow for a new setting all one has to do is add a entry to settingsList with a corresponding event and it will work out of the box. the profile plugin is right now still a stub, just to test Dispatcher. the plan is to finish it and eventually refactor ReaderGesture to rely on this. This also needs effort to move many functions out of reader gesture into events where they belong.
2020-06-19 21:38:53 +00:00
local SpinWidget = require("ui/widget/spinwidget")
local items = SpinWidget:new{
Dispatcher: get name from item & add separators to menu & fixes
2020-07-28 18:49:55 +00:00
value = location[settings] ~= nil and location[settings][k] or 0,
[plugin] Dispatcher: for profiles & gestures (#6106) add a Dispatcher module that allows for dispatching multiple events at once. This will allow for profiles & for gestures that do multiple things. it has 2 methods: Execute which is given a kv table of settings to change and fires an event for each of them. addSubMenu adds a menu item to a menu to allow for modifying which events are called it also has settingsList which is a master table of all allowed setting and their corresponding info (it is mostly from ReaderGesture and needs a lot of work) to allow for a new setting all one has to do is add a entry to settingsList with a corresponding event and it will work out of the box. the profile plugin is right now still a stub, just to test Dispatcher. the plan is to finish it and eventually refactor ReaderGesture to rely on this. This also needs effort to move many functions out of reader gesture into events where they belong.
2020-06-19 21:38:53 +00:00
value_min = settingsList[k].min,
Dispatcher: Make font size actions consistent with ConfigDialog's NumberPicker (#7626)
2021-05-05 18:48:42 +00:00
value_step = settingsList[k].step or 1,
Cleanup for #7626
2021-05-13 02:38:52 +00:00
precision = precision,
Dispatcher: increase hold_step for usability
2021-01-11 17:14:10 +00:00
value_hold_step = 5,
[plugin] Dispatcher: for profiles & gestures (#6106) add a Dispatcher module that allows for dispatching multiple events at once. This will allow for profiles & for gestures that do multiple things. it has 2 methods: Execute which is given a kv table of settings to change and fires an event for each of them. addSubMenu adds a menu item to a menu to allow for modifying which events are called it also has settingsList which is a master table of all allowed setting and their corresponding info (it is mostly from ReaderGesture and needs a lot of work) to allow for a new setting all one has to do is add a entry to settingsList with a corresponding event and it will work out of the box. the profile plugin is right now still a stub, just to test Dispatcher. the plan is to finish it and eventually refactor ReaderGesture to rely on this. This also needs effort to move many functions out of reader gesture into events where they belong.
2020-06-19 21:38:53 +00:00
value_max = settingsList[k].max,
default_value = 0,
Dispatcher: Fixes, Sort & QuickMenu Fix condition check, simplify getNameFromItem Allow sorting Dispatcher items and displaying them as a QuickMenu
2022-09-19 02:22:41 +00:00
title_text = Dispatcher:getNameFromItem(k, location[settings]),
Dispatcher: use sections (#6364) use `device` `filemanager` `rolling` and `paging` sections to organize the dispatcher menu and allow the user to know when the action will apply add events from ReaderGesture allow profiles in FM
2020-07-14 21:39:03 +00:00
info_text = _([[If called by a gesture the amount of the gesture will be used]]),
SpinWidget in Dispatcher fix (#8558) Enable SpinWidget OK button in dispatcher for unchanged value.
2021-12-16 11:55:05 +00:00
ok_always_enabled = true,
[plugin] Dispatcher: for profiles & gestures (#6106) add a Dispatcher module that allows for dispatching multiple events at once. This will allow for profiles & for gestures that do multiple things. it has 2 methods: Execute which is given a kv table of settings to change and fires an event for each of them. addSubMenu adds a menu item to a menu to allow for modifying which events are called it also has settingsList which is a master table of all allowed setting and their corresponding info (it is mostly from ReaderGesture and needs a lot of work) to allow for a new setting all one has to do is add a entry to settingsList with a corresponding event and it will work out of the box. the profile plugin is right now still a stub, just to test Dispatcher. the plan is to finish it and eventually refactor ReaderGesture to rely on this. This also needs effort to move many functions out of reader gesture into events where they belong.
2020-06-19 21:38:53 +00:00
callback = function(spin)
Dispatcher: get name from item & add separators to menu & fixes
2020-07-28 18:49:55 +00:00
if location[settings] == nil then
location[settings] = {}
end
simplify Dispatcher (#6435) there is no need to pass the caller rather just the table where the setting is located. passing the setting alone is not enough as sometimes it is nil and then you do not get a reference to its location
2020-07-28 01:26:56 +00:00
location[settings][k] = spin.value
Dispatcher: Fixes, Sort & QuickMenu Fix condition check, simplify getNameFromItem Allow sorting Dispatcher items and displaying them as a QuickMenu
2022-09-19 02:22:41 +00:00
Dispatcher:_addToOrder(location, settings, k)
Dispatcher Gestures Profiles: only flush settings when changed (#6471)
2020-08-04 22:19:28 +00:00
caller.updated = true
[plugin] Dispatcher: for profiles & gestures (#6106) add a Dispatcher module that allows for dispatching multiple events at once. This will allow for profiles & for gestures that do multiple things. it has 2 methods: Execute which is given a kv table of settings to change and fires an event for each of them. addSubMenu adds a menu item to a menu to allow for modifying which events are called it also has settingsList which is a master table of all allowed setting and their corresponding info (it is mostly from ReaderGesture and needs a lot of work) to allow for a new setting all one has to do is add a entry to settingsList with a corresponding event and it will work out of the box. the profile plugin is right now still a stub, just to test Dispatcher. the plan is to finish it and eventually refactor ReaderGesture to rely on this. This also needs effort to move many functions out of reader gesture into events where they belong.
2020-06-19 21:38:53 +00:00
if touchmenu_instance then
touchmenu_instance:updateItems()
end
end
}
UIManager:show(items)
end,
hold_callback = function(touchmenu_instance)
Dispatcher: get name from item & add separators to menu & fixes
2020-07-28 18:49:55 +00:00
if location[settings] ~= nil and location[settings][k] ~= nil then
location[settings][k] = nil
Dispatcher: Fixes, Sort & QuickMenu Fix condition check, simplify getNameFromItem Allow sorting Dispatcher items and displaying them as a QuickMenu
2022-09-19 02:22:41 +00:00
Dispatcher:_removeFromOrder(location, settings, k)
Dispatcher Gestures Profiles: only flush settings when changed (#6471)
2020-08-04 22:19:28 +00:00
caller.updated = true
Dispatcher: get name from item & add separators to menu & fixes
2020-07-28 18:49:55 +00:00
end
[plugin] Dispatcher: for profiles & gestures (#6106) add a Dispatcher module that allows for dispatching multiple events at once. This will allow for profiles & for gestures that do multiple things. it has 2 methods: Execute which is given a kv table of settings to change and fires an event for each of them. addSubMenu adds a menu item to a menu to allow for modifying which events are called it also has settingsList which is a master table of all allowed setting and their corresponding info (it is mostly from ReaderGesture and needs a lot of work) to allow for a new setting all one has to do is add a entry to settingsList with a corresponding event and it will work out of the box. the profile plugin is right now still a stub, just to test Dispatcher. the plan is to finish it and eventually refactor ReaderGesture to rely on this. This also needs effort to move many functions out of reader gesture into events where they belong.
2020-06-19 21:38:53 +00:00
if touchmenu_instance then
touchmenu_instance:updateItems()
end
end,
Dispatcher: use sections (#6364) use `device` `filemanager` `rolling` and `paging` sections to organize the dispatcher menu and allow the user to know when the action will apply add events from ReaderGesture allow profiles in FM
2020-07-14 21:39:03 +00:00
separator = settingsList[k].separator,
[plugin] Dispatcher: for profiles & gestures (#6106) add a Dispatcher module that allows for dispatching multiple events at once. This will allow for profiles & for gestures that do multiple things. it has 2 methods: Execute which is given a kv table of settings to change and fires an event for each of them. addSubMenu adds a menu item to a menu to allow for modifying which events are called it also has settingsList which is a master table of all allowed setting and their corresponding info (it is mostly from ReaderGesture and needs a lot of work) to allow for a new setting all one has to do is add a entry to settingsList with a corresponding event and it will work out of the box. the profile plugin is right now still a stub, just to test Dispatcher. the plan is to finish it and eventually refactor ReaderGesture to rely on this. This also needs effort to move many functions out of reader gesture into events where they belong.
2020-06-19 21:38:53 +00:00
})
Dispatcher: initial Kopt support
2021-05-14 22:13:27 +00:00
elseif settingsList[k].category == "string" or settingsList[k].category == "configurable" then
[plugin] Dispatcher: for profiles & gestures (#6106) add a Dispatcher module that allows for dispatching multiple events at once. This will allow for profiles & for gestures that do multiple things. it has 2 methods: Execute which is given a kv table of settings to change and fires an event for each of them. addSubMenu adds a menu item to a menu to allow for modifying which events are called it also has settingsList which is a master table of all allowed setting and their corresponding info (it is mostly from ReaderGesture and needs a lot of work) to allow for a new setting all one has to do is add a entry to settingsList with a corresponding event and it will work out of the box. the profile plugin is right now still a stub, just to test Dispatcher. the plan is to finish it and eventually refactor ReaderGesture to rely on this. This also needs effort to move many functions out of reader gesture into events where they belong.
2020-06-19 21:38:53 +00:00
local sub_item_table = {}
Dispatcher: allow args_func
2021-12-16 20:30:48 +00:00
if settingsList[k].args_func then
settingsList[k].args, settingsList[k].toggle = settingsList[k].args_func()
end
[plugin] Dispatcher: for profiles & gestures (#6106) add a Dispatcher module that allows for dispatching multiple events at once. This will allow for profiles & for gestures that do multiple things. it has 2 methods: Execute which is given a kv table of settings to change and fires an event for each of them. addSubMenu adds a menu item to a menu to allow for modifying which events are called it also has settingsList which is a master table of all allowed setting and their corresponding info (it is mostly from ReaderGesture and needs a lot of work) to allow for a new setting all one has to do is add a entry to settingsList with a corresponding event and it will work out of the box. the profile plugin is right now still a stub, just to test Dispatcher. the plan is to finish it and eventually refactor ReaderGesture to rely on this. This also needs effort to move many functions out of reader gesture into events where they belong.
2020-06-19 21:38:53 +00:00
for i=1,#settingsList[k].args do
table.insert(sub_item_table, {
text = tostring(settingsList[k].toggle[i]),
checked_func = function()
simplify Dispatcher (#6435) there is no need to pass the caller rather just the table where the setting is located. passing the setting alone is not enough as sometimes it is nil and then you do not get a reference to its location
2020-07-28 01:26:56 +00:00
return location[settings] ~= nil
and location[settings][k] ~= nil
and location[settings][k] == settingsList[k].args[i]
[plugin] Dispatcher: for profiles & gestures (#6106) add a Dispatcher module that allows for dispatching multiple events at once. This will allow for profiles & for gestures that do multiple things. it has 2 methods: Execute which is given a kv table of settings to change and fires an event for each of them. addSubMenu adds a menu item to a menu to allow for modifying which events are called it also has settingsList which is a master table of all allowed setting and their corresponding info (it is mostly from ReaderGesture and needs a lot of work) to allow for a new setting all one has to do is add a entry to settingsList with a corresponding event and it will work out of the box. the profile plugin is right now still a stub, just to test Dispatcher. the plan is to finish it and eventually refactor ReaderGesture to rely on this. This also needs effort to move many functions out of reader gesture into events where they belong.
2020-06-19 21:38:53 +00:00
end,
callback = function()
Dispatcher: get name from item & add separators to menu & fixes
2020-07-28 18:49:55 +00:00
if location[settings] == nil then
location[settings] = {}
end
simplify Dispatcher (#6435) there is no need to pass the caller rather just the table where the setting is located. passing the setting alone is not enough as sometimes it is nil and then you do not get a reference to its location
2020-07-28 01:26:56 +00:00
location[settings][k] = settingsList[k].args[i]
Dispatcher: Fixes, Sort & QuickMenu Fix condition check, simplify getNameFromItem Allow sorting Dispatcher items and displaying them as a QuickMenu
2022-09-19 02:22:41 +00:00
Dispatcher:_addToOrder(location, settings, k)
Dispatcher Gestures Profiles: only flush settings when changed (#6471)
2020-08-04 22:19:28 +00:00
caller.updated = true
[plugin] Dispatcher: for profiles & gestures (#6106) add a Dispatcher module that allows for dispatching multiple events at once. This will allow for profiles & for gestures that do multiple things. it has 2 methods: Execute which is given a kv table of settings to change and fires an event for each of them. addSubMenu adds a menu item to a menu to allow for modifying which events are called it also has settingsList which is a master table of all allowed setting and their corresponding info (it is mostly from ReaderGesture and needs a lot of work) to allow for a new setting all one has to do is add a entry to settingsList with a corresponding event and it will work out of the box. the profile plugin is right now still a stub, just to test Dispatcher. the plan is to finish it and eventually refactor ReaderGesture to rely on this. This also needs effort to move many functions out of reader gesture into events where they belong.
2020-06-19 21:38:53 +00:00
end,
})
end
table.insert(menu, {
text_func = function()
Dispatcher: Fixes, Sort & QuickMenu Fix condition check, simplify getNameFromItem Allow sorting Dispatcher items and displaying them as a QuickMenu
2022-09-19 02:22:41 +00:00
return Dispatcher:getNameFromItem(k, location[settings])
[plugin] Dispatcher: for profiles & gestures (#6106) add a Dispatcher module that allows for dispatching multiple events at once. This will allow for profiles & for gestures that do multiple things. it has 2 methods: Execute which is given a kv table of settings to change and fires an event for each of them. addSubMenu adds a menu item to a menu to allow for modifying which events are called it also has settingsList which is a master table of all allowed setting and their corresponding info (it is mostly from ReaderGesture and needs a lot of work) to allow for a new setting all one has to do is add a entry to settingsList with a corresponding event and it will work out of the box. the profile plugin is right now still a stub, just to test Dispatcher. the plan is to finish it and eventually refactor ReaderGesture to rely on this. This also needs effort to move many functions out of reader gesture into events where they belong.
2020-06-19 21:38:53 +00:00
end,
checked_func = function()
Dispatcher: get name from item & add separators to menu & fixes
2020-07-28 18:49:55 +00:00
return location[settings] ~= nil and location[settings][k] ~= nil
[plugin] Dispatcher: for profiles & gestures (#6106) add a Dispatcher module that allows for dispatching multiple events at once. This will allow for profiles & for gestures that do multiple things. it has 2 methods: Execute which is given a kv table of settings to change and fires an event for each of them. addSubMenu adds a menu item to a menu to allow for modifying which events are called it also has settingsList which is a master table of all allowed setting and their corresponding info (it is mostly from ReaderGesture and needs a lot of work) to allow for a new setting all one has to do is add a entry to settingsList with a corresponding event and it will work out of the box. the profile plugin is right now still a stub, just to test Dispatcher. the plan is to finish it and eventually refactor ReaderGesture to rely on this. This also needs effort to move many functions out of reader gesture into events where they belong.
2020-06-19 21:38:53 +00:00
end,
sub_item_table = sub_item_table,
keep_menu_open = true,
hold_callback = function(touchmenu_instance)
Dispatcher: get name from item & add separators to menu & fixes
2020-07-28 18:49:55 +00:00
if location[settings] ~= nil and location[settings][k] ~= nil then
location[settings][k] = nil
Dispatcher: Fixes, Sort & QuickMenu Fix condition check, simplify getNameFromItem Allow sorting Dispatcher items and displaying them as a QuickMenu
2022-09-19 02:22:41 +00:00
Dispatcher:_removeFromOrder(location, settings, k)
Dispatcher Gestures Profiles: only flush settings when changed (#6471)
2020-08-04 22:19:28 +00:00
caller.updated = true
Dispatcher: get name from item & add separators to menu & fixes
2020-07-28 18:49:55 +00:00
end
[plugin] Dispatcher: for profiles & gestures (#6106) add a Dispatcher module that allows for dispatching multiple events at once. This will allow for profiles & for gestures that do multiple things. it has 2 methods: Execute which is given a kv table of settings to change and fires an event for each of them. addSubMenu adds a menu item to a menu to allow for modifying which events are called it also has settingsList which is a master table of all allowed setting and their corresponding info (it is mostly from ReaderGesture and needs a lot of work) to allow for a new setting all one has to do is add a entry to settingsList with a corresponding event and it will work out of the box. the profile plugin is right now still a stub, just to test Dispatcher. the plan is to finish it and eventually refactor ReaderGesture to rely on this. This also needs effort to move many functions out of reader gesture into events where they belong.
2020-06-19 21:38:53 +00:00
if touchmenu_instance then
touchmenu_instance:updateItems()
end
end,
Dispatcher: use sections (#6364) use `device` `filemanager` `rolling` and `paging` sections to organize the dispatcher menu and allow the user to know when the action will apply add events from ReaderGesture allow profiles in FM
2020-07-14 21:39:03 +00:00
separator = settingsList[k].separator,
TouchMenu: open to items page when going up a level Builds on #7490
2021-05-25 14:16:53 +00:00
menu_item_id = k,
[plugin] Dispatcher: for profiles & gestures (#6106) add a Dispatcher module that allows for dispatching multiple events at once. This will allow for profiles & for gestures that do multiple things. it has 2 methods: Execute which is given a kv table of settings to change and fires an event for each of them. addSubMenu adds a menu item to a menu to allow for modifying which events are called it also has settingsList which is a master table of all allowed setting and their corresponding info (it is mostly from ReaderGesture and needs a lot of work) to allow for a new setting all one has to do is add a entry to settingsList with a corresponding event and it will work out of the box. the profile plugin is right now still a stub, just to test Dispatcher. the plan is to finish it and eventually refactor ReaderGesture to rely on this. This also needs effort to move many functions out of reader gesture into events where they belong.
2020-06-19 21:38:53 +00:00
})
end
end
Dispatcher: use sections (#6364) use `device` `filemanager` `rolling` and `paging` sections to organize the dispatcher menu and allow the user to know when the action will apply add events from ReaderGesture allow profiles in FM
2020-07-14 21:39:03 +00:00
end
end
--[[--
Add a submenu to edit which items are dispatched
arguments are:
Dispatcher Gestures Profiles: only flush settings when changed (#6471)
2020-08-04 22:19:28 +00:00
1) the caller so dispatcher can set the updated flag
2) the table representing the submenu (can be empty)
3) the object (table) in which the settings table is found
4) the name of the settings table
Dispatcher: use sections (#6364) use `device` `filemanager` `rolling` and `paging` sections to organize the dispatcher menu and allow the user to know when the action will apply add events from ReaderGesture allow profiles in FM
2020-07-14 21:39:03 +00:00
example usage:
Dispatcher:removeAction() Gestures: use sub_item_table_func to allow the menu to refresh on change
2021-09-10 20:14:07 +00:00
Dispatcher:addSubMenu(self, sub_items, self.data, "profile1")
Dispatcher: use sections (#6364) use `device` `filemanager` `rolling` and `paging` sections to organize the dispatcher menu and allow the user to know when the action will apply add events from ReaderGesture allow profiles in FM
2020-07-14 21:39:03 +00:00
--]]--
Dispatcher Gestures Profiles: only flush settings when changed (#6471)
2020-08-04 22:19:28 +00:00
function Dispatcher:addSubMenu(caller, menu, location, settings)
Gestures/Profiles: make sure dispatcher is initalized even when the menu is not opened. this was causing a crash when the event name was parsed from creoptions
2020-09-22 00:05:02 +00:00
Dispatcher:init()
Dispatcher: use sections (#6364) use `device` `filemanager` `rolling` and `paging` sections to organize the dispatcher menu and allow the user to know when the action will apply add events from ReaderGesture allow profiles in FM
2020-07-14 21:39:03 +00:00
table.insert(menu, {
Dispatcher: get name from item & add separators to menu & fixes
2020-07-28 18:49:55 +00:00
text = _("Nothing"),
Dispatcher: use sections (#6364) use `device` `filemanager` `rolling` and `paging` sections to organize the dispatcher menu and allow the user to know when the action will apply add events from ReaderGesture allow profiles in FM
2020-07-14 21:39:03 +00:00
separator = true,
checked_func = function()
Dispatcher: get name from item & add separators to menu & fixes
2020-07-28 18:49:55 +00:00
return location[settings] ~= nil and next(location[settings]) == nil
Dispatcher: use sections (#6364) use `device` `filemanager` `rolling` and `paging` sections to organize the dispatcher menu and allow the user to know when the action will apply add events from ReaderGesture allow profiles in FM
2020-07-14 21:39:03 +00:00
end,
callback = function(touchmenu_instance)
simplify Dispatcher (#6435) there is no need to pass the caller rather just the table where the setting is located. passing the setting alone is not enough as sometimes it is nil and then you do not get a reference to its location
2020-07-28 01:26:56 +00:00
location[settings] = {}
Dispatcher Gestures Profiles: only flush settings when changed (#6471)
2020-08-04 22:19:28 +00:00
caller.updated = true
Dispatcher: use sections (#6364) use `device` `filemanager` `rolling` and `paging` sections to organize the dispatcher menu and allow the user to know when the action will apply add events from ReaderGesture allow profiles in FM
2020-07-14 21:39:03 +00:00
if touchmenu_instance then touchmenu_instance:updateItems() end
end,
})
local section_list = {
Dispatcher: Revamp sections and item order
2021-09-10 20:11:24 +00:00
{"general", _("General")},
Dispatcher: use sections (#6364) use `device` `filemanager` `rolling` and `paging` sections to organize the dispatcher menu and allow the user to know when the action will apply add events from ReaderGesture allow profiles in FM
2020-07-14 21:39:03 +00:00
{"device", _("Device")},
Dispatcher: adjust "screen and lights" to style guide (#8215) Same as "Taps and gestures"
2021-09-14 07:22:43 +00:00
{"screen", _("Screen and lights")},
[fix, lang] Filemanager → file browser consistency (#6387)
2020-07-17 07:57:46 +00:00
{"filemanager", _("File browser")},
Dispatcher: Revamp sections and item order
2021-09-10 20:11:24 +00:00
{"reader", _("Reader")},
Dispatcher: use sections (#6364) use `device` `filemanager` `rolling` and `paging` sections to organize the dispatcher menu and allow the user to know when the action will apply add events from ReaderGesture allow profiles in FM
2020-07-14 21:39:03 +00:00
{"rolling", _("Reflowable documents (epub, fb2, txt…)")},
{"paging", _("Fixed layout documents (pdf, djvu, pics…)")},
}
for _, section in ipairs(section_list) do
local submenu = {}
Dispatcher: Fixes, Sort & QuickMenu Fix condition check, simplify getNameFromItem Allow sorting Dispatcher items and displaying them as a QuickMenu
2022-09-19 02:22:41 +00:00
Dispatcher:_addItem(caller, submenu, location, settings, section[1])
Dispatcher: use sections (#6364) use `device` `filemanager` `rolling` and `paging` sections to organize the dispatcher menu and allow the user to know when the action will apply add events from ReaderGesture allow profiles in FM
2020-07-14 21:39:03 +00:00
table.insert(menu, {
text = section[2],
Dispatcher: get name from item & add separators to menu & fixes
2020-07-28 18:49:55 +00:00
checked_func = function()
if location[settings] ~= nil then
for k, _ in pairs(location[settings]) do
Dispatcher: allow registering actions at runtime
2020-10-12 03:06:04 +00:00
if settingsList[k] ~= nil and settingsList[k][section[1]] == true and
Dispatcher: get name from item & add separators to menu & fixes
2020-07-28 18:49:55 +00:00
(settingsList[k].condition == nil or settingsList[k].condition)
then return true end
end
end
end,
hold_callback = function(touchmenu_instance)
if location[settings] ~= nil then
for k, _ in pairs(location[settings]) do
Dispatcher: allow registering actions at runtime
2020-10-12 03:06:04 +00:00
if settingsList[k] ~= nil and settingsList[k][section[1]] == true then
Dispatcher: get name from item & add separators to menu & fixes
2020-07-28 18:49:55 +00:00
location[settings][k] = nil
Dispatcher: Fixes, Sort & QuickMenu Fix condition check, simplify getNameFromItem Allow sorting Dispatcher items and displaying them as a QuickMenu
2022-09-19 02:22:41 +00:00
Dispatcher:_removeFromOrder(location, settings, k)
Dispatcher Gestures Profiles: only flush settings when changed (#6471)
2020-08-04 22:19:28 +00:00
caller.updated = true
Dispatcher: get name from item & add separators to menu & fixes
2020-07-28 18:49:55 +00:00
end
end
if touchmenu_instance then touchmenu_instance:updateItems() end
end
end,
Dispatcher: use sections (#6364) use `device` `filemanager` `rolling` and `paging` sections to organize the dispatcher menu and allow the user to know when the action will apply add events from ReaderGesture allow profiles in FM
2020-07-14 21:39:03 +00:00
sub_item_table = submenu,
})
end
Dispatcher: Fixes, Sort & QuickMenu Fix condition check, simplify getNameFromItem Allow sorting Dispatcher items and displaying them as a QuickMenu
2022-09-19 02:22:41 +00:00
menu[#menu].separator = true
table.insert(menu, {
text = _("Show as QuickMenu"),
checked_func = function()
return location[settings] ~= nil
and location[settings].settings ~= nil
and location[settings].settings.show_as_quickmenu
end,
callback = function()
Dispatcher: QuickMenu: Fix footgun Fixes: #9594
2022-10-06 00:46:58 +00:00
if location[settings] then
if location[settings].settings then
if location[settings].settings.show_as_quickmenu then
location[settings].settings.show_as_quickmenu = nil
if next(location[settings].settings) == nil then
location[settings].settings = nil
end
else
location[settings].settings.show_as_quickmenu = true
Dispatcher: Fixes, Sort & QuickMenu Fix condition check, simplify getNameFromItem Allow sorting Dispatcher items and displaying them as a QuickMenu
2022-09-19 02:22:41 +00:00
end
else
Dispatcher: QuickMenu: Fix footgun Fixes: #9594
2022-10-06 00:46:58 +00:00
location[settings].settings = {["show_as_quickmenu"] = true}
Dispatcher: Fixes, Sort & QuickMenu Fix condition check, simplify getNameFromItem Allow sorting Dispatcher items and displaying them as a QuickMenu
2022-09-19 02:22:41 +00:00
end
Dispatcher: QuickMenu: Fix footgun Fixes: #9594
2022-10-06 00:46:58 +00:00
caller.updated = true
Dispatcher: Fixes, Sort & QuickMenu Fix condition check, simplify getNameFromItem Allow sorting Dispatcher items and displaying them as a QuickMenu
2022-09-19 02:22:41 +00:00
end
end,
})
table.insert(menu, {
text = _("Sort"),
checked_func = function()
return location[settings] ~= nil
and location[settings].settings ~= nil
and location[settings].settings.order ~= nil
end,
callback = function(touchmenu_instance)
Dispatcher:_sortActions(caller, location, settings, touchmenu_instance)
end,
hold_callback = function(touchmenu_instance)
if location[settings]
and location[settings].settings
and location[settings].settings.order then
Dispatcher:_removeFromOrder(location, settings)
caller.updated = true
if touchmenu_instance then touchmenu_instance:updateItems() end
end
end,
})
end
function Dispatcher:_showAsMenu(settings)
local display_list = Dispatcher:getDisplayList(settings)
local quickmenu
local buttons = {}
for _, v in ipairs(display_list) do
table.insert(buttons, {{
text = v.text,
align = "left",
font_face = "smallinfofont",
font_size = 22,
font_bold = false,
callback = function()
UIManager:close(quickmenu)
Dispatcher:execute({[v.key] = settings[v.key]})
end,
}})
end
local ButtonDialogTitle = require("ui/widget/buttondialogtitle")
quickmenu = ButtonDialogTitle:new{
title = settings.settings.name or "Quick Menu",
title_align = "center",
width_factor = 0.8,
use_info_style = false,
buttons = buttons,
}
UIManager:show(quickmenu)
[plugin] Dispatcher: for profiles & gestures (#6106) add a Dispatcher module that allows for dispatching multiple events at once. This will allow for profiles & for gestures that do multiple things. it has 2 methods: Execute which is given a kv table of settings to change and fires an event for each of them. addSubMenu adds a menu item to a menu to allow for modifying which events are called it also has settingsList which is a master table of all allowed setting and their corresponding info (it is mostly from ReaderGesture and needs a lot of work) to allow for a new setting all one has to do is add a entry to settingsList with a corresponding event and it will work out of the box. the profile plugin is right now still a stub, just to test Dispatcher. the plan is to finish it and eventually refactor ReaderGesture to rely on this. This also needs effort to move many functions out of reader gesture into events where they belong.
2020-06-19 21:38:53 +00:00
end
simplify Dispatcher (#6435) there is no need to pass the caller rather just the table where the setting is located. passing the setting alone is not enough as sometimes it is nil and then you do not get a reference to its location
2020-07-28 01:26:56 +00:00
--[[--
Calls the events in a settings list
arguments are:
1) a reference to the uimanager
2) the settings table
3) optionally a `gestures`object
--]]--
Dispatcher: use UIManager:sendEvent instead of the current instance (#7999) This fixes inheritance issues when changing documents. Also allow "Go to page" in FM.
2021-07-23 11:27:12 +00:00
function Dispatcher:execute(settings, gesture)
Dispatcher: Fixes, Sort & QuickMenu Fix condition check, simplify getNameFromItem Allow sorting Dispatcher items and displaying them as a QuickMenu
2022-09-19 02:22:41 +00:00
if settings.settings ~= nil and settings.settings.show_as_quickmenu == true then
return Dispatcher:_showAsMenu(settings)
end
for k, v in iter_func(settings) do
if type(k) == "number" then
k = v
v = settings[k]
end
if settingsList[k] ~= nil and (settingsList[k].condition == nil or settingsList[k].condition == true) then
Dispatcher: use UIManager:sendEvent instead of the current instance (#7999) This fixes inheritance issues when changing documents. Also allow "Go to page" in FM.
2021-07-23 11:27:12 +00:00
Notification:setNotifySource(Notification.SOURCE_DISPATCHER)
Dispatcher: update configurable before event (like configdialog)
2021-08-30 15:01:46 +00:00
if settingsList[k].configurable then
local value = v
if type(v) ~= "number" then
for i, r in ipairs(settingsList[k].args) do
if v == r then value = settingsList[k].configurable.values[i] break end
end
end
UIManager:sendEvent(Event:new("ConfigChange", settingsList[k].configurable.name, value))
end
Dispatcher: use UIManager:sendEvent instead of the current instance (#7999) This fixes inheritance issues when changing documents. Also allow "Go to page" in FM.
2021-07-23 11:27:12 +00:00
if settingsList[k].category == "none" then
if settingsList[k].arg ~= nil then
UIManager:sendEvent(Event:new(settingsList[k].event, settingsList[k].arg))
else
UIManager:sendEvent(Event:new(settingsList[k].event))
Dispatcher: fix possible crash when no document (#7716)
2021-05-20 17:23:34 +00:00
end
Dispatcher: use UIManager:sendEvent instead of the current instance (#7999) This fixes inheritance issues when changing documents. Also allow "Go to page" in FM.
2021-07-23 11:27:12 +00:00
end
if settingsList[k].category == "absolutenumber"
or settingsList[k].category == "string"
then
UIManager:sendEvent(Event:new(settingsList[k].event, v))
end
-- the event can accept a gesture object or an argument
if settingsList[k].category == "arg" then
local arg = gesture or settingsList[k].arg
UIManager:sendEvent(Event:new(settingsList[k].event, arg))
end
-- the event can accept a gesture object or a number
if settingsList[k].category == "incrementalnumber" then
local arg = v ~= 0 and v or gesture or 0
UIManager:sendEvent(Event:new(settingsList[k].event, arg))
end
[plugin] Dispatcher: for profiles & gestures (#6106) add a Dispatcher module that allows for dispatching multiple events at once. This will allow for profiles & for gestures that do multiple things. it has 2 methods: Execute which is given a kv table of settings to change and fires an event for each of them. addSubMenu adds a menu item to a menu to allow for modifying which events are called it also has settingsList which is a master table of all allowed setting and their corresponding info (it is mostly from ReaderGesture and needs a lot of work) to allow for a new setting all one has to do is add a entry to settingsList with a corresponding event and it will work out of the box. the profile plugin is right now still a stub, just to test Dispatcher. the plan is to finish it and eventually refactor ReaderGesture to rely on this. This also needs effort to move many functions out of reader gesture into events where they belong.
2020-06-19 21:38:53 +00:00
end
Dispatcher: use UIManager:sendEvent instead of the current instance (#7999) This fixes inheritance issues when changing documents. Also allow "Go to page" in FM.
2021-07-23 11:27:12 +00:00
Notification:resetNotifySource()
[plugin] Dispatcher: for profiles & gestures (#6106) add a Dispatcher module that allows for dispatching multiple events at once. This will allow for profiles & for gestures that do multiple things. it has 2 methods: Execute which is given a kv table of settings to change and fires an event for each of them. addSubMenu adds a menu item to a menu to allow for modifying which events are called it also has settingsList which is a master table of all allowed setting and their corresponding info (it is mostly from ReaderGesture and needs a lot of work) to allow for a new setting all one has to do is add a entry to settingsList with a corresponding event and it will work out of the box. the profile plugin is right now still a stub, just to test Dispatcher. the plan is to finish it and eventually refactor ReaderGesture to rely on this. This also needs effort to move many functions out of reader gesture into events where they belong.
2020-06-19 21:38:53 +00:00
end
end
return Dispatcher
Reference in New Issue Copy Permalink