langfingaz/anki
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #791 from abdnh/sidebar-context-menu

Browse Source 
help-wanted#6: continue work on new browser sidebar (based on #590)
This commit is contained in:
Damien Elmes 2020-10-21 21:13:32 +10:00 committed by GitHub
commit 5fc841de85
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 147 additions and 50 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

90
qt/aqt/browser.py
View File

@ -31,6 +31,7 @@ from aqt.main import ResetReason
from aqt.previewer import BrowserPreviewer as PreviewDialog
from aqt.previewer import Previewer
from aqt.qt import *
from aqt.sidebar import NewSidebarTreeView, SidebarItemType, SidebarTreeViewBase
from aqt.theme import theme_manager
from aqt.utils import (
MenuList,
@ -448,14 +449,18 @@ class SidebarItem:
onClick: Callable[[], None] = None,
onExpanded: Callable[[bool], None] = None,
expanded: bool = False,
item_type: SidebarItemType = SidebarItemType.CUSTOM,
id: int = 0,
) -> None:
self.name = name
self.icon = icon
self.item_type = item_type
self.id = id
self.onClick = onClick
self.onExpanded = onExpanded
self.expanded = expanded
self.children: List["SidebarItem"] = []
self.parentItem: Optional[SidebarItem] = None
self.parentItem: Optional["SidebarItem"] = None
self.tooltip: Optional[str] = None
def addChild(self, cb: "SidebarItem") -> None:
@ -584,6 +589,7 @@ class Browser(QMainWindow):
def __init__(self, mw: AnkiQt) -> None:
QMainWindow.__init__(self, None, Qt.Window)
self.mw = mw
self.want_old_sidebar = mw.app.queryKeyboardModifiers() & Qt.ShiftModifier
self.col = self.mw.col
self.lastFilter = ""
self.focusTo: Optional[int] = None
@ -1015,51 +1021,22 @@ QTableView {{ gridline-color: {grid} }}
def onColumnMoved(self, a, b, c):
self.setColumnSizes()
# Sidebar
######################################################################
class SidebarTreeView(QTreeView):
def __init__(self):
super().__init__()
qconnect(self.expanded, self.onExpansion)
qconnect(self.collapsed, self.onCollapse)
def onClickCurrent(self) -> None:
idx = self.currentIndex()
if idx.isValid():
item: SidebarItem = idx.internalPointer()
if item.onClick:
item.onClick()
def mouseReleaseEvent(self, event: QMouseEvent) -> None:
super().mouseReleaseEvent(event)
self.onClickCurrent()
def keyPressEvent(self, event: QKeyEvent) -> None:
if event.key() in (Qt.Key_Return, Qt.Key_Enter):
self.onClickCurrent()
else:
super().keyPressEvent(event)
def onExpansion(self, idx: QModelIndex) -> None:
self._onExpansionChange(idx, True)
def onCollapse(self, idx: QModelIndex) -> None:
self._onExpansionChange(idx, False)
def _onExpansionChange(self, idx: QModelIndex, expanded: bool) -> None:
item: SidebarItem = idx.internalPointer()
if item.expanded != expanded:
item.expanded = expanded
if item.onExpanded:
item.onExpanded(expanded)
# implementation moved to sidebar.py. this is kept for compatibility
class SidebarTreeView(SidebarTreeViewBase):
pass
def setupSidebar(self) -> None:
dw = self.sidebarDockWidget = QDockWidget(_("Sidebar"), self)
dw.setFeatures(QDockWidget.DockWidgetClosable)
dw.setObjectName("Sidebar")
dw.setAllowedAreas(Qt.LeftDockWidgetArea)
self.sidebarTree = self.SidebarTreeView()
self.sidebarTree: SidebarTreeViewBase
if self.want_old_sidebar:
self.sidebarTree = self.SidebarTreeView()
else:
self.sidebarTree = NewSidebarTreeView(self)
self.sidebarTree.mw = self.mw
self.sidebarTree.setUniformRowHeights(True)
self.sidebarTree.setHeaderHidden(True)
@ -1097,7 +1074,7 @@ QTableView {{ gridline-color: {grid} }}
self.mw.progress.timer(10, deferredDisplay, False)
def buildTree(self) -> SidebarItem:
root = SidebarItem("", "")
root = SidebarItem("", "", item_type=SidebarItemType.ROOT)
handled = gui_hooks.browser_will_build_tree(
False, root, SidebarStage.ROOT, self
@ -1122,14 +1099,20 @@ QTableView {{ gridline-color: {grid} }}
return root
def _stdTree(self, root) -> None:
for name, filt, icon in [
[_("Whole Collection"), "", "collection"],
[_("Current Deck"), "deck:current", "deck"],
]:
item = SidebarItem(
name, ":/icons/{}.svg".format(icon), self._filterFunc(filt)
)
root.addChild(item)
item = SidebarItem(
_("Whole Collection"),
":/icons/collection.svg",
self._filterFunc(""),
item_type=SidebarItemType.COLLECTION,
)
root.addChild(item)
item = SidebarItem(
_("Current Deck"),
":/icons/deck.svg",
self._filterFunc("deck:current"),
item_type=SidebarItemType.CURRENT_DECK,
)
root.addChild(item)
def _favTree(self, root) -> None:
assert self.col
@ -1139,6 +1122,7 @@ QTableView {{ gridline-color: {grid} }}
name,
":/icons/heart.svg",
lambda s=filt: self.setFilter(s), # type: ignore
item_type=SidebarItemType.FILTER,
)
root.addChild(item)
@ -1146,7 +1130,10 @@ QTableView {{ gridline-color: {grid} }}
assert self.col
for t in self.col.tags.all():
item = SidebarItem(
t, ":/icons/tag.svg", lambda t=t: self.setFilter("tag", t) # type: ignore
t,
":/icons/tag.svg",
lambda t=t: self.setFilter("tag", t), # type: ignore
item_type=SidebarItemType.TAG,
)
root.addChild(item)
@ -1170,6 +1157,8 @@ QTableView {{ gridline-color: {grid} }}
set_filter(),
toggle_expand(),
not node.collapsed,
item_type=SidebarItemType.DECK,
id=node.deck_id,
)
root.addChild(item)
newhead = head + node.name + "::"
@ -1184,6 +1173,7 @@ QTableView {{ gridline-color: {grid} }}
m.name,
":/icons/notetype.svg",
lambda m=m: self.setFilter("note", m.name), # type: ignore
item_type=SidebarItemType.NOTETYPE,
)
root.addChild(item)

107
qt/aqt/sidebar.py Normal file
View File

@ -0,0 +1,107 @@
# -*- coding: utf-8 -*-
# Copyright: Ankitects Pty Ltd and contributors
# License: GNU AGPL, version 3 or later; http://www.gnu.org/licenses/agpl.html
from __future__ import annotations
from enum import Enum
import aqt
from anki.errors import DeckRenameError
from anki.lang import _
from aqt.qt import *
from aqt.utils import getOnlyText, showWarning
class SidebarItemType(Enum):
ROOT = 0
COLLECTION = 1
CURRENT_DECK = 2
FILTER = 3
DECK = 4
NOTETYPE = 5
TAG = 6
CUSTOM = 7
class SidebarTreeViewBase(QTreeView):
def __init__(self):
super().__init__()
qconnect(self.expanded, self.onExpansion)
qconnect(self.collapsed, self.onCollapse)
def onClickCurrent(self) -> None:
idx = self.currentIndex()
if idx.isValid():
item: "aqt.browser.SidebarItem" = idx.internalPointer()
if item.onClick:
item.onClick()
def mouseReleaseEvent(self, event: QMouseEvent) -> None:
super().mouseReleaseEvent(event)
self.onClickCurrent()
def keyPressEvent(self, event: QKeyEvent) -> None:
if event.key() in (Qt.Key_Return, Qt.Key_Enter):
self.onClickCurrent()
else:
super().keyPressEvent(event)
def onExpansion(self, idx: QModelIndex) -> None:
self._onExpansionChange(idx, True)
def onCollapse(self, idx: QModelIndex) -> None:
self._onExpansionChange(idx, False)
def _onExpansionChange(self, idx: QModelIndex, expanded: bool) -> None:
item: "aqt.browser.SidebarItem" = idx.internalPointer()
if item.expanded != expanded:
item.expanded = expanded
if item.onExpanded:
item.onExpanded(expanded)
class NewSidebarTreeView(SidebarTreeViewBase):
def __init__(self, browser: aqt.browser.Browser) -> None:
super().__init__()
self.browser = browser
self.mw = browser.mw
self.col = self.mw.col
self.setContextMenuPolicy(Qt.CustomContextMenu)
self.customContextMenuRequested.connect(self.onContextMenu) # type: ignore
self.context_menus = {
SidebarItemType.DECK: ((_("Rename"), self.rename_deck),),
}
def onContextMenu(self, point: QPoint) -> None:
idx: QModelIndex = self.indexAt(point)
item: "aqt.browser.SidebarItem" = idx.internalPointer()
if not item:
return
item_type: SidebarItemType = item.item_type
if item_type not in self.context_menus:
return
m = QMenu()
for action in self.context_menus[item_type]:
act_name = action[0]
act_func = action[1]
a = m.addAction(act_name)
a.triggered.connect(lambda _, func=act_func: func(item)) # type: ignore
m.exec_(QCursor.pos())
def rename_deck(self, item: "aqt.browser.SidebarItem") -> None:
self.mw.checkpoint(_("Rename Deck"))
deck = self.mw.col.decks.get(item.id)
old_name = deck["name"]
new_name = getOnlyText(_("New deck name:"), default=old_name)
new_name = new_name.replace('"', "")
if not new_name or new_name == old_name:
return
try:
self.mw.col.decks.rename(deck, new_name)
self.browser.maybeRefreshSidebar()
except DeckRenameError as e:
return showWarning(e.description)
self.show()