naturtag.app.controls module#

This module contains utilities for the main UI controls:

  • Toolbar

  • Menu bar

  • Global keyboard shortcuts

class naturtag.app.controls.Toolbar(parent, user_dirs)#

Bases: PySide6.QtWidgets.QToolBar

add_button(name, tooltip, icon, shortcut=None, visible=True)#
Return type

QAction

populate_menu(menu)#

Populate the application menu using actions defined on the toolbar

staticMetaObject = PySide6.QtCore.QMetaObject("Toolbar" inherits "QToolBar": )#
class naturtag.app.controls.UserDirs(settings)#

Bases: PySide6.QtCore.QObject

add_favorite_dir(image_dir, save=True)#

Add an image directory to Favorites (if not already added)

Return type

Optional[QAction]

add_recent_dir(image_dir, save=True)#

Add an image directory to Recent (if not already added)

Return type

Optional[QAction]

add_recent_dirs(paths, save=True)#

Update recently used image directories in the menu and (optionally) settings

Parameters
  • paths (list[Path]) – Image or image directory paths

  • save (bool) – Save directories to settings

choose_favorite_dir()#

Open a file chooser to select a new favorite directory

on_dir_open#
open_or_add_favorite_dir(image_dir)#

Open a directory from the ‘Open Recent’ submenu, or Ctrl-click to add it as a favorite

open_or_remove_favorite_dir(image_dir)#

Open a directory from the ‘Open Favorites’ submenu, or Ctrl-click to add it as a favorite

remove_favorite_dir(image_dir)#

Remove an image directory from Favorites menu

remove_recent_dir(image_dir)#

Remove an image directory from Recent menu

staticMetaObject = PySide6.QtCore.QMetaObject("UserDirs" inherits "QObject": Methods:   #5 type=Signal, signature=on_dir_open(PyObject), parameters=PyObject   #6 type=Slot, signature=open_or_add_favorite_dir(PyObject), parameters=PyObject   #7 type=Slot, signature=open_or_remove_favorite_dir(PyObject), parameters=PyObject )#