Back to index

lightning-sunbird  0.9+nobinonly
nsDocShellEditorData.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
00002  *
00003  * ***** BEGIN LICENSE BLOCK *****
00004  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00005  *
00006  * The contents of this file are subject to the Mozilla Public License Version
00007  * 1.1 (the "License"); you may not use this file except in compliance with
00008  * the License. You may obtain a copy of the License at
00009  * http://www.mozilla.org/MPL/
00010  *
00011  * Software distributed under the License is distributed on an "AS IS" basis,
00012  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00013  * for the specific language governing rights and limitations under the
00014  * License.
00015  *
00016  * The Original Code is the Mozilla browser.
00017  *
00018  * The Initial Developer of the Original Code is
00019  * Netscape Communications, Inc.
00020  * Portions created by the Initial Developer are Copyright (C) 1999
00021  * the Initial Developer. All Rights Reserved.
00022  *
00023  * Contributor(s):
00024  *   Simon Fraser <sfraser@netscape.com>
00025  *
00026  * Alternatively, the contents of this file may be used under the terms of
00027  * either of the GNU General Public License Version 2 or later (the "GPL"),
00028  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00029  * in which case the provisions of the GPL or the LGPL are applicable instead
00030  * of those above. If you wish to allow use of your version of this file only
00031  * under the terms of either the GPL or the LGPL, and not to allow others to
00032  * use your version of this file under the terms of the MPL, indicate your
00033  * decision by deleting the provisions above and replace them with the notice
00034  * and other provisions required by the GPL or the LGPL. If you do not delete
00035  * the provisions above, a recipient may use your version of this file under
00036  * the terms of any one of the MPL, the GPL or the LGPL.
00037  *
00038  * ***** END LICENSE BLOCK ***** */
00039 #ifndef nsDocShellEditorData_h__
00040 #define nsDocShellEditorData_h__
00041 
00042 #ifndef nsCOMPtr_h___
00043 #include "nsCOMPtr.h"
00044 #endif
00045 
00046 #ifndef __gen_nsIDocShell_h__
00047 #include "nsIDocShell.h"
00048 #endif
00049 
00050 #ifndef __gen_nsIEditingSession_h__
00051 #include "nsIEditingSession.h"
00052 #endif
00053 
00054 
00055 #include "nsIEditor.h"
00056 
00057 
00058 // a non-XPCOM class that is used to store per-docshell editor-related
00059 // data.
00060 
00061 class nsDocShellEditorData
00062 {
00063 public:
00064 
00065               nsDocShellEditorData(nsIDocShell* inOwningDocShell);
00066               ~nsDocShellEditorData();
00067               
00068 
00069   // set a flag to say this frame should be editable when the next url loads
00070   nsresult    MakeEditable(PRBool inWaitForUriLoad);
00071   
00072   PRBool      GetEditable();
00073   
00074               // actually create the editor for this docShell
00075   nsresult    CreateEditor();
00076   
00077               // get the editing session. The editing session always lives on the content
00078               // root docShell; this call may crawl up the frame tree to find it.
00079   nsresult    GetEditingSession(nsIEditingSession **outEditingSession);
00080   
00081               // get the editor for this docShell. May return null but NS_OK
00082   nsresult    GetEditor(nsIEditor **outEditor);
00083   
00084               // set the editor on this docShell
00085   nsresult    SetEditor(nsIEditor *inEditor);
00086 
00087   // Tear down the editor on this docshell, if any.
00088   void        TearDownEditor();
00089 
00090 protected:              
00091 
00092   nsresult    EnsureEditingSession();
00093 
00094 protected:
00095 
00096   nsIDocShell*                mDocShell;        // the doc shell that owns us. Weak ref, since it always outlives us.  
00097   
00098   nsCOMPtr<nsIEditingSession> mEditingSession;  // only present for the content root docShell. Session is owned here
00099 
00100   PRBool                      mMakeEditable;    // indicates whether to make an editor after a url load
00101   nsCOMPtr<nsIEditor>         mEditor;          // if this frame is editable, store editor here. Editor is owned here.
00102 
00103 };
00104 
00105 
00106 #endif // nsDocShellEditorData_h__