CursorDevices.h

Go to the documentation of this file.

 
#ifndef __CURSORDEVICES__
#define __CURSORDEVICES__
 
#ifndef __MACTYPES__
#include <MacTypes.h>
#endif
 
#ifndef __MIXEDMODE__
#include <MixedMode.h>
#endif
 
#if PRAGMA_ONCE
#pragma once
#endif
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#if PRAGMA_IMPORT
#pragma import on
#endif
 
#if PRAGMA_STRUCT_ALIGN
#pragma options align = mac68k
#elif PRAGMA_STRUCT_PACKPUSH
#pragma pack(push, 2)
#elif PRAGMA_STRUCT_PACK
#pragma pack(2)
#endif
 
  typedef short ButtonOpcode;
  /* ButtonOpcodes */
  enum
  {
    kButtonNoOp = 0,        /* No action for this button */
    kButtonSingleClick = 1, /* Normal mouse button */
    kButtonDoubleClick = 2, /* Click-release-click when pressed */
    kButtonClickLock = 3    /* Click on press, release on next press */
  };
 
  enum
  {
    kButtonCustom = 6 /* Custom behavior, data = CursorDeviceCustomButtonUPP */
  };
 
  /* Device Classes */
  enum
  {
    kDeviceClassAbsolute = 0,  /* a flat-response device */
    kDeviceClassMouse = 1,     /* mechanical or optical mouse */
    kDeviceClassTrackball = 2, /* trackball */
    kDeviceClassTrackPad = 3
  };
 
  enum
  {
    kDeviceClass3D = 6 /* a 3D pointing device */
  };
 
  /* Structures used in Cursor Device Manager calls */
  struct CursorData
  {
    struct CursorData *nextCursorData; /* next in global list */
    Ptr displayInfo;                   /* unused (reserved for future) */
    Fixed whereX;                      /* horizontal position */
    Fixed whereY;                      /* vertical position */
    Point where;                       /* the pixel position */
    Boolean isAbs;                     /* has been stuffed with absolute coords */
    UInt8 buttonCount;                 /* number of buttons currently pressed */
    long screenRes;                    /* pixels per inch on the current display */
    short privateFields[22];           /* fields use internally by CDM */
  };
  typedef struct CursorData CursorData;
  typedef CursorData *CursorDataPtr;
  struct CursorDevice
  {
    struct CursorDevice
        *nextCursorDevice;   /* pointer to next record in linked list */
    CursorData *whichCursor; /* pointer to data for target cursor */
    long refCon;             /* application-defined */
    long unused;             /* reserved for future */
    OSType devID;            /* device identifier (from ADB reg 1) */
    Fixed resolution;        /* units/inch (orig. from ADB reg 1) */
    UInt8 devClass;          /* device class (from ADB reg 1) */
    UInt8 cntButtons;        /* number of buttons (from ADB reg 1) */
    UInt8 filler1;           /* reserved for future */
    UInt8 buttons;           /* state of all buttons */
    UInt8 buttonOp[8];       /* action performed per button */
    unsigned long
        buttonTicks[8];            /* ticks when button last went up (for debounce) */
    long buttonData[8];            /* data for the button operation */
    unsigned long doubleClickTime; /* device-specific double click speed */
    Fixed acceleration;            /* current acceleration */
    short privateFields[15];       /* fields used internally to CDM */
  };
  typedef struct CursorDevice CursorDevice;
  typedef CursorDevice *CursorDevicePtr;
  /* for use with CursorDeviceButtonOp when opcode = kButtonCustom */
  typedef CALLBACK_API_REGISTER68K(void, CursorDeviceCustomButtonProcPtr,
                                   (CursorDevicePtr ourDevice, short button));
  typedef REGISTER_UPP_TYPE(CursorDeviceCustomButtonProcPtr)
      CursorDeviceCustomButtonUPP;
#if CALL_NOT_IN_CARBON
  CursorDeviceCustomButtonUPP
  NewCursorDeviceCustomButtonUPP(CursorDeviceCustomButtonProcPtr userRoutine);
#if !OPAQUE_UPP_TYPES
  enum
  {
    uppCursorDeviceCustomButtonProcInfo = 0x000ED802
  }; /* register no_return_value Func(4_bytes:A2, 2_bytes:D3) */
#ifdef __cplusplus
  inline CursorDeviceCustomButtonUPP
  NewCursorDeviceCustomButtonUPP(CursorDeviceCustomButtonProcPtr userRoutine)
  {
    return (CursorDeviceCustomButtonUPP)NewRoutineDescriptor(
        (ProcPtr)(userRoutine), uppCursorDeviceCustomButtonProcInfo,
        GetCurrentArchitecture());
  }
#else
#define NewCursorDeviceCustomButtonUPP(userRoutine)                \
  (CursorDeviceCustomButtonUPP) NewRoutineDescriptor(              \
      (ProcPtr)(userRoutine), uppCursorDeviceCustomButtonProcInfo, \
      GetCurrentArchitecture())
#endif
#endif
 
  void
  DisposeCursorDeviceCustomButtonUPP(CursorDeviceCustomButtonUPP userUPP);
#if !OPAQUE_UPP_TYPES
#ifdef __cplusplus
  inline void
  DisposeCursorDeviceCustomButtonUPP(CursorDeviceCustomButtonUPP userUPP)
  {
    DisposeRoutineDescriptor((UniversalProcPtr)userUPP);
  }
#else
#define DisposeCursorDeviceCustomButtonUPP(userUPP) \
  DisposeRoutineDescriptor(userUPP)
#endif
#endif
 
  void
  InvokeCursorDeviceCustomButtonUPP(CursorDevicePtr ourDevice, short button,
                                    CursorDeviceCustomButtonUPP userUPP);
#if !OPAQUE_UPP_TYPES && \
    (!TARGET_OS_MAC || !TARGET_CPU_68K || TARGET_RT_MAC_CFM)
#ifdef __cplusplus
  inline void
  InvokeCursorDeviceCustomButtonUPP(CursorDevicePtr ourDevice, short button,
                                    CursorDeviceCustomButtonUPP userUPP)
  {
    CALL_TWO_PARAMETER_UPP(userUPP, uppCursorDeviceCustomButtonProcInfo,
                           ourDevice, button);
  }
#else
#define InvokeCursorDeviceCustomButtonUPP(ourDevice, button, userUPP)    \
  CALL_TWO_PARAMETER_UPP((userUPP), uppCursorDeviceCustomButtonProcInfo, \
                         (ourDevice), (button))
#endif
#endif
 
#endif /* CALL_NOT_IN_CARBON */
 
#if CALL_NOT_IN_CARBON || OLDROUTINENAMES
/* support for pre-Carbon UPP routines: New...Proc and Call...Proc */
#define NewCursorDeviceCustomButtonProc(userRoutine) \
  NewCursorDeviceCustomButtonUPP(userRoutine)
#define CallCursorDeviceCustomButtonProc(userRoutine, ourDevice, button) \
  InvokeCursorDeviceCustomButtonUPP(ourDevice, button, userRoutine)
#endif /* CALL_NOT_IN_CARBON */
 
#if CALL_NOT_IN_CARBON
  OSErr
  CursorDeviceMove(CursorDevicePtr ourDevice, long deltaX, long deltaY);
 
  OSErr
  CursorDeviceMoveTo(CursorDevicePtr ourDevice, long absX, long absY);
 
  OSErr
  CursorDeviceFlush(CursorDevicePtr ourDevice);
 
  OSErr
  CursorDeviceButtons(CursorDevicePtr ourDevice, short buttons);
 
  OSErr
  CursorDeviceButtonDown(CursorDevicePtr ourDevice);
 
  OSErr
  CursorDeviceButtonUp(CursorDevicePtr ourDevice);
 
  OSErr
  CursorDeviceButtonOp(CursorDevicePtr ourDevice, short buttonNumber,
                       ButtonOpcode opcode, long data);
 
  OSErr
  CursorDeviceSetButtons(CursorDevicePtr ourDevice, short numberOfButtons);
 
  OSErr
  CursorDeviceSetAcceleration(CursorDevicePtr ourDevice, Fixed acceleration);
 
  OSErr
  CursorDeviceDoubleTime(CursorDevicePtr ourDevice, long durationTicks);
 
  OSErr
  CursorDeviceUnitsPerInch(CursorDevicePtr ourDevice, Fixed resolution);
 
  OSErr
  CursorDeviceNextDevice(CursorDevicePtr *ourDevice);
 
  OSErr
  CursorDeviceNewDevice(CursorDevicePtr *ourDevice);
 
  OSErr
  CursorDeviceDisposeDevice(CursorDevicePtr ourDevice);
 
#endif /* CALL_NOT_IN_CARBON */
 
#if OLDROUTINENAMES
#if CALL_NOT_IN_CARBON
  OSErr
  CrsrDevMoveTo(CursorDevicePtr ourDevice, long absX, long absY);
 
  OSErr
  CrsrDevNextDevice(CursorDevicePtr *ourDevice);
 
#endif /* CALL_NOT_IN_CARBON */
 
#endif /* OLDROUTINENAMES */
 
#if PRAGMA_STRUCT_ALIGN
#pragma options align = reset
#elif PRAGMA_STRUCT_PACKPUSH
#pragma pack(pop)
#elif PRAGMA_STRUCT_PACK
#pragma pack()
#endif
 
#ifdef PRAGMA_IMPORT_OFF
#pragma import off
#elif PRAGMA_IMPORT
#pragma import reset
#endif
 
#ifdef __cplusplus
}
#endif
 
#endif /* __CURSORDEVICES__ */