/Users/dietrich/moz/trunk/mozilla/toolkit/components/places/public/nsINavBookmarksService.idl

Go to the documentation of this file.

/* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* ***** 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 Places.
 *
 * The Initial Developer of the Original Code is
 * Google Inc.
 * Portions created by the Initial Developer are Copyright (C) 2005
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *   Brian Ryner <bryner@brianryner.com> (original author)
 *   Joe Hughes <joe@retrovirus.com>
 *   Dietrich Ayala <dietrich@mozilla.com>
 *   Asaf Romano <mano@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"

%{C++
#include "nsTArray.h"
#include "prtypes.h"
%}

interface nsIFile;
interface nsIURI;
interface nsITransaction;
interface nsINavHistoryBatchCallback;

[ptr] native PRInt64Array(nsTArray<PRInt64>);

[scriptable, uuid(f9828ba8-9c70-4d95-b926-60d9e4378d7d)]
interface nsINavBookmarkObserver : nsISupports
{
  void onBeginUpdateBatch();

  void onEndUpdateBatch();

  void onItemAdded(in long long aItemId, in long long aFolder,
                   in long aIndex);

  void onItemRemoved(in long long aItemId, in long long aFolder,
                     in long aIndex);

  void onItemChanged(in long long aBookmarkId, in ACString aProperty,
                     in boolean aIsAnnotationProperty,
                     in AUTF8String aValue);

  void onItemVisited(in long long aBookmarkId, in long long aVisitID,
                     in PRTime time);

  void onItemMoved(in long long aItemId,
                   in long long aOldParent, in long aOldIndex,
                   in long long aNewParent, in long aNewIndex);
};

[scriptable, uuid(3b6ff5c5-0ab4-4aab-b1be-d569763a6ce0)]
interface nsINavBookmarksService : nsISupports
{
  readonly attribute long long placesRoot;

  readonly attribute long long bookmarksMenuFolder;

  readonly attribute long long tagsFolder;

  readonly attribute long long unfiledBookmarksFolder;

  readonly attribute long long toolbarFolder;

  const short DEFAULT_INDEX = -1;

  const unsigned short TYPE_BOOKMARK = 1;
  const unsigned short TYPE_FOLDER = 2;
  const unsigned short TYPE_SEPARATOR = 3;
  const unsigned short TYPE_DYNAMIC_CONTAINER = 4;

  long long insertBookmark(in long long aParentFolder, in nsIURI aURI,
                           in long aIndex, in AUTF8String aTitle);

  void removeItem(in long long aItemId);

  long long createFolder(in long long aParentFolder, in AUTF8String name,
                         in long index);

  long long createDynamicContainer(in long long aParentFolder, in AUTF8String aName,
                                   in AString aContractId, in long aIndex);

  void removeFolder(in long long aFolder);

  nsITransaction getRemoveFolderTransaction(in long long aFolder);

  void removeFolderChildren(in long long aFolder);

  void moveItem(in long long aItemId, in long long aNewParent, in long aIndex);

  long long getChildFolder(in long long aFolder, in AString aSubFolder);

  long long insertSeparator(in long long aFolder, in long aIndex);

  void removeChildAt(in long long aFolder, in long aIndex);

  long long getIdForItemAt(in long long aFolder, in long aIndex);

  AString getItemGUID(in long long aItemId);

  void setItemGUID(in long long aItemId, in AString aGUID);

  long long getItemIdForGUID(in AString aGUID);

  void setItemTitle(in long long aItemId, in AUTF8String aTitle);

  AUTF8String getItemTitle(in long long aItemId);

  void setItemDateAdded(in long long aItemId, in PRTime aDateAdded);
  PRTime getItemDateAdded(in long long aItemId);

  void setItemLastModified(in long long aItemId, in PRTime aLastModified);
  PRTime getItemLastModified(in long long aItemId);

  nsIURI getBookmarkURI(in long long aItemId);

  long getItemIndex(in long long aItemId);

  void setItemIndex(in long long aItemId, in long aNewIndex);

  unsigned short getItemType(in long long aItemId);

  boolean getFolderReadonly(in long long aFolder);

  void setFolderReadonly(in long long aFolder, in boolean aReadOnly);

  boolean isBookmarked(in nsIURI aURI);

  nsIURI getBookmarkedURIFor(in nsIURI aURI);

  void changeBookmarkURI(in long long aItemId, in nsIURI aNewURI);

  long long getFolderIdForItem(in long long aItemId);

  void getBookmarkIdsForURI(in nsIURI aURI, out unsigned long count,
                            [array, retval, size_is(count)] out long long bookmarks);

  [noscript] void getBookmarkIdsForURITArray(in nsIURI aURI,
                                           in PRInt64Array aResult);

  void setKeywordForBookmark(in long long aItemId, in AString aKeyword);

  AString getKeywordForURI(in nsIURI aURI);

  AString getKeywordForBookmark(in long long aItemId);

  nsIURI getURIForKeyword(in AString keyword);

  void addObserver(in nsINavBookmarkObserver observer, in boolean ownsWeak);

  void removeObserver(in nsINavBookmarkObserver observer);

  void runInBatchMode(in nsINavHistoryBatchCallback aCallback,
                      in nsISupports aUserData);
};

---