gtkactionobservable.c 2.59 KB
Newer Older
1 2 3
/*
 * Copyright © 2011 Canonical Limited
 *
Javier Jardón's avatar
Javier Jardón committed
4
 * This library is free software: you can redistribute it and/or modify
5 6 7 8 9 10 11 12 13 14
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2 of the
 * licence or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
Javier Jardón's avatar
Javier Jardón committed
15
 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
16 17 18 19 20 21
 *
 * Authors: Ryan Lortie <desrt@desrt.ca>
 */

#include "config.h"

22
#include "gtkactionobservable.h"
23

24
G_DEFINE_INTERFACE (GtkActionObservable, gtk_action_observable, G_TYPE_OBJECT)
25

26
/*
27
 * SECTION:gtkactionobserable
28 29 30 31 32
 * @short_description: an interface implemented by objects that report
 *                     changes to actions
 */

void
33
gtk_action_observable_default_init (GtkActionObservableInterface *iface)
34 35 36
{
}

37
/**
38 39
 * gtk_action_observable_register_observer:
 * @observable: a #GtkActionObservable
40
 * @action_name: the name of the action
41
 * @observer: the #GtkActionObserver to which the events will be reported
42 43 44
 *
 * Registers @observer as being interested in changes to @action_name on
 * @observable.
45
 */
46
void
47 48 49
gtk_action_observable_register_observer (GtkActionObservable *observable,
                                         const gchar         *action_name,
                                         GtkActionObserver   *observer)
50
{
51
  g_return_if_fail (GTK_IS_ACTION_OBSERVABLE (observable));
52

53
  GTK_ACTION_OBSERVABLE_GET_IFACE (observable)
54 55 56
    ->register_observer (observable, action_name, observer);
}

57
/**
58 59
 * gtk_action_observable_unregister_observer:
 * @observable: a #GtkActionObservable
60
 * @action_name: the name of the action
61
 * @observer: the #GtkActionObserver to which the events will be reported
62 63 64 65 66 67
 *
 * Removes the registration of @observer as being interested in changes
 * to @action_name on @observable.
 *
 * If the observer was registered multiple times, it must be
 * unregistered an equal number of times.
68
 */
69
void
70 71 72
gtk_action_observable_unregister_observer (GtkActionObservable *observable,
                                           const gchar         *action_name,
                                           GtkActionObserver   *observer)
73
{
74
  g_return_if_fail (GTK_IS_ACTION_OBSERVABLE (observable));
75

76
  GTK_ACTION_OBSERVABLE_GET_IFACE (observable)
77 78
    ->unregister_observer (observable, action_name, observer);
}