Main Page | Namespace List | Class Hierarchy | Class List | File List | Namespace Members | Class Members | File Members

Accessibility::Registry Interface Reference

The Registry is a service through which applications providing accessibility services (servers) can rendezvous with consumers of those services (Assistive Technologies). More...

import "Accessibility_Registry.idl";

Inheritance diagram for Accessibility::Registry:

Accessibility::EventListener List of all members.

Public Member Functions

oneway void registerApplication (in Application application)
 Register a new application with the accessibility broker.
void deregisterApplication (in Application application)
 De-register an application previously registered with the broker.
void registerGlobalEventListener (in EventListener listener, in string eventName)
 Register a client's interest in (all) application events of a certain type.
void deregisterGlobalEventListenerAll (in EventListener listener)
 deregisterGlobalEventListenerAll:
void deregisterGlobalEventListener (in EventListener listener, in string eventName)
 deregisterGlobalEventListener:
short getDesktopCount ()
 getDesktopCount:
Desktop getDesktop (in short n)
 getDesktop:
: the index of the requested Desktop.
DesktopSeq getDesktopList ()
 Get a list of accessible desktops.
DeviceEventController getDeviceEventController ()
 Obtain an object which can be used to request device event notifications.

Detailed Description

The Registry is a service through which applications providing accessibility services (servers) can rendezvous with consumers of those services (Assistive Technologies).

The Registry is the first "port of call" for accessible applications and for assistive technologies wishing to query and interact with those applications.

The Registry service provides four basic functions to Assistive Technology (AT) clients:

From the point of view of accessible applications (i.e. AT-SPI service producers), the Registry is primarily a registration and event delivery service. Applications normally only call the registerApplication and deregisterApplication Registry methods, and its inherited EventListener::notifyEvent method.

Note:
Although all application events are dispatched via the Registry, other AT client calls are serviced directly by the applications, rather than being relayed via the Registry. The AT client obtains references to these application objects via the enumeration of Desktop instances whose children are Application instances (Registry::getDesktopList) and via examination of the 'source' member of the Event structure.
The Registry normally lives in its own process space; communication via Registry and both application services and AT clients takes place via IPC. A process space diagram illustrating the relationship between applications, Registry, and AT is shown below.
SPIBlockDiagram.png

See also:
Desktop, Application, Event, EventListener

Definition at line 74 of file Accessibility_Registry.idl.


Member Function Documentation

oneway void Accessibility::Registry::registerApplication in Application  application  ) 
 

Register a new application with the accessibility broker.

Parameters:
application,: a reference to the requesting Application

void Accessibility::Registry::deregisterApplication in Application  application  ) 
 

De-register an application previously registered with the broker.

deregisterApplication:

Parameters:
application,: a reference to the Application to be deregistered.

void Accessibility::Registry::registerGlobalEventListener in EventListener  listener,
in string  eventName
 

Register a client's interest in (all) application events of a certain type.

Parameters:
listener,: a reference to the requesting EventListener.
eventName,: a string which indicates the type of events about which the client desires notification.

void Accessibility::Registry::deregisterGlobalEventListenerAll in EventListener  listener  ) 
 

deregisterGlobalEventListenerAll:

Parameters:
listener,: the requesting EventListener
Request that a previously registered client stop receiving global notifications for all events for which it was registered.

void Accessibility::Registry::deregisterGlobalEventListener in EventListener  listener,
in string  eventName
 

deregisterGlobalEventListener:

Parameters:
listener,: the requesting EventListener
eventName,: a string indicating the type of events
Request that a previously registered client stop receiving global notifications for events of a certain type.

short Accessibility::Registry::getDesktopCount  ) 
 

getDesktopCount:

Get the current number of desktops.

Returns:
a short integer indicating the current number of Desktops.

Desktop Accessibility::Registry::getDesktop in short  n  ) 
 

getDesktop:
: the index of the requested Desktop.

Get the nth accessible desktop.

Returns:
a reference to the requested Desktop.

DesktopSeq Accessibility::Registry::getDesktopList  ) 
 

Get a list of accessible desktops.

Returns:
: a sequence containing references to the Desktops.

DeviceEventController Accessibility::Registry::getDeviceEventController  ) 
 

Obtain an object which can be used to request device event notifications.

Returns:
: an object implementing DeviceEventController


The documentation for this interface was generated from the following file:
Generated on Fri Dec 2 15:20:46 2005 for AT_SPI_IDL by  doxygen 1.4.3