/* Copyright (C) 1997 Aladdin Enterprises.  All rights reserved.
  
  This file is part of Aladdin Ghostscript.
  
  Aladdin Ghostscript is distributed with NO WARRANTY OF ANY KIND.  No author
  or distributor accepts any responsibility for the consequences of using it,
  or for whether it serves any particular purpose or works at all, unless he
  or she says so in writing.  Refer to the Aladdin Ghostscript Free Public
  License (the "License") for full details.
  
  Every copy of Aladdin Ghostscript must include a copy of the License,
  normally in a plain ASCII text file named PUBLIC.  The License grants you
  the right to copy, modify and redistribute Aladdin Ghostscript, but only
  under certain conditions described in the License.  Among other things, the
  License requires that the copyright notice and this notice be preserved on
  all copies.
*/

/* gdevpxen.h */
/* Enumerated attribute value definitions for PCL XL */

#ifndef gdevpxen_INCLUDED
#  define gdevpxen_INCLUDED

typedef enum {
  eClockWise = 0,
  eCounterClockWise,
  pxeArcDirection_next
} pxeArcDirection_t;

typedef enum {
  eNoSubstitution = 0,
  eVerticalSubstitution,
  pxeCharSubModeArray_next
} pxeCharSubModeArray_t;

typedef enum {
  eNonZeroWinding = 0,
  eEvenOdd,
  pxeClipMode_next,
  pxeFillMode_next = pxeClipMode_next		/* see pxeFillMode_t below */
} pxeClipMode_t;

typedef enum {
  eInterior = 0,
  eExterior,
  pxeClipRegion_next
} pxeClipRegion_t;

typedef enum {
  e1Bit = 0,
  e4Bit,
  e8Bit,
  pxeColorDepth_next
} pxeColorDepth_t;

typedef enum {
  eDirectPixel = 0,
  eIndexedPixel,
  pxeColorMapping_next
} pxeColorMapping_t;

typedef enum {
  eNoColorSpace = 0, /* Note: for this enumeration only, 0 is not a valid value! */
  eGray,
  eRGB,
  pxeColorSpace_next
} pxeColorSpace_t;

typedef enum {
  eNoCompression = 0,
  eRLECompression,
  pxeCompressMode_next
} pxeCompressMode_t;

typedef enum {
  eBinaryHighByteFirst = 0,
  eBinaryLowByteFirst,
  pxeDataOrg_next	/* is this DataOrg or DataOrganization? */
} pxeDataOrg_t;

typedef enum {
  eDefault = 0,		/* bad choice of name! */
  pxeDataSource_next
} pxeDataSource_t;

typedef enum {
  eUByte = 0,
  eSByte,
  eUInt16,
  eSInt16,
  pxeDataType_next
} pxeDataType_t;

typedef enum {
  eDownloaded = -1,	/* Not a real value, indicates a downloaded matrix */
  eDeviceBest = 0,
  pxeDitherMatrix_next
} pxeDitherMatrix_t;

typedef enum {
  eDuplexHorizontalBinding = 0,
  eDuplexVerticalBinding,
  pxeDuplexPageMode_next
} pxeDuplexPageMode_t;

typedef enum {
  eFrontMediaSide = 0,
  eBackMediaSide,
  pxeDuplexPageSide_next
} pxeDuplexPageSide_t;

typedef enum {
  /* Several pieces of code know that this is a bit mask. */
  eNoReporting = 0,
  eBackChannel,
  eErrorPage,
  eBackChAndErrPage,
  pxeErrorReport_next
} pxeErrorReport_t;

typedef pxeClipMode_t pxeFillMode_t;

typedef enum {
  eButtCap = 0,
  eRoundCap,
  eSquareCap,
  eTriangleCap,
  pxeLineCap_next
} pxeLineCap_t;
#define pxeLineCap_to_library\
  { gs_cap_butt, gs_cap_round, gs_cap_square, gs_cap_triangle }

typedef enum {
  eMiterJoin = 0,
  eRoundJoin,
  eBevelJoin,
  eNoJoin,
  pxeLineJoin_next
} pxeLineJoin_t;
#define pxeLineJoin_to_library\
  { gs_join_miter, gs_join_round, gs_join_bevel, gs_join_none }

typedef enum {
  eInch = 0,
  eMillimeter,
  eTenthsOfAMillimeter,
  pxeMeasure_next
} pxeMeasure_t;
#define pxeMeasure_to_points { 72.0, 72.0 / 25.4, 72.0 / 254.0 }

/**** MediaDestination is not documented. ****/
typedef enum {
  eDefaultDestination = 0,
  pxeMediaDestination_next
} pxeMediaDestination_t;

typedef enum {
  eLetterPaper = 0,
  eLegalPaper,
  eA4Paper,
  eExecPaper,
  eLedgerPaper,
  eA3Paper,
  eCOM10Envelope,
  eMonarchEnvelope,
  eC5Envelope,
  eDLEnvelope,
  eJB4Paper,
  eJB5Paper,
  eB5Envelope,
  eJPostcard,
  eJDoublePostcard,
  eA5Paper,
  pxeMediaSize_next
} pxeMediaSize_t;

/*
 * Apply a macro (or procedure) to all known paper sizes.
 * The arguments are:
 *	media size code, resolution for width/height, width, height.
 */
#define px_enumerate_media(m)\
  m(eLetterPaper, 300, 2550, 3300)\
  m(eLegalPaper, 300, 2550, 5300)\
  m(eA4Paper, 300, 2480, 3507)\
  m(eExecPaper, 300, 2175, 3150)\
  m(eLedgerPaper, 300, 3300, 5100)\
  m(eA3Paper, 300, 3507, 4960)\
  m(eCOM10Envelope, 300, 1237, 2850)\
  m(eMonarchEnvelope, 300, 1162, 2250)\
  m(eC5Envelope, 300, 1913, 2704)\
  m(eDLEnvelope, 300, 1299, 2598)\
  m(eB5Envelope, 300, 2078, 2952)

typedef enum {
  eDefaultSource = 0,
  eAutoSelect,
  eManualFeed,
  eMultiPurposeTray,
  eUpperCassette,
  eLowerCassette,
  eEnvelopeTray,
  pxeMediaSource_next
} pxeMediaSource_t;

/**** MediaType is not documented. ****/
typedef enum {
  eDefaultType = 0,
  pxeMediaType_next
} pxeMediaType_t;

typedef enum {
  ePortraitOrientation = 0,
  eLandscapeOrientation,
  eReversePortrait,
  eReverseLandscape,
  pxeOrientation_next
} pxeOrientation_t;

typedef enum {
  eTempPattern = 0,
  ePagePattern,
  eSessionPattern,
  pxePatternPersistence_next
} pxePatternPersistence_t;

typedef enum {
  eSimplexFrontSide = 0,
  pxeSimplexPageMode_next
} pxeSimplexPageMode_t;

typedef enum {
  eOpaque = 0,
  eTransparent,
  pxeTxMode_next
} pxeTxMode_t;

#endif				/* gdevpxen_INCLUDED */
