InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IMoveRowsCmdData Class Referenceabstract

#include <IMoveRowsCmdData.h>

Inheritance diagram for IMoveRowsCmdData:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IMOVEROWSCMDDATA }
 

Public Member Functions

virtual void Set (ITableModel *sourceTable, GridArea fromArea, int32 toR, Tables::ERelativePosition, bool16 duplicateFlag)=0
 
virtual GridArea GetFromArea (void) const =0
 
virtual int32 GetToRow (void) const =0
 
virtual Tables::ERelativePosition GetRelativePos (void) const =0
 
virtual bool16 GetDuplicateFlag (void) const =0
 
virtual ITableModelGetSourceTable (void) const =0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

Maintains information needed by command to move row within a table

Member Function Documentation

virtual bool16 IMoveRowsCmdData::GetDuplicateFlag (void ) const
pure virtual

Returns whether duplication of row is to be done

Returns
bool16
virtual GridArea IMoveRowsCmdData::GetFromArea (void ) const
pure virtual

Returns the source grid area

Returns
GridArea
virtual Tables::ERelativePosition IMoveRowsCmdData::GetRelativePos (void ) const
pure virtual

Returns the relative position with respect to destination row

Returns
Tables::ERelativePosition
virtual int32 IMoveRowsCmdData::GetToRow (void ) const
pure virtual

Returns the destination row

Returns
int32
virtual void IMoveRowsCmdData::Set (ITableModelsourceTable,
GridArea fromArea,
int32 toR,
Tables::ERelativePosition ,
bool16 duplicateFlag 
)
pure virtual

Sets the table model, grid area to move, the destination row, relative position and whether to duplicate rows or not

Parameters
sourceTableThe table whose rows need to be moved
fromAreaThe source grid area
toRDestination row
ERelativePositionPosition of moved area with respect to destination row
duplicateFlagFlag is true to indicate that row is to be duplicated