262 <td>Public method to load just the documentation sets plugins.</td> |
262 <td>Public method to load just the documentation sets plugins.</td> |
263 </tr> |
263 </tr> |
264 <tr> |
264 <tr> |
265 <td><a href="#PluginManager.loadPlugin">loadPlugin</a></td> |
265 <td><a href="#PluginManager.loadPlugin">loadPlugin</a></td> |
266 <td>Public method to load a plugin module.</td> |
266 <td>Public method to load a plugin module.</td> |
|
267 </tr> |
|
268 <tr> |
|
269 <td><a href="#PluginManager.pipInstall">pipInstall</a></td> |
|
270 <td>Public method to install the given package via pip.</td> |
267 </tr> |
271 </tr> |
268 <tr> |
272 <tr> |
269 <td><a href="#PluginManager.preferencesChanged">preferencesChanged</a></td> |
273 <td><a href="#PluginManager.preferencesChanged">preferencesChanged</a></td> |
270 <td>Public slot to react to changes in configuration.</td> |
274 <td>Public slot to react to changes in configuration.</td> |
271 </tr> |
275 </tr> |
1090 plug-in modules |
1094 plug-in modules |
1091 </dd> |
1095 </dd> |
1092 </dl> |
1096 </dl> |
1093 <a NAME="PluginManager.loadPlugin" ID="PluginManager.loadPlugin"></a> |
1097 <a NAME="PluginManager.loadPlugin" ID="PluginManager.loadPlugin"></a> |
1094 <h4>PluginManager.loadPlugin</h4> |
1098 <h4>PluginManager.loadPlugin</h4> |
1095 <b>loadPlugin</b>(<i>name, directory, reload_=False</i>) |
1099 <b>loadPlugin</b>(<i>name, directory, reload_=False, install=False</i>) |
1096 |
1100 |
1097 <p> |
1101 <p> |
1098 Public method to load a plugin module. |
1102 Public method to load a plugin module. |
1099 </p> |
1103 </p> |
1100 <p> |
1104 <p> |
1103 basic validity checks are performed as well. Modules failing these |
1107 basic validity checks are performed as well. Modules failing these |
1104 checks are added to the failed modules list. |
1108 checks are added to the failed modules list. |
1105 </p> |
1109 </p> |
1106 <dl> |
1110 <dl> |
1107 |
1111 |
1108 <dt><i>name</i></dt> |
1112 <dt><i>name</i> (str)</dt> |
1109 <dd> |
1113 <dd> |
1110 name of the module to be loaded (string) |
1114 name of the module to be loaded |
1111 </dd> |
1115 </dd> |
1112 <dt><i>directory</i></dt> |
1116 <dt><i>directory</i> (str)</dt> |
1113 <dd> |
1117 <dd> |
1114 name of the plugin directory (string) |
1118 name of the plugin directory |
1115 </dd> |
1119 </dd> |
1116 <dt><i>reload_</i></dt> |
1120 <dt><i>reload_</i> (bool)</dt> |
1117 <dd> |
1121 <dd> |
1118 flag indicating to reload the module (boolean) |
1122 flag indicating to reload the module |
|
1123 </dd> |
|
1124 <dt><i>install</i> (bool)</dt> |
|
1125 <dd> |
|
1126 flag indicating a load operation as part of an |
|
1127 installation process |
1119 </dd> |
1128 </dd> |
1120 </dl> |
1129 </dl> |
1121 <dl> |
1130 <dl> |
1122 |
1131 |
1123 <dt>Raises <b>PluginLoadError</b>:</dt> |
1132 <dt>Raises <b>PluginLoadError</b>:</dt> |
1124 <dd> |
1133 <dd> |
1125 raised to indicate an issue loading |
1134 raised to indicate an issue loading |
1126 the plug-in |
1135 the plug-in |
|
1136 </dd> |
|
1137 </dl> |
|
1138 <a NAME="PluginManager.pipInstall" ID="PluginManager.pipInstall"></a> |
|
1139 <h4>PluginManager.pipInstall</h4> |
|
1140 <b>pipInstall</b>(<i>packages</i>) |
|
1141 |
|
1142 <p> |
|
1143 Public method to install the given package via pip. |
|
1144 </p> |
|
1145 <dl> |
|
1146 |
|
1147 <dt><i>packages</i> (list of str)</dt> |
|
1148 <dd> |
|
1149 list of packages to install |
1127 </dd> |
1150 </dd> |
1128 </dl> |
1151 </dl> |
1129 <a NAME="PluginManager.preferencesChanged" ID="PluginManager.preferencesChanged"></a> |
1152 <a NAME="PluginManager.preferencesChanged" ID="PluginManager.preferencesChanged"></a> |
1130 <h4>PluginManager.preferencesChanged</h4> |
1153 <h4>PluginManager.preferencesChanged</h4> |
1131 <b>preferencesChanged</b>(<i></i>) |
1154 <b>preferencesChanged</b>(<i></i>) |