/usr/share/gtk-doc/html/libmatemixer/MateMixerSwitch.html is in libmatemixer-doc 1.12.1-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>MateMixerSwitch: libmatemixer Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="libmatemixer Reference Manual">
<link rel="up" href="ch01.html" title="API Reference">
<link rel="prev" href="MateMixerStoredControl.html" title="MateMixerStoredControl">
<link rel="next" href="MateMixerSwitchOption.html" title="MateMixerSwitchOption">
<meta name="generator" content="GTK-Doc V1.24 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#MateMixerSwitch.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#MateMixerSwitch.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#MateMixerSwitch.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="MateMixerStoredControl.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="MateMixerSwitchOption.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="MateMixerSwitch"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="MateMixerSwitch.top_of_page"></a>MateMixerSwitch</span></h2>
<p>MateMixerSwitch</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="MateMixerSwitch.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="MateMixerSwitch.html#mate-mixer-switch-get-name" title="mate_mixer_switch_get_name ()">mate_mixer_switch_get_name</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="MateMixerSwitch.html#mate-mixer-switch-get-label" title="mate_mixer_switch_get_label ()">mate_mixer_switch_get_label</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="MateMixerSwitchOption.html" title="MateMixerSwitchOption"><span class="returnvalue">MateMixerSwitchOption</span></a> *
</td>
<td class="function_name">
<a class="link" href="MateMixerSwitch.html#mate-mixer-switch-get-option" title="mate_mixer_switch_get_option ()">mate_mixer_switch_get_option</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">GList</span> *
</td>
<td class="function_name">
<a class="link" href="MateMixerSwitch.html#mate-mixer-switch-list-options" title="mate_mixer_switch_list_options ()">mate_mixer_switch_list_options</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="MateMixerSwitchOption.html" title="MateMixerSwitchOption"><span class="returnvalue">MateMixerSwitchOption</span></a> *
</td>
<td class="function_name">
<a class="link" href="MateMixerSwitch.html#mate-mixer-switch-get-active-option" title="mate_mixer_switch_get_active_option ()">mate_mixer_switch_get_active_option</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="MateMixerSwitch.html#mate-mixer-switch-set-active-option" title="mate_mixer_switch_set_active_option ()">mate_mixer_switch_set_active_option</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="MateMixerSwitch.properties"></a><h2>Properties</h2>
<div class="informaltable"><table border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type">
<a class="link" href="MateMixerSwitchOption.html" title="MateMixerSwitchOption"><span class="type">MateMixerSwitchOption</span></a> *</td>
<td class="property_name"><a class="link" href="MateMixerSwitch.html#MateMixerSwitch--active-option" title="The “active-option” property">active-option</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type">
<span class="type">gchar</span> *</td>
<td class="property_name"><a class="link" href="MateMixerSwitch.html#MateMixerSwitch--label" title="The “label” property">label</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type">
<span class="type">gchar</span> *</td>
<td class="property_name"><a class="link" href="MateMixerSwitch.html#MateMixerSwitch--name" title="The “name” property">name</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="MateMixerSwitch.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="MateMixerSwitch.html#MateMixerSwitch-struct" title="MateMixerSwitch">MateMixerSwitch</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="MateMixerSwitch.html#MateMixerSwitchClass" title="struct MateMixerSwitchClass">MateMixerSwitchClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="MateMixerSwitch.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GObject
<span class="lineart">╰──</span> MateMixerSwitch
<span class="lineart">├──</span> <a class="link" href="MateMixerDeviceSwitch.html" title="MateMixerDeviceSwitch">MateMixerDeviceSwitch</a>
<span class="lineart">╰──</span> <a class="link" href="MateMixerStreamSwitch.html" title="MateMixerStreamSwitch">MateMixerStreamSwitch</a>
</pre>
</div>
<div class="refsect1">
<a name="MateMixerSwitch.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <libmatemixer/matemixer.h>
</pre>
</div>
<div class="refsect1">
<a name="MateMixerSwitch.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="MateMixerSwitch.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="mate-mixer-switch-get-name"></a><h3>mate_mixer_switch_get_name ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
mate_mixer_switch_get_name (<em class="parameter"><code><a class="link" href="MateMixerSwitch.html" title="MateMixerSwitch"><span class="type">MateMixerSwitch</span></a> *swtch</code></em>);</pre>
<p>Gets the name of the switch.</p>
<p>The name serves as a unique identifier and in most cases it is not in a
user-readable form.</p>
<div class="refsect3">
<a name="id-1.2.12.9.2.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>swtch</p></td>
<td class="parameter_description"><p>a <a class="link" href="MateMixerSwitch.html" title="MateMixerSwitch"><span class="type">MateMixerSwitch</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.12.9.2.7"></a><h4>Returns</h4>
<p> the name of the switch.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="mate-mixer-switch-get-label"></a><h3>mate_mixer_switch_get_label ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
mate_mixer_switch_get_label (<em class="parameter"><code><a class="link" href="MateMixerSwitch.html" title="MateMixerSwitch"><span class="type">MateMixerSwitch</span></a> *swtch</code></em>);</pre>
<p>Gets the label of the switch.</p>
<p>This is a potentially translated string that should be presented to users
in the user interface.</p>
<div class="refsect3">
<a name="id-1.2.12.9.3.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>swtch</p></td>
<td class="parameter_description"><p>a <a class="link" href="MateMixerSwitch.html" title="MateMixerSwitch"><span class="type">MateMixerSwitch</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.12.9.3.7"></a><h4>Returns</h4>
<p> the label of the switch option.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="mate-mixer-switch-get-option"></a><h3>mate_mixer_switch_get_option ()</h3>
<pre class="programlisting"><a class="link" href="MateMixerSwitchOption.html" title="MateMixerSwitchOption"><span class="returnvalue">MateMixerSwitchOption</span></a> *
mate_mixer_switch_get_option (<em class="parameter"><code><a class="link" href="MateMixerSwitch.html" title="MateMixerSwitch"><span class="type">MateMixerSwitch</span></a> *swtch</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
<p>Gets the <a class="link" href="MateMixerSwitchOption.html" title="MateMixerSwitchOption"><span class="type">MateMixerSwitchOption</span></a> with the given name.</p>
<div class="refsect3">
<a name="id-1.2.12.9.4.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>swtch</p></td>
<td class="parameter_description"><p>a <a class="link" href="MateMixerSwitch.html" title="MateMixerSwitch"><span class="type">MateMixerSwitch</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>the name of an option</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.12.9.4.6"></a><h4>Returns</h4>
<p> a <a class="link" href="MateMixerSwitchOption.html" title="MateMixerSwitchOption"><span class="type">MateMixerSwitchOption</span></a> or <code class="literal">NULL</code> if there is no such switch option.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="mate-mixer-switch-list-options"></a><h3>mate_mixer_switch_list_options ()</h3>
<pre class="programlisting">const <span class="returnvalue">GList</span> *
mate_mixer_switch_list_options (<em class="parameter"><code><a class="link" href="MateMixerSwitch.html" title="MateMixerSwitch"><span class="type">MateMixerSwitch</span></a> *swtch</code></em>);</pre>
<p>Gets the list of switch options that belong to the switch.</p>
<p>The returned <span class="type">GList</span> is owned by the <a class="link" href="MateMixerSwitch.html" title="MateMixerSwitch"><span class="type">MateMixerSwitch</span></a> and may be invalidated
at any time.</p>
<div class="refsect3">
<a name="id-1.2.12.9.5.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>swtch</p></td>
<td class="parameter_description"><p>a <a class="link" href="MateMixerSwitch.html" title="MateMixerSwitch"><span class="type">MateMixerSwitch</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.12.9.5.7"></a><h4>Returns</h4>
<p> a <span class="type">GList</span> of the switch options.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="mate-mixer-switch-get-active-option"></a><h3>mate_mixer_switch_get_active_option ()</h3>
<pre class="programlisting"><a class="link" href="MateMixerSwitchOption.html" title="MateMixerSwitchOption"><span class="returnvalue">MateMixerSwitchOption</span></a> *
mate_mixer_switch_get_active_option (<em class="parameter"><code><a class="link" href="MateMixerSwitch.html" title="MateMixerSwitch"><span class="type">MateMixerSwitch</span></a> *swtch</code></em>);</pre>
<p>Gets the <a class="link" href="MateMixerSwitchOption.html" title="MateMixerSwitchOption"><span class="type">MateMixerSwitchOption</span></a> which is currently active.</p>
<div class="refsect3">
<a name="id-1.2.12.9.6.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>swtch</p></td>
<td class="parameter_description"><p>a <a class="link" href="MateMixerSwitch.html" title="MateMixerSwitch"><span class="type">MateMixerSwitch</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.12.9.6.6"></a><h4>Returns</h4>
<p> a <a class="link" href="MateMixerSwitchOption.html" title="MateMixerSwitchOption"><span class="type">MateMixerSwitchOption</span></a>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="mate-mixer-switch-set-active-option"></a><h3>mate_mixer_switch_set_active_option ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
mate_mixer_switch_set_active_option (<em class="parameter"><code><a class="link" href="MateMixerSwitch.html" title="MateMixerSwitch"><span class="type">MateMixerSwitch</span></a> *swtch</code></em>,
<em class="parameter"><code><a class="link" href="MateMixerSwitchOption.html" title="MateMixerSwitchOption"><span class="type">MateMixerSwitchOption</span></a> *option</code></em>);</pre>
<p>Changes the currently active switch option.</p>
<div class="refsect3">
<a name="id-1.2.12.9.7.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>swtch</p></td>
<td class="parameter_description"><p>a <a class="link" href="MateMixerSwitch.html" title="MateMixerSwitch"><span class="type">MateMixerSwitch</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>option</p></td>
<td class="parameter_description"><p>the <a class="link" href="MateMixerSwitchOption.html" title="MateMixerSwitchOption"><span class="type">MateMixerSwitchOption</span></a> to set as the active option</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.12.9.7.6"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> on success or <code class="literal">FALSE</code> on failure.</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="MateMixerSwitch.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="MateMixerSwitch-struct"></a><h3>MateMixerSwitch</h3>
<pre class="programlisting">typedef struct _MateMixerSwitch MateMixerSwitch;</pre>
<p>The <a class="link" href="MateMixerSwitch.html" title="MateMixerSwitch"><span class="type">MateMixerSwitch</span></a> structure contains only private data and should only
be accessed using the provided API.</p>
</div>
<hr>
<div class="refsect2">
<a name="MateMixerSwitchClass"></a><h3>struct MateMixerSwitchClass</h3>
<pre class="programlisting">struct MateMixerSwitchClass {
GObjectClass parent_class;
};
</pre>
<p>The class structure for <a class="link" href="MateMixerSwitch.html" title="MateMixerSwitch"><span class="type">MateMixerSwitch</span></a>.</p>
<div class="refsect3">
<a name="id-1.2.12.10.3.5"></a><h4>Members</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody><tr>
<td class="struct_member_name"><p><span class="type">GObjectClass</span> <em class="structfield"><code><a name="MateMixerSwitchClass.parent-class"></a>parent_class</code></em>;</p></td>
<td class="struct_member_description"><p>The parent class.</p></td>
<td class="struct_member_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="MateMixerSwitch.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="MateMixerSwitch--active-option"></a><h3>The <code class="literal">“active-option”</code> property</h3>
<pre class="programlisting"> “active-option” <a class="link" href="MateMixerSwitchOption.html" title="MateMixerSwitchOption"><span class="type">MateMixerSwitchOption</span></a> *</pre>
<p>Active option of the switch.</p>
<p>Flags: Read / Write / Construct Only</p>
</div>
<hr>
<div class="refsect2">
<a name="MateMixerSwitch--label"></a><h3>The <code class="literal">“label”</code> property</h3>
<pre class="programlisting"> “label” <span class="type">gchar</span> *</pre>
<p>Label of the switch.</p>
<p>Flags: Read / Write / Construct Only</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="MateMixerSwitch--name"></a><h3>The <code class="literal">“name”</code> property</h3>
<pre class="programlisting"> “name” <span class="type">gchar</span> *</pre>
<p>Name of the switch.</p>
<p>Flags: Read / Write / Construct Only</p>
<p>Default value: NULL</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24</div>
</body>
</html>
|