1 : /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
2 : *
3 : * ***** BEGIN LICENSE BLOCK *****
4 : * Version: MPL 1.1/GPL 2.0/LGPL 2.1
5 : *
6 : * The contents of this file are subject to the Mozilla Public License Version
7 : * 1.1 (the "License"); you may not use this file except in compliance with
8 : * the License. You may obtain a copy of the License at
9 : * http://www.mozilla.org/MPL/
10 : *
11 : * Software distributed under the License is distributed on an "AS IS" basis,
12 : * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
13 : * for the specific language governing rights and limitations under the
14 : * License.
15 : *
16 : * The Original Code is the Mozilla browser.
17 : *
18 : * The Initial Developer of the Original Code is
19 : * Netscape Communications, Inc.
20 : * Portions created by the Initial Developer are Copyright (C) 1999
21 : * the Initial Developer. All Rights Reserved.
22 : *
23 : * Contributor(s):
24 : * Simon Fraser <sfraser@netscape.com>
25 : *
26 : * Alternatively, the contents of this file may be used under the terms of
27 : * either of the GNU General Public License Version 2 or later (the "GPL"),
28 : * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
29 : * in which case the provisions of the GPL or the LGPL are applicable instead
30 : * of those above. If you wish to allow use of your version of this file only
31 : * under the terms of either the GPL or the LGPL, and not to allow others to
32 : * use your version of this file under the terms of the MPL, indicate your
33 : * decision by deleting the provisions above and replace them with the notice
34 : * and other provisions required by the GPL or the LGPL. If you do not delete
35 : * the provisions above, a recipient may use your version of this file under
36 : * the terms of any one of the MPL, the GPL or the LGPL.
37 : *
38 : * ***** END LICENSE BLOCK ***** */
39 : #ifndef nsDocShellEditorData_h__
40 : #define nsDocShellEditorData_h__
41 :
42 : #ifndef nsCOMPtr_h___
43 : #include "nsCOMPtr.h"
44 : #endif
45 :
46 : #ifndef __gen_nsIDocShell_h__
47 : #include "nsIDocShell.h"
48 : #endif
49 :
50 : #ifndef __gen_nsIEditingSession_h__
51 : #include "nsIEditingSession.h"
52 : #endif
53 :
54 :
55 : #include "nsIHTMLDocument.h"
56 : #include "nsIEditor.h"
57 :
58 : class nsIDOMWindow;
59 :
60 : class nsDocShellEditorData
61 : {
62 : public:
63 :
64 : nsDocShellEditorData(nsIDocShell* inOwningDocShell);
65 : ~nsDocShellEditorData();
66 :
67 : nsresult MakeEditable(bool inWaitForUriLoad);
68 : bool GetEditable();
69 : nsresult CreateEditor();
70 : nsresult GetEditingSession(nsIEditingSession **outEditingSession);
71 : nsresult GetEditor(nsIEditor **outEditor);
72 : nsresult SetEditor(nsIEditor *inEditor);
73 : void TearDownEditor();
74 : nsresult DetachFromWindow();
75 : nsresult ReattachToWindow(nsIDocShell *aDocShell);
76 0 : bool WaitingForLoad() const { return mMakeEditable; }
77 :
78 : protected:
79 :
80 : nsresult EnsureEditingSession();
81 :
82 : // The doc shell that owns us. Weak ref, since it always outlives us.
83 : nsIDocShell* mDocShell;
84 :
85 : // Only present for the content root docShell. Session is owned here.
86 : nsCOMPtr<nsIEditingSession> mEditingSession;
87 :
88 : // Indicates whether to make an editor after a url load.
89 : bool mMakeEditable;
90 :
91 : // If this frame is editable, store editor here. Editor is owned here.
92 : nsCOMPtr<nsIEditor> mEditor;
93 :
94 : // Denotes if the editor is detached from its window. The editor is detached
95 : // while it's stored in the session history bfcache.
96 : bool mIsDetached;
97 :
98 : // Backup for mMakeEditable while the editor is detached.
99 : bool mDetachedMakeEditable;
100 :
101 : // Backup for the corresponding nsIHTMLDocument's editing state while
102 : // the editor is detached.
103 : nsIHTMLDocument::EditingState mDetachedEditingState;
104 :
105 : };
106 :
107 :
108 : #endif // nsDocShellEditorData_h__
|