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 1
- ce3163531e4b
- child 16
- 091df4c07a8c
equal
deleted
inserted
replaced
| 0:8014a543718a | 1:ce3163531e4b |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>Plugin_Tools_GenerateHash.PluginToolGenerateHash</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_Tools_GenerateHash.PluginToolGenerateHash</h1> | |
| 23 <p> | |
| 24 Module implementing the 'Generate Hash' tool plug-in. | |
| 25 </p> | |
| 26 <h3>Global Attributes</h3> | |
| 27 <table> | |
| 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>shortDescription</td></tr><tr><td>version</td></tr> | |
| 29 </table> | |
| 30 <h3>Classes</h3> | |
| 31 <table> | |
| 32 <tr> | |
| 33 <td><a href="#ToolGenerateHashPlugin">ToolGenerateHashPlugin</a></td> | |
| 34 <td>Class implementing the 'Generate Hash' tool plug-in.</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="ToolGenerateHashPlugin" ID="ToolGenerateHashPlugin"></a> | |
| 43 <h2>ToolGenerateHashPlugin</h2> | |
| 44 <p> | |
| 45 Class implementing the 'Generate Hash' tool plug-in. | |
| 46 </p> | |
| 47 <h3>Derived from</h3> | |
| 48 QObject | |
| 49 <h3>Class Attributes</h3> | |
| 50 <table> | |
| 51 <tr><td>Hashes</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="#ToolGenerateHashPlugin.__init__">ToolGenerateHashPlugin</a></td> | |
| 61 <td>Constructor</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#ToolGenerateHashPlugin.__editorClosed">__editorClosed</a></td> | |
| 64 <td>Private slot called, when an editor was closed.</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#ToolGenerateHashPlugin.__editorOpened">__editorOpened</a></td> | |
| 67 <td>Private slot called, when a new editor was opened.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#ToolGenerateHashPlugin.__hashDirectory">__hashDirectory</a></td> | |
| 70 <td>Private slot to generate the hash for a directory.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#ToolGenerateHashPlugin.__hashFile">__hashFile</a></td> | |
| 73 <td>Private slot to generate the hash for a file.</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#ToolGenerateHashPlugin.__initMenus">__initMenus</a></td> | |
| 76 <td>Private method to initialize the hash generation menus.</td> | |
| 77 </tr><tr> | |
| 78 <td><a href="#ToolGenerateHashPlugin.__insertHash">__insertHash</a></td> | |
| 79 <td>Private method to insert the generated hash string.</td> | |
| 80 </tr><tr> | |
| 81 <td><a href="#ToolGenerateHashPlugin.__loadTranslator">__loadTranslator</a></td> | |
| 82 <td>Private method to load the translation file.</td> | |
| 83 </tr><tr> | |
| 84 <td><a href="#ToolGenerateHashPlugin.__populateMenu">__populateMenu</a></td> | |
| 85 <td>Private slot to populate the tools menu with our entries.</td> | |
| 86 </tr><tr> | |
| 87 <td><a href="#ToolGenerateHashPlugin.activate">activate</a></td> | |
| 88 <td>Public method to activate this plugin.</td> | |
| 89 </tr><tr> | |
| 90 <td><a href="#ToolGenerateHashPlugin.deactivate">deactivate</a></td> | |
| 91 <td>Public method to deactivate this plugin.</td> | |
| 92 </tr> | |
| 93 </table> | |
| 94 <h3>Static Methods</h3> | |
| 95 <table> | |
| 96 <tr><td>None</td></tr> | |
| 97 </table> | |
| 98 <a NAME="ToolGenerateHashPlugin.__init__" ID="ToolGenerateHashPlugin.__init__"></a> | |
| 99 <h4>ToolGenerateHashPlugin (Constructor)</h4> | |
| 100 <b>ToolGenerateHashPlugin</b>(<i>ui</i>) | |
| 101 <p> | |
| 102 Constructor | |
| 103 </p><dl> | |
| 104 <dt><i>ui</i></dt> | |
| 105 <dd> | |
| 106 reference to the user interface object (UI.UserInterface) | |
| 107 </dd> | |
| 108 </dl><a NAME="ToolGenerateHashPlugin.__editorClosed" ID="ToolGenerateHashPlugin.__editorClosed"></a> | |
| 109 <h4>ToolGenerateHashPlugin.__editorClosed</h4> | |
| 110 <b>__editorClosed</b>(<i>editor</i>) | |
| 111 <p> | |
| 112 Private slot called, when an editor was closed. | |
| 113 </p><dl> | |
| 114 <dt><i>editor</i></dt> | |
| 115 <dd> | |
| 116 reference to the editor (QScintilla.Editor) | |
| 117 </dd> | |
| 118 </dl><a NAME="ToolGenerateHashPlugin.__editorOpened" ID="ToolGenerateHashPlugin.__editorOpened"></a> | |
| 119 <h4>ToolGenerateHashPlugin.__editorOpened</h4> | |
| 120 <b>__editorOpened</b>(<i>editor</i>) | |
| 121 <p> | |
| 122 Private slot called, when a new editor was opened. | |
| 123 </p><dl> | |
| 124 <dt><i>editor</i></dt> | |
| 125 <dd> | |
| 126 reference to the new editor (QScintilla.Editor) | |
| 127 </dd> | |
| 128 </dl><a NAME="ToolGenerateHashPlugin.__hashDirectory" ID="ToolGenerateHashPlugin.__hashDirectory"></a> | |
| 129 <h4>ToolGenerateHashPlugin.__hashDirectory</h4> | |
| 130 <b>__hashDirectory</b>(<i></i>) | |
| 131 <p> | |
| 132 Private slot to generate the hash for a directory. | |
| 133 </p><a NAME="ToolGenerateHashPlugin.__hashFile" ID="ToolGenerateHashPlugin.__hashFile"></a> | |
| 134 <h4>ToolGenerateHashPlugin.__hashFile</h4> | |
| 135 <b>__hashFile</b>(<i></i>) | |
| 136 <p> | |
| 137 Private slot to generate the hash for a file. | |
| 138 </p><a NAME="ToolGenerateHashPlugin.__initMenus" ID="ToolGenerateHashPlugin.__initMenus"></a> | |
| 139 <h4>ToolGenerateHashPlugin.__initMenus</h4> | |
| 140 <b>__initMenus</b>(<i></i>) | |
| 141 <p> | |
| 142 Private method to initialize the hash generation menus. | |
| 143 </p><a NAME="ToolGenerateHashPlugin.__insertHash" ID="ToolGenerateHashPlugin.__insertHash"></a> | |
| 144 <h4>ToolGenerateHashPlugin.__insertHash</h4> | |
| 145 <b>__insertHash</b>(<i>hashStr</i>) | |
| 146 <p> | |
| 147 Private method to insert the generated hash string. | |
| 148 </p><dl> | |
| 149 <dt><i>hashStr</i></dt> | |
| 150 <dd> | |
| 151 hash string (string) | |
| 152 </dd> | |
| 153 </dl><a NAME="ToolGenerateHashPlugin.__loadTranslator" ID="ToolGenerateHashPlugin.__loadTranslator"></a> | |
| 154 <h4>ToolGenerateHashPlugin.__loadTranslator</h4> | |
| 155 <b>__loadTranslator</b>(<i></i>) | |
| 156 <p> | |
| 157 Private method to load the translation file. | |
| 158 </p><a NAME="ToolGenerateHashPlugin.__populateMenu" ID="ToolGenerateHashPlugin.__populateMenu"></a> | |
| 159 <h4>ToolGenerateHashPlugin.__populateMenu</h4> | |
| 160 <b>__populateMenu</b>(<i>name, menu</i>) | |
| 161 <p> | |
| 162 Private slot to populate the tools menu with our entries. | |
| 163 </p><dl> | |
| 164 <dt><i>name</i></dt> | |
| 165 <dd> | |
| 166 name of the menu (string) | |
| 167 </dd><dt><i>menu</i></dt> | |
| 168 <dd> | |
| 169 reference to the menu to be populated (QMenu) | |
| 170 </dd> | |
| 171 </dl><a NAME="ToolGenerateHashPlugin.activate" ID="ToolGenerateHashPlugin.activate"></a> | |
| 172 <h4>ToolGenerateHashPlugin.activate</h4> | |
| 173 <b>activate</b>(<i></i>) | |
| 174 <p> | |
| 175 Public method to activate this plugin. | |
| 176 </p><dl> | |
| 177 <dt>Returns:</dt> | |
| 178 <dd> | |
| 179 tuple of None and activation status (boolean) | |
| 180 </dd> | |
| 181 </dl><a NAME="ToolGenerateHashPlugin.deactivate" ID="ToolGenerateHashPlugin.deactivate"></a> | |
| 182 <h4>ToolGenerateHashPlugin.deactivate</h4> | |
| 183 <b>deactivate</b>(<i></i>) | |
| 184 <p> | |
| 185 Public method to deactivate this plugin. | |
| 186 </p> | |
| 187 <div align="right"><a href="#top">Up</a></div> | |
| 188 <hr /> | |
| 189 </body></html> |
