PageRenderTime 12ms CodeModel.GetById 8ms RepoModel.GetById 0ms app.codeStats 0ms

/gecko_api/include/nsISupportsBase.h

http://firefox-mac-pdf.googlecode.com/
C++ Header | 112 lines | 20 code | 14 blank | 78 comment | 0 complexity | 0c4f1f198b4ab0533c291ab9a3ee958c MD5 | raw file
  1. /* ***** BEGIN LICENSE BLOCK *****
  2. * Version: MPL 1.1/GPL 2.0/LGPL 2.1
  3. *
  4. * The contents of this file are subject to the Mozilla Public License Version
  5. * 1.1 (the "License"); you may not use this file except in compliance with
  6. * the License. You may obtain a copy of the License at
  7. * http://www.mozilla.org/MPL/
  8. *
  9. * Software distributed under the License is distributed on an "AS IS" basis,
  10. * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  11. * for the specific language governing rights and limitations under the
  12. * License.
  13. *
  14. * The Original Code is XPCOM.
  15. *
  16. * The Initial Developer of the Original Code is Netscape Communications Corp.
  17. * Portions created by the Initial Developer are Copyright (C) 2001
  18. * the Initial Developer. All Rights Reserved.
  19. *
  20. * Contributor(s):
  21. *
  22. * Alternatively, the contents of this file may be used under the terms of
  23. * either the GNU General Public License Version 2 or later (the "GPL"), or
  24. * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  25. * in which case the provisions of the GPL or the LGPL are applicable instead
  26. * of those above. If you wish to allow use of your version of this file only
  27. * under the terms of either the GPL or the LGPL, and not to allow others to
  28. * use your version of this file under the terms of the MPL, indicate your
  29. * decision by deleting the provisions above and replace them with the notice
  30. * and other provisions required by the GPL or the LGPL. If you do not delete
  31. * the provisions above, a recipient may use your version of this file under
  32. * the terms of any one of the MPL, the GPL or the LGPL.
  33. *
  34. * ***** END LICENSE BLOCK ***** */
  35. #ifndef nsISupportsBase_h__
  36. #define nsISupportsBase_h__
  37. #ifndef nscore_h___
  38. #include "nscore.h"
  39. #endif
  40. #ifndef nsID_h__
  41. #include "nsID.h"
  42. #endif
  43. /*@{*/
  44. /**
  45. * IID for the nsISupports interface
  46. * {00000000-0000-0000-c000-000000000046}
  47. *
  48. * To maintain binary compatibility with COM's IUnknown, we define the IID
  49. * of nsISupports to be the same as that of COM's IUnknown.
  50. */
  51. #define NS_ISUPPORTS_IID \
  52. { 0x00000000, 0x0000, 0x0000, \
  53. {0xc0, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x46} }
  54. /**
  55. * Basic component object model interface. Objects which implement
  56. * this interface support runtime interface discovery (QueryInterface)
  57. * and a reference counted memory model (AddRef/Release). This is
  58. * modelled after the win32 IUnknown API.
  59. */
  60. class NS_NO_VTABLE nsISupports {
  61. public:
  62. NS_DECLARE_STATIC_IID_ACCESSOR(NS_ISUPPORTS_IID)
  63. /**
  64. * @name Methods
  65. */
  66. //@{
  67. /**
  68. * A run time mechanism for interface discovery.
  69. * @param aIID [in] A requested interface IID
  70. * @param aInstancePtr [out] A pointer to an interface pointer to
  71. * receive the result.
  72. * @return <b>NS_OK</b> if the interface is supported by the associated
  73. * instance, <b>NS_NOINTERFACE</b> if it is not.
  74. *
  75. * aInstancePtr must not be null.
  76. */
  77. NS_IMETHOD QueryInterface(REFNSIID aIID, void** aInstancePtr) = 0;
  78. /**
  79. * Increases the reference count for this interface.
  80. * The associated instance will not be deleted unless
  81. * the reference count is returned to zero.
  82. *
  83. * @return The resulting reference count.
  84. */
  85. NS_IMETHOD_(nsrefcnt) AddRef(void) = 0;
  86. /**
  87. * Decreases the reference count for this interface.
  88. * Generally, if the reference count returns to zero,
  89. * the associated instance is deleted.
  90. *
  91. * @return The resulting reference count.
  92. */
  93. NS_IMETHOD_(nsrefcnt) Release(void) = 0;
  94. //@}
  95. };
  96. NS_DEFINE_STATIC_IID_ACCESSOR(nsISupports, NS_ISUPPORTS_IID)
  97. /*@}*/
  98. #endif