← Back to branch summary

~oif-team/ubuntu/natty/qt4-x11/xi2.1

« back to all changes in this revision

Viewing changes to doc/html/qx11embedcontainer.html

  • Committer: Bazaar Package Importer
  • Author(s): Alessandro Ghersi
  • Date: 2009-11-02 18:30:08 UTC
  • mfrom: (1.2.2 upstream)
  • mto: (15.2.5 experimental)
  • mto: This revision was merged to the branch mainline in revision 88.
  • Revision ID: james.westby@ubuntu.com-20091102183008-b6a4gcs128mvfb3m
Tags: upstream-4.6.0~beta1
Import upstream version 4.6.0~beta1

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/html/qx11embedcontainer.html
2
2
<!DOCTYPE html
3
3
    PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
4
4
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5
 
<!-- /fasttmp/mkdist-qt-4.5.2-1245473805/qt-x11-opensource-src-4.5.2/src/gui/kernel/qx11embed_x11.cpp -->
 
5
<!-- qx11embed_x11.cpp -->
6
6
<head>
7
 
  <title>Qt 4.5: QX11EmbedContainer Class Reference</title>
 
7
  <title>Qt 4.6: QX11EmbedContainer Class Reference</title>
8
8
  <link href="classic.css" rel="stylesheet" type="text/css" />
9
9
</head>
10
10
<body>
 
11
<a name="//apple_ref/cpp/cl//QX11EmbedContainer" />
11
12
<table border="0" cellpadding="0" cellspacing="0" width="100%">
12
13
<tr>
13
 
<td align="left" valign="top" width="32"><a href="http://qtsoftware.com/products/qt"><img src="images/qt-logo.png" align="left" border="0" /></a></td>
14
 
<td width="1">&nbsp;&nbsp;</td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a>&nbsp;&middot; <a href="namespaces.html"><font color="#004faf">All&nbsp;Namespaces</font></a>&nbsp;&middot; <a href="classes.html"><font color="#004faf">All&nbsp;Classes</font></a>&nbsp;&middot; <a href="mainclasses.html"><font color="#004faf">Main&nbsp;Classes</font></a>&nbsp;&middot; <a href="groups.html"><font color="#004faf">Grouped&nbsp;Classes</font></a>&nbsp;&middot; <a href="modules.html"><font color="#004faf">Modules</font></a>&nbsp;&middot; <a href="functions.html"><font color="#004faf">Functions</font></a></td>
15
 
<td align="right" valign="top" width="230"></td></tr></table><h1 class="title">QX11EmbedContainer Class Reference<br /><span class="small-subtitle">[<a href="qtgui.html">QtGui</a> module]</span>
 
14
<td align="left" valign="top" width="32"><a href="http://qt.nokia.com/"><img src="images/qt-logo.png" align="left" border="0" /></a></td>
 
15
<td width="1">&nbsp;&nbsp;</td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a>&nbsp;&middot; <a href="classes.html"><font color="#004faf">All&nbsp;Classes</font></a>&nbsp;&middot; <a href="functions.html"><font color="#004faf">All&nbsp;Functions</font></a>&nbsp;&middot; <a href="overviews.html"><font color="#004faf">Overviews</font></a></td><td class="searchBar" align="right" valign="center"><form action="http://www.google.com/cse" id="cse-search-box"><div><input type="hidden" name="cx" value="000136343326384750312:dhbxnqlakyu" /><input type="hidden" name="ie" value="UTF-8" /><input type="text" name="q" size="31" /><input type="submit" name="sa" value="Search" /></div></form></td>
 
16
</tr></table><h1 class="title">QX11EmbedContainer Class Reference<br /><span class="small-subtitle">[<a href="qtgui.html">QtGui</a> module]</span>
16
17
</h1>
17
18
<p>The QX11EmbedContainer class provides an XEmbed container widget. <a href="#details">More...</a></p>
18
19
<pre> #include &lt;QX11EmbedContainer&gt;</pre><p>Inherits <a href="qwidget.html">QWidget</a>.</p>
19
20
<ul>
20
21
<li><a href="qx11embedcontainer-members.html">List of all members, including inherited members</a></li>
21
22
</ul>
 
23
<hr />
22
24
<a name="public-types"></a>
23
 
<h3>Public Types</h3>
24
 
<ul>
25
 
<li><div class="fn"></div>enum <b><a href="qx11embedcontainer.html#Error-enum">Error</a></b> { Unknown, InvalidWindowID }</li>
26
 
</ul>
 
25
<h2>Public Types</h2>
 
26
<table class="alignedsummary" border="0" cellpadding="0" cellspacing="0" width="100%">
 
27
<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><b><a href="qx11embedcontainer.html#Error-enum">Error</a></b> { Unknown, InvalidWindowID }</td></tr>
 
28
</table>
 
29
<hr />
27
30
<a name="public-functions"></a>
28
 
<h3>Public Functions</h3>
29
 
<ul>
30
 
<li><div class="fn"></div><b><a href="qx11embedcontainer.html#QX11EmbedContainer">QX11EmbedContainer</a></b> ( QWidget * <i>parent</i> = 0 )</li>
31
 
<li><div class="fn"></div><b><a href="qx11embedcontainer.html#dtor.QX11EmbedContainer">~QX11EmbedContainer</a></b> ()</li>
32
 
<li><div class="fn"></div>WId <b><a href="qx11embedcontainer.html#clientWinId">clientWinId</a></b> () const</li>
33
 
<li><div class="fn"></div>void <b><a href="qx11embedcontainer.html#discardClient">discardClient</a></b> ()</li>
34
 
<li><div class="fn"></div>void <b><a href="qx11embedcontainer.html#embedClient">embedClient</a></b> ( WId <i>id</i> )</li>
35
 
<li><div class="fn"></div>Error <b><a href="qx11embedcontainer.html#error">error</a></b> () const</li>
36
 
</ul>
37
 
<ul>
38
 
<li><div class="fn"></div>207 public functions inherited from <a href="qwidget.html#public-functions">QWidget</a></li>
39
 
<li><div class="fn"></div>29 public functions inherited from <a href="qobject.html#public-functions">QObject</a></li>
40
 
<li><div class="fn"></div>12 public functions inherited from <a href="qpaintdevice.html#public-functions">QPaintDevice</a></li>
41
 
</ul>
 
31
<h2>Public Functions</h2>
 
32
<table class="alignedsummary" border="0" cellpadding="0" cellspacing="0" width="100%">
 
33
<tr><td class="memItemLeft" align="right" valign="top"></td><td class="memItemRight" valign="bottom"><b><a href="qx11embedcontainer.html#QX11EmbedContainer">QX11EmbedContainer</a></b> ( QWidget * <i>parent</i> = 0 )</td></tr>
 
34
<tr><td class="memItemLeft" align="right" valign="top"></td><td class="memItemRight" valign="bottom"><b><a href="qx11embedcontainer.html#dtor.QX11EmbedContainer">~QX11EmbedContainer</a></b> ()</td></tr>
 
35
<tr><td class="memItemLeft" align="right" valign="top">WId </td><td class="memItemRight" valign="bottom"><b><a href="qx11embedcontainer.html#clientWinId">clientWinId</a></b> () const</td></tr>
 
36
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qx11embedcontainer.html#discardClient">discardClient</a></b> ()</td></tr>
 
37
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qx11embedcontainer.html#embedClient">embedClient</a></b> ( WId <i>id</i> )</td></tr>
 
38
<tr><td class="memItemLeft" align="right" valign="top">Error </td><td class="memItemRight" valign="bottom"><b><a href="qx11embedcontainer.html#error">error</a></b> () const</td></tr>
 
39
</table>
 
40
<ul>
 
41
<li><div bar="2" class="fn"></div>215 public functions inherited from <a href="qwidget.html#public-functions">QWidget</a></li>
 
42
<li><div bar="2" class="fn"></div>29 public functions inherited from <a href="qobject.html#public-functions">QObject</a></li>
 
43
<li><div bar="2" class="fn"></div>12 public functions inherited from <a href="qpaintdevice.html#public-functions">QPaintDevice</a></li>
 
44
</ul>
 
45
<hr />
42
46
<a name="signals"></a>
43
 
<h3>Signals</h3>
 
47
<h2>Signals</h2>
 
48
<table class="alignedsummary" border="0" cellpadding="0" cellspacing="0" width="100%">
 
49
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qx11embedcontainer.html#clientClosed">clientClosed</a></b> ()</td></tr>
 
50
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qx11embedcontainer.html#clientIsEmbedded">clientIsEmbedded</a></b> ()</td></tr>
 
51
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qx11embedcontainer.html#error-2">error</a></b> ( QX11EmbedContainer::Error <i>error</i> )</td></tr>
 
52
</table>
44
53
<ul>
45
 
<li><div class="fn"></div>void <b><a href="qx11embedcontainer.html#clientClosed">clientClosed</a></b> ()</li>
46
 
<li><div class="fn"></div>void <b><a href="qx11embedcontainer.html#clientIsEmbedded">clientIsEmbedded</a></b> ()</li>
47
 
<li><div class="fn"></div>void <b><a href="qx11embedcontainer.html#error-2">error</a></b> ( QX11EmbedContainer::Error <i>error</i> )</li>
 
54
<li><div bar="2" class="fn"></div>1 signal inherited from <a href="qwidget.html#signals">QWidget</a></li>
 
55
<li><div bar="2" class="fn"></div>1 signal inherited from <a href="qobject.html#signals">QObject</a></li>
48
56
</ul>
 
57
<hr />
 
58
<a name="reimplemented-protected-functions"></a>
 
59
<h2>Reimplemented Protected Functions</h2>
 
60
<table class="alignedsummary" border="0" cellpadding="0" cellspacing="0" width="100%">
 
61
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><b><a href="qx11embedcontainer.html#event">event</a></b> ( QEvent * <i>event</i> )</td></tr>
 
62
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><b><a href="qx11embedcontainer.html#paintEvent">paintEvent</a></b> ( QPaintEvent * <i>e</i> )</td></tr>
 
63
</table>
49
64
<ul>
50
 
<li><div class="fn"></div>1 signal inherited from <a href="qwidget.html#signals">QWidget</a></li>
51
 
<li><div class="fn"></div>1 signal inherited from <a href="qobject.html#signals">QObject</a></li>
 
65
<li><div bar="2" class="fn"></div>37 protected functions inherited from <a href="qwidget.html#protected-functions">QWidget</a></li>
 
66
<li><div bar="2" class="fn"></div>7 protected functions inherited from <a href="qobject.html#protected-functions">QObject</a></li>
 
67
<li><div bar="2" class="fn"></div>1 protected function inherited from <a href="qpaintdevice.html#protected-functions">QPaintDevice</a></li>
52
68
</ul>
53
69
<h3>Additional Inherited Members</h3>
54
70
<ul>
55
 
<li><div class="fn"></div>57 properties inherited from <a href="qwidget.html#properties">QWidget</a></li>
 
71
<li><div class="fn"></div>58 properties inherited from <a href="qwidget.html#properties">QWidget</a></li>
56
72
<li><div class="fn"></div>1 property inherited from <a href="qobject.html#properties">QObject</a></li>
57
73
<li><div class="fn"></div>19 public slots inherited from <a href="qwidget.html#public-slots">QWidget</a></li>
58
74
<li><div class="fn"></div>1 public slot inherited from <a href="qobject.html#public-slots">QObject</a></li>
96
112
 }</pre>
97
113
<p>When the client widget is embedded, the container emits the signal <a href="qx11embedcontainer.html#clientIsEmbedded">clientIsEmbedded</a>(). The signal <a href="qx11embedcontainer.html#clientClosed">clientClosed</a>() is emitted when a widget is closed.</p>
98
114
<p>It is possible for QX11EmbedContainer to embed XEmbed widgets from toolkits other than Qt, such as GTK+. Arbitrary (non-XEmbed) X11 widgets can also be embedded, but the XEmbed-specific features such as window activation and focus handling are then lost.</p>
99
 
<p>The GTK+ equivalent of QX11EmbedContainer is GtkSocket. The KDE widget is called QXEmbed.</p>
 
115
<p>The GTK+ equivalent of QX11EmbedContainer is GtkSocket. The corresponding KDE 3 widget is called QXEmbed.</p>
100
116
<p>See also <a href="qx11embedwidget.html">QX11EmbedWidget</a> and <a href="http://www.freedesktop.org/Standards/xembed-spec">XEmbed Specification</a>.</p>
101
117
<hr />
102
118
<h2>Member Type Documentation</h2>
 
119
<a name="//apple_ref/cpp/tag/QX11EmbedContainer/Error" />
 
120
<a name="//apple_ref/cpp/econst/QX11EmbedContainer/Unknown" />
 
121
<a name="//apple_ref/cpp/econst/QX11EmbedContainer/InvalidWindowID" />
 
122
<a name="//apple_ref/cpp/econst/QX11EmbedContainer/Internal" />
103
123
<h3 class="fn"><a name="Error-enum"></a>enum QX11EmbedContainer::Error</h3>
104
 
<p><table border="1" cellpadding="2" cellspacing="1" width="100%">
 
124
<p><table class="valuelist" border="1" cellpadding="2" cellspacing="1" width="100%">
105
125
<tr><th width="25%">Constant</th><th width="15%">Value</th><th width="60%">Description</th></tr>
106
126
<tr><td valign="top"><tt>QX11EmbedContainer::Unknown</tt></td><td align="center" valign="top"><tt>0</tt></td><td valign="top">An unrecognized error occurred.</td></tr>
107
127
<tr><td valign="top"><tt>QX11EmbedContainer::InvalidWindowID</tt></td><td align="center" valign="top"><tt>2</tt></td><td valign="top">The X11 window ID of the container was invalid. This error is usually triggered by passing an invalid window ID to embed().</td></tr>
108
128
</table></p>
109
129
<hr />
110
130
<h2>Member Function Documentation</h2>
 
131
<a name="//apple_ref/cpp/instm/QX11EmbedContainer/QX11EmbedContainer" />
111
132
<h3 class="fn"><a name="QX11EmbedContainer"></a>QX11EmbedContainer::QX11EmbedContainer ( <a href="qwidget.html">QWidget</a> * <i>parent</i> = 0 )</h3>
112
133
<p>Creates a <a href="qx11embedcontainer.html">QX11EmbedContainer</a> object with the given <i>parent</i>.</p>
 
134
<a name="//apple_ref/cpp/instm/QX11EmbedContainer/~QX11EmbedContainer" />
113
135
<h3 class="fn"><a name="dtor.QX11EmbedContainer"></a>QX11EmbedContainer::~QX11EmbedContainer ()</h3>
114
136
<p>Destructs a <a href="qx11embedcontainer.html">QX11EmbedContainer</a>.</p>
 
137
<a name="//apple_ref/cpp/instm/QX11EmbedContainer/clientClosed" />
115
138
<h3 class="fn"><a name="clientClosed"></a>void QX11EmbedContainer::clientClosed ()&nbsp;&nbsp;<tt> [signal]</tt></h3>
116
139
<p>This signal is emitted by the container when the client widget closes.</p>
 
140
<a name="//apple_ref/cpp/instm/QX11EmbedContainer/clientIsEmbedded" />
117
141
<h3 class="fn"><a name="clientIsEmbedded"></a>void QX11EmbedContainer::clientIsEmbedded ()&nbsp;&nbsp;<tt> [signal]</tt></h3>
118
142
<p>This signal is emitted by the container when a client widget has been embedded.</p>
 
143
<a name="//apple_ref/cpp/instm/QX11EmbedContainer/clientWinId" />
119
144
<h3 class="fn"><a name="clientWinId"></a><a href="qwidget.html#WId-typedef">WId</a> QX11EmbedContainer::clientWinId () const</h3>
120
145
<p>If the container has an embedded widget, this function returns the X11 window ID of the client; otherwise it returns 0.</p>
 
146
<a name="//apple_ref/cpp/instm/QX11EmbedContainer/discardClient" />
121
147
<h3 class="fn"><a name="discardClient"></a>void QX11EmbedContainer::discardClient ()</h3>
122
148
<p>Detaches the client from the embedder. The client will appear as a standalone window on the desktop.</p>
 
149
<a name="//apple_ref/cpp/instm/QX11EmbedContainer/embedClient" />
123
150
<h3 class="fn"><a name="embedClient"></a>void QX11EmbedContainer::embedClient ( <a href="qwidget.html#WId-typedef">WId</a> <i>id</i> )</h3>
124
151
<p>Instructs the container to embed the X11 window with window ID <i>id</i>. The client widget will then move on top of the container window and be resized to fit into the container.</p>
125
152
<p>The <i>id</i> should be the ID of a window controlled by an XEmbed enabled application, but this is not mandatory. If <i>id</i> does not belong to an XEmbed client widget, then focus handling, activation, accelerators and other features will not work properly.</p>
 
153
<a name="//apple_ref/cpp/instm/QX11EmbedContainer/error" />
126
154
<h3 class="fn"><a name="error"></a><a href="qx11embedcontainer.html#Error-enum">Error</a> QX11EmbedContainer::error () const</h3>
127
155
<p>Returns the last error that occurred.</p>
128
156
<h3 class="fn"><a name="error-2"></a>void QX11EmbedContainer::error ( <a href="qx11embedcontainer.html#Error-enum">QX11EmbedContainer::Error</a> <i>error</i> )&nbsp;&nbsp;<tt> [signal]</tt></h3>
129
157
<p>This signal is emitted if an error occurred when embedding or communicating with a client. The specified <i>error</i> describes the problem that occurred.</p>
130
158
<p>See also <a href="qx11embedcontainer.html#Error-enum">QX11EmbedContainer::Error</a>.</p>
 
159
<a name="//apple_ref/cpp/instm/QX11EmbedContainer/event" />
 
160
<h3 class="fn"><a name="event"></a>bool QX11EmbedContainer::event ( <a href="qevent.html">QEvent</a> * <i>event</i> )&nbsp;&nbsp;<tt> [virtual protected]</tt></h3>
 
161
<p>Reimplemented from <a href="qobject.html#event">QObject::event</a>().</p>
 
162
<a name="//apple_ref/cpp/instm/QX11EmbedContainer/paintEvent" />
 
163
<h3 class="fn"><a name="paintEvent"></a>void QX11EmbedContainer::paintEvent ( <a href="qpaintevent.html">QPaintEvent</a> * <i>e</i> )&nbsp;&nbsp;<tt> [virtual protected]</tt></h3>
 
164
<p>Reimplemented from <a href="qwidget.html#paintEvent">QWidget::paintEvent</a>().</p>
131
165
<p /><address><hr /><div align="center">
132
166
<table width="100%" cellspacing="0" border="0"><tr class="address">
133
 
<td width="30%" align="left">Copyright &copy; 2009 Nokia Corporation and/or its subsidiary(-ies)</td>
134
 
<td width="40%" align="center"><a href="trademarks.html">Trademarks</a></td>
135
 
<td width="30%" align="right"><div align="right">Qt 4.5.2</div></td>
136
 
</tr></table></div></address></body>
 
167
<td width="40%" align="left">Copyright &copy; 2009 Nokia Corporation and/or its subsidiary(-ies)</td>
 
168
<td width="20%" align="center"><a href="trademarks.html">Trademarks</a></td>
 
169
<td width="40%" align="right"><div align="right">Qt 4.6.0</div></td>
 
170
<script type="text/javascript" src="http://www.google.com/jsapi"></script><script type="text/javascript">google.load("elements", "1", {packages: "transliteration"});</script><script type="text/javascript" src="http://www.google.com/coop/cse/t13n?form=cse-search-box&t13n_langs=en"></script><script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=cse-search-box&lang=en"></script></tr></table></div></address></body>
137
171
</html>