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

changeset 6
fe575423760e
child 35
20bea809ae09
equal deleted inserted replaced
5:f08517d21ccc 6:fe575423760e
1 <!DOCTYPE html>
2 <html><head>
3 <title>Plugin_Wizard_DataUriEncoder.WizardDataUriEncoder.DataUriEncoderWizardDialog</title>
4 <meta charset="UTF-8">
5 <style>
6 body {
7 background: #EDECE6;
8 margin: 0em 1em 10em 1em;
9 color: black;
10 }
11
12 h1 { color: white; background: #85774A; }
13 h2 { color: white; background: #85774A; }
14 h3 { color: white; background: #9D936E; }
15 h4 { color: white; background: #9D936E; }
16
17 a { color: #BA6D36; }
18
19 </style>
20 </head>
21 <body><a NAME="top" ID="top"></a>
22 <h1>Plugin_Wizard_DataUriEncoder.WizardDataUriEncoder.DataUriEncoderWizardDialog</h1>
23 <p>
24 Module implementing the base64 data URI encoder wizard dialog.
25 </p>
26 <h3>Global Attributes</h3>
27 <table>
28 <tr><td>Python2Template</td></tr><tr><td>Python3Template</td></tr>
29 </table>
30 <h3>Classes</h3>
31 <table>
32 <tr>
33 <td><a href="#DataUriEncoderWizardDialog">DataUriEncoderWizardDialog</a></td>
34 <td>Class implementing the base64 data URI encoder wizard dialog.</td>
35 </tr>
36 </table>
37 <h3>Functions</h3>
38 <table>
39 <tr><td>None</td></tr>
40 </table>
41 <hr /><hr />
42 <a NAME="DataUriEncoderWizardDialog" ID="DataUriEncoderWizardDialog"></a>
43 <h2>DataUriEncoderWizardDialog</h2>
44 <p>
45 Class implementing the base64 data URI encoder wizard dialog.
46 </p>
47 <h3>Derived from</h3>
48 QDialog, Ui_DataUriEncoderWizardDialog
49 <h3>Class Attributes</h3>
50 <table>
51 <tr><td>None</td></tr>
52 </table>
53 <h3>Class Methods</h3>
54 <table>
55 <tr><td>None</td></tr>
56 </table>
57 <h3>Methods</h3>
58 <table>
59 <tr>
60 <td><a href="#DataUriEncoderWizardDialog.__init__">DataUriEncoderWizardDialog</a></td>
61 <td>Constructor</td>
62 </tr><tr>
63 <td><a href="#DataUriEncoderWizardDialog.__askMime">__askMime</a></td>
64 <td>Private method to get the mime type from the user.</td>
65 </tr><tr>
66 <td><a href="#DataUriEncoderWizardDialog.__getStartDir">__getStartDir</a></td>
67 <td>Private method to get the start directory for selection dialogs.</td>
68 </tr><tr>
69 <td><a href="#DataUriEncoderWizardDialog.getCode">getCode</a></td>
70 <td>Public method to get the code.</td>
71 </tr><tr>
72 <td><a href="#DataUriEncoderWizardDialog.on_copyButton_clicked">on_copyButton_clicked</a></td>
73 <td>Private slot to copy the output to the clipboard.</td>
74 </tr><tr>
75 <td><a href="#DataUriEncoderWizardDialog.on_embeddingComboBox_currentIndexChanged">on_embeddingComboBox_currentIndexChanged</a></td>
76 <td>Private slot to handle the selection of an embedding method.</td>
77 </tr><tr>
78 <td><a href="#DataUriEncoderWizardDialog.on_encodeButton_clicked">on_encodeButton_clicked</a></td>
79 <td>Private slot to encode the contents of the given file.</td>
80 </tr><tr>
81 <td><a href="#DataUriEncoderWizardDialog.on_fileButton_clicked">on_fileButton_clicked</a></td>
82 <td>Private slot to select the file to be encoded via a selection dialog.</td>
83 </tr><tr>
84 <td><a href="#DataUriEncoderWizardDialog.on_fileEdit_textChanged">on_fileEdit_textChanged</a></td>
85 <td>Private slot to handle the editing of the file name.</td>
86 </tr><tr>
87 <td><a href="#DataUriEncoderWizardDialog.on_outputTextEdit_textChanged">on_outputTextEdit_textChanged</a></td>
88 <td>Private slot to handle the existence of some output text.</td>
89 </tr>
90 </table>
91 <h3>Static Methods</h3>
92 <table>
93 <tr><td>None</td></tr>
94 </table>
95 <a NAME="DataUriEncoderWizardDialog.__init__" ID="DataUriEncoderWizardDialog.__init__"></a>
96 <h4>DataUriEncoderWizardDialog (Constructor)</h4>
97 <b>DataUriEncoderWizardDialog</b>(<i>parent=None</i>)
98 <p>
99 Constructor
100 </p><dl>
101 <dt><i>parent</i></dt>
102 <dd>
103 reference to the parent widget (QWidget)
104 </dd>
105 </dl><a NAME="DataUriEncoderWizardDialog.__askMime" ID="DataUriEncoderWizardDialog.__askMime"></a>
106 <h4>DataUriEncoderWizardDialog.__askMime</h4>
107 <b>__askMime</b>(<i></i>)
108 <p>
109 Private method to get the mime type from the user.
110 </p><dl>
111 <dt>Returns:</dt>
112 <dd>
113 entered mime type (string)
114 </dd>
115 </dl><a NAME="DataUriEncoderWizardDialog.__getStartDir" ID="DataUriEncoderWizardDialog.__getStartDir"></a>
116 <h4>DataUriEncoderWizardDialog.__getStartDir</h4>
117 <b>__getStartDir</b>(<i></i>)
118 <p>
119 Private method to get the start directory for selection dialogs.
120 </p><dl>
121 <dt>Returns:</dt>
122 <dd>
123 start directory (string)
124 </dd>
125 </dl><a NAME="DataUriEncoderWizardDialog.getCode" ID="DataUriEncoderWizardDialog.getCode"></a>
126 <h4>DataUriEncoderWizardDialog.getCode</h4>
127 <b>getCode</b>(<i></i>)
128 <p>
129 Public method to get the code.
130 </p><dl>
131 <dt>Returns:</dt>
132 <dd>
133 generated code (string)
134 </dd>
135 </dl><a NAME="DataUriEncoderWizardDialog.on_copyButton_clicked" ID="DataUriEncoderWizardDialog.on_copyButton_clicked"></a>
136 <h4>DataUriEncoderWizardDialog.on_copyButton_clicked</h4>
137 <b>on_copyButton_clicked</b>(<i></i>)
138 <p>
139 Private slot to copy the output to the clipboard.
140 </p><a NAME="DataUriEncoderWizardDialog.on_embeddingComboBox_currentIndexChanged" ID="DataUriEncoderWizardDialog.on_embeddingComboBox_currentIndexChanged"></a>
141 <h4>DataUriEncoderWizardDialog.on_embeddingComboBox_currentIndexChanged</h4>
142 <b>on_embeddingComboBox_currentIndexChanged</b>(<i>index</i>)
143 <p>
144 Private slot to handle the selection of an embedding method.
145 </p><dl>
146 <dt><i>index</i></dt>
147 <dd>
148 index of the selected entry (integer)
149 </dd>
150 </dl><a NAME="DataUriEncoderWizardDialog.on_encodeButton_clicked" ID="DataUriEncoderWizardDialog.on_encodeButton_clicked"></a>
151 <h4>DataUriEncoderWizardDialog.on_encodeButton_clicked</h4>
152 <b>on_encodeButton_clicked</b>(<i></i>)
153 <p>
154 Private slot to encode the contents of the given file.
155 </p><a NAME="DataUriEncoderWizardDialog.on_fileButton_clicked" ID="DataUriEncoderWizardDialog.on_fileButton_clicked"></a>
156 <h4>DataUriEncoderWizardDialog.on_fileButton_clicked</h4>
157 <b>on_fileButton_clicked</b>(<i></i>)
158 <p>
159 Private slot to select the file to be encoded via a selection dialog.
160 </p><a NAME="DataUriEncoderWizardDialog.on_fileEdit_textChanged" ID="DataUriEncoderWizardDialog.on_fileEdit_textChanged"></a>
161 <h4>DataUriEncoderWizardDialog.on_fileEdit_textChanged</h4>
162 <b>on_fileEdit_textChanged</b>(<i>txt</i>)
163 <p>
164 Private slot to handle the editing of the file name.
165 </p><dl>
166 <dt><i>txt</i></dt>
167 <dd>
168 current file name (string)
169 </dd>
170 </dl><a NAME="DataUriEncoderWizardDialog.on_outputTextEdit_textChanged" ID="DataUriEncoderWizardDialog.on_outputTextEdit_textChanged"></a>
171 <h4>DataUriEncoderWizardDialog.on_outputTextEdit_textChanged</h4>
172 <b>on_outputTextEdit_textChanged</b>(<i></i>)
173 <p>
174 Private slot to handle the existence of some output text.
175 </p>
176 <div align="right"><a href="#top">Up</a></div>
177 <hr />
178 </body></html>

eric ide

mercurial