author Ryan VanderMeulen <>
Tue, 11 Feb 2020 16:42:31 +0000
changeset 575603 9eebc3f33831424089c2159ea1a0b865c1d6e3fb
parent 341529 232a786cf87fb0f68f9bda6e9316515524d2ac8a
child 504652 fb09acfff1684500e989acc798e97fa7f9358dc0
permissions -rw-r--r--
Bug 1562666 - Close old branch THUNDERBIRD550b1_2017061508_RELBRANCH

/* -*- Mode: Objective-C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at */

/* For documentation of the accessibility architecture,
 * see

#ifndef _AccessibleWrap_H_
#define _AccessibleWrap_H_

#include <objc/objc.h>

#include "Accessible.h"
#include "States.h"

#include "nsCOMPtr.h"

#include "nsTArray.h"

#if defined(__OBJC__)
@class mozAccessible;

namespace mozilla {
namespace a11y {

class AccessibleWrap : public Accessible
public: // construction, destruction
  AccessibleWrap(nsIContent* aContent, DocAccessible* aDoc);
  virtual ~AccessibleWrap();

   * Get the native Obj-C object (mozAccessible).
  virtual void GetNativeInterface(void** aOutAccessible) override;

   * The objective-c |Class| type that this accessible's native object
   * should be instantied with.   used on runtime to determine the
   * right type for this accessible's associated native object.
  virtual Class GetNativeType ();

  virtual void Shutdown () override;

  virtual bool InsertChildAt(uint32_t aIdx, Accessible* aChild) override;
  virtual bool RemoveChild(Accessible* aAccessible) override;

  virtual nsresult HandleAccEvent(AccEvent* aEvent) override;


   * Return true if the parent doesn't have children to expose to AT.
  bool AncestorIsFlat();

   * Get the native object. Create it if needed.
#if defined(__OBJC__)
  mozAccessible* GetNativeObject();
  id GetNativeObject();


   * Our native object. Private because its creation is done lazily.
   * Don't access it directly. Ever. Unless you are GetNativeObject() or
   * Shutdown()
#if defined(__OBJC__)
  // if we are in Objective-C, we use the actual Obj-C class.
  mozAccessible* mNativeObject;
  id mNativeObject;

   * We have created our native. This does not mean there is one.
   * This can never go back to false.
   * We need it because checking whether we need a native object cost time.
  bool mNativeInited;

#if defined(__OBJC__)
  void FireNativeEvent(mozAccessible* aNativeAcc, uint32_t aEventType);
  void FireNativeEvent(id aNativeAcc, uint32_t aEventType);

Class GetTypeFromRole(roles::Role aRole);

} // namespace a11y
} // namespace mozilla