Documentation/Source/eric5.Tools.UIPreviewer.html

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
<html><head>
<title>eric5.Tools.UIPreviewer</title>
<style>
body {
    background: #EDECE6;
    margin: 0em 1em 10em 1em;
    color: black;
}

h1 { color: white; background: #85774A; }
h2 { color: white; background: #85774A; }
h3 { color: white; background: #9D936E; }
h4 { color: white; background: #9D936E; }
    
a { color: #BA6D36; }

</style>
</head>
<body><a NAME="top" ID="top"></a>
<h1>eric5.Tools.UIPreviewer</h1>
<p>
Module implementing the UI Previewer main window.
</p>
<h3>Global Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>
<table>
<tr>
<td><a href="#UIPreviewer">UIPreviewer</a></td>
<td>Class implementing the UI Previewer main window.</td>
</tr>
</table>
<h3>Functions</h3>
<table>
<tr><td>None</td></tr>
</table>
<hr /><hr />
<a NAME="UIPreviewer" ID="UIPreviewer"></a>
<h2>UIPreviewer</h2>
<p>
    Class implementing the UI Previewer main window.
</p>
<h3>Derived from</h3>
QMainWindow
<h3>Class Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Methods</h3>
<table>
<tr>
<td><a href="#UIPreviewer.__init__">UIPreviewer</a></td>
<td>Constructor</td>
</tr><tr>
<td><a href="#UIPreviewer.__about">__about</a></td>
<td>Private slot to show the about information.</td>
</tr><tr>
<td><a href="#UIPreviewer.__aboutQt">__aboutQt</a></td>
<td>Private slot to show info about Qt.</td>
</tr><tr>
<td><a href="#UIPreviewer.__copyImageToClipboard">__copyImageToClipboard</a></td>
<td>Private slot to handle the Copy Image menu action.</td>
</tr><tr>
<td><a href="#UIPreviewer.__guiStyleSelected">__guiStyleSelected</a></td>
<td>Private slot to handle the selection of a GUI style.</td>
</tr><tr>
<td><a href="#UIPreviewer.__handleCloseEvent">__handleCloseEvent</a></td>
<td>Private slot to handle the close event of a viewed QMainWidget.</td>
</tr><tr>
<td><a href="#UIPreviewer.__initActions">__initActions</a></td>
<td>Private method to define the user interface actions.</td>
</tr><tr>
<td><a href="#UIPreviewer.__initMenus">__initMenus</a></td>
<td>Private method to create the menus.</td>
</tr><tr>
<td><a href="#UIPreviewer.__initToolbars">__initToolbars</a></td>
<td>Private method to create the toolbars.</td>
</tr><tr>
<td><a href="#UIPreviewer.__loadFile">__loadFile</a></td>
<td>Private slot to load a ui file.</td>
</tr><tr>
<td><a href="#UIPreviewer.__openFile">__openFile</a></td>
<td>Private slot to load a new file.</td>
</tr><tr>
<td><a href="#UIPreviewer.__print">__print</a></td>
<td>Private slot to the actual printing.</td>
</tr><tr>
<td><a href="#UIPreviewer.__printImage">__printImage</a></td>
<td>Private slot to handle the Print Image menu action.</td>
</tr><tr>
<td><a href="#UIPreviewer.__printPreviewImage">__printPreviewImage</a></td>
<td>Private slot to handle the Print Preview menu action.</td>
</tr><tr>
<td><a href="#UIPreviewer.__saveImage">__saveImage</a></td>
<td>Private slot to handle the Save Image menu action.</td>
</tr><tr>
<td><a href="#UIPreviewer.__updateActions">__updateActions</a></td>
<td>Private slot to update the actions state.</td>
</tr><tr>
<td><a href="#UIPreviewer.__updateChildren">__updateChildren</a></td>
<td>Private slot to change the style of the show UI.</td>
</tr><tr>
<td><a href="#UIPreviewer.__whatsThis">__whatsThis</a></td>
<td>Private slot called in to enter Whats This mode.</td>
</tr><tr>
<td><a href="#UIPreviewer.eventFilter">eventFilter</a></td>
<td>Protected method called to filter an event.</td>
</tr><tr>
<td><a href="#UIPreviewer.show">show</a></td>
<td>Public slot to show this dialog.</td>
</tr>
</table>
<a NAME="UIPreviewer.__init__" ID="UIPreviewer.__init__"></a>
<h4>UIPreviewer (Constructor)</h4>
<b>UIPreviewer</b>(<i>filename=None, parent=None, name=None</i>)
<p>
        Constructor
</p><dl>
<dt><i>filename</i></dt>
<dd>
name of a UI file to load
</dd><dt><i>parent</i></dt>
<dd>
parent widget of this window (QWidget)
</dd><dt><i>name</i></dt>
<dd>
name of this window (string)
</dd>
</dl><a NAME="UIPreviewer.__about" ID="UIPreviewer.__about"></a>
<h4>UIPreviewer.__about</h4>
<b>__about</b>(<i></i>)
<p>
        Private slot to show the about information.
</p><a NAME="UIPreviewer.__aboutQt" ID="UIPreviewer.__aboutQt"></a>
<h4>UIPreviewer.__aboutQt</h4>
<b>__aboutQt</b>(<i></i>)
<p>
        Private slot to show info about Qt.
</p><a NAME="UIPreviewer.__copyImageToClipboard" ID="UIPreviewer.__copyImageToClipboard"></a>
<h4>UIPreviewer.__copyImageToClipboard</h4>
<b>__copyImageToClipboard</b>(<i></i>)
<p>
        Private slot to handle the Copy Image menu action.
</p><a NAME="UIPreviewer.__guiStyleSelected" ID="UIPreviewer.__guiStyleSelected"></a>
<h4>UIPreviewer.__guiStyleSelected</h4>
<b>__guiStyleSelected</b>(<i>selectedStyle</i>)
<p>
        Private slot to handle the selection of a GUI style.
</p><dl>
<dt><i>selectedStyle</i></dt>
<dd>
name of the selected style (string)
</dd>
</dl><a NAME="UIPreviewer.__handleCloseEvent" ID="UIPreviewer.__handleCloseEvent"></a>
<h4>UIPreviewer.__handleCloseEvent</h4>
<b>__handleCloseEvent</b>(<i></i>)
<p>
        Private slot to handle the close event of a viewed QMainWidget.
</p><a NAME="UIPreviewer.__initActions" ID="UIPreviewer.__initActions"></a>
<h4>UIPreviewer.__initActions</h4>
<b>__initActions</b>(<i></i>)
<p>
        Private method to define the user interface actions.
</p><a NAME="UIPreviewer.__initMenus" ID="UIPreviewer.__initMenus"></a>
<h4>UIPreviewer.__initMenus</h4>
<b>__initMenus</b>(<i></i>)
<p>
        Private method to create the menus.
</p><a NAME="UIPreviewer.__initToolbars" ID="UIPreviewer.__initToolbars"></a>
<h4>UIPreviewer.__initToolbars</h4>
<b>__initToolbars</b>(<i></i>)
<p>
        Private method to create the toolbars.
</p><a NAME="UIPreviewer.__loadFile" ID="UIPreviewer.__loadFile"></a>
<h4>UIPreviewer.__loadFile</h4>
<b>__loadFile</b>(<i>fn</i>)
<p>
        Private slot to load a ui file.
</p><dl>
<dt><i>fn</i></dt>
<dd>
name of the ui file to be laoded (string)
</dd>
</dl><a NAME="UIPreviewer.__openFile" ID="UIPreviewer.__openFile"></a>
<h4>UIPreviewer.__openFile</h4>
<b>__openFile</b>(<i></i>)
<p>
        Private slot to load a new file.
</p><a NAME="UIPreviewer.__print" ID="UIPreviewer.__print"></a>
<h4>UIPreviewer.__print</h4>
<b>__print</b>(<i>printer</i>)
<p>
        Private slot to the actual printing.
</p><dl>
<dt><i>printer</i></dt>
<dd>
reference to the printer object (QPrinter)
</dd>
</dl><a NAME="UIPreviewer.__printImage" ID="UIPreviewer.__printImage"></a>
<h4>UIPreviewer.__printImage</h4>
<b>__printImage</b>(<i></i>)
<p>
        Private slot to handle the Print Image menu action.
</p><a NAME="UIPreviewer.__printPreviewImage" ID="UIPreviewer.__printPreviewImage"></a>
<h4>UIPreviewer.__printPreviewImage</h4>
<b>__printPreviewImage</b>(<i></i>)
<p>
        Private slot to handle the Print Preview menu action.
</p><a NAME="UIPreviewer.__saveImage" ID="UIPreviewer.__saveImage"></a>
<h4>UIPreviewer.__saveImage</h4>
<b>__saveImage</b>(<i></i>)
<p>
        Private slot to handle the Save Image menu action.
</p><a NAME="UIPreviewer.__updateActions" ID="UIPreviewer.__updateActions"></a>
<h4>UIPreviewer.__updateActions</h4>
<b>__updateActions</b>(<i></i>)
<p>
        Private slot to update the actions state.
</p><a NAME="UIPreviewer.__updateChildren" ID="UIPreviewer.__updateChildren"></a>
<h4>UIPreviewer.__updateChildren</h4>
<b>__updateChildren</b>(<i>sstyle</i>)
<p>
        Private slot to change the style of the show UI.
</p><dl>
<dt><i>sstyle</i></dt>
<dd>
name of the selected style (string)
</dd>
</dl><a NAME="UIPreviewer.__whatsThis" ID="UIPreviewer.__whatsThis"></a>
<h4>UIPreviewer.__whatsThis</h4>
<b>__whatsThis</b>(<i></i>)
<p>
        Private slot called in to enter Whats This mode.
</p><a NAME="UIPreviewer.eventFilter" ID="UIPreviewer.eventFilter"></a>
<h4>UIPreviewer.eventFilter</h4>
<b>eventFilter</b>(<i>obj, ev</i>)
<p>
        Protected method called to filter an event.
</p><dl>
<dt><i>object</i></dt>
<dd>
object, that generated the event (QObject)
</dd><dt><i>event</i></dt>
<dd>
the event, that was generated by object (QEvent)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
flag indicating if event was filtered out
</dd>
</dl><a NAME="UIPreviewer.show" ID="UIPreviewer.show"></a>
<h4>UIPreviewer.show</h4>
<b>show</b>(<i></i>)
<p>
        Public slot to show this dialog.
</p><p>
        This overloaded slot loads a UI file to be previewed after
        the main window has been shown. This way, previewing a dialog
        doesn't interfere with showing the main window.
</p>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>