← Back to branch summary

~ubuntu-branches/ubuntu/saucy/libbonobo/saucy-proposed

« back to all changes in this revision

Viewing changes to doc/api/xml/bonobo-item-container.xml

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2010-03-30 13:59:10 UTC
  • mfrom: (1.1.27 upstream)
  • Revision ID: james.westby@ubuntu.com-20100330135910-bq8awt4jhdd71oq1
Tags: 2.24.3-0ubuntu1
* New upstream version:
  - Set up dbus environment in test-activation/test.sh 
  - Fix memory corruption 
  - Updated translations 

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/api/xml/bonobo-item-container.xml
1
 
<refentry id="libbonobo-bonobo-item-container">
2
 
<refmeta>
3
 
<refentrytitle role="top_of_page" id="libbonobo-bonobo-item-container.top_of_page">BonoboItemContainer</refentrytitle>
4
 
<manvolnum>3</manvolnum>
5
 
<refmiscinfo>LIBBONOBO Library</refmiscinfo>
6
 
</refmeta>
7
 
 
8
 
<refnamediv>
9
 
<refname>BonoboItemContainer</refname>
10
 
<refpurpose>this implements a simple container interface for compound document containers</refpurpose>
11
 
</refnamediv>
12
 
 
13
 
<refsynopsisdiv id="libbonobo-bonobo-item-container.synopsis" role="synopsis">
14
 
<title role="synopsis.title">Synopsis</title>
15
 
<anchor id="BonoboItemContainer"/>
16
 
<synopsis>
17
 
                    <link linkend="BonoboItemContainer-struct">BonoboItemContainer</link>;
18
 
                    <link linkend="BonoboItemContainerClass">BonoboItemContainerClass</link>;
19
 
<link linkend="BonoboItemContainer">BonoboItemContainer</link> * <link linkend="bonobo-item-container-new">bonobo_item_container_new</link>         (void);
20
 
<link linkend="void">void</link>                <link linkend="bonobo-item-container-add">bonobo_item_container_add</link>           (<link linkend="BonoboItemContainer">BonoboItemContainer</link> *container,
21
 
                                                         const <link linkend="char">char</link> *name,
22
 
                                                         <link linkend="BonoboObject">BonoboObject</link> *object);
23
 
<link linkend="void">void</link>                <link linkend="bonobo-item-container-remove-by-name">bonobo_item_container_remove_by_name</link>
24
 
                                                        (<link linkend="BonoboItemContainer">BonoboItemContainer</link> *container,
25
 
                                                         const <link linkend="char">char</link> *name);
26
 
</synopsis>
27
 
</refsynopsisdiv>
28
 
 
29
 
<refsect1 id="libbonobo-bonobo-item-container.object-hierarchy" role="object_hierarchy">
30
 
<title role="object_hierarchy.title">Object Hierarchy</title>
31
 
<synopsis>
32
 
  <link linkend="GObject">GObject</link>
33
 
   +----<link linkend="BonoboObject">BonoboObject</link>
34
 
         +----BonoboItemContainer
35
 
</synopsis>
36
 
</refsect1>
37
 
 
38
 
 
39
 
 
40
 
 
41
 
 
42
 
 
43
 
<refsect1 id="libbonobo-bonobo-item-container.signals" role="signal_proto">
44
 
<title role="signal_proto.title">Signals</title>
45
 
<synopsis>
46
 
  &quot;<link linkend="BonoboItemContainer-get-object">get-object</link>&quot;                                     : Run Last
47
 
</synopsis>
48
 
</refsect1>
49
 
 
50
 
 
51
 
<refsect1 id="libbonobo-bonobo-item-container.description" role="desc">
52
 
<title role="desc.title">Description</title>
53
 
<para>
54
 
This implementation is mostly deprecated, see <link linkend="BonoboItemHandler"><type>BonoboItemHandler</type></link>
55
 
</para>
56
 
</refsect1>
57
 
 
58
 
<refsect1 id="libbonobo-bonobo-item-container.details" role="details">
59
 
<title role="details.title">Details</title>
60
 
<refsect2 id="BonoboItemContainer-struct" role="struct">
61
 
<title>BonoboItemContainer</title>
62
 
<indexterm zone="BonoboItemContainer-struct"><primary sortas="BonoboItemContainer">BonoboItemContainer</primary></indexterm><programlisting>typedef struct _BonoboItemContainer BonoboItemContainer;</programlisting>
63
 
<para>
64
 
Object that implements Bonobo::ItemHandler
65
 
</para></refsect2>
66
 
<refsect2 id="BonoboItemContainerClass" role="struct">
67
 
<title>BonoboItemContainerClass</title>
68
 
<indexterm zone="BonoboItemContainerClass"><primary sortas="BonoboItemContainerClass">BonoboItemContainerClass</primary></indexterm><programlisting>typedef struct {
69
 
        BonoboObjectClass parent_class;
70
 
 
71
 
        POA_Bonobo_ItemContainer__epv epv;
72
 
 
73
 
        Bonobo_Unknown (*get_object) (BonoboItemContainer *item_container,
74
 
                                      CORBA_char          *item_name,
75
 
                                      CORBA_boolean        only_if_exists,
76
 
                                      CORBA_Environment   *ev);
77
 
} BonoboItemContainerClass;
78
 
</programlisting>
79
 
<para>
80
 
<link linkend="BonoboItemContainer"><type>BonoboItemContainer</type></link>'s class
81
 
</para></refsect2>
82
 
<refsect2 id="bonobo-item-container-new" role="function">
83
 
<title>bonobo_item_container_new ()</title>
84
 
<indexterm zone="bonobo-item-container-new"><primary sortas="bonobo_item_container_new">bonobo_item_container_new</primary></indexterm><programlisting><link linkend="BonoboItemContainer">BonoboItemContainer</link> * bonobo_item_container_new         (void);</programlisting>
85
 
<para>
86
 
Creates a new BonoboItemContainer object.  These are used to hold
87
 
client sites.</para>
88
 
<para>
89
 
</para><variablelist role="params">
90
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> The newly created BonoboItemContainer object
91
 
</simpara></listitem></varlistentry>
92
 
</variablelist></refsect2>
93
 
<refsect2 id="bonobo-item-container-add" role="function">
94
 
<title>bonobo_item_container_add ()</title>
95
 
<indexterm zone="bonobo-item-container-add"><primary sortas="bonobo_item_container_add">bonobo_item_container_add</primary></indexterm><programlisting><link linkend="void">void</link>                bonobo_item_container_add           (<link linkend="BonoboItemContainer">BonoboItemContainer</link> *container,
96
 
                                                         const <link linkend="char">char</link> *name,
97
 
                                                         <link linkend="BonoboObject">BonoboObject</link> *object);</programlisting>
98
 
<para>
99
 
Adds the <parameter>object</parameter> to the list of objects managed by this
100
 
container</para>
101
 
<para>
102
 
</para><variablelist role="params">
103
 
<varlistentry><term><parameter>container</parameter>&#160;:</term>
104
 
<listitem><simpara> The object to operate on.
105
 
</simpara></listitem></varlistentry>
106
 
<varlistentry><term><parameter>name</parameter>&#160;:</term>
107
 
<listitem><simpara> The name of the object
108
 
</simpara></listitem></varlistentry>
109
 
<varlistentry><term><parameter>object</parameter>&#160;:</term>
110
 
<listitem><simpara> The object to add to the container
111
 
</simpara></listitem></varlistentry>
112
 
</variablelist></refsect2>
113
 
<refsect2 id="bonobo-item-container-remove-by-name" role="function">
114
 
<title>bonobo_item_container_remove_by_name ()</title>
115
 
<indexterm zone="bonobo-item-container-remove-by-name"><primary sortas="bonobo_item_container_remove_by_name">bonobo_item_container_remove_by_name</primary></indexterm><programlisting><link linkend="void">void</link>                bonobo_item_container_remove_by_name
116
 
                                                        (<link linkend="BonoboItemContainer">BonoboItemContainer</link> *container,
117
 
                                                         const <link linkend="char">char</link> *name);</programlisting>
118
 
<para>
119
 
Removes the named object from the <parameter>container</parameter></para>
120
 
<para>
121
 
</para><variablelist role="params">
122
 
<varlistentry><term><parameter>container</parameter>&#160;:</term>
123
 
<listitem><simpara> The object to operate on.
124
 
</simpara></listitem></varlistentry>
125
 
<varlistentry><term><parameter>name</parameter>&#160;:</term>
126
 
<listitem><simpara> The name of the object to remove from the container
127
 
</simpara></listitem></varlistentry>
128
 
</variablelist></refsect2>
129
 
 
130
 
</refsect1>
131
 
 
132
 
<refsect1 id="libbonobo-bonobo-item-container.signal-details" role="signals">
133
 
<title role="signals.title">Signal Details</title>
134
 
<refsect2 id="BonoboItemContainer-get-object" role="signal"><title>The <literal>&quot;get-object&quot;</literal> signal</title>
135
 
<indexterm zone="BonoboItemContainer-get-object"><primary sortas="BonoboItemContainer::get-object">BonoboItemContainer::get-object</primary></indexterm><programlisting><link linkend="BonoboUnknown">BonoboUnknown</link>*      user_function                      (<link linkend="BonoboItemContainer">BonoboItemContainer</link>  *bonoboitemcontainer,
136
 
                                                        <link linkend="gchar">gchar</link>                *arg1,
137
 
                                                        <link linkend="gboolean">gboolean</link>              arg2,
138
 
                                                        <link linkend="BonoboCorbaException">BonoboCorbaException</link> *arg3,
139
 
                                                        <link linkend="gpointer">gpointer</link>              user_data)                : Run Last</programlisting>
140
 
<para>
141
 
Signal emitted when a sub-object is requested from the item container.
142
 
</para><variablelist role="params">
143
 
<varlistentry><term><parameter>bonoboitemcontainer</parameter>&#160;:</term>
144
 
<listitem><simpara>the object which received the signal.
145
 
</simpara></listitem></varlistentry>
146
 
<varlistentry><term><parameter>arg1</parameter>&#160;:</term>
147
 
<listitem><simpara>the item name, i.e. the string after the '!' character, usually a semicolon separated list of key=value options
148
 
</simpara></listitem></varlistentry>
149
 
<varlistentry><term><parameter>arg2</parameter>&#160;:</term>
150
 
<listitem><simpara>the "only_if_exists" flag; if <link linkend="TRUE--CAPS"><literal>TRUE</literal></link>, client requests that subobject be returned if it exists, but that it should not be created on demand if it doesn't
151
 
</simpara></listitem></varlistentry>
152
 
<varlistentry><term><parameter>arg3</parameter>&#160;:</term>
153
 
<listitem><simpara>environment, in case the signal wishes to raise an exception
154
 
</simpara></listitem></varlistentry>
155
 
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
156
 
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
157
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>an object contained by the item container, or <link linkend="CORBA-OBJECT-NIL--CAPS"><literal>CORBA_OBJECT_NIL</literal></link>.
158
 
</simpara></listitem></varlistentry>
159
 
</variablelist></refsect2>
160
 
</refsect1>
161
 
 
162
 
 
163
 
<refsect1 id="libbonobo-bonobo-item-container.see-also">
164
 
<title>See Also</title>
165
 
<para>
166
 
   <link linkend="BonoboItemHandler"><type>BonoboItemHandler</type></link>
167
 
</para>
168
 
</refsect1>
169
 
 
170
 
</refentry>