Mercurial Repositories > Print Remover Tool / file comparison
comparison: PrintRemover/Documentation/source/Plugin_Tools_Print_Remover.PluginPrintRemover.html
PrintRemover/Documentation/source/Plugin_Tools_Print_Remover.PluginPrintRemover.html
- changeset 2
- 1375fce99e3b
- child 9
- a9366d1cbef5
equal
deleted
inserted
replaced
| 1:674088a74a31 | 2:1375fce99e3b |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>Plugin_Tools_Print_Remover.PluginPrintRemover</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_Print_Remover.PluginPrintRemover</h1> | |
| 23 <p> | |
| 24 Module implementing the Print Remover 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>printRemoverPluginObject</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="#PrintRemoverPlugin">PrintRemoverPlugin</a></td> | |
| 34 <td>Class implementing the Print Remover plugin.</td> | |
| 35 </tr> | |
| 36 </table> | |
| 37 <h3>Functions</h3> | |
| 38 <table> | |
| 39 <tr> | |
| 40 <td><a href="#createPrintRemoverPage">createPrintRemoverPage</a></td> | |
| 41 <td>Module function to create the Print Remover configuration page.</td> | |
| 42 </tr><tr> | |
| 43 <td><a href="#getConfigData">getConfigData</a></td> | |
| 44 <td>Module function returning data as required by the configuration dialog.</td> | |
| 45 </tr><tr> | |
| 46 <td><a href="#prepareUninstall">prepareUninstall</a></td> | |
| 47 <td>Module function to prepare for an uninstallation.</td> | |
| 48 </tr> | |
| 49 </table> | |
| 50 <hr /><hr /> | |
| 51 <a NAME="PrintRemoverPlugin" ID="PrintRemoverPlugin"></a> | |
| 52 <h2>PrintRemoverPlugin</h2> | |
| 53 <p> | |
| 54 Class implementing the Print Remover plugin. | |
| 55 </p> | |
| 56 <h3>Derived from</h3> | |
| 57 QObject | |
| 58 <h3>Class Attributes</h3> | |
| 59 <table> | |
| 60 <tr><td>PreferencesKey</td></tr> | |
| 61 </table> | |
| 62 <h3>Class Methods</h3> | |
| 63 <table> | |
| 64 <tr><td>None</td></tr> | |
| 65 </table> | |
| 66 <h3>Methods</h3> | |
| 67 <table> | |
| 68 <tr> | |
| 69 <td><a href="#PrintRemoverPlugin.__init__">PrintRemoverPlugin</a></td> | |
| 70 <td>Constructor</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#PrintRemoverPlugin.__loadTranslator">__loadTranslator</a></td> | |
| 73 <td>Private method to load the translation file.</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#PrintRemoverPlugin.__populateMenu">__populateMenu</a></td> | |
| 76 <td>Private slot to populate the tools menu with our entries.</td> | |
| 77 </tr><tr> | |
| 78 <td><a href="#PrintRemoverPlugin.__removeLine">__removeLine</a></td> | |
| 79 <td>Private slot to remove lines starting with the selected pattern.</td> | |
| 80 </tr><tr> | |
| 81 <td><a href="#PrintRemoverPlugin.activate">activate</a></td> | |
| 82 <td>Public method to activate this plugin.</td> | |
| 83 </tr><tr> | |
| 84 <td><a href="#PrintRemoverPlugin.deactivate">deactivate</a></td> | |
| 85 <td>Public method to deactivate this plugin.</td> | |
| 86 </tr><tr> | |
| 87 <td><a href="#PrintRemoverPlugin.getPreferences">getPreferences</a></td> | |
| 88 <td>Public method to retrieve the various settings.</td> | |
| 89 </tr><tr> | |
| 90 <td><a href="#PrintRemoverPlugin.setPreferences">setPreferences</a></td> | |
| 91 <td>Public method to store the various settings.</td> | |
| 92 </tr> | |
| 93 </table> | |
| 94 <h3>Static Methods</h3> | |
| 95 <table> | |
| 96 <tr><td>None</td></tr> | |
| 97 </table> | |
| 98 <a NAME="PrintRemoverPlugin.__init__" ID="PrintRemoverPlugin.__init__"></a> | |
| 99 <h4>PrintRemoverPlugin (Constructor)</h4> | |
| 100 <b>PrintRemoverPlugin</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="PrintRemoverPlugin.__loadTranslator" ID="PrintRemoverPlugin.__loadTranslator"></a> | |
| 109 <h4>PrintRemoverPlugin.__loadTranslator</h4> | |
| 110 <b>__loadTranslator</b>(<i></i>) | |
| 111 <p> | |
| 112 Private method to load the translation file. | |
| 113 </p><a NAME="PrintRemoverPlugin.__populateMenu" ID="PrintRemoverPlugin.__populateMenu"></a> | |
| 114 <h4>PrintRemoverPlugin.__populateMenu</h4> | |
| 115 <b>__populateMenu</b>(<i>name, menu</i>) | |
| 116 <p> | |
| 117 Private slot to populate the tools menu with our entries. | |
| 118 </p><dl> | |
| 119 <dt><i>name</i></dt> | |
| 120 <dd> | |
| 121 name of the menu (string) | |
| 122 </dd><dt><i>menu</i></dt> | |
| 123 <dd> | |
| 124 reference to the menu to be populated (QMenu) | |
| 125 </dd> | |
| 126 </dl><a NAME="PrintRemoverPlugin.__removeLine" ID="PrintRemoverPlugin.__removeLine"></a> | |
| 127 <h4>PrintRemoverPlugin.__removeLine</h4> | |
| 128 <b>__removeLine</b>(<i></i>) | |
| 129 <p> | |
| 130 Private slot to remove lines starting with the selected pattern. | |
| 131 </p><a NAME="PrintRemoverPlugin.activate" ID="PrintRemoverPlugin.activate"></a> | |
| 132 <h4>PrintRemoverPlugin.activate</h4> | |
| 133 <b>activate</b>(<i></i>) | |
| 134 <p> | |
| 135 Public method to activate this plugin. | |
| 136 </p><dl> | |
| 137 <dt>Returns:</dt> | |
| 138 <dd> | |
| 139 tuple of None and activation status (boolean) | |
| 140 </dd> | |
| 141 </dl><a NAME="PrintRemoverPlugin.deactivate" ID="PrintRemoverPlugin.deactivate"></a> | |
| 142 <h4>PrintRemoverPlugin.deactivate</h4> | |
| 143 <b>deactivate</b>(<i></i>) | |
| 144 <p> | |
| 145 Public method to deactivate this plugin. | |
| 146 </p><a NAME="PrintRemoverPlugin.getPreferences" ID="PrintRemoverPlugin.getPreferences"></a> | |
| 147 <h4>PrintRemoverPlugin.getPreferences</h4> | |
| 148 <b>getPreferences</b>(<i>key</i>) | |
| 149 <p> | |
| 150 Public method to retrieve the various settings. | |
| 151 </p><dl> | |
| 152 <dt><i>key</i></dt> | |
| 153 <dd> | |
| 154 the key of the value to get (string) | |
| 155 </dd> | |
| 156 </dl><dl> | |
| 157 <dt>Returns:</dt> | |
| 158 <dd> | |
| 159 the requested setting | |
| 160 </dd> | |
| 161 </dl><a NAME="PrintRemoverPlugin.setPreferences" ID="PrintRemoverPlugin.setPreferences"></a> | |
| 162 <h4>PrintRemoverPlugin.setPreferences</h4> | |
| 163 <b>setPreferences</b>(<i>key, value</i>) | |
| 164 <p> | |
| 165 Public method to store the various settings. | |
| 166 </p><dl> | |
| 167 <dt><i>key</i></dt> | |
| 168 <dd> | |
| 169 the key of the setting to be set (string) | |
| 170 </dd><dt><i>value</i></dt> | |
| 171 <dd> | |
| 172 the value to be set | |
| 173 </dd> | |
| 174 </dl> | |
| 175 <div align="right"><a href="#top">Up</a></div> | |
| 176 <hr /><hr /> | |
| 177 <a NAME="createPrintRemoverPage" ID="createPrintRemoverPage"></a> | |
| 178 <h2>createPrintRemoverPage</h2> | |
| 179 <b>createPrintRemoverPage</b>(<i>configDlg</i>) | |
| 180 <p> | |
| 181 Module function to create the Print Remover configuration page. | |
| 182 </p><dl> | |
| 183 <dt><i>configDlg</i></dt> | |
| 184 <dd> | |
| 185 reference to the configuration dialog | |
| 186 </dd> | |
| 187 </dl><dl> | |
| 188 <dt>Returns:</dt> | |
| 189 <dd> | |
| 190 reference to the configuration page | |
| 191 </dd> | |
| 192 </dl> | |
| 193 <div align="right"><a href="#top">Up</a></div> | |
| 194 <hr /><hr /> | |
| 195 <a NAME="getConfigData" ID="getConfigData"></a> | |
| 196 <h2>getConfigData</h2> | |
| 197 <b>getConfigData</b>(<i></i>) | |
| 198 <p> | |
| 199 Module function returning data as required by the configuration dialog. | |
| 200 </p><dl> | |
| 201 <dt>Returns:</dt> | |
| 202 <dd> | |
| 203 dictionary containing the relevant data | |
| 204 </dd> | |
| 205 </dl> | |
| 206 <div align="right"><a href="#top">Up</a></div> | |
| 207 <hr /><hr /> | |
| 208 <a NAME="prepareUninstall" ID="prepareUninstall"></a> | |
| 209 <h2>prepareUninstall</h2> | |
| 210 <b>prepareUninstall</b>(<i></i>) | |
| 211 <p> | |
| 212 Module function to prepare for an uninstallation. | |
| 213 </p> | |
| 214 <div align="right"><a href="#top">Up</a></div> | |
| 215 <hr /> | |
| 216 </body></html> |
