Foxit PDF SDK

fs_ofdrenderer.h
1 #if (defined(_WIN32) || defined(_WIN64))|| defined(__linux__)
2
16 #ifndef FS_OFDRENDERER_H_
17 #define FS_OFDRENDERER_H_
18
19 #include "common/fs_common.h"
20 #include "common/fs_image.h"
21 #include "fs_ofdpage.h"
22
28 namespace foxit {
32 namespace addon {
36 namespace ofd {
43 class OFDRenderer FS_FINAL : public Base{
44 public:
50 typedef enum _ColorMode {
52 e_ColorModeNormal = 0,
54 e_ColorModeMappingGray = 1,
56 e_ColorModeMapping = 2
57 } ColorMode;
58
64 typedef enum _ContentFlag {
66 e_ContentFlagAllContent = 0x00,
68 e_ContentFlagPage = 0x01,
70 e_ContentFlagAnnot = 0x02,
72 e_ContentFlagHighLightAnnots = 0x04,
74 e_ContentFlagStampAnnots = 0x08
75 } ContentFlag;
76
77
81 OFDRenderer() {}
82
88 OFDRenderer(const common::Bitmap & bitmap);
94 OFDRenderer(const OFDRenderer& other);
95
97 ~OFDRenderer();
98
106 OFDRenderer& operator = (const OFDRenderer& other);
114 bool operator == (const OFDRenderer& other) const;
122 bool operator != (const OFDRenderer& other) const;
123
131 bool IsEmpty() const;
132
142 void SetColorMode(ColorMode color_mode);
143
153 void SetContentFlag(uint32 content_flag);
154
168 common::Progressive StartRender(const OFDPage& page, const Matrix& matrix);
169 };
170
171 }//namespace ofd
172 }//namespace addon
173 }//namespace foxit
174 #endif // FS_OFDRENDERER_H_
175 #endif // (defined(_WIN32) || defined(_WIN64)) || (defined(__linux__) && defined(__x86_64__) && !defined(__ANDROID__))
foxit::addon::ofd::OFDRenderer::operator==
bool operator==(const OFDRenderer &other) const
Equal operator.
foxit::common::Bitmap
Definition: fs_image.h:36
foxit::addon::ofd::OFDRenderer::ColorMode
ColorMode
Enumeration for rendering color mode.
Definition: fs_ofdrenderer.h:50
fs_ofdpage.h
Header file for OFD page related classes and methods.
foxit::addon::ofd::OFDPage
Definition: fs_ofdpage.h:41
foxit::addon::ofd::OFDRenderer::operator !=
bool operator !=(const OFDRenderer &other) const
Not equal operator.
foxit::addon::ofd::OFDRenderer::SetContentFlag
void SetContentFlag(uint32 content_flag)
Set the content flag.
fs_image.h
Header file for image and bitmap related definitions and classes.
foxit::addon::ofd::OFDRenderer::IsEmpty
bool IsEmpty() const
Check whether current object is empty or not.
foxit::addon::ofd::OFDRenderer::~OFDRenderer
~OFDRenderer()
Destructor.
foxit::addon::ofd::OFDRenderer::e_ContentFlagHighLightAnnots
If set, highlight annotations will be rendered.
Definition: fs_ofdrenderer.h:72
foxit::addon::ofd::OFDRenderer::e_ContentFlagAnnot
If set, annotations will be rendered.(Excluding highlight annotation and stamp)
Definition: fs_ofdrenderer.h:70
foxit::addon::ofd::OFDRenderer::StartRender
common::Progressive StartRender(const OFDPage &page, const Matrix &matrix)
Start to render an OFD page.
foxit::addon::ofd::OFDRenderer::ContentFlag
ContentFlag
Enumeration for OFD rendering content flags.
Definition: fs_ofdrenderer.h:64
foxit::common::Progressive
Definition: fs_common.h:373
foxit::addon::ofd::OFDRenderer::SetColorMode
void SetColorMode(ColorMode color_mode)
Set the color mode.
foxit::uint32
FX_UINT32 uint32
32-bit unsigned integer.
Definition: fs_basictypes.h:195
fs_common.h
Header file for common definitions and classes.
foxit::Base
Definition: fs_basictypes.h:451
foxit
Foxit namespace.
Definition: fs_pdf3d.h:26
foxit::addon::ofd::OFDRenderer
Definition: fs_ofdrenderer.h:43
foxit::addon::ofd::OFDRenderer::e_ContentFlagStampAnnots
If set, stamp annotations will be rendered.
Definition: fs_ofdrenderer.h:74
CFX_Matrix
Definition: fx_coordinates.h:1076
foxit::addon::ofd::OFDRenderer::e_ContentFlagAllContent
If set, all content will be rendered. This value should be used alone.
Definition: fs_ofdrenderer.h:66
foxit::addon::ofd::OFDRenderer::e_ContentFlagPage
If set, page content will be rendered.
Definition: fs_ofdrenderer.h:68
foxit::addon::ofd::OFDRenderer::OFDRenderer
OFDRenderer()
Constructor.
Definition: fs_ofdrenderer.h:81
foxit::addon::ofd::OFDRenderer::e_ColorModeNormal
Normal color mode.
Definition: fs_ofdrenderer.h:52
foxit::addon::ofd::OFDRenderer::e_ColorModeMapping
Map a color value to the color range defined by a background color and a foreground color.
Definition: fs_ofdrenderer.h:56
foxit::addon::ofd::OFDRenderer::e_ColorModeMappingGray
Map gray/white/black color value to background/foreground; for other colors, no change.
Definition: fs_ofdrenderer.h:54
foxit::addon::ofd::OFDRenderer::operator=
OFDRenderer & operator=(const OFDRenderer &other)
Assign operator.