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

#include <IGoToPositionBehaviorData.h>

Inheritance diagram for IGoToPositionBehaviorData:
IGoToZoomBehaviorDataIBehaviorDataIPMUnknown

Public Types

enum  PositionConstants {
  kFirstPage = 0, kLastPage, kPreviousPage, kNextPage,
  kPreviousView, kNextView, kSpecificPage
}
 
typedef int32 Position
 
- Public Types inherited from IGoToZoomBehaviorData
enum  ZoomConstants {
  kInherit = 0, kActualSize, kFitInWindow, kFitWidth,
  kFitVisible
}
 
typedef int32 Zoom
 
- Public Types inherited from IBehaviorData
enum  { kDefaultIID = IID_IBEHAVIORDATA }
 

Public Member Functions

virtual Position GetPosition () const =0
 
virtual void SetSpecificPageIndex (uint32 zeroBasedIndex)=0
 
virtual uint32 GetSpecificPageIndex () const =0
 
- Public Member Functions inherited from IGoToZoomBehaviorData
virtual void SetZoom (const Zoom &view)=0
 
virtual Zoom GetZoom () const =0
 
- Public Member Functions inherited from IBehaviorData
virtual int32 GetAction () const =0
 
virtual PMString GetName () const =0
 
virtual UID GetOwner () const =0
 
virtual void SetOwner (const UID &owner)=0
 
virtual bool16 IsEnabled () const =0
 
virtual bool16 Enable (const bool16 &enable=kTrue)=0
 
bool16 IsDisabled () const
 
bool16 Disable ()
 
virtual void Copy (IPMUnknown *srcData)=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

Data interface for Go To Position Behavior

Member Function Documentation

virtual Position IGoToPositionBehaviorData::GetPosition () const
pure virtual

Get the destination position Position is a static property. It can't be changed once the behavior is created.

Returns
the destination position ( kFirstPage, kLastPage, kPreviousPage, kNextPage, kPreviousView, kNextView, kSpecificPage )
virtual uint32 IGoToPositionBehaviorData::GetSpecificPageIndex () const
pure virtual

GetSpecificPage only makes sense when Position == kSpecificPage. GetSpecificPage will return the zero-based destination page index to GoTo.

Returns
zero-based destination page index.
virtual void IGoToPositionBehaviorData::SetSpecificPageIndex (uint32 zeroBasedIndex)
pure virtual

If the Position is kSpecificPage, then use SetSpecificPageIndex to set a one-based page index.

Parameters
oneBasedIndex[IN]: the zero-based page index of the destination page