Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric6.WebBrowser.WebBrowserSingleApplication.html

Documentation/Source/eric6.WebBrowser.WebBrowserSingleApplication.html

changeset 6632
084880ed940c
equal deleted inserted replaced
6631:0a2f0feac79d 6632:084880ed940c
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.WebBrowser.WebBrowserSingleApplication</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>eric6.WebBrowser.WebBrowserSingleApplication</h1>
23 <p>
24 Module implementing the single application server and client for the web
25 browser.
26 </p>
27 <h3>Global Attributes</h3>
28 <table>
29 <tr><td>SAFile</td></tr><tr><td>SALoadUrl</td></tr><tr><td>SANewTab</td></tr><tr><td>SASearch</td></tr><tr><td>SAShutdown</td></tr>
30 </table>
31 <h3>Classes</h3>
32 <table>
33 <tr>
34 <td><a href="#WebBrowserSingleApplicationClient">WebBrowserSingleApplicationClient</a></td>
35 <td>Class implementing the single application client of the web browser.</td>
36 </tr><tr>
37 <td><a href="#WebBrowserSingleApplicationServer">WebBrowserSingleApplicationServer</a></td>
38 <td>Class implementing the single application server embedded within the Web Browser.</td>
39 </tr>
40 </table>
41 <h3>Functions</h3>
42 <table>
43 <tr><td>None</td></tr>
44 </table>
45 <hr /><hr />
46 <a NAME="WebBrowserSingleApplicationClient" ID="WebBrowserSingleApplicationClient"></a>
47 <h2>WebBrowserSingleApplicationClient</h2>
48 <p>
49 Class implementing the single application client of the web browser.
50 </p>
51 <h3>Derived from</h3>
52 SingleApplicationClient
53 <h3>Class Attributes</h3>
54 <table>
55 <tr><td>None</td></tr>
56 </table>
57 <h3>Class Methods</h3>
58 <table>
59 <tr><td>None</td></tr>
60 </table>
61 <h3>Methods</h3>
62 <table>
63 <tr>
64 <td><a href="#WebBrowserSingleApplicationClient.__init__">WebBrowserSingleApplicationClient</a></td>
65 <td>Constructor</td>
66 </tr><tr>
67 <td><a href="#WebBrowserSingleApplicationClient.__loadUrl">__loadUrl</a></td>
68 <td>Private method to send an URL to be loaded.</td>
69 </tr><tr>
70 <td><a href="#WebBrowserSingleApplicationClient.__newTab">__newTab</a></td>
71 <td>Private method to send an URL to be loaded in a new tab.</td>
72 </tr><tr>
73 <td><a href="#WebBrowserSingleApplicationClient.__search">__search</a></td>
74 <td>Private method to send a word to search for.</td>
75 </tr><tr>
76 <td><a href="#WebBrowserSingleApplicationClient.__shutdown">__shutdown</a></td>
77 <td>Private method to signal a shutdown request to the browser.</td>
78 </tr><tr>
79 <td><a href="#WebBrowserSingleApplicationClient.processArgs">processArgs</a></td>
80 <td>Public method to process the command line args passed to the UI.</td>
81 </tr>
82 </table>
83 <h3>Static Methods</h3>
84 <table>
85 <tr><td>None</td></tr>
86 </table>
87 <a NAME="WebBrowserSingleApplicationClient.__init__" ID="WebBrowserSingleApplicationClient.__init__"></a>
88 <h4>WebBrowserSingleApplicationClient (Constructor)</h4>
89 <b>WebBrowserSingleApplicationClient</b>(<i>name=""</i>)
90 <p>
91 Constructor
92 </p><dl>
93 <dt><i>name</i> (str)</dt>
94 <dd>
95 name to be used by the single application server
96 </dd>
97 </dl><a NAME="WebBrowserSingleApplicationClient.__loadUrl" ID="WebBrowserSingleApplicationClient.__loadUrl"></a>
98 <h4>WebBrowserSingleApplicationClient.__loadUrl</h4>
99 <b>__loadUrl</b>(<i>url</i>)
100 <p>
101 Private method to send an URL to be loaded.
102 </p><dl>
103 <dt><i>url</i> (str)</dt>
104 <dd>
105 URL to be loaded
106 </dd>
107 </dl><a NAME="WebBrowserSingleApplicationClient.__newTab" ID="WebBrowserSingleApplicationClient.__newTab"></a>
108 <h4>WebBrowserSingleApplicationClient.__newTab</h4>
109 <b>__newTab</b>(<i>url</i>)
110 <p>
111 Private method to send an URL to be loaded in a new tab.
112 </p><dl>
113 <dt><i>url</i> (str)</dt>
114 <dd>
115 URL to be loaded
116 </dd>
117 </dl><a NAME="WebBrowserSingleApplicationClient.__search" ID="WebBrowserSingleApplicationClient.__search"></a>
118 <h4>WebBrowserSingleApplicationClient.__search</h4>
119 <b>__search</b>(<i>word</i>)
120 <p>
121 Private method to send a word to search for.
122 </p><dl>
123 <dt><i>word</i> (str)</dt>
124 <dd>
125 to to be searched for
126 </dd>
127 </dl><a NAME="WebBrowserSingleApplicationClient.__shutdown" ID="WebBrowserSingleApplicationClient.__shutdown"></a>
128 <h4>WebBrowserSingleApplicationClient.__shutdown</h4>
129 <b>__shutdown</b>(<i></i>)
130 <p>
131 Private method to signal a shutdown request to the browser.
132 </p><a NAME="WebBrowserSingleApplicationClient.processArgs" ID="WebBrowserSingleApplicationClient.processArgs"></a>
133 <h4>WebBrowserSingleApplicationClient.processArgs</h4>
134 <b>processArgs</b>(<i>args, disconnect=True</i>)
135 <p>
136 Public method to process the command line args passed to the UI.
137 </p><dl>
138 <dt><i>args</i> (list of str)</dt>
139 <dd>
140 list of command line arguments
141 </dd><dt><i>disconnect</i> (bool)</dt>
142 <dd>
143 flag indicating to disconnect when done
144 </dd>
145 </dl>
146 <div align="right"><a href="#top">Up</a></div>
147 <hr /><hr />
148 <a NAME="WebBrowserSingleApplicationServer" ID="WebBrowserSingleApplicationServer"></a>
149 <h2>WebBrowserSingleApplicationServer</h2>
150 <p>
151 Class implementing the single application server embedded within the
152 Web Browser.
153 </p><h3>Signals</h3>
154 <dl>
155 <dt>loadUrl(str)</dt>
156 <dd>
157 emitted to load an URL
158 </dd><dt>newTab(str)</dt>
159 <dd>
160 emitted to load an URL in a new tab
161 </dd><dt>search(str)</dt>
162 <dd>
163 emitted to search for a given word
164 </dd><dt>shutdown()</dt>
165 <dd>
166 emitted to shut down the browser
167 </dd>
168 </dl>
169 <h3>Derived from</h3>
170 SingleApplicationServer
171 <h3>Class Attributes</h3>
172 <table>
173 <tr><td>None</td></tr>
174 </table>
175 <h3>Class Methods</h3>
176 <table>
177 <tr><td>None</td></tr>
178 </table>
179 <h3>Methods</h3>
180 <table>
181 <tr>
182 <td><a href="#WebBrowserSingleApplicationServer.__init__">WebBrowserSingleApplicationServer</a></td>
183 <td>Constructor</td>
184 </tr><tr>
185 <td><a href="#WebBrowserSingleApplicationServer.__saLoadUrl">__saLoadUrl</a></td>
186 <td>Private method to load an URL in a new tab.</td>
187 </tr><tr>
188 <td><a href="#WebBrowserSingleApplicationServer.__saNewTab">__saNewTab</a></td>
189 <td>Private method to load an URL .</td>
190 </tr><tr>
191 <td><a href="#WebBrowserSingleApplicationServer.__saSearch">__saSearch</a></td>
192 <td>Private method to search for a given word.</td>
193 </tr><tr>
194 <td><a href="#WebBrowserSingleApplicationServer.__saShutdown">__saShutdown</a></td>
195 <td>Private method to shut down the web browser.</td>
196 </tr><tr>
197 <td><a href="#WebBrowserSingleApplicationServer.handleCommand">handleCommand</a></td>
198 <td>Public slot to handle the command sent by the client.</td>
199 </tr>
200 </table>
201 <h3>Static Methods</h3>
202 <table>
203 <tr><td>None</td></tr>
204 </table>
205 <a NAME="WebBrowserSingleApplicationServer.__init__" ID="WebBrowserSingleApplicationServer.__init__"></a>
206 <h4>WebBrowserSingleApplicationServer (Constructor)</h4>
207 <b>WebBrowserSingleApplicationServer</b>(<i>name=""</i>)
208 <p>
209 Constructor
210 </p><dl>
211 <dt><i>name</i> (str)</dt>
212 <dd>
213 name to be used by the single application server
214 </dd>
215 </dl><a NAME="WebBrowserSingleApplicationServer.__saLoadUrl" ID="WebBrowserSingleApplicationServer.__saLoadUrl"></a>
216 <h4>WebBrowserSingleApplicationServer.__saLoadUrl</h4>
217 <b>__saLoadUrl</b>(<i>url</i>)
218 <p>
219 Private method to load an URL in a new tab.
220 </p><dl>
221 <dt><i>url</i> (str)</dt>
222 <dd>
223 URL to be loaded
224 </dd>
225 </dl><a NAME="WebBrowserSingleApplicationServer.__saNewTab" ID="WebBrowserSingleApplicationServer.__saNewTab"></a>
226 <h4>WebBrowserSingleApplicationServer.__saNewTab</h4>
227 <b>__saNewTab</b>(<i>url</i>)
228 <p>
229 Private method to load an URL .
230 </p><dl>
231 <dt><i>url</i> (str)</dt>
232 <dd>
233 URL to be loaded
234 </dd>
235 </dl><a NAME="WebBrowserSingleApplicationServer.__saSearch" ID="WebBrowserSingleApplicationServer.__saSearch"></a>
236 <h4>WebBrowserSingleApplicationServer.__saSearch</h4>
237 <b>__saSearch</b>(<i>word</i>)
238 <p>
239 Private method to search for a given word.
240 </p><dl>
241 <dt><i>word</i> (str)</dt>
242 <dd>
243 word to be searched for
244 </dd>
245 </dl><a NAME="WebBrowserSingleApplicationServer.__saShutdown" ID="WebBrowserSingleApplicationServer.__saShutdown"></a>
246 <h4>WebBrowserSingleApplicationServer.__saShutdown</h4>
247 <b>__saShutdown</b>(<i></i>)
248 <p>
249 Private method to shut down the web browser.
250 </p><a NAME="WebBrowserSingleApplicationServer.handleCommand" ID="WebBrowserSingleApplicationServer.handleCommand"></a>
251 <h4>WebBrowserSingleApplicationServer.handleCommand</h4>
252 <b>handleCommand</b>(<i>command, arguments</i>)
253 <p>
254 Public slot to handle the command sent by the client.
255 </p><dl>
256 <dt><i>command</i> (str)</dt>
257 <dd>
258 command sent by the client
259 </dd><dt><i>arguments</i> (list of str)</dt>
260 <dd>
261 list of command arguments
262 </dd>
263 </dl>
264 <div align="right"><a href="#top">Up</a></div>
265 <hr />
266 </body></html>

Mercurial Repository: eric

eric ide

mercurial