WizardDataUriEncoder/Documentation/source/Plugin_Wizard_DataUriEncoder.WizardDataUriEncoder.DataUriEncoderWizardDialog.html

changeset 6
fe575423760e
child 35
20bea809ae09
diff -r f08517d21ccc -r fe575423760e WizardDataUriEncoder/Documentation/source/Plugin_Wizard_DataUriEncoder.WizardDataUriEncoder.DataUriEncoderWizardDialog.html
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/WizardDataUriEncoder/Documentation/source/Plugin_Wizard_DataUriEncoder.WizardDataUriEncoder.DataUriEncoderWizardDialog.html	Mon Dec 30 11:24:23 2013 +0100
@@ -0,0 +1,178 @@
+<!DOCTYPE html>
+<html><head>
+<title>Plugin_Wizard_DataUriEncoder.WizardDataUriEncoder.DataUriEncoderWizardDialog</title>
+<meta charset="UTF-8">
+<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>Plugin_Wizard_DataUriEncoder.WizardDataUriEncoder.DataUriEncoderWizardDialog</h1>
+<p>
+Module implementing the base64 data URI encoder wizard dialog.
+</p>
+<h3>Global Attributes</h3>
+<table>
+<tr><td>Python2Template</td></tr><tr><td>Python3Template</td></tr>
+</table>
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#DataUriEncoderWizardDialog">DataUriEncoderWizardDialog</a></td>
+<td>Class implementing the base64 data URI encoder wizard dialog.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr /><hr />
+<a NAME="DataUriEncoderWizardDialog" ID="DataUriEncoderWizardDialog"></a>
+<h2>DataUriEncoderWizardDialog</h2>
+<p>
+    Class implementing the base64 data URI encoder wizard dialog.
+</p>
+<h3>Derived from</h3>
+QDialog, Ui_DataUriEncoderWizardDialog
+<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="#DataUriEncoderWizardDialog.__init__">DataUriEncoderWizardDialog</a></td>
+<td>Constructor</td>
+</tr><tr>
+<td><a href="#DataUriEncoderWizardDialog.__askMime">__askMime</a></td>
+<td>Private method to get the mime type from the user.</td>
+</tr><tr>
+<td><a href="#DataUriEncoderWizardDialog.__getStartDir">__getStartDir</a></td>
+<td>Private method to get the start directory for selection dialogs.</td>
+</tr><tr>
+<td><a href="#DataUriEncoderWizardDialog.getCode">getCode</a></td>
+<td>Public method to get the code.</td>
+</tr><tr>
+<td><a href="#DataUriEncoderWizardDialog.on_copyButton_clicked">on_copyButton_clicked</a></td>
+<td>Private slot to copy the output to the clipboard.</td>
+</tr><tr>
+<td><a href="#DataUriEncoderWizardDialog.on_embeddingComboBox_currentIndexChanged">on_embeddingComboBox_currentIndexChanged</a></td>
+<td>Private slot to handle the selection of an embedding method.</td>
+</tr><tr>
+<td><a href="#DataUriEncoderWizardDialog.on_encodeButton_clicked">on_encodeButton_clicked</a></td>
+<td>Private slot to encode the contents of the given file.</td>
+</tr><tr>
+<td><a href="#DataUriEncoderWizardDialog.on_fileButton_clicked">on_fileButton_clicked</a></td>
+<td>Private slot to select the file to be encoded via a selection dialog.</td>
+</tr><tr>
+<td><a href="#DataUriEncoderWizardDialog.on_fileEdit_textChanged">on_fileEdit_textChanged</a></td>
+<td>Private slot to handle the editing of the file name.</td>
+</tr><tr>
+<td><a href="#DataUriEncoderWizardDialog.on_outputTextEdit_textChanged">on_outputTextEdit_textChanged</a></td>
+<td>Private slot to handle the existence of some output text.</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<a NAME="DataUriEncoderWizardDialog.__init__" ID="DataUriEncoderWizardDialog.__init__"></a>
+<h4>DataUriEncoderWizardDialog (Constructor)</h4>
+<b>DataUriEncoderWizardDialog</b>(<i>parent=None</i>)
+<p>
+        Constructor
+</p><dl>
+<dt><i>parent</i></dt>
+<dd>
+reference to the parent widget (QWidget)
+</dd>
+</dl><a NAME="DataUriEncoderWizardDialog.__askMime" ID="DataUriEncoderWizardDialog.__askMime"></a>
+<h4>DataUriEncoderWizardDialog.__askMime</h4>
+<b>__askMime</b>(<i></i>)
+<p>
+        Private method to get the mime type from the user.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+entered mime type (string)
+</dd>
+</dl><a NAME="DataUriEncoderWizardDialog.__getStartDir" ID="DataUriEncoderWizardDialog.__getStartDir"></a>
+<h4>DataUriEncoderWizardDialog.__getStartDir</h4>
+<b>__getStartDir</b>(<i></i>)
+<p>
+        Private method to get the start directory for selection dialogs.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+start directory (string)
+</dd>
+</dl><a NAME="DataUriEncoderWizardDialog.getCode" ID="DataUriEncoderWizardDialog.getCode"></a>
+<h4>DataUriEncoderWizardDialog.getCode</h4>
+<b>getCode</b>(<i></i>)
+<p>
+        Public method to get the code.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+generated code (string)
+</dd>
+</dl><a NAME="DataUriEncoderWizardDialog.on_copyButton_clicked" ID="DataUriEncoderWizardDialog.on_copyButton_clicked"></a>
+<h4>DataUriEncoderWizardDialog.on_copyButton_clicked</h4>
+<b>on_copyButton_clicked</b>(<i></i>)
+<p>
+        Private slot to copy the output to the clipboard.
+</p><a NAME="DataUriEncoderWizardDialog.on_embeddingComboBox_currentIndexChanged" ID="DataUriEncoderWizardDialog.on_embeddingComboBox_currentIndexChanged"></a>
+<h4>DataUriEncoderWizardDialog.on_embeddingComboBox_currentIndexChanged</h4>
+<b>on_embeddingComboBox_currentIndexChanged</b>(<i>index</i>)
+<p>
+        Private slot to handle the selection of an embedding method.
+</p><dl>
+<dt><i>index</i></dt>
+<dd>
+index of the selected entry (integer)
+</dd>
+</dl><a NAME="DataUriEncoderWizardDialog.on_encodeButton_clicked" ID="DataUriEncoderWizardDialog.on_encodeButton_clicked"></a>
+<h4>DataUriEncoderWizardDialog.on_encodeButton_clicked</h4>
+<b>on_encodeButton_clicked</b>(<i></i>)
+<p>
+        Private slot to encode the contents of the given file.
+</p><a NAME="DataUriEncoderWizardDialog.on_fileButton_clicked" ID="DataUriEncoderWizardDialog.on_fileButton_clicked"></a>
+<h4>DataUriEncoderWizardDialog.on_fileButton_clicked</h4>
+<b>on_fileButton_clicked</b>(<i></i>)
+<p>
+        Private slot to select the file to be encoded via a selection dialog.
+</p><a NAME="DataUriEncoderWizardDialog.on_fileEdit_textChanged" ID="DataUriEncoderWizardDialog.on_fileEdit_textChanged"></a>
+<h4>DataUriEncoderWizardDialog.on_fileEdit_textChanged</h4>
+<b>on_fileEdit_textChanged</b>(<i>txt</i>)
+<p>
+        Private slot to handle the editing of the file name.
+</p><dl>
+<dt><i>txt</i></dt>
+<dd>
+current file name (string)
+</dd>
+</dl><a NAME="DataUriEncoderWizardDialog.on_outputTextEdit_textChanged" ID="DataUriEncoderWizardDialog.on_outputTextEdit_textChanged"></a>
+<h4>DataUriEncoderWizardDialog.on_outputTextEdit_textChanged</h4>
+<b>on_outputTextEdit_textChanged</b>(<i></i>)
+<p>
+        Private slot to handle the existence of some output text.
+</p>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial