IPDFHyperlinks.h

//========================================================================================
// 
// $File$
// 
// Owner: Steve Flenniken
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance 
// with the terms of the Adobe license agreement accompanying it. If you have received
// this file from a source other than Adobe, then your use, modification, or 
// distribution of it requires the prior written permission of Adobe.
// 
//========================================================================================

#ifndef __IPDFHyperlinks__
#define __IPDFHyperlinks__

#include "PMRect.h"
#include "KeyValuePair.h"
#include "PDFID.h"
class PMMatrix;

typedef struct _t_PDDoc *PDDoc;
typedef struct _t_PDPage *PDPage;
typedef struct OPAQUE_64_BITS CosObj;
typedef OPAQUE_64_BITS PDAnnot;

// Used to store a list of page indeces that documents start page
typedef KeyValuePair<PMString, int32> DocPathIndexPair;
typedef K2Vector<DocPathIndexPair> DocPageIndexList;

class HotSpotAttributes
{
public:
 HotSpotAttributes() : borderWidth(0), hCornerRadius(0), vCornerRadius(0), selectionBehavior(1),
 useBorderColor(0), borderDashArrayLen(0) {};
 ~HotSpotAttributes() {};

 int32 borderWidth;

 int32 hCornerRadius;

 int32 vCornerRadius;

 int32 selectionBehavior;

 bool32 useBorderColor;

 int32 borderDashArrayLen;

 PMReal borderColor[3];

 PMReal borderDashArray[10];
};

class IPDFHyperlinks : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IPDFHYPERLINKS };

 enum DestinationType
 {
 DestXYZ = 0, 

 DestFit, 

 DestFitH, 

 DestFitV, 

 DestFitR, 

 DestFitB, 

 DestFitBH, 

 DestFitBV
 };

 class PageDestination
 {
 public:
 PageDestination() : fPageIndex(0), fDestinationType(DestXYZ), fInheritRect(true), fInheritZoom(true) {};

 PageDestination(const uint32 pageIndex, const DestinationType destinationType, const PMRect &destinationRect, const PMReal &zoomFactor) :
 fPageIndex(pageIndex), fDestinationType(destinationType), fDestinationRect(destinationRect), fZoomFactor(zoomFactor),
 fInheritRect(pageIndex), fInheritZoom(destinationType) {};
 ~PageDestination() {};

 uint32 GetPageIndex() const {return fPageIndex;} ;

 DestinationType GetDestinationType() const {return fDestinationType;};

 const PMRect &GetDestinationRect() const {return fDestinationRect;};

 PMReal GetZoomFactor() const {return fZoomFactor;};

 bool32 GetInheritRect() const {return fInheritRect;};

 bool32 GetInheritZoom() const {return fInheritZoom;};

 private:
 uint32 fPageIndex;
 DestinationType fDestinationType;
 PMRect fDestinationRect;
 PMReal fZoomFactor;
 bool32 fInheritRect;
 bool32 fInheritZoom;
 };

 virtual ErrorCode BeginBook(PDDoc thePDDoc, bool32 addHyperlinks, IDataBase *db, bool32 addBookmarks, bool32 bookExport, DocPageIndexList docIndexList, bool16 readerSpreads, bool16 layers = false) = 0;

 virtual ErrorCode EndBook() = 0;

 virtual ErrorCode BeginDocument(IDataBase *db) = 0;

 virtual ErrorCode EndDocument() = 0;

 virtual ErrorCode BeginPage(PDPage thePDPage, PMRect &pageBounds, PMMatrix &pageBoundsToSpreadMatrix, UID pageUID) = 0;

 virtual ErrorCode EndPage() = 0;

 virtual ErrorCode HyperlinkHotSpot(const PMRect &hotSpot, const PMString &name, const HotSpotAttributes *pAttributes = nil, int32 *pAnnotation = nil) = 0;

 virtual ErrorCode HyperlinkHotSpotPage(const PMRect &hotSpot, int32 pageIndex, const HotSpotAttributes *pAttributes = nil, int32 *pAnnotation = nil) = 0;

 virtual ErrorCode HyperlinkHotSpotURL(const PMRect &hotSpot, const PMString &theURL, const bool32 isMap, const HotSpotAttributes *pAttributes = nil, int32 *pAnnotation = nil) = 0;

 enum NamedType { 
 NextPage = 0,
 PrevPage, 
 FirstPage, 
 LastPage};

 virtual ErrorCode HyperlinkHotSpotNamed(const PMRect &hotSpot, NamedType namedType, const HotSpotAttributes *pAttributes = nil, int32 *pAnnotation = nil) = 0;

 virtual ErrorCode HyperlinkHotSpotExternal(const PMRect &hotSpot, const PMString &name, const PMString &fullpath, bool32 bNewWindow = false, const HotSpotAttributes *pAttributes = nil, int32 *pAnnotation = nil) = 0;

 virtual ErrorCode HyperlinkDestination(const PMString &name, DestinationType destType, const PMRect *destRect = nil, const PMReal *zoomFactor = nil) = 0;

 virtual ErrorCode GetLinkAnnotation(int32 annotation, CosObj *page, PDAnnot *annot) = 0;

 virtual ErrorCode CreateHyperlink(IDataBase *db, UID hyperlinkUID, PMRect &hotSpot, int32 *linkAnnotation) = 0;

 virtual ErrorCode HyperlinkHotSpotExternalPage(const PMRect &hotSpot, const PageDestination &pageDestination, const PMString &fullpath, bool32 bNewWindow = false, const HotSpotAttributes *pAttributes = nil, int32 *pAnnotation = nil) = 0;

 virtual ErrorCode BeginLayer(CosObj layerInfo) = 0;

 virtual ErrorCode EndLayer() = 0;

 virtual ErrorCode CreateEndnoteRefLink(IDataBase *db, UID endnoteUID, PMRect &hotSpot, int32 *linkAnnotation) = 0;

 virtual ErrorCode CreateEndnoteRangeLink(IDataBase *db, UID endnoteRangeUID, PMRect &hotSpot, int32 *linkAnnotation) = 0;
 
 virtual ErrorCode GetEndnotelinkAnnotation(int32 annotation, CosObj *page, PDAnnot *annot) = 0;

 virtual ErrorCode GetHyperlinkAltText(int32 annotation, PMString& altText) = 0;
};

#endif