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

#include <IStepAndRepeatSuite.h>

Inheritance diagram for IStepAndRepeatSuite:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_ISTEPANDREPEATSUITE }
 

Public Member Functions

virtual bool16 CanStepAndRepeat () const =0
 
virtual bool16 CanStepAndRepeatVertical () const =0
 
virtual bool16 CanStepAndRepeatHorizontal () const =0
 
virtual bool16 AreValuesAllowed (const PBPMPoint &offset, int32 repeatCountOrRowCount, int32 columnCount) const =0
 
virtual ErrorCode StepAndRepeat (const PBPMPoint &offset, int32 repeatCountOrRowCount, int32 columnCount, const UIDRef &layerRef)=0
 
virtual ErrorCode FinalizeSelection (const UIDList &allStepAndRepeatItems)=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

Defines the interface for a step and repeat suite to be used in the new selection architecture

Member Function Documentation

virtual bool16 IStepAndRepeatSuite::AreValuesAllowed (const PBPMPointoffset,
int32 repeatCountOrRowCount,
int32 columnCount 
) const
pure virtual

Can values be passed in to Step and Repeat (Text for instance cannot receive values)

Parameters
offset- The values client would like to use
repeatCountOrRowCount- The number of times client would like to repeat the step and repeat. When columnCount is not -1, this is the rowCount.
columnCount- The number of times client would like to repeat columns when creating a grid. Use a value of -1 when not creating a grid.
Returns
bool16
virtual bool16 IStepAndRepeatSuite::CanStepAndRepeat () const
pure virtual

Can this selection be step and repeated

Parameters
none
Returns
bool16
virtual bool16 IStepAndRepeatSuite::CanStepAndRepeatHorizontal () const
pure virtual

Can this selection be step and repeated horizontally

Parameters
none
Returns
bool16
virtual bool16 IStepAndRepeatSuite::CanStepAndRepeatVertical () const
pure virtual

Can this selection be step and repeated vertically

Parameters
none
Returns
bool16
virtual ErrorCode IStepAndRepeatSuite::FinalizeSelection (const UIDListallStepAndRepeatItems)
pure virtual

Finalize the selection after the Step and Repeat action. e.g. Select just the newly created items.

Parameters
allStepAndRepeatItems- all the items that are stepped and repeated. This includes the original items and the newly created ones.
Returns
ErrorCode - kSuccess or kFailure
virtual ErrorCode IStepAndRepeatSuite::StepAndRepeat (const PBPMPointoffset,
int32 repeatCountOrRowCount,
int32 columnCount,
const UIDReflayerRef 
)
pure virtual

Perform the Step and Repeat action

Parameters
offset- Offset to use
repeatCountOrRowCount- Number of times to repeat, or number of rows to create.
columnCount- Number of columns to create, -1 when just doing a standard "repeat" Step and Repeat.
layerRef- This is the layer to step and repeat onto
Returns
ErrorCode - kSuccess or kFailure