ILinkCaptionPrefs.h

//========================================================================================
// 
// $File$
// 
// Owner: lance bushore
// 
// $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 __ILinkCaptionPrefs
#define __ILinkCaptionPrefs

#include "IPMUnknown.h"
#include "LinksID.h"

class ILinkCaptionPrefs : public IPMUnknown
{
public: 
 enum { kDefaultIID = IID_ILINKCAPTIONPREFS };

 virtual int32 GetNumCaptionLines() const = 0;

 virtual PMString GetNthBeforeString(int32 index) const = 0;

 virtual PMString GetNthLinkInfoProviderName(int32 index) const = 0;

 virtual PMString GetNthAfterString(int32 index) const = 0;
 
 virtual void ClearAllCaptionLines() = 0;
 
 virtual void AddNewCaptionLine(const PMString& beforeString, const PMString& linkInfoProviderName, const PMString& afterString) = 0;

 virtual void SetFrameOffset(const PMReal& offset) = 0;
 virtual PMReal GetFrameOffset() const = 0;
 
 virtual void SetCaptionParagraphStyleUID(UID styleUID) = 0;
 virtual UID GetCaptionParagraphStyleUID() const = 0;

 virtual void SetGroupCaptionWithImage(bool shouldGroup) = 0;
 virtual bool GetGroupCaptionWithImage() const = 0;

 virtual void SetCaptionLayerName(const PMString& layerName) = 0;
 virtual PMString GetCaptionLayerName() const = 0;

 enum CaptionAlignment
 {
 kAlignAbove, 
 kAlignBelow,
 kAlignLeft,
 kAlignRight
 };
 virtual void SetCaptionAlignment(CaptionAlignment newAlign) = 0;
 virtual CaptionAlignment GetCaptionAlignment() const = 0;

 virtual void CopyFrom(const ILinkCaptionPrefs *src) = 0;
 
 
};

#endif