Foxit PDF SDK
foxit::FloatingInfo类 参考

继承自 Object .

Public 类型

enum  OffScreenAction { e_OffScreenAllow = 0, e_OffScreenForceOnScreen = 1, e_OffScreenCancel = 2 }
 如果浮动窗口完全或部分位于屏幕外时可以采取的操作的枚举。 更多...
 
enum  RelativeTarget { e_RelativeTargetPageWindow = 0, e_RelativeTargetAppWindow = 1, e_RelativeTargetDesktop = 2, e_RelativeTargetMonitor = 3 }
 用于设置浮动窗口相对位置的值的枚举。 更多...
 
enum  ResizeType { e_ResizeTypeNo = 0, e_ResizeTypeKeepRatio = 1, e_ResizeTypeYes = 2 }
 调整大小类型的枚举,指定浮动窗口是否可以被用户调整大小。 更多...
 
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
}
 用于媒体播放器的窗口位置枚举。 更多...
 

Public 成员函数

 FloatingInfo ()
 构造函数。
 
 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)
 构造函数,带参数。 更多...
 
 FloatingInfo (const FloatingInfo &floating_info)
 构造函数,使用另一个浮动信息对象。 更多...
 
FloatingInfooperator= (const FloatingInfo &floating_info)
 赋值操作符。 更多...
 
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)
 设置值。 更多...
 

Public 属性

bool has_close
 true 表示浮动窗口应该有关闭窗口控制按钮,false 表示没有。
 
bool has_title
 true 表示标题栏中应显示标题,false 表示不显示。
 
OffScreenAction off_screen
 指定当浮动窗口完全或部分位于屏幕外时应采取的操作。 请参考从 FloatingInfo::e_OffScreenAllow 开始的值,这应该是这些值中的一个。
 
RectF rect
 指定浮动窗口在设备坐标系中的位置和大小的矩形。
 
RelativeTarget relative_target
 指定浮动窗口要对齐的目标。请参考从 FloatingInfo::e_RelativeTargetPageWindow 开始的值,这应该是这些值中的一个。
 
ResizeType resize_type
 指定用户是否可以调整浮动窗口的大小。请参考从 FloatingInfo::e_ResizeTypeNo 开始的值,这应该是这些值中的一个。
 
WString title
 如果has_title为true时要显示的标题。
 
WindowPosition window_pos
 指定浮动窗口相对于由relative_target指定的窗口的定位方式。 请参考从 FloatingInfo::e_WindowPositionTopLeft 开始的值,这应该是这些值中的一个。
 

详细描述

此类表示浮动信息。

成员枚举类型说明

◆ OffScreenAction

如果浮动窗口完全或部分位于屏幕外时可以采取的操作的枚举。

此枚举的值应单独使用。

枚举值
e_OffScreenAllow 

屏幕外操作:不采取任何操作。

e_OffScreenForceOnScreen 

屏幕外操作:移动或调整窗口大小以使其在屏幕上。

e_OffScreenCancel 

屏幕外操作:取消播放媒体剪辑。

◆ RelativeTarget

用于设置浮动窗口相对位置的值的枚举。

此枚举的值应单独使用。

枚举值
e_RelativeTargetPageWindow 

相对类型:将浮动窗口相对于文档(页面)窗口对齐。

e_RelativeTargetAppWindow 

相对类型:将浮动窗口相对于应用程序窗口对齐。

e_RelativeTargetDesktop 

相对类型:将浮动窗口相对于完整虚拟桌面对齐。

e_RelativeTargetMonitor 

相对类型:将浮动窗口相对于监视器显示屏幕对齐。

◆ ResizeType

调整大小类型的枚举,指定浮动窗口是否可以被用户调整大小。

此枚举的值应单独使用。

枚举值
e_ResizeTypeNo 

调整类型:不可调整大小。

e_ResizeTypeKeepRatio 

调整类型:只有在保持纵横比的情况下才能调整大小。

e_ResizeTypeYes 

调整类型:可以在不保持纵横比的情况下调整大小。

◆ WindowPosition

用于媒体播放器的窗口位置枚举。

此枚举的值应单独使用。

枚举值
e_WindowPositionTopLeft 

窗口位置:在左上角。

e_WindowPositionTopCenter 

窗口位置:在顶部中央。

e_WindowPositionTopRight 

窗口位置:在右上角。

e_WindowPositionCenterLeft 

窗口位置:在中央左侧。

e_WindowPositionCenter 

窗口位置:在中央。

e_WindowPositionCenterRight 

窗口位置:在中央右侧。

e_WindowPositionBottomLeft 

窗口位置:在左下角。

e_WindowPositionBottomCenter 

窗口位置:在底部中央。

e_WindowPositionBottomRight 

窗口位置:在右下角。

构造及析构函数说明

◆ FloatingInfo() [1/2]

foxit::FloatingInfo::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 
)
inline

构造函数,带参数。

参数
[in]window_pos指定浮动窗口相对于 relative_target 指定的窗口的位置。
[in]relative_target指定浮动窗口要对齐到的窗口。
[in]resize_type指定浮动窗口是否可以被用户调整大小。
[in]has_closetrue 表示浮动窗口应该有一个关闭窗口控制按钮,false 表示没有。
[in]has_titletrue 表示应该在标题栏中显示标题,false 表示不显示。
[in]title如果 has_title 为 true,要显示的标题。
[in]off_screen指定如果浮动窗口完全或部分位于屏幕外时应采取的操作。
[in]rect指定浮动窗口在设备坐标系统中的位置和大小的矩形。

◆ FloatingInfo() [2/2]

foxit::FloatingInfo::FloatingInfo ( const FloatingInfo floating_info)
inline

构造函数,使用另一个浮动信息对象。

参数
[in]floating_info另一个浮动信息对象。

成员函数说明

◆ operator=()

FloatingInfo& foxit::FloatingInfo::operator= ( const FloatingInfo floating_info)
inline

赋值操作符。

参数
[in]floating_info另一个浮动信息对象。
返回
当前对象自身的引用。

◆ Set()

void foxit::FloatingInfo::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 
)
inline

设置值。

参数
[in]window_pos指定浮动窗口相对于 relative_target 指定的窗口的位置。
[in]relative_target指定浮动窗口要对齐到的窗口。
[in]resize_type指定浮动窗口是否可以被用户调整大小。
[in]has_closetrue 表示浮动窗口应该有一个关闭窗口控制按钮,false 表示没有。
[in]has_titletrue 表示应该在标题栏中显示标题,false 表示不显示。
[in]title如果 has_title 为 true,要显示的标题。
[in]off_screen指定如果浮动窗口完全或部分位于屏幕外时应采取的操作。
[in]rect指定浮动窗口在设备坐标系统中的位置和大小的矩形。
返回
无。