widget/nsITouchBarInput.idl
author Dorel Luca <dluca@mozilla.com>
Tue, 23 Apr 2019 17:16:13 +0300
changeset 470493 e56e63264f65972f66905dd8893eb549984ffce9
parent 454830 099f631b90046b102aa1868455f03b7f9942eaba
child 483744 6bad91b2f1989e35f5dbcaa2a850102a0bcb3078
permissions -rw-r--r--
Backed out changeset 7d3f2f4c53be (bug 1544863) for eslint failure

/* 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 "nsIArray.idl"
#include "nsISupports.idl"

[scriptable, function, uuid(001ab07c-1b3a-4dbf-a657-fada0065ff55)]
interface nsITouchBarInputCallback : nsISupports
{
  void onCommand();
};

/**
 * Implements an input to be registered on the Mac Touch Bar.
 */

[scriptable, uuid(77441d17-f29c-49d7-982f-f20a5ab5a900)]
interface nsITouchBarInput : nsISupports
{
  readonly attribute AString key;

  /**
   * The lookup key for the button's localized text title.
   */
  attribute AString title;

  /**
   * The name of a icon file added to
   * /widget/cocoa/touchbar.
   */
  attribute AString image;

  /**
   * The type of the input.
   * Takes one of:
   *   `button`: A standard button.
   *             If an image is available, only the image is displayed.
   *   `mainButton`: An extra-wide button. Displays both the image and title.
   *   `scrubber`: A Scrubber element. Not yet implemented, except in the
   *               case of Apple's pre-built Share scrubber.
   */
  attribute AString type;

  /**
   * A callback function to be invoked when an element is touched.
   */
  attribute nsITouchBarInputCallback callback;

  /**
   * A hexadecimal uint32_t specifying the input's
   * background color. If omitted, the default background color is used.
   */
  attribute uint32_t color;

  /**
   * If `true`, the Touch Bar input is greyed out and inoperable.
   */
  attribute boolean disabled;
};