blingbling.task_warrior.html 5.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218
  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. </ul>
  28. <h2>Modules</h2>
  29. <ul class="$(kind=='Topics' and '' or 'nowrap'">
  30. <li><a href="../modules/blingbling.calendar.html">blingbling.calendar</a></li>
  31. <li><a href="../modules/blingbling.clock.html">blingbling.clock</a></li>
  32. <li><a href="../modules/blingbling.helpers.html">blingbling.helpers</a></li>
  33. <li><a href="../modules/blingbling.linegraph.html">blingbling.linegraph</a></li>
  34. <li><a href="../modules/blingbling.widget.html">blingbling.widget</a></li>
  35. <li><a href="../modules/blingbling.popups.html">blingbling.popups</a></li>
  36. <li><a href="../modules/blingbling.progress_graph.html">blingbling.progress_graph</a></li>
  37. <li><a href="../modules/blingbling.system.html">blingbling.system</a></li>
  38. <li><a href="../modules/blingbling.tagslist.html">blingbling.tagslist</a></li>
  39. <li><strong>blingbling.task_warrior</strong></li>
  40. <li><a href="../modules/blingbling.text_box.html">blingbling.text_box</a></li>
  41. <li><a href="../modules/blingbling.transient.html">blingbling.transient</a></li>
  42. <li><a href="../modules/blingbling.triangular_progress_graph.html">blingbling.triangular_progress_graph</a></li>
  43. <li><a href="../modules/blingbling.udisks_glue.html">blingbling.udisks_glue</a></li>
  44. <li><a href="../modules/blingbling.value_text_box.html">blingbling.value_text_box</a></li>
  45. <li><a href="../modules/blingbling.volume.html">blingbling.volume</a></li>
  46. <li><a href="../modules/blingbling.wlourf_circle_graph.html">blingbling.wlourf_circle_graph</a></li>
  47. </ul>
  48. </div>
  49. <div id="content">
  50. <h1>Module <code>blingbling.task_warrior</code></h1>
  51. <p>Task warrior menu</p>
  52. <p></p>
  53. <h2><a href="#Functions">Functions</a></h2>
  54. <table class="function_list">
  55. <tr>
  56. <td class="name" nowrap><a href="#set_task_done_icon">set_task_done_icon (tw_menu, an_image)</a></td>
  57. <td class="summary">Set the icon for "set task done" menu item.</td>
  58. </tr>
  59. <tr>
  60. <td class="name" nowrap><a href="#set_project_icon">set_project_icon (tw_menu, an_image)</a></td>
  61. <td class="summary">Set the icon for project menu item.</td>
  62. </tr>
  63. <tr>
  64. <td class="name" nowrap><a href="#set_task_icon">set_task_icon (tw_menu, an_image)</a></td>
  65. <td class="summary">Set the icon for task menu item.</td>
  66. </tr>
  67. <tr>
  68. <td class="name" nowrap><a href="#new">new (args)</a></td>
  69. <td class="summary">Create new task warrior menu.</td>
  70. </tr>
  71. </table>
  72. <br/>
  73. <br/>
  74. <h2><a name="Functions"></a>Functions</h2>
  75. <dl class="function">
  76. <dt>
  77. <a name = "set_task_done_icon"></a>
  78. <strong>set_task_done_icon (tw_menu, an_image)</strong>
  79. </dt>
  80. <dd>
  81. Set the icon for "set task done" menu item.
  82. <h3>Parameters:</h3>
  83. <ul>
  84. <li><span class="parameter">tw_menu</span>
  85. a task warrior menu
  86. </li>
  87. <li><span class="parameter">an_image</span>
  88. an image file name
  89. </li>
  90. </ul>
  91. <h3>Usage:</h3>
  92. <ul>
  93. <pre class="example">my_tasks:set_task_done_icon(an_image_file_name)</pre>
  94. </ul>
  95. </dd>
  96. <dt>
  97. <a name = "set_project_icon"></a>
  98. <strong>set_project_icon (tw_menu, an_image)</strong>
  99. </dt>
  100. <dd>
  101. Set the icon for project menu item.
  102. <h3>Parameters:</h3>
  103. <ul>
  104. <li><span class="parameter">tw_menu</span>
  105. a task warrior menu
  106. </li>
  107. <li><span class="parameter">an_image</span>
  108. an image file name
  109. </li>
  110. </ul>
  111. <h3>Usage:</h3>
  112. <ul>
  113. <pre class="example">my_tasks:set_project_icon(an_image_file_name)</pre>
  114. </ul>
  115. </dd>
  116. <dt>
  117. <a name = "set_task_icon"></a>
  118. <strong>set_task_icon (tw_menu, an_image)</strong>
  119. </dt>
  120. <dd>
  121. Set the icon for task menu item.
  122. <h3>Parameters:</h3>
  123. <ul>
  124. <li><span class="parameter">tw_menu</span>
  125. a task warrior menu
  126. </li>
  127. <li><span class="parameter">an_image</span>
  128. an image file name
  129. </li>
  130. </ul>
  131. <h3>Usage:</h3>
  132. <ul>
  133. <pre class="example">my_tasks:set_task_icon(an_image_file_name)</pre>
  134. </ul>
  135. </dd>
  136. <dt>
  137. <a name = "new"></a>
  138. <strong>new (args)</strong>
  139. </dt>
  140. <dd>
  141. Create new task warrior menu.
  142. <h3>Parameters:</h3>
  143. <ul>
  144. <li><span class="parameter">args</span>
  145. a table
  146. </li>
  147. </ul>
  148. <h3>Returns:</h3>
  149. <ol>
  150. tw_menu a task warrior menu
  151. </ol>
  152. <h3>Usage:</h3>
  153. <ul>
  154. <pre class="example">my_tasks=blingbling.task_warrior.new({ menu_icon = an_icon_file, width = integer <span class="comment">--[[optional--]]</span>, project_icon = an_icon_file <span class="comment">--[[optional--]]</span>, task_icon = an_icon_file <span class="comment">--[[optional--]]</span>, task_icon_done = an_icon_file <span class="comment">--[[optional--]]</span>} )</pre>
  155. </ul>
  156. </dd>
  157. </dl>
  158. </div> <!-- id="content" -->
  159. </div> <!-- id="main" -->
  160. <div id="about">
  161. <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i>
  162. <i style="float:right;">Last updated 2015-08-04 10:16:50 </i>
  163. </div> <!-- id="about" -->
  164. </div> <!-- id="container" -->
  165. </body>
  166. </html>