Skip to content

Input Gestures dialog: Async filtering for smoother response #10307

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
feerrenrut merged 8 commits into from
Jul 2, 2020
Merged

Input Gestures dialog: Async filtering for smoother response #10307

Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
946f732
Input Gestures dialog: Delay applying filter for smoother response
JulienCochuyt Oct 1, 2019
52f3e04
Merge branch 'master' into inputGesturesFilterDelay
JulienCochuyt Oct 5, 2019
80e3fc6
Input Gestures dialog: Refactor using VirtualTree
JulienCochuyt Oct 5, 2019
f594f79
Merge branch 'master' into inputGesturesFilterDelay
JulienCochuyt Oct 28, 2019
927691c
Input Gestures dialog: Expand categories only if there are few results
JulienCochuyt Oct 28, 2019
432ef35
Input Gestures dialog: Add explanatory comment
JulienCochuyt Oct 29, 2019
ba1e208
Merge branch 'master' into inputGesturesFilterDelay
JulienCochuyt Nov 18, 2019
3fc2f4a
Merge branch 'master' into inputGesturesFilterDelay
JulienCochuyt May 4, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Input Gestures dialog: Expand categories only if there are few results 
Allows to refresh the tree with no delay.
  • Loading branch information
@JulienCochuyt
JulienCochuyt committed Oct 28, 2019
commit 927691c4e4193528cfe8561930783eacd330183d
32 changes: 22 additions & 10 deletions source/gui/settingsDialogs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3281,7 +3281,16 @@ def OnGetItemText(self, index: Tuple[int, ...], column: int = 0) -> str:
return _("Enter input gesture:")
category, commands = self.Parent.filteredGestures[index[0]]
if len(index) == 1:
return category
if self.Parent.filteredGestures is self.Parent.flattenedGestures:
return category
nbResults = len(commands)
if nbResults == 1:
# Translators: The label for a filtered category in the Input Gestures dialog.
return _("{category} (1 result)").format(category=category)
# Translators: The label for a filtered category in the Input Gestures dialog.
return _("{category} ({nbResults} results)").format(
category=category, nbResults=len(commands)
)
command, scriptInfo = commands[index[1]]
if len(index) == 2:
return command
Expand Down Expand Up @@ -3321,7 +3330,7 @@ def makeSettings(self, settingsSizer):
filterSizer = wx.BoxSizer(wx.HORIZONTAL)
# Translators: The label of a text field to search for gestures in the Input Gestures dialog.
filterLabel = wx.StaticText(self, label=pgettext("inputGestures", "&Filter by:"))
filter = self.filter = wx.TextCtrl(self)
filter = wx.TextCtrl(self)
filterSizer.Add(filterLabel, flag=wx.ALIGN_CENTER_VERTICAL)
filterSizer.AddSpacer(guiHelper.SPACE_BETWEEN_ASSOCIATED_CONTROL_HORIZONTAL)
filterSizer.Add(filter, proportion=1)
Expand Down Expand Up @@ -3387,7 +3396,7 @@ def run():

def _filter(self, token: object, filter: str):
if not filter:
wx.CallAfter(self.refreshTree, token, self.flattenedGestures, delayed=False)
wx.CallAfter(self.refreshTree, token, self.flattenedGestures)
return
filteredGestures = []
# This regexp uses a positive lookahead (?=...) for every word in the filter, which just makes sure
Expand All @@ -3396,6 +3405,7 @@ def _filter(self, token: object, filter: str):
# Because we're escaping, words must then be split on r"\ ".
filter = re.escape(filter)
pattern = re.compile(r"(?=.*?" + r")(?=.*?".join(filter.split(r"\ ")) + r")", re.U | re.IGNORECASE)
nbCommands = 0
for category, commands in self.flattenedGestures:
if token is not self.filterToken:
log.debug(f"filter token {token} superseded by {self.filterToken}")
Expand All @@ -3407,23 +3417,25 @@ def _filter(self, token: object, filter: str):
]
if filteredCommands:
filteredGestures.append((category, filteredCommands))
nbCommands += len(filteredCommands)
if token is not self.filterToken:
log.debug(f"filter token {token} superseded by {self.filterToken}")
return
wx.CallAfter(self.refreshTree, token, filteredGestures, delayed=True)
wx.CallAfter(self.refreshTree, token, filteredGestures, expandCategories=nbCommands <= 10)

def refreshTree(self, token: object, filteredGestures: FlattenedGestureMappings, delayed: bool = False):
if delayed:
wx.CallLater(300, self.refreshTree, token, filteredGestures, delayed=False)
return
def refreshTree(
self,
token: object,
filteredGestures: FlattenedGestureMappings,
expandCategories: bool = False,
):
if token is not self.filterToken:
log.debug(f"filter token {token} superseded by {self.filterToken}")
return
self.tree.CollapseAll()
self.filteredGestures = filteredGestures
self.tree.RefreshItems()
if filteredGestures is self.flattenedGestures:
# Do not forcibly expand the categories if there is no filter
if not expandCategories:
return
for index in range(len(self.filteredGestures)):
if token is not self.filterToken:
Expand Down