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
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta content="text/html; charset=ISO-8859-1"
http-equiv="content-type">
<title>GTK+ Foundation Classes</title>
<link href="gfc.css" rel="stylesheet" type="text/css">
<meta content="The GFC Development Team" name="author">
<meta content="Core Library Reference Manual" name="description">
</head>
<body style="color: rgb(0, 0, 0); background-color: rgb(243, 244, 248);"
alink="#000099" link="#000099" vlink="#990099">
<table style="text-align: left; width: 1227px; height: 117px;"
border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td
style="text-align: center; background-color: rgb(255, 255, 255); width: 220px; vertical-align: top;"><img
alt="GFC Logo" src="../images/gfc.png"
style="width: 207px; height: 92px;"></td>
<td
style="text-align: center; background-color: rgb(87, 107, 152); vertical-align: middle;"><img
alt="GFC Title Logo" src="../images/gfc-title.png"
style="width: 418px; height: 76px;"><br>
</td>
</tr>
<tr>
<td
style="text-align: center; background-color: rgb(65, 77, 104); vertical-align: middle;"><big><span
style="color: rgb(255, 255, 153); font-weight: bold;">Reference Manual</span></big><br>
</td>
<td
style="text-align: center; background-color: rgb(148, 164, 200); vertical-align: middle;"><small
style="font-family: helvetica,arial,sans-serif;"><a
href="../html/index.html">Main Page</a> | <a
href="../html/namespaces.html">Namespace List</a> | <a
href="classes.html">Alphabetical List</a> | <a
href="../html/annotated.html">Class List</a> | <a
href="../html/files.html">File List</a></small><br>
</td>
</tr>
</tbody>
</table>
<small> </small>
</body>
</html>
<!-- Generated by Doxygen 1.3.8 -->
<h1>GFC::Gtk::Plug Class Reference</h1>A GtkPlug C++ wrapper class.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="plug_8hh-source.html">gfc/gtk/plug.hh</a>></code>
<p>
<p>Inheritance diagram for GFC::Gtk::Plug:
<p><center><img src="classGFC_1_1Gtk_1_1Plug.png" usemap="#GFC::Gtk::Plug_map" border="0" alt=""></center>
<map name="GFC::Gtk::Plug_map">
<area href="classGFC_1_1Gtk_1_1Window.html" alt="GFC::Gtk::Window" shape="rect" coords="73,392,210,416">
<area href="classGFC_1_1Gtk_1_1Bin.html" alt="GFC::Gtk::Bin" shape="rect" coords="73,336,210,360">
<area href="classGFC_1_1Gtk_1_1Container.html" alt="GFC::Gtk::Container" shape="rect" coords="73,280,210,304">
<area href="classGFC_1_1Gtk_1_1Widget.html" alt="GFC::Gtk::Widget" shape="rect" coords="73,224,210,248">
<area href="classGFC_1_1Gtk_1_1Object.html" alt="GFC::Gtk::Object" shape="rect" coords="0,168,137,192">
<area href="classGFC_1_1Atk_1_1Implementor.html" alt="GFC::Atk::Implementor" shape="rect" coords="147,168,284,192">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Object.html" alt="GFC::G::Object" shape="rect" coords="0,112,137,136">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1TypeInterface.html" alt="GFC::G::TypeInterface" shape="rect" coords="147,112,284,136">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1TypeInstance.html" alt="GFC::G::TypeInstance" shape="rect" coords="0,56,137,80">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1TypeInstance.html" alt="GFC::G::TypeInstance" shape="rect" coords="147,56,284,80">
<area doxygen="gfccore.tag:" href="classGFC_1_1Trackable.html" alt="GFC::Trackable" shape="rect" coords="0,0,137,24">
<area doxygen="gfccore.tag:" href="classGFC_1_1Trackable.html" alt="GFC::Trackable" shape="rect" coords="147,0,284,24">
</map>
<a href="classGFC_1_1Gtk_1_1Plug-members.html">List of all members.</a><h2>Signal Prototypes</h2>
<ul>
<li>const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Signal.html">EmbeddedSignalType</a> <a class="el" href="classGFC_1_1Gtk_1_1Plug.html#z695_2">embedded_signal</a>
<dl class="el"><dd class="mdescRight">Embedded signal (see <a class="el" href="classGFC_1_1Gtk_1_1Plug.html#z698_0">sig_embedded()</a>). <a href="#z695_2"></a><br></dl></ul>
<h2>Public Member Functions</h2>
<tr><td colspan="2"><div class="groupHeader">Constructors</div></td></tr>
<ul>
<li><a class="el" href="classGFC_1_1Gtk_1_1Plug.html#z696_0">Plug</a> (GdkNativeWindow socket_id, const <a class="el" href="classGFC_1_1Gdk_1_1Display.html">Gdk::Display</a> *display=0)
<dl class="el"><dd class="mdescRight">Constructs a new plug widget inside the <a class="el" href="classGFC_1_1Gtk_1_1Socket.html">Socket</a> identified by socket_id. <a href="#z696_0"></a><br></dl><li><a class="anchor" name="z696_1" doxytag="GFC::Gtk::Plug::~Plug" ></a>
virtual <a class="el" href="classGFC_1_1Gtk_1_1Plug.html#z696_1">~Plug</a> ()
<dl class="el"><dd class="mdescRight">Destructor. <br></dl></ul>
<tr><td colspan="2"><div class="groupHeader">Accessors</div></td></tr>
<ul>
<li><a class="anchor" name="z697_0" doxytag="GFC::Gtk::Plug::gtk_plug" ></a>
GtkPlug * <a class="el" href="classGFC_1_1Gtk_1_1Plug.html#z697_0">gtk_plug</a> () const
<dl class="el"><dd class="mdescRight">Get a pointer to the GtkPlug structure. <br></dl><li><a class="anchor" name="z697_1" doxytag="GFC::Gtk::Plug::operator GtkPlug *" ></a>
<a class="el" href="classGFC_1_1Gtk_1_1Plug.html#z697_1">operator GtkPlug *</a> () const
<dl class="el"><dd class="mdescRight">Conversion operator; safely converts a <a class="el" href="classGFC_1_1Gtk_1_1Plug.html">Plug</a> to a GtkPlug pointer. <br></dl><li><a class="anchor" name="z697_2" doxytag="GFC::Gtk::Plug::has_socket" ></a>
bool <a class="el" href="classGFC_1_1Gtk_1_1Plug.html#z697_2">has_socket</a> () const
<dl class="el"><dd class="mdescRight">Returns true if this plug is embedded into a socket. <br></dl><li><a class="anchor" name="z697_3" doxytag="GFC::Gtk::Plug::socket_window" ></a>
<a class="el" href="classGFC_1_1Gdk_1_1Window.html">Gdk::Window</a> * <a class="el" href="classGFC_1_1Gtk_1_1Plug.html#z697_3">socket_window</a> () const
<dl class="el"><dd class="mdescRight">Returns the socket window the plug is embedded into, or null if it is not embedded. <br></dl><li><a class="anchor" name="z697_4" doxytag="GFC::Gtk::Plug::same_app" ></a>
bool <a class="el" href="classGFC_1_1Gtk_1_1Plug.html#z697_4">same_app</a> () const
<dl class="el"><dd class="mdescRight">Return true if the plug is embedded into a socket in the same application. <br></dl><li>GdkNativeWindow <a class="el" href="classGFC_1_1Gtk_1_1Plug.html#z697_5">get_id</a> () const
<dl class="el"><dd class="mdescRight">Gets the window ID of a <a class="el" href="classGFC_1_1Gtk_1_1Plug.html">Plug</a> widget, which can then be used to embed this window inside another window, for instance with <a class="el" href="classGFC_1_1Gtk_1_1Socket.html#z819_0">Gtk::Socket::add_id()</a>. <a href="#z697_5"></a><br></dl></ul>
<tr><td colspan="2"><div class="groupHeader">Signal Proxies</div></td></tr>
<ul>
<li><a class="anchor" name="z698_0" doxytag="GFC::Gtk::Plug::sig_embedded" ></a>
const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1SignalProxy.html">EmbeddedSignalProxy</a> <a class="el" href="classGFC_1_1Gtk_1_1Plug.html#z698_0">sig_embedded</a> ()
<dl class="el"><dd class="mdescRight">Connect to the embedded_signal; emitted when a plug is embedded into a socket. <br></dl></ul>
<h2>Protected Member Functions</h2>
<tr><td colspan="2"><div class="groupHeader">Constructors</div></td></tr>
<ul>
<li><a class="el" href="classGFC_1_1Gtk_1_1Plug.html#z694_0">Plug</a> (GtkPlug *plug, bool <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1Trackable.html#z143_1">owns_reference</a>=false)
<dl class="el"><dd class="mdescRight">Construct a new <a class="el" href="classGFC_1_1Gtk_1_1Plug.html">Plug</a> from an existing GtkPlug. <a href="#z694_0"></a><br></dl></ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A GtkPlug C++ wrapper class.
<p>
Together with <a class="el" href="classGFC_1_1Gtk_1_1Socket.html">Socket</a>, <a class="el" href="classGFC_1_1Gtk_1_1Plug.html">Plug</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="el" href="classGFC_1_1Gtk_1_1Socket.html">Socket</a> widget and, passes the ID of that widgets window to the other process, which then creates a <a class="el" href="classGFC_1_1Gtk_1_1Plug.html">Plug</a> with that window ID. Any widgets contained in the <a class="el" href="classGFC_1_1Gtk_1_1Plug.html">Plug</a> then will appear inside the first applications window.
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="z694_0" doxytag="GFC::Gtk::Plug::Plug" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> GFC::Gtk::Plug::Plug </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">GtkPlug * </td>
<td class="mdname" nowrap> <em>plug</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>bool </td>
<td class="mdname" nowrap> <em>owns_reference</em> = <code>false</code></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [explicit, protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Construct a new <a class="el" href="classGFC_1_1Gtk_1_1Plug.html">Plug</a> from an existing GtkPlug.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>plug</em> </td><td>A pointer to a GtkPlug. </td></tr>
<tr><td></td><td valign=top><em>owns_reference</em> </td><td>Set false if the initial reference count is floating, set true if it's not.</td></tr>
</table>
</dl>
<br>
The <em>plug</em> can be a newly created GtkPlug or an existing GtkPlug (see <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Object.html#z68_0">G::Object::Object</a>). </td>
</tr>
</table>
<a class="anchor" name="z696_0" doxytag="GFC::Gtk::Plug::Plug" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> GFC::Gtk::Plug::Plug </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">GdkNativeWindow </td>
<td class="mdname" nowrap> <em>socket_id</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>const <a class="el" href="classGFC_1_1Gdk_1_1Display.html">Gdk::Display</a> * </td>
<td class="mdname" nowrap> <em>display</em> = <code>0</code></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Constructs a new plug widget inside the <a class="el" href="classGFC_1_1Gtk_1_1Socket.html">Socket</a> identified by socket_id.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>socket_id</em> </td><td>The XID of the socket's window. </td></tr>
<tr><td></td><td valign=top><em>display</em> </td><td>The <a class="el" href="classGFC_1_1Gdk_1_1Display.html">Gdk::Display</a> on which socket_id is displayed, or null for the default display.</td></tr>
</table>
</dl>
<br>
If socket_id is 0, the plug is left "unplugged" and can later be plugged into a <a class="el" href="classGFC_1_1Gtk_1_1Socket.html">Socket</a> by <a class="el" href="classGFC_1_1Gtk_1_1Socket.html#z819_0">Gtk::Socket::add_id()</a>.<p>
<b>Note:</b> The default GDK display is the only display in the absence of MultiHead support. </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="z697_5" doxytag="GFC::Gtk::Plug::get_id" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> GdkNativeWindow GFC::Gtk::Plug::get_id </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Gets the window ID of a <a class="el" href="classGFC_1_1Gtk_1_1Plug.html">Plug</a> widget, which can then be used to embed this window inside another window, for instance with <a class="el" href="classGFC_1_1Gtk_1_1Socket.html#z819_0">Gtk::Socket::add_id()</a>.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>The window ID for the plug. </dd></dl>
</td>
</tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="z695_2" doxytag="GFC::Gtk::Plug::embedded_signal" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Signal.html">EmbeddedSignalType</a> <a class="el" href="classGFC_1_1Gtk_1_1Plug.html#z695_2">GFC::Gtk::Plug::embedded_signal</a><code> [static, protected]</code> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Embedded signal (see <a class="el" href="classGFC_1_1Gtk_1_1Plug.html#z698_0">sig_embedded()</a>).
<p>
Calls a slot with the signature: <div class="fragment"><pre> <span class="keywordtype">void</span> function();
</pre></div> </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="plug_8hh-source.html">plug.hh</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Tue Aug 24 00:34:41 2004 for GFC-UI by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 ></a> 1.3.8 </small></address>
</body>
</html>
|
