/usr/share/gtk-doc/html/libbonoboui/libbonoboui-bonobo-plug.html is in libbonoboui2-dev 2.24.5-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>BonoboPlug</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="LibBonoboUI API Reference Manual">
<link rel="up" href="bonobo-support-utilities.html" title="Supporting Classes">
<link rel="prev" href="bonobo-support-utilities.html" title="Supporting Classes">
<link rel="next" href="libbonoboui-bonobo-socket.html" title="BonoboSocket">
<meta name="generator" content="GTK-Doc V1.15.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="bonobo-support-utilities.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="bonobo-support-utilities.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">LibBonoboUI API Reference Manual</th>
<td><a accesskey="n" href="libbonoboui-bonobo-socket.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libbonoboui-bonobo-plug.synopsis" class="shortcut">Top</a>
|
<a href="#libbonoboui-bonobo-plug.description" class="shortcut">Description</a>
|
<a href="#libbonoboui-bonobo-plug.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#libbonoboui-bonobo-plug.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
|
<a href="#libbonoboui-bonobo-plug.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry">
<a name="libbonoboui-bonobo-plug"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libbonoboui-bonobo-plug.top_of_page"></a>BonoboPlug</span></h2>
<p>BonoboPlug — Toplevel for embedding into other processes.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libbonoboui-bonobo-plug.synopsis"></a><h2>Synopsis</h2>
<a name="BonoboPlug"></a><pre class="synopsis"> <a class="link" href="libbonoboui-bonobo-plug.html#BonoboPlug-struct" title="BonoboPlug">BonoboPlug</a>;
<a class="link" href="libbonoboui-bonobo-plug.html#BonoboPlugPrivate" title="BonoboPlugPrivate">BonoboPlugPrivate</a>;
<a class="link" href="libbonoboui-bonobo-plug.html#BonoboPlugClass" title="BonoboPlugClass">BonoboPlugClass</a>;
<span class="returnvalue">void</span> <a class="link" href="libbonoboui-bonobo-plug.html#bonobo-plug-construct" title="bonobo_plug_construct ()">bonobo_plug_construct</a> (<em class="parameter"><code><a class="link" href="libbonoboui-bonobo-plug.html#BonoboPlug"><span class="type">BonoboPlug</span></a> *plug</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> socket_id</code></em>);
<span class="returnvalue">GtkWidget</span> * <a class="link" href="libbonoboui-bonobo-plug.html#bonobo-plug-new" title="bonobo_plug_new ()">bonobo_plug_new</a> (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> socket_id</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libbonoboui-bonobo-plug.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
+----<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
+----GtkObject
+----GtkWidget
+----GtkContainer
+----GtkBin
+----GtkWindow
+----GtkPlug
+----BonoboPlug
</pre>
</div>
<div class="refsect1">
<a name="libbonoboui-bonobo-plug.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
BonoboPlug implements
AtkImplementorIface and GtkBuildable.</p>
</div>
<div class="refsect1">
<a name="libbonoboui-bonobo-plug.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="libbonoboui-bonobo-plug.html#BonoboPlug--event-forwarding" title='The "event-forwarding" property'>event-forwarding</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write
</pre>
</div>
<div class="refsect1">
<a name="libbonoboui-bonobo-plug.description"></a><h2>Description</h2>
<p>
This is an internal support routine of the X code in Bonobo.
</p>
<p>
Together with <a class="link" href="libbonoboui-bonobo-socket.html#BonoboSocket"><span class="type">BonoboSocket</span></a>, <a class="link" href="libbonoboui-bonobo-plug.html#BonoboPlug"><span class="type">BonoboPlug</span></a> provides the ability
to embed widgets from one process into another process
in a fashion that is transparent to the user. One
process creates a <a class="link" href="libbonoboui-bonobo-socket.html#BonoboSocket"><span class="type">BonoboSocket</span></a> widget and, passes the
XID of that widgets window to the other process,
which then creates a <a class="link" href="libbonoboui-bonobo-plug.html#BonoboPlug"><span class="type">BonoboPlug</span></a> window with that XID.
Any widgets contained in the <a class="link" href="libbonoboui-bonobo-plug.html#BonoboPlug"><span class="type">BonoboPlug</span></a> then will appear
inside the first applications window.
</p>
<p>
This code is a modified copy of <span class="type">GtkPlug</span>, it is included in
bonobo since this forked version could be effectively bug fixed,
and integrated with the <a class="link" href="libbonoboui-bonobo-control.html#BonoboControl"><span class="type">BonoboControl</span></a> / <span class="type">BonoboControlframe</span> CORBA
pipe, to ensure synchronization between the X and CORBA transports.
</p>
</div>
<div class="refsect1">
<a name="libbonoboui-bonobo-plug.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="BonoboPlug-struct"></a><h3>BonoboPlug</h3>
<pre class="programlisting">typedef struct _BonoboPlug BonoboPlug;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="BonoboPlugPrivate"></a><h3>BonoboPlugPrivate</h3>
<pre class="programlisting">typedef struct _BonoboPlugPrivate BonoboPlugPrivate;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="BonoboPlugClass"></a><h3>BonoboPlugClass</h3>
<pre class="programlisting">typedef struct {
GtkPlugClass parent_class;
gpointer dummy[4];
} BonoboPlugClass;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="bonobo-plug-construct"></a><h3>bonobo_plug_construct ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> bonobo_plug_construct (<em class="parameter"><code><a class="link" href="libbonoboui-bonobo-plug.html#BonoboPlug"><span class="type">BonoboPlug</span></a> *plug</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> socket_id</code></em>);</pre>
<p>
Finish the creation of a <a class="link" href="libbonoboui-bonobo-plug.html#BonoboPlug"><span class="type">BonoboPlug</span></a> widget. This function
will generally only be used by classes deriving
from <a class="link" href="libbonoboui-bonobo-plug.html#BonoboPlug"><span class="type">BonoboPlug</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>plug</code></em> :</span></p></td>
<td>The <a class="link" href="libbonoboui-bonobo-plug.html#BonoboPlug"><span class="type">BonoboPlug</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>socket_id</code></em> :</span></p></td>
<td>the XID of the socket's window.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="bonobo-plug-new"></a><h3>bonobo_plug_new ()</h3>
<pre class="programlisting"><span class="returnvalue">GtkWidget</span> * bonobo_plug_new (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> socket_id</code></em>);</pre>
<p>
Create a new plug widget inside the <span class="type">GtkSocket</span> identified
by <em class="parameter"><code>socket_id</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>socket_id</code></em> :</span></p></td>
<td>the XID of the socket's window.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the new <a class="link" href="libbonoboui-bonobo-plug.html#BonoboPlug"><span class="type">BonoboPlug</span></a> widget.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="libbonoboui-bonobo-plug.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="BonoboPlug--event-forwarding"></a><h3>The <code class="literal">"event-forwarding"</code> property</h3>
<pre class="programlisting"> "event-forwarding" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write</pre>
<p>Whether X events should be forwarded.</p>
<p>Default value: TRUE</p>
</div>
</div>
<div class="refsect1">
<a name="libbonoboui-bonobo-plug.see-also"></a><h2>See Also</h2>
<p>
<a class="link" href="libbonoboui-bonobo-socket.html#BonoboSocket"><span class="type">BonoboSocket</span></a>, <a class="link" href="libbonoboui-bonobo-control-frame.html#BonoboControlFrame"><span class="type">BonoboControlFrame</span></a>.
</p>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.15.1</div>
</body>
</html>
|