Mercurial Repositories > Eric Assistant / file comparison

comparison: AssistantEric/Documentation/source/Plugin_Assistant_Eric.PluginAssistantEric.html

AssistantEric/Documentation/source/Plugin_Assistant_Eric.PluginAssistantEric.html

changeset 163
842fce9b31ce
parent 138
e5f860436ab9
child 177
25cb41783971
equal deleted inserted replaced
162:db992524e3f5 163:842fce9b31ce
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_Assistant_Eric.PluginAssistantEric</h1> 23 <h1>Plugin_Assistant_Eric.PluginAssistantEric</h1>
24
23 <p> 25 <p>
24 Module implementing the Eric assistant plugin. 26 Module implementing the Eric assistant plugin.
25 </p> 27 </p>
26 <h3>Global Attributes</h3> 28 <h3>Global Attributes</h3>
27 <table> 29
28 <tr><td>assistantEricPluginObject</td></tr><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>assistantEricPluginObject</td></tr><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="#AssistantEricPlugin">AssistantEricPlugin</a></td> 38 <td><a href="#AssistantEricPlugin">AssistantEricPlugin</a></td>
34 <td>Class implementing the Eric assistant plugin.</td> 39 <td>Class implementing the Eric assistant 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="#createAutoCompletionPage">createAutoCompletionPage</a></td> 47 <td><a href="#createAutoCompletionPage">createAutoCompletionPage</a></td>
41 <td>Module function to create the autocompletion configuration page.</td> 48 <td>Module function to create the autocompletion configuration page.</td>
42 </tr><tr> 49 </tr>
50 <tr>
43 <td><a href="#createCallTipsPage">createCallTipsPage</a></td> 51 <td><a href="#createCallTipsPage">createCallTipsPage</a></td>
44 <td>Module function to create the calltips configuration page.</td> 52 <td>Module function to create the calltips configuration page.</td>
45 </tr><tr> 53 </tr>
54 <tr>
46 <td><a href="#getConfigData">getConfigData</a></td> 55 <td><a href="#getConfigData">getConfigData</a></td>
47 <td>Module function returning data as required by the configuration dialog.</td> 56 <td>Module function returning data as required by the configuration dialog.</td>
48 </tr><tr> 57 </tr>
58 <tr>
49 <td><a href="#prepareUninstall">prepareUninstall</a></td> 59 <td><a href="#prepareUninstall">prepareUninstall</a></td>
50 <td>Module function to prepare for an uninstallation.</td> 60 <td>Module function to prepare for an uninstallation.</td>
51 </tr> 61 </tr>
52 </table> 62 </table>
53 <hr /><hr /> 63 <hr />
64 <hr />
54 <a NAME="AssistantEricPlugin" ID="AssistantEricPlugin"></a> 65 <a NAME="AssistantEricPlugin" ID="AssistantEricPlugin"></a>
55 <h2>AssistantEricPlugin</h2> 66 <h2>AssistantEricPlugin</h2>
67
56 <p> 68 <p>
57 Class implementing the Eric assistant plugin. 69 Class implementing the Eric assistant plugin.
58 </p> 70 </p>
59 <h3>Derived from</h3> 71 <h3>Derived from</h3>
60 QObject 72 QObject
61 <h3>Class Attributes</h3> 73 <h3>Class Attributes</h3>
74
62 <table> 75 <table>
63 <tr><td>PreferencesKey</td></tr> 76 <tr><td>PreferencesKey</td></tr>
64 </table> 77 </table>
65 <h3>Class Methods</h3> 78 <h3>Class Methods</h3>
79
66 <table> 80 <table>
67 <tr><td>None</td></tr> 81 <tr><td>None</td></tr>
68 </table> 82 </table>
69 <h3>Methods</h3> 83 <h3>Methods</h3>
70 <table> 84
85 <table>
86
71 <tr> 87 <tr>
72 <td><a href="#AssistantEricPlugin.__init__">AssistantEricPlugin</a></td> 88 <td><a href="#AssistantEricPlugin.__init__">AssistantEricPlugin</a></td>
73 <td>Constructor</td> 89 <td>Constructor</td>
74 </tr><tr> 90 </tr>
91 <tr>
75 <td><a href="#AssistantEricPlugin.__checkQSql">__checkQSql</a></td> 92 <td><a href="#AssistantEricPlugin.__checkQSql">__checkQSql</a></td>
76 <td>Private method to perform some checks on QSql.</td> 93 <td>Private method to perform some checks on QSql.</td>
77 </tr><tr> 94 </tr>
95 <tr>
78 <td><a href="#AssistantEricPlugin.__initialize">__initialize</a></td> 96 <td><a href="#AssistantEricPlugin.__initialize">__initialize</a></td>
79 <td>Private slot to (re)initialize the plugin.</td> 97 <td>Private slot to (re)initialize the plugin.</td>
80 </tr><tr> 98 </tr>
99 <tr>
81 <td><a href="#AssistantEricPlugin.__loadTranslator">__loadTranslator</a></td> 100 <td><a href="#AssistantEricPlugin.__loadTranslator">__loadTranslator</a></td>
82 <td>Private method to load the translation file.</td> 101 <td>Private method to load the translation file.</td>
83 </tr><tr> 102 </tr>
103 <tr>
84 <td><a href="#AssistantEricPlugin.activate">activate</a></td> 104 <td><a href="#AssistantEricPlugin.activate">activate</a></td>
85 <td>Public method to activate this plugin.</td> 105 <td>Public method to activate this plugin.</td>
86 </tr><tr> 106 </tr>
107 <tr>
87 <td><a href="#AssistantEricPlugin.deactivate">deactivate</a></td> 108 <td><a href="#AssistantEricPlugin.deactivate">deactivate</a></td>
88 <td>Public method to deactivate this plugin.</td> 109 <td>Public method to deactivate this plugin.</td>
89 </tr><tr> 110 </tr>
111 <tr>
90 <td><a href="#AssistantEricPlugin.getPreferences">getPreferences</a></td> 112 <td><a href="#AssistantEricPlugin.getPreferences">getPreferences</a></td>
91 <td>Public method to retrieve the various refactoring settings.</td> 113 <td>Public method to retrieve the various refactoring settings.</td>
92 </tr><tr> 114 </tr>
115 <tr>
93 <td><a href="#AssistantEricPlugin.setPreferences">setPreferences</a></td> 116 <td><a href="#AssistantEricPlugin.setPreferences">setPreferences</a></td>
94 <td>Public method to store the various refactoring settings.</td> 117 <td>Public method to store the various refactoring settings.</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="AssistantEricPlugin.__init__" ID="AssistantEricPlugin.__init__"></a> 126 <a NAME="AssistantEricPlugin.__init__" ID="AssistantEricPlugin.__init__"></a>
102 <h4>AssistantEricPlugin (Constructor)</h4> 127 <h4>AssistantEricPlugin (Constructor)</h4>
103 <b>AssistantEricPlugin</b>(<i>ui</i>) 128 <b>AssistantEricPlugin</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="AssistantEricPlugin.__checkQSql" ID="AssistantEricPlugin.__checkQSql"></a> 139 </dl>
140 <a NAME="AssistantEricPlugin.__checkQSql" ID="AssistantEricPlugin.__checkQSql"></a>
112 <h4>AssistantEricPlugin.__checkQSql</h4> 141 <h4>AssistantEricPlugin.__checkQSql</h4>
113 <b>__checkQSql</b>(<i></i>) 142 <b>__checkQSql</b>(<i></i>)
143
114 <p> 144 <p>
115 Private method to perform some checks on QSql. 145 Private method to perform some checks on QSql.
116 </p><dl> 146 </p>
147 <dl>
117 <dt>Returns:</dt> 148 <dt>Returns:</dt>
118 <dd> 149 <dd>
119 flag indicating QSql is ok (boolean) 150 flag indicating QSql is ok (boolean)
120 </dd> 151 </dd>
121 </dl><a NAME="AssistantEricPlugin.__initialize" ID="AssistantEricPlugin.__initialize"></a> 152 </dl>
153 <a NAME="AssistantEricPlugin.__initialize" ID="AssistantEricPlugin.__initialize"></a>
122 <h4>AssistantEricPlugin.__initialize</h4> 154 <h4>AssistantEricPlugin.__initialize</h4>
123 <b>__initialize</b>(<i></i>) 155 <b>__initialize</b>(<i></i>)
156
124 <p> 157 <p>
125 Private slot to (re)initialize the plugin. 158 Private slot to (re)initialize the plugin.
126 </p><a NAME="AssistantEricPlugin.__loadTranslator" ID="AssistantEricPlugin.__loadTranslator"></a> 159 </p>
160 <a NAME="AssistantEricPlugin.__loadTranslator" ID="AssistantEricPlugin.__loadTranslator"></a>
127 <h4>AssistantEricPlugin.__loadTranslator</h4> 161 <h4>AssistantEricPlugin.__loadTranslator</h4>
128 <b>__loadTranslator</b>(<i></i>) 162 <b>__loadTranslator</b>(<i></i>)
163
129 <p> 164 <p>
130 Private method to load the translation file. 165 Private method to load the translation file.
131 </p><a NAME="AssistantEricPlugin.activate" ID="AssistantEricPlugin.activate"></a> 166 </p>
167 <a NAME="AssistantEricPlugin.activate" ID="AssistantEricPlugin.activate"></a>
132 <h4>AssistantEricPlugin.activate</h4> 168 <h4>AssistantEricPlugin.activate</h4>
133 <b>activate</b>(<i></i>) 169 <b>activate</b>(<i></i>)
170
134 <p> 171 <p>
135 Public method to activate this plugin. 172 Public method to activate this plugin.
136 </p><dl> 173 </p>
174 <dl>
137 <dt>Returns:</dt> 175 <dt>Returns:</dt>
138 <dd> 176 <dd>
139 tuple of None and activation status (boolean) 177 tuple of None and activation status (boolean)
140 </dd> 178 </dd>
141 </dl><a NAME="AssistantEricPlugin.deactivate" ID="AssistantEricPlugin.deactivate"></a> 179 </dl>
180 <a NAME="AssistantEricPlugin.deactivate" ID="AssistantEricPlugin.deactivate"></a>
142 <h4>AssistantEricPlugin.deactivate</h4> 181 <h4>AssistantEricPlugin.deactivate</h4>
143 <b>deactivate</b>(<i></i>) 182 <b>deactivate</b>(<i></i>)
183
144 <p> 184 <p>
145 Public method to deactivate this plugin. 185 Public method to deactivate this plugin.
146 </p><a NAME="AssistantEricPlugin.getPreferences" ID="AssistantEricPlugin.getPreferences"></a> 186 </p>
187 <a NAME="AssistantEricPlugin.getPreferences" ID="AssistantEricPlugin.getPreferences"></a>
147 <h4>AssistantEricPlugin.getPreferences</h4> 188 <h4>AssistantEricPlugin.getPreferences</h4>
148 <b>getPreferences</b>(<i>key</i>) 189 <b>getPreferences</b>(<i>key</i>)
190
149 <p> 191 <p>
150 Public method to retrieve the various refactoring settings. 192 Public method to retrieve the various refactoring settings.
151 </p><dl> 193 </p>
194 <dl>
195
152 <dt><i>key</i></dt> 196 <dt><i>key</i></dt>
153 <dd> 197 <dd>
154 the key of the value to get 198 the key of the value to get
155 </dd> 199 </dd>
156 </dl><dl> 200 </dl>
201 <dl>
157 <dt>Returns:</dt> 202 <dt>Returns:</dt>
158 <dd> 203 <dd>
159 the requested refactoring setting 204 the requested refactoring setting
160 </dd> 205 </dd>
161 </dl><a NAME="AssistantEricPlugin.setPreferences" ID="AssistantEricPlugin.setPreferences"></a> 206 </dl>
207 <a NAME="AssistantEricPlugin.setPreferences" ID="AssistantEricPlugin.setPreferences"></a>
162 <h4>AssistantEricPlugin.setPreferences</h4> 208 <h4>AssistantEricPlugin.setPreferences</h4>
163 <b>setPreferences</b>(<i>key, value</i>) 209 <b>setPreferences</b>(<i>key, value</i>)
210
164 <p> 211 <p>
165 Public method to store the various refactoring settings. 212 Public method to store the various refactoring settings.
166 </p><dl> 213 </p>
214 <dl>
215
167 <dt><i>key</i></dt> 216 <dt><i>key</i></dt>
168 <dd> 217 <dd>
169 the key of the setting to be set (string) 218 the key of the setting to be set (string)
170 </dd><dt><i>value</i></dt> 219 </dd>
220 <dt><i>value</i></dt>
171 <dd> 221 <dd>
172 the value to be set 222 the value to be set
173 </dd> 223 </dd>
174 </dl> 224 </dl>
175 <div align="right"><a href="#top">Up</a></div> 225 <div align="right"><a href="#top">Up</a></div>
176 <hr /><hr /> 226 <hr />
227 <hr />
177 <a NAME="createAutoCompletionPage" ID="createAutoCompletionPage"></a> 228 <a NAME="createAutoCompletionPage" ID="createAutoCompletionPage"></a>
178 <h2>createAutoCompletionPage</h2> 229 <h2>createAutoCompletionPage</h2>
179 <b>createAutoCompletionPage</b>(<i>configDlg</i>) 230 <b>createAutoCompletionPage</b>(<i>configDlg</i>)
231
180 <p> 232 <p>
181 Module function to create the autocompletion configuration page. 233 Module function to create the autocompletion configuration page.
182 </p><dl> 234 </p>
235 <dl>
236
183 <dt><i>configDlg</i></dt> 237 <dt><i>configDlg</i></dt>
184 <dd> 238 <dd>
185 reference to the configuration dialog 239 reference to the configuration dialog
186 </dd> 240 </dd>
187 </dl><dl> 241 </dl>
242 <dl>
188 <dt>Returns:</dt> 243 <dt>Returns:</dt>
189 <dd> 244 <dd>
190 reference to the configuration page 245 reference to the configuration page
191 </dd> 246 </dd>
192 </dl> 247 </dl>
193 <div align="right"><a href="#top">Up</a></div> 248 <div align="right"><a href="#top">Up</a></div>
194 <hr /><hr /> 249 <hr />
250 <hr />
195 <a NAME="createCallTipsPage" ID="createCallTipsPage"></a> 251 <a NAME="createCallTipsPage" ID="createCallTipsPage"></a>
196 <h2>createCallTipsPage</h2> 252 <h2>createCallTipsPage</h2>
197 <b>createCallTipsPage</b>(<i>configDlg</i>) 253 <b>createCallTipsPage</b>(<i>configDlg</i>)
254
198 <p> 255 <p>
199 Module function to create the calltips configuration page. 256 Module function to create the calltips configuration page.
200 </p><dl> 257 </p>
258 <dl>
259
201 <dt><i>configDlg</i></dt> 260 <dt><i>configDlg</i></dt>
202 <dd> 261 <dd>
203 reference to the configuration dialog 262 reference to the configuration dialog
204 </dd> 263 </dd>
205 </dl><dl> 264 </dl>
265 <dl>
206 <dt>Returns:</dt> 266 <dt>Returns:</dt>
207 <dd> 267 <dd>
208 reference to the configuration page 268 reference to the configuration page
209 </dd> 269 </dd>
210 </dl> 270 </dl>
211 <div align="right"><a href="#top">Up</a></div> 271 <div align="right"><a href="#top">Up</a></div>
212 <hr /><hr /> 272 <hr />
273 <hr />
213 <a NAME="getConfigData" ID="getConfigData"></a> 274 <a NAME="getConfigData" ID="getConfigData"></a>
214 <h2>getConfigData</h2> 275 <h2>getConfigData</h2>
215 <b>getConfigData</b>(<i></i>) 276 <b>getConfigData</b>(<i></i>)
277
216 <p> 278 <p>
217 Module function returning data as required by the configuration dialog. 279 Module function returning data as required by the configuration dialog.
218 </p><dl> 280 </p>
281 <dl>
219 <dt>Returns:</dt> 282 <dt>Returns:</dt>
220 <dd> 283 <dd>
221 dictionary containing the relevant data 284 dictionary containing the relevant data
222 </dd> 285 </dd>
223 </dl> 286 </dl>
224 <div align="right"><a href="#top">Up</a></div> 287 <div align="right"><a href="#top">Up</a></div>
225 <hr /><hr /> 288 <hr />
289 <hr />
226 <a NAME="prepareUninstall" ID="prepareUninstall"></a> 290 <a NAME="prepareUninstall" ID="prepareUninstall"></a>
227 <h2>prepareUninstall</h2> 291 <h2>prepareUninstall</h2>
228 <b>prepareUninstall</b>(<i></i>) 292 <b>prepareUninstall</b>(<i></i>)
293
229 <p> 294 <p>
230 Module function to prepare for an uninstallation. 295 Module function to prepare for an uninstallation.
231 </p> 296 </p>
232 <div align="right"><a href="#top">Up</a></div> 297 <div align="right"><a href="#top">Up</a></div>
233 <hr /> 298 <hr />

Mercurial Repository: Eric Assistant

eric ide

mercurial