InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ICMSProfileList.h
1 //========================================================================================
2 //
3 // $File$
4 //
5 // Owner: fhaberma
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 __ICMSProfileList__
25 #define __ICMSProfileList__
26 
27 #if PRAGMA_ONCE
28 #endif
29 
30 #include "IPMUnknown.h"
31 #include "ICMSProfile.h"
32 
34 {
35 public:
36 
37  virtual bool16 ShouldEmbedProfiles()=0; //Returns whether should copy entire profile into document
38  virtual void SetShouldEmbedProfiles(bool16 should)=0; //Sets whether should copy entire profile into document
39 
40  virtual int32 AddProfile(ICMSProfile *newProfile, ICMSProfile::profileCategory category = ICMSProfile::kOther) = 0;
41  virtual int32 AddProfile(const UID& newProfile, ICMSProfile::profileCategory category = ICMSProfile::kOther) = 0;
42 
43  virtual bool16 GetNthProfile(int32 n, UID *profile) = 0;
44  virtual bool16 GetNthProfile(int32 n, UIDRef *profile) = 0;
45  virtual PMString GetNthProfileName(int32 n) = 0;
46 
47  virtual int32 FindProfile(ICMSProfile *profile) = 0;
48  virtual int32 FindProfile(const UID& profile) = 0;
49  virtual int32 FindProfile(const PMString &searchName) = 0;
50 
51  // Assign the 'n'th profile to the speficied 'category'.
52  virtual bool16 AssignProfileToCategory(int32 n, ICMSProfile::profileCategory category) = 0;
53 
54  // Clear the 'category'.
55  virtual bool16 ClearCategory(ICMSProfile::profileCategory category) = 0;
56 
57  // Get the index of the profile assigned to the 'category'.
58  virtual int32 GetProfileAssignedToCategory(ICMSProfile::profileCategory category) = 0;
59 
60  virtual int32 Length() = 0;
61 
62  virtual bool16 Remove(int32 n) = 0;
63 
64 #ifdef DEBUG
65  virtual void DumpToDebugWindow() = 0;
66 #endif
67 
68 };
69 
70 #endif // __ICMSProfileList__
71 
72 // End, ICMSProfileList.h.