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

Accessibility::Selector Interface Reference

This interface is intended for use by assistive technologies and related user-agents. More...

import "Accessibility_Selector.idl";

List of all members.

Public Types

enum  CommandResult {
  COMMAND_RESULT_INVALID,
  COMMAND_RESULT_SUCCESS,
  COMMAND_RESULT_FAILED,
  COMMAND_RESULT_OBSOLETE,
  COMMAND_RESULT_LAST_DEFINED
}
 A code returned by a call to activateCommand, indicating the result of the activation request. More...

Public Member Functions

CommandList getCommands ()
 Query the Selector for the current CommandList.
boolean replaceCommands (in CommandList commands)
boolean refreshCommands ()
 Ask the Selector to re-calculate its CommandList.
CommandResult activateCommand (in Command command)
 Request that the Selector invoke the specified Command.
void registerChangeListener (in CommandListener listener)
 Register a :CommandListener instance for notification of changes to the command set.
void deregisterChangeListener (in CommandListener listener)
 Tell the Selector instance to cease notifying the specified CommandListener of changes to the command list.

Public Attributes

readonly attribute boolean supportsReplace
 This attribute is TRUE if this Selector allows its CommandList to be specified by the client.


Detailed Description

This interface is intended for use by assistive technologies and related user-agents.

Via this interface, an assistive technology or user agent may expose a series of choices or selections in textual form, which can be activated on demand by a client of the Selector interface.

Examples of the use of this interface include voice-command and remote-control applications, in which the user interaction is wholly or partly delegated by the implementor to an external agent.

Since:
AT-SPI 1.7.0

Definition at line 68 of file Accessibility_Selector.idl.


Member Enumeration Documentation

enum Accessibility::Selector::CommandResult
 

A code returned by a call to activateCommand, indicating the result of the activation request.

Enumerator:
COMMAND_RESULT_INVALID  The command was invalid or ill-formed; usually indicates an error condition.
COMMAND_RESULT_SUCCESS  The command was successfully activated.
COMMAND_RESULT_FAILED  The command was valid, but could not be activated.

This may be due to problems with permissions or error conditions.

COMMAND_RESULT_OBSOLETE  The command is no longer valid in the current program context.

This may mean that the application has changed state in such a way that the specified command it no longer applicable, or because changes to the application state have rendered it ambiguous. Commands should be re-fetched and a new selection made.

COMMAND_RESULT_LAST_DEFINED  Defines size of enumeration; do not use this value as a parameter.

Definition at line 74 of file Accessibility_Selector.idl.


Member Function Documentation

CommandList Accessibility::Selector::getCommands  ) 
 

Query the Selector for the current CommandList.

Returns:
the currently available CommandList

boolean Accessibility::Selector::replaceCommands in CommandList  commands  ) 
 

Returns:
TRUE if the replacement request was successful, FALSE if the request could not be honored.

boolean Accessibility::Selector::refreshCommands  ) 
 

Ask the Selector to re-calculate its CommandList.

Note:
in most cases the Selector will continuously update its CommandList without recourse to this call. This call is equivalent to getCommands, except that after refreshCommands the new CommandList will be returned via any registered CommandListener instances rather than synchronously via this call.
Returns:
TRUE if the CommandList changed.

CommandResult Accessibility::Selector::activateCommand in Command  command  ) 
 

Request that the Selector invoke the specified Command.

Parameters:
command the Command to activate/invoke.
Returns:
a CommandResult indicating whether the request was honored, and the reason for failure if the Command could not be activated or invoked.

void Accessibility::Selector::registerChangeListener in CommandListener  listener  ) 
 

Register a :CommandListener instance for notification of changes to the command set.

Parameters:
listener the CommandListener to be notified of changes.

void Accessibility::Selector::deregisterChangeListener in CommandListener  listener  ) 
 

Tell the Selector instance to cease notifying the specified CommandListener of changes to the command list.

Parameters:
listener the CommandListener to remove from the notification list.


Member Data Documentation

readonly attribute boolean Accessibility::Selector::supportsReplace
 

This attribute is TRUE if this Selector allows its CommandList to be specified by the client.

Definition at line 93 of file Accessibility_Selector.idl.


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