|
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/libbonoboui/ |
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>BonoboSelector</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
<link rel="start" href="index.html" title="LibBonoboUI API Reference Manual">
<link rel="up" href="bonobo-support-utilities.html" title="Supporting Classes">
<link rel="prev" href="libbonoboui-bonobo-wrapper.html" title="bonobo-wrapper">
<link rel="next" href="libbonoboui-bonobo-selector-widget.html" title="bonobo-selector-widget">
<meta name="generator" content="GTK-Doc V1.7 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="ch01.html" title="Object Hierarchy">
<link rel="chapter" href="bonobo-controls.html" title="Controls">
<link rel="chapter" href="bonobo-ui.html" title="Bonobo UI">
<link rel="chapter" href="bonobo-support-utilities.html" title="Supporting Classes">
</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-wrapper.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-selector-widget.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="#id2830795" class="shortcut">Top</a>
 | 
<a href="#id2831228" class="shortcut">Description</a>
 | 
<a href="#id2831013" class="shortcut">Object Hierarchy</a>
 | 
<a href="#id2831090" class="shortcut">Implemented Interfaces</a>
 | 
<a href="#id2831112" class="shortcut">Properties</a>
 | 
<a href="#id2831147" class="shortcut">Signals</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="libbonoboui-bonobo-selector"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2830795"></a><span class="refentrytitle">BonoboSelector</span>
</h2>
<p>BonoboSelector — a component selector widget</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<a name="BonoboSelector"></a><pre class="synopsis">
<a href="libbonoboui-bonobo-selector.html#BonoboSelectorPrivate">BonoboSelectorPrivate</a>;
<a href="libbonoboui-bonobo-selector.html#BonoboSelector-struct">BonoboSelector</a>;
<a href="libbonoboui-bonobo-selector.html#BonoboSelectorClass">BonoboSelectorClass</a>;
<a
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
>GtkWidget</a>* <a href="libbonoboui-bonobo-selector.html#bonobo-selector-construct">bonobo_selector_construct</a> (<a href="libbonoboui-bonobo-selector.html#BonoboSelector">BonoboSelector</a> *sel,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *title,
<a href="libbonoboui-bonobo-selector-widget.html#BonoboSelectorWidget">BonoboSelectorWidget</a> *selector);
<a
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
>GtkWidget</a>* <a href="libbonoboui-bonobo-selector.html#bonobo-selector-new">bonobo_selector_new</a> (const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *title,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> **interfaces_required);
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a>* <a href="libbonoboui-bonobo-selector.html#bonobo-selector-get-selected-id">bonobo_selector_get_selected_id</a> (<a href="libbonoboui-bonobo-selector.html#BonoboSelector">BonoboSelector</a> *sel);
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a>* <a href="libbonoboui-bonobo-selector.html#bonobo-selector-get-selected-name">bonobo_selector_get_selected_name</a>
(<a href="libbonoboui-bonobo-selector.html#BonoboSelector">BonoboSelector</a> *sel);
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a>* <a href="libbonoboui-bonobo-selector.html#bonobo-selector-get-selected-description">bonobo_selector_get_selected_description</a>
(<a href="libbonoboui-bonobo-selector.html#BonoboSelector">BonoboSelector</a> *sel);
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a>* <a href="libbonoboui-bonobo-selector.html#bonobo-selector-select-id">bonobo_selector_select_id</a> (const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *title,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> **interfaces_required);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2831013"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"
>GObject</a>
+----<a
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned"
>GInitiallyUnowned</a>
+----<a
href="/usr/share/gtk-doc/html/gtk/GtkObject.html"
>GtkObject</a>
+----<a
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
>GtkWidget</a>
+----<a
href="/usr/share/gtk-doc/html/gtk/GtkContainer.html"
>GtkContainer</a>
+----<a
href="/usr/share/gtk-doc/html/gtk/GtkBin.html"
>GtkBin</a>
+----<a
href="/usr/share/gtk-doc/html/gtk/GtkWindow.html"
>GtkWindow</a>
+----<a
href="/usr/share/gtk-doc/html/gtk/GtkDialog.html"
>GtkDialog</a>
+----BonoboSelector
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2831090"></a><h2>Implemented Interfaces</h2>
<p>
BonoboSelector implements
AtkImplementorIface.</p>
</div>
<div class="refsect1" lang="en">
<a name="id2831112"></a><h2>Properties</h2>
<pre class="synopsis">
"<a href="libbonoboui-bonobo-selector.html#BonoboSelector--interfaces-required">interfaces-required</a>" <a
href="/usr/share/gtk-doc/html/gobject/gobject-Value-arrays.html#GValueArray"
>GValueArray</a> : Write / Construct
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2831147"></a><h2>Signals</h2>
<pre class="synopsis">
"<a href="libbonoboui-bonobo-selector.html#BonoboSelector-cancel">cancel</a>" void user_function (<a href="libbonoboui-bonobo-selector.html#BonoboSelector">BonoboSelector</a> *bonoboselector,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run last
"<a href="libbonoboui-bonobo-selector.html#BonoboSelector-ok">ok</a>" void user_function (<a href="libbonoboui-bonobo-selector.html#BonoboSelector">BonoboSelector</a> *bonoboselector,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run last
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2831228"></a><h2>Description</h2>
<p>
This <a
href="/usr/share/gtk-doc/html/libgnomeui/GnomeDialog.html"
><span class="type">GnomeDialog</span></a> allows the user to select a component implementing
a set of interfaces. The easiest way to do this in your code is by
using:
</p>
<div class="example">
<a name="id2831252"></a><p class="title"><b>Example 2. Simple Bonobo/Control selection</b></p>
<pre class="programlisting">
{
char *interfaces [] = { "IDL:Bonobo/Control:1.0", NULL };
char *oaf_iid;
oaf_iid = bonobo_selector_select_id (
_("Please select a Control"), interfaces);
g_warning ("You selected '<code class="literal">s</code>'", oaf_iid);
g_free (oaf_iid);
}
</pre>
</div>
<p>
This will throw up a dialog containing all the available components
implementing the IDL:Bonobo/Control:1.0 interface and list them for
the user to select.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2831284"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2831295"></a><h3>
<a name="BonoboSelectorPrivate"></a>BonoboSelectorPrivate</h3>
<a class="indexterm" name="id2831308"></a><pre class="programlisting">typedef struct _BonoboSelectorPrivate BonoboSelectorPrivate;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2831324"></a><h3>
<a name="BonoboSelector-struct"></a>BonoboSelector</h3>
<a class="indexterm" name="id2831337"></a><pre class="programlisting">typedef struct _BonoboSelector BonoboSelector;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2831353"></a><h3>
<a name="BonoboSelectorClass"></a>BonoboSelectorClass</h3>
<a class="indexterm" name="id2831365"></a><pre class="programlisting">typedef struct {
GtkDialogClass parent_class;
void (* ok) (BonoboSelector *sel);
void (* cancel) (BonoboSelector *sel);
gpointer dummy[2];
} BonoboSelectorClass;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2831383"></a><h3>
<a name="bonobo-selector-construct"></a>bonobo_selector_construct ()</h3>
<a class="indexterm" name="id2831397"></a><pre class="programlisting"><a
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
>GtkWidget</a>* bonobo_selector_construct (<a href="libbonoboui-bonobo-selector.html#BonoboSelector">BonoboSelector</a> *sel,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *title,
<a href="libbonoboui-bonobo-selector-widget.html#BonoboSelectorWidget">BonoboSelectorWidget</a> *selector);</pre>
<p>
Don't use this ever - use construct-time properties instead.
TODO: Remove from header when we are allowed to change the API.
Constructs the innards of a bonobo selector window.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>sel</code></em> :</span></td>
<td> the selector to construct
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>title</code></em> :</span></td>
<td> the title for the window
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>selector</code></em> :</span></td>
<td> the component view widget to put inside it.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the constructed widget.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2831505"></a><h3>
<a name="bonobo-selector-new"></a>bonobo_selector_new ()</h3>
<a class="indexterm" name="id2831518"></a><pre class="programlisting"><a
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
>GtkWidget</a>* bonobo_selector_new (const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *title,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> **interfaces_required);</pre>
<p>
Creates a new BonoboSelector widget. The title of the dialog
is set to <em class="parameter"><code>title</code></em>, and the list of selectable servers is populated
with those servers which support the interfaces specified in
<em class="parameter"><code>interfaces_required</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>title</code></em> :</span></td>
<td> A string which should go in the title of the
BonoboSelector window.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>interfaces_required</code></em> :</span></td>
<td> A NULL-terminated array of interfaces which a
server must support in order to be listed in the selector. Defaults
to "IDL:Bonobo/Embeddable:1.0" if no interfaces are listed.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> A pointer to the newly-created BonoboSelector widget.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2831619"></a><h3>
<a name="bonobo-selector-get-selected-id"></a>bonobo_selector_get_selected_id ()</h3>
<a class="indexterm" name="id2831633"></a><pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a>* bonobo_selector_get_selected_id (<a href="libbonoboui-bonobo-selector.html#BonoboSelector">BonoboSelector</a> *sel);</pre>
<p>
</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>sel</code></em> :</span></td>
<td> A BonoboSelector widget.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> A newly-allocated string containing the ID of the
currently-selected CORBA server (i.e., the corba server whose name
is highlighted in the list). The user of this function is
responsible for freeing this. It will give an oaf iid back.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2831697"></a><h3>
<a name="bonobo-selector-get-selected-name"></a>bonobo_selector_get_selected_name ()</h3>
<a class="indexterm" name="id2831712"></a><pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a>* bonobo_selector_get_selected_name
(<a href="libbonoboui-bonobo-selector.html#BonoboSelector">BonoboSelector</a> *sel);</pre>
<p>
</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>sel</code></em> :</span></td>
<td> A BonoboSelector widget.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> A newly-allocated string containing the name of the
currently-selected CORBA server (i.e., the corba server whose name
is highlighted in the list). The user of this function is
responsible for freeing this.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2831775"></a><h3>
<a name="bonobo-selector-get-selected-description"></a>bonobo_selector_get_selected_description ()</h3>
<a class="indexterm" name="id2831790"></a><pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a>* bonobo_selector_get_selected_description
(<a href="libbonoboui-bonobo-selector.html#BonoboSelector">BonoboSelector</a> *sel);</pre>
<p>
</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>sel</code></em> :</span></td>
<td> A BonoboSelector widget.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> A newly-allocated string containing the description of the
currently-selected CORBA server (i.e., the corba server whose name
is highlighted in the list). The user of this function is
responsible for freeing this.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2831854"></a><h3>
<a name="bonobo-selector-select-id"></a>bonobo_selector_select_id ()</h3>
<a class="indexterm" name="id2831868"></a><pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a>* bonobo_selector_select_id (const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *title,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> **interfaces_required);</pre>
<p>
Calls <a href="libbonoboui-bonobo-selector.html#bonobo-selector-new"><code class="function">bonobo_selector_new()</code></a> to create a new
BonoboSelector widget with the specified paramters, <em class="parameter"><code>title</code></em> and
<em class="parameter"><code>interfaces_required</code></em>. Then runs the dialog modally and allows
the user to make a selection.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>title</code></em> :</span></td>
<td> The title to be used for the dialog.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>interfaces_required</code></em> :</span></td>
<td> A list of required interfaces. See
<a href="libbonoboui-bonobo-selector.html#bonobo-selector-new"><code class="function">bonobo_selector_new()</code></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> The Oaf IID of the selected server, or NULL if no server is
selected. The ID string has been allocated with g_strdup.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2831990"></a><h2>Property Details</h2>
<div class="refsect2" lang="en">
<a name="id2832000"></a><h3>
<a name="BonoboSelector--interfaces-required"></a>The "<code class="literal">interfaces-required</code>" property</h3>
<a class="indexterm" name="id2832018"></a><pre class="programlisting"> "interfaces-required" <a
href="/usr/share/gtk-doc/html/gobject/gobject-Value-arrays.html#GValueArray"
>GValueArray</a> : Write / Construct</pre>
<p>A NULL-terminated array of interfaces which a server must support in order to be listed in the selector. Defaults to "IDL:Bonobo/Embeddable:1.0" if no interfaces are listed.</p>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2832044"></a><h2>Signal Details</h2>
<div class="refsect2" lang="en">
<a name="id2832055"></a><h3>
<a name="BonoboSelector-cancel"></a>The "cancel" signal</h3>
<a class="indexterm" name="id2832065"></a><pre class="programlisting">void user_function (<a href="libbonoboui-bonobo-selector.html#BonoboSelector">BonoboSelector</a> *bonoboselector,
<a
href="/usr/share/gtk-doc/html/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>bonoboselector</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>
<hr>
<div class="refsect2" lang="en">
<a name="id2832134"></a><h3>
<a name="BonoboSelector-ok"></a>The "ok" signal</h3>
<a class="indexterm" name="id2832144"></a><pre class="programlisting">void user_function (<a href="libbonoboui-bonobo-selector.html#BonoboSelector">BonoboSelector</a> *bonoboselector,
<a
href="/usr/share/gtk-doc/html/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>bonoboselector</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>
</body>
</html>