vcs.maemo.org Git - monky/blob - doc/lua.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   4 <title>Lua API</title>
   5 </head>
   6 <body bgcolor="#FFFFFF"><table cellpadding="3">
   7 <tr bgcolor="#eecfa1">
   8 <th>Name</th>
   9 <th>Type</th>
  10 <th>Details</th>
  11 </tr>
  12 <tr bgcolor="#fffafa">
  13 <td align="center">conky_parse(string)</td>
  14 <td align="center">function</td>
  15 <td>
  16             <p>This function takes a string that is evaluated as
  17             per Conky's TEXT section, and then returns a string
  18             with the result.</p>
  19         </td>
  20 </tr>
  21 <tr bgcolor="#b4cdcd">
  22 <td align="center">conky_set_update_interval(number)</td>
  23 <td align="center">function</td>
  24 <td>
  25             <p>Sets Conky's update interval (in seconds) to
  26             'number'.</p>
  27         </td>
  28 </tr>
  29 <tr bgcolor="#fffafa">
  30 <td align="center">conky_window</td>
  31 <td align="center">table</td>
  32 <td>
  33             <p>This table contains some information about
  34             Conky's window. The following table describes the
  35             values contained:</p>
  36             <ul>
  37 <li>
  38                     <strong>drawable</strong> -
  39
  40                     Window's drawable (Xlib Drawable),
  41                     requires Lua extras enabled at compile
  42                     time.
  43                 </li>
  44 <li>
  45                     <strong>visual</strong> -
  46
  47                     Window's visual (Xlib Visual), requires
  48                     Lua extras enabled at compile time.
  49                 </li>
  50 <li>
  51                     <strong>display</strong> -
  52
  53                     Window's display (Xlib Display),
  54                     requires Lua extras enabled at compile
  55                     time.
  56                 </li>
  57 <li>
  58                     <strong>width</strong> -
  59
  60                     Window width (in pixels).
  61                 </li>
  62 <li>
  63                     <strong>height</strong> -
  64
  65                     Window height (in pixels).
  66                 </li>
  67 <li>
  68                     <strong>border_inner_margin</strong> -
  69
  70                     Window's inner border margin (in
  71                     pixels).
  72                 </li>
  73 <li>
  74                     <strong>border_outer_margin</strong> -
  75
  76                     Window's outer border margin (in
  77                     pixels).
  78                 </li>
  79 <li>
  80                     <strong>border_width</strong> -
  81
  82                     Window's border width (in
  83                     pixels).
  84                 </li>
  85 <li>
  86                     <strong>text_start_x</strong> -
  87
  88                     The x component of the starting
  89                     coordinate of text drawing.
  90                 </li>
  91 <li>
  92                     <strong>text_start_y</strong> -
  93
  94                     The y component of the starting
  95                     coordinate of text drawing.
  96                 </li>
  97 <li>
  98                     <strong>text_width</strong> -
  99
 100                     The width of the text drawing
 101                     region.
 102                 </li>
 103 <li>
 104                     <strong>text_height</strong> -
 105
 106                     The height of the text drawing
 107                     region.
 108                 </li>
 109 </ul>
 110             <p>NOTE: This table is only defined when X support
 111             is enabled.</p>
 112         </td>
 113 </tr>
 114 <tr bgcolor="#b4cdcd">
 115 <td align="center">conky_info</td>
 116 <td align="center">table</td>
 117 <td>
 118             <p>This table contains some information about
 119             Conky's internal data. The following table describes
 120             the values contained:</p>
 121             <ul>
 122 <li>
 123                     <strong>update_interval</strong> -
 124
 125                     Conky's update interval (in
 126                     seconds).
 127                 </li>
 128 <li>
 129                     <strong>uptime</strong> -
 130
 131                     System uptime, in seconds.
 132                 </li>
 133 </ul>
 134         </td>
 135 </tr>
 136 <tr bgcolor="#fffafa">
 137 <td align="center">conky_build_info</td>
 138 <td align="center">string</td>
 139 <td>
 140             <p>A string containing the build info for this
 141             particular instance of Conky, including the version,
 142             build date, and architecture.</p>
 143         </td>
 144 </tr>
 145 <tr bgcolor="#b4cdcd">
 146 <td align="center">conky_build_date</td>
 147 <td align="center">string</td>
 148 <td>
 149             <p>A string containing the build date for this
 150             particular instance of Conky.</p>
 151         </td>
 152 </tr>
 153 <tr bgcolor="#fffafa">
 154 <td align="center">conky_build_arch</td>
 155 <td align="center">string</td>
 156 <td>
 157             <p>A string containing the build architecture for
 158             this particular instance of Conky.</p>
 159         </td>
 160 </tr>
 161 <tr bgcolor="#b4cdcd">
 162 <td align="center">conky_version</td>
 163 <td align="center">string</td>
 164 <td>
 165             <p>A string containing the version of the current
 166             instance of Conky.</p>
 167         </td>
 168 </tr>
 169 <tr bgcolor="#fffafa">
 170 <td align="center">conky_config</td>
 171 <td align="center">string</td>
 172 <td>
 173             <p>A string containing the path of the current Conky
 174             configuration file.</p>
 175         </td>
 176 </tr>
 177 <tr bgcolor="#b4cdcd">
 178 <td align="center">cairo_text_extents_t:create()</td>
 179 <td align="center">function</td>
 180 <td>
 181                         <p>
 182                                 Call this function to return a new cairo_text_extents_t structure.  A creation function for this structure is not provided by the cairo API.  After calling this, you should use tolua.takeownership() on the return value to ensure ownership is passed properly.
 183                         </p>
 184         </td>
 185 </tr>
 186 <tr bgcolor="#fffafa">
 187 <td align="center">cairo_font_extents_t:create()</td>
 188 <td align="center">function</td>
 189 <td>
 190                         <p>
 191                                 Call this function to return a new cairo_font_extents_t structure.  A creation function for this structure is not provided by the cairo API.  After calling this, you should use tolua.takeownership() on the return value to ensure ownership is passed properly.
 192                         </p>
 193         </td>
 194 </tr>
 195 <tr bgcolor="#b4cdcd">
 196 <td align="center">cairo_matrix_t:create()</td>
 197 <td align="center">function</td>
 198 <td>
 199                         <p>
 200                                 Call this function to return a new cairo_matrix_t structure.  A creation function for this structure is not provided by the cairo API.  After calling this, you should use tolua.takeownership() on the return value to ensure ownership is passed properly.
 201                         </p>
 202         </td>
 203 </tr>
 204 </table></body>
 205 </html>