michael@0: /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
michael@0: /* This Source Code Form is subject to the terms of the Mozilla Public
michael@0:  * License, v. 2.0. If a copy of the MPL was not distributed with this
michael@0:  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
michael@0: 
michael@0: #ifndef mozilla_a11y_BaseAccessibles_h__
michael@0: #define mozilla_a11y_BaseAccessibles_h__
michael@0: 
michael@0: #include "AccessibleWrap.h"
michael@0: #include "HyperTextAccessibleWrap.h"
michael@0: 
michael@0: class nsIContent;
michael@0: 
michael@0: /**
michael@0:   * This file contains a number of classes that are used as base
michael@0:   *  classes for the different accessibility implementations of
michael@0:   *  the HTML and XUL widget sets.  --jgaunt
michael@0:   */
michael@0: 
michael@0: namespace mozilla {
michael@0: namespace a11y {
michael@0: 
michael@0: /**
michael@0:   * Leaf version of DOM Accessible -- has no children
michael@0:   */
michael@0: class LeafAccessible : public AccessibleWrap
michael@0: {
michael@0: public:
michael@0: 
michael@0:   LeafAccessible(nsIContent* aContent, DocAccessible* aDoc);
michael@0: 
michael@0:   // nsISupports
michael@0:   NS_DECL_ISUPPORTS_INHERITED
michael@0: 
michael@0:   // Accessible
michael@0:   virtual Accessible* ChildAtPoint(int32_t aX, int32_t aY,
michael@0:                                    EWhichChildAtPoint aWhichChild);
michael@0:   virtual bool InsertChildAt(uint32_t aIndex, Accessible* aChild) MOZ_OVERRIDE MOZ_FINAL;
michael@0:   virtual bool RemoveChild(Accessible* aChild) MOZ_OVERRIDE MOZ_FINAL;
michael@0: 
michael@0: protected:
michael@0: 
michael@0:   // Accessible
michael@0:   virtual void CacheChildren();
michael@0: };
michael@0: 
michael@0: /**
michael@0:  * Used for text or image accessible nodes contained by link accessibles or
michael@0:  * accessibles for nodes with registered click event handler. It knows how to
michael@0:  * report the state of the host link (traveled or not) and can activate (click)
michael@0:  * the host accessible programmatically.
michael@0:  */
michael@0: class LinkableAccessible : public AccessibleWrap
michael@0: {
michael@0: public:
michael@0:   enum { eAction_Jump = 0 };
michael@0: 
michael@0:   LinkableAccessible(nsIContent* aContent, DocAccessible* aDoc);
michael@0: 
michael@0:   NS_DECL_ISUPPORTS_INHERITED
michael@0: 
michael@0:   // nsIAccessible
michael@0:   NS_IMETHOD GetActionName(uint8_t aIndex, nsAString& aName);
michael@0:   NS_IMETHOD DoAction(uint8_t index);
michael@0:   NS_IMETHOD TakeFocus();
michael@0: 
michael@0:   // Accessible
michael@0:   virtual void Shutdown();
michael@0:   virtual void Value(nsString& aValue);
michael@0:   virtual uint64_t NativeLinkState() const;
michael@0: 
michael@0:   // ActionAccessible
michael@0:   virtual uint8_t ActionCount();
michael@0:   virtual KeyBinding AccessKey() const;
michael@0: 
michael@0:   // HyperLinkAccessible
michael@0:   virtual already_AddRefed<nsIURI> AnchorURIAt(uint32_t aAnchorIndex);
michael@0: 
michael@0: protected:
michael@0:   // Accessible
michael@0:   virtual void BindToParent(Accessible* aParent, uint32_t aIndexInParent);
michael@0:   virtual void UnbindFromParent();
michael@0: 
michael@0:   /**
michael@0:    * Parent accessible that provides an action for this linkable accessible.
michael@0:    */
michael@0:   Accessible* mActionAcc;
michael@0:   bool mIsLink;
michael@0:   bool mIsOnclick;
michael@0: };
michael@0: 
michael@0: /**
michael@0:  * A simple accessible that gets its enumerated role passed into constructor.
michael@0:  */
michael@0: class EnumRoleAccessible : public AccessibleWrap
michael@0: {
michael@0: public:
michael@0:   EnumRoleAccessible(nsIContent* aContent, DocAccessible* aDoc, 
michael@0:                      a11y::role aRole);
michael@0:   virtual ~EnumRoleAccessible() { }
michael@0: 
michael@0:   NS_DECL_ISUPPORTS_INHERITED
michael@0: 
michael@0:   // Accessible
michael@0:   virtual a11y::role NativeRole();
michael@0: 
michael@0: protected:
michael@0:   a11y::role mRole;
michael@0: };
michael@0: 
michael@0: 
michael@0: /**
michael@0:  * A wrapper accessible around native accessible to connect it with
michael@0:  * crossplatform accessible tree.
michael@0:  */
michael@0: class DummyAccessible : public AccessibleWrap
michael@0: {
michael@0: public:
michael@0:   DummyAccessible() : AccessibleWrap(nullptr, nullptr) { }
michael@0:   virtual ~DummyAccessible() { }
michael@0: 
michael@0:   virtual uint64_t NativeState() MOZ_OVERRIDE MOZ_FINAL;
michael@0:   virtual uint64_t NativeInteractiveState() const MOZ_OVERRIDE MOZ_FINAL;
michael@0:   virtual uint64_t NativeLinkState() const MOZ_OVERRIDE MOZ_FINAL;
michael@0:   virtual bool NativelyUnavailable() const MOZ_OVERRIDE MOZ_FINAL;
michael@0:   virtual void ApplyARIAState(uint64_t* aState) const MOZ_OVERRIDE MOZ_FINAL;
michael@0: };
michael@0: 
michael@0: } // namespace a11y
michael@0: } // namespace mozilla
michael@0: 
michael@0: #endif