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

#include <CCursorProvider.h>

Inheritance diagram for CCursorProvider:
ICursorProviderIPMUnknownCToolCursorProviderSnapCursorProvider

Public Member Functions

 CCursorProvider (IPMUnknown *boss)
 
virtual CursorSpec GetCursor (IControlView *viewUnderMouse, const SysPoint globalLocation, ICursorMgr::eCursorModifierState modifiers) const
 
virtual bool16 LocationAffectsCursor (SysRgn cursorRgn) const
 
virtual bool16 ModifiersAffectCursor (SysRgn cursorRgn) const
 
virtual bool16 HasLockedState () const
 
virtual void SetSingleCursor (const CursorSpec &)
 

Additional Inherited Members

- Public Types inherited from ICursorProvider
enum  { kDefaultIID = IID_ICURSORPROVIDER }
 

Detailed Description

Basic implementation of the ICursorProvider interface, representing the connection between a region on the screen and the cursor to be used when withing that region. Implementors of ICursorProvider should either derive from either this, or just use SimpleCursorProvider.

See Also
ICursorProvider, SimpleCursorProvider

Member Function Documentation

virtual CursorSpec CCursorProvider::GetCursor (IControlViewviewUnderMouse,
const SysPoint globalLocation,
ICursorMgr::eCursorModifierState modifiers 
) const
virtual

Default behavior: returns kCrsrPointer

Implements ICursorProvider.

Reimplemented in CToolCursorProvider, and SnapCursorProvider.

virtual bool16 CCursorProvider::HasLockedState () const
virtual

Default behavior: returns kTrue

Implements ICursorProvider.

Reimplemented in CToolCursorProvider.

virtual bool16 CCursorProvider::LocationAffectsCursor (SysRgn cursorRgn) const
virtual

Default behavior: returns kFalse

Implements ICursorProvider.

virtual bool16 CCursorProvider::ModifiersAffectCursor (SysRgn cursorRgn) const
virtual

Default behavior: returns kFalse

Implements ICursorProvider.

Reimplemented in CToolCursorProvider.

virtual void CCursorProvider::SetSingleCursor (const CursorSpec)
virtual

Default behavior: does nothing. In debug builds, this asserts when called unless overridden. The SimpleCursorProvider implementation is intended for providers involving only a single cursor.

Implements ICursorProvider.