{% extends "base.html" %} {% block title %}{{ namespace.name }}.{{ class.class_name }}.{{ class_method.name }}{% endblock %} {% block meta_other %} {% endblock %} {% block sidebar %}
Type
Class methods
{% endblock %} {% block content %}

Class method

{{ namespace.name }}{{ class.class_name }}{{ class_method.name }}

{%- if CONFIG.is_unstable(class_method.available_since) -%} unstable  {%- endif %} {%- if class_method.deprecated_since -%} deprecated: {{ class_method.deprecated_since.version }}  {%- endif -%} {%- if class_method.available_since -%} since: {{ class_method.available_since }} {%- endif -%}

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

{{ class_method.c_decl }}

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

{{ class_method.description }}
{% if class_method.stability -%}

Stability: {{ class_method.stability }}

{%- endif %} {% if class_method.available_since -%}

Available since: {{ class_method.available_since }}

{%- endif %} {% if class_method.deprecated_since -%}
{%- if class_method.deprecated_since.message -%}

Deprecated since: {{ class_method.deprecated_since.version }}

{{ class_method.deprecated_since.message }} {%- else -%}

Deprecated since: {{ class_method.deprecated_since.version }}. Do not use in newly written code

{%- endif -%}
{%- endif %} {% if not class_method.introspectable -%}

This method is not directly available to language bindings.

{%- endif %}
{% if class_method.attributes %}
{% for (key, value) in class_method.attributes.items() %} {% endfor %}
{{ key|escape }}{{ value|escape }}
{% endif %}
{% if class_method.arguments|length != 0 %}

Parameters

{% for arg in class_method.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.nullable %}{% endif %} {% if arg.direction in ["inout", "out"] 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 class method
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 class_method.throws %}
error

Type: GError **

The return location for a recoverable error.

The argument can be NULL.
If the return location is not NULL, then you must initialize it to a NULL GError*.
The argument will left initialized to NULL by the class method if there are no errors.
In case of error, the argument will be set to a newly allocated GError; the caller will take ownership of the data, and be responsible for freeing it.
{% endif %}
{% endif %} {% if class_method.return_value %}

Return value

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

{{ class_method.return_value.description|safe }}

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