gxImgExt Class Reference

Inheritance diagram for gxImgExt:

List of all members.

---

Detailed Description

Class for the extended image functions.

Public Member Functions
	gxImgExt () throw (gxError)
	Constructor.
bool	ColorAdjust (gxImage &image, float contrast=0, float brightness=0, float saturation=0, float gamma=1, int flags=0) throw (gxError)
	Makes contrast, brightness, saturation and gamma correction on the image.
bool	Contrast (gxImage &image, float contrast, int flags=0) throw (gxError)
	Makes contrast correction on the image.
bool	Brightness (gxImage &image, float brightness, int flags=0) throw (gxError)
	Makes brightness correction on the image.
bool	Saturation (gxImage &image, float saturation) throw (gxError)
	Makes saturation correction on the image.
bool	Gamma (gxImage &image, float gamma) throw (gxError)
	Makes gamma correction on the image.
bool	ColorMixer (gxImage &target, gxImage &source, int r1, int g1, int b1, int r2=0, int g2=0, int b2=0, int r3=0, int g3=0, int b3=0) throw (gxError)
	Changes the colors of the source image based on the weight parameters.
bool	Difference (gxImage &target, gxImage &source1, gxImage &source2) throw (gxError)
	Generates a differential image from two images.
bool	Transform (gxImage &target, gxImage &source, gxPG4 area) throw (gxError)
	Transforms a general area from the source image in the target image.
bool	FTransform (gxImage &target, gxImage &source, gxTrafo &trafo) throw (gxError)
	Fine transforms an image with the transformation described by the trafo.
bool	Compose (gxImage &target, gxImage &upper, gxImage &lower, gxPNT position, float alpha_u=1, float alpha_l=1, int flags=0) throw (gxError)
	Composes two images.
bool	DrawText (gxImage &image, const char *text, gxPNT position, const char *fonttype, int fontheight, int fontwidth, void *txtcolor, unsigned int flags) throw (gxError)
	Draw text on an image.
void	Dispose (void)
	It disposes the class.
bool	Open (const wchar_t *modulename, const wchar_t *groupname=(const wchar_t *) 0) throw (gxError)
	Opens a GX system compatible module (Unicode version).
bool	Open (const char *modulename, const char *groupname=(const char *) 0) throw (gxError)
	Opens a GX system compatible module (ASCII version).
bool	Open (gxInStr modulename, gxInStr groupname) throw (gxError)
	Opens a GX system compatible module (Unicode version).
bool	Open (gxInStr modulename) throw (gxError)
	Opens a GX system compatible module with the default properties (Unicode version).
bool	Open (gxInAStr modulename, gxInAStr groupname) throw (gxError)
	Opens a GX system compatible module (ASCII version).
bool	Open (gxInAStr modulename) throw (gxError)
	Opens a GX system compatible module with the default properties (ASCII version).
bool	Close (void) throw (gxError)
	Closes a previously opened module.
bool	IsValid (void) const
	Checks if the handle of the module is valid.
bool	GetInfo (const gxMODULEINFO **moduleinfo) throw (gxError)
	Gives information about an opened module.
bool	Call (int callcode, void *params)
	Calls a process of the module with its parameters.
bool	GetProperty (const wchar_t *name, wchar_t *string, int maxlen) throw (gxError)
	Gets a property of the specified module (Unicode version).
std::wstring	GetProperty (const wchar_t *name) throw (gxError)
	Gets a property of the specified module (Unicode version).
bool	GetProperty (const char *name, char *string, int maxlen) throw (gxError)
	Gets a property of the specified module (ASCII version).
std::string	GetProperty (const char *name) throw (gxError)
	Gets a property of the specified module (ASCII version).
gxOutStr	GetProperty (gxInStr name) throw (gxError)
	Gets a property of the specified module (Unicode version).
gxOutAStr	GetProperty (gxInAStr name) throw (gxError)
	Gets a property of the specified module (ASCII version).
bool	GetProperty (const wchar_t *name, int *ivalue) throw (gxError)
	Gets an integer property of the specified module (Unicode version).
bool	GetProperty (const char *name, int *ivalue) throw (gxError)
	Gets an integer property of the specified module (ASCII version).
bool	GetProperty (const wchar_t *name, double *fvalue) throw (gxError)
	Gets a floating-point property of the specified module (Unicode version).
bool	GetProperty (const char *name, double *fvalue) throw (gxError)
	Gets a floating-point property of the specified module (ASCII version).
int	GetPropertyInt (const wchar_t *name) throw (gxError)
	Gets an integer property of the specified module (Unicode version).
int	GetPropertyInt (gxInStr name) throw (gxError)
	Gets an integer property of the specified module (Unicode version).
int	GetPropertyInt (const char *name) throw (gxError)
	Gets an integer property of the specified module (ASCII version).
int	GetPropertyInt (gxInAStr name) throw (gxError)
	Gets an integer property of the specified module (ASCII version).
double	GetPropertyFloat (const wchar_t *name) throw (gxError)
	Gets a floating-point property of the specified module (Unicode version).
double	GetPropertyFloat (gxInStr name) throw (gxError)
	Gets a floating-point property of the specified module (Unicode version).
double	GetPropertyFloat (const char *name) throw (gxError)
	Gets a floating-point property of the specified module (ASCII version).
double	GetPropertyFloat (gxInAStr name) throw (gxError)
	Gets a floating-point property of the specified module (ASCII version).
bool	GetPropertyVersion (const wchar_t *name, unsigned int *version) throw (gxError)
	Gets a version property of the specified module (Unicode version).
unsigned int	GetPropertyVersion (const wchar_t *name) throw (gxError)
	Gets a version property of the specified module (Unicode version).
unsigned int	GetPropertyVersion (gxInStr name) throw (gxError)
	Gets a version property of the specified module (Unicode version).
bool	GetPropertyVersion (const char *name, unsigned int *version) throw (gxError)
	Gets a version property of the specified module (ASCII version).
unsigned int	GetPropertyVersion (const char *name) throw (gxError)
	Gets a version property of the specified module (ASCII version).
unsigned int	GetPropertyVersion (gxInAStr name) throw (gxError)
	Gets a version property of the specified module (ASCII version).
bool	SetProperty (const wchar_t *name, const wchar_t *string) throw (gxError)
	Sets a property of the specified module (Unicode version).
bool	SetProperty (const char *name, const char *string) throw (gxError)
	Sets a property of the specified module (ASCII version).
bool	SetProperty (gxInStr name, gxInStr str) throw (gxError)
	Sets a property of the specified module (Unicode version).
bool	SetProperty (gxInAStr name, gxInAStr str) throw (gxError)
	Sets a property of the specified module (ASCII version).
bool	SetProperty (const wchar_t *name, int ivalue) throw (gxError)
	Sets an integer property of the specified module (Unicode version).
bool	SetProperty (const char *name, int ivalue) throw (gxError)
	Sets an integer property of the specified module (ASCII version).
bool	SetProperty (gxInStr name, int ivalue) throw (gxError)
	Sets an integer property of the specified module (Unicode version).
bool	SetProperty (gxInAStr name, int ivalue) throw (gxError)
	Sets an integer property of the specified module (ASCII version).
bool	SetProperty (const wchar_t *name, double fvalue) throw (gxError)
	Sets a floating-point property of the specified module (Unicode version).
bool	SetProperty (const char *name, double fvalue) throw (gxError)
	Sets a floating-point property of the specified module (ASCII version).
bool	SetProperty (gxInStr name, double fvalue) throw (gxError)
	Sets a floating-point property of the specified module (Unicode version).
bool	SetProperty (gxInAStr name, double fvalue) throw (gxError)
	Sets a floating-point property of the specified module (ASCII version).
bool	SaveProperties (const wchar_t *name, int level=0) throw (gxError)
	Saves the properties of a module stored in the memory to a branch of the property tree stored on a mass storage device (Unicode version).
bool	SaveProperties (const char *name, int level=0) throw (gxError)
	Saves the properties of a module stored in the memory to a branch of the property tree stored on a mass storage device (ASCII version).
bool	SaveProperties (gxInStr name, int level) throw (gxError)
	Saves the properties of a module stored in the memory to a branch of the property tree stored on a mass storage device (Unicode version).
bool	SaveProperties (gxInStr name) throw (gxError)
	Saves the properties of a module stored in the memory to a branch of the property tree stored on a mass storage device (Unicode version).
bool	SaveProperties (gxInAStr name, int level=0) throw (gxError)
	Saves the properties of a module stored in the memory to a branch of the property tree stored on a mass storage device (ASCII version).
bool	MPStartTransaction (void)
	It starts the property transaction.
bool	MPCommit (void)
	It ends the property transaction and updates your changes to module.
Public Attributes
gxu32	handle
	Handle of the module.

---

Constructor & Destructor Documentation

gxImgExt

(

)

throw (gxError) [inline]

Constructor.

References gx_openmodule().

---

Member Function Documentation

bool ColorAdjust	(	gxImage &	image,
		float	contrast = 0,
		float	brightness = 0,
		float	saturation = 0,
		float	gamma = 1,
		int	flags = 0
	)			throw (gxError) [inline]

Makes contrast, brightness, saturation and gamma correction on the image.

The usual values for the adjusting values are between [-1, 1], the level change calculation can be expressed by the

new_level = (1+f)*old_level 

abstraction.

The value of -1 discards all the partial information, a value of 0 does not modify the image setting.

For the gamma correction other rules are applied. The value of 1 leaves the image unchanged.

Parameters:

	image	Image to process.
	contrast	Contrast adjust level.
	brightness	Brightness adjust level.
	saturation	Saturation adjust level.
	gamma	Gamma correction level.
	flags	Color adjusting flags, see GX_COLORADJUST_FLAGS.

Returns:

On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_coloradjust().

bool Contrast	(	gxImage &	image,
		float	contrast,
		int	flags = 0
	)			throw (gxError) [inline]

Makes contrast correction on the image.

The usual values for the adjusting values are between [-1, 1], the level change calculation can be expressed by the

new_level = (1+f)*old_level 

abstraction.

The value of -1 discards all the partial information, a value of 0 does not modify the image setting.

In case of adjusting more than one image color parameter the ColorAdjust() function should be called for performance reasons.

Parameters:

	image	Image to process.
	contrast	Contrast adjust level.
	flags	Color adjusting flags, see GX_COLORADJUST_FLAGS.

Returns:

On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_coloradjust().

bool Brightness	(	gxImage &	image,
		float	brightness,
		int	flags = 0
	)			throw (gxError) [inline]

Makes brightness correction on the image.

The usual values for the adjusting values are between [-1, 1].

The value of -1 results a black image, a value of 0 does not modify the image setting, and the value of 1 results a white image.

In case of adjusting more than one image color parameter the ColorAdjust() function should be called for performance reasons.

Parameters:

	image	Image to process.
	brightness	Brightness adjust level.
	flags	Color adjusting flags, see GX_COLORADJUST_FLAGS.

Returns:

On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_coloradjust().

bool Saturation	(	gxImage &	image,
		float	saturation
	)			throw (gxError) [inline]

Makes saturation correction on the image.

The usual values for the adjusting values are between [-1, 1], the level change calculation can be expressed by the

new_level = (1+f)*old_level 

abstraction.

The value of -1 discards all the partial information, a value of 0 does not modify the image setting.

In case of adjusting more than one image color parameter the ColorAdjust() function should be called for performance reasons.

Parameters:

	image	Image to process.
	saturation	Saturation adjust level.

Returns:

On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_coloradjust().

bool Gamma	(	gxImage &	image,
		float	gamma
	)			throw (gxError) [inline]

Makes gamma correction on the image.

In case of adjusting more than one image color parameter the ColorAdjust() function should be called for performance reasons.

Parameters:

	image	Image to process.
	gamma	Gamma correction level.

Returns:

On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_coloradjust().

bool ColorMixer	(	gxImage &	target,
		gxImage &	source,
		int	r1,
		int	g1,
		int	b1,
		int	r2 = 0,
		int	g2 = 0,
		int	b2 = 0,
		int	r3 = 0,
		int	g3 = 0,
		int	b3 = 0
	)			throw (gxError) [inline]

Changes the colors of the source image based on the weight parameters.

This function is an advanced image manipulating function that can be used in adaptive processes by setting the weights.

Note:

If only the first three weights are defined the resulted image will be a grayscale image.

Parameters:

	target	Preallocated image to return the result.
	source	Image to process.
	r1	Adaptable weight.
	g1	Adaptable weight.
	b1	Adaptable weight.
	r2	Adaptable weight.
	g2	Adaptable weight.
	b2	Adaptable weight.
	r3	Adaptable weight.
	g3	Adaptable weight.
	b3	Adaptable weight.

Returns:

On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_colormixer().

bool Difference	(	gxImage &	target,
		gxImage &	source1,
		gxImage &	source2
	)			throw (gxError) [inline]

Generates a differential image from two images.

Parameters:

	target	Preallocated image to return the result.
	source1	First image.
	source2	Second image.

Returns:

On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_imagedifference().

bool Transform	(	gxImage &	target,
		gxImage &	source,
		gxPG4	area
	)			throw (gxError) [inline]

Transforms a general area from the source image in the target image.

Parameters:

	target	Preallocated image to return the result.
	source	Image to process.
	area	General area defined on the source image.

Returns:

On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_imagetransform().

bool FTransform	(	gxImage &	target,
		gxImage &	source,
		gxTrafo &	trafo
	)			throw (gxError) [inline]

Fine transforms an image with the transformation described by the trafo.

Parameters:

	target	Preallocated image to return the result.
	source	Image to process.
	trafo	Transformation descriptor.

Returns:

On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_imageftransform().

bool Compose	(	gxImage &	target,
		gxImage &	upper,
		gxImage &	lower,
		gxPNT	position,
		float	alpha_u = 1,
		float	alpha_l = 1,
		int	flags = 0
	)			throw (gxError) [inline]

Composes two images.

Parameters:

	target	Preallocated image to return the result.
	upper	Upper image.
	lower	Lower image.
	position	Position of the upper image defined on the lower image.
	alpha_u	Alpha channel of the upper image.
	alpha_l	Alpha channel of the lower image.
	flags	Image composing flags, see GX_COMPOSE_FLAGS.

Returns:

On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_imagecompose().

bool DrawText	(	gxImage &	image,
		const char *	text,
		gxPNT	position,
		const char *	fonttype,
		int	fontheight,
		int	fontwidth,
		void *	txtcolor,
		unsigned int	flags
	)			throw (gxError) [inline]

Draw text on an image.

If no image given, create a grayscale image.

Parameters:

	image	Image to return the result.
	text	Text to draw.
	position	Position of the text on image.
	fonttype	Name of the fontface (WIN32) or path of the font file (LINUX).
	fontheight	Character height of the text in logical units.
	fontwidth	Average character width in logical units.
	txtcolor	Text color.
	flags	WIN32: see GX_TEXT_FLAGS.

Returns:

On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_drawtext().

void Dispose

(

void

)

[inline, inherited]

It disposes the class.

no base class.

Reimplemented in gxImage, gxLog, and gxTrafo.

Referenced by gxTrafo::Dispose(), gxLog::Dispose(), and gxImage::Dispose().

bool Open	(	const wchar_t *	modulename,
		const wchar_t *	groupname = (const wchar_t *)0
	)			throw (gxError) [inline, inherited]

Opens a GX system compatible module (Unicode version).

Parameters:

	modulename	Name of the module.
	groupname	Property place in the property tree.

Returns:

An exception is thrown or false is returned in case of error.

References gx_openmodule().

bool Open	(	const char *	modulename,
		const char *	groupname = (const char *)0
	)			throw (gxError) [inline, inherited]

Opens a GX system compatible module (ASCII version).

Parameters:

	modulename	Name of the module.
	groupname	Property place in the property tree.

Returns:

An exception is thrown or false is returned in case of error.

References gx_openmodule().

bool Open	(	gxInStr	modulename,
		gxInStr	groupname
	)			throw (gxError) [inline, inherited]

Opens a GX system compatible module (Unicode version).

Parameters:

	modulename	Name of the module.
	groupname	Property place in the property tree.

Returns:

An exception is thrown or false is returned in case of error.

References gx_openmodule().

bool Open

(

gxInStr

modulename

)

throw (gxError) [inline, inherited]

Opens a GX system compatible module with the default properties (Unicode version).

Parameters:

modulename

Name of the module.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxGZip, and gxZip.

References gx_openmodule().

bool Open	(	gxInAStr	modulename,
		gxInAStr	groupname
	)			throw (gxError) [inline, inherited]

Opens a GX system compatible module (ASCII version).

Parameters:

	modulename	Name of the module.
	groupname	Property place in the property tree.

Returns:

An exception is thrown or false is returned in case of error.

References gx_openmodulea().

bool Open

(

gxInAStr

modulename

)

throw (gxError) [inline, inherited]

Opens a GX system compatible module with the default properties (ASCII version).

Parameters:

modulename

Name of the module.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxGZip, and gxZip.

References gx_openmodulea().

bool Close

(

void

)

throw (gxError) [inline, inherited]

Closes a previously opened module.

It decreases the reference counter of the handle. The function closes the module if required (in case when the reference counter becames zero).

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxGZip, and gxZip.

References gx_unrefhandle(), and gxHandle::IsValid().

Referenced by gxHandle::operator=().

bool IsValid

(

void

)

const [inline, inherited]

Checks if the handle of the module is valid.

Returns:

In case of existing handle the return value is true.

Reimplemented in gxImage, gxTrafo, gxGZip, and gxZip.

Referenced by gxHandle::Close(), gxHandle::gxHandle(), gxImage::gxImage(), gxTrafo::gxTrafo(), gxZip::IsValid(), gxGZip::IsValid(), gxTrafo::IsValid(), and gxImage::IsValid().

bool GetInfo

(

const gxMODULEINFO **

moduleinfo

)

throw (gxError) [inline, inherited]

Gives information about an opened module.

Parameters:

moduleinfo

Pointer to an information structure pointer where the system returns the data of the specified module.

Returns:

An exception is thrown or false is returned in case of error.

References gx_getmoduleinfo().

bool Call	(	int	callcode,
		void *	params
	)			[inline, inherited]

Calls a process of the module with its parameters.

The functions and parameters usable inside the modules can be found in the documentation of the modules. The headers given with the modules contain inline functions, which make easier to access the functions of the module.

Parameters:

	callcode	Call code for the function (GX_CALL_xxx call codes).
	params	Parameters to give for the function (GX_PARM_xxx structures).

Returns:

Module defined, usually success is true.

References gx_call().

bool GetProperty	(	const wchar_t *	name,
		wchar_t *	string,
		int	maxlen
	)			throw (gxError) [inline, inherited]

Gets a property of the specified module (Unicode version).

Parameters:

	name	Name of the property.
	string	Pointer to a memory area where to store the value.
	maxlen	Size of memory area in characters (not bytes).

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_getmoduleproperty().

std::wstring GetProperty

(

const wchar_t *

name

)

throw (gxError) [inline, inherited]

Gets a property of the specified module (Unicode version).

Parameters:

name

Name of the property.

Returns:

Value of the property or an exception is thrown in case of error.

Reimplemented in gxProperty.

References gx_getmoduleproperty().

bool GetProperty	(	const char *	name,
		char *	string,
		int	maxlen
	)			throw (gxError) [inline, inherited]

Gets a property of the specified module (ASCII version).

Parameters:

	name	Name of the property.
	string	Pointer to a memory area where to store the value.
	maxlen	Size of memory area in characters (not bytes).

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_getmoduleproperty().

std::string GetProperty

(

const char *

name

)

throw (gxError) [inline, inherited]

Gets a property of the specified module (ASCII version).

Parameters:

name

Name of the property.

Returns:

Value of the property or an exception is thrown in case of error.

Reimplemented in gxProperty.

References gx_getmoduleproperty().

gxOutStr GetProperty

(

gxInStr

name

)

throw (gxError) [inline, inherited]

Gets a property of the specified module (Unicode version).

Parameters:

name

Name of the property.

Returns:

Value of the property or an exception is thrown in case of error.

Reimplemented in gxProperty.

References gx_getmoduleproperty().

gxOutAStr GetProperty

(

gxInAStr

name

)

throw (gxError) [inline, inherited]

Gets a property of the specified module (ASCII version).

Parameters:

name

Name of the property.

Returns:

Value of the property or an exception is thrown in case of error.

Reimplemented in gxProperty.

References gx_getmodulepropertya().

bool GetProperty	(	const wchar_t *	name,
		int *	ivalue
	)			throw (gxError) [inline, inherited]

Gets an integer property of the specified module (Unicode version).

Parameters:

	name	Name of the property.
	ivalue	Pointer to an integer where to store the value.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_getmodulepropertyint().

bool GetProperty	(	const char *	name,
		int *	ivalue
	)			throw (gxError) [inline, inherited]

Gets an integer property of the specified module (ASCII version).

Parameters:

	name	Name of the property.
	ivalue	Pointer to an integer where to store the value.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_getmodulepropertyinta().

bool GetProperty	(	const wchar_t *	name,
		double *	fvalue
	)			throw (gxError) [inline, inherited]

Gets a floating-point property of the specified module (Unicode version).

Parameters:

	name	Name of the property.
	fvalue	Pointer to a floating-point where to store the value.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_getmodulepropertyfloat().

bool GetProperty	(	const char *	name,
		double *	fvalue
	)			throw (gxError) [inline, inherited]

Gets a floating-point property of the specified module (ASCII version).

Parameters:

	name	Name of the property.
	fvalue	Pointer to a floating-point where to store the value.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_getmodulepropertyfloata().

int GetPropertyInt

(

const wchar_t *

name

)

throw (gxError) [inline, inherited]

Gets an integer property of the specified module (Unicode version).

Parameters:

name

Name of the property.

Returns:

The integer value of the property or an exception is thrown in case of error.

References gx_getmodulepropertyint().

int GetPropertyInt

(

gxInStr

name

)

throw (gxError) [inline, inherited]

Gets an integer property of the specified module (Unicode version).

Parameters:

name

Name of the property.

Returns:

The integer value of the property or an exception is thrown in case of error.

Reimplemented in gxProperty.

References gx_getmodulepropertyint().

int GetPropertyInt

(

const char *

name

)

throw (gxError) [inline, inherited]

Gets an integer property of the specified module (ASCII version).

Parameters:

name

Name of the property.

Returns:

The integer value of the property or an exception is thrown in case of error.

References gx_getmodulepropertyinta().

int GetPropertyInt

(

gxInAStr

name

)

throw (gxError) [inline, inherited]

Gets an integer property of the specified module (ASCII version).

Parameters:

name

Name of the property.

Returns:

The integer value of the property or an exception is thrown in case of error.

Reimplemented in gxProperty.

References gx_getmodulepropertyinta().

double GetPropertyFloat

(

const wchar_t *

name

)

throw (gxError) [inline, inherited]

Gets a floating-point property of the specified module (Unicode version).

Parameters:

name

Name of the property.

Returns:

The floating-point value of the property or an exception is thrown in case of error.

References gx_getmodulepropertyfloat().

double GetPropertyFloat

(

gxInStr

name

)

throw (gxError) [inline, inherited]

Gets a floating-point property of the specified module (Unicode version).

Parameters:

name

Name of the property.

Returns:

The floating-point value of the property or an exception is thrown in case of error.

Reimplemented in gxProperty.

References gx_getmodulepropertyfloat().

double GetPropertyFloat

(

const char *

name

)

throw (gxError) [inline, inherited]

Gets a floating-point property of the specified module (ASCII version).

Parameters:

name

Name of the property.

Returns:

The floating-point value of the property or an exception is thrown in case of error.

References gx_getmodulepropertyfloata().

double GetPropertyFloat

(

gxInAStr

name

)

throw (gxError) [inline, inherited]

Gets a floating-point property of the specified module (ASCII version).

Parameters:

name

Name of the property.

Returns:

The floating-point value of the property or an exception is thrown in case of error.

Reimplemented in gxProperty.

References gx_getmodulepropertyfloata().

bool GetPropertyVersion	(	const wchar_t *	name,
		unsigned int *	version
	)			throw (gxError) [inline, inherited]

Gets a version property of the specified module (Unicode version).

Parameters:

	name	Name of the property.
	version	Pointer to an integer where to store the version.

Returns:

An exception is thrown or false is returned in case of error.

References gx_getmodulepropertyversion().

unsigned int GetPropertyVersion

(

const wchar_t *

name

)

throw (gxError) [inline, inherited]

Gets a version property of the specified module (Unicode version).

Parameters:

name

Name of the property.

Returns:

The integer value of the property or an exception is thrown in case of error.

References gx_getmodulepropertyversion().

unsigned int GetPropertyVersion

(

gxInStr

name

)

throw (gxError) [inline, inherited]

Gets a version property of the specified module (Unicode version).

Parameters:

name

Name of the property.

Returns:

The integer value of the property or an exception is thrown in case of error.

References gx_getmodulepropertyversion().

bool GetPropertyVersion	(	const char *	name,
		unsigned int *	version
	)			throw (gxError) [inline, inherited]

Gets a version property of the specified module (ASCII version).

Parameters:

	name	Name of the property.
	version	Pointer to an integer where to store the version.

Returns:

An exception is thrown or false is returned in case of error.

References gx_getmodulepropertyversiona().

unsigned int GetPropertyVersion

(

const char *

name

)

throw (gxError) [inline, inherited]

Gets a version property of the specified module (ASCII version).

Parameters:

name

Name of the property.

Returns:

The integer value of the property or an exception is thrown in case of error.

References gx_getmodulepropertyversiona().

unsigned int GetPropertyVersion

(

gxInAStr

name

)

throw (gxError) [inline, inherited]

Gets a version property of the specified module (ASCII version).

Parameters:

name

Name of the property.

Returns:

The integer value of the property or an exception is thrown in case of error.

References gx_getmodulepropertyversiona().

bool SetProperty	(	const wchar_t *	name,
		const wchar_t *	string
	)			throw (gxError) [inline, inherited]

Sets a property of the specified module (Unicode version).

Parameters:

	name	Name of the property.
	string	Value of the property.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_setmoduleproperty().

bool SetProperty	(	const char *	name,
		const char *	string
	)			throw (gxError) [inline, inherited]

Sets a property of the specified module (ASCII version).

Parameters:

	name	Name of the property.
	string	Value of the property.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_setmodulepropertya().

bool SetProperty	(	gxInStr	name,
		gxInStr	str
	)			throw (gxError) [inline, inherited]

Sets a property of the specified module (Unicode version).

Parameters:

	name	Name of the property.
	str	Value of the property.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_setmoduleproperty().

bool SetProperty	(	gxInAStr	name,
		gxInAStr	str
	)			throw (gxError) [inline, inherited]

Sets a property of the specified module (ASCII version).

Parameters:

	name	Name of the property.
	str	Value of the property.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_setmodulepropertya().

bool SetProperty	(	const wchar_t *	name,
		int	ivalue
	)			throw (gxError) [inline, inherited]

Sets an integer property of the specified module (Unicode version).

Parameters:

	name	Name of the property.
	ivalue	An integer value of the property.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_setmodulepropertyint().

bool SetProperty	(	const char *	name,
		int	ivalue
	)			throw (gxError) [inline, inherited]

Sets an integer property of the specified module (ASCII version).

Parameters:

	name	Name of the property.
	ivalue	An integer value of the property.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_setmodulepropertyinta().

bool SetProperty	(	gxInStr	name,
		int	ivalue
	)			throw (gxError) [inline, inherited]

Sets an integer property of the specified module (Unicode version).

Parameters:

	name	Name of the property.
	ivalue	An integer value of the property.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_setmodulepropertyint().

bool SetProperty	(	gxInAStr	name,
		int	ivalue
	)			throw (gxError) [inline, inherited]

Sets an integer property of the specified module (ASCII version).

Parameters:

	name	Name of the property.
	ivalue	An integer value of the property.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_setmodulepropertyinta().

bool SetProperty	(	const wchar_t *	name,
		double	fvalue
	)			throw (gxError) [inline, inherited]

Sets a floating-point property of the specified module (Unicode version).

Parameters:

	name	Name of the property.
	fvalue	A floating-point value of the property.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_setmodulepropertyfloat().

bool SetProperty	(	const char *	name,
		double	fvalue
	)			throw (gxError) [inline, inherited]

Sets a floating-point property of the specified module (ASCII version).

Parameters:

	name	Name of the property.
	fvalue	A floating-point value of the property.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_setmodulepropertyfloata().

bool SetProperty	(	gxInStr	name,
		double	fvalue
	)			throw (gxError) [inline, inherited]

Sets a floating-point property of the specified module (Unicode version).

Parameters:

	name	Name of the property.
	fvalue	A floating-point value of the property.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_setmodulepropertyfloat().

bool SetProperty	(	gxInAStr	name,
		double	fvalue
	)			throw (gxError) [inline, inherited]

Sets a floating-point property of the specified module (ASCII version).

Parameters:

	name	Name of the property.
	fvalue	A floating-point value of the property.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_setmodulepropertyfloata().

bool SaveProperties	(	const wchar_t *	name,
		int	level = 0
	)			throw (gxError) [inline, inherited]

Saves the properties of a module stored in the memory to a branch of the property tree stored on a mass storage device (Unicode version).

Parameters:

	name	Place of property in the tree.
	level	Higher numbers give more details (0 = basic properties, 100 = all properties).

Returns:

An exception is thrown or false is returned in case of error.

References gx_savemoduleproperties().

bool SaveProperties	(	const char *	name,
		int	level = 0
	)			throw (gxError) [inline, inherited]

Saves the properties of a module stored in the memory to a branch of the property tree stored on a mass storage device (ASCII version).

Parameters:

	name	Place of property in the tree.
	level	Higher numbers give more details (0 = basic properties, 100 = all properties).

Returns:

An exception is thrown or false is returned in case of error.

References gx_savemoduleproperties().

bool SaveProperties	(	gxInStr	name,
		int	level
	)			throw (gxError) [inline, inherited]

Saves the properties of a module stored in the memory to a branch of the property tree stored on a mass storage device (Unicode version).

Parameters:

	name	Place of property in the tree.
	level	Higher numbers give more details (0 = basic properties, 100 = all properties).

Returns:

An exception is thrown or false is returned in case of error.

References gx_savemoduleproperties().

bool SaveProperties

(

gxInStr

name

)

throw (gxError) [inline, inherited]

Saves the properties of a module stored in the memory to a branch of the property tree stored on a mass storage device (Unicode version).

Parameters:

name

Place of property in the tree.

Returns:

An exception is thrown or false is returned in case of error.

References gx_savemoduleproperties().

bool SaveProperties	(	gxInAStr	name,
		int	level = 0
	)			throw (gxError) [inline, inherited]

Saves the properties of a module stored in the memory to a branch of the property tree stored on a mass storage device (ASCII version).

Parameters:

	name	Place of property in the tree.
	level	Higher numbers give more details (0 = basic properties, 100 = all properties).

Returns:

An exception is thrown or false is returned in case of error.

References gx_savemodulepropertiesa().

bool MPStartTransaction

(

void

)

[inline, inherited]

It starts the property transaction.

The module accepts but doesn't update properties (setmoduleproperty). You must use 'gx_mpcommit' to update these properties.

Warning:

Not supported by each module!

Returns:

An exception is thrown or false is returned in case of error.

References gx_mpstarttransaction().

bool MPCommit

(

void

)

[inline, inherited]

It ends the property transaction and updates your changes to module.

Warning:

Not supported by each module!

Returns:

An exception is thrown or false is returned in case of error.

References gx_mpcommit().

---

Member Data Documentation

gxu32 handle [inherited]

Handle of the module.

If it is zero, it is invalid.

See also:

gx_isvalidhandle()

Referenced by gx_closehandle(), gx_direct(), gx_isvalidhandle(), gxHandle::gxHandle(), gxImageHandler::gxImageHandler(), gxTrafoHandler::gxTrafoHandler(), and gxHandle::operator=().