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
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 nsEditRules_h__
39 : #define nsEditRules_h__
40 :
41 : // FB45AC36-E8F1-44ae-8FB7-466E1BE119B0
42 : #define NS_IEDITRULES_IID \
43 : { 0x2cc50d11, 0x9909, 0x433f, \
44 : { 0xb6, 0xfb, 0x4c, 0xf2, 0x56, 0xe5, 0xe5, 0x71 } }
45 :
46 : class nsPlaintextEditor;
47 : class nsISelection;
48 :
49 : /***************************************************************************
50 : * base for an object to encapsulate any additional info needed to be passed
51 : * to rules system by the editor
52 : */
53 : class nsRulesInfo
54 : {
55 : public:
56 :
57 0 : nsRulesInfo(int aAction) : action(aAction) {}
58 0 : virtual ~nsRulesInfo() {}
59 :
60 : int action;
61 : };
62 :
63 : /***************************************************************************
64 : * Interface of editing rules.
65 : *
66 : */
67 : class nsIEditRules : public nsISupports
68 0 : {
69 : public:
70 : NS_DECLARE_STATIC_IID_ACCESSOR(NS_IEDITRULES_IID)
71 :
72 : //Interfaces for addref and release and queryinterface
73 : //NOTE: Use NS_DECL_ISUPPORTS_INHERITED in any class inherited from nsIEditRules
74 :
75 : NS_IMETHOD Init(nsPlaintextEditor *aEditor)=0;
76 : NS_IMETHOD DetachEditor()=0;
77 : NS_IMETHOD BeforeEdit(PRInt32 action, nsIEditor::EDirection aDirection)=0;
78 : NS_IMETHOD AfterEdit(PRInt32 action, nsIEditor::EDirection aDirection)=0;
79 : NS_IMETHOD WillDoAction(nsISelection *aSelection, nsRulesInfo *aInfo, bool *aCancel, bool *aHandled)=0;
80 : NS_IMETHOD DidDoAction(nsISelection *aSelection, nsRulesInfo *aInfo, nsresult aResult)=0;
81 : NS_IMETHOD DocumentIsEmpty(bool *aDocumentIsEmpty)=0;
82 : NS_IMETHOD DocumentModified()=0;
83 : };
84 :
85 : NS_DEFINE_STATIC_IID_ACCESSOR(nsIEditRules, NS_IEDITRULES_IID)
86 :
87 : #endif //nsEditRules_h__
88 :
|