gecko-dev/editor/base/InsertTableTxn.h

/* -*- 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.0 (the "NPL"); you may not use this file except in
 * compliance with the NPL.  You may obtain a copy of the NPL at
 * http://www.mozilla.org/NPL/
 *
 * Software distributed under the NPL is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
 * for the specific language governing rights and limitations under the
 * NPL.
 *
 * The Initial Developer of this code under the NPL is Netscape
 * Communications Corporation.  Portions created by Netscape are
 * Copyright (C) 1998 Netscape Communications Corporation.  All Rights
 * Reserved.
 */

#ifndef InsertTable_h__
#define InsertTable_h__

#include "EditTxn.h"
#include "nsIEditor.h"
#include "nsIDOMCharacterData.h"
#include "nsCOMPtr.h"


#define INSERT_TABLE_TXN_IID \
{/*12D65E51-C6CA-11d2-9839-00805F8AA8B8*/ \
0x12d65e51, 0xc6ca, 0x11d2, \
{ 0x98, 0x39, 0x0, 0x80, 0x5f, 0x8a, 0xa8, 0xb8 } }

class nsIPresShell;

/**
  * A transaction that inserts Table into a content node. 
  */
class InsertTableTxn : public EditTxn
{
public:

  /** used to name aggregate transactions that consist only of a single InsertTableTxn,
    * or a DeleteSelection followed by an InsertTableTxn.
    */
  static nsIAtom *gInsertTableTxnName;
	
  /** initialize the transaction
    * @param aElement the current content node
    * @param aOffset  the location in aElement to do the insertion
    * @param aNode    the new Table to insert
    * @param aPresShell used to get and set the selection
    */
  virtual nsresult Init(nsIDOMCharacterData *aElement,
                        PRUint32 aOffset,
                        nsIDOMNode *aNode,
                        nsIPresShell* aPresShell);

private:
	
	InsertTableTxn();

public:
	
  virtual nsresult Do(void);

  virtual nsresult Undo(void);

  virtual nsresult Merge(PRBool *aDidMerge, nsITransaction *aTransaction);

  virtual nsresult Write(nsIOutputStream *aOutputStream);

  virtual nsresult GetUndoString(nsString **aString);

  virtual nsresult GetRedoString(nsString **aString);

// nsISupports declarations

  // override QueryInterface to handle InsertTableTxn request
  NS_IMETHOD QueryInterface(const nsIID& aIID, void** aInstancePtr);

  static const nsIID& IID() { static nsIID iid = INSERT_TABLE_TXN_IID; return iid; }


  /** return the string data associated with this transaction */
//  virtual nsresult GetData(nsString& aResult);

  /** must be called before any InsertTableTxn is instantiated */
  static nsresult ClassInit();

protected:

  // /* return PR_TRUE if aOtherTxn immediately follows this txn */
  // virtual PRBool IsSequentialInsert(InsertTableTxn *aOtherTxn);
  
  /** the element to operate upon */
  nsCOMPtr<nsIDOMCharacterData> mElement;
  
  /** the offset into mElement where the insertion is to take place */
  PRUint32 mOffset;

  /** the Table to insert into mElement at mOffset */
  nsIDOMNode *mTableToInsert;

  /** the presentation shell, which we'll need to get the selection */
  nsIPresShell* mPresShell;

  friend class TransactionFactory;

};

#endif