Foxit PDF SDK

fs_outputpreview.h
Go to the documentation of this file.
1
15 #ifndef FS_OUTPUTPREVIEW_H_
16 #define FS_OUTPUTPREVIEW_H_
17
18 #include "common/fs_common.h"
19 #include "pdf/fs_pdfdoc.h"
20 #include "common/fs_render.h"
21
27 namespace foxit {
31 namespace pdf {
38 class OutputPreview FS_FINAL : public Base{
39 public:
45 typedef enum _ShowType {
47 e_ShowAll = 0,
49 e_ShowDeviceCMYK = 1,
51 e_ShowNotDeviceCMYK = 2,
53 e_ShowICCBasedCMYK = 3,
55 e_ShowSpotColor = 4,
57 e_ShowDeviceCMYKAndSpot = 5,
59 e_ShowNotDeviceCMYKOrSpot = 6,
61 e_ShowDeviceN = 7,
63 e_ShowCMYK = 8,
65 e_ShowRGB = 9,
67 e_ShowDeviceRGB = 10,
69 e_ShowICCBasedRGB = 11,
71 e_ShowGray = 12,
73 e_ShowDeviceGray = 13,
75 e_ShowCalGray = 14,
77 e_ShowCalibrated = 15,
79 e_ShowLab = 16,
81 e_ShowDevice = 17,
83 e_ShowImages = 18,
85 e_ShowSolidColor = 19,
87 e_ShowSmoothShades = 20,
89 e_ShowRegistrationColor = 21,
91 e_ShowText = 22,
93 e_ShowLineArt = 23
94 } ShowType;
95
101 typedef enum _ColorantType {
103 e_ColorantTypeProcess = 0,
105 e_ColorantTypeSpot = 1
106 } ColorantType;
107
108
114 OutputPreview(const PDFDoc& pdf_doc);
120 OutputPreview(const OutputPreview& other);
128 OutputPreview& operator = (const OutputPreview& other);
129
137 bool operator == (const OutputPreview& other) const;
145 bool operator != (const OutputPreview& other) const;
146
154 bool IsEmpty() const;
155
157 ~OutputPreview();
158
169 void SetSimulationProfile(const WString& icc_profile_path);
170
181 void SetShowType(ShowType show_type);
182
193 StringArray GetPlates(ColorantType colorant_type);
194
204 RGB GetSpotPlateColor(const char* plate_name);
205
214 void SetCheckStatus(const String& plate_name, bool to_check);
215
225 bool IsChecked(const String& plate_name) const;
226
237 void EnableSimulateOverprint(bool is_to_simulate_overprint);
238
252 common::Bitmap GeneratePreviewBitmap(const PDFPage& page, const Matrix& matrix, const common::Renderer& renderer);
253
254 // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
255 explicit OutputPreview(FS_HANDLE handle = NULL);
256
257 };
258 } // namespace pdf
259 } // namespace foxit
260 #endif // FS_OUTPUTPREVIEW_H_
261
foxit::pdf::OutputPreview::e_ColorantTypeProcess
Colorant type: process.
Definition: fs_outputpreview.h:103
foxit::pdf::OutputPreview::e_ShowCalibrated
If set, only show with Calibrated.
Definition: fs_outputpreview.h:77
foxit::common::Bitmap
Definition: fs_image.h:36
foxit::pdf::OutputPreview::GeneratePreviewBitmap
common::Bitmap GeneratePreviewBitmap(const PDFPage &page, const Matrix &matrix, const common::Renderer &renderer)
Generate the output preview bitmap for a PDF page.
foxit::pdf::OutputPreview::operator !=
bool operator !=(const OutputPreview &other) const
Not equal operator.
foxit::pdf::OutputPreview::SetShowType
void SetShowType(ShowType show_type)
Set show type.
foxit::pdf::OutputPreview
Definition: fs_outputpreview.h:38
foxit::pdf::OutputPreview::e_ShowCalGray
If set, only show with CalGray.
Definition: fs_outputpreview.h:75
fs_pdfdoc.h
Header file for PDF document related definitions and classes.
foxit::pdf::OutputPreview::e_ShowDeviceCMYK
If set, only show with DeviceCMYK.
Definition: fs_outputpreview.h:49
foxit::pdf::OutputPreview::e_ShowDeviceRGB
If set, only show with DeviceRGB.
Definition: fs_outputpreview.h:67
foxit::RGB
uint32 RGB
RGB color type, 24 bits, ((b) | ((g) << 8) | ((r) << 16)))
Definition: fs_basictypes.h:211
foxit::pdf::OutputPreview::IsEmpty
bool IsEmpty() const
Check whether current object is empty or not.
foxit::pdf::OutputPreview::SetCheckStatus
void SetCheckStatus(const String &plate_name, bool to_check)
Set the check status for a plate.
foxit::pdf::OutputPreview::e_ShowDeviceN
If set, only show with DeviceN.
Definition: fs_outputpreview.h:61
foxit::pdf::OutputPreview::e_ShowAll
If set, show all.
Definition: fs_outputpreview.h:47
CFX_WideString
WIDE STRING CLASS.
Definition: fx_string.h:1461
foxit::pdf::OutputPreview::operator==
bool operator==(const OutputPreview &other) const
Equal operator.
foxit::pdf::OutputPreview::~OutputPreview
~OutputPreview()
Destructor.
foxit::pdf::PDFDoc
Definition: fs_pdfdoc.h:776
foxit::pdf::OutputPreview::EnableSimulateOverprint
void EnableSimulateOverprint(bool is_to_simulate_overprint)
Set the flag to decide whether to enable simulate overprint.
foxit::pdf::OutputPreview::e_ShowRegistrationColor
If set, only show registration color.
Definition: fs_outputpreview.h:89
foxit::pdf::OutputPreview::operator=
OutputPreview & operator=(const OutputPreview &other)
Assign operator.
foxit::pdf::OutputPreview::ShowType
ShowType
Enumeration for show type.
Definition: fs_outputpreview.h:45
foxit::pdf::OutputPreview::e_ShowDevice
If set, only show with Device.
Definition: fs_outputpreview.h:81
foxit::common::Renderer
Definition: fs_render.h:197
foxit::pdf::OutputPreview::e_ShowText
If set, only show text.
Definition: fs_outputpreview.h:91
foxit::pdf::OutputPreview::e_ShowRGB
If set, only show with RGB.
Definition: fs_outputpreview.h:65
foxit::pdf::OutputPreview::e_ShowCMYK
If set, only show with CMYK.
Definition: fs_outputpreview.h:63
foxit::pdf::OutputPreview::GetPlates
StringArray GetPlates(ColorantType colorant_type)
Get Separations plates.
foxit::pdf::OutputPreview::e_ShowLab
If set, only show with Lab.
Definition: fs_outputpreview.h:79
foxit::pdf::OutputPreview::e_ColorantTypeSpot
Colorant type: spot.
Definition: fs_outputpreview.h:105
foxit::pdf::OutputPreview::e_ShowNotDeviceCMYKOrSpot
If set, only show with DeviceCMYK or spot.
Definition: fs_outputpreview.h:59
foxit::pdf::OutputPreview::OutputPreview
OutputPreview(const PDFDoc &pdf_doc)
Constructor, with parameters.
foxit::pdf::OutputPreview::e_ShowSmoothShades
If set, only show smooth shades.
Definition: fs_outputpreview.h:87
foxit::pdf::OutputPreview::SetSimulationProfile
void SetSimulationProfile(const WString &icc_profile_path)
Set simulation ICC profile file path.
foxit::pdf::OutputPreview::e_ShowDeviceCMYKAndSpot
If set, only show with DeviceCMYK and spot.
Definition: fs_outputpreview.h:57
foxit::pdf::PDFPage
Definition: fs_pdfpage.h:412
foxit::FS_HANDLE
void * FS_HANDLE
Handle type.
Definition: fs_basictypes.h:213
fs_common.h
Header file for common definitions and classes.
foxit::Base
Definition: fs_basictypes.h:451
foxit::StringArray
Definition: fs_basictypes.h:229
foxit::pdf::OutputPreview::e_ShowSolidColor
If set, only show solid color.
Definition: fs_outputpreview.h:85
foxit::pdf::OutputPreview::GetSpotPlateColor
RGB GetSpotPlateColor(const char *plate_name)
Get the color value of a plate.
foxit::pdf::OutputPreview::e_ShowImages
If set, only show images.
Definition: fs_outputpreview.h:83
foxit::pdf::OutputPreview::e_ShowICCBasedCMYK
If set, only show with ICCBased CMYK.
Definition: fs_outputpreview.h:53
foxit::pdf::OutputPreview::e_ShowDeviceGray
If set, only show with DeviceGray.
Definition: fs_outputpreview.h:73
foxit::pdf::OutputPreview::e_ShowICCBasedRGB
If set, only show with ICCBased RGB.
Definition: fs_outputpreview.h:69
foxit
Foxit namespace.
Definition: fs_pdf3d.h:26
CFX_ByteString
BYTE STRING CLASS.
Definition: fx_string.h:317
foxit::pdf::OutputPreview::e_ShowLineArt
If set, only show line art.
Definition: fs_outputpreview.h:93
foxit::pdf::OutputPreview::e_ShowSpotColor
If set, only show with spot color.
Definition: fs_outputpreview.h:55
NULL
#define NULL
The null-pointer value.
Definition: fx_system.h:792
CFX_Matrix
Definition: fx_coordinates.h:1076
fs_render.h
Header file for rendering related definitions and classes.
foxit::pdf::OutputPreview::ColorantType
ColorantType
Enumeration for colorant type.
Definition: fs_outputpreview.h:101
foxit::pdf::OutputPreview::IsChecked
bool IsChecked(const String &plate_name) const
Check whether a plate is checked or not.
foxit::pdf::OutputPreview::e_ShowGray
If set, only show with Gray.
Definition: fs_outputpreview.h:71
foxit::pdf::OutputPreview::e_ShowNotDeviceCMYK
If set, only show without DeviceCMYK.
Definition: fs_outputpreview.h:51