~ubuntu-branches/ubuntu/vivid/gnome-desktop3/vivid
» Revision
33
: docs/reference/gnome-desktop3/html/GnomeIdleMonitor.html
« back to all changes in this revision
Viewing changes to docs/reference/gnome-desktop3/html/GnomeIdleMonitor.html
- browse files at revision 33
- compare with another revision
- compare with revision 33
- download diff
- download tarball
- view history from revision 33
- Committer: Package Import Robot
- Author(s): Jackson Doak
- Date: 2014-10-31 07:46:09 UTC
- mfrom: (1.6.5) (32.1.1 vivid-proposed)
- Revision ID: package-import@ubuntu.com-20141031074609-gb280wdsxsgldc91
Tags: 3.14.1-1ubuntu1
* Merge with Debian, Remaining changes:
- debian/patches:
+ 04_compute_average_color.patch: Compute the avergage color in
gnome-desktop itself, not in unity to fix some races (LP #963140)
+ tweak_color_computation.patch, Patch from Gord, no patch header,
no bug link.
+ git_revert_draw_background.patch
+ ubuntu_language.patch, Ported relevant bits from g-c-c
52_region_language.patch, as required for gnome 3.8 region panel
+ ubuntu_language_list_from_SUPPORTED.patch,
adds api to get list of available languages from SUPPORTED file.
To be used by gnome 3.8 region panel language installation.
- debian/libgnome-desktop-3-10.symbols:
+ Add symbols included in Ubuntu patches
- debian/control.in:
+ Mark gnome-desktop3-data Multi-Arch: foreign
- debian/patches:
+ 04_compute_average_color.patch: Compute the avergage color in
gnome-desktop itself, not in unity to fix some races (LP #963140)
+ tweak_color_computation.patch, Patch from Gord, no patch header,
no bug link.
+ git_revert_draw_background.patch
+ ubuntu_language.patch, Ported relevant bits from g-c-c
52_region_language.patch, as required for gnome 3.8 region panel
+ ubuntu_language_list_from_SUPPORTED.patch,
adds api to get list of available languages from SUPPORTED file.
To be used by gnome 3.8 region panel language installation.
- debian/libgnome-desktop-3-10.symbols:
+ Add symbols included in Ubuntu patches
- debian/control.in:
+ Mark gnome-desktop3-data Multi-Arch: foreign
added
removed
docs/reference/gnome-desktop3/html/GnomeIdleMonitor.html
2
2
<html>
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
<title>GnomeIdleMonitor</title>
5
<title>GNOME Desktop Library Reference Manual: GnomeIdleMonitor</title>
6
6
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
7
7
<link rel="home" href="index.html" title="GNOME Desktop Library Reference Manual">
8
8
<link rel="up" href="idle-monitor.html" title="Part V. Idle Monitor">
9
9
<link rel="prev" href="idle-monitor.html" title="Part V. Idle Monitor">
10
10
<link rel="next" href="wall-clock.html" title="Part VI. Wall Clock">
11
<meta name="generator" content="GTK-Doc V1.19 (XML mode)">
11
<meta name="generator" content="GTK-Doc V1.20 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
</head>
14
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
16
<tr valign="middle">
17
<td><a accesskey="p" href="idle-monitor.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18
<td><a accesskey="u" href="idle-monitor.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20
<th width="100%" align="center">GNOME Desktop Library Reference Manual</th>
21
<td><a accesskey="n" href="wall-clock.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
22
</tr>
23
<tr><td colspan="5" class="shortcuts">
24
<a href="#GnomeIdleMonitor.synopsis" class="shortcut">Top</a>
25
|
26
<a href="#GnomeIdleMonitor.description" class="shortcut">Description</a>
27
|
28
<a href="#GnomeIdleMonitor.object-hierarchy" class="shortcut">Object Hierarchy</a>
29
|
30
<a href="#GnomeIdleMonitor.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
31
|
32
<a href="#GnomeIdleMonitor.properties" class="shortcut">Properties</a>
33
</td></tr>
34
</table>
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle">
16
<td width="100%" align="left" class="shortcuts">
17
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
18
<a href="#GnomeIdleMonitor.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
19
<a href="#GnomeIdleMonitor.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span>
20
<a href="#GnomeIdleMonitor.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span>
21
<a href="#GnomeIdleMonitor.properties" class="shortcut">Properties</a></span>
22
</td>
23
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
24
<td><a accesskey="u" href="idle-monitor.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
25
<td><a accesskey="p" href="idle-monitor.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
26
<td><a accesskey="n" href="wall-clock.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
27
</tr></table>
35
28
<div class="refentry">
36
29
<a name="GnomeIdleMonitor"></a><div class="titlepage"></div>
37
30
<div class="refnamediv"><table width="100%"><tr>
39
32
<h2><span class="refentrytitle"><a name="GnomeIdleMonitor.top_of_page"></a>GnomeIdleMonitor</span></h2>
40
33
<p>GnomeIdleMonitor</p>
41
34
</td>
42
<td valign="top" align="right"></td>
35
<td class="gallery_image" valign="top" align="right"></td>
43
36
</tr></table></div>
44
<div class="refsynopsisdiv">
45
<a name="GnomeIdleMonitor.synopsis"></a><h2>Synopsis</h2>
46
<pre class="synopsis">struct <a class="link" href="GnomeIdleMonitor.html#GnomeIdleMonitor-struct" title="struct GnomeIdleMonitor">GnomeIdleMonitor</a>;
47
struct <a class="link" href="GnomeIdleMonitor.html#GnomeIdleMonitorClass" title="struct GnomeIdleMonitorClass">GnomeIdleMonitorClass</a>;
48
<span class="returnvalue">void</span> (<a class="link" href="GnomeIdleMonitor.html#GnomeIdleMonitorWatchFunc" title="GnomeIdleMonitorWatchFunc ()">*GnomeIdleMonitorWatchFunc</a>) (<em class="parameter"><code><a class="link" href="GnomeIdleMonitor.html" title="GnomeIdleMonitor"><span class="type">GnomeIdleMonitor</span></a> *monitor</code></em>,
49
<em class="parameter"><code><span class="type">guint</span> id</code></em>,
50
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);
51
<a class="link" href="GnomeIdleMonitor.html" title="GnomeIdleMonitor"><span class="returnvalue">GnomeIdleMonitor</span></a> * <a class="link" href="GnomeIdleMonitor.html#gnome-idle-monitor-new" title="gnome_idle_monitor_new ()">gnome_idle_monitor_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
52
<a class="link" href="GnomeIdleMonitor.html" title="GnomeIdleMonitor"><span class="returnvalue">GnomeIdleMonitor</span></a> * <a class="link" href="GnomeIdleMonitor.html#gnome-idle-monitor-new-for-device" title="gnome_idle_monitor_new_for_device ()">gnome_idle_monitor_new_for_device</a> (<em class="parameter"><code><span class="type">GdkDevice</span> *device</code></em>,
53
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
54
<span class="returnvalue">guint</span> <a class="link" href="GnomeIdleMonitor.html#gnome-idle-monitor-add-idle-watch" title="gnome_idle_monitor_add_idle_watch ()">gnome_idle_monitor_add_idle_watch</a> (<em class="parameter"><code><a class="link" href="GnomeIdleMonitor.html" title="GnomeIdleMonitor"><span class="type">GnomeIdleMonitor</span></a> *monitor</code></em>,
55
<em class="parameter"><code><span class="type">guint64</span> interval_msec</code></em>,
56
<em class="parameter"><code><a class="link" href="GnomeIdleMonitor.html#GnomeIdleMonitorWatchFunc" title="GnomeIdleMonitorWatchFunc ()"><span class="type">GnomeIdleMonitorWatchFunc</span></a> callback</code></em>,
57
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>,
58
<em class="parameter"><code><span class="type">GDestroyNotify</span> notify</code></em>);
59
<span class="returnvalue">guint</span> <a class="link" href="GnomeIdleMonitor.html#gnome-idle-monitor-add-user-active-watch" title="gnome_idle_monitor_add_user_active_watch ()">gnome_idle_monitor_add_user_active_watch</a>
60
(<em class="parameter"><code><a class="link" href="GnomeIdleMonitor.html" title="GnomeIdleMonitor"><span class="type">GnomeIdleMonitor</span></a> *monitor</code></em>,
61
<em class="parameter"><code><a class="link" href="GnomeIdleMonitor.html#GnomeIdleMonitorWatchFunc" title="GnomeIdleMonitorWatchFunc ()"><span class="type">GnomeIdleMonitorWatchFunc</span></a> callback</code></em>,
62
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>,
63
<em class="parameter"><code><span class="type">GDestroyNotify</span> notify</code></em>);
64
<span class="returnvalue">void</span> <a class="link" href="GnomeIdleMonitor.html#gnome-idle-monitor-remove-watch" title="gnome_idle_monitor_remove_watch ()">gnome_idle_monitor_remove_watch</a> (<em class="parameter"><code><a class="link" href="GnomeIdleMonitor.html" title="GnomeIdleMonitor"><span class="type">GnomeIdleMonitor</span></a> *monitor</code></em>,
65
<em class="parameter"><code><span class="type">guint</span> id</code></em>);
66
<span class="returnvalue">guint64</span> <a class="link" href="GnomeIdleMonitor.html#gnome-idle-monitor-get-idletime" title="gnome_idle_monitor_get_idletime ()">gnome_idle_monitor_get_idletime</a> (<em class="parameter"><code><a class="link" href="GnomeIdleMonitor.html" title="GnomeIdleMonitor"><span class="type">GnomeIdleMonitor</span></a> *monitor</code></em>);
67
</pre>
37
<div class="refsect1">
38
<a name="GnomeIdleMonitor.functions"></a><h2>Functions</h2>
39
<div class="informaltable"><table width="100%" border="0">
40
<colgroup>
41
<col width="150px" class="functions_return">
42
<col class="functions_name">
43
</colgroup>
44
<tbody>
45
<tr>
46
<td class="function_type">
47
<span class="returnvalue">void</span>
48
</td>
49
<td class="function_name">
50
<span class="c_punctuation">(</span><a class="link" href="GnomeIdleMonitor.html#GnomeIdleMonitorWatchFunc" title="GnomeIdleMonitorWatchFunc ()">*GnomeIdleMonitorWatchFunc</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
51
</td>
52
</tr>
53
<tr>
54
<td class="function_type">
55
<a class="link" href="GnomeIdleMonitor.html" title="GnomeIdleMonitor"><span class="returnvalue">GnomeIdleMonitor</span></a> *
56
</td>
57
<td class="function_name">
58
<a class="link" href="GnomeIdleMonitor.html#gnome-idle-monitor-new" title="gnome_idle_monitor_new ()">gnome_idle_monitor_new</a> <span class="c_punctuation">()</span>
59
</td>
60
</tr>
61
<tr>
62
<td class="function_type">
63
<a class="link" href="GnomeIdleMonitor.html" title="GnomeIdleMonitor"><span class="returnvalue">GnomeIdleMonitor</span></a> *
64
</td>
65
<td class="function_name">
66
<a class="link" href="GnomeIdleMonitor.html#gnome-idle-monitor-new-for-device" title="gnome_idle_monitor_new_for_device ()">gnome_idle_monitor_new_for_device</a> <span class="c_punctuation">()</span>
67
</td>
68
</tr>
69
<tr>
70
<td class="function_type">
71
<span class="returnvalue">guint</span>
72
</td>
73
<td class="function_name">
74
<a class="link" href="GnomeIdleMonitor.html#gnome-idle-monitor-add-idle-watch" title="gnome_idle_monitor_add_idle_watch ()">gnome_idle_monitor_add_idle_watch</a> <span class="c_punctuation">()</span>
75
</td>
76
</tr>
77
<tr>
78
<td class="function_type">
79
<span class="returnvalue">guint</span>
80
</td>
81
<td class="function_name">
82
<a class="link" href="GnomeIdleMonitor.html#gnome-idle-monitor-add-user-active-watch" title="gnome_idle_monitor_add_user_active_watch ()">gnome_idle_monitor_add_user_active_watch</a> <span class="c_punctuation">()</span>
83
</td>
84
</tr>
85
<tr>
86
<td class="function_type">
87
<span class="returnvalue">void</span>
88
</td>
89
<td class="function_name">
90
<a class="link" href="GnomeIdleMonitor.html#gnome-idle-monitor-remove-watch" title="gnome_idle_monitor_remove_watch ()">gnome_idle_monitor_remove_watch</a> <span class="c_punctuation">()</span>
91
</td>
92
</tr>
93
<tr>
94
<td class="function_type">
95
<span class="returnvalue">guint64</span>
96
</td>
97
<td class="function_name">
98
<a class="link" href="GnomeIdleMonitor.html#gnome-idle-monitor-get-idletime" title="gnome_idle_monitor_get_idletime ()">gnome_idle_monitor_get_idletime</a> <span class="c_punctuation">()</span>
99
</td>
100
</tr>
101
</tbody>
102
</table></div>
103
</div>
104
<div class="refsect1">
105
<a name="GnomeIdleMonitor.properties"></a><h2>Properties</h2>
106
<div class="informaltable"><table border="0">
107
<colgroup>
108
<col width="150px" class="properties_type">
109
<col width="300px" class="properties_name">
110
<col width="200px" class="properties_flags">
111
</colgroup>
112
<tbody><tr>
113
<td class="property_type">
114
<span class="type">GdkDevice</span> *</td>
115
<td class="property_name"><a class="link" href="GnomeIdleMonitor.html#GnomeIdleMonitor--device" title="The “device” property">device</a></td>
116
<td class="property_flags">Read / Write / Construct Only</td>
117
</tr></tbody>
118
</table></div>
119
</div>
120
<div class="refsect1">
121
<a name="GnomeIdleMonitor.other"></a><h2>Types and Values</h2>
122
<div class="informaltable"><table width="100%" border="0">
123
<colgroup>
124
<col width="150px" class="name">
125
<col class="description">
126
</colgroup>
127
<tbody>
128
<tr>
129
<td class="datatype_keyword">struct</td>
130
<td class="function_name"><a class="link" href="GnomeIdleMonitor.html#GnomeIdleMonitor-struct" title="struct GnomeIdleMonitor">GnomeIdleMonitor</a></td>
131
</tr>
132
<tr>
133
<td class="datatype_keyword">struct</td>
134
<td class="function_name"><a class="link" href="GnomeIdleMonitor.html#GnomeIdleMonitorClass" title="struct GnomeIdleMonitorClass">GnomeIdleMonitorClass</a></td>
135
</tr>
136
</tbody>
137
</table></div>
68
138
</div>
69
139
<div class="refsect1">
70
140
<a name="GnomeIdleMonitor.object-hierarchy"></a><h2>Object Hierarchy</h2>
71
<pre class="synopsis">
72
GObject
73
+----GnomeIdleMonitor
141
<pre class="screen"> GObject
142
<span class="lineart">╰──</span> GnomeIdleMonitor
74
143
</pre>
75
144
</div>
76
145
<div class="refsect1">
80
149
GInitable.</p>
81
150
</div>
82
151
<div class="refsect1">
83
<a name="GnomeIdleMonitor.properties"></a><h2>Properties</h2>
84
<pre class="synopsis">
85
"<a class="link" href="GnomeIdleMonitor.html#GnomeIdleMonitor--device" title='The "device" property'>device</a>" <span class="type">GdkDevice</span>* : Read / Write / Construct Only
86
</pre>
87
</div>
88
<div class="refsect1">
89
152
<a name="GnomeIdleMonitor.description"></a><h2>Description</h2>
90
153
<p>
91
154
</p>
92
155
</div>
93
156
<div class="refsect1">
94
<a name="GnomeIdleMonitor.details"></a><h2>Details</h2>
95
<div class="refsect2">
96
<a name="GnomeIdleMonitor-struct"></a><h3>struct GnomeIdleMonitor</h3>
97
<pre class="programlisting">struct GnomeIdleMonitor;</pre>
98
<p>
99
</p>
100
</div>
101
<hr>
102
<div class="refsect2">
103
<a name="GnomeIdleMonitorClass"></a><h3>struct GnomeIdleMonitorClass</h3>
104
<pre class="programlisting">struct GnomeIdleMonitorClass {
105
GObjectClass parent_class;
106
};
107
</pre>
108
<p>
109
</p>
110
</div>
111
<hr>
112
<div class="refsect2">
113
<a name="GnomeIdleMonitorWatchFunc"></a><h3>GnomeIdleMonitorWatchFunc ()</h3>
114
<pre class="programlisting"><span class="returnvalue">void</span> (*GnomeIdleMonitorWatchFunc) (<em class="parameter"><code><a class="link" href="GnomeIdleMonitor.html" title="GnomeIdleMonitor"><span class="type">GnomeIdleMonitor</span></a> *monitor</code></em>,
115
<em class="parameter"><code><span class="type">guint</span> id</code></em>,
116
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
117
<p>
118
</p>
119
</div>
120
<hr>
121
<div class="refsect2">
122
<a name="gnome-idle-monitor-new"></a><h3>gnome_idle_monitor_new ()</h3>
123
<pre class="programlisting"><a class="link" href="GnomeIdleMonitor.html" title="GnomeIdleMonitor"><span class="returnvalue">GnomeIdleMonitor</span></a> * gnome_idle_monitor_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
124
<div class="variablelist"><table border="0" class="variablelist">
125
<colgroup>
126
<col align="left" valign="top">
127
<col>
128
</colgroup>
129
<tbody><tr>
130
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
131
<td>a new <a class="link" href="GnomeIdleMonitor.html" title="GnomeIdleMonitor"><span class="type">GnomeIdleMonitor</span></a> that tracks the server-global
157
<a name="GnomeIdleMonitor.functions_details"></a><h2>Functions</h2>
158
<div class="refsect2">
159
<a name="GnomeIdleMonitorWatchFunc"></a><h3>GnomeIdleMonitorWatchFunc ()</h3>
160
<pre class="programlisting"><span class="returnvalue">void</span>
161
<span class="c_punctuation">(</span>*GnomeIdleMonitorWatchFunc<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="GnomeIdleMonitor.html" title="GnomeIdleMonitor"><span class="type">GnomeIdleMonitor</span></a> *monitor</code></em>,
162
<em class="parameter"><code><span class="type">guint</span> id</code></em>,
163
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
164
<p>
165
</p>
166
</div>
167
<hr>
168
<div class="refsect2">
169
<a name="gnome-idle-monitor-new"></a><h3>gnome_idle_monitor_new ()</h3>
170
<pre class="programlisting"><a class="link" href="GnomeIdleMonitor.html" title="GnomeIdleMonitor"><span class="returnvalue">GnomeIdleMonitor</span></a> *
171
gnome_idle_monitor_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
172
<div class="refsect3">
173
<a name="id-1.6.2.9.3.4"></a><h4>Returns</h4>
174
<p> a new <a class="link" href="GnomeIdleMonitor.html" title="GnomeIdleMonitor"><span class="type">GnomeIdleMonitor</span></a> that tracks the server-global
132
175
idletime for all devices. To track device-specific idletime,
133
use <a class="link" href="GnomeIdleMonitor.html#gnome-idle-monitor-new-for-device" title="gnome_idle_monitor_new_for_device ()"><code class="function">gnome_idle_monitor_new_for_device()</code></a>.</td>
134
</tr></tbody>
135
</table></div>
136
</div>
137
<hr>
138
<div class="refsect2">
139
<a name="gnome-idle-monitor-new-for-device"></a><h3>gnome_idle_monitor_new_for_device ()</h3>
140
<pre class="programlisting"><a class="link" href="GnomeIdleMonitor.html" title="GnomeIdleMonitor"><span class="returnvalue">GnomeIdleMonitor</span></a> * gnome_idle_monitor_new_for_device (<em class="parameter"><code><span class="type">GdkDevice</span> *device</code></em>,
141
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
142
<div class="variablelist"><table border="0" class="variablelist">
143
<colgroup>
144
<col align="left" valign="top">
145
<col>
146
</colgroup>
147
<tbody>
148
<tr>
149
<td><p><span class="term"><em class="parameter"><code>device</code></em> :</span></p></td>
150
<td>A <span class="type">GdkDevice</span> to get the idle time for.</td>
151
</tr>
152
<tr>
153
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
154
<td>A pointer to a <span class="type">GError</span> or <code class="literal">NULL</code>.</td>
155
</tr>
156
<tr>
157
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
158
<td>a new <a class="link" href="GnomeIdleMonitor.html" title="GnomeIdleMonitor"><span class="type">GnomeIdleMonitor</span></a> that tracks the device-specific
159
idletime for <em class="parameter"><code>device</code></em>. If device-specific idletime is not available,
160
<code class="literal">NULL</code> is returned, and <em class="parameter"><code>error</code></em> is set. To track server-global
161
idletime for all devices, use <a class="link" href="GnomeIdleMonitor.html#gnome-idle-monitor-new" title="gnome_idle_monitor_new ()"><code class="function">gnome_idle_monitor_new()</code></a>.</td>
162
</tr>
163
</tbody>
164
</table></div>
165
</div>
166
<hr>
167
<div class="refsect2">
168
<a name="gnome-idle-monitor-add-idle-watch"></a><h3>gnome_idle_monitor_add_idle_watch ()</h3>
169
<pre class="programlisting"><span class="returnvalue">guint</span> gnome_idle_monitor_add_idle_watch (<em class="parameter"><code><a class="link" href="GnomeIdleMonitor.html" title="GnomeIdleMonitor"><span class="type">GnomeIdleMonitor</span></a> *monitor</code></em>,
170
<em class="parameter"><code><span class="type">guint64</span> interval_msec</code></em>,
171
<em class="parameter"><code><a class="link" href="GnomeIdleMonitor.html#GnomeIdleMonitorWatchFunc" title="GnomeIdleMonitorWatchFunc ()"><span class="type">GnomeIdleMonitorWatchFunc</span></a> callback</code></em>,
172
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>,
173
<em class="parameter"><code><span class="type">GDestroyNotify</span> notify</code></em>);</pre>
174
<div class="variablelist"><table border="0" class="variablelist">
175
<colgroup>
176
<col align="left" valign="top">
177
<col>
178
</colgroup>
179
<tbody>
180
<tr>
181
<td><p><span class="term"><em class="parameter"><code>monitor</code></em> :</span></p></td>
182
<td>A <a class="link" href="GnomeIdleMonitor.html" title="GnomeIdleMonitor"><span class="type">GnomeIdleMonitor</span></a>
183
</td>
184
</tr>
185
<tr>
186
<td><p><span class="term"><em class="parameter"><code>interval_msec</code></em> :</span></p></td>
187
<td>The idletime interval, in milliseconds</td>
188
</tr>
189
<tr>
190
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
191
<td>The callback to call when the user has
192
accumulated <em class="parameter"><code>interval_msec</code></em> milliseconds of idle time. <span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span>
193
</td>
194
</tr>
195
<tr>
196
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
197
<td>The user data to pass to the callback. <span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span>
198
</td>
199
</tr>
200
<tr>
201
<td><p><span class="term"><em class="parameter"><code>notify</code></em> :</span></p></td>
202
<td>A <span class="type">GDestroyNotify</span>
203
</td>
204
</tr>
205
<tr>
206
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
207
<td>a watch id
208
Adds a watch for a specific idle time. The callback will be called
209
when the user has accumulated <em class="parameter"><code>interval_msec</code></em> milliseconds of idle time.
176
use <a class="link" href="GnomeIdleMonitor.html#gnome-idle-monitor-new-for-device" title="gnome_idle_monitor_new_for_device ()"><code class="function">gnome_idle_monitor_new_for_device()</code></a>.</p>
177
<p></p>
178
</div>
179
</div>
180
<hr>
181
<div class="refsect2">
182
<a name="gnome-idle-monitor-new-for-device"></a><h3>gnome_idle_monitor_new_for_device ()</h3>
183
<pre class="programlisting"><a class="link" href="GnomeIdleMonitor.html" title="GnomeIdleMonitor"><span class="returnvalue">GnomeIdleMonitor</span></a> *
184
gnome_idle_monitor_new_for_device (<em class="parameter"><code><span class="type">GdkDevice</span> *device</code></em>,
185
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
186
<div class="refsect3">
187
<a name="id-1.6.2.9.4.4"></a><h4>Parameters</h4>
188
<div class="informaltable"><table width="100%" border="0">
189
<colgroup>
190
<col width="150px" class="parameters_name">
191
<col class="parameters_description">
192
<col width="200px" class="parameters_annotations">
193
</colgroup>
194
<tbody>
195
<tr>
196
<td class="parameter_name"><p>device</p></td>
197
<td class="parameter_description"><p>A <span class="type">GdkDevice</span> to get the idle time for.</p></td>
198
<td class="parameter_annotations"> </td>
199
</tr>
200
<tr>
201
<td class="parameter_name"><p>error</p></td>
202
<td class="parameter_description"><p>A pointer to a <span class="type">GError</span> or <code class="literal">NULL</code>.</p></td>
203
<td class="parameter_annotations"> </td>
204
</tr>
205
</tbody>
206
</table></div>
207
</div>
208
<div class="refsect3">
209
<a name="id-1.6.2.9.4.5"></a><h4>Returns</h4>
210
<p> a new <a class="link" href="GnomeIdleMonitor.html" title="GnomeIdleMonitor"><span class="type">GnomeIdleMonitor</span></a> that tracks the device-specific
211
idletime for <em class="parameter"><code>device</code></em>
212
. If device-specific idletime is not available,
213
<code class="literal">NULL</code> is returned, and <em class="parameter"><code>error</code></em>
214
is set. To track server-global
215
idletime for all devices, use <a class="link" href="GnomeIdleMonitor.html#gnome-idle-monitor-new" title="gnome_idle_monitor_new ()"><code class="function">gnome_idle_monitor_new()</code></a>.</p>
216
<p></p>
217
</div>
218
</div>
219
<hr>
220
<div class="refsect2">
221
<a name="gnome-idle-monitor-add-idle-watch"></a><h3>gnome_idle_monitor_add_idle_watch ()</h3>
222
<pre class="programlisting"><span class="returnvalue">guint</span>
223
gnome_idle_monitor_add_idle_watch (<em class="parameter"><code><a class="link" href="GnomeIdleMonitor.html" title="GnomeIdleMonitor"><span class="type">GnomeIdleMonitor</span></a> *monitor</code></em>,
224
<em class="parameter"><code><span class="type">guint64</span> interval_msec</code></em>,
225
<em class="parameter"><code><a class="link" href="GnomeIdleMonitor.html#GnomeIdleMonitorWatchFunc" title="GnomeIdleMonitorWatchFunc ()"><span class="type">GnomeIdleMonitorWatchFunc</span></a> callback</code></em>,
226
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>,
227
<em class="parameter"><code><span class="type">GDestroyNotify</span> notify</code></em>);</pre>
228
<div class="refsect3">
229
<a name="id-1.6.2.9.5.4"></a><h4>Parameters</h4>
230
<div class="informaltable"><table width="100%" border="0">
231
<colgroup>
232
<col width="150px" class="parameters_name">
233
<col class="parameters_description">
234
<col width="200px" class="parameters_annotations">
235
</colgroup>
236
<tbody>
237
<tr>
238
<td class="parameter_name"><p>monitor</p></td>
239
<td class="parameter_description"><p>A <a class="link" href="GnomeIdleMonitor.html" title="GnomeIdleMonitor"><span class="type">GnomeIdleMonitor</span></a></p></td>
240
<td class="parameter_annotations"> </td>
241
</tr>
242
<tr>
243
<td class="parameter_name"><p>interval_msec</p></td>
244
<td class="parameter_description"><p>The idletime interval, in milliseconds</p></td>
245
<td class="parameter_annotations"> </td>
246
</tr>
247
<tr>
248
<td class="parameter_name"><p>callback</p></td>
249
<td class="parameter_description"><p> The callback to call when the user has
250
accumulated <em class="parameter"><code>interval_msec</code></em>
251
milliseconds of idle time. </p></td>
252
<td class="parameter_annotations"><span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span></td>
253
</tr>
254
<tr>
255
<td class="parameter_name"><p>user_data</p></td>
256
<td class="parameter_description"><p> The user data to pass to the callback. </p></td>
257
<td class="parameter_annotations"><span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span></td>
258
</tr>
259
<tr>
260
<td class="parameter_name"><p>notify</p></td>
261
<td class="parameter_description"><p>A <span class="type">GDestroyNotify</span></p></td>
262
<td class="parameter_annotations"> </td>
263
</tr>
264
</tbody>
265
</table></div>
266
</div>
267
<div class="refsect3">
268
<a name="id-1.6.2.9.5.5"></a><h4>Returns</h4>
269
<p> a watch id</p>
270
<p>Adds a watch for a specific idle time. The callback will be called
271
when the user has accumulated <em class="parameter"><code>interval_msec</code></em>
272
milliseconds of idle time.
210
273
This function will return an ID that can either be passed to
211
<a class="link" href="GnomeIdleMonitor.html#gnome-idle-monitor-remove-watch" title="gnome_idle_monitor_remove_watch ()"><code class="function">gnome_idle_monitor_remove_watch()</code></a>, or can be used to tell idle time
212
watches apart if you have more than one.
213
Also note that this function will only care about positive transitions
274
<a class="link" href="GnomeIdleMonitor.html#gnome-idle-monitor-remove-watch" title="gnome_idle_monitor_remove_watch ()"><code class="function">gnome_idle_monitor_remove_watch()</code></a>, or can be used to tell idle time
275
watches apart if you have more than one.</p>
276
<p>Also note that this function will only care about positive transitions
214
277
(user's idle time exceeding a certain time). If you want to know about
215
278
when the user has become active, use
216
<a class="link" href="GnomeIdleMonitor.html#gnome-idle-monitor-add-user-active-watch" title="gnome_idle_monitor_add_user_active_watch ()"><code class="function">gnome_idle_monitor_add_user_active_watch()</code></a>.</td>
217
</tr>
218
</tbody>
219
</table></div>
279
<a class="link" href="GnomeIdleMonitor.html#gnome-idle-monitor-add-user-active-watch" title="gnome_idle_monitor_add_user_active_watch ()"><code class="function">gnome_idle_monitor_add_user_active_watch()</code></a>.</p>
280
<p></p>
281
</div>
220
282
</div>
221
283
<hr>
222
284
<div class="refsect2">
223
<a name="gnome-idle-monitor-add-user-active-watch"></a><h3>gnome_idle_monitor_add_user_active_watch ()</h3>
224
<pre class="programlisting"><span class="returnvalue">guint</span> gnome_idle_monitor_add_user_active_watch
225
(<em class="parameter"><code><a class="link" href="GnomeIdleMonitor.html" title="GnomeIdleMonitor"><span class="type">GnomeIdleMonitor</span></a> *monitor</code></em>,
226
<em class="parameter"><code><a class="link" href="GnomeIdleMonitor.html#GnomeIdleMonitorWatchFunc" title="GnomeIdleMonitorWatchFunc ()"><span class="type">GnomeIdleMonitorWatchFunc</span></a> callback</code></em>,
227
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>,
228
<em class="parameter"><code><span class="type">GDestroyNotify</span> notify</code></em>);</pre>
229
<div class="variablelist"><table border="0" class="variablelist">
285
<a name="gnome-idle-monitor-add-user-active-watch"></a><h3>gnome_idle_monitor_add_user_active_watch ()</h3>
286
<pre class="programlisting"><span class="returnvalue">guint</span>
287
gnome_idle_monitor_add_user_active_watch
288
(<em class="parameter"><code><a class="link" href="GnomeIdleMonitor.html" title="GnomeIdleMonitor"><span class="type">GnomeIdleMonitor</span></a> *monitor</code></em>,
289
<em class="parameter"><code><a class="link" href="GnomeIdleMonitor.html#GnomeIdleMonitorWatchFunc" title="GnomeIdleMonitorWatchFunc ()"><span class="type">GnomeIdleMonitorWatchFunc</span></a> callback</code></em>,
290
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>,
291
<em class="parameter"><code><span class="type">GDestroyNotify</span> notify</code></em>);</pre>
292
<div class="refsect3">
293
<a name="id-1.6.2.9.6.4"></a><h4>Parameters</h4>
294
<div class="informaltable"><table width="100%" border="0">
230
295
<colgroup>
231
<col align="left" valign="top">
232
<col>
296
<col width="150px" class="parameters_name">
297
<col class="parameters_description">
298
<col width="200px" class="parameters_annotations">
233
299
</colgroup>
234
300
<tbody>
235
301
<tr>
236
<td><p><span class="term"><em class="parameter"><code>monitor</code></em> :</span></p></td>
237
<td>A <a class="link" href="GnomeIdleMonitor.html" title="GnomeIdleMonitor"><span class="type">GnomeIdleMonitor</span></a>
238
</td>
239
</tr>
240
<tr>
241
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
242
<td>The callback to call when the user is
243
active again. <span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span>
244
</td>
245
</tr>
246
<tr>
247
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
248
<td>The user data to pass to the callback. <span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span>
249
</td>
250
</tr>
251
<tr>
252
<td><p><span class="term"><em class="parameter"><code>notify</code></em> :</span></p></td>
253
<td>A <span class="type">GDestroyNotify</span>
254
</td>
255
</tr>
256
<tr>
257
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
258
<td>a watch id
259
Add a one-time watch to know when the user is active again.
302
<td class="parameter_name"><p>monitor</p></td>
303
<td class="parameter_description"><p>A <a class="link" href="GnomeIdleMonitor.html" title="GnomeIdleMonitor"><span class="type">GnomeIdleMonitor</span></a></p></td>
304
<td class="parameter_annotations"> </td>
305
</tr>
306
<tr>
307
<td class="parameter_name"><p>callback</p></td>
308
<td class="parameter_description"><p> The callback to call when the user is
309
active again. </p></td>
310
<td class="parameter_annotations"><span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span></td>
311
</tr>
312
<tr>
313
<td class="parameter_name"><p>user_data</p></td>
314
<td class="parameter_description"><p> The user data to pass to the callback. </p></td>
315
<td class="parameter_annotations"><span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span></td>
316
</tr>
317
<tr>
318
<td class="parameter_name"><p>notify</p></td>
319
<td class="parameter_description"><p>A <span class="type">GDestroyNotify</span></p></td>
320
<td class="parameter_annotations"> </td>
321
</tr>
322
</tbody>
323
</table></div>
324
</div>
325
<div class="refsect3">
326
<a name="id-1.6.2.9.6.5"></a><h4>Returns</h4>
327
<p> a watch id</p>
328
<p>Add a one-time watch to know when the user is active again.
260
329
Note that this watch is one-time and will de-activate after the
261
330
function is called, for efficiency purposes. It's most convenient
262
331
to call this when an idle watch, as added by
263
<a class="link" href="GnomeIdleMonitor.html#gnome-idle-monitor-add-idle-watch" title="gnome_idle_monitor_add_idle_watch ()"><code class="function">gnome_idle_monitor_add_idle_watch()</code></a>, has triggered.</td>
264
</tr>
265
</tbody>
266
</table></div>
267
</div>
268
<hr>
269
<div class="refsect2">
270
<a name="gnome-idle-monitor-remove-watch"></a><h3>gnome_idle_monitor_remove_watch ()</h3>
271
<pre class="programlisting"><span class="returnvalue">void</span> gnome_idle_monitor_remove_watch (<em class="parameter"><code><a class="link" href="GnomeIdleMonitor.html" title="GnomeIdleMonitor"><span class="type">GnomeIdleMonitor</span></a> *monitor</code></em>,
272
<em class="parameter"><code><span class="type">guint</span> id</code></em>);</pre>
273
<p>
274
Removes an idle time watcher, previously added by
275
<a class="link" href="GnomeIdleMonitor.html#gnome-idle-monitor-add-idle-watch" title="gnome_idle_monitor_add_idle_watch ()"><code class="function">gnome_idle_monitor_add_idle_watch()</code></a> or
276
<a class="link" href="GnomeIdleMonitor.html#gnome-idle-monitor-add-user-active-watch" title="gnome_idle_monitor_add_user_active_watch ()"><code class="function">gnome_idle_monitor_add_user_active_watch()</code></a>.
277
</p>
278
<div class="variablelist"><table border="0" class="variablelist">
279
<colgroup>
280
<col align="left" valign="top">
281
<col>
282
</colgroup>
283
<tbody>
284
<tr>
285
<td><p><span class="term"><em class="parameter"><code>monitor</code></em> :</span></p></td>
286
<td>A <a class="link" href="GnomeIdleMonitor.html" title="GnomeIdleMonitor"><span class="type">GnomeIdleMonitor</span></a>
287
</td>
288
</tr>
289
<tr>
290
<td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td>
291
<td>A watch ID</td>
292
</tr>
293
</tbody>
294
</table></div>
295
</div>
296
<hr>
297
<div class="refsect2">
298
<a name="gnome-idle-monitor-get-idletime"></a><h3>gnome_idle_monitor_get_idletime ()</h3>
299
<pre class="programlisting"><span class="returnvalue">guint64</span> gnome_idle_monitor_get_idletime (<em class="parameter"><code><a class="link" href="GnomeIdleMonitor.html" title="GnomeIdleMonitor"><span class="type">GnomeIdleMonitor</span></a> *monitor</code></em>);</pre>
300
<div class="variablelist"><table border="0" class="variablelist">
301
<colgroup>
302
<col align="left" valign="top">
303
<col>
304
</colgroup>
305
<tbody>
306
<tr>
307
<td><p><span class="term"><em class="parameter"><code>monitor</code></em> :</span></p></td>
308
<td>A <a class="link" href="GnomeIdleMonitor.html" title="GnomeIdleMonitor"><span class="type">GnomeIdleMonitor</span></a>
309
</td>
310
</tr>
311
<tr>
312
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
313
<td>The current idle time, in milliseconds</td>
314
</tr>
315
</tbody>
316
</table></div>
332
<a class="link" href="GnomeIdleMonitor.html#gnome-idle-monitor-add-idle-watch" title="gnome_idle_monitor_add_idle_watch ()"><code class="function">gnome_idle_monitor_add_idle_watch()</code></a>, has triggered.</p>
333
<p></p>
334
</div>
335
</div>
336
<hr>
337
<div class="refsect2">
338
<a name="gnome-idle-monitor-remove-watch"></a><h3>gnome_idle_monitor_remove_watch ()</h3>
339
<pre class="programlisting"><span class="returnvalue">void</span>
340
gnome_idle_monitor_remove_watch (<em class="parameter"><code><a class="link" href="GnomeIdleMonitor.html" title="GnomeIdleMonitor"><span class="type">GnomeIdleMonitor</span></a> *monitor</code></em>,
341
<em class="parameter"><code><span class="type">guint</span> id</code></em>);</pre>
342
<p>Removes an idle time watcher, previously added by
343
<a class="link" href="GnomeIdleMonitor.html#gnome-idle-monitor-add-idle-watch" title="gnome_idle_monitor_add_idle_watch ()"><code class="function">gnome_idle_monitor_add_idle_watch()</code></a> or
344
<a class="link" href="GnomeIdleMonitor.html#gnome-idle-monitor-add-user-active-watch" title="gnome_idle_monitor_add_user_active_watch ()"><code class="function">gnome_idle_monitor_add_user_active_watch()</code></a>.</p>
345
<div class="refsect3">
346
<a name="id-1.6.2.9.7.5"></a><h4>Parameters</h4>
347
<div class="informaltable"><table width="100%" border="0">
348
<colgroup>
349
<col width="150px" class="parameters_name">
350
<col class="parameters_description">
351
<col width="200px" class="parameters_annotations">
352
</colgroup>
353
<tbody>
354
<tr>
355
<td class="parameter_name"><p>monitor</p></td>
356
<td class="parameter_description"><p>A <a class="link" href="GnomeIdleMonitor.html" title="GnomeIdleMonitor"><span class="type">GnomeIdleMonitor</span></a></p></td>
357
<td class="parameter_annotations"> </td>
358
</tr>
359
<tr>
360
<td class="parameter_name"><p>id</p></td>
361
<td class="parameter_description"><p>A watch ID</p></td>
362
<td class="parameter_annotations"> </td>
363
</tr>
364
</tbody>
365
</table></div>
366
</div>
367
</div>
368
<hr>
369
<div class="refsect2">
370
<a name="gnome-idle-monitor-get-idletime"></a><h3>gnome_idle_monitor_get_idletime ()</h3>
371
<pre class="programlisting"><span class="returnvalue">guint64</span>
372
gnome_idle_monitor_get_idletime (<em class="parameter"><code><a class="link" href="GnomeIdleMonitor.html" title="GnomeIdleMonitor"><span class="type">GnomeIdleMonitor</span></a> *monitor</code></em>);</pre>
373
<div class="refsect3">
374
<a name="id-1.6.2.9.8.4"></a><h4>Parameters</h4>
375
<div class="informaltable"><table width="100%" border="0">
376
<colgroup>
377
<col width="150px" class="parameters_name">
378
<col class="parameters_description">
379
<col width="200px" class="parameters_annotations">
380
</colgroup>
381
<tbody><tr>
382
<td class="parameter_name"><p>monitor</p></td>
383
<td class="parameter_description"><p>A <a class="link" href="GnomeIdleMonitor.html" title="GnomeIdleMonitor"><span class="type">GnomeIdleMonitor</span></a></p></td>
384
<td class="parameter_annotations"> </td>
385
</tr></tbody>
386
</table></div>
387
</div>
388
<div class="refsect3">
389
<a name="id-1.6.2.9.8.5"></a><h4>Returns</h4>
390
<p> The current idle time, in milliseconds</p>
391
<p></p>
392
</div>
393
</div>
394
</div>
395
<div class="refsect1">
396
<a name="GnomeIdleMonitor.other_details"></a><h2>Types and Values</h2>
397
<div class="refsect2">
398
<a name="GnomeIdleMonitor-struct"></a><h3>struct GnomeIdleMonitor</h3>
399
<pre class="programlisting">struct GnomeIdleMonitor;</pre>
400
<p>
401
</p>
402
</div>
403
<hr>
404
<div class="refsect2">
405
<a name="GnomeIdleMonitorClass"></a><h3>struct GnomeIdleMonitorClass</h3>
406
<pre class="programlisting">struct GnomeIdleMonitorClass {
407
GObjectClass parent_class;
408
};
409
</pre>
410
<p>
411
</p>
317
412
</div>
318
413
</div>
319
414
<div class="refsect1">
320
415
<a name="GnomeIdleMonitor.property-details"></a><h2>Property Details</h2>
321
416
<div class="refsect2">
322
<a name="GnomeIdleMonitor--device"></a><h3>The <code class="literal">"device"</code> property</h3>
323
<pre class="programlisting"> "device" <span class="type">GdkDevice</span>* : Read / Write / Construct Only</pre>
324
<p>
325
The device to listen to idletime on.
326
</p>
417
<a name="GnomeIdleMonitor--device"></a><h3>The <code class="literal">“device”</code> property</h3>
418
<pre class="programlisting"> “device” <span class="type">GdkDevice</span> *</pre>
419
<p>The device to listen to idletime on.</p>
420
<p>Flags: Read / Write / Construct Only</p>
327
421
</div>
328
422
</div>
329
423
</div>
330
424
<div class="footer">
331
425
<hr>
332
Generated by GTK-Doc V1.19</div>
426
Generated by GTK-Doc V1.20</div>
333
427
</body>
334
428
</html>
b'\\ No newline at end of file'
Loggerhead is a web-based interface for Breezy
Version: 2.0.1