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

#include <AcquireModalCursor.h>

Inheritance diagram for AcquireWaitCursor:
BaseAcquireModalCursor

Public Member Functions

 AcquireWaitCursor ()
 
virtual ~AcquireWaitCursor ()
 
virtual void ChangeCursor (const CursorSpec &newspec)
 
void Animate ()
 

Protected Attributes

ModalCursorTicket fTicket
 
ICursorMgrfCursorMgr
 

Detailed Description

Helper object used to acquire, manipulate, and release a wait cursor.

AcquireWaitCursor should be used for changing the cursor to a watch for well understood intervals.



This helper can be either stack or heap allocated depending on how far flung the two ends of the cursor wait period are. 

If it all happens within the body of a single function or single function call chain, then stack based is preferred. 

If the start and end are in separate functions, then heap based should be used.

Constructor & Destructor Documentation

AcquireWaitCursor::AcquireWaitCursor ()

Installs the busy cursor.

virtual AcquireWaitCursor::~AcquireWaitCursor ()
virtual

Removes the busy cursor, and restores the previous cursor.

Member Function Documentation

void AcquireWaitCursor::Animate ()

Call periodcally to ensure that the cursor continues to spin.

virtual void AcquireWaitCursor::ChangeCursor (const CursorSpecnewspec)
virtual

Calls Animate

Implements BaseAcquireModalCursor.