1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
|
<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>gtkmozembed.MozEmbed</title><meta name="generator" content="DocBook XSL Stylesheets V1.71.0"><link rel="start" href="index.html" title="Python GtkMozembed Reference Manual"><link rel="up" href="gtkmozembed-class-reference.html" title="The GtkMozembed Class Reference"><link rel="prev" href="gtkmozembed-class-reference.html" title="The GtkMozembed Class Reference"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">gtkmozembed.MozEmbed</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="gtkmozembed-class-reference.html">Prev</a> </td><th width="60%" align="center">The GtkMozembed Class Reference</th><td width="20%" align="right"> </td></tr></table><hr></div><div class="refentry" lang="en"><a name="class-gtkmozembed"></a><div class="titlepage"></div><div class="refnamediv"><h2>gtkmozembed.MozEmbed</h2><p>gtkmozembed.MozEmbed — Embed Mozilla browser in Gtk application</p></div><div class="refsect1" lang="en"><a name="id2563600"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtkmozembed.MozEmbed</span></span>(<span class="ooclass"><span class="classname">gtk.Bin</span></span>):
<code class="constructorsynopsis"> <span class="methodname"><a href="class-gtkmozembed.html#constructor-gtkmozembed" title="Constructor">gtkmozembed.MozEmbed</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code></code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkmozembed.html#method-gtkmozembed--load-url" title="gtkmozembed.MozEmbed.load_url">load_url</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>url</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkmozembed.html#method-gtkmozembed--stop-load" title="gtkmozembed.MozEmbed.stop_load">stop_load</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkmozembed.html#method-gtkmozembed--can-go-back" title="gtkmozembed.MozEmbed.can_go_back">can_go_back</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkmozembed.html#method-gtkmozembed--can-go-forward" title="gtkmozembed.MozEmbed.can_go_forward">can_go_forward</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkmozembed.html#method-gtkmozembed--go-back" title="gtkmozembed.MozEmbed.go_back">go_back</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkmozembed.html#method-gtkmozembed--go-forward" title="gtkmozembed.MozEmbed.go_forward">go_forward</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkmozembed.html#method-gtkmozembed--render-data" title="gtkmozembed.MozEmbed.render_data">render_data</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>data</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>len</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>base_uri</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>mime_type</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkmozembed.html#method-gtkmozembed--open-stream" title="gtkmozembed.MozEmbed.open_stream">open_stream</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>base_uri</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>mime_type</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkmozembed.html#method-gtkmozembed--append-data" title="gtkmozembed.MozEmbed.append_data">append_data</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>data</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>len</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkmozembed.html#method-gtkmozembed--close-stream" title="gtkmozembed.MozEmbed.close_stream">close_stream</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkmozembed.html#method-gtkmozembed--get-link-message" title="gtkmozembed.MozEmbed.get_link_message">get_link_message</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkmozembed.html#method-gtkmozembed--get-js-status" title="gtkmozembed.MozEmbed.get_js_status">get_js_status</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkmozembed.html#method-gtkmozembed--get-title" title="gtkmozembed.MozEmbed.get_title">get_title</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkmozembed.html#method-gtkmozembed--get-location" title="gtkmozembed.MozEmbed.get_location">get_location</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkmozembed.html#method-gtkmozembed--reload" title="gtkmozembed.MozEmbed.reload">reload</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>flags</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkmozembed.html#method-gtkmozembed--set-chrome-mask" title="gtkmozembed.MozEmbed.set_chrome_mask">set_chrome_mask</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>flags</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkmozembed.html#method-gtkmozembed--get-chrome-mask" title="gtkmozembed.MozEmbed.get_chrome_mask">get_chrome_mask</a></span>(<span class="methodparam"></span>)</code><br></pre></td></tr></table><pre class="programlisting">
<span class="bold"><strong>Functions</strong></span>
<code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkmozembed.html#function-gtkmozembed--push-startup" title="gtkmozembed.push_startup">gtkmozembed.push_startup</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkmozembed.html#function-gtkmozembed--pop-startup" title="gtkmozembed.pop_startup">gtkmozembed.pop_startup</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkmozembed.html#function-gtkmozembed--gtk-moz-embed-set-comp-path" title="gtkmozembed.gtk_moz_embed_set_comp_path">gtkmozembed.gtk_moz_embed_set_comp_path</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkmozembed.html#function-gtkmozembed--gtk-moz-embed-set-profile-path" title="gtkmozembed.gtk_moz_embed_set_profile_path">gtkmozembed.gtk_moz_embed_set_profile_path</a></span>(<span class="methodparam"></span>)</code></pre></div><div class="refsect1" lang="en"><a name="id2564956"></a><h2>Ancestry</h2><pre class="synopsis">+-- gobject.GObject
+-- gtk.Object
+-- gtk.Widget
+-- gtk.Bin
+-- <a href="class-gtkmozembed.html" title="gtkmozembed.MozEmbed">gtk.MozEmbed</a>
</pre></div><div class="refsect1" lang="en"><a name="id2500322"></a><h2>Signal Prototypes</h2><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term">"<a href="class-gtkmozembed.html#signal-gtkmozembed--link-message" title='The "link-message" gtkmozembed.MozEmbed Signal'>link-message</a>"</span></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>mozembed</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>data</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr><tr><td><span class="term">"<a href="class-gtkmozembed.html#signal-gtkmozembed--js-status" title='The "js-status" gtkmozembed.MozEmbed Signal'>js-status</a>"</span></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>mozembed</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>data</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr><tr><td><span class="term">"<a href="class-gtkmozembed.html#signal-gtkmozembed--location" title='The "location" gtkmozembed.MozEmbed Signal'>location</a>"</span></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>mozembed</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>data</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr><tr><td><span class="term">"<a href="class-gtkmozembed.html#signal-gtkmozembed--title" title='The "title" gtkmozembed.MozEmbed Signal'>title</a>"</span></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>mozembed</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>data</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr><tr><td><span class="term">"<a href="class-gtkmozembed.html#signal-gtkmozembed--progress" title='The "progress" gtkmozembed.MozEmbed Signal'>progress</a>"</span></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>mozembed</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>cur</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>max</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>data</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr><tr><td><span class="term">"<a href="class-gtkmozembed.html#signal-gtkmozembed--net-state" title='The "net-state" gtkmozembed.MozEmbed Signal'>net-state</a>"</span></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>mozembed</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>flags</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>status</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>data</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr><tr><td><span class="term">"<a href="class-gtkmozembed.html#signal-gtkmozembed--net-start" title='The "net-start" gtkmozembed.MozEmbed Signal'>net-start</a>"</span></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>mozembed</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>data</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr><tr><td><span class="term">"<a href="class-gtkmozembed.html#signal-gtkmozembed--net-stop" title='The "net-stop" gtkmozembed.MozEmbed Signal'>net-stop</a>"</span></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>mozembed</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>data</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr><tr><td><span class="term">"<a href="class-gtkmozembed.html#signal-gtkmozembed--new-window" title='The "new-window" gtkmozembed.MozEmbed Signal'>new-window</a>"</span></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>mozembed</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>retval</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>chromemask</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>data</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr><tr><td><span class="term">"<a href="class-gtkmozembed.html#signal-gtkmozembed--visibility" title='The "visibility" gtkmozembed.MozEmbed Signal'>visibility</a>"</span></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>mozembed</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>visibility</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>data</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr><tr><td><span class="term">"<a href="class-gtkmozembed.html#signal-gtkmozembed--destroy-browser" title='The "destroy-browser" gtkmozembed.MozEmbed Signal'>destroy-browser</a>"</span></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>mozembed</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>data</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr><tr><td><span class="term">"<a href="class-gtkmozembed.html#signal-gtkmozembed--open-uri" title='The "open-uri" gtkmozembed.MozEmbed Signal'>open-uri</a>"</span></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>mozembed</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>visibility</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>data</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr></tbody></table></div><div class="refsect1" lang="en"><a name="description-gtkmozembed"></a><h2>Description</h2><p>
GtkMozEmbed is an easy-to-use widget that will allow you to embed a Mozilla browser window into your Gtk application.
</p><p>
It's designed to be easy to use and uncomplicated to make the barrier for use as low as possible.
This means that the functionality exposed should cover about 80% of uses. If you want to get at some of Mozilla's higher brain
functions it means that you will have to write your own embedding widget.
</p><p>Here's a small example:</p><pre class="programlisting">
import gtk
import gtkmozembed
class TinyGecko:
def __init__(self):
self.moz = gtkmozembed.MozEmbed()
win = gtk.Window()
win.add(self.moz)
win.show_all()
# self.moz.load_url('http://www.pygtk.org')
data = '<html><head><title>Hello</title></head><body>pygtk dev</body></html>'
self.moz.render_data(data, long(len(data)), 'file:///', 'text/html')
if __name__ == '__main__':
TinyGecko()
gtk.main()
</pre></div><div class="refsect1" lang="en"><a name="constructor-gtkmozembed"></a><h2>Constructor</h2><pre class="programlisting"><code class="constructorsynopsis"> <span class="methodname">gtkmozembed.MozEmbed</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code></code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>a new <a href="class-gtkmozembed.html" title="gtkmozembed.MozEmbed"><code class="classname">gtkmozembed.MozEmbed</code></a> object.
</td></tr></tbody></table><p>
Creates a new <a href="class-gtkmozembed.html" title="gtkmozembed.MozEmbed"><code class="classname">gtkmozembed.MozEmbed</code></a> object.
</p></div><div class="refsect1" lang="en"><a name="id2592145"></a><h2>Methods</h2><div class="refsect2" lang="en"><a name="method-gtkmozembed--load-url"></a><h3>gtkmozembed.MozEmbed.load_url</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">load_url</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>url</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><strong class="parameter"><code>url</code></strong> :</span></td><td>The <em class="parameter"><code>url</code></em> that have to be loaded.</td></tr></tbody></table><p>
The <code class="methodname">load_url</code>() method starts loading a url in the embedding widget. All loads are asynchronous. The url argument
should be in the form of http://www.gnome.org.
</p></div><div class="refsect2" lang="en"><a name="method-gtkmozembed--stop-load"></a><h3>gtkmozembed.MozEmbed.stop_load</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">stop_load</span>(<span class="methodparam"></span>)</code></pre><p>
The <code class="methodname">stop_load</code>() method will allow you to stop the load of a document that is being loaded in the widget.
</p></div><div class="refsect2" lang="en"><a name="method-gtkmozembed--can-go-back"></a><h3>gtkmozembed.MozEmbed.can_go_back</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">can_go_back</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>if <code class="literal">TRUE</code> you can go back in the navigation history.</td></tr></tbody></table><p>
The <code class="methodname">can_go_back</code>() method return whether or not you can go backwards in the document's navigation history.
It will return <code class="literal">TRUE</code> if it can go backwards, <code class="literal">FALSE</code> if it can't.
</p></div><div class="refsect2" lang="en"><a name="method-gtkmozembed--can-go-forward"></a><h3>gtkmozembed.MozEmbed.can_go_forward</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">can_go_forward</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> <code class="literal">TRUE</code> if you can go forward in the navigation history.</td></tr></tbody></table><p>
The <code class="methodname">can_go_forward</code>() method return whether or not you can go forwards in the document's navigation history.
It will return <code class="literal">TRUE</code> if it can go forwards, <code class="literal">FALSE</code> if it can't.
</p></div><div class="refsect2" lang="en"><a name="method-gtkmozembed--go-back"></a><h3>gtkmozembed.MozEmbed.go_back</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">go_back</span>(<span class="methodparam"></span>)</code></pre><p>
The <code class="methodname">go_back</code>() method will go backwards one step in the document's navigation history.
</p></div><div class="refsect2" lang="en"><a name="method-gtkmozembed--go-forward"></a><h3>gtkmozembed.MozEmbed.go_forward</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">go_forward</span>(<span class="methodparam"></span>)</code></pre><p>
The <code class="methodname">go_forward</code>() method will go forwards one step in the document's navigation history.
</p></div><div class="refsect2" lang="en"><a name="method-gtkmozembed--render-data"></a><h3>gtkmozembed.MozEmbed.render_data</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">render_data</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>data</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>len</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>base_uri</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>mime_type</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><strong class="parameter"><code>data</code></strong> :</span></td><td> a chunk of random data.</td></tr><tr><td><span class="term"><strong class="parameter"><code>len</code></strong> :</span></td><td> the lenght of the data.</td></tr><tr><td><span class="term"><strong class="parameter"><code>base_uri</code></strong> :</span></td><td> the base uri.</td></tr><tr><td><span class="term"><strong class="parameter"><code>mime_type</code></strong> :</span></td><td> the mime type.</td></tr></tbody></table><p>
The <code class="methodname">render_data</code>() method will allow you to take a chunk of random data and render it into the document.
You need to pass in the data and the length of the data. The base_uri is used to resolve internal references in the document
and the mime_type is used to determine how to render the document internally.
</p></div><div class="refsect2" lang="en"><a name="method-gtkmozembed--open-stream"></a><h3>gtkmozembed.MozEmbed.open_stream</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">open_stream</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>base_uri</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>mime_type</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><strong class="parameter"><code>base_uri</code></strong> :</span></td><td> the base uri.</td></tr><tr><td><span class="term"><strong class="parameter"><code>mime_type</code></strong> :</span></td><td> the mime type.</td></tr></tbody></table><p>
The <code class="methodname">open_stream</code>() method is used to start loading a document from an external source into the embedding widget.
You need to pass in the <em class="parameter"><code>base_uri</code></em> for resolving internal links and and the <em class="parameter"><code>mime_type</code></em> of the document.
</p></div><div class="refsect2" lang="en"><a name="method-gtkmozembed--append-data"></a><h3>gtkmozembed.MozEmbed.append_data</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">append_data</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>data</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>len</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><strong class="parameter"><code>data</code></strong> :</span></td><td> the data to append in the stream.</td></tr><tr><td><span class="term"><strong class="parameter"><code>len</code></strong> :</span></td><td> the lenght of data.</td></tr></tbody></table><p>
The <code class="methodname">append_data</code>() allows you to append data to an already opened stream in the widget.
You need to pass in the data that you want to append to the document and its length.
</p></div><div class="refsect2" lang="en"><a name="method-gtkmozembed--close-stream"></a><h3>gtkmozembed.MozEmbed.close_stream</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">close_stream</span>(<span class="methodparam"></span>)</code></pre><p>
The <code class="methodname">close_stream</code>() method closes the stream that you have been using to append data manually to the embedding widget.
</p></div><div class="refsect2" lang="en"><a name="method-gtkmozembed--get-link-message"></a><h3>gtkmozembed.MozEmbed.get_link_message</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_link_message</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> the current link message.</td></tr></tbody></table><p>
The <code class="methodname">get_link_message</code>() returns the current link message of the document if there is one.
</p></div><div class="refsect2" lang="en"><a name="method-gtkmozembed--get-js-status"></a><h3>gtkmozembed.MozEmbed.get_js_status</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_js_status</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> the js_status message.</td></tr></tbody></table><p>
The <code class="methodname">get_js_status</code>() returns the js_status message if there is one.
</p></div><div class="refsect2" lang="en"><a name="method-gtkmozembed--get-title"></a><h3>gtkmozembed.MozEmbed.get_title</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_title</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> the current title.</td></tr></tbody></table><p>
The <code class="methodname">get_title</code>() returns the the current title for a document.
</p></div><div class="refsect2" lang="en"><a name="method-gtkmozembed--get-location"></a><h3>gtkmozembed.MozEmbed.get_location</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_location</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> the current location.</td></tr></tbody></table><p>
The <code class="methodname">get_location</code>() returns the current location of the document.
</p></div><div class="refsect2" lang="en"><a name="method-gtkmozembed--reload"></a><h3>gtkmozembed.MozEmbed.reload</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">reload</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>flags</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><strong class="parameter"><code>flags</code></strong> :</span></td><td> the flags argument can be used to control the behaviour of the reload.</td></tr></tbody></table><p>
The <code class="methodname">reload</code>() reloads the document. The flags argument can be used to control the behaviour of the reload.
The flags argument can be one of the following values:
</p><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><code class="literal">GTK_MOZ_EMBED_FLAG_RELOADNORMAL</code></span></td><td></td></tr><tr><td><span class="term"><code class="literal">GTK_MOZ_EMBED_FLAG_RELOADBYPASSCACHE</code></span></td><td></td></tr><tr><td><span class="term"><code class="literal">GTK_MOZ_EMBED_FLAG_RELOADBYPASSPROXY</code></span></td><td></td></tr><tr><td><span class="term"><code class="literal">GTK_MOZ_EMBED_FLAG_RELOADBYPASSPROXYANDCACHE</code></span></td><td></td></tr></tbody></table></div><div class="refsect2" lang="en"><a name="method-gtkmozembed--set-chrome-mask"></a><h3>gtkmozembed.MozEmbed.set_chrome_mask</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_chrome_mask</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>flags</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><strong class="parameter"><code>flags</code></strong> :</span></td><td> the flags argument </td></tr></tbody></table><p>
The <code class="methodname">set_chrome_mask</code>() is used to set the chome mask for this window.
It can be the logical or of any of the following values:
</p><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><code class="literal">GTK_MOZ_EMBED_FLAG_DEFAULTCHROME</code></span></td><td></td></tr><tr><td><span class="term"><code class="literal">GTK_MOZ_EMBED_FLAG_WINDOWBORDERSON</code></span></td><td></td></tr><tr><td><span class="term"><code class="literal">GTK_MOZ_EMBED_FLAG_WINDOWCLOSEON</code></span></td><td></td></tr><tr><td><span class="term"><code class="literal">GTK_MOZ_EMBED_FLAG_WINDOWRESIZEON</code></span></td><td></td></tr><tr><td><span class="term"><code class="literal">GTK_MOZ_EMBED_FLAG_MENUBARON</code></span></td><td></td></tr><tr><td><span class="term"><code class="literal">GTK_MOZ_EMBED_FLAG_TOOLBARON</code></span></td><td></td></tr><tr><td><span class="term"><code class="literal">GTK_MOZ_EMBED_FLAG_LOCATIONBARON</code></span></td><td></td></tr><tr><td><span class="term"><code class="literal">GTK_MOZ_EMBED_FLAG_STATUSBARON</code></span></td><td></td></tr><tr><td><span class="term"><code class="literal">GTK_MOZ_EMBED_FLAG_PERSONALTOOLBARON</code></span></td><td></td></tr><tr><td><span class="term"><code class="literal">GTK_MOZ_EMBED_FLAG_SCROLLBARSON</code></span></td><td></td></tr><tr><td><span class="term"><code class="literal">GTK_MOZ_EMBED_FLAG_TITLEBARON</code></span></td><td></td></tr><tr><td><span class="term"><code class="literal">GTK_MOZ_EMBED_FLAG_EXTRACHROMEON</code></span></td><td></td></tr><tr><td><span class="term"><code class="literal">GTK_MOZ_EMBED_FLAG_WINDOWRAISED</code></span></td><td></td></tr><tr><td><span class="term"><code class="literal">GTK_MOZ_EMBED_FLAG_WINDOWLOWERED</code></span></td><td></td></tr><tr><td><span class="term"><code class="literal">GTK_MOZ_EMBED_FLAG_CENTERSCREEN</code></span></td><td></td></tr><tr><td><span class="term"><code class="literal">GTK_MOZ_EMBED_FLAG_DEPENDENT</code></span></td><td></td></tr><tr><td><span class="term"><code class="literal">GTK_MOZ_EMBED_FLAG_MODAL</code></span></td><td></td></tr><tr><td><span class="term"><code class="literal">GTK_MOZ_EMBED_FLAG_OPENASDIALOG</code></span></td><td></td></tr><tr><td><span class="term"><code class="literal">GTK_MOZ_EMBED_FLAG_OPENASCHROME</code></span></td><td></td></tr><tr><td><span class="term"><code class="literal">GTK_MOZ_EMBED_FLAG_ALLCHROME</code></span></td><td></td></tr></tbody></table></div><div class="refsect2" lang="en"><a name="method-gtkmozembed--get-chrome-mask"></a><h3>gtkmozembed.MozEmbed.get_chrome_mask</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_chrome_mask</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> the current chome mask for this window.</td></tr></tbody></table><p>
The <code class="methodname">get_chrome_mask</code>() gets the current chome mask for this window.
Please see the documentation for
<a href="class-gtkmozembed.html#method-gtkmozembed--set-chrome-mask" title="gtkmozembed.MozEmbed.set_chrome_mask"><code class="methodname">gtkmozembed.MozEmbed.set_chrome_mask</code></a>
for the value of the return mask.
</p></div></div><div class="refsect1" lang="en"><a name="id2593564"></a><h2>Functions</h2><div class="refsect2" lang="en"><a name="function-gtkmozembed--push-startup"></a><h3>gtkmozembed.push_startup</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtkmozembed.push_startup</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>.....</em></span> :</span></td><td> .....</td></tr></tbody></table><p>
The <code class="methodname">push_startup</code>() .....
</p></div><div class="refsect2" lang="en"><a name="function-gtkmozembed--pop-startup"></a><h3>gtkmozembed.pop_startup</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtkmozembed.pop_startup</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>.....</em></span> :</span></td><td> .....</td></tr></tbody></table><p>
The <code class="methodname">pop_startup</code>() .....
</p></div><div class="refsect2" lang="en"><a name="function-gtkmozembed--gtk-moz-embed-set-comp-path"></a><h3>gtkmozembed.gtk_moz_embed_set_comp_path</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtkmozembed.gtk_moz_embed_set_comp_path</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>.....</em></span> :</span></td><td> .....</td></tr></tbody></table><p>
The <code class="methodname">gtk_moz_embed_set_comp_path</code>() must be called before the first widget is created or XPCOM is initialized.
It allows you to set the path to the mozilla components.
</p></div><div class="refsect2" lang="en"><a name="function-gtkmozembed--gtk-moz-embed-set-profile-path"></a><h3>gtkmozembed.gtk_moz_embed_set_profile_path</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtkmozembed.gtk_moz_embed_set_profile_path</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>.....</em></span> :</span></td><td> .....</td></tr></tbody></table><p>
The <code class="methodname">gtk_moz_embed_set_profile_path</code>() .....
</p></div></div><div class="refsect1" lang="en"><a name="id2593786"></a><h2>Signals</h2><div class="refsect2" lang="en"><a name="signal-gtkmozembed--link-message"></a><h3>The "link-message" gtkmozembed.MozEmbed Signal</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>mozembed</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>data</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><em class="parameter"><code>mozembed</code></em> :</span></td><td>the mozembed that received the signal</td></tr><tr><td><span class="term"><em class="parameter"><code>data</code></em> :</span></td><td>additional data (if any) specified with the
<code class="methodname">connect</code>() method</td></tr><tr><td><span class="term"><em class="parameter"><code>...</code></em> :</span></td><td>additional user parameters (if any)</td></tr></tbody></table><p>
The "link-message" signal is emitted when the link message changes.
This happens when the user moves the mouse over a link in a web page.
Please use <a href="class-gtkmozembed.html#method-gtkmozembed--get-link-message" title="gtkmozembed.MozEmbed.get_link_message"><code class="methodname">get_link_message</code></a>
to get the actual value of the link message.
</p></div><div class="refsect2" lang="en"><a name="signal-gtkmozembed--js-status"></a><h3>The "js-status" gtkmozembed.MozEmbed Signal</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>mozembed</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>data</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><em class="parameter"><code>mozembed</code></em> :</span></td><td>the mozembed that received the signal</td></tr><tr><td><span class="term"><em class="parameter"><code>data</code></em> :</span></td><td>additional data (if any) specified with the
<code class="methodname">connect</code>() method</td></tr><tr><td><span class="term"><em class="parameter"><code>...</code></em> :</span></td><td>additional user parameters (if any)</td></tr></tbody></table><p>
The "js_status" signal is emitted when the JavaScript status message changes.
Please use <a href="class-gtkmozembed.html#method-gtkmozembed--get-js-status" title="gtkmozembed.MozEmbed.get_js_status"><code class="methodname">get_js_status</code></a>
to get the actual value of the js status message.
</p></div><div class="refsect2" lang="en"><a name="signal-gtkmozembed--location"></a><h3>The "location" gtkmozembed.MozEmbed Signal</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>mozembed</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>data</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><em class="parameter"><code>mozembed</code></em> :</span></td><td>the mozembed that received the signal</td></tr><tr><td><span class="term"><em class="parameter"><code>data</code></em> :</span></td><td>additional data (if any) specified with the
<code class="methodname">connect</code>() method</td></tr><tr><td><span class="term"><em class="parameter"><code>...</code></em> :</span></td><td>additional user parameters (if any)</td></tr></tbody></table><p>
The "location" signal is emitted any time that the location of the document has changed.
Please use <a href="class-gtkmozembed.html#method-gtkmozembed--get-location" title="gtkmozembed.MozEmbed.get_location"><code class="methodname">get_location</code></a>
to get the actual value of the location.
</p></div><div class="refsect2" lang="en"><a name="signal-gtkmozembed--title"></a><h3>The "title" gtkmozembed.MozEmbed Signal</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>mozembed</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>data</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><em class="parameter"><code>mozembed</code></em> :</span></td><td>the mozembed that received the signal</td></tr><tr><td><span class="term"><em class="parameter"><code>data</code></em> :</span></td><td>additional data (if any) specified with the
<code class="methodname">connect</code>() method</td></tr><tr><td><span class="term"><em class="parameter"><code>...</code></em> :</span></td><td>additional user parameters (if any)</td></tr></tbody></table><p>
The "title" signal is emitted any time that the title of a document has changed.
Please use the <a href="class-gtkmozembed.html#method-gtkmozembed--get-title" title="gtkmozembed.MozEmbed.get_title"><code class="methodname">get_title</code></a>
call to get the actual value of the title.
</p></div><div class="refsect2" lang="en"><a name="signal-gtkmozembed--progress"></a><h3>The "progress" gtkmozembed.MozEmbed Signal</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>mozembed</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>cur</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>max</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>data</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><em class="parameter"><code>mozembed</code></em> :</span></td><td>the mozembed that received the signal</td></tr><tr><td><span class="term"><em class="parameter"><code>cur</code></em> :</span></td><td> indicates how much of the document has been downloaded.</td></tr><tr><td><span class="term"><em class="parameter"><code>max</code></em> :</span></td><td> indicates the length of the document.
If the value of <em class="parameter"><code>max</code></em> is less than one, the full length of the document can not be determined.</td></tr><tr><td><span class="term"><em class="parameter"><code>data</code></em> :</span></td><td>additional data (if any) specified with the
<code class="methodname">connect</code>() method</td></tr><tr><td><span class="term"><em class="parameter"><code>...</code></em> :</span></td><td>additional user parameters (if any)</td></tr></tbody></table><p>
The "progress" signal is emitted any time that there is a change in the progress of loading a document.
</p></div><div class="refsect2" lang="en"><a name="signal-gtkmozembed--net-state"></a><h3>The "net-state" gtkmozembed.MozEmbed Signal</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>mozembed</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>flags</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>status</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>data</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><em class="parameter"><code>mozembed</code></em> :</span></td><td>the mozembed that received the signal</td></tr><tr><td><span class="term"><em class="parameter"><code>flags</code></em> :</span></td><td> .....</td></tr><tr><td><span class="term"><em class="parameter"><code>status</code></em> :</span></td><td> .....</td></tr><tr><td><span class="term"><em class="parameter"><code>data</code></em> :</span></td><td>additional data (if any) specified with the
<code class="methodname">connect</code>() method</td></tr><tr><td><span class="term"><em class="parameter"><code>...</code></em> :</span></td><td>additional user parameters (if any)</td></tr></tbody></table><p>
The "net-state" signal is emitted when there's a change in the state of the loading of a document.
</p></div><div class="refsect2" lang="en"><a name="signal-gtkmozembed--net-start"></a><h3>The "net-start" gtkmozembed.MozEmbed Signal</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>mozembed</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>data</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><em class="parameter"><code>mozembed</code></em> :</span></td><td>the mozembed that received the signal</td></tr><tr><td><span class="term"><em class="parameter"><code>data</code></em> :</span></td><td>additional data (if any) specified with the
<code class="methodname">connect</code>() method</td></tr><tr><td><span class="term"><em class="parameter"><code>...</code></em> :</span></td><td>additional user parameters (if any)</td></tr></tbody></table><p>
The "title" signal is emitted any time that the load of a document has been started.
</p></div><div class="refsect2" lang="en"><a name="signal-gtkmozembed--net-stop"></a><h3>The "net-stop" gtkmozembed.MozEmbed Signal</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>mozembed</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>data</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><em class="parameter"><code>mozembed</code></em> :</span></td><td>the mozembed that received the signal</td></tr><tr><td><span class="term"><em class="parameter"><code>data</code></em> :</span></td><td>additional data (if any) specified with the
<code class="methodname">connect</code>() method</td></tr><tr><td><span class="term"><em class="parameter"><code>...</code></em> :</span></td><td>additional user parameters (if any)</td></tr></tbody></table><p>
The "title" signal is emitted any time that the loading of a document has completed.
</p></div><div class="refsect2" lang="en"><a name="signal-gtkmozembed--new-window"></a><h3>The "new-window" gtkmozembed.MozEmbed Signal</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>mozembed</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>retval</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>chromemask</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>data</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><em class="parameter"><code>mozembed</code></em> :</span></td><td>the mozembed that received the signal</td></tr><tr><td><span class="term"><em class="parameter"><code>retval</code></em> :</span></td><td> .....</td></tr><tr><td><span class="term"><em class="parameter"><code>chromemask</code></em> :</span></td><td> .....</td></tr><tr><td><span class="term"><em class="parameter"><code>data</code></em> :</span></td><td>additional data (if any) specified with the
<code class="methodname">connect</code>() method</td></tr><tr><td><span class="term"><em class="parameter"><code>...</code></em> :</span></td><td>additional user parameters (if any)</td></tr></tbody></table><p>
The "new-window" signal is emitted any time that a new toplevel window is requested by the document.
This will happen in the case of a window.open() in JavaScript.
Responding to this signal allows you to surround a new toplevel window with your chrome.
You should return the newly created GtkMozEmbed object via the retval.
</p></div><div class="refsect2" lang="en"><a name="signal-gtkmozembed--visibility"></a><h3>The "visibility" gtkmozembed.MozEmbed Signal</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>mozembed</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>visibility</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>data</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><em class="parameter"><code>mozembed</code></em> :</span></td><td>the mozembed that received the signal</td></tr><tr><td><span class="term"><em class="parameter"><code>visibility</code></em> :</span></td><td> if <code class="literal">TRUE</code> then the window should be shown. If it's <code class="literal">FALSE</code> it should be hidden.</td></tr><tr><td><span class="term"><em class="parameter"><code>data</code></em> :</span></td><td>additional data (if any) specified with the
<code class="methodname">connect</code>() method</td></tr><tr><td><span class="term"><em class="parameter"><code>...</code></em> :</span></td><td>additional user parameters (if any)</td></tr></tbody></table><p>
The "new-window" signal is emitted when the toplevel window in question needs to be shown or hidden.
</p></div><div class="refsect2" lang="en"><a name="signal-gtkmozembed--destroy-browser"></a><h3>The "destroy-browser" gtkmozembed.MozEmbed Signal</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>mozembed</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>data</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><em class="parameter"><code>mozembed</code></em> :</span></td><td>the mozembed that received the signal</td></tr><tr><td><span class="term"><em class="parameter"><code>data</code></em> :</span></td><td>additional data (if any) specified with the
<code class="methodname">connect</code>() method</td></tr><tr><td><span class="term"><em class="parameter"><code>...</code></em> :</span></td><td>additional user parameters (if any)</td></tr></tbody></table><p>
The "destroy-browser" signal is emitted when the document as requested that the toplevel window be closed.
This will happen in the case of a JavaScript window.close().
</p></div><div class="refsect2" lang="en"><a name="signal-gtkmozembed--open-uri"></a><h3>The "open-uri" gtkmozembed.MozEmbed Signal</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>mozembed</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>uri</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>data</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><em class="parameter"><code>mozembed</code></em> :</span></td><td>the mozembed that received the signal</td></tr><tr><td><span class="term"><em class="parameter"><code>uri</code></em> :</span></td><td> the uri that's going to be loaded.</td></tr><tr><td><span class="term"><em class="parameter"><code>data</code></em> :</span></td><td>additional data (if any) specified with the
<code class="methodname">connect</code>() method</td></tr><tr><td><span class="term"><em class="parameter"><code>...</code></em> :</span></td><td>additional user parameters (if any)</td></tr></tbody></table><p>
The "open-uri" signal is emitted when when the document tries to load a new document, for example when someone clicks on a link in a web page.
This signal gives the embedder the opportunity to keep the new document from being loaded.
The <em class="parameter"><code>uri</code></em> argument is the uri that's going to be loaded.
If you return <code class="literal">TRUE</code> from this signal, the new document will NOT be loaded.
If you return <code class="literal">FALSE</code> the new document will be loaded.
This is somewhat non-intuitive. Think of it as the Mozilla engine is asking if you want to interrupt the loading of a new document.
By returning <code class="literal">TRUE</code> you are saying "don't load this document."
</p></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="gtkmozembed-class-reference.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="gtkmozembed-class-reference.html">Up</a></td><td width="40%" align="right"> </td></tr><tr><td width="40%" align="left" valign="top">The GtkMozembed Class Reference </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> </td></tr></table></div></body></html>
|
