gecko-dev/accessible/interfaces/nsIAccessibleRetrieval.idl
Birunthan Mohanathas 3111e08278 Bug 1028563 - Part 2: Rename accessible/{public => interfaces}/. rs=surkov
--HG--
rename : accessible/public/ia2/IA2Marshal.def => accessible/interfaces/ia2/IA2Marshal.def
rename : accessible/public/ia2/Makefile.in => accessible/interfaces/ia2/Makefile.in
rename : accessible/public/ia2/moz.build => accessible/interfaces/ia2/moz.build
rename : accessible/public/moz.build => accessible/interfaces/moz.build
rename : accessible/public/msaa/AccessibleMarshal.def => accessible/interfaces/msaa/AccessibleMarshal.def
rename : accessible/public/msaa/ISimpleDOMDocument.idl => accessible/interfaces/msaa/ISimpleDOMDocument.idl
rename : accessible/public/msaa/ISimpleDOMNode.idl => accessible/interfaces/msaa/ISimpleDOMNode.idl
rename : accessible/public/msaa/ISimpleDOMText.idl => accessible/interfaces/msaa/ISimpleDOMText.idl
rename : accessible/public/msaa/Makefile.in => accessible/interfaces/msaa/Makefile.in
rename : accessible/public/msaa/moz.build => accessible/interfaces/msaa/moz.build
rename : accessible/public/nsIAccessibilityService.h => accessible/interfaces/nsIAccessibilityService.h
rename : accessible/public/nsIAccessible.idl => accessible/interfaces/nsIAccessible.idl
rename : accessible/public/nsIAccessibleApplication.idl => accessible/interfaces/nsIAccessibleApplication.idl
rename : accessible/public/nsIAccessibleCaretMoveEvent.idl => accessible/interfaces/nsIAccessibleCaretMoveEvent.idl
rename : accessible/public/nsIAccessibleDocument.idl => accessible/interfaces/nsIAccessibleDocument.idl
rename : accessible/public/nsIAccessibleEditableText.idl => accessible/interfaces/nsIAccessibleEditableText.idl
rename : accessible/public/nsIAccessibleEvent.idl => accessible/interfaces/nsIAccessibleEvent.idl
rename : accessible/public/nsIAccessibleHideEvent.idl => accessible/interfaces/nsIAccessibleHideEvent.idl
rename : accessible/public/nsIAccessibleHyperLink.idl => accessible/interfaces/nsIAccessibleHyperLink.idl
rename : accessible/public/nsIAccessibleHyperText.idl => accessible/interfaces/nsIAccessibleHyperText.idl
rename : accessible/public/nsIAccessibleImage.idl => accessible/interfaces/nsIAccessibleImage.idl
rename : accessible/public/nsIAccessiblePivot.idl => accessible/interfaces/nsIAccessiblePivot.idl
rename : accessible/public/nsIAccessibleRelation.idl => accessible/interfaces/nsIAccessibleRelation.idl
rename : accessible/public/nsIAccessibleRetrieval.idl => accessible/interfaces/nsIAccessibleRetrieval.idl
rename : accessible/public/nsIAccessibleRole.idl => accessible/interfaces/nsIAccessibleRole.idl
rename : accessible/public/nsIAccessibleSelectable.idl => accessible/interfaces/nsIAccessibleSelectable.idl
rename : accessible/public/nsIAccessibleStateChangeEvent.idl => accessible/interfaces/nsIAccessibleStateChangeEvent.idl
rename : accessible/public/nsIAccessibleStates.idl => accessible/interfaces/nsIAccessibleStates.idl
rename : accessible/public/nsIAccessibleTable.idl => accessible/interfaces/nsIAccessibleTable.idl
rename : accessible/public/nsIAccessibleTableChangeEvent.idl => accessible/interfaces/nsIAccessibleTableChangeEvent.idl
rename : accessible/public/nsIAccessibleText.idl => accessible/interfaces/nsIAccessibleText.idl
rename : accessible/public/nsIAccessibleTextChangeEvent.idl => accessible/interfaces/nsIAccessibleTextChangeEvent.idl
rename : accessible/public/nsIAccessibleTextRange.idl => accessible/interfaces/nsIAccessibleTextRange.idl
rename : accessible/public/nsIAccessibleTypes.idl => accessible/interfaces/nsIAccessibleTypes.idl
rename : accessible/public/nsIAccessibleValue.idl => accessible/interfaces/nsIAccessibleValue.idl
rename : accessible/public/nsIAccessibleVirtualCursorChangeEvent.idl => accessible/interfaces/nsIAccessibleVirtualCursorChangeEvent.idl
rename : accessible/public/nsIXBLAccessible.idl => accessible/interfaces/nsIXBLAccessible.idl
2014-06-22 10:16:39 -07:00

112 lines
3.4 KiB
Plaintext

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#include "nsISupports.idl"
interface nsIDOMNode;
interface nsIAccessible;
interface nsIWeakReference;
interface nsIPresShell;
interface nsIDOMWindow;
interface nsIAccessiblePivot;
/**
* An interface for in-process accessibility clients wishing to get an
* nsIAccessible for a given DOM node. More documentation at:
* http://www.mozilla.org/projects/ui/accessibility
*/
[scriptable, uuid(17f86615-1a3d-4021-b227-3a2ef5cbffd8)]
interface nsIAccessibleRetrieval : nsISupports
{
/**
* Return application accessible.
*/
nsIAccessible getApplicationAccessible();
/**
* Return an nsIAccessible for a DOM node in pres shell 0.
* Create a new accessible of the appropriate type if necessary,
* or use one from the accessibility cache if it already exists.
* @param aNode The DOM node to get an accessible for.
* @return The nsIAccessible for the given DOM node.
*/
nsIAccessible getAccessibleFor(in nsIDOMNode aNode);
/**
* Returns accessible role as a string.
*
* @param aRole - the accessible role constants.
*/
AString getStringRole(in unsigned long aRole);
/**
* Returns list which contains accessible states as a strings.
*
* @param aStates - accessible states.
* @param aExtraStates - accessible extra states.
*/
nsISupports getStringStates(in unsigned long aStates,
in unsigned long aExtraStates);
/**
* Get the type of accessible event as a string.
*
* @param aEventType - the accessible event type constant
* @return - accessible event type presented as human readable string
*/
AString getStringEventType(in unsigned long aEventType);
/**
* Get the type of accessible relation as a string.
*
* @param aRelationType - the accessible relation type constant
* @return - accessible relation type presented as human readable string
*/
AString getStringRelationType(in unsigned long aRelationType);
/**
* Return an accessible for the given DOM node from the cache.
* @note the method is intended for testing purposes
*
* @param aNode [in] the DOM node to get an accessible for
*
* @return cached accessible for the given DOM node if any
*/
nsIAccessible getAccessibleFromCache(in nsIDOMNode aNode);
/**
* Create a new pivot for tracking a position and traversing a subtree.
*
* @param aRoot [in] the accessible root for the pivot
* @return a new pivot
*/
nsIAccessiblePivot createAccessiblePivot(in nsIAccessible aRoot);
/**
* Enable logging for the given modules, all other modules aren't logged.
*
* @param aModules [in] list of modules, format is comma separated list
* like 'docload,doccreate'.
* @note Works on debug build only.
* @see Logging.cpp for list of possible values.
*/
void setLogging(in ACString aModules);
/**
* Return true if the given module is logged.
*/
boolean isLogged(in AString aModule);
};
%{ C++
// for component registration
// {663CA4A8-D219-4000-925D-D8F66406B626}
#define NS_ACCESSIBLE_RETRIEVAL_CID \
{ 0x663ca4a8, 0xd219, 0x4000, { 0x92, 0x5d, 0xd8, 0xf6, 0x64, 0x6, 0xb6, 0x26 } }
%}