2004-02-11 Padraig O'Briain <padraig.obriain@sun.com>

[platform/core/uifw/at-spi2-atk.git] / idl / Accessibility_Application.idl

diff --git a/idl/Accessibility_Application.idl b/idl/Accessibility_Application.idl
index 1253bb4..33b4998 100644 (file)
--- a/idl/Accessibility_Application.idl
+++ b/idl/Accessibility_Application.idl
@@ -23,14 +23,25 @@
 #ifndef __ACCESSIBILITY_APPLICATION_DEFINED__
 #define __ACCESSIBILITY_APPLICATION_DEFINED__
 
-#include <Bonobo.idl>
-#include <Accessible.idl>
+#include <Bonobo_Unknown.idl>
+#include <Accessibility_Accessible.idl>
 
 module Accessibility {
+
+  enum LOCALE_TYPE {
+      LOCALE_TYPE_MESSAGES,
+      LOCALE_TYPE_COLLATE,
+      LOCALE_TYPE_CTYPE,
+      LOCALE_TYPE_MONETARY,
+      LOCALE_TYPE_NUMERIC,
+      LOCALE_TYPE_TIME
+  };
+
   interface Application : Accessible {
 
     /**
-     * Get a string indicating the type of user interface toolkit
+     * @toolkitName:
+     * A string indicating the type of user interface toolkit
      * which is used by the application.
      * Ordinarily clients of @AccessibleApplication should be
      * toolkit-agnostic, dependencies on this method probably
@@ -39,36 +50,80 @@ module Accessibility {
     readonly attribute string toolkitName;
 
     /**
-     * Get a string indicating the version number of the application's
+     * @version:
+     * A string indicating the version number of the application's
      * accessibility bridge implementation.
      **/
     readonly attribute string version;
 
     /**
-     * Get the application's process ID in the operating system's 
-     * process table.
+     * @id:
+     * The application instance's unique ID as assigned by the registry.
+     **/
+    attribute long id;
+
+    /**
+     * registerToolkitEventListener:
+     * @listener: an #EventListener object which will receive the requested
+     *            events from the application's toolkits via toolit 'bridges'
+     * @eventName: a UTF-8 string indicating the type of (toolkit-specific) event
+     *            being requested.  Not all applications can generate toolkit events of
+     *            a given type.
+     *
+     * Register with this application's toolkit for "toolkit-specific" event notifications.
+     *       For most event support, clients should use non-toolkit-specific events
+     *       whenever possible, via #Registry::registerGlobalEventListener - this method 
+     *       is provided as a 'back door' when generic names do not exist for the events in question.
+     * SUBJECT TO DEPRECATION in favor of Registry::registerGlobalEventListener forms.
+     *
+     **/
+    void registerToolkitEventListener (in EventListener listener, in string eventName);
+
+    /**
+     * registerObjectEventListener:
+     * @listener: an #EventListener object which will receive the requested
+     *            events
+     * @eventName: a UTF-8 string indicating the type of (toolkit-specific) event
+     *            being requested.  
+     * Register with this application toolkit for "Accessibility::Accessible" 
+     * event notifications. SUBJECT TO DEPRECATION
      *
      **/
-    readonly attribute string id;
+    void registerObjectEventListener (in EventListener listener, in string eventName);
 
     /**
      * pause:
-     * Returns: %true if the request succeeded, %false otherwise.
      *
      * Request that the application temporarily stop sending events.
      * In most cases this should pause the application's main event loop.
      *
+     * Returns: %true if the request succeeded, %false otherwise.
      **/
     boolean       pause ();
 
     /**
      * resume:
-     * Returns: %true if the request succeeded, %false otherwise.
      *
      * Request that the application resume sending events.
      *
+     * Returns: %true if the request succeeded, %false otherwise.
      **/
     boolean       resume ();
+
+     /**
+     * getLocale:
+     *
+     * @lctype: the LocaleType for which the locale is queried.
+     * Gets the locale in which the application is currently operating.
+     * For the current message locale, use @lctype LOCALE_TYPE_MESSAGES.
+     *
+     * Returns: a string compliant with the POSIX standard for locale description.
+     **/
+    string       getLocale (in LOCALE_TYPE lctype);
+
+    void          unImplemented_ ();
+    void          unImplemented2_ ();
+    void          unImplemented3_ ();
   };
 };