cedlemo
/
blingbling
Mirror von https://github.com/cedlemo/blingbling.git


			
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634
							<!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><strong>blingbling.progress_graph</strong></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><a href="../modules/blingbling.volume.html">blingbling.volume</a></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.progress_graph</code></h1>
<p>A progress graph widget.</p>
<p></p>


<h2><a href="#Functions">Functions</a></h2>
<table class="function_list">
	<tr>
	<td class="name" nowrap><a href="#set_background_color">set_background_color (graph, color)</a></td>
	<td class="summary">Fill all the widget (width * height) with this color (default is none ).</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#set_graph_background_color">set_graph_background_color (graph, color)</a></td>
	<td class="summary">Fill the graph area background with this color (default is none).</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#set_rounded_size">set_rounded_size (graph, rounded_size)</a></td>
	<td class="summary">Set rounded corners for background and graph background.</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#set_v_margin">set_v_margin (graph, margin)</a></td>
	<td class="summary">Define the top and bottom margin for the graph area.</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#set_h_margin">set_h_margin (graph, margin)</a></td>
	<td class="summary">Define the left and right margin for the graph area.</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#set_graph_color">set_graph_color (graph, color)</a></td>
	<td class="summary">Define the graph color.</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#set_graph_line_color">set_graph_line_color (graph, color)</a></td>
	<td class="summary">Define the graph outline.</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#set_show_text">set_show_text (graph, boolean)</a></td>
	<td class="summary">Display text on the graph or not.</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#set_value_format">set_value_format (graph, printf)</a></td>
	<td class="summary">Define displayed text value format string</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#set_text_color">set_text_color (graph, color)</a></td>
	<td class="summary">Define the color of the text.</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#set_text_background_color">set_text_background_color (graph, color)</a></td>
	<td class="summary">Define the background color of the text.</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#set_font_size">set_font_size (graph, size)</a></td>
	<td class="summary">Define the text font size.</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#set_label">set_label (graph, text)</a></td>
	<td class="summary">Define the template of the text to display.</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#set_horizontal">set_horizontal (graph, boolean)</a></td>
	<td class="summary">Define if the graph should increase/decrease horizontaly.</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#set_value">set_value (p_graph, value)</a></td>
	<td class="summary">Set the p_graph value.</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#progressgraph:set_height">progressgraph:set_height (height)</a></td>
	<td class="summary">Set the p_graph height.</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#progressgraph:set_width">progressgraph:set_width (width)</a></td>
	<td class="summary">Set the p_graph width.</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#progressgraph.new">progressgraph.new (args)</a></td>
	<td class="summary">Create a p_graph widget.</td>
	</tr>
</table>

<br/>
<br/>


    <h2><a name="Functions"></a>Functions</h2>

    <dl class="function">
    <dt>
    <a name = "set_background_color"></a>
    <strong>set_background_color (graph, color)</strong>
    </dt>
    <dd>
    Fill all the widget (width * height) with this color (default is none ).


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">graph</span>
         the graph
        </li>
        <li><span class="parameter">color</span>
         a string "#rrggbbaa" or "#rrggbb"
        </li>
    </ul>


    <h3>Usage:</h3>
    <ul>
        <pre class="example">mygraph:set_background_color(<span class="global">string</span>) --&gt;<span class="string">"#rrggbbaa"</span></pre>
    </ul>

</dd>
    <dt>
    <a name = "set_graph_background_color"></a>
    <strong>set_graph_background_color (graph, color)</strong>
    </dt>
    <dd>
    Fill the graph area background with this color (default is none).


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">graph</span>
         the graph
        </li>
        <li><span class="parameter">color</span>
         a string "#rrggbbaa" or "#rrggbb"
        </li>
    </ul>


    <h3>Usage:</h3>
    <ul>
        <pre class="example">mygraph:set_graph_background_color(<span class="global">string</span>) --&gt;<span class="string">"#rrggbbaa"</span></pre>
    </ul>

</dd>
    <dt>
    <a name = "set_rounded_size"></a>
    <strong>set_rounded_size (graph, rounded_size)</strong>
    </dt>
    <dd>
    Set rounded corners for background and graph background.


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">graph</span>
         the graph
        </li>
        <li><span class="parameter">rounded_size</span>
         float in [0,1]
        </li>
    </ul>


    <h3>Usage:</h3>
    <ul>
        <pre class="example">mygraph:set_rounded_size(a) -&gt; a <span class="keyword">in</span> [<span class="number">0</span>,<span class="number">1</span>]</pre>
    </ul>

</dd>
    <dt>
    <a name = "set_v_margin"></a>
    <strong>set_v_margin (graph, margin)</strong>
    </dt>
    <dd>
    Define the top and bottom margin for the graph area.


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">graph</span>
         the graph
        </li>
        <li><span class="parameter">margin</span>
         an integer for top and bottom margin
        </li>
    </ul>


    <h3>Usage:</h3>
    <ul>
        <pre class="example">mygraph:set_v_margin(integer)</pre>
    </ul>

</dd>
    <dt>
    <a name = "set_h_margin"></a>
    <strong>set_h_margin (graph, margin)</strong>
    </dt>
    <dd>
    Define the left and right margin for the graph area.


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">graph</span>
         the graph
        </li>
        <li><span class="parameter">margin</span>
         an integer for left and right margin
        </li>
    </ul>


    <h3>Usage:</h3>
    <ul>
        <pre class="example">mygraph:set_h_margin(integer)</pre>
    </ul>

</dd>
    <dt>
    <a name = "set_graph_color"></a>
    <strong>set_graph_color (graph, color)</strong>
    </dt>
    <dd>
    Define the graph color.


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">graph</span>
         the graph
        </li>
        <li><span class="parameter">color</span>
         a string "#rrggbbaa" or "#rrggbb"
        </li>
    </ul>


    <h3>Usage:</h3>
    <ul>
        <pre class="example">mygraph:set_graph_color(<span class="global">string</span>) --&gt;<span class="string">"#rrggbbaa"</span></pre>
    </ul>

</dd>
    <dt>
    <a name = "set_graph_line_color"></a>
    <strong>set_graph_line_color (graph, color)</strong>
    </dt>
    <dd>
    Define the graph outline.


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">graph</span>
         the graph
        </li>
        <li><span class="parameter">color</span>
         a string "#rrggbbaa" or "#rrggbb"
        </li>
    </ul>


    <h3>Usage:</h3>
    <ul>
        <pre class="example">mygraph:set_graph_line_color(<span class="global">string</span>) --&gt;<span class="string">"#rrggbbaa"</span></pre>
    </ul>

</dd>
    <dt>
    <a name = "set_show_text"></a>
    <strong>set_show_text (graph, boolean)</strong>
    </dt>
    <dd>
    Display text on the graph or not.


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">graph</span>
         the graph
        </li>
        <li><span class="parameter">boolean</span>
         true or false (default is false)
        </li>
    </ul>


    <h3>Usage:</h3>
    <ul>
        <pre class="example">mygraph:set_show_text(boolean) --&gt; <span class="keyword">true</span> <span class="keyword">or</span> <span class="keyword">false</span></pre>
    </ul>

</dd>
    <dt>
    <a name = "set_value_format"></a>
    <strong>set_value_format (graph, printf)</strong>
    </dt>
    <dd>
    Define displayed text value format string


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">graph</span>
         the graph
        </li>
        <li><span class="parameter">printf</span>
         format string for display text
        </li>
    </ul>


    <h3>Usage:</h3>
    <ul>
        <pre class="example">mygraph:set_value_format(<span class="global">string</span>) --&gt; <span class="string">"%2.f"</span></pre>
    </ul>

</dd>
    <dt>
    <a name = "set_text_color"></a>
    <strong>set_text_color (graph, color)</strong>
    </dt>
    <dd>
    Define the color of the text.


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">graph</span>
         the graph
        </li>
        <li><span class="parameter">color</span>
         a string "#rrggbbaa" or "#rrggbb" defaul is white
        </li>
    </ul>


    <h3>Usage:</h3>
    <ul>
        <pre class="example">mygraph:set_text_color(<span class="global">string</span>) --&gt;<span class="string">"#rrggbbaa"</span></pre>
    </ul>

</dd>
    <dt>
    <a name = "set_text_background_color"></a>
    <strong>set_text_background_color (graph, color)</strong>
    </dt>
    <dd>
    Define the background color of the text.


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">graph</span>
         the graph
        </li>
        <li><span class="parameter">color</span>
         a string "#rrggbbaa" or "#rrggbb"
        </li>
    </ul>


    <h3>Usage:</h3>
    <ul>
        <pre class="example">mygraph:set_text_background_color(<span class="global">string</span>) --&gt;<span class="string">"#rrggbbaa"</span></pre>
    </ul>

</dd>
    <dt>
    <a name = "set_font_size"></a>
    <strong>set_font_size (graph, size)</strong>
    </dt>
    <dd>
    Define the text font size.


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">graph</span>
         the graph
        </li>
        <li><span class="parameter">size</span>
         the font size
        </li>
    </ul>


    <h3>Usage:</h3>
    <ul>
        <pre class="example">mygraph:set_font_size(integer)</pre>
    </ul>

</dd>
    <dt>
    <a name = "set_label"></a>
    <strong>set_label (graph, text)</strong>
    </dt>
    <dd>
    Define the template of the text to display.


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">graph</span>
         the graph
        </li>
        <li><span class="parameter">text</span>
         the text to display
        </li>
    </ul>


    <h3>Usage:</h3>
    <ul>
        <pre class="example"> mygraph:set_label(<span class="global">string</span>)
By default the text is : (value_send_to_the_widget *<span class="number">100</span>) .. <span class="string">"%"</span>
static <span class="global">string</span>: example set_label(<span class="string">"CPU usage:"</span>) will display <span class="string">"CUP usage:"</span> on the graph
dynamic <span class="global">string</span>: use $percent <span class="keyword">in</span> the <span class="global">string</span> example set_label(<span class="string">"Load $percent %"</span>) will display <span class="string">"Load 10%"</span> </pre>
    </ul>

</dd>
    <dt>
    <a name = "set_horizontal"></a>
    <strong>set_horizontal (graph, boolean)</strong>
    </dt>
    <dd>
    Define if the graph should increase/decrease horizontaly.


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">graph</span>
         the graph
        </li>
        <li><span class="parameter">boolean</span>
         true or false (false by default)
        </li>
    </ul>


    <h3>Usage:</h3>
    <ul>
        <pre class="example">mygraph:set_horizontal(boolean) --&gt; <span class="keyword">true</span> <span class="keyword">or</span> <span class="keyword">false</span></pre>
    </ul>

</dd>
    <dt>
    <a name = "set_value"></a>
    <strong>set_value (p_graph, value)</strong>
    </dt>
    <dd>
    Set the p_graph value.


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">p_graph</span>
         The progress bar.
        </li>
        <li><span class="parameter">value</span>
         The progress bar value between 0 and 1.
        </li>
    </ul>


</dd>
    <dt>
    <a name = "progressgraph:set_height"></a>
    <strong>progressgraph:set_height (height)</strong>
    </dt>
    <dd>
    Set the p_graph height.


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">height</span>
         The height to set.
        </li>
    </ul>


</dd>
    <dt>
    <a name = "progressgraph:set_width"></a>
    <strong>progressgraph:set_width (width)</strong>
    </dt>
    <dd>
    Set the p_graph width.


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">width</span>
         The width to set.
        </li>
    </ul>


</dd>
    <dt>
    <a name = "progressgraph.new"></a>
    <strong>progressgraph.new (args)</strong>
    </dt>
    <dd>
    Create a p_graph widget.


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">args</span>
         Standard widget() arguments. You should add width and height
 key to set p_graph geometry.
        </li>
    </ul>

    <h3>Returns:</h3>
    <ol>

        A p_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>