Debian Codegraph @

docs/reference/html/XfceScreensaver.html

raw
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>XfceScreensaver: libxfce4ui Reference Manual</title>
6 <meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
7 <link rel="home" href="index.html" title="libxfce4ui Reference Manual">
8 <link rel="up" href="ch01.html" title="[Insert title here]">
9 <link rel="prev" href="XfceSMClient.html" title="XfceSMClient">
10 <link rel="next" href="XfceFilenameInput.html" title="XfceFilenameInput">
11 <meta name="generator" content="GTK-Doc V1.34.0 (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="5"><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="#XfceScreensaver.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
19 <a href="#XfceScreensaver.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties">  <span class="dim">|</span> 
20 <a href="#XfceScreensaver.properties" class="shortcut">Properties</a></span>
21 </td>
22 <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
23 <td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
24 <td><a accesskey="p" href="XfceSMClient.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
25 <td><a accesskey="n" href="XfceFilenameInput.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
26 </tr></table>
27 <div class="refentry">
28 <a name="XfceScreensaver"></a><div class="titlepage"></div>
29 <div class="refnamediv"><table width="100%"><tr>
30 <td valign="top">
31 <h2><span class="refentrytitle"><a name="XfceScreensaver.top_of_page"></a>XfceScreensaver</span></h2>
32 <p>XfceScreensaver — screensaver related shared functions</p>
33 </td>
34 <td class="gallery_image" valign="top" align="right"></td>
35 </tr></table></div>
36 <div class="refsect1">
37 <a name="XfceScreensaver.functions"></a><h2>Functions</h2>
38 <div class="informaltable"><table class="informaltable" width="100%" border="0">
39 <colgroup>
40 <col width="150px" class="functions_proto_type">
41 <col class="functions_proto_name">
42 </colgroup>
43 <tbody>
44 <tr>
45 <td class="function_type">
46 <a class="link" href="XfceScreensaver.html" title="XfceScreensaver"><span class="returnvalue">XfceScreensaver</span></a> *
47 </td>
48 <td class="function_name">
49 <a class="link" href="XfceScreensaver.html#xfce-screensaver-new" title="xfce_screensaver_new ()">xfce_screensaver_new</a> <span class="c_punctuation">()</span>
50 </td>
51 </tr>
52 <tr>
53 <td class="function_type">
54 <span class="returnvalue">void</span>
55 </td>
56 <td class="function_name">
57 <a class="link" href="XfceScreensaver.html#xfce-screensaver-inhibit" title="xfce_screensaver_inhibit ()">xfce_screensaver_inhibit</a> <span class="c_punctuation">()</span>
58 </td>
59 </tr>
60 <tr>
61 <td class="function_type">
62 <span class="returnvalue">gboolean</span>
63 </td>
64 <td class="function_name">
65 <a class="link" href="XfceScreensaver.html#xfce-screensaver-lock" title="xfce_screensaver_lock ()">xfce_screensaver_lock</a> <span class="c_punctuation">()</span>
66 </td>
67 </tr>
68 </tbody>
69 </table></div>
70 </div>
71 <div class="refsect1">
72 <a name="XfceScreensaver.properties"></a><h2>Properties</h2>
73 <div class="informaltable"><table class="informaltable" border="0">
74 <colgroup>
75 <col width="150px" class="properties_type">
76 <col width="300px" class="properties_name">
77 <col width="200px" class="properties_flags">
78 </colgroup>
79 <tbody>
80 <tr>
81 <td class="property_type">
82 <span class="type">char</span> *</td>
83 <td class="property_name"><a class="link" href="XfceScreensaver.html#XfceScreensaver--heartbeat-command" title="The “heartbeat-command” property">heartbeat-command</a></td>
84 <td class="property_flags">Read / Write / Construct</td>
85 </tr>
86 <tr>
87 <td class="property_type">
88 <span class="type">char</span> *</td>
89 <td class="property_name"><a class="link" href="XfceScreensaver.html#XfceScreensaver--lock-command" title="The “lock-command” property">lock-command</a></td>
90 <td class="property_flags">Read / Write / Construct</td>
91 </tr>
92 <tr>
93 <td class="property_type"><span class="type">gboolean</span></td>
94 <td class="property_name"><a class="link" href="XfceScreensaver.html#XfceScreensaver--lock-on-sleep" title="The “lock-on-sleep” property">lock-on-sleep</a></td>
95 <td class="property_flags">Read / Write / Construct</td>
96 </tr>
97 </tbody>
98 </table></div>
99 </div>
100 <div class="refsect1">
101 <a name="XfceScreensaver.other"></a><h2>Types and Values</h2>
102 <div class="informaltable"><table class="informaltable" width="100%" border="0">
103 <colgroup>
104 <col width="150px" class="other_proto_type">
105 <col class="other_proto_name">
106 </colgroup>
107 <tbody><tr>
108 <td class="datatype_keyword"> </td>
109 <td class="function_name"><a class="link" href="XfceScreensaver.html#XfceScreensaver-struct" title="XfceScreensaver">XfceScreensaver</a></td>
110 </tr></tbody>
111 </table></div>
112 </div>
113 <div class="refsect1">
114 <a name="XfceScreensaver.object-hierarchy"></a><h2>Object Hierarchy</h2>
115 <pre class="screen"> GObject
116 <span class="lineart">╰──</span> XfceScreensaver
117 </pre>
118 </div>
119 <div class="refsect1">
120 <a name="XfceScreensaver.includes"></a><h2>Includes</h2>
121 <pre class="synopsis">#include &lt;libxfce4ui/libxfce4ui.h&gt;
122 </pre>
123 </div>
124 <div class="refsect1">
125 <a name="XfceScreensaver.description"></a><h2>Description</h2>
126 </div>
127 <div class="refsect1">
128 <a name="XfceScreensaver.functions_details"></a><h2>Functions</h2>
129 <div class="refsect2">
130 <a name="xfce-screensaver-new"></a><h3>xfce_screensaver_new ()</h3>
131 <pre class="programlisting"><a class="link" href="XfceScreensaver.html" title="XfceScreensaver"><span class="returnvalue">XfceScreensaver</span></a> *
132 xfce_screensaver_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
133 <p>Creates a new <a class="link" href="XfceScreensaver.html" title="XfceScreensaver"><span class="type">XfceScreensaver</span></a> object or increases the reference count
134 of the current object.</p>
135 <div class="refsect3">
136 <a name="xfce-screensaver-new.returns"></a><h4>Returns</h4>
137 <p>An <a class="link" href="XfceScreensaver.html" title="XfceScreensaver"><span class="type">XfceScreensaver</span></a> object, to be released with
138 <code class="function">g_object_unref()</code> when no longer used. </p>
139 <p><span class="annotation">[<acronym title="The caller owns the data, and is responsible for free it."><span class="acronym">transfer full</span></acronym>]</span></p>
140 </div>
141 <p class="since">Since: <a class="link" href="api-index-4-18-2.html#api-index-4.18.2">4.18.2</a></p>
142 </div>
143 <hr>
144 <div class="refsect2">
145 <a name="xfce-screensaver-inhibit"></a><h3>xfce_screensaver_inhibit ()</h3>
146 <pre class="programlisting"><span class="returnvalue">void</span>
147 xfce_screensaver_inhibit (<em class="parameter"><code><a class="link" href="XfceScreensaver.html" title="XfceScreensaver"><span class="type">XfceScreensaver</span></a> *saver</code></em>,
148 <em class="parameter"><code><span class="type">gboolean</span> inhibit</code></em>);</pre>
149 <p>Calling this function with <em class="parameter"><code>inhibit</code></em>
150 as <code class="literal">TRUE</code> will prevent the user's
151 screensaver from activating. This is useful when the user is watching
152 a movie or giving a presentation.</p>
153 <p>Calling this function with <em class="parameter"><code>inhibit</code></em>
154 as <code class="literal">FALSE</code> will remove any current
155 screensaver inhibit the <a class="link" href="XfceScreensaver.html" title="XfceScreensaver"><span class="type">XfceScreensaver</span></a> object has.</p>
156 <div class="refsect3">
157 <a name="xfce-screensaver-inhibit.parameters"></a><h4>Parameters</h4>
158 <div class="informaltable"><table class="informaltable" width="100%" border="0">
159 <colgroup>
160 <col width="150px" class="parameters_name">
161 <col class="parameters_description">
162 <col width="200px" class="parameters_annotations">
163 </colgroup>
164 <tbody>
165 <tr>
166 <td class="parameter_name"><p>saver</p></td>
167 <td class="parameter_description"><p>the <a class="link" href="XfceScreensaver.html" title="XfceScreensaver"><span class="type">XfceScreensaver</span></a> object</p></td>
168 <td class="parameter_annotations"> </td>
169 </tr>
170 <tr>
171 <td class="parameter_name"><p>inhibit</p></td>
172 <td class="parameter_description"><p>whether to inhibit the screensaver from activating</p></td>
173 <td class="parameter_annotations"> </td>
174 </tr>
175 </tbody>
176 </table></div>
177 </div>
178 <p class="since">Since: <a class="link" href="api-index-4-18-2.html#api-index-4.18.2">4.18.2</a></p>
179 </div>
180 <hr>
181 <div class="refsect2">
182 <a name="xfce-screensaver-lock"></a><h3>xfce_screensaver_lock ()</h3>
183 <pre class="programlisting"><span class="returnvalue">gboolean</span>
184 xfce_screensaver_lock (<em class="parameter"><code><a class="link" href="XfceScreensaver.html" title="XfceScreensaver"><span class="type">XfceScreensaver</span></a> *saver</code></em>);</pre>
185 <p>Attempts to lock the screen, either with one of the screensaver
186 D-Bus proxies, the Xfconf lock command, or one of the
187 fallback scripts such as xdg-screensaver.</p>
188 <div class="refsect3">
189 <a name="xfce-screensaver-lock.parameters"></a><h4>Parameters</h4>
190 <div class="informaltable"><table class="informaltable" width="100%" border="0">
191 <colgroup>
192 <col width="150px" class="parameters_name">
193 <col class="parameters_description">
194 <col width="200px" class="parameters_annotations">
195 </colgroup>
196 <tbody><tr>
197 <td class="parameter_name"><p>saver</p></td>
198 <td class="parameter_description"><p>the <a class="link" href="XfceScreensaver.html" title="XfceScreensaver"><span class="type">XfceScreensaver</span></a> object</p></td>
199 <td class="parameter_annotations"> </td>
200 </tr></tbody>
201 </table></div>
202 </div>
203 <div class="refsect3">
204 <a name="xfce-screensaver-lock.returns"></a><h4>Returns</h4>
205 <p> <code class="literal">TRUE</code> if the lock attempt returns success, <code class="literal">FALSE</code> otherwise.</p>
206 </div>
207 <p class="since">Since: <a class="link" href="api-index-4-18-2.html#api-index-4.18.2">4.18.2</a></p>
208 </div>
209 </div>
210 <div class="refsect1">
211 <a name="XfceScreensaver.other_details"></a><h2>Types and Values</h2>
212 <div class="refsect2">
213 <a name="XfceScreensaver-struct"></a><h3>XfceScreensaver</h3>
214 <pre class="programlisting">typedef struct _XfceScreensaver XfceScreensaver;</pre>
215 </div>
216 </div>
217 <div class="refsect1">
218 <a name="XfceScreensaver.property-details"></a><h2>Property Details</h2>
219 <div class="refsect2">
220 <a name="XfceScreensaver--heartbeat-command"></a><h3>The <code class="literal">“heartbeat-command”</code> property</h3>
221 <pre class="programlisting"> “heartbeat-command” <span class="type">char</span> *</pre>
222 <p>Inhibit the screensaver from activating, e.g. xscreensaver-command --deactivate.</p>
223 <p>Owner: XfceScreensaver</p>
224 <p>Flags: Read / Write / Construct</p>
225 <p>Default value: NULL</p>
226 </div>
227 <hr>
228 <div class="refsect2">
229 <a name="XfceScreensaver--lock-command"></a><h3>The <code class="literal">“lock-command”</code> property</h3>
230 <pre class="programlisting"> “lock-command” <span class="type">char</span> *</pre>
231 <p>Lock the desktop, e.g. xscreensaver-command --lock.</p>
232 <p>Owner: XfceScreensaver</p>
233 <p>Flags: Read / Write / Construct</p>
234 <p>Default value: NULL</p>
235 </div>
236 <hr>
237 <div class="refsect2">
238 <a name="XfceScreensaver--lock-on-sleep"></a><h3>The <code class="literal">“lock-on-sleep”</code> property</h3>
239 <pre class="programlisting"> “lock-on-sleep” <span class="type">gboolean</span></pre>
240 <p>Whether to lock before suspend/hibernate.</p>
241 <p>Owner: XfceScreensaver</p>
242 <p>Flags: Read / Write / Construct</p>
243 <p>Default value: FALSE</p>
244 </div>
245 </div>
246 </div>
247 <div class="footer">
248 <hr>Generated by GTK-Doc V1.34.0</div>
249 </body>
250 </html>