gecko-dev/editor/libeditor/base/nsEditRules.h

73 lines
2.4 KiB
C++

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
*
* The contents of this file are subject to the Netscape Public
* License Version 1.1 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.mozilla.org/NPL/
*
* Software distributed under the License is distributed on an "AS
* IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
* implied. See the License for the specific language governing
* rights and limitations under the License.
*
* The Original Code is mozilla.org code.
*
* The Initial Developer of the Original Code is Netscape
* Communications Corporation. Portions created by Netscape are
* Copyright (C) 1998 Netscape Communications Corporation. All
* Rights Reserved.
*
* Contributor(s):
*/
#ifndef nsEditRules_h__
#define nsEditRules_h__
#define NS_IEDITRULES_IID \
{ /* a6cf911d-15b3-11d2-932e-00805f8add32 */ \
0xa6cf911d, 0x15b3, 0x11d2, \
{0x93, 0x2e, 0x00, 0x80, 0x5f, 0x8a, 0xdd, 0x32} }
class nsPlaintextEditor;
class nsISelection;
/***************************************************************************
* base for an object to encapsulate any additional info needed to be passed
* to rules system by the editor
*/
class nsRulesInfo
{
public:
nsRulesInfo(int aAction) : action(aAction) {}
virtual ~nsRulesInfo() {}
int action;
};
/***************************************************************************
* Interface of editing rules.
*
*/
class nsIEditRules : public nsISupports
{
public:
static const nsIID& GetIID() { static nsIID iid = NS_IEDITRULES_IID; return iid; }
//Interfaces for addref and release and queryinterface
//NOTE: Use NS_DECL_ISUPPORTS_INHERITED in any class inherited from nsIEditRules
NS_IMETHOD Init(nsPlaintextEditor *aEditor, PRUint32 aFlags)=0;
NS_IMETHOD BeforeEdit(PRInt32 action, nsIEditor::EDirection aDirection)=0;
NS_IMETHOD AfterEdit(PRInt32 action, nsIEditor::EDirection aDirection)=0;
NS_IMETHOD WillDoAction(nsISelection *aSelection, nsRulesInfo *aInfo, PRBool *aCancel, PRBool *aHandled)=0;
NS_IMETHOD DidDoAction(nsISelection *aSelection, nsRulesInfo *aInfo, nsresult aResult)=0;
NS_IMETHOD GetFlags(PRUint32 *aFlags)=0;
NS_IMETHOD SetFlags(PRUint32 aFlags)=0;
NS_IMETHOD DocumentIsEmpty(PRBool *aDocumentIsEmpty)=0;
};
#endif //nsEditRules_h__