aqt.browser.sidebar.tree
========================

.. py:module:: aqt.browser.sidebar.tree


Classes
-------

.. autoapisummary::

   aqt.browser.sidebar.tree.SidebarStage
   aqt.browser.sidebar.tree.SidebarTreeView


Module Contents
---------------

.. py:class:: SidebarStage(*args, **kwds)

   Bases: :py:obj:`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.


   .. py:attribute:: ROOT


   .. py:attribute:: SAVED_SEARCHES


   .. py:attribute:: TODAY


   .. py:attribute:: FLAGS


   .. py:attribute:: CARD_STATE


   .. py:attribute:: DECKS


   .. py:attribute:: NOTETYPES


   .. py:attribute:: TAGS


.. py:class:: SidebarTreeView(browser: aqt.browser.Browser)

   Bases: :py:obj:`QTreeView`


   .. py:attribute:: browser


   .. py:attribute:: mw


   .. py:attribute:: col


   .. py:attribute:: current_search
      :type:  str | None
      :value: None



   .. py:attribute:: valid_drop_types
      :type:  tuple[aqt.browser.sidebar.item.SidebarItemType, Ellipsis]
      :value: ()



   .. py:attribute:: toolbar


   .. py:attribute:: searchBar


   .. py:method:: cleanup() -> None


   .. py:property:: tool
      :type: aqt.browser.sidebar.toolbar.SidebarTool



   .. py:method:: model() -> aqt.browser.sidebar.model.SidebarModel


   .. py:method:: op_executed(changes: anki.collection.OpChanges, handler: object | None, focused: bool) -> None


   .. py:method:: refresh_if_needed() -> None


   .. py:method:: refresh(new_current: aqt.browser.sidebar.item.SidebarItem | None = None) -> None

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



   .. py:method:: restore_current(current: aqt.browser.sidebar.item.SidebarItem) -> None


   .. py:method:: 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


   .. py:method:: search_for(text: str) -> None


   .. py:method:: update_search(*terms: str | anki.collection.SearchNode, joiner: anki.collection.SearchJoiner = 'AND') -> None

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



   .. py:method:: drawRow(painter: QPainter | None, options: QStyleOptionViewItem, idx: QModelIndex) -> None


   .. py:method:: dropEvent(event: QDropEvent | None) -> None


   .. py:method:: mouseReleaseEvent(event: QMouseEvent | None) -> None


   .. py:method:: keyPressEvent(event: QKeyEvent | None) -> None


   .. py:method:: handle_drag_drop(sources: list[aqt.browser.sidebar.item.SidebarItem], target: aqt.browser.sidebar.item.SidebarItem) -> bool


   .. py:method:: onContextMenu(point: QPoint) -> None


   .. py:method:: show_context_menu(item: aqt.browser.sidebar.item.SidebarItem, index: QModelIndex) -> None


   .. py:method:: rename_flag(item: aqt.browser.sidebar.item.SidebarItem, new_name: str) -> None


   .. py:method:: restore_default_flag_name(item: aqt.browser.sidebar.item.SidebarItem) -> None


   .. py:method:: rename_deck(item: aqt.browser.sidebar.item.SidebarItem, new_name: str) -> None


   .. py:method:: delete_decks(_item: aqt.browser.sidebar.item.SidebarItem) -> None


   .. py:method:: remove_tags(item: aqt.browser.sidebar.item.SidebarItem) -> None


   .. py:method:: rename_tag(item: aqt.browser.sidebar.item.SidebarItem, new_name: str) -> None


   .. py:method:: add_tags_to_selected_notes() -> None


   .. py:method:: remove_tags_from_selected_notes() -> None


   .. py:method:: remove_saved_searches(_item: aqt.browser.sidebar.item.SidebarItem) -> None


   .. py:method:: rename_saved_search(item: aqt.browser.sidebar.item.SidebarItem, new_name: str) -> None


   .. py:method:: save_current_search() -> None


   .. py:method:: update_saved_search(item: aqt.browser.sidebar.item.SidebarItem) -> None


   .. py:method:: manage_notetype(item: aqt.browser.sidebar.item.SidebarItem) -> None


   .. py:method:: manage_template(item: aqt.browser.sidebar.item.SidebarItem) -> None


   .. py:method:: manage_fields(item: aqt.browser.sidebar.item.SidebarItem) -> None