qtapp

qtapp helps to create Qt5 GUI with as little source code as possible.

Features:

• Load UI-file
• Compile resources
• Connect signals and events
• Add tray icon
• Show splash screen

Requirements:

• PyQt / PySide
• qtpy
• pathlib (Python 3.4+)

Documentation:

`options` - `dict` with various options
  Members:
  `skip_missing_resources`=False - do not raise error if .qrc-file not found
  `debug`=False - print various debug messages to stdout
  `slot_prefix`="" - slot name prefix, see `connect_all`
  `compiled_qrc`=True - compile resource files to .pyc instead of .py
`QtApp` - QApplication subclass
  Members:
  `path` - application path
  `load_resources` - load specified .qrc-file
  `exec()` - start main event loop
  [signal] `terminated` - application is terminated with Ctrl+C (SIGINT)
  [signal] `deactivated` - application lost focus
  [signal] `wheel(widget, direction)` - mouse wheel event over a `widget`
`app()` - `QtApp` instance, creates a new one on 1st call
`QtForm()` - create new Qt window (and `QtApp` instance if needed). Arguments
             can be provided in variables of user class: _argname_ = value
  Arguments:
  `Form` - user class to use as a subclass of `QWidget` (explicitly specify
           super class [QDialog|QWidget|QMainWindow] if ui-file is not used)
  `*args`=() - additional arguments for user class `__init__`
  `flags`=None - Qt.WindowFlags
  `ui`=None - path to .ui-file (file extension is optional), `False` - disable
              .ui loading, `None` - try lowercase name of `Form` class.
  `ontop`=False - show window always on top, adds `WindowStaysOnTopHint` flag
                  to `flags`.
  `icon`=None - set window icon: QIcon|QStyle.StandardPixmap|image-path.
                `SP_TitleBarMenuButton` icon is used by default
  `show`=True - show window by default
  `tray`=None - add tray icon: True (use QtForm window icon)|dict
      Arguments:
      {`tip` - tray icon tooltip,
       `icon` - custom icon (see `QtForm` `icon` arg)}
  `splash`=None - show splash screen: str|pathlib.Path|dict
                  Pass image path only or options dict.
      Arguments:
      {`image` - path to splash screen image file,
       `title`="Loading application..." - caption on the splash screen,
       `align`=Qt.AlignHCenter|Qt.AlignBottom - caption alignment,
       `color`=Qt.black - caption color,
       `width`, `height`=None - resize image (px), aspect ratio is preserved
                                if one argument is not specified
  `loop`=False - do not return and start main event loop
  `connect`='after' - call `connect_all()` [before|after] user class
                      initialization or never (False). 'after' is ignored if a
                      user calls the function manually.
  `slot_prefix`=options['slot_prefix'] - slot name prefix for QtForm subclass
  `title`=None - set window title
  `layout`=None - set layout of a specified `QLayout` subclass to the widget
  `**kwargs`=() - additional keyword arguments for user class `__init__`.
                  To pass additional arguments to base class `__init__` use
                  keywords with `_super` postfix.
  Members:
  `app` - `QtApp` instance
  `tray` - `QSystemTrayIcon` if created or None
      Members:
      `addMenuItem(name1, func1, ...)` - add 1 or more context menu items
  `connect_all()` - connects events and signals to appropriate members:
                    [prefix_]object_signal (special: `eventFilter`)
              Note: Use object="self" for `QtForm` signal handlers.
                    Its event handlers can be reimplemented directly.
          See also: http://stackoverflow.com/q/48027254
  `init_tray()` - init. tray icon manually, see `tray` arg. of `QtForm`
  `splashscreen` - `QSplashScreen` if created or None. After _init_ it's None
  `setTopmost`/`isTopmost` - put window on top of all other windows

`Dialog()` - show modal dialog which wraps `QDialog`
  Arguments:
  All arguments of QtForm except for `show`.
  `get_result`=True - return `(result, answer)` otherwise returns QDialog
                      instance. See also `QDialog.result`.
  Members:
  `accept([answer])` - accept dialog, set answer. See also `QDialog.accept`.
  `reject([answer])` - reject dialog, set answer. See also `QDialog.reject`.
  `answer()` - answer set by `accept` or `None`.