|
Foxit PDF SDK
|
Public Member Functions | |
| def | GetFit_bounds () |
| Get a boolean value that indicates whether to scale button appearance to fit fully within bounds or not. More... | |
| def | GetHorizontal_fraction () |
| Get the horizontal fraction of left-over space to allocate at the left and bottom of the icon. More... | |
| def | GetIs_proportional_scaling () |
| Get a boolean value which indicates whether use proportional scaling or not. More... | |
| def | GetScale_way_type () |
| Get the circumstances under which the icon should be scaled inside the annotation rectangle. More... | |
| def | GetVertical_fraction () |
| Get the vertical fraction of left-over space to allocate at the left and bottom of the icon. More... | |
| def | Set (type, is_proportional_scaling, horizontal_fraction, vertical_fraction, fit_bounds) |
| Set value. More... | |
| def | SetFit_bounds (value) |
| Set a boolean value that indicates whether to scale button appearance to fit fully within bounds or not. More... | |
| def | SetHorizontal_fraction (value) |
| Set the horizontal fraction of left-over space to allocate at the left and bottom of the icon. More... | |
| def | SetIs_proportional_scaling (value) |
| Set a boolean value which indicates whether use proportional scaling or not. More... | |
| def | SetScale_way_type (value) |
| Set the circumstances under which the icon should be scaled inside the annotation rectangle. More... | |
| def | SetVertical_fraction (value) |
| Set 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.
| fsdk.IconFit.GetFit_bounds | ( | ) |
Get 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.
| fsdk.IconFit.GetHorizontal_fraction | ( | ) |
Get 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.
| fsdk.IconFit.GetIs_proportional_scaling | ( | ) |
Get 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.
| fsdk.IconFit.GetScale_way_type | ( | ) |
Get the circumstances under which the icon should be scaled inside the annotation rectangle.
| fsdk.IconFit.GetVertical_fraction | ( | ) |
Get 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.
| def fsdk.IconFit.Set | ( | type, | |
| is_proportional_scaling, | |||
| horizontal_fraction, | |||
| vertical_fraction, | |||
| fit_bounds | |||
| ) |
Set value.
| [in] | type | The circumstances under which the icon should be scaled inside the annotation rectangle. Please refer to values starting from fsdk.IconFitE_ScaleWayAlways and this should be one of these values. This value shold not be fsdk.IconFitE_ScaleWayNone when current icon fit object is used for setting. |
| [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. |
| fsdk.IconFit.SetFit_bounds | ( | value | ) |
Set 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.
| [in] | value | A boolean value that indicates whether to scale button appearance to fit fully within bounds or not. |
| fsdk.IconFit.SetHorizontal_fraction | ( | value | ) |
Set 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.
| [in] | value | The horizontal fraction of left-over space to allocate at the left and bottom of the icon. |
| fsdk.IconFit.SetIs_proportional_scaling | ( | value | ) |
Set 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.
| [in] | value | A boolean value which indicates whether use proportional scaling or not. |
| fsdk.IconFit.SetScale_way_type | ( | value | ) |
Set the circumstances under which the icon should be scaled inside the annotation rectangle.
| [in] | value | The circumstances under which the icon should be scaled inside the annotation rectangle. Please refer to values starting from fsdk.IconFitE_ScaleWayNone and this should be one of these values. When current icon fit object is used for setting, this value should not be fsdk.IconFitE_ScaleWayNone . |
| fsdk.IconFit.SetVertical_fraction | ( | value | ) |
Set 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.
| [in] | value | The vertical fraction of left-over space to allocate at the left and bottom of the icon. |