widget/nsIMacFinderProgress.idl

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
   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
  10 [scriptable, function, uuid(6BAE6D1C-7FFD-4354-8D7B-64697E98A801)]
  11 interface nsIMacFinderProgressCanceledCallback : nsISupports
  12 {
  13   void canceled();
  14 };
  15
  16
  17 [scriptable, uuid(25A0B01F-54D4-4AEF-B2BF-C5764CDC68A8)]
  18 interface nsIMacFinderProgress : nsISupports
  19 {
  20   /**
  21   * Initialize and display a new Finder progressbar on the given file
  22   *
  23   * @param      path              The path of the file
  24   *
  25   * @param      canceledCallback  Callback which is called when cancelation is requested
  26   */
  27   void init(in AString path, in nsIMacFinderProgressCanceledCallback canceledCallback);
  28
  29   /**
  30   * Update the current and total progess. If currentProgress and totalProgress are both 0,
  31   * the progress is indetermined
  32   *
  33   * @param      currentProgress  The current progress
  34   *
  35   * @param      totalProgress    The total progress
  36   */
  37   void updateProgress(in unsigned long long currentProgress, in unsigned long long totalProgress);
  38
  39   /**
  40   * End displaying the progressbar on the file
  41   */
  42   void end();
  43 };