← Back to branch summary

~ubuntu-branches/ubuntu/precise/kompozer/precise

« back to all changes in this revision

Viewing changes to mozilla/editor/libeditor/base/InsertTextTxn.h

  • Committer: Bazaar Package Importer
  • Author(s): Anthony Yarusso
  • Date: 2007-08-27 01:11:03 UTC
  • Revision ID: james.westby@ubuntu.com-20070827011103-2jgf4s6532gqu2ka
Tags: upstream-0.7.10
Import upstream version 0.7.10

Show diffs side-by-side

added added

removed removed

Lines of Context:
mozilla/editor/libeditor/base/InsertTextTxn.h
 
1
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
 
2
/* ***** BEGIN LICENSE BLOCK *****
 
3
 * Version: NPL 1.1/GPL 2.0/LGPL 2.1
 
4
 *
 
5
 * The contents of this file are subject to the Netscape Public License
 
6
 * Version 1.1 (the "License"); you may not use this file except in
 
7
 * compliance with the License. You may obtain a copy of the License at
 
8
 * http://www.mozilla.org/NPL/
 
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
 *
 
25
 * Alternatively, the contents of this file may be used under the terms of
 
26
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 
27
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 
28
 * in which case the provisions of the GPL or the LGPL are applicable instead
 
29
 * of those above. If you wish to allow use of your version of this file only
 
30
 * under the terms of either the GPL or the LGPL, and not to allow others to
 
31
 * use your version of this file under the terms of the NPL, indicate your
 
32
 * decision by deleting the provisions above and replace them with the notice
 
33
 * and other provisions required by the GPL or the LGPL. If you do not delete
 
34
 * the provisions above, a recipient may use your version of this file under
 
35
 * the terms of any one of the NPL, the GPL or the LGPL.
 
36
 *
 
37
 * ***** END LICENSE BLOCK ***** */
 
38
 
 
39
#ifndef InsertTextTxn_h__
 
40
#define InsertTextTxn_h__
 
41
 
 
42
#include "EditTxn.h"
 
43
#include "nsIDOMCharacterData.h"
 
44
#include "nsIEditor.h"
 
45
#include "nsCOMPtr.h"
 
46
 
 
47
#define INSERT_TEXT_TXN_CID \
 
48
{/* 93276f00-ab2c-11d2-8f4b-006008159b0c*/ \
 
49
0x93276f00, 0xab2c, 0x11d2, \
 
50
{0x8f, 0xb4, 0x0, 0x60, 0x8, 0x15, 0x9b, 0xc} }
 
51
 
 
52
class nsIPresShell;
 
53
 
 
54
/**
 
55
  * A transaction that inserts text into a content node. 
 
56
  */
 
57
class InsertTextTxn : public EditTxn
 
58
{
 
59
public:
 
60
 
 
61
  static const nsIID& GetCID() { static const nsIID iid = INSERT_TEXT_TXN_CID; return iid; }
 
62
 
 
63
  virtual ~InsertTextTxn();
 
64
 
 
65
  /** used to name aggregate transactions that consist only of a single InsertTextTxn,
 
66
    * or a DeleteSelection followed by an InsertTextTxn.
 
67
    */
 
68
  static nsIAtom *gInsertTextTxnName;
 
69
        
 
70
  /** initialize the transaction
 
71
    * @param aElement the text content node
 
72
    * @param aOffset  the location in aElement to do the insertion
 
73
    * @param aString  the new text to insert
 
74
    * @param aPresShell used to get and set the selection
 
75
    */
 
76
  NS_IMETHOD Init(nsIDOMCharacterData *aElement,
 
77
                  PRUint32 aOffset,
 
78
                  const nsAString& aString,
 
79
                  nsIEditor *aEditor);
 
80
 
 
81
private:
 
82
        
 
83
        InsertTextTxn();
 
84
 
 
85
public:
 
86
        
 
87
  NS_IMETHOD DoTransaction(void);
 
88
 
 
89
  NS_IMETHOD UndoTransaction(void);
 
90
 
 
91
  NS_IMETHOD Merge(nsITransaction *aTransaction, PRBool *aDidMerge);
 
92
 
 
93
  NS_IMETHOD GetTxnDescription(nsAString& aTxnDescription);
 
94
 
 
95
// nsISupports declarations
 
96
 
 
97
  // override QueryInterface to handle InsertTextTxn request
 
98
  NS_IMETHOD QueryInterface(const nsIID& aIID, void** aInstancePtr);
 
99
 
 
100
  /** return the string data associated with this transaction */
 
101
  NS_IMETHOD GetData(nsString& aResult);
 
102
 
 
103
  /** must be called before any InsertTextTxn is instantiated */
 
104
  static nsresult ClassInit();
 
105
 
 
106
  /** must be called once we are guaranteed all InsertTextTxn have completed */
 
107
  static nsresult ClassShutdown();
 
108
 
 
109
protected:
 
110
 
 
111
  /** return PR_TRUE if aOtherTxn immediately follows this txn */
 
112
  virtual PRBool IsSequentialInsert(InsertTextTxn *aOtherTxn);
 
113
  
 
114
  /** the text element to operate upon */
 
115
  nsCOMPtr<nsIDOMCharacterData> mElement;
 
116
  
 
117
  /** the offset into mElement where the insertion is to take place */
 
118
  PRUint32 mOffset;
 
119
 
 
120
  /** the text to insert into mElement at mOffset */
 
121
  nsString mStringToInsert;
 
122
 
 
123
  /** the editor, which we'll need to get the selection */
 
124
  nsIEditor *mEditor;   
 
125
 
 
126
  friend class TransactionFactory;
 
127
 
 
128
  friend class nsDerivedSafe<InsertTextTxn>; // work around for a compiler bug
 
129
 
 
130
};
 
131
 
 
132
#endif