giscanner/mallard-Python-signal.tmpl

   1 <?xml version="1.0"?>
   2 <page id="${namespace.name}.${node.parent.name}-${node.name}"
   3       type="topic"
   4       style="signal"
   5       xmlns="http://projectmallard.org/1.0/"
   6       xmlns:ui="http://projectmallard.org/experimental/ui/">
   7   <info>
   8     <link type="guide" xref="${namespace.name}.${node.parent.name}" group="signal"/>
   9     <title type="link" role="topic">${node.name}</title>
  10   </info>
  11   <title>${namespace.name}.${node.parent.name}::${node.name}</title>
  12 <synopsis><code mime="text/x-python">
  13 def callback(${formatter.to_underscores(node.parent.name).lower()}, \
  14 % for arg, ix in zip(node.parameters, range(len(node.parameters))):
  15 ${arg.argname}, \
  16 % endfor
  17 user_param1, ...)
  18 </code></synopsis>
  19 ${formatter.format(node.doc)}
  20
  21 <table>
  22 <tr>
  23 <td><p>${formatter.to_underscores(node.parent.name).lower()} :</p></td>
  24 <td><p>instance of ${namespace.name}.${node.parent.name} that is emitting the signal</p></td>
  25 </tr>
  26 % for arg, ix in zip(node.parameters, range(len(node.parameters))):
  27 <tr>
  28 <td><p>${arg.argname} :</p></td>
  29 <td>${formatter.format(arg.doc)}</td>
  30 </tr>
  31 % endfor
  32 <tr>
  33 <td><p>user_param1 :</p></td>
  34 <td><p>first user parameter (if any) specified with the connect() method</p></td>
  35 </tr>
  36 <tr>
  37 <td><p>... :</p></td>
  38 <td><p>additional user parameters (if any)</p></td>
  39 </tr>
  40 % if node.retval and \
  41      node.retval.type.ctype != 'void' and \
  42      node.retval.type.ctype is not None:
  43 <tr>
  44 <td><p>Returns :</p></td>
  45 <td>${node.retval.type.ctype} ${formatter.format(node.retval.doc)}</td>
  46 </tr>
  47 % endif
  48 </table>
  49 % if node.version:
  50 <p>Since ${node.version}</p>
  51 % endif
  52 </page>