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