ColorHandle Class Reference

Represents a color value for annotations and other PDF elements. More...

Inheritance diagram for ColorHandle:

error_type CALLING_CONVENTION	Color_CreateTransparent (ColorHandle **result)
	Create a transparent color (no color)
error_type CALLING_CONVENTION	Color_CreateGray (real_type gray, ColorHandle **result)
	Create a grayscale color.
error_type CALLING_CONVENTION	Color_CreateRGB (real_type red, real_type green, real_type blue, ColorHandle **result)
	Create an RGB color.
error_type CALLING_CONVENTION	Color_CreateCMYK (real_type cyan, real_type magenta, real_type yellow, real_type black, ColorHandle **result)
	Create a CMYK color.
error_type CALLING_CONVENTION	Color_GetColorSpace (ColorHandle *handle, ColorSpaceType *result)
	Get the color space type.
error_type CALLING_CONVENTION	Color_GetRed (ColorHandle *handle, real_type *result)
	Get the red component (for RGB colors)
error_type CALLING_CONVENTION	Color_GetGreen (ColorHandle *handle, real_type *result)
	Get the green component (for RGB colors)
error_type CALLING_CONVENTION	Color_GetBlue (ColorHandle *handle, real_type *result)
	Get the blue component (for RGB colors)
error_type CALLING_CONVENTION	Color_GetGray (ColorHandle *handle, real_type *result)
	Get the gray component (for grayscale colors)
error_type CALLING_CONVENTION	Color_GetCyan (ColorHandle *handle, real_type *result)
	Get the cyan component (for CMYK colors)
error_type CALLING_CONVENTION	Color_GetMagenta (ColorHandle *handle, real_type *result)
	Get the magenta component (for CMYK colors)
error_type CALLING_CONVENTION	Color_GetYellow (ColorHandle *handle, real_type *result)
	Get the yellow component (for CMYK colors)
error_type CALLING_CONVENTION	Color_GetBlack (ColorHandle *handle, real_type *result)
	Get the black component (for CMYK colors)
error_type CALLING_CONVENTION	Color_ToUnknown (ColorHandle *handle, IUnknownHandle **result)
	Reinterpret current object as IUnknownHandle.
error_type CALLING_CONVENTION	Color_FromUnknown (IUnknownHandle *handle, ColorHandle **result)
	Convert IUnknownHandle to ColorHandle.
error_type CALLING_CONVENTION	Color_Release (ColorHandle *handle)
	Decrement the internal reference counter.

Additional Inherited Members
Public Member Functions inherited from IUnknownHandle
error_type CALLING_CONVENTION	IUnknown_AddRef (IUnknownHandle *handle)
	Increment the internal reference counter.
Related Symbols inherited from IUnknownHandle
error_type CALLING_CONVENTION	IUnknown_Release (IUnknownHandle *handle)
	Decrement the internal reference counter.

Detailed Description

Represents a color value for annotations and other PDF elements.

Friends And Related Symbol Documentation

Color_CreateGray()

error_type CALLING_CONVENTION Color_CreateGray ( real_type  gray, ColorHandle **  result  )

related

Create a grayscale color.

Parameters

gray	the gray component (0.0 to 1.0)
result	a pointer to variable that will contain the new color upon success

Color_CreateRGB()

error_type CALLING_CONVENTION Color_CreateRGB ( real_type  red, real_type  green, real_type  blue, ColorHandle **  result  )

related

Create an RGB color.

Parameters

red	the red component (0.0 to 1.0)
green	the green component (0.0 to 1.0)
blue	the blue component (0.0 to 1.0)
result	a pointer to variable that will contain the new color upon success

Color_CreateCMYK()

error_type CALLING_CONVENTION Color_CreateCMYK ( real_type  cyan, real_type  magenta, real_type  yellow, real_type  black, ColorHandle **  result  )

related

Create a CMYK color.

Parameters

cyan	the cyan component (0.0 to 1.0)
magenta	the magenta component (0.0 to 1.0)
yellow	the yellow component (0.0 to 1.0)
black	the black component (0.0 to 1.0)
result	a pointer to variable that will contain the new color upon success

Color_Release()

error_type CALLING_CONVENTION Color_Release ( ColorHandle *  handle )

related

Decrement the internal reference counter.

When the internal counter reaches zero the object is deleted. Releasing already disposed object causes undefined behavior.

See also

IUnknown_Release

---

The documentation for this class was generated from the following file:

• c_color.h