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

#include <AcquireModalCursor.h>

Inheritance diagram for AcquireModalCursor:
BaseAcquireModalCursor

Public Member Functions

 AcquireModalCursor (const CursorSpec &newspec, int16 restoreCursor=ICursorMgr::kRecomputeNewCursor)
 
 AcquireModalCursor (int16 restoreCursor=ICursorMgr::kRecomputeNewCursor)
 
virtual ~AcquireModalCursor ()
 
virtual void ChangeCursor (const CursorSpec &newspec)
 

Protected Attributes

ModalCursorTicket fTicket
 
ICursorMgrfCursorMgr
 

Detailed Description

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

This helper can be either stack or heap allocated depending on how far flung the two ends of the cursor modality 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

AcquireModalCursor::AcquireModalCursor (const CursorSpecnewspec,
int16 restoreCursor = ICursorMgr::kRecomputeNewCursor 
)

Installs the modal cursor.

AcquireModalCursor::AcquireModalCursor (int16 restoreCursor = ICursorMgr::kRecomputeNewCursor)

Installs a modal arrow cursor.

virtual AcquireModalCursor::~AcquireModalCursor ()
virtual

Removes the modal cursor, and restores the previous cursor or recomputes a new one.

Member Function Documentation

virtual void AcquireModalCursor::ChangeCursor (const CursorSpecnewspec)
virtual

Sets the cursor

Implements BaseAcquireModalCursor.