Accessibility_Registry.idl

Go to the documentation of this file.

/* 
 * AT-SPI - Assistive Technology Service Provider Interface 
 * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
 *
 * Copyright 2001 Sun Microsystems 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 <Bonobo_Unknown.idl>
#include <Accessibility_Event.idl>
#include <Accessibility_Application.idl>
#include <Accessibility_Desktop.idl>

#ifndef _ACCESSIBILITY_REGISTRY_IDL_
#define _ACCESSIBILITY_REGISTRY_IDL_

module Accessibility {

  typedef sequence<Desktop> DesktopSeq;

  interface DeviceEventController;

  interface Registry : EventListener {

        oneway void registerApplication (in Application application);

        void deregisterApplication (in Application application);

        void registerGlobalEventListener (in EventListener listener,
                                          in string eventName);

        void deregisterGlobalEventListenerAll (in EventListener listener);
        void deregisterGlobalEventListener (in EventListener listener, 
                                            in string event_name);
        short getDesktopCount ();

        Desktop getDesktop (in short n);

        DesktopSeq getDesktopList ();

        DeviceEventController getDeviceEventController ();

        void unImplemented ();
        void unImplemented2 ();
        void unImplemented3 ();
        void unImplemented4 ();
        void unImplemented5 ();
        void unImplemented6 ();
    };

  /* Deprecated, DO NOT USE! */
  enum KeyEventType {
    KEY_PRESSED,
    KEY_RELEASED
  };

  enum EventType {
    KEY_PRESSED_EVENT,
    KEY_RELEASED_EVENT,
    BUTTON_PRESSED_EVENT,
    BUTTON_RELEASED_EVENT
  };

  enum KeySynthType {
    KEY_PRESS,
    KEY_RELEASE,
    KEY_PRESSRELEASE,
    KEY_SYM,
    KEY_STRING
  };

  enum ModifierType {
    MODIFIER_SHIFT,
    MODIFIER_SHIFTLOCK,
    MODIFIER_CONTROL,
    MODIFIER_ALT,
    MODIFIER_META,
    MODIFIER_META2,
    MODIFIER_META3,
    MODIFIER_NUMLOCK
  };

  struct EventListenerMode {
    boolean synchronous;
    boolean preemptive;
    boolean global;       
  };

  typedef unsigned long ControllerEventMask;

  struct DeviceEvent {
    EventType type; 
    long  id;
    short hw_code;
    unsigned short modifiers;
    unsigned long timestamp;
    string event_string;
    boolean is_text;
  };

  struct KeyDefinition {
    long keycode;
    long keysym;
    string keystring;
    long unused;
  };    

  typedef sequence< KeyDefinition > KeySet;
  typedef sequence< EventType > KeyEventTypeSeq;
  typedef sequence< EventType > EventTypeSeq;

  interface DeviceEventListener : Bonobo::Unknown {
        boolean notifyEvent (in DeviceEvent event);
        void    unImplemented__ ();
        void    unImplemented_2_ ();
        void    unImplemented_3_ ();
        void    unImplemented_4_ ();
        void    unImplemented_5_ ();
        void    unImplemented_6_ ();
  };

  interface DeviceEventController : Bonobo::Unknown {

        boolean registerKeystrokeListener (in DeviceEventListener listener,
                                        in KeySet keys,
                                        in ControllerEventMask mask,
                                        in KeyEventTypeSeq type,
                                        in EventListenerMode mode);
    
        void deregisterKeystrokeListener (in DeviceEventListener listener,
                                          in KeySet keys,
                                          in ControllerEventMask mask,
                                          in KeyEventTypeSeq type);
    
        boolean registerDeviceEventListener (in DeviceEventListener listener,
                                             in EventTypeSeq typeseq);
    
        void deregisterDeviceEventListener (in DeviceEventListener listener,
                                            in EventTypeSeq typeseq);
    
        boolean notifyListenersSync (in DeviceEvent event);

        oneway void notifyListenersAsync (in DeviceEvent event);

         void generateKeyboardEvent (in long keycode, 
                                     in string keystring, 
                                     in KeySynthType type);

         void generateMouseEvent (in long x, in long y, in string eventName);

         void unImplemented ();
         void unImplemented2 ();
         void unImplemented3 ();
         void unImplemented4 ();
    }; 
};

#endif

---