IBaselineFrameGridData.h

//========================================================================================
// 
// $File$
// 
// Owner: psorrick
// 
// $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 __IBaselineFrameGridData__
#define __IBaselineFrameGridData__

#include "IPMUnknown.h"
#include "TextID.h"

class IBaselineFrameGridData : public IPMUnknown
{
 public: 
 enum { kDefaultIID = IID_IBASELINEFRAMEGRIDDATA };

 typedef enum { kTopOfPage, kTopOfMargin, kTopOfFrame, kTopOfInset } RelativeOption;

 virtual void SetUseCustomBaselineGridFlag(const bool16& flag) = 0;

 virtual bool16 GetUseCustomBaselineGridFlag() const = 0;

 virtual void SetStartingOffset(const PMReal& startingOffset) = 0;

 virtual PMReal GetStartingOffset() const = 0;

 virtual void SetRelativeOption(IBaselineFrameGridData::RelativeOption& relativeOption) = 0;

 virtual IBaselineFrameGridData::RelativeOption GetRelativeOption() const = 0;

 virtual void SetIncrement(const PMReal& increment) = 0;

 virtual PMReal GetIncrement() const = 0;

 virtual bool16 GetBaselineFrameGridShown() const = 0;

 virtual UIDRef GetBaselineFrameGridColor() = 0;

 virtual void SetBaselineFrameGridColor(const UID& colorUID) = 0;

 virtual PMReal GetBaselineFrameGridViewThreshold() const = 0;

 enum SetValueID{ kSetNone = 0,
 kSetUseBaselineGrid = 1,
 kSetStartingOffset = 2, 
 kSetRelativeOption = 4, 
 kSetIncrement = 8, 
 kSetBaselineFrameGridColor = 16 };
 
 virtual void SetValue(const IBaselineFrameGridData::SetValueID& val) = 0;
 virtual void ClearSetValues() = 0;
 
 virtual bool16 ApplyValue(const IBaselineFrameGridData::SetValueID& val) const = 0;

};

#endif