{% extends "base.html" %} {% block title %}{{ namespace.name }}.{{ class.name }}.{{ vfunc.name }}{% endblock %} {% block meta_other %} {% endblock %} {% block sidebar %}
Type
Virtual methods
{% endblock %} {% block content %}

Virtual Method

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

Declaration {% if CONFIG.source_location_url and vfunc.source_location %} [src] {% endif %}

{{ vfunc.c_decl }}

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

{{ vfunc.description }}
{% if vfunc.stability %} {% endif %} {% if vfunc.available_since %} {% endif %} {% if vfunc.deprecated_since %} {% endif %}
Stability:{{ vfunc.stability }}
Available since:{{ vfunc.available_since }}
Deprecated since:{{ vfunc.deprecated_since.version }}
{{ vfunc.deprecated_since.message }}
{% if vfunc.attributes %}
{% for (key, value) in vfunc.attributes.items() %} {% endfor %}
{{ key|escape }}{{ value|escape }}
{% endif %}
{% if vfunc.arguments|length != 0 %}

Parameters

{% for arg in vfunc.arguments %}
{{ arg.name }}

Type:  {%- if arg.is_array -%}An array of {%- endif -%} {%- if arg.is_list -%}A list of {%- endif -%} {%- if arg.link -%} {{ arg.link|safe }} {%- else -%} {{ arg.type_cname }} {%- endif -%}

{{ arg.description|safe }}

{% if arg.direction != "in" %}{% endif %} {% if arg.direction == "in" and arg.is_pointer and arg.nullable %}{% endif %} {% if arg.direction == "out" and arg.is_pointer and arg.nullable %}{% endif %} {% if arg.optional %}{% endif %} {% if arg.is_array and arg.zero_terminated %}{% endif %} {% if arg.is_array and arg.fixed_size > 0 %}{% endif %} {% if arg.is_array and arg.len_arg %}{% endif %} {% if arg.is_pointer %}{% endif %} {% if arg.string_note %}{% endif %}
{{ arg.direction_note }}
The argument can be NULL.
The argument can be set to NULL by the virtual function.
The argument can be NULL.
The array must be NULL-terminated.
The array must have {{ arg.fixed_size }} elements.
The length of the array is specified in the {{ arg.len_arg }} argument.
{{ arg.transfer_note }}
{{ arg.string_note }}
{% endfor %} {% if vfunc.throws %}
error

Type: GError **

The return location for an error.

The argument can be NULL.
The argument will be set to NULL by the function if there are no errors.
In case of error, the argument will be set and the caller will take ownership of the data, and be responsible for freeing it.
{% endif %}
{% endif %} {% if vfunc.return_value %}

Return value

Type:  {%- if vfunc.return_value.is_array -%}An array of {%- endif -%} {%- if vfunc.return_value.is_list -%}A list of {%- endif -%} {%- if vfunc.return_value.is_list_model -%}A list model of {%- endif -%} {%- if vfunc.return_value.link -%} {{ vfunc.return_value.link|safe }} {%- else -%} {{ vfunc.return_value.type_cname }} {%- endif -%}

{{ vfunc.return_value.description|safe }}

{% if vfunc.return_value.is_array and vfunc.return_value.zero_terminated %}{% endif %} {% if vfunc.return_value.is_array and vfunc.return_value.fixed_size > 0 %}{% endif %} {% if vfunc.return_value.is_array and vfunc.return_value.len_arg %}{% endif %} {% if vfunc.return_value.is_pointer %}{% endif %} {% if vfunc.return_value.is_pointer and vfunc.return_value.nullable %}{% endif %} {% if vfunc.return_value.string_note %}{% endif %}
The array is NULL-terminated.
The array has {{ vfunc.return_value.fixed_size }} elements.
The length of the array is in the {{ vfunc.return_value.len_arg }} argument.
{{ vfunc.return_value.transfer_note }}
The return value can be NULL.
{{ vfunc.return_value.string_note }}
{% endif %}
{% endblock %}