← Back to branch summary

~ubuntu-branches/ubuntu/trusty/libzeitgeist/trusty-proposed

« back to all changes in this revision

Viewing changes to doc/reference/html/ZeitgeistMonitor.html

  • Committer: Bazaar Package Importer
  • Author(s): Didier Roche
  • Date: 2011-03-23 17:05:43 UTC
  • mfrom: (1.1.8 upstream)
  • Revision ID: james.westby@ubuntu.com-20110323170543-qks4dcl41i222izh
Tags: 0.3.8-0ubuntu1
https://launchpad.net/bugs/734080
https://launchpad.net/bugs/739653
* New upstream release
  - ZeitgeistLog missing implementation of get_property for "connected"
    (LP: #734080)
  - libzeitgeist vapi needs an update (LP: #739653)

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reference/html/ZeitgeistMonitor.html
49
49
                    <a class="link" href="ZeitgeistMonitor.html#ZeitgeistMonitor-struct" title="ZeitgeistMonitor">ZeitgeistMonitor</a>;
50
50
struct              <a class="link" href="ZeitgeistMonitor.html#ZeitgeistMonitorClass" title="struct ZeitgeistMonitorClass">ZeitgeistMonitorClass</a>;
51
51
<a class="link" href="ZeitgeistMonitor.html" title="ZeitgeistMonitor"><span class="returnvalue">ZeitgeistMonitor</span></a> *    <a class="link" href="ZeitgeistMonitor.html#zeitgeist-monitor-new" title="zeitgeist_monitor_new ()">zeitgeist_monitor_new</a>             (<em class="parameter"><code><a class="link" href="ZeitgeistTimeRange.html" title="ZeitgeistTimeRange"><span class="type">ZeitgeistTimeRange</span></a> *time_range</code></em>,
52
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a> *event_templates</code></em>);
 
52
                                                         <em class="parameter"><code><a href="../glib/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a> *event_templates</code></em>);
53
53
<a class="link" href="ZeitgeistTimeRange.html" title="ZeitgeistTimeRange"><span class="returnvalue">ZeitgeistTimeRange</span></a> *  <a class="link" href="ZeitgeistMonitor.html#zeitgeist-monitor-get-time-range" title="zeitgeist_monitor_get_time_range ()">zeitgeist_monitor_get_time_range</a>  (<em class="parameter"><code><a class="link" href="ZeitgeistMonitor.html" title="ZeitgeistMonitor"><span class="type">ZeitgeistMonitor</span></a> *self</code></em>);
54
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="returnvalue">GPtrArray</span></a> *           <a class="link" href="ZeitgeistMonitor.html#zeitgeist-monitor-get-templates" title="zeitgeist_monitor_get_templates ()">zeitgeist_monitor_get_templates</a>   (<em class="parameter"><code><a class="link" href="ZeitgeistMonitor.html" title="ZeitgeistMonitor"><span class="type">ZeitgeistMonitor</span></a> *self</code></em>);
55
 
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *         <a class="link" href="ZeitgeistMonitor.html#zeitgeist-monitor-get-path" title="zeitgeist_monitor_get_path ()">zeitgeist_monitor_get_path</a>        (<em class="parameter"><code><a class="link" href="ZeitgeistMonitor.html" title="ZeitgeistMonitor"><span class="type">ZeitgeistMonitor</span></a> *self</code></em>);
 
54
<a href="../glib/glib-Pointer-Arrays.html#GPtrArray"><span class="returnvalue">GPtrArray</span></a> *           <a class="link" href="ZeitgeistMonitor.html#zeitgeist-monitor-get-templates" title="zeitgeist_monitor_get_templates ()">zeitgeist_monitor_get_templates</a>   (<em class="parameter"><code><a class="link" href="ZeitgeistMonitor.html" title="ZeitgeistMonitor"><span class="type">ZeitgeistMonitor</span></a> *self</code></em>);
 
55
const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *         <a class="link" href="ZeitgeistMonitor.html#zeitgeist-monitor-get-path" title="zeitgeist_monitor_get_path ()">zeitgeist_monitor_get_path</a>        (<em class="parameter"><code><a class="link" href="ZeitgeistMonitor.html" title="ZeitgeistMonitor"><span class="type">ZeitgeistMonitor</span></a> *self</code></em>);
56
56
</pre>
57
57
</div>
58
58
<div class="refsect1">
59
59
<a name="ZeitgeistMonitor.object-hierarchy"></a><h2>Object Hierarchy</h2>
60
60
<pre class="synopsis">
61
 
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
 
61
  <a href="../gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
62
62
   +----ZeitgeistMonitor
63
63
</pre>
64
64
</div>
65
65
<div class="refsect1">
66
66
<a name="ZeitgeistMonitor.properties"></a><h2>Properties</h2>
67
67
<pre class="synopsis">
68
 
  "<a class="link" href="ZeitgeistMonitor.html#ZeitgeistMonitor--event-templates" title='The "event-templates" property'>event-templates</a>"          <a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a>*            : Read / Write / Construct Only
 
68
  "<a class="link" href="ZeitgeistMonitor.html#ZeitgeistMonitor--event-templates" title='The "event-templates" property'>event-templates</a>"          <a href="../glib/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a>*            : Read / Write / Construct Only
69
69
  "<a class="link" href="ZeitgeistMonitor.html#ZeitgeistMonitor--time-range" title='The "time-range" property'>time-range</a>"               <a class="link" href="ZeitgeistTimeRange.html" title="ZeitgeistTimeRange"><span class="type">ZeitgeistTimeRange</span></a>*   : Read / Write / Construct Only
70
70
</pre>
71
71
</div>
72
72
<div class="refsect1">
73
73
<a name="ZeitgeistMonitor.signals"></a><h2>Signals</h2>
74
74
<pre class="synopsis">
75
 
  "<a class="link" href="ZeitgeistMonitor.html#ZeitgeistMonitor-events-deleted" title='The "events-deleted" signal'>events-deleted</a>"                                 : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
76
 
  "<a class="link" href="ZeitgeistMonitor.html#ZeitgeistMonitor-events-inserted" title='The "events-inserted" signal'>events-inserted</a>"                                : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
 
75
  "<a class="link" href="ZeitgeistMonitor.html#ZeitgeistMonitor-events-deleted" title='The "events-deleted" signal'>events-deleted</a>"                                 : <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
 
76
  "<a class="link" href="ZeitgeistMonitor.html#ZeitgeistMonitor-events-inserted" title='The "events-inserted" signal'>events-inserted</a>"                                : <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
77
77
</pre>
78
78
</div>
79
79
<div class="refsect1">
120
120
<div class="refsect2">
121
121
<a name="zeitgeist-monitor-new"></a><h3>zeitgeist_monitor_new ()</h3>
122
122
<pre class="programlisting"><a class="link" href="ZeitgeistMonitor.html" title="ZeitgeistMonitor"><span class="returnvalue">ZeitgeistMonitor</span></a> *    zeitgeist_monitor_new             (<em class="parameter"><code><a class="link" href="ZeitgeistTimeRange.html" title="ZeitgeistTimeRange"><span class="type">ZeitgeistTimeRange</span></a> *time_range</code></em>,
123
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a> *event_templates</code></em>);</pre>
 
123
                                                         <em class="parameter"><code><a href="../glib/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a> *event_templates</code></em>);</pre>
124
124
<p>
125
125
Create a new monitor. Before you can receive signals from the monitor you
126
126
need to install it in the running Zeitgeist daemon by calling
137
137
</tr>
138
138
<tr>
139
139
<td><p><span class="term"><em class="parameter"><code>event_templates</code></em> :</span></p></td>
140
 
<td>A <a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a> of <a class="link" href="ZeitgeistEvent.html" title="ZeitgeistEvent"><span class="type">ZeitgeistEvent</span></a>s. Only listen for
 
140
<td>A <a href="../glib/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a> of <a class="link" href="ZeitgeistEvent.html" title="ZeitgeistEvent"><span class="type">ZeitgeistEvent</span></a>s. Only listen for
141
141
events that match any of these templates.
142
142
The monitor will assume ownership of the events and
143
143
the pointer array.
144
144
If you want to keep a reference for yourself you must do a
145
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#g-ptr-array-ref"><code class="function">g_ptr_array_ref()</code></a> on <em class="parameter"><code>event_templates</code></em> as well as reffing
 
145
<a href="../glib/glib-Pointer-Arrays.html#g-ptr-array-ref"><code class="function">g_ptr_array_ref()</code></a> on <em class="parameter"><code>event_templates</code></em> as well as reffing
146
146
the events held by it before calling this method.</td>
147
147
</tr>
148
148
<tr>
162
162
<hr>
163
163
<div class="refsect2">
164
164
<a name="zeitgeist-monitor-get-templates"></a><h3>zeitgeist_monitor_get_templates ()</h3>
165
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="returnvalue">GPtrArray</span></a> *           zeitgeist_monitor_get_templates   (<em class="parameter"><code><a class="link" href="ZeitgeistMonitor.html" title="ZeitgeistMonitor"><span class="type">ZeitgeistMonitor</span></a> *self</code></em>);</pre>
 
165
<pre class="programlisting"><a href="../glib/glib-Pointer-Arrays.html#GPtrArray"><span class="returnvalue">GPtrArray</span></a> *           zeitgeist_monitor_get_templates   (<em class="parameter"><code><a class="link" href="ZeitgeistMonitor.html" title="ZeitgeistMonitor"><span class="type">ZeitgeistMonitor</span></a> *self</code></em>);</pre>
166
166
<p>
167
167
</p>
168
168
</div>
169
169
<hr>
170
170
<div class="refsect2">
171
171
<a name="zeitgeist-monitor-get-path"></a><h3>zeitgeist_monitor_get_path ()</h3>
172
 
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *         zeitgeist_monitor_get_path        (<em class="parameter"><code><a class="link" href="ZeitgeistMonitor.html" title="ZeitgeistMonitor"><span class="type">ZeitgeistMonitor</span></a> *self</code></em>);</pre>
 
172
<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *         zeitgeist_monitor_get_path        (<em class="parameter"><code><a class="link" href="ZeitgeistMonitor.html" title="ZeitgeistMonitor"><span class="type">ZeitgeistMonitor</span></a> *self</code></em>);</pre>
173
173
<p>
174
174
</p>
175
175
</div>
178
178
<a name="ZeitgeistMonitor.property-details"></a><h2>Property Details</h2>
179
179
<div class="refsect2">
180
180
<a name="ZeitgeistMonitor--event-templates"></a><h3>The <code class="literal">"event-templates"</code> property</h3>
181
 
<pre class="programlisting">  "event-templates"          <a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a>*            : Read / Write / Construct Only</pre>
 
181
<pre class="programlisting">  "event-templates"          <a href="../glib/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a>*            : Read / Write / Construct Only</pre>
182
182
<p>
183
183
Events must match at least one these templates in order to trigger the
184
184
monitor
200
200
<a name="ZeitgeistMonitor-events-deleted"></a><h3>The <code class="literal">"events-deleted"</code> signal</h3>
201
201
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="ZeitgeistMonitor.html" title="ZeitgeistMonitor"><span class="type">ZeitgeistMonitor</span></a>   *time_range,
202
202
                                                        <a class="link" href="ZeitgeistTimeRange.html" title="ZeitgeistTimeRange"><span class="type">ZeitgeistTimeRange</span></a> *event_ids,
203
 
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Arrays.html#GArray"><span class="type">GArray</span></a>             *arg2,
204
 
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>            user_data)       : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
 
203
                                                        <a href="../glib/glib-Arrays.html#GArray"><span class="type">GArray</span></a>             *arg2,
 
204
                                                        <a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>            user_data)       : <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
205
205
<p>
206
206
Emitted when events with timestamps within the time range of this monitor
207
207
has been deleted from the log. Note that the deleted events may not match
217
217
</tr>
218
218
<tr>
219
219
<td><p><span class="term"><em class="parameter"><code>event_ids</code></em> :</span></p></td>
220
 
<td>A <a href="http://library.gnome.org/devel/glib/unstable/glib-Arrays.html#GArray"><span class="type">GArray</span></a> of <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a>s holding the ids of the deleted
 
220
<td>A <a href="../glib/glib-Arrays.html#GArray"><span class="type">GArray</span></a> of <a href="../glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a>s holding the ids of the deleted
221
221
events</td>
222
222
</tr>
223
223
<tr>
233
233
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="ZeitgeistMonitor.html" title="ZeitgeistMonitor"><span class="type">ZeitgeistMonitor</span></a>   *time_range,
234
234
                                                        <a class="link" href="ZeitgeistTimeRange.html" title="ZeitgeistTimeRange"><span class="type">ZeitgeistTimeRange</span></a> *events,
235
235
                                                        <a class="link" href="ZeitgeistResultSet.html" title="ZeitgeistResultSet"><span class="type">ZeitgeistResultSet</span></a> *arg2,
236
 
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>            user_data)       : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
 
236
                                                        <a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>            user_data)       : <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
237
237
<p>
238
238
Emitted when events matching the event templates and with timestamps
239
239
within the time range of the monitor has been inserted into the log.