docshell/shistory/nsISHContainer.idl
author Wes Kocher <wkocher@mozilla.com>
Thu, 09 Jul 2015 17:43:08 -0700
changeset 252149 fb0c6275d5c2b06d8467c9aa69ff2e50af16ecef
parent 244259 b14c429c72fb1b282c44045f8ed37ab67034b15c
permissions -rw-r--r--
Backed out 5 changesets (bug 1180921) for build failures in BasePrincipal.cpp Backed out changeset d8c1a2e11a9a (bug 1180921) Backed out changeset f4dd8c53df5f (bug 1180921) Backed out changeset b272a0ebf5d8 (bug 1180921) Backed out changeset 8e86b6a7d201 (bug 1180921) Backed out changeset bbdebd7b8881 (bug 1180921)

/* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#include "nsISupports.idl"

interface nsISHEntry;

/**
 * The nsISHEntryContainer. The interface to access child entries
 * of an nsISHEntry.
 * 
 */

[scriptable, uuid(67dd0357-8372-4122-bff6-217435e8b7e4)]
interface nsISHContainer : nsISupports
{
	/**
     * The current number of nsISHEntries which are immediate children of the 
	 * current SHEntry
     */
	readonly attribute long childCount;

	/**
	 * Add a new child SHEntry.  If offset is -1 adds to the end of the list.
	 */
	void AddChild(in nsISHEntry child, in long offset);

	/**
	 * Removes a child SHEntry
	 */
	void RemoveChild(in nsISHEntry child);

	/**
	 * Get child at an index
	 */
	nsISHEntry GetChildAt(in long index);

	/**
	 * Replaces a child which is for the same docshell as aNewChild
	 * with aNewChild.
	 * @throw if nothing was replaced.
	 */
	void ReplaceChild(in nsISHEntry aNewChild);

};