accessible/xul/XULMenuAccessible.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this
   4  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   5
   6 #ifndef mozilla_a11y_XULMenuAccessible_h__
   7 #define mozilla_a11y_XULMenuAccessible_h__
   8
   9 #include "AccessibleWrap.h"
  10 #include "nsIDOMXULSelectCntrlEl.h"
  11 #include "XULSelectControlAccessible.h"
  12
  13 namespace mozilla {
  14 namespace a11y {
  15
  16 /**
  17  * Used for XUL menu, menuitem elements.
  18  */
  19 class XULMenuitemAccessible : public AccessibleWrap
  20 {
  21 public:
  22   enum { eAction_Click = 0 };
  23
  24   XULMenuitemAccessible(nsIContent* aContent, DocAccessible* aDoc);
  25
  26   // Accessible
  27   virtual void Description(nsString& aDescription) MOZ_OVERRIDE;
  28   virtual a11y::role NativeRole() MOZ_OVERRIDE;
  29   virtual uint64_t NativeState() MOZ_OVERRIDE;
  30   virtual uint64_t NativeInteractiveState() const MOZ_OVERRIDE;
  31   virtual int32_t GetLevelInternal() MOZ_OVERRIDE;
  32
  33   virtual bool CanHaveAnonChildren() MOZ_OVERRIDE;
  34
  35   // ActionAccessible
  36   virtual uint8_t ActionCount() MOZ_OVERRIDE;
  37   virtual void ActionNameAt(uint8_t aIndex, nsAString& aName) MOZ_OVERRIDE;
  38   virtual bool DoAction(uint8_t aIndex) MOZ_OVERRIDE;
  39   virtual KeyBinding AccessKey() const MOZ_OVERRIDE;
  40   virtual KeyBinding KeyboardShortcut() const MOZ_OVERRIDE;
  41
  42   // Widgets
  43   virtual bool IsActiveWidget() const MOZ_OVERRIDE;
  44   virtual bool AreItemsOperable() const MOZ_OVERRIDE;
  45   virtual Accessible* ContainerWidget() const MOZ_OVERRIDE;
  46
  47 protected:
  48   // Accessible
  49   virtual ENameValueFlag NativeName(nsString& aName) MOZ_OVERRIDE;
  50 };
  51
  52 /**
  53  * Used for XUL menuseparator element.
  54  */
  55 class XULMenuSeparatorAccessible : public XULMenuitemAccessible
  56 {
  57 public:
  58   XULMenuSeparatorAccessible(nsIContent* aContent, DocAccessible* aDoc);
  59
  60   // Accessible
  61   virtual a11y::role NativeRole() MOZ_OVERRIDE;
  62   virtual uint64_t NativeState() MOZ_OVERRIDE;
  63
  64   // ActionAccessible
  65   virtual uint8_t ActionCount() MOZ_OVERRIDE;
  66   virtual void ActionNameAt(uint8_t aIndex, nsAString& aName) MOZ_OVERRIDE;
  67   virtual bool DoAction(uint8_t aIndex) MOZ_OVERRIDE;
  68
  69 protected:
  70   // Accessible
  71   virtual ENameValueFlag NativeName(nsString& aName) MOZ_OVERRIDE;
  72 };
  73
  74
  75 /**
  76  * Used for XUL menupopup and panel.
  77  */
  78 class XULMenupopupAccessible : public XULSelectControlAccessible
  79 {
  80 public:
  81   XULMenupopupAccessible(nsIContent* aContent, DocAccessible* aDoc);
  82
  83   // Accessible
  84   virtual a11y::role NativeRole() MOZ_OVERRIDE;
  85   virtual uint64_t NativeState() MOZ_OVERRIDE;
  86
  87   // Widgets
  88   virtual bool IsWidget() const MOZ_OVERRIDE;
  89   virtual bool IsActiveWidget() const MOZ_OVERRIDE;
  90   virtual bool AreItemsOperable() const MOZ_OVERRIDE;
  91
  92   virtual Accessible* ContainerWidget() const MOZ_OVERRIDE;
  93
  94 protected:
  95   // Accessible
  96   virtual ENameValueFlag NativeName(nsString& aName) MOZ_OVERRIDE;
  97 };
  98
  99 /**
 100  * Used for XUL menubar element.
 101  */
 102 class XULMenubarAccessible : public AccessibleWrap
 103 {
 104 public:
 105   XULMenubarAccessible(nsIContent* aContent, DocAccessible* aDoc);
 106
 107   // Accessible
 108   virtual a11y::role NativeRole() MOZ_OVERRIDE;
 109
 110   // Widget
 111   virtual bool IsActiveWidget() const MOZ_OVERRIDE;
 112   virtual bool AreItemsOperable() const MOZ_OVERRIDE;
 113   virtual Accessible* CurrentItem() MOZ_OVERRIDE;
 114   virtual void SetCurrentItem(Accessible* aItem) MOZ_OVERRIDE;
 115
 116 protected:
 117   // Accessible
 118   virtual ENameValueFlag NativeName(nsString& aName) MOZ_OVERRIDE;
 119 };
 120
 121 } // namespace a11y
 122 } // namespace mozilla
 123
 124 #endif