1 : /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
2 : /* ***** BEGIN LICENSE BLOCK *****
3 : * Version: MPL 1.1/GPL 2.0/LGPL 2.1
4 : *
5 : * The contents of this file are subject to the Mozilla Public License Version
6 : * 1.1 (the "License"); you may not use this file except in compliance with
7 : * the License. You may obtain a copy of the License at
8 : * http://www.mozilla.org/MPL/
9 : *
10 : * Software distributed under the License is distributed on an "AS IS" basis,
11 : * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
12 : * for the specific language governing rights and limitations under the
13 : * License.
14 : *
15 : * The Original Code is mozilla.org code.
16 : *
17 : * The Initial Developer of the Original Code is
18 : * Netscape Communications Corporation.
19 : * Portions created by the Initial Developer are Copyright (C) 1998-1999
20 : * the Initial Developer. All Rights Reserved.
21 : *
22 : * Contributor(s):
23 : *
24 : * Alternatively, the contents of this file may be used under the terms of
25 : * either of the GNU General Public License Version 2 or later (the "GPL"),
26 : * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
27 : * in which case the provisions of the GPL or the LGPL are applicable instead
28 : * of those above. If you wish to allow use of your version of this file only
29 : * under the terms of either the GPL or the LGPL, and not to allow others to
30 : * use your version of this file under the terms of the MPL, indicate your
31 : * decision by deleting the provisions above and replace them with the notice
32 : * and other provisions required by the GPL or the LGPL. If you do not delete
33 : * the provisions above, a recipient may use your version of this file under
34 : * the terms of any one of the MPL, the GPL or the LGPL.
35 : *
36 : * ***** END LICENSE BLOCK ***** */
37 :
38 : #ifndef SetDocTitleTxn_h__
39 : #define SetDocTitleTxn_h__
40 :
41 : #include "EditTxn.h"
42 : #include "nsIEditor.h"
43 : #include "nsIHTMLEditor.h"
44 : #include "nsITransaction.h"
45 : #include "nsCOMPtr.h"
46 :
47 : /**
48 : * A transaction that changes the document's title,
49 : * which is a text node under the <title> tag in a page's <head> section
50 : * provides default concrete behavior for all nsITransaction methods.
51 : */
52 : class SetDocTitleTxn : public EditTxn
53 0 : {
54 : public:
55 : /** Initialize the transaction.
56 : * @param aEditor the object providing core editing operations
57 : * @param aValue the new value for document title
58 : */
59 : NS_IMETHOD Init(nsIHTMLEditor *aEditor,
60 : const nsAString *aValue);
61 : SetDocTitleTxn();
62 : private:
63 : nsresult SetDomTitle(const nsAString& aTitle);
64 :
65 : public:
66 : NS_DECL_EDITTXN
67 :
68 : NS_IMETHOD RedoTransaction();
69 : NS_IMETHOD GetIsTransient(bool *aIsTransient);
70 :
71 : protected:
72 :
73 : /** the editor that created this transaction */
74 : nsIHTMLEditor* mEditor;
75 :
76 : /** The new title string */
77 : nsString mValue;
78 :
79 : /** The previous title string to use for undo */
80 : nsString mUndoValue;
81 :
82 : /** Set true if we dont' really change the title during Do() */
83 : bool mIsTransient;
84 : };
85 :
86 : #endif
|