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

#include <IActionsPlaybackPreference.h>

Inheritance diagram for IActionsPlaybackPreference:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IACTIONSPLAYBACKPREFERENCE }
 
enum  PlaybackSpeed { kAccelerated, kStepByStep, kPauseFor }
 

Public Member Functions

virtual void SetPlaybackSpeed (PlaybackSpeed newSpeed)=0
 
virtual PlaybackSpeed GetPlaybackSpeed () const =0
 
virtual void SetPauseForSeconds (PMReal pauseAmount)=0
 
virtual PMReal GetPauseForSeconds (void) const =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 the actions playback preference. This is used to store the playback options on the session, as well as for the kSetActionsPlaybackOptionsCmdBoss command.

Note: The default value for this preference is kTrue.

Member Function Documentation

virtual PMReal IActionsPlaybackPreference::GetPauseForSeconds (void ) const
pure virtual

Gets the pause seconds preference.

Parameters
newSpeedIN new playback speed.
virtual PlaybackSpeed IActionsPlaybackPreference::GetPlaybackSpeed () const
pure virtual

Returns the value of the playback speed preference.

Returns
PlaybackSpeed
virtual void IActionsPlaybackPreference::SetPauseForSeconds (PMReal pauseAmount)
pure virtual

Sets the pause seconds preference.

Parameters
pauseAmountIN new pause amount.
virtual void IActionsPlaybackPreference::SetPlaybackSpeed (PlaybackSpeed newSpeed)
pure virtual

Sets the playback speed preference.

Parameters
newSpeedIN new playback speed.