GitHub/Anki
1
0
Fork 0
mirror of https://github.com/ankitects/anki.git synced 2025-12-16 00:00:59 -05:00
Code Issues Projects Releases Packages 1 Wiki Activity Actions

Rename SearchContext.properties to SearchContext.addon_metadata

Browse source
This commit is contained in:
Jonathan Schoreels 2025-04-25 09:48:02 +02:00
parent a993577279
commit 3fbf6d8253
3 changed files with 7 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
qt/aqt/browser/table/__init__.py
View file

@ -29,7 +29,7 @@ class SearchContext:
browser: aqt.browser.Browser
order: bool | str | Column = True
reverse: bool = False
properties: dict | None = None
addon_metadata: dict | None = None
# if set, provided ids will be used instead of the regular search
ids: Sequence[ItemId] | None = None

2
qt/aqt/browser/table/model.py
View file

@ -269,7 +269,7 @@ class DataModel(QAbstractTableModel):
# invalid sort column in config
context.order = self.columns["noteCrt"]
context.reverse = self._state.sort_backwards
context.properties = {}
context.addon_metadata = {}
gui_hooks.browser_will_search(context)
if context.ids is None:
context.ids = self._state.find_items(

9
qt/tools/genhooks_gui.py
View file

@ -549,8 +549,9 @@ hooks = [
You can modify context.search to change the text that is sent to the
searching backend.
If you need to pass properties to the browser_did_search hook, you can
do it with context.properties
If you need to pass metadata to the browser_did_search hook, you can
do it with context.addon_metadata. For example, to trigger filtering
based on a new custom filter.
If you set context.ids to a list of ids, the regular search will
not be performed, and the provided ids will be used instead.
@ -581,8 +582,8 @@ hooks = [
backend did not recognize will be returned as an empty string, and can be
replaced with custom content.
You can retrieve properties passed from browser_will_search with
context.properties (for example to trigger post-processing filtering)
You can retrieve metadata passed from browser_will_search with
context.addon_metadata (for example to trigger post-processing filtering).
Columns is a list of string values identifying what each column in the row
represents.