Class
{{ namespace.name }}{{ class.name }}
Description {% if CONFIG.source_location_url and class.docs_location %} [src] {% endif %}
{{ class.c_decl }}
Stability: | {{ class.stability }} |
Available since: | {{ class.available_since }} |
Deprecated since: | {{ class.deprecated_since.version }} |
{{ class.deprecated_since.message }} |
{{ key|escape }} | {{ value|escape }} |
Ancestors
-
{% for ancestor in class.ancestors %}
{% if ancestor.namespace == namespace.name %}
- {{ ancestor.type_cname }} {% else %}
- {{ ancestor.type_cname }} {% endif %} {% endfor %}
Descendants
-
{%- for cls in class.descendants %}
- {{ cls.ctype }} {% endfor -%}
Implements
-
{% for iface in class.interfaces %}
{% if iface.namespace == namespace.name %}
- {{ iface.type_cname }} {% else %}
- {{ iface.type_cname }} {% endif %} {% endfor %}
Constructors
{{ ctor.identifier }}
Available since: {{ ctor.available_since }}
{%- endif -%} {%- if ctor.deprecated_since -%}Deprecated since: {{ ctor.deprecated_since }}
{%- endif -%}Functions
{{ func.identifier }}
Available since: {{ func.available_since }}
{%- endif -%} {%- if func.deprecated_since -%}Deprecated since: {{ func.deprecated_since }}
{%- endif -%}Instance methods
{{ method.identifier }}
Available since: {{ method.available_since }}
{%- endif -%} {%- if method.deprecated_since -%}Deprecated since: {{ method.deprecated_since }}
{%- endif -%}Methods inherited from {{ ancestor.type_cname }} ({{ ancestor.n_methods }})
{%- else -%}Methods inherited from {{ ancestor.type_cname }} ({{ ancestor.n_methods }})
{% endif -%}{{ method.identifier }}
{%- else -%}{{ method.identifier }}
{% endif -%}Available since: {{ method.available_since }}
{%- endif -%} {%- if method.deprecated_since -%}Deprecated since: {{ method.deprecated_since }}
{%- endif -%}Please see {%- if ancestor.namespace == namespace.name -%} {{ ancestor.type_cname }} {%- else -%} {{ ancestor.type_cname }} {%- endif -%} for a full list of methods.
Methods inherited from {{ iface.type_cname }} ({{ iface.n_methods }})
{%- else -%}Methods inherited from {{ iface.type_cname }} ({{ iface.n_methods }})
{% endif -%}{{ method.identifier }}
{%- else -%}{{ method.identifier }}
{% endif -%}Available since: {{ method.available_since }}
{%- endif -%} {%- if method.deprecated_since -%}Deprecated since: {{ method.deprecated_since }}
{%- endif -%}Please see {%- if iface.namespace == namespace.name -%} {{ iface.type_cname }} {%- else -%} {{ iface.type_cname }} {%- endif -%} for a full list of methods.
Properties
{% if class.properties %}{{ class.fqtn }}:{{ property.name }}
Available since: {{ property.available_since }}
{%- endif -%} {%- if property.deprecated_since -%}Deprecated since: {{ property.deprecated_since }}
{%- endif -%}Properties inherited from {{ ancestor.type_cname }} ({{ ancestor.n_properties }})
{%- else -%}Properties inherited from {{ ancestor.type_cname }} ({{ ancestor.n_properties }})
{% endif -%}{{ ancestor.fqtn }}:{{ property.name }}
{%- else -%}{{ ancestor.fqtn }}:{{ property.name }}
{% endif -%}Available since: {{ property.available_since }}
{%- endif -%} {%- if property.deprecated_since -%}Deprecated since: {{ property.deprecated_since }}
{%- endif -%}Properties inherited from {{ iface.type_cname }} ({{ iface.n_properties }})
{%- else -%}Properties inherited from {{ iface.type_cname }} ({{ iface.n_properties }})
{% endif -%}{{ iface.fqtn }}:{{ property.name }}
{%- else -%}{{ iface.fqtn }}:{{ property.name }}
{% endif -%}Available since: {{ property.available_since }}
{%- endif -%} {%- if property.deprecated_since -%}Deprecated since: {{ property.deprecated_since }}
{%- endif -%}Signals
{% if class.signals %}{{ class.fqtn }}::{{ signal.name }}
Available since: {{ signal.available_since }}
{%- endif -%} {%- if signal.deprecated_since -%}Deprecated since: {{ signal.deprecated_since }}
{%- endif -%}Signals inherited from {{ ancestor.type_cname }} ({{ ancestor.n_signals }})
{%- else -%}Signals inherited from {{ ancestor.type_cname }} ({{ ancestor.n_signals }})
{% endif -%}{{ ancestor.fqtn }}::{{ signal.name }}
{%- else -%}{{ ancestor.fqtn }}::{{ signal.name }}
{% endif -%}Available since: {{ signal.available_since }}
{%- endif -%} {%- if signal.deprecated_since -%}Deprecated since: {{ signal.deprecated_since }}
{%- endif -%}Signals inherited from {{ iface.type_cname }} ({{ iface.n_signals }})
{%- else -%}Signals inherited from {{ iface.type_cname }} ({{ iface.n_signals }})
{% endif -%}{{ iface.fqtn }}::{{ signal.name }}
{%- else -%}{{ iface.fqtn }}::{{ signal.name }}
{% endif -%}Available since: {{ signal.available_since }}
{%- endif -%} {%- if signal.deprecated_since -%}Deprecated since: {{ signal.deprecated_since }}
{%- endif -%}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 %}
}
Class members
-
{% for field in class.class_fields %}
{{ field.name }}: {{ field.type_cname }}
- {{ field.description }} {% endfor %}
Virtual methods
{{ namespace.name }}.{{ class.class_name }}.{{ method.name }}
Available since: {{ method.available_since }}
{%- endif -%} {%- if method.deprecated_since -%}Deprecated since: {{ method.deprecated_since }}
{%- endif -%}Class methods
{{ method.identifier }}
Available since: {{ method.available_since }}
{%- endif -%} {%- if method.deprecated_since -%}Deprecated since: {{ method.deprecated_since }}
{%- endif -%}