|
Server : Apache/2.2.17 (Unix) mod_ssl/2.2.17 OpenSSL/0.9.8e-fips-rhel5 DAV/2 PHP/5.2.17 System : Linux localhost 2.6.18-419.el5 #1 SMP Fri Feb 24 22:47:42 UTC 2017 x86_64 User : nobody ( 99) PHP Version : 5.2.17 Disable Function : NONE Directory : /usr/share/gtk-doc/html/gtk/ |
Upload File : |
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>GtkPlug</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
<link rel="start" href="index.html" title="GTK+ Reference Manual">
<link rel="up" href="PlugSocket.html" title="Cross-process Embedding">
<link rel="prev" href="PlugSocket.html" title="Cross-process Embedding">
<link rel="next" href="GtkSocket.html" title="GtkSocket">
<meta name="generator" content="GTK-Doc V1.6 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="gtk.html" title="Part I. GTK+ Overview">
<link rel="part" href="gtkbase.html" title="Part II. GTK+ Core Reference">
<link rel="part" href="gtkobjects.html" title="Part III. GTK+ Widgets and Objects">
<link rel="chapter" href="ch01.html" title="Object Hierarchy">
<link rel="chapter" href="ch02.html" title="Widget Gallery">
<link rel="chapter" href="WindowWidgets.html" title="Windows">
<link rel="chapter" href="DisplayWidgets.html" title="Display Widgets">
<link rel="chapter" href="ButtonWidgets.html" title="Buttons and Toggles">
<link rel="chapter" href="NumericEntry.html" title="Numeric/Text Data Entry">
<link rel="chapter" href="TextWidgetObjects.html" title="Multiline Text Editor">
<link rel="chapter" href="TreeWidgetObjects.html" title="Tree, List and Icon Grid Widgets">
<link rel="chapter" href="MenusAndCombos.html" title="Menus, Combo Box, Toolbar">
<link rel="chapter" href="Actions.html" title="Action-based menus and toolbars">
<link rel="chapter" href="SelectorWidgets.html" title="Selectors (File/Font/Color/Input Devices)">
<link rel="chapter" href="LayoutContainers.html" title="Layout Containers">
<link rel="chapter" href="Ornaments.html" title="Ornaments">
<link rel="chapter" href="ScrollingWidgets.html" title="Scrolling">
<link rel="chapter" href="Printing.html" title="Printing">
<link rel="chapter" href="MiscObjects.html" title="Miscellaneous">
<link rel="chapter" href="AbstractObjects.html" title="Abstract Base Classes">
<link rel="chapter" href="PlugSocket.html" title="Cross-process Embedding">
<link rel="chapter" href="SpecialObjects.html" title="Special-purpose features">
<link rel="chapter" href="RecentDocuments.html" title="Recently Used Documents">
<link rel="chapter" href="DeprecatedObjects.html" title="Deprecated">
<link rel="part" href="migrating.html" title="Part IV. Migrating from Previous Versions of GTK+">
<link rel="chapter" href="gtk-migrating-checklist.html" title="Migration Checklist">
<link rel="chapter" href="gtk-migrating-GtkFileChooser.html" title="Migrating from GtkFileSelection to GtkFileChooser">
<link rel="chapter" href="gtk-migrating-GtkAction.html" title="Migrating from old menu and toolbar systems to GtkAction">
<link rel="chapter" href="gtk-migrating-GtkComboBox.html" title="Migrating from GtkOptionMenu and GtkCombo to GtkComboBox and
GtkComboBoxEntry">
<link rel="chapter" href="gtk-migrating-GtkIconView.html" title="Migrating from GnomeIconList to GtkIconView">
<link rel="chapter" href="gtk-migrating-GtkAboutDialog.html" title="Migrating from GnomeAbout to GtkAboutDialog">
<link rel="chapter" href="gtk-migrating-GtkColorButton.html" title="Migrating from GnomeColorPicker to GtkColorButton">
<link rel="chapter" href="gtk-migrating-GtkAssistant.html" title="Migrating from GnomeDruid to GtkAssistant">
<link rel="chapter" href="gtk-migrating-GtkRecentChooser.html" title="Migrating from EggRecent to GtkRecentChooser">
<link rel="chapter" href="gtk-migrating-GtkLinkButton.html" title="Migrating from GnomeHRef to GtkLinkButton">
<link rel="part" href="pt05.html" title="Part V. GTK+ Tools">
<link rel="glossary" href="glossary.html" title="Glossary">
<link rel="index" href="ix01.html" title="Index">
<link rel="index" href="ix02.html" title="Index of deprecated symbols">
<link rel="index" href="ix03.html" title="Index of new symbols in 2.2">
<link rel="index" href="ix04.html" title="Index of new symbols in 2.4">
<link rel="index" href="ix05.html" title="Index of new symbols in 2.6">
<link rel="index" href="ix06.html" title="Index of new symbols in 2.8">
<link rel="index" href="ix07.html" title="Index of new symbols in 2.10">
</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="PlugSocket.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="PlugSocket.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">GTK+ Reference Manual</th>
<td><a accesskey="n" href="GtkSocket.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id3765810" class="shortcut">Top</a>
 | 
<a href="#id3766117" class="shortcut">Description</a>
 | 
<a href="#id3765977" class="shortcut">Object Hierarchy</a>
 | 
<a href="#id3766046" class="shortcut">Implemented Interfaces</a>
 | 
<a href="#id3766069" class="shortcut">Signals</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="GtkPlug"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id3765810"></a><span class="refentrytitle">GtkPlug</span>
</h2>
<p>GtkPlug — Toplevel for embedding into other processes</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">
#include <gtk/gtk.h>
<a href="GtkPlug.html#GtkPlug-struct">GtkPlug</a>;
void <a href="GtkPlug.html#gtk-plug-construct">gtk_plug_construct</a> (<a href="GtkPlug.html" title="GtkPlug">GtkPlug</a> *plug,
<a
href="../gdk/gdk-Event-Structures.html#GdkNativeWindow"
>GdkNativeWindow</a> socket_id);
void <a href="GtkPlug.html#gtk-plug-construct-for-display">gtk_plug_construct_for_display</a> (<a href="GtkPlug.html" title="GtkPlug">GtkPlug</a> *plug,
<a
href="../gdk/GdkDisplay.html"
>GdkDisplay</a> *display,
<a
href="../gdk/gdk-Event-Structures.html#GdkNativeWindow"
>GdkNativeWindow</a> socket_id);
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a>* <a href="GtkPlug.html#gtk-plug-new">gtk_plug_new</a> (<a
href="../gdk/gdk-Event-Structures.html#GdkNativeWindow"
>GdkNativeWindow</a> socket_id);
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a>* <a href="GtkPlug.html#gtk-plug-new-for-display">gtk_plug_new_for_display</a> (<a
href="../gdk/GdkDisplay.html"
>GdkDisplay</a> *display,
<a
href="../gdk/gdk-Event-Structures.html#GdkNativeWindow"
>GdkNativeWindow</a> socket_id);
<a
href="../gdk/gdk-Event-Structures.html#GdkNativeWindow"
>GdkNativeWindow</a> <a href="GtkPlug.html#gtk-plug-get-id">gtk_plug_get_id</a> (<a href="GtkPlug.html" title="GtkPlug">GtkPlug</a> *plug);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id3765977"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
>GObject</a>
+----<a
href="../gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned"
>GInitiallyUnowned</a>
+----<a href="GtkObject.html" title="GtkObject">GtkObject</a>
+----<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a>
+----<a href="GtkContainer.html" title="GtkContainer">GtkContainer</a>
+----<a href="GtkBin.html" title="GtkBin">GtkBin</a>
+----<a href="GtkWindow.html" title="GtkWindow">GtkWindow</a>
+----GtkPlug
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id3766046"></a><h2>Implemented Interfaces</h2>
<p>
GtkPlug implements
AtkImplementorIface.</p>
</div>
<div class="refsect1" lang="en">
<a name="id3766069"></a><h2>Signals</h2>
<pre class="synopsis">
"<a href="GtkPlug.html#GtkPlug-embedded">embedded</a>" void user_function (<a href="GtkPlug.html" title="GtkPlug">GtkPlug</a> *plug,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run last
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id3766117"></a><h2>Description</h2>
<p>
Together with <a href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a>, <a href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</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 href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a> widget and, passes the
ID of that widgets window to the other process,
which then creates a <a href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a> with that window ID.
Any widgets contained in the <a href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a> then will appear
inside the first applications window.
</p>
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
<p>
The <a href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a> and <a href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a> widgets are currently not available
on all platforms supported by GTK+.
</p>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id3766201"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id3766211"></a><h3>
<a name="GtkPlug-struct"></a>GtkPlug</h3>
<a class="indexterm" name="id3766224"></a><pre class="programlisting">typedef struct _GtkPlug GtkPlug;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3766239"></a><h3>
<a name="gtk-plug-construct"></a>gtk_plug_construct ()</h3>
<a class="indexterm" name="id3766253"></a><pre class="programlisting">void gtk_plug_construct (<a href="GtkPlug.html" title="GtkPlug">GtkPlug</a> *plug,
<a
href="../gdk/gdk-Event-Structures.html#GdkNativeWindow"
>GdkNativeWindow</a> socket_id);</pre>
<p>
Finish the initialization of <em class="parameter"><code>plug</code></em> for a given <a href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a> identified by
<em class="parameter"><code>socket_id</code></em>. This function will generally only be used by classes deriving from <a href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>plug</code></em> :</span></td>
<td> a <a href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>socket_id</code></em> :</span></td>
<td> the XID of the socket's window.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3766361"></a><h3>
<a name="gtk-plug-construct-for-display"></a>gtk_plug_construct_for_display ()</h3>
<a class="indexterm" name="id3766377"></a><pre class="programlisting">void gtk_plug_construct_for_display (<a href="GtkPlug.html" title="GtkPlug">GtkPlug</a> *plug,
<a
href="../gdk/GdkDisplay.html"
>GdkDisplay</a> *display,
<a
href="../gdk/gdk-Event-Structures.html#GdkNativeWindow"
>GdkNativeWindow</a> socket_id);</pre>
<p>
Finish the initialization of <em class="parameter"><code>plug</code></em> for a given <a href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a> identified by
<em class="parameter"><code>socket_id</code></em> which is currently displayed on <em class="parameter"><code>display</code></em>.
This function will generally only be used by classes deriving from <a href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>plug</code></em> :</span></td>
<td> a <a href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>display</code></em> :</span></td>
<td> the <a
href="../gdk/GdkDisplay.html"
><span class="type">GdkDisplay</span></a> associated with <em class="parameter"><code>socket_id</code></em>'s
<a href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>socket_id</code></em> :</span></td>
<td> the XID of the socket's window.
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.2
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3766540"></a><h3>
<a name="gtk-plug-new"></a>gtk_plug_new ()</h3>
<a class="indexterm" name="id3766553"></a><pre class="programlisting"><a href="GtkWidget.html" title="GtkWidget">GtkWidget</a>* gtk_plug_new (<a
href="../gdk/gdk-Event-Structures.html#GdkNativeWindow"
>GdkNativeWindow</a> socket_id);</pre>
<p>
Creates a new plug widget inside the <a href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a> identified
by <em class="parameter"><code>socket_id</code></em>. If <em class="parameter"><code>socket_id</code></em> is 0, the plug is left "unplugged" and
can later be plugged into a <a href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a> by <a href="GtkSocket.html#gtk-socket-add-id"><code class="function">gtk_socket_add_id()</code></a>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>socket_id</code></em> :</span></td>
<td> the window ID of the socket, or 0.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the new <a href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a> widget.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3766664"></a><h3>
<a name="gtk-plug-new-for-display"></a>gtk_plug_new_for_display ()</h3>
<a class="indexterm" name="id3766680"></a><pre class="programlisting"><a href="GtkWidget.html" title="GtkWidget">GtkWidget</a>* gtk_plug_new_for_display (<a
href="../gdk/GdkDisplay.html"
>GdkDisplay</a> *display,
<a
href="../gdk/gdk-Event-Structures.html#GdkNativeWindow"
>GdkNativeWindow</a> socket_id);</pre>
<p>
Create a new plug widget inside the <a href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a> identified by socket_id.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>display</code></em> :</span></td>
<td> the <a
href="../gdk/GdkDisplay.html"
><span class="type">GdkDisplay</span></a> on which <em class="parameter"><code>socket_id</code></em> is displayed
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>socket_id</code></em> :</span></td>
<td> the XID of the socket's window.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the new <a href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a> widget.
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.2
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3766798"></a><h3>
<a name="gtk-plug-get-id"></a>gtk_plug_get_id ()</h3>
<a class="indexterm" name="id3766810"></a><pre class="programlisting"><a
href="../gdk/gdk-Event-Structures.html#GdkNativeWindow"
>GdkNativeWindow</a> gtk_plug_get_id (<a href="GtkPlug.html" title="GtkPlug">GtkPlug</a> *plug);</pre>
<p>
Gets the window ID of a <a href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a> widget, which can then
be used to embed this window inside another window, for
instance with <a href="GtkSocket.html#gtk-socket-add-id"><code class="function">gtk_socket_add_id()</code></a>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>plug</code></em> :</span></td>
<td> a <a href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the window ID for the plug
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id3766900"></a><h2>Signal Details</h2>
<div class="refsect2" lang="en">
<a name="id3766910"></a><h3>
<a name="GtkPlug-embedded"></a>The "embedded" signal</h3>
<a class="indexterm" name="id3766921"></a><pre class="programlisting">void user_function (<a href="GtkPlug.html" title="GtkPlug">GtkPlug</a> *plug,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run last</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>plug</code></em> :</span></td>
<td>the object which received the signal.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id3766990"></a><h2>See Also</h2>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><a href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a></span></td>
<td><p>the widget that a <a href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a> plugs into.</p></td>
</tr></tbody>
</table></div>
<p>
</p>
</div>
</div>
</body>
</html>