IHyperlinkFacade.h

//========================================================================================
// 
// $File$
// 
// Owner: Jianlan Song
// 
// $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.
// 
// 
// Note:
// 
//========================================================================================


#include "Utils.h"

// ----- Interfaces -----
#include "IHyperlinkAppearanceData.h"
#include "IPDFHyperlinks.h"

// ----- ID.h files -----
#include "HyperlinkID.h"

class XRefBuildingBlock;

struct HyperlinkChanges
{
 HyperlinkChanges() : 
 changeDestination(kFalse), newDestination(kInvalidUIDRef), 
 changeSource(kFalse), newSource(kInvalidUIDRef),
 changeName(kFalse), newName(),
 changeVisibility(kFalse), visible(kFalse),
 changeBorderWidth(kFalse), borderLineWidth(1),
 changeBorderColor(kFalse), borderColor(kInvalidUID),
 changeHilight(kFalse), hilight(IHyperlinkAppearanceData::kNoHyperlinkHilight),
 changeOutline(kFalse), outlineStyle(IHyperlinkAppearanceData::kHyperlinkSolidOutline),
 changeHyperlinkAltText(kFalse), hyperlinkAltText(PMString(""))
 {}

 bool16 changeDestination;
 UIDRef newDestination;

 bool16 changeSource;
 UIDRef newSource;

 bool16 changeName;
 PMString newName;

 bool16 changeVisibility;
 bool16 visible;

 bool16 changeBorderWidth;
 int32 borderLineWidth;

 bool16 changeBorderColor;
 UID borderColor;

 bool16 changeHilight;
 IHyperlinkAppearanceData::HyperlinkHilight hilight;

 bool16 changeOutline;
 IHyperlinkAppearanceData::HyperlinkOutlineLineStyle outlineStyle;

 bool16 changeHyperlinkAltText;
 PMString hyperlinkAltText;
};

namespace Facade
{
 class IHyperlinkFacade : public IPMUnknown
 {
 public:
 enum { kDefaultIID = IID_IHYPERLINKFACADE };


 virtual ErrorCode CreateHyperlink
 (
 UIDRef hyperlinkSource,
 UIDRef hyperlinkDestination,
 UIDRef* newHyperlink = nil,
 const PMString& hyperlinkName = "",
 bool16 visible = kTrue,
 bool16 defaultAppearance = kTrue,
 bool16 visibleRectangle = kFalse,
 int32 borderLineWidth = 1,
 UID borderColor = kInvalidUID,
 IHyperlinkAppearanceData::HyperlinkHilight hilight = IHyperlinkAppearanceData::kNoHyperlinkHilight,
 IHyperlinkAppearanceData::HyperlinkOutlineLineStyle outlineStyle = IHyperlinkAppearanceData::kHyperlinkSolidOutline,
 const PMString& altText = ""
 ) = 0;
 
 virtual ErrorCode DeleteHyperlinks
 (
 UIDList hyperlinks
 ) = 0;
 
 virtual ErrorCode RenameHyperlink
 (
 UIDRef hyperlink,
 const PMString& newName
 ) = 0;

 virtual ErrorCode ChangeSourceForHyperlink
 (
 UIDRef hyperlink,
 UIDRef newSource
 ) = 0;

 virtual ErrorCode ChangeDestinationForHyperlink
 (
 UIDRef hyperlink,
 UIDRef newDestination
 ) = 0;

 virtual ErrorCode ChangeHyperlinkToDefaultAppearance
 (
 UIDRef hyperlink
 ) = 0;
 
 virtual ErrorCode ChangeHyperlinkAppearance
 (
 UIDRef hyperlink,
 bool16 changeVisible ,
 bool16 visible,
 bool16 changeWidth ,
 int32 borderLineWidth,
 bool16 changeBorderColor,
 UID borderColor,
 bool16 changeHilight,
 IHyperlinkAppearanceData::HyperlinkHilight hilight,
 bool16 changeOutlineStyle,
 IHyperlinkAppearanceData::HyperlinkOutlineLineStyle outlineStyle
 ) = 0;

 virtual ErrorCode ChangeHyperlinkVisibility
 (
 UIDRef hyperlink,
 bool16 visible
 ) = 0;

 virtual ErrorCode ChangeHyperlinkBorderWidth
 (
 UIDRef hyperlink,
 int32 borderLineWidth
 ) = 0;
 
 virtual ErrorCode ChangeHyperlinkBorderColor
 (
 UIDRef hyperlink,
 UID borderColor 
 ) = 0;

 virtual ErrorCode ChangeHyperlinkHilight
 (
 UIDRef hyperlink,
 IHyperlinkAppearanceData::HyperlinkHilight hilight
 ) = 0;
 
 virtual ErrorCode ChangeHyperlinkOutlineStyle
 (
 UIDRef hyperlink,
 IHyperlinkAppearanceData::HyperlinkOutlineLineStyle outlineStyle
 ) = 0;


 virtual ErrorCode ChangeHyperlink
 (
 UIDRef hyperlink,
 const HyperlinkChanges &changes
 ) = 0;

 virtual ErrorCode UpdateHyperlinkDestinationInfo
 (
 UIDList hyperlinks,
 bool16 openClosedDoc = kTrue
 ) = 0;
 
 
 virtual ErrorCode DeleteHyperlinkSource
 (
 UIDList sources
 ) = 0;

 virtual ErrorCode CreateHyperlinkTextSource
 (
 UIDRef story,
 TextIndex startIndex,
 int32 length,
 UIDRef* newSource = nil,
 const PMString& hyperlinkName = "",
 UID charStyle = kInvalidUID,
 bool16 visible = kTrue
 ) = 0;

 virtual ErrorCode CreateXRefTextSource
 (
 UIDRef story,
 TextIndex startIndex,
 int32 length,
 UID xrefFormat,
 UIDRef* newSource = nil,
 const PMString& hyperlinkName = "",
 bool16 visible = kTrue
 ) = 0;

 virtual ErrorCode RenameTextSource
 (
 UIDRef source,
 const PMString& hyperlinkName
 ) = 0;

 virtual ErrorCode ChangeTextSourceCharacterStyle
 (
 UIDRef source,
 UID charStyle
 ) = 0;
 
 virtual ErrorCode ConvertXRefToHyperlink
 (
 UIDRef source
 ) = 0;

 virtual ErrorCode ChangeFormatForXRef
 (
 UIDRef source,
 UID xrefFormat
 ) = 0;

 virtual ErrorCode ConvertHyperlinkToXRef
 (
 UIDRef source,
 UID xrefFormat
 ) = 0;
 
 virtual ErrorCode ChangeTextSource
 (
 UIDRef source,
 bool16 changeStory,
 UIDRef story,
 bool16 changeRange = kFalse,
 TextIndex startIndex = -1,
 int32 length = -1,
 bool16 changeName = kFalse,
 const PMString& hyperlinkName = "",
 bool16 changeCharStyle = kFalse,
 UID charStyle = kInvalidUID,
 bool16 changeXRefInfo = kFalse,
 bool16 isXRef = kFalse,
 UID xrefFormat = kInvalidUID
 ) = 0;

 virtual ErrorCode UpdateXRefSource
 (
 UIDList xrefs
 ) = 0;

 virtual ErrorCode UpdateXRefSrcsForBook
 (
 const IDFile& bookFile
 ) = 0;


 virtual ErrorCode CreateHyperlinkPageItemSource
 (
 UIDRef pageItem,
 UIDRef* newSource = nil,
 const PMString& name = "",
 bool16 visible = kTrue
 ) = 0;

 virtual ErrorCode RenameHyperlinkPageItemSource
 (
 UIDRef source,
 const PMString& name
 ) = 0;

 virtual ErrorCode ChangeHyperlinkPageItemSource
 (
 UIDRef source,
 UIDRef pageItem
 ) = 0;

 virtual ErrorCode ChangeHyperlinkPageItemSource
 (
 UIDRef source,
 UIDRef pageItem,
 const PMString& name
 ) = 0;
 

 virtual ErrorCode DeleteHyperlinkDestination
 (
 UIDList destinations
 ) = 0;
 
 virtual ErrorCode CreateHyperlinkTextDestination
 (
 UIDRef story,
 TextIndex position,
 UIDRef* newDest = nil,
 const PMString& name = "",
 bool16 visible = kTrue,
 bool16 useExistingAnchor = kFalse,
 int32 uniqueKey = 0
 ) = 0;
 
 virtual ErrorCode CreateParagraphDestination
 (
 UIDRef story,
 TextIndex position,
 UIDRef* newDest = nil,
 bool16* newDestCreated = nil,
 const PMString& name = "",
 int32 uniqueKey = 0
 ) = 0;

 virtual ErrorCode RenameHyperlinkTextDestination
 (
 UIDRef destination,
 const PMString& name
 ) = 0;
 
 virtual ErrorCode ChangeHyperlinkTextDestination
 (
 UIDRef destination,
 bool16 changeStory,
 UIDRef story,
 bool16 changePosition,
 TextIndex position,
 bool16 changeName = kFalse,
 const PMString& name = ""
 ) = 0;


 virtual ErrorCode CreateHyperlinkPageDestination
 (
 UIDRef page,
 UIDRef* newDest,
 const PMString& name,
 bool16 visible,
 PMReal zoomFact = 1.0,
 IPDFHyperlinks::DestinationType pdfFitType = IPDFHyperlinks::DestXYZ,
 PMRect zoomRectangle = kEmptyRect,
 int32 uniqueKey = 0
 ) = 0;

 virtual ErrorCode CreateHyperlinkPageDestinationWithAutoName
 (
 UIDRef page,
 UIDRef* newDest,
 bool16 visible,
 PMReal zoomFact = 1.0,
 IPDFHyperlinks::DestinationType pdfFitType = IPDFHyperlinks::DestXYZ,
 PMRect zoomRectangle = kEmptyRect,
 int32 uniqueKey = 0
 ) = 0;

 virtual ErrorCode RenameHyperlinkPageDestination
 (
 UIDRef destination,
 const PMString& name
 ) = 0;

 virtual ErrorCode RenameHyperlinkPageDestinationWithAutoName
 (
 UIDRef destination
 ) = 0;
 
 virtual ErrorCode ChangeZoomForHyperlinkPageDestination
 (
 UIDRef destination,
 bool16 changeZoomFact,
 PMReal zoomFact,
 bool16 changeFitType = kFalse,
 int32 pdfFitType = -1,
 bool16 changeRect = kFalse,
 PMRect zoomRectangle = kEmptyRect
 ) = 0;

 virtual ErrorCode ChangeHyperlinkPageDestination
 (
 UIDRef destination,
 bool16 changePage,
 UIDRef page,
 bool16 changeName = kFalse,
 const PMString& name = "",
 bool16 changeZoomFact = kFalse,
 PMReal zoomFact = -1,
 bool16 changeFitType = kFalse,
 int32 pdfFitType = -1,
 bool16 changeRect = kFalse,
 PMRect zoomRectangle = kEmptyRect
 ) = 0;

 virtual ErrorCode ChangeHyperlinkPageDestinationWithAutoName
 (
 UIDRef destination,
 bool16 changePage,
 UIDRef page,
 bool16 changeZoomFact = kFalse,
 PMReal zoomFact = -1,
 bool16 changeFitType = kFalse,
 int32 pdfFitType = -1,
 bool16 changeRect = kFalse,
 PMRect zoomRectangle = kEmptyRect
 ) = 0;


 virtual ErrorCode CreateHyperlinkExternPageDestination
 (
 IDataBase* db,
 const PMString& filePath,
 int32 pageIndex,
 UIDRef* newDest = nil,
 PMReal zoomFact = 1.0,
 IPDFHyperlinks::DestinationType pdfFitType = IPDFHyperlinks::DestXYZ,
 PMRect zoomRectangle = kEmptyRect,
 int32 uniqueKey = 0
 ) = 0;

 virtual ErrorCode ChangePageIndexForHyperlinkExternPageDest
 (
 UIDRef destination,
 int32 pageIndex 
 ) = 0;
 
 virtual ErrorCode ChangeZoomForHyperlinkExternPageDest
 (
 UIDRef destination,
 bool16 changeZoomFact,
 PMReal zoomFact,
 bool16 changeFitType = kFalse,
 int32 pdfFitType = -1,
 bool16 changeRect = kFalse,
 PMRect zoomRectangle = kEmptyRect
 ) = 0;
 
 virtual ErrorCode ChangeHyperlinkExternPageDestination
 (
 UIDRef destination,
 bool16 changeFile,
 const PMString& filePath,
 bool16 changePageIndex,
 int32 pageIndex,
 bool16 changeZoomFact = kFalse,
 PMReal zoomFact = -1,
 bool16 changeFitType = kFalse,
 int32 pdfFitType = -1,
 bool16 changeRect = kFalse,
 PMRect zoomRectangle = kEmptyRect
 ) = 0;


 virtual ErrorCode CreateHyperlinkURLDestination
 (
 IDataBase* db,
 const PMString& urlString,
 UIDRef* newDest = nil,
 const PMString& name = "",
 bool16 visible = kTrue,
 int32 uniqueKey = 0
 ) = 0;

 virtual ErrorCode ChangeHyperlinkURLDestinationName
 (
 UIDRef destination,
 const PMString& name
 ) = 0;

 virtual ErrorCode ChangeHyperlinkURLDestinationURL
 (
 UIDRef destination,
 const PMString& urlString
 ) = 0;

 virtual ErrorCode ChangeHyperlinkURLDestination
 (
 UIDRef destination,
 const PMString& urlString,
 const PMString& name
 ) = 0;


 virtual ErrorCode CreateXRefFormat
 (
 IDataBase* db,
 UIDRef* newFormat = nil,
 const K2Vector<XRefBuildingBlock>* buildingBlocks = nil,
 const PMString& name = "",
 UID charStyle = kInvalidUID
 ) = 0;
 
 virtual ErrorCode DeleteXRefFormat
 (
 UIDList formats
 ) = 0;

 virtual ErrorCode ChangeXRefFormatName
 (
 UIDRef format,
 const PMString& name
 ) = 0;

 virtual ErrorCode ChangeXRefFormatCharacterStyle
 (
 UIDRef format,
 UID charStyle
 ) = 0;
 
 virtual ErrorCode ChangeXRefFormatBuildingBlocks
 (
 UIDRef format,
 const K2Vector<XRefBuildingBlock>* buildingBlocks
 ) = 0;

 virtual ErrorCode ChangeXRefFormat
 (
 UIDRef format,
 const PMString& name,
 const K2Vector<XRefBuildingBlock>* buildingBlocks,
 UID charStyle
 ) = 0;

 virtual ErrorCode LoadXRefFormats
 (
 IDataBase* db, 
 const IDFile& sourceFile
 ) = 0;
 
 virtual ErrorCode LoadXRefFormatsFromCloudID(IDataBase* db, const std::string & assetRef) =0;
 };
}