michael@0: /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
michael@0: /* vim:set ts=2 sw=2 sts=2 et cindent: */
michael@0: /* This Source Code Form is subject to the terms of the Mozilla Public
michael@0:  * License, v. 2.0. If a copy of the MPL was not distributed with this
michael@0:  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
michael@0: 
michael@0: #include "nsISupports.idl"
michael@0: 
michael@0: /**
michael@0:  * This interface provides a means to cancel an operation that is in progress.
michael@0:  */
michael@0: [scriptable, uuid(d94ac0a0-bb18-46b8-844e-84159064b0bd)]
michael@0: interface nsICancelable : nsISupports
michael@0: {
michael@0:   /**
michael@0:    * Call this method to request that this object abort whatever operation it
michael@0:    * may be performing.
michael@0:    *
michael@0:    * @param aReason
michael@0:    *        Pass a failure code to indicate the reason why this operation is
michael@0:    *        being canceled.  It is an error to pass a success code.
michael@0:    */
michael@0:   void cancel(in nsresult aReason);
michael@0: };