[Author: kevinww]
[google-gears.git] / gears / desktop / desktop_ff.idl.m4
blobaa028d43f85f08f80bf42bb72e09299ffd959b0b
1 // Copyright 2007, Google Inc.
2 //
3 // Redistribution and use in source and binary forms, with or without
4 // modification, are permitted provided that the following conditions are met:
5 //
6 //  1. Redistributions of source code must retain the above copyright notice,
7 //     this list of conditions and the following disclaimer.
8 //  2. Redistributions in binary form must reproduce the above copyright notice,
9 //     this list of conditions and the following disclaimer in the documentation
10 //     and/or other materials provided with the distribution.
11 //  3. Neither the name of Google Inc. nor the names of its contributors may be
12 //     used to endorse or promote products derived from this software without
13 //     specific prior written permission.
15 // THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
16 // WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
17 // MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
18 // EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
19 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
21 // OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
22 // WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
23 // OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
24 // ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 #include "nsISupports.idl"
27 #include "base_interface_ff.idl" // XPIDL doesn't like slashes in #includes
28 #include "blob_ff.idl"
31 // GearsDesktopInterface
33 [scriptable, function, uuid(0273640F-FE6D-4a26-95C7-455DE83C6049)]
34 interface GearsDesktopInterface : GearsBaseClassInterface {
36   // icons parameter is expected to be a javascript object with properties for
37   // each available icon size. Valid property names are currently "16x16",
38   // "32x32", "48x48", and "128x128". 
39   void createShortcut(//in string name,
40                       //in string description,
41                       //in string url,
42                       //in object icons
43                       );
45 m4_changequote(`^',`^')m4_dnl
46 m4_ifdef(^DEBUG^,^m4_dnl
47   // This is a quick way to make a blob for now, if you want to play with
48   // binary data in your module.
49   GearsBlobInterface newFileBlob(in AString filename);