Module AggiEngine.uimanager

Classes

class UiManager (window, customWidgets=None)

QUiLoader(self, parent: typing.Union[PySide2.QtCore.QObject, NoneType] = None) -> None

Expand source code

class UiManager(QUiLoader):

    def __init__(self, window, customWidgets=None):
        QUiLoader.__init__(self)
        self.window = window

        # Register all the custom widgets so that they can be created later
        self.customWidgets = customWidgets
        if customWidgets is not None:
            for wid in customWidgets:
                self.registerCustomWidget(wid)

        self.keepWidgets = []

    def createWidget(self, class_name, parent=None, name=''):
        """
        Overrides QUiLoader to createWidget in current window rather than a new one
        ``class_name:`` The class we want to create  
        ``parent:`` The parent widget  
        ``name:`` The name of the widget we'll create  
        """

        if class_name is QMainWindow.__name__:
            return self.window

        if parent is None and self.window:
            return self.window
        else:
            if class_name in self.availableWidgets():
                widget = QUiLoader.createWidget(self, class_name, parent, name)
                widget.show()
            else:
                try:
                    widget = self.customWidgets[class_name](parent)
                except (TypeError, KeyError) as e:
                    raise Exception(class_name, 'was not found are you sure it was promoted?')

            if self.window:
                setattr(self.window, name, widget)

            return widget

    def loadWidgets(self, ui_file, deleteCurrent=False):
        """
        Loads the current ui_file and if wanted deleted old widgets
        ``ui_file:`` The file path to load  
        ``deleteCurrent:`` Remove old widgets  
        """

        if len(self.window.children()) > 0 and deleteCurrent:
            for i in range(0, len(self.window.children())):
                if not(self.window.children()[i] in self.keepWidgets):
                    self.window.children()[i].deleteLater()

        widgets = self.load(ui_file)  # load widgets
        QMetaObject.connectSlotsByName(widgets)

Ancestors

• PySide2.QtUiTools.QUiLoader
• PySide2.QtCore.QObject
• Shiboken.Object

Class variables

var staticMetaObject

Methods

def createWidget(self, class_name, parent=None, name='')

Overrides QUiLoader to createWidget in current window rather than a new one class_name: The class we want to create
parent: The parent widget
name: The name of the widget we'll create

Expand source code

def createWidget(self, class_name, parent=None, name=''):
    """
    Overrides QUiLoader to createWidget in current window rather than a new one
    ``class_name:`` The class we want to create  
    ``parent:`` The parent widget  
    ``name:`` The name of the widget we'll create  
    """

    if class_name is QMainWindow.__name__:
        return self.window

    if parent is None and self.window:
        return self.window
    else:
        if class_name in self.availableWidgets():
            widget = QUiLoader.createWidget(self, class_name, parent, name)
            widget.show()
        else:
            try:
                widget = self.customWidgets[class_name](parent)
            except (TypeError, KeyError) as e:
                raise Exception(class_name, 'was not found are you sure it was promoted?')

        if self.window:
            setattr(self.window, name, widget)

        return widget

def loadWidgets(self, ui_file, deleteCurrent=False)

Loads the current ui_file and if wanted deleted old widgets ui_file: The file path to load
deleteCurrent: Remove old widgets

Expand source code

def loadWidgets(self, ui_file, deleteCurrent=False):
    """
    Loads the current ui_file and if wanted deleted old widgets
    ``ui_file:`` The file path to load  
    ``deleteCurrent:`` Remove old widgets  
    """

    if len(self.window.children()) > 0 and deleteCurrent:
        for i in range(0, len(self.window.children())):
            if not(self.window.children()[i] in self.keepWidgets):
                self.window.children()[i].deleteLater()

    widgets = self.load(ui_file)  # load widgets
    QMetaObject.connectSlotsByName(widgets)