Interface
{{ namespace.name }}{{ interface.name }}
Description {% if CONFIG.source_location_url and interface.docs_location %} [src] {% endif %}
{{ interface.c_decl }}
Stability: | {{ interface.stability }} |
Available since: | {{ interface.available_since }} |
Deprecated since: | {{ interface.deprecated_since.version }} |
{{ interface.deprecated_since.message }} |
{{ 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 }}
.
Functions
{{ func.identifier }}
Deprecated since: {{ func.deprecated_since.version }}
Instance methods
{{ method.identifier }}
Available since: {{ method.available_since }}
{%- endif -%} {%- if method.deprecated_since -%}Deprecated since: {{ method.deprecated_since }}
{%- endif -%}Properties
{{ interface.fqtn }}:{{ property.name }}
Available since: {{ property.available_since }}
{%- endif -%} {%- if property.deprecated_since -%}Deprecated since: {{ property.deprecated_since }}
{%- endif -%}Signals
{{ interface.fqtn }}::{{ signal.name }}
Available since: {{ signal.available_since }}
{%- endif -%} {%- if signal.deprecated_since -%}Deprecated since: {{ signal.deprecated_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 }}
Deprecated since: {{ method.deprecated_since.version }}
Virtual methods
{{ namespace.name }}.{{ interface.name }}.{{ method.name }}
Deprecated since: {{ method.deprecated_since.version }}