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

#include <IMoveColumnsCmdData.h>

Inheritance diagram for IMoveColumnsCmdData:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IMOVECOLUMNSCMDDATA }
 

Public Member Functions

virtual void Set (ITableModel *sourceTable, GridArea fromAr, int32 toC, Tables::ERelativePosition pos, bool16 duplicateFlag)=0
 
virtual GridArea GetFromArea (void) const =0
 
virtual int32 GetToColumn (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 column within a table

Member Function Documentation

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

Returns if duplication of column is to be done

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

Returns the source grid area

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

Returns the relative position with respect to destination column

Returns
Tables::ERelativePosition
virtual ITableModel* IMoveColumnsCmdData::GetSourceTable (void ) const
pure virtual

Returns table from which columns are to be moved

Returns
ITableModel*
virtual int32 IMoveColumnsCmdData::GetToColumn (void ) const
pure virtual

Returns the destination column

Returns
int32
virtual void IMoveColumnsCmdData::Set (ITableModelsourceTable,
GridArea fromAr,
int32 toC,
Tables::ERelativePosition pos,
bool16 duplicateFlag 
)
pure virtual

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

Parameters
sourceTableThe table whose columns need to be moved
fromArThe source grid area
toCDestination column
posPosition of new column(col to be moved) with respect to drop location
duplicateFlagFlag is true to indicate that column is to be duplicated