{% extends "base.html" %} {% block title %}{{ namespace.name }}.{{ interface.name }}{% endblock %} {% block meta_other %} {% endblock %} {% macro sidebar_block(elements, iface_name, section_title, section_class, section_fragment) -%} {% if elements|length > 0 %}
{{ section_title }}
{% endif %} {% endmacro %} {% block sidebar %}
Type
{{ sidebar_block(interface.methods, interface.name, "Instance methods", "method", "method") }} {{ sidebar_block(interface.properties, interface.name, "Properties", "property", "property") }} {{ sidebar_block(interface.signals, interface.name, "Signals", "signal", "signal") }} {{ sidebar_block(interface.class_methods, interface.name, "Interface methods", "method", "class_method") }} {{ sidebar_block(interface.type_funcs, interface.name, "Functions", "func", "type_func") }} {{ sidebar_block(interface.virtual_methods, interface.name, "Virtual methods", "method", "vfunc") }} {% endblock %} {% block content %}

Interface

{{ namespace.name }}.{{ interface.name }}

Description {% if CONFIG.source_location_url and interface.docs_location %} [src] {% endif %}

{{ interface.c_decl }}
{{ interface.description }}
{% if interface.stability %} {% endif %} {% if interface.available_since %} {% endif %} {% if interface.deprecated_since %} {% endif %}
Stability:{{ interface.stability }}
Available since:{{ interface.available_since }}
Deprecated since:{{ interface.deprecated_since.version }}
{{ interface.deprecated_since.message }}
{% if interface.attributes %}
{% for (key, value) in interface.attributes.items() %} {% endfor %}
{{ key|escape }}{{ value|escape }}
{% endif %}
{% if interface.methods %}

Instance methods

{% for method in interface.methods %}
{{ method.identifier }}
{{ method.summary }}
{% if method.available_since or method.deprecated_since -%}
{%- if method.available_since -%}

Available since: {{ method.available_since }}

{%- endif -%} {%- if method.deprecated_since -%}

Deprecated since: {{ method.deprecated_since }}

{%- endif -%}
{%- endif %}
{% endfor %}
{% endif %} {% if interface.properties %}

Properties

{% for property in interface.properties %}
{{ interface.fqtn }}:{{ property.name }}
{{ property.summary }}
{% if property.available_since or property.deprecated_since -%}
{%- if property.available_since -%}

Available since: {{ property.available_since }}

{%- endif -%} {%- if property.deprecated_since -%}

Deprecated since: {{ property.deprecated_since }}

{%- endif -%}
{%- endif %}
{% endfor %}
{% endif %} {% if interface.signals %}

Signals

{% for signal in interface.signals %}
{{ interface.fqtn }}::{{ signal.name }}
{{ signal.summary }}
{% if signal.available_since or signal.deprecated_since -%}
{%- if signal.available_since -%}

Available since: {{ signal.available_since }}

{%- endif -%} {%- if signal.deprecated_since -%}

Deprecated since: {{ signal.deprecated_since }}

{%- endif -%}
{%- endif %}
{% endfor %}
{% endif %} {% if interface.class_name %}

Interface structure {% if CONFIG.source_location_url and interface.source_location %} [src] {% endif %}

struct {{ namespace.name}}{{ interface.class_name }} {
  {% for field in interface.class_fields %}
  {%- if field.is_callback -%}
  {{ field.type_cname }};
  {%- else -%}
  {{ field.type_cname }} {{ field.name }};
  {%- endif %}
  {% else %}/* no available fields */{% endfor %}
}
{% if interface.class_fields %}
Interface members
{% for field in interface.class_fields %} {% endfor %}
{{ field.name }}
{{ field.type_cname }}
 {{ field.description }}
{% endif %}
{% endif %} {% if interface.class_methods %}

Interface methods

{% for method in interface.class_methods %}
{{ method.identifier }}
{{ method.summary }}
{% if method.deprecated_since %}

Deprecated since: {{ method.deprecated_since.version }}

{% endif %}
{% endfor %}
{% endif %} {% if interface.type_funcs %}

Functions

{% for func in interface.type_funcs %}
{{ func.identifier }}
{{ func.summary }}
{% if func.deprecated_since %}

Deprecated since: {{ func.deprecated_since.version }}

{% endif %}
{% endfor %}
{% endif %} {% if interface.virtual_methods %}

Virtual methods

{% for method in interface.virtual_methods %}
{{ namespace.name }}.{{ interface.name }}.{{ method.name }}
{{ method.summary }}
{% if method.deprecated_since %}

Deprecated since: {{ method.deprecated_since.version }}

{% endif %}
{% endfor %}
{% endif %}
{% endblock %}