widget/nsIColorPicker.idl
author Nicholas D. Matsakis <nmatsakis@mozilla.com>
Tue, 11 Mar 2014 13:23:24 -0400
changeset 206610 4903226b4f2ff4f6c44fe08e91e5dff0e163741d
parent 149921 73a472818f63bb52bedc2dc7d7329d1961b1de76
child 318762 e22b3043887ed36bf2c634c2924a7c8d39d226b1
permissions -rw-r--r--
Bug 973238 Part 6 -- Consult prototype rather than typed object addendum r=bhackett

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#include "nsISupports.idl"

interface nsIDOMWindow;

/**
 * nsIColorPicker is representing colors as strings because the internal
 * representation will depend on the underlying backend.
 * The format of the colors taken in input and returned will always follow the
 * format of the <input type='color'> value as described in the HTML
 * specifications.
 */

[scriptable, uuid(d2ce78d1-40b5-49d1-b66d-5801fcb9a385)]
interface nsIColorPickerShownCallback : nsISupports
{
 /**
  * Callback called when the color picker requests a color update.
  * This callback can not be called after done() was called.
  * When this callback is used, the consumer can assume that the color value has
  * changed.
  *
  * @param  color  The new selected color value following the format specifed on
  *                top of this file.
  */
 void update(in AString color);

 /**
  * Callback called when the color picker is dismissed.
  * When this callback is used, the color might have changed or could stay the
  * same.
  * If the color has not changed, the color parameter will be the empty string.
  *
  * @param  color  The new selected color value following the format specifed on
  *                top of this file or the empty string.
  */
  void done(in AString color);
};

[scriptable, uuid(3c3bdcce-54b1-4ae2-8647-1a8d4712ef2e)]
interface nsIColorPicker : nsISupports
{
 /**
  * Initialize the color picker widget. The color picker will not be shown until
  * open() is called.
  * If the backend doesn't support setting a title to the native color picker
  * widget, the title parameter might be ignored.
  * If the initialColor parameter does not follow the format specified on top of
  * this file, the behavior will be unspecified. The initialColor could be the
  * one used by the underlying backend or an arbitrary one. The backend could
  * also assert.
  *
  * @param      parent       nsIDOMWindow parent. This dialog will be dependent
  *                          on this parent. parent must be non-null.
  * @param      title        The title for the color picker widget.
  * @param      initialColor The color to show when the widget is opened. The
  *                          parameter has to follow the format specified on top
  *                          of this file.
  */
  void init(in nsIDOMWindow parent, in AString title, in AString initialColor);

 /**
  * Opens the color dialog asynchrounously.
  * The results are provided via the callback object.
  */
  void open(in nsIColorPickerShownCallback aColorPickerShownCallback);
};