123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158 |
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
- <html>
- <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
- <head>
- <title>Reference</title>
- <link rel="stylesheet" href="../ldoc.css" type="text/css" />
- </head>
- <body>
- <div id="container">
- <div id="product">
- <div id="product_logo"></div>
- <div id="product_name"><big><b></b></big></div>
- <div id="product_description"></div>
- </div> <!-- id="product" -->
- <div id="main">
- <!-- Menu -->
- <div id="navigation">
- <br/>
- <h1>ldoc</h1>
- <ul>
- <li><a href="../index.html">Index</a></li>
- </ul>
- <h2>Contents</h2>
- <ul>
- <li><a href="#Functions">Functions</a></li>
- </ul>
- <h2>Modules</h2>
- <ul class="$(kind=='Topics' and '' or 'nowrap'">
- <li><a href="../modules/blingbling.calendar.html">blingbling.calendar</a></li>
- <li><a href="../modules/blingbling.clock.html">blingbling.clock</a></li>
- <li><a href="../modules/blingbling.helpers.html">blingbling.helpers</a></li>
- <li><a href="../modules/blingbling.linegraph.html">blingbling.linegraph</a></li>
- <li><a href="../modules/blingbling.widget.html">blingbling.widget</a></li>
- <li><a href="../modules/blingbling.popups.html">blingbling.popups</a></li>
- <li><a href="../modules/blingbling.progress_graph.html">blingbling.progress_graph</a></li>
- <li><a href="../modules/blingbling.system.html">blingbling.system</a></li>
- <li><a href="../modules/blingbling.tagslist.html">blingbling.tagslist</a></li>
- <li><a href="../modules/blingbling.task_warrior.html">blingbling.task_warrior</a></li>
- <li><a href="../modules/blingbling.text_box.html">blingbling.text_box</a></li>
- <li><a href="../modules/blingbling.transient.html">blingbling.transient</a></li>
- <li><a href="../modules/blingbling.triangular_progress_graph.html">blingbling.triangular_progress_graph</a></li>
- <li><a href="../modules/blingbling.udisks_glue.html">blingbling.udisks_glue</a></li>
- <li><a href="../modules/blingbling.value_text_box.html">blingbling.value_text_box</a></li>
- <li><strong>blingbling.volume</strong></li>
- <li><a href="../modules/blingbling.wlourf_circle_graph.html">blingbling.wlourf_circle_graph</a></li>
- </ul>
- </div>
- <div id="content">
- <h1>Module <code>blingbling.volume</code></h1>
- <p>Volume widget</p>
- <p></p>
- <h2><a href="#Functions">Functions</a></h2>
- <table class="function_list">
- <tr>
- <td class="name" nowrap><a href="#set_master_control">set_master_control (volume_graph)</a></td>
- <td class="summary">Link the widget to the master channel of your system (uses amixer).</td>
- </tr>
- <tr>
- <td class="name" nowrap><a href="#new">new (args)</a></td>
- <td class="summary">Create a volume_graph widget.</td>
- </tr>
- </table>
- <br/>
- <br/>
- <h2><a name="Functions"></a>Functions</h2>
- <dl class="function">
- <dt>
- <a name = "set_master_control"></a>
- <strong>set_master_control (volume_graph)</strong>
- </dt>
- <dd>
- Link the widget to the master channel of your system (uses amixer).
- a left clic toggle mute/unmute, wheel up to increase the volume and wheel down to decrease the volume
- <h3>Parameters:</h3>
- <ul>
- <li><span class="parameter">volume_graph</span>
- </li>
- </ul>
- <h3>Usage:</h3>
- <ul>
- <pre class="example">myvolume:set_master_control()</pre>
- </ul>
- </dd>
- <dt>
- <a name = "new"></a>
- <strong>new (args)</strong>
- </dt>
- <dd>
- Create a volume_graph widget.
- <h3>Parameters:</h3>
- <ul>
- <li><span class="parameter">args</span>
- Standard widget() arguments. This is a table that accepts
- different keys:
- <p> <code>{ cmd = "amixer -c 1", label = "$percent%", graph_color = "#005500" }</code>
- <p> The default cmd is "amixer" which should be good enough if you only have one audio output.
- You can provide another command based on your need. For example, the "amixer -c 1" command
- has been given by k3rni contributor and allow to select the audio card. (see
- https://github.com/cedlemo/blingbling/pull/30 for more information.
- <p> The other keys are those related to the graph itself and are the same that those
- used with the triangular_progress_graph
- </li>
- </ul>
- <h3>Returns:</h3>
- <ol>
- A graph widget.
- </ol>
- </dd>
- </dl>
- </div> <!-- id="content" -->
- </div> <!-- id="main" -->
- <div id="about">
- <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i>
- <i style="float:right;">Last updated 2015-08-04 10:16:50 </i>
- </div> <!-- id="about" -->
- </div> <!-- id="container" -->
- </body>
- </html>
|