DOC: add example and documentation for PyDMWindow

Author: craftablescience

docs/source/widgets/index.rst

@@ -58,6 +58,7 @@ Container Widgets
    frame.rst
    tab_widget.rst
    template_repeater.rst
+   window.rst
 
 Drawing Widgets
 ---------------

docs/source/widgets/window.rst

@@ -0,0 +1,32 @@
+#######################
+PyDMWindow
+#######################
+
+The PyDM Window Widget is a container widget that allows the display creator to set certain global display
+properties. It is currently used to hide specific UI elements when the display is the first loaded display
+in the running PyDM instance.
+
+Using the PyDM Window Widget in Designer
+========================================
+
+In designer, when creating a new display, select PyDMWindow as the base widget.
+
+
+Widget Properties
+=================
+
+============= ==== ===========
+Property      Type Description
+============= ==== ===========
+hideMenuBar   bool Hide the menu bar if this is the first loaded display.
+hideNavBar    bool Hide the nav bar if this is the first loaded display.
+hideStatusBar bool Hide the status bar if this is the first loaded display.
+============= ==== ===========
+
+
+API Documentation
+=================
+
+.. autoclass:: pydm.widgets.window.PyDMWindow
+   :members:
+   :show-inheritance:

examples/window/window.ui

@@ -0,0 +1,52 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ui version="4.0">
+ <class>Display</class>
+ <widget class="PyDMWindow" name="Display">
+  <property name="geometry">
+   <rect>
+    <x>0</x>
+    <y>0</y>
+    <width>400</width>
+    <height>300</height>
+   </rect>
+  </property>
+  <property name="windowTitle">
+   <string>PyDMWindow</string>
+  </property>
+  <property name="hideMenuBar" stdset="0">
+   <bool>true</bool>
+  </property>
+  <property name="hideNavBar" stdset="0">
+   <bool>true</bool>
+  </property>
+  <property name="hideStatusBar" stdset="0">
+   <bool>true</bool>
+  </property>
+  <widget class="QLabel" name="Label">
+   <property name="geometry">
+    <rect>
+     <x>10</x>
+     <y>10</y>
+     <width>380</width>
+     <height>280</height>
+    </rect>
+   </property>
+   <property name="text">
+    <string>&lt;html&gt;&lt;head/&gt;&lt;body&gt;&lt;p&gt;This display is using a PyDMWindow widget as the root widget. This allows it to customize some otherwise unavailable properties.&lt;/p&gt;&lt;p&gt;&lt;br/&gt;&lt;/p&gt;&lt;p&gt;Currently it is used for hiding specific parts of the PyDM interface, including the menu bar, nav bar, and status bar. Disabling these elements can make your popup displays look nicer!&lt;/p&gt;&lt;/body&gt;&lt;/html&gt;</string>
+   </property>
+   <property name="wordWrap">
+    <bool>true</bool>
+   </property>
+  </widget>
+ </widget>
+ <customwidgets>
+  <customwidget>
+   <class>PyDMWindow</class>
+   <extends>QWidget</extends>
+   <header>pydm.widgets.window</header>
+   <container>1</container>
+  </customwidget>
+ </customwidgets>
+ <resources/>
+ <connections/>
+</ui>

pydm/widgets/__init__.py

@@ -35,6 +35,7 @@
     "PyDMTabWidget",
     "PyDMTemplateRepeater",
     "PyDMNTTable",
+	"PyDMWindow",
 ]
 
 from .channel import PyDMChannel
@@ -75,3 +76,4 @@
 from .tab_bar import PyDMTabWidget
 from .template_repeater import PyDMTemplateRepeater
 from .nt_table import PyDMNTTable
+from .window import PyDMWindow