ToolGenerateHash/Documentation/source/Plugin_Tools_GenerateHash.PluginToolGenerateHash.html

branch
eric7
changeset 54
b43a0eccfc61
parent 51
b5a1a986b800
child 57
f19f9dbb1076
equal deleted inserted replaced
53:a64adc8090ef 54:b43a0eccfc61
144 <p> 144 <p>
145 Private slot called, when an editor was closed. 145 Private slot called, when an editor was closed.
146 </p> 146 </p>
147 <dl> 147 <dl>
148 148
149 <dt><i>editor</i></dt> 149 <dt><i>editor</i> (Editor)</dt>
150 <dd> 150 <dd>
151 reference to the editor (QScintilla.Editor) 151 reference to the editor
152 </dd> 152 </dd>
153 </dl> 153 </dl>
154 <a NAME="ToolGenerateHashPlugin.__editorOpened" ID="ToolGenerateHashPlugin.__editorOpened"></a> 154 <a NAME="ToolGenerateHashPlugin.__editorOpened" ID="ToolGenerateHashPlugin.__editorOpened"></a>
155 <h4>ToolGenerateHashPlugin.__editorOpened</h4> 155 <h4>ToolGenerateHashPlugin.__editorOpened</h4>
156 <b>__editorOpened</b>(<i>editor</i>) 156 <b>__editorOpened</b>(<i>editor</i>)
158 <p> 158 <p>
159 Private slot called, when a new editor was opened. 159 Private slot called, when a new editor was opened.
160 </p> 160 </p>
161 <dl> 161 <dl>
162 162
163 <dt><i>editor</i></dt> 163 <dt><i>editor</i> (Editor)</dt>
164 <dd> 164 <dd>
165 reference to the new editor (QScintilla.Editor) 165 reference to the new editor
166 </dd> 166 </dd>
167 </dl> 167 </dl>
168 <a NAME="ToolGenerateHashPlugin.__editorShowMenu" ID="ToolGenerateHashPlugin.__editorShowMenu"></a> 168 <a NAME="ToolGenerateHashPlugin.__editorShowMenu" ID="ToolGenerateHashPlugin.__editorShowMenu"></a>
169 <h4>ToolGenerateHashPlugin.__editorShowMenu</h4> 169 <h4>ToolGenerateHashPlugin.__editorShowMenu</h4>
170 <b>__editorShowMenu</b>(<i>menuName, menu, editor</i>) 170 <b>__editorShowMenu</b>(<i>menuName, menu, editor</i>)
173 Private slot called, when the the editor context menu or a submenu is 173 Private slot called, when the the editor context menu or a submenu is
174 about to be shown. 174 about to be shown.
175 </p> 175 </p>
176 <dl> 176 <dl>
177 177
178 <dt><i>menuName</i></dt> 178 <dt><i>menuName</i> (str)</dt>
179 <dd> 179 <dd>
180 name of the menu to be shown (string) 180 name of the menu to be shown
181 </dd> 181 </dd>
182 <dt><i>menu</i></dt> 182 <dt><i>menu</i> (QMenu)</dt>
183 <dd> 183 <dd>
184 reference to the menu (QMenu) 184 reference to the menu
185 </dd> 185 </dd>
186 <dt><i>editor</i></dt> 186 <dt><i>editor</i> (Editor)</dt>
187 <dd> 187 <dd>
188 reference to the editor 188 reference to the editor
189 </dd> 189 </dd>
190 </dl> 190 </dl>
191 <a NAME="ToolGenerateHashPlugin.__hashDirectory" ID="ToolGenerateHashPlugin.__hashDirectory"></a> 191 <a NAME="ToolGenerateHashPlugin.__hashDirectory" ID="ToolGenerateHashPlugin.__hashDirectory"></a>
192 <h4>ToolGenerateHashPlugin.__hashDirectory</h4> 192 <h4>ToolGenerateHashPlugin.__hashDirectory</h4>
193 <b>__hashDirectory</b>(<i></i>) 193 <b>__hashDirectory</b>(<i>act</i>)
194 194
195 <p> 195 <p>
196 Private slot to generate the hash for a directory. 196 Private slot to generate the hash for a directory.
197 </p> 197 </p>
198 <dl>
199
200 <dt><i>act</i> (QAction)</dt>
201 <dd>
202 reference to the action that was triggered
203 </dd>
204 </dl>
198 <a NAME="ToolGenerateHashPlugin.__hashFile" ID="ToolGenerateHashPlugin.__hashFile"></a> 205 <a NAME="ToolGenerateHashPlugin.__hashFile" ID="ToolGenerateHashPlugin.__hashFile"></a>
199 <h4>ToolGenerateHashPlugin.__hashFile</h4> 206 <h4>ToolGenerateHashPlugin.__hashFile</h4>
200 <b>__hashFile</b>(<i></i>) 207 <b>__hashFile</b>(<i>act</i>)
201 208
202 <p> 209 <p>
203 Private slot to generate the hash for a file. 210 Private slot to generate the hash for a file.
204 </p> 211 </p>
212 <dl>
213
214 <dt><i>act</i> (QAction)</dt>
215 <dd>
216 reference to the action that was triggered
217 </dd>
218 </dl>
205 <a NAME="ToolGenerateHashPlugin.__initMenus" ID="ToolGenerateHashPlugin.__initMenus"></a> 219 <a NAME="ToolGenerateHashPlugin.__initMenus" ID="ToolGenerateHashPlugin.__initMenus"></a>
206 <h4>ToolGenerateHashPlugin.__initMenus</h4> 220 <h4>ToolGenerateHashPlugin.__initMenus</h4>
207 <b>__initMenus</b>(<i></i>) 221 <b>__initMenus</b>(<i></i>)
208 222
209 <p> 223 <p>
216 <p> 230 <p>
217 Private method to insert the generated hash string. 231 Private method to insert the generated hash string.
218 </p> 232 </p>
219 <dl> 233 <dl>
220 234
221 <dt><i>hashStr</i></dt> 235 <dt><i>hashStr</i> (str)</dt>
222 <dd> 236 <dd>
223 hash string (string) 237 hash string
224 </dd> 238 </dd>
225 </dl> 239 </dl>
226 <a NAME="ToolGenerateHashPlugin.__loadTranslator" ID="ToolGenerateHashPlugin.__loadTranslator"></a> 240 <a NAME="ToolGenerateHashPlugin.__loadTranslator" ID="ToolGenerateHashPlugin.__loadTranslator"></a>
227 <h4>ToolGenerateHashPlugin.__loadTranslator</h4> 241 <h4>ToolGenerateHashPlugin.__loadTranslator</h4>
228 <b>__loadTranslator</b>(<i></i>) 242 <b>__loadTranslator</b>(<i></i>)
237 <p> 251 <p>
238 Private slot to populate the tools menu with our entries. 252 Private slot to populate the tools menu with our entries.
239 </p> 253 </p>
240 <dl> 254 <dl>
241 255
242 <dt><i>name</i></dt> 256 <dt><i>name</i> (str)</dt>
243 <dd> 257 <dd>
244 name of the menu (string) 258 name of the menu
245 </dd> 259 </dd>
246 <dt><i>menu</i></dt> 260 <dt><i>menu</i> (QMenu)</dt>
247 <dd> 261 <dd>
248 reference to the menu to be populated (QMenu) 262 reference to the menu to be populated
249 </dd> 263 </dd>
250 </dl> 264 </dl>
251 <a NAME="ToolGenerateHashPlugin.activate" ID="ToolGenerateHashPlugin.activate"></a> 265 <a NAME="ToolGenerateHashPlugin.activate" ID="ToolGenerateHashPlugin.activate"></a>
252 <h4>ToolGenerateHashPlugin.activate</h4> 266 <h4>ToolGenerateHashPlugin.activate</h4>
253 <b>activate</b>(<i></i>) 267 <b>activate</b>(<i></i>)
256 Public method to activate this plugin. 270 Public method to activate this plugin.
257 </p> 271 </p>
258 <dl> 272 <dl>
259 <dt>Return:</dt> 273 <dt>Return:</dt>
260 <dd> 274 <dd>
261 tuple of None and activation status (boolean) 275 tuple of None and activation status
276 </dd>
277 </dl>
278 <dl>
279 <dt>Return Type:</dt>
280 <dd>
281 bool
262 </dd> 282 </dd>
263 </dl> 283 </dl>
264 <a NAME="ToolGenerateHashPlugin.deactivate" ID="ToolGenerateHashPlugin.deactivate"></a> 284 <a NAME="ToolGenerateHashPlugin.deactivate" ID="ToolGenerateHashPlugin.deactivate"></a>
265 <h4>ToolGenerateHashPlugin.deactivate</h4> 285 <h4>ToolGenerateHashPlugin.deactivate</h4>
266 <b>deactivate</b>(<i></i>) 286 <b>deactivate</b>(<i></i>)

eric ide

mercurial