123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272 |
- <!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>
- <li><a href="#Tables">Tables</a></li>
- </ul>
- <h2>Modules</h2>
- <ul class="$(kind=='Topics' and '' or 'nowrap'">
- <li><a href="../modules/blingbling.clock.html">blingbling.clock</a></li>
- <li><a href="../modules/blingbling.wlourf_circle_graph.html">blingbling.wlourf_circle_graph</a></li>
- <li><a href="../modules/blingbling.progress_graph.html">blingbling.progress_graph</a></li>
- <li><strong>transient</strong></li>
- <li><a href="../modules/blingbling.tagslist.html">blingbling.tagslist</a></li>
- <li><a href="../modules/blingbling.value_text_box.html">blingbling.value_text_box</a></li>
- <li><a href="../modules/blingbling.helpers.html">blingbling.helpers</a></li>
- <li><a href="../modules/blingbling.popups.html">blingbling.popups</a></li>
- <li><a href="../modules/blingbling.triangular_progress_graph.html">blingbling.triangular_progress_graph</a></li>
- <li><a href="../modules/blingbling.volume.html">blingbling.volume</a></li>
- <li><a href="../modules/blingbling.udisks_glue.html">blingbling.udisks_glue</a></li>
- <li><a href="../modules/blingbling.text_box.html">blingbling.text_box</a></li>
- <li><a href="../modules/blingbling.system.html">blingbling.system</a></li>
- <li><a href="../modules/blingbling.task_warrior.html">blingbling.task_warrior</a></li>
- <li><a href="../modules/blingbling.linegraph.html">blingbling.linegraph</a></li>
- <li><a href="../modules/blingbling.calendar.html">blingbling.calendar</a></li>
- <li><a href="../modules/blingbling.widget.html">blingbling.widget</a></li>
- <li><a href="../modules/config_example.grey_blue.theme.html">config_example.grey_blue.theme</a></li>
- <li><a href="../modules/config_example.japanese2.theme.html">config_example.japanese2.theme</a></li>
- </ul>
- </div>
- <div id="content">
- <h1>Module <code>transient</code></h1>
- <p></p>
- <p></p>
- <h3>Info:</h3>
- <ul>
- <li><strong>Copyright</strong>: 2010 Uli Schlachter</li>
- <li><strong>Release</strong>: v3.5.5</li>
- <li><strong>Author</strong>: Uli Schlachter</li>
- </ul>
- <h2><a href="#Functions">Functions</a></h2>
- <table class="function_list">
- <tr>
- <td class="name" nowrap><a href="#set_widget">set_widget (widget)</a></td>
- <td class="summary">Set the widget that the transient displays</td>
- </tr>
- <tr>
- <td class="name" nowrap><a href="#set_bg">set_bg (c)</a></td>
- <td class="summary">Set the background of the transient</td>
- </tr>
- <tr>
- <td class="name" nowrap><a href="#set_fg">set_fg (c)</a></td>
- <td class="summary">Set the foreground of the transient</td>
- </tr>
- <tr>
- <td class="name" nowrap><a href="#show">show ()</a></td>
- <td class="summary">Show the transient window according to the timeout set when creating the
- transient window</td>
- </tr>
- <tr>
- <td class="name" nowrap><a href="#draw">draw (transient)</a></td>
- <td class="summary">Redraw a transient.</td>
- </tr>
- </table>
- <h2><a href="#Tables">Tables</a></h2>
- <table class="function_list">
- <tr>
- <td class="name" nowrap><a href="#transient">transient</a></td>
- <td class="summary">This provides widget box windows.</td>
- </tr>
- <tr>
- <td class="name" nowrap><a href="#drawin">drawin</a></td>
- <td class="summary">Widget box object.</td>
- </tr>
- </table>
- <br/>
- <br/>
- <h2><a name="Functions"></a>Functions</h2>
- <dl class="function">
- <dt>
- <a name = "set_widget"></a>
- <strong>set_widget (widget)</strong>
- </dt>
- <dd>
- Set the widget that the transient displays
- <h3>Parameters:</h3>
- <ul>
- <li><span class="parameter">widget</span>
- </li>
- </ul>
- </dd>
- <dt>
- <a name = "set_bg"></a>
- <strong>set_bg (c)</strong>
- </dt>
- <dd>
- Set the background of the transient
- <h3>Parameters:</h3>
- <ul>
- <li><span class="parameter">c</span>
- The background to use. This must either be a cairo pattern object,
- nil or a string that gears.color() understands.
- </li>
- </ul>
- </dd>
- <dt>
- <a name = "set_fg"></a>
- <strong>set_fg (c)</strong>
- </dt>
- <dd>
- Set the foreground of the transient
- <h3>Parameters:</h3>
- <ul>
- <li><span class="parameter">c</span>
- The foreground to use. This must either be a cairo pattern object,
- nil or a string that gears.color() understands.
- </li>
- </ul>
- </dd>
- <dt>
- <a name = "show"></a>
- <strong>show ()</strong>
- </dt>
- <dd>
- Show the transient window according to the timeout set when creating the
- transient window
- </dd>
- <dt>
- <a name = "draw"></a>
- <strong>draw (transient)</strong>
- </dt>
- <dd>
- Redraw a transient. You should never have to call this explicitely because it is
- automatically called when needed.
- <h3>Parameters:</h3>
- <ul>
- <li><span class="parameter">transient</span>
- </li>
- </ul>
- </dd>
- </dl>
- <h2><a name="Tables"></a>Tables</h2>
- <dl class="function">
- <dt>
- <a name = "transient"></a>
- <strong>transient</strong>
- </dt>
- <dd>
- This provides widget box windows. Every transient can also be used as if it were
- a drawin. All drawin functions and properties are also available on transientes!
- transient
- <h3>Fields:</h3>
- <ul>
- <li><span class="parameter">mt</span>
- </li>
- </ul>
- </dd>
- <dt>
- <a name = "drawin"></a>
- <strong>drawin</strong>
- </dt>
- <dd>
- Widget box object.
- Every transient "inherits" from a drawin and you can use all of drawin's
- functions directly on this as well. When creating a transient, you can specify a
- "fg" and a "bg" color as keys in the table that is passed to the constructor.
- All other arguments will be passed to drawin's constructor.
- </dd>
- </dl>
- </div> <!-- id="content" -->
- </div> <!-- id="main" -->
- <div id="about">
- <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.2</a></i>
- </div> <!-- id="about" -->
- </div> <!-- id="container" -->
- </body>
- </html>
|