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 7
e6fbd4a7484d
child 30
38092622e612
equal deleted inserted replaced
6:a1600fa29542 7:e6fbd4a7484d
1 <!DOCTYPE html>
2 <html><head>
3 <title>Plugin_Project_Web.PluginProjectWeb</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_Project_Web.PluginProjectWeb</h1>
23 <p>
24 Module implementing the Web project plugin.
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>shortDescription</td></tr><tr><td>version</td></tr>
29 </table>
30 <h3>Classes</h3>
31 <table>
32 <tr>
33 <td><a href="#ProjectWebPlugin">ProjectWebPlugin</a></td>
34 <td>Class implementing the Web project plugin.</td>
35 </tr>
36 </table>
37 <h3>Functions</h3>
38 <table>
39 <tr><td>None</td></tr>
40 </table>
41 <hr /><hr />
42 <a NAME="ProjectWebPlugin" ID="ProjectWebPlugin"></a>
43 <h2>ProjectWebPlugin</h2>
44 <p>
45 Class implementing the Web project plugin.
46 </p>
47 <h3>Derived from</h3>
48 QObject
49 <h3>Class Attributes</h3>
50 <table>
51 <tr><td>None</td></tr>
52 </table>
53 <h3>Class Methods</h3>
54 <table>
55 <tr><td>None</td></tr>
56 </table>
57 <h3>Methods</h3>
58 <table>
59 <tr>
60 <td><a href="#ProjectWebPlugin.__init__">ProjectWebPlugin</a></td>
61 <td>Constructor</td>
62 </tr><tr>
63 <td><a href="#ProjectWebPlugin.__editorClosed">__editorClosed</a></td>
64 <td>Private slot called, when an editor was closed.</td>
65 </tr><tr>
66 <td><a href="#ProjectWebPlugin.__editorOpened">__editorOpened</a></td>
67 <td>Private slot called, when a new editor was opened.</td>
68 </tr><tr>
69 <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>
71 </tr><tr>
72 <td><a href="#ProjectWebPlugin.__html5Prettify">__html5Prettify</a></td>
73 <td>Private slot handling the Prettify HTML action.</td>
74 </tr><tr>
75 <td><a href="#ProjectWebPlugin.__html5ToCss3">__html5ToCss3</a></td>
76 <td>Private slot handling the HTML5 to CSS3 conversion.</td>
77 </tr><tr>
78 <td><a href="#ProjectWebPlugin.__html5ToJs">__html5ToJs</a></td>
79 <td>Private slot handling the HTML5 to JavaScript conversion.</td>
80 </tr><tr>
81 <td><a href="#ProjectWebPlugin.__initMenu">__initMenu</a></td>
82 <td>Private method to initialize the web tools menu.</td>
83 </tr><tr>
84 <td><a href="#ProjectWebPlugin.__initialize">__initialize</a></td>
85 <td>Private slot to (re)initialize the plugin.</td>
86 </tr><tr>
87 <td><a href="#ProjectWebPlugin.__loadTranslator">__loadTranslator</a></td>
88 <td>Private method to load the translation file.</td>
89 </tr><tr>
90 <td><a href="#ProjectWebPlugin.__menuAboutToShow">__menuAboutToShow</a></td>
91 <td>Private slot to prepare the menu before it is shown.</td>
92 </tr><tr>
93 <td><a href="#ProjectWebPlugin.__populateMenu">__populateMenu</a></td>
94 <td>Private slot to populate the tools menu with our entries.</td>
95 </tr><tr>
96 <td><a href="#ProjectWebPlugin.activate">activate</a></td>
97 <td>Public method to activate this plugin.</td>
98 </tr><tr>
99 <td><a href="#ProjectWebPlugin.deactivate">deactivate</a></td>
100 <td>Public method to deactivate this plugin.</td>
101 </tr><tr>
102 <td><a href="#ProjectWebPlugin.fileTypesCallback">fileTypesCallback</a></td>
103 <td>Public method to get the filetype associations of the Web project type.</td>
104 </tr>
105 </table>
106 <h3>Static Methods</h3>
107 <table>
108 <tr><td>None</td></tr>
109 </table>
110 <a NAME="ProjectWebPlugin.__init__" ID="ProjectWebPlugin.__init__"></a>
111 <h4>ProjectWebPlugin (Constructor)</h4>
112 <b>ProjectWebPlugin</b>(<i>ui</i>)
113 <p>
114 Constructor
115 </p><dl>
116 <dt><i>ui</i></dt>
117 <dd>
118 reference to the user interface object (UI.UserInterface)
119 </dd>
120 </dl><a NAME="ProjectWebPlugin.__editorClosed" ID="ProjectWebPlugin.__editorClosed"></a>
121 <h4>ProjectWebPlugin.__editorClosed</h4>
122 <b>__editorClosed</b>(<i>editor</i>)
123 <p>
124 Private slot called, when an editor was closed.
125 </p><dl>
126 <dt><i>editor</i></dt>
127 <dd>
128 reference to the editor (QScintilla.Editor)
129 </dd>
130 </dl><a NAME="ProjectWebPlugin.__editorOpened" ID="ProjectWebPlugin.__editorOpened"></a>
131 <h4>ProjectWebPlugin.__editorOpened</h4>
132 <b>__editorOpened</b>(<i>editor</i>)
133 <p>
134 Private slot called, when a new editor was opened.
135 </p><dl>
136 <dt><i>editor</i></dt>
137 <dd>
138 reference to the new editor (QScintilla.Editor)
139 </dd>
140 </dl><a NAME="ProjectWebPlugin.__editorShowMenu" ID="ProjectWebPlugin.__editorShowMenu"></a>
141 <h4>ProjectWebPlugin.__editorShowMenu</h4>
142 <b>__editorShowMenu</b>(<i>menuName, menu, editor</i>)
143 <p>
144 Private slot called, when the the editor context menu or a submenu is
145 about to be shown.
146 </p><dl>
147 <dt><i>menuName</i></dt>
148 <dd>
149 name of the menu to be shown (string)
150 </dd><dt><i>menu</i></dt>
151 <dd>
152 reference to the menu (QMenu)
153 </dd><dt><i>editor</i></dt>
154 <dd>
155 reference to the editor
156 </dd>
157 </dl><a NAME="ProjectWebPlugin.__html5Prettify" ID="ProjectWebPlugin.__html5Prettify"></a>
158 <h4>ProjectWebPlugin.__html5Prettify</h4>
159 <b>__html5Prettify</b>(<i></i>)
160 <p>
161 Private slot handling the Prettify HTML action.
162 </p><a NAME="ProjectWebPlugin.__html5ToCss3" ID="ProjectWebPlugin.__html5ToCss3"></a>
163 <h4>ProjectWebPlugin.__html5ToCss3</h4>
164 <b>__html5ToCss3</b>(<i></i>)
165 <p>
166 Private slot handling the HTML5 to CSS3 conversion.
167 </p><a NAME="ProjectWebPlugin.__html5ToJs" ID="ProjectWebPlugin.__html5ToJs"></a>
168 <h4>ProjectWebPlugin.__html5ToJs</h4>
169 <b>__html5ToJs</b>(<i></i>)
170 <p>
171 Private slot handling the HTML5 to JavaScript conversion.
172 </p><a NAME="ProjectWebPlugin.__initMenu" ID="ProjectWebPlugin.__initMenu"></a>
173 <h4>ProjectWebPlugin.__initMenu</h4>
174 <b>__initMenu</b>(<i></i>)
175 <p>
176 Private method to initialize the web tools menu.
177 </p><a NAME="ProjectWebPlugin.__initialize" ID="ProjectWebPlugin.__initialize"></a>
178 <h4>ProjectWebPlugin.__initialize</h4>
179 <b>__initialize</b>(<i></i>)
180 <p>
181 Private slot to (re)initialize the plugin.
182 </p><a NAME="ProjectWebPlugin.__loadTranslator" ID="ProjectWebPlugin.__loadTranslator"></a>
183 <h4>ProjectWebPlugin.__loadTranslator</h4>
184 <b>__loadTranslator</b>(<i></i>)
185 <p>
186 Private method to load the translation file.
187 </p><a NAME="ProjectWebPlugin.__menuAboutToShow" ID="ProjectWebPlugin.__menuAboutToShow"></a>
188 <h4>ProjectWebPlugin.__menuAboutToShow</h4>
189 <b>__menuAboutToShow</b>(<i></i>)
190 <p>
191 Private slot to prepare the menu before it is shown.
192 </p><a NAME="ProjectWebPlugin.__populateMenu" ID="ProjectWebPlugin.__populateMenu"></a>
193 <h4>ProjectWebPlugin.__populateMenu</h4>
194 <b>__populateMenu</b>(<i>name, menu</i>)
195 <p>
196 Private slot to populate the tools menu with our entries.
197 </p><dl>
198 <dt><i>name</i></dt>
199 <dd>
200 name of the menu (string)
201 </dd><dt><i>menu</i></dt>
202 <dd>
203 reference to the menu to be populated (QMenu)
204 </dd>
205 </dl><a NAME="ProjectWebPlugin.activate" ID="ProjectWebPlugin.activate"></a>
206 <h4>ProjectWebPlugin.activate</h4>
207 <b>activate</b>(<i></i>)
208 <p>
209 Public method to activate this plugin.
210 </p><dl>
211 <dt>Returns:</dt>
212 <dd>
213 tuple of None and activation status (boolean)
214 </dd>
215 </dl><a NAME="ProjectWebPlugin.deactivate" ID="ProjectWebPlugin.deactivate"></a>
216 <h4>ProjectWebPlugin.deactivate</h4>
217 <b>deactivate</b>(<i></i>)
218 <p>
219 Public method to deactivate this plugin.
220 </p><a NAME="ProjectWebPlugin.fileTypesCallback" ID="ProjectWebPlugin.fileTypesCallback"></a>
221 <h4>ProjectWebPlugin.fileTypesCallback</h4>
222 <b>fileTypesCallback</b>(<i></i>)
223 <p>
224 Public method to get the filetype associations of the Web project type.
225 </p><dl>
226 <dt>Returns:</dt>
227 <dd>
228 dictionary with file type associations
229 </dd>
230 </dl>
231 <div align="right"><a href="#top">Up</a></div>
232 <hr />
233 </body></html>

Mercurial Repository: Web Project and Tools

eric ide

mercurial