signal.tmpl 1.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041
  1. <%inherit file="/base.tmpl"/>
  2. <%block name="info">
  3. ${formatter.format_xref(node.parent, type="guide", group=page_kind)}
  4. <title type="link" role="topic">${node.name}</title>
  5. </%block>
  6. <%block name="synopsis">
  7. <synopsis><code mime="text/x-python">
  8. def callback(${formatter.to_underscores(node.parent).lower()}, \
  9. % for arg in formatter.get_in_parameters(node):
  10. ${arg.argname}, \
  11. % endfor
  12. user_param1, ...)
  13. </code></synopsis></%block>
  14. <%block name="details">
  15. <terms>
  16. <item>
  17. <title><code>${formatter.to_underscores(node.parent).lower()}</code></title>
  18. <p>instance of ${formatter.format_xref(node.parent)} that is emitting the signal</p>
  19. </item>
  20. % for arg in formatter.get_in_parameters(node):
  21. <item>
  22. <title><code>${arg.argname}</code></title>
  23. ${formatter.format(node, arg.doc)}
  24. </item>
  25. % endfor
  26. <title><code>user_param1</code></title>
  27. <p>first user parameter (if any) specified with the connect() method</p>
  28. <item>
  29. <title><code>...</code></title>
  30. <p>additional user parameters (if any)</p>
  31. </item>
  32. % if node.retval and \
  33. node.retval.type.ctype != 'void' and \
  34. node.retval.type.ctype is not None:
  35. <item>
  36. <title><code>Returns</code></title>
  37. ${formatter.format(node, node.retval.doc)}
  38. </item>
  39. % endif
  40. </terms>
  41. </%block>