Mercurial Repositories > eric / file comparison
comparison: eric6/Documentation/Source/eric6.Plugins.PluginVcsGit.html
eric6/Documentation/Source/eric6.Plugins.PluginVcsGit.html
- changeset 7273
- 391d6b7b1eff
- parent 7204
- cbf6d88004ce
- child 7989
- a21d673a8f99
equal
deleted
inserted
replaced
| 7272:1779dc278077 | 7273:391d6b7b1eff |
|---|---|
| 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>eric6.Plugins.PluginVcsGit</h1> | 23 <h1>eric6.Plugins.PluginVcsGit</h1> |
| 24 | |
| 23 <p> | 25 <p> |
| 24 Module implementing the Git version control plugin. | 26 Module implementing the Git version control plugin. |
| 25 </p> | 27 </p> |
| 26 <h3>Global Attributes</h3> | 28 <h3>Global Attributes</h3> |
| 29 | |
| 27 <table> | 30 <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>gitCfgPluginObject</td></tr><tr><td>longDescription</td></tr><tr><td>name</td></tr><tr><td>packageName</td></tr><tr><td>pluginType</td></tr><tr><td>pluginTypename</td></tr><tr><td>pyqtApi</td></tr><tr><td>shortDescription</td></tr><tr><td>version</td></tr> | 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>gitCfgPluginObject</td></tr><tr><td>longDescription</td></tr><tr><td>name</td></tr><tr><td>packageName</td></tr><tr><td>pluginType</td></tr><tr><td>pluginTypename</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="#VcsGitPlugin">VcsGitPlugin</a></td> | 38 <td><a href="#VcsGitPlugin">VcsGitPlugin</a></td> |
| 34 <td>Class implementing the Git version control plugin.</td> | 39 <td>Class implementing the Git version control plugin.</td> |
| 35 </tr> | 40 </tr> |
| 36 </table> | 41 </table> |
| 37 <h3>Functions</h3> | 42 <h3>Functions</h3> |
| 38 <table> | 43 |
| 44 <table> | |
| 45 | |
| 39 <tr> | 46 <tr> |
| 40 <td><a href="#clearPrivateData">clearPrivateData</a></td> | 47 <td><a href="#clearPrivateData">clearPrivateData</a></td> |
| 41 <td>Module function to clear the private data of the plug-in.</td> | 48 <td>Module function to clear the private data of the plug-in.</td> |
| 42 </tr><tr> | 49 </tr> |
| 50 <tr> | |
| 43 <td><a href="#createConfigurationPage">createConfigurationPage</a></td> | 51 <td><a href="#createConfigurationPage">createConfigurationPage</a></td> |
| 44 <td>Module function to create the configuration page.</td> | 52 <td>Module function to create the configuration page.</td> |
| 45 </tr><tr> | 53 </tr> |
| 54 <tr> | |
| 46 <td><a href="#displayString">displayString</a></td> | 55 <td><a href="#displayString">displayString</a></td> |
| 47 <td>Public function to get the display string.</td> | 56 <td>Public function to get the display string.</td> |
| 48 </tr><tr> | 57 </tr> |
| 58 <tr> | |
| 49 <td><a href="#exeDisplayData">exeDisplayData</a></td> | 59 <td><a href="#exeDisplayData">exeDisplayData</a></td> |
| 50 <td>Public method to support the display of some executable info.</td> | 60 <td>Public method to support the display of some executable info.</td> |
| 51 </tr><tr> | 61 </tr> |
| 62 <tr> | |
| 52 <td><a href="#getConfigData">getConfigData</a></td> | 63 <td><a href="#getConfigData">getConfigData</a></td> |
| 53 <td>Module function returning data as required by the configuration dialog.</td> | 64 <td>Module function returning data as required by the configuration dialog.</td> |
| 54 </tr><tr> | 65 </tr> |
| 66 <tr> | |
| 55 <td><a href="#getVcsSystemIndicator">getVcsSystemIndicator</a></td> | 67 <td><a href="#getVcsSystemIndicator">getVcsSystemIndicator</a></td> |
| 56 <td>Public function to get the indicators for this version control system.</td> | 68 <td>Public function to get the indicators for this version control system.</td> |
| 57 </tr><tr> | 69 </tr> |
| 70 <tr> | |
| 58 <td><a href="#prepareUninstall">prepareUninstall</a></td> | 71 <td><a href="#prepareUninstall">prepareUninstall</a></td> |
| 59 <td>Module function to prepare for an uninstallation.</td> | 72 <td>Module function to prepare for an uninstallation.</td> |
| 60 </tr> | 73 </tr> |
| 61 </table> | 74 </table> |
| 62 <hr /><hr /> | 75 <hr /> |
| 76 <hr /> | |
| 63 <a NAME="VcsGitPlugin" ID="VcsGitPlugin"></a> | 77 <a NAME="VcsGitPlugin" ID="VcsGitPlugin"></a> |
| 64 <h2>VcsGitPlugin</h2> | 78 <h2>VcsGitPlugin</h2> |
| 79 | |
| 65 <p> | 80 <p> |
| 66 Class implementing the Git version control plugin. | 81 Class implementing the Git version control plugin. |
| 67 </p> | 82 </p> |
| 68 <h3>Derived from</h3> | 83 <h3>Derived from</h3> |
| 69 QObject | 84 QObject |
| 70 <h3>Class Attributes</h3> | 85 <h3>Class Attributes</h3> |
| 86 | |
| 71 <table> | 87 <table> |
| 72 <tr><td>GitDefaults</td></tr> | 88 <tr><td>GitDefaults</td></tr> |
| 73 </table> | 89 </table> |
| 74 <h3>Class Methods</h3> | 90 <h3>Class Methods</h3> |
| 75 <table> | 91 |
| 92 <table> | |
| 93 | |
| 76 <tr> | 94 <tr> |
| 77 <td><a href="#VcsGitPlugin.getPreferences">getPreferences</a></td> | 95 <td><a href="#VcsGitPlugin.getPreferences">getPreferences</a></td> |
| 78 <td>Class method to retrieve the various settings.</td> | 96 <td>Class method to retrieve the various settings.</td> |
| 79 </tr><tr> | 97 </tr> |
| 98 <tr> | |
| 80 <td><a href="#VcsGitPlugin.setPreferences">setPreferences</a></td> | 99 <td><a href="#VcsGitPlugin.setPreferences">setPreferences</a></td> |
| 81 <td>Class method to store the various settings.</td> | 100 <td>Class method to store the various settings.</td> |
| 82 </tr> | 101 </tr> |
| 83 </table> | 102 </table> |
| 84 <h3>Methods</h3> | 103 <h3>Methods</h3> |
| 85 <table> | 104 |
| 105 <table> | |
| 106 | |
| 86 <tr> | 107 <tr> |
| 87 <td><a href="#VcsGitPlugin.__init__">VcsGitPlugin</a></td> | 108 <td><a href="#VcsGitPlugin.__init__">VcsGitPlugin</a></td> |
| 88 <td>Constructor</td> | 109 <td>Constructor</td> |
| 89 </tr><tr> | 110 </tr> |
| 111 <tr> | |
| 90 <td><a href="#VcsGitPlugin.__loadTranslator">__loadTranslator</a></td> | 112 <td><a href="#VcsGitPlugin.__loadTranslator">__loadTranslator</a></td> |
| 91 <td>Private method to load the translation file.</td> | 113 <td>Private method to load the translation file.</td> |
| 92 </tr><tr> | 114 </tr> |
| 115 <tr> | |
| 93 <td><a href="#VcsGitPlugin.activate">activate</a></td> | 116 <td><a href="#VcsGitPlugin.activate">activate</a></td> |
| 94 <td>Public method to activate this plugin.</td> | 117 <td>Public method to activate this plugin.</td> |
| 95 </tr><tr> | 118 </tr> |
| 119 <tr> | |
| 96 <td><a href="#VcsGitPlugin.deactivate">deactivate</a></td> | 120 <td><a href="#VcsGitPlugin.deactivate">deactivate</a></td> |
| 97 <td>Public method to deactivate this plugin.</td> | 121 <td>Public method to deactivate this plugin.</td> |
| 98 </tr><tr> | 122 </tr> |
| 123 <tr> | |
| 99 <td><a href="#VcsGitPlugin.getConfigPath">getConfigPath</a></td> | 124 <td><a href="#VcsGitPlugin.getConfigPath">getConfigPath</a></td> |
| 100 <td>Public method to get the filename of the config file.</td> | 125 <td>Public method to get the filename of the config file.</td> |
| 101 </tr><tr> | 126 </tr> |
| 127 <tr> | |
| 102 <td><a href="#VcsGitPlugin.getProjectHelper">getProjectHelper</a></td> | 128 <td><a href="#VcsGitPlugin.getProjectHelper">getProjectHelper</a></td> |
| 103 <td>Public method to get a reference to the project helper object.</td> | 129 <td>Public method to get a reference to the project helper object.</td> |
| 104 </tr><tr> | 130 </tr> |
| 131 <tr> | |
| 105 <td><a href="#VcsGitPlugin.initToolbar">initToolbar</a></td> | 132 <td><a href="#VcsGitPlugin.initToolbar">initToolbar</a></td> |
| 106 <td>Public slot to initialize the VCS toolbar.</td> | 133 <td>Public slot to initialize the VCS toolbar.</td> |
| 107 </tr><tr> | 134 </tr> |
| 135 <tr> | |
| 108 <td><a href="#VcsGitPlugin.prepareUninstall">prepareUninstall</a></td> | 136 <td><a href="#VcsGitPlugin.prepareUninstall">prepareUninstall</a></td> |
| 109 <td>Public method to prepare for an uninstallation.</td> | 137 <td>Public method to prepare for an uninstallation.</td> |
| 110 </tr><tr> | 138 </tr> |
| 139 <tr> | |
| 111 <td><a href="#VcsGitPlugin.prepareUnload">prepareUnload</a></td> | 140 <td><a href="#VcsGitPlugin.prepareUnload">prepareUnload</a></td> |
| 112 <td>Public method to prepare for an unload.</td> | 141 <td>Public method to prepare for an unload.</td> |
| 113 </tr> | 142 </tr> |
| 114 </table> | 143 </table> |
| 115 <h3>Static Methods</h3> | 144 <h3>Static Methods</h3> |
| 145 | |
| 116 <table> | 146 <table> |
| 117 <tr><td>None</td></tr> | 147 <tr><td>None</td></tr> |
| 118 </table> | 148 </table> |
| 149 | |
| 119 <a NAME="VcsGitPlugin.getPreferences" ID="VcsGitPlugin.getPreferences"></a> | 150 <a NAME="VcsGitPlugin.getPreferences" ID="VcsGitPlugin.getPreferences"></a> |
| 120 <h4>VcsGitPlugin.getPreferences (class method)</h4> | 151 <h4>VcsGitPlugin.getPreferences (class method)</h4> |
| 121 <b>getPreferences</b>(<i>key</i>) | 152 <b>getPreferences</b>(<i>key</i>) |
| 153 | |
| 122 <p> | 154 <p> |
| 123 Class method to retrieve the various settings. | 155 Class method to retrieve the various settings. |
| 124 </p><dl> | 156 </p> |
| 157 <dl> | |
| 158 | |
| 125 <dt><i>key</i></dt> | 159 <dt><i>key</i></dt> |
| 126 <dd> | 160 <dd> |
| 127 the key of the value to get | 161 the key of the value to get |
| 128 </dd> | 162 </dd> |
| 129 </dl><dl> | 163 </dl> |
| 164 <dl> | |
| 130 <dt>Returns:</dt> | 165 <dt>Returns:</dt> |
| 131 <dd> | 166 <dd> |
| 132 the requested setting | 167 the requested setting |
| 133 </dd> | 168 </dd> |
| 134 </dl><a NAME="VcsGitPlugin.setPreferences" ID="VcsGitPlugin.setPreferences"></a> | 169 </dl> |
| 170 <a NAME="VcsGitPlugin.setPreferences" ID="VcsGitPlugin.setPreferences"></a> | |
| 135 <h4>VcsGitPlugin.setPreferences (class method)</h4> | 171 <h4>VcsGitPlugin.setPreferences (class method)</h4> |
| 136 <b>setPreferences</b>(<i>key, value</i>) | 172 <b>setPreferences</b>(<i>key, value</i>) |
| 173 | |
| 137 <p> | 174 <p> |
| 138 Class method to store the various settings. | 175 Class method to store the various settings. |
| 139 </p><dl> | 176 </p> |
| 177 <dl> | |
| 178 | |
| 140 <dt><i>key</i></dt> | 179 <dt><i>key</i></dt> |
| 141 <dd> | 180 <dd> |
| 142 the key of the setting to be set | 181 the key of the setting to be set |
| 143 </dd><dt><i>value</i></dt> | 182 </dd> |
| 183 <dt><i>value</i></dt> | |
| 144 <dd> | 184 <dd> |
| 145 the value to be set | 185 the value to be set |
| 146 </dd> | 186 </dd> |
| 147 </dl><a NAME="VcsGitPlugin.__init__" ID="VcsGitPlugin.__init__"></a> | 187 </dl> |
| 188 <a NAME="VcsGitPlugin.__init__" ID="VcsGitPlugin.__init__"></a> | |
| 148 <h4>VcsGitPlugin (Constructor)</h4> | 189 <h4>VcsGitPlugin (Constructor)</h4> |
| 149 <b>VcsGitPlugin</b>(<i>ui</i>) | 190 <b>VcsGitPlugin</b>(<i>ui</i>) |
| 191 | |
| 150 <p> | 192 <p> |
| 151 Constructor | 193 Constructor |
| 152 </p><dl> | 194 </p> |
| 195 <dl> | |
| 196 | |
| 153 <dt><i>ui</i></dt> | 197 <dt><i>ui</i></dt> |
| 154 <dd> | 198 <dd> |
| 155 reference to the user interface object (UI.UserInterface) | 199 reference to the user interface object (UI.UserInterface) |
| 156 </dd> | 200 </dd> |
| 157 </dl><a NAME="VcsGitPlugin.__loadTranslator" ID="VcsGitPlugin.__loadTranslator"></a> | 201 </dl> |
| 202 <a NAME="VcsGitPlugin.__loadTranslator" ID="VcsGitPlugin.__loadTranslator"></a> | |
| 158 <h4>VcsGitPlugin.__loadTranslator</h4> | 203 <h4>VcsGitPlugin.__loadTranslator</h4> |
| 159 <b>__loadTranslator</b>(<i></i>) | 204 <b>__loadTranslator</b>(<i></i>) |
| 205 | |
| 160 <p> | 206 <p> |
| 161 Private method to load the translation file. | 207 Private method to load the translation file. |
| 162 </p><a NAME="VcsGitPlugin.activate" ID="VcsGitPlugin.activate"></a> | 208 </p> |
| 209 <a NAME="VcsGitPlugin.activate" ID="VcsGitPlugin.activate"></a> | |
| 163 <h4>VcsGitPlugin.activate</h4> | 210 <h4>VcsGitPlugin.activate</h4> |
| 164 <b>activate</b>(<i></i>) | 211 <b>activate</b>(<i></i>) |
| 212 | |
| 165 <p> | 213 <p> |
| 166 Public method to activate this plugin. | 214 Public method to activate this plugin. |
| 167 </p><dl> | 215 </p> |
| 216 <dl> | |
| 168 <dt>Returns:</dt> | 217 <dt>Returns:</dt> |
| 169 <dd> | 218 <dd> |
| 170 tuple of reference to instantiated viewmanager and | 219 tuple of reference to instantiated viewmanager and |
| 171 activation status (boolean) | 220 activation status (boolean) |
| 172 </dd> | 221 </dd> |
| 173 </dl><a NAME="VcsGitPlugin.deactivate" ID="VcsGitPlugin.deactivate"></a> | 222 </dl> |
| 223 <a NAME="VcsGitPlugin.deactivate" ID="VcsGitPlugin.deactivate"></a> | |
| 174 <h4>VcsGitPlugin.deactivate</h4> | 224 <h4>VcsGitPlugin.deactivate</h4> |
| 175 <b>deactivate</b>(<i></i>) | 225 <b>deactivate</b>(<i></i>) |
| 226 | |
| 176 <p> | 227 <p> |
| 177 Public method to deactivate this plugin. | 228 Public method to deactivate this plugin. |
| 178 </p><a NAME="VcsGitPlugin.getConfigPath" ID="VcsGitPlugin.getConfigPath"></a> | 229 </p> |
| 230 <a NAME="VcsGitPlugin.getConfigPath" ID="VcsGitPlugin.getConfigPath"></a> | |
| 179 <h4>VcsGitPlugin.getConfigPath</h4> | 231 <h4>VcsGitPlugin.getConfigPath</h4> |
| 180 <b>getConfigPath</b>(<i></i>) | 232 <b>getConfigPath</b>(<i></i>) |
| 233 | |
| 181 <p> | 234 <p> |
| 182 Public method to get the filename of the config file. | 235 Public method to get the filename of the config file. |
| 183 </p><dl> | 236 </p> |
| 237 <dl> | |
| 184 <dt>Returns:</dt> | 238 <dt>Returns:</dt> |
| 185 <dd> | 239 <dd> |
| 186 filename of the config file (string) | 240 filename of the config file (string) |
| 187 </dd> | 241 </dd> |
| 188 </dl><a NAME="VcsGitPlugin.getProjectHelper" ID="VcsGitPlugin.getProjectHelper"></a> | 242 </dl> |
| 243 <a NAME="VcsGitPlugin.getProjectHelper" ID="VcsGitPlugin.getProjectHelper"></a> | |
| 189 <h4>VcsGitPlugin.getProjectHelper</h4> | 244 <h4>VcsGitPlugin.getProjectHelper</h4> |
| 190 <b>getProjectHelper</b>(<i></i>) | 245 <b>getProjectHelper</b>(<i></i>) |
| 246 | |
| 191 <p> | 247 <p> |
| 192 Public method to get a reference to the project helper object. | 248 Public method to get a reference to the project helper object. |
| 193 </p><dl> | 249 </p> |
| 250 <dl> | |
| 194 <dt>Returns:</dt> | 251 <dt>Returns:</dt> |
| 195 <dd> | 252 <dd> |
| 196 reference to the project helper object | 253 reference to the project helper object |
| 197 </dd> | 254 </dd> |
| 198 </dl><a NAME="VcsGitPlugin.initToolbar" ID="VcsGitPlugin.initToolbar"></a> | 255 </dl> |
| 256 <a NAME="VcsGitPlugin.initToolbar" ID="VcsGitPlugin.initToolbar"></a> | |
| 199 <h4>VcsGitPlugin.initToolbar</h4> | 257 <h4>VcsGitPlugin.initToolbar</h4> |
| 200 <b>initToolbar</b>(<i>ui, toolbarManager</i>) | 258 <b>initToolbar</b>(<i>ui, toolbarManager</i>) |
| 259 | |
| 201 <p> | 260 <p> |
| 202 Public slot to initialize the VCS toolbar. | 261 Public slot to initialize the VCS toolbar. |
| 203 </p><dl> | 262 </p> |
| 263 <dl> | |
| 264 | |
| 204 <dt><i>ui</i></dt> | 265 <dt><i>ui</i></dt> |
| 205 <dd> | 266 <dd> |
| 206 reference to the main window (UserInterface) | 267 reference to the main window (UserInterface) |
| 207 </dd><dt><i>toolbarManager</i></dt> | 268 </dd> |
| 269 <dt><i>toolbarManager</i></dt> | |
| 208 <dd> | 270 <dd> |
| 209 reference to a toolbar manager object | 271 reference to a toolbar manager object |
| 210 (E5ToolBarManager) | 272 (E5ToolBarManager) |
| 211 </dd> | 273 </dd> |
| 212 </dl><a NAME="VcsGitPlugin.prepareUninstall" ID="VcsGitPlugin.prepareUninstall"></a> | 274 </dl> |
| 275 <a NAME="VcsGitPlugin.prepareUninstall" ID="VcsGitPlugin.prepareUninstall"></a> | |
| 213 <h4>VcsGitPlugin.prepareUninstall</h4> | 276 <h4>VcsGitPlugin.prepareUninstall</h4> |
| 214 <b>prepareUninstall</b>(<i></i>) | 277 <b>prepareUninstall</b>(<i></i>) |
| 278 | |
| 215 <p> | 279 <p> |
| 216 Public method to prepare for an uninstallation. | 280 Public method to prepare for an uninstallation. |
| 217 </p><a NAME="VcsGitPlugin.prepareUnload" ID="VcsGitPlugin.prepareUnload"></a> | 281 </p> |
| 282 <a NAME="VcsGitPlugin.prepareUnload" ID="VcsGitPlugin.prepareUnload"></a> | |
| 218 <h4>VcsGitPlugin.prepareUnload</h4> | 283 <h4>VcsGitPlugin.prepareUnload</h4> |
| 219 <b>prepareUnload</b>(<i></i>) | 284 <b>prepareUnload</b>(<i></i>) |
| 285 | |
| 220 <p> | 286 <p> |
| 221 Public method to prepare for an unload. | 287 Public method to prepare for an unload. |
| 222 </p> | 288 </p> |
| 223 <div align="right"><a href="#top">Up</a></div> | 289 <div align="right"><a href="#top">Up</a></div> |
| 224 <hr /><hr /> | 290 <hr /> |
| 291 <hr /> | |
| 225 <a NAME="clearPrivateData" ID="clearPrivateData"></a> | 292 <a NAME="clearPrivateData" ID="clearPrivateData"></a> |
| 226 <h2>clearPrivateData</h2> | 293 <h2>clearPrivateData</h2> |
| 227 <b>clearPrivateData</b>(<i></i>) | 294 <b>clearPrivateData</b>(<i></i>) |
| 295 | |
| 228 <p> | 296 <p> |
| 229 Module function to clear the private data of the plug-in. | 297 Module function to clear the private data of the plug-in. |
| 230 </p> | 298 </p> |
| 231 <div align="right"><a href="#top">Up</a></div> | 299 <div align="right"><a href="#top">Up</a></div> |
| 232 <hr /><hr /> | 300 <hr /> |
| 301 <hr /> | |
| 233 <a NAME="createConfigurationPage" ID="createConfigurationPage"></a> | 302 <a NAME="createConfigurationPage" ID="createConfigurationPage"></a> |
| 234 <h2>createConfigurationPage</h2> | 303 <h2>createConfigurationPage</h2> |
| 235 <b>createConfigurationPage</b>(<i>configDlg</i>) | 304 <b>createConfigurationPage</b>(<i>configDlg</i>) |
| 305 | |
| 236 <p> | 306 <p> |
| 237 Module function to create the configuration page. | 307 Module function to create the configuration page. |
| 238 </p><dl> | 308 </p> |
| 309 <dl> | |
| 310 | |
| 239 <dt><i>configDlg</i></dt> | 311 <dt><i>configDlg</i></dt> |
| 240 <dd> | 312 <dd> |
| 241 reference to the configuration dialog (QDialog) | 313 reference to the configuration dialog (QDialog) |
| 242 </dd> | 314 </dd> |
| 243 </dl><dl> | 315 </dl> |
| 316 <dl> | |
| 244 <dt>Returns:</dt> | 317 <dt>Returns:</dt> |
| 245 <dd> | 318 <dd> |
| 246 reference to the configuration page | 319 reference to the configuration page |
| 247 </dd> | 320 </dd> |
| 248 </dl> | 321 </dl> |
| 249 <div align="right"><a href="#top">Up</a></div> | 322 <div align="right"><a href="#top">Up</a></div> |
| 250 <hr /><hr /> | 323 <hr /> |
| 324 <hr /> | |
| 251 <a NAME="displayString" ID="displayString"></a> | 325 <a NAME="displayString" ID="displayString"></a> |
| 252 <h2>displayString</h2> | 326 <h2>displayString</h2> |
| 253 <b>displayString</b>(<i></i>) | 327 <b>displayString</b>(<i></i>) |
| 328 | |
| 254 <p> | 329 <p> |
| 255 Public function to get the display string. | 330 Public function to get the display string. |
| 256 </p><dl> | 331 </p> |
| 332 <dl> | |
| 257 <dt>Returns:</dt> | 333 <dt>Returns:</dt> |
| 258 <dd> | 334 <dd> |
| 259 display string (string) | 335 display string (string) |
| 260 </dd> | 336 </dd> |
| 261 </dl> | 337 </dl> |
| 262 <div align="right"><a href="#top">Up</a></div> | 338 <div align="right"><a href="#top">Up</a></div> |
| 263 <hr /><hr /> | 339 <hr /> |
| 340 <hr /> | |
| 264 <a NAME="exeDisplayData" ID="exeDisplayData"></a> | 341 <a NAME="exeDisplayData" ID="exeDisplayData"></a> |
| 265 <h2>exeDisplayData</h2> | 342 <h2>exeDisplayData</h2> |
| 266 <b>exeDisplayData</b>(<i></i>) | 343 <b>exeDisplayData</b>(<i></i>) |
| 344 | |
| 267 <p> | 345 <p> |
| 268 Public method to support the display of some executable info. | 346 Public method to support the display of some executable info. |
| 269 </p><dl> | 347 </p> |
| 348 <dl> | |
| 270 <dt>Returns:</dt> | 349 <dt>Returns:</dt> |
| 271 <dd> | 350 <dd> |
| 272 dictionary containing the data to query the presence of | 351 dictionary containing the data to query the presence of |
| 273 the executable | 352 the executable |
| 274 </dd> | 353 </dd> |
| 275 </dl> | 354 </dl> |
| 276 <div align="right"><a href="#top">Up</a></div> | 355 <div align="right"><a href="#top">Up</a></div> |
| 277 <hr /><hr /> | 356 <hr /> |
| 357 <hr /> | |
| 278 <a NAME="getConfigData" ID="getConfigData"></a> | 358 <a NAME="getConfigData" ID="getConfigData"></a> |
| 279 <h2>getConfigData</h2> | 359 <h2>getConfigData</h2> |
| 280 <b>getConfigData</b>(<i></i>) | 360 <b>getConfigData</b>(<i></i>) |
| 361 | |
| 281 <p> | 362 <p> |
| 282 Module function returning data as required by the configuration dialog. | 363 Module function returning data as required by the configuration dialog. |
| 283 </p><dl> | 364 </p> |
| 365 <dl> | |
| 284 <dt>Returns:</dt> | 366 <dt>Returns:</dt> |
| 285 <dd> | 367 <dd> |
| 286 dictionary with key "zzz_gitPage" containing the relevant | 368 dictionary with key "zzz_gitPage" containing the relevant |
| 287 data | 369 data |
| 288 </dd> | 370 </dd> |
| 289 </dl> | 371 </dl> |
| 290 <div align="right"><a href="#top">Up</a></div> | 372 <div align="right"><a href="#top">Up</a></div> |
| 291 <hr /><hr /> | 373 <hr /> |
| 374 <hr /> | |
| 292 <a NAME="getVcsSystemIndicator" ID="getVcsSystemIndicator"></a> | 375 <a NAME="getVcsSystemIndicator" ID="getVcsSystemIndicator"></a> |
| 293 <h2>getVcsSystemIndicator</h2> | 376 <h2>getVcsSystemIndicator</h2> |
| 294 <b>getVcsSystemIndicator</b>(<i></i>) | 377 <b>getVcsSystemIndicator</b>(<i></i>) |
| 378 | |
| 295 <p> | 379 <p> |
| 296 Public function to get the indicators for this version control system. | 380 Public function to get the indicators for this version control system. |
| 297 </p><dl> | 381 </p> |
| 382 <dl> | |
| 298 <dt>Returns:</dt> | 383 <dt>Returns:</dt> |
| 299 <dd> | 384 <dd> |
| 300 dictionary with indicator as key and a tuple with the vcs name | 385 dictionary with indicator as key and a tuple with the vcs name |
| 301 (string) and vcs display string (string) | 386 (string) and vcs display string (string) |
| 302 </dd> | 387 </dd> |
| 303 </dl> | 388 </dl> |
| 304 <div align="right"><a href="#top">Up</a></div> | 389 <div align="right"><a href="#top">Up</a></div> |
| 305 <hr /><hr /> | 390 <hr /> |
| 391 <hr /> | |
| 306 <a NAME="prepareUninstall" ID="prepareUninstall"></a> | 392 <a NAME="prepareUninstall" ID="prepareUninstall"></a> |
| 307 <h2>prepareUninstall</h2> | 393 <h2>prepareUninstall</h2> |
| 308 <b>prepareUninstall</b>(<i></i>) | 394 <b>prepareUninstall</b>(<i></i>) |
| 395 | |
| 309 <p> | 396 <p> |
| 310 Module function to prepare for an uninstallation. | 397 Module function to prepare for an uninstallation. |
| 311 </p> | 398 </p> |
| 312 <div align="right"><a href="#top">Up</a></div> | 399 <div align="right"><a href="#top">Up</a></div> |
| 313 <hr /> | 400 <hr /> |
