You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
215 lines
7.4 KiB
Python
215 lines
7.4 KiB
Python
# coding:utf-8
|
|
#!/usr/bin/python
|
|
#
|
|
# All or portions of this file Copyright (c) Amazon.com, Inc. or its affiliates or
|
|
# its licensors.
|
|
#
|
|
# For complete copyright and license terms please see the LICENSE at the root of this
|
|
# distribution (the "License"). All use of this software is governed by the License,
|
|
# or, if provided, by the license below or the license accompanying this file. Do not
|
|
# remove or modify any license notices. This file is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
#
|
|
# -------------------------------------------------------------------------
|
|
|
|
"""help_menu.py: Setup a standard Help item in the menubar for PySide2 GUIs"""
|
|
|
|
# built in's
|
|
import os
|
|
import logging
|
|
|
|
# azpy
|
|
from azpy import initialize_logger
|
|
# import azpy.shared.ui.qt_settings as qt_settings
|
|
|
|
# 3rd Party
|
|
from unipath import Path
|
|
import PySide2.QtCore as QtCore
|
|
import PySide2.QtGui as QtGui
|
|
import PySide2.QtWidgets as QtWidgets
|
|
|
|
# -------------------------------------------------------------------------
|
|
# global space debug flag
|
|
_G_DEBUG = os.getenv('DCCSI_GDEBUG', False)
|
|
|
|
# global space developer mode flag
|
|
_DCCSI_DEV_MODE = os.getenv('DCCSI_DEV_MODE', False)
|
|
|
|
_MODULE_PATH = Path(__file__)
|
|
|
|
_ORG_TAG = 'Amazon_Lumberyard'
|
|
_APP_TAG = 'DCCsi'
|
|
_TOOL_TAG = 'azpy.shared.ui.help_menu'
|
|
_TYPE_TAG = 'test'
|
|
|
|
_MODULENAME = __name__
|
|
if _MODULENAME is '__main__':
|
|
_MODULENAME = _TOOL_TAG
|
|
|
|
_LOGGER = logging.getLogger(_MODULENAME)
|
|
_LOGGER.debug('Something invoked :: {0}.'.format({_MODULENAME}))
|
|
|
|
# TODO: implement this
|
|
# checks the run configuration to determine if we are running in maya
|
|
_G_MAYA = False
|
|
try:
|
|
from azpy.config.maya import _G_MAYA
|
|
if _G_MAYA:
|
|
import maya.cmds as mc
|
|
except:
|
|
pass
|
|
# -------------------------------------------------------------------------
|
|
|
|
|
|
class HelpMenu():
|
|
"""
|
|
Setup a standard Help item in the menubar for PySide2 GUIs
|
|
|
|
INPUTS:
|
|
main_window = the class instance of the QMainWindow
|
|
tool_label = the menu label for the tool's help item
|
|
tool_help_page = the http:// path to the tool specific help page
|
|
|
|
Here's an example
|
|
# self.help_menu = azpy.shared.ui.help_menu.setup(self, 'Help...', 'https://some.site.com/azpy')
|
|
|
|
"""
|
|
|
|
# ----------------------------------------------------------------------
|
|
def __init__(self, main_window, tool_label, tool_help_page):
|
|
"""Constructor"""
|
|
|
|
self.main_window = main_window
|
|
# store mainwindow menubar, we can attach the Help menu to this
|
|
self.menubar = self.main_window.menuBar()
|
|
self.tool_label = tool_label
|
|
self.tool_help_page = tool_help_page
|
|
|
|
self.help_menu = QtWidgets.QMenu(self.menubar)
|
|
self.help_menu.setObjectName("help_menu")
|
|
self.help_menu.setTitle("Help")
|
|
|
|
self.generic_tool_help_setup()
|
|
self.specific_tool_help_setup()
|
|
self.tool_bug_report_setup()
|
|
|
|
# ----------------------------------------------------------------------
|
|
|
|
def specific_tool_help_setup(self):
|
|
""""""
|
|
self.tool_action_help = QtWidgets.QAction(self.main_window)
|
|
self.tool_action_help.setObjectName("tool_action_help")
|
|
self.help_menu.addAction(self.tool_action_help)
|
|
self.menubar.addAction(self.help_menu.menuAction())
|
|
self.tool_action_help.setText(self.tool_label)
|
|
self.main_window.connect(self.tool_action_help, QtCore.SIGNAL("triggered()"), self.tool_help_display)
|
|
|
|
# ----------------------------------------------------------------------
|
|
def generic_tool_help_setup(self):
|
|
""""""
|
|
self.azpy_tool_action_help = QtWidgets.QAction(self.main_window)
|
|
self.azpy_tool_action_help.setObjectName("azpy_tool_action_help")
|
|
self.help_menu.addAction(self.azpy_tool_action_help)
|
|
self.menubar.addAction(self.help_menu.menuAction())
|
|
self.azpy_tool_action_help.setText("DCCsi help...")
|
|
self.main_window.connect(self.azpy_tool_action_help, QtCore.SIGNAL("triggered()"), self.azpy_tool_help_display)
|
|
|
|
# ----------------------------------------------------------------------
|
|
def tool_bug_report_setup(self):
|
|
""""""
|
|
self.tool_action_bug_report = QtWidgets.QAction(self.main_window)
|
|
self.tool_action_bug_report.setObjectName("tool_action_bug_report")
|
|
self.help_menu.addAction(self.tool_action_bug_report)
|
|
self.menubar.addAction(self.help_menu.menuAction())
|
|
self.tool_action_bug_report.setText("Report a Tool Bug...")
|
|
self.main_window.connect(self.tool_action_bug_report, QtCore.SIGNAL("triggered()"), self.bug_report_display)
|
|
|
|
# ----------------------------------------------------------------------
|
|
|
|
def tool_help_display(self):
|
|
""""""
|
|
if _G_MAYA:
|
|
mc.showHelp(self.tool_help_page, absolute=True)
|
|
else:
|
|
_LOGGER.debug('This command, {0}: currently only works when running in Maya.'.format('tool_help_display'))
|
|
pass
|
|
|
|
# ----------------------------------------------------------------------
|
|
def azpy_tool_help_display(self):
|
|
""""""
|
|
if _G_MAYA:
|
|
mc.showHelp('https://some.site.com/azpy/maya_tools/', absolute=True)
|
|
else:
|
|
_LOGGER.debug('This command, {0}: currently only works when running in Maya.'.format('azpy_tool_help_display'))
|
|
pass
|
|
|
|
# ----------------------------------------------------------------------
|
|
def bug_report_display(self):
|
|
""""""
|
|
if _G_MAYA:
|
|
mc.showHelp('https://some.site.com/azpy/report_bug', absolute=True)
|
|
else:
|
|
_LOGGER.debug('This command, {0}: currently only works when running in Maya.'.format('bug_report_display'))
|
|
pass
|
|
# -------------------------------------------------------------------------
|
|
|
|
|
|
class TestMainWindow(QtWidgets.QMainWindow):
|
|
def __init__(self, parent=None):
|
|
super().__init__(parent)
|
|
self.setup_ui()
|
|
|
|
def setup_ui(self):
|
|
self.setWindowTitle('PySide2-HelpMenu-Test')
|
|
|
|
# Setup Help Menu
|
|
self.help_menu = HelpMenu(self, 'PySide2-Test Help...', 'http://dccSI.com/NewTool')
|
|
|
|
# main widget
|
|
self.main_widget = QtWidgets.QWidget(self)
|
|
self.setCentralWidget(self.main_widget)
|
|
|
|
# layout initialize
|
|
self.global_layout = QtWidgets.QVBoxLayout()
|
|
self.main_widget.setLayout(self.global_layout)
|
|
|
|
# Add Widgets
|
|
self.spinbox = QtWidgets.QSpinBox()
|
|
self.spinbox.setValue(30)
|
|
layout = QtWidgets.QFormLayout()
|
|
layout.addRow('Parameter', self.spinbox)
|
|
self.button = QtWidgets.QPushButton('Execute')
|
|
|
|
# global layout setting
|
|
self.global_layout.addLayout(layout)
|
|
self.global_layout.addWidget(self.button)
|
|
# ----------------------------------------------------------------------
|
|
|
|
def closeEvent(self, event):
|
|
"""Event which is run when window closes"""
|
|
|
|
_LOGGER.debug("Exiting: {0}".format(_TOOL_TAG))
|
|
# ----------------------------------------------------------------------
|
|
# -------------------------------------------------------------------------
|
|
|
|
|
|
if __name__ == '__main__':
|
|
"""Run this file as main"""
|
|
import sys
|
|
|
|
_LOGGER.debug("{0} :: if __name__ == '__main__':".format(_TOOL_TAG))
|
|
_LOGGER.debug("Starting App: {0} ...".format(_TOOL_TAG))
|
|
app = QtWidgets.QApplication(sys.argv)
|
|
mainWin = TestMainWindow()
|
|
mainWin.show()
|
|
|
|
del _LOGGER
|
|
sys.exit(app.exec_())
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|