Tenative commit to debug AdvancedDockingSystem.

example/advanced-dock.py

@@ -0,0 +1,161 @@
+#!/usr/bin/env python
+#
+# The MIT License (MIT)
+#
+# Copyright (c) <2021> <Alex Huszagh>
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the 'Software'), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+'''
+    advanced-dock
+    =============
+
+    Simple PyQt application using the advanced-docking-system.
+'''
+
+import argparse
+import os
+import sys
+
+example_dir = os.path.dirname(os.path.realpath(__file__))
+home = os.path.dirname(example_dir)
+
+# Create our arguments.
+parser = argparse.ArgumentParser(description='Configurations for the Qt5 application.')
+parser.add_argument(
+    '--stylesheet',
+    help='''stylesheet name''',
+    default='native'
+)
+# Know working styles include:
+#   1. Fusion
+#   2. Windows
+parser.add_argument(
+    '--style',
+    help='''application style, which is different than the stylesheet''',
+    default='native'
+)
+parser.add_argument(
+    '--font-size',
+    help='''font size for the application''',
+    type=float,
+    default=-1
+)
+parser.add_argument(
+    '--font-family',
+    help='''the font family'''
+)
+parser.add_argument(
+    '--scale',
+    help='''scale factor for the UI''',
+    type=float,
+    default=1,
+)
+parser.add_argument(
+    '--pyqt6',
+    help='''use PyQt6 rather than PyQt5.''',
+    action='store_true'
+)
+
+# Need to fix an issue on Wayland on Linux:
+#   conda-forge does not support Wayland, for who knows what reason.
+if sys.platform.lower().startswith('linux') and 'CONDA_PREFIX' in os.environ:
+    os.environ['XDG_SESSION_TYPE'] = 'x11'
+
+args, unknown = parser.parse_known_args()
+if args.pyqt6:
+    from PyQt6 import QtCore, QtGui, QtWidgets
+    QtCore.QDir.addSearchPath(args.stylesheet, f'{home}/pyqt6/{args.stylesheet}/')
+    stylesheet = f'{args.stylesheet}:stylesheet.qss'
+else:
+    sys.path.insert(0, home)
+    from PyQt5 import QtCore, QtGui, QtWidgets
+    import breeze_resources
+    stylesheet = f':/{args.stylesheet}/stylesheet.qss'
+
+from PyQtAds import QtAds
+
+# Compat definitions, between Qt5 and Qt6.
+if args.pyqt6:
+    AlignTop = QtCore.Qt.AlignmentFlag.AlignTop
+    AlignLeft = QtCore.Qt.AlignmentFlag.AlignLeft
+    ReadOnly = QtCore.QFile.OpenModeFlag.ReadOnly
+    Text = QtCore.QFile.OpenModeFlag.Text
+else:
+    AlignTop = QtCore.Qt.AlignTop
+    AlignLeft = QtCore.Qt.AlignLeft
+    ReadOnly = QtCore.QFile.ReadOnly
+    Text = QtCore.QFile.Text
+
+
+def main():
+    'Application entry point'
+
+
+    if args.scale != 1:
+        os.environ['QT_SCALE_FACTOR'] = str(args.scale)
+    else:
+        os.environ['QT_AUTO_SCREEN_SCALE_FACTOR'] = '1'
+    if args.style != 'native':
+        style = QtWidgets.QStyleFactory.create(args.style)
+        QtWidgets.QApplication.setStyle(style)
+
+    app = QtWidgets.QApplication(sys.argv[:1] + unknown)
+    window = QtWidgets.QMainWindow()
+
+    # use the default font size
+    font = app.font()
+    if args.font_size > 0:
+        font.setPointSizeF(args.font_size)
+    if args.font_family:
+        font.setFamily(args.font_family)
+    app.setFont(font)
+
+    # setup stylesheet
+    if args.stylesheet != 'native':
+        file = QtCore.QFile(stylesheet)
+        file.open(ReadOnly | Text)
+        stream = QtCore.QTextStream(file)
+        app.setStyleSheet(stream.readAll())
+
+    # setup the dock manager
+    window.setObjectName('MainWindow')
+    window.resize(1068, 824)
+    central_widget = QtWidgets.QWidget(window)
+    central_widget.setObjectName("central_widget")
+    window.setCentralWidget(central_widget)
+    dock_manager = QtAds.CDockManager(window)
+
+    # add widgets to the dock manager
+    dock1 = QtAds.CDockWidget('Dock 1')
+    dock1_widget = QtWidgets.QWidget()
+    layout1 = QtWidgets.QVBoxLayout(dock1_widget)
+    dock1.setWidget(dock1_widget)
+    layout1.addWidget(QtWidgets.QPushButton('Some Button'))
+    dock_manager.addDockWidget(QtAds.TopDockWidgetArea, dock1)
+
+    # run
+    window.show()
+    if args.pyqt6:
+        return app.exec()
+    else:
+        return app.exec_()
+
+if __name__ == '__main__':
+    sys.exit(main())

example/widgets.py

@@ -24,8 +24,10 @@
 # THE SOFTWARE.
 
 '''
-    example
+    widgets
     =======
+
+    Simple example showing numerous built-in widgets.
 '''
 
 import argparse
@@ -33,7 +35,8 @@ import logging
 import os
 import sys
 
-home = os.path.dirname(os.path.realpath(__file__))
+example_dir = os.path.dirname(os.path.realpath(__file__))
+home = os.path.dirname(example_dir)
 
 # Create our arguments.
 parser = argparse.ArgumentParser(description='Configurations for the Qt5 application.')
@@ -72,12 +75,18 @@ parser.add_argument(
     action='store_true'
 )
 
+# Need to fix an issue on Wayland on Linux:
+#   conda-forge does not support Wayland, for who knows what reason.
+if sys.platform.lower().startswith('linux') and 'CONDA_PREFIX' in os.environ:
+    os.environ['XDG_SESSION_TYPE'] = 'x11'
+
 args, unknown = parser.parse_known_args()
 if args.pyqt6:
     from PyQt6 import QtCore, QtGui, QtWidgets
     QtCore.QDir.addSearchPath(args.stylesheet, f'{home}/pyqt6/{args.stylesheet}/')
     stylesheet = f'{args.stylesheet}:stylesheet.qss'
 else:
+    sys.path.insert(0, home)
     from PyQt5 import QtCore, QtGui, QtWidgets
     import breeze_resources
     stylesheet = f':/{args.stylesheet}/stylesheet.qss'

recipes/README.md

@@ -0,0 +1,4 @@
+recipes
+=======
+
+Sample recipes and template files for adding third-party Qt widgets and stylesheets into BreezeStyleSheets.

tests/ui.py

@@ -36,7 +36,8 @@ import random
 import sys
 import time
 
-home = os.path.dirname(os.path.realpath(__file__))
+tests_dir = os.path.dirname(os.path.realpath(__file__))
+home = os.path.dirname(tests_dir)
 
 # Create our arguments.
 parser = argparse.ArgumentParser(description='Configurations for the Qt5 application.')
@@ -108,6 +109,7 @@ if args.pyqt6:
     style_prefix = f'{args.stylesheet}:'
     stylesheet = f'{style_prefix}stylesheet.qss'
 else:
+    sys.path.insert(0, home)
     from PyQt5 import QtCore, QtGui, QtWidgets
     import breeze_resources
     style_prefix = f':/{args.stylesheet}/'