foxit::pdf::annots::IconFit Class Reference

Inherits Object.

Public Types

enum  ScaleWayType { e_ScaleWayAlways = 1, e_ScaleWayBigger = 2, e_ScaleWaySmaller = 3, e_ScaleWayNever = 4 }
 Enumeration for the type of icon scaling way. More...
 

Public Member Functions

 IconFit ()
 Constructor.
 
 IconFit (ScaleWayType type, bool is_proportional_scaling, float horizontal_fraction, float vertical_fraction, bool fit_bounds)
 Constructor, with parameters. More...
 
 IconFit (const IconFit &icon_fit)
 Constructor, with another IconFit object. More...
 
bool operator!= (const IconFit &icon_fit) const
 Equal operator. More...
 
IconFitoperator= (const IconFit &icon_fit)
 Assign operator. More...
 
bool operator== (const IconFit &icon_fit) const
 Equal operator. More...
 
void Set (ScaleWayType type, bool is_proportional_scaling, float horizontal_fraction, float vertical_fraction, bool fit_bounds)
 Set value. More...
 

Public Attributes

bool fit_bounds
 A boolean value that indicates whether to scale button appearance to fit fully within bounds or not. More...
 
float horizontal_fraction
 The horizontal fraction of left-over space to allocate at the left and bottom of the icon. More...
 
bool is_proportional_scaling
 A boolean value which indicates whether use proportional scaling or not. More...
 
ScaleWayType scale_way_type
 The circumstances under which the icon should be scaled inside the annotation rectangle. Please refer to values starting from IconFit::e_ScaleWayAlways and this should be one of these values.
 
float vertical_fraction
 The vertical fraction of left-over space to allocate at the left and bottom of the icon. More...
 

Detailed Description

This class represents icon fit information. Icon fit information is used to specify how to display a button's icon within the annotation rectangle of its associated widget annotation.

Member Enumeration Documentation

◆ ScaleWayType

Enumeration for the type of icon scaling way.

Values of this enumeration should be used alone.

Enumerator
e_ScaleWayAlways 

Always scale.

e_ScaleWayBigger 

Scale only when icon is bigger than annotation rectangle.

e_ScaleWaySmaller 

Scale only when icon is smaller than annotation rectangle.

e_ScaleWayNever 

Never scale.

Constructor & Destructor Documentation

◆ IconFit() [1/2]

foxit::pdf::annots::IconFit::IconFit ( ScaleWayType  type,
bool  is_proportional_scaling,
float  horizontal_fraction,
float  vertical_fraction,
bool  fit_bounds 
)
inline

Constructor, with parameters.

Parameters
[in]typeThe circumstances under which the icon should be scaled inside the annotation rectangle. Please refer to values starting from IconFit::e_ScaleWayAlways and this should be one of these values.
[in]is_proportional_scalingIndicates whether use proportional scaling or not. 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.
[in]horizontal_fractionThe horizontal fraction of left-over space to allocate at the left and bottom of the icon if the icon is scaled proportionally. Valid range: 0.0 to 1.0.
[in]vertical_fractionThe vertical fraction of left-over space to allocate at the left and bottom of the icon if the icon is scaled proportionally. Valid range: 0.0 to 1.0.
[in]fit_boundsIndicates whether to scale button appearance to fit fully within bounds or not. true means 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.

◆ IconFit() [2/2]

foxit::pdf::annots::IconFit::IconFit ( const IconFit icon_fit)
inline

Constructor, with another IconFit object.

Parameters
[in]icon_fitAnother IconFit object.

Member Function Documentation

◆ operator!=()

bool foxit::pdf::annots::IconFit::operator!= ( const IconFit icon_fit) const
inline

Equal operator.

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

◆ operator=()

IconFit& foxit::pdf::annots::IconFit::operator= ( const IconFit icon_fit)
inline

Assign operator.

Parameters
[in]icon_fitAnother IconFit object, whose value would be assigned to current object.
Returns
Reference to current object itself.

◆ operator==()

bool foxit::pdf::annots::IconFit::operator== ( const IconFit icon_fit) const
inline

Equal operator.

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

◆ Set()

void foxit::pdf::annots::IconFit::Set ( ScaleWayType  type,
bool  is_proportional_scaling,
float  horizontal_fraction,
float  vertical_fraction,
bool  fit_bounds 
)
inline

Set value.

Parameters
[in]typeThe circumstances under which the icon should be scaled inside the annotation rectangle. Please refer to values starting from IconFit::e_ScaleWayAlways and this should be one of these values.
[in]is_proportional_scalingIndicates whether use proportional scaling or not. 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.
[in]horizontal_fractionThe horizontal fraction of left-over space to allocate at the left and bottom of the icon if the icon is scaled proportionally. Valid range: 0.0 to 1.0.
[in]vertical_fractionThe vertical fraction of left-over space to allocate at the left and bottom of the icon if the icon is scaled proportionally. Valid range: 0.0 to 1.0.
[in]fit_boundsIndicates whether to scale button appearance to fit fully within bounds or not. true means 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.
Returns
None.

Member Data Documentation

◆ fit_bounds

bool foxit::pdf::annots::IconFit::fit_bounds

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.

◆ horizontal_fraction

float foxit::pdf::annots::IconFit::horizontal_fraction

The horizontal fraction of left-over space to allocate at the left and bottom of the icon.

This entry is used only if the icon is scaled proportionally. Valid range: 0.0 to 1.0.

◆ is_proportional_scaling

bool foxit::pdf::annots::IconFit::is_proportional_scaling

A boolean value which indicates whether use proportional scaling or not.

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.

◆ vertical_fraction

float foxit::pdf::annots::IconFit::vertical_fraction

The vertical fraction of left-over space to allocate at the left and bottom of the icon.

This entry is used only if the icon is scaled proportionally. Valid range: 0.0 to 1.0.

Foxit Software Corporation Logo
@2018 Foxit Software Incorporated. All rights reserved.