Signal
{{ namespace.name }}{{ class.name }}::{{ signal.name }}
Description {% if CONFIG.source_location_url and signal.docs_location %} [src] {% 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 }} | |
| {{ key|escape }} | {{ value|escape }} |
Parameters
-
{% for arg in signal.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 %}{{ arg.direction_note }} {% endif %} {% if arg.direction in ["inout", "out"] and arg.nullable %}The argument can be NULL. {% endif %} {% if arg.optional %}The argument can be set to NULLby the signal handler. {% endif %} {% if arg.is_array and arg.zero_terminated %}The argument can be NULL. {% endif %} {% if arg.is_array and arg.fixed_size > 0 %}The array must be NULL-terminated. {% endif %} {% if arg.is_array and arg.len_arg %}The array must have {{ arg.fixed_size }} elements. {% endif %} {% if arg.is_pointer %}The length of the array is specified in the {{ arg.len_arg }}argument. {% endif %} {% if arg.string_note %}{{ arg.transfer_note }} {% endif %}{{ arg.string_note }}
{% endfor %}
{% if signal.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 aNULLGError*.The argument will left initialized to NULLby the signal handler 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 %}
Return value
Type:
{%- if signal.return_value.is_array -%}An array of {%- endif -%}
{%- if signal.return_value.is_list -%}A list of {%- endif -%}
{%- if signal.return_value.is_list_model -%}A list model of {%- endif -%}
{%- if signal.return_value.link -%}
{{ signal.return_value.link|safe }}
{%- else -%}
{{ signal.return_value.type_cname }}
{%- endif -%}
{{ signal.return_value.description|safe }}
The array is NULL-terminated. |
| The array has {{ 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 }} |
The return value can be NULL. |
| {{ signal.return_value.string_note }} |