Revved to 1.7.4; Fixes for cspi event handlers for EventDetails.

[platform/core/uifw/at-spi2-atk.git] / cspi / spi_action.c

diff --git a/cspi/spi_action.c b/cspi/spi_action.c
index 4a5fa29..adfd1d1 100644 (file)
--- a/cspi/spi_action.c
+++ b/cspi/spi_action.c
@@ -1,3 +1,26 @@
+/*
+ * AT-SPI - Assistive Technology Service Provider Interface
+ * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
+ *
+ * Copyright 2001, 2002 Sun Microsystems Inc.,
+ * Copyright 2001, 2002 Ximian, Inc.
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Library General Public
+ * License as published by the Free Software Foundation; either
+ * version 2 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Library General Public License for more details.
+ *
+ * You should have received a copy of the GNU Library General Public
+ * License along with this library; if not, write to the
+ * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+ * Boston, MA 02111-1307, USA.
+ */
+
 #include <cspi/spi-private.h>
 
 /**
@@ -66,7 +89,7 @@ AccessibleAction_getDescription (AccessibleAction *obj,
 
   retval =
     Accessibility_Action_getDescription (CSPI_OBJREF (obj),
-                                        (CORBA_long) i,
+                                        i,
                                         cspi_ev ());
 
   cspi_return_val_if_ev ("getDescription", NULL);
@@ -81,6 +104,25 @@ AccessibleAction_getDescription (AccessibleAction *obj,
  *
  * Get the keybindings for the @i-th action invokable on an
  *      object implementing #AccessibleAction, if any are defined.
+ *      The keybindings string format is as follows:
+ *        there are multiple parts to a keybinding string (typically 3).
+ *        They are delimited with ";".  The first is the action's
+ *        keybinding which is usable if the object implementing the action
+ *        is currently posted to the screen, e.g. if a menu is posted 
+ *        then these keybindings for the corresponding menu-items are
+ *        available.  The second keybinding substring is the full key sequence
+ *        necessary to post the action's widget and activate it, e.g. for
+ *        a menu item such as "File->Open" it would both post the menu and
+ *        activate the item.  Thus the second keybinding string is available
+ *        during the lifetime of the containing toplevel window as a whole,
+ *        whereas the first keybinding string only works while the object
+ *        implementing AtkAction is posted.  The third (and optional)
+ *        keybinding string is the "keyboard shortcut" which invokes the 
+ *        action without posting any menus. 
+ *        Meta-keys are indicated by the conventional strings
+ *        "<Control>", "<Alt>", "<Shift>", "<Mod2>",
+ *        etc. (we use the same string as gtk_accelerator_name() in 
+ *        gtk+-2.X.
  *
  * Returns: a UTF-8 string which can be parsed to determine the @i-th
  *       invokable action's keybindings.
@@ -95,7 +137,7 @@ AccessibleAction_getKeyBinding (AccessibleAction *obj,
 
   retval =
     Accessibility_Action_getKeyBinding (CSPI_OBJREF (obj),
-       (CORBA_long) i,
+       i,
        cspi_ev ());
 
   cspi_return_val_if_ev ("getKeyBinding", NULL);
@@ -123,7 +165,7 @@ AccessibleAction_getName (AccessibleAction *obj,
 
   retval =
    Accessibility_Action_getName (CSPI_OBJREF (obj),
-                                (CORBA_long) i,
+                                i,
                                 cspi_ev ());
 
   cspi_return_val_if_ev ("getName", NULL);
@@ -148,9 +190,8 @@ AccessibleAction_doAction (AccessibleAction *obj,
 
   cspi_return_val_if_fail (obj != NULL, FALSE);
 
-  retval = (SPIBoolean)
-    Accessibility_Action_doAction (CSPI_OBJREF (obj),
-                                  (CORBA_long) i,
+  retval = Accessibility_Action_doAction (CSPI_OBJREF (obj),
+                                  i,
                                   cspi_ev ());
 
   cspi_return_val_if_ev ("doAction", FALSE);