Debian Codegraph @

docs/reference/html/garcon-Desktop-Environment-Configuration.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>Desktop Environment Configuration: garcon Reference Manual</title>
6 <meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
7 <link rel="home" href="index.html" title="garcon Reference Manual">
8 <link rel="up" href="garcon-miscellaneous.html" title="Part V. Miscellaneous">
9 <link rel="prev" href="garcon-miscellaneous.html" title="Part V. Miscellaneous">
10 <link rel="next" href="garcon-Version-Information.html" title="Version Information">
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="#garcon-Desktop-Environment-Configuration.description" class="shortcut">Description</a></span>
19 </td>
20 <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
21 <td><a accesskey="u" href="garcon-miscellaneous.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
22 <td><a accesskey="p" href="garcon-miscellaneous.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
23 <td><a accesskey="n" href="garcon-Version-Information.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
24 </tr></table>
25 <div class="refentry">
26 <a name="garcon-Desktop-Environment-Configuration"></a><div class="titlepage"></div>
27 <div class="refnamediv"><table width="100%"><tr>
28 <td valign="top">
29 <h2><span class="refentrytitle"><a name="garcon-Desktop-Environment-Configuration.top_of_page"></a>Desktop Environment Configuration</span></h2>
30 <p>Desktop Environment Configuration — Desktop Environment Configuration</p>
31 </td>
32 <td class="gallery_image" valign="top" align="right"></td>
33 </tr></table></div>
34 <div class="refsect1">
35 <a name="garcon-Desktop-Environment-Configuration.functions"></a><h2>Functions</h2>
36 <div class="informaltable"><table class="informaltable" width="100%" border="0">
37 <colgroup>
38 <col width="150px" class="functions_proto_type">
39 <col class="functions_proto_name">
40 </colgroup>
41 <tbody>
42 <tr>
43 <td class="function_type">
44 <span class="returnvalue">void</span>
45 </td>
46 <td class="function_name">
47 <a class="link" href="garcon-Desktop-Environment-Configuration.html#garcon-set-environment" title="garcon_set_environment ()">garcon_set_environment</a> <span class="c_punctuation">()</span>
48 </td>
49 </tr>
50 <tr>
51 <td class="function_type">const <span class="returnvalue">gchar</span> *
52 </td>
53 <td class="function_name">
54 <a class="link" href="garcon-Desktop-Environment-Configuration.html#garcon-get-environment" title="garcon_get_environment ()">garcon_get_environment</a> <span class="c_punctuation">()</span>
55 </td>
56 </tr>
57 <tr>
58 <td class="function_type">
59 <span class="returnvalue">void</span>
60 </td>
61 <td class="function_name">
62 <a class="link" href="garcon-Desktop-Environment-Configuration.html#garcon-set-environment-xdg" title="garcon_set_environment_xdg ()">garcon_set_environment_xdg</a> <span class="c_punctuation">()</span>
63 </td>
64 </tr>
65 </tbody>
66 </table></div>
67 </div>
68 <div class="refsect1">
69 <a name="garcon-Desktop-Environment-Configuration.other"></a><h2>Types and Values</h2>
70 <div class="informaltable"><table class="informaltable" width="100%" border="0">
71 <colgroup>
72 <col width="150px" class="other_proto_type">
73 <col class="other_proto_name">
74 </colgroup>
75 <tbody><tr>
76 <td class="define_keyword">#define</td>
77 <td class="function_name"><a class="link" href="garcon-Desktop-Environment-Configuration.html#GARCON-ENVIRONMENT-XFCE:CAPS" title="GARCON_ENVIRONMENT_XFCE">GARCON_ENVIRONMENT_XFCE</a></td>
78 </tr></tbody>
79 </table></div>
80 </div>
81 <div class="refsect1">
82 <a name="garcon-Desktop-Environment-Configuration.includes"></a><h2>Includes</h2>
83 <pre class="synopsis">#include &lt;garcon/garcon.h&gt;
84 </pre>
85 </div>
86 <div class="refsect1">
87 <a name="garcon-Desktop-Environment-Configuration.description"></a><h2>Description</h2>
88 <p>Set the desktop environment used by the OnlyShowIn and NotShowIn
89 desktop files keys.</p>
90 </div>
91 <div class="refsect1">
92 <a name="garcon-Desktop-Environment-Configuration.functions_details"></a><h2>Functions</h2>
93 <div class="refsect2">
94 <a name="garcon-set-environment"></a><h3>garcon_set_environment ()</h3>
95 <pre class="programlisting"><span class="returnvalue">void</span>
96 garcon_set_environment (<em class="parameter"><code>const <span class="type">gchar</span> *env</code></em>);</pre>
97 <p>Sets (or unsets) the desktop environment for which menus will generated.
98 Menus and menu items belonging to other desktop environments will be
99 ignored. If set to <code class="literal">NULL</code>, all menu items are used.</p>
100 <div class="refsect3">
101 <a name="garcon-set-environment.parameters"></a><h4>Parameters</h4>
102 <div class="informaltable"><table class="informaltable" width="100%" border="0">
103 <colgroup>
104 <col width="150px" class="parameters_name">
105 <col class="parameters_description">
106 <col width="200px" class="parameters_annotations">
107 </colgroup>
108 <tbody><tr>
109 <td class="parameter_name"><p>env</p></td>
110 <td class="parameter_description"><p>Name of the desktop environment for which menus will
111 be generated (e.g. XFCE, KDE, GNOME or <code class="literal">NULL</code>).</p></td>
112 <td class="parameter_annotations"> </td>
113 </tr></tbody>
114 </table></div>
115 </div>
116 </div>
117 <hr>
118 <div class="refsect2">
119 <a name="garcon-get-environment"></a><h3>garcon_get_environment ()</h3>
120 <pre class="programlisting">const <span class="returnvalue">gchar</span> *
121 garcon_get_environment (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
122 <p>Get the environment set with <a class="link" href="garcon-Desktop-Environment-Configuration.html#garcon-set-environment" title="garcon_set_environment ()"><code class="function">garcon_set_environment()</code></a>.</p>
123 <div class="refsect3">
124 <a name="garcon-get-environment.returns"></a><h4>Returns</h4>
125 <p> Name of the desktop environment (e.g. XFCE, KDE, GNOME)
126 which is used or <code class="literal">NULL</code>.</p>
127 </div>
128 </div>
129 <hr>
130 <div class="refsect2">
131 <a name="garcon-set-environment-xdg"></a><h3>garcon_set_environment_xdg ()</h3>
132 <pre class="programlisting"><span class="returnvalue">void</span>
133 garcon_set_environment_xdg (<em class="parameter"><code>const <span class="type">gchar</span> *fallback_env</code></em>);</pre>
134 <p>Set the desktop environment to the envvar XDG_CURRENT_DESKTOP.
135 If this variables is not set, it falls back to <em class="parameter"><code>default_env</code></em>
136 .</p>
137 <p>For <em class="parameter"><code>fallback_env</code></em>
138 you can use for example <a class="link" href="garcon-Desktop-Environment-Configuration.html#GARCON-ENVIRONMENT-XFCE:CAPS" title="GARCON_ENVIRONMENT_XFCE"><span class="type">GARCON_ENVIRONMENT_XFCE</span></a>.</p>
139 <div class="refsect3">
140 <a name="garcon-set-environment-xdg.parameters"></a><h4>Parameters</h4>
141 <div class="informaltable"><table class="informaltable" width="100%" border="0">
142 <colgroup>
143 <col width="150px" class="parameters_name">
144 <col class="parameters_description">
145 <col width="200px" class="parameters_annotations">
146 </colgroup>
147 <tbody><tr>
148 <td class="parameter_name"><p>fallback_env</p></td>
149 <td class="parameter_description"><p>fallback value</p></td>
150 <td class="parameter_annotations"> </td>
151 </tr></tbody>
152 </table></div>
153 </div>
154 <p class="since">Since: <a class="link" href="api-index-0-3.html#api-index-0.3.0">0.3.0</a></p>
155 </div>
156 </div>
157 <div class="refsect1">
158 <a name="garcon-Desktop-Environment-Configuration.other_details"></a><h2>Types and Values</h2>
159 <div class="refsect2">
160 <a name="GARCON-ENVIRONMENT-XFCE:CAPS"></a><h3>GARCON_ENVIRONMENT_XFCE</h3>
161 <pre class="programlisting">#define GARCON_ENVIRONMENT_XFCE "XFCE"
162 </pre>
163 <p>Macro for garcon_set_environment or garcon_set_environment_xdg
164 to set the Xfce Desktop Environment.</p>
165 <p class="since">Since: <a class="link" href="api-index-0-3.html#api-index-0.3.0">0.3.0</a></p>
166 </div>
167 </div>
168 </div>
169 <div class="footer">
170 <hr>Generated by GTK-Doc V1.34.0</div>
171 </body>
172 </html>