/usr/share/gtk-doc/html/libmatemixer/MateMixerSwitchOption.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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>MateMixerSwitchOption: 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="MateMixerSwitch.html" title="MateMixerSwitch">
<link rel="next" href="api-index-full.html" title="API Index">
<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="#MateMixerSwitchOption.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#MateMixerSwitchOption.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#MateMixerSwitchOption.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="MateMixerSwitch.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="api-index-full.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="MateMixerSwitchOption"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="MateMixerSwitchOption.top_of_page"></a>MateMixerSwitchOption</span></h2>
<p>MateMixerSwitchOption</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="MateMixerSwitchOption.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="MateMixerSwitchOption.html#mate-mixer-switch-option-get-name" title="mate_mixer_switch_option_get_name ()">mate_mixer_switch_option_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="MateMixerSwitchOption.html#mate-mixer-switch-option-get-label" title="mate_mixer_switch_option_get_label ()">mate_mixer_switch_option_get_label</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="MateMixerSwitchOption.html#mate-mixer-switch-option-get-icon" title="mate_mixer_switch_option_get_icon ()">mate_mixer_switch_option_get_icon</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="MateMixerSwitchOption.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">
<span class="type">gchar</span> *</td>
<td class="property_name"><a class="link" href="MateMixerSwitchOption.html#MateMixerSwitchOption--icon" title="The “icon” property">icon</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="MateMixerSwitchOption.html#MateMixerSwitchOption--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="MateMixerSwitchOption.html#MateMixerSwitchOption--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="MateMixerSwitchOption.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="MateMixerSwitchOption.html#MateMixerSwitchOption-struct" title="MateMixerSwitchOption">MateMixerSwitchOption</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="MateMixerSwitchOption.html#MateMixerSwitchOptionClass" title="struct MateMixerSwitchOptionClass">MateMixerSwitchOptionClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="MateMixerSwitchOption.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GObject
<span class="lineart">╰──</span> MateMixerSwitchOption
</pre>
</div>
<div class="refsect1">
<a name="MateMixerSwitchOption.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <libmatemixer/matemixer.h>
</pre>
</div>
<div class="refsect1">
<a name="MateMixerSwitchOption.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="MateMixerSwitchOption.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="mate-mixer-switch-option-get-name"></a><h3>mate_mixer_switch_option_get_name ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
mate_mixer_switch_option_get_name (<em class="parameter"><code><a class="link" href="MateMixerSwitchOption.html" title="MateMixerSwitchOption"><span class="type">MateMixerSwitchOption</span></a> *option</code></em>);</pre>
<p>Gets the name of the switch option. The name serves as a unique identifier
and in most cases it is not in a user-readable form.</p>
<p>The returned name is guaranteed to be unique across all the switch options
of a particular <a class="link" href="MateMixerSwitch.html" title="MateMixerSwitch"><span class="type">MateMixerSwitch</span></a> and may be used to get the <a class="link" href="MateMixerSwitchOption.html" title="MateMixerSwitchOption"><span class="type">MateMixerSwitchOption</span></a>
using <a class="link" href="MateMixerSwitch.html#mate-mixer-switch-get-option" title="mate_mixer_switch_get_option ()"><code class="function">mate_mixer_switch_get_option()</code></a>.</p>
<div class="refsect3">
<a name="id-1.2.13.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>option</p></td>
<td class="parameter_description"><p>a <a class="link" href="MateMixerSwitchOption.html" title="MateMixerSwitchOption"><span class="type">MateMixerSwitchOption</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.13.9.2.7"></a><h4>Returns</h4>
<p> the name of the switch option.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="mate-mixer-switch-option-get-label"></a><h3>mate_mixer_switch_option_get_label ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
mate_mixer_switch_option_get_label (<em class="parameter"><code><a class="link" href="MateMixerSwitchOption.html" title="MateMixerSwitchOption"><span class="type">MateMixerSwitchOption</span></a> *option</code></em>);</pre>
<p>Gets the label of the switch option. 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.13.9.3.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>option</p></td>
<td class="parameter_description"><p>a <a class="link" href="MateMixerSwitchOption.html" title="MateMixerSwitchOption"><span class="type">MateMixerSwitchOption</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.13.9.3.6"></a><h4>Returns</h4>
<p> the label of the switch option.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="mate-mixer-switch-option-get-icon"></a><h3>mate_mixer_switch_option_get_icon ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
mate_mixer_switch_option_get_icon (<em class="parameter"><code><a class="link" href="MateMixerSwitchOption.html" title="MateMixerSwitchOption"><span class="type">MateMixerSwitchOption</span></a> *option</code></em>);</pre>
<p>Gets the XDG icon name of the switch option.</p>
<div class="refsect3">
<a name="id-1.2.13.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>option</p></td>
<td class="parameter_description"><p>a <a class="link" href="MateMixerSwitchOption.html" title="MateMixerSwitchOption"><span class="type">MateMixerSwitchOption</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.13.9.4.6"></a><h4>Returns</h4>
<p> the icon name or <code class="literal">NULL</code>.</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="MateMixerSwitchOption.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="MateMixerSwitchOption-struct"></a><h3>MateMixerSwitchOption</h3>
<pre class="programlisting">typedef struct _MateMixerSwitchOption MateMixerSwitchOption;</pre>
<p>The <a class="link" href="MateMixerSwitchOption.html" title="MateMixerSwitchOption"><span class="type">MateMixerSwitchOption</span></a> structure contains only private data and should only
be accessed using the provided API.</p>
</div>
<hr>
<div class="refsect2">
<a name="MateMixerSwitchOptionClass"></a><h3>struct MateMixerSwitchOptionClass</h3>
<pre class="programlisting">struct MateMixerSwitchOptionClass {
GObjectClass parent_class;
};
</pre>
<p>The class structure for <a class="link" href="MateMixerSwitchOption.html" title="MateMixerSwitchOption"><span class="type">MateMixerSwitchOption</span></a>.</p>
<div class="refsect3">
<a name="id-1.2.13.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="MateMixerSwitchOptionClass.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="MateMixerSwitchOption.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="MateMixerSwitchOption--icon"></a><h3>The <code class="literal">“icon”</code> property</h3>
<pre class="programlisting"> “icon” <span class="type">gchar</span> *</pre>
<p>The XDG icon name of the switch option.</p>
<p>Flags: Read / Write / Construct Only</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="MateMixerSwitchOption--label"></a><h3>The <code class="literal">“label”</code> property</h3>
<pre class="programlisting"> “label” <span class="type">gchar</span> *</pre>
<p>The label of the switch option. This is a potentially translated string
that should be presented to users in the user interface.</p>
<p>Flags: Read / Write / Construct Only</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="MateMixerSwitchOption--name"></a><h3>The <code class="literal">“name”</code> property</h3>
<pre class="programlisting"> “name” <span class="type">gchar</span> *</pre>
<p>The name of the switch option. The name serves as a unique identifier
and in most cases it is not in a user-readable form.</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>
|