/*
 * 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 "nsIURL.idl"

  /**
   * nsIIconURI
   *
   * This interface derives from nsIURI, to provide additional information
   * about moz-icon URIs.
   *
   * What *is* a moz-icon URI you ask?  Well, it has the following syntax:
   *
   * moz-icon:[<valid-url> | //<file-with-extension> | //stock/<stock-icon>]?
   *            ['?'[<parameter-value-pairs>]]
   *
   * <valid-url> is a valid URL spec.
   *
   * <file-with-extension> is any filename with an extension, e.g. "dummy.html".
   * If the file you want an icon for isn't known to exist, you can use this
   * instead of a URL and just place a dummy file name with the extension or
   * content type you want.
   *
   * <stock-icon> is the name of a platform-dependant stock icon.
   *
   * Legal parameter value pairs are listed below:
   *
   *   Parameter:   size
   *   Values:      [<integer> | button | toolbar | toolbarsmall | menu |
   *                 dialog]
   *   Description: If integer, this is the desired size in square pixels of
   *                the icon
   *                Else, use the OS default for the specified keyword context.
   *
   *   Parameter:   state
   *   Values:      [normal | disabled]
   *   Description: The state of the icon.
   *
   *   Parameter:   contentType
   *   Values:      <mime-type>
   *   Description: The mime type we want an icon for. This is ignored by
   *                stock images.
   */

[scriptable, builtinclass, uuid(f8fe5ef2-5f2b-43f3-857d-5b64d192c427)]
interface nsIMozIconURI : nsIURI
{
  /// iconFile: the file URL contained within this moz-icon url, or null.
  readonly attribute nsIURL iconURL;

  /// imageSize: The image area in square pixels, defaults to 16 if unspecified.
  [infallible] readonly attribute unsigned long imageSize;

  /// The scale of the icon.
  [infallible] readonly attribute unsigned long imageScale;

  /// imageDark: Returns whether dark or light mode was specified. Fails if not
  /// specified at all.
  readonly attribute boolean imageDark;

  /// stockIcon: The stock icon name requested from the OS.
  readonly attribute ACString stockIcon;

  /// contentType: A valid mime type, or the empty string.
  readonly attribute ACString contentType;

  /// fileExtension: The extension of the file we are looking up, prefixed with
  /// a period, so that it is a placeholder file name rather than a bare
  /// extension ("dummy.html" yields ".html"). A lone "." means the name ends in
  /// a period and so has no extension; the empty string means there is no
  /// extension to report.
  ///
  /// The period is deliberate: callers typically want an icon for a file that
  /// does not exist, and the OS APIs that produce the icon take a file name
  /// rather than an extension, so this value is meant to be usable directly as
  /// a stand-in for one.
  ///
  /// Beware that this is not the convention used elsewhere in the tree.
  /// nsIURL.fileExtension and the nsIMIMEService extension lookups all expect
  /// a bare extension with no period, so the period has to be stripped when
  /// handing this value to them. Forgetting to is easy to miss, because a
  /// period-prefixed extension usually just quietly fails to match.
  readonly attribute ACString fileExtension;
};

%{C++
#define NS_MOZICONURIMUTATOR_CID                     \
{                                                    \
    0x1460df3b,                                      \
    0x774c,                                          \
    0x4205,                                          \
    {0x83, 0x49, 0x83, 0x8e, 0x50, 0x7c, 0x3e, 0xf9} \
}
%}
