Commit 21348867 authored by Daniel Boles's avatar Daniel Boles

GSimpleAction: Explain "(expected|correct) type"

Let's avoid users having to infer what these mean; it's easy to explain.

https://bugzilla.gnome.org/show_bug.cgi?id=795070
parent 75021c6c
......@@ -376,8 +376,9 @@ g_simple_action_class_init (GSimpleActionClass *class)
*
* Indicates that the action was just activated.
*
* @parameter will always be of the expected type. In the event that
* an incorrect type was given, no signal will be emitted.
* @parameter will always be of the expected type, i.e. the parameter type
* specified when the action was created. If an incorrect type is given when
* activating the action, this signal is not emitted.
*
* Since GLib 2.40, if no handler is connected to this signal then the
* default behaviour for boolean-stated actions with a %NULL parameter
......@@ -406,8 +407,10 @@ g_simple_action_class_init (GSimpleActionClass *class)
* Indicates that the action just received a request to change its
* state.
*
* @value will always be of the correct state type. In the event that
* an incorrect type was given, no signal will be emitted.
* @value will always be of the correct state type, i.e. the type of the
* initial state passed to g_simple_action_new_stateful(). If an incorrect
* type is given when requesting to change the state, this signal is not
* emitted.
*
* If no handler is connected to this signal then the default
* behaviour is to call g_simple_action_set_state() to set the state
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment