accessible/src/html/nsHTMLImageAccessible.h

   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) 1998
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *   Author: Aaron Leventhal (aaronl@netscape.com)
  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 #ifndef _nsHTMLImageAccessible_H_
  40 #define _nsHTMLImageAccessible_H_
  41
  42 #include "nsBaseWidgetAccessible.h"
  43 #include "nsIDOMHTMLMapElement.h"
  44 #include "nsIAccessibleImage.h"
  45
  46 /* Accessible for supporting images
  47  * supports:
  48  * - gets name, role
  49  * - support basic state
  50  */
  51 class nsHTMLImageAccessible : public nsLinkableAccessible,
  52                               public nsIAccessibleImage
  53 {
  54
  55   NS_DECL_ISUPPORTS_INHERITED
  56
  57 public:
  58   nsHTMLImageAccessible(nsIDOMNode* aDomNode, nsIWeakReference* aShell);
  59
  60   // nsIAccessible
  61   NS_IMETHOD GetName(nsAString& _retval);
  62   NS_IMETHOD GetState(PRUint32 *aState, PRUint32 *aExtraState);
  63   NS_IMETHOD GetRole(PRUint32 *_retval);
  64   NS_IMETHOD GetNumActions(PRUint8 *aNumActions);
  65   NS_IMETHOD GetActionName(PRUint8 aIndex, nsAString& aName);
  66   NS_IMETHOD DoAction(PRUint8 index);
  67
  68   // nsIAccessibleHyperLink
  69   NS_IMETHOD GetAnchorCount(PRInt32 *aAnchorCount);
  70   NS_IMETHOD GetURI(PRInt32 aIndex, nsIURI **aURI);
  71   NS_IMETHOD GetAnchor(PRInt32 aIndex, nsIAccessible **aAccessible);
  72
  73   // nsPIAccessNode
  74   NS_IMETHOD Shutdown();
  75
  76   // nsIAccessibleImage
  77   NS_DECL_NSIACCESSIBLEIMAGE
  78
  79   // nsAccessible
  80   virtual nsresult GetAttributesInternal(nsIPersistentProperties *aAttributes);
  81
  82 protected:
  83   // nsAccessible
  84   virtual void CacheChildren();
  85
  86   already_AddRefed<nsIDOMHTMLCollection> GetAreaCollection();
  87   already_AddRefed<nsIAccessible>
  88     GetAreaAccessible(nsIDOMHTMLCollection* aAreaNodes, PRInt32 aAreaNum);
  89
  90   // Reference on linked map element if any.
  91   nsCOMPtr<nsIDOMHTMLMapElement> mMapElement;
  92
  93   // Cache of area accessibles. We do not use common cache because images can
  94   // share area elements but we need to have separate area accessibles for
  95   // each image accessible.
  96   nsAccessNodeHashtable *mAccessNodeCache;
  97
  98 private:
  99   /**
 100    * Determine if this image accessible has a longdesc attribute.
 101    *
 102    * @returns  true if the longdesc attribute is present.
 103    */
 104   PRBool HasLongDesc();
 105
 106   /**
 107    * Used by GetActionName and DoAction to ensure the index for opening the
 108    * longdesc URL is valid.
 109    * It is always assumed that the highest possible index opens the longdesc.
 110    *
 111    * @param aIndex  The 0-based index to be tested.
 112    *
 113    * @returns  true if index is valid for longdesc action.
 114    */
 115   PRBool IsValidLongDescIndex(PRUint8 aIndex);
 116 };
 117
 118 #endif
 119