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... | |
IconFit & | operator= (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... | |
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.
Enumeration for the type of icon scaling way.
Values of this enumeration should be used alone.
|
inline |
Constructor, with parameters.
[in] | 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. |
[in] | is_proportional_scaling | 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. |
[in] | horizontal_fraction | The 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_fraction | The 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_bounds | Indicates 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. |
|
inline |
|
inline |
Equal operator.
[in] | icon_fit | Another IconFit object. This function will check if current object is not equal to this one. |
Assign operator.
[in] | icon_fit | Another IconFit object, whose value would be assigned to current object. |
|
inline |
Equal operator.
[in] | icon_fit | Another IconFit object. This function will check if current object is equal to this one. |
|
inline |
Set value.
[in] | 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. |
[in] | is_proportional_scaling | 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. |
[in] | horizontal_fraction | The 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_fraction | The 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_bounds | Indicates 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. |
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.
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.
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.
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.