mg2enums.h

Go to the documentation of this file.

/******************************************************************************,
 *
 * \file mi32/mg2enums.h
 * \brief enums used by the MGD code
 *
 * \if NODOC
 * $Log: mg2enums.h_v $
 * Revision 1.1  2004/05/25 19:26:41  dwilliss
 * Initial revision
 *
 * \endif
 */

#ifndef INC_MI32_MG2ENUMS_H
#define INC_MI32_MG2ENUMS_H

#ifndef INC_MI32_STDDEFNS_H
#include <mi32/stddefns.h>
#endif


namespace MGD {


enum FONTTYPE {
   FONTTYPE_OF = 0,
   FONTTYPE_TTF = 1
   };

enum ARROWTYPE {
   ARROWTYPE_FilledTriangle = 0,
   ARROWTYPE_UnfilledTriangle,
   ARROWTYPE_Open,
   ARROWTYPE_FilledArc
   };

//! XXX How much of this is actually used?  I don't think it's really
//! even implemented except perhaps in the X implementation
//! SetPixelFunc is used in etext.c, but sets GXinvert and GXxor, not
//! these constants.
//! mdview sets it to PIXELFUNC_Copy, which is the default anyway.
enum PIXELFUNC {
   PIXELFUNC_Clear = 0,       //!< 0
   PIXELFUNC_And,             //!< src AND dst
   PIXELFUNC_AndReverse,      //!< src AND NOT dst
   PIXELFUNC_Copy,            //!< src
   PIXELFUNC_AndInverted,     //!< NOT src AND dst
   PIXELFUNC_NoOp,            //!< dst
   PIXELFUNC_ExclusiveOr,     //!< src XOR dst
   PIXELFUNC_Or,              //!< src OR dst
   PIXELFUNC_Nor,             //!< NOT src AND NOT dst
   PIXELFUNC_Equiv,           //!< NOT src XOR dst
   PIXELFUNC_Invert,          //!< NOT dst
   PIXELFUNC_OrReverse,       //!< src OR NOT dst
   PIXELFUNC_CopyInverted,    //!< NOT src
   PIXELFUNC_OrInverted,      //!< NOT src OR dst
   PIXELFUNC_NotAnd,          //!< NOT src OR NOT dst
   PIXELFUNC_Set              //!< 1
   };

enum SHAPECLOSE {
   SHAPECLOSE_None = 0, 
   SHAPECLOSE_Direct,
   SHAPECLOSE_ViaCenter
   };

enum DEPTHTEST {
   DEPTHTEST_None = 0,
   DEPTHTEST_SetOnly = 1,
   DEPTHTEST_CheckAndSet = 2
   };

enum LINECAP {
   LINECAP_NotLast = 0,
   LINECAP_Butt,
   LINECAP_Round,
   LINECAP_Projecting
   };

enum LINEJOIN {
   LINEJOIN_Miter = 0,
   LINEJOIN_Round,
   LINEJOIN_Bevel
   };

enum POLYSHAPE {
   POLYSHAPE_Complex = 0,     //!< Polygon may or may not be convex
   POLYSHAPE_NonConvex,       //!< Polygon is known to be non-convex
   POLYSHAPE_Convex           //!< Polygon is convex (doesn't double back on itself)
   };

enum CAPABILITY {
   CAPABILITY_None               = 0,
   CAPABILITY_Transparency       = 0x00000001,  //!< Can do transparency
   CAPABILITY_3D                 = 0x00000002,
   CAPABILITY_InterfaceText      = 0x00000004,
   CAPABILITY_ScanColorUse       = 0x00000008,
   CAPABILITY_CopyRect           = 0x00000010,
   CAPABILITY_GetImage           = 0x00000020,
   CAPABILITY_MaskInImageSpan    = 0x00000040,  //!< PutImageSpan can use a mask array 
   CAPABILITY_TransparencyIsExpensive = 0x00000080,   //!< Can do it, but don't bother for anti-aliasing text.
   CAPABILITY_ComplexClip        = 0x00000100,  //!< Device handles clip regions
   CAPABILITY_BitmapFill         = 0x00000200   //!< Implements its own, optimized bitmap pattern fill in FillSpan
   };

DEFINE_ENUM_OPERATORS(CAPABILITY);

enum BASELINE {
   BASELINE_Unspecified    = 0,
   BASELINE_Straight       = 0x00000001,
   BASELINE_Spline         = 0x00000002,
   BASELINE_Nonconvex      = 0x00000004
   };
DEFINE_ENUM_OPERATORS(BASELINE);

enum TEXTBORDER {
   TEXTBORDER_None         = 0,
   TEXTBORDER_SingleLine   = 1,
   TEXTBORDER_DoubleLine   = 2
   };


//! Flags for DrawXxxxStyleSample()
enum STYLESAMPLEFLAGS {
   STYLESAMPLE_Default =         0x0000,
   STYLESAMPLE_ShrinkToFit =     0x0001,
   STYLESAMPLE_ForceToFit =      0x0002,
   STYLESAMPLE_ZigZag =          0x0004,  //!< /\/ line sample
   STYLESAMPLE_RoundRect =       0x0008,  //!< "rounded" rectangles
   STYLESAMPLE_NoScaleToMap =    0x0010,  //!< Disable scaling to map, use symbol/pattern design scale
   STYLESAMPLE_CenterSymbol =    0x0020   //!< Center symbol
   };
DEFINE_ENUM_OPERATORS(STYLESAMPLEFLAGS);


enum EMBEDPERMISSION {
   EMBEDPERMISSION_All           = 0,
   EMBEDPERMISSION_Restricted    = 0x00000002,
   EMBEDPERMISSION_PreviewPrint  = 0x00000004,
   EMBEDPERMISSION_Editable      = 0x00000008,
   EMBEDPERMISSION_NoSubset      = 0x00000100
   };

DEFINE_ENUM_OPERATORS(EMBEDPERMISSION);

enum INTERFACETEXTSTYLE {
   INTERFACETEXTSTYLE_Normal     = 0,
   INTERFACETEXTSTYLE_Bold       = 0x00000001,
   INTERFACETEXTSTYLE_Italic     = 0x00000002,
   INTERFACETEXTSTYLE_Fixed      = 0x00000004   // Fixed width font
   };

DEFINE_ENUM_OPERATORS(INTERFACETEXTSTYLE);

enum ICONFLAGS {
   ICON_OriginTop             = 0x00000000,
   ICON_OriginLeft            = 0x00000000,
   ICON_OriginBottom          = 0x00000001,
   ICON_OriginRight           = 0x00000002,
   ICON_OriginCenterX         = 0x00000004,
   ICON_OriginCenterY         = 0x00000008,
   ICON_OriginTopLeft         = (ICON_OriginTop|ICON_OriginLeft),
   ICON_OriginTopCenter       = (ICON_OriginTop|ICON_OriginCenterX),
   ICON_OriginTopRight        = (ICON_OriginTop|ICON_OriginRight),
   ICON_OriginCenterLeft      = (ICON_OriginCenterY|ICON_OriginLeft),
   ICON_OriginCenter          = (ICON_OriginCenterY|ICON_OriginCenterX),
   ICON_OriginCenterRight     = (ICON_OriginCenterY|ICON_OriginRight),
   ICON_OriginBottomLeft      = (ICON_OriginBottom|ICON_OriginLeft),
   ICON_OriginBottomCenter    = (ICON_OriginBottom|ICON_OriginCenterX),
   ICON_OriginBottomRight     = (ICON_OriginBottom|ICON_OriginRight),
   ICON_Dimmed                = 0x00000010   //!< Draw "dimmed" (stippled) icon
   };
DEFINE_ENUM_OPERATORS(ICONFLAGS);

enum BUILTINFILLSTYLE {
   BUILTINFILLSTYLE_Solid  = 0,
   BUILTINFILLSTYLE_50pct,       //!<  Every other pixel in a checkerboard pattern
   BUILTINFILLSTYLE_OneIn2x2,    //!<     2x2 pattern with one pixel on
   BUILTINFILLSTYLE_OneIn4x4,    //!<     4x4 pattern with one pixel on
   BUILTINFILLSTYLE_OneIn6x6,    //!<     6x6 pattern with one pixel on
   BUILTINFILLSTYLE_OneIn8x8,    //!<     8x8 pattern with one pixel on
   BUILTINFILLSTYLE_Hatch8L,     //!< 45 degree hatch every 8 pixels (going down to the left)
   BUILTINFILLSTYLE_Hatch8R,     //!< 45 degree hatch every 8 pixels (going down to the right)

   };

//! These constants are defined by the TrueType spec and are used for TextGetTTFName()
enum TTFNAMEID {
   TTFNAMEID_Copyright     = 0,  //!< eg: "Copyright Apple Computer, Inc. 1992"
   TTFNAMEID_Family        = 1,  //!< eg: "New York"
   TTFNAMEID_Style         = 2,  //!< eg: "Bold"
   TTFNAMEID_ID            = 3,  //!< eg: "Apple Computer New York Bold version 1.0"
   TTFNAMEID_FullName      = 4,  //!< eg: "New York Bold"
   TTFNAMEID_Version       = 5,  //!< eg: "August 10, 1991, 1.08d21"
   TTFNAMEID_PostScript    = 6,  //!< eg: "Times-Bold"
   TTFNAMEID_Trademark     = 7,
   TTFNAMEID_Designer      = 8
   };



} // End of namespace MGD


#endif   // INC_MI32_MG2ENUMS_H

---