blingbling.popups.html 5.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159
  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><strong>blingbling.popups</strong></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><a href="../modules/blingbling.task_warrior.html">blingbling.task_warrior</a></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.popups</code></h1>
  51. <p>Differents popups for Awesome widgets</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="#htop">htop (mywidget, args)</a></td>
  57. <td class="summary">Top popup.</td>
  58. </tr>
  59. <tr>
  60. <td class="name" nowrap><a href="#netstat">netstat (mywidget, args)</a></td>
  61. <td class="summary">Netstat popup.</td>
  62. </tr>
  63. </table>
  64. <br/>
  65. <br/>
  66. <h2><a name="Functions"></a>Functions</h2>
  67. <dl class="function">
  68. <dt>
  69. <a name = "htop"></a>
  70. <strong>htop (mywidget, args)</strong>
  71. </dt>
  72. <dd>
  73. Top popup.
  74. It binds a colorized output of the top command to a widget, and the possibility to launch htop with a click on the widget.
  75. </br>Example blingbling.popups.htop(mycairograph,{ title_color = "#rrggbbaa", user_color = "#rrggbbaa", root_color="#rrggbbaa", terminal = "urxvt"})
  76. </br>The terminal parameter is not mandatory, htop will be launch in xterm. Mandatory arguments:
  77. <ul> <li>title_color define the color of the title's columns.</li>
  78. <li>user_color display the name of the current user with this color in the top output.</li>
  79. <li>root_color display the root name with this color in the top output. </li></ul>
  80. <h3>Parameters:</h3>
  81. <ul>
  82. <li><span class="parameter">mywidget</span>
  83. the widget
  84. </li>
  85. <li><span class="parameter">args</span>
  86. a table of arguments { title_color = "#rrggbbaa", user_color = "#rrggbbaa", root_color="#rrggbbaa", terminal = a terminal name})
  87. </li>
  88. </ul>
  89. </dd>
  90. <dt>
  91. <a name = "netstat"></a>
  92. <strong>netstat (mywidget, args)</strong>
  93. </dt>
  94. <dd>
  95. Netstat popup.
  96. It binds a colorized output of the netstat command to a widget.
  97. </br>Example: blingbling.popups.netstat(net,{ title_color = "#rrggbbaa", established_color= "#rrggbbaa", listen_color="#rrggbbaa"})
  98. </br>Mandatory arguments:
  99. <ul><li>widget (if blinbling widget add .widget ex: cpu.widget, if textbox or image box just put the widget name)</li>
  100. <li>title_color define the color of the title's columns.</li>
  101. <li>established_color display the state "ESTABLISHED" of a connexion with this color in the netstat output.</li>
  102. <li>listen_color display the state "LISTEN" with this color in the netstat output.</li></ul>
  103. <h3>Parameters:</h3>
  104. <ul>
  105. <li><span class="parameter">mywidget</span>
  106. the widget
  107. </li>
  108. <li><span class="parameter">args</span>
  109. a table { title_color = "#rrggbbaa", established_color= "#rrggbbaa", listen_color="#rrggbbaa"}
  110. </li>
  111. </ul>
  112. </dd>
  113. </dl>
  114. </div> <!-- id="content" -->
  115. </div> <!-- id="main" -->
  116. <div id="about">
  117. <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i>
  118. <i style="float:right;">Last updated 2015-08-04 10:16:50 </i>
  119. </div> <!-- id="about" -->
  120. </div> <!-- id="container" -->
  121. </body>
  122. </html>