gecko-dev/embedding/browser/webBrowser/nsIProgressListener.idl

73 строки
2.7 KiB
Plaintext

/* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
*
* 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 the Mozilla browser.
*
* The Initial Developer of the Original Code is Netscape
* Communications, Inc. Portions created by Netscape are
* Copyright (C) 1999, Mozilla. All Rights Reserved.
*
* Contributor(s):
* Travis Bogard <travis@netscape.com>
*/
#include "nsISupports.idl"
/**
* The nsIProgressListener is the interface implemented by clients wishing to
* listen in on a progress object.
*/
[scriptable, uuid(69E5DF05-7B8B-11d3-AF61-00A024FFC08C)]
interface nsIProgressListener : nsISupports
{
/*
Notification that the number of child parts has changed.
@param numChildParts - The current number of childParts.
*/
void onChildCountChange(in long numChildParts);
/*
Notification of that the progress has changed for this object.
@param curSelfProgress - The current position of progress. This is
between 0 and maxSelfProgress. This is the position of only this
progress object. It doesn not include the progress of all children.
@param maxSelfProgress - The maximum position that progress will go to.
This sets a relative position point for the current progress to relate
to. This is the max position of only this progress object. It does not
include the progress of all the children.
@param curTotalProgress - The current position of progress for this object
and all children added together. This is between 0 and maxTotalProgress.
@param maxTotalProgress - The maximum position that progress will go to for
the max of this progress object and all children. This sets the relative
position point for the current progress to relate to.
*/
void onProgressChange(in long curSelfProgress, in long maxSelfProgress,
in long curTotalProgress, in long maxTotalProgress);
/*
Notification that the status has changed.
@param active - Simple boolean to know if the browser is active or not.
This is only a convience method to avoid having to check all the possible
connectionStatus to resolve to a simple yes or no active question.
@param connectionStatus - This is the current connectionStatus. This will
be one of the progress connection steps.
*/
void onStatusChange(in boolean active, in long connectionStatus);
};