InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ICJKGridSuite.h
1 //========================================================================================
2 //
3 // $File$
4 //
5 // Owner: Heath Lynn
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 __ICJKGridSuite__
25 #define __ICJKGridSuite__
26 
27 #include "IPMUnknown.h"
28 #include "IFilteredCJKGridCmdData.h"
29 #include "ICJKCharCountOptions.h"
30 #include "ICJKFrameGridDefaults.h"
31 
32 #include "CJKGridID.h"
33 #include "PMRect.h"
34 #include "K2Vector.h"
35 
36 
37 //========================================================================================
38 // Forward declarations
39 //========================================================================================
40 class ICJKGridData;
42 class CJKGridData;
43 
44 //========================================================================================
45 // CLASS ICJKGriSuite
46 //========================================================================================
47 
50 class ICJKGridSuite : public IPMUnknown
51 {
52 
53 public:
54 
55  typedef struct
56  {
57  bool16 applyNumOfLines;
58  int32 numOfLines;
59  bool16 applyCharsPerLine;
60  int32 charsPerLine;
61  bool16 applyNumOfColumns;
62  int32 numOfColumns;
63  bool16 applyColumnGutter;
64  PMReal columnGutter;
65 
66  } ApplyData;
67 
68 
69  enum { kDefaultIID = IID_ICJKGRIDSUITE };
70 
77  virtual void FreezeSelectionForModalDialog() = 0;
78 
83  virtual void ThawSelectionForModalDialog() = 0;
84 
88  virtual bool16 CanApplyCJKGrid( ) const = 0;
89 
94  virtual ErrorCode ApplyCJKGrid( ) = 0;
95 
100  virtual void GetFrameGridView(K2Vector<ICJKFrameGridDefaults::View> & frameGridViewVector, bool16 sortedAndUnique = kFalse ) const = 0;
101 
105  virtual ErrorCode SetFrameGridView( ICJKFrameGridDefaults::View view ) = 0;
106 
110  virtual ICJKCharCountOptions::Location GetCharCountLocation() const = 0;
111 
115  virtual PMReal GetCharacterCountSize() const =0;
116 
121  virtual ErrorCode SetCharacterCountOptions(ICJKCharCountOptions::Location location , const PMReal & size ) = 0;
122 
126  virtual bool16 ShouldEnablePasteWithoutCJKGrid( ) const = 0;
127 
131  virtual UID GetActiveNamedGrid() const = 0;
132 
137  virtual ErrorCode ApplyNamedGrid(UID namedGrid) = 0;
138 
142  virtual bool16 ShouldEnableFrameGrid( ) const = 0;
143 
147  virtual bool16 IsFrameGridDefaults( ) const = 0;
148 
152  virtual void GetFilteredGridData( IFilteredCJKGridCmdData * filteredGridData ) const = 0;
153 
159  virtual void GetLinesAndCharsPerLine(K2Vector<int32> & numberOfLinesVector, K2Vector<int32> & charsPerLineVector, bool16 sortedAndUnique = kFalse ) const = 0;
160 
170  virtual ErrorCode ApplyFrameGrid (IFilteredCJKGridCmdData * filteredGridData,
171  ApplyData applyData,
172  bool16 applyGridView,
173  ICJKFrameGridDefaults::View gridView,
174  ICJKCharCountOptions::Location charCountLocation,
175  const PMReal & charCountSize
176  ) = 0;
177 
184  virtual void GetFrameSizeInfo ( PMString & outString,
185  IFilteredCJKGridCmdData * filteredGridData,
186  ApplyData applyData
187  ) = 0;
188 
189 };
190 
191 #endif