DesktopPrinting.h

Go to the documentation of this file.

 
#ifndef __DESKTOPPRINTING__
#define __DESKTOPPRINTING__
 
#ifndef __MACTYPES__
#include <MacTypes.h>
#endif
 
#ifndef __FILES__
#include <Files.h>
#endif
 
#ifndef __PRINTING__
#include <Printing.h>
#endif
 
#ifndef __QUICKDRAW__
#include <Quickdraw.h>
#endif
 
#ifndef __MACERRORS__
#include <MacErrors.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
 
  enum
  {
    kDTPUnknownPrinterType = -1,  
    kDTPSerialPrinterType = 0,    
    kDTPAppleTalkPrinterType = 1, 
    kDTPTCPIPPrinterType = 2,     
    kDTPSCSIPrinterType = 3,      
    kDTPUSBPrinterType = 4        
  };
 
  enum
  {
    kDTPUnknownPort = -1, 
    kDTPPrinterPort = 0,  
    kDTPModemPort = 1     
  };
 
  enum
  {
    kDTPGetPrinterInfo = 23,
    kDTPIsSamePrinterInfo = 24,
    kDTPSetDefaultPrinterInfo = 25
  };
 
  struct DTPSerialAddress
  {
    short port;     
    Str31 portName; 
  };
  typedef struct DTPSerialAddress DTPSerialAddress;
  struct DTPAppleTalkAddress
  {
    Str32 nbpName;
    Str32 nbpZone;
    Str32 nbpType;
  };
  typedef struct DTPAppleTalkAddress DTPAppleTalkAddress;
  struct DTPTCPIPAddress
  {
    Str255 TCPIPAddress;
    Str255 queueName;
  };
  typedef struct DTPTCPIPAddress DTPTCPIPAddress;
  struct DTPSCSIAddress
  {
    short id; 
  };
  typedef struct DTPSCSIAddress DTPSCSIAddress;
  struct DTPUSBAddress
  {
    Str255 name; 
  };
  typedef struct DTPUSBAddress DTPUSBAddress;
  struct DTPPrinterInfo
  {
    Str31 dtpDefaultName; 
    short printerType;    
    union
    {
      DTPSerialAddress serial;
      DTPAppleTalkAddress appleTalk;
      DTPTCPIPAddress tcpip;
      DTPSCSIAddress scsi;
      DTPUSBAddress usb;
    } u;
 
  };
  typedef struct DTPPrinterInfo DTPPrinterInfo;
  typedef DTPPrinterInfo *DTPPrinterInfoPtr;
  typedef DTPPrinterInfoPtr *DTPPrinterInfoHandle;
  struct TDTPPrGeneralData
  {
    short iOpCode; 
    short iError;
    long iCommand;
    DTPPrinterInfoHandle printerInfo;
  };
  typedef struct TDTPPrGeneralData TDTPPrGeneralData;
  enum
  {
    kDTPInfoResType = FOUR_CHAR_CODE('dtpi'),
    kDTPInfoResID = -8192
  };
 
  enum
  {
    kDTPUnknownConnection = 0x00000000,   
    kDTPSerialConnection = 0x00000001,    
    kDTPSCSIConnection = 0x00000002,      
    kDTPAppleTalkConnection = 0x00000004, 
    kDTPTCPIPConnection = 0x00000008,     
    kDTPUSBConnection = 0x00000010        
  };
 
  enum
  {
    kDTPBasicFeatures =
        0x00000000 
  };
 
  struct DTPInfoResource
  {
    long features;       
    long connectionType; 
  };
  typedef struct DTPInfoResource DTPInfoResource;
  enum
  {
    kDTPGestaltStructVersion2 =
        0x02008000,                        
    kDTPGestaltStructVersion3 = 0x03000000 
  };
 
  struct DTPInfo
  {
    short vRefNum;     
    long dirID;        
    Str31 dtpName;     
    OSType driverType; 
    Boolean current;   
    Str32 printerName; 
    Str32 zoneName;    
  };
  typedef struct DTPInfo DTPInfo;
  struct GestaltDTPInfoRec
  {
    long version;            
    short numDTPs;           
    Handle theDTPList;       
    Handle theDTPDriverList; 
    long reserved;
  };
  typedef struct GestaltDTPInfoRec GestaltDTPInfoRec;
  typedef GestaltDTPInfoRec *GestaltDTPInfoPtr;
  typedef GestaltDTPInfoPtr *GestaltDTPInfoHdle;
  enum
  {
    kDTPSignature = FOUR_CHAR_CODE('dtpx')
  };
 
  enum
  {
    aeDTPSetDefaultEventType = FOUR_CHAR_CODE(
        'pfsd'), 
    aeDTPSyncEventType =
        FOUR_CHAR_CODE('pfsc') 
  };
 
  struct DTPAppleEventData
  {
    OSType dtpSignature; 
    OSType dtpEventType; 
    FSSpec dtpSpec;      
  };
  typedef struct DTPAppleEventData DTPAppleEventData;
  typedef CALLBACK_API(void,
                       DTPAsyncErrorNotificationProcPtr)(StringHandle errStr);
  typedef CALLBACK_API(void, DTPEndNotificationProcPtr)(void);
  typedef CALLBACK_API(Boolean, DTPInForegroundProcPtr)(void);
  typedef CALLBACK_API(void, DTPStatusMessageProcPtr)(StringHandle statusStr);
  typedef STACK_UPP_TYPE(DTPAsyncErrorNotificationProcPtr)
      DTPAsyncErrorNotificationUPP;
  typedef STACK_UPP_TYPE(DTPEndNotificationProcPtr) DTPEndNotificationUPP;
  typedef STACK_UPP_TYPE(DTPInForegroundProcPtr) DTPInForegroundUPP;
  typedef STACK_UPP_TYPE(DTPStatusMessageProcPtr) DTPStatusMessageUPP;
#if CALL_NOT_IN_CARBON
  DTPAsyncErrorNotificationUPP
  NewDTPAsyncErrorNotificationUPP(DTPAsyncErrorNotificationProcPtr userRoutine);
#if !OPAQUE_UPP_TYPES
  enum
  {
    uppDTPAsyncErrorNotificationProcInfo = 0x000000C0
  }; 
#ifdef __cplusplus
  inline DTPAsyncErrorNotificationUPP
  NewDTPAsyncErrorNotificationUPP(DTPAsyncErrorNotificationProcPtr userRoutine)
  {
    return (DTPAsyncErrorNotificationUPP)NewRoutineDescriptor(
        (ProcPtr)(userRoutine), uppDTPAsyncErrorNotificationProcInfo,
        GetCurrentArchitecture());
  }
#else
#define NewDTPAsyncErrorNotificationUPP(userRoutine)                \
  (DTPAsyncErrorNotificationUPP) NewRoutineDescriptor(              \
      (ProcPtr)(userRoutine), uppDTPAsyncErrorNotificationProcInfo, \
      GetCurrentArchitecture())
#endif
#endif
 
  DTPEndNotificationUPP
  NewDTPEndNotificationUPP(DTPEndNotificationProcPtr userRoutine);
#if !OPAQUE_UPP_TYPES
  enum
  {
    uppDTPEndNotificationProcInfo = 0x00000000
  }; 
#ifdef __cplusplus
  inline DTPEndNotificationUPP
  NewDTPEndNotificationUPP(DTPEndNotificationProcPtr userRoutine)
  {
    return (DTPEndNotificationUPP)NewRoutineDescriptor(
        (ProcPtr)(userRoutine), uppDTPEndNotificationProcInfo,
        GetCurrentArchitecture());
  }
#else
#define NewDTPEndNotificationUPP(userRoutine)                                 \
  (DTPEndNotificationUPP) NewRoutineDescriptor((ProcPtr)(userRoutine),        \
                                               uppDTPEndNotificationProcInfo, \
                                               GetCurrentArchitecture())
#endif
#endif
 
  DTPInForegroundUPP
  NewDTPInForegroundUPP(DTPInForegroundProcPtr userRoutine);
#if !OPAQUE_UPP_TYPES
  enum
  {
    uppDTPInForegroundProcInfo = 0x00000010
  }; 
#ifdef __cplusplus
  inline DTPInForegroundUPP
  NewDTPInForegroundUPP(DTPInForegroundProcPtr userRoutine)
  {
    return (DTPInForegroundUPP)NewRoutineDescriptor((ProcPtr)(userRoutine),
                                                    uppDTPInForegroundProcInfo,
                                                    GetCurrentArchitecture());
  }
#else
#define NewDTPInForegroundUPP(userRoutine)                                     \
  (DTPInForegroundUPP)                                                         \
      NewRoutineDescriptor((ProcPtr)(userRoutine), uppDTPInForegroundProcInfo, \
                           GetCurrentArchitecture())
#endif
#endif
 
  DTPStatusMessageUPP
  NewDTPStatusMessageUPP(DTPStatusMessageProcPtr userRoutine);
#if !OPAQUE_UPP_TYPES
  enum
  {
    uppDTPStatusMessageProcInfo = 0x000000C0
  }; 
#ifdef __cplusplus
  inline DTPStatusMessageUPP
  NewDTPStatusMessageUPP(DTPStatusMessageProcPtr userRoutine)
  {
    return (DTPStatusMessageUPP)NewRoutineDescriptor((ProcPtr)(userRoutine),
                                                     uppDTPStatusMessageProcInfo,
                                                     GetCurrentArchitecture());
  }
#else
#define NewDTPStatusMessageUPP(userRoutine)                               \
  (DTPStatusMessageUPP) NewRoutineDescriptor((ProcPtr)(userRoutine),      \
                                             uppDTPStatusMessageProcInfo, \
                                             GetCurrentArchitecture())
#endif
#endif
 
  void
  DisposeDTPAsyncErrorNotificationUPP(DTPAsyncErrorNotificationUPP userUPP);
#if !OPAQUE_UPP_TYPES
#ifdef __cplusplus
  inline void
  DisposeDTPAsyncErrorNotificationUPP(DTPAsyncErrorNotificationUPP userUPP)
  {
    DisposeRoutineDescriptor((UniversalProcPtr)userUPP);
  }
#else
#define DisposeDTPAsyncErrorNotificationUPP(userUPP) \
  DisposeRoutineDescriptor(userUPP)
#endif
#endif
 
  void
  DisposeDTPEndNotificationUPP(DTPEndNotificationUPP userUPP);
#if !OPAQUE_UPP_TYPES
#ifdef __cplusplus
  inline void DisposeDTPEndNotificationUPP(DTPEndNotificationUPP userUPP)
  {
    DisposeRoutineDescriptor((UniversalProcPtr)userUPP);
  }
#else
#define DisposeDTPEndNotificationUPP(userUPP) DisposeRoutineDescriptor(userUPP)
#endif
#endif
 
  void
  DisposeDTPInForegroundUPP(DTPInForegroundUPP userUPP);
#if !OPAQUE_UPP_TYPES
#ifdef __cplusplus
  inline void DisposeDTPInForegroundUPP(DTPInForegroundUPP userUPP)
  {
    DisposeRoutineDescriptor((UniversalProcPtr)userUPP);
  }
#else
#define DisposeDTPInForegroundUPP(userUPP) DisposeRoutineDescriptor(userUPP)
#endif
#endif
 
  void
  DisposeDTPStatusMessageUPP(DTPStatusMessageUPP userUPP);
#if !OPAQUE_UPP_TYPES
#ifdef __cplusplus
  inline void DisposeDTPStatusMessageUPP(DTPStatusMessageUPP userUPP)
  {
    DisposeRoutineDescriptor((UniversalProcPtr)userUPP);
  }
#else
#define DisposeDTPStatusMessageUPP(userUPP) DisposeRoutineDescriptor(userUPP)
#endif
#endif
 
  void
  InvokeDTPAsyncErrorNotificationUPP(StringHandle errStr,
                                     DTPAsyncErrorNotificationUPP userUPP);
#if !OPAQUE_UPP_TYPES
#ifdef __cplusplus
  inline void
  InvokeDTPAsyncErrorNotificationUPP(StringHandle errStr,
                                     DTPAsyncErrorNotificationUPP userUPP)
  {
    CALL_ONE_PARAMETER_UPP(userUPP, uppDTPAsyncErrorNotificationProcInfo, errStr);
  }
#else
#define InvokeDTPAsyncErrorNotificationUPP(errStr, userUPP)               \
  CALL_ONE_PARAMETER_UPP((userUPP), uppDTPAsyncErrorNotificationProcInfo, \
                         (errStr))
#endif
#endif
 
  void
  InvokeDTPEndNotificationUPP(DTPEndNotificationUPP userUPP);
#if !OPAQUE_UPP_TYPES
#ifdef __cplusplus
  inline void InvokeDTPEndNotificationUPP(DTPEndNotificationUPP userUPP)
  {
    CALL_ZERO_PARAMETER_UPP(userUPP, uppDTPEndNotificationProcInfo);
  }
#else
#define InvokeDTPEndNotificationUPP(userUPP) \
  CALL_ZERO_PARAMETER_UPP((userUPP), uppDTPEndNotificationProcInfo)
#endif
#endif
 
  Boolean
  InvokeDTPInForegroundUPP(DTPInForegroundUPP userUPP);
#if !OPAQUE_UPP_TYPES
#ifdef __cplusplus
  inline Boolean InvokeDTPInForegroundUPP(DTPInForegroundUPP userUPP)
  {
    return (Boolean)CALL_ZERO_PARAMETER_UPP(userUPP, uppDTPInForegroundProcInfo);
  }
#else
#define InvokeDTPInForegroundUPP(userUPP) \
  (Boolean) CALL_ZERO_PARAMETER_UPP((userUPP), uppDTPInForegroundProcInfo)
#endif
#endif
 
  void
  InvokeDTPStatusMessageUPP(StringHandle statusStr, DTPStatusMessageUPP userUPP);
#if !OPAQUE_UPP_TYPES
#ifdef __cplusplus
  inline void InvokeDTPStatusMessageUPP(StringHandle statusStr,
                                        DTPStatusMessageUPP userUPP)
  {
    CALL_ONE_PARAMETER_UPP(userUPP, uppDTPStatusMessageProcInfo, statusStr);
  }
#else
#define InvokeDTPStatusMessageUPP(statusStr, userUPP) \
  CALL_ONE_PARAMETER_UPP((userUPP), uppDTPStatusMessageProcInfo, (statusStr))
#endif
#endif
 
#endif 
#if CALL_NOT_IN_CARBON || OLDROUTINENAMES
#define NewDTPAsyncErrorNotificationProc(userRoutine) \
  NewDTPAsyncErrorNotificationUPP(userRoutine)
#define NewDTPEndNotificationProc(userRoutine) \
  NewDTPEndNotificationUPP(userRoutine)
#define NewDTPInForegroundProc(userRoutine) NewDTPInForegroundUPP(userRoutine)
#define NewDTPStatusMessageProc(userRoutine) NewDTPStatusMessageUPP(userRoutine)
#define CallDTPAsyncErrorNotificationProc(userRoutine, errStr) \
  InvokeDTPAsyncErrorNotificationUPP(errStr, userRoutine)
#define CallDTPEndNotificationProc(userRoutine) \
  InvokeDTPEndNotificationUPP(userRoutine)
#define CallDTPInForegroundProc(userRoutine) \
  InvokeDTPInForegroundUPP(userRoutine)
#define CallDTPStatusMessageProc(userRoutine, statusStr) \
  InvokeDTPStatusMessageUPP(statusStr, userRoutine)
#endif 
  enum
  {
    kPrintMonitorPrGeneral = -3
  };
 
  struct TPrintMonitorPrintingData
  {
    short iOpCode; 
    short iError;
    long iReserved; 
    THPrint hPrint;
    short noProcs; 
    long iReserved2;
    DTPAsyncErrorNotificationUPP
        pAsyncNotificationProc; 
    DTPEndNotificationUPP
        pAsyncEndnotifyProc; 
    DTPInForegroundUPP
        pDTPInForegroundProc; 
  };
  typedef struct TPrintMonitorPrintingData TPrintMonitorPrintingData;
  struct TDesktopPrintMonitorPrintingData
  {
    short iOpCode; 
    short iError;
    long iReserved; 
    THPrint hPrint;
    short noProcs; 
    long iReserved2;
    DTPAsyncErrorNotificationUPP
        pAsyncNotificationProc; 
    DTPEndNotificationUPP
        pAsyncEndnotifyProc; 
    DTPInForegroundUPP
        pInForegroundProc; 
    DTPStatusMessageUPP
        pStatusMessageProc; 
  };
  typedef struct TDesktopPrintMonitorPrintingData
      TDesktopPrintMonitorPrintingData;
  struct SpoolFileHeader
  {
    short version;      
    long fileLen;       
    long fileFlags;     
    short numPages;     
    TPrint printRecord; 
  };
  typedef struct SpoolFileHeader SpoolFileHeader;
  typedef SpoolFileHeader *SpoolFileHeaderPtr;
  typedef SpoolFileHeaderPtr *SpoolFileHeaderHandle;
  struct SpoolPage
  {
    long pictFlags;  
    Picture thePict; 
    long pageOffset; 
  };
  typedef struct SpoolPage SpoolPage;
  struct SpoolPREC126Record
  {
    short version;   
    short flags;     
    short numPages;  
    short numCopies; 
    OSType creator;  
    Str31 appName;   
  };
  typedef struct SpoolPREC126Record SpoolPREC126Record;
  typedef SpoolPREC126Record *SpoolPREC126Ptr;
  typedef SpoolPREC126Ptr *SpoolPREC126Handle;
  struct SpoolPageIndex
  {
    short count;        
    long pageOffset[1]; 
  };
  typedef struct SpoolPageIndex SpoolPageIndex;
  typedef SpoolPageIndex *SpoolPageIndexPtr;
  typedef SpoolPageIndexPtr *SpoolPageIndexHandle;
  enum
  {
    kDTPPrintJobUrgent = 0x00000001,
    kDTPPrintJobAtTime = 0x00000002,
    kDTPPrintJobNormal = 0x00000003,
    kDTPPrintJobHolding = 0x00001003
  };
 
  struct DTPPrintJobInfo
  {
    short firstPageToPrint;    
    short priority;            
    short numCopies;           
    short numPages;            
    unsigned long timeToPrint; 
    Str31 documentName;        
    Str31 applicationName;     
    Str32 printerName;         
  };
  typedef struct DTPPrintJobInfo DTPPrintJobInfo;
  typedef DTPPrintJobInfo *DTPPrintJobInfoPtr;
  typedef DTPPrintJobInfoPtr *DTPPrintJobInfoHandle;
 
#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