This file is indexed.

/usr/share/gtk-doc/html/libbonoboui/libbonoboui-bonobo-ui-container.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
201
202
203
204
205
206
207
208
209
210
211
212
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>BonoboUIContainer</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-ui.html" title="Bonobo UI">
<link rel="prev" href="libbonoboui-bonobo-ui-component.html" title="BonoboUIComponent">
<link rel="next" href="libbonoboui-bonobo-ui-util.html" title="bonobo-ui-util">
<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="libbonoboui-bonobo-ui-component.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="bonobo-ui.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-ui-util.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-ui-container.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#libbonoboui-bonobo-ui-container.description" class="shortcut">Description</a>
                   | 
                  <a href="#libbonoboui-bonobo-ui-container.object-hierarchy" class="shortcut">Object Hierarchy</a>
</td></tr>
</table>
<div class="refentry">
<a name="libbonoboui-bonobo-ui-container"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libbonoboui-bonobo-ui-container.top_of_page"></a>BonoboUIContainer</span></h2>
<p>BonoboUIContainer — The container interface as implemented for BonoboWindow</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libbonoboui-bonobo-ui-container.synopsis"></a><h2>Synopsis</h2>
<a name="BonoboUIContainer"></a><pre class="synopsis">                    <a class="link" href="libbonoboui-bonobo-ui-container.html#BonoboUIContainer-struct" title="BonoboUIContainer">BonoboUIContainer</a>;
                    <a class="link" href="libbonoboui-bonobo-ui-container.html#BonoboUIContainerPrivate" title="BonoboUIContainerPrivate">BonoboUIContainerPrivate</a>;
                    <a class="link" href="libbonoboui-bonobo-ui-container.html#BonoboUIContainerClass" title="BonoboUIContainerClass">BonoboUIContainerClass</a>;
<a class="link" href="libbonoboui-bonobo-ui-container.html#BonoboUIContainer"><span class="returnvalue">BonoboUIContainer</span></a> * <a class="link" href="libbonoboui-bonobo-ui-container.html#bonobo-ui-container-new" title="bonobo_ui_container_new ()">bonobo_ui_container_new</a>             (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">void</span>                <a class="link" href="libbonoboui-bonobo-ui-container.html#bonobo-ui-container-set-engine" title="bonobo_ui_container_set_engine ()">bonobo_ui_container_set_engine</a>      (<em class="parameter"><code><a class="link" href="libbonoboui-bonobo-ui-container.html#BonoboUIContainer"><span class="type">BonoboUIContainer</span></a> *container</code></em>,
                                                         <em class="parameter"><code><a class="link" href="libbonoboui-bonobo-ui-engine.html#BonoboUIEngine"><span class="type">BonoboUIEngine</span></a> *engine</code></em>);
<a class="link" href="libbonoboui-bonobo-ui-engine.html#BonoboUIEngine"><span class="returnvalue">BonoboUIEngine</span></a> *    <a class="link" href="libbonoboui-bonobo-ui-container.html#bonobo-ui-container-get-engine" title="bonobo_ui_container_get_engine ()">bonobo_ui_container_get_engine</a>      (<em class="parameter"><code><a class="link" href="libbonoboui-bonobo-ui-container.html#BonoboUIContainer"><span class="type">BonoboUIContainer</span></a> *container</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libbonoboui-bonobo-ui-container.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="/opt/gnome/share/gtk-doc/html/libbonobo/libbonobo-bonobo-object.html#BonoboObject">BonoboObject</a>
         +----BonoboUIContainer
</pre>
</div>
<div class="refsect1">
<a name="libbonoboui-bonobo-ui-container.description"></a><h2>Description</h2>
<p>
A BonoboUIContainer is a very thin object, it implements the CORBA
interface for doing UI merging, but none of the logic. In order
to achieve the effect it is associated with a BonoboUIEngine object.
Traditionaly the UI container was associated with a <a class="link" href="libbonoboui-bonobo-window.html#BonoboWindow"><span class="type">BonoboWindow</span></a>
however, this is now strongly deprecated, since the BonoboUIContainer
can be used with any <a class="link" href="libbonoboui-bonobo-ui-engine.html#BonoboUIEngine"><span class="type">BonoboUIEngine</span></a>, not just that used by BonoboWindow.
</p>
<p>
Here is how your code should interact with the BonoboUIContainer
  </p>
<div class="example">
<a name="id2806040"></a><p class="title"><b>Example 6. How to setup a BonoboUIContainer</b></p>
<div class="example-contents">
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
    <tbody>
      <tr>
        <td class="listing_lines" align="right"><pre>1
2
3
4
5
6
7
8
9
10
11</pre></td>
        <td class="listing_code"><pre class="programlisting"><span class="cbracket">{</span>
<span class="normal">    </span><span class="usertype">BonoboWindow</span><span class="normal">      </span><span class="symbol">*</span><span class="normal">window</span><span class="symbol">;</span>
<span class="normal">    </span><span class="usertype">BonoboUIEngine</span><span class="normal">    </span><span class="symbol">*</span><span class="normal">engine</span><span class="symbol">;</span>
<span class="normal">    </span><span class="usertype">BonoboUIContainer</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">container</span><span class="symbol">;</span>
<span class="normal">    window </span><span class="symbol">=</span><span class="normal"> </span><span class="function">BONOBO_WINDOW</span><span class="normal"> </span><span class="symbol">(</span>
<span class="normal">        </span><span class="function"><a href="libbonoboui-bonobo-window.html#bonobo-window-new">bonobo_window_new</a></span><span class="normal"> </span><span class="symbol">(</span><span class="string">"Window"</span><span class="symbol">,</span><span class="normal"> </span><span class="string">"My Test Application"</span><span class="symbol">));</span>
<span class="normal">    container </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="libbonoboui-bonobo-ui-container.html#bonobo-ui-container-new">bonobo_ui_container_new</a></span><span class="normal"> </span><span class="symbol">();</span>
<span class="normal">    engine </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="libbonoboui-bonobo-window.html#bonobo-window-get-ui-engine">bonobo_window_get_ui_engine</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">window</span><span class="symbol">);</span>
<span class="normal">    </span><span class="function"><a href="libbonoboui-bonobo-ui-container.html#bonobo-ui-container-set-engine">bonobo_ui_container_set_engine</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">container</span><span class="symbol">,</span><span class="normal"> engine</span><span class="symbol">);</span>
<span class="normal">    </span><span class="keyword">return</span><span class="normal"> window</span><span class="symbol">;</span>
<span class="cbracket">}</span></pre></td>
      </tr>
    </tbody>
  </table>
</div>

</div>
<p><br class="example-break">
</p>
</div>
<div class="refsect1">
<a name="libbonoboui-bonobo-ui-container.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="BonoboUIContainer-struct"></a><h3>BonoboUIContainer</h3>
<pre class="programlisting">typedef struct _BonoboUIContainer BonoboUIContainer;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="BonoboUIContainerPrivate"></a><h3>BonoboUIContainerPrivate</h3>
<pre class="programlisting">typedef struct _BonoboUIContainerPrivate BonoboUIContainerPrivate;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="BonoboUIContainerClass"></a><h3>BonoboUIContainerClass</h3>
<pre class="programlisting">typedef struct {
	BonoboObjectClass parent;

	POA_Bonobo_UIContainer__epv epv;

	gpointer dummy[2];
} BonoboUIContainerClass;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="bonobo-ui-container-new"></a><h3>bonobo_ui_container_new ()</h3>
<pre class="programlisting"><a class="link" href="libbonoboui-bonobo-ui-container.html#BonoboUIContainer"><span class="returnvalue">BonoboUIContainer</span></a> * bonobo_ui_container_new             (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a newly created BonoboUIContainer
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="bonobo-ui-container-set-engine"></a><h3>bonobo_ui_container_set_engine ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                bonobo_ui_container_set_engine      (<em class="parameter"><code><a class="link" href="libbonoboui-bonobo-ui-container.html#BonoboUIContainer"><span class="type">BonoboUIContainer</span></a> *container</code></em>,
                                                         <em class="parameter"><code><a class="link" href="libbonoboui-bonobo-ui-engine.html#BonoboUIEngine"><span class="type">BonoboUIEngine</span></a> *engine</code></em>);</pre>
<p>
Associates the BonoboUIContainer with a <a class="link" href="libbonoboui-bonobo-ui-engine.html#BonoboUIEngine"><span class="type">BonoboUIEngine</span></a>
that it will use to handle all the UI merging requests.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>container</code></em> :</span></p></td>
<td>the container
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>engine</code></em> :</span></p></td>
<td>the engine
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="bonobo-ui-container-get-engine"></a><h3>bonobo_ui_container_get_engine ()</h3>
<pre class="programlisting"><a class="link" href="libbonoboui-bonobo-ui-engine.html#BonoboUIEngine"><span class="returnvalue">BonoboUIEngine</span></a> *    bonobo_ui_container_get_engine      (<em class="parameter"><code><a class="link" href="libbonoboui-bonobo-ui-container.html#BonoboUIContainer"><span class="type">BonoboUIContainer</span></a> *container</code></em>);</pre>
<p>
Get the associated <a class="link" href="libbonoboui-bonobo-ui-engine.html#BonoboUIEngine"><span class="type">BonoboUIEngine</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>container</code></em> :</span></p></td>
<td>the UI container
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the engine
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="libbonoboui-bonobo-ui-container.see-also"></a><h2>See Also</h2>
<p>
<a class="link" href="libbonoboui-bonobo-ui-component.html#BonoboUIComponent"><span class="type">BonoboUIComponent</span></a>, <a class="link" href="libbonoboui-bonobo-ui-engine.html#BonoboUIEngine"><span class="type">BonoboUIEngine</span></a>, <a class="link" href="libbonoboui-bonobo-window.html#BonoboWindow"><span class="type">BonoboWindow</span></a>, <a class="link" href="libbonoboui-bonobo-ui-sync.html#BonoboUISync"><span class="type">BonoboUISync</span></a>,
 <a class="xref" href="libbonoboui-bonobo-ui-util.html" title="bonobo-ui-util"><span class="refentrytitle"><a name="libbonoboui-bonobo-ui-util.top_of_page"></a>bonobo-ui-util</span>(3)</a>
</p>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.15.1</div>
</body>
</html>