gio/gaction.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_H__
  27 #define __G_ACTION_H__
  28
  29 #include <gio/giotypes.h>
  30
  31 G_BEGIN_DECLS
  32
  33 #define G_TYPE_ACTION                                       (g_action_get_type ())
  34 #define G_ACTION(inst)                                      (G_TYPE_CHECK_INSTANCE_CAST ((inst),                     \
  35                                                              G_TYPE_ACTION, GAction))
  36 #define G_IS_ACTION(inst)                                   (G_TYPE_CHECK_INSTANCE_TYPE ((inst), G_TYPE_ACTION))
  37 #define G_ACTION_GET_IFACE(inst)                            (G_TYPE_INSTANCE_GET_INTERFACE ((inst),                  \
  38                                                              G_TYPE_ACTION, GActionInterface))
  39
  40 typedef struct _GActionInterface                            GActionInterface;
  41
  42 /**
  43  * GActionInterface:
  44  * @get_name: the virtual function pointer for g_action_get_name()
  45  * @get_parameter_type: the virtual function pointer for g_action_get_parameter_type()
  46  * @get_state_type: the virtual function pointer for g_action_get_state_type()
  47  * @get_state_hint: the virtual function pointer for g_action_get_state_hint()
  48  * @get_enabled: the virtual function pointer for g_action_get_enabled()
  49  * @get_state: the virtual function pointer for g_action_get_state()
  50  * @change_state: the virtual function pointer for g_action_change_state()
  51  * @activate: the virtual function pointer for g_action_activate().  Note that #GAction does not have an
  52  *            'activate' signal but that implementations of it may have one.
  53  *
  54  * Since: 2.28
  55  */
  56 struct _GActionInterface
  57 {
  58   GTypeInterface g_iface;
  59
  60   /* virtual functions */
  61   const gchar *        (* get_name)             (GAction  *action);
  62   const GVariantType * (* get_parameter_type)   (GAction  *action);
  63   const GVariantType * (* get_state_type)       (GAction  *action);
  64   GVariant *           (* get_state_hint)       (GAction  *action);
  65
  66   gboolean             (* get_enabled)          (GAction  *action);
  67   GVariant *           (* get_state)            (GAction  *action);
  68
  69   void                 (* change_state)         (GAction  *action,
  70                                                  GVariant *value);
  71   void                 (* activate)             (GAction  *action,
  72                                                  GVariant *parameter);
  73 };
  74
  75 GType                   g_action_get_type                               (void) G_GNUC_CONST;
  76
  77 const gchar *           g_action_get_name                               (GAction            *action);
  78 const GVariantType *    g_action_get_parameter_type                     (GAction            *action);
  79 const GVariantType *    g_action_get_state_type                         (GAction            *action);
  80 GVariant *              g_action_get_state_hint                         (GAction            *action);
  81
  82 gboolean                g_action_get_enabled                            (GAction            *action);
  83 GVariant *              g_action_get_state                              (GAction            *action);
  84
  85 void                    g_action_change_state                           (GAction            *action,
  86                                                                          GVariant           *value);
  87 void                    g_action_activate                               (GAction            *action,
  88                                                                          GVariant           *parameter);
  89 G_END_DECLS
  90
  91 #endif /* __G_ACTION_H__ */