~ubuntu-branches/ubuntu/quantal/libbonobo/quantal-201207170711

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
<refentry id="libbonobo-bonobo-running-context">
<refmeta>
<refentrytitle role="top_of_page">BonoboRunningContext</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBBONOBO Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>BonoboRunningContext</refname>
<refpurpose>a live object tracker</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>

<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>

<synopsis>



                    <link linkend="BonoboRunningContext">BonoboRunningContext</link>;
                    <link linkend="BonoboRunningContextClass">BonoboRunningContextClass</link>;
<link linkend="BonoboObject">BonoboObject</link>*       <link linkend="bonobo-running-context-new">bonobo_running_context_new</link>          (void);
<link linkend="void">void</link>                <link linkend="bonobo-running-context-ignore-object">bonobo_running_context_ignore_object</link>
                                                        (<link linkend="CORBA-Object">CORBA_Object</link> object);
<link linkend="void">void</link>                <link linkend="bonobo-running-context-at-exit-unref">bonobo_running_context_at_exit_unref</link>
                                                        (<link linkend="CORBA-Object">CORBA_Object</link> object);


</synopsis>
</refsynopsisdiv>









<refsect1 role="desc">
<title role="desc.title">Description</title>

<para>
    <link linkend="BonoboRunningContext"><type>BonoboRunningContext</type></link> implements the
    <classname>Bonobo::RunningContext</classname> IDL interface,
    depicted in <xref linkend="running-context-img"/>.
</para>

<figure id="running-context-img">
    <title>The Bonobo::RunningContext interface</title>
    <mediaobject>
	<imageobject>
	    <imagedata fileref="running-context.png" format="PNG"/>
	</imageobject>
    </mediaobject>
</figure>

<para>
    The purpose of this object is to keep track of currently running
    objects.  This is useful in, for example, exe type factories, in
    order to know when it is safe to quit from the main loop.
</para>

<para>
    <link linkend="BonoboRunningContext"><type>BonoboRunningContext</type></link> is a singleton.  There is at most one
    instance running at all times.  All <link linkend="BonoboObject"><type>BonoboObject</type></link>'s are
    automatically registered with the running context as part of their
    normal initialization procedure.
</para>
<para>
    To find out when all objects have been destroyed, just connect a
    handler to the "last-unref" signal.
</para>
</refsect1>

<refsect1 role="details">
<title role="details.title">Details</title>
<refsect2>
<title><anchor id="BonoboRunningContext" role="struct"/>BonoboRunningContext</title>
<indexterm><primary>BonoboRunningContext</primary></indexterm><programlisting>typedef struct {
	BonoboObject parent;

	BonoboRunningContextPrivate *priv;
} BonoboRunningContext;
</programlisting>
<para>
the running context data
</para></refsect2>
<refsect2>
<title><anchor id="BonoboRunningContextClass" role="struct"/>BonoboRunningContextClass</title>
<indexterm><primary>BonoboRunningContextClass</primary></indexterm><programlisting>typedef struct {
	BonoboObjectClass parent;

	POA_Bonobo_RunningContext__epv epv;

	void (*last_unref) (void);
} BonoboRunningContextClass;
</programlisting>
<para>
the running context class
</para></refsect2>
<refsect2>
<title><anchor id="bonobo-running-context-new" role="function"/>bonobo_running_context_new ()</title>
<indexterm><primary>bonobo_running_context_new</primary></indexterm><programlisting><link linkend="BonoboObject">BonoboObject</link>*       bonobo_running_context_new          (void);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="bonobo-running-context-ignore-object" role="function"/>bonobo_running_context_ignore_object ()</title>
<indexterm><primary>bonobo_running_context_ignore_object</primary></indexterm><programlisting><link linkend="void">void</link>                bonobo_running_context_ignore_object
                                                        (<link linkend="CORBA-Object">CORBA_Object</link> object);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>object</parameter>&nbsp;:</term>
<listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="bonobo-running-context-at-exit-unref" role="function"/>bonobo_running_context_at_exit_unref ()</title>
<indexterm><primary>bonobo_running_context_at_exit_unref</primary></indexterm><programlisting><link linkend="void">void</link>                bonobo_running_context_at_exit_unref
                                                        (<link linkend="CORBA-Object">CORBA_Object</link> object);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>object</parameter>&nbsp;:</term>
<listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>



<refsect1>
<title>See Also</title>
<para>
    <xref linkend="libbonobo-bonobo-generic-factory"/>
</para>
</refsect1>

</refentry>