transient.html 6.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
  2. "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
  3. <html>
  4. <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
  5. <head>
  6. <title>Reference</title>
  7. <link rel="stylesheet" href="../ldoc.css" type="text/css" />
  8. </head>
  9. <body>
  10. <div id="container">
  11. <div id="product">
  12. <div id="product_logo"></div>
  13. <div id="product_name"><big><b></b></big></div>
  14. <div id="product_description"></div>
  15. </div> <!-- id="product" -->
  16. <div id="main">
  17. <!-- Menu -->
  18. <div id="navigation">
  19. <br/>
  20. <h1>ldoc</h1>
  21. <ul>
  22. <li><a href="../index.html">Index</a></li>
  23. </ul>
  24. <h2>Contents</h2>
  25. <ul>
  26. <li><a href="#Functions">Functions</a></li>
  27. <li><a href="#Tables">Tables</a></li>
  28. </ul>
  29. <h2>Modules</h2>
  30. <ul class="$(kind=='Topics' and '' or 'nowrap'">
  31. <li><a href="../modules/blingbling.clock.html">blingbling.clock</a></li>
  32. <li><a href="../modules/blingbling.wlourf_circle_graph.html">blingbling.wlourf_circle_graph</a></li>
  33. <li><a href="../modules/blingbling.progress_graph.html">blingbling.progress_graph</a></li>
  34. <li><strong>transient</strong></li>
  35. <li><a href="../modules/blingbling.tagslist.html">blingbling.tagslist</a></li>
  36. <li><a href="../modules/blingbling.value_text_box.html">blingbling.value_text_box</a></li>
  37. <li><a href="../modules/blingbling.helpers.html">blingbling.helpers</a></li>
  38. <li><a href="../modules/blingbling.popups.html">blingbling.popups</a></li>
  39. <li><a href="../modules/blingbling.triangular_progress_graph.html">blingbling.triangular_progress_graph</a></li>
  40. <li><a href="../modules/blingbling.volume.html">blingbling.volume</a></li>
  41. <li><a href="../modules/blingbling.udisks_glue.html">blingbling.udisks_glue</a></li>
  42. <li><a href="../modules/blingbling.text_box.html">blingbling.text_box</a></li>
  43. <li><a href="../modules/blingbling.system.html">blingbling.system</a></li>
  44. <li><a href="../modules/blingbling.task_warrior.html">blingbling.task_warrior</a></li>
  45. <li><a href="../modules/blingbling.linegraph.html">blingbling.linegraph</a></li>
  46. <li><a href="../modules/blingbling.calendar.html">blingbling.calendar</a></li>
  47. <li><a href="../modules/blingbling.widget.html">blingbling.widget</a></li>
  48. <li><a href="../modules/config_example.grey_blue.theme.html">config_example.grey_blue.theme</a></li>
  49. <li><a href="../modules/config_example.japanese2.theme.html">config_example.japanese2.theme</a></li>
  50. </ul>
  51. </div>
  52. <div id="content">
  53. <h1>Module <code>transient</code></h1>
  54. <p></p>
  55. <p></p>
  56. <h3>Info:</h3>
  57. <ul>
  58. <li><strong>Copyright</strong>: 2010 Uli Schlachter</li>
  59. <li><strong>Release</strong>: v3.5.5</li>
  60. <li><strong>Author</strong>: Uli Schlachter</li>
  61. </ul>
  62. <h2><a href="#Functions">Functions</a></h2>
  63. <table class="function_list">
  64. <tr>
  65. <td class="name" nowrap><a href="#set_widget">set_widget (widget)</a></td>
  66. <td class="summary">Set the widget that the transient displays</td>
  67. </tr>
  68. <tr>
  69. <td class="name" nowrap><a href="#set_bg">set_bg (c)</a></td>
  70. <td class="summary">Set the background of the transient</td>
  71. </tr>
  72. <tr>
  73. <td class="name" nowrap><a href="#set_fg">set_fg (c)</a></td>
  74. <td class="summary">Set the foreground of the transient</td>
  75. </tr>
  76. <tr>
  77. <td class="name" nowrap><a href="#show">show ()</a></td>
  78. <td class="summary">Show the transient window according to the timeout set when creating the
  79. transient window</td>
  80. </tr>
  81. <tr>
  82. <td class="name" nowrap><a href="#draw">draw (transient)</a></td>
  83. <td class="summary">Redraw a transient.</td>
  84. </tr>
  85. </table>
  86. <h2><a href="#Tables">Tables</a></h2>
  87. <table class="function_list">
  88. <tr>
  89. <td class="name" nowrap><a href="#transient">transient</a></td>
  90. <td class="summary">This provides widget box windows.</td>
  91. </tr>
  92. <tr>
  93. <td class="name" nowrap><a href="#drawin">drawin</a></td>
  94. <td class="summary">Widget box object.</td>
  95. </tr>
  96. </table>
  97. <br/>
  98. <br/>
  99. <h2><a name="Functions"></a>Functions</h2>
  100. <dl class="function">
  101. <dt>
  102. <a name = "set_widget"></a>
  103. <strong>set_widget (widget)</strong>
  104. </dt>
  105. <dd>
  106. Set the widget that the transient displays
  107. <h3>Parameters:</h3>
  108. <ul>
  109. <li><span class="parameter">widget</span>
  110. </li>
  111. </ul>
  112. </dd>
  113. <dt>
  114. <a name = "set_bg"></a>
  115. <strong>set_bg (c)</strong>
  116. </dt>
  117. <dd>
  118. Set the background of the transient
  119. <h3>Parameters:</h3>
  120. <ul>
  121. <li><span class="parameter">c</span>
  122. The background to use. This must either be a cairo pattern object,
  123. nil or a string that gears.color() understands.
  124. </li>
  125. </ul>
  126. </dd>
  127. <dt>
  128. <a name = "set_fg"></a>
  129. <strong>set_fg (c)</strong>
  130. </dt>
  131. <dd>
  132. Set the foreground of the transient
  133. <h3>Parameters:</h3>
  134. <ul>
  135. <li><span class="parameter">c</span>
  136. The foreground to use. This must either be a cairo pattern object,
  137. nil or a string that gears.color() understands.
  138. </li>
  139. </ul>
  140. </dd>
  141. <dt>
  142. <a name = "show"></a>
  143. <strong>show ()</strong>
  144. </dt>
  145. <dd>
  146. Show the transient window according to the timeout set when creating the
  147. transient window
  148. </dd>
  149. <dt>
  150. <a name = "draw"></a>
  151. <strong>draw (transient)</strong>
  152. </dt>
  153. <dd>
  154. Redraw a transient. You should never have to call this explicitely because it is
  155. automatically called when needed.
  156. <h3>Parameters:</h3>
  157. <ul>
  158. <li><span class="parameter">transient</span>
  159. </li>
  160. </ul>
  161. </dd>
  162. </dl>
  163. <h2><a name="Tables"></a>Tables</h2>
  164. <dl class="function">
  165. <dt>
  166. <a name = "transient"></a>
  167. <strong>transient</strong>
  168. </dt>
  169. <dd>
  170. This provides widget box windows. Every transient can also be used as if it were
  171. a drawin. All drawin functions and properties are also available on transientes!
  172. transient
  173. <h3>Fields:</h3>
  174. <ul>
  175. <li><span class="parameter">mt</span>
  176. </li>
  177. </ul>
  178. </dd>
  179. <dt>
  180. <a name = "drawin"></a>
  181. <strong>drawin</strong>
  182. </dt>
  183. <dd>
  184. Widget box object.
  185. Every transient "inherits" from a drawin and you can use all of drawin's
  186. functions directly on this as well. When creating a transient, you can specify a
  187. "fg" and a "bg" color as keys in the table that is passed to the constructor.
  188. All other arguments will be passed to drawin's constructor.
  189. </dd>
  190. </dl>
  191. </div> <!-- id="content" -->
  192. </div> <!-- id="main" -->
  193. <div id="about">
  194. <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.2</a></i>
  195. </div> <!-- id="about" -->
  196. </div> <!-- id="container" -->
  197. </body>
  198. </html>