Foxit PDF SDK
FoxitPDFSDKPython3.RectI Class Reference

Inherits FoxitPDFSDKPython3._object.

Public Member Functions

def RectI ()
 Construct a rect not initialized.

 
def RectI (left1, top1, right1, bottom1)
 Construct a rect with left-top and right bottom corners.
More...
 
def Contains (other_rect)
 Check if current rectangle fully contains the other provided rectangle. That means to check if the other rectangle is fully inside current one.
More...
 
def Contains (x, y)
 Check if current rectangle contains the provided point. That means to check if the provided point is inside current one.
More...
 
def Height ()
 Get the height of the rect.
More...
 
def Intersect (left1, top1, right1, bottom1)
 Intersect with a rect.
More...
 
def Intersect (src)
 Intersect with a rect.
More...
 
def IsEmpty ()
 Verify whether the rect is empty.
More...
 
def Normalize ()
 Normalize the rect. Make sure left <= right, top <= bottom.
More...
 
def Offset (dx, dy)
 Shift the coordinates by delta value of x and y directions.
More...
 
def Union (other_rect)
 Union with a rect.
More...
 
def Valid ()
 Check if current rectangle is valid.
More...
 
def Width ()
 Get the width of the rect.
More...
 

Static Public Attributes

 bottom = _swig_property(_fsdk.RectI_bottom_get, _fsdk.RectI_bottom_set)
 The bottom.

 
 left = _swig_property(_fsdk.RectI_left_get, _fsdk.RectI_left_set)
 The left.

 
 right = _swig_property(_fsdk.RectI_right_get, _fsdk.RectI_right_set)
 The right.

 
 top = _swig_property(_fsdk.RectI_top_get, _fsdk.RectI_top_set)
 The top.

 

Detailed Description

The struct represents integer rectangle for Windows coordinates. Defined as equivalent of Windows RECT structure, with some convenient function members. This structure use Windows space where Y axis runs from top to bottom.

Constructor & Destructor Documentation

◆ RectI()

FoxitPDFSDKPython3.RectI.RectI (   left1,
  top1,
  right1,
  bottom1 
)

Construct a rect with left-top and right bottom corners.

Parameters
[in]left1The left.
[in]top1The top.
[in]right1The right.
[in]bottom1The bottom.

Member Function Documentation

◆ Contains() [1/2]

def FoxitPDFSDKPython3.RectI.Contains (   other_rect)

Check if current rectangle fully contains the other provided rectangle. That means to check if the other rectangle is fully inside current one.

Parameters
[in]other_rectThe other provided rect.
Returns
true means current rect fully contains the other rectangle, while false means not.

◆ Contains() [2/2]

def FoxitPDFSDKPython3.RectI.Contains (   x,
  y 
)

Check if current rectangle contains the provided point. That means to check if the provided point is inside current one.

Parameters
[in]xThe x coordinate of the provided point.
[in]yThe y coordinate of the provided point.
Returns
true means current rect contains the provided point, while false means not.

◆ Height()

def FoxitPDFSDKPython3.RectI.Height ( )

Get the height of the rect.

Returns
The height of the rect.

◆ Intersect() [1/2]

def FoxitPDFSDKPython3.RectI.Intersect (   left1,
  top1,
  right1,
  bottom1 
)

Intersect with a rect.

Parameters
[in]left1The left of the rect to intersect with.
[in]top1The top of the rect to intersect with.
[in]right1The right of the rect to intersect with.
[in]bottom1The bottom of the rect to intersect with.
Returns
None.

◆ Intersect() [2/2]

def FoxitPDFSDKPython3.RectI.Intersect (   src)

Intersect with a rect.

Parameters
[in]srcThe rect to intersect with.
Returns
None.

◆ IsEmpty()

def FoxitPDFSDKPython3.RectI.IsEmpty ( )

Verify whether the rect is empty.

Returns
true means current rect is empty, while false means not.

◆ Normalize()

def FoxitPDFSDKPython3.RectI.Normalize ( )

Normalize the rect. Make sure left <= right, top <= bottom.

Returns
None.

◆ Offset()

def FoxitPDFSDKPython3.RectI.Offset (   dx,
  dy 
)

Shift the coordinates by delta value of x and y directions.

Parameters
[in]dxThe delta value of x-direction.
[in]dyThe delta value of y-direction.
Returns
None.

◆ Union()

def FoxitPDFSDKPython3.RectI.Union (   other_rect)

Union with a rect.

Parameters
[in]other_rectThe rect to union with.
Returns
None.

◆ Valid()

def FoxitPDFSDKPython3.RectI.Valid ( )

Check if current rectangle is valid.

Returns
true means valid, while false means invalid.

◆ Width()

def FoxitPDFSDKPython3.RectI.Width ( )

Get the width of the rect.

Returns
The width of the rect.