ColorPicker.h

Go to the documentation of this file.

 
#ifndef __COLORPICKER__
#define __COLORPICKER__
 
#ifndef __MIXEDMODE__
#include <MixedMode.h>
#endif
 
#ifndef __QUICKDRAW__
#include <Quickdraw.h>
#endif
 
#ifndef __CMAPPLICATION__
#include <CMApplication.h>
#endif
 
#ifndef __EVENTS__
#include <Events.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
  {
    /*Maximum small fract value, as long*/
    kMaximumSmallFract = 0x0000FFFF
  };
 
  enum
  {
    kDefaultColorPickerWidth = 383,
    kDefaultColorPickerHeight = 238
  };
 
  typedef SInt16 DialogPlacementSpec;
  enum
  {
    kAtSpecifiedOrigin = 0,
    kDeepestColorScreen = 1,
    kCenterOnMainScreen = 2
  };
 
  /* These are for the flags field in the structs below (for example
   * ColorPickerInfo). */
  enum
  {
    kColorPickerDialogIsMoveable = 1,
    kColorPickerDialogIsModal = 2,
    kColorPickerCanModifyPalette = 4,
    kColorPickerCanAnimatePalette = 8,
    kColorPickerAppIsColorSyncAware = 16,
    kColorPickerInSystemDialog = 32,
    kColorPickerInApplicationDialog = 64,
    kColorPickerInPickerDialog = 128,
    kColorPickerDetachedFromChoices = 256,
    kColorPickerCallColorProcLive = 512
  };
 
#if OLDROUTINENAMES
  enum
  {
    /*Maximum small fract value, as long*/
    MaxSmallFract = 0x0000FFFF
  };
 
  enum
  {
    kDefaultWidth = 383,
    kDefaultHeight = 238
  };
 
  /* These are for the flags field in the structs below (for example
   * ColorPickerInfo). */
  enum
  {
    DialogIsMoveable = 1,
    DialogIsModal = 2,
    CanModifyPalette = 4,
    CanAnimatePalette = 8,
    AppIsColorSyncAware = 16,
    InSystemDialog = 32,
    InApplicationDialog = 64,
    InPickerDialog = 128,
    DetachedFromChoices = 256,
    CallColorProcLive = 512
  };
 
#endif /* OLDROUTINENAMES */
 
  /* A SmallFract value is just the fractional part of a Fixed number,
  which is the low order word.  SmallFracts are used to save room,
  and to be compatible with Quickdraw's RGBColor.  They can be
  assigned directly to and from INTEGERs. */
  /* Unsigned fraction between 0 and 1 */
  typedef unsigned short SmallFract;
  /* For developmental simplicity in switching between the HLS and HSV
  models, HLS is reordered into HSL. Thus both models start with
  hue and saturation values; value/lightness/brightness is last. */
 
  struct HSVColor
  {
    SmallFract hue;        /*Fraction of circle, red at 0*/
    SmallFract saturation; /*0-1, 0 for gray, 1 for pure color*/
    SmallFract value;      /*0-1, 0 for black, 1 for max intensity*/
  };
  typedef struct HSVColor HSVColor;
  struct HSLColor
  {
    SmallFract hue;        /*Fraction of circle, red at 0*/
    SmallFract saturation; /*0-1, 0 for gray, 1 for pure color*/
    SmallFract lightness;  /*0-1, 0 for black, 1 for white*/
  };
  typedef struct HSLColor HSLColor;
  struct CMYColor
  {
    SmallFract cyan;
    SmallFract magenta;
    SmallFract yellow;
  };
  typedef struct CMYColor CMYColor;
  struct PMColor
  {
    CMProfileHandle profile;
    CMColor color;
  };
  typedef struct PMColor PMColor;
  typedef PMColor *PMColorPtr;
  struct NPMColor
  {
    CMProfileRef profile;
    CMColor color;
  };
  typedef struct NPMColor NPMColor;
  typedef NPMColor *NPMColorPtr;
  typedef struct OpaquePicker *Picker;
  typedef Picker picker;
  struct PickerMenuItemInfo
  {
    short editMenuID;
    short cutItem;
    short copyItem;
    short pasteItem;
    short clearItem;
    short undoItem;
  };
  typedef struct PickerMenuItemInfo PickerMenuItemInfo;
  /* Structs related to deprecated API's have been pulled from this file. */
  /* Those structs necessary for developers writing their own color pickers... */
  /* have been moved to ColorPickerComponents.h. */
 
  typedef CALLBACK_API(void, ColorChangedProcPtr)(long userData,
                                                  PMColor *newColor);
  typedef CALLBACK_API(void, NColorChangedProcPtr)(long userData,
                                                   NPMColor *newColor);
  typedef CALLBACK_API(Boolean, UserEventProcPtr)(EventRecord *event);
  typedef STACK_UPP_TYPE(ColorChangedProcPtr) ColorChangedUPP;
  typedef STACK_UPP_TYPE(NColorChangedProcPtr) NColorChangedUPP;
  typedef STACK_UPP_TYPE(UserEventProcPtr) UserEventUPP;
  struct ColorPickerInfo
  {
    PMColor theColor;
    CMProfileHandle dstProfile;
    UInt32 flags;
    DialogPlacementSpec placeWhere;
    Point dialogOrigin;
    OSType pickerType;
    UserEventUPP eventProc;
    ColorChangedUPP colorProc;
    UInt32 colorProcData;
    Str255 prompt;
    PickerMenuItemInfo mInfo;
    Boolean newColorChosen;
    SInt8 filler;
  };
  typedef struct ColorPickerInfo ColorPickerInfo;
  struct NColorPickerInfo
  {
    NPMColor theColor;
    CMProfileRef dstProfile;
    UInt32 flags;
    DialogPlacementSpec placeWhere;
    Point dialogOrigin;
    OSType pickerType;
    UserEventUPP eventProc;
    NColorChangedUPP colorProc;
    UInt32 colorProcData;
    Str255 prompt;
    PickerMenuItemInfo mInfo;
    Boolean newColorChosen;
    UInt8 reserved; /*Must be 0*/
  };
  typedef struct NColorPickerInfo NColorPickerInfo;
 
  /*  Below are the color conversion routines.*/
  SmallFract
  Fix2SmallFract(Fixed f);
 
  Fixed
  SmallFract2Fix(SmallFract s);
 
  void
  CMY2RGB(const CMYColor *cColor, RGBColor *rColor);
 
  void
  RGB2CMY(const RGBColor *rColor, CMYColor *cColor);
 
  void
  HSL2RGB(const HSLColor *hColor, RGBColor *rColor);
 
  void
  RGB2HSL(const RGBColor *rColor, HSLColor *hColor);
 
  void
  HSV2RGB(const HSVColor *hColor, RGBColor *rColor);
 
  void
  RGB2HSV(const RGBColor *rColor, HSVColor *hColor);
 
  /*  GetColor() works with or without the Color Picker extension.*/
  Boolean
  GetColor(Point where, ConstStr255Param prompt, const RGBColor *inColor,
           RGBColor *outColor);
 
  /*  PickColor() requires the Color Picker extension (version 2.0 or greater).*/
  OSErr
  PickColor(ColorPickerInfo *theColorInfo);
 
  /*  NPickColor() requires the Color Picker extension (version 2.1 or greater).*/
  OSErr
  NPickColor(NColorPickerInfo *theColorInfo);
 
  /* A suite of mid-level API calls have been deprecated.  Likely you never...  */
  /* used them anyway.  They were removed from this file and should not be... */
  /* used in the future as they are not gauranteed to be supported. */
  ColorChangedUPP
  NewColorChangedUPP(ColorChangedProcPtr userRoutine);
#if !OPAQUE_UPP_TYPES
  enum
  {
    uppColorChangedProcInfo = 0x000003C0
  }; /* pascal no_return_value Func(4_bytes, 4_bytes) */
#ifdef __cplusplus
  inline ColorChangedUPP NewColorChangedUPP(ColorChangedProcPtr userRoutine)
  {
    return (ColorChangedUPP)NewRoutineDescriptor((ProcPtr)(userRoutine),
                                                 uppColorChangedProcInfo,
                                                 GetCurrentArchitecture());
  }
#else
#define NewColorChangedUPP(userRoutine)                                     \
  (ColorChangedUPP)                                                         \
      NewRoutineDescriptor((ProcPtr)(userRoutine), uppColorChangedProcInfo, \
                           GetCurrentArchitecture())
#endif
#endif
 
  NColorChangedUPP
  NewNColorChangedUPP(NColorChangedProcPtr userRoutine);
#if !OPAQUE_UPP_TYPES
  enum
  {
    uppNColorChangedProcInfo = 0x000003C0
  }; /* pascal no_return_value Func(4_bytes, 4_bytes) */
#ifdef __cplusplus
  inline NColorChangedUPP NewNColorChangedUPP(NColorChangedProcPtr userRoutine)
  {
    return (NColorChangedUPP)NewRoutineDescriptor((ProcPtr)(userRoutine),
                                                  uppNColorChangedProcInfo,
                                                  GetCurrentArchitecture());
  }
#else
#define NewNColorChangedUPP(userRoutine)                                     \
  (NColorChangedUPP)                                                         \
      NewRoutineDescriptor((ProcPtr)(userRoutine), uppNColorChangedProcInfo, \
                           GetCurrentArchitecture())
#endif
#endif
 
  UserEventUPP
  NewUserEventUPP(UserEventProcPtr userRoutine);
#if !OPAQUE_UPP_TYPES
  enum
  {
    uppUserEventProcInfo = 0x000000D0
  }; /* pascal 1_byte Func(4_bytes) */
#ifdef __cplusplus
  inline UserEventUPP NewUserEventUPP(UserEventProcPtr userRoutine)
  {
    return (UserEventUPP)NewRoutineDescriptor(
        (ProcPtr)(userRoutine), uppUserEventProcInfo, GetCurrentArchitecture());
  }
#else
#define NewUserEventUPP(userRoutine)   \
  (UserEventUPP) NewRoutineDescriptor( \
      (ProcPtr)(userRoutine), uppUserEventProcInfo, GetCurrentArchitecture())
#endif
#endif
 
  void
  DisposeColorChangedUPP(ColorChangedUPP userUPP);
#if !OPAQUE_UPP_TYPES
#ifdef __cplusplus
  inline void DisposeColorChangedUPP(ColorChangedUPP userUPP)
  {
    DisposeRoutineDescriptor((UniversalProcPtr)userUPP);
  }
#else
#define DisposeColorChangedUPP(userUPP) DisposeRoutineDescriptor(userUPP)
#endif
#endif
 
  void
  DisposeNColorChangedUPP(NColorChangedUPP userUPP);
#if !OPAQUE_UPP_TYPES
#ifdef __cplusplus
  inline void DisposeNColorChangedUPP(NColorChangedUPP userUPP)
  {
    DisposeRoutineDescriptor((UniversalProcPtr)userUPP);
  }
#else
#define DisposeNColorChangedUPP(userUPP) DisposeRoutineDescriptor(userUPP)
#endif
#endif
 
  void
  DisposeUserEventUPP(UserEventUPP userUPP);
#if !OPAQUE_UPP_TYPES
#ifdef __cplusplus
  inline void DisposeUserEventUPP(UserEventUPP userUPP)
  {
    DisposeRoutineDescriptor((UniversalProcPtr)userUPP);
  }
#else
#define DisposeUserEventUPP(userUPP) DisposeRoutineDescriptor(userUPP)
#endif
#endif
 
  void
  InvokeColorChangedUPP(long userData, PMColor *newColor,
                        ColorChangedUPP userUPP);
#if !OPAQUE_UPP_TYPES
#ifdef __cplusplus
  inline void InvokeColorChangedUPP(long userData, PMColor *newColor,
                                    ColorChangedUPP userUPP)
  {
    CALL_TWO_PARAMETER_UPP(userUPP, uppColorChangedProcInfo, userData, newColor);
  }
#else
#define InvokeColorChangedUPP(userData, newColor, userUPP)               \
  CALL_TWO_PARAMETER_UPP((userUPP), uppColorChangedProcInfo, (userData), \
                         (newColor))
#endif
#endif
 
  void
  InvokeNColorChangedUPP(long userData, NPMColor *newColor,
                         NColorChangedUPP userUPP);
#if !OPAQUE_UPP_TYPES
#ifdef __cplusplus
  inline void InvokeNColorChangedUPP(long userData, NPMColor *newColor,
                                     NColorChangedUPP userUPP)
  {
    CALL_TWO_PARAMETER_UPP(userUPP, uppNColorChangedProcInfo, userData, newColor);
  }
#else
#define InvokeNColorChangedUPP(userData, newColor, userUPP)               \
  CALL_TWO_PARAMETER_UPP((userUPP), uppNColorChangedProcInfo, (userData), \
                         (newColor))
#endif
#endif
 
  Boolean
  InvokeUserEventUPP(EventRecord *event, UserEventUPP userUPP);
#if !OPAQUE_UPP_TYPES
#ifdef __cplusplus
  inline Boolean InvokeUserEventUPP(EventRecord *event, UserEventUPP userUPP)
  {
    return (Boolean)CALL_ONE_PARAMETER_UPP(userUPP, uppUserEventProcInfo, event);
  }
#else
#define InvokeUserEventUPP(event, userUPP) \
  (Boolean) CALL_ONE_PARAMETER_UPP((userUPP), uppUserEventProcInfo, (event))
#endif
#endif
 
#if CALL_NOT_IN_CARBON || OLDROUTINENAMES
/* support for pre-Carbon UPP routines: New...Proc and Call...Proc */
#define NewColorChangedProc(userRoutine) NewColorChangedUPP(userRoutine)
#define NewNColorChangedProc(userRoutine) NewNColorChangedUPP(userRoutine)
#define NewUserEventProc(userRoutine) NewUserEventUPP(userRoutine)
#define CallColorChangedProc(userRoutine, userData, newColor) \
  InvokeColorChangedUPP(userData, newColor, userRoutine)
#define CallNColorChangedProc(userRoutine, userData, newColor) \
  InvokeNColorChangedUPP(userData, newColor, userRoutine)
#define CallUserEventProc(userRoutine, event) \
  InvokeUserEventUPP(event, userRoutine)
#endif /* CALL_NOT_IN_CARBON */
 
#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 /* __COLORPICKER__ */