nsICancelable.idl 863 B

12345678910111213141516171819202122232425
  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. #include "nsISupports.idl"
  7. /**
  8. * This interface provides a means to cancel an operation that is in progress.
  9. */
  10. [scriptable, uuid(d94ac0a0-bb18-46b8-844e-84159064b0bd)]
  11. interface nsICancelable : nsISupports
  12. {
  13. /**
  14. * Call this method to request that this object abort whatever operation it
  15. * may be performing.
  16. *
  17. * @param aReason
  18. * Pass a failure code to indicate the reason why this operation is
  19. * being canceled. It is an error to pass a success code.
  20. */
  21. void cancel(in nsresult aReason);
  22. };