accessible/public/nsIAccessibilityService.idl

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
   2  *
   3  * ***** BEGIN LICENSE BLOCK *****
   4  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   5  *
   6  * The contents of this file are subject to the Mozilla Public License Version
   7  * 1.1 (the "License"); you may not use this file except in compliance with
   8  * the License. You may obtain a copy of the License at
   9  * http://www.mozilla.org/MPL/
  10  *
  11  * Software distributed under the License is distributed on an "AS IS" basis,
  12  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  13  * for the specific language governing rights and limitations under the
  14  * License.
  15  *
  16  * The Original Code is the Mozilla browser.
  17  *
  18  * The Initial Developer of the Original Code is
  19  * Netscape Communications Corporation.
  20  * Portions created by the Initial Developer are Copyright (C) 1999
  21  * the Initial Developer. All Rights Reserved.
  22  *
  23  * Contributor(s):
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either of the GNU General Public License Version 2 or later (the "GPL"),
  27  * or 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 #include "nsIAccessibleRetrieval.idl"
  41
  42 interface nsIAccessibleEventListener;
  43 interface nsIDocument;
  44 interface nsIFrame;
  45 interface nsObjectFrame;
  46 interface nsIContent;
  47 interface nsITimer;
  48
  49 [uuid(44685af8-18be-494a-8e64-16c7d4296dd1)]
  50 interface nsIAccessibilityService : nsIAccessibleRetrieval
  51 {
  52   nsIAccessible createOuterDocAccessible(in nsIDOMNode aNode);
  53   nsIAccessible createRootAccessible(in nsIPresShell aShell, in nsIDocument aDocument);
  54
  55   nsIAccessible createHTML4ButtonAccessible(in nsISupports aFrame);
  56   nsIAccessible createHyperTextAccessible(in nsISupports aFrame);
  57   nsIAccessible createHTMLBRAccessible(in nsISupports aFrame);
  58   nsIAccessible createHTMLButtonAccessible(in nsISupports aFrame);
  59   nsIAccessible createHTMLAccessibleByMarkup(in nsIFrame aFrame, in nsIWeakReference aWeakShell, in nsIDOMNode aDOMNode);
  60   nsIAccessible createHTMLLIAccessible(in nsISupports aFrame, in nsISupports aBulletFrame, in AString aBulletText);
  61   nsIAccessible createHTMLCheckboxAccessible(in nsISupports aFrame);
  62   nsIAccessible createHTMLComboboxAccessible(in nsIDOMNode aNode, in nsIWeakReference aPresShell);
  63   nsIAccessible createHTMLGenericAccessible(in nsISupports aFrame);
  64   nsIAccessible createHTMLGroupboxAccessible(in nsISupports aFrame);
  65   nsIAccessible createHTMLHRAccessible(in nsISupports aFrame);
  66   nsIAccessible createHTMLImageAccessible(in nsISupports aFrame);
  67   nsIAccessible createHTMLLabelAccessible(in nsISupports aFrame);
  68   nsIAccessible createHTMLListboxAccessible(in nsIDOMNode aNode, in nsIWeakReference aPresShell);
  69   nsIAccessible createHTMLObjectFrameAccessible(in nsObjectFrame aFrame);
  70   nsIAccessible createHTMLRadioButtonAccessible(in nsISupports aFrame);
  71   nsIAccessible createHTMLSelectOptionAccessible(in nsIDOMNode aNode, in nsIAccessible aAccParent, in nsIWeakReference aPresShell);
  72   nsIAccessible createHTMLTableAccessible(in nsISupports aFrame);
  73   nsIAccessible createHTMLTableCellAccessible(in nsISupports aFrame);
  74   nsIAccessible createHTMLTableHeadAccessible(in nsIDOMNode aDOMNode);
  75   nsIAccessible createHTMLTextAccessible(in nsISupports aFrame);
  76   nsIAccessible createHTMLTextFieldAccessible(in nsISupports aFrame);
  77   nsIAccessible createHTMLCaptionAccessible(in nsISupports aFrame);
  78
  79   nsIAccessible getAccessible(in nsIDOMNode aNode, in nsIPresShell aPresShell,
  80                               in nsIWeakReference aWeakShell,
  81                               inout nsIFrame frameHint, out boolean aIsHidden);
  82
  83   // For gtk+ native window accessible
  84   nsIAccessible addNativeRootAccessible(in voidPtr aAtkAccessible);
  85   void removeNativeRootAccessible(in nsIAccessible aRootAccessible);
  86
  87   /**
  88    * Invalidate the accessibility cache associated with aPresShell, for accessibles
  89    * that were generated for aContainerContent and its subtree.
  90    * The container content node for the change is passed in, rather than the
  91    * changed presentation for the content node itself.
  92    * @param aPresShell         The presShell where changes occured
  93    * @param aChangeContent     The affected DOM content
  94    * @param aEvent             The event from nsIAccessibleEvent that
  95    *                           caused the change:
  96    *                           Must be one of:
  97    *                           EVENT_REORDER (change),
  98    *                           EVENT_SHOW (make visible or create) or
  99    *                           EVENT_HIDE (destroy or hide)
 100    */
 101   void invalidateSubtreeFor(in nsIPresShell aPresShell,
 102                             in nsIContent aChangedContent,
 103                             in PRUint32 aEvent);
 104
 105   /**
 106    *  An internal doc load event has occured. Handle the event and remove it from the list.
 107    *  @param aTimer      The timer created to handle this doc load event
 108    *  @param aClosure    The nsIWebProgress* for the load event
 109    *  @param aEventType  The type of load event, one of: nsIAccessibleEvent::EVENT_DOCUMENT_LOAD_START,
 110    *                                                     nsIAccessibleEvent::EVENT_DOCUMENT_LOAD_COMPLETE or
 111    *                                                     nsIAccessibleEvent::EVENT_DOCUMENT_LOAD_STOPPED
 112    */
 113   void processDocLoadEvent(in nsITimer aTimer, in voidPtr aClosure, in PRUint32 aEventType);
 114
 115   /**
 116    * Fire accessible event of the given type for the given target.
 117    *
 118    * @param aEvent   [in] accessible event type
 119    * @param aTarget  [in] target of accessible event
 120    */
 121   void fireAccessibleEvent(in unsigned long aEvent, in nsIAccessible aTarget);
 122 };
 123
 124
 125 %{ C++
 126
 127 // for component registration
 128 // {DE401C37-9A7F-4278-A6F8-3DE2833989EF}
 129 #define NS_ACCESSIBILITY_SERVICE_CID \
 130 { 0xde401c37, 0x9a7f, 0x4278, { 0xa6, 0xf8, 0x3d, 0xe2, 0x83, 0x39, 0x89, 0xef } }
 131
 132 extern nsresult
 133 NS_GetAccessibilityService(nsIAccessibilityService** aResult);
 134
 135 %}