Foxit PDF SDK
|
Public Types | |
enum | ColorMode { e_ColorModeNormal = 0, e_ColorModeMappingGray = 1, e_ColorModeMapping = 2 } |
Enumeration for rendering color mode. More... | |
enum | ContentFlag { e_ContentFlagAllContent = 0x00, e_ContentFlagPage = 0x01, e_ContentFlagAnnot = 0x02, e_ContentFlagHighLightAnnots = 0x04, e_ContentFlagStampAnnots = 0x08 } |
Enumeration for OFD rendering content flags. More... | |
Public Member Functions | |
OFDRenderer () | |
Constructor. | |
OFDRenderer (const common::Bitmap &bitmap) | |
Constructor, with a bitmap object. More... | |
OFDRenderer (const OFDRenderer &other) | |
Constructor, with another renderer object. More... | |
~OFDRenderer () | |
Destructor. | |
bool | IsEmpty () const |
Check whether current object is empty or not. More... | |
bool | operator != (const OFDRenderer &other) const |
Not equal operator. More... | |
OFDRenderer & | operator= (const OFDRenderer &other) |
Assign operator. More... | |
bool | operator== (const OFDRenderer &other) const |
Equal operator. More... | |
void | SetColorMode (ColorMode color_mode) |
Set the color mode. More... | |
void | SetContentFlag (uint32 content_flag) |
Set the content flag. More... | |
common::Progressive | StartRender (const OFDPage &page, const Matrix &matrix) |
Start to render an OFD page. More... | |
![]() | |
FS_HANDLE | Handle () const |
Get the handle of current object. More... | |
This class is used to render an OFD page to a bitmap. Please ensure common::Library::InitializeOFDEngine has been called successfully before using this class.
Enumeration for rendering color mode.
Values of this enumeration should be used alone.
Enumeration for OFD rendering content flags.
Values of this enumeration can be used alone or in combination.
foxit::addon::ofd::OFDRenderer::OFDRenderer | ( | const common::Bitmap & | bitmap | ) |
Constructor, with a bitmap object.
[in] | bitmap | A bitmap object. It should not be an empty bitmap. |
foxit::addon::ofd::OFDRenderer::OFDRenderer | ( | const OFDRenderer & | other | ) |
Constructor, with another renderer object.
[in] | other | Another renderer object. |
bool foxit::addon::ofd::OFDRenderer::IsEmpty | ( | ) | const |
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
bool foxit::addon::ofd::OFDRenderer::operator != | ( | const OFDRenderer & | other | ) | const |
Not equal operator.
[in] | other | Another OFD renderer object. This function will check if current object is not equal to this one. |
OFDRenderer& foxit::addon::ofd::OFDRenderer::operator= | ( | const OFDRenderer & | other | ) |
Assign operator.
[in] | other | Another OFD renderer object, whose value would be assigned to current object. |
bool foxit::addon::ofd::OFDRenderer::operator== | ( | const OFDRenderer & | other | ) | const |
Equal operator.
[in] | other | Another OFD renderer object. This function will check if current object is equal to this one. |
void foxit::addon::ofd::OFDRenderer::SetColorMode | ( | ColorMode | color_mode | ) |
Set the color mode.
[in] | color_mode | Color mode. Please refer to values starting from OFDRenderer::e_ColorModeNormal and this should be one of these values. The default value is OFDRenderer::e_ColorModeNormal. |
void foxit::addon::ofd::OFDRenderer::SetContentFlag | ( | uint32 | content_flag | ) |
Set the content flag.
[in] | content_flag | Content flag. Please refer to values starting from OFDRenderer::e_ContentFlagAllContent and this can be one or a combination of these values. The default value is OFDRenderer::e_ContentFlagAllContent. |
common::Progressive foxit::addon::ofd::OFDRenderer::StartRender | ( | const OFDPage & | page, |
const Matrix & | matrix | ||
) |
Start to render an OFD page.
This function is used to start to render an OFD page.
[in] | page | An OFD page object. It should not be an empty object. |
[in] | matrix | A matrix for rendering the page, which is usually returned by function OFDPage::GetDisplayMatrix. |