atk-1.0/atk/atkaction.h

0001 /* ATK -  Accessibility Toolkit
0002  * Copyright 2001 Sun Microsystems Inc.
0003  *
0004  * This library is free software; you can redistribute it and/or
0005  * modify it under the terms of the GNU Library General Public
0006  * License as published by the Free Software Foundation; either
0007  * version 2 of the License, or (at your option) any later version.
0008  *
0009  * This library is distributed in the hope that it will be useful,
0010  * but WITHOUT ANY WARRANTY; without even the implied warranty of
0011  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
0012  * Library General Public License for more details.
0013  *
0014  * You should have received a copy of the GNU Library General Public
0015  * License along with this library; if not, write to the
0016  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
0017  * Boston, MA 02111-1307, USA.
0018  */
0019
0020 #ifndef __ATK_ACTION_H__
0021 #define __ATK_ACTION_H__
0022
0023 #if defined(ATK_DISABLE_SINGLE_INCLUDES) && !defined(__ATK_H_INSIDE__) && !defined(ATK_COMPILATION)
0024 #error "Only <atk/atk.h> can be included directly."
0025 #endif
0026
0027 #include <atk/atkobject.h>
0028
0029 G_BEGIN_DECLS
0030
0031 /*
0032  */
0033
0034 #define ATK_TYPE_ACTION (atk_action_get_type ())
0035 #define ATK_IS_ACTION(obj) G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_ACTION)
0036 #define ATK_ACTION(obj) G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_ACTION, AtkAction)
0037 #define ATK_ACTION_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), ATK_TYPE_ACTION, AtkActionIface))
0038
0039 #ifndef _TYPEDEF_ATK_ACTION_
0040 #define _TYPEDEF_ATK_ACTION_
0041 typedef struct _AtkAction AtkAction;
0042 #endif
0043 typedef struct _AtkActionIface AtkActionIface;
0044
0045 /**
0046  * AtkActionIface:
0047  * @do_action:
0048  * @get_n_actions:
0049  * @get_description:
0050  * @get_name:
0051  * @get_keybinding:
0052  * @set_description:
0053  * @get_localized_name:
0054  *
0055  * The #AtkAction interface should be supported by any object that can
0056  * perform one or more actions. The interface provides the standard
0057  * mechanism for an assistive technology to determine what those actions
0058  * are as well as tell the object to perform them. Any object that can
0059  * be manipulated should support this interface.
0060  */
0061 struct _AtkActionIface
0062 {
0063   /*< private >*/
0064   GTypeInterface parent;
0065
0066   /*< public >*/
0067   gboolean (*do_action) (AtkAction *action,
0068                          gint i);
0069   gint (*get_n_actions) (AtkAction *action);
0070   const gchar *(*get_description) (AtkAction *action,
0071                                    gint i);
0072   const gchar *(*get_name) (AtkAction *action,
0073                             gint i);
0074   const gchar *(*get_keybinding) (AtkAction *action,
0075                                   gint i);
0076   gboolean (*set_description) (AtkAction *action,
0077                                gint i,
0078                                const gchar *desc);
0079   const gchar *(*get_localized_name) (AtkAction *action,
0080                                       gint i);
0081 };
0082
0083 ATK_AVAILABLE_IN_ALL
0084 GType atk_action_get_type (void);
0085
0086 /*
0087  * These are the function which would be called by an application with
0088  * the argument being a AtkObject object cast to (AtkAction).
0089  *
0090  * The function will just check that * the corresponding
0091  * function pointer is not NULL and will call it.
0092  *
0093  * The "real" implementation of the function for accessible will be
0094  * provided in a support library
0095  */
0096
0097 ATK_AVAILABLE_IN_ALL
0098 gboolean atk_action_do_action (AtkAction *action,
0099                                gint i);
0100 ATK_AVAILABLE_IN_ALL
0101 gint atk_action_get_n_actions (AtkAction *action);
0102 ATK_AVAILABLE_IN_ALL
0103 const gchar *atk_action_get_description (AtkAction *action,
0104                                          gint i);
0105 ATK_AVAILABLE_IN_ALL
0106 const gchar *atk_action_get_name (AtkAction *action,
0107                                   gint i);
0108 ATK_AVAILABLE_IN_ALL
0109 const gchar *atk_action_get_keybinding (AtkAction *action,
0110                                         gint i);
0111 ATK_AVAILABLE_IN_ALL
0112 gboolean atk_action_set_description (AtkAction *action,
0113                                      gint i,
0114                                      const gchar *desc);
0115
0116 /* NEW in ATK 1.1: */
0117 ATK_AVAILABLE_IN_ALL
0118 const gchar *atk_action_get_localized_name (AtkAction *action,
0119                                             gint i);
0120
0121 /*
0122  * Additional GObject properties exported by AtkAction:
0123  *    "accessible_action"
0124  *       (an accessible action, or the list of actions, has changed)
0125  */
0126
0127 G_END_DECLS
0128
0129 #endif /* __ATK_ACTION_H__ */