IMargins.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.
// 
//========================================================================================

#ifndef __IMARGINS__
#define __IMARGINS__

#include "IPMUnknown.h"
#include "MasterPageID.h"
#include "PMRect.h"
#include "SpreadID.h"

#define kMixedMargin -1

#define kMinMargin 0

class IMargins : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IMARGINS };

 virtual void SetMargins
 (
 const PMReal& insideLeft, /* inside (for facing pages case) or left margin */
 const PMReal& top, /* top margin */
 const PMReal& outsideRight, /* outside (for facing pages case) or right margin */
 const PMReal& bottom /* bottom margin */
 ) = 0;

 virtual void GetMargins(PMRect *marginRect, bool16 wantMaster = kTrue) = 0;

 virtual void GetMargins(PMReal* insideLeft, PMReal* top, PMReal* outsideRight, PMReal* bottom, bool16 wantMaster = kTrue) = 0;
 
 virtual bool16 MarginsAreValid() = 0;

 virtual void SetMarginsAreValid(bool16 valid) = 0;
};

#endif