Foxit PDF SDK
|
Inherits Object.
Public Types | |
enum | OffScreenAction { e_OffScreenAllow = 0, e_OffScreenForceOnScreen = 1, e_OffScreenCancel = 2 } |
Enumeration for the action can be taken if the floating window is positioned totally or partially offscreen. More... | |
enum | RelativeTarget { e_RelativeTargetPageWindow = 0, e_RelativeTargetAppWindow = 1, e_RelativeTargetDesktop = 2, e_RelativeTargetMonitor = 3 } |
Enumeration for the values used to set relative position of floating window. More... | |
enum | ResizeType { e_ResizeTypeNo = 0, e_ResizeTypeKeepRatio = 1, e_ResizeTypeYes = 2 } |
Enumeration for the resize type, which specifies whether a floating window may be resized by the user. More... | |
enum | WindowPosition { e_WindowPositionTopLeft = 0, e_WindowPositionTopCenter = 1, e_WindowPositionTopRight = 2, e_WindowPositionCenterLeft = 3, e_WindowPositionCenter = 4, e_WindowPositionCenterRight = 5, e_WindowPositionBottomLeft = 6, e_WindowPositionBottomCenter = 7, e_WindowPositionBottomRight = 8 } |
Enumeration for the window position used for media player. More... | |
Public Member Functions | |
FloatingInfo () | |
Constructor. | |
FloatingInfo (const FloatingInfo &floating_info) | |
Constructor, with another floating infomation object. More... | |
FloatingInfo (WindowPosition window_pos, RelativeTarget relative_target, ResizeType resize_type, bool has_close, bool has_title, const wchar_t *title, OffScreenAction off_screen, const RectF &rect) | |
Constructor, with parameters. More... | |
FloatingInfo & | operator= (const FloatingInfo &floating_info) |
Assign operator. More... | |
void | Set (WindowPosition window_pos, RelativeTarget relative_target, ResizeType resize_type, bool has_close, bool has_title, const wchar_t *title, OffScreenAction off_screen, const RectF &rect) |
Set values. More... | |
Public Attributes | |
bool | has_close |
true means the floating window should have a close window control button, while false means not. | |
bool | has_title |
true means a title should be displayed in the title bar, while false means not. | |
OffScreenAction | off_screen |
Specify what action should be taken if the floating window is positioned totally or partially offscreen. Please refer to values starting from FloatingInfo::e_OffScreenAllow and this should be one of these values. | |
RectF | rect |
A rectangle specifies the location and size of the floating window in device coordinate system. | |
RelativeTarget | relative_target |
Specify the target to which the floating window is to be aligned. Please refer to values starting from FloatingInfo::e_RelativeTargetPageWindow and this should be one of these values. | |
ResizeType | resize_type |
Specify whether the floating window may be resized by the user. Please refer to values starting from FloatingInfo::e_ResizeTypeNo and this should be one of these values. | |
WString | title |
This title to be displayed if has_title is true. | |
WindowPosition | window_pos |
Specify how the floating window is to be positioned relative to the window specified by the relative_target . Please refer to values starting from FloatingInfo::e_WindowPositionTopLeft and this should be one of these values. | |
This class represents floating imformation.
Enumeration for the action can be taken if the floating window is positioned totally or partially offscreen.
Values of this enumeration should be used alone.
Enumeration for the values used to set relative position of floating window.
Values of this enumeration should be used alone.
Enumeration for the resize type, which specifies whether a floating window may be resized by the user.
Values of this enumeration should be used alone.
Enumeration for the window position used for media player.
Values of this enumeration should be used alone.
|
inline |
Constructor, with parameters.
[in] | window_pos | Specify how the floating window is to be positioned relative to the window specified by the relative_target . |
[in] | relative_target | Specify the window to which the floating window is to be aligned. |
[in] | resize_type | Specify whether the floating window may be resized by the user. |
[in] | has_close | true means the floating window should have a close window control button, while false means not. |
[in] | has_title | true means a title should be displayed in the title bar, while false means not. |
[in] | title | This title to be displayed if has_title is true. |
[in] | off_screen | Specify what action should be taken if the floating window is positioned totally or partially offscreen. |
[in] | rect | A rectangle specifies the location and size of the floating window in device coordinate system. |
|
inline |
Constructor, with another floating infomation object.
[in] | floating_info | Another floating infomation object. |
|
inline |
Assign operator.
[in] | floating_info | Another floating infomation object. |
|
inline |
Set values.
[in] | window_pos | Specify how the floating window is to be positioned relative to the window specified by the relative_target . |
[in] | relative_target | Specify the window to which the floating window is to be aligned. |
[in] | resize_type | Specify whether the floating window may be resized by the user. |
[in] | has_close | true means the floating window should have a close window control button, while false means not. |
[in] | has_title | true means a title should be displayed in the title bar, while false means not. |
[in] | title | This title to be displayed if has_title is true. |
[in] | off_screen | Specify what action should be taken if the floating window is positioned totally or partially offscreen. |
[in] | rect | A rectangle specifies the location and size of the floating window in device coordinate system. |