accessible/public/nsPIAccessibleDocument.idl

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is mozilla.org code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 2003
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Original Author: Aaron Leventhal (aaronl@netscape.com)
  23  * Contributor(s):
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either the GNU General Public License Version 2 or later (the "GPL"), or
  27  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28  * in which case the provisions of the GPL or the LGPL are applicable instead
  29  * of those above. If you wish to allow use of your version of this file only
  30  * under the terms of either the GPL or the LGPL, and not to allow others to
  31  * use your version of this file under the terms of the MPL, indicate your
  32  * decision by deleting the provisions above and replace them with the notice
  33  * and other provisions required by the GPL or the LGPL. If you do not delete
  34  * the provisions above, a recipient may use your version of this file under
  35  * the terms of any one of the MPL, the GPL or the LGPL.
  36  *
  37  * ***** END LICENSE BLOCK ***** */
  38
  39 #include "nsISupports.idl"
  40
  41 interface nsIAccessNode;
  42 interface nsIContent;
  43
  44 [uuid(fa9cafac-9562-49ad-afcf-911ab1e4e4fb)]
  45
  46 interface nsPIAccessibleDocument : nsISupports
  47 {
  48    /**
  49     * Find the accessible object in the accessibility cache that
  50     * corresponds to aStartNode or the first ancestor of aStartNode
  51     * that has an accessible object associated with it.
  52     * Clear that accessible object's parent's cache of accessible children and
  53     * and remove the accessible object and any decendents from the accessible cache.
  54     * New accessible objects will be created and cached again on demand.
  55     * @param aChangeContent     The child that is changing
  56     * @param aEvent             The event from nsIAccessibleEvent that caused the change:
  57     *                           Must be one of: EVENT_REORDER (change),
  58     *                                           EVENT_SHOW (make visible or create) or
  59     *                                           EVENT_HIDE (destroy or hide)
  60     */
  61   void invalidateCacheSubtree(in nsIContent aChangeContent,
  62                               in PRUint32 aChangeEvent);
  63   void cacheAccessNode(in voidPtr aUniqueID, in nsIAccessNode aAccessNode);
  64   void flushPendingEvents();
  65   void fireDocLoadEvents(in PRUint32 aEventType);
  66   void fireAnchorJumpEvent();
  67 };