IRulerSettings.h

//========================================================================================
// 
// $File$
// 
// Owner: Bernd Paradies
// 
// $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 __IRulerSettings__
#define __IRulerSettings__

#include "IPMUnknown.h"
#include "PMPoint.h"

//---------------------------------------------------------------
// Interface IRulerSettings
//---------------------------------------------------------------

class IRulerSettings : public IPMUnknown
{
public:
 enum Orientation { kHorizontal, kVertical };
 
 virtual void SetOrientation( Orientation nOrientation ) = 0; 
 // sets the ruler's orientation, default is kHorizontal.
 virtual Orientation GetOrientation() const = 0; 
 // returns the ruler's orientation, default is kHorizontal.
 virtual ClassID GetUnitOfMeasure() const = 0; 
 // returns XUnitOfMeasure on kHorizontal and YUnitOfMeasure on kVertical
 virtual PMPoint GetZeroPoint() const = 0;
 // returns the zero point
 virtual void SetZeroPoint( const PMPoint &rPoint ) = 0;
 // sets the zero point -- allowed only for the text ruler
 inline bool16 IsHorizontal() const { return this->GetOrientation() == kHorizontal; }
 // returns whether the ruler is in horizontal mode or not (=vertical).
};

#endif