Mac OS 9
GXEnvironment.h File Reference

QuickDraw GX environment constants and interfaces. More...

#include <ConditionalMacros.h>
#include <MixedMode.h>
#include <Quickdraw.h>
#include <GXTypes.h>
#include <CMApplication.h>

Go to the source code of this file.

Data Structures

struct  gxQuickDrawPict
 
struct  gxFlatProfileListItem
 

Macros

#define NewgxPollingHandlerUPP(userRoutine)
 
#define DisposegxPollingHandlerUPP(userUPP)   DisposeRoutineDescriptor(userUPP)
 
#define InvokegxPollingHandlerUPP(reference, flags, userUPP)
 
#define NewgxPollingHandlerProc(userRoutine)   NewgxPollingHandlerUPP(userRoutine)
 
#define CallgxPollingHandlerProc(userRoutine, reference, flags)    InvokegxPollingHandlerUPP(reference, flags, userRoutine)
 
#define NewgxShapeSpoolUPP(userRoutine)
 
#define NewgxUserViewPortFilterUPP(userRoutine)
 
#define NewgxConvertQDFontUPP(userRoutine)
 
#define DisposegxShapeSpoolUPP(userUPP)   DisposeRoutineDescriptor(userUPP)
 
#define DisposegxUserViewPortFilterUPP(userUPP)    DisposeRoutineDescriptor(userUPP)
 
#define DisposegxConvertQDFontUPP(userUPP)   DisposeRoutineDescriptor(userUPP)
 
#define InvokegxShapeSpoolUPP(toSpool, refCon, userUPP)
 
#define InvokegxUserViewPortFilterUPP(toFilter, portOrder, refCon, userUPP)
 
#define InvokegxConvertQDFontUPP(dst, txFont, txFace, userUPP)
 
#define NewgxShapeSpoolProc(userRoutine)   NewgxShapeSpoolUPP(userRoutine)
 
#define NewgxUserViewPortFilterProc(userRoutine)    NewgxUserViewPortFilterUPP(userRoutine)
 
#define NewgxConvertQDFontProc(userRoutine)   NewgxConvertQDFontUPP(userRoutine)
 
#define CallgxShapeSpoolProc(userRoutine, toSpool, refCon)    InvokegxShapeSpoolUPP(toSpool, refCon, userRoutine)
 
#define CallgxUserViewPortFilterProc(userRoutine, toFilter, portOrder, refCon)    InvokegxUserViewPortFilterUPP(toFilter, portOrder, refCon, userRoutine)
 
#define CallgxConvertQDFontProc(userRoutine, dst, txFont, txFace)    InvokegxConvertQDFontUPP(dst, txFont, txFace, userRoutine)
 

Typedefs

typedef long gxPollingHandlerFlags
 
typedef gxPollingHandlerFlags flags
 
typedef long gxTranslationOption
 
typedef long gxTranslationStatistic
 
typedef struct gxQuickDrawPict gxQuickDrawPict
 
typedef long refCon
 
typedef gxViewPort portOrder
 
typedef long txFont
 
typedef long long txFace
 
typedef gxShapeSpoolProcPtr gxShapeSpoolFunction
 
typedef gxUserViewPortFilterProcPtr gxUserViewPortFilter
 
typedef gxConvertQDFontProcPtr gxConvertQDFontFunction
 
typedef unsigned long gxProfilePoolAttributes
 
typedef struct gxFlatProfileListItem gxFlatProfileListItem
 

Enumerations

enum  { defaultPollingHandlerFlags = 0x00 , okToSwitchDuringPollFlag = 0x00 , dontSwitchDuringPollFlag = 0x01 }
 
enum  { uppgxPollingHandlerProcInfo = 0x000003C1 }
 
enum  {
  gxDefaultOptionsTranslation = 0x0000 , gxOptimizedTranslation = 0x0001 , gxReplaceLineWidthTranslation = 0x0002 , gxSimpleScalingTranslation = 0x0004 ,
  gxSimpleGeometryTranslation = 0x0008 , gxSimpleLinesTranslation = 0x000C , gxLayoutTextTranslation = 0x0010 , gxRasterTargetTranslation = 0x0020 ,
  gxPostScriptTargetTranslation = 0x0040 , gxVectorTargetTranslation = 0x0080 , gxPDDTargetTranslation = 0x0100 , gxDontConvertPatternsTranslation = 0x1000 ,
  gxDontSplitBitmapsTranslation = 0x2000
}
 
enum  { gxContainsFormsBegin = 0x0001 , gxContainsFormsEnd = 0x0002 , gxContainsPostScript = 0x0004 , gxContainsEmptyPostScript = 0x0008 }
 
enum  { gxQuickDrawPictTag = FOUR_CHAR_CODE('pict') }
 
enum  { uppgxShapeSpoolProcInfo = 0x000003E1 }
 
enum  { uppgxUserViewPortFilterProcInfo = 0x00000FC1 }
 
enum  { uppgxConvertQDFontProcInfo = 0x00000FF1 }
 

Functions

typedef CALLBACK_API_C (void, gxPollingHandlerProcPtr)(long reference
 
typedef STACK_UPP_TYPE (gxPollingHandlerProcPtr) gxPollingHandlerUPP
 
gxPollingHandlerUPP NewgxPollingHandlerUPP (gxPollingHandlerProcPtr userRoutine)
 
void DisposegxPollingHandlerUPP (gxPollingHandlerUPP userUPP)
 
void InvokegxPollingHandlerUPP (long reference, gxPollingHandlerFlags flags, gxPollingHandlerUPP userUPP)
 
gxPollingHandlerUPP GXGetGraphicsPollingHandler (long *reference)
 
void GXSetGraphicsPollingHandler (gxPollingHandlerUPP handler, long reference)
 
gxViewPort GXNewWindowViewPort (WindowRef qdWindow)
 
gxViewPort GXGetWindowViewPort (WindowRef qdWindow)
 
WindowRef GXGetViewPortWindow (gxViewPort portOrder)
 
GDHandle GXGetViewDeviceGDevice (gxViewDevice theDevice)
 
gxViewDevice GXGetGDeviceViewDevice (GDHandle qdGDevice)
 
void GXConvertQDPoint (const Point *shortPt, gxViewPort portOrder, gxPoint *fixedPt)
 
typedef CALLBACK_API_C (OSErr, gxShapeSpoolProcPtr)(gxShape toSpool
 
typedef CALLBACK_API_C (void, gxUserViewPortFilterProcPtr)(gxShape toFilter
 
typedef CALLBACK_API_C (long, gxConvertQDFontProcPtr)(gxStyle dst
 
typedef STACK_UPP_TYPE (gxShapeSpoolProcPtr) gxShapeSpoolUPP
 
typedef STACK_UPP_TYPE (gxUserViewPortFilterProcPtr) gxUserViewPortFilterUPP
 
typedef STACK_UPP_TYPE (gxConvertQDFontProcPtr) gxConvertQDFontUPP
 
gxShapeSpoolUPP NewgxShapeSpoolUPP (gxShapeSpoolProcPtr userRoutine)
 
gxUserViewPortFilterUPP NewgxUserViewPortFilterUPP (gxUserViewPortFilterProcPtr userRoutine)
 
gxConvertQDFontUPP NewgxConvertQDFontUPP (gxConvertQDFontProcPtr userRoutine)
 
void DisposegxShapeSpoolUPP (gxShapeSpoolUPP userUPP)
 
void DisposegxUserViewPortFilterUPP (gxUserViewPortFilterUPP userUPP)
 
void DisposegxConvertQDFontUPP (gxConvertQDFontUPP userUPP)
 
OSErr InvokegxShapeSpoolUPP (gxShape toSpool, long refCon, gxShapeSpoolUPP userUPP)
 
void InvokegxUserViewPortFilterUPP (gxShape toFilter, gxViewPort portOrder, long refCon, gxUserViewPortFilterUPP userUPP)
 
long InvokegxConvertQDFontUPP (gxStyle dst, long txFont, long txFace, gxConvertQDFontUPP userUPP)
 
void GXGetGlobalMouse (gxPoint *globalPt)
 
void GXGetViewPortMouse (gxViewPort portOrder, gxPoint *localPt)
 
gxUserViewPortFilterUPP GXGetViewPortFilter (gxViewPort portOrder, long *refCon)
 
void GXSetViewPortFilter (gxViewPort portOrder, gxUserViewPortFilterUPP filter, long refCon)
 
void GXInstallQDTranslator (GrafPtr port, gxTranslationOption options, const Rect *srcRect, const Rect *dstRect, Point styleStrech, gxShapeSpoolUPP userFunction, void *reference)
 
gxTranslationStatistic GXRemoveQDTranslator (GrafPtr port, gxTranslationStatistic *statistic)
 
gxShape GXConvertPICTToShape (PicHandle pict, gxTranslationOption options, const Rect *srcRect, const Rect *dstRect, Point styleStretch, gxShape destination, gxTranslationStatistic *stats)
 
long GXConvertQDFont (gxStyle theStyle, long txFont, long txFace)
 
gxConvertQDFontUPP GXGetConvertQDFont (void)
 
void GXSetConvertQDFont (gxConvertQDFontUPP userFunction)
 

Detailed Description

QuickDraw GX environment constants and interfaces.

Introduced In: Quickdraw GX 1.1
Avaliable From: Universal Interfaces 3.4.1
Copyright: © 1994-2001 by Apple Computer, Inc., all rights reserved.

For bug reports, consult the following page on the World Wide Web:

http://developer.apple.com/bugreporter/

Macro Definition Documentation

◆ InvokegxConvertQDFontUPP

#define InvokegxConvertQDFontUPP (   dst,
  txFont,
  txFace,
  userUPP 
)
Value:
(long)CALL_THREE_PARAMETER_UPP((userUPP), uppgxConvertQDFontProcInfo, (dst), \
(txFont), (txFace))

◆ InvokegxPollingHandlerUPP

#define InvokegxPollingHandlerUPP (   reference,
  flags,
  userUPP 
)
Value:
CALL_TWO_PARAMETER_UPP((userUPP), uppgxPollingHandlerProcInfo, (reference), \
(flags))

◆ InvokegxShapeSpoolUPP

#define InvokegxShapeSpoolUPP (   toSpool,
  refCon,
  userUPP 
)
Value:
(OSErr) CALL_TWO_PARAMETER_UPP((userUPP), uppgxShapeSpoolProcInfo, \
(toSpool), (refCon))

◆ InvokegxUserViewPortFilterUPP

#define InvokegxUserViewPortFilterUPP (   toFilter,
  portOrder,
  refCon,
  userUPP 
)
Value:
CALL_THREE_PARAMETER_UPP((userUPP), uppgxUserViewPortFilterProcInfo, \
(toFilter), (portOrder), (refCon))

◆ NewgxConvertQDFontUPP

#define NewgxConvertQDFontUPP (   userRoutine)
Value:
(gxConvertQDFontUPP) \
NewRoutineDescriptor((ProcPtr)(userRoutine), uppgxConvertQDFontProcInfo, \
GetCurrentArchitecture())
UniversalProcPtr NewRoutineDescriptor(ProcPtr theProc, ProcInfoType theProcInfo, ISAType theISA)

4_bytes Func(4_bytes, 4_bytes, 4_bytes)

◆ NewgxPollingHandlerProc

#define NewgxPollingHandlerProc (   userRoutine)    NewgxPollingHandlerUPP(userRoutine)

CALL_NOT_IN_CARBON support for pre-Carbon UPP routines: New...Proc and Call...Proc

◆ NewgxPollingHandlerUPP

#define NewgxPollingHandlerUPP (   userRoutine)
Value:
(gxPollingHandlerUPP) NewRoutineDescriptor((ProcPtr)(userRoutine), \
uppgxPollingHandlerProcInfo, \
GetCurrentArchitecture())

no_return_value Func(4_bytes, 4_bytes)

◆ NewgxShapeSpoolProc

#define NewgxShapeSpoolProc (   userRoutine)    NewgxShapeSpoolUPP(userRoutine)

CALL_NOT_IN_CARBON support for pre-Carbon UPP routines: New...Proc and Call...Proc

◆ NewgxShapeSpoolUPP

#define NewgxShapeSpoolUPP (   userRoutine)
Value:
(gxShapeSpoolUPP) \
NewRoutineDescriptor((ProcPtr)(userRoutine), uppgxShapeSpoolProcInfo, \
GetCurrentArchitecture())

2_bytes Func(4_bytes, 4_bytes)

◆ NewgxUserViewPortFilterUPP

#define NewgxUserViewPortFilterUPP (   userRoutine)
Value:
(gxUserViewPortFilterUPP) NewRoutineDescriptor( \
(ProcPtr)(userRoutine), uppgxUserViewPortFilterProcInfo, \
GetCurrentArchitecture())

no_return_value Func(4_bytes, 4_bytes, 4_bytes)

Typedef Documentation

◆ gxProfilePoolAttributes

typedef unsigned long gxProfilePoolAttributes

CALL_NOT_IN_CARBON

◆ gxShapeSpoolFunction

typedef gxShapeSpoolProcPtr gxShapeSpoolFunction

CALL_NOT_IN_CARBON

Enumeration Type Documentation

◆ anonymous enum

anonymous enum

old header = graphics macintosh

◆ anonymous enum

anonymous enum

old header = graphics toolbox QD to QD GX Translator typedefs CALL_NOT_IN_CARBON

Enumerator
gxSimpleLinesTranslation 

implies simple scaling

gxLayoutTextTranslation 

implies simple geometry & scaling

gxRasterTargetTranslation 

turn on gxLine layout (normally off)

Function Documentation

◆ CALLBACK_API_C() [1/2]

typedef CALLBACK_API_C ( OSErr  ,
gxShapeSpoolProcPtr   
)

CALL_NOT_IN_CARBON

◆ CALLBACK_API_C() [2/2]

typedef CALLBACK_API_C ( void  ,
gxUserViewPortFilterProcPtr   
)

printing utilities typedef

◆ DisposegxConvertQDFontUPP()

void DisposegxConvertQDFontUPP ( gxConvertQDFontUPP  userUPP)

DisposegxConvertQDFontUPP()

Non-Carbon CFM: available as macro/inline
Carbon Lib: not available
Mac OS X: not available

◆ DisposegxPollingHandlerUPP()

void DisposegxPollingHandlerUPP ( gxPollingHandlerUPP  userUPP)

DisposegxPollingHandlerUPP()

Non-Carbon CFM: available as macro/inline
Carbon Lib: not available
Mac OS X: not available

◆ DisposegxShapeSpoolUPP()

void DisposegxShapeSpoolUPP ( gxShapeSpoolUPP  userUPP)

DisposegxShapeSpoolUPP()

Non-Carbon CFM: available as macro/inline
Carbon Lib: not available
Mac OS X: not available

◆ DisposegxUserViewPortFilterUPP()

void DisposegxUserViewPortFilterUPP ( gxUserViewPortFilterUPP  userUPP)

DisposegxUserViewPortFilterUPP()

Non-Carbon CFM: available as macro/inline
Carbon Lib: not available
Mac OS X: not available

◆ GXConvertPICTToShape()

gxShape GXConvertPICTToShape ( PicHandle  pict,
gxTranslationOption  options,
const Rect srcRect,
const Rect dstRect,
Point  styleStretch,
gxShape  destination,
gxTranslationStatistic *  stats 
)

GXConvertPICTToShape()

Non-Carbon CFM: not available
Carbon Lib: not available
Mac OS X: not available

◆ GXConvertQDFont()

long GXConvertQDFont ( gxStyle  theStyle,
long  txFont,
long  txFace 
)

Find the best GX style given a QD font and face. Called by the QD->GX translator GXConvertQDFont()

Non-Carbon CFM: not available
Carbon Lib: not available
Mac OS X: not available

◆ GXConvertQDPoint()

void GXConvertQDPoint ( const Point shortPt,
gxViewPort  portOrder,
gxPoint fixedPt 
)

gxPoint utilities GXConvertQDPoint()

Non-Carbon CFM: not available
Carbon Lib: not available
Mac OS X: not available

◆ GXGetConvertQDFont()

gxConvertQDFontUPP GXGetConvertQDFont ( void  )

GXGetConvertQDFont()

Non-Carbon CFM: not available
Carbon Lib: not available
Mac OS X: not available

◆ GXGetGDeviceViewDevice()

gxViewDevice GXGetGDeviceViewDevice ( GDHandle  qdGDevice)

GXGetGDeviceViewDevice()

Non-Carbon CFM: not available
Carbon Lib: not available
Mac OS X: not available

◆ GXGetGlobalMouse()

void GXGetGlobalMouse ( gxPoint globalPt)

mouse utilities return mouse location in fixed-gxPoint global space GXGetGlobalMouse()

Non-Carbon CFM: not available
Carbon Lib: not available
Mac OS X: not available

◆ GXGetGraphicsPollingHandler()

gxPollingHandlerUPP GXGetGraphicsPollingHandler ( long *  reference)

CALL_NOT_IN_CARBON GXGetGraphicsPollingHandler()

Non-Carbon CFM: not available
Carbon Lib: not available
Mac OS X: not available

◆ GXGetViewDeviceGDevice()

GDHandle GXGetViewDeviceGDevice ( gxViewDevice  theDevice)

GDevice utilities GXGetViewDeviceGDevice()

Non-Carbon CFM: not available
Carbon Lib: not available
Mac OS X: not available

◆ GXGetViewPortFilter()

gxUserViewPortFilterUPP GXGetViewPortFilter ( gxViewPort  portOrder,
long *  refCon 
)

printing utilities GXGetViewPortFilter()

Non-Carbon CFM: not available
Carbon Lib: not available
Mac OS X: not available

◆ GXGetViewPortMouse()

void GXGetViewPortMouse ( gxViewPort  portOrder,
gxPoint localPt 
)

return fixed-gxPoint local mouse (gxViewPort == 0 --> default) GXGetViewPortMouse()

Non-Carbon CFM: not available
Carbon Lib: not available
Mac OS X: not available

◆ GXGetViewPortWindow()

WindowRef GXGetViewPortWindow ( gxViewPort  portOrder)

GXGetViewPortWindow()

Non-Carbon CFM: not available
Carbon Lib: not available
Mac OS X: not available

◆ GXGetWindowViewPort()

gxViewPort GXGetWindowViewPort ( WindowRef  qdWindow)

GXGetWindowViewPort()

Non-Carbon CFM: not available
Carbon Lib: not available
Mac OS X: not available

◆ GXInstallQDTranslator()

void GXInstallQDTranslator ( GrafPtr  port,
gxTranslationOption  options,
const Rect srcRect,
const Rect dstRect,
Point  styleStrech,
gxShapeSpoolUPP  userFunction,
void *  reference 
)

QD to QD GX Translator functions GXInstallQDTranslator()

Non-Carbon CFM: not available
Carbon Lib: not available
Mac OS X: not available

◆ GXNewWindowViewPort()

gxViewPort GXNewWindowViewPort ( WindowRef  qdWindow)

WindowRecord utilities GXNewWindowViewPort()

Non-Carbon CFM: not available
Carbon Lib: not available
Mac OS X: not available

◆ GXRemoveQDTranslator()

gxTranslationStatistic GXRemoveQDTranslator ( GrafPtr  port,
gxTranslationStatistic *  statistic 
)

GXRemoveQDTranslator()

Non-Carbon CFM: not available
Carbon Lib: not available
Mac OS X: not available

◆ GXSetConvertQDFont()

void GXSetConvertQDFont ( gxConvertQDFontUPP  userFunction)

GXSetConvertQDFont()

Non-Carbon CFM: not available
Carbon Lib: not available
Mac OS X: not available

◆ GXSetGraphicsPollingHandler()

void GXSetGraphicsPollingHandler ( gxPollingHandlerUPP  handler,
long  reference 
)

GXSetGraphicsPollingHandler()

Non-Carbon CFM: not available
Carbon Lib: not available
Mac OS X: not available

◆ GXSetViewPortFilter()

void GXSetViewPortFilter ( gxViewPort  portOrder,
gxUserViewPortFilterUPP  filter,
long  refCon 
)

GXSetViewPortFilter()

Non-Carbon CFM: not available
Carbon Lib: not available
Mac OS X: not available

◆ InvokegxConvertQDFontUPP()

long InvokegxConvertQDFontUPP ( gxStyle  dst,
long  txFont,
long  txFace,
gxConvertQDFontUPP  userUPP 
)

InvokegxConvertQDFontUPP()

Non-Carbon CFM: available as macro/inline
Carbon Lib: not available
Mac OS X: not available

◆ InvokegxPollingHandlerUPP()

void InvokegxPollingHandlerUPP ( long  reference,
gxPollingHandlerFlags  flags,
gxPollingHandlerUPP  userUPP 
)

InvokegxPollingHandlerUPP()

Non-Carbon CFM: available as macro/inline
Carbon Lib: not available
Mac OS X: not available

◆ InvokegxShapeSpoolUPP()

OSErr InvokegxShapeSpoolUPP ( gxShape  toSpool,
long  refCon,
gxShapeSpoolUPP  userUPP 
)

InvokegxShapeSpoolUPP()

Non-Carbon CFM: available as macro/inline
Carbon Lib: not available
Mac OS X: not available

◆ InvokegxUserViewPortFilterUPP()

void InvokegxUserViewPortFilterUPP ( gxShape  toFilter,
gxViewPort  portOrder,
long  refCon,
gxUserViewPortFilterUPP  userUPP 
)

InvokegxUserViewPortFilterUPP()

Non-Carbon CFM: available as macro/inline
Carbon Lib: not available
Mac OS X: not available

◆ NewgxConvertQDFontUPP()

gxConvertQDFontUPP NewgxConvertQDFontUPP ( gxConvertQDFontProcPtr  userRoutine)

NewgxConvertQDFontUPP()

Non-Carbon CFM: available as macro/inline
Carbon Lib: not available
Mac OS X: not available

◆ NewgxPollingHandlerUPP()

gxPollingHandlerUPP NewgxPollingHandlerUPP ( gxPollingHandlerProcPtr  userRoutine)

NewgxPollingHandlerUPP()

Non-Carbon CFM: available as macro/inline
Carbon Lib: not available
Mac OS X: not available

◆ NewgxShapeSpoolUPP()

gxShapeSpoolUPP NewgxShapeSpoolUPP ( gxShapeSpoolProcPtr  userRoutine)

NewgxShapeSpoolUPP()

Non-Carbon CFM: available as macro/inline
Carbon Lib: not available
Mac OS X: not available

◆ NewgxUserViewPortFilterUPP()

gxUserViewPortFilterUPP NewgxUserViewPortFilterUPP ( gxUserViewPortFilterProcPtr  userRoutine)

NewgxUserViewPortFilterUPP()

Non-Carbon CFM: available as macro/inline
Carbon Lib: not available
Mac OS X: not available