fuelIApplication.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):
 *  Mark Finkle <mfinkle@mozilla.com> (Original Author)
 *  John Resig  <jresig@mozilla.com> (Original Author)
 *
 * 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"
#include "extIApplication.idl"

interface nsIVariant;
interface nsIURI;
interface nsIDOMHTMLDocument;

interface fuelIBookmarkFolder;
interface fuelIBrowserTab;

[scriptable, uuid(335c9292-91a1-4ca0-ad0b-07d5f63ed6cd)]
interface fuelIAnnotations : nsISupports
{
  readonly attribute nsIVariant names;

  boolean has(in AString aName);

  nsIVariant get(in AString aName);

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

  void remove(in AString aName);
};


[scriptable, uuid(808585b6-7568-4b26-8c62-545221bf2b8c)]
interface fuelIBookmark : nsISupports
{
  readonly attribute long long id;

  attribute AString title;

  attribute nsIURI uri;

  attribute AString description;

  attribute AString keyword;

  readonly attribute AString type;

  attribute fuelIBookmarkFolder parent;

  readonly attribute fuelIAnnotations annotations;

  readonly attribute extIEvents events;

  void remove();
};


[scriptable, uuid(9f42fe20-52de-4a55-8632-a459c7716aa0)]
interface fuelIBookmarkFolder : nsISupports
{
  readonly attribute long long id;

  attribute AString title;

  attribute AString description;

  readonly attribute AString type;

  attribute fuelIBookmarkFolder parent;

  readonly attribute fuelIAnnotations annotations;

  readonly attribute extIEvents events;

  readonly attribute nsIVariant children;

  fuelIBookmark addBookmark(in AString aTitle, in nsIURI aURI);

  fuelIBookmark addSeparator();

  fuelIBookmarkFolder addFolder(in AString aTitle);

  void remove();
};

[scriptable, uuid(c9a80870-eb3c-11dc-95ff-0800200c9a66)]
interface fuelIBookmarkRoots : nsISupports
{
  readonly attribute fuelIBookmarkFolder menu;

  readonly attribute fuelIBookmarkFolder toolbar;

  readonly attribute fuelIBookmarkFolder tags;

  readonly attribute fuelIBookmarkFolder unfiled;
};

[scriptable, uuid(207edb28-eb5e-424e-a862-b0e97C8de866)]
interface fuelIWindow : nsISupports
{
  readonly attribute nsIVariant tabs;

  readonly attribute fuelIBrowserTab activeTab;

  fuelIBrowserTab open(in nsIURI aURI);

  readonly attribute extIEvents events;
};

[scriptable, uuid(3073ceff-777c-41ce-9ace-ab37268147c1)]
interface fuelIBrowserTab : nsISupports
{
  readonly attribute nsIURI uri;

  readonly attribute PRInt32 index;

  readonly attribute fuelIWindow window;

  readonly attribute nsIDOMHTMLDocument document;

  readonly attribute extIEvents events;

  void load(in nsIURI aURI);

  void focus();

  void close();

  void moveBefore(in fuelIBrowserTab aBefore);

  void moveToEnd();
};

[scriptable, uuid(fe74cf80-aa2d-11db-abbd-0800200c9a66)]
interface fuelIApplication : extIApplication
{
  readonly attribute fuelIBookmarkRoots bookmarks;

  readonly attribute nsIVariant windows;

  readonly attribute fuelIWindow activeWindow;
};