IMasterPage.h

//========================================================================================
// 
// $File$
// 
// Owner: Brendan O'Shea
// 
// $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.
// 
// 
// An interface for a page which defines the master associated with that page. 
// 
//========================================================================================

#ifndef __IMASTERPAGE__
#define __IMASTERPAGE__

#include "IPMUnknown.h"
#include "MasterPageID.h"


// AdobePatentID="B1114" (sheridan 30 Nov 2009 - Master page overlay (InDesign))


class IMasterPage : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IMASTERPAGE };
 enum { kPositionDependant = kMaxUInt16 };

 virtual UID GetMasterSpreadUID() const = 0;

 virtual void SetMasterPageData( UID masterspreadUID, uint16 mpIndex = IMasterPage::kPositionDependant) = 0;

 virtual uint16 GetMasterSpreadPageIndex( UID alternateMasterSpreadUID = kInvalidUID) const = 0;

 virtual bool16 IsValid() const = 0;
 
 virtual void SetMasterPageTransform( const PMMatrix& m) = 0;
 virtual bool16 GetMasterPageTransform( PMMatrix* mp) const = 0; //return whether the matrix is identity
 
};

#endif