gio/gactionmap.h

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