Mako 8.2.0 API
MakoCore SDK API Documentation
Loading...
Searching...
No Matches
idompage.h
Go to the documentation of this file.
1/*
2* Copyright (C) 2007-2025 Global Graphics Software Ltd. All rights reserved.
3*/
4
5#ifndef IDOMPAGE_H
6#define IDOMPAGE_H
7
8#include <edl/edltypes.h>
9#include <edl/edlfwd.h>
10#include <edl/edlgeom.h>
11#include <edl/idomid.h>
12#include <edl/idomnode.h>
13#include <edl/idomjobtk.h>
14#include <edl/edlfwd.h>
15#include <edl/idomresources.h>
17#include <edl/idomgroup.h>
18
20
21
22class IDOMFixedPage;
24
39{
40#define IDOMFixedPageClassID 0xE3258A9B, 0x97194760, 0x854C790B, 0x48B724CF
41public:
50 static EDL_API IDOMFixedPagePtr create(IEDLClassFactory *pFactory, double width = 793.7, double height = 1122.5);
51
56 class Data : public CClassParams
57 {
58 public:
59 Data() : width(0.0), height(0.0), degenerated(false) {}
60 double width;
61 double height;
68 IDOMResourceDictionaryPtr ptrResources;
69 IDOMJobTkPtr ptrJobTicket;
70 IDOMImagePtr ptrThumbnail;
71 IDOMTransparencyGroupPtr ptrPageGroup;
72 };
73
78 static const CClassID &classID()
79 {
81 return id;
82 }
83
95 virtual void setWidth(double width) = 0;
96
101 virtual double getWidth() const = 0;
102
114 virtual void setHeight(double height) = 0;
115
120 virtual double getHeight() const = 0;
121
130 virtual const FRect &getContentBox () const = 0;
131
142 virtual void setContentBox (const FRect &bb) = 0;
143
152 virtual const FRect &getBleedBox () const = 0;
153
162 virtual void setBleedBox (const FRect &bb) = 0;
163
168 virtual const FRect &getCropBox () const = 0;
169
174 virtual void setCropBox (const FRect &cropBox) = 0;
175
183 virtual const FRect &getTrimBox () const = 0;
184
192 virtual void setTrimBox (const FRect &trimBox) = 0;
193
204 virtual EDLString getLanguage () const = 0;
205
213 virtual IDOMTransparencyGroupPtr getPageGroup() const = 0;
214
220 virtual void setPageGroup(const IDOMTransparencyGroupPtr &pageGroup) = 0;
221
232 virtual void setLanguage (const EDLString &lang) = 0;
233
239 virtual IDOMResourceDictionaryPtr getResourceDictionary() const = 0;
240
246 virtual void setResourceDictionary(const IDOMResourceDictionaryPtr &ptrResources) = 0;
247
252 virtual IDOMImagePtr getThumbnail() const = 0;
253
259 virtual void setThumbnail(const IDOMImagePtr &ptrThumbnail) = 0;
260
261};
262#define edlobj2IDOMFixedPage(src) edl_cast((IDOMFixedPage *)NULL, src)
263#define dom2IDOMFixedPage(src) dom2NodeType<IDOMFixedPage, eDOMFixedPageNode>(src)
264
266
267#endif /* IDOMPAGE_H */
268
An object to represent a 128-bit globally unique ID.
Definition objclassid.h:29
EDL Object Interface.
Definition iedlobject.h:31
bool degenerated
Definition idompage.h:67
IDOMTransparencyGroupPtr ptrPageGroup
Definition idompage.h:71
Data()
Definition idompage.h:59
EDLString language
Definition idompage.h:66
FRect cropBox
Definition idompage.h:64
FRect trimBox
Definition idompage.h:65
double width
Definition idompage.h:60
IDOMResourceDictionaryPtr ptrResources
Definition idompage.h:68
FRect bleedBox
Definition idompage.h:62
double height
Definition idompage.h:61
IDOMJobTkPtr ptrJobTicket
Definition idompage.h:69
FRect contentBox
Definition idompage.h:63
IDOMImagePtr ptrThumbnail
Definition idompage.h:70
Represents <FixedPage> element.
Definition idompage.h:39
virtual void setPageGroup(const IDOMTransparencyGroupPtr &pageGroup)=0
Set the page transparency group.
virtual void setLanguage(const EDLString &lang)=0
Sets the language of the fixed page and any of its children.
virtual const FRect & getContentBox() const =0
Retrieves the fixed page's content box. The content bos is the area of the page containing imageable ...
virtual void setHeight(double height)=0
Sets the fixed page height.
virtual IDOMResourceDictionaryPtr getResourceDictionary() const =0
Retrieves a smart pointer to the resource dictionary. The resource dictionary contains the IDs of res...
virtual void setWidth(double width)=0
Sets the fixed page width.
virtual void setContentBox(const FRect &bb)=0
Sets the content box for the fixed page. The content bos is the area of the page containing imageable...
virtual void setTrimBox(const FRect &trimBox)=0
Sets the fixed page's trim box. The trim box defines the intended dimensions of the finished page aft...
virtual double getWidth() const =0
Retrieves the fixed page width.
virtual IDOMTransparencyGroupPtr getPageGroup() const =0
Retrieves the page transparency group, if present. Generally this is used to dictate the color space ...
static const CClassID & classID()
Retrieves the class id of IDOMFixedPage.
Definition idompage.h:78
virtual IDOMImagePtr getThumbnail() const =0
Retrieves a smart pointer to the fixed document thumbnail image.
virtual EDLString getLanguage() const =0
Retrieves default language of the fixed page and any of its children.
virtual void setThumbnail(const IDOMImagePtr &ptrThumbnail)=0
Sets a new thumbnail image for the document sequence. The image must be in either JPEG or PNG format....
static EDL_API IDOMFixedPagePtr create(IEDLClassFactory *pFactory, double width=793.7, double height=1122.5)
Simplified creation function for IDOMFixedPage Throws an IEDLError exception on failure.
virtual const FRect & getCropBox() const =0
Retrieves the fixed page's crop box - the region to which the contents of the page are to be clipped ...
virtual void setCropBox(const FRect &cropBox)=0
Sets the fixed page's crop box.
virtual const FRect & getBleedBox() const =0
Retrieves the fixed page's bleed box. The bleed box is the area, inclusive of crop marks,...
virtual double getHeight() const =0
Retrieves the fixed page height.
virtual void setBleedBox(const FRect &bb)=0
Sets the fixed page's bleed box. The bleed box is the area, inclusive of crop marks,...
virtual const FRect & getTrimBox() const =0
Retrieves the fixed page's trim box. The trim box defines the intended dimensions of the finished pag...
virtual void setResourceDictionary(const IDOMResourceDictionaryPtr &ptrResources)=0
Sets the resource dictionary.
Interface to the IDOMJobTkOwner node.
Definition idomjobtk.h:65
EDL Factory Interface allows one part of the EDL infrastructure to register class creation methods id...
Definition iedlfactory.h:31
RectTmpl< double > FRect
Definition edlgeom.h:338
#define _END_EDL_DOM_NAMESPACE
Definition edlnamespaces.h:110
#define _BEGIN_EDL_DOM_NAMESPACE
Definition edlnamespaces.h:109
std::wstring EDLString
Definition edlstring.h:165
EDL "standard" types including known bit-length signed and unsigned integer type[def]s and definition...
#define EDL_API
Definition edltypes.h:86
#define IDOMFixedPageClassID
Definition idompage.h:40
IDOMResources interface.
#define DECL_SMART_PTR(cls)
Definition smartptr.h:211