2019-02-05 04:59:03 +01:00
|
|
|
# Copyright: Ankitects Pty Ltd and contributors
|
2012-12-21 08:51:59 +01:00
|
|
|
# License: GNU AGPL, version 3 or later; http://www.gnu.org/licenses/agpl.html
|
2021-03-16 13:40:37 +01:00
|
|
|
|
2020-02-11 23:28:21 +01:00
|
|
|
from __future__ import annotations
|
|
|
|
|
|
2021-05-08 06:32:15 +02:00
|
|
|
from typing import Callable, Optional, Sequence, Tuple, Union
|
2019-12-19 12:11:12 +01:00
|
|
|
|
2020-03-29 21:10:30 +02:00
|
|
|
import aqt
|
2019-12-20 10:19:03 +01:00
|
|
|
import aqt.forms
|
2021-03-27 12:38:20 +01:00
|
|
|
from anki.cards import Card, CardId
|
2021-03-29 08:12:26 +02:00
|
|
|
from anki.collection import Collection, Config, OpChanges, SearchNode
|
2019-12-20 10:19:03 +01:00
|
|
|
from anki.consts import *
|
rework filtered deck screen & search errors
- Filtered deck creation now happens as an atomic operation, and is
undoable.
- The logic for initial search text, normalizing searches and so on
has been pushed into the backend.
- Use protobuf to pass the filtered deck to the updated dialog, so
we don't need to deal with untyped JSON.
- Change the "revise your search?" prompt to be a simple info box -
user has access to cancel and build buttons, and doesn't need a separate
prompt. Tweak the wording so the 'show excluded' button should be more
obvious.
- Filtered decks have a time appended to them instead of a number,
primarily because it's easier to implement. No objections going back to
the old behaviour if someone wants to contribute a clean patch.
The standard de-duplication will happen if two decks are created in the
same minute with the same name.
- Tweak the default sort order, and start with two searches. The UI
will still hide the second search by default, but by starting with two,
the frontend doesn't need logic for creating the starting text.
- Search errors now have their own error type, instead of using
InvalidInput, as that was intended mainly for bad API calls. The markdown
conversion is done when the error is converted from the backend, allowing
errors to printed as a string without any special handling by the calling
code.
TODO: when building a new filtered deck, update_active() is clobbering
the undo log when the overview is refreshed
2021-03-24 12:52:48 +01:00
|
|
|
from anki.errors import NotFoundError
|
2020-11-18 04:48:23 +01:00
|
|
|
from anki.lang import without_unicode_isolation
|
2021-03-27 12:38:20 +01:00
|
|
|
from anki.notes import NoteId
|
2021-03-18 03:06:45 +01:00
|
|
|
from anki.tags import MARKED_TAG
|
2021-03-29 08:12:26 +02:00
|
|
|
from anki.utils import ids2str, isMac
|
|
|
|
|
from aqt import AnkiQt, gui_hooks
|
2020-01-15 22:41:23 +01:00
|
|
|
from aqt.editor import Editor
|
2020-02-10 04:15:19 +01:00
|
|
|
from aqt.exporting import ExportDialog
|
2021-04-03 08:26:10 +02:00
|
|
|
from aqt.operations.card import set_card_deck, set_card_flag
|
2021-05-19 07:18:39 +02:00
|
|
|
from aqt.operations.collection import redo, undo
|
2021-04-03 08:26:10 +02:00
|
|
|
from aqt.operations.note import remove_notes
|
|
|
|
|
from aqt.operations.scheduling import (
|
undoable ops now return changes directly; add new *_ops.py files
- Introduced a new transact() method that wraps the return value
in a separate struct that describes the changes that were made.
- Changes are now gathered from the undo log, so we don't need to
guess at what was changed - eg if update_note() is called with identical
note contents, no changes are returned. Card changes will only be set
if cards were actually generated by the update_note() call, and tag
will only be set if a new tag was added.
- mw.perform_op() has been updated to expect the op to return the changes,
or a structure with the changes in it, and it will use them to fire the
change hook, instead of fetching the changes from undo_status(), so there
is no risk of race conditions.
- the various calls to mw.perform_op() have been split into separate
files like card_ops.py. Aside from making the code cleaner, this works
around a rather annoying issue with mypy. Because we run it with
no_strict_optional, mypy is happy to accept an operation that returns None,
despite the type signature saying it requires changes to be returned.
Turning no_strict_optional on for the whole codebase is not practical
at the moment, but we can enable it for individual files.
Still todo:
- The cursor keeps moving back to the start of a field when typing -
we need to ignore the refresh hook when we are the initiator.
- The busy cursor icon should probably be delayed a few hundreds ms.
- Still need to think about a nicer way of handling saveNow()
- op_made_changes(), op_affects_study_queue() might be better embedded
as properties in the object instead
2021-03-16 05:26:42 +01:00
|
|
|
forget_cards,
|
2021-03-18 02:46:11 +01:00
|
|
|
reposition_new_cards_dialog,
|
undoable ops now return changes directly; add new *_ops.py files
- Introduced a new transact() method that wraps the return value
in a separate struct that describes the changes that were made.
- Changes are now gathered from the undo log, so we don't need to
guess at what was changed - eg if update_note() is called with identical
note contents, no changes are returned. Card changes will only be set
if cards were actually generated by the update_note() call, and tag
will only be set if a new tag was added.
- mw.perform_op() has been updated to expect the op to return the changes,
or a structure with the changes in it, and it will use them to fire the
change hook, instead of fetching the changes from undo_status(), so there
is no risk of race conditions.
- the various calls to mw.perform_op() have been split into separate
files like card_ops.py. Aside from making the code cleaner, this works
around a rather annoying issue with mypy. Because we run it with
no_strict_optional, mypy is happy to accept an operation that returns None,
despite the type signature saying it requires changes to be returned.
Turning no_strict_optional on for the whole codebase is not practical
at the moment, but we can enable it for individual files.
Still todo:
- The cursor keeps moving back to the start of a field when typing -
we need to ignore the refresh hook when we are the initiator.
- The busy cursor icon should probably be delayed a few hundreds ms.
- Still need to think about a nicer way of handling saveNow()
- op_made_changes(), op_affects_study_queue() might be better embedded
as properties in the object instead
2021-03-16 05:26:42 +01:00
|
|
|
set_due_date_dialog,
|
|
|
|
|
suspend_cards,
|
|
|
|
|
unsuspend_cards,
|
|
|
|
|
)
|
2021-04-03 08:26:10 +02:00
|
|
|
from aqt.operations.tag import (
|
|
|
|
|
add_tags_to_notes,
|
|
|
|
|
clear_unused_tags,
|
|
|
|
|
remove_tags_from_notes,
|
|
|
|
|
)
|
|
|
|
|
from aqt.qt import *
|
2021-03-29 12:24:24 +02:00
|
|
|
from aqt.switch import Switch
|
2021-05-19 07:18:39 +02:00
|
|
|
from aqt.undo import UndoActionsInfo
|
2019-12-23 01:34:10 +01:00
|
|
|
from aqt.utils import (
|
2021-01-25 14:45:47 +01:00
|
|
|
HelpPage,
|
2021-03-17 05:51:59 +01:00
|
|
|
KeyboardModifiersPressed,
|
2021-03-14 13:08:37 +01:00
|
|
|
current_top_level_widget,
|
2021-03-16 13:40:37 +01:00
|
|
|
ensure_editor_saved,
|
2019-12-23 01:34:10 +01:00
|
|
|
getTag,
|
2021-05-19 10:34:36 +02:00
|
|
|
load_flags,
|
2021-04-26 08:46:08 +02:00
|
|
|
no_arg_trigger,
|
2019-12-23 01:34:10 +01:00
|
|
|
openHelp,
|
|
|
|
|
qtMenuShortcutWorkaround,
|
|
|
|
|
restoreGeom,
|
|
|
|
|
restoreSplitter,
|
|
|
|
|
restoreState,
|
|
|
|
|
saveGeom,
|
|
|
|
|
saveSplitter,
|
|
|
|
|
saveState,
|
|
|
|
|
showInfo,
|
rework filtered deck screen & search errors
- Filtered deck creation now happens as an atomic operation, and is
undoable.
- The logic for initial search text, normalizing searches and so on
has been pushed into the backend.
- Use protobuf to pass the filtered deck to the updated dialog, so
we don't need to deal with untyped JSON.
- Change the "revise your search?" prompt to be a simple info box -
user has access to cancel and build buttons, and doesn't need a separate
prompt. Tweak the wording so the 'show excluded' button should be more
obvious.
- Filtered decks have a time appended to them instead of a number,
primarily because it's easier to implement. No objections going back to
the old behaviour if someone wants to contribute a clean patch.
The standard de-duplication will happen if two decks are created in the
same minute with the same name.
- Tweak the default sort order, and start with two searches. The UI
will still hide the second search by default, but by starting with two,
the frontend doesn't need logic for creating the starting text.
- Search errors now have their own error type, instead of using
InvalidInput, as that was intended mainly for bad API calls. The markdown
conversion is done when the error is converted from the backend, allowing
errors to printed as a string without any special handling by the calling
code.
TODO: when building a new filtered deck, update_active() is clobbering
the undo log when the overview is refreshed
2021-03-24 12:52:48 +01:00
|
|
|
showWarning,
|
2021-04-25 08:47:15 +02:00
|
|
|
skip_if_selection_is_empty,
|
2020-02-17 05:41:01 +01:00
|
|
|
tr,
|
2019-12-23 01:34:10 +01:00
|
|
|
)
|
2021-05-08 07:08:45 +02:00
|
|
|
|
|
|
|
|
from .card_info import CardInfoDialog
|
|
|
|
|
from .change_notetype import ChangeModel
|
|
|
|
|
from .find_and_replace import FindAndReplaceDialog
|
|
|
|
|
from .previewer import BrowserPreviewer as PreviewDialog
|
|
|
|
|
from .previewer import Previewer
|
|
|
|
|
from .sidebar import SidebarTreeView
|
|
|
|
|
from .table import Table
|
2012-12-21 08:51:59 +01:00
|
|
|
|
2020-02-08 23:59:29 +01:00
|
|
|
|
2012-12-21 08:51:59 +01:00
|
|
|
class Browser(QMainWindow):
|
2019-12-20 08:55:19 +01:00
|
|
|
mw: AnkiQt
|
2020-05-20 09:56:52 +02:00
|
|
|
col: Collection
|
2020-01-15 22:41:23 +01:00
|
|
|
editor: Optional[Editor]
|
2021-03-29 08:12:26 +02:00
|
|
|
table: Table
|
2012-12-21 08:51:59 +01:00
|
|
|
|
2021-02-01 11:54:28 +01:00
|
|
|
def __init__(
|
|
|
|
|
self,
|
|
|
|
|
mw: AnkiQt,
|
|
|
|
|
card: Optional[Card] = None,
|
2021-02-11 10:57:19 +01:00
|
|
|
search: Optional[Tuple[Union[str, SearchNode]]] = None,
|
2021-02-01 11:54:28 +01:00
|
|
|
) -> None:
|
2021-02-02 09:48:55 +01:00
|
|
|
"""
|
|
|
|
|
card : try to search for its note and select it
|
|
|
|
|
search: set and perform search; caller must ensure validity
|
|
|
|
|
"""
|
|
|
|
|
|
2012-12-21 08:51:59 +01:00
|
|
|
QMainWindow.__init__(self, None, Qt.Window)
|
|
|
|
|
self.mw = mw
|
|
|
|
|
self.col = self.mw.col
|
|
|
|
|
self.lastFilter = ""
|
2020-07-26 01:25:39 +02:00
|
|
|
self.focusTo: Optional[int] = None
|
|
|
|
|
self._previewer: Optional[Previewer] = None
|
2016-07-14 12:23:44 +02:00
|
|
|
self._closeEventHasCleanedUp = False
|
2012-12-21 08:51:59 +01:00
|
|
|
self.form = aqt.forms.browser.Ui_Dialog()
|
|
|
|
|
self.form.setupUi(self)
|
2017-08-13 11:11:40 +02:00
|
|
|
self.setupSidebar()
|
2012-12-21 08:51:59 +01:00
|
|
|
restoreGeom(self, "editor", 0)
|
|
|
|
|
restoreState(self, "editor")
|
|
|
|
|
restoreSplitter(self.form.splitter, "editor3")
|
|
|
|
|
self.form.splitter.setChildrenCollapsible(False)
|
2020-01-15 22:41:23 +01:00
|
|
|
self.card: Optional[Card] = None
|
2021-03-29 08:12:26 +02:00
|
|
|
self.setup_table()
|
2012-12-21 08:51:59 +01:00
|
|
|
self.setupMenus()
|
|
|
|
|
self.setupHooks()
|
|
|
|
|
self.setupEditor()
|
2021-05-19 07:18:39 +02:00
|
|
|
# disable undo/redo
|
|
|
|
|
self.on_undo_state_change(mw.undo_actions_info())
|
2021-02-01 11:54:28 +01:00
|
|
|
self.setupSearch(card, search)
|
2020-02-29 17:02:51 +01:00
|
|
|
gui_hooks.browser_will_show(self)
|
2012-12-21 08:51:59 +01:00
|
|
|
self.show()
|
|
|
|
|
|
2021-04-06 02:14:11 +02:00
|
|
|
def on_operation_did_execute(
|
|
|
|
|
self, changes: OpChanges, handler: Optional[object]
|
|
|
|
|
) -> None:
|
2021-03-16 09:30:54 +01:00
|
|
|
focused = current_top_level_widget() == self
|
2021-04-06 02:14:11 +02:00
|
|
|
self.table.op_executed(changes, handler, focused)
|
|
|
|
|
self.sidebar.op_executed(changes, handler, focused)
|
2021-03-16 09:30:54 +01:00
|
|
|
if changes.note or changes.notetype:
|
2021-04-06 02:14:11 +02:00
|
|
|
if handler is not self.editor:
|
2021-03-18 15:06:54 +01:00
|
|
|
# fixme: this will leave the splitter shown, but with no current
|
|
|
|
|
# note being edited
|
2021-03-16 09:30:54 +01:00
|
|
|
note = self.editor.note
|
|
|
|
|
if note:
|
2021-03-18 15:06:54 +01:00
|
|
|
try:
|
|
|
|
|
note.load()
|
|
|
|
|
except NotFoundError:
|
|
|
|
|
self.editor.set_note(None)
|
|
|
|
|
return
|
2021-03-16 09:30:54 +01:00
|
|
|
self.editor.set_note(note)
|
|
|
|
|
|
|
|
|
|
self._renderPreview()
|
2021-03-14 13:08:37 +01:00
|
|
|
|
|
|
|
|
def on_focus_change(self, new: Optional[QWidget], old: Optional[QWidget]) -> None:
|
|
|
|
|
if current_top_level_widget() == self:
|
2021-03-16 09:30:54 +01:00
|
|
|
self.setUpdatesEnabled(True)
|
2021-03-29 08:12:26 +02:00
|
|
|
self.table.redraw_cells()
|
2021-03-16 10:21:18 +01:00
|
|
|
self.sidebar.refresh_if_needed()
|
2021-03-12 08:53:14 +01:00
|
|
|
|
2020-01-15 22:41:23 +01:00
|
|
|
def setupMenus(self) -> None:
|
2019-03-04 07:01:10 +01:00
|
|
|
# pylint: disable=unnecessary-lambda
|
2012-12-21 08:51:59 +01:00
|
|
|
# actions
|
2016-05-31 10:51:40 +02:00
|
|
|
f = self.form
|
2017-08-11 06:40:51 +02:00
|
|
|
# edit
|
2021-03-12 08:56:13 +01:00
|
|
|
qconnect(f.actionUndo.triggered, self.undo)
|
2021-05-19 07:18:39 +02:00
|
|
|
qconnect(f.actionRedo.triggered, self.redo)
|
2021-03-29 08:12:26 +02:00
|
|
|
qconnect(f.actionInvertSelection.triggered, self.table.invert_selection)
|
2020-05-04 05:23:08 +02:00
|
|
|
qconnect(f.actionSelectNotes.triggered, self.selectNotes)
|
2017-08-11 06:40:51 +02:00
|
|
|
if not isMac:
|
|
|
|
|
f.actionClose.setVisible(False)
|
2021-02-01 12:09:37 +01:00
|
|
|
qconnect(f.actionCreateFilteredDeck.triggered, self.createFilteredDeck)
|
2021-02-02 09:29:09 +01:00
|
|
|
f.actionCreateFilteredDeck.setShortcuts(["Ctrl+G", "Ctrl+Alt+G"])
|
2017-08-11 06:40:51 +02:00
|
|
|
# notes
|
2020-05-04 05:23:08 +02:00
|
|
|
qconnect(f.actionAdd.triggered, self.mw.onAddCard)
|
2021-04-25 19:51:57 +02:00
|
|
|
qconnect(f.actionAdd_Tags.triggered, self.add_tags_to_selected_notes)
|
|
|
|
|
qconnect(f.actionRemove_Tags.triggered, self.remove_tags_from_selected_notes)
|
clear_unused_tags and browser redraw improvements
- clear_unused_tags() is now undoable, and returns the number of removed
notes
- add a new mw.query_op() helper for immutable queries
- decouple "freeze/unfreeze ui state" hooks from the "interface update
required" hook, so that the former is fired even on error, and can be
made re-entrant
- use a 'block_updates' flag in Python, instead of setUpdatesEnabled(),
as the latter has the side-effect of preventing child windows like
tooltips from appearing, and forces a full redrawn when updates are
enabled again. The new behaviour leads to the card list blanking out
when a long-running op is running, but in the future if we cache the
cell values we can just display them from the cache instead.
- we were indiscriminately saving the note with saveNow(), due to the
call to saveTags(). Changed so that it only saves when the tags field
is focused.
- drain the "on_done" queue on main before launching a new background
task, to lower the chances of something in on_done making a small query
to the DB and hanging until a long op finishes
- the duplicate check in the editor was executed after the webview loads,
leading to it hanging until the sidebar finishes loading. Run it at
set_note() time instead, so that the editor loads first.
- don't throw an error when a long-running op started with with_progress()
finishes after the window it was launched from has closed
- don't throw an error when the browser is closed before the sidebar
has finished loading
2021-03-17 12:27:42 +01:00
|
|
|
qconnect(f.actionClear_Unused_Tags.triggered, self.clear_unused_tags)
|
2021-03-31 10:05:44 +02:00
|
|
|
qconnect(f.actionToggle_Mark.triggered, self.toggle_mark_of_selected_notes)
|
2020-05-04 05:23:08 +02:00
|
|
|
qconnect(f.actionChangeModel.triggered, self.onChangeModel)
|
|
|
|
|
qconnect(f.actionFindDuplicates.triggered, self.onFindDupes)
|
|
|
|
|
qconnect(f.actionFindReplace.triggered, self.onFindReplace)
|
|
|
|
|
qconnect(f.actionManage_Note_Types.triggered, self.mw.onNoteTypes)
|
2021-03-12 08:53:14 +01:00
|
|
|
qconnect(f.actionDelete.triggered, self.delete_selected_notes)
|
2017-08-11 06:40:51 +02:00
|
|
|
# cards
|
2021-03-12 08:53:14 +01:00
|
|
|
qconnect(f.actionChange_Deck.triggered, self.set_deck_of_selected_cards)
|
2020-05-04 05:23:08 +02:00
|
|
|
qconnect(f.action_Info.triggered, self.showCardInfo)
|
|
|
|
|
qconnect(f.actionReposition.triggered, self.reposition)
|
Rework reschedule tool
The old rescheduling dialog's two options have been split into two
separate menu items, "Forget", and "Set Due Date"
For cards that are not review cards, "Set Due Date" behaves like the
old reschedule option, changing the cards into a review card, and
and setting both the interval and due date to the provided number of
days.
When "Set Due Date" is applied to a review card, it no longer resets
the card's interval. Instead, it looks at how much the provided number
of days will change the original interval, and adjusts the interval by
that amount, so that cards that are answered earlier receive a smaller
next interval, and cards that are answered after a longer delay receive
a bonus.
For example, imagine a card was answered on day 5, and given an interval
of 10 days, so it has a due date of day 15.
- if on day 10 the due date is changed to day 12 (today+2), the card
is being scheduled 3 days earlier than it was supposed to be, so the
interval will be adjusted to 7 days.
- and if on day 10 the due date is changed to day 20, the interval will
be changed from 10 days to 15 days.
There is no separate option to reset the interval of a review card, but
it can be accomplished by forgetting the card(s), and then setting the
desired due date.
Other notes:
- Added the action to the review screen as well.
- Set the shortcut to Ctrl+Shift+D, and changed the existing Delete
Tags shortcut to Ctrl+Alt+Shift+A.
2021-02-07 11:58:16 +01:00
|
|
|
qconnect(f.action_set_due_date.triggered, self.set_due_date)
|
|
|
|
|
qconnect(f.action_forget.triggered, self.forget_cards)
|
2021-03-04 13:14:35 +01:00
|
|
|
qconnect(f.actionToggle_Suspend.triggered, self.suspend_selected_cards)
|
2021-05-19 19:17:43 +02:00
|
|
|
|
|
|
|
|
def set_flag_func(desired_flag: int) -> Callable:
|
|
|
|
|
return lambda: self.set_flag_of_selected_cards(desired_flag)
|
|
|
|
|
|
|
|
|
|
for flag in load_flags(self.col):
|
|
|
|
|
qconnect(
|
|
|
|
|
getattr(self.form, flag.action).triggered, set_flag_func(flag.index)
|
|
|
|
|
)
|
2021-05-19 10:34:36 +02:00
|
|
|
self._update_flag_labels()
|
2021-04-25 19:51:57 +02:00
|
|
|
qconnect(f.actionExport.triggered, self._on_export_notes)
|
2012-12-21 08:51:59 +01:00
|
|
|
# jumps
|
2020-05-04 05:23:08 +02:00
|
|
|
qconnect(f.actionPreviousCard.triggered, self.onPreviousCard)
|
|
|
|
|
qconnect(f.actionNextCard.triggered, self.onNextCard)
|
|
|
|
|
qconnect(f.actionFirstCard.triggered, self.onFirstCard)
|
|
|
|
|
qconnect(f.actionLastCard.triggered, self.onLastCard)
|
|
|
|
|
qconnect(f.actionFind.triggered, self.onFind)
|
|
|
|
|
qconnect(f.actionNote.triggered, self.onNote)
|
|
|
|
|
qconnect(f.actionSidebar.triggered, self.focusSidebar)
|
|
|
|
|
qconnect(f.actionCardList.triggered, self.onCardList)
|
2012-12-21 08:51:59 +01:00
|
|
|
# help
|
2020-05-04 05:23:08 +02:00
|
|
|
qconnect(f.actionGuide.triggered, self.onHelp)
|
2012-12-21 08:51:59 +01:00
|
|
|
# keyboard shortcut for shift+home/end
|
|
|
|
|
self.pgUpCut = QShortcut(QKeySequence("Shift+Home"), self)
|
2020-01-15 22:41:23 +01:00
|
|
|
qconnect(self.pgUpCut.activated, self.onFirstCard)
|
2012-12-21 08:51:59 +01:00
|
|
|
self.pgDownCut = QShortcut(QKeySequence("Shift+End"), self)
|
2020-01-15 22:41:23 +01:00
|
|
|
qconnect(self.pgDownCut.activated, self.onLastCard)
|
2012-12-21 08:51:59 +01:00
|
|
|
# add-on hook
|
2020-01-15 08:18:11 +01:00
|
|
|
gui_hooks.browser_menus_did_init(self)
|
2012-12-21 08:51:59 +01:00
|
|
|
self.mw.maybeHideAccelerators(self)
|
|
|
|
|
|
2021-02-01 00:39:55 +01:00
|
|
|
def closeEvent(self, evt: QCloseEvent) -> None:
|
2017-08-16 04:45:33 +02:00
|
|
|
if self._closeEventHasCleanedUp:
|
2016-07-14 12:23:44 +02:00
|
|
|
evt.accept()
|
2017-08-16 04:45:33 +02:00
|
|
|
return
|
2021-03-16 13:40:37 +01:00
|
|
|
self.editor.call_after_note_saved(self._closeWindow)
|
2017-08-16 04:45:33 +02:00
|
|
|
evt.ignore()
|
2016-07-14 12:23:44 +02:00
|
|
|
|
2021-02-01 00:39:55 +01:00
|
|
|
def _closeWindow(self) -> None:
|
2020-04-10 10:42:28 +02:00
|
|
|
self._cleanup_preview()
|
2017-08-16 04:45:33 +02:00
|
|
|
self.editor.cleanup()
|
2021-04-11 12:28:11 +02:00
|
|
|
self.table.cleanup()
|
2012-12-21 08:51:59 +01:00
|
|
|
saveSplitter(self.form.splitter, "editor3")
|
|
|
|
|
saveGeom(self, "editor")
|
|
|
|
|
saveState(self, "editor")
|
|
|
|
|
self.teardownHooks()
|
|
|
|
|
self.mw.maybeReset()
|
2017-08-16 04:45:33 +02:00
|
|
|
aqt.dialogs.markClosed("Browser")
|
2016-07-14 12:23:44 +02:00
|
|
|
self._closeEventHasCleanedUp = True
|
2021-03-05 04:07:52 +01:00
|
|
|
self.mw.deferred_delete_and_garbage_collect(self)
|
2017-08-16 04:45:33 +02:00
|
|
|
self.close()
|
2012-12-21 08:51:59 +01:00
|
|
|
|
2021-03-16 13:40:37 +01:00
|
|
|
@ensure_editor_saved
|
2021-02-01 00:39:55 +01:00
|
|
|
def closeWithCallback(self, onsuccess: Callable) -> None:
|
2021-03-16 13:40:37 +01:00
|
|
|
self._closeWindow()
|
|
|
|
|
onsuccess()
|
2013-04-11 12:23:32 +02:00
|
|
|
|
2021-02-01 00:39:55 +01:00
|
|
|
def keyPressEvent(self, evt: QKeyEvent) -> None:
|
2012-12-21 08:51:59 +01:00
|
|
|
if evt.key() == Qt.Key_Escape:
|
|
|
|
|
self.close()
|
2017-08-13 11:11:40 +02:00
|
|
|
else:
|
|
|
|
|
super().keyPressEvent(evt)
|
2012-12-21 08:51:59 +01:00
|
|
|
|
2021-02-01 11:54:28 +01:00
|
|
|
def reopen(
|
|
|
|
|
self,
|
|
|
|
|
_mw: AnkiQt,
|
|
|
|
|
card: Optional[Card] = None,
|
2021-02-11 10:57:19 +01:00
|
|
|
search: Optional[Tuple[Union[str, SearchNode]]] = None,
|
2021-02-01 11:54:28 +01:00
|
|
|
) -> None:
|
|
|
|
|
if search is not None:
|
|
|
|
|
self.search_for_terms(*search)
|
|
|
|
|
self.form.searchEdit.setFocus()
|
|
|
|
|
elif card:
|
|
|
|
|
self.show_single_card(card)
|
|
|
|
|
self.form.searchEdit.setFocus()
|
|
|
|
|
|
2012-12-21 08:51:59 +01:00
|
|
|
# Searching
|
|
|
|
|
######################################################################
|
|
|
|
|
|
2021-02-01 11:54:28 +01:00
|
|
|
def setupSearch(
|
|
|
|
|
self,
|
|
|
|
|
card: Optional[Card] = None,
|
2021-02-11 10:57:19 +01:00
|
|
|
search: Optional[Tuple[Union[str, SearchNode]]] = None,
|
2021-02-01 23:33:41 +01:00
|
|
|
) -> None:
|
2020-05-04 05:23:08 +02:00
|
|
|
qconnect(self.form.searchEdit.lineEdit().returnPressed, self.onSearchActivated)
|
2012-12-21 08:51:59 +01:00
|
|
|
self.form.searchEdit.setCompleter(None)
|
2021-01-29 21:07:42 +01:00
|
|
|
self.form.searchEdit.lineEdit().setPlaceholderText(
|
2021-03-26 04:48:26 +01:00
|
|
|
tr.browsing_search_bar_hint()
|
2019-12-23 01:34:10 +01:00
|
|
|
)
|
2021-01-30 10:51:31 +01:00
|
|
|
self.form.searchEdit.addItems(self.mw.pm.profile["searchHistory"])
|
2021-02-01 11:54:28 +01:00
|
|
|
if search is not None:
|
|
|
|
|
self.search_for_terms(*search)
|
|
|
|
|
elif card:
|
|
|
|
|
self.show_single_card(card)
|
|
|
|
|
else:
|
|
|
|
|
self.search_for(
|
2021-02-11 10:57:19 +01:00
|
|
|
self.col.build_search_string(SearchNode(deck="current")), ""
|
2021-02-01 11:54:28 +01:00
|
|
|
)
|
2016-07-14 12:23:44 +02:00
|
|
|
self.form.searchEdit.setFocus()
|
|
|
|
|
|
|
|
|
|
# search triggered by user
|
2021-03-16 13:40:37 +01:00
|
|
|
@ensure_editor_saved
|
2021-02-01 00:39:55 +01:00
|
|
|
def onSearchActivated(self) -> None:
|
2021-04-14 10:42:26 +02:00
|
|
|
text = self.current_search()
|
2021-01-30 10:51:31 +01:00
|
|
|
try:
|
|
|
|
|
normed = self.col.build_search_string(text)
|
rework filtered deck screen & search errors
- Filtered deck creation now happens as an atomic operation, and is
undoable.
- The logic for initial search text, normalizing searches and so on
has been pushed into the backend.
- Use protobuf to pass the filtered deck to the updated dialog, so
we don't need to deal with untyped JSON.
- Change the "revise your search?" prompt to be a simple info box -
user has access to cancel and build buttons, and doesn't need a separate
prompt. Tweak the wording so the 'show excluded' button should be more
obvious.
- Filtered decks have a time appended to them instead of a number,
primarily because it's easier to implement. No objections going back to
the old behaviour if someone wants to contribute a clean patch.
The standard de-duplication will happen if two decks are created in the
same minute with the same name.
- Tweak the default sort order, and start with two searches. The UI
will still hide the second search by default, but by starting with two,
the frontend doesn't need logic for creating the starting text.
- Search errors now have their own error type, instead of using
InvalidInput, as that was intended mainly for bad API calls. The markdown
conversion is done when the error is converted from the backend, allowing
errors to printed as a string without any special handling by the calling
code.
TODO: when building a new filtered deck, update_active() is clobbering
the undo log when the overview is refreshed
2021-03-24 12:52:48 +01:00
|
|
|
except Exception as err:
|
|
|
|
|
showWarning(str(err))
|
2021-01-30 10:51:31 +01:00
|
|
|
else:
|
|
|
|
|
self.search_for(normed)
|
2021-01-29 23:05:51 +01:00
|
|
|
self.update_history()
|
2018-11-12 03:43:54 +01:00
|
|
|
|
2021-02-01 00:39:55 +01:00
|
|
|
def search_for(self, search: str, prompt: Optional[str] = None) -> None:
|
2021-01-30 11:05:48 +01:00
|
|
|
"""Keep track of search string so that we reuse identical search when
|
|
|
|
|
refreshing, rather than whatever is currently in the search field.
|
|
|
|
|
Optionally set the search bar to a different text than the actual search.
|
|
|
|
|
"""
|
2016-07-14 12:23:44 +02:00
|
|
|
|
2020-10-19 20:37:17 +02:00
|
|
|
self._lastSearchTxt = search
|
2021-01-30 10:51:31 +01:00
|
|
|
prompt = search if prompt == None else prompt
|
|
|
|
|
self.form.searchEdit.lineEdit().setText(prompt)
|
2016-07-14 12:23:44 +02:00
|
|
|
self.search()
|
|
|
|
|
|
2021-02-09 01:50:39 +01:00
|
|
|
def current_search(self) -> str:
|
|
|
|
|
return self.form.searchEdit.lineEdit().text()
|
|
|
|
|
|
2021-02-01 00:39:55 +01:00
|
|
|
def search(self) -> None:
|
2021-01-30 10:51:31 +01:00
|
|
|
"""Search triggered programmatically. Caller must have saved note first."""
|
2016-07-14 12:23:44 +02:00
|
|
|
|
2021-01-29 23:05:51 +01:00
|
|
|
try:
|
2021-03-29 08:12:26 +02:00
|
|
|
self.table.search(self._lastSearchTxt)
|
2021-01-30 10:51:31 +01:00
|
|
|
except Exception as err:
|
rework filtered deck screen & search errors
- Filtered deck creation now happens as an atomic operation, and is
undoable.
- The logic for initial search text, normalizing searches and so on
has been pushed into the backend.
- Use protobuf to pass the filtered deck to the updated dialog, so
we don't need to deal with untyped JSON.
- Change the "revise your search?" prompt to be a simple info box -
user has access to cancel and build buttons, and doesn't need a separate
prompt. Tweak the wording so the 'show excluded' button should be more
obvious.
- Filtered decks have a time appended to them instead of a number,
primarily because it's easier to implement. No objections going back to
the old behaviour if someone wants to contribute a clean patch.
The standard de-duplication will happen if two decks are created in the
same minute with the same name.
- Tweak the default sort order, and start with two searches. The UI
will still hide the second search by default, but by starting with two,
the frontend doesn't need logic for creating the starting text.
- Search errors now have their own error type, instead of using
InvalidInput, as that was intended mainly for bad API calls. The markdown
conversion is done when the error is converted from the backend, allowing
errors to printed as a string without any special handling by the calling
code.
TODO: when building a new filtered deck, update_active() is clobbering
the undo log when the overview is refreshed
2021-03-24 12:52:48 +01:00
|
|
|
showWarning(str(err))
|
2012-12-21 08:51:59 +01:00
|
|
|
|
2021-02-01 00:39:55 +01:00
|
|
|
def update_history(self) -> None:
|
2019-12-23 01:34:10 +01:00
|
|
|
sh = self.mw.pm.profile["searchHistory"]
|
2021-01-29 23:05:51 +01:00
|
|
|
if self._lastSearchTxt in sh:
|
|
|
|
|
sh.remove(self._lastSearchTxt)
|
|
|
|
|
sh.insert(0, self._lastSearchTxt)
|
2012-12-21 08:51:59 +01:00
|
|
|
sh = sh[:30]
|
|
|
|
|
self.form.searchEdit.clear()
|
|
|
|
|
self.form.searchEdit.addItems(sh)
|
2019-12-23 01:34:10 +01:00
|
|
|
self.mw.pm.profile["searchHistory"] = sh
|
2020-12-22 11:08:47 +01:00
|
|
|
|
2021-03-29 08:12:26 +02:00
|
|
|
def updateTitle(self) -> None:
|
|
|
|
|
selected = self.table.len_selection()
|
|
|
|
|
cur = self.table.len()
|
|
|
|
|
tr_title = (
|
2021-03-29 15:51:34 +02:00
|
|
|
tr.browsing_window_title_notes
|
|
|
|
|
if self.table.is_notes_mode()
|
|
|
|
|
else tr.browsing_window_title
|
2021-03-29 08:12:26 +02:00
|
|
|
)
|
2019-12-23 01:34:10 +01:00
|
|
|
self.setWindowTitle(
|
2021-03-29 08:12:26 +02:00
|
|
|
without_unicode_isolation(tr_title(total=cur, selected=selected))
|
2019-12-23 01:34:10 +01:00
|
|
|
)
|
2012-12-21 08:51:59 +01:00
|
|
|
|
2021-02-11 10:57:19 +01:00
|
|
|
def search_for_terms(self, *search_terms: Union[str, SearchNode]) -> None:
|
2021-02-01 11:54:28 +01:00
|
|
|
search = self.col.build_search_string(*search_terms)
|
|
|
|
|
self.form.searchEdit.setEditText(search)
|
|
|
|
|
self.onSearchActivated()
|
2021-01-30 11:05:48 +01:00
|
|
|
|
2021-02-01 23:46:56 +01:00
|
|
|
def show_single_card(self, card: Card) -> None:
|
2021-02-01 11:54:28 +01:00
|
|
|
if card.nid:
|
2021-01-30 10:51:31 +01:00
|
|
|
|
2021-02-01 00:39:55 +01:00
|
|
|
def on_show_single_card() -> None:
|
2021-01-30 10:51:31 +01:00
|
|
|
self.card = card
|
2021-02-11 10:57:19 +01:00
|
|
|
search = self.col.build_search_string(SearchNode(nid=card.nid))
|
2021-01-30 10:51:31 +01:00
|
|
|
search = gui_hooks.default_search(search, card)
|
|
|
|
|
self.search_for(search, "")
|
2021-03-29 08:12:26 +02:00
|
|
|
self.table.select_single_card(card.id)
|
2021-01-30 10:51:31 +01:00
|
|
|
|
2021-03-16 13:40:37 +01:00
|
|
|
self.editor.call_after_note_saved(on_show_single_card)
|
2021-01-29 21:07:42 +01:00
|
|
|
|
2021-02-01 00:39:55 +01:00
|
|
|
def onReset(self) -> None:
|
2021-01-23 10:59:12 +01:00
|
|
|
self.sidebar.refresh()
|
2021-03-29 08:12:26 +02:00
|
|
|
self.begin_reset()
|
|
|
|
|
self.end_reset()
|
|
|
|
|
|
|
|
|
|
# caller must have called editor.saveNow() before calling this or .reset()
|
|
|
|
|
def begin_reset(self) -> None:
|
|
|
|
|
self.editor.set_note(None, hide=False)
|
|
|
|
|
self.mw.progress.start()
|
|
|
|
|
self.table.begin_reset()
|
2012-12-21 08:51:59 +01:00
|
|
|
|
2021-03-29 08:12:26 +02:00
|
|
|
def end_reset(self) -> None:
|
|
|
|
|
self.table.end_reset()
|
|
|
|
|
self.mw.progress.finish()
|
|
|
|
|
|
|
|
|
|
# Table & Editor
|
2012-12-21 08:51:59 +01:00
|
|
|
######################################################################
|
|
|
|
|
|
2021-03-29 08:12:26 +02:00
|
|
|
def setup_table(self) -> None:
|
|
|
|
|
self.table = Table(self)
|
|
|
|
|
self.table.set_view(self.form.tableView)
|
2021-03-29 12:24:24 +02:00
|
|
|
switch = Switch(11, tr.browsing_card_initial(), tr.browsing_note_initial())
|
2021-03-29 15:51:34 +02:00
|
|
|
switch.setChecked(self.table.is_notes_mode())
|
2021-04-06 11:41:18 +02:00
|
|
|
switch.setToolTip(tr.browsing_toggle_showing_cards_notes())
|
2021-03-31 18:53:36 +02:00
|
|
|
qconnect(self.form.action_toggle_mode.triggered, switch.toggle)
|
2021-03-29 12:24:24 +02:00
|
|
|
qconnect(switch.toggled, self.on_table_state_changed)
|
|
|
|
|
self.form.gridLayout.addWidget(switch, 0, 0)
|
2012-12-21 08:51:59 +01:00
|
|
|
|
2021-02-01 00:39:55 +01:00
|
|
|
def setupEditor(self) -> None:
|
2021-04-14 20:41:03 +02:00
|
|
|
def add_preview_button(editor: Editor) -> None:
|
|
|
|
|
preview_shortcut = "Ctrl+Shift+P" # TODO
|
|
|
|
|
|
|
|
|
|
editor._links["preview"] = lambda _editor: self.onTogglePreview()
|
|
|
|
|
editor.web.eval(
|
2021-05-07 16:50:17 +02:00
|
|
|
"$editorToolbar.then(({ notetypeButtons }) => notetypeButtons.appendButton({ component: editorToolbar.PreviewButton, id: 'preview' }));"
|
2021-01-10 01:44:08 +01:00
|
|
|
)
|
2021-01-09 22:34:53 +01:00
|
|
|
|
2021-04-14 20:41:03 +02:00
|
|
|
gui_hooks.editor_did_init.append(add_preview_button)
|
2019-12-23 01:34:10 +01:00
|
|
|
self.editor = aqt.editor.Editor(self.mw, self.form.fieldsArea, self)
|
2021-04-14 20:41:03 +02:00
|
|
|
gui_hooks.editor_did_init.remove(add_preview_button)
|
2012-12-21 08:51:59 +01:00
|
|
|
|
2021-03-16 13:40:37 +01:00
|
|
|
@ensure_editor_saved
|
2021-03-17 05:51:59 +01:00
|
|
|
def onRowChanged(
|
2021-03-30 22:06:58 +02:00
|
|
|
self, _current: Optional[QItemSelection], _previous: Optional[QItemSelection]
|
2021-03-17 05:51:59 +01:00
|
|
|
) -> None:
|
2021-05-07 10:12:56 +02:00
|
|
|
"""Update current note and hide/show editor."""
|
2020-04-02 11:44:51 +02:00
|
|
|
if self._closeEventHasCleanedUp:
|
|
|
|
|
return
|
2021-03-29 08:12:26 +02:00
|
|
|
|
|
|
|
|
self.updateTitle()
|
|
|
|
|
# the current card is used for context actions
|
|
|
|
|
self.card = self.table.get_current_card()
|
|
|
|
|
# if there is only one selected card, use it in the editor
|
|
|
|
|
# it might differ from the current card
|
|
|
|
|
card = self.table.get_single_selected_card()
|
|
|
|
|
self.singleCard = bool(card)
|
|
|
|
|
self.form.splitter.widget(1).setVisible(self.singleCard)
|
|
|
|
|
if self.singleCard:
|
|
|
|
|
self.editor.set_note(card.note(), focusTo=self.focusTo)
|
|
|
|
|
self.focusTo = None
|
|
|
|
|
self.editor.card = card
|
|
|
|
|
else:
|
2021-03-16 07:39:41 +01:00
|
|
|
self.editor.set_note(None)
|
2021-03-30 22:06:58 +02:00
|
|
|
self._renderPreview()
|
2021-03-31 10:05:44 +02:00
|
|
|
self._update_context_actions()
|
2020-01-15 08:45:35 +01:00
|
|
|
gui_hooks.browser_did_change_row(self)
|
2012-12-21 08:51:59 +01:00
|
|
|
|
2021-03-31 10:05:44 +02:00
|
|
|
def _update_context_actions(self) -> None:
|
|
|
|
|
self._update_flags_menu()
|
|
|
|
|
self._update_toggle_mark_action()
|
|
|
|
|
self._update_toggle_suspend_action()
|
|
|
|
|
|
2021-03-29 12:24:24 +02:00
|
|
|
@ensure_editor_saved
|
|
|
|
|
def on_table_state_changed(self, checked: bool) -> None:
|
2021-03-29 08:12:26 +02:00
|
|
|
self.mw.progress.start()
|
2021-03-29 12:24:24 +02:00
|
|
|
self.table.toggle_state(checked, self._lastSearchTxt)
|
2021-03-29 08:12:26 +02:00
|
|
|
self.mw.progress.finish()
|
2012-12-21 08:51:59 +01:00
|
|
|
|
2021-03-29 08:12:26 +02:00
|
|
|
# Sidebar
|
|
|
|
|
######################################################################
|
2012-12-21 08:51:59 +01:00
|
|
|
|
2019-12-19 12:11:12 +01:00
|
|
|
def setupSidebar(self) -> None:
|
2021-03-26 04:48:26 +01:00
|
|
|
dw = self.sidebarDockWidget = QDockWidget(tr.browsing_sidebar(), self)
|
2017-08-13 11:11:40 +02:00
|
|
|
dw.setFeatures(QDockWidget.DockWidgetClosable)
|
|
|
|
|
dw.setObjectName("Sidebar")
|
|
|
|
|
dw.setAllowedAreas(Qt.LeftDockWidgetArea)
|
2020-10-10 03:42:49 +02:00
|
|
|
|
2021-01-23 10:59:12 +01:00
|
|
|
self.sidebar = SidebarTreeView(self)
|
|
|
|
|
self.sidebarTree = self.sidebar # legacy alias
|
|
|
|
|
dw.setWidget(self.sidebar)
|
2021-01-26 23:35:40 +01:00
|
|
|
qconnect(
|
2021-02-05 05:32:56 +01:00
|
|
|
self.form.actionSidebarFilter.triggered,
|
2021-01-26 23:35:40 +01:00
|
|
|
self.focusSidebarSearchBar,
|
|
|
|
|
)
|
2021-02-26 13:04:30 +01:00
|
|
|
grid = QGridLayout()
|
2021-03-17 05:51:59 +01:00
|
|
|
grid.addWidget(self.sidebar.searchBar, 0, 0)
|
|
|
|
|
grid.addWidget(self.sidebar.toolbar, 0, 1)
|
2021-02-26 13:04:30 +01:00
|
|
|
grid.addWidget(self.sidebar, 1, 0, 1, 2)
|
|
|
|
|
grid.setContentsMargins(0, 0, 0, 0)
|
|
|
|
|
grid.setSpacing(0)
|
2021-01-26 23:35:40 +01:00
|
|
|
w = QWidget()
|
2021-02-26 13:04:30 +01:00
|
|
|
w.setLayout(grid)
|
2021-01-26 23:35:40 +01:00
|
|
|
dw.setWidget(w)
|
2017-08-15 06:54:13 +02:00
|
|
|
self.sidebarDockWidget.setFloating(False)
|
2021-01-23 10:59:12 +01:00
|
|
|
|
2017-08-15 07:19:22 +02:00
|
|
|
self.sidebarDockWidget.setTitleBarWidget(QWidget())
|
2017-08-14 08:57:43 +02:00
|
|
|
self.addDockWidget(Qt.LeftDockWidgetArea, dw)
|
2017-08-13 11:11:40 +02:00
|
|
|
|
2021-01-23 10:59:12 +01:00
|
|
|
# schedule sidebar to refresh after browser window has loaded, so the
|
|
|
|
|
# UI is more responsive
|
|
|
|
|
self.mw.progress.timer(10, self.sidebar.refresh, False)
|
2017-08-13 11:11:40 +02:00
|
|
|
|
2021-01-26 23:35:40 +01:00
|
|
|
def showSidebar(self) -> None:
|
2020-10-24 10:47:25 +02:00
|
|
|
# workaround for PyQt focus bug
|
|
|
|
|
self.editor.hideCompleters()
|
2017-08-13 11:11:40 +02:00
|
|
|
self.sidebarDockWidget.setVisible(True)
|
2021-01-26 23:35:40 +01:00
|
|
|
|
|
|
|
|
def focusSidebar(self) -> None:
|
|
|
|
|
self.showSidebar()
|
2021-01-23 10:59:12 +01:00
|
|
|
self.sidebar.setFocus()
|
2017-08-13 11:11:40 +02:00
|
|
|
|
2021-01-26 23:35:40 +01:00
|
|
|
def focusSidebarSearchBar(self) -> None:
|
|
|
|
|
self.showSidebar()
|
|
|
|
|
self.sidebar.searchBar.setFocus()
|
|
|
|
|
|
2021-02-01 00:39:55 +01:00
|
|
|
def toggle_sidebar(self) -> None:
|
2021-01-23 10:59:12 +01:00
|
|
|
want_visible = not self.sidebarDockWidget.isVisible()
|
|
|
|
|
self.sidebarDockWidget.setVisible(want_visible)
|
|
|
|
|
if want_visible:
|
|
|
|
|
self.sidebar.refresh()
|
2020-02-15 21:03:15 +01:00
|
|
|
|
2021-01-23 10:59:12 +01:00
|
|
|
# legacy
|
2021-02-09 01:50:39 +01:00
|
|
|
|
2021-02-01 00:39:55 +01:00
|
|
|
def setFilter(self, *terms: str) -> None:
|
2021-02-09 01:50:39 +01:00
|
|
|
self.sidebar.update_search(*terms)
|
2021-01-23 10:59:12 +01:00
|
|
|
|
2012-12-21 08:51:59 +01:00
|
|
|
# Info
|
|
|
|
|
######################################################################
|
|
|
|
|
|
2021-02-01 00:39:55 +01:00
|
|
|
def showCardInfo(self) -> None:
|
2012-12-21 08:51:59 +01:00
|
|
|
if not self.card:
|
|
|
|
|
return
|
2020-06-15 06:14:18 +02:00
|
|
|
|
2021-05-08 07:08:45 +02:00
|
|
|
CardInfoDialog(parent=self, mw=self.mw, card=self.card)
|
2012-12-21 08:51:59 +01:00
|
|
|
|
|
|
|
|
# Menu helpers
|
|
|
|
|
######################################################################
|
|
|
|
|
|
2021-03-29 08:48:33 +02:00
|
|
|
def selected_cards(self) -> Sequence[CardId]:
|
2021-03-29 08:12:26 +02:00
|
|
|
return self.table.get_selected_card_ids()
|
2012-12-21 08:51:59 +01:00
|
|
|
|
2021-03-29 08:48:33 +02:00
|
|
|
def selected_notes(self) -> Sequence[NoteId]:
|
2021-03-29 08:12:26 +02:00
|
|
|
return self.table.get_selected_note_ids()
|
2012-12-21 08:51:59 +01:00
|
|
|
|
2021-03-29 08:48:33 +02:00
|
|
|
def selectedNotesAsCards(self) -> Sequence[CardId]:
|
2021-03-29 08:12:26 +02:00
|
|
|
return self.table.get_card_ids_from_selected_note_ids()
|
2012-12-21 08:51:59 +01:00
|
|
|
|
2021-03-29 08:48:33 +02:00
|
|
|
def oneModelNotes(self) -> Sequence[NoteId]:
|
2021-03-18 02:46:11 +01:00
|
|
|
sf = self.selected_notes()
|
2012-12-21 08:51:59 +01:00
|
|
|
if not sf:
|
2021-02-01 00:39:55 +01:00
|
|
|
return []
|
2019-12-23 01:34:10 +01:00
|
|
|
mods = self.col.db.scalar(
|
|
|
|
|
"""
|
2012-12-21 08:51:59 +01:00
|
|
|
select count(distinct mid) from notes
|
2019-12-23 01:34:10 +01:00
|
|
|
where id in %s"""
|
|
|
|
|
% ids2str(sf)
|
|
|
|
|
)
|
2012-12-21 08:51:59 +01:00
|
|
|
if mods > 1:
|
2021-03-26 04:48:26 +01:00
|
|
|
showInfo(tr.browsing_please_select_cards_from_only_one())
|
2021-02-01 00:39:55 +01:00
|
|
|
return []
|
2012-12-21 08:51:59 +01:00
|
|
|
return sf
|
|
|
|
|
|
2021-02-01 00:39:55 +01:00
|
|
|
def onHelp(self) -> None:
|
2021-01-25 14:45:47 +01:00
|
|
|
openHelp(HelpPage.BROWSING)
|
2012-12-21 08:51:59 +01:00
|
|
|
|
2021-03-18 02:46:11 +01:00
|
|
|
# legacy
|
|
|
|
|
|
|
|
|
|
selectedCards = selected_cards
|
|
|
|
|
selectedNotes = selected_notes
|
|
|
|
|
|
2012-12-21 08:51:59 +01:00
|
|
|
# Misc menu options
|
|
|
|
|
######################################################################
|
|
|
|
|
|
2021-04-26 08:46:08 +02:00
|
|
|
@no_arg_trigger
|
|
|
|
|
@skip_if_selection_is_empty
|
|
|
|
|
@ensure_editor_saved
|
2021-02-01 00:39:55 +01:00
|
|
|
def onChangeModel(self) -> None:
|
2021-04-25 08:47:15 +02:00
|
|
|
ChangeModel(self, self.oneModelNotes())
|
2012-12-21 08:51:59 +01:00
|
|
|
|
2021-02-01 23:46:56 +01:00
|
|
|
def createFilteredDeck(self) -> None:
|
2021-04-14 10:42:26 +02:00
|
|
|
search = self.current_search()
|
2021-03-17 05:51:59 +01:00
|
|
|
if self.mw.col.schedVer() != 1 and KeyboardModifiersPressed().alt:
|
2021-03-24 04:17:12 +01:00
|
|
|
aqt.dialogs.open("FilteredDeckConfigDialog", self.mw, search_2=search)
|
2021-02-02 09:29:09 +01:00
|
|
|
else:
|
2021-03-24 04:17:12 +01:00
|
|
|
aqt.dialogs.open("FilteredDeckConfigDialog", self.mw, search=search)
|
2021-02-01 19:10:05 +01:00
|
|
|
|
2013-05-03 10:52:46 +02:00
|
|
|
# Preview
|
|
|
|
|
######################################################################
|
|
|
|
|
|
2021-02-01 00:39:55 +01:00
|
|
|
def onTogglePreview(self) -> None:
|
2020-03-29 21:10:30 +02:00
|
|
|
if self._previewer:
|
2020-04-02 09:35:51 +02:00
|
|
|
self._previewer.close()
|
2020-05-19 23:46:50 +02:00
|
|
|
self._on_preview_closed()
|
2013-05-03 10:52:46 +02:00
|
|
|
else:
|
2020-04-08 08:19:59 +02:00
|
|
|
self._previewer = PreviewDialog(self, self.mw, self._on_preview_closed)
|
2020-04-02 09:35:51 +02:00
|
|
|
self._previewer.open()
|
2017-08-08 08:28:53 +02:00
|
|
|
|
2021-02-01 00:39:55 +01:00
|
|
|
def _renderPreview(self) -> None:
|
2020-03-29 21:10:30 +02:00
|
|
|
if self._previewer:
|
2021-01-10 02:01:24 +01:00
|
|
|
if self.singleCard:
|
|
|
|
|
self._previewer.render_card()
|
|
|
|
|
else:
|
|
|
|
|
self.onTogglePreview()
|
2017-08-08 08:28:53 +02:00
|
|
|
|
2021-02-01 00:39:55 +01:00
|
|
|
def _cleanup_preview(self) -> None:
|
2020-03-29 21:10:30 +02:00
|
|
|
if self._previewer:
|
2020-04-02 17:34:53 +02:00
|
|
|
self._previewer.cancel_timer()
|
2020-04-10 10:42:28 +02:00
|
|
|
self._previewer.close()
|
2019-02-26 02:18:32 +01:00
|
|
|
|
2021-02-01 00:39:55 +01:00
|
|
|
def _on_preview_closed(self) -> None:
|
2021-01-10 01:21:52 +01:00
|
|
|
if self.editor.web:
|
2021-04-13 20:29:59 +02:00
|
|
|
self.editor.web.eval(
|
|
|
|
|
"document.getElementById('previewButton').classList.remove('highlighted')"
|
|
|
|
|
)
|
2020-04-08 08:19:59 +02:00
|
|
|
self._previewer = None
|
|
|
|
|
|
2012-12-21 08:51:59 +01:00
|
|
|
# Card deletion
|
|
|
|
|
######################################################################
|
|
|
|
|
|
2021-04-26 08:46:08 +02:00
|
|
|
@no_arg_trigger
|
|
|
|
|
@skip_if_selection_is_empty
|
2021-03-12 08:53:14 +01:00
|
|
|
def delete_selected_notes(self) -> None:
|
|
|
|
|
# ensure deletion is not accidentally triggered when the user is focused
|
|
|
|
|
# in the editing screen or search bar
|
2018-03-01 04:31:52 +01:00
|
|
|
focus = self.focusWidget()
|
|
|
|
|
if focus != self.form.tableView:
|
|
|
|
|
return
|
2016-07-14 12:23:44 +02:00
|
|
|
|
2021-03-29 08:12:26 +02:00
|
|
|
nids = self.table.get_selected_note_ids()
|
experiment with preserving search when resetting
Up until now, we've been forcing a new search whenever reset is called.
The primary reason was that the card list display routines did not expect
a card or note to have been removed. By updating the model to show
"(deleted)" when a card or note is missing, we no longer have to repeat
the search.
This has a few advantages:
- Searches, especially complex ones, can be slow to execute. When we
perform them after every operation like a delete, it can make Anki feel
sluggish.
- The fact that notes have been deleted becomes more obvious - some users
found it easy to miss the "deleted" pop-up in the past.
This change does not just affect deletions, as many other operations
trigger a reset as well. In the past, when using 'set due date' in the
review screen for example, it caused an ugly flicker in the browser screen,
and could be slow when the current search couldn't be quickly redone.
The disadvantage of this approach is that the displayed content may
not reflect the specified search, which has the potential to be confusing.
But if that turns out to be a problem, it could be (partly) alleviated by
displaying a refresh button next to the search bar when the search may
need to be refreshed.
Feedback welcome!
2021-03-13 05:52:44 +01:00
|
|
|
# select the next card if there is one
|
2021-03-29 08:12:26 +02:00
|
|
|
self.focusTo = self.editor.currentField
|
|
|
|
|
self.table.to_next_row()
|
2021-03-12 08:53:14 +01:00
|
|
|
|
2021-04-06 06:56:36 +02:00
|
|
|
remove_notes(parent=self, note_ids=nids).run_in_background()
|
2021-03-12 08:53:14 +01:00
|
|
|
|
|
|
|
|
# legacy
|
|
|
|
|
|
|
|
|
|
deleteNotes = delete_selected_notes
|
2012-12-21 08:51:59 +01:00
|
|
|
|
|
|
|
|
# Deck change
|
|
|
|
|
######################################################################
|
|
|
|
|
|
2021-04-26 08:46:08 +02:00
|
|
|
@no_arg_trigger
|
|
|
|
|
@skip_if_selection_is_empty
|
|
|
|
|
@ensure_editor_saved
|
2021-03-12 08:53:14 +01:00
|
|
|
def set_deck_of_selected_cards(self) -> None:
|
2012-12-21 08:51:59 +01:00
|
|
|
from aqt.studydeck import StudyDeck
|
2019-12-23 01:34:10 +01:00
|
|
|
|
2021-03-29 08:12:26 +02:00
|
|
|
cids = self.table.get_selected_card_ids()
|
2019-12-23 01:34:10 +01:00
|
|
|
did = self.mw.col.db.scalar("select did from cards where id = ?", cids[0])
|
|
|
|
|
current = self.mw.col.decks.get(did)["name"]
|
2012-12-21 08:51:59 +01:00
|
|
|
ret = StudyDeck(
|
2019-12-23 01:34:10 +01:00
|
|
|
self.mw,
|
|
|
|
|
current=current,
|
2021-03-26 04:48:26 +01:00
|
|
|
accept=tr.browsing_move_cards(),
|
|
|
|
|
title=tr.browsing_change_deck(),
|
2021-01-25 14:45:47 +01:00
|
|
|
help=HelpPage.BROWSING,
|
2019-12-23 01:34:10 +01:00
|
|
|
parent=self,
|
|
|
|
|
)
|
2012-12-21 08:51:59 +01:00
|
|
|
if not ret.name:
|
|
|
|
|
return
|
|
|
|
|
did = self.col.decks.id(ret.name)
|
2021-03-12 07:27:40 +01:00
|
|
|
|
2021-04-06 06:36:13 +02:00
|
|
|
set_card_deck(parent=self, card_ids=cids, deck_id=did).run_in_background()
|
2021-03-12 08:53:14 +01:00
|
|
|
|
|
|
|
|
# legacy
|
|
|
|
|
|
|
|
|
|
setDeck = set_deck_of_selected_cards
|
2012-12-21 08:51:59 +01:00
|
|
|
|
|
|
|
|
# Tags
|
|
|
|
|
######################################################################
|
|
|
|
|
|
2021-04-26 08:46:08 +02:00
|
|
|
@no_arg_trigger
|
|
|
|
|
@skip_if_selection_is_empty
|
|
|
|
|
@ensure_editor_saved
|
2021-03-05 11:47:51 +01:00
|
|
|
def add_tags_to_selected_notes(
|
2021-02-01 00:39:55 +01:00
|
|
|
self,
|
|
|
|
|
tags: Optional[str] = None,
|
|
|
|
|
) -> None:
|
2021-03-05 11:47:51 +01:00
|
|
|
"Shows prompt if tags not provided."
|
2021-03-26 04:48:26 +01:00
|
|
|
if not (tags := tags or self._prompt_for_tags(tr.browsing_enter_tags_to_add())):
|
2021-03-16 13:40:37 +01:00
|
|
|
return
|
2021-04-01 07:01:08 +02:00
|
|
|
add_tags_to_notes(
|
2021-04-06 04:47:55 +02:00
|
|
|
parent=self, note_ids=self.selected_notes(), space_separated_tags=tags
|
2021-04-06 06:36:13 +02:00
|
|
|
).run_in_background(initiator=self)
|
undoable ops now return changes directly; add new *_ops.py files
- Introduced a new transact() method that wraps the return value
in a separate struct that describes the changes that were made.
- Changes are now gathered from the undo log, so we don't need to
guess at what was changed - eg if update_note() is called with identical
note contents, no changes are returned. Card changes will only be set
if cards were actually generated by the update_note() call, and tag
will only be set if a new tag was added.
- mw.perform_op() has been updated to expect the op to return the changes,
or a structure with the changes in it, and it will use them to fire the
change hook, instead of fetching the changes from undo_status(), so there
is no risk of race conditions.
- the various calls to mw.perform_op() have been split into separate
files like card_ops.py. Aside from making the code cleaner, this works
around a rather annoying issue with mypy. Because we run it with
no_strict_optional, mypy is happy to accept an operation that returns None,
despite the type signature saying it requires changes to be returned.
Turning no_strict_optional on for the whole codebase is not practical
at the moment, but we can enable it for individual files.
Still todo:
- The cursor keeps moving back to the start of a field when typing -
we need to ignore the refresh hook when we are the initiator.
- The busy cursor icon should probably be delayed a few hundreds ms.
- Still need to think about a nicer way of handling saveNow()
- op_made_changes(), op_affects_study_queue() might be better embedded
as properties in the object instead
2021-03-16 05:26:42 +01:00
|
|
|
|
2021-04-26 08:46:08 +02:00
|
|
|
@no_arg_trigger
|
|
|
|
|
@skip_if_selection_is_empty
|
|
|
|
|
@ensure_editor_saved
|
2021-03-05 11:47:51 +01:00
|
|
|
def remove_tags_from_selected_notes(self, tags: Optional[str] = None) -> None:
|
|
|
|
|
"Shows prompt if tags not provided."
|
2021-03-16 13:40:37 +01:00
|
|
|
if not (
|
2021-03-26 04:48:26 +01:00
|
|
|
tags := tags or self._prompt_for_tags(tr.browsing_enter_tags_to_delete())
|
2021-03-16 13:40:37 +01:00
|
|
|
):
|
|
|
|
|
return
|
2021-04-06 04:47:55 +02:00
|
|
|
|
2021-04-01 07:01:08 +02:00
|
|
|
remove_tags_from_notes(
|
2021-04-06 04:47:55 +02:00
|
|
|
parent=self, note_ids=self.selected_notes(), space_separated_tags=tags
|
2021-04-06 06:36:13 +02:00
|
|
|
).run_in_background(initiator=self)
|
undoable ops now return changes directly; add new *_ops.py files
- Introduced a new transact() method that wraps the return value
in a separate struct that describes the changes that were made.
- Changes are now gathered from the undo log, so we don't need to
guess at what was changed - eg if update_note() is called with identical
note contents, no changes are returned. Card changes will only be set
if cards were actually generated by the update_note() call, and tag
will only be set if a new tag was added.
- mw.perform_op() has been updated to expect the op to return the changes,
or a structure with the changes in it, and it will use them to fire the
change hook, instead of fetching the changes from undo_status(), so there
is no risk of race conditions.
- the various calls to mw.perform_op() have been split into separate
files like card_ops.py. Aside from making the code cleaner, this works
around a rather annoying issue with mypy. Because we run it with
no_strict_optional, mypy is happy to accept an operation that returns None,
despite the type signature saying it requires changes to be returned.
Turning no_strict_optional on for the whole codebase is not practical
at the moment, but we can enable it for individual files.
Still todo:
- The cursor keeps moving back to the start of a field when typing -
we need to ignore the refresh hook when we are the initiator.
- The busy cursor icon should probably be delayed a few hundreds ms.
- Still need to think about a nicer way of handling saveNow()
- op_made_changes(), op_affects_study_queue() might be better embedded
as properties in the object instead
2021-03-16 05:26:42 +01:00
|
|
|
|
clear_unused_tags and browser redraw improvements
- clear_unused_tags() is now undoable, and returns the number of removed
notes
- add a new mw.query_op() helper for immutable queries
- decouple "freeze/unfreeze ui state" hooks from the "interface update
required" hook, so that the former is fired even on error, and can be
made re-entrant
- use a 'block_updates' flag in Python, instead of setUpdatesEnabled(),
as the latter has the side-effect of preventing child windows like
tooltips from appearing, and forces a full redrawn when updates are
enabled again. The new behaviour leads to the card list blanking out
when a long-running op is running, but in the future if we cache the
cell values we can just display them from the cache instead.
- we were indiscriminately saving the note with saveNow(), due to the
call to saveTags(). Changed so that it only saves when the tags field
is focused.
- drain the "on_done" queue on main before launching a new background
task, to lower the chances of something in on_done making a small query
to the DB and hanging until a long op finishes
- the duplicate check in the editor was executed after the webview loads,
leading to it hanging until the sidebar finishes loading. Run it at
set_note() time instead, so that the editor loads first.
- don't throw an error when a long-running op started with with_progress()
finishes after the window it was launched from has closed
- don't throw an error when the browser is closed before the sidebar
has finished loading
2021-03-17 12:27:42 +01:00
|
|
|
def _prompt_for_tags(self, prompt: str) -> Optional[str]:
|
undoable ops now return changes directly; add new *_ops.py files
- Introduced a new transact() method that wraps the return value
in a separate struct that describes the changes that were made.
- Changes are now gathered from the undo log, so we don't need to
guess at what was changed - eg if update_note() is called with identical
note contents, no changes are returned. Card changes will only be set
if cards were actually generated by the update_note() call, and tag
will only be set if a new tag was added.
- mw.perform_op() has been updated to expect the op to return the changes,
or a structure with the changes in it, and it will use them to fire the
change hook, instead of fetching the changes from undo_status(), so there
is no risk of race conditions.
- the various calls to mw.perform_op() have been split into separate
files like card_ops.py. Aside from making the code cleaner, this works
around a rather annoying issue with mypy. Because we run it with
no_strict_optional, mypy is happy to accept an operation that returns None,
despite the type signature saying it requires changes to be returned.
Turning no_strict_optional on for the whole codebase is not practical
at the moment, but we can enable it for individual files.
Still todo:
- The cursor keeps moving back to the start of a field when typing -
we need to ignore the refresh hook when we are the initiator.
- The busy cursor icon should probably be delayed a few hundreds ms.
- Still need to think about a nicer way of handling saveNow()
- op_made_changes(), op_affects_study_queue() might be better embedded
as properties in the object instead
2021-03-16 05:26:42 +01:00
|
|
|
(tags, ok) = getTag(self, self.col, prompt)
|
|
|
|
|
if not ok:
|
|
|
|
|
return None
|
|
|
|
|
else:
|
|
|
|
|
return tags
|
2012-12-21 08:51:59 +01:00
|
|
|
|
2021-04-26 08:46:08 +02:00
|
|
|
@no_arg_trigger
|
|
|
|
|
@ensure_editor_saved
|
clear_unused_tags and browser redraw improvements
- clear_unused_tags() is now undoable, and returns the number of removed
notes
- add a new mw.query_op() helper for immutable queries
- decouple "freeze/unfreeze ui state" hooks from the "interface update
required" hook, so that the former is fired even on error, and can be
made re-entrant
- use a 'block_updates' flag in Python, instead of setUpdatesEnabled(),
as the latter has the side-effect of preventing child windows like
tooltips from appearing, and forces a full redrawn when updates are
enabled again. The new behaviour leads to the card list blanking out
when a long-running op is running, but in the future if we cache the
cell values we can just display them from the cache instead.
- we were indiscriminately saving the note with saveNow(), due to the
call to saveTags(). Changed so that it only saves when the tags field
is focused.
- drain the "on_done" queue on main before launching a new background
task, to lower the chances of something in on_done making a small query
to the DB and hanging until a long op finishes
- the duplicate check in the editor was executed after the webview loads,
leading to it hanging until the sidebar finishes loading. Run it at
set_note() time instead, so that the editor loads first.
- don't throw an error when a long-running op started with with_progress()
finishes after the window it was launched from has closed
- don't throw an error when the browser is closed before the sidebar
has finished loading
2021-03-17 12:27:42 +01:00
|
|
|
def clear_unused_tags(self) -> None:
|
2021-04-06 06:36:13 +02:00
|
|
|
clear_unused_tags(parent=self).run_in_background()
|
2017-08-11 06:40:51 +02:00
|
|
|
|
2021-03-05 11:47:51 +01:00
|
|
|
addTags = add_tags_to_selected_notes
|
|
|
|
|
deleteTags = remove_tags_from_selected_notes
|
clear_unused_tags and browser redraw improvements
- clear_unused_tags() is now undoable, and returns the number of removed
notes
- add a new mw.query_op() helper for immutable queries
- decouple "freeze/unfreeze ui state" hooks from the "interface update
required" hook, so that the former is fired even on error, and can be
made re-entrant
- use a 'block_updates' flag in Python, instead of setUpdatesEnabled(),
as the latter has the side-effect of preventing child windows like
tooltips from appearing, and forces a full redrawn when updates are
enabled again. The new behaviour leads to the card list blanking out
when a long-running op is running, but in the future if we cache the
cell values we can just display them from the cache instead.
- we were indiscriminately saving the note with saveNow(), due to the
call to saveTags(). Changed so that it only saves when the tags field
is focused.
- drain the "on_done" queue on main before launching a new background
task, to lower the chances of something in on_done making a small query
to the DB and hanging until a long op finishes
- the duplicate check in the editor was executed after the webview loads,
leading to it hanging until the sidebar finishes loading. Run it at
set_note() time instead, so that the editor loads first.
- don't throw an error when a long-running op started with with_progress()
finishes after the window it was launched from has closed
- don't throw an error when the browser is closed before the sidebar
has finished loading
2021-03-17 12:27:42 +01:00
|
|
|
clearUnusedTags = clear_unused_tags
|
2021-03-05 11:47:51 +01:00
|
|
|
|
2017-08-12 08:08:10 +02:00
|
|
|
# Suspending
|
2012-12-21 08:51:59 +01:00
|
|
|
######################################################################
|
|
|
|
|
|
2021-03-31 10:05:44 +02:00
|
|
|
def _update_toggle_suspend_action(self) -> None:
|
|
|
|
|
is_suspended = bool(self.card and self.card.queue == QUEUE_TYPE_SUSPENDED)
|
|
|
|
|
self.form.actionToggle_Suspend.setChecked(is_suspended)
|
2012-12-21 08:51:59 +01:00
|
|
|
|
2021-04-25 08:47:15 +02:00
|
|
|
@skip_if_selection_is_empty
|
2021-03-31 10:05:44 +02:00
|
|
|
@ensure_editor_saved
|
|
|
|
|
def suspend_selected_cards(self, checked: bool) -> None:
|
2021-03-18 02:46:11 +01:00
|
|
|
cids = self.selected_cards()
|
2021-03-31 10:05:44 +02:00
|
|
|
if checked:
|
2021-04-06 08:38:42 +02:00
|
|
|
suspend_cards(parent=self, card_ids=cids).run_in_background()
|
undoable ops now return changes directly; add new *_ops.py files
- Introduced a new transact() method that wraps the return value
in a separate struct that describes the changes that were made.
- Changes are now gathered from the undo log, so we don't need to
guess at what was changed - eg if update_note() is called with identical
note contents, no changes are returned. Card changes will only be set
if cards were actually generated by the update_note() call, and tag
will only be set if a new tag was added.
- mw.perform_op() has been updated to expect the op to return the changes,
or a structure with the changes in it, and it will use them to fire the
change hook, instead of fetching the changes from undo_status(), so there
is no risk of race conditions.
- the various calls to mw.perform_op() have been split into separate
files like card_ops.py. Aside from making the code cleaner, this works
around a rather annoying issue with mypy. Because we run it with
no_strict_optional, mypy is happy to accept an operation that returns None,
despite the type signature saying it requires changes to be returned.
Turning no_strict_optional on for the whole codebase is not practical
at the moment, but we can enable it for individual files.
Still todo:
- The cursor keeps moving back to the start of a field when typing -
we need to ignore the refresh hook when we are the initiator.
- The busy cursor icon should probably be delayed a few hundreds ms.
- Still need to think about a nicer way of handling saveNow()
- op_made_changes(), op_affects_study_queue() might be better embedded
as properties in the object instead
2021-03-16 05:26:42 +01:00
|
|
|
else:
|
2021-04-06 08:38:42 +02:00
|
|
|
unsuspend_cards(parent=self.mw, card_ids=cids).run_in_background()
|
2012-12-21 08:51:59 +01:00
|
|
|
|
2020-02-10 04:15:10 +01:00
|
|
|
# Exporting
|
|
|
|
|
######################################################################
|
|
|
|
|
|
2021-04-26 08:46:08 +02:00
|
|
|
@no_arg_trigger
|
|
|
|
|
@skip_if_selection_is_empty
|
2021-02-01 00:39:55 +01:00
|
|
|
def _on_export_notes(self) -> None:
|
2020-02-10 04:15:10 +01:00
|
|
|
cids = self.selectedNotesAsCards()
|
2021-04-25 08:47:15 +02:00
|
|
|
ExportDialog(self.mw, cids=list(cids))
|
2020-02-10 04:15:10 +01:00
|
|
|
|
2017-08-16 12:30:29 +02:00
|
|
|
# Flags & Marking
|
2017-08-12 08:08:10 +02:00
|
|
|
######################################################################
|
2012-12-21 08:51:59 +01:00
|
|
|
|
2021-04-25 08:47:15 +02:00
|
|
|
@skip_if_selection_is_empty
|
2021-03-18 03:06:45 +01:00
|
|
|
@ensure_editor_saved
|
|
|
|
|
def set_flag_of_selected_cards(self, flag: int) -> None:
|
2019-12-06 05:23:54 +01:00
|
|
|
if not self.card:
|
|
|
|
|
return
|
2020-09-27 04:31:25 +02:00
|
|
|
|
2018-11-12 02:11:53 +01:00
|
|
|
# flag needs toggling off?
|
undoable ops now return changes directly; add new *_ops.py files
- Introduced a new transact() method that wraps the return value
in a separate struct that describes the changes that were made.
- Changes are now gathered from the undo log, so we don't need to
guess at what was changed - eg if update_note() is called with identical
note contents, no changes are returned. Card changes will only be set
if cards were actually generated by the update_note() call, and tag
will only be set if a new tag was added.
- mw.perform_op() has been updated to expect the op to return the changes,
or a structure with the changes in it, and it will use them to fire the
change hook, instead of fetching the changes from undo_status(), so there
is no risk of race conditions.
- the various calls to mw.perform_op() have been split into separate
files like card_ops.py. Aside from making the code cleaner, this works
around a rather annoying issue with mypy. Because we run it with
no_strict_optional, mypy is happy to accept an operation that returns None,
despite the type signature saying it requires changes to be returned.
Turning no_strict_optional on for the whole codebase is not practical
at the moment, but we can enable it for individual files.
Still todo:
- The cursor keeps moving back to the start of a field when typing -
we need to ignore the refresh hook when we are the initiator.
- The busy cursor icon should probably be delayed a few hundreds ms.
- Still need to think about a nicer way of handling saveNow()
- op_made_changes(), op_affects_study_queue() might be better embedded
as properties in the object instead
2021-03-16 05:26:42 +01:00
|
|
|
if flag == self.card.user_flag():
|
|
|
|
|
flag = 0
|
more reset refactoring
'card modified' covers the common case where we need to rebuild the
study queue, but is also set when changing the card flags. We want to
avoid a queue rebuild in that case, as it causes UI flicker, and may
result in a different card being shown. Note marking doesn't trigger
a queue build, but still causes flicker, and may return the user back
to the front side when they were looking at the answer.
I still think entity-based change tracking is the simplest in the
common case, but to solve the above, I've introduced an enum describing
the last operation that was taken. This currently is not trying to list
out all possible operations, and just describes the ones we want to
special-case.
Other changes:
- Fire the old 'state_did_reset' hook after an operation is performed,
so legacy code can refresh itself after an operation is performed.
- Fire the new `operation_did_execute` hook when mw.reset() is called,
so that as the UI is updated to the use the new hook, it will still
be able to refresh after legacy code calls mw.reset()
- Update the deck browser, overview and review screens to listen to
the new hook, instead of relying on the main window to call moveToState()
- Add a 'set flag' backend action, so we can distinguish it from a
normal card update.
- Drop the separate added/modified entries in the change list in
favour of a single entry per entity.
- Add typing to mw.state
- Tweak perform_op()
- Convert a few more actions to use perform_op()
2021-03-14 10:54:15 +01:00
|
|
|
|
2021-04-06 06:36:13 +02:00
|
|
|
set_card_flag(
|
|
|
|
|
parent=self, card_ids=self.selected_cards(), flag=flag
|
|
|
|
|
).run_in_background()
|
2012-12-21 08:51:59 +01:00
|
|
|
|
2021-03-18 03:06:45 +01:00
|
|
|
def _update_flags_menu(self) -> None:
|
2021-03-06 15:17:17 +01:00
|
|
|
flag = self.card and self.card.user_flag()
|
2018-11-12 03:10:50 +01:00
|
|
|
flag = flag or 0
|
|
|
|
|
|
2021-05-19 19:17:43 +02:00
|
|
|
for f in load_flags(self.col):
|
|
|
|
|
getattr(self.form, f.action).setChecked(flag == f.index)
|
2019-02-05 05:37:07 +01:00
|
|
|
|
|
|
|
|
qtMenuShortcutWorkaround(self.form.menuFlag)
|
2018-11-12 03:10:50 +01:00
|
|
|
|
2021-05-19 10:34:36 +02:00
|
|
|
def _update_flag_labels(self) -> None:
|
|
|
|
|
for flag in load_flags(self.col):
|
2021-05-19 19:17:43 +02:00
|
|
|
getattr(self.form, flag.action).setText(flag.label)
|
2021-05-19 10:34:36 +02:00
|
|
|
|
2021-03-31 10:05:44 +02:00
|
|
|
def toggle_mark_of_selected_notes(self, checked: bool) -> None:
|
|
|
|
|
if checked:
|
2021-03-18 03:06:45 +01:00
|
|
|
self.add_tags_to_selected_notes(tags=MARKED_TAG)
|
2021-03-31 10:05:44 +02:00
|
|
|
else:
|
|
|
|
|
self.remove_tags_from_selected_notes(tags=MARKED_TAG)
|
|
|
|
|
|
|
|
|
|
def _update_toggle_mark_action(self) -> None:
|
|
|
|
|
is_marked = bool(self.card and self.card.note().has_tag(MARKED_TAG))
|
|
|
|
|
self.form.actionToggle_Mark.setChecked(is_marked)
|
2017-08-16 12:30:29 +02:00
|
|
|
|
2021-03-18 02:46:11 +01:00
|
|
|
# Scheduling
|
2012-12-21 08:51:59 +01:00
|
|
|
######################################################################
|
|
|
|
|
|
2021-04-26 08:46:08 +02:00
|
|
|
@no_arg_trigger
|
|
|
|
|
@skip_if_selection_is_empty
|
|
|
|
|
@ensure_editor_saved
|
2021-02-01 00:39:55 +01:00
|
|
|
def reposition(self) -> None:
|
2021-03-18 02:46:11 +01:00
|
|
|
if self.card and self.card.queue != QUEUE_TYPE_NEW:
|
2021-03-26 04:48:26 +01:00
|
|
|
showInfo(tr.browsing_only_new_cards_can_be_repositioned(), parent=self)
|
2012-12-21 08:51:59 +01:00
|
|
|
return
|
|
|
|
|
|
2021-04-25 11:26:55 +02:00
|
|
|
if op := reposition_new_cards_dialog(
|
2021-04-06 08:38:42 +02:00
|
|
|
parent=self, card_ids=self.selected_cards()
|
2021-04-25 11:26:55 +02:00
|
|
|
):
|
|
|
|
|
op.run_in_background()
|
2012-12-21 08:51:59 +01:00
|
|
|
|
2021-04-26 08:46:08 +02:00
|
|
|
@no_arg_trigger
|
|
|
|
|
@skip_if_selection_is_empty
|
|
|
|
|
@ensure_editor_saved
|
Rework reschedule tool
The old rescheduling dialog's two options have been split into two
separate menu items, "Forget", and "Set Due Date"
For cards that are not review cards, "Set Due Date" behaves like the
old reschedule option, changing the cards into a review card, and
and setting both the interval and due date to the provided number of
days.
When "Set Due Date" is applied to a review card, it no longer resets
the card's interval. Instead, it looks at how much the provided number
of days will change the original interval, and adjusts the interval by
that amount, so that cards that are answered earlier receive a smaller
next interval, and cards that are answered after a longer delay receive
a bonus.
For example, imagine a card was answered on day 5, and given an interval
of 10 days, so it has a due date of day 15.
- if on day 10 the due date is changed to day 12 (today+2), the card
is being scheduled 3 days earlier than it was supposed to be, so the
interval will be adjusted to 7 days.
- and if on day 10 the due date is changed to day 20, the interval will
be changed from 10 days to 15 days.
There is no separate option to reset the interval of a review card, but
it can be accomplished by forgetting the card(s), and then setting the
desired due date.
Other notes:
- Added the action to the review screen as well.
- Set the shortcut to Ctrl+Shift+D, and changed the existing Delete
Tags shortcut to Ctrl+Alt+Shift+A.
2021-02-07 11:58:16 +01:00
|
|
|
def set_due_date(self) -> None:
|
2021-04-25 11:26:55 +02:00
|
|
|
if op := set_due_date_dialog(
|
2021-03-16 13:40:37 +01:00
|
|
|
parent=self,
|
2021-03-18 02:46:11 +01:00
|
|
|
card_ids=self.selected_cards(),
|
2021-03-16 13:40:37 +01:00
|
|
|
config_key=Config.String.SET_DUE_BROWSER,
|
2021-04-25 11:26:55 +02:00
|
|
|
):
|
|
|
|
|
op.run_in_background()
|
Rework reschedule tool
The old rescheduling dialog's two options have been split into two
separate menu items, "Forget", and "Set Due Date"
For cards that are not review cards, "Set Due Date" behaves like the
old reschedule option, changing the cards into a review card, and
and setting both the interval and due date to the provided number of
days.
When "Set Due Date" is applied to a review card, it no longer resets
the card's interval. Instead, it looks at how much the provided number
of days will change the original interval, and adjusts the interval by
that amount, so that cards that are answered earlier receive a smaller
next interval, and cards that are answered after a longer delay receive
a bonus.
For example, imagine a card was answered on day 5, and given an interval
of 10 days, so it has a due date of day 15.
- if on day 10 the due date is changed to day 12 (today+2), the card
is being scheduled 3 days earlier than it was supposed to be, so the
interval will be adjusted to 7 days.
- and if on day 10 the due date is changed to day 20, the interval will
be changed from 10 days to 15 days.
There is no separate option to reset the interval of a review card, but
it can be accomplished by forgetting the card(s), and then setting the
desired due date.
Other notes:
- Added the action to the review screen as well.
- Set the shortcut to Ctrl+Shift+D, and changed the existing Delete
Tags shortcut to Ctrl+Alt+Shift+A.
2021-02-07 11:58:16 +01:00
|
|
|
|
2021-04-26 08:46:08 +02:00
|
|
|
@no_arg_trigger
|
|
|
|
|
@skip_if_selection_is_empty
|
|
|
|
|
@ensure_editor_saved
|
Rework reschedule tool
The old rescheduling dialog's two options have been split into two
separate menu items, "Forget", and "Set Due Date"
For cards that are not review cards, "Set Due Date" behaves like the
old reschedule option, changing the cards into a review card, and
and setting both the interval and due date to the provided number of
days.
When "Set Due Date" is applied to a review card, it no longer resets
the card's interval. Instead, it looks at how much the provided number
of days will change the original interval, and adjusts the interval by
that amount, so that cards that are answered earlier receive a smaller
next interval, and cards that are answered after a longer delay receive
a bonus.
For example, imagine a card was answered on day 5, and given an interval
of 10 days, so it has a due date of day 15.
- if on day 10 the due date is changed to day 12 (today+2), the card
is being scheduled 3 days earlier than it was supposed to be, so the
interval will be adjusted to 7 days.
- and if on day 10 the due date is changed to day 20, the interval will
be changed from 10 days to 15 days.
There is no separate option to reset the interval of a review card, but
it can be accomplished by forgetting the card(s), and then setting the
desired due date.
Other notes:
- Added the action to the review screen as well.
- Set the shortcut to Ctrl+Shift+D, and changed the existing Delete
Tags shortcut to Ctrl+Alt+Shift+A.
2021-02-07 11:58:16 +01:00
|
|
|
def forget_cards(self) -> None:
|
2021-03-16 13:40:37 +01:00
|
|
|
forget_cards(
|
|
|
|
|
parent=self,
|
2021-03-18 02:46:11 +01:00
|
|
|
card_ids=self.selected_cards(),
|
2021-04-06 08:38:42 +02:00
|
|
|
).run_in_background()
|
2012-12-21 08:51:59 +01:00
|
|
|
|
|
|
|
|
# Edit: selection
|
|
|
|
|
######################################################################
|
|
|
|
|
|
2021-04-26 08:46:08 +02:00
|
|
|
@no_arg_trigger
|
|
|
|
|
@skip_if_selection_is_empty
|
|
|
|
|
@ensure_editor_saved
|
2021-02-01 00:39:55 +01:00
|
|
|
def selectNotes(self) -> None:
|
2021-03-18 02:46:11 +01:00
|
|
|
nids = self.selected_notes()
|
2012-12-21 08:51:59 +01:00
|
|
|
# clear the selection so we don't waste energy preserving it
|
2021-03-29 08:12:26 +02:00
|
|
|
self.table.clear_selection()
|
2021-01-30 02:23:32 +01:00
|
|
|
search = self.col.build_search_string(
|
2021-02-11 10:57:19 +01:00
|
|
|
SearchNode(nids=SearchNode.IdList(ids=nids))
|
2021-01-30 02:23:32 +01:00
|
|
|
)
|
2020-10-19 20:51:36 +02:00
|
|
|
self.search_for(search)
|
2021-03-29 08:12:26 +02:00
|
|
|
self.table.select_all()
|
2012-12-21 08:51:59 +01:00
|
|
|
|
2020-01-15 22:53:12 +01:00
|
|
|
# Hooks
|
2012-12-21 08:51:59 +01:00
|
|
|
######################################################################
|
|
|
|
|
|
2020-01-15 22:41:23 +01:00
|
|
|
def setupHooks(self) -> None:
|
2021-05-19 07:18:39 +02:00
|
|
|
gui_hooks.undo_state_did_change.append(self.on_undo_state_change)
|
2021-03-29 08:12:26 +02:00
|
|
|
gui_hooks.backend_will_block.append(self.table.on_backend_will_block)
|
|
|
|
|
gui_hooks.backend_did_block.append(self.table.on_backend_did_block)
|
2021-03-13 14:59:32 +01:00
|
|
|
gui_hooks.operation_did_execute.append(self.on_operation_did_execute)
|
2021-03-14 13:08:37 +01:00
|
|
|
gui_hooks.focus_did_change.append(self.on_focus_change)
|
2012-12-21 08:51:59 +01:00
|
|
|
|
2020-01-15 22:41:23 +01:00
|
|
|
def teardownHooks(self) -> None:
|
2021-05-19 07:18:39 +02:00
|
|
|
gui_hooks.undo_state_did_change.remove(self.on_undo_state_change)
|
2021-03-29 08:12:26 +02:00
|
|
|
gui_hooks.backend_will_block.remove(self.table.on_backend_will_block)
|
|
|
|
|
gui_hooks.backend_did_block.remove(self.table.on_backend_will_block)
|
2021-03-13 14:59:32 +01:00
|
|
|
gui_hooks.operation_did_execute.remove(self.on_operation_did_execute)
|
2021-03-14 13:08:37 +01:00
|
|
|
gui_hooks.focus_did_change.remove(self.on_focus_change)
|
2020-01-15 22:53:12 +01:00
|
|
|
|
2021-03-12 08:56:13 +01:00
|
|
|
# Undo
|
|
|
|
|
######################################################################
|
|
|
|
|
|
|
|
|
|
def undo(self) -> None:
|
2021-04-06 06:36:13 +02:00
|
|
|
undo(parent=self)
|
2021-03-12 08:56:13 +01:00
|
|
|
|
2021-05-19 07:18:39 +02:00
|
|
|
def redo(self) -> None:
|
|
|
|
|
redo(parent=self)
|
|
|
|
|
|
|
|
|
|
def on_undo_state_change(self, info: UndoActionsInfo) -> None:
|
|
|
|
|
self.form.actionUndo.setText(info.undo_text)
|
|
|
|
|
self.form.actionUndo.setEnabled(info.can_undo)
|
|
|
|
|
self.form.actionRedo.setText(info.redo_text)
|
|
|
|
|
self.form.actionRedo.setEnabled(info.can_redo)
|
|
|
|
|
self.form.actionRedo.setVisible(info.show_redo)
|
2012-12-21 08:51:59 +01:00
|
|
|
|
|
|
|
|
# Edit: replacing
|
|
|
|
|
######################################################################
|
|
|
|
|
|
2021-04-26 08:46:08 +02:00
|
|
|
@no_arg_trigger
|
|
|
|
|
@skip_if_selection_is_empty
|
|
|
|
|
@ensure_editor_saved
|
2021-02-01 00:39:55 +01:00
|
|
|
def onFindReplace(self) -> None:
|
2021-04-25 08:47:15 +02:00
|
|
|
FindAndReplaceDialog(self, mw=self.mw, note_ids=self.selected_notes())
|
2012-12-21 08:51:59 +01:00
|
|
|
|
|
|
|
|
# Edit: finding dupes
|
|
|
|
|
######################################################################
|
|
|
|
|
|
2021-04-26 08:46:08 +02:00
|
|
|
@no_arg_trigger
|
|
|
|
|
@ensure_editor_saved
|
2021-02-01 00:39:55 +01:00
|
|
|
def onFindDupes(self) -> None:
|
2021-05-08 06:32:15 +02:00
|
|
|
from aqt.browser.find_duplicates import FindDuplicatesDialog
|
2013-10-03 17:07:11 +02:00
|
|
|
|
2021-05-08 06:32:15 +02:00
|
|
|
FindDuplicatesDialog(browser=self, mw=self.mw)
|
2012-12-21 08:51:59 +01:00
|
|
|
|
|
|
|
|
# Jumping
|
|
|
|
|
######################################################################
|
|
|
|
|
|
2021-03-29 08:12:26 +02:00
|
|
|
def has_previous_card(self) -> bool:
|
|
|
|
|
return self.table.has_previous()
|
|
|
|
|
|
|
|
|
|
def has_next_card(self) -> bool:
|
|
|
|
|
return self.table.has_next()
|
2012-12-21 08:51:59 +01:00
|
|
|
|
2021-02-01 00:39:55 +01:00
|
|
|
def onPreviousCard(self) -> None:
|
2017-08-05 07:15:19 +02:00
|
|
|
self.focusTo = self.editor.currentField
|
2021-03-29 08:12:26 +02:00
|
|
|
self.editor.call_after_note_saved(self.table.to_previous_row)
|
2012-12-21 08:51:59 +01:00
|
|
|
|
2021-02-01 00:39:55 +01:00
|
|
|
def onNextCard(self) -> None:
|
2017-08-05 07:15:19 +02:00
|
|
|
self.focusTo = self.editor.currentField
|
2021-03-29 08:12:26 +02:00
|
|
|
self.editor.call_after_note_saved(self.table.to_next_row)
|
2012-12-21 08:51:59 +01:00
|
|
|
|
2021-02-01 00:39:55 +01:00
|
|
|
def onFirstCard(self) -> None:
|
2021-03-29 08:12:26 +02:00
|
|
|
self.table.to_first_row()
|
2012-12-21 08:51:59 +01:00
|
|
|
|
2021-02-01 00:39:55 +01:00
|
|
|
def onLastCard(self) -> None:
|
2021-03-29 08:12:26 +02:00
|
|
|
self.table.to_last_row()
|
2012-12-21 08:51:59 +01:00
|
|
|
|
2021-02-01 00:39:55 +01:00
|
|
|
def onFind(self) -> None:
|
2020-10-24 10:47:25 +02:00
|
|
|
# workaround for PyQt focus bug
|
|
|
|
|
self.editor.hideCompleters()
|
|
|
|
|
|
2012-12-21 08:51:59 +01:00
|
|
|
self.form.searchEdit.setFocus()
|
|
|
|
|
self.form.searchEdit.lineEdit().selectAll()
|
|
|
|
|
|
2021-02-01 00:39:55 +01:00
|
|
|
def onNote(self) -> None:
|
2020-10-24 10:47:25 +02:00
|
|
|
# workaround for PyQt focus bug
|
|
|
|
|
self.editor.hideCompleters()
|
|
|
|
|
|
2013-01-29 01:49:04 +01:00
|
|
|
self.editor.web.setFocus()
|
2019-12-06 05:22:49 +01:00
|
|
|
self.editor.loadNote(focusTo=0)
|
2012-12-21 08:51:59 +01:00
|
|
|
|
2021-02-01 00:39:55 +01:00
|
|
|
def onCardList(self) -> None:
|
2012-12-21 08:51:59 +01:00
|
|
|
self.form.tableView.setFocus()
|