InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
GenericID.h
1 //========================================================================================
2 //
3 // $File: //depot/shuksan/source/public/interfaces/layout/GenericID.h $
4 //
5 // Owner: Robin_Briggs
6 //
7 // $Author: mbiswas $
8 //
9 // $DateTime: 2021/08/11 07:25:49 $
10 //
11 // $Revision: #401 $
12 //
13 // $Change: 1109500 $
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 // Contains IDs used by the generic page item plug-in
24 //
25 //========================================================================================
26 
27 #ifndef __GenericID__
28 #define __GenericID__
29 
30 #include "CrossPlatformTypes.h"
31 #include "IDFactory.h"
32 
33 #define kGenericIDPrefix RezLong(0x2C00)
34 #define kGenericIDPrefix2 RezLong(0x1e200)
35 #define kObjectStylePrefix RezLong(0x1b900)
36 
37 // <Start IDC>
38 // PluginID
39 #define kGenericPluginName "Generic Page Item"
40 
41 
42 // <Class ID>
43 // ClassIDs
44 // gap
45 // gap
46 // gap
47 // gap
48 // gap
49 // gap
50 // ---- Moved from Clipping Path Dialog plug-in
51 // ---- end move.
52 //gap
53 //gap
54 
55 //export options attributes
56 
57 
58 // <Interface ID>
59 // IIDs
60 
61 //
62 // All these IID_IHIERARCHY_* interfaces are really messages that are part
63 // of the IM2MMessageManager scheme. They are used to communicate well known
64 // changes to a Target to Hierarchy Ancestors/Descendents.
65 // See HierarchyListener for how this is done.
66 //
67 // Child adding to/removing from Hierarchy. NOT forwarded.
68 
69 // Root of the Hierarchy changing. Forwarded to all descendents
70 
71 // Spread of the Hierarchy changing (for non Root changes). Used for transitory
72 // Hierarchy members such as Inlines. Forwarded to all descendents.
73 
74 // Layer of the Hierarchy changing. Sent to the Hierarchy moving and forwarded
75 // to all descendents.
76 
77 // Effective ZOrder of the Hierarchy changing. Sent to the Hierarch(ies) moving
78 // and forwarded to all descendents.
79 
80 // IID_ITRANSFORM on a Hierarchy ancestor or child changing. Forwarded to the
81 // parent and all descendents.
82 
83 // IID_IGEOMETRY on a Hierarchy child changing. Forwarded to the parent.
84 
85 // IID_IPATHGEOMETRY on a Hierarchy ancestor changing. Forwarded to all
86 // descendents BUT not typically forwarded to sub-Hierarchies such as TOP.
87 
88 // Synthetic message - some property of an ancestor has changed which *may*
89 // mean that our effective visibility has changed. Forwarded to all descendents.
90 
91 // Synthetic message - an Inline ancestor is part of a WaxRun rebuild and has
92 // discovered that it's position will change from where it was when first
93 // applied. This can occur due to re-justification on the part of the Composer
94 // due to things such as, for example, font changes or page number changes.
95 //
96 // This message always preceeds a IID_IHIERARCHY_TRANSFORM which represents
97 // the actual change to the effective transform. As such thus this synthetic
98 // message provides a qualifier to the later IID_IHIERARCHY_TRANSFORM message.
99 //
100 // The policy around rebuilt is that all the normal transform reactive behavior
101 // needs to take place - such as invalidating PB caches - but that nothing
102 // should be done that would trigger damage or re-composition.
103 //
104 // So, for example, StandOffs and MultiColumnTextFrames should react to the
105 // movement relative to the Spread by damaging content.
106 
107 // Synthetic message to the spline listener that tells it the user (or a script)
108 // is doing a content fit.
109 
110 // Synthetic message - sent from SpreadLayer bosses to kPageBoss IHierarchy
111 // children when their index within the Hierarchy list is about to change.
112 // So if you insert a new child at index 0 then all the other children will see
113 // this message. NOT forwarded.
114 //
115 // This is to support Pages determining that their index within their parent
116 // has changed since that influences how their effective Master.
117 
118 //
119 // Synthetic message - called from the DataBase::DeleteUID() method before
120 // the UID is actually deleted - note that there will never be subsequent call
121 // to M2MMessageListener::Validate() because the UID will be deleted.
122 //
123 // 01/05/12 dwaterfa: This is hooked into the DataBase at a very low level and
124 // that creates problems for AutoUndo. As a result AutoUndo we will SUPPRESS
125 // this notification when it directly deletes UIDs as part of Undo OR Redo.
126 // The upshot of this is that for most Listeners you will only be called on the
127 // Do() of a DeleteUID operation and never for Undo() or Redo() of that
128 // operation. Note that during Undo/Redo operations inval handlers can be called
129 // and THEY might DeleteUIDs and for those you WILL be called - it is only those
130 // UIDs which the AutoUndo mechanism remembers directly does this apply too.
131 //
132 // Object export options command notifications
133 
134 // end of Object export options command notifications
135 
136 // Effective ZOrder of the Hierarchy changing. Not forwarded.
137 
138 // Synthetic message - the content dropper is about to resize a PageItem during
139 // the drop action. This message is sent against the PageItem being resized.
140 
141 // The above message forwarded to descendents of the initial target of the drop
142 
143 
144 // -- GAP ---
145 
146 // gap
147 
148 
149 // <Implementation ID>
150 // ImplementationIIDs
151 // gap
152 //gap
153 // gap
154 // gap
155 // gap
156 // gap
157 // gap
158 // gap
159 //gap
160 //gap
161 // gap
162 // gap
163 //gap
164 
165 //gap
166 
167 //gap
168 // kStringDataImpl aliases
169 
170 
171 
172 
173 //gap
174 // <Service ID>
175 // Service Providers
176 
177 
178 // <Error ID>
179 // Error Codes
180 //gap
181 //gap
182 
183 // <Message ID>
184 // Message IDs (start at 200)
185 
186 // <Global ID>
187 // Global IDs
188 
189 
190 
191 
192 
193 
194 
195 
196 
197 //
198 //Script Element IDs
199 //
200 
201 //Suites
202 
203 //Objects
204 
205 //Events
206 
207 //Methods
208 
209 //Properties
210 
211 //Methods
212 
213 //Enums
214 
215 //gap
216 
217 
218 //gap
219 
220 
221 //Adding Scripting Support for Height/Width
222 
223 
224 //gap
225 
226 
227 
228 //---------------------------------------------------
229 // InvalHandlerTypeID
230 //---------------------------------------------------
231 
232 
234 // Object Styles //
236 
237 // ClassIDs
238 
239 // Attribute Categories
240 
241 
242 //for style groups
243 
244 
245 // InterfaceIDs
246 //gap
247 
248 // ImplementationIDs
249 
250 // Services
251 
252 //
253 //Script Element IDs
254 //
255 
256 //Suites
257 
258 //Objects
259 
260 //Methods
261 
262 //Properties
263 
264 // Enums
265 
266 //Style Groups
267 
268 //new XP categories
269 
270 // New Text frame auto size option
271 
272 //New Custom Layout Type options
273 
274 
275 
276 
277 //GUIDS
278 // {D7D2C130-D321-11d1-AAA2-00C04FA349C7}
279 #define kPageItem_CLSID { 0xd7d2c130, 0xd321, 0x11d1, { 0xaa, 0xa2, 0x0, 0xc0, 0x4f, 0xa3, 0x49, 0xc7 } }
280 // {D7D2C131-D321-11d1-AAA2-00C04FA349C7}
281 #define kPageItems_CLSID { 0xd7d2c131, 0xd321, 0x11d1, { 0xaa, 0xa2, 0x0, 0xc0, 0x4f, 0xa3, 0x49, 0xc7 } }
282 // {7761758B-D3DE-11d1-AAA6-00C04FA349C7}
283 #define kGroup_CLSID { 0x7761758b, 0xd3de, 0x11d1, { 0xaa, 0xa6, 0x0, 0xc0, 0x4f, 0xa3, 0x49, 0xc7 } }
284 // {EE964062-06C6-11d2-AAC9-00C04FA349C7}
285 #define kGroups_CLSID { 0xee964062, 0x6c6, 0x11d2, { 0xaa, 0xc9, 0x0, 0xc0, 0x4f, 0xa3, 0x49, 0xc7 } }
286 // {6AE52037-9E4E-442d-ADFC-2D492B4BCBEF}
287 #define kGraphic_CLSID { 0x6ae52037, 0x9e4e, 0x442d, { 0xad, 0xfc, 0x2d, 0x49, 0x2b, 0x4b, 0xcb, 0xef } }
288 // {C85A4AB3-9492-4c40-8A7B-F8305706C8B8}
289 #define kGraphics_CLSID { 0xc85a4ab3, 0x9492, 0x4c40, { 0x8a, 0x7b, 0xf8, 0x30, 0x57, 0x6, 0xc8, 0xb8 } }
290 // {77617582-D3DE-11d1-AAA6-00C04FA349C7}
291 #define kImage_CLSID { 0x77617582, 0xd3de, 0x11d1, { 0xaa, 0xa6, 0x0, 0xc0, 0x4f, 0xa3, 0x49, 0xc7 } }
292 // {77617583-D3DE-11d1-AAA6-00C04FA349C7}
293 #define kImages_CLSID { 0x77617583, 0xd3de, 0x11d1, { 0xaa, 0xa6, 0x0, 0xc0, 0x4f, 0xa3, 0x49, 0xc7 } }
294 // {77617584-D3DE-11d1-AAA6-00C04FA349C7}
295 #define kEPS_CLSID { 0x77617584, 0xd3de, 0x11d1, { 0xaa, 0xa6, 0x0, 0xc0, 0x4f, 0xa3, 0x49, 0xc7 } }
296 // {77617585-D3DE-11d1-AAA6-00C04FA349C7}
297 #define kEPSs_CLSID { 0x77617585, 0xd3de, 0x11d1, { 0xaa, 0xa6, 0x0, 0xc0, 0x4f, 0xa3, 0x49, 0xc7 } }
298 // {A2B63906-121F-4ae5-ABB4-8A13B4C18B3C}
299 #define kWMF_CLSID { 0xa2b63906, 0x121f, 0x4ae5, { 0xab, 0xb4, 0x8a, 0x13, 0xb4, 0xc1, 0x8b, 0x3c } }
300 // {37AC274D-488D-489e-8E69-94A2168971F7}
301 #define kWMFs_CLSID { 0x37ac274d, 0x488d, 0x489e, { 0x8e, 0x69, 0x94, 0xa2, 0x16, 0x89, 0x71, 0xf7 } }
302 // {62E3E8FA-B2EC-41f1-90F2-C5AF3AFBC750}
303 #define kPICT_CLSID { 0x62e3e8fa, 0xb2ec, 0x41f1, { 0x90, 0xf2, 0xc5, 0xaf, 0x3a, 0xfb, 0xc7, 0x50 } }
304 // {7D72B638-C127-42a5-B60F-F3CA6EFF9E5F}
305 #define kPICTs_CLSID { 0x7d72b638, 0xc127, 0x42a5, { 0xb6, 0xf, 0xf3, 0xca, 0x6e, 0xff, 0x9e, 0x5f } }
306 // {77617586-D3DE-11d1-AAA6-00C04FA349C7}
307 #define kPDF_CLSID { 0x77617586, 0xd3de, 0x11d1, { 0xaa, 0xa6, 0x0, 0xc0, 0x4f, 0xa3, 0x49, 0xc7 } }
308 // {77617587-D3DE-11d1-AAA6-00C04FA349C7}
309 #define kPDFs_CLSID { 0x77617587, 0xd3de, 0x11d1, { 0xaa, 0xa6, 0x0, 0xc0, 0x4f, 0xa3, 0x49, 0xc7 } }
310 // {8014E427-849B-4476-BBEC-C14E3B546F80}
311 #define kObjectStyle_CLSID { 0x8014e427, 0x849b, 0x4476, { 0xbb, 0xec, 0xc1, 0x4e, 0x3b, 0x54, 0x6f, 0x80 } }
312 // {825602C7-96FB-41f4-8B5D-F51FCDC92413}
313 #define kObjectStyles_CLSID { 0x825602c7, 0x96fb, 0x41f4, { 0x8b, 0x5d, 0xf5, 0x1f, 0xcd, 0xc9, 0x24, 0x13} }
314 // {21EC2086-4911-4879-B8DE-A7049C96C769}
315 #define kFrameFittingOptions_CLSID { 0x21ec2086, 0x4911, 0x4879, { 0xb8, 0xde, 0xa7, 0x4, 0x9c, 0x96, 0xc7, 0x69 } }
316 // {84A2FCDA-3906-473f-A9B5-2ECAD5AE68B8}
317 #define kPageItemDefault_CLSID { 0x84a2fcda, 0x3906, 0x473f, { 0xa9, 0xb5, 0x2e, 0xca, 0xd5, 0xae, 0x68, 0xb8 } }
318 // {D68B4EC1-1E8D-443b-8B52-0CDB037F8483}
319 #define kObjectStyleGroup_CLSID { 0xd68b4ec1, 0x1e8d, 0x443b, { 0x8b, 0x52, 0xc, 0xdb, 0x3, 0x7f, 0x84, 0x83 } }
320 // {53D49BD2-D485-4f57-9259-08609E389AAE}
321 #define kObjectStyleGroups_CLSID { 0x53d49bd2, 0xd485, 0x4f57, { 0x92, 0x59, 0x8, 0x60, 0x9e, 0x38, 0x9a, 0xae } }
322 // {A7F95DBB-18A4-44a3-9E0D-2E684B3D6A0C}
323 #define kTransformMatrix_CLSID { 0xa7f95dbb, 0x18a4, 0x44a3, { 0x9e, 0xd, 0x2e, 0x68, 0x4b, 0x3d, 0x6a, 0xc } }
324 // {5E39F04A-7FF9-45c9-AD13-65DBE13A460E}
325 #define kTransformValue_CLSID { 0x5e39f04a, 0x7ff9, 0x45c9, { 0xad, 0x13, 0x65, 0xdb, 0xe1, 0x3a, 0x46, 0xe } }
326 // {1684D190-8EB4-40d1-AD5D-FA4AA209ACA9}
327 #define kResizeValue_CLSID { 0x1684d190, 0x8eb4, 0x40d1, { 0xad, 0x5d, 0xfa, 0x4a, 0xa2, 0x9, 0xac, 0xa9 } }
328 // {E8901C74-4DAB-41b7-8622-29DED5A7EDF0}
329 #define kTransformMatrices_CLSID { 0xe8901c74, 0x4dab, 0x41b7, { 0x86, 0x22, 0x29, 0xde, 0xd5, 0xa7, 0xed, 0xf0 } }
330 // {4F016B6D-E5C0-49e3-9BCE-878E56711671}
331 #define kAlignDistPref_CLSID { 0x4f016b6d, 0xe5c0, 0x49e3, { 0x9b, 0xce, 0x87, 0x8e, 0x56, 0x71, 0x16, 0x71 } }
332 // {A39D6F3B-52C7-4459-A29C-8EAAD7D8ED0A}
333 #define kObjStyleXPPageItemSettingsCategory_CLSID { 0xa39d6f3b, 0x52c7, 0x4459, { 0xa2, 0x9c, 0x8e, 0xaa, 0xd7, 0xd8, 0xed, 0xa } }
334 // {DF03D94D-9CC2-4248-8503-EE8AACCAA3C8}
335 #define kObjStyleXPStrokeSettingsCategory_CLSID { 0xdf03d94d, 0x9cc2, 0x4248, { 0x85, 0x3, 0xee, 0x8a, 0xac, 0xca, 0xa3, 0xc8 } }
336 // {CABD713E-5D70-4a32-B94A-EAD956BC758B}
337 #define kObjStyleXPFillSettingsCategory_CLSID { 0xcabd713e, 0x5d70, 0x4a32, { 0xb9, 0x4a, 0xea, 0xd9, 0x56, 0xbc, 0x75, 0x8b } }
338 // {26037992-69DF-42e2-A7B2-E28AB15A81D9}
339 #define kObjStyleXPContentSettingsCategory_CLSID { 0x26037992, 0x69df, 0x42e2, { 0xa7, 0xb2, 0xe2, 0x8a, 0xb1, 0x5a, 0x81, 0xd9 } }
340 // {FF9A3CFD-C8A6-4dee-9802-D87C716756F8}
341 #define kRootObjectStyleGroup_CLSID { 0xff9a3cfd, 0xc8a6, 0x4dee, { 0x98, 0x2, 0xd8, 0x7c, 0x71, 0x67, 0x56, 0xf8 } }
342 // {76BA337C-A2B9-4daa-935D-4E7B1C3E329C}
343 #define kObjectExportOptions_CLSID { 0x76ba337c, 0xa2b9, 0x4daa, { 0x93, 0x5d, 0x4e, 0x7b, 0x1c, 0x3e, 0x32, 0x9c } }
344 // {B41C6E16-E7B6-4D68-BAC1-38292E7AF712}
345 #define kObjectStyleExportTagMap_CLSID { 0xb41c6e16, 0xe7b6, 0x4d68, { 0xba, 0xc1, 0x38, 0x29, 0x2e, 0x7a, 0xf7, 0x12 } }
346 // {BB98DEF5-A07E-4E96-B545-7FEFFB29640F}
347 #define kObjectStyleExportTagMaps_CLSID { 0xbb98def5, 0xa07e, 0x4e96, { 0xb5, 0x45, 0x7f, 0xef, 0xfb, 0x29, 0x64, 0xf } }
348 // {DF7AB3F9-1449-4B73-B813-5742028C69DB}
349 #define kObjectStyleLayoutAttrOptions_CLSID { 0xdf7ab3f9, 0x1449, 0x4b73 {0xb8, 0x13, 0x57, 0x42, 0x2, 0x8c, 0x69, 0xdb } }
350 
351 
352 enum GenericScriptIDs
353 {
354  c_PageItem = 'pitm',
355  c_PageItems = 'pits',
356  c_Graphic = 'Grfc',
357  c_Graphics = 'Grfs',
358  c_Image = 'imag',
359  c_Images = 'imgs',
360  c_WMF = 'WMF ',
361  c_WMFs = 'WMFs',
362  c_PICT = 'PICT',
363  c_PICTs = 'PICs',
364  c_ObjectExportOptions = 'ObEx',
365 
366  e_BeforeNodeRemoved = 'bfNR',
367  e_AfterNodeInserted = 'afNI',
368  e_BeforeNodeRemovedFromDocument = 'bNRD',
369  e_AfterNodeInsertedIntoDocument = 'aNID',
370  e_BeforeGeometryChanged = 'bfGC',
371  e_AfterGeometryChanged = 'afGC',
372  e_BeforeTransformChanged = 'bfTC',
373  e_AfterTransformChanged = 'afTC',
374  e_AfterLabelChanged = 'afLC',
375  e_AfterTextWrapChanged = 'afTW',
376  e_AlternateText = 'alTx',
377  e_ActualText = 'acTx',
378 
379  p_ParentPage = 'PaPa',
380  p_ObjectExportOptionsProperty = 'oExP',
381  p_AltTextSourceType = 'alSP',
382  p_ActualTextSourceType = 'acSP',
383  p_CustomAltText = 'alCt',
384  p_CustomActualText = 'acCt',
385  p_AltMetadataProperty = 'alMp',
386  p_ActualMetadataProperty = 'acMp',
387  p_CustomImageConversion = 'CIcv',
388  p_UseOriginalImage = 'Uoim',
389  p_ApplyTagType = 'Aptt',
390  p_ImageConversionType = 'ICvt',
391  p_ImageSizeOption = 'pISz',
392  p_ImageResolution = 'ImRs',
393  p_CustomImageAlignment = 'CIma',
394  p_CustomLayout = 'CuLy',
395  p_CustomLayoutType = 'CLaT',
396  p_CustomWidthType = 'CWiT',
397  p_CustomHeightType = 'CHeT',
398  p_CustomSizeType = 'CSsT',
399  p_EditBoxCustomSize = 'EbCu',
400  p_ImageAlignment = 'ImAl',
401  p_ImageSpaceBefore = 'ImSB',
402  p_EditBoxCustomWidth = 'OcWi',
403  //p_EditBoxCustomWidthUnit = 'ObCu',
404  p_EditBoxCustomHeight = 'OcHe',
405  //p_EditBoxCustomHeightUnit = 'ObCh',
406  p_ImageSpaceAfter = 'ImSA',
407  p_SpaceUnit = 'SpUn',
408  p_UseImagePageBreak = 'Uipb',
409  p_ImagePageBreak = 'ImPk',
410  p_EpubType = 'EpTy',
411  p_UseExistingImage = 'Ueim',
412  p_PreserveObjectLayoutAppearance = 'PoLa',
413 
414  en_SourceType = 'sTyp',
415  en_SourceCustom = 'sTCm',
416  en_SourceXMPAltText = 'sTXa',
417  en_SourceXMPExtendedDescription = 'sTXe',
418  en_SourceXMPTitle = 'sTXt',
419  en_SourceXMPDescription = 'sTXd',
420  en_SourceXMPHeadline = 'sTXh',
421  en_SourceXMPOther = 'sTXo',
422  en_SourceXMLStructure = 'sTXs',
423  en_TagType = 'tgTp',
424  en_TagFromStructure = 'tgSe',
425  en_TagArtifact = 'tgAf',
426  en_TagBasedOnObject = 'tgBo',
427  en_ImageConversionType = 'iCvt',
428  en_ImageSizeOption = 'ImSz',
429  en_RelativeToPageWidth = 'RvPw',
430  en_RelativeSizeToTextFlow = 'RsTT',
431  en_RelativeToTextFlow = 'RvTf',
432  en_RelativeToTextSize = 'RvTs',
433  en_ImageSizeResolution = 'Imrs',
434  en_72 = 'rsSt',
435  en_96 = 'rsNs',
436  en_150 = 'rs0f',
437  en_300 = 'rsTh',
438  en_ObjectImageAlignment = 'ImAn',
439  en_AlignLeft = 'AlLf',
440  en_AlignCenter = 'AlCr',
441  en_AlignRight = 'AlRt',
442  en_CSSUnit = 'CsUn',
443  en_CSSEm = 'SpEm',
444  en_CSSPixel = 'SpPx',
445  en_ImagePageBreak = 'ImPb',
446  en_CustomLayoutType = 'CuLT',
447 
448  en_CustomWidthType = 'CuWT',
449  en_CustomHeightType = 'CuHT',
450  en_CustomSizeType = 'CuSi',
451  en_BreakBefore = 'Brbf',
452  en_BreakAfter = 'Braf',
453  en_BreakBeforeAndAfter = 'Brba',
454  en_NoneSize = 'NonS',
455  en_DefaultSize = 'DeSi',
456  en_RelativeSize = 'RelS',
457  en_FixedOptionSize = 'FixS',
458  en_FixedSize = 'Fxdz',
459  en_NoneWidth = 'NWid',
460  en_DefaultWidth = 'DWid',
461  en_RelativeWidth = 'RelW',
462  en_FixedWidth = 'FixW',
463  en_CustomWidth = 'CVWi',
464  en_NoneHeight = 'NHei',
465  en_DefaultHeight = 'DefH',
466  en_FixedHeight = 'FHei',
467  en_CustomHeight = 'CuVH',
468  en_UseCustomWidth = 'UCWi',
469  en_UseCustomHeight = 'UCHe',
470  en_AlignmentAndSpacing = 'AlSp',
471  en_FloatLeft = 'FlLe',
472  en_FloatRight = 'FlRi',
473 
474  en_PreserveObjectLayoutAppearance = 'PrAp',
475  en_DefaultAppearance = 'PrDe',
476  en_UseExisting = 'PrUe',
477  en_RasterizeContainer = 'PrRr',
478  en_RasterizeContent = 'PrRt',
479  e_ConvertToRawText = 'CtRt',
480  en_SourceDecorativeImage = 'bDci',
481 } ;
482 
483 // User Action Categories
484 
485 
486 // Default styles names
487 #define kNoObjectStyleName "[None]"
488 #define kDefaultObjectStyleForAGraphicFrameName "[Normal Graphics Frame]"
489 #define kDefaultObjectStyleForATextFrameName "[Normal Text Frame]"
490 #define kDefaultObjectStyleForAFrameGridName "[Normal Grid]"
491 
492 #endif // __GenericID__
493