xpcom/components/nsIClassInfo.idl

   1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 4 -*-
   2  *
   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 #include "nsISupports.idl"
   8
   9 interface nsIXPCScriptable;
  10
  11 /**
  12  * Provides information about a specific implementation class.  If you want
  13  * your class to implement nsIClassInfo, see nsIClassInfoImpl.h for
  14  * instructions--you most likely do not want to inherit from nsIClassInfo.
  15  */
  16
  17 [scriptable, uuid(a60569d7-d401-4677-ba63-2aa5971af25d)]
  18 interface nsIClassInfo : nsISupports
  19 {
  20     /**
  21      * Returns a list of the interfaces which instances of this class promise
  22      * to implement. Note that nsISupports is an implicit member of any such
  23      * list, and need not be included.
  24      */
  25     readonly attribute Array<nsIIDRef> interfaces;
  26
  27     /**
  28      * Return an object to assist XPConnect in supplying JavaScript-specific
  29      * behavior to callers of the instance object, or null if not needed.
  30      */
  31     nsIXPCScriptable getScriptableHelper();
  32
  33     /**
  34      * A contract ID through which an instance of this class can be created
  35      * (or accessed as a service, if |flags & SINGLETON|), or null/void.
  36      */
  37     readonly attribute AUTF8String contractID;
  38
  39     /**
  40      * A human readable string naming the class, or null/void.
  41      */
  42     readonly attribute AUTF8String classDescription;
  43
  44     /**
  45      * A class ID through which an instance of this class can be created
  46      * (or accessed as a service, if |flags & SINGLETON|), or null.
  47      */
  48     readonly attribute nsCIDPtr classID;
  49
  50     /**
  51      * Bitflags for 'flags' attribute.
  52      */
  53     const uint32_t SINGLETON            = 1 << 0;
  54     const uint32_t THREADSAFE           = 1 << 1;
  55     const uint32_t SINGLETON_CLASSINFO  = 1 << 5;
  56
  57     // The high order bit is RESERVED for consumers of these flags.
  58     // No implementor of this interface should ever return flags
  59     // with this bit set.
  60     const uint32_t RESERVED             = 1 << 31;
  61
  62
  63     readonly attribute uint32_t flags;
  64
  65     /**
  66      * Also a class ID through which an instance of this class can be created
  67      * (or accessed as a service, if |flags & SINGLETON|).  If the class does
  68      * not have a CID, it should return NS_ERROR_NOT_AVAILABLE.  This attribute
  69      * exists so C++ callers can avoid allocating and freeing a CID, as would
  70      * happen if they used classID.
  71      */
  72     [noscript] readonly attribute nsCID classIDNoAlloc;
  73
  74 };