src/eric7/Documentation/Source/eric7.WebBrowser.WebInspector.html

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 10479
856476537696
equal deleted inserted replaced
9208:3fc8dfeb6ebe 9209:b99e7fd55fd3
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.WebBrowser.WebInspector</title>
4 <meta charset="UTF-8">
5 <link rel="stylesheet" href="styles.css">
6 </head>
7 <body>
8 <a NAME="top" ID="top"></a>
9 <h1>eric7.WebBrowser.WebInspector</h1>
10
11 <p>
12 Module implementing a QWebEngineView to load the web inspector in.
13 </p>
14 <h3>Global Attributes</h3>
15
16 <table>
17 <tr><td>_VIEWS</td></tr>
18 </table>
19 <h3>Classes</h3>
20
21 <table>
22
23 <tr>
24 <td><a href="#WebInspector">WebInspector</a></td>
25 <td>Class implementing a QWebEngineView to load the web inspector in.</td>
26 </tr>
27 </table>
28 <h3>Functions</h3>
29
30 <table>
31
32 <tr>
33 <td><a href="#pushView">pushView</a></td>
34 <td>Function to push a view to the front of the list.</td>
35 </tr>
36 <tr>
37 <td><a href="#registerView">registerView</a></td>
38 <td>Function to register a view.</td>
39 </tr>
40 <tr>
41 <td><a href="#unregisterView">unregisterView</a></td>
42 <td>Function to unregister a view.</td>
43 </tr>
44 </table>
45 <hr />
46 <hr />
47 <a NAME="WebInspector" ID="WebInspector"></a>
48 <h2>WebInspector</h2>
49
50 <p>
51 Class implementing a QWebEngineView to load the web inspector in.
52 </p>
53 <h3>Signals</h3>
54 <dl>
55
56 <dt>inspectorClosed</dt>
57 <dd>
58 emitted to indicate the closing of the inspector
59 window
60 </dd>
61 </dl>
62 <h3>Derived from</h3>
63 QWebEngineView
64 <h3>Class Attributes</h3>
65
66 <table>
67 <tr><td>None</td></tr>
68 </table>
69 <h3>Class Methods</h3>
70
71 <table>
72
73 <tr>
74 <td><a href="#WebInspector.isEnabled">isEnabled</a></td>
75 <td>Class method to check, if the web inspector is enabled.</td>
76 </tr>
77 </table>
78 <h3>Methods</h3>
79
80 <table>
81
82 <tr>
83 <td><a href="#WebInspector.__init__">WebInspector</a></td>
84 <td>Constructor</td>
85 </tr>
86 <tr>
87 <td><a href="#WebInspector.__loadFinished">__loadFinished</a></td>
88 <td>Private slot handling the finished signal.</td>
89 </tr>
90 <tr>
91 <td><a href="#WebInspector.__reloadGeometry">__reloadGeometry</a></td>
92 <td>Private method to restore the geometry.</td>
93 </tr>
94 <tr>
95 <td><a href="#WebInspector.closeEvent">closeEvent</a></td>
96 <td>Protected method to save the geometry when closed.</td>
97 </tr>
98 <tr>
99 <td><a href="#WebInspector.inspectElement">inspectElement</a></td>
100 <td>Public method to inspect an element.</td>
101 </tr>
102 <tr>
103 <td><a href="#WebInspector.setView">setView</a></td>
104 <td>Public method to connect a view to this inspector.</td>
105 </tr>
106 </table>
107 <h3>Static Methods</h3>
108
109 <table>
110 <tr><td>None</td></tr>
111 </table>
112
113 <a NAME="WebInspector.isEnabled" ID="WebInspector.isEnabled"></a>
114 <h4>WebInspector.isEnabled (class method)</h4>
115 <b>isEnabled</b>(<i></i>)
116
117 <p>
118 Class method to check, if the web inspector is enabled.
119 </p>
120 <dl>
121 <dt>Return:</dt>
122 <dd>
123 flag indicating the enabled state
124 </dd>
125 </dl>
126 <dl>
127 <dt>Return Type:</dt>
128 <dd>
129 bool
130 </dd>
131 </dl>
132 <a NAME="WebInspector.__init__" ID="WebInspector.__init__"></a>
133 <h4>WebInspector (Constructor)</h4>
134 <b>WebInspector</b>(<i>parent=None</i>)
135
136 <p>
137 Constructor
138 </p>
139 <dl>
140
141 <dt><i>parent</i> (QWidget)</dt>
142 <dd>
143 reference to the parent widget
144 </dd>
145 </dl>
146 <a NAME="WebInspector.__loadFinished" ID="WebInspector.__loadFinished"></a>
147 <h4>WebInspector.__loadFinished</h4>
148 <b>__loadFinished</b>(<i></i>)
149
150 <p>
151 Private slot handling the finished signal.
152 </p>
153 <a NAME="WebInspector.__reloadGeometry" ID="WebInspector.__reloadGeometry"></a>
154 <h4>WebInspector.__reloadGeometry</h4>
155 <b>__reloadGeometry</b>(<i></i>)
156
157 <p>
158 Private method to restore the geometry.
159 </p>
160 <a NAME="WebInspector.closeEvent" ID="WebInspector.closeEvent"></a>
161 <h4>WebInspector.closeEvent</h4>
162 <b>closeEvent</b>(<i>evt</i>)
163
164 <p>
165 Protected method to save the geometry when closed.
166 </p>
167 <dl>
168
169 <dt><i>evt</i> (QCloseEvent)</dt>
170 <dd>
171 event object
172 </dd>
173 </dl>
174 <a NAME="WebInspector.inspectElement" ID="WebInspector.inspectElement"></a>
175 <h4>WebInspector.inspectElement</h4>
176 <b>inspectElement</b>(<i></i>)
177
178 <p>
179 Public method to inspect an element.
180 </p>
181 <a NAME="WebInspector.setView" ID="WebInspector.setView"></a>
182 <h4>WebInspector.setView</h4>
183 <b>setView</b>(<i>view, inspectElement=False</i>)
184
185 <p>
186 Public method to connect a view to this inspector.
187 </p>
188 <dl>
189
190 <dt><i>view</i> (WebBrowserView)</dt>
191 <dd>
192 reference to the view object
193 </dd>
194 <dt><i>inspectElement</i> (bool)</dt>
195 <dd>
196 flag indicating to start a web inspection
197 </dd>
198 </dl>
199 <div align="right"><a href="#top">Up</a></div>
200 <hr />
201 <hr />
202 <a NAME="pushView" ID="pushView"></a>
203 <h2>pushView</h2>
204 <b>pushView</b>(<i>view</i>)
205
206 <p>
207 Function to push a view to the front of the list.
208 </p>
209 <dl>
210
211 <dt><i>view</i> (WebBrowserView)</dt>
212 <dd>
213 reference to the view
214 </dd>
215 </dl>
216 <div align="right"><a href="#top">Up</a></div>
217 <hr />
218 <hr />
219 <a NAME="registerView" ID="registerView"></a>
220 <h2>registerView</h2>
221 <b>registerView</b>(<i>view</i>)
222
223 <p>
224 Function to register a view.
225 </p>
226 <dl>
227
228 <dt><i>view</i> (WebBrowserView)</dt>
229 <dd>
230 reference to the view
231 </dd>
232 </dl>
233 <div align="right"><a href="#top">Up</a></div>
234 <hr />
235 <hr />
236 <a NAME="unregisterView" ID="unregisterView"></a>
237 <h2>unregisterView</h2>
238 <b>unregisterView</b>(<i>view</i>)
239
240 <p>
241 Function to unregister a view.
242 </p>
243 <dl>
244
245 <dt><i>view</i> (WebBrowserView)</dt>
246 <dd>
247 reference to the view
248 </dd>
249 </dl>
250 <div align="right"><a href="#top">Up</a></div>
251 <hr />
252 </body></html>

eric ide

mercurial