Foxit PDF SDK
foxit::addon::ofd::OFDRenderer Class Reference
Inheritance diagram for foxit::addon::ofd::OFDRenderer:
foxit::Base

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...
 
OFDRendereroperator= (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...
 
- Public Member Functions inherited from foxit::Base
FS_HANDLE Handle () const
 Get the handle of current object. More...
 

Detailed Description

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.

See also
common::Library

Member Enumeration Documentation

◆ ColorMode

Enumeration for rendering color mode.

Values of this enumeration should be used alone.

Enumerator
e_ColorModeNormal 

Normal color mode.

e_ColorModeMappingGray 

Map gray/white/black color value to background/foreground; for other colors, no change.

e_ColorModeMapping 

Map a color value to the color range defined by a background color and a foreground color.

◆ ContentFlag

Enumeration for OFD rendering content flags.

Values of this enumeration can be used alone or in combination.

Enumerator
e_ContentFlagAllContent 

If set, all content will be rendered. This value should be used alone.

e_ContentFlagPage 

If set, page content will be rendered.

e_ContentFlagAnnot 

If set, annotations will be rendered.(Excluding highlight annotation and stamp)

e_ContentFlagHighLightAnnots 

If set, highlight annotations will be rendered.

e_ContentFlagStampAnnots 

If set, stamp annotations will be rendered.

Constructor & Destructor Documentation

◆ OFDRenderer() [1/2]

foxit::addon::ofd::OFDRenderer::OFDRenderer ( const common::Bitmap bitmap)

Constructor, with a bitmap object.

Parameters
[in]bitmapA bitmap object. It should not be an empty bitmap.

◆ OFDRenderer() [2/2]

foxit::addon::ofd::OFDRenderer::OFDRenderer ( const OFDRenderer other)

Constructor, with another renderer object.

Parameters
[in]otherAnother renderer object.

Member Function Documentation

◆ IsEmpty()

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.

Returns
true means current object is empty, while false means not.

◆ operator !=()

bool foxit::addon::ofd::OFDRenderer::operator != ( const OFDRenderer other) const

Not equal operator.

Parameters
[in]otherAnother OFD renderer object. This function will check if current object is not equal to this one.
Returns
true means not equal, while false means equal.

◆ operator=()

OFDRenderer& foxit::addon::ofd::OFDRenderer::operator= ( const OFDRenderer other)

Assign operator.

Parameters
[in]otherAnother OFD renderer object, whose value would be assigned to current object.
Returns
Reference to current object itself.

◆ operator==()

bool foxit::addon::ofd::OFDRenderer::operator== ( const OFDRenderer other) const

Equal operator.

Parameters
[in]otherAnother OFD renderer object. This function will check if current object is equal to this one.
Returns
true means equal, while false means not equal.

◆ SetColorMode()

void foxit::addon::ofd::OFDRenderer::SetColorMode ( ColorMode  color_mode)

Set the color mode.

Parameters
[in]color_modeColor 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.
Returns
None.

◆ SetContentFlag()

void foxit::addon::ofd::OFDRenderer::SetContentFlag ( uint32  content_flag)

Set the content flag.

Parameters
[in]content_flagContent 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.
Returns
None.

◆ StartRender()

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.

Parameters
[in]pageAn OFD page object. It should not be an empty object.
[in]matrixA matrix for rendering the page, which is usually returned by function OFDPage::GetDisplayMatrix.
Returns
A progressive object. Please check the rate of current progress by function common::Progressive::GetRateOfProgress. If the rate is not 100 yet, call function common::Progressive::Continue to continue the progress until the progress is finished.