accessible/mac/AccessibleWrap.h

   1 /* clang-format off */
   2 /* -*- Mode: Objective-C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   3 /* clang-format on */
   4 /* This Source Code Form is subject to the terms of the Mozilla Public
   5  * License, v. 2.0. If a copy of the MPL was not distributed with this
   6  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   7
   8 /* For documentation of the accessibility architecture,
   9  * see http://lxr.mozilla.org/seamonkey/source/accessible/accessible-docs.html
  10  */
  11
  12 #ifndef _AccessibleWrap_H_
  13 #define _AccessibleWrap_H_
  14
  15 #include <objc/objc.h>
  16
  17 #include "Accessible.h"
  18 #include "States.h"
  19
  20 #include "nsCOMPtr.h"
  21
  22 #include "nsTArray.h"
  23
  24 #if defined(__OBJC__)
  25 @class mozAccessible;
  26 #endif
  27
  28 namespace mozilla {
  29 namespace a11y {
  30
  31 class AccessibleWrap : public Accessible {
  32  public:  // construction, destruction
  33   AccessibleWrap(nsIContent* aContent, DocAccessible* aDoc);
  34   virtual ~AccessibleWrap();
  35
  36   /**
  37    * Get the native Obj-C object (mozAccessible).
  38    */
  39   virtual void GetNativeInterface(void** aOutAccessible) override;
  40
  41   /**
  42    * The objective-c |Class| type that this accessible's native object
  43    * should be instantied with.   used on runtime to determine the
  44    * right type for this accessible's associated native object.
  45    */
  46   virtual Class GetNativeType();
  47
  48   virtual void Shutdown() override;
  49
  50   virtual nsresult HandleAccEvent(AccEvent* aEvent) override;
  51
  52  protected:
  53   friend class xpcAccessibleMacInterface;
  54
  55   /**
  56    * Get the native object. Create it if needed.
  57    */
  58 #if defined(__OBJC__)
  59   mozAccessible* GetNativeObject();
  60 #else
  61   id GetNativeObject();
  62 #endif
  63
  64  private:
  65   /**
  66    * Our native object. Private because its creation is done lazily.
  67    * Don't access it directly. Ever. Unless you are GetNativeObject() or
  68    * Shutdown()
  69    */
  70 #if defined(__OBJC__)
  71   // if we are in Objective-C, we use the actual Obj-C class.
  72   mozAccessible* mNativeObject;
  73 #else
  74   id mNativeObject;
  75 #endif
  76
  77   /**
  78    * We have created our native. This does not mean there is one.
  79    * This can never go back to false.
  80    * We need it because checking whether we need a native object cost time.
  81    */
  82   bool mNativeInited;
  83 };
  84
  85 Class GetTypeFromRole(roles::Role aRole);
  86
  87 }  // namespace a11y
  88 }  // namespace mozilla
  89
  90 #endif