~xubuntu-dev/libxfce4util/maverick

« back to all changes in this revision

Viewing changes to docs/html/libxfce4util-Xfce-Kiosk-functions.html

  • Committer: Bazaar Package Importer
  • Author(s): Yves-Alexis Perez
  • Date: 2008-07-06 10:58:49 UTC
  • mfrom: (1.2.11 upstream)
  • mto: (2.2.1 squeeze)
  • mto: This revision was merged to the branch mainline in revision 18.
  • Revision ID: james.westby@ubuntu.com-20080706105849-zetal1iaztbjbj6x
Tags: 4.4.2-3
* debian/control:
  - fixed typo in short description.                          closes: #489493
  - removed Martin Loschwitz from Uploaders.
  - updated standards version to 3.8.0.

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=US-ASCII">
 
5
<title>Xfce Kiosk functions</title>
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
 
7
<link rel="start" href="index.html" title="libxfce4util Reference Manual">
 
8
<link rel="up" href="libxfce4util-core.html" title="Xfce Core Application support">
 
9
<link rel="prev" href="libxfce4util-Desktop-entries.html" title="XfceDesktopEntry">
 
10
<link rel="next" href="libxfce4util-utilities.html" title="Xfce Utilities">
 
11
<meta name="generator" content="GTK-Doc V1.8 (XML mode)">
 
12
<link rel="stylesheet" href="style.css" type="text/css">
 
13
<link rel="chapter" href="reference.html" title="libxfce4util Overview">
 
14
<link rel="chapter" href="libxfce4util-fundamentals.html" title="Xfce Fundamentals">
 
15
<link rel="chapter" href="libxfce4util-core.html" title="Xfce Core Application support">
 
16
<link rel="chapter" href="libxfce4util-utilities.html" title="Xfce Utilities">
 
17
<link rel="chapter" href="libxfce4util-datatypes.html" title="Xfce Data types">
 
18
</head>
 
19
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
 
20
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
 
21
<tr valign="middle">
 
22
<td><a accesskey="p" href="libxfce4util-Desktop-entries.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 
23
<td><a accesskey="u" href="libxfce4util-core.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
 
24
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
 
25
<th width="100%" align="center">libxfce4util Reference Manual</th>
 
26
<td><a accesskey="n" href="libxfce4util-utilities.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
 
27
</tr>
 
28
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2580349" class="shortcut">Top</a>
 
29
                  &#160;|&#160;
 
30
                  <a href="#id2580444" class="shortcut">Description</a></nobr></td></tr>
 
31
</table>
 
32
<div class="refentry" lang="en">
 
33
<a name="libxfce4util-Xfce-Kiosk-functions"></a><div class="titlepage"></div>
 
34
<div class="refnamediv"><table width="100%"><tr>
 
35
<td valign="top">
 
36
<h2>
 
37
<a name="id2580349"></a><span class="refentrytitle">Xfce Kiosk functions</span>
 
38
</h2>
 
39
<p>Xfce Kiosk functions &#8212; Xfce Kiosk mode support functions.</p>
 
40
</td>
 
41
<td valign="top" align="right"></td>
 
42
</tr></table></div>
 
43
<div class="refsynopsisdiv">
 
44
<h2>Synopsis</h2>
 
45
<pre class="synopsis">
 
46
 
 
47
#include &lt;libxfce4util/libxfce4util.h&gt;
 
48
 
 
49
 
 
50
                    <a class="link" href="libxfce4util-Xfce-Kiosk-functions.html#XfceKiosk">XfceKiosk</a>;
 
51
<a class="link" href="libxfce4util-Xfce-Kiosk-functions.html#XfceKiosk">XfceKiosk</a>*          <a class="link" href="libxfce4util-Xfce-Kiosk-functions.html#xfce-kiosk-new">xfce_kiosk_new</a>                      (const <a
 
52
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
 
53
>gchar</a> *module);
 
54
<a
 
55
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
 
56
>gboolean</a>            <a class="link" href="libxfce4util-Xfce-Kiosk-functions.html#xfce-kiosk-query">xfce_kiosk_query</a>                    (const <a class="link" href="libxfce4util-Xfce-Kiosk-functions.html#XfceKiosk">XfceKiosk</a> *kiosk,
 
57
                                                         const <a
 
58
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
 
59
>gchar</a> *capability);
 
60
void                <a class="link" href="libxfce4util-Xfce-Kiosk-functions.html#xfce-kiosk-free">xfce_kiosk_free</a>                     (<a class="link" href="libxfce4util-Xfce-Kiosk-functions.html#XfceKiosk">XfceKiosk</a> *kiosk);
 
61
</pre>
 
62
</div>
 
63
<div class="refsect1" lang="en">
 
64
<a name="id2580444"></a><h2>Description</h2>
 
65
<p>
 
66
        This module provides a simple Kiosk mode for Xfce.
 
67
</p>
 
68
</div>
 
69
<div class="refsect1" lang="en">
 
70
<a name="id2580459"></a><h2>Details</h2>
 
71
<div class="refsect2" lang="en">
 
72
<a name="id2580470"></a><h3>
 
73
<a name="XfceKiosk"></a>XfceKiosk</h3>
 
74
<a class="indexterm" name="id2580482"></a><pre class="programlisting">typedef struct _XfceKiosk XfceKiosk;</pre>
 
75
<p>
 
76
 
 
77
</p>
 
78
</div>
 
79
<hr>
 
80
<div class="refsect2" lang="en">
 
81
<a name="id2580497"></a><h3>
 
82
<a name="xfce-kiosk-new"></a>xfce_kiosk_new ()</h3>
 
83
<a class="indexterm" name="id2580512"></a><pre class="programlisting"><a class="link" href="libxfce4util-Xfce-Kiosk-functions.html#XfceKiosk">XfceKiosk</a>*          xfce_kiosk_new                      (const <a
 
84
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
 
85
>gchar</a> *module);</pre>
 
86
<p>
 
87
FIXME</p>
 
88
<p>
 
89
 
 
90
</p>
 
91
<div class="variablelist"><table border="0">
 
92
<col align="left" valign="top">
 
93
<tbody>
 
94
<tr>
 
95
<td><p><span class="term"><em class="parameter"><code>module</code></em>&#160;:</span></p></td>
 
96
<td>
 
97
</td>
 
98
</tr>
 
99
<tr>
 
100
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
 
101
<td>
 
102
 
 
103
 
 
104
</td>
 
105
</tr>
 
106
</tbody>
 
107
</table></div>
 
108
<p class="since">Since  4.2
 
109
</p>
 
110
</div>
 
111
<hr>
 
112
<div class="refsect2" lang="en">
 
113
<a name="id2580578"></a><h3>
 
114
<a name="xfce-kiosk-query"></a>xfce_kiosk_query ()</h3>
 
115
<a class="indexterm" name="id2580593"></a><pre class="programlisting"><a
 
116
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
 
117
>gboolean</a>            xfce_kiosk_query                    (const <a class="link" href="libxfce4util-Xfce-Kiosk-functions.html#XfceKiosk">XfceKiosk</a> *kiosk,
 
118
                                                         const <a
 
119
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
 
120
>gchar</a> *capability);</pre>
 
121
<p>
 
122
Queries the <em class="parameter"><code>kiosk</code></em> object for a given capability and returns <a
 
123
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
 
124
><code class="literal">TRUE</code></a> if
 
125
the current user has the <em class="parameter"><code>capability</code></em>, else <a
 
126
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
 
127
><code class="literal">FALSE</code></a>.</p>
 
128
<p>
 
129
 
 
130
</p>
 
131
<div class="variablelist"><table border="0">
 
132
<col align="left" valign="top">
 
133
<tbody>
 
134
<tr>
 
135
<td><p><span class="term"><em class="parameter"><code>kiosk</code></em>&#160;:</span></p></td>
 
136
<td>      A <a class="link" href="libxfce4util-Xfce-Kiosk-functions.html#XfceKiosk"><span class="type">XfceKiosk</span></a>.
 
137
</td>
 
138
</tr>
 
139
<tr>
 
140
<td><p><span class="term"><em class="parameter"><code>capability</code></em>&#160;:</span></p></td>
 
141
<td> The name of the capability to check.
 
142
</td>
 
143
</tr>
 
144
<tr>
 
145
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
 
146
<td> <a
 
147
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
 
148
><code class="literal">TRUE</code></a> if the current user has the <em class="parameter"><code>capability</code></em>, else <a
 
149
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
 
150
><code class="literal">FALSE</code></a>.
 
151
 
 
152
</td>
 
153
</tr>
 
154
</tbody>
 
155
</table></div>
 
156
<p class="since">Since  4.2
 
157
</p>
 
158
</div>
 
159
<hr>
 
160
<div class="refsect2" lang="en">
 
161
<a name="id2580749"></a><h3>
 
162
<a name="xfce-kiosk-free"></a>xfce_kiosk_free ()</h3>
 
163
<a class="indexterm" name="id2580764"></a><pre class="programlisting">void                xfce_kiosk_free                     (<a class="link" href="libxfce4util-Xfce-Kiosk-functions.html#XfceKiosk">XfceKiosk</a> *kiosk);</pre>
 
164
<p>
 
165
Frees the <em class="parameter"><code>kiosk</code></em> object.</p>
 
166
<p>
 
167
 
 
168
</p>
 
169
<div class="variablelist"><table border="0">
 
170
<col align="left" valign="top">
 
171
<tbody><tr>
 
172
<td><p><span class="term"><em class="parameter"><code>kiosk</code></em>&#160;:</span></p></td>
 
173
<td> A <a class="link" href="libxfce4util-Xfce-Kiosk-functions.html#XfceKiosk"><span class="type">XfceKiosk</span></a>.
 
174
</td>
 
175
</tr></tbody>
 
176
</table></div>
 
177
<p class="since">Since  4.2
 
178
</p>
 
179
</div>
 
180
</div>
 
181
</div>
 
182
</body>
 
183
</html>