InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ICreateNoteCmdData.h
1 //========================================================================================
2 //
3 // $File$
4 //
5 // Owner: Wai Cheuk
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 CREATENOTECMDDATA_H
25 #define CREATENOTECMDDATA_H
26 
27 #include "NoteID.h"
28 #include "PMRect.h"
29 #include "WideString.h"
30 #include "PMString.h"
31 #include "IPMUnknown.h"
32 #include "RangeData.h"
33 
34 // ===================================================================================
35 // class ICreateNoteCmdData
36 // ===================================================================================
40 
41 //-----------------------------------
42 // Constants
43 //
44 public:
45  enum {kDefaultIID = IID_ICREATENOTECMDDATA};
46 
47 //-----------------------------------
48 //
49 public:
50 
51 
56  virtual const WideString& GetAuthor() const = 0;
57 
58 
63  virtual bool16 GetCollapse() const = 0;
64 
65 
69  virtual void SetCollapse(const bool16 collapse) = 0;
70 
71 
76  virtual void Set(const WideString& author, bool16 collapsedState) = 0;
77 
78 
83  virtual void GetNoteContentRange(TextIndex& start, TextIndex& end) = 0;
84 
85 
90  virtual void SetNoteContentRange(TextIndex start, TextIndex end) = 0;
91 
97  virtual bool16 GetShouldUseExistingCharacter() const = 0;
98 
104  virtual void SetShouldUseExistingCharacter(const bool16 shouldUse) = 0;
105 };
106 
107 
108 #endif // CREATENOTECMDDATA_H