def __init__(self, **kwargs):
"""Creates a new instance of PyGlassWindow."""
parent = ArgsUtils.extract('parent', None, kwargs)
self._application = ArgsUtils.extract('pyGlassApp', None, kwargs)
self._qApplication = ArgsUtils.extract('qApp', None, kwargs)
self._isMainWindow = ArgsUtils.extract('isMainWindow', bool(parent is None), kwargs)
self._mainWindow = ArgsUtils.extract('mainWindow', None, kwargs)
self._appWrappingWidget = None
self._centerWidget = None
self._hasShown = False
self._isHighDpi = OsUtils.isHighDpiScaledScreen()
self._settings = ConfigsDict()
self._appLevelWidgets = dict()
self._appLevelWidgetDisplayHistory = []
self._keyboardCallback = ArgsUtils.extract('keyboardCallback', None, kwargs)
if not self._mainWindow:
if self._isMainWindow:
self._mainWindow = self
elif self._application:
self._mainWindow = self._application.mainWindow
self._dependentWindows = []
self._currentWidget = None
QtGui.QMainWindow.__init__(self, parent, ArgsUtils.extract('flags', 0, kwargs))
self._instanceUid = TimeUtils.getUidTimecode(
prefix=self.__class__.__name__,
suffix=StringUtils.getRandomString(8))
self._styleSheet = kwargs.get('styleSheet', None)
if self._styleSheet:
self.setStyleSheet(self.styleSheetPath)
if self._keyboardCallback is not None:
self.setFocusPolicy(QtCore.Qt.StrongFocus)
if self._isMainWindow:
self._log = Logger(self, printOut=True)
self._config = ApplicationConfig(self)
self._commonConfig = ApplicationConfig(self, common=True)
self._resourceFolderParts = PyGlassGuiUtils.getResourceFolderParts(self)
icon = PyGlassGuiUtils.createIcon(
kwargs.get('iconsPath', self.getAppResourcePath('icons', isDir=True)) )
if icon:
self.setWindowIcon(icon)
elif self._mainWindow:
icon = self._mainWindow.windowIcon()
if icon:
self.setWindowIcon(icon)
self._appWrappingWidget = VisibilityElement(self)
layout = QtGui.QVBoxLayout()
layout.setContentsMargins(0, 0, 0, 0)
layout.setSpacing(0)
self._appWrappingWidget.setLayout(layout)
self._contentWrappingWidget = self.addApplicationLevelWidget('main')
layout = QtGui.QVBoxLayout()
layout.setContentsMargins(0, 0, 0, 0)
layout.setSpacing(0)
self._contentWrappingWidget.setLayout(layout)
# Loads the ui file if it exists
externalCentralParent = None
hasWindowFile = kwargs.get('mainWindowFile', False)
if hasWindowFile == self:
UiFileLoader.loadWidgetFile(self)
externalCentralParent = getattr(self, 'windowContainer')
if externalCentralParent:
externalLayout = externalCentralParent.layout()
if not externalLayout:
externalLayout = QtGui.QVBoxLayout()
externalLayout.setContentsMargins(0, 0, 0, 0)
externalLayout.setSpacing(0)
externalCentralParent.setLayout(externalLayout)
if externalCentralParent:
self._appWrappingWidget.setParent(externalCentralParent)
externalLayout.addWidget(self._appWrappingWidget)
else:
self.setCentralWidget(self._appWrappingWidget)
# Sets a non-standard central widget
centralWidgetName = kwargs.get('centralWidgetName')
if centralWidgetName and hasattr(self, centralWidgetName):
self._centerWidget = getattr(self, centralWidgetName)
elif hasWindowFile and not hasWindowFile == self:
if not self._centerWidget:
self._createCentralWidget()
UiFileLoader.loadWidgetFile(self, target=self._centerWidget)
elif not hasWindowFile:
self._centerWidget = None
if not self._centerWidget and kwargs.get('defaultCenterWidget', True):
self._createCentralWidget()
self._lastChildWidgetID = None
self._widgetParent = None
self._widgets = None
self._widgetFlags = None
self._widgetClasses = kwargs.get('widgets', dict())
if self._widgetClasses:
self._initializeWidgetChildren()
self.setWindowTitle(kwargs.get('title', self._createTitleFromClass()))
self.updateStatusBar()
class PyGlassWindow(QtGui.QMainWindow):
"""A class for..."""
#===================================================================================================
# C L A S S
#___________________________________________________________________________________________________ __init__
def __init__(self, **kwargs):
"""Creates a new instance of PyGlassWindow."""
parent = ArgsUtils.extract('parent', None, kwargs)
self._application = ArgsUtils.extract('pyGlassApp', None, kwargs)
self._qApplication = ArgsUtils.extract('qApp', None, kwargs)
self._isMainWindow = ArgsUtils.extract('isMainWindow', bool(parent is None), kwargs)
self._mainWindow = ArgsUtils.extract('mainWindow', None, kwargs)
self._appWrappingWidget = None
self._centerWidget = None
self._hasShown = False
self._isHighDpi = OsUtils.isHighDpiScaledScreen()
self._settings = ConfigsDict()
self._appLevelWidgets = dict()
self._appLevelWidgetDisplayHistory = []
self._keyboardCallback = ArgsUtils.extract('keyboardCallback', None, kwargs)
if not self._mainWindow:
if self._isMainWindow:
self._mainWindow = self
elif self._application:
self._mainWindow = self._application.mainWindow
self._dependentWindows = []
self._currentWidget = None
QtGui.QMainWindow.__init__(self, parent, ArgsUtils.extract('flags', 0, kwargs))
self._instanceUid = TimeUtils.getUidTimecode(
prefix=self.__class__.__name__,
suffix=StringUtils.getRandomString(8))
self._styleSheet = kwargs.get('styleSheet', None)
if self._styleSheet:
self.setStyleSheet(self.styleSheetPath)
if self._keyboardCallback is not None:
self.setFocusPolicy(QtCore.Qt.StrongFocus)
if self._isMainWindow:
self._log = Logger(self, printOut=True)
self._config = ApplicationConfig(self)
self._commonConfig = ApplicationConfig(self, common=True)
self._resourceFolderParts = PyGlassGuiUtils.getResourceFolderParts(self)
icon = PyGlassGuiUtils.createIcon(
kwargs.get('iconsPath', self.getAppResourcePath('icons', isDir=True)) )
if icon:
self.setWindowIcon(icon)
elif self._mainWindow:
icon = self._mainWindow.windowIcon()
if icon:
self.setWindowIcon(icon)
self._appWrappingWidget = VisibilityElement(self)
layout = QtGui.QVBoxLayout()
layout.setContentsMargins(0, 0, 0, 0)
layout.setSpacing(0)
self._appWrappingWidget.setLayout(layout)
self._contentWrappingWidget = self.addApplicationLevelWidget('main')
layout = QtGui.QVBoxLayout()
layout.setContentsMargins(0, 0, 0, 0)
layout.setSpacing(0)
self._contentWrappingWidget.setLayout(layout)
# Loads the ui file if it exists
externalCentralParent = None
hasWindowFile = kwargs.get('mainWindowFile', False)
if hasWindowFile == self:
UiFileLoader.loadWidgetFile(self)
externalCentralParent = getattr(self, 'windowContainer')
if externalCentralParent:
externalLayout = externalCentralParent.layout()
if not externalLayout:
externalLayout = QtGui.QVBoxLayout()
externalLayout.setContentsMargins(0, 0, 0, 0)
externalLayout.setSpacing(0)
externalCentralParent.setLayout(externalLayout)
if externalCentralParent:
self._appWrappingWidget.setParent(externalCentralParent)
externalLayout.addWidget(self._appWrappingWidget)
else:
self.setCentralWidget(self._appWrappingWidget)
# Sets a non-standard central widget
centralWidgetName = kwargs.get('centralWidgetName')
if centralWidgetName and hasattr(self, centralWidgetName):
self._centerWidget = getattr(self, centralWidgetName)
elif hasWindowFile and not hasWindowFile == self:
if not self._centerWidget:
self._createCentralWidget()
UiFileLoader.loadWidgetFile(self, target=self._centerWidget)
elif not hasWindowFile:
self._centerWidget = None
if not self._centerWidget and kwargs.get('defaultCenterWidget', True):
self._createCentralWidget()
self._lastChildWidgetID = None
self._widgetParent = None
self._widgets = None
self._widgetFlags = None
self._widgetClasses = kwargs.get('widgets', dict())
if self._widgetClasses:
self._initializeWidgetChildren()
self.setWindowTitle(kwargs.get('title', self._createTitleFromClass()))
self.updateStatusBar()
#===================================================================================================
# G E T / S E T
#___________________________________________________________________________________________________ GS: settings
@property
def settings(self):
return self._settings
#___________________________________________________________________________________________________ GS: isHighDpi
@property
def isHighDpi(self):
return self._isHighDpi
#___________________________________________________________________________________________________ GS: instanceUid
@property
def instanceUid(self):
return self._instanceUid
#___________________________________________________________________________________________________ GS: isDeployed
@ClassGetter
def isDeployed(cls):
return PyGlassEnvironment.isDeployed
#___________________________________________________________________________________________________ GS: isOnDisplay
@property
def isOnDisplay(self):
return self.isVisible()
#___________________________________________________________________________________________________ GS: appID
@property
def appID(self):
return self.pyGlassApplication.appID
#___________________________________________________________________________________________________ GS: isMainWindow
@property
def isMainWindow(self):
return self._isMainWindow
#___________________________________________________________________________________________________ GS: allowsOwnership
@property
def allowsOwnership(self):
return True
#___________________________________________________________________________________________________ GS: mainWindow
@property
def mainWindow(self):
if self.isMainWindow:
return self
if self._mainWindow:
return self._mainWindow
self._mainWindow = PyGlassGuiUtils.getMainWindow(self)
# Handle case where main window turns out to this window
if self._mainWindow == self:
self._isMainWindow = True
self._mainWindow = None
return self
return self._mainWindow
#___________________________________________________________________________________________________ GS: owner
@property
def owner(self):
if self.isMainWindow:
return self
return self.mainWindow
#___________________________________________________________________________________________________ GS: pyGlassApplication
@property
def pyGlassApplication(self):
return self._application if self.isMainWindow else self.mainWindow.pyGlassApplication
#___________________________________________________________________________________________________ GS: application
@property
def application(self):
if self._application is not None:
return self._application
return self._application if self.isMainWindow else self.mainWindow.application
#___________________________________________________________________________________________________ GS: qApplication
@property
def qApplication(self):
if self._qApplication is not None:
return self._qApplication
return self._qApplication if self.isMainWindow else self.mainWindow.qApplication
#___________________________________________________________________________________________________ GS: appConfig
@property
def appConfig(self):
return self._config if self.isMainWindow else self.mainWindow.appConfig
#___________________________________________________________________________________________________ GS: commonAppConfig
@property
def commonAppConfig(self):
return self._commonConfig if self.isMainWindow else self.mainWindow.commonAppConfig
#___________________________________________________________________________________________________ GS: logger
@property
def logger(self):
return self._log if self.isMainWindow else self.owner.log
#___________________________________________________________________________________________________ GS: log
@property
def log(self):
return self.logger
#___________________________________________________________________________________________________ GS: styleSheetPath
@property
def styleSheetPath(self):
if not self._styleSheet:
return None
if os.path.isabs(self._styleSheet):
return self._styleSheet
parts = self._resourceFolderParts + self._stylesheet.split('/')
return self.getResourcePath(*parts, isFile=True)
#___________________________________________________________________________________________________ GS: rootResourcePath
@property
def rootResourcePath(self):
return PyGlassEnvironment.getRootResourcePath()
#___________________________________________________________________________________________________ GS: rootLocalResourcePath
@property
def rootLocalResourcePath(self):
return PyGlassEnvironment.getRootLocalResourcePath()
#___________________________________________________________________________________________________ GS: appResourcePath
@property
def appResourcePath(self):
if not self.isMainWindow:
return self.owner.appResourcePath
out = self.pyGlassApplication.getAppResourcePath(isDir=True)
if not os.path.exists(out):
os.makedirs(out)
return out
#___________________________________________________________________________________________________ GS: localAppResourcePath
@property
def localAppResourcePath(self):
if not self.isMainWindow:
return self.owner.localAppResourcePath
out = self.pyGlassApplication.getLocalAppResourcePath(isDir=True)
if not os.path.exists(out):
os.makedirs(out)
return out
#___________________________________________________________________________________________________ GS: sharedResourcePath
@property
def sharedResourcePath(self):
out = self.getRootResourcePath('shared', isDir=True)
if not os.path.exists(out):
os.makedirs(out)
return out
#___________________________________________________________________________________________________ GS: localSharedResourcePath
@property
def localSharedResourcePath(self):
out = self.getLocalResourcePath('shared', isDir=True)
if not os.path.exists(out):
os.makedirs(out)
return out
#___________________________________________________________________________________________________ GS: widgets
@property
def widgets(self):
return self._widgets
#___________________________________________________________________________________________________ GS: screenWidth
@property
def screenWidth(self):
rect = self._qApplication.desktop().screenGeometry()
return rect.width()
#___________________________________________________________________________________________________ GS: screenHeight
@property
def screenHeight(self):
rect = self._qApplication.desktop().screenGeometry()
return rect.height()
#===================================================================================================
# P U B L I C
#___________________________________________________________________________________________________ scaleByDpi
def scaleByDpi(self, value, rounded =False, asInt =False):
if self._isHighDpi:
value *= 2
if rounded or asInt:
value = round(value)
if asInt:
return int(value)
return value
#___________________________________________________________________________________________________ keyPressEvent
def keyPressEvent(self, event):
if self._keyboardCallback is None or not self._keyboardCallback(event):
super(PyGlassWindow, self).keyPressEvent(event)
#___________________________________________________________________________________________________ showEvent
def showEvent(self, *args, **kwargs):
if not self._hasShown:
self._firstShowImpl()
self._hasShown = True
#___________________________________________________________________________________________________ closeEvent
def closeEvent(self, *args, **kwargs):
if self.isMainWindow:
for depWindow in self._dependentWindows:
depWindow.close()
return super(PyGlassWindow, self).closeEvent(*args, **kwargs)
#___________________________________________________________________________________________________ addDependentWindow
def addDependentWindow(self, window):
if window in self._dependentWindows:
return True
self._dependentWindows.append(window)
return True
#___________________________________________________________________________________________________ removeDependentWindow
def removeDependentWindow(self, window):
if window not in self._dependentWindows:
return True
self._dependentWindows.remove(window)
return True
#___________________________________________________________________________________________________ refreshWidgets
def refreshWidgets(self, **kwargs):
for name, widget in DictUtils.iter(self._widgets):
widget.refresh(**kwargs)
self.refreshGui()
#___________________________________________________________________________________________________ updateStatusBar
def updateStatusBar(self, message =None, timeout =-1):
if not message:
self.statusBar().clearMessage()
self.statusBar().setVisible(False)
else:
if timeout < 0:
timeout = 3000
self.statusBar().showMessage(message, timeout=timeout)
self.statusBar().setVisible(True)
#___________________________________________________________________________________________________ getWidgetFromID
def getWidgetFromID(self, widgetID, createIfMissing =True):
if widgetID not in self._widgets and createIfMissing:
self.loadWidgets(widgetID)
return self._widgets.get(widgetID, None)
#___________________________________________________________________________________________________ getSharedResourcePath
def getSharedResourcePath(self, *args, **kwargs):
return FileUtils.createPath(self.sharedResourcePath, *args, **kwargs)
#___________________________________________________________________________________________________ getLocalSharedResourcePath
def getLocalSharedResourcePath(self, *args, **kwargs):
return FileUtils.createPath(self.localSharedResourcePath, *args, **kwargs)
#___________________________________________________________________________________________________ getAppResourcePath
def getAppResourcePath(self, *args, **kwargs):
"""Doc..."""
return FileUtils.createPath(self.appResourcePath, *args, **kwargs)
#___________________________________________________________________________________________________ getLocalAppResourcePath
def getLocalAppResourcePath(self, *args, **kwargs):
"""Doc..."""
return FileUtils.createPath(self.localAppResourcePath, *args, **kwargs)
#___________________________________________________________________________________________________ getRootResourcePath
def getRootResourcePath(self, *args, **kwargs):
return PyGlassEnvironment.getRootResourcePath(*args, **kwargs)
#___________________________________________________________________________________________________ getRootLocalResourcePath
def getRootLocalResourcePath(self, *args, **kwargs):
return PyGlassEnvironment.getRootLocalResourcePath(*args, **kwargs)
#___________________________________________________________________________________________________ getResourcePath
def getResourcePath(self, *args, **kwargs):
"""Doc..."""
return FileUtils.createPath(
self.rootResourcePath, 'widget', self._resourceFolderParts, *args, **kwargs)
#___________________________________________________________________________________________________ getLocalResourcePath
def getLocalResourcePath(self, *args, **kwargs):
"""Doc..."""
return FileUtils.createPath(
self.rootLocalResourcePath, 'widget', self._resourceFolderParts, *args, **kwargs)
#___________________________________________________________________________________________________ showApplicationLevelWidget
def showApplicationLevelWidget(self, widgetID, **kwargs):
w = self.getApplicationLevelWidget(widgetID)
if not w:
return
for wid, widget in DictUtils.iter(self._appLevelWidgets):
if wid == widgetID:
widget.setVisible(True)
widget.activateWidgetDisplay(**kwargs)
else:
widget.visibility.addMuteRequest(w)
self.refreshGui()
#___________________________________________________________________________________________________ hideApplicationLevelWidget
def hideApplicationLevelWidget(self, widgetID, **kwargs):
w = self.getApplicationLevelWidget(widgetID)
if not w:
return
for wid, widget in DictUtils.iter(self._appLevelWidgets):
if wid == widgetID:
widget.setVisible(False)
widget.deactivateWidgetDisplay(**kwargs)
else:
widget.visibility.removeMuteRequest(w)
if widget.visibility.isVisible:
widget.refreshWidgetDisplay()
self.refreshGui()
#___________________________________________________________________________________________________ showLoading
def showLoading(self, target, **kwargs):
w = self.getApplicationLevelWidget('loading')
if not w:
return
self.showApplicationLevelWidget('loading', target=target, **kwargs)
self._showLoadingImpl(target=target, **kwargs)
#___________________________________________________________________________________________________ hideLoading
def hideLoading(self, target, **kwargs):
w = self.getApplicationLevelWidget('loading')
if not w or not w.target == target:
return
self.hideApplicationLevelWidget('loading', target=target, **kwargs)
self._hideLoadingImpl(target=target, **kwargs)
#___________________________________________________________________________________________________ addWidget
def addWidget(self, key, widgetClass, setActive =False):
self._widgetClasses[key] = widgetClass
if self._widgets is None:
self._initializeWidgetChildren(key if setActive else None)
elif setActive:
return self.setActiveWidget(key)
return True
#___________________________________________________________________________________________________ setActiveWidget
def setActiveWidget(self, widgetID, force =False, args =None, doneArgs =None):
if not self._centerWidget or widgetID is None or widgetID not in self._widgetClasses:
return False
if not force and self._currentWidget and self._currentWidget.widgetID == widgetID:
return True
if widgetID not in self._widgets:
self.loadWidgets(widgetID)
widget = self._widgets[widgetID]
# Deactivates the current widget if the widgets are being switched. However, ignored if the
# same widget is being activated for a second time.
if self._currentWidget and widgetID != self._currentWidget.widgetID:
if doneArgs is None:
doneArgs = dict()
self._currentWidget.deactivateWidgetDisplay(**doneArgs)
self._currentWidget.setParent(self._widgetParent)
self._lastChildWidgetID = self._currentWidget.widgetID
self._currentWidget = widget
if self._centerWidget:
layout = self._centerWidget.layout()
if not layout:
layout = QtGui.QVBoxLayout()
layout.setContentsMargins(0, 0, 0, 0)
self._centerWidget.setLayout(layout)
layout.addWidget(widget)
else:
self._contentWrappingWidget.layout().addWidget(widget)
self.setContentsMargins(0, 0, 0, 0)
self.refreshGui()
if args is None:
args = dict()
widget.activateWidgetDisplay(lastPeerWidgetID=self._lastChildWidgetID, **args)
return True
#___________________________________________________________________________________________________ loadWidgets
def loadWidgets(self, widgetIdents =None):
if not widgetIdents:
widgetIdents = self._widgetClasses.keys()
elif StringUtils.isStringType(widgetIdents):
widgetIdents = [widgetIdents]
for widgetID in widgetIdents:
if widgetID in self._widgets:
continue
if widgetID not in self._widgetClasses:
self._log.write(
'ERROR: Unrecognized widgetID "%s" in %s' % (str(widgetID), str(self)))
try:
widget = self._widgetClasses[widgetID](
parent=self._widgetParent, flags=self._widgetFlags, widgetID=widgetID)
self._widgets[widgetID] = widget
except Exception as err:
self._log.write('ERROR: Failed to load widget with id: "%s" ->' % widgetID)
raise
#___________________________________________________________________________________________________ refreshGui
def refreshGui(self):
self.qApplication.processEvents()
#___________________________________________________________________________________________________ exit
def exit(self):
self.qApplication.exit()
#___________________________________________________________________________________________________ initialize
def initialize(self, *args, **kwargs):
self._initializeImpl(*args, **kwargs)
#___________________________________________________________________________________________________ initializeComplete
def initializeComplete(self, preDisplay =None):
self.pyGlassApplication.closeSplashScreen()
result = False
if preDisplay:
preDisplay.show()
result = self.qApplication.exec_()
if result:
sys.exit(result)
self._application.runMainLoop()
#___________________________________________________________________________________________________ preShow
def preShow(self, **kwargs):
self._preShowImpl(**kwargs)
#___________________________________________________________________________________________________ postShow
def postShow(self, **kwargs):
self._postShowImpl(**kwargs)
#___________________________________________________________________________________________________ addApplicationLevelWidget
def addApplicationLevelWidget(self, widgetID, widgetClass =None, **kwargs):
if widgetClass is None:
widgetClass = ApplicationLevelWidget
ArgsUtils.addIfMissing('widgetFile', False, kwargs)
widget = widgetClass(parent=self._appWrappingWidget, **kwargs)
self._appWrappingWidget.layout().addWidget(widget)
self._appLevelWidgets[widgetID] = widget
return widget
#___________________________________________________________________________________________________ getApplicationLevelWidget
def getApplicationLevelWidget(self, widgetID):
if widgetID in self._appLevelWidgets:
return self._appLevelWidgets[widgetID]
return None
#===================================================================================================
# P R O T E C T E D
#___________________________________________________________________________________________________ _createCentralWidget
def _createCentralWidget(self):
widget = self._centerWidget
if widget:
return widget
w = QtGui.QWidget(self._contentWrappingWidget)
self._contentWrappingWidget.layout().addWidget(w)
self._centerWidget = w
return w
#___________________________________________________________________________________________________ _initializeWidgetChildren
def _initializeWidgetChildren(self, activeWidgetID =None):
if not self._widgetClasses or self._widgets:
return False
self._widgetParent = PyGlassBackgroundParent(proxy=self)
self._widgets = dict()
if activeWidgetID:
self.setActiveWidget(activeWidgetID)
#___________________________________________________________________________________________________ _preShowImpl
def _preShowImpl(self, **kwargs):
pass
#___________________________________________________________________________________________________ _firstShowImpl
def _firstShowImpl(self):
pass
#___________________________________________________________________________________________________ _postShowImpl
def _postShowImpl(self, **kwargs):
pass
#___________________________________________________________________________________________________ _showLoadingImpl
def _showLoadingImpl(self, **kwargs):
pass
#___________________________________________________________________________________________________ _hideLoadingImpl
def _hideLoadingImpl(self, **kwargs):
pass
#___________________________________________________________________________________________________ _createTitleFromClass
def _createTitleFromClass(self):
"""Doc..."""
src = self.__class__.__name__
out = src[0]
wasCaps = True
for c in src[1:]:
if c.lower() == c:
out += c
wasCaps = False
elif wasCaps:
out += c
else:
out += ' ' + c
wasCaps = True
return out
#___________________________________________________________________________________________________ _initializeImpl
def _initializeImpl(self, *args, **kwargs):
self.initializeComplete()
#===================================================================================================
# I N T R I N S I C
#___________________________________________________________________________________________________ __repr__
def __repr__(self):
return self.__str__()
#___________________________________________________________________________________________________ __unicode__
def __unicode__(self):
return StringUtils.toUnicode(self.__str__())
#___________________________________________________________________________________________________ __str__
def __str__(self):
return '<%s>' % self.__class__.__name__