gio/gactiongroup.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, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  *
  19  * Authors: Ryan Lortie <desrt@desrt.ca>
  20  */
  21
  22 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
  23 #error "Only <gio/gio.h> can be included directly."
  24 #endif
  25
  26 #ifndef __G_ACTION_GROUP_H__
  27 #define __G_ACTION_GROUP_H__
  28
  29 #include <gio/giotypes.h>
  30
  31 G_BEGIN_DECLS
  32
  33 #define G_TYPE_ACTION_GROUP                                 (g_action_group_get_type ())
  34 #define G_ACTION_GROUP(inst)                                (G_TYPE_CHECK_INSTANCE_CAST ((inst),                     \
  35                                                              G_TYPE_ACTION_GROUP, GActionGroup))
  36 #define G_IS_ACTION_GROUP(inst)                             (G_TYPE_CHECK_INSTANCE_TYPE ((inst),                     \
  37                                                              G_TYPE_ACTION_GROUP))
  38 #define G_ACTION_GROUP_GET_IFACE(inst)                      (G_TYPE_INSTANCE_GET_INTERFACE ((inst),                  \
  39                                                              G_TYPE_ACTION_GROUP, GActionGroupInterface))
  40
  41 typedef struct _GActionGroupInterface                       GActionGroupInterface;
  42
  43 /**
  44  * GActionGroupInterface:
  45  * @has_action: the virtual function pointer for g_action_group_has_action()
  46  * @list_actions: the virtual function pointer for g_action_group_list_actions()
  47  * @get_parameter_type: the virtual function pointer for g_action_group_get_parameter_type()
  48  * @get_state_type: the virtual function pointer for g_action_group_get_state_type()
  49  * @get_state_hint: the virtual function pointer for g_action_group_get_state_hint()
  50  * @get_enabled: the virtual function pointer for g_action_group_get_enabled()
  51  * @get_state: the virtual function pointer for g_action_group_get_state()
  52  * @set_state: the virtual function pointer for g_action_group_set_state()
  53  * @activate: the virtual function pointer for g_action_group_activate()
  54  * @action_added: the class closure for the action-added signal
  55  * @action_removed: the class closure for the action-removed signal
  56  * @action_enabled_changed: the class closure for the action-enabled-changed signal
  57  * @action_state_changed: the class closure for the action-enabled-changed signal
  58  *
  59  * The virtual function table for #GActionGroup.
  60  *
  61  * Since: 2.26
  62  */
  63 struct _GActionGroupInterface
  64 {
  65   GTypeInterface g_iface;
  66
  67   /* virtual functions */
  68   gboolean              (* has_action)              (GActionGroup  *action_group,
  69                                                      const gchar   *action_name);
  70
  71   gchar **              (* list_actions)            (GActionGroup  *action_group);
  72
  73   gboolean              (* get_enabled)             (GActionGroup  *action_group,
  74                                                      const gchar   *action_name);
  75
  76   const GVariantType *  (* get_parameter_type)      (GActionGroup  *action_group,
  77                                                      const gchar   *action_name);
  78
  79   const GVariantType *  (* get_state_type)          (GActionGroup  *action_group,
  80                                                      const gchar   *action_name);
  81
  82   GVariant *            (* get_state_hint)          (GActionGroup  *action_group,
  83                                                      const gchar   *action_name);
  84
  85   GVariant *            (* get_state)               (GActionGroup  *action_group,
  86                                                      const gchar   *action_name);
  87
  88   void                  (* set_state)               (GActionGroup  *action_group,
  89                                                      const gchar   *action_name,
  90                                                      GVariant      *value);
  91
  92   void                  (* activate)                (GActionGroup  *action_group,
  93                                                      const gchar   *action_name,
  94                                                      GVariant      *parameter);
  95
  96   /* signals */
  97   void                  (* action_added)            (GActionGroup  *action_group,
  98                                                      const gchar   *action_name);
  99   void                  (* action_removed)          (GActionGroup  *action_group,
 100                                                      const gchar   *action_name);
 101   void                  (* action_enabled_changed)  (GActionGroup  *action_group,
 102                                                      const gchar   *action_name,
 103                                                      gboolean       enabled);
 104   void                  (* action_state_changed)    (GActionGroup   *action_group,
 105                                                      const gchar    *action_name,
 106                                                      GVariant       *value);
 107 };
 108
 109 GType                   g_action_group_get_type                         (void) G_GNUC_CONST;
 110
 111 gboolean                g_action_group_has_action                       (GActionGroup *action_group,
 112                                                                          const gchar  *action_name);
 113 gchar **                g_action_group_list_actions                     (GActionGroup *action_group);
 114
 115 const GVariantType *    g_action_group_get_parameter_type               (GActionGroup *action_group,
 116                                                                          const gchar  *action_name);
 117 const GVariantType *    g_action_group_get_state_type                   (GActionGroup *action_group,
 118                                                                          const gchar  *action_name);
 119 GVariant *              g_action_group_get_state_hint                   (GActionGroup *action_group,
 120                                                                          const gchar  *action_name);
 121
 122 gboolean                g_action_group_get_enabled                      (GActionGroup *action_group,
 123                                                                          const gchar  *action_name);
 124
 125 GVariant *              g_action_group_get_state                        (GActionGroup *action_group,
 126                                                                          const gchar  *action_name);
 127 void                    g_action_group_set_state                        (GActionGroup *action_group,
 128                                                                          const gchar  *action_name,
 129                                                                          GVariant     *value);
 130
 131 void                    g_action_group_activate                         (GActionGroup *action_group,
 132                                                                          const gchar  *action_name,
 133                                                                          GVariant     *parameter);
 134
 135 /* signals */
 136 void                    g_action_group_action_added                     (GActionGroup *action_group,
 137                                                                          const gchar  *action_name);
 138 void                    g_action_group_action_removed                   (GActionGroup *action_group,
 139                                                                          const gchar  *action_name);
 140 void                    g_action_group_action_enabled_changed           (GActionGroup *action_group,
 141                                                                          const gchar  *action_name,
 142                                                                          gboolean      enabled);
 143
 144 void                    g_action_group_action_state_changed             (GActionGroup *action_group,
 145                                                                          const gchar  *action_name,
 146                                                                          GVariant     *state);
 147
 148 G_END_DECLS
 149
 150 #endif /* __G_ACTION_GROUP_H__ */