dom/bindings/CallbackInterface.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim:set ts=2 sw=2 sts=2 et cindent: */
   3 /* This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 /**
   8  * A common base class for representing WebIDL callback interface types in C++.
   9  *
  10  * This class implements common functionality like lifetime management,
  11  * initialization with the callback object, and setup of the call environment.
  12  * Subclasses corresponding to particular callback interface types should
  13  * provide methods that actually do the various necessary calls.
  14  */
  15
  16 #ifndef mozilla_dom_CallbackInterface_h
  17 #define mozilla_dom_CallbackInterface_h
  18
  19 #include "mozilla/dom/CallbackObject.h"
  20
  21 namespace mozilla {
  22 namespace dom {
  23
  24 class CallbackInterface : public CallbackObject
  25 {
  26 public:
  27   explicit CallbackInterface(JSObject* aCallback)
  28     : CallbackObject(aCallback)
  29   {
  30   }
  31
  32 protected:
  33   bool GetCallableProperty(JSContext* cx, const char* aPropName,
  34                            JS::MutableHandle<JS::Value> aCallable);
  35
  36 };
  37
  38 } // namespace dom
  39 } // namespace mozilla
  40
  41 #endif // mozilla_dom_CallbackFunction_h