aqt.browser.sidebar.tree#

Classes#

SidebarStage

Create a collection of name/value pairs.

SidebarTreeView

Module Contents#

class aqt.browser.sidebar.tree.SidebarStage(*args, **kwds)#

Bases: enum.Enum

Create a collection of name/value pairs.

Example enumeration:

>>> class Color(Enum):
...     RED = 1
...     BLUE = 2
...     GREEN = 3

Access them by:

  • attribute access:

    >>> Color.RED
    <Color.RED: 1>
    
  • value lookup:

    >>> Color(1)
    <Color.RED: 1>
    
  • name lookup:

    >>> Color['RED']
    <Color.RED: 1>
    

Enumerations can be iterated over, and know how many members they have:

>>> len(Color)
3
>>> list(Color)
[<Color.RED: 1>, <Color.BLUE: 2>, <Color.GREEN: 3>]

Methods can be added to enumerations, and members can have their own attributes – see the documentation for details.

ROOT#
SAVED_SEARCHES#
TODAY#
FLAGS#
CARD_STATE#
DECKS#
NOTETYPES#
TAGS#
class aqt.browser.sidebar.tree.SidebarTreeView(browser: aqt.browser.Browser)#

Bases: QTreeView

browser#
mw#
col#
valid_drop_types: tuple[aqt.browser.sidebar.item.SidebarItemType, Ellipsis] = ()#
toolbar#
searchBar#
cleanup() None#
property tool: aqt.browser.sidebar.toolbar.SidebarTool#
model() aqt.browser.sidebar.model.SidebarModel#
op_executed(changes: anki.collection.OpChanges, handler: object | None, focused: bool) None#
refresh_if_needed() None#
refresh(new_current: aqt.browser.sidebar.item.SidebarItem | None = None) None#

Refresh list. No-op if sidebar is not visible.

restore_current(current: aqt.browser.sidebar.item.SidebarItem) None#
find_item(is_target: aqt.qt.Callable[[aqt.browser.sidebar.item.SidebarItem], bool], parent: aqt.browser.sidebar.item.SidebarItem | None = None) aqt.browser.sidebar.item.SidebarItem | None#
search_for(text: str) None#

Modify the current search string based on modifier keys, then refresh.

drawRow(painter: QPainter | None, options: QStyleOptionViewItem, idx: QModelIndex) None#
dropEvent(event: QDropEvent | None) None#
mouseReleaseEvent(event: QMouseEvent | None) None#
keyPressEvent(event: QKeyEvent | None) None#
handle_drag_drop(sources: list[aqt.browser.sidebar.item.SidebarItem], target: aqt.browser.sidebar.item.SidebarItem) bool#
onContextMenu(point: QPoint) None#
show_context_menu(item: aqt.browser.sidebar.item.SidebarItem, index: QModelIndex) None#
rename_flag(item: aqt.browser.sidebar.item.SidebarItem, new_name: str) None#
restore_default_flag_name(item: aqt.browser.sidebar.item.SidebarItem) None#
rename_deck(item: aqt.browser.sidebar.item.SidebarItem, new_name: str) None#
delete_decks(_item: aqt.browser.sidebar.item.SidebarItem) None#
remove_tags(item: aqt.browser.sidebar.item.SidebarItem) None#
rename_tag(item: aqt.browser.sidebar.item.SidebarItem, new_name: str) None#
add_tags_to_selected_notes() None#
remove_tags_from_selected_notes() None#
remove_saved_searches(_item: aqt.browser.sidebar.item.SidebarItem) None#
manage_notetype(item: aqt.browser.sidebar.item.SidebarItem) None#
manage_template(item: aqt.browser.sidebar.item.SidebarItem) None#
manage_fields(item: aqt.browser.sidebar.item.SidebarItem) None#