gecko/editor/libeditor/base/DeleteRangeTxn.h

114 lines
3.6 KiB
C++

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Mozilla 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/MPL/
*
* 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 the Initial Developer are Copyright (C) 1998-1999
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
*
* Alternatively, the contents of this file may be used under the terms of
* either of the GNU General Public License Version 2 or later (the "GPL"),
* or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the MPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
#ifndef DeleteRangeTxn_h__
#define DeleteRangeTxn_h__
#include "EditAggregateTxn.h"
#include "nsIDOMNode.h"
#include "nsIDOMRange.h"
#include "nsIEditor.h"
#include "nsCOMPtr.h"
class nsIDOMRange;
class nsIEditor;
class nsRangeUpdater;
/**
* A transaction that deletes an entire range in the content tree
*/
class DeleteRangeTxn : public EditAggregateTxn
{
public:
/** initialize the transaction.
* @param aEditor the object providing basic editing operations
* @param aRange the range to delete
*/
NS_IMETHOD Init(nsIEditor *aEditor,
nsIDOMRange *aRange,
nsRangeUpdater *aRangeUpdater);
DeleteRangeTxn();
NS_DECL_CYCLE_COLLECTION_CLASS_INHERITED(DeleteRangeTxn, EditAggregateTxn)
NS_IMETHOD QueryInterface(REFNSIID aIID, void** aInstancePtr);
NS_DECL_EDITTXN
NS_IMETHOD RedoTransaction();
protected:
NS_IMETHOD CreateTxnsToDeleteBetween(nsIDOMNode *aStartParent,
PRUint32 aStartOffset,
PRUint32 aEndOffset);
NS_IMETHOD CreateTxnsToDeleteNodesBetween();
NS_IMETHOD CreateTxnsToDeleteContent(nsIDOMNode *aParent,
PRUint32 aOffset,
nsIEditor::EDirection aAction);
protected:
/** p1 in the range */
nsCOMPtr<nsIDOMRange> mRange; // is this really an owning ptr?
/** p1 in the range */
nsCOMPtr<nsIDOMNode> mStartParent;
/** p1 offset */
PRInt32 mStartOffset;
/** p2 in the range */
nsCOMPtr<nsIDOMNode> mEndParent;
/** the closest common parent of p1 and p2 */
nsCOMPtr<nsIDOMNode> mCommonParent;
/** p2 offset */
PRInt32 mEndOffset;
/** the editor for this transaction */
nsIEditor* mEditor;
/** range updater object */
nsRangeUpdater *mRangeUpdater;
};
#endif