SDKLayoutHelper.h

//========================================================================================
// 
// $File$
// 
// Owner: Adobe Developer Technologies
// 
// $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 __SDKLayoutHelper_H_DEFINED__
#define __SDKLayoutHelper_H_DEFINED__

#include "IDocFileHandler.h" // or include from client code?
#include "PMPathPoint.h" // because I can't forward decl PMPathPointList?
class ITextModel;
class ITextFrameColumn;
class IGraphicFrameData;

class SDKLayoutHelper {

 public:

 SDKLayoutHelper();
 
 virtual ~SDKLayoutHelper();

 public:
 // Document manipulation helper methods.

 UIDRef CreateDocument(const UIFlags uiFlags = K2::kFullUI,
 const PMReal& width = 612, 
 const PMReal& height = 792, 
 const int32 pages = 1,
 const int32 pagesPerSpread = 1,
 const int32 pageBinding = 0);

 UIDRef OpenDocument(const IDFile& sysFile,
 UIFlags uiFlags = K2::kFullUI);

 ErrorCode CloseDocument(const UIDRef& documentUIDRef, 
 bool16 saveOnClose = kFalse,
 UIFlags uiFlags = K2::kFullUI, 
 bool8 allowCancel = kTrue, 
 IDocFileHandler::CloseCmdMode cmdMode = IDocFileHandler::kSchedule);

 ErrorCode SaveDocumentAs(const UIDRef& documentUIDRef, 
 const IDFile& sysFile, 
 UIFlags uiFlags = kFullUI);

 ErrorCode OpenLayoutWindow(const UIDRef& documentUIDRef);

 public:
 // Spread & page manipulation:

 UIDRef GetActiveSpreadLayerRef(const UIDRef& spreadUIDRef, 
 bool16 wantGuideLayer=kFalse);

 UIDRef GetSpreadLayerRef(const UIDRef& spreadUIDRef, 
 int32 documentLayerIndex=1, 
 bool16 wantGuideLayer=kFalse);

 PMRect PageToSpread(const UIDRef& pageUIDRef, const PMRect& boundsInPageCoords);
 
 public:
 // Frame creation:

 UIDRef PlaceFileInFrame(const IDFile& contentFile,
 const UIDRef& parentUIDRef,
 const PMRect& boundsInParentCoords, 
 const UIFlags uiFlags = K2::kFullUI, 
 const bool16 retainFormat = kTrue, 
 const bool16 convertQuotes = kTrue, 
 const bool16 applyCJKGrid = kFalse,
 const UID& uidPreview = kInvalidUID);

 UIDRef CreateRectangleFrame(const UIDRef& parentUIDRef, const PMRect& boundsInParentCoords);

 UIDRef CreateTextFrame(const UIDRef& parentUIDRef,
 const PMRect& boundsInParentCoords,
 int32 numberOfColumns = 0,
 bool16 verticalFrame = kFalse,
 UIDRef* storyUIDRef = nil,
 bool16 isLeftToRight = kTrue);
 
 UIDRef CreateRectangleGraphic(const UIDRef& parentUIDRef, const PMRect& boundsInParentCoords);

 UIDRef CreateSplineGraphic(const UIDRef& parentUIDRef, 
 const PMRect& boundsInParentCoords, 
 const PMRect& boundsInInnerCoords, 
 PMPathPointList& pathPointList, 
 bool16 bClosedPath = kTrue);

 public:
 // Layout model navigation helpers.

 UIDRef GetGraphicFrameRef(const InterfacePtr<ITextFrameColumn>& textFrameColumn);

 UIDRef GetTextModelRef(const InterfacePtr<IGraphicFrameData>& graphicFrameData);

};



#endif // __SDKLayoutHelper_H_DEFINED__