PrEditor 2.1.0__py3-none-any.whl

preditor/gui/ui/set_text_editor_path_dialog.ui

@@ -0,0 +1,189 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ui version="4.0">
+ <class>Dialog</class>
+ <widget class="QDialog" name="Dialog">
+  <property name="geometry">
+   <rect>
+    <x>0</x>
+    <y>0</y>
+    <width>1064</width>
+    <height>325</height>
+   </rect>
+  </property>
+  <property name="windowTitle">
+   <string>Set Text Editor Executable Path</string>
+  </property>
+  <layout class="QVBoxLayout" name="verticalLayout">
+   <property name="spacing">
+    <number>15</number>
+   </property>
+   <item>
+    <widget class="QWidget" name="widget" native="true">
+     <layout class="QVBoxLayout" name="verticalLayout_2">
+      <property name="spacing">
+       <number>3</number>
+      </property>
+      <property name="leftMargin">
+       <number>0</number>
+      </property>
+      <property name="topMargin">
+       <number>0</number>
+      </property>
+      <property name="rightMargin">
+       <number>0</number>
+      </property>
+      <property name="bottomMargin">
+       <number>0</number>
+      </property>
+      <item>
+       <widget class="QLabel" name="label">
+        <property name="sizePolicy">
+         <sizepolicy hsizetype="Preferred" vsizetype="Maximum">
+          <horstretch>0</horstretch>
+          <verstretch>0</verstretch>
+         </sizepolicy>
+        </property>
+        <property name="font">
+         <font>
+          <pointsize>10</pointsize>
+         </font>
+        </property>
+        <property name="text">
+         <string>Path to the executable of your preferred text editor</string>
+        </property>
+       </widget>
+      </item>
+      <item>
+       <widget class="QLineEdit" name="uiTextEditorExecutablePathLE">
+        <property name="font">
+         <font>
+          <pointsize>10</pointsize>
+         </font>
+        </property>
+        <property name="text">
+         <string>C:\Program Files\Sublime Text 3\sublime_text.exe</string>
+        </property>
+       </widget>
+      </item>
+     </layout>
+    </widget>
+   </item>
+   <item>
+    <widget class="QWidget" name="widget_2" native="true">
+     <layout class="QVBoxLayout" name="verticalLayout_3">
+      <property name="spacing">
+       <number>3</number>
+      </property>
+      <property name="leftMargin">
+       <number>0</number>
+      </property>
+      <property name="topMargin">
+       <number>0</number>
+      </property>
+      <property name="rightMargin">
+       <number>0</number>
+      </property>
+      <property name="bottomMargin">
+       <number>0</number>
+      </property>
+      <item>
+       <widget class="QLabel" name="label_2">
+        <property name="sizePolicy">
+         <sizepolicy hsizetype="Preferred" vsizetype="Maximum">
+          <horstretch>0</horstretch>
+          <verstretch>0</verstretch>
+         </sizepolicy>
+        </property>
+        <property name="font">
+         <font>
+          <pointsize>10</pointsize>
+         </font>
+        </property>
+        <property name="text">
+         <string>Command Prompt template (template of the Command Prompt command to launch your text editor, including how it may implement specifying line numbers).
+Use these template strings: &quot;{exePath}&quot;, &quot;{modulePath}&quot;, {lineNum}. Include quotes around exePath and modulePath to handle filepaths which contain spaces.</string>
+        </property>
+        <property name="wordWrap">
+         <bool>true</bool>
+        </property>
+       </widget>
+      </item>
+      <item>
+       <widget class="QLineEdit" name="uiTextEditorCommandPatternLE">
+        <property name="font">
+         <font>
+          <pointsize>10</pointsize>
+         </font>
+        </property>
+        <property name="toolTip">
+         <string/>
+        </property>
+        <property name="text">
+         <string>&quot;{exePath}&quot; &quot;{modulePath}&quot;:{lineNum}</string>
+        </property>
+       </widget>
+      </item>
+     </layout>
+    </widget>
+   </item>
+   <item>
+    <spacer name="verticalSpacer">
+     <property name="orientation">
+      <enum>Qt::Vertical</enum>
+     </property>
+     <property name="sizeHint" stdset="0">
+      <size>
+       <width>20</width>
+       <height>40</height>
+      </size>
+     </property>
+    </spacer>
+   </item>
+   <item>
+    <widget class="QDialogButtonBox" name="uiDialogButtonBox">
+     <property name="orientation">
+      <enum>Qt::Horizontal</enum>
+     </property>
+     <property name="standardButtons">
+      <set>QDialogButtonBox::Cancel|QDialogButtonBox::Ok</set>
+     </property>
+    </widget>
+   </item>
+  </layout>
+ </widget>
+ <resources/>
+ <connections>
+  <connection>
+   <sender>uiDialogButtonBox</sender>
+   <signal>accepted()</signal>
+   <receiver>Dialog</receiver>
+   <slot>accept()</slot>
+   <hints>
+    <hint type="sourcelabel">
+     <x>248</x>
+     <y>254</y>
+    </hint>
+    <hint type="destinationlabel">
+     <x>157</x>
+     <y>274</y>
+    </hint>
+   </hints>
+  </connection>
+  <connection>
+   <sender>uiDialogButtonBox</sender>
+   <signal>rejected()</signal>
+   <receiver>Dialog</receiver>
+   <slot>reject()</slot>
+   <hints>
+    <hint type="sourcelabel">
+     <x>316</x>
+     <y>260</y>
+    </hint>
+    <hint type="destinationlabel">
+     <x>286</x>
+     <y>274</y>
+    </hint>
+   </hints>
+  </connection>
+ </connections>
+</ui>

preditor/gui/ui/suggest_path_quotes_dialog.ui

@@ -0,0 +1,225 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ui version="4.0">
+ <class>uiSuggestPathQuotesDLG</class>
+ <widget class="QDialog" name="uiSuggestPathQuotesDLG">
+  <property name="geometry">
+   <rect>
+    <x>0</x>
+    <y>0</y>
+    <width>716</width>
+    <height>342</height>
+   </rect>
+  </property>
+  <property name="windowTitle">
+   <string>Set Text Editor Executable Path</string>
+  </property>
+  <layout class="QVBoxLayout" name="verticalLayout">
+   <property name="spacing">
+    <number>15</number>
+   </property>
+   <item>
+    <widget class="QWidget" name="widget" native="true">
+     <layout class="QVBoxLayout" name="verticalLayout_2">
+      <property name="spacing">
+       <number>3</number>
+      </property>
+      <property name="leftMargin">
+       <number>0</number>
+      </property>
+      <property name="topMargin">
+       <number>0</number>
+      </property>
+      <property name="rightMargin">
+       <number>0</number>
+      </property>
+      <property name="bottomMargin">
+       <number>0</number>
+      </property>
+      <item>
+       <widget class="QLabel" name="label">
+        <property name="sizePolicy">
+         <sizepolicy hsizetype="Preferred" vsizetype="Maximum">
+          <horstretch>0</horstretch>
+          <verstretch>0</verstretch>
+         </sizepolicy>
+        </property>
+        <property name="font">
+         <font>
+          <pointsize>10</pointsize>
+         </font>
+        </property>
+        <property name="text">
+         <string>It is recommended to wrap filepaths in double-quotes in case of spaces in the paths. Would you like to update the command template from:</string>
+        </property>
+        <property name="wordWrap">
+         <bool>true</bool>
+        </property>
+       </widget>
+      </item>
+      <item>
+       <widget class="QLineEdit" name="uiTextEditorOldCommandPatternLE">
+        <property name="enabled">
+         <bool>false</bool>
+        </property>
+        <property name="font">
+         <font>
+          <pointsize>10</pointsize>
+         </font>
+        </property>
+        <property name="toolTip">
+         <string/>
+        </property>
+        <property name="text">
+         <string>uiTextEditorOldCommandPatternLE</string>
+        </property>
+       </widget>
+      </item>
+     </layout>
+    </widget>
+   </item>
+   <item>
+    <widget class="QWidget" name="widget_3" native="true">
+     <layout class="QVBoxLayout" name="verticalLayout_4">
+      <property name="spacing">
+       <number>3</number>
+      </property>
+      <property name="leftMargin">
+       <number>0</number>
+      </property>
+      <property name="topMargin">
+       <number>0</number>
+      </property>
+      <property name="rightMargin">
+       <number>0</number>
+      </property>
+      <property name="bottomMargin">
+       <number>0</number>
+      </property>
+      <item>
+       <widget class="QLabel" name="label_2">
+        <property name="sizePolicy">
+         <sizepolicy hsizetype="Preferred" vsizetype="Maximum">
+          <horstretch>0</horstretch>
+          <verstretch>0</verstretch>
+         </sizepolicy>
+        </property>
+        <property name="font">
+         <font>
+          <pointsize>10</pointsize>
+         </font>
+        </property>
+        <property name="text">
+         <string>to:</string>
+        </property>
+        <property name="wordWrap">
+         <bool>true</bool>
+        </property>
+       </widget>
+      </item>
+      <item>
+       <widget class="QLineEdit" name="uiTextEditorNewCommandPatternLE">
+        <property name="font">
+         <font>
+          <pointsize>10</pointsize>
+         </font>
+        </property>
+        <property name="toolTip">
+         <string/>
+        </property>
+        <property name="text">
+         <string/>
+        </property>
+       </widget>
+      </item>
+     </layout>
+    </widget>
+   </item>
+   <item>
+    <widget class="QWidget" name="widget_4" native="true">
+     <layout class="QVBoxLayout" name="verticalLayout_5">
+      <property name="spacing">
+       <number>3</number>
+      </property>
+      <property name="leftMargin">
+       <number>0</number>
+      </property>
+      <property name="topMargin">
+       <number>0</number>
+      </property>
+      <property name="rightMargin">
+       <number>0</number>
+      </property>
+      <property name="bottomMargin">
+       <number>0</number>
+      </property>
+     </layout>
+    </widget>
+   </item>
+   <item>
+    <spacer name="verticalSpacer">
+     <property name="orientation">
+      <enum>Qt::Vertical</enum>
+     </property>
+     <property name="sizeHint" stdset="0">
+      <size>
+       <width>20</width>
+       <height>40</height>
+      </size>
+     </property>
+    </spacer>
+   </item>
+   <item>
+    <widget class="QCheckBox" name="uiDontAskAgainCHK">
+     <property name="text">
+      <string>Don't Ask Again</string>
+     </property>
+    </widget>
+   </item>
+   <item>
+    <widget class="QDialogButtonBox" name="uiDialogButtonBox">
+     <property name="orientation">
+      <enum>Qt::Horizontal</enum>
+     </property>
+     <property name="standardButtons">
+      <set>QDialogButtonBox::No|QDialogButtonBox::Yes</set>
+     </property>
+    </widget>
+   </item>
+  </layout>
+ </widget>
+ <resources/>
+ <connections>
+  <connection>
+   <sender>uiDialogButtonBox</sender>
+   <signal>accepted()</signal>
+   <receiver>uiSuggestPathQuotesDLG</receiver>
+   <slot>accept()</slot>
+   <hints>
+    <hint type="sourcelabel">
+     <x>248</x>
+     <y>254</y>
+    </hint>
+    <hint type="destinationlabel">
+     <x>157</x>
+     <y>274</y>
+    </hint>
+   </hints>
+  </connection>
+  <connection>
+   <sender>uiDialogButtonBox</sender>
+   <signal>rejected()</signal>
+   <receiver>uiSuggestPathQuotesDLG</receiver>
+   <slot>reject()</slot>
+   <hints>
+    <hint type="sourcelabel">
+     <x>316</x>
+     <y>260</y>
+    </hint>
+    <hint type="destinationlabel">
+     <x>286</x>
+     <y>274</y>
+    </hint>
+   </hints>
+  </connection>
+ </connections>
+</ui>

preditor/gui/window.py

@@ -0,0 +1,161 @@
+from __future__ import absolute_import
+
+from Qt.QtCore import Qt
+from Qt.QtWidgets import QMainWindow
+
+from .. import config, relativePath
+
+
+class Window(QMainWindow):
+    _instance = None
+
+    @classmethod
+    def instance(cls, parent=None):
+        """If you only want to have one instance of a window, use this
+                    method instead of creating a new window. It will only create a
+                    new instance of the class if the class variable _instance is
+                    none.
+
+        Args:
+            parent (QWidget, optional): The parent widget
+
+        Returns:
+            Window:
+        """
+        if not cls._instance:
+            cls._instance = cls(parent=parent)
+            # protect the memory
+            cls._instance.setAttribute(Qt.WidgetAttribute.WA_DeleteOnClose, False)
+        return cls._instance
+
+    def __init__(self, parent=None, flags=0):
+        # if there is no root, create
+        if not parent:
+            parent = config.root_window()
+
+        # create a QMainWindow
+        if flags:
+            QMainWindow.__init__(self, parent, flags)
+        else:
+            QMainWindow.__init__(self, parent)
+
+        # INFO
+        #
+        # As far as we can tell, the purpose for this class is keeping live
+        # references to the subclasses so they don't get garbage collected, all while
+        # getting around having to actively maintain a list of running dialogs.
+        #
+        # Generally, setting WA_DeleteOnClose to False, and keeping the _instance
+        # variable around
+        # will do the trick for pseudo-singleton dialogs. (created with instance=True)
+        #
+        # However, for non-instanced dialogs where multiples are allowed, deleteOnClose
+        # is set to True and no _instance variable is set.  Because there are no live
+        # references to the dialog, it is closed and garbage collected almost
+        # immediately in certain programs (xsi, maya).
+        #
+        # The current workaround is to manually set WA_DeleteOnClose to False, however
+        # this causes any subclasses to stick around in memory even when the
+        # window/dialog is closed. So you also have to manually set WA_DeleteOnClose to
+        # True in the sub-classed .closeEvent() method before you call super()
+        #
+        # It is completely possible to write some code that would automatically handle
+        # this, and it is CERTAINLY something we can/will be doing in the future, but
+        # for now we're not quite sure how that would affect the production tools.
+        # Technically this is a problem, but there are currently no consequences from an
+        # artist standpoint because we have more than enough memory to hold all those
+        # dead dialogs
+
+        # set the delete attribute to clean up the window once it is closed
+        self.setAttribute(Qt.WidgetAttribute.WA_DeleteOnClose, True)
+        # If this value is set to False calling setGeometry on this window will not
+        # adjust the geometry to ensure the window is on a valid screen.
+        self.checkScreenGeo = True
+        # attempt to set the dialog icon
+        import os
+        import sys
+
+        from Qt.QtGui import QIcon
+
+        try:
+            path = relativePath(
+                os.path.abspath(sys.modules[self.__class__.__module__].__file__),
+                'img/icon.png',
+            )
+            if os.path.exists(path):
+                self.setWindowIcon(QIcon(path))
+        except (KeyError, AttributeError):
+            pass
+
+    def _shouldDisableAccelerators(self, old, now):
+        """Used to enable typing in DCC's that require it(Max 2018).
+
+        Args:
+            old (QWidget or None): The QWidget that lost focus.
+            new (QWidget or None): The QWidget that gained focus.
+
+        Returns:
+            bool: If accelerators should be disabled.
+        """
+        # By default we always want to disable accelerators.
+        return True
+
+    def closeEvent(self, event):
+        # ensure this object gets deleted
+        wwidget = None
+        if self.testAttribute(Qt.WidgetAttribute.WA_DeleteOnClose):
+            # collect the win widget to uncache it
+            if self.parent() and self.parent().inherits('QWinWidget'):
+                wwidget = self.parent()
+
+        QMainWindow.closeEvent(self, event)
+
+        # uncache the win widget if necessary
+        if wwidget:
+            from .winwidget import WinWidget
+
+            WinWidget.uncache(wwidget)
+
+    def setGeometry(self, *args):
+        """
+        Sets the window's geometry, It will also check if the geometry is visible on any
+        monitors. If it is not it will move the window so it is visible. This can be
+        disabled by setting self.checkScreenGeo to False
+        """
+        super(Window, self).setGeometry(*args)
+        if self.checkScreenGeo:
+            from ..utils.cute import ensureWindowIsVisible
+
+            ensureWindowIsVisible(self)
+
+    def shutdown(self):
+        # use a @classmethod to make inheritance magically work
+        self._shutdown(self)
+
+    @classmethod
+    def _shutdown(cls, this):
+        """
+        If this item is the class instance properly close it and remove it from memory
+        so it can be recreated.
+        """
+        # allow the global instance to be cleared
+        if this == cls._instance:
+            cls._instance = None
+            this.setAttribute(Qt.WidgetAttribute.WA_DeleteOnClose, True)
+        try:
+            this.close()
+        except RuntimeError:
+            pass
+
+    @classmethod
+    def instance_shutdown(cls):
+        """Call shutdown on this class instance only if the class was instantiated.
+
+        Returns:
+            bool: if cls.instance().shutdown() needed to be called.
+        """
+        instance = cls._instance
+        if instance:
+            instance.shutdown()
+            return True
+        return False