extIApplication.idl

Go to the documentation of this file.

/* ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is FUEL.
 *
 * The Initial Developer of the Original Code is Mozilla Corporation.
 * Portions created by the Initial Developer are Copyright (C) 2006
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *  Joey Minta  <jminta@gmail.com> (Original Author)
 *  Mark Finkle <mfinkle@mozilla.com>
 *  John Resig  <jresig@mozilla.com>
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */

#include "nsISupports.idl"

interface nsIVariant;
interface extIPreference;
interface extISessionStorage;


[scriptable, uuid(ae8482e0-aa5a-11db-abbd-0800200c9a66)]
interface extIConsole : nsISupports
{
  void log(in AString aMsg);

  void open();
};


[scriptable, function, uuid(05281820-ab62-11db-abbd-0800200c9a66)]
interface extIEventItem : nsISupports
{
  readonly attribute AString type;

  readonly attribute nsIVariant data;

  void preventDefault();
}; 


[scriptable, function, uuid(2dfe3a50-ab2f-11db-abbd-0800200c9a66)]
interface extIEventListener : nsISupports
{
  void handleEvent(in extIEventItem aEvent);
}; 


[scriptable, uuid(3a8ec9d0-ab19-11db-abbd-0800200c9a66)]
interface extIEvents : nsISupports
{
  void addListener(in AString aEvent, in extIEventListener aListener);

  void removeListener(in AString aEvent, in extIEventListener aListener);
}; 


[scriptable, uuid(ce697d40-aa5a-11db-abbd-0800200c9a66)]
interface extIPreferenceBranch : nsISupports
{
  readonly attribute AString root;
  
  readonly attribute nsIVariant all;
  
  readonly attribute extIEvents events;
  
  boolean has(in AString aName);
  
  extIPreference get(in AString aName);
  
  nsIVariant getValue(in AString aName, in nsIVariant aDefaultValue);

  void setValue(in AString aName, in nsIVariant aValue);

  void reset();
};

[scriptable, uuid(2C7462E2-72C2-4473-9007-0E6AE71E23CA)]
interface extIPreference : nsISupports
{
  readonly attribute AString name;
  
  readonly attribute AString type;
  
  attribute nsIVariant value;
  
  attribute boolean locked;
  
  readonly attribute boolean modified;
  
  readonly attribute extIPreferenceBranch branch;
  
  readonly attribute extIEvents events;
  
  void reset();
};


[scriptable, uuid(10cee02c-f6e0-4d61-ab27-c16572b18c46)]
interface extIExtension : nsISupports
{
  readonly attribute AString id;

  readonly attribute AString name;
  
  readonly attribute boolean enabled;
  
  readonly attribute AString version;

  readonly attribute boolean firstRun;

  readonly attribute extIPreferenceBranch prefs;

  readonly attribute extISessionStorage storage;

  readonly attribute extIEvents events;
}; 


[scriptable, uuid(de281930-aa5a-11db-abbd-0800200c9a66)]
interface extIExtensions : nsISupports
{
  readonly attribute nsIVariant all;

  boolean has(in AString aId);

  extIExtension get(in AString aId);
}; 

[scriptable, uuid(0787ac44-29b9-4889-b97f-13573aec6971)]
interface extISessionStorage : nsISupports
{
  readonly attribute extIEvents events;

  boolean has(in AString aName);

  void set(in AString aName, in nsIVariant aValue);

  nsIVariant get(in AString aName, in nsIVariant aDefaultValue);
}; 

[scriptable, uuid(e53d6610-7468-11dd-ad8b-0800200c9a66)]
interface extIApplication : nsISupports
{
  readonly attribute AString id;

  readonly attribute AString name;
  
  readonly attribute AString version;
  
  readonly attribute extIConsole console;

  readonly attribute extIExtensions extensions;

  readonly attribute extIPreferenceBranch prefs;

  readonly attribute extISessionStorage storage;

  readonly attribute extIEvents events;

  boolean quit();

  boolean restart();
};