InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IHyperlinkCmdData.h
1 //========================================================================================
2 //
3 // $File$
4 //
5 // Owner: Brendan O'Shea
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 __IHyperlinkCmdData__
25 #define __IHyperlinkCmdData__
26 
27 #include "IPMUnknown.h"
28 #include "HyperlinkID.h"
29 #include "IHyperlinkAppearanceData.h"
30 
40 {
41 public:
42  enum {kDefaultIID = IID_IHYPERLINKCMDDATA};
43 
44  // General hyperlink characteristics (required):
45 
50  virtual void Set( const UIDRef &hyperLinkDestination,
51  const PMString *name = nil) = 0;
52 
53 
57  virtual void InitializeToDefaultAppearance(IDataBase *db) = 0;
58 
59 
63  virtual void SetHyperlinkName(const PMString *name = nil) = 0;
64 
69  virtual const PMString& GetHyperlinkName() const = 0;
70 
75  virtual bool16 ChangingHyperlinkName() const = 0;
76 
77 
81  virtual void SetHyperlinkDestination(const UIDRef &hyperLinkDestination) = 0;
82 
87  virtual const UIDRef &GetHyperlinkDestination() const = 0;
88 
92  virtual void SetHyperlinkDestinationUniqueKey(int32 uniqueKey) = 0;
97  virtual int32 GetHyperlinkDestinationUniqueKey() const = 0;
98 
103  virtual bool16 ChangingHyperlinkDestination() const = 0;
104 
105  // Hyperlink Appearance characteristics (optional):
106 
110  virtual void SetVisible(const bool16 bIsVisible) = 0;
111 
116  virtual bool16 GetVisible() const = 0;
117 
122  virtual bool16 ChangingVisibleAttribute() const = 0;
123 
124 
128  virtual void SetBorderLineWidth(const int32 strokeWidthInPixels) = 0;
129 
134  virtual int32 GetBorderLineWidth() const = 0;
135 
140  virtual bool16 ChangingBorderLineWidth() const = 0;
141 
142 
146  virtual void SetHyperlinkHilight(IHyperlinkAppearanceData::HyperlinkHilight hilightType) = 0;
147 
152  virtual IHyperlinkAppearanceData::HyperlinkHilight GetHyperlinkHilight() const = 0;
153 
158  virtual bool16 ChangingHyperlinkHilight() const = 0;
159 
160 
164  virtual void SetBorderColorUID(const UID interfaceColorUID) = 0;
165 
170  virtual const UID GetBorderColorUID() const = 0;
171 
176  virtual bool16 ChangingBorderColor() const = 0;
177 
178 
182  virtual void SetHyperlinkOutlineLineStyle(IHyperlinkAppearanceData::HyperlinkOutlineLineStyle style) = 0;
183 
188  virtual IHyperlinkAppearanceData::HyperlinkOutlineLineStyle GetHyperlinkOutlineLineStyle() const = 0;
189 
194  virtual bool16 ChangingHyperlinkOutlineLineStyle() const = 0;
195 
199  virtual void SetFileMissing(bool16 fileMissing) = 0;
203  virtual bool16 GetFileMissing() const = 0;
207  virtual bool16 ChangingFileMissing() const = 0;
208 
212  virtual bool16 IsFromDuplicate() const = 0;
216  virtual void SetFromDuplicate(bool16 fromDup) = 0;
217 
221  virtual bool16 ChangingHyperlinkAltText() const = 0;
222 
226  virtual void SetHyperlinkAltText(const PMString altText) = 0;
227 
232  virtual const PMString GetHyperlinkAltText() = 0;
233 
234 };
235 
236 
237 #endif // __IHyperlinkCmdData__
238