actionobserver: Clarify primary_accel_changed docs

Either action_name or action_and_target may be NULL
here, and observer implementations should be careful
when checking those values.
This commit is contained in:
Matthias Clasen 2021-06-16 10:34:37 -04:00
parent 7b1a7629bc
commit 424dd8a463

View File

@ -158,15 +158,17 @@ gtk_action_observer_action_removed (GtkActionObserver *observer,
* gtk_action_observer_primary_accel_changed: * gtk_action_observer_primary_accel_changed:
* @observer: a `GtkActionObserver` * @observer: a `GtkActionObserver`
* @observable: the source of the event * @observable: the source of the event
* @action_name: the name of the action * @action_name: (nullable): the name of the action
* @action_and_target: detailed action of the changed accel, in action and target format * @action_and_target: (nullable): detailed action of the changed accel, in action and target format
* *
* This function is called when an action that the observer is * This function is called when an action that the observer is
* registered to receive events for has one of its accelerators changed. * registered to receive events for has one of its accelerators changed.
* *
* Accelerator changes are reported for all targets associated with the * Accelerator changes are reported for all targets associated with the
* action. The @action_and_target string should be used to check if the * action. The @action_and_target string should be used to check if the
* reported target is the one that the observer is interested in. * reported target is the one that the observer is interested in.
*
* Either @action_name or @action_and_target may be %NULL.
*/ */
void void
gtk_action_observer_primary_accel_changed (GtkActionObserver *observer, gtk_action_observer_primary_accel_changed (GtkActionObserver *observer,