Mercurial Repositories > Hash Generation Tool / file comparison

comparison: ToolGenerateHash/Documentation/source/Plugin_Tools_GenerateHash.PluginToolGenerateHash.html

ToolGenerateHash/Documentation/source/Plugin_Tools_GenerateHash.PluginToolGenerateHash.html

changeset 45
60ef6c28f7fb
parent 24
31a6f2b29967
child 51
b5a1a986b800
equal deleted inserted replaced
44:4a8ec9716e40 45:60ef6c28f7fb
16 16
17 a { color: #BA6D36; } 17 a { color: #BA6D36; }
18 18
19 </style> 19 </style>
20 </head> 20 </head>
21 <body><a NAME="top" ID="top"></a> 21 <body>
22 <a NAME="top" ID="top"></a>
22 <h1>Plugin_Tools_GenerateHash.PluginToolGenerateHash</h1> 23 <h1>Plugin_Tools_GenerateHash.PluginToolGenerateHash</h1>
24
23 <p> 25 <p>
24 Module implementing the 'Generate Hash' tool plug-in. 26 Module implementing the 'Generate Hash' tool plug-in.
25 </p> 27 </p>
26 <h3>Global Attributes</h3> 28 <h3>Global Attributes</h3>
27 <table> 29
28 <tr><td>author</td></tr><tr><td>autoactivate</td></tr><tr><td>className</td></tr><tr><td>deactivateable</td></tr><tr><td>error</td></tr><tr><td>longDescription</td></tr><tr><td>name</td></tr><tr><td>needsRestart</td></tr><tr><td>packageName</td></tr><tr><td>pyqtApi</td></tr><tr><td>python2Compatible</td></tr><tr><td>shortDescription</td></tr><tr><td>version</td></tr> 30 <table>
31 <tr><td>author</td></tr><tr><td>autoactivate</td></tr><tr><td>className</td></tr><tr><td>deactivateable</td></tr><tr><td>error</td></tr><tr><td>longDescription</td></tr><tr><td>name</td></tr><tr><td>needsRestart</td></tr><tr><td>packageName</td></tr><tr><td>pyqtApi</td></tr><tr><td>shortDescription</td></tr><tr><td>version</td></tr>
29 </table> 32 </table>
30 <h3>Classes</h3> 33 <h3>Classes</h3>
31 <table> 34
35 <table>
36
32 <tr> 37 <tr>
33 <td><a href="#ToolGenerateHashPlugin">ToolGenerateHashPlugin</a></td> 38 <td><a href="#ToolGenerateHashPlugin">ToolGenerateHashPlugin</a></td>
34 <td>Class implementing the 'Generate Hash' tool plug-in.</td> 39 <td>Class implementing the 'Generate Hash' tool plug-in.</td>
35 </tr> 40 </tr>
36 </table> 41 </table>
37 <h3>Functions</h3> 42 <h3>Functions</h3>
43
38 <table> 44 <table>
39 <tr><td>None</td></tr> 45 <tr><td>None</td></tr>
40 </table> 46 </table>
41 <hr /><hr /> 47 <hr />
48 <hr />
42 <a NAME="ToolGenerateHashPlugin" ID="ToolGenerateHashPlugin"></a> 49 <a NAME="ToolGenerateHashPlugin" ID="ToolGenerateHashPlugin"></a>
43 <h2>ToolGenerateHashPlugin</h2> 50 <h2>ToolGenerateHashPlugin</h2>
51
44 <p> 52 <p>
45 Class implementing the 'Generate Hash' tool plug-in. 53 Class implementing the 'Generate Hash' tool plug-in.
46 </p> 54 </p>
47 <h3>Derived from</h3> 55 <h3>Derived from</h3>
48 QObject 56 QObject
49 <h3>Class Attributes</h3> 57 <h3>Class Attributes</h3>
58
50 <table> 59 <table>
51 <tr><td>Hashes</td></tr> 60 <tr><td>Hashes</td></tr>
52 </table> 61 </table>
53 <h3>Class Methods</h3> 62 <h3>Class Methods</h3>
63
54 <table> 64 <table>
55 <tr><td>None</td></tr> 65 <tr><td>None</td></tr>
56 </table> 66 </table>
57 <h3>Methods</h3> 67 <h3>Methods</h3>
58 <table> 68
69 <table>
70
59 <tr> 71 <tr>
60 <td><a href="#ToolGenerateHashPlugin.__init__">ToolGenerateHashPlugin</a></td> 72 <td><a href="#ToolGenerateHashPlugin.__init__">ToolGenerateHashPlugin</a></td>
61 <td>Constructor</td> 73 <td>Constructor</td>
62 </tr><tr> 74 </tr>
75 <tr>
63 <td><a href="#ToolGenerateHashPlugin.__editorClosed">__editorClosed</a></td> 76 <td><a href="#ToolGenerateHashPlugin.__editorClosed">__editorClosed</a></td>
64 <td>Private slot called, when an editor was closed.</td> 77 <td>Private slot called, when an editor was closed.</td>
65 </tr><tr> 78 </tr>
79 <tr>
66 <td><a href="#ToolGenerateHashPlugin.__editorOpened">__editorOpened</a></td> 80 <td><a href="#ToolGenerateHashPlugin.__editorOpened">__editorOpened</a></td>
67 <td>Private slot called, when a new editor was opened.</td> 81 <td>Private slot called, when a new editor was opened.</td>
68 </tr><tr> 82 </tr>
83 <tr>
69 <td><a href="#ToolGenerateHashPlugin.__editorShowMenu">__editorShowMenu</a></td> 84 <td><a href="#ToolGenerateHashPlugin.__editorShowMenu">__editorShowMenu</a></td>
70 <td>Private slot called, when the the editor context menu or a submenu is about to be shown.</td> 85 <td>Private slot called, when the the editor context menu or a submenu is about to be shown.</td>
71 </tr><tr> 86 </tr>
87 <tr>
72 <td><a href="#ToolGenerateHashPlugin.__hashDirectory">__hashDirectory</a></td> 88 <td><a href="#ToolGenerateHashPlugin.__hashDirectory">__hashDirectory</a></td>
73 <td>Private slot to generate the hash for a directory.</td> 89 <td>Private slot to generate the hash for a directory.</td>
74 </tr><tr> 90 </tr>
91 <tr>
75 <td><a href="#ToolGenerateHashPlugin.__hashFile">__hashFile</a></td> 92 <td><a href="#ToolGenerateHashPlugin.__hashFile">__hashFile</a></td>
76 <td>Private slot to generate the hash for a file.</td> 93 <td>Private slot to generate the hash for a file.</td>
77 </tr><tr> 94 </tr>
95 <tr>
78 <td><a href="#ToolGenerateHashPlugin.__initMenus">__initMenus</a></td> 96 <td><a href="#ToolGenerateHashPlugin.__initMenus">__initMenus</a></td>
79 <td>Private method to initialize the hash generation menus.</td> 97 <td>Private method to initialize the hash generation menus.</td>
80 </tr><tr> 98 </tr>
99 <tr>
81 <td><a href="#ToolGenerateHashPlugin.__insertHash">__insertHash</a></td> 100 <td><a href="#ToolGenerateHashPlugin.__insertHash">__insertHash</a></td>
82 <td>Private method to insert the generated hash string.</td> 101 <td>Private method to insert the generated hash string.</td>
83 </tr><tr> 102 </tr>
103 <tr>
84 <td><a href="#ToolGenerateHashPlugin.__loadTranslator">__loadTranslator</a></td> 104 <td><a href="#ToolGenerateHashPlugin.__loadTranslator">__loadTranslator</a></td>
85 <td>Private method to load the translation file.</td> 105 <td>Private method to load the translation file.</td>
86 </tr><tr> 106 </tr>
107 <tr>
87 <td><a href="#ToolGenerateHashPlugin.__populateMenu">__populateMenu</a></td> 108 <td><a href="#ToolGenerateHashPlugin.__populateMenu">__populateMenu</a></td>
88 <td>Private slot to populate the tools menu with our entries.</td> 109 <td>Private slot to populate the tools menu with our entries.</td>
89 </tr><tr> 110 </tr>
111 <tr>
90 <td><a href="#ToolGenerateHashPlugin.activate">activate</a></td> 112 <td><a href="#ToolGenerateHashPlugin.activate">activate</a></td>
91 <td>Public method to activate this plugin.</td> 113 <td>Public method to activate this plugin.</td>
92 </tr><tr> 114 </tr>
115 <tr>
93 <td><a href="#ToolGenerateHashPlugin.deactivate">deactivate</a></td> 116 <td><a href="#ToolGenerateHashPlugin.deactivate">deactivate</a></td>
94 <td>Public method to deactivate this plugin.</td> 117 <td>Public method to deactivate this plugin.</td>
95 </tr> 118 </tr>
96 </table> 119 </table>
97 <h3>Static Methods</h3> 120 <h3>Static Methods</h3>
121
98 <table> 122 <table>
99 <tr><td>None</td></tr> 123 <tr><td>None</td></tr>
100 </table> 124 </table>
125
101 <a NAME="ToolGenerateHashPlugin.__init__" ID="ToolGenerateHashPlugin.__init__"></a> 126 <a NAME="ToolGenerateHashPlugin.__init__" ID="ToolGenerateHashPlugin.__init__"></a>
102 <h4>ToolGenerateHashPlugin (Constructor)</h4> 127 <h4>ToolGenerateHashPlugin (Constructor)</h4>
103 <b>ToolGenerateHashPlugin</b>(<i>ui</i>) 128 <b>ToolGenerateHashPlugin</b>(<i>ui</i>)
129
104 <p> 130 <p>
105 Constructor 131 Constructor
106 </p><dl> 132 </p>
133 <dl>
134
107 <dt><i>ui</i></dt> 135 <dt><i>ui</i></dt>
108 <dd> 136 <dd>
109 reference to the user interface object (UI.UserInterface) 137 reference to the user interface object (UI.UserInterface)
110 </dd> 138 </dd>
111 </dl><a NAME="ToolGenerateHashPlugin.__editorClosed" ID="ToolGenerateHashPlugin.__editorClosed"></a> 139 </dl>
140 <a NAME="ToolGenerateHashPlugin.__editorClosed" ID="ToolGenerateHashPlugin.__editorClosed"></a>
112 <h4>ToolGenerateHashPlugin.__editorClosed</h4> 141 <h4>ToolGenerateHashPlugin.__editorClosed</h4>
113 <b>__editorClosed</b>(<i>editor</i>) 142 <b>__editorClosed</b>(<i>editor</i>)
143
114 <p> 144 <p>
115 Private slot called, when an editor was closed. 145 Private slot called, when an editor was closed.
116 </p><dl> 146 </p>
147 <dl>
148
117 <dt><i>editor</i></dt> 149 <dt><i>editor</i></dt>
118 <dd> 150 <dd>
119 reference to the editor (QScintilla.Editor) 151 reference to the editor (QScintilla.Editor)
120 </dd> 152 </dd>
121 </dl><a NAME="ToolGenerateHashPlugin.__editorOpened" ID="ToolGenerateHashPlugin.__editorOpened"></a> 153 </dl>
154 <a NAME="ToolGenerateHashPlugin.__editorOpened" ID="ToolGenerateHashPlugin.__editorOpened"></a>
122 <h4>ToolGenerateHashPlugin.__editorOpened</h4> 155 <h4>ToolGenerateHashPlugin.__editorOpened</h4>
123 <b>__editorOpened</b>(<i>editor</i>) 156 <b>__editorOpened</b>(<i>editor</i>)
157
124 <p> 158 <p>
125 Private slot called, when a new editor was opened. 159 Private slot called, when a new editor was opened.
126 </p><dl> 160 </p>
161 <dl>
162
127 <dt><i>editor</i></dt> 163 <dt><i>editor</i></dt>
128 <dd> 164 <dd>
129 reference to the new editor (QScintilla.Editor) 165 reference to the new editor (QScintilla.Editor)
130 </dd> 166 </dd>
131 </dl><a NAME="ToolGenerateHashPlugin.__editorShowMenu" ID="ToolGenerateHashPlugin.__editorShowMenu"></a> 167 </dl>
168 <a NAME="ToolGenerateHashPlugin.__editorShowMenu" ID="ToolGenerateHashPlugin.__editorShowMenu"></a>
132 <h4>ToolGenerateHashPlugin.__editorShowMenu</h4> 169 <h4>ToolGenerateHashPlugin.__editorShowMenu</h4>
133 <b>__editorShowMenu</b>(<i>menuName, menu, editor</i>) 170 <b>__editorShowMenu</b>(<i>menuName, menu, editor</i>)
171
134 <p> 172 <p>
135 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
136 about to be shown. 174 about to be shown.
137 </p><dl> 175 </p>
176 <dl>
177
138 <dt><i>menuName</i></dt> 178 <dt><i>menuName</i></dt>
139 <dd> 179 <dd>
140 name of the menu to be shown (string) 180 name of the menu to be shown (string)
141 </dd><dt><i>menu</i></dt> 181 </dd>
182 <dt><i>menu</i></dt>
142 <dd> 183 <dd>
143 reference to the menu (QMenu) 184 reference to the menu (QMenu)
144 </dd><dt><i>editor</i></dt> 185 </dd>
186 <dt><i>editor</i></dt>
145 <dd> 187 <dd>
146 reference to the editor 188 reference to the editor
147 </dd> 189 </dd>
148 </dl><a NAME="ToolGenerateHashPlugin.__hashDirectory" ID="ToolGenerateHashPlugin.__hashDirectory"></a> 190 </dl>
191 <a NAME="ToolGenerateHashPlugin.__hashDirectory" ID="ToolGenerateHashPlugin.__hashDirectory"></a>
149 <h4>ToolGenerateHashPlugin.__hashDirectory</h4> 192 <h4>ToolGenerateHashPlugin.__hashDirectory</h4>
150 <b>__hashDirectory</b>(<i></i>) 193 <b>__hashDirectory</b>(<i></i>)
194
151 <p> 195 <p>
152 Private slot to generate the hash for a directory. 196 Private slot to generate the hash for a directory.
153 </p><a NAME="ToolGenerateHashPlugin.__hashFile" ID="ToolGenerateHashPlugin.__hashFile"></a> 197 </p>
198 <a NAME="ToolGenerateHashPlugin.__hashFile" ID="ToolGenerateHashPlugin.__hashFile"></a>
154 <h4>ToolGenerateHashPlugin.__hashFile</h4> 199 <h4>ToolGenerateHashPlugin.__hashFile</h4>
155 <b>__hashFile</b>(<i></i>) 200 <b>__hashFile</b>(<i></i>)
201
156 <p> 202 <p>
157 Private slot to generate the hash for a file. 203 Private slot to generate the hash for a file.
158 </p><a NAME="ToolGenerateHashPlugin.__initMenus" ID="ToolGenerateHashPlugin.__initMenus"></a> 204 </p>
205 <a NAME="ToolGenerateHashPlugin.__initMenus" ID="ToolGenerateHashPlugin.__initMenus"></a>
159 <h4>ToolGenerateHashPlugin.__initMenus</h4> 206 <h4>ToolGenerateHashPlugin.__initMenus</h4>
160 <b>__initMenus</b>(<i></i>) 207 <b>__initMenus</b>(<i></i>)
208
161 <p> 209 <p>
162 Private method to initialize the hash generation menus. 210 Private method to initialize the hash generation menus.
163 </p><a NAME="ToolGenerateHashPlugin.__insertHash" ID="ToolGenerateHashPlugin.__insertHash"></a> 211 </p>
212 <a NAME="ToolGenerateHashPlugin.__insertHash" ID="ToolGenerateHashPlugin.__insertHash"></a>
164 <h4>ToolGenerateHashPlugin.__insertHash</h4> 213 <h4>ToolGenerateHashPlugin.__insertHash</h4>
165 <b>__insertHash</b>(<i>hashStr</i>) 214 <b>__insertHash</b>(<i>hashStr</i>)
215
166 <p> 216 <p>
167 Private method to insert the generated hash string. 217 Private method to insert the generated hash string.
168 </p><dl> 218 </p>
219 <dl>
220
169 <dt><i>hashStr</i></dt> 221 <dt><i>hashStr</i></dt>
170 <dd> 222 <dd>
171 hash string (string) 223 hash string (string)
172 </dd> 224 </dd>
173 </dl><a NAME="ToolGenerateHashPlugin.__loadTranslator" ID="ToolGenerateHashPlugin.__loadTranslator"></a> 225 </dl>
226 <a NAME="ToolGenerateHashPlugin.__loadTranslator" ID="ToolGenerateHashPlugin.__loadTranslator"></a>
174 <h4>ToolGenerateHashPlugin.__loadTranslator</h4> 227 <h4>ToolGenerateHashPlugin.__loadTranslator</h4>
175 <b>__loadTranslator</b>(<i></i>) 228 <b>__loadTranslator</b>(<i></i>)
229
176 <p> 230 <p>
177 Private method to load the translation file. 231 Private method to load the translation file.
178 </p><a NAME="ToolGenerateHashPlugin.__populateMenu" ID="ToolGenerateHashPlugin.__populateMenu"></a> 232 </p>
233 <a NAME="ToolGenerateHashPlugin.__populateMenu" ID="ToolGenerateHashPlugin.__populateMenu"></a>
179 <h4>ToolGenerateHashPlugin.__populateMenu</h4> 234 <h4>ToolGenerateHashPlugin.__populateMenu</h4>
180 <b>__populateMenu</b>(<i>name, menu</i>) 235 <b>__populateMenu</b>(<i>name, menu</i>)
236
181 <p> 237 <p>
182 Private slot to populate the tools menu with our entries. 238 Private slot to populate the tools menu with our entries.
183 </p><dl> 239 </p>
240 <dl>
241
184 <dt><i>name</i></dt> 242 <dt><i>name</i></dt>
185 <dd> 243 <dd>
186 name of the menu (string) 244 name of the menu (string)
187 </dd><dt><i>menu</i></dt> 245 </dd>
246 <dt><i>menu</i></dt>
188 <dd> 247 <dd>
189 reference to the menu to be populated (QMenu) 248 reference to the menu to be populated (QMenu)
190 </dd> 249 </dd>
191 </dl><a NAME="ToolGenerateHashPlugin.activate" ID="ToolGenerateHashPlugin.activate"></a> 250 </dl>
251 <a NAME="ToolGenerateHashPlugin.activate" ID="ToolGenerateHashPlugin.activate"></a>
192 <h4>ToolGenerateHashPlugin.activate</h4> 252 <h4>ToolGenerateHashPlugin.activate</h4>
193 <b>activate</b>(<i></i>) 253 <b>activate</b>(<i></i>)
254
194 <p> 255 <p>
195 Public method to activate this plugin. 256 Public method to activate this plugin.
196 </p><dl> 257 </p>
258 <dl>
197 <dt>Returns:</dt> 259 <dt>Returns:</dt>
198 <dd> 260 <dd>
199 tuple of None and activation status (boolean) 261 tuple of None and activation status (boolean)
200 </dd> 262 </dd>
201 </dl><a NAME="ToolGenerateHashPlugin.deactivate" ID="ToolGenerateHashPlugin.deactivate"></a> 263 </dl>
264 <a NAME="ToolGenerateHashPlugin.deactivate" ID="ToolGenerateHashPlugin.deactivate"></a>
202 <h4>ToolGenerateHashPlugin.deactivate</h4> 265 <h4>ToolGenerateHashPlugin.deactivate</h4>
203 <b>deactivate</b>(<i></i>) 266 <b>deactivate</b>(<i></i>)
267
204 <p> 268 <p>
205 Public method to deactivate this plugin. 269 Public method to deactivate this plugin.
206 </p> 270 </p>
207 <div align="right"><a href="#top">Up</a></div> 271 <div align="right"><a href="#top">Up</a></div>
208 <hr /> 272 <hr />

Mercurial Repository: Hash Generation Tool

eric ide

mercurial