IVerticalColumnRuleData.h

//========================================================================================
// 
// $File$
// 
// Owner: Anurag Singh
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// ADOBE CONFIDENTIAL
// 
// Copyright 1997-2019 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: All information contained herein is, and remains
// the property of Adobe Systems Incorporated and its suppliers,
// if any. The intellectual and technical concepts contained
// herein are proprietary to Adobe Systems Incorporated and its
// suppliers and may be covered by U.S. and Foreign Patents,
// patents in process, and are protected by trade secret or copyright law.
// Dissemination of this information or reproduction of this material
// is strictly forbidden unless prior written permission is obtained
// from Adobe Systems Incorporated.
// 
//========================================================================================


#ifndef _IVerticalColumnRuleData_
#define _IVerticalColumnRuleData_

#define kMinVerticalRuleOffset -10000
#define kMaxVerticalRuleOffset 10000 
#define kMinVerticalRuleTopInset -10000 
#define kMaxVerticalRuleTopInset 10000 
#define kMinVerticalRuleBottomInset -10000 
#define kMaxVerticalRuleBottomInset 10000 
#define kMaxVerticalRuleWidth 10000

#ifndef __ODFRC__ // when used for core resource compilation, provide just the parameter range constants

#include "IPMUnknown.h"
#include "ICompositionStyle.h"

#include "TextID.h"

#include "PMReal.h"
class ITextFrameOptionsData;

class IVerticalColumnRuleData : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IVERTICALCOLUMNRULEDATA };

 enum VerticalRuleHeightMode
 {
 kFlag_VerticalRuleHeightDefault = 0,
 kFlag_VerticalRuleHeightAscToDesc,
 kFlag_VerticalRuleHeightEmBoxToEmBox
 };

 virtual bool16 GetUseVerticalRule() const = 0;

 virtual void SetUseVerticalRule(bool16 useVerticalRule) = 0;

 virtual PMReal GetVerticalRuleOffset() const = 0;

 virtual void SetVerticalRuleOffset(PMReal offset) = 0;

 virtual PMReal GetVerticalRuleTopInset() const = 0;

 virtual void SetVerticalRuleTopInset(PMReal inset) = 0;

 virtual bool16 GetVerticalRuleInsetChain() const = 0;

 virtual void SetVerticalRuleInsetChain(bool16 isChained) = 0;

 virtual PMReal GetVerticalRuleBottomInset() const = 0;

 virtual void SetVerticalRuleBottomInset(PMReal inset) = 0;

 virtual PMReal GetVerticalRuleStrokeWidth() const = 0;

 virtual void SetVerticalRuleStrokeWidth(PMReal width) = 0;

 virtual UID GetVerticalRuleStrokeColor() const = 0;

 virtual void SetVerticalRuleStrokeColor(UID colorUID) = 0;

 virtual ICompositionStyle::StrokeType GetVerticalRuleStrokeType() const = 0;

 virtual void SetVerticalRuleStrokeType(ICompositionStyle::StrokeType strokeType) = 0;

 virtual PMReal GetVerticalRuleTint() const = 0;

 virtual void SetVerticalRuleTint(PMReal tint) = 0;

 virtual bool16 GetVerticalRuleOverprint() const = 0;

 virtual void SetVerticalRuleOverprint(bool16 isOverprint) = 0;

 virtual VerticalRuleHeightMode GetVerticalRuleHeightMode() const = 0;

 virtual void SetVerticalRuleHeightMode() = 0;

 virtual void CopyFrom(const IVerticalColumnRuleData* verticalColumnRuleData) = 0;

 virtual void CopyFrom(const ITextFrameOptionsData* tfoData) = 0;
};

#endif // __odfrc__
#endif // _IVerticalColumnRuleData_