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

#include <ITransformSuite.h>

Inheritance diagram for ITransformSuite:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_ITRANSFORMSUITE }
 

Public Member Functions

virtual int32 GetTransformItemsCount () const =0
 
virtual bool16 SelectionHasTransformValues (const Transform::CoordinateSpace &coordinateSpace, uint32 valuesOfInterest) const =0
 
virtual bool16 CanChangeSelectionTransformValues (const Transform::CoordinateSpace &coordinateSpace, uint32 valuesOfInterest) const =0
 
virtual void GetSelectionScale (const Transform::CoordinateSpace &coordinateSpace, K2Vector< PMPoint > &results) const =0
 
virtual void GetSelectionScaleX (const Transform::CoordinateSpace &coordinateSpace, K2Vector< PMReal > &results) const =0
 
virtual void GetSelectionScaleY (const Transform::CoordinateSpace &coordinateSpace, K2Vector< PMReal > &results) const =0
 
virtual void GetSelectionSkewAngle (const Transform::CoordinateSpace &coordinateSpace, K2Vector< PMReal > &results) const =0
 
virtual void GetSelectionRotationAngle (const Transform::CoordinateSpace &coordinateSpace, K2Vector< PMReal > &results) const =0
 
virtual void GetSelectionTranslation (const Transform::CoordinateSpace &coordinateSpace, K2Vector< PMPoint > &results) const =0
 
virtual void GetSelectionTranslationX (const Transform::CoordinateSpace &coordinateSpace, K2Vector< PMReal > &results) const =0
 
virtual void GetSelectionTranslationY (const Transform::CoordinateSpace &coordinateSpace, K2Vector< PMReal > &results) const =0
 
virtual ErrorCode TransformSelection (const Transform::CoordinateSpace &coordinateSpace, const Transform::TransformOrigin &referencePoint, const Transform::TransformValue &xform, Transform::Target originalOrDuplicate=Transform::OriginalItems())=0
 
virtual bool16 CanRedefineSelectionScaling () const =0
 
virtual ErrorCode RedefineSelectionScaling ()=0
 
virtual bool16 CanRemoveSelectionTransformations (const Transform::CoordinateSpace &coordinateSpace) const =0
 
virtual ErrorCode RemoveSelectionTransformations (const Transform::CoordinateSpace &coordinateSpace)=0
 
virtual bool16 CanCopyTransform () const =0
 
virtual bool16 HasTransformAgainAbility () const =0
 
virtual bool16 HasTransformLastAgainAbility () const =0
 
virtual ErrorCode TransformAgain (IActiveContext *iContext, IScriptRequestData::TargetHandlingPolicy scriptTargetHandlingPolicy)=0
 
virtual ErrorCode TransformLastAgain (IActiveContext *iContext, IScriptRequestData::TargetHandlingPolicy scriptTargetHandlingPolicy)=0
 
virtual void EnableTransformAgainSelectionObserver ()=0
 
virtual void DisableTransformAgainSelectionObserver ()=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

IID_ITRANSFORMSUITE interface; this interface involves selections; There will be an implementation on the ASB which is referred to as the integrator, and different selection format such as Layout, Text, Table and XML implement their own CSB; when client code ask for a method, it check current selection and let each selection CSB do their own work.

Member Function Documentation

virtual bool16 ITransformSuite::CanCopyTransform () const
pure virtual

Detect if can copy and transform selected items.

Parameters
none
Returns
bool16
virtual bool16 ITransformSuite::CanRedefineSelectionScaling () const
pure virtual

Can the selection have its transform reset (to 100%)?

Parameters
void
Returns
bool16
virtual bool16 ITransformSuite::CanRemoveSelectionTransformations (const Transform::CoordinateSpacecoordinateSpace) const
pure virtual

Can the selection be reset to identity transform (remove rotation, skew and scaling)?

Parameters
void
Returns
bool16
virtual void ITransformSuite::DisableTransformAgainSelectionObserver ()
pure virtual

Private use only

virtual void ITransformSuite::EnableTransformAgainSelectionObserver ()
pure virtual

Private use only

virtual void ITransformSuite::GetSelectionRotationAngle (const Transform::CoordinateSpacecoordinateSpace,
K2Vector< PMReal > & results 
) const
pure virtual

Return all of the rotations (sorted and only unique values) in the selection.

Parameters
results[OUT] Return result in "rotationList"
pbRelative[IN] whether tranform are relative to pasteboard
virtual void ITransformSuite::GetSelectionScale (const Transform::CoordinateSpacecoordinateSpace,
K2Vector< PMPoint > & results 
) const
pure virtual

Return all of the scale Xs (sorted and only unique values) in the selection.

Parameters
coordinateSpace- one of Transform::PasteboardCoordinates(), Transform::ParentCoordinates(), Transform::InnerCoordinates().
results[OUT] Return result in "scaleXList"
pbRelative[IN] whether tranform are relative to pasteboard
virtual void ITransformSuite::GetSelectionScaleX (const Transform::CoordinateSpacecoordinateSpace,
K2Vector< PMReal > & results 
) const
pure virtual

Return all of the scale Xs (sorted and only unique values) in the selection.

Parameters
coordinateSpace- one of Transform::PasteboardCoordinates(), Transform::ParentCoordinates(), Transform::InnerCoordinates().
results[OUT] Return result in "scaleXList"
pbRelative[IN] whether tranform are relative to pasteboard
virtual void ITransformSuite::GetSelectionScaleY (const Transform::CoordinateSpacecoordinateSpace,
K2Vector< PMReal > & results 
) const
pure virtual

Return all of the scale Ys (sorted and only unique values) in the selection.

Parameters
coordinateSpace- one of Transform::PasteboardCoordinates(), Transform::ParentCoordinates(), Transform::InnerCoordinates().
results[OUT] Return result in "scaleYList"
pbRelative[IN] whether tranform are relative to pasteboard
virtual void ITransformSuite::GetSelectionSkewAngle (const Transform::CoordinateSpacecoordinateSpace,
K2Vector< PMReal > & results 
) const
pure virtual

Return all of the skew Xs (sorted and only unique values) in the selection.

Parameters
coordinateSpace- one of Transform::PasteboardCoordinates(), Transform::ParentCoordinates(), Transform::InnerCoordinates().
results[OUT] Return result in "skewXList"
pbRelative[IN] whether tranform are relative to pasteboard
virtual void ITransformSuite::GetSelectionTranslation (const Transform::CoordinateSpacecoordinateSpace,
K2Vector< PMPoint > & results 
) const
pure virtual

Get distinct (x,y) translations; asserts if not HasX() and not HasY()

Parameters
coordinateSpace- one of Transform::PasteboardCoordinates(), Transform::ParentCoordinates(), Transform::InnerCoordinates().
K2Vector<PMPoint>&
virtual void ITransformSuite::GetSelectionTranslationX (const Transform::CoordinateSpacecoordinateSpace,
K2Vector< PMReal > & results 
) const
pure virtual

Get distinct 'x' translations; asserts if not HasX()

Parameters
coordinateSpace- one of Transform::PasteboardCoordinates(), Transform::ParentCoordinates(), Transform::InnerCoordinates().
K2Vector<PMReal>&
virtual void ITransformSuite::GetSelectionTranslationY (const Transform::CoordinateSpacecoordinateSpace,
K2Vector< PMReal > & results 
) const
pure virtual

Get distinct 'y' translations; asserts if not HasY()

Parameters
coordinateSpace- one of Transform::PasteboardCoordinates(), Transform::ParentCoordinates(), Transform::InnerCoordinates().
K2Vector<PMReal>&
virtual int32 ITransformSuite::GetTransformItemsCount () const
pure virtual

Return the number of items that will be affected by the transform.

Returns
int32
virtual bool16 ITransformSuite::HasTransformAgainAbility () const
pure virtual

Can Tranform Again be done?

Parameters
void
Returns
bool16
virtual bool16 ITransformSuite::HasTransformLastAgainAbility () const
pure virtual

Can Tranform Last Again be done?

Parameters
void
Returns
bool16
virtual ErrorCode ITransformSuite::RedefineSelectionScaling ()
pure virtual

Reset selected items to uniform 100% scaling.

Parameters
void
Returns
Command processing result
virtual ErrorCode ITransformSuite::RemoveSelectionTransformations (const Transform::CoordinateSpacecoordinateSpace)
pure virtual

Reset selected items to identity matrix (remove all rotation, skew and scaling).

Parameters
void
Returns
Command processing result
virtual ErrorCode ITransformSuite::TransformAgain (IActiveContextiContext,
IScriptRequestData::TargetHandlingPolicy scriptTargetHandlingPolicy 
)
pure virtual

Transform Again

Parameters
iContextthe context
scriptTargetHandlingPolicythe script target handling policy
Returns
ErrorCode
virtual ErrorCode ITransformSuite::TransformLastAgain (IActiveContextiContext,
IScriptRequestData::TargetHandlingPolicy scriptTargetHandlingPolicy 
)
pure virtual

Transform Last Again

Parameters
iContextthe context
scriptTargetHandlingPolicythe script target handling policy
Returns
ErrorCode