atk/atkaction.h

   1 /* ATK -  Accessibility Toolkit
   2  * Copyright 2001 Sun Microsystems Inc.
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Library General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at 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  * Library General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Library General Public
  15  * License along with this library; if not, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 #if defined(ATK_DISABLE_SINGLE_INCLUDES) && !defined (__ATK_H_INSIDE__) && !defined (ATK_COMPILATION)
  19 #error "Only <atk/atk.h> can be included directly."
  20 #endif
  21
  22 #ifndef __ATK_ACTION_H__
  23 #define __ATK_ACTION_H__
  24
  25 #include <atk/atkobject.h>
  26
  27 G_BEGIN_DECLS
  28
  29 /*
  30  * The interface AtkAction should be supported by any object that can
  31  * perform one or more actions. The interface provides the standard
  32  * mechanism for an assistive technology to determine what those actions
  33  * are as well as tell the object to perform them. Any object that can
  34  * be manipulated should support this interface.
  35  */
  36
  37
  38 #define ATK_TYPE_ACTION                    (atk_action_get_type ())
  39 #define ATK_IS_ACTION(obj)                 G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_ACTION)
  40 #define ATK_ACTION(obj)                    G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_ACTION, AtkAction)
  41 #define ATK_ACTION_GET_IFACE(obj)          (G_TYPE_INSTANCE_GET_INTERFACE ((obj), ATK_TYPE_ACTION, AtkActionIface))
  42
  43 #ifndef _TYPEDEF_ATK_ACTION_
  44 #define _TYPEDEF_ATK_ACTION_
  45 typedef struct _AtkAction AtkAction;
  46 #endif
  47 typedef struct _AtkActionIface AtkActionIface;
  48
  49 struct _AtkActionIface
  50 {
  51   GTypeInterface parent;
  52
  53   gboolean                (*do_action)         (AtkAction         *action,
  54                                                 gint              i);
  55   gint                    (*get_n_actions)     (AtkAction         *action);
  56   const gchar*            (*get_description)   (AtkAction         *action,
  57                                                 gint              i);
  58   const gchar*            (*get_name)          (AtkAction         *action,
  59                                                 gint              i);
  60   const gchar*            (*get_keybinding)    (AtkAction         *action,
  61                                                 gint              i);
  62   gboolean                (*set_description)   (AtkAction         *action,
  63                                                 gint              i,
  64                                                 const gchar       *desc);
  65   const gchar*            (*get_localized_name)(AtkAction         *action,
  66                                                 gint              i);
  67 };
  68
  69 GType atk_action_get_type (void);
  70
  71 /*
  72  * These are the function which would be called by an application with
  73  * the argument being a AtkObject object cast to (AtkAction).
  74  *
  75  * The function will just check that * the corresponding
  76  * function pointer is not NULL and will call it.
  77  *
  78  * The "real" implementation of the function for accessible will be
  79  * provided in a support library
  80  */
  81
  82 gboolean   atk_action_do_action                (AtkAction         *action,
  83                                             gint              i);
  84 gint   atk_action_get_n_actions            (AtkAction *action);
  85 const gchar*          atk_action_get_description  (AtkAction         *action,
  86                                                    gint              i);
  87 const gchar*          atk_action_get_name         (AtkAction         *action,
  88                                                    gint              i);
  89 const gchar*          atk_action_get_keybinding   (AtkAction         *action,
  90                                                    gint              i);
  91 gboolean              atk_action_set_description  (AtkAction         *action,
  92                                                    gint              i,
  93                                                    const gchar       *desc);
  94
  95 /* NEW in ATK 1.1: */
  96
  97 const gchar* atk_action_get_localized_name (AtkAction       *action,
  98                                                      gint            i);
  99
 100 /*
 101  * Additional GObject properties exported by AtkAction:
 102  *    "accessible_action"
 103  *       (an accessible action, or the list of actions, has changed)
 104  */
 105
 106 G_END_DECLS
 107
 108 #endif /* __ATK_ACTION_H__ */