Back to index

lightning-sunbird  0.9+nobinonly
nsIEditingSession.idl
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is mozilla.org code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 1998
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *   Simon Fraser   <sfraser@netscape.com>
00024  *   Mike Judge     <mjudge@netscape.com>
00025  *   Charles Manske <cmanske@netscape.com>
00026  *
00027  * Alternatively, the contents of this file may be used under the terms of
00028  * either of the GNU General Public License Version 2 or later (the "GPL"),
00029  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00030  * in which case the provisions of the GPL or the LGPL are applicable instead
00031  * of those above. If you wish to allow use of your version of this file only
00032  * under the terms of either the GPL or the LGPL, and not to allow others to
00033  * use your version of this file under the terms of the MPL, indicate your
00034  * decision by deleting the provisions above and replace them with the notice
00035  * and other provisions required by the GPL or the LGPL. If you do not delete
00036  * the provisions above, a recipient may use your version of this file under
00037  * the terms of any one of the MPL, the GPL or the LGPL.
00038  *
00039  * ***** END LICENSE BLOCK ***** */
00040 
00041 #include "nsISupports.idl"
00042 #include "domstubs.idl"
00043 
00044 interface nsIEditor;
00045 interface nsIEditingShell;
00046 
00047 [scriptable, uuid(d39fd2b4-3978-45d2-a4be-ba448171b61b)]
00048 
00049 interface nsIEditingSession : nsISupports
00050 {
00055   const long eEditorOK = 0;
00056   const long eEditorCreationInProgress = 1;
00057   const long eEditorErrorCantEditMimeType = 2;
00058   const long eEditorErrorFileNotFound = 3;
00059   const long eEditorErrorCantEditFramesets = 8;
00060   const long eEditorErrorUnknown = 9;
00061 
00066   readonly attribute unsigned long editorStatus;
00067 
00073   void makeWindowEditable(in nsIDOMWindow window, in string aEditorType, in boolean doAfterUriLoad);
00074   
00082   boolean windowIsEditable(in nsIDOMWindow window);
00083   
00087        nsIEditor getEditorForWindow(in nsIDOMWindow window);   
00088 
00092   void setupEditorOnWindow(in nsIDOMWindow window);
00093 
00097   void tearDownEditorOnWindow(in nsIDOMWindow window);
00098 
00099   void setEditorOnControllers(in nsIDOMWindow aWindow,
00100                               in nsIEditor aEditor);
00101 
00102 };
00103