Foxit PDF SDK
fsdk.FloatingInfo Class Reference

Public Member Functions

def GetHas_close ()
 Get true means the floating window should have a close window control button, while false means not. More...
 
def GetHas_title ()
 Get true means a title should be displayed in the title bar, while false means not. More...
 
def GetOff_screen ()
 Get specify what action should be taken if the floating window is positioned totally or partially offscreen. More...
 
def GetRect ()
 Get a rectangle specifies the location and size of the floating window in device coordinate system. More...
 
def GetRelative_target ()
 Get specify the target to which the floating window is to be aligned. More...
 
def GetResize_type ()
 Get specify whether the floating window may be resized by the user. More...
 
def GetTitle ()
 Get this title to be displayed if has_title is true. More...
 
def GetWindow_pos ()
 Get specify how the floating window is to be positioned relative to the window specified by the relative_target . More...
 
def Set (window_pos, relative_target, resize_type, has_close, has_title, title, off_screen, rect)
 Set values. More...
 
def SetHas_close (value)
 Set true means the floating window should have a close window control button, while false means not. More...
 
def SetHas_title (value)
 Set true means a title should be displayed in the title bar, while false means not. More...
 
def SetOff_screen (value)
 Set specify what action should be taken if the floating window is positioned totally or partially offscreen. More...
 
def SetRect (value)
 Set a rectangle specifies the location and size of the floating window in device coordinate system. More...
 
def SetRelative_target (value)
 Set specify the target to which the floating window is to be aligned. More...
 
def SetResize_type (value)
 Set specify whether the floating window may be resized by the user. More...
 
def SetTitle (value)
 Set this title to be displayed if has_title is true. More...
 
def SetWindow_pos (value)
 Set specify how the floating window is to be positioned relative to the window specified by the relative_target . More...
 

Detailed Description

This class represents floating imformation.

Member Function Documentation

◆ GetHas_close()

fsdk.FloatingInfo.GetHas_close ( )

Get true means the floating window should have a close window control button, while false means not.

Returns
true means the floating window should have a close window control button, while false means not.

◆ GetHas_title()

fsdk.FloatingInfo.GetHas_title ( )

Get true means a title should be displayed in the title bar, while false means not.

Returns
true means a title should be displayed in the title bar, while false means not.

◆ GetOff_screen()

fsdk.FloatingInfo.GetOff_screen ( )

Get specify what action should be taken if the floating window is positioned totally or partially offscreen.

Returns
Specify what action should be taken if the floating window is positioned totally or partially offscreen. Please refer to values starting from fsdk.FloatingInfoE_OffScreenAllow and this should be one of these values.

◆ GetRect()

fsdk.FloatingInfo.GetRect ( )

Get a rectangle specifies the location and size of the floating window in device coordinate system.

Returns
A rectangle specifies the location and size of the floating window in device coordinate system.

◆ GetRelative_target()

fsdk.FloatingInfo.GetRelative_target ( )

Get specify the target to which the floating window is to be aligned.

Returns
Specify the target to which the floating window is to be aligned. Please refer to values starting from fsdk.FloatingInfoE_RelativeTargetPageWindow and this should be one of these values.

◆ GetResize_type()

fsdk.FloatingInfo.GetResize_type ( )

Get specify whether the floating window may be resized by the user.

Returns
Specify whether the floating window may be resized by the user. Please refer to values starting from fsdk.FloatingInfoE_ResizeTypeNo and this should be one of these values.

◆ GetTitle()

fsdk.FloatingInfo.GetTitle ( )

Get this title to be displayed if has_title is true.

Returns
This title to be displayed if has_title is true.

◆ GetWindow_pos()

fsdk.FloatingInfo.GetWindow_pos ( )

Get specify how the floating window is to be positioned relative to the window specified by the relative_target .

Returns
Specify how the floating window is to be positioned relative to the window specified by the relative_target . Please refer to values starting from fsdk.FloatingInfoE_WindowPositionTopLeft and this should be one of these values.

◆ Set()

def fsdk.FloatingInfo.Set (   window_pos,
  relative_target,
  resize_type,
  has_close,
  has_title,
  title,
  off_screen,
  rect 
)

Set values.

Parameters
[in]window_posSpecify how the floating window is to be positioned relative to the window specified by the relative_target .
[in]relative_targetSpecify the window to which the floating window is to be aligned.
[in]resize_typeSpecify whether the floating window may be resized by the user.
[in]has_closetrue means the floating window should have a close window control button, while false means not.
[in]has_titletrue means a title should be displayed in the title bar, while false means not.
[in]titleThis title to be displayed if has_title is true.
[in]off_screenSpecify what action should be taken if the floating window is positioned totally or partially offscreen.
[in]rectA rectangle specifies the location and size of the floating window in device coordinate system.
Returns
None.

◆ SetHas_close()

fsdk.FloatingInfo.SetHas_close (   value)

Set true means the floating window should have a close window control button, while false means not.

Parameters
[in]valuetrue means the floating window should have a close window control button, while false means not.
Returns
None.

◆ SetHas_title()

fsdk.FloatingInfo.SetHas_title (   value)

Set true means a title should be displayed in the title bar, while false means not.

Parameters
[in]valuetrue means a title should be displayed in the title bar, while false means not.
Returns
None.

◆ SetOff_screen()

fsdk.FloatingInfo.SetOff_screen (   value)

Set specify what action should be taken if the floating window is positioned totally or partially offscreen.

Parameters
[in]valueSpecify what action should be taken if the floating window is positioned totally or partially offscreen. Please refer to values starting from fsdk.FloatingInfoE_OffScreenAllow and this should be one of these values.
Returns
None.

◆ SetRect()

fsdk.FloatingInfo.SetRect (   value)

Set a rectangle specifies the location and size of the floating window in device coordinate system.

Parameters
[in]valueA rectangle specifies the location and size of the floating window in device coordinate system.
Returns
None.

◆ SetRelative_target()

fsdk.FloatingInfo.SetRelative_target (   value)

Set specify the target to which the floating window is to be aligned.

Parameters
[in]valueSpecify the target to which the floating window is to be aligned. Please refer to values starting from fsdk.FloatingInfoE_RelativeTargetPageWindow and this should be one of these values.
Returns
None.

◆ SetResize_type()

fsdk.FloatingInfo.SetResize_type (   value)

Set specify whether the floating window may be resized by the user.

Parameters
[in]valueSpecify whether the floating window may be resized by the user. Please refer to values starting from fsdk.FloatingInfoE_ResizeTypeNo and this should be one of these values.
Returns
None.

◆ SetTitle()

fsdk.FloatingInfo.SetTitle (   value)

Set this title to be displayed if has_title is true.

Parameters
[in]valueThis title to be displayed if has_title is true.
Returns
None.

◆ SetWindow_pos()

fsdk.FloatingInfo.SetWindow_pos (   value)

Set specify how the floating window is to be positioned relative to the window specified by the relative_target .

Parameters
[in]valueSpecify how the floating window is to be positioned relative to the window specified by the relative_target . Please refer to values starting from fsdk.FloatingInfoE_WindowPositionTopLeft and this should be one of these values.
Returns
None.