SnapTracker Class Reference

Inheritance diagram for SnapTracker:

Public Member Functions
	SnapTracker (IPMUnknown *boss)
	~SnapTracker ()
virtual bool16	BeginTracking (IEvent *theEvent)
Public Member Functions inherited from CTracker
	CTracker (IPMUnknown *boss)
virtual void	SetupTracker (IControlView *theControlView, ISnapTo *theSnapper=NULL, IItemContext *context=NULL)
virtual IControlView *	QueryControlView () const
virtual bool16	IsEnabled ()
virtual bool16	IsTracking ()
virtual void	EnableTracking ()
virtual void	DisableTracking ()
virtual void	HandleContinueTracking (const GSysPoint &where)
virtual void	ContinueTracking (const PBPMPoint &where, bool16 mouseDidMove)
virtual bool16	EndTracking (IEvent *theEvent)
virtual void	AbortTracking (IEvent *theEvent)
virtual void	TimerMessage (int32 flags)
virtual bool16	WantTimer (ClassID trackerTimerBoss)
Public Member Functions inherited from ITracker
void	SetupTracker (IControlView *theControlView)
void	SetupSpecialTracker (IControlView *theControlView, ISnapTo *theSnapper, IItemContext *context)
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Protected Member Functions
virtual ErrorCode	CreateAndProcessSetSpreadCmd (ISpread *iSpread, ILayoutControlData *iLayoutControlData)
UIDRef	HitTestPoint (ISpread *spread, const PBPMPoint &where, PMRect &outBounds)
void	RemoveLastElement (PMString &fromthis)
void	AppendPathSeparator (PMString &path)
void	Replace (PMString &original, const PMString &target, const PMString &replace)
Protected Member Functions inherited from CTracker
virtual void	Initialize (IEvent *theEvent)
virtual bool16	DoBeginTracking (IEvent *theEvent)
virtual bool16	DoEndTracking (IEvent *theEvent)
virtual void	NotifyBeginTracking (const PMPoint &startPt, IDynamicTrackerData::TrackingEffect effect=IDynamicTrackerData::kUnknown)
virtual void	NotifyContinueTracking (const PMPoint &startPt, const PMPoint &endPoint, IDynamicTrackerData::TrackingEffect effect=IDynamicTrackerData::kUnknown)
virtual void	NotifyEndTracking (const PMPoint &startPt, const PMPoint &endPoint, IDynamicTrackerData::TrackingEffect effect=IDynamicTrackerData::kUnknown)
virtual IDynamicTrackerData::TrackingEffect	GetTrackingEffect (IDynamicTrackerData::TrackingState state)
virtual void	PushEventHandler ()
virtual void	PopEventHandler ()
virtual bool16	WantsToAutoScroll (const PMPoint &currentPoint)
virtual PMPoint	AutoScroll (const PMPoint &scrollBy, const PMPoint &scrolledPoint)
virtual void	GlobalToPasteboard (const GSysPoint &thePoint, PBPMPoint &convertedPoint)
virtual PMPoint	PasteboardToGlobal (const PBPMPoint &pbPoint)
virtual IPanorama *	QueryPanorama (IControlView *pView) const
virtual void	DisableUpdates ()
virtual void	EnableUpdates ()
void	DeselectAllItems ()
virtual void	ComputeAdjustedPoint (PMPoint &adjustedPoint)
void	InitializeModalCursor ()
void	ChangeModalCursor (const CursorSpec &spec)
void	UpdateModalCursor ()
void	ReleaseModalCursor ()
virtual uint32	GetMouseMoveDelay ()
virtual uint32	GetMouseSteadyDelay ()
virtual bool16	AdjustPoint (PBPMPoint &point)
void	StartTimer (ClassID trackerTimerBoss, uint32 milliSeconds, uint32 mouseMoveDelay=kDefaultMouseMoveDelay, uint32 mouseSteadyDelay=kDefaultMouseSteadyDelay)
void	StopTimer (ClassID trackerTimerBoss)
bool16	GetTimerFlags ()
void	SetTimerFlags (int32 flags)
uint32	GetElapsedTime ()
virtual IDataBase *	GetTrackingDataBase () const

Additional Inherited Members
Static Protected Member Functions inherited from CTracker
static void	DeactivatePageItem ()
Protected Attributes inherited from CTracker
IControlView *	fControlView
IDataBase *	fDataBase
IItemContext *	fItemContext
ISnapTo *	fSnapTo
SnapType	fSnapType
bool16	fIsTracking
bool16	fWantsToAutoScroll
PMPoint	fPreviousPoint
PMPoint	fFirstPoint
GSysPoint	fFirstGlobalWhere
uint32	fFirstTicks
bool16	fEnabled
IRulerData *	fHorzRuler
IRulerData *	fVertRuler
AcquireModalCursor *	fModalCursor
AutoBusyCursor *	fAutoBusyCursor
uint32	fOldSchedulerMask
int32	fTimerFlags
K2Vector< ITrackerTimer * >	fTimerPtrs

Detailed Description

The Snapshot Tool's tracker. Snapshot creates images of spreads, pages and selections.

The user must double click to take the snapshot.

If a selection is set double clicking takes a snapshot of it.

If no selection is set double clicking on the background of the spread creates a snapshot of the spread. Double clicking on a page creates a snapshot of the page.

By selecting a frame with no fill or stroke you can create snapshots clipped to the bounds of this frame. Use the selection tool to drag the frame around and create snapshots of different areas.

The tool has global preferences that allow the name of the output file, the file format, scale factor and various other parameters to be set.

If the output file specified by the preferences is an absolute filenname it will be used. Otherwise the snapshot image file is created in the same folder as the document from which snapshots are being made.

This tracker completes all of its behaviour in a single call to BeginTracking().

Constructor & Destructor Documentation

SnapTracker::SnapTracker

(

IPMUnknown *

boss

)

The constructor

SnapTracker::~SnapTracker ( )

inline

Destructor

Member Function Documentation

void SnapTracker::AppendPathSeparator ( PMString &  path )

protected

Appends a platform specific path separator.

Parameters

path	IN/OUT The path to which you want to append a path separator.

bool16 SnapTracker::BeginTracking ( IEvent *  theEvent )

virtual

Invoked when the tool is selected and the user clicks the mouse.

Reimplemented from CTracker.

void SnapTracker::RemoveLastElement ( PMString &  fromthis )

protected

Removes the last part of a path.

Parameters

fromthis

IN/OUT The path that needs to have the last part (file or folder) removed.

void SnapTracker::Replace ( PMString &  original, const PMString &  target, const PMString &  replace  )

protected

Replaces substrings found in a string with something else.

Parameters

original	IN/OUT Original string to search in.
target	IN Text to search for.
replace	IN Text to replace with.