{% extends "base.html" %} {% block title %}{{ namespace.name }}.{{ class.name }}::{{ signal.name }}{% endblock %} {% block meta_other %} {% endblock %} {% block sidebar %}
Type
Signals
{% endblock %} {% block content %}

Signal

{{ namespace.name }}.{{ class.name }}::{{ signal.name }}

Declaration

{{ signal.c_decl }}

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

{{ signal.description }}
{% if signal.no_recurse %} {% endif %} {% if signal.is_action %} {% endif %} {% if signal.is_detailed %} {% endif %} {% if signal.no_hooks %} {% endif %} {% if signal.stability %} {% endif %} {% if signal.available_since %} {% endif %} {% if signal.deprecated_since %} {% endif %}
Default handler: {{ signal.when }}
Signal emission will restart instead of recursing
The signal can be emitted directly
The signal can be detailed
Hooks are disabled for this signal
Stability:{{ signal.stability }}
Available since:{{ signal.available_since }}
Deprecated since:{{ signal.deprecated_since.version }}
{{ signal.deprecated_since.message }}
{% if signal.attributes %}
{% for (key, value) in signal.attributes.items() %} {% endfor %}
{{ key|escape }}{{ value|escape }}
{% endif %}
{% if signal.arguments|length != 0 %}

Parameters

{% for arg in signal.arguments %} {% if arg.direction != "in" %}{% endif %} {% if arg.direction == "in" and arg.is_pointer and arg.nullable %}{% endif %} {% if arg.direction == "out" and arg.optional %}{% endif %} {% if arg.is_pointer %}{% endif %} {% if arg.string_note %}{% endif %} {% endfor %}
{{ arg.name }} {%- if arg.link -%} {%- if arg.is_array -%}An array of {%- endif -%} {%- if arg.is_list -%}A list of {%- endif -%} {{ arg.link|safe }} {%- else -%} {{ arg.type_cname }} {%- endif -%}
  {{ arg.description }}
 Direction: {{ arg.direction }}
 Can be NULL
 Can be NULL
 {{ arg.transfer_note }}
 {{ arg.string_note }}
{% endif %} {% if signal.return_value %}

Return value

{% if signal.return_value.is_array and signal.return_value.zero_terminated %}{% endif %} {% if signal.return_value.is_array and signal.return_value.fixed_size > 0 %}{% endif %} {% if signal.return_value.is_array and signal.return_value.len_arg %}{% endif %} {% if signal.return_value.is_pointer %}{% endif %} {% if signal.return_value.is_pointer and signal.return_value.nullable %}{% endif %} {% if signal.return_value.string_note %}{% endif %}
Returns:  {%- if signal.return_value.link -%} {%- if signal.return_value.is_array -%}An array of {%- endif -%} {%- if signal.return_value.is_list -%}A list of {%- endif -%} {{ signal.return_value.link|safe }} {%- else -%} {{ signal.return_value.type_cname }} {%- endif -%}
{{ signal.return_value.description }}
 The array must be NULL terminated
 The array must have {{ signal.return_value.fixed_size }} elements
 The length of the array is in the {{ signal.return_value.len_arg }} argument
{{ signal.return_value.transfer_note }}
Can be NULL
{{ signal.return_value.string_note }}
{% endif %}
{% endblock %}