Mercurial Repositories > Web Project and Tools / file comparison

comparison: ProjectWeb/Documentation/source/Plugin_Project_Web.PluginProjectWeb.html

ProjectWeb/Documentation/source/Plugin_Project_Web.PluginProjectWeb.html

changeset 30
38092622e612
parent 7
e6fbd4a7484d
child 35
a3f1dcf94fe4
equal deleted inserted replaced
29:38577502d613 30:38092622e612
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_Project_Web.PluginProjectWeb</h1> 23 <h1>Plugin_Project_Web.PluginProjectWeb</h1>
24
23 <p> 25 <p>
24 Module implementing the Web project plugin. 26 Module implementing the Web project plugin.
25 </p> 27 </p>
26 <h3>Global Attributes</h3> 28 <h3>Global Attributes</h3>
27 <table> 29
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>shortDescription</td></tr><tr><td>version</td></tr> 30 <table>
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>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="#ProjectWebPlugin">ProjectWebPlugin</a></td> 38 <td><a href="#ProjectWebPlugin">ProjectWebPlugin</a></td>
34 <td>Class implementing the Web project plugin.</td> 39 <td>Class implementing the Web project plugin.</td>
35 </tr> 40 </tr>
36 </table> 41 </table>
37 <h3>Functions</h3> 42 <h3>Functions</h3>
43
38 <table> 44 <table>
39 <tr><td>None</td></tr> 45 <tr><td>None</td></tr>
40 </table> 46 </table>
41 <hr /><hr /> 47 <hr />
48 <hr />
42 <a NAME="ProjectWebPlugin" ID="ProjectWebPlugin"></a> 49 <a NAME="ProjectWebPlugin" ID="ProjectWebPlugin"></a>
43 <h2>ProjectWebPlugin</h2> 50 <h2>ProjectWebPlugin</h2>
51
44 <p> 52 <p>
45 Class implementing the Web project plugin. 53 Class implementing the Web project plugin.
46 </p> 54 </p>
47 <h3>Derived from</h3> 55 <h3>Derived from</h3>
48 QObject 56 QObject
49 <h3>Class Attributes</h3> 57 <h3>Class Attributes</h3>
58
50 <table> 59 <table>
51 <tr><td>None</td></tr> 60 <tr><td>None</td></tr>
52 </table> 61 </table>
53 <h3>Class Methods</h3> 62 <h3>Class Methods</h3>
63
54 <table> 64 <table>
55 <tr><td>None</td></tr> 65 <tr><td>None</td></tr>
56 </table> 66 </table>
57 <h3>Methods</h3> 67 <h3>Methods</h3>
58 <table> 68
69 <table>
70
59 <tr> 71 <tr>
60 <td><a href="#ProjectWebPlugin.__init__">ProjectWebPlugin</a></td> 72 <td><a href="#ProjectWebPlugin.__init__">ProjectWebPlugin</a></td>
61 <td>Constructor</td> 73 <td>Constructor</td>
62 </tr><tr> 74 </tr>
75 <tr>
63 <td><a href="#ProjectWebPlugin.__editorClosed">__editorClosed</a></td> 76 <td><a href="#ProjectWebPlugin.__editorClosed">__editorClosed</a></td>
64 <td>Private slot called, when an editor was closed.</td> 77 <td>Private slot called, when an editor was closed.</td>
65 </tr><tr> 78 </tr>
79 <tr>
66 <td><a href="#ProjectWebPlugin.__editorOpened">__editorOpened</a></td> 80 <td><a href="#ProjectWebPlugin.__editorOpened">__editorOpened</a></td>
67 <td>Private slot called, when a new editor was opened.</td> 81 <td>Private slot called, when a new editor was opened.</td>
68 </tr><tr> 82 </tr>
83 <tr>
69 <td><a href="#ProjectWebPlugin.__editorShowMenu">__editorShowMenu</a></td> 84 <td><a href="#ProjectWebPlugin.__editorShowMenu">__editorShowMenu</a></td>
70 <td>Private slot called, when the the editor context menu or a submenu is about to be shown.</td> 85 <td>Private slot called, when the the editor context menu or a submenu is about to be shown.</td>
71 </tr><tr> 86 </tr>
87 <tr>
72 <td><a href="#ProjectWebPlugin.__html5Prettify">__html5Prettify</a></td> 88 <td><a href="#ProjectWebPlugin.__html5Prettify">__html5Prettify</a></td>
73 <td>Private slot handling the Prettify HTML action.</td> 89 <td>Private slot handling the Prettify HTML action.</td>
74 </tr><tr> 90 </tr>
91 <tr>
75 <td><a href="#ProjectWebPlugin.__html5ToCss3">__html5ToCss3</a></td> 92 <td><a href="#ProjectWebPlugin.__html5ToCss3">__html5ToCss3</a></td>
76 <td>Private slot handling the HTML5 to CSS3 conversion.</td> 93 <td>Private slot handling the HTML5 to CSS3 conversion.</td>
77 </tr><tr> 94 </tr>
95 <tr>
78 <td><a href="#ProjectWebPlugin.__html5ToJs">__html5ToJs</a></td> 96 <td><a href="#ProjectWebPlugin.__html5ToJs">__html5ToJs</a></td>
79 <td>Private slot handling the HTML5 to JavaScript conversion.</td> 97 <td>Private slot handling the HTML5 to JavaScript conversion.</td>
80 </tr><tr> 98 </tr>
99 <tr>
81 <td><a href="#ProjectWebPlugin.__initMenu">__initMenu</a></td> 100 <td><a href="#ProjectWebPlugin.__initMenu">__initMenu</a></td>
82 <td>Private method to initialize the web tools menu.</td> 101 <td>Private method to initialize the web tools menu.</td>
83 </tr><tr> 102 </tr>
103 <tr>
84 <td><a href="#ProjectWebPlugin.__initialize">__initialize</a></td> 104 <td><a href="#ProjectWebPlugin.__initialize">__initialize</a></td>
85 <td>Private slot to (re)initialize the plugin.</td> 105 <td>Private slot to (re)initialize the plugin.</td>
86 </tr><tr> 106 </tr>
107 <tr>
87 <td><a href="#ProjectWebPlugin.__loadTranslator">__loadTranslator</a></td> 108 <td><a href="#ProjectWebPlugin.__loadTranslator">__loadTranslator</a></td>
88 <td>Private method to load the translation file.</td> 109 <td>Private method to load the translation file.</td>
89 </tr><tr> 110 </tr>
111 <tr>
90 <td><a href="#ProjectWebPlugin.__menuAboutToShow">__menuAboutToShow</a></td> 112 <td><a href="#ProjectWebPlugin.__menuAboutToShow">__menuAboutToShow</a></td>
91 <td>Private slot to prepare the menu before it is shown.</td> 113 <td>Private slot to prepare the menu before it is shown.</td>
92 </tr><tr> 114 </tr>
115 <tr>
93 <td><a href="#ProjectWebPlugin.__populateMenu">__populateMenu</a></td> 116 <td><a href="#ProjectWebPlugin.__populateMenu">__populateMenu</a></td>
94 <td>Private slot to populate the tools menu with our entries.</td> 117 <td>Private slot to populate the tools menu with our entries.</td>
95 </tr><tr> 118 </tr>
119 <tr>
96 <td><a href="#ProjectWebPlugin.activate">activate</a></td> 120 <td><a href="#ProjectWebPlugin.activate">activate</a></td>
97 <td>Public method to activate this plugin.</td> 121 <td>Public method to activate this plugin.</td>
98 </tr><tr> 122 </tr>
123 <tr>
99 <td><a href="#ProjectWebPlugin.deactivate">deactivate</a></td> 124 <td><a href="#ProjectWebPlugin.deactivate">deactivate</a></td>
100 <td>Public method to deactivate this plugin.</td> 125 <td>Public method to deactivate this plugin.</td>
101 </tr><tr> 126 </tr>
127 <tr>
102 <td><a href="#ProjectWebPlugin.fileTypesCallback">fileTypesCallback</a></td> 128 <td><a href="#ProjectWebPlugin.fileTypesCallback">fileTypesCallback</a></td>
103 <td>Public method to get the filetype associations of the Web project type.</td> 129 <td>Public method to get the filetype associations of the Web project type.</td>
104 </tr> 130 </tr>
105 </table> 131 </table>
106 <h3>Static Methods</h3> 132 <h3>Static Methods</h3>
133
107 <table> 134 <table>
108 <tr><td>None</td></tr> 135 <tr><td>None</td></tr>
109 </table> 136 </table>
137
110 <a NAME="ProjectWebPlugin.__init__" ID="ProjectWebPlugin.__init__"></a> 138 <a NAME="ProjectWebPlugin.__init__" ID="ProjectWebPlugin.__init__"></a>
111 <h4>ProjectWebPlugin (Constructor)</h4> 139 <h4>ProjectWebPlugin (Constructor)</h4>
112 <b>ProjectWebPlugin</b>(<i>ui</i>) 140 <b>ProjectWebPlugin</b>(<i>ui</i>)
141
113 <p> 142 <p>
114 Constructor 143 Constructor
115 </p><dl> 144 </p>
145 <dl>
146
116 <dt><i>ui</i></dt> 147 <dt><i>ui</i></dt>
117 <dd> 148 <dd>
118 reference to the user interface object (UI.UserInterface) 149 reference to the user interface object (UI.UserInterface)
119 </dd> 150 </dd>
120 </dl><a NAME="ProjectWebPlugin.__editorClosed" ID="ProjectWebPlugin.__editorClosed"></a> 151 </dl>
152 <a NAME="ProjectWebPlugin.__editorClosed" ID="ProjectWebPlugin.__editorClosed"></a>
121 <h4>ProjectWebPlugin.__editorClosed</h4> 153 <h4>ProjectWebPlugin.__editorClosed</h4>
122 <b>__editorClosed</b>(<i>editor</i>) 154 <b>__editorClosed</b>(<i>editor</i>)
155
123 <p> 156 <p>
124 Private slot called, when an editor was closed. 157 Private slot called, when an editor was closed.
125 </p><dl> 158 </p>
159 <dl>
160
126 <dt><i>editor</i></dt> 161 <dt><i>editor</i></dt>
127 <dd> 162 <dd>
128 reference to the editor (QScintilla.Editor) 163 reference to the editor (QScintilla.Editor)
129 </dd> 164 </dd>
130 </dl><a NAME="ProjectWebPlugin.__editorOpened" ID="ProjectWebPlugin.__editorOpened"></a> 165 </dl>
166 <a NAME="ProjectWebPlugin.__editorOpened" ID="ProjectWebPlugin.__editorOpened"></a>
131 <h4>ProjectWebPlugin.__editorOpened</h4> 167 <h4>ProjectWebPlugin.__editorOpened</h4>
132 <b>__editorOpened</b>(<i>editor</i>) 168 <b>__editorOpened</b>(<i>editor</i>)
169
133 <p> 170 <p>
134 Private slot called, when a new editor was opened. 171 Private slot called, when a new editor was opened.
135 </p><dl> 172 </p>
173 <dl>
174
136 <dt><i>editor</i></dt> 175 <dt><i>editor</i></dt>
137 <dd> 176 <dd>
138 reference to the new editor (QScintilla.Editor) 177 reference to the new editor (QScintilla.Editor)
139 </dd> 178 </dd>
140 </dl><a NAME="ProjectWebPlugin.__editorShowMenu" ID="ProjectWebPlugin.__editorShowMenu"></a> 179 </dl>
180 <a NAME="ProjectWebPlugin.__editorShowMenu" ID="ProjectWebPlugin.__editorShowMenu"></a>
141 <h4>ProjectWebPlugin.__editorShowMenu</h4> 181 <h4>ProjectWebPlugin.__editorShowMenu</h4>
142 <b>__editorShowMenu</b>(<i>menuName, menu, editor</i>) 182 <b>__editorShowMenu</b>(<i>menuName, menu, editor</i>)
183
143 <p> 184 <p>
144 Private slot called, when the the editor context menu or a submenu is 185 Private slot called, when the the editor context menu or a submenu is
145 about to be shown. 186 about to be shown.
146 </p><dl> 187 </p>
188 <dl>
189
147 <dt><i>menuName</i></dt> 190 <dt><i>menuName</i></dt>
148 <dd> 191 <dd>
149 name of the menu to be shown (string) 192 name of the menu to be shown (string)
150 </dd><dt><i>menu</i></dt> 193 </dd>
194 <dt><i>menu</i></dt>
151 <dd> 195 <dd>
152 reference to the menu (QMenu) 196 reference to the menu (QMenu)
153 </dd><dt><i>editor</i></dt> 197 </dd>
198 <dt><i>editor</i></dt>
154 <dd> 199 <dd>
155 reference to the editor 200 reference to the editor
156 </dd> 201 </dd>
157 </dl><a NAME="ProjectWebPlugin.__html5Prettify" ID="ProjectWebPlugin.__html5Prettify"></a> 202 </dl>
203 <a NAME="ProjectWebPlugin.__html5Prettify" ID="ProjectWebPlugin.__html5Prettify"></a>
158 <h4>ProjectWebPlugin.__html5Prettify</h4> 204 <h4>ProjectWebPlugin.__html5Prettify</h4>
159 <b>__html5Prettify</b>(<i></i>) 205 <b>__html5Prettify</b>(<i></i>)
206
160 <p> 207 <p>
161 Private slot handling the Prettify HTML action. 208 Private slot handling the Prettify HTML action.
162 </p><a NAME="ProjectWebPlugin.__html5ToCss3" ID="ProjectWebPlugin.__html5ToCss3"></a> 209 </p>
210 <a NAME="ProjectWebPlugin.__html5ToCss3" ID="ProjectWebPlugin.__html5ToCss3"></a>
163 <h4>ProjectWebPlugin.__html5ToCss3</h4> 211 <h4>ProjectWebPlugin.__html5ToCss3</h4>
164 <b>__html5ToCss3</b>(<i></i>) 212 <b>__html5ToCss3</b>(<i></i>)
213
165 <p> 214 <p>
166 Private slot handling the HTML5 to CSS3 conversion. 215 Private slot handling the HTML5 to CSS3 conversion.
167 </p><a NAME="ProjectWebPlugin.__html5ToJs" ID="ProjectWebPlugin.__html5ToJs"></a> 216 </p>
217 <a NAME="ProjectWebPlugin.__html5ToJs" ID="ProjectWebPlugin.__html5ToJs"></a>
168 <h4>ProjectWebPlugin.__html5ToJs</h4> 218 <h4>ProjectWebPlugin.__html5ToJs</h4>
169 <b>__html5ToJs</b>(<i></i>) 219 <b>__html5ToJs</b>(<i></i>)
220
170 <p> 221 <p>
171 Private slot handling the HTML5 to JavaScript conversion. 222 Private slot handling the HTML5 to JavaScript conversion.
172 </p><a NAME="ProjectWebPlugin.__initMenu" ID="ProjectWebPlugin.__initMenu"></a> 223 </p>
224 <a NAME="ProjectWebPlugin.__initMenu" ID="ProjectWebPlugin.__initMenu"></a>
173 <h4>ProjectWebPlugin.__initMenu</h4> 225 <h4>ProjectWebPlugin.__initMenu</h4>
174 <b>__initMenu</b>(<i></i>) 226 <b>__initMenu</b>(<i></i>)
227
175 <p> 228 <p>
176 Private method to initialize the web tools menu. 229 Private method to initialize the web tools menu.
177 </p><a NAME="ProjectWebPlugin.__initialize" ID="ProjectWebPlugin.__initialize"></a> 230 </p>
231 <a NAME="ProjectWebPlugin.__initialize" ID="ProjectWebPlugin.__initialize"></a>
178 <h4>ProjectWebPlugin.__initialize</h4> 232 <h4>ProjectWebPlugin.__initialize</h4>
179 <b>__initialize</b>(<i></i>) 233 <b>__initialize</b>(<i></i>)
234
180 <p> 235 <p>
181 Private slot to (re)initialize the plugin. 236 Private slot to (re)initialize the plugin.
182 </p><a NAME="ProjectWebPlugin.__loadTranslator" ID="ProjectWebPlugin.__loadTranslator"></a> 237 </p>
238 <a NAME="ProjectWebPlugin.__loadTranslator" ID="ProjectWebPlugin.__loadTranslator"></a>
183 <h4>ProjectWebPlugin.__loadTranslator</h4> 239 <h4>ProjectWebPlugin.__loadTranslator</h4>
184 <b>__loadTranslator</b>(<i></i>) 240 <b>__loadTranslator</b>(<i></i>)
241
185 <p> 242 <p>
186 Private method to load the translation file. 243 Private method to load the translation file.
187 </p><a NAME="ProjectWebPlugin.__menuAboutToShow" ID="ProjectWebPlugin.__menuAboutToShow"></a> 244 </p>
245 <a NAME="ProjectWebPlugin.__menuAboutToShow" ID="ProjectWebPlugin.__menuAboutToShow"></a>
188 <h4>ProjectWebPlugin.__menuAboutToShow</h4> 246 <h4>ProjectWebPlugin.__menuAboutToShow</h4>
189 <b>__menuAboutToShow</b>(<i></i>) 247 <b>__menuAboutToShow</b>(<i></i>)
248
190 <p> 249 <p>
191 Private slot to prepare the menu before it is shown. 250 Private slot to prepare the menu before it is shown.
192 </p><a NAME="ProjectWebPlugin.__populateMenu" ID="ProjectWebPlugin.__populateMenu"></a> 251 </p>
252 <a NAME="ProjectWebPlugin.__populateMenu" ID="ProjectWebPlugin.__populateMenu"></a>
193 <h4>ProjectWebPlugin.__populateMenu</h4> 253 <h4>ProjectWebPlugin.__populateMenu</h4>
194 <b>__populateMenu</b>(<i>name, menu</i>) 254 <b>__populateMenu</b>(<i>name, menu</i>)
255
195 <p> 256 <p>
196 Private slot to populate the tools menu with our entries. 257 Private slot to populate the tools menu with our entries.
197 </p><dl> 258 </p>
259 <dl>
260
198 <dt><i>name</i></dt> 261 <dt><i>name</i></dt>
199 <dd> 262 <dd>
200 name of the menu (string) 263 name of the menu (string)
201 </dd><dt><i>menu</i></dt> 264 </dd>
265 <dt><i>menu</i></dt>
202 <dd> 266 <dd>
203 reference to the menu to be populated (QMenu) 267 reference to the menu to be populated (QMenu)
204 </dd> 268 </dd>
205 </dl><a NAME="ProjectWebPlugin.activate" ID="ProjectWebPlugin.activate"></a> 269 </dl>
270 <a NAME="ProjectWebPlugin.activate" ID="ProjectWebPlugin.activate"></a>
206 <h4>ProjectWebPlugin.activate</h4> 271 <h4>ProjectWebPlugin.activate</h4>
207 <b>activate</b>(<i></i>) 272 <b>activate</b>(<i></i>)
273
208 <p> 274 <p>
209 Public method to activate this plugin. 275 Public method to activate this plugin.
210 </p><dl> 276 </p>
277 <dl>
211 <dt>Returns:</dt> 278 <dt>Returns:</dt>
212 <dd> 279 <dd>
213 tuple of None and activation status (boolean) 280 tuple of None and activation status (boolean)
214 </dd> 281 </dd>
215 </dl><a NAME="ProjectWebPlugin.deactivate" ID="ProjectWebPlugin.deactivate"></a> 282 </dl>
283 <a NAME="ProjectWebPlugin.deactivate" ID="ProjectWebPlugin.deactivate"></a>
216 <h4>ProjectWebPlugin.deactivate</h4> 284 <h4>ProjectWebPlugin.deactivate</h4>
217 <b>deactivate</b>(<i></i>) 285 <b>deactivate</b>(<i></i>)
286
218 <p> 287 <p>
219 Public method to deactivate this plugin. 288 Public method to deactivate this plugin.
220 </p><a NAME="ProjectWebPlugin.fileTypesCallback" ID="ProjectWebPlugin.fileTypesCallback"></a> 289 </p>
290 <a NAME="ProjectWebPlugin.fileTypesCallback" ID="ProjectWebPlugin.fileTypesCallback"></a>
221 <h4>ProjectWebPlugin.fileTypesCallback</h4> 291 <h4>ProjectWebPlugin.fileTypesCallback</h4>
222 <b>fileTypesCallback</b>(<i></i>) 292 <b>fileTypesCallback</b>(<i></i>)
293
223 <p> 294 <p>
224 Public method to get the filetype associations of the Web project type. 295 Public method to get the filetype associations of the Web project type.
225 </p><dl> 296 </p>
297 <dl>
226 <dt>Returns:</dt> 298 <dt>Returns:</dt>
227 <dd> 299 <dd>
228 dictionary with file type associations 300 dictionary with file type associations
229 </dd> 301 </dd>
230 </dl> 302 </dl>

Mercurial Repository: Web Project and Tools

eric ide

mercurial