Foxit PDF SDK
FoxitPDFSDKPython3.PathObject Class Reference
Inheritance diagram for FoxitPDFSDKPython3.PathObject:
FoxitPDFSDKPython3.GraphicsObject

Public Member Functions

def GetFillMode ()
 Get fill mode.
More...
 
def GetPathData ()
 Get the path data.
More...
 
def GetStrokeState ()
 Get stroke state.
More...
 
def SetFillMode (fill_mode)
 Set fill mode.
More...
 
def SetPathData (path_data)
 Set the path data.
More...
 
def SetStrokeState (is_stroke)
 Set stroke state.
More...
 
- Public Member Functions inherited from FoxitPDFSDKPython3.GraphicsObject
def AddClipPath (path, fill_mode)
 Add a path for clipping.
More...
 
def AddClipTextObject (textobject)
 Add text object for clipping.
More...
 
def ClearClips ()
 Clear all clips.
More...
 
def Clone ()
 Clone a new graphics object.
More...
 
def GetBlendMode ()
 Get the blend mode for transparent imaging model.
More...
 
def GetClipPath (index)
 Get a path clip by index.
More...
 
def GetClipPathCount ()
 Get the count of path clip.
More...
 
def GetClipPathFillMode (index)
 Get the fill mode of a path clip by index.
More...
 
def GetClipRect ()
 Get clip rectangle.
More...
 
def GetClipTextObject (index)
 Get the text object of a text clip by index.
More...
 
def GetClipTextObjectCount ()
 Get the count of text clip.
More...
 
def GetColorState ()
 Get color state.
More...
 
def GetFillColor ()
 Get the fill color.
More...
 
def GetFillOpacity ()
 Get the opacity value for painting operations other than stroking.
More...
 
def GetFormXObject ()
 Get the form XObject graphics object if current graphics object represents a form XObject object.
More...
 
def GetGraphState ()
 Get graph state.
More...
 
def GetImageObject ()
 Get the image graphics object if current graphics object represents an image object.
More...
 
def GetLayers (layer_tree)
 Get all the layers which are associated with current graphics object.
More...
 
def GetMarkedContent ()
 Get marked content object.
More...
 
def GetMatrix ()
 Get matrix.
More...
 
def GetPathObject ()
 Get the path graphics object if current graphics object represents a path object.
More...
 
def GetRect ()
 Get the rectangle of current graphics object.
More...
 
def GetShadingObject ()
 Get the shading graphics object if current graphics object represents a shading object.
More...
 
def GetStrokeColor ()
 Get the stroke color.
More...
 
def GetStrokeOpacity ()
 Get opacity value for stroke painting operations for paths and glyph outlines.
More...
 
def GetTextObject ()
 Get the text graphics object if current graphics object represents a text object.
More...
 
def GetType ()
 Get the type of current graphics object.
More...
 
def HasTransparency ()
 Check whether current graphics object has transparency or not.
More...
 
def Release ()
 Release a cloned or newly created PDF graphics object which has not been inserted into any PDF page or other object.
More...
 
def RemoveClipPath (index)
 Remove a path clip by index.
More...
 
def RemoveClipTextObject (index)
 Remove a text clip by index for clipping.
More...
 
def Rotate (angle)
 Rotate current graphics object from current state with specified angle degree in clockwise.
More...
 
def SetBlendMode (blend_mode)
 Set the blend mode for transparent imaging model.
More...
 
def SetClipRect (clip_rect)
 Set clip rectangle.
More...
 
def SetColorState (color_state)
 Set color state.
More...
 
def SetFillColor (color)
 Set the fill color.
More...
 
def SetFillOpacity (opacity)
 Set the opacity value for painting operations other than stroking.
More...
 
def SetGraphState (graph_state)
 Set graph state.
More...
 
def SetMatrix (matrix)
 Set matrix.
More...
 
def SetStrokeColor (color)
 Set the stroke color.
More...
 
def SetStrokeOpacity (opacity)
 Set opacity value for stroke painting operations for paths and glyph outlines.
More...
 
def Transform (matrix, need_transform_clippath)
 Transform current graphics object.
More...
 

Static Public Member Functions

def Create (dictionary)
 Create a new path graphics object.
More...
 
def CreateFromTextObject (page, text_obj)
 Create a path graphics object from a text object.
More...
 

Additional Inherited Members

- Static Public Attributes inherited from FoxitPDFSDKPython3.GraphicsObject
 e_BlendColor = _fsdk.GraphicsObject_e_BlendColor
 Creates a color with the hue and saturation of the source color, and the luminosity of the backdrop color.
More...
 
 e_BlendColorBurn = _fsdk.GraphicsObject_e_BlendColorBurn
 Darkens backdrop color to reflect the source color.
More...
 
 e_BlendColorDodge = _fsdk.GraphicsObject_e_BlendColorDodge
 Brightens backdrop color to reflect source colors.
More...
 
 e_BlendDarken = _fsdk.GraphicsObject_e_BlendDarken
 Select darker one of backdrop and source colors.
More...
 
 e_BlendDifference = _fsdk.GraphicsObject_e_BlendDifference
 Subtracts the darker of the two constituent colors from lighter colors.
More...
 
 e_BlendExclusion = _fsdk.GraphicsObject_e_BlendExclusion
 Creates a color with the hue of the source color, and the saturation and luminosity of the backdrop color.
More...
 
 e_BlendHardlight = _fsdk.GraphicsObject_e_BlendHardlight
 Multiply or screens colors, depending on source color value.
More...
 
 e_BlendHue = _fsdk.GraphicsObject_e_BlendHue
 Creates a color with the hue of the source color, and the saturation and luminosity of the backdrop color.
More...
 
 e_BlendLighten = _fsdk.GraphicsObject_e_BlendLighten
 Select lighter one of backdrop and source colors.
More...
 
 e_BlendLuminosity = _fsdk.GraphicsObject_e_BlendLuminosity
 Creates a color with the luminosity of the source color, and the hue and saturation of the backdrop color.
More...
 
 e_BlendMultiply = _fsdk.GraphicsObject_e_BlendMultiply
 Multiply backdrop by source color values.
More...
 
 e_BlendNormal = _fsdk.GraphicsObject_e_BlendNormal
 Selecting source color and ignoring backdrop color.
More...
 
 e_BlendOverlay = _fsdk.GraphicsObject_e_BlendOverlay
 Multiply or screens colors, depending on backdrop color value.
More...
 
 e_BlendSaturation = _fsdk.GraphicsObject_e_BlendSaturation
 Creates a color with the saturation of the source color, and the hue and luminosity of the backdrop color.
More...
 
 e_BlendScreen = _fsdk.GraphicsObject_e_BlendScreen
 Multiply complements of backdrop by source color values, and then complement the result.
More...
 
 e_BlendSoftlight = _fsdk.GraphicsObject_e_BlendSoftlight
 Darkens or lightens colors, depending on source color value.
More...
 
 e_TypeAll = _fsdk.GraphicsObject_e_TypeAll
 Represents all graphics object types, only used as filter.

 
 e_TypeFormXObject = _fsdk.GraphicsObject_e_TypeFormXObject
 Form XObject graphics object.

 
 e_TypeImage = _fsdk.GraphicsObject_e_TypeImage
 Image graphics object.

 
 e_TypePath = _fsdk.GraphicsObject_e_TypePath
 Path graphics object.

 
 e_TypeShading = _fsdk.GraphicsObject_e_TypeShading
 Shading graphics object.

 
 e_TypeText = _fsdk.GraphicsObject_e_TypeText
 Text graphics object.

 

Detailed Description

Path graphics object is a kind of PDF graphics object, so class PathObject is derived from class GraphicsObject . It offers functions to get/set path graphics object's data.
To create a new path graphics object, please use function FoxitPDFSDKPython3.PathObject.Create and then use setting functions to set information to the new path graphics object. Function FoxitPDFSDKPython3.PathObject.CreateFromTextObject can be used to create a path graphics object from a text graphics object.

See also
GraphicsObject

Member Function Documentation

◆ Create()

FoxitPDFSDKPython3.PathObject.Create (   dictionary)
static

Create a new path graphics object.

The newly created path graphics object does not have any data yet. Then, setting functions can be called to set data to the new path graphics object. If the newly created path graphics object will not inserted to any page or other objects, please remember to call function FoxitPDFSDKPython3.GraphicsObject.Release to release it when no use.

Returns
A new path graphics object. If there is any error, this function will return null.

◆ CreateFromTextObject()

FoxitPDFSDKPython3.PathObject.CreateFromTextObject (   page,
  text_obj 
)
static

Create a path graphics object from a text object.

If the newly created path graphics object will not inserted to any page or other objects, please remember to call function FoxitPDFSDKPython3.GraphicsObject.Release to release it when no use.

Parameters
[in]pageA valid PDF page object.
[in]text_objA text graphics object. It should not be null. Please ensure the text graphics object is in the PDF page specified by parameter page.
Returns
A new path graphics object. If there is any error, this function will return null.

◆ GetFillMode()

def FoxitPDFSDKPython3.PathObject.GetFillMode ( )

Get fill mode.

Returns
Fill mode. Please refer to values starting from FoxitPDFSDKPython3.e_FillModeNone and this would be one of these values.

◆ GetPathData()

def FoxitPDFSDKPython3.PathObject.GetPathData ( )

Get the path data.

Returns
Path data. If the return value of function FoxitPDFSDKPython3.Path.IsEmpty for the returned path object is true, that means there is any error.

◆ GetStrokeState()

def FoxitPDFSDKPython3.PathObject.GetStrokeState ( )

Get stroke state.

Returns
true means current path graphics object is stroked, and false means current path graphics object is not stroked.

◆ SetFillMode()

def FoxitPDFSDKPython3.PathObject.SetFillMode (   fill_mode)

Set fill mode.

Parameters
[in]fill_modeFill mode. Please refer to values starting from FoxitPDFSDKPython3.e_FillModeNone and this should be one of these values.
Returns
None.
Note
When this function succeeds, function FoxitPDFSDKPython3.GraphicsObjects.GenerateContent should be called. Please refer to function FoxitPDFSDKPython3.GraphicsObjects.GenerateContent for more details.

◆ SetPathData()

def FoxitPDFSDKPython3.PathObject.SetPathData (   path_data)

Set the path data.

Parameters
[in]path_dataA valid path object which represents the path data to be set.
Returns
None.
Note
When this function succeeds, function FoxitPDFSDKPython3.GraphicsObjects.GenerateContent should be called. Please refer to function FoxitPDFSDKPython3.GraphicsObjects.GenerateContent for more details.

◆ SetStrokeState()

def FoxitPDFSDKPython3.PathObject.SetStrokeState (   is_stroke)

Set stroke state.

Parameters
[in]is_stroketrue means current path graphics object is to be stroked. false means current path graphics object is not to be stroked.
Returns
None.
Note
When this function succeeds, function FoxitPDFSDKPython3.GraphicsObjects.GenerateContent should be called. Please refer to function FoxitPDFSDKPython3.GraphicsObjects.GenerateContent for more details.