giscanner/mallard-Python-class.tmpl

   1 <?xml version="1.0"?>
   2 <page id="${node.namespace.name}.${node.name}"
   3       type="guide"
   4       style="class"
   5       xmlns="http://projectmallard.org/1.0/"
   6       xmlns:api="http://projectmallard.org/experimental/api/"
   7       xmlns:ui="http://projectmallard.org/experimental/ui/">
   8   <info>
   9     <link type="guide" xref="index" group="class"/>
  10   </info>
  11   <title>${namespace.name}.${node.name}</title>
  12 ${formatter.format(node.doc)}
  13
  14   <synopsis><code>
  15 from gi.repository import ${namespace.name}
  16
  17 ${formatter.to_underscores(node.name).lower()} = ${namespace.name}.${node.name}(\
  18 % for property_, ix in zip(node.properties, range(len(node.properties))):
  19 % if property_.construct or property_.construct_only or property_.writable:
  20 <link xref='${namespace.name}.${node.name}-${property_.name}'>${property_.name.replace('-', '_')}</link>=value\
  21 % if ix != len(node.properties) - 1:
  22 , \
  23 % endif
  24 % endif
  25 % endfor
  26 )\
  27   </code></synopsis>
  28
  29 % if node.version:
  30 <p>Since ${node.version}</p>
  31 % endif
  32   <synopsis>
  33     <title>Hierarchy</title>
  34     <tree>
  35 % for class_ in formatter.get_class_hierarchy(node):
  36       <item>
  37         <code>${class_.namespace.name}.${class_.name}</code>
  38 % endfor
  39 % for class_ in formatter.get_class_hierarchy(node):
  40       </item>
  41 % endfor
  42     </tree>
  43   </synopsis>
  44   <links type="topic" ui:expanded="yes"
  45          api:type="function" api:mime="text/x-python"
  46          groups="method" style="linklist">
  47     <title>Methods</title>
  48   </links>
  49   <links type="topic" ui:expanded="yes"
  50          api:type="function" api:mime="text/x-python"
  51          groups="function" style="linklist">
  52     <title>Functions</title>
  53   </links>
  54   <links type="topic" ui:expanded="yes" groups="property" style="linklist">
  55     <title>Properties</title>
  56   </links>
  57   <links type="topic" ui:expanded="yes" groups="signal" style="linklist">
  58     <title>Signals</title>
  59   </links>
  60   <links type="topic" ui:expanded="yes" groups="vfunc" style="linklist">
  61     <title>Virtual functions</title>
  62   </links>
  63   <links type="topic" ui:expanded="yes" groups="#first #default #last" style="linklist">
  64     <title>Other</title>
  65   </links>
  66 </page>