1 /* ***** BEGIN LICENSE BLOCK *****
2 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
3 *
4 * The contents of this file are subject to the Mozilla Public License Version
5 * 1.1 (the "License"); you may not use this file except in compliance with
6 * the License. You may obtain a copy of the License at
7 * http://www.mozilla.org/MPL/
8 *
9 * Software distributed under the License is distributed on an "AS IS" basis,
10 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
11 * for the specific language governing rights and limitations under the
12 * License.
13 *
14 * The Original Code is mozilla.org code.
15 *
16 * The Initial Developer of the Original Code is
17 * Nick Kreeger <nick.kreeger@park.edu>
18 * Portions created by the Initial Developer are Copyright (C) 2007
19 * the Initial Developer. All Rights Reserved.
20 *
21 * Contributor(s):
22 *
23 * Alternatively, the contents of this file may be used under the terms of
24 * either of the GNU General Public License Version 2 or later (the "GPL"),
25 * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
26 * in which case the provisions of the GPL or the LGPL are applicable instead
27 * of those above. If you wish to allow use of your version of this file only
28 * under the terms of either the GPL or the LGPL, and not to allow others to
29 * use your version of this file under the terms of the MPL, indicate your
30 * decision by deleting the provisions above and replace them with the notice
31 * and other provisions required by the GPL or the LGPL. If you do not delete
32 * the provisions above, a recipient may use your version of this file under
33 * the terms of any one of the MPL, the GPL or the LGPL.
34 *
35 * ***** END LICENSE BLOCK ***** */
36
37 #include "nsISupports.idl"
38 interface nsIUrlListener;
39 interface nsIMsgWindow;
40 interface nsIWebProgressListener;
41
42 [scriptable, uuid(D1B43428-B631-4629-B691-AB0E01A2DB4B)]
43 interface nsIMsgShutdownTask : nsISupports
44 {
45 /**
46 * Inform the caller wheter or not the task needs to be run. This method
47 * gives the task the flexibility to cancel running a task on shutdown
48 * if nothing needs to be run.
49 */
50 readonly attribute boolean needsToRunTask;
51
52 /**
53 * At shutdown-time, this function will be called to all registered implementors.
54 * Shutdown will be temporarily postponed until |OnStopRequest()| has been called
55 * on the passed in url-listener.
56 * @param inUrlListener The URL listener to report events to.
57 * @param inMsgWindow The current message window to allow for posing dialogs.
58 * @return If the shutdown URL was run or not. If the URL is running, the task
59 * will be responsible for notifying |inUrlListener| when the task is completed.
60 */
61 boolean doShutdownTask(in nsIUrlListener inUrlListener, in nsIMsgWindow inMsgWindow);
62
63 /**
64 * Get the displayable name of the current task. This textual information will be
65 * shown to the user so they know what shutdown task is being performed.
66 * @return The name of the current task being performed.
67 */
68 AString getCurrentTaskName();
69 };
70
71 [scriptable, uuid(483C8ABB-ECF9-48A3-A394-2C604B603BD5)]
72 interface nsIMsgShutdownService : nsISupports
73 {
74 /**
75 * Get the number of tasks that will need to be processed at shutdown time.
76 * @return The number of shutdown tasks to do.
77 */
78 long getNumTasks();
79
80 /**
81 * Start the shutdown tasks.
82 */
83 void startShutdownTasks();
84
85 /**
86 * Tell the service to stop running tasks and go ahead and shutdown the application.
87 */
88 void cancelShutdownTasks();
89
90 /**
91 * Set the shutdown listener.
92 */
93 void setShutdownListener(in nsIWebProgressListener inListener);
94
95 /**
96 * Set the status text of the shutdown progress dialog.
97 */
98 void setStatusText(in AString inStatusString);
99 };