InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
INewDocCmdData.h
1 //========================================================================================
2 //
3 // $File$
4 //
5 // Owner: psorrick
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 __INewDocCmdData__
25 #define __INewDocCmdData__
26 
27 #include "IPMUnknown.h"
28 #include "PMRect.h"
29 #include "IDocument.h"
30 #include "IColumns.h"
31 #include "IPageSetupPrefs.h"
32 #include "IMasterOverrideable.h"
33 
34 class FormatID;
35 
40 class INewDocCmdData : public IPMUnknown
41 {
42 public:
46  enum { kDefaultIID = IID_INEWDOCCMDDATA };
47 
55  virtual void SetUIFlags(UIFlags uiflags) = 0;
56 
63  virtual UIFlags GetUIFlags() const = 0;
64 
74 #define kFullNewDocument 0x00
75 #define kMinimalNewDocument 0x01
76 #define kXMLInterchangeNewDocument 0x02
77 
89  virtual void SetCreateBasicDocument(uint16 typeFlags) = 0;
90 
101  virtual uint16 GetCreateBasicDocument() const = 0;
102 
113  virtual void SetMargins(const PMReal& insideLeft, /* inside (for facing pages case) or left margin */
114  const PMReal& top, /* top margin */
115  const PMReal& outsideRight, /* outside (for facing pages case) or right margin */
116  const PMReal& bottom /* bottom margin */
117  ) = 0;
118 
129  virtual void GetMargins(PMReal* insideLeft, PMReal* top, PMReal* outsideRight, PMReal* bottom) = 0;
130 
138  virtual void SetUseUniformMargins(bool16 bUniform) = 0;
139 
146  virtual bool16 GetUseUniformMargins() const = 0;
147 
158  virtual void SetColumns_4( int32 numColumns, PMReal gutter, IColumns::ColumnOrientation direction) = 0;
159 
166  virtual int32 GetNumColumns() const = 0;
167 
174  virtual PMReal GetGutter() const = 0;
175 
182  virtual IColumns::ColumnOrientation GetColumnOrientation_4() const = 0;
183 
191  virtual void SetAutoTextFrame( bool16 shown) = 0;
192 
200  virtual bool16 GetAutoTextFrame() const = 0;
201 
209  virtual void SetOverrideAutoTextFrame( bool16 bOverride) = 0;
210 
216  virtual bool16 GetOverrideAutoTextFrame() const = 0;
217 
225  virtual void SetNewDocumentPageSize(const PMPageSize& pageSize) = 0;
226 
233  virtual const PMPageSize& GetNewDocumentPageSize() const = 0;
234 
239  virtual void SetSpreadScale(const K2Pair<PMReal, PMReal>& scale) = 0;
240 
243  virtual PMReal GetSpreadWidthScale() const = 0;
244 
247  virtual PMReal GetSpreadHeightScale() const = 0;
248 
256  virtual void SetWideOrientation( bool16 bWide) = 0;
257 
264  virtual bool16 GetWideOrientation() const = 0;
265 
273  virtual void SetNumPages( int32 numPages) = 0;
274 
281  virtual int32 GetNumPages() const = 0;
282 
290  virtual void SetPagesPerSpread( int32 numPagesPerSpread) = 0;
291 
298  virtual int32 GetPagesPerSpread() const = 0;
299 
307  virtual void SetPageBinding( int32 bindingDirection) = 0;
308 
315  virtual int32 GetPageBinding() const = 0;
316 
324  virtual void SetRestartPageNum( bool16 bRestartPageNum) = 0;
325 
332  virtual bool16 GetRestartPageNum() const = 0;
333 
341  virtual void SetBleedBox(PMRect offsets) = 0;
342 
349  virtual PMRect GetBleedBox() = 0;
350 
358  virtual void SetUseUniformBleed(bool16 bUniform) = 0;
359 
366  virtual bool16 GetUseUniformBleed() const = 0;
367 
368 
376  virtual void SetSlugBox(PMRect offsets) = 0;
377 
384  virtual PMRect GetSlugBox() = 0;
385 
393  virtual void SetUseUniformSlug(bool16 bUniform) = 0;
394 
401  virtual bool16 GetUseUniformSlug() const = 0;
402 
410  virtual void SetStartPageNumber(int32 startPageNumber) = 0;
416  virtual int32 GetStartPageNumber() const = 0;
417 
422  virtual DocumentIntent GetIntent() const = 0;
423 
427  virtual void SetIntent(DocumentIntent intent) = 0;
428 
436  virtual void SetDocBossClassID(ClassID bossID = kDocBoss) = 0;
437 
444  virtual ClassID GetDocBossClassID() const = 0;
445 
451  virtual void SetUndoSupport(IDocument::UndoSupport undoSupport) = 0;
452 
458  virtual IDocument::UndoSupport GetUndoSupport() const = 0;
459 
460 };
461 
462 #endif
463