widget/public/nsITaskbarProgress.idl
author Siddharth Agarwal <sid.bugzilla@gmail.com>
Tue, 06 Oct 2009 14:00:23 -0500
changeset 33510 77d0e4a45bcd26f78c73d69b52a3e6ae83784847
permissions -rw-r--r--
Bug 474060 - Win7 progress indicator platform support. r=jimm, r=robarnold, sr=roc.

/* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
 *
 * ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is mozilla.org code.
 *
 * The Initial Developer of the Original Code is
 * Siddharth Agarwal <sid.bugzilla@gmail.com>
 * Portions created by the Initial Developer are Copyright (C) 2009
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */

#include "nsISupports.idl"
#include "nsIBaseWindow.idl"

typedef long nsTaskbarProgressState;

/**
 * Starting in Windows 7, applications can display a progress notification in
 * the taskbar. This class wraps around the native functionality to do this.
 */
[scriptable, uuid(23ac257d-ef3c-4033-b424-be7fef91a86c)]
interface nsITaskbarProgress : nsISupports
{
  /**
   * Stop displaying progress on the taskbar button. This should be used when
   * the operation is complete or cancelled.
   */
  const nsTaskbarProgressState STATE_NO_PROGRESS   = 0;

  /**
   * Display a cycling, indeterminate progress bar.
   */
  const nsTaskbarProgressState STATE_INDETERMINATE = 1;

  /**
   * Display a determinate, normal progress bar.
   */
  const nsTaskbarProgressState STATE_NORMAL        = 2;

  /**
   * Display a determinate, error progress bar.
   */
  const nsTaskbarProgressState STATE_ERROR         = 3;

  /**
   * Display a determinate progress bar indicating that the operation has
   * paused.
   */
  const nsTaskbarProgressState STATE_PAUSED        = 4;

  /**
   * Sets the taskbar progress state and value for this window. The currentValue
   * and maxValue parameters are optional and should be supplied when |state|
   * is one of STATE_NORMAL, STATE_ERROR or STATE_PAUSED.
   *
   * @throws NS_ERROR_INVALID_ARG if state is STATE_NO_PROGRESS or
   *         STATE_INDETERMINATE, and either currentValue or maxValue is not 0.
   * @throws NS_ERROR_ILLEGAL_VALUE if currentValue is greater than maxValue.
   */
  void setProgressState(in nsTaskbarProgressState state,
                        [optional] in unsigned long long currentValue,
                        [optional] in unsigned long long maxValue);
};