InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ILinkCaptionPrefs.h
1 //========================================================================================
2 //
3 // $File$
4 //
5 // Owner: lance bushore
6 //
7 // $Author$
8 //
9 // $DateTime$
10 //
11 // $Revision$
12 //
13 // $Change$
14 //
15 // Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
16 //
17 // NOTICE: Adobe permits you to use, modify, and distribute this file in accordance
18 // with the terms of the Adobe license agreement accompanying it. If you have received
19 // this file from a source other than Adobe, then your use, modification, or
20 // distribution of it requires the prior written permission of Adobe.
21 //
22 //========================================================================================
23 
24 #ifndef __ILinkCaptionPrefs
25 #define __ILinkCaptionPrefs
26 
27 #include "IPMUnknown.h"
28 #include "LinksID.h"
29 
32 {
33 public:
35  enum { kDefaultIID = IID_ILINKCAPTIONPREFS };
36 
38  virtual int32 GetNumCaptionLines() const = 0;
39 
41  virtual PMString GetNthBeforeString(int32 index) const = 0;
42 
44  virtual PMString GetNthLinkInfoProviderName(int32 index) const = 0;
45 
47  virtual PMString GetNthAfterString(int32 index) const = 0;
48 
50  virtual void ClearAllCaptionLines() = 0;
51 
53  virtual void AddNewCaptionLine(const PMString& beforeString, const PMString& linkInfoProviderName, const PMString& afterString) = 0;
54 
56  virtual void SetFrameOffset(const PMReal& offset) = 0;
57  virtual PMReal GetFrameOffset() const = 0;
58 
60  virtual void SetCaptionParagraphStyleUID(UID styleUID) = 0;
61  virtual UID GetCaptionParagraphStyleUID() const = 0;
62 
64  virtual void SetGroupCaptionWithImage(bool shouldGroup) = 0;
65  virtual bool GetGroupCaptionWithImage() const = 0;
66 
68  virtual void SetCaptionLayerName(const PMString& layerName) = 0;
69  virtual PMString GetCaptionLayerName() const = 0;
70 
71  enum CaptionAlignment
72  {
73  kAlignAbove,
74  kAlignBelow,
75  kAlignLeft,
76  kAlignRight
77  };
79  virtual void SetCaptionAlignment(CaptionAlignment newAlign) = 0;
80  virtual CaptionAlignment GetCaptionAlignment() const = 0;
81 
83  virtual void CopyFrom(const ILinkCaptionPrefs *src) = 0;
84 
85 
86 };
87 
88 #endif