PdfPublishCommon.h

Go to the documentation of this file.

// Copyright (C) 2002-2017, Open Design Alliance (the "Alliance"). 
// All rights reserved. 
// 
// This software and its documentation and related materials are owned by 
// the Alliance. The software may only be incorporated into application 
// programs owned by members of the Alliance, subject to a signed 
// Membership Agreement and Supplemental Software License Agreement with the
// Alliance. The structure and organization of this software are the valuable  
// trade secrets of the Alliance and its suppliers. The software is also 
// protected by copyright law and international treaty provisions. Application  
// programs incorporating this software must include the following statement 
// with their copyright notices:
//   
//   This application incorporates Teigha(R) software pursuant to a license 
//   agreement with Open Design Alliance.
//   Teigha(R) Copyright (C) 2002-2017 by Open Design Alliance. 
//   All rights reserved.
//
// By use of this software, its documentation or related materials, you 
// acknowledge and accept the above terms.
 
 
#ifndef _PDFPUBLISH_COMMON_INCLUDED_
#define _PDFPUBLISH_COMMON_INCLUDED_
 
#include "OdaCommon.h"
 
namespace OdPdfPublish {
 
  enum PdfPublishResult
  {
    eOk                       = 0,          
    eInternalError            = 1,          
    eEmptyInputArray          = 2,          
    eNotSortedArray           = 3,          
    eDuplicatedElement        = 4,          
    eNullDocument             = 5,          
    eKeyNotFound              = 6,          
    eNullBaseName             = 7,          
    eNotImplementedYet        = 8,          
    exOdError                 = 0x00020000, 
    //DOM-IGNORE-BEGIN
    eLastErrorNum             = 0xFFFF  
    //DOM-IGNORE-END
  };
 
  namespace Activation {
    
    enum When {
      kExplicit,  
      kOpened,    
      kVisible    
    };
  }
 
  namespace Deactivation {
    
    enum When {
      kExplicit,    
      kClosed,      
      kNotVisible   
    };
  }
 
  namespace Page {
    
    enum Format {
      kA4 = 0,  
      kA3,      
      kP11x17, 
      kA5, 
      kB4JIS, 
      kB5JIS, 
      kExecutive, 
      kLegal, 
      kLetter, 
      kTabloid, 
      kB4ISO, 
      kB5ISO, 
      kCustom,
      //DOM-IGNORE-BEGIN
      kLastFormat 
      //DOM-IGNORE-END
    };
 
    enum Orientation {
      kPortrait = 0,  
      kLandscape,     
 
      //DOM-IGNORE-BEGIN
      kLastOrientation 
      //DOM-IGNORE-END
    };
 
    enum PaperUnits
    {
      kInches         = 0,   
      kMillimeters    = 1,   
      kPixels         = 2 
    };
  }
 
  namespace Camera {
    
    enum Projection {
      kOrthographic = 0,  
      kPerspective        
    };
  }
 
  namespace Lighting
  {
  
    enum Mode {
      kDefault = 0,   
      kArtwork,       
      kNone,          
      kWhite,         
      kDay,           
      kBright,        
      kPrimaryColor,  
      kNight,         
      kBlue,          
      kRed,           
      kCube,          
      kCADOptimized,  
      kHeadlamp       
    };
  }
  
  namespace Rendering
  {
    enum Mode {
      kDefault = 0,                   
      kSolid,                         
      kSolidWireframe,                
      kSolidOutline,                  
      kBoundingBox,                   
      kTransparent,                   
      kTransparentWireframe,          
      kTransparentBoundingBox,        
      kTransparentBoundingBoxOutline, 
      kIllustration,                  
      kShadedIllustration,            
      kWireframe,                     
      kShadedWireframe,               
      kHiddenWireframe,               
      kVertices,                      
      kShadedVertices                 
    };
  }
 
   namespace PRC {
   
     enum BRepCompression {
       kNone = 0,   
       kLow,        
       kMedium,     
       kHigh        
     };
   }
 
  namespace Artwork {
  
    enum AnimationStyle {
      kNone,  
      kLoop,  
      kBounce 
    };
    
    enum ViewPreference {
      kNative,  
      kPDF      
    };
    
    enum DisplayPreference {
      kDefined, 
      kRuntime  
    };
  }
 
  namespace Border {
  
    enum Thickness {
      kThin,    
      kMedium,  
      kWide     
    };
    
    enum Style {
      kSolid,         
      kDashed,        
      kBeveled,       
      kInset,         
      kUnderlined,    
    };
  }
 
  namespace Text {
  
    enum FontStyle {
      kRegular,     
      kBold,        
      kItalic,      
      kBoldItalic   
    };
    
    enum Justification {
      kLeft,    
      kRight,   
      kCenter   
    };
    
    enum Rotation {
      kNone,                        
      kCounterClockwise90Degrees,   
      kCounterClockwise180Degrees,  
      kCounterClockwise270Degrees   
    };
    
    enum StandardFontsType 
    {
      kTimesRoman,            
      kHelvetica,             
      kCourier,               
      kSymbol,                
      kTimesBold,             
      kHelveticaBold,         
      kCourierBold,           
      kZapfDingbats,          
      kTimesItalic,           
      kHelveticaOblique,      
      kCourierOblique,        
      kTimesBoldItalic,       
      kHelveticaBoldOblique,  
      kCourierBoldOblique     
    };
    enum StorageType
    {
      kBuiltIn,
      kExplicit
    };
    enum Language
    {
      kASCII,
      kEastEuropeanRoman,
      kCyrillic,
      kGreek,
      kTurkish,
      kHebrew,
      kArabic,
      kBaltic,
      kChineseTraditional,
      kChineseSimplified,
      kJapanese,
      kKorean,
      kDefault
    };
  }
 
  namespace Label {
    
    enum Position
    {
      kLabelOnly, 
      kIconOnly,  
      kTop,       
      kBottom,    
      kLeft,      
      kRight,     
      kOnTop      
    };
  }
 
  namespace Highlighting {
    
    enum Mode
    {
      kNone,    
      kInvert,  
      kOutline, 
      kPush     
    };
  }
 
  namespace Image {
    
    enum Format
    {
 
      kUnknown  = -1, 
      kBMP,           
      kICO,           
      kJPEG,          
      kJNG,           
      kKOALA,         
      kLBM,           
      kIFF,           
      kMNG,           
      kPBM,           
      kPBMRAW,        
      kPCD,           
      kPCX,           
      kPGM,           
      kPGMRAW,        
      kPNG,           
      kPPM,           
      kPPMRAW,        
      kRAS,           
      kTARGA,         
      kTIFF,          
      kWBMP,          
      kPSD,           
      kCUT,           
      kXBM,           
      kXPM,           
      kDDS,           
      kGIF,           
      kHDR,           
      kFAXG3,         
      kSGI,           
      kEXR,           
      kJ2K,           
      kJP2,           
      kPFM,           
      kPICT,          
      kRAW            
    };
  }
 
  namespace Action {
    
    enum Type
    {
      kCursorEnter,    
      kCursorExit,  
      kButtonPressed, 
      kButtonReleased,
      kInputFocus,
      kLoseFocus,
      kPageOpened,
      kPageClosed,
      kPageVisible,
      kPageInvisible
    };
  }
 
  namespace Geometry {
    enum PDFLineCap
    {
      kLineCapNotSet = -1,
      kButtCap = 0,
      kRoundCap = 1,
      kProjectingSquareCap = 2
    };
 
    enum PDFLineJoin
    {
      kLineJoinNotSet = -1,
      kMiterJoin = 0,
      kRoundJoin = 1,
      kBevelJoin = 2
    };
 
    enum PDFFinishRule
    {
      kFillNotSet  = 0,
      kEnd         = 1, // End the path
      kStroke      = 2, // Stroke the path
      kClose       = 4, // Close the path
      kFillEvenOdd = 8, // Fill the path, using the even-odd rule to determine the region to fill
      kFillNonZero = 16 // Fill the path, using the nonzero winding number rule to determine the region to fill. Any subpaths that are open are implicitly closed before being filled.
    };
  }
}
 
#endif // _PDFPUBLISH_COMMON_INCLUDED_