Mercurial Repositories > Selection Encloser Tool / file comparison

comparison: SelectionEncloser/Documentation/source/Plugin_Tools_Selection_Encloser.PluginSelectionEncloser.html

SelectionEncloser/Documentation/source/Plugin_Tools_Selection_Encloser.PluginSelectionEncloser.html

changeset 4
b712f76dbf9e
child 41
e747eb5f3f43
equal deleted inserted replaced
3:b26df0282953 4:b712f76dbf9e
1 <!DOCTYPE html>
2 <html><head>
3 <title>Plugin_Tools_Selection_Encloser.PluginSelectionEncloser</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_Selection_Encloser.PluginSelectionEncloser</h1>
23 <p>
24 Module implementing the Selection Encloser 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>python2Compatible</td></tr><tr><td>selectionEncloserPluginObject</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="#SelectionEncloserPlugin">SelectionEncloserPlugin</a></td>
34 <td>Class implementing the Selection Encloser plugin.</td>
35 </tr>
36 </table>
37 <h3>Functions</h3>
38 <table>
39 <tr>
40 <td><a href="#createSelectionEncloserPage">createSelectionEncloserPage</a></td>
41 <td>Module function to create the Selection Encloser 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="SelectionEncloserPlugin" ID="SelectionEncloserPlugin"></a>
52 <h2>SelectionEncloserPlugin</h2>
53 <p>
54 Class implementing the Selection Encloser 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="#SelectionEncloserPlugin.__init__">SelectionEncloserPlugin</a></td>
70 <td>Constructor</td>
71 </tr><tr>
72 <td><a href="#SelectionEncloserPlugin.__editorClosed">__editorClosed</a></td>
73 <td>Private slot called, when an editor was closed.</td>
74 </tr><tr>
75 <td><a href="#SelectionEncloserPlugin.__editorOpened">__editorOpened</a></td>
76 <td>Private slot called, when a new editor was opened.</td>
77 </tr><tr>
78 <td><a href="#SelectionEncloserPlugin.__editorShowMenu">__editorShowMenu</a></td>
79 <td>Private slot called, when the the editor context menu or a submenu is about to be shown.</td>
80 </tr><tr>
81 <td><a href="#SelectionEncloserPlugin.__encloseSelection">__encloseSelection</a></td>
82 <td>Private slot to enclose the selection with the selected string.</td>
83 </tr><tr>
84 <td><a href="#SelectionEncloserPlugin.__initMenu">__initMenu</a></td>
85 <td>Private method to initialize the menu.</td>
86 </tr><tr>
87 <td><a href="#SelectionEncloserPlugin.__loadTranslator">__loadTranslator</a></td>
88 <td>Private method to load the translation file.</td>
89 </tr><tr>
90 <td><a href="#SelectionEncloserPlugin.__populateMenu">__populateMenu</a></td>
91 <td>Private slot to populate the tools menu with our entry.</td>
92 </tr><tr>
93 <td><a href="#SelectionEncloserPlugin.__showMenu">__showMenu</a></td>
94 <td>Private slot to build the menu hierarchy.</td>
95 </tr><tr>
96 <td><a href="#SelectionEncloserPlugin.activate">activate</a></td>
97 <td>Public method to activate this plugin.</td>
98 </tr><tr>
99 <td><a href="#SelectionEncloserPlugin.deactivate">deactivate</a></td>
100 <td>Public method to deactivate this plugin.</td>
101 </tr><tr>
102 <td><a href="#SelectionEncloserPlugin.getPreferences">getPreferences</a></td>
103 <td>Public method to retrieve the various settings.</td>
104 </tr><tr>
105 <td><a href="#SelectionEncloserPlugin.setPreferences">setPreferences</a></td>
106 <td>Public method to store the various settings.</td>
107 </tr>
108 </table>
109 <h3>Static Methods</h3>
110 <table>
111 <tr><td>None</td></tr>
112 </table>
113 <a NAME="SelectionEncloserPlugin.__init__" ID="SelectionEncloserPlugin.__init__"></a>
114 <h4>SelectionEncloserPlugin (Constructor)</h4>
115 <b>SelectionEncloserPlugin</b>(<i>ui</i>)
116 <p>
117 Constructor
118 </p><dl>
119 <dt><i>ui</i></dt>
120 <dd>
121 reference to the user interface object (UI.UserInterface)
122 </dd>
123 </dl><a NAME="SelectionEncloserPlugin.__editorClosed" ID="SelectionEncloserPlugin.__editorClosed"></a>
124 <h4>SelectionEncloserPlugin.__editorClosed</h4>
125 <b>__editorClosed</b>(<i>editor</i>)
126 <p>
127 Private slot called, when an editor was closed.
128 </p><dl>
129 <dt><i>editor</i></dt>
130 <dd>
131 reference to the editor (QScintilla.Editor)
132 </dd>
133 </dl><a NAME="SelectionEncloserPlugin.__editorOpened" ID="SelectionEncloserPlugin.__editorOpened"></a>
134 <h4>SelectionEncloserPlugin.__editorOpened</h4>
135 <b>__editorOpened</b>(<i>editor</i>)
136 <p>
137 Private slot called, when a new editor was opened.
138 </p><dl>
139 <dt><i>editor</i></dt>
140 <dd>
141 reference to the new editor (QScintilla.Editor)
142 </dd>
143 </dl><a NAME="SelectionEncloserPlugin.__editorShowMenu" ID="SelectionEncloserPlugin.__editorShowMenu"></a>
144 <h4>SelectionEncloserPlugin.__editorShowMenu</h4>
145 <b>__editorShowMenu</b>(<i>menuName, menu, editor</i>)
146 <p>
147 Private slot called, when the the editor context menu or a submenu is
148 about to be shown.
149 </p><dl>
150 <dt><i>menuName</i></dt>
151 <dd>
152 name of the menu to be shown (string)
153 </dd><dt><i>menu</i></dt>
154 <dd>
155 reference to the menu (QMenu)
156 </dd><dt><i>editor</i></dt>
157 <dd>
158 reference to the editor
159 </dd>
160 </dl><a NAME="SelectionEncloserPlugin.__encloseSelection" ID="SelectionEncloserPlugin.__encloseSelection"></a>
161 <h4>SelectionEncloserPlugin.__encloseSelection</h4>
162 <b>__encloseSelection</b>(<i></i>)
163 <p>
164 Private slot to enclose the selection with the selected string.
165 </p><a NAME="SelectionEncloserPlugin.__initMenu" ID="SelectionEncloserPlugin.__initMenu"></a>
166 <h4>SelectionEncloserPlugin.__initMenu</h4>
167 <b>__initMenu</b>(<i></i>)
168 <p>
169 Private method to initialize the menu.
170 </p><a NAME="SelectionEncloserPlugin.__loadTranslator" ID="SelectionEncloserPlugin.__loadTranslator"></a>
171 <h4>SelectionEncloserPlugin.__loadTranslator</h4>
172 <b>__loadTranslator</b>(<i></i>)
173 <p>
174 Private method to load the translation file.
175 </p><a NAME="SelectionEncloserPlugin.__populateMenu" ID="SelectionEncloserPlugin.__populateMenu"></a>
176 <h4>SelectionEncloserPlugin.__populateMenu</h4>
177 <b>__populateMenu</b>(<i>name, menu</i>)
178 <p>
179 Private slot to populate the tools menu with our entry.
180 </p><dl>
181 <dt><i>name</i></dt>
182 <dd>
183 name of the menu (string)
184 </dd><dt><i>menu</i></dt>
185 <dd>
186 reference to the menu to be populated (QMenu)
187 </dd>
188 </dl><a NAME="SelectionEncloserPlugin.__showMenu" ID="SelectionEncloserPlugin.__showMenu"></a>
189 <h4>SelectionEncloserPlugin.__showMenu</h4>
190 <b>__showMenu</b>(<i></i>)
191 <p>
192 Private slot to build the menu hierarchy.
193 </p><a NAME="SelectionEncloserPlugin.activate" ID="SelectionEncloserPlugin.activate"></a>
194 <h4>SelectionEncloserPlugin.activate</h4>
195 <b>activate</b>(<i></i>)
196 <p>
197 Public method to activate this plugin.
198 </p><dl>
199 <dt>Returns:</dt>
200 <dd>
201 tuple of None and activation status (boolean)
202 </dd>
203 </dl><a NAME="SelectionEncloserPlugin.deactivate" ID="SelectionEncloserPlugin.deactivate"></a>
204 <h4>SelectionEncloserPlugin.deactivate</h4>
205 <b>deactivate</b>(<i></i>)
206 <p>
207 Public method to deactivate this plugin.
208 </p><a NAME="SelectionEncloserPlugin.getPreferences" ID="SelectionEncloserPlugin.getPreferences"></a>
209 <h4>SelectionEncloserPlugin.getPreferences</h4>
210 <b>getPreferences</b>(<i>key</i>)
211 <p>
212 Public method to retrieve the various settings.
213 </p><dl>
214 <dt><i>key</i></dt>
215 <dd>
216 the key of the value to get (string)
217 </dd>
218 </dl><dl>
219 <dt>Returns:</dt>
220 <dd>
221 the requested setting
222 </dd>
223 </dl><a NAME="SelectionEncloserPlugin.setPreferences" ID="SelectionEncloserPlugin.setPreferences"></a>
224 <h4>SelectionEncloserPlugin.setPreferences</h4>
225 <b>setPreferences</b>(<i>key, value</i>)
226 <p>
227 Public method to store the various settings.
228 </p><dl>
229 <dt><i>key</i></dt>
230 <dd>
231 the key of the setting to be set (string)
232 </dd><dt><i>value</i></dt>
233 <dd>
234 the value to be set
235 </dd>
236 </dl>
237 <div align="right"><a href="#top">Up</a></div>
238 <hr /><hr />
239 <a NAME="createSelectionEncloserPage" ID="createSelectionEncloserPage"></a>
240 <h2>createSelectionEncloserPage</h2>
241 <b>createSelectionEncloserPage</b>(<i>configDlg</i>)
242 <p>
243 Module function to create the Selection Encloser configuration page.
244 </p><dl>
245 <dt><i>configDlg</i></dt>
246 <dd>
247 reference to the configuration dialog
248 </dd>
249 </dl><dl>
250 <dt>Returns:</dt>
251 <dd>
252 reference to the configuration page
253 </dd>
254 </dl>
255 <div align="right"><a href="#top">Up</a></div>
256 <hr /><hr />
257 <a NAME="getConfigData" ID="getConfigData"></a>
258 <h2>getConfigData</h2>
259 <b>getConfigData</b>(<i></i>)
260 <p>
261 Module function returning data as required by the configuration dialog.
262 </p><dl>
263 <dt>Returns:</dt>
264 <dd>
265 dictionary containing the relevant data
266 </dd>
267 </dl>
268 <div align="right"><a href="#top">Up</a></div>
269 <hr /><hr />
270 <a NAME="prepareUninstall" ID="prepareUninstall"></a>
271 <h2>prepareUninstall</h2>
272 <b>prepareUninstall</b>(<i></i>)
273 <p>
274 Module function to prepare for an uninstallation.
275 </p>
276 <div align="right"><a href="#top">Up</a></div>
277 <hr />
278 </body></html>

Mercurial Repository: Selection Encloser Tool

eric ide

mercurial