Interface
{{ namespace.name }}{{ interface.name }}
{%- if CONFIG.is_unstable(interface.available_since) -%} unstable {%- endif %} {%- if interface.deprecated_since -%} deprecated: {{ interface.deprecated_since.version }} {%- endif -%} {%- if interface.available_since -%} since: {{ interface.available_since }} {%- endif -%}
Description {% if CONFIG.source_location_url and interface.docs_location %} [src] {% endif %}
{{ interface.c_decl }}
Stability: {{ interface.stability }}
{% endif %} {% if interface.available_since %}Available since: {{ interface.available_since }}
{% endif %} {% if interface.deprecated_since %} {%- if interface.deprecated_since.message -%}Deprecated since: {{ interface.deprecated_since.version }}
{{ interface.deprecated_since.message }}Deprecated since: {{ interface.deprecated_since.version }}. Do not use in newly written code.
{%- endif -%} {% endif %}{{ key|escape }} | {{ value|escape }} |
Prerequisite
In order to implement {{ interface.name }}, your type must inherit from
{%- if interface.requires_namespace == namespace.name -%}
{%- else -%}
{%- endif -%}
{{ interface.requires_ctype }}
.
Implementations
-
{%- for impl in interface.implementations %}
- {{ impl.ctype }} {% endfor -%}
Functions
{{ func.identifier }}
{%- if CONFIG.is_unstable(func.available_since) -%} unstable {%- endif %} {%- if func.deprecated_since -%} deprecated: {{ func.deprecated_since }} {%- endif -%} {%- if func.available_since -%} since: {{ func.available_since }} {%- endif -%}
Instance methods
{{ method.identifier }}
{%- if CONFIG.is_unstable(method.available_since) -%} unstable {%- endif %} {%- if method.deprecated_since -%} deprecated: {{ method.deprecated_since }} {%- endif -%} {%- if method.available_since -%} since: {{ method.available_since }} {%- endif -%}
Properties
{{ interface.fqtn }}:{{ property.name }}
{%- if CONFIG.is_unstable(property.available_since) -%} unstable {%- endif %} {%- if property.deprecated_since -%} deprecated: {{ property.deprecated_since }} {%- endif -%} {%- if property.available_since -%} since: {{ property.available_since }} {%- endif -%}
Signals
{{ interface.fqtn }}::{{ signal.name }}
{%- if CONFIG.is_unstable(signal.available_since) -%} unstable {%- endif %} {%- if signal.deprecated_since -%} deprecated: {{ signal.deprecated_since }} {%- endif -%} {%- if signal.available_since -%} since: {{ signal.available_since }} {%- endif -%}
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 %}
}
Interface members
{{ field.name }} |
|
{{ field.description }} |
Interface methods
{{ method.identifier }}
{%- if CONFIG.is_unstable(method.available_since) -%} unstable {%- endif %} {%- if method.deprecated_since -%} deprecated: {{ method.deprecated_since }} {%- endif -%} {%- if method.available_since -%} since: {{ method.available_since }} {%- endif -%}
Virtual methods
{{ namespace.name }}.{{ interface.name }}.{{ method.name }}
{%- if CONFIG.is_unstable(method.available_since) -%} unstable {%- endif %} {%- if method.deprecated_since -%} deprecated: {{ method.deprecated_since }} {%- endif -%} {%- if method.available_since -%} since: {{ method.available_since }} {%- endif -%}