--- a/eric6/Documentation/Source/eric6.UI.Previewer.html Wed Sep 25 19:40:31 2019 +0200 +++ b/eric6/Documentation/Source/eric6.UI.Previewer.html Wed Sep 25 19:42:44 2019 +0200 @@ -18,29 +18,37 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<body> +<a NAME="top" ID="top"></a> <h1>eric6.UI.Previewer</h1> + <p> Module implementing a previewer widget for HTML, Markdown and ReST files. </p> <h3>Global Attributes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Classes</h3> + <table> + <tr> <td><a href="#Previewer">Previewer</a></td> <td>Class implementing a previewer widget containing a stack of specialized previewers.</td> </tr> </table> <h3>Functions</h3> + <table> <tr><td>None</td></tr> </table> -<hr /><hr /> +<hr /> +<hr /> <a NAME="Previewer" ID="Previewer"></a> <h2>Previewer</h2> + <p> Class implementing a previewer widget containing a stack of specialized previewers. @@ -48,149 +56,201 @@ <h3>Derived from</h3> QStackedWidget <h3>Class Attributes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Class Methods</h3> + <table> <tr><td>None</td></tr> </table> <h3>Methods</h3> + <table> + <tr> <td><a href="#Previewer.__init__">Previewer</a></td> <td>Constructor</td> -</tr><tr> +</tr> +<tr> <td><a href="#Previewer.__editorChanged">__editorChanged</a></td> <td>Private slot to handle a change of the current editor.</td> -</tr><tr> +</tr> +<tr> <td><a href="#Previewer.__editorLanguageChanged">__editorLanguageChanged</a></td> <td>Private slot to handle a change of the current editor's language.</td> -</tr><tr> +</tr> +<tr> <td><a href="#Previewer.__editorTextChanged">__editorTextChanged</a></td> <td>Private slot to handle changes of an editor's text.</td> -</tr><tr> +</tr> +<tr> <td><a href="#Previewer.__isPreviewable">__isPreviewable</a></td> <td>Private method to check, if a preview can be shown for the given editor.</td> -</tr><tr> +</tr> +<tr> <td><a href="#Previewer.__previewStateChanged">__previewStateChanged</a></td> <td>Private slot to toggle the display of the preview.</td> -</tr><tr> +</tr> +<tr> <td><a href="#Previewer.__processEditor">__processEditor</a></td> <td>Private slot to schedule the processing of the current editor's text.</td> -</tr><tr> +</tr> +<tr> <td><a href="#Previewer.__splitterMoved">__splitterMoved</a></td> <td>Private slot to handle the movement of the embedding splitter's handle.</td> -</tr><tr> +</tr> +<tr> <td><a href="#Previewer.hide">hide</a></td> <td>Public method to hide the preview widget.</td> -</tr><tr> +</tr> +<tr> <td><a href="#Previewer.show">show</a></td> <td>Public method to show the preview widget.</td> -</tr><tr> +</tr> +<tr> <td><a href="#Previewer.shutdown">shutdown</a></td> <td>Public method to perform shutdown actions.</td> </tr> </table> <h3>Static Methods</h3> + <table> <tr><td>None</td></tr> </table> + <a NAME="Previewer.__init__" ID="Previewer.__init__"></a> <h4>Previewer (Constructor)</h4> <b>Previewer</b>(<i>viewmanager, splitter, parent=None</i>) + <p> Constructor -</p><dl> +</p> +<dl> + <dt><i>viewmanager</i></dt> <dd> reference to the viewmanager object (ViewManager) -</dd><dt><i>splitter</i></dt> +</dd> +<dt><i>splitter</i></dt> <dd> reference to the embedding splitter (QSplitter) -</dd><dt><i>parent</i></dt> +</dd> +<dt><i>parent</i></dt> <dd> reference to the parent widget (QWidget) </dd> -</dl><a NAME="Previewer.__editorChanged" ID="Previewer.__editorChanged"></a> +</dl> +<a NAME="Previewer.__editorChanged" ID="Previewer.__editorChanged"></a> <h4>Previewer.__editorChanged</h4> <b>__editorChanged</b>(<i>editor</i>) + <p> Private slot to handle a change of the current editor. -</p><dl> +</p> +<dl> + <dt><i>editor</i></dt> <dd> reference to the editor (Editor) </dd> -</dl><a NAME="Previewer.__editorLanguageChanged" ID="Previewer.__editorLanguageChanged"></a> +</dl> +<a NAME="Previewer.__editorLanguageChanged" ID="Previewer.__editorLanguageChanged"></a> <h4>Previewer.__editorLanguageChanged</h4> <b>__editorLanguageChanged</b>(<i>editor</i>) + <p> Private slot to handle a change of the current editor's language. -</p><dl> +</p> +<dl> + <dt><i>editor</i></dt> <dd> reference to the editor (Editor) </dd> -</dl><a NAME="Previewer.__editorTextChanged" ID="Previewer.__editorTextChanged"></a> +</dl> +<a NAME="Previewer.__editorTextChanged" ID="Previewer.__editorTextChanged"></a> <h4>Previewer.__editorTextChanged</h4> <b>__editorTextChanged</b>(<i>editor</i>) + <p> Private slot to handle changes of an editor's text. -</p><dl> +</p> +<dl> + <dt><i>editor</i></dt> <dd> reference to the editor (Editor) </dd> -</dl><a NAME="Previewer.__isPreviewable" ID="Previewer.__isPreviewable"></a> +</dl> +<a NAME="Previewer.__isPreviewable" ID="Previewer.__isPreviewable"></a> <h4>Previewer.__isPreviewable</h4> <b>__isPreviewable</b>(<i>editor</i>) + <p> Private method to check, if a preview can be shown for the given editor. -</p><dl> +</p> +<dl> + <dt><i>editor</i></dt> <dd> reference to an editor (Editor) </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> flag indicating if a preview can be shown (boolean) </dd> -</dl><a NAME="Previewer.__previewStateChanged" ID="Previewer.__previewStateChanged"></a> +</dl> +<a NAME="Previewer.__previewStateChanged" ID="Previewer.__previewStateChanged"></a> <h4>Previewer.__previewStateChanged</h4> <b>__previewStateChanged</b>(<i>on</i>) + <p> Private slot to toggle the display of the preview. -</p><dl> +</p> +<dl> + <dt><i>on</i></dt> <dd> flag indicating to show a preview (boolean) </dd> -</dl><a NAME="Previewer.__processEditor" ID="Previewer.__processEditor"></a> +</dl> +<a NAME="Previewer.__processEditor" ID="Previewer.__processEditor"></a> <h4>Previewer.__processEditor</h4> <b>__processEditor</b>(<i></i>) + <p> Private slot to schedule the processing of the current editor's text. -</p><a NAME="Previewer.__splitterMoved" ID="Previewer.__splitterMoved"></a> +</p> +<a NAME="Previewer.__splitterMoved" ID="Previewer.__splitterMoved"></a> <h4>Previewer.__splitterMoved</h4> <b>__splitterMoved</b>(<i></i>) + <p> Private slot to handle the movement of the embedding splitter's handle. -</p><a NAME="Previewer.hide" ID="Previewer.hide"></a> +</p> +<a NAME="Previewer.hide" ID="Previewer.hide"></a> <h4>Previewer.hide</h4> <b>hide</b>(<i></i>) + <p> Public method to hide the preview widget. -</p><a NAME="Previewer.show" ID="Previewer.show"></a> +</p> +<a NAME="Previewer.show" ID="Previewer.show"></a> <h4>Previewer.show</h4> <b>show</b>(<i></i>) + <p> Public method to show the preview widget. -</p><a NAME="Previewer.shutdown" ID="Previewer.shutdown"></a> +</p> +<a NAME="Previewer.shutdown" ID="Previewer.shutdown"></a> <h4>Previewer.shutdown</h4> <b>shutdown</b>(<i></i>) + <p> Public method to perform shutdown actions. </p>