diff options
Diffstat (limited to 'giscanner/mallard-Python-class.tmpl')
-rw-r--r-- | giscanner/mallard-Python-class.tmpl | 63 |
1 files changed, 63 insertions, 0 deletions
diff --git a/giscanner/mallard-Python-class.tmpl b/giscanner/mallard-Python-class.tmpl new file mode 100644 index 00000000..62feb9ab --- /dev/null +++ b/giscanner/mallard-Python-class.tmpl @@ -0,0 +1,63 @@ +<?xml version="1.0"?> +<page id="${node.namespace.name}.${node.name}" + type="guide" + style="class" + xmlns="http://projectmallard.org/1.0/" + xmlns:api="http://projectmallard.org/experimental/api/" + xmlns:ui="http://projectmallard.org/experimental/ui/"> + <info> + <link type="guide" xref="index" group="class"/> + </info> + <title>${namespace.name}.${node.name}</title> +${formatter.format(node.doc)} + + <synopsis><code> +from gi.repository import ${namespace.name} + +${formatter.to_underscores(node.name).lower()} = ${namespace.name}.${node.name}(\ +% for property_, ix in zip(node.properties, range(len(node.properties))): +% if property_.construct or property_.construct_only or property_.writable: +<link xref='${namespace.name}.${node.name}-${property_.name}'>${property_.name.replace('-', '_')}</link>=value\ +% if ix != len(node.properties) - 1: +, \ +% endif +% endif +% endfor +)\ + </code></synopsis> + +% if node.version: +<p>Since ${node.version}</p> +% endif + <synopsis> + <title>Hierarchy</title> + <tree> +% for class_ in formatter.get_class_hierarchy(node): + <item> + <code>${class_.namespace.name}.${class_.name}</code> +% endfor +% for class_ in formatter.get_class_hierarchy(node): + </item> +% endfor + </tree> + </synopsis> + <links type="topic" ui:expanded="yes" + api:type="function" api:mime="text/x-python" + groups="method" style="linklist"> + <title>Methods</title> + </links> + <links type="topic" ui:expanded="yes" + api:type="function" api:mime="text/x-python" + groups="function" style="linklist"> + <title>Functions</title> + </links> + <links type="topic" ui:expanded="yes" groups="property" style="linklist"> + <title>Properties</title> + </links> + <links type="topic" ui:expanded="yes" groups="signal" style="linklist"> + <title>Signals</title> + </links> + <links type="topic" ui:expanded="yes" groups="#first #default #last" style="linklist"> + <title>Other</title> + </links> +</page> |