IPageTransitionInfo Class Reference

#include <IPageTransitionInfo.h>

Inheritance diagram for IPageTransitionInfo:

Public Types
enum	{ kDefaultIID = IID_IPAGETRANSITIONINFO }

Public Member Functions
virtual ClassID	GetPageTransitionID () const =0
virtual uint32	GetDirection () const =0
virtual uint32	GetDuration () const =0
virtual void	SetPageTransitionID (const ClassID &classID)=0
virtual void	SetDirection (uint32 direction)=0
virtual void	SetDuration (uint32 duration)=0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Detailed Description

This is a persistent interface that sits on a kSpreadBoss, and holds the page transition information for the spread. Please use IPageTransitionFacade to extract or to change this information. Changes to this interface are notified by the kSetPageTransitionCmdBoss command, which is broadcasted to the document workspace, as well as each spread being changed.

See Also

IPageTransitionFacade, IPageTransition

Member Function Documentation

virtual uint32 IPageTransitionInfo::GetDirection ( ) const

pure virtual

Gets the direction of the page transition, as defined by the enum in IPageTransition.

Returns

uint32 The direction of the page transition, as defined in the enum in IPageTransition.

See Also

IPageTransition

virtual uint32 IPageTransitionInfo::GetDuration ( ) const

pure virtual

Gets the duration of the page transition. Setting is in ticks, where there are 60 ticks per second.

Returns

uint32 The duration of the page transition in ticks (60 ticks per second).

virtual ClassID IPageTransitionInfo::GetPageTransitionID ( ) const

pure virtual

Gets the ClassID of the page transition.

Returns

ClassID The classID of the page transition applied to the spread. This will return kInvalidClass if there isn't a page transition applied.

virtual void IPageTransitionInfo::SetDirection ( uint32  direction )

pure virtual

Sets the direction of the page transition, as defined by the enum in IPageTransition.

Parameters

uint32

The direction of the page transition, as defined in the enum in IPageTransition.

See Also

IPageTransition

virtual void IPageTransitionInfo::SetDuration ( uint32  duration )

pure virtual

Sets the duration of the page transition.

Returns

uint32 The duration of the page transition in ticks (60 ticks per second).

virtual void IPageTransitionInfo::SetPageTransitionID ( const ClassID &  classID )

pure virtual

Sets the ClassID of the page transition. Set to kInvalidClass if no page transition applied.

Parameters

ClassID

The classID of the page transition applied to the spread.