michael@0: /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
michael@0: /* This Source Code Form is subject to the terms of the Mozilla Public
michael@0:  * License, v. 2.0. If a copy of the MPL was not distributed with this
michael@0:  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
michael@0: 
michael@0: #include "nsISupports.idl"
michael@0: 
michael@0: interface nsILoadGroup;
michael@0: 
michael@0: /**
michael@0:  * nsILoadGroupChild provides a hierarchy of load groups so that the
michael@0:  * root load group can be used to conceptually tie a series of loading
michael@0:  * operations into a logical whole while still leaving them separate
michael@0:  * for the purposes of cancellation and status events.
michael@0:  */
michael@0: 
michael@0: [scriptable, uuid(02efe8e2-fbbc-4718-a299-b8a09c60bf6b)]
michael@0: interface nsILoadGroupChild : nsISupports
michael@0: {
michael@0:     /**
michael@0:      * The parent of this load group. It is stored with
michael@0:      * a nsIWeakReference/nsWeakPtr so there is no requirement for the
michael@0:      * parentLoadGroup to out live the child, nor will the child keep a
michael@0:      * reference count on the parent.
michael@0:      */
michael@0:     attribute nsILoadGroup parentLoadGroup;
michael@0: 
michael@0:     /**
michael@0:      * The nsILoadGroup associated with this nsILoadGroupChild
michael@0:      */
michael@0:     readonly attribute nsILoadGroup childLoadGroup;
michael@0: 
michael@0:     /**
michael@0:      * The rootLoadGroup is the recursive parent of this
michael@0:      * load group where parent is defined as parentlLoadGroup if set
michael@0:      * or childLoadGroup.loadGroup as a backup. (i.e. parentLoadGroup takes
michael@0:      * precedence.) The nsILoadGroup child is the root if neither parent
michael@0:      * nor loadgroup attribute is specified.
michael@0:      */
michael@0:     readonly attribute nsILoadGroup rootLoadGroup;
michael@0: };
michael@0: