summaryrefslogtreecommitdiffstats
path: root/image/nsIIconURI.idl
diff options
context:
space:
mode:
Diffstat (limited to 'image/nsIIconURI.idl')
-rw-r--r--image/nsIIconURI.idl84
1 files changed, 84 insertions, 0 deletions
diff --git a/image/nsIIconURI.idl b/image/nsIIconURI.idl
new file mode 100644
index 000000000..d6f393aad
--- /dev/null
+++ b/image/nsIIconURI.idl
@@ -0,0 +1,84 @@
+/* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
+ *
+ * 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, uuid(f8fe5ef2-5f2b-43f3-857d-5b64d192c427)]
+interface nsIMozIconURI : nsIURI
+{
+ /// iconFile: the file URL contained within this moz-icon url, or null.
+ attribute nsIURL iconURL;
+
+ /// imageSize: The image area in square pixels, defaults to 16 if unspecified.
+ attribute unsigned long imageSize;
+
+ /// stockIcon: The stock icon name requested from the OS.
+ readonly attribute ACString stockIcon;
+
+ /// iconSize: The stock icon size requested from the OS.
+ readonly attribute ACString iconSize;
+
+ /// iconState: The stock icon state requested from the OS.
+ readonly attribute ACString iconState;
+
+ /// contentType: A valid mime type, or the empty string.
+ attribute ACString contentType;
+
+ /// fileExtension: The file extension of the file which we are looking up.
+ readonly attribute ACString fileExtension;
+};
+
+%{C++
+
+// CID for nsMozIconURI, if implemented on this platform.
+#define NS_MOZICONURI_CID \
+{ \
+ 0x43a88e0e, \
+ 0x2d37, \
+ 0x11d5, \
+ { 0x99, 0x7, 0x0, 0x10, 0x83, 0x1, 0xe, 0x9b } \
+}
+
+%}