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

Class

{{ namespace.name }}.{{ class.name }}

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

{{ class.c_decl }}
{{ class.description }}
{% if class.stability %} {% endif %} {% if class.available_since %} {% endif %} {% if class.deprecated_since %} {% endif %}
Stability:{{ class.stability }}
Available since:{{ class.available_since }}
Deprecated since:{{ class.deprecated_since.version }}
{{ class.deprecated_since.message }}
{% if class.attributes %}
{% for (key, value) in class.attributes.items() %} {% endfor %}
{{ key|escape }}{{ value|escape }}
{% endif %}
{% if CONFIG.show_class_hierarchy and (class.ancestors or class.interfaces) %}

Hierarchy

{{ class.hierarchy_svg|safe }}
{% endif %} {% if class.ancestors %}

Ancestors

    {% for ancestor in class.ancestors %} {% if ancestor.namespace == namespace.name %}
  • {{ ancestor.type_cname }}
  • {% else %}
  • {{ ancestor.type_cname }}
  • {% endif %} {% endfor %}
{% endif %} {% if class.interfaces %}

Implements

    {% for iface in class.interfaces %} {% if iface.namespace == namespace.name %}
  • {{ iface.type_cname }}
  • {% else %}
  • {{ iface.type_cname }}
  • {% endif %} {% endfor %}
{% endif %} {% if class.ctors %}

Constructors

{% for ctor in class.ctors %}
{{ ctor.identifier }}
{{ ctor.summary }}
{% if ctor.available_since or ctor.deprecated_since -%}
{%- if ctor.available_since -%}

Available since: {{ ctor.available_since }}

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

Deprecated since: {{ ctor.deprecated_since }}

{%- endif -%}
{%- endif %}
{% endfor %}
{% endif %} {% if class.methods %}

Instance methods

{% for method in class.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 %}
{% for ancestor in class.ancestors %} {% if ancestor.namespace == namespace.name and ancestor.n_methods > 0 %}
Methods inherited from {{ ancestor.type_cname }} ({{ ancestor.n_methods }})
{% if ancestor.methods %}
{% for method in ancestor.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 %}
{% endif %} {% endfor %} {% for iface in class.interfaces %} {% if iface.namespace == namespace.name and iface.n_methods > 0 %}
Methods inherited from {{ iface.type_cname }} ({{ iface.n_methods }})
{% if iface.methods %}
{% for method in iface.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 %}
{% endif %} {% endfor %}
{% endif %} {% if class.properties %}

Properties

{% for property in class.properties %}
{{ class.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 %}
{% for ancestor in class.ancestors %} {% if ancestor.namespace == namespace.name and ancestor.n_properties > 0 %}
Properties inherited from {{ ancestor.type_cname }} ({{ ancestor.n_properties }})
{% if ancestor.properties %}
{% for property in ancestor.properties %}
{{ ancestor.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 %}
{% endif %} {% endfor %} {% for iface in class.interfaces %} {% if iface.namespace == namespace.name and iface.n_properties > 0 %}
Properties inherited from {{ iface.type_cname }} ({{ iface.n_properties }})
{% if iface.properties %}
{% for property in iface.properties %}
{{ iface.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 %}
{% endif %} {% endfor %}
{% endif %} {% if class.signals %}

Signals

{% for signal in class.signals %}
{{ class.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 %}
{% for ancestor in class.ancestors %} {% if ancestor.namespace == namespace.name and ancestor.n_signals > 0 %}
Signals inherited from {{ ancestor.type_cname }} ({{ ancestor.n_signals }})
{% if ancestor.signals %}
{% for signal in ancestor.signals %}
{{ ancestor.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 %}
{% endif %} {% endfor %} {% for iface in class.interfaces %} {% if iface.namespace == namespace.name and iface.n_signals %}
Signals inherited from {{ iface.type_cname }} ({{ iface.n_signals }})
{% if iface.signals %}
{% for signal in iface.signals %}
{{ iface.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 %}
{% endif %} {% endfor %}
{% endif %} {% if class.class_name %}

Class structure

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

Virtual methods

{% for method in class.virtual_methods %}
{{ namespace.name }}.{{ class.class_name }}.{{ method.name }}
{{ 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 class.class_methods %}

Class methods

{% for method in class.class_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 class.type_funcs %}

Functions

{% for func in class.type_funcs %}
{{ func.identifier }}
{{ func.summary }}
{% if func.available_since or func.deprecated_since -%}
{%- if func.available_since -%}

Available since: {{ func.available_since }}

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

Deprecated since: {{ func.deprecated_since }}

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