widget/nsITaskbarPreviewButton.idl

   1 /* vim: se cin sw=2 ts=2 et : */
   2 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
   3  *
   4  * This Source Code Form is subject to the terms of the Mozilla Public
   5  * License, v. 2.0. If a copy of the MPL was not distributed with this
   6  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   7
   8 #include "nsISupports.idl"
   9
  10 interface imgIContainer;
  11
  12 /**
  13  * nsITaskbarPreviewButton
  14  *
  15  * Provides access to a window preview's toolbar button's properties.
  16  */
  17 [scriptable, uuid(CED8842D-FE37-4767-9A8E-FDFA56510C75)]
  18 interface nsITaskbarPreviewButton : nsISupports
  19 {
  20   /**
  21    * The button's tooltip.
  22    *
  23    * Default: an empty string
  24    */
  25   attribute AString tooltip;
  26
  27   /**
  28    * True if the array of previews should be dismissed when this button is clicked.
  29    *
  30    * Default: false
  31    */
  32   attribute boolean dismissOnClick;
  33
  34   /**
  35    * True if the taskbar should draw a border around this button's image.
  36    *
  37    * Default: true
  38    */
  39   attribute boolean hasBorder;
  40
  41   /**
  42    * True if the button is disabled. This is not the same as visible.
  43    *
  44    * Default: false
  45    */
  46   attribute boolean disabled;
  47
  48   /**
  49    * The icon used for the button.
  50    *
  51    * Default: null
  52    */
  53   attribute imgIContainer image;
  54
  55   /**
  56    * True if the button is shown. Buttons that are invisible do not
  57    * participate in the layout of buttons underneath the preview.
  58    *
  59    * Default: false
  60    */
  61   attribute boolean visible;
  62 };