~ubuntu-branches/ubuntu/vivid/upower/vivid

« back to all changes in this revision

Viewing changes to doc/html/UPower-up-history-item.html

  • Committer: Package Import Robot
  • Author(s): Martin Pitt
  • Date: 2013-10-08 18:26:25 UTC
  • mfrom: (49.1.1 sid)
  • Revision ID: package-import@ubuntu.com-20131008182625-roccyppydypnly0t
Tags: 0.9.22-1
* New upstream release.
* Drop 00git_updates.patch, included in new release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
 
<html>
3
 
<head>
4
 
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
 
<title>up-history-item</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
7
 
<link rel="home" href="index.html" title="UPower Reference Manual">
8
 
<link rel="up" href="libupower-glib.html" title="libupower-glib GObjects">
9
 
<link rel="prev" href="UPower-up-device.html" title="up-device">
10
 
<link rel="next" href="UPower-up-qos-item.html" title="up-qos-item">
11
 
<meta name="generator" content="GTK-Doc V1.19 (XML mode)">
12
 
<link rel="stylesheet" href="style.css" type="text/css">
13
 
</head>
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="UPower-up-device.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18
 
<td><a accesskey="u" href="libupower-glib.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">UPower Reference Manual</th>
21
 
<td><a accesskey="n" href="UPower-up-qos-item.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="#UPower-up-history-item.synopsis" class="shortcut">Top</a>
25
 
                   | 
26
 
                  <a href="#UPower-up-history-item.description" class="shortcut">Description</a>
27
 
</td></tr>
28
 
</table>
29
 
<div class="refentry">
30
 
<a name="UPower-up-history-item"></a><div class="titlepage"></div>
31
 
<div class="refnamediv"><table width="100%"><tr>
32
 
<td valign="top">
33
 
<h2><span class="refentrytitle"><a name="UPower-up-history-item.top_of_page"></a>up-history-item</span></h2>
34
 
<p>up-history-item — Helper object representing one item of historical data.</p>
35
 
</td>
36
 
<td valign="top" align="right"></td>
37
 
</tr></table></div>
38
 
<div class="refsynopsisdiv">
39
 
<a name="UPower-up-history-item.synopsis"></a><h2>Synopsis</h2>
40
 
<pre class="synopsis"><a class="link" href="UPower-up-types.html#UpDeviceState" title="enum UpDeviceState"><span class="returnvalue">UpDeviceState</span></a>       <a class="link" href="UPower-up-history-item.html#up-history-item-get-state" title="up_history_item_get_state ()">up_history_item_get_state</a>           (<em class="parameter"><code><span class="type">UpHistoryItem</span> *history_item</code></em>);
41
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <a class="link" href="UPower-up-history-item.html#up-history-item-get-time" title="up_history_item_get_time ()">up_history_item_get_time</a>            (<em class="parameter"><code><span class="type">UpHistoryItem</span> *history_item</code></em>);
42
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a>             <a class="link" href="UPower-up-history-item.html#up-history-item-get-value" title="up_history_item_get_value ()">up_history_item_get_value</a>           (<em class="parameter"><code><span class="type">UpHistoryItem</span> *history_item</code></em>);
43
 
<span class="returnvalue">UpHistoryItem</span> *     <a class="link" href="UPower-up-history-item.html#up-history-item-new" title="up_history_item_new ()">up_history_item_new</a>                 (<em class="parameter"><code><span class="type">void</span></code></em>);
44
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="UPower-up-history-item.html#up-history-item-set-from-string" title="up_history_item_set_from_string ()">up_history_item_set_from_string</a>     (<em class="parameter"><code><span class="type">UpHistoryItem</span> *history_item</code></em>,
45
 
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *text</code></em>);
46
 
<span class="returnvalue">void</span>                <a class="link" href="UPower-up-history-item.html#up-history-item-set-state" title="up_history_item_set_state ()">up_history_item_set_state</a>           (<em class="parameter"><code><span class="type">UpHistoryItem</span> *history_item</code></em>,
47
 
                                                         <em class="parameter"><code><a class="link" href="UPower-up-types.html#UpDeviceState" title="enum UpDeviceState"><span class="type">UpDeviceState</span></a> state</code></em>);
48
 
<span class="returnvalue">void</span>                <a class="link" href="UPower-up-history-item.html#up-history-item-set-time" title="up_history_item_set_time ()">up_history_item_set_time</a>            (<em class="parameter"><code><span class="type">UpHistoryItem</span> *history_item</code></em>,
49
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> time</code></em>);
50
 
<span class="returnvalue">void</span>                <a class="link" href="UPower-up-history-item.html#up-history-item-set-time-to-present" title="up_history_item_set_time_to_present ()">up_history_item_set_time_to_present</a> (<em class="parameter"><code><span class="type">UpHistoryItem</span> *history_item</code></em>);
51
 
<span class="returnvalue">void</span>                <a class="link" href="UPower-up-history-item.html#up-history-item-set-value" title="up_history_item_set_value ()">up_history_item_set_value</a>           (<em class="parameter"><code><span class="type">UpHistoryItem</span> *history_item</code></em>,
52
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> value</code></em>);
53
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             <a class="link" href="UPower-up-history-item.html#up-history-item-to-string" title="up_history_item_to_string ()">up_history_item_to_string</a>           (<em class="parameter"><code><span class="type">UpHistoryItem</span> *history_item</code></em>);
54
 
</pre>
55
 
</div>
56
 
<div class="refsect1">
57
 
<a name="UPower-up-history-item.description"></a><h2>Description</h2>
58
 
<p>
59
 
This object represents one item of data which may be returned from the
60
 
daemon in response to a query.
61
 
</p>
62
 
<p>
63
 
See also: <span class="type">UpDevice</span>, <span class="type">UpClient</span>
64
 
</p>
65
 
</div>
66
 
<div class="refsect1">
67
 
<a name="UPower-up-history-item.details"></a><h2>Details</h2>
68
 
<div class="refsect2">
69
 
<a name="up-history-item-get-state"></a><h3>up_history_item_get_state ()</h3>
70
 
<pre class="programlisting"><a class="link" href="UPower-up-types.html#UpDeviceState" title="enum UpDeviceState"><span class="returnvalue">UpDeviceState</span></a>       up_history_item_get_state           (<em class="parameter"><code><span class="type">UpHistoryItem</span> *history_item</code></em>);</pre>
71
 
<p>
72
 
Gets the item state.
73
 
</p>
74
 
<div class="variablelist"><table border="0" class="variablelist">
75
 
<colgroup>
76
 
<col align="left" valign="top">
77
 
<col>
78
 
</colgroup>
79
 
<tbody><tr>
80
 
<td><p><span class="term"><em class="parameter"><code>history_item</code></em> :</span></p></td>
81
 
<td><span class="type">UpHistoryItem</span></td>
82
 
</tr></tbody>
83
 
</table></div>
84
 
<p class="since">Since 0.9.0</p>
85
 
</div>
86
 
<hr>
87
 
<div class="refsect2">
88
 
<a name="up-history-item-get-time"></a><h3>up_history_item_get_time ()</h3>
89
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               up_history_item_get_time            (<em class="parameter"><code><span class="type">UpHistoryItem</span> *history_item</code></em>);</pre>
90
 
<p>
91
 
Gets the item time.
92
 
</p>
93
 
<div class="variablelist"><table border="0" class="variablelist">
94
 
<colgroup>
95
 
<col align="left" valign="top">
96
 
<col>
97
 
</colgroup>
98
 
<tbody><tr>
99
 
<td><p><span class="term"><em class="parameter"><code>history_item</code></em> :</span></p></td>
100
 
<td><span class="type">UpHistoryItem</span></td>
101
 
</tr></tbody>
102
 
</table></div>
103
 
<p class="since">Since 0.9.0</p>
104
 
</div>
105
 
<hr>
106
 
<div class="refsect2">
107
 
<a name="up-history-item-get-value"></a><h3>up_history_item_get_value ()</h3>
108
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a>             up_history_item_get_value           (<em class="parameter"><code><span class="type">UpHistoryItem</span> *history_item</code></em>);</pre>
109
 
<p>
110
 
Gets the item value.
111
 
</p>
112
 
<div class="variablelist"><table border="0" class="variablelist">
113
 
<colgroup>
114
 
<col align="left" valign="top">
115
 
<col>
116
 
</colgroup>
117
 
<tbody><tr>
118
 
<td><p><span class="term"><em class="parameter"><code>history_item</code></em> :</span></p></td>
119
 
<td><span class="type">UpHistoryItem</span></td>
120
 
</tr></tbody>
121
 
</table></div>
122
 
<p class="since">Since 0.9.0</p>
123
 
</div>
124
 
<hr>
125
 
<div class="refsect2">
126
 
<a name="up-history-item-new"></a><h3>up_history_item_new ()</h3>
127
 
<pre class="programlisting"><span class="returnvalue">UpHistoryItem</span> *     up_history_item_new                 (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
128
 
<div class="variablelist"><table border="0" class="variablelist">
129
 
<colgroup>
130
 
<col align="left" valign="top">
131
 
<col>
132
 
</colgroup>
133
 
<tbody><tr>
134
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
135
 
<td>a new UpHistoryItem object.</td>
136
 
</tr></tbody>
137
 
</table></div>
138
 
<p class="since">Since 0.9.0</p>
139
 
</div>
140
 
<hr>
141
 
<div class="refsect2">
142
 
<a name="up-history-item-set-from-string"></a><h3>up_history_item_set_from_string ()</h3>
143
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            up_history_item_set_from_string     (<em class="parameter"><code><span class="type">UpHistoryItem</span> *history_item</code></em>,
144
 
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *text</code></em>);</pre>
145
 
<p>
146
 
Converts the history item to a string representation.
147
 
</p>
148
 
<div class="variablelist"><table border="0" class="variablelist">
149
 
<colgroup>
150
 
<col align="left" valign="top">
151
 
<col>
152
 
</colgroup>
153
 
<tbody><tr>
154
 
<td><p><span class="term"><em class="parameter"><code>history_item</code></em> :</span></p></td>
155
 
<td><span class="type">UpHistoryItem</span></td>
156
 
</tr></tbody>
157
 
</table></div>
158
 
<p class="since">Since 0.9.1</p>
159
 
</div>
160
 
<hr>
161
 
<div class="refsect2">
162
 
<a name="up-history-item-set-state"></a><h3>up_history_item_set_state ()</h3>
163
 
<pre class="programlisting"><span class="returnvalue">void</span>                up_history_item_set_state           (<em class="parameter"><code><span class="type">UpHistoryItem</span> *history_item</code></em>,
164
 
                                                         <em class="parameter"><code><a class="link" href="UPower-up-types.html#UpDeviceState" title="enum UpDeviceState"><span class="type">UpDeviceState</span></a> state</code></em>);</pre>
165
 
<p>
166
 
Sets the item state.
167
 
</p>
168
 
<div class="variablelist"><table border="0" class="variablelist">
169
 
<colgroup>
170
 
<col align="left" valign="top">
171
 
<col>
172
 
</colgroup>
173
 
<tbody>
174
 
<tr>
175
 
<td><p><span class="term"><em class="parameter"><code>history_item</code></em> :</span></p></td>
176
 
<td><span class="type">UpHistoryItem</span></td>
177
 
</tr>
178
 
<tr>
179
 
<td><p><span class="term"><em class="parameter"><code>state</code></em> :</span></p></td>
180
 
<td>the new value</td>
181
 
</tr>
182
 
</tbody>
183
 
</table></div>
184
 
<p class="since">Since 0.9.0</p>
185
 
</div>
186
 
<hr>
187
 
<div class="refsect2">
188
 
<a name="up-history-item-set-time"></a><h3>up_history_item_set_time ()</h3>
189
 
<pre class="programlisting"><span class="returnvalue">void</span>                up_history_item_set_time            (<em class="parameter"><code><span class="type">UpHistoryItem</span> *history_item</code></em>,
190
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> time</code></em>);</pre>
191
 
<p>
192
 
Sets the item time.
193
 
</p>
194
 
<div class="variablelist"><table border="0" class="variablelist">
195
 
<colgroup>
196
 
<col align="left" valign="top">
197
 
<col>
198
 
</colgroup>
199
 
<tbody>
200
 
<tr>
201
 
<td><p><span class="term"><em class="parameter"><code>history_item</code></em> :</span></p></td>
202
 
<td><span class="type">UpHistoryItem</span></td>
203
 
</tr>
204
 
<tr>
205
 
<td><p><span class="term"><em class="parameter"><code>time</code></em> :</span></p></td>
206
 
<td>the new value</td>
207
 
</tr>
208
 
</tbody>
209
 
</table></div>
210
 
<p class="since">Since 0.9.0</p>
211
 
</div>
212
 
<hr>
213
 
<div class="refsect2">
214
 
<a name="up-history-item-set-time-to-present"></a><h3>up_history_item_set_time_to_present ()</h3>
215
 
<pre class="programlisting"><span class="returnvalue">void</span>                up_history_item_set_time_to_present (<em class="parameter"><code><span class="type">UpHistoryItem</span> *history_item</code></em>);</pre>
216
 
<p>
217
 
Sets the item time to the present value.
218
 
</p>
219
 
<div class="variablelist"><table border="0" class="variablelist">
220
 
<colgroup>
221
 
<col align="left" valign="top">
222
 
<col>
223
 
</colgroup>
224
 
<tbody><tr>
225
 
<td><p><span class="term"><em class="parameter"><code>history_item</code></em> :</span></p></td>
226
 
<td><span class="type">UpHistoryItem</span></td>
227
 
</tr></tbody>
228
 
</table></div>
229
 
<p class="since">Since 0.9.1</p>
230
 
</div>
231
 
<hr>
232
 
<div class="refsect2">
233
 
<a name="up-history-item-set-value"></a><h3>up_history_item_set_value ()</h3>
234
 
<pre class="programlisting"><span class="returnvalue">void</span>                up_history_item_set_value           (<em class="parameter"><code><span class="type">UpHistoryItem</span> *history_item</code></em>,
235
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> value</code></em>);</pre>
236
 
<p>
237
 
Sets the item value.
238
 
</p>
239
 
<div class="variablelist"><table border="0" class="variablelist">
240
 
<colgroup>
241
 
<col align="left" valign="top">
242
 
<col>
243
 
</colgroup>
244
 
<tbody>
245
 
<tr>
246
 
<td><p><span class="term"><em class="parameter"><code>history_item</code></em> :</span></p></td>
247
 
<td><span class="type">UpHistoryItem</span></td>
248
 
</tr>
249
 
<tr>
250
 
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
251
 
<td>the new value</td>
252
 
</tr>
253
 
</tbody>
254
 
</table></div>
255
 
<p class="since">Since 0.9.0</p>
256
 
</div>
257
 
<hr>
258
 
<div class="refsect2">
259
 
<a name="up-history-item-to-string"></a><h3>up_history_item_to_string ()</h3>
260
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             up_history_item_to_string           (<em class="parameter"><code><span class="type">UpHistoryItem</span> *history_item</code></em>);</pre>
261
 
<p>
262
 
Converts the history item to a string representation.
263
 
</p>
264
 
<div class="variablelist"><table border="0" class="variablelist">
265
 
<colgroup>
266
 
<col align="left" valign="top">
267
 
<col>
268
 
</colgroup>
269
 
<tbody><tr>
270
 
<td><p><span class="term"><em class="parameter"><code>history_item</code></em> :</span></p></td>
271
 
<td><span class="type">UpHistoryItem</span></td>
272
 
</tr></tbody>
273
 
</table></div>
274
 
<p class="since">Since 0.9.1</p>
275
 
</div>
276
 
</div>
277
 
</div>
278
 
<div class="footer">
279
 
<hr>
280
 
          Generated by GTK-Doc V1.19</div>
281
 
</body>
282
 
</html>
 
 
b'\\ No newline at end of file'