--- a/Documentation/Source/eric5.UI.Previewer.html Mon Mar 31 19:13:22 2014 +0200
+++ b/Documentation/Source/eric5.UI.Previewer.html Mon Mar 31 19:27:31 2014 +0200
@@ -30,14 +30,8 @@
<h3>Classes</h3>
<table>
<tr>
-<td><a href="#PreviewProcessingThread">PreviewProcessingThread</a></td>
-<td>Class implementing a thread to process some text into HTML usable by the previewer view.</td>
-</tr><tr>
<td><a href="#Previewer">Previewer</a></td>
-<td>Class implementing a previewer widget for HTML, Markdown and ReST files.</td>
-</tr><tr>
-<td><a href="#_StrikeThroughExtension">_StrikeThroughExtension</a></td>
-<td>Class is placed here, because it depends on imported markdown, and markdown import is lazy.</td>
+<td>Class implementing a previewer widget containing a stack of specialized previewers.</td>
</tr>
</table>
<h3>Functions</h3>
@@ -45,189 +39,14 @@
<tr><td>None</td></tr>
</table>
<hr /><hr />
-<a NAME="PreviewProcessingThread" ID="PreviewProcessingThread"></a>
-<h2>PreviewProcessingThread</h2>
-<p>
- Class implementing a thread to process some text into HTML usable by the
- previewer view.
-</p><h3>Signals</h3>
-<dl>
-<dt>htmlReady(str,str)</dt>
-<dd>
-emitted with the file name and processed HTML
- to signal the availability of the processed HTML
-</dd>
-</dl>
-<h3>Derived from</h3>
-QThread
-<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="#PreviewProcessingThread.__init__">PreviewProcessingThread</a></td>
-<td>Constructor</td>
-</tr><tr>
-<td><a href="#PreviewProcessingThread.__convertMarkdown">__convertMarkdown</a></td>
-<td>Private method to convert Markdown text into HTML.</td>
-</tr><tr>
-<td><a href="#PreviewProcessingThread.__convertReST">__convertReST</a></td>
-<td>Private method to convert ReST text into HTML.</td>
-</tr><tr>
-<td><a href="#PreviewProcessingThread.__getHtml">__getHtml</a></td>
-<td>Private method to process the given text depending upon the given language.</td>
-</tr><tr>
-<td><a href="#PreviewProcessingThread.__processSSI">__processSSI</a></td>
-<td>Private method to process the given text for SSI statements.</td>
-</tr><tr>
-<td><a href="#PreviewProcessingThread.process">process</a></td>
-<td>Convert the given text to HTML.</td>
-</tr><tr>
-<td><a href="#PreviewProcessingThread.run">run</a></td>
-<td>Thread function to convert the stored data.</td>
-</tr>
-</table>
-<h3>Static Methods</h3>
-<table>
-<tr><td>None</td></tr>
-</table>
-<a NAME="PreviewProcessingThread.__init__" ID="PreviewProcessingThread.__init__"></a>
-<h4>PreviewProcessingThread (Constructor)</h4>
-<b>PreviewProcessingThread</b>(<i>parent=None</i>)
-<p>
- Constructor
-</p><dl>
-<dt><i>parent</i></dt>
-<dd>
-reference to the parent object (QObject)
-</dd>
-</dl><a NAME="PreviewProcessingThread.__convertMarkdown" ID="PreviewProcessingThread.__convertMarkdown"></a>
-<h4>PreviewProcessingThread.__convertMarkdown</h4>
-<b>__convertMarkdown</b>(<i>text</i>)
-<p>
- Private method to convert Markdown text into HTML.
-</p><dl>
-<dt><i>text</i></dt>
-<dd>
-text to be processed (string)
-</dd>
-</dl><dl>
-<dt>Returns:</dt>
-<dd>
-processed HTML (string)
-</dd>
-</dl><a NAME="PreviewProcessingThread.__convertReST" ID="PreviewProcessingThread.__convertReST"></a>
-<h4>PreviewProcessingThread.__convertReST</h4>
-<b>__convertReST</b>(<i>text</i>)
-<p>
- Private method to convert ReST text into HTML.
-</p><dl>
-<dt><i>text</i></dt>
-<dd>
-text to be processed (string)
-</dd>
-</dl><dl>
-<dt>Returns:</dt>
-<dd>
-processed HTML (string)
-</dd>
-</dl><a NAME="PreviewProcessingThread.__getHtml" ID="PreviewProcessingThread.__getHtml"></a>
-<h4>PreviewProcessingThread.__getHtml</h4>
-<b>__getHtml</b>(<i>language, text, ssiEnabled, filePath, rootPath</i>)
-<p>
- Private method to process the given text depending upon the given
- language.
-</p><dl>
-<dt><i>language</i></dt>
-<dd>
-language of the text (string)
-</dd><dt><i>text</i></dt>
-<dd>
-to be processed (string)
-</dd><dt><i>ssiEnabled</i></dt>
-<dd>
-flag indicating to do some (limited) SSI processing
- (boolean)
-</dd><dt><i>filePath</i></dt>
-<dd>
-file path of the text (string)
-</dd><dt><i>rootPath</i></dt>
-<dd>
-root path to be used for SSI processing (str)
-</dd>
-</dl><dl>
-<dt>Returns:</dt>
-<dd>
-processed HTML text (string)
-</dd>
-</dl><a NAME="PreviewProcessingThread.__processSSI" ID="PreviewProcessingThread.__processSSI"></a>
-<h4>PreviewProcessingThread.__processSSI</h4>
-<b>__processSSI</b>(<i>txt, filename, root</i>)
-<p>
- Private method to process the given text for SSI statements.
-</p><p>
- Note: Only a limited subset of SSI statements are supported.
-</p><dl>
-<dt><i>txt</i></dt>
-<dd>
-text to be processed (string)
-</dd><dt><i>filename</i></dt>
-<dd>
-name of the file associated with the given text
- (string)
-</dd><dt><i>root</i></dt>
-<dd>
-directory of the document root (string)
-</dd>
-</dl><dl>
-<dt>Returns:</dt>
-<dd>
-processed HTML (string)
-</dd>
-</dl><a NAME="PreviewProcessingThread.process" ID="PreviewProcessingThread.process"></a>
-<h4>PreviewProcessingThread.process</h4>
-<b>process</b>(<i>filePath, language, text, ssiEnabled, rootPath</i>)
-<p>
- Convert the given text to HTML.
-</p><dl>
-<dt><i>filePath</i></dt>
-<dd>
-file path of the text (string)
-</dd><dt><i>language</i></dt>
-<dd>
-language of the text (string)
-</dd><dt><i>text</i></dt>
-<dd>
-text to be processed (string)
-</dd><dt><i>ssiEnabled</i></dt>
-<dd>
-flag indicating to do some (limited) SSI processing
- (boolean)
-</dd><dt><i>rootPath</i></dt>
-<dd>
-root path to be used for SSI processing (str)
-</dd>
-</dl><a NAME="PreviewProcessingThread.run" ID="PreviewProcessingThread.run"></a>
-<h4>PreviewProcessingThread.run</h4>
-<b>run</b>(<i></i>)
-<p>
- Thread function to convert the stored data.
-</p>
-<div align="right"><a href="#top">Up</a></div>
-<hr /><hr />
<a NAME="Previewer" ID="Previewer"></a>
<h2>Previewer</h2>
<p>
- Class implementing a previewer widget for HTML, Markdown and ReST files.
+ Class implementing a previewer widget containing a stack of
+ specialized previewers.
</p>
<h3>Derived from</h3>
-QWidget, Ui_Previewer
+QStackedWidget
<h3>Class Attributes</h3>
<table>
<tr><td>None</td></tr>
@@ -257,39 +76,15 @@
<td><a href="#Previewer.__previewStateChanged">__previewStateChanged</a></td>
<td>Public slot to toggle the display of the preview.</td>
</tr><tr>
-<td><a href="#Previewer.__restoreScrollBarPositions">__restoreScrollBarPositions</a></td>
-<td>Private method to restore scroll bar positions for a previewed editor.</td>
-</tr><tr>
-<td><a href="#Previewer.__runProcessingThread">__runProcessingThread</a></td>
+<td><a href="#Previewer.__processEditor">__processEditor</a></td>
<td>Private slot to schedule the processing of the current editor's text.</td>
</tr><tr>
-<td><a href="#Previewer.__saveScrollBarPositions">__saveScrollBarPositions</a></td>
-<td>Private method to save scroll bar positions for a previewed editor.</td>
-</tr><tr>
-<td><a href="#Previewer.__setHtml">__setHtml</a></td>
-<td>Private method to set the HTML to the view and restore the scroll bars positions.</td>
-</tr><tr>
-<td><a href="#Previewer.__setJavaScriptEnabled">__setJavaScriptEnabled</a></td>
-<td>Private method to enable/disable JavaScript.</td>
-</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>
<td><a href="#Previewer.hide">hide</a></td>
<td>Public method to hide the preview widget.</td>
</tr><tr>
-<td><a href="#Previewer.on_jsCheckBox_clicked">on_jsCheckBox_clicked</a></td>
-<td>Private slot to enable/disable JavaScript.</td>
-</tr><tr>
-<td><a href="#Previewer.on_previewView_linkClicked">on_previewView_linkClicked</a></td>
-<td>Private slot handling the clicking of a link.</td>
-</tr><tr>
-<td><a href="#Previewer.on_previewView_titleChanged">on_previewView_titleChanged</a></td>
-<td>Private slot to handle a change of the title.</td>
-</tr><tr>
-<td><a href="#Previewer.on_ssiCheckBox_clicked">on_ssiCheckBox_clicked</a></td>
-<td>Private slot to enable/disable SSI.</td>
-</tr><tr>
<td><a href="#Previewer.show">show</a></td>
<td>Public method to show the preview widget.</td>
</tr><tr>
@@ -373,46 +168,12 @@
<dd>
flag indicating to show a preview (boolean)
</dd>
-</dl><a NAME="Previewer.__restoreScrollBarPositions" ID="Previewer.__restoreScrollBarPositions"></a>
-<h4>Previewer.__restoreScrollBarPositions</h4>
-<b>__restoreScrollBarPositions</b>(<i></i>)
-<p>
- Private method to restore scroll bar positions for a previewed editor.
-</p><a NAME="Previewer.__runProcessingThread" ID="Previewer.__runProcessingThread"></a>
-<h4>Previewer.__runProcessingThread</h4>
-<b>__runProcessingThread</b>(<i></i>)
+</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.__saveScrollBarPositions" ID="Previewer.__saveScrollBarPositions"></a>
-<h4>Previewer.__saveScrollBarPositions</h4>
-<b>__saveScrollBarPositions</b>(<i></i>)
-<p>
- Private method to save scroll bar positions for a previewed editor.
-</p><a NAME="Previewer.__setHtml" ID="Previewer.__setHtml"></a>
-<h4>Previewer.__setHtml</h4>
-<b>__setHtml</b>(<i>filePath, html</i>)
-<p>
- Private method to set the HTML to the view and restore the scroll bars
- positions.
-</p><dl>
-<dt><i>filePath</i></dt>
-<dd>
-file path of the previewed editor (string)
-</dd><dt><i>html</i></dt>
-<dd>
-processed HTML text ready to be shown (string)
-</dd>
-</dl><a NAME="Previewer.__setJavaScriptEnabled" ID="Previewer.__setJavaScriptEnabled"></a>
-<h4>Previewer.__setJavaScriptEnabled</h4>
-<b>__setJavaScriptEnabled</b>(<i>enable</i>)
-<p>
- Private method to enable/disable JavaScript.
-</p><dl>
-<dt><i>enable</i></dt>
-<dd>
-flag indicating the enable state (boolean)
-</dd>
-</dl><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>
@@ -422,47 +183,7 @@
<b>hide</b>(<i></i>)
<p>
Public method to hide the preview widget.
-</p><a NAME="Previewer.on_jsCheckBox_clicked" ID="Previewer.on_jsCheckBox_clicked"></a>
-<h4>Previewer.on_jsCheckBox_clicked</h4>
-<b>on_jsCheckBox_clicked</b>(<i>checked</i>)
-<p>
- Private slot to enable/disable JavaScript.
-</p><dl>
-<dt><i>checked</i></dt>
-<dd>
-state of the checkbox (boolean)
-</dd>
-</dl><a NAME="Previewer.on_previewView_linkClicked" ID="Previewer.on_previewView_linkClicked"></a>
-<h4>Previewer.on_previewView_linkClicked</h4>
-<b>on_previewView_linkClicked</b>(<i>url</i>)
-<p>
- Private slot handling the clicking of a link.
-</p><dl>
-<dt><i>url</i></dt>
-<dd>
-url of the clicked link (QUrl)
-</dd>
-</dl><a NAME="Previewer.on_previewView_titleChanged" ID="Previewer.on_previewView_titleChanged"></a>
-<h4>Previewer.on_previewView_titleChanged</h4>
-<b>on_previewView_titleChanged</b>(<i>title</i>)
-<p>
- Private slot to handle a change of the title.
-</p><dl>
-<dt><i>title</i></dt>
-<dd>
-new title (string)
-</dd>
-</dl><a NAME="Previewer.on_ssiCheckBox_clicked" ID="Previewer.on_ssiCheckBox_clicked"></a>
-<h4>Previewer.on_ssiCheckBox_clicked</h4>
-<b>on_ssiCheckBox_clicked</b>(<i>checked</i>)
-<p>
- Private slot to enable/disable SSI.
-</p><dl>
-<dt><i>checked</i></dt>
-<dd>
-state of the checkbox (boolean)
-</dd>
-</dl><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>
@@ -474,42 +195,5 @@
Public method to perform shutdown actions.
</p>
<div align="right"><a href="#top">Up</a></div>
-<hr /><hr />
-<a NAME="_StrikeThroughExtension" ID="_StrikeThroughExtension"></a>
-<h2>_StrikeThroughExtension</h2>
-<p>
- Class is placed here, because it depends on imported markdown,
- and markdown import is lazy.
-</p><p>
- (see http://achinghead.com/
- python-markdown-adding-insert-delete.html this page for
- details)
-</p>
-<h3>Derived from</h3>
-markdown.Extension
-<h3>Class Attributes</h3>
-<table>
-<tr><td>DEL_RE</td></tr>
-</table>
-<h3>Class Methods</h3>
-<table>
-<tr><td>None</td></tr>
-</table>
-<h3>Methods</h3>
-<table>
-<tr>
-<td><a href="#_StrikeThroughExtension.extendMarkdown">extendMarkdown</a></td>
-<td></td>
-</tr>
-</table>
-<h3>Static Methods</h3>
-<table>
-<tr><td>None</td></tr>
-</table>
-<a NAME="_StrikeThroughExtension.extendMarkdown" ID="_StrikeThroughExtension.extendMarkdown"></a>
-<h4>_StrikeThroughExtension.extendMarkdown</h4>
-<b>extendMarkdown</b>(<i>md, md_globals</i>)
-
-<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>
\ No newline at end of file
