InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
AdapativePageItemData Class Reference

#include <IAdaptiveTransientData.h>

Public Member Functions

bool16 HasNewStartAndEndPointForTOP ()
 
void GetStartAndEndPointForTOP (PMPoint &startPoint, PMPoint &endPoint, bool reset=false)
 
void SetStartAndEndPointForTOP (PMPoint startPoint, PMPoint endPoint)
 
bool HasRecommendedBounds ()
 
virtual PMRect GetRecommendedBounds (bool reset=false)
 
void SetRecommendedBounds (PMRect bounds)
 

Public Attributes

UIDList fDependents
 
PMRect fInitialBounds
 
PMRect fFinalBounds
 
PMRect fRecommendedBounds
 
PMPoint fStartPoint
 
PMPoint fEndPoint
 
PMPoint fFinalStartPoint
 
PMPoint fFinalEndPoint
 
UID fTOPUID
 
UID fSpreadUID
 
bool16 fUnlockThis
 
bool16 fLeftToRightBinding
 
bool16 fDependentsInitialised
 
bool16 fHasRecommendedBounds
 

Detailed Description

The data structure to hold the temporary data for a particular page item while the Adaptive (Adjust) Layout is in progress.

Member Function Documentation

virtual PMRect AdapativePageItemData::GetRecommendedBounds (bool reset = false)
inlinevirtual

Returns recommended final bounds that has been set for this page item.

Parameters
reset[in] true if the recommended bounds are to be rest after returning the bounds.
Returns
Bounds which have been recommended for this page item and false otherwise. These are supposed to be in spread coordinates.
void AdapativePageItemData::GetStartAndEndPointForTOP (PMPointstartPoint,
PMPointendPoint,
bool reset = false 
)
inline

Returns the start and end point information pertaining to the TOP on this page item.

Parameters
startPoint[out] starting point of the TOP.
endPoint[out] ending point of the TOP. reset [in] true if the TOP information is to be reset after returning the values.
bool16 AdapativePageItemData::HasNewStartAndEndPointForTOP ()
inline

Returns true if start and end point information pertaining to the TOP on this page item has been set.

Returns
true if TOP related information has been set.
bool AdapativePageItemData::HasRecommendedBounds ()
inline

Returns true if recommended final bounds has been set for this page item.

Returns
true if bounds has been recommended for this page item and false otherwise.
void AdapativePageItemData::SetRecommendedBounds (PMRect bounds)
inline

Sets recommended final bounds for this page item.

Parameters
Thefinal recommended bounds for this page item. These are supposed to be in spread coordinates.
void AdapativePageItemData::SetStartAndEndPointForTOP (PMPoint startPoint,
PMPoint endPoint 
)
inline

Sets starting point and ending point information for the TOP on this page item.

Parameters
startPoint[in] starting point of the TOP.
endPoint[in] ending point of the TOP.