Struct xpcom::interfaces::nsIAccessibilityService [] [src]

#[repr(C)]
pub struct nsIAccessibilityService { /* fields omitted */ }

interface nsIAccessibilityService : nsISupports

/**
 * 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
 */

Methods

impl nsIAccessibilityService
[src]

[src]

Cast this nsIAccessibilityService to one of its base interfaces.

impl nsIAccessibilityService
[src]

[src]

/**
   * Return application accessible.
   */

nsIAccessible getApplicationAccessible ();

[src]

/**
   * 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);

[src]

/**
    * Returns accessible role as a string.
    *
    * @param aRole - the accessible role constants.
    */

AString getStringRole (in unsigned long aRole);

[src]

/**
    * 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);

[src]

/**
   * 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);

[src]

/**
   * 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);

[src]

/**
   * 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);

[src]

/**
   * 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);

[src]

/**
   * 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);

[src]

/**
   * Return true if the given module is logged.
   */

boolean isLogged (in AString aModule);

[src]

/**
   * Get the current accessibility service consumers.
   * @returns a JSON string representing the accessibility service consumers.
   */

AString getConsumers ();

Methods from Deref<Target = nsISupports>

[src]

Cast this nsISupports to one of its base interfaces.

[src]

void QueryInterface (in nsIIDRef uuid, [iid_is (uuid), retval] out nsQIResult result);

[src]

[noscript,notxpcom] nsrefcnt AddRef ();

[src]

[noscript,notxpcom] nsrefcnt Release ();

Trait Implementations

impl XpCom for nsIAccessibilityService
[src]

IID: nsIID = nsID(562619296, 51342, 4583, [143, 26, 8, 0, 32, 12, 154, 102])

[src]

Perform a QueryInterface call on this object, attempting to dynamically cast it to the requested interface type. Returns Some(RefPtr) if the cast succeeded, and None otherwise. Read more

impl RefCounted for nsIAccessibilityService
[src]

[src]

Increment the reference count.

[src]

Decrement the reference count, potentially freeing backing memory.

impl Deref for nsIAccessibilityService
[src]

The resulting type after dereferencing.

[src]

Dereferences the value.