Foxit PDF SDK
FoxitPDFSDKPython2.Color Class Reference
Inheritance diagram for FoxitPDFSDKPython2.Color:
FoxitPDFSDKPython2.Base

Public Member Functions

def Color ()
 Construct an empty color. More...
 
def ConvertToCMYK (intent)
 Convert to a CMYK color. More...
 
def ConvertToRGB (intent)
 Convert to a RGB color. More...
 
def GetColorSpace ()
 Get the color space that current color belongs to. More...
 
def GetValue ()
 Get component value array. More...
 
def IsEmpty ()
 Check whether current object is empty or not. More...
 
def SetValue (component_array)
 Set component value array. More...
 

Detailed Description

This class represents a color.

Constructor & Destructor Documentation

◆ Color()

def FoxitPDFSDKPython2.Color.Color ( )

Construct an empty color.

Constructor, with another color object.

Constructor, with a color space object.

Parameters
[in]color_spaceA valid color space object.
[in]otherAnother Color object.

Member Function Documentation

◆ ConvertToCMYK()

def FoxitPDFSDKPython2.Color.ConvertToCMYK (   intent)

Convert to a CMYK color.

Parameters
[in]intent(Reserved) Rendering intent used for color conversion.
Returns
Converted color. If the return value of function FoxitPDFSDKPython2.Color.IsEmpty for the returned color is true, that means the conversion failed.

◆ ConvertToRGB()

def FoxitPDFSDKPython2.Color.ConvertToRGB (   intent)

Convert to a RGB color.

Parameters
[in]intent(Reserved) Rendering intent used for color conversion.
Returns
Converted color. If the return value of function FoxitPDFSDKPython2.Color.IsEmpty for the returned color is true, that means the conversion failed.

◆ GetColorSpace()

def FoxitPDFSDKPython2.Color.GetColorSpace ( )

Get the color space that current color belongs to.

Returns
Color space object.

◆ GetValue()

def FoxitPDFSDKPython2.Color.GetValue ( )

Get component value array.

The count of components depends on the color space that current color belongs to. User can get the color space object by function FoxitPDFSDKPython2.Color.GetColorSpace , and then get the count of componets by function FoxitPDFSDKPython2.ColorSpace.GetComponentCount .

Returns
A component value array. Each component value would be in the range from 0.0 to 1.0.

◆ IsEmpty()

def FoxitPDFSDKPython2.Color.IsEmpty ( )

Check whether current object is empty or not.

When the current object is empty, that means current object is useless.

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

◆ SetValue()

def FoxitPDFSDKPython2.Color.SetValue (   component_array)

Set component value array.

The count of components depends on the color space that current color belongs to. User can get the color space object by function FoxitPDFSDKPython2.Color.GetColorSpace , and then get the count of componets by function FoxitPDFSDKPython2.ColorSpace.GetComponentCount .

Parameters
[in]component_arrayA component value array. The count of components in this array should match the count of components of the color space that current color belongs to. Valid range of each component value: from 0.0 to 1.0.
Returns
None.