Foxit PDF SDK
fsdk.PathObject Class Reference

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...
 

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 fsdk.PathObjectCreate and then use setting functions to set information to the new path graphics object. Function fsdk.PathObjectCreateFromTextObject can be used to create a path graphics object from a text graphics object.

See also
GraphicsObject

Member Function Documentation

◆ GetFillMode()

def fsdk.PathObject.GetFillMode ( )

Get fill mode.

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

◆ GetPathData()

def fsdk.PathObject.GetPathData ( )

Get the path data.

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

◆ GetStrokeState()

def fsdk.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 fsdk.PathObject.SetFillMode (   fill_mode)

Set fill mode.

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

◆ SetPathData()

def fsdk.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 fsdk.GraphicsObjects.GenerateContent should be called. Please refer to function fsdk.GraphicsObjects.GenerateContent for more details.

◆ SetStrokeState()

def fsdk.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 fsdk.GraphicsObjects.GenerateContent should be called. Please refer to function fsdk.GraphicsObjects.GenerateContent for more details.