ITableScrapCmdData Class Reference

#include <ITableScrapCmdData.h>

Inheritance diagram for ITableScrapCmdData:

Public Types
enum	{ kDefaultIID = IID_ITABLESCRAPCMDDATA }

Public Member Functions
virtual void	Set (UIDRef tableModel, GridArea whichCells, IDataExchangeHandler *destinationHandler)=0
virtual UIDRef	GetTableModel () const =0
virtual GridArea	GetRange () const =0
virtual void	ReleaseDestinationHandler ()=0
virtual IDataExchangeHandler *	GetDestinationHandler () const =0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Detailed Description

The table scrap information used by commands when copy/pasting table cells on the scrap

Member Function Documentation

virtual IDataExchangeHandler* ITableScrapCmdData::GetDestinationHandler ( ) const

pure virtual

Commands often need access to the dataHandler that will be the target of a copy-to-scrap command. but the lifetime data handlers is very short because we revert scrap databases frequently. ReleaseDestinationHandler should be called soon after the command has completed, and definitely before the affected scrap gets reverted.

Returns

IDataExchangeHandler

virtual GridArea ITableScrapCmdData::GetRange ( ) const

pure virtual

Returns the cell range this command acted on

Returns

GridArea the cell range

virtual UIDRef ITableScrapCmdData::GetTableModel ( ) const

pure virtual

Returns the table mode this command acted on

Returns

UIDRef the table mode ref

virtual void ITableScrapCmdData::ReleaseDestinationHandler ( )

pure virtual

Commands often need access to the dataHandler that will be the target of a copy-to-scrap command. but the lifetime data handlers is very short because we revert scrap databases frequently. ReleaseDestinationHandler should be called soon after the command has completed, and definitely before the affected scrap gets reverted.

virtual void ITableScrapCmdData::Set ( UIDRef  tableModel, GridArea  whichCells, IDataExchangeHandler *  destinationHandler  )

pure virtual

Sets the information the command needs to act

Parameters

tableModel

the table mode UIDRef

Returns

whichCells the cell range Grid Area

destinationHandler The IDataExchangeHandler see