gio/gactionmap.h

   1 /*
   2  * Copyright © 2010 Codethink Limited
   3  *
   4  * This program is free software: you can redistribute it and/or modify
   5  * it under the terms of the GNU Lesser General Public License as published
   6  * by the Free Software Foundation; either version 2 of the licence or (at
   7  * your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General
  15  * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
  16  *
  17  * Authors: Ryan Lortie <desrt@desrt.ca>
  18  */
  19
  20 #ifndef __G_ACTION_MAP_H__
  21 #define __G_ACTION_MAP_H__
  22
  23 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
  24 #error "Only <gio/gio.h> can be included directly."
  25 #endif
  26
  27 #include <gio/giotypes.h>
  28
  29 G_BEGIN_DECLS
  30
  31
  32 #define G_TYPE_ACTION_MAP                                   (g_action_map_get_type ())
  33 #define G_ACTION_MAP(inst)                                  (G_TYPE_CHECK_INSTANCE_CAST ((inst),                      \
  34                                                              G_TYPE_ACTION_MAP, GActionMap))
  35 #define G_IS_ACTION_MAP(inst)                               (G_TYPE_CHECK_INSTANCE_TYPE ((inst),                      \
  36                                                              G_TYPE_ACTION_MAP))
  37 #define G_ACTION_MAP_GET_IFACE(inst)                        (G_TYPE_INSTANCE_GET_INTERFACE ((inst),                   \
  38                                                              G_TYPE_ACTION_MAP, GActionMapInterface))
  39
  40 typedef struct _GActionMapInterface                         GActionMapInterface;
  41 typedef struct _GActionEntry                                GActionEntry;
  42
  43 struct _GActionMapInterface
  44 {
  45   GTypeInterface g_iface;
  46
  47   GAction * (* lookup_action) (GActionMap  *action_map,
  48                                const gchar *action_name);
  49   void      (* add_action)    (GActionMap  *action_map,
  50                                GAction     *action);
  51   void      (* remove_action) (GActionMap  *action_map,
  52                                const gchar *action_name);
  53 };
  54
  55 struct _GActionEntry
  56 {
  57   const gchar *name;
  58
  59   void (* activate) (GSimpleAction *action,
  60                      GVariant      *parameter,
  61                      gpointer       user_data);
  62
  63   const gchar *parameter_type;
  64
  65   const gchar *state;
  66
  67   void (* change_state) (GSimpleAction *action,
  68                          GVariant      *value,
  69                          gpointer       user_data);
  70
  71   /*< private >*/
  72   gsize padding[3];
  73 };
  74
  75 GLIB_AVAILABLE_IN_2_32
  76 GType                   g_action_map_get_type                           (void) G_GNUC_CONST;
  77
  78 GLIB_AVAILABLE_IN_2_32
  79 GAction *               g_action_map_lookup_action                      (GActionMap         *action_map,
  80                                                                          const gchar        *action_name);
  81 GLIB_AVAILABLE_IN_2_32
  82 void                    g_action_map_add_action                         (GActionMap         *action_map,
  83                                                                          GAction            *action);
  84 GLIB_AVAILABLE_IN_2_32
  85 void                    g_action_map_remove_action                      (GActionMap         *action_map,
  86                                                                          const gchar        *action_name);
  87 GLIB_AVAILABLE_IN_2_32
  88 void                    g_action_map_add_action_entries                 (GActionMap         *action_map,
  89                                                                          const GActionEntry *entries,
  90                                                                          gint                n_entries,
  91                                                                          gpointer            user_data);
  92
  93 G_END_DECLS
  94
  95 #endif /* __G_ACTION_MAP_H__ */