FSPDF_ANNOTICONFIT Struct Reference

Structure for annotation icon fit. More...

#include <fpdf_annot_r.h>

Public Attributes

FS_DWORD flags
 Icon fit flag. More...
 
FS_INT32 scaleWay
 The circumstances under which the icon should be scaled inside the annotation rectangle. More...
 
FS_BOOL aspectRatio
 A boolean value that indicates which type of scaling is to be used. More...
 
FS_FLOAT left
 Left-over space to allocate at the left of the icon. More...
 
FS_FLOAT bottom
 Left-over space to allocate at the bottom of the icon. More...
 
FS_BOOL fitBounds
 A boolean value that indicates whether to scale button appearance to fit fully within bounds or not. More...
 

Detailed Description

Structure for annotation icon fit.

Member Data Documentation

FS_BOOL FSPDF_ANNOTICONFIT::aspectRatio

A boolean value that indicates which type of scaling is to be used.

TRUE means to fill the annotation rectangle exactly, without regard to its original aspect ratio (ratio of width to height).
FALSE means scale the icon to scale the icon to fit the width or height of the annotation rectangle while maintaining the icon's original aspect ratio.
Meaningful only when FSPDF_ANNOTICONFIT::flags contains FSPDF_ANNOT_ICONFITFLAG_ASPECTRATIO.

FS_FLOAT FSPDF_ANNOTICONFIT::bottom

Left-over space to allocate at the bottom of the icon.

It is only valid for proportional scaling. Valid range: 0.0 to 1.0.
Meaningful only when FSPDF_ANNOTICONFIT::flags contains FSPDF_ANNOT_ICONFITFLAG_POSITION.

FS_BOOL FSPDF_ANNOTICONFIT::fitBounds

A boolean value that indicates whether to scale button appearance to fit fully within bounds or not.

TRUE indicates that the button appearance should be scaled to fit fully within the bounds of the annotation without taking into consideration the line width of the border.
Meaningful only when FSPDF_ANNOTICONFIT::flags contains FSPDF_ANNOT_ICONFITFLAG_FITBOUNDS.

FS_DWORD FSPDF_ANNOTICONFIT::flags
FS_FLOAT FSPDF_ANNOTICONFIT::left

Left-over space to allocate at the left of the icon.

It is only valid for proportional scaling. Valid range: 0.0 to 1.0.
Meaningful only when FSPDF_ANNOTICONFIT::flags contains FSPDF_ANNOT_ICONFITFLAG_POSITION.

FS_INT32 FSPDF_ANNOTICONFIT::scaleWay

The circumstances under which the icon should be scaled inside the annotation rectangle.

It should be one of the following macro definitions:

Meaningful only when FSPDF_ANNOTICONFIT::flags contains FSPDF_ANNOT_ICONFITFLAG_SCALEWAY.


The documentation for this struct was generated from the following file:

Foxit Corporation