CImagePluginCapability_interface.h File Reference

Interface for CImagePluginCapability wrapper. More...

Go to the source code of this file.

Functions
CImagePluginCapability	CImagePluginCapability_Create (idrs_exception *pargException)
	Creates a new CImagePluginCapability object.
CImagePluginCapability	CImagePluginCapability_Create2 (enum ImageFormat const ffFileFormat, IDRS_BOOL const bCanSaveFormat, IDRS_BOOL const bCanLoadFormat, const CImageSaveOptions argImageSaveOptions, idrs_exception *pargException)
	Creates a new CImagePluginCapability object.
enum ImageFormat	CImagePluginCapability_GetFileFormat (const CImagePluginCapability argCImagePluginCapability, idrs_exception *pargException)
	Gets the file format set.
void	CImagePluginCapability_SetFileFormat (CImagePluginCapability argCImagePluginCapability, enum ImageFormat const ffFileFormat, idrs_exception *pargException)
	Sets the file format for the capability.
IDRS_BOOL	CImagePluginCapability_GetCanSave (const CImagePluginCapability argCImagePluginCapability, idrs_exception *pargException)
	Returns the flag specifying if the current capability supports saving operation.
void	CImagePluginCapability_SetCanSave (CImagePluginCapability argCImagePluginCapability, IDRS_BOOL const bValue, idrs_exception *pargException)
	Sets the flag specifying if the current capability supports saving operation.
IDRS_BOOL	CImagePluginCapability_GetCanLoad (const CImagePluginCapability argCImagePluginCapability, idrs_exception *pargException)
	Returns the flag specifying if the current capability supports loading operation.
void	CImagePluginCapability_SetCanLoad (CImagePluginCapability argCImagePluginCapability, IDRS_BOOL const bValue, idrs_exception *pargException)
	Sets the flag specifying if the current capability supports loading operation.
const CImageSaveOptions	CImagePluginCapability_GetImageSaveOptions (const CImagePluginCapability argCImagePluginCapability, idrs_exception *pargException)
	Gets the CImageSaveOptions object associated with the current capability.
void	CImagePluginCapability_SetImageSaveOptions (CImagePluginCapability argCImagePluginCapability, const CImageSaveOptions argImageSaveOptions, idrs_exception *pargException)
	Sets the CImageSaveOptions object associated with the current capability.
void	CImagePluginCapability_Destroy (CImagePluginCapability argCImagePluginCapability, idrs_exception *pargException)
	Destroys a CImagePluginCapability handle.

Detailed Description

Interface for CImagePluginCapability wrapper.

Function Documentation

CImagePluginCapability_Create()

CImagePluginCapability CImagePluginCapability_Create

(

idrs_exception *

pargException

)

Creates a new CImagePluginCapability object.

Returns

The newly created CImagePluginCapability object

Parameters

pargException

Pointer to exception structure that will be filled if an exception occurs

CImagePluginCapability_Create2()

CImagePluginCapability CImagePluginCapability_Create2	(	enum ImageFormat const	ffFileFormat,
		IDRS_BOOL const	bCanSaveFormat,
		IDRS_BOOL const	bCanLoadFormat,
		const CImageSaveOptions	argImageSaveOptions,
		idrs_exception *	pargException
	)

Creates a new CImagePluginCapability object.

Parameters

ffFileFormat	The file format
bCanSaveFormat	Flag specifying whether save operation is supported
bCanLoadFormat	Flag specifying whether load operation is supported
argImageSaveOptions	Image options object usually contains information about the compression or color mode to be used
pargException	Pointer to exception structure that will be filled if an exception occurs

Returns

The newly created CImagePluginCapability object

See also

ImageFormat

CImageSaveOptions

CImagePluginCapability_Destroy()

void CImagePluginCapability_Destroy	(	CImagePluginCapability	argCImagePluginCapability,
		idrs_exception *	pargException
	)

Destroys a CImagePluginCapability handle.

Parameters

argCImagePluginCapability	CImagePluginCapability handle to destroy
pargException	Pointer to exception structure that will be filled if an exception occurs

CImagePluginCapability_GetCanLoad()

IDRS_BOOL CImagePluginCapability_GetCanLoad	(	const CImagePluginCapability	argCImagePluginCapability,
		idrs_exception *	pargException
	)

Returns the flag specifying if the current capability supports loading operation.

Returns

IDRS_TRU if the load operation is implemented, IDRS_FALSE otherwise

Parameters

argCImagePluginCapability	CImagePluginCapability handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CImagePluginCapability_GetCanSave()

IDRS_BOOL CImagePluginCapability_GetCanSave	(	const CImagePluginCapability	argCImagePluginCapability,
		idrs_exception *	pargException
	)

Returns the flag specifying if the current capability supports saving operation.

Returns

IDRS_TRUE if the save operation is implemented, IDRS_FALSE otherwise

Parameters

argCImagePluginCapability	CImagePluginCapability handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CImagePluginCapability_GetFileFormat()

enum ImageFormat CImagePluginCapability_GetFileFormat	(	const CImagePluginCapability	argCImagePluginCapability,
		idrs_exception *	pargException
	)

Gets the file format set.

Returns

The file format

See also

ImageFormat

Parameters

argCImagePluginCapability	CImagePluginCapability handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CImagePluginCapability_GetImageSaveOptions()

const CImageSaveOptions CImagePluginCapability_GetImageSaveOptions	(	const CImagePluginCapability	argCImagePluginCapability,
		idrs_exception *	pargException
	)

Gets the CImageSaveOptions object associated with the current capability.

The CImageSaveOptions object usually contains information like the color mode or the image compression algorithm to be used.

Returns

The CImageSaveOptions object

See also

CImageSaveOptions and derived classes

Parameters

argCImagePluginCapability	CImagePluginCapability handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CImagePluginCapability_SetCanLoad()

void CImagePluginCapability_SetCanLoad	(	CImagePluginCapability	argCImagePluginCapability,
		IDRS_BOOL const	bValue,
		idrs_exception *	pargException
	)

Sets the flag specifying if the current capability supports loading operation.

Parameters

argCImagePluginCapability	CImagePluginCapability handle
bValue	Boolean flag
pargException	Pointer to exception structure that will be filled if an exception occurs

CImagePluginCapability_SetCanSave()

void CImagePluginCapability_SetCanSave	(	CImagePluginCapability	argCImagePluginCapability,
		IDRS_BOOL const	bValue,
		idrs_exception *	pargException
	)

Sets the flag specifying if the current capability supports saving operation.

Parameters

argCImagePluginCapability	CImagePluginCapability handle
bValue	Boolean flag
pargException	Pointer to exception structure that will be filled if an exception occurs

CImagePluginCapability_SetFileFormat()

void CImagePluginCapability_SetFileFormat	(	CImagePluginCapability	argCImagePluginCapability,
		enum ImageFormat const	ffFileFormat,
		idrs_exception *	pargException
	)

Sets the file format for the capability.

Parameters

argCImagePluginCapability	CImagePluginCapability handle
ffFileFormat	The file format
pargException	Pointer to exception structure that will be filled if an exception occurs

See also

ImageFormat

CImagePluginCapability_SetImageSaveOptions()

void CImagePluginCapability_SetImageSaveOptions	(	CImagePluginCapability	argCImagePluginCapability,
		const CImageSaveOptions	argImageSaveOptions,
		idrs_exception *	pargException
	)

Sets the CImageSaveOptions object associated with the current capability.

Parameters

argCImagePluginCapability	CImagePluginCapability handle
argImageSaveOptions	The CImageSaveOptions object
pargException	Pointer to exception structure that will be filled if an exception occurs

See also

CImageSaveOptions and derived classes