~ubuntu-branches/ubuntu/karmic/gears/karmic

« back to all changes in this revision

Viewing changes to gears/base/firefox/interfaces.idl

  • Committer: Bazaar Package Importer
  • Author(s): Stefan Lesicnik
  • Date: 2009-04-30 19:15:25 UTC
  • Revision ID: james.westby@ubuntu.com-20090430191525-0790sb5wzg8ou0xb
Tags: upstream-0.5.21.0~svn3334+dfsg
ImportĀ upstreamĀ versionĀ 0.5.21.0~svn3334+dfsg

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
// Copyright 2006, 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.
 
14
//
 
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.
 
25
 
 
26
#include "nsISupports.idl"
 
27
 
 
28
 
 
29
interface FFHttpRequest; // defined in C++
 
30
[ptr] native FFHttpRequestPtr(FFHttpRequest);
 
31
 
 
32
[noscript, uuid(c1aa6650-21da-4b68-bde4-a2f8cf5cc091)]
 
33
interface SpecialHttpRequestInterface : nsISupports {
 
34
  // This is an interface for use by CacheIntercept.  We QueryInterface
 
35
  // for it to see whether a given request came from Gears.
 
36
  [noscript] FFHttpRequestPtr getNativeHttpRequest();
 
37
};
 
38
 
 
39
 
 
40
// Notionally, this interface is for the GearsFactory object returned by a
 
41
// "new GearsFactory()" call in JavaScript. The method names are accurate, but
 
42
// the arguments, and the return value, are considered only advisory. The
 
43
// underlying GearsFactoryFF implementation delegates to something which is not
 
44
// an XPCOM object, but instead interfaces directly with the JS engine, and not
 
45
// via XPConnect. Hence, we don't need to specify the exact function signature.
 
46
[scriptable, uuid(8A06E8B5-60D2-4268-B2F6-C9AEEAAF8392)]
 
47
interface GearsFactoryInterface : nsISupports {
 
48
  // Args: string className.
 
49
  nsISupports create();
 
50
 
 
51
  // Optional args: string siteName, string imageUrl, string extraMessage.
 
52
  boolean getPermission();
 
53
 
 
54
  AString getBuildInfo();
 
55
 
 
56
  readonly attribute boolean hasPermission;
 
57
  readonly attribute AString version;
 
58
};