Main Page   Namespace List   Class Hierarchy   Data Structures   File List   Namespace Members   Data Fields  

Accessibility::Registry Interface Reference

import "Accessibility_Registry.idl";

Inheritance diagram for Accessibility::Registry:

Accessibility::EventListener

Public Methods

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 eventName)
short getDesktopCount ()
Desktop getDesktop (in short n)
DesktopSeq getDesktopList ()
DeviceEventController getDeviceEventController ()
void unImplemented ()
void unImplemented2 ()
void unImplemented3 ()
void unImplemented4 ()
void unImplemented5 ()
void unImplemented6 ()

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


Member Function Documentation

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::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.

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.

Desktop Accessibility::Registry::getDesktop in short    n
 

getDesktop: @n: the index of the requested Desktop.

Get the nth accessible desktop.

Returns :
a reference to the requested Desktop.

short Accessibility::Registry::getDesktopCount  
 

getDesktopCount:

Get the current number of desktops.

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

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

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::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::unImplemented  
 

\cond unImplemented:

placeholders for future expansion.

void Accessibility::Registry::unImplemented2  
 

void Accessibility::Registry::unImplemented3  
 

void Accessibility::Registry::unImplemented4  
 

void Accessibility::Registry::unImplemented5  
 

void Accessibility::Registry::unImplemented6  
 


The documentation for this interface was generated from the following file:
Generated on Thu Mar 23 17:40:30 2006 for at-spi-idl by doxygen1.2.17