accessible/src/base/FocusManager.h

   1 /* This Source Code Form is subject to the terms of the Mozilla Public
   2  * License, v. 2.0. If a copy of the MPL was not distributed with this
   3  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   4
   5 #ifndef mozilla_a11y_FocusManager_h_
   6 #define mozilla_a11y_FocusManager_h_
   7
   8 #include "nsAutoPtr.h"
   9 #include "mozilla/dom/Element.h"
  10
  11 namespace mozilla {
  12 namespace a11y {
  13
  14 class AccEvent;
  15 class Accessible;
  16 class DocAccessible;
  17
  18 /**
  19  * Manage the accessible focus. Used to fire and process accessible events.
  20  */
  21 class FocusManager
  22 {
  23 public:
  24   virtual ~FocusManager();
  25
  26   /**
  27    * Return a focused accessible.
  28    */
  29   Accessible* FocusedAccessible() const;
  30
  31   /**
  32    * Return true if given accessible is focused.
  33    */
  34   bool IsFocused(const Accessible* aAccessible) const;
  35
  36   /**
  37    * Return true if the given accessible is an active item, i.e. an item that
  38    * is current within the active widget.
  39    */
  40   inline bool IsActiveItem(const Accessible* aAccessible)
  41     { return aAccessible == mActiveItem; }
  42
  43   /**
  44    * Return true if given DOM node has DOM focus.
  45    */
  46   inline bool HasDOMFocus(const nsINode* aNode) const
  47     { return aNode == FocusedDOMNode(); }
  48
  49   /**
  50    * Return true if focused accessible is within the given container.
  51    */
  52   bool IsFocusWithin(const Accessible* aContainer) const;
  53
  54   /**
  55    * Return whether the given accessible is focused or contains the focus or
  56    * contained by focused accessible.
  57    */
  58   enum FocusDisposition {
  59     eNone,
  60     eFocused,
  61     eContainsFocus,
  62     eContainedByFocus
  63   };
  64   FocusDisposition IsInOrContainsFocus(const Accessible* aAccessible) const;
  65
  66   //////////////////////////////////////////////////////////////////////////////
  67   // Focus notifications and processing (don't use until you know what you do).
  68
  69   /**
  70    * Called when DOM focus event is fired.
  71    */
  72   void NotifyOfDOMFocus(nsISupports* aTarget);
  73
  74   /**
  75    * Called when DOM blur event is fired.
  76    */
  77   void NotifyOfDOMBlur(nsISupports* aTarget);
  78
  79   /**
  80    * Called when active item is changed. Note: must be called when accessible
  81    * tree is up to date.
  82    */
  83   void ActiveItemChanged(Accessible* aItem, bool aCheckIfActive = true);
  84
  85   /**
  86    * Dispatch delayed focus event for the current focus accessible.
  87    */
  88   void ForceFocusEvent();
  89
  90   /**
  91    * Dispatch delayed focus event for the given target.
  92    */
  93   void DispatchFocusEvent(DocAccessible* aDocument, Accessible* aTarget);
  94
  95   /**
  96    * Process DOM focus notification.
  97    */
  98   void ProcessDOMFocus(nsINode* aTarget);
  99
 100   /**
 101    * Process the delayed accessible event.
 102    * do.
 103    */
 104   void ProcessFocusEvent(AccEvent* aEvent);
 105
 106 protected:
 107   FocusManager();
 108
 109 private:
 110   FocusManager(const FocusManager&);
 111   FocusManager& operator =(const FocusManager&);
 112
 113   /**
 114    * Return DOM node having DOM focus.
 115    */
 116   nsINode* FocusedDOMNode() const;
 117
 118   /**
 119    * Return DOM document having DOM focus.
 120    */
 121   nsIDocument* FocusedDOMDocument() const;
 122
 123 private:
 124   nsRefPtr<Accessible> mActiveItem;
 125   nsRefPtr<Accessible> mActiveARIAMenubar;
 126 };
 127
 128 } // namespace a11y
 129 } // namespace mozilla
 130
 131 #endif