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 #define G_TYPE_ACTION_GROUP                                 (g_action_group_get_type ())
  42 #define G_ACTION_GROUP(inst)                                (G_TYPE_CHECK_INSTANCE_CAST ((inst),                     \
  43                                                              G_TYPE_ACTION_GROUP, GActionGroup))
  44 #define G_IS_ACTION_GROUP(inst)                             (G_TYPE_CHECK_INSTANCE_TYPE ((inst),                     \
  45                                                              G_TYPE_ACTION_GROUP))
  46 #define G_ACTION_GROUP_GET_IFACE(inst)                      (G_TYPE_INSTANCE_GET_INTERFACE ((inst),                  \
  47                                                              G_TYPE_ACTION_GROUP, GActionGroupInterface))
  48
  49 typedef struct _GContextActionGroupInterface                GContextActionGroupInterface;
  50 typedef struct _GActionGroupInterface                       GActionGroupInterface;
  51
  52 /**
  53  * GActionGroupInterface:
  54  * @has_action: the virtual function pointer for g_action_group_has_action()
  55  * @list_actions: the virtual function pointer for g_action_group_list_actions()
  56  * @get_parameter_type: the virtual function pointer for g_action_group_get_parameter_type()
  57  * @get_state_type: the virtual function pointer for g_action_group_get_state_type()
  58  * @get_state_hint: the virtual function pointer for g_action_group_get_state_hint()
  59  * @get_enabled: the virtual function pointer for g_action_group_get_enabled()
  60  * @get_state: the virtual function pointer for g_action_group_get_state()
  61  * @set_state: the virtual function pointer for g_action_group_set_state()
  62  * @activate: the virtual function pointer for g_action_group_activate()
  63  * @action_added: the class closure for the action-added signal
  64  * @action_removed: the class closure for the action-removed signal
  65  * @action_enabled_changed: the class closure for the action-enabled-changed signal
  66  * @action_state_changed: the class closure for the action-enabled-changed signal
  67  *
  68  * The virtual function table for #GActionGroup.
  69  *
  70  * Since: 2.26
  71  */
  72 struct _GActionGroupInterface
  73 {
  74   GTypeInterface g_iface;
  75
  76   /* virtual functions */
  77   gboolean              (* has_action)                 (GActionGroup  *action_group,
  78                                                         const gchar   *action_name);
  79
  80   gchar **              (* list_actions)               (GActionGroup  *action_group);
  81
  82   gboolean              (* get_action_enabled)         (GActionGroup  *action_group,
  83                                                         const gchar   *action_name);
  84
  85   const GVariantType *  (* get_action_parameter_type)  (GActionGroup  *action_group,
  86                                                         const gchar   *action_name);
  87
  88   const GVariantType *  (* get_action_state_type)      (GActionGroup  *action_group,
  89                                                         const gchar   *action_name);
  90
  91   GVariant *            (* get_action_state_hint)      (GActionGroup  *action_group,
  92                                                         const gchar   *action_name);
  93
  94   GVariant *            (* get_action_state)           (GActionGroup  *action_group,
  95                                                         const gchar   *action_name);
  96
  97   void                  (* change_action_state)        (GActionGroup  *action_group,
  98                                                         const gchar   *action_name,
  99                                                         GVariant      *value);
 100
 101   void                  (* activate_action)            (GActionGroup  *action_group,
 102                                                         const gchar   *action_name,
 103                                                         GVariant      *parameter);
 104
 105   /* signals */
 106   void                  (* action_added)               (GActionGroup  *action_group,
 107                                                         const gchar   *action_name);
 108   void                  (* action_removed)             (GActionGroup  *action_group,
 109                                                         const gchar   *action_name);
 110   void                  (* action_enabled_changed)     (GActionGroup  *action_group,
 111                                                         const gchar   *action_name,
 112                                                         gboolean       enabled);
 113   void                  (* action_state_changed)       (GActionGroup   *action_group,
 114                                                         const gchar    *action_name,
 115                                                         GVariant       *value);
 116 };
 117
 118 struct _GContextActionGroupInterface
 119 {
 120   void                  (* change_action_state)        (GActionGroup  *action_group,
 121                                                         const gchar   *action_name,
 122                                                         GVariant      *value,
 123                                                         GVariant      *context);
 124
 125   void                  (* activate_action)            (GActionGroup  *action_group,
 126                                                         const gchar   *action_name,
 127                                                         GVariant      *parameter,
 128                                                         GVariant      *context);
 129 };
 130
 131
 132 GType                   g_action_group_get_type                         (void) G_GNUC_CONST;
 133
 134 gboolean                g_action_group_has_action                       (GActionGroup *action_group,
 135                                                                          const gchar  *action_name);
 136 gchar **                g_action_group_list_actions                     (GActionGroup *action_group);
 137
 138 const GVariantType *    g_action_group_get_action_parameter_type        (GActionGroup *action_group,
 139                                                                          const gchar  *action_name);
 140 const GVariantType *    g_action_group_get_action_state_type            (GActionGroup *action_group,
 141                                                                          const gchar  *action_name);
 142 GVariant *              g_action_group_get_action_state_hint            (GActionGroup *action_group,
 143                                                                          const gchar  *action_name);
 144
 145 gboolean                g_action_group_get_action_enabled               (GActionGroup *action_group,
 146                                                                          const gchar  *action_name);
 147
 148 GVariant *              g_action_group_get_action_state                 (GActionGroup *action_group,
 149                                                                          const gchar  *action_name);
 150 void                    g_action_group_change_action_state              (GActionGroup *action_group,
 151                                                                          const gchar  *action_name,
 152                                                                          GVariant     *value);
 153
 154 void                    g_action_group_activate_action                  (GActionGroup *action_group,
 155                                                                          const gchar  *action_name,
 156                                                                          GVariant     *parameter);
 157
 158 /* signals */
 159 void                    g_action_group_action_added                     (GActionGroup *action_group,
 160                                                                          const gchar  *action_name);
 161 void                    g_action_group_action_removed                   (GActionGroup *action_group,
 162                                                                          const gchar  *action_name);
 163 void                    g_action_group_action_enabled_changed           (GActionGroup *action_group,
 164                                                                          const gchar  *action_name,
 165                                                                          gboolean      enabled);
 166
 167 void                    g_action_group_action_state_changed             (GActionGroup *action_group,
 168                                                                          const gchar  *action_name,
 169                                                                          GVariant     *state);
 170
 171 G_END_DECLS
 172
 173 #endif /* __G_ACTION_GROUP_H__ */