IliDbPicture Class Reference

Field picture class. More...

#include <ilviews/dataccess/gadgets/dbpictur.h>

Inheritance diagram for IliDbPicture:

List of all members.

Public Member Functions
	IliDbPicture (IlvDisplay *display, const IlvPoint &at, IlvBitmap *bitmap, IlUShort thickness=IlvDefaultGadgetThickness, IlvPalette *palette=0)
	Initialize a new IliDbPicture instance.
	IliDbPicture (IlvDisplay *display, IlvBitmap *bitmap, const IlvRect &rect, IlUShort thickness=IlvDefaultGadgetThickness, IlvPalette *palette=0)
	Initializes a new IliDbPicture instance.
	IliDbPicture (IlvDisplay *display, const IlvPoint &at, const char *bitmapName, IlUShort thickness=IlvDefaultGadgetThickness, IlvPalette *palette=0)
	Initializes a new IliDbPicture instance.
	IliDbPicture (IlvDisplay *display, const char *bitmapName, const IlvRect &rect, IlUShort thickness=IlvDefaultGadgetThickness, IlvPalette *palette=0)
	Initializes a new IliDbPicture instance.
void	enableTransparentColor (IlBoolean enable)
	Enables/Disables the transparent color usage.
virtual IlBoolean	f_externalToInternal ()
	Updates the internal value of a field according to its current external representation.
virtual IlvAlignment	f_getAlignment () const
	Returns the text alignment of the field.
virtual const IliValue &	f_getValue (IlBoolean internalP=IlFalse) const
	Returns the value of the field.
virtual void	f_internalToExternal ()
	Updates the external representation of the field and its display according to its current internal value.
virtual IlBoolean	f_isConsistent () const
	Returns IlTrue if the internal value of the field corresponds to its current external representation.
virtual IlBoolean	f_isReadOnly () const
	Returns IlTrue if the field is read-only.
virtual void	f_setAlignment (IlvAlignment)
	Sets the text alignment of the field.
virtual void	f_setReadOnly (IlBoolean)
	Sets the read-only property for the field.
virtual IlBoolean	f_setValue (const IliValue &, IlBoolean internalP=IlFalse)
	Sets the value of the field.
virtual IlBoolean	f_supportsTableProperties () const
	Returns IlTrue if this gadget supports table properties.
IlvBitmap *	getBitmap () const
	Returns the bitmap displayed by this gadget.
const char *	getBitmapName () const
	Returns the file name of the displayed bitmap.
IlBoolean	isAdjustedBitmap () const
	Returns IlTrue if the bitmap is stretched in the gadget rectangle.
IlBoolean	isBitmapType ()
	Returns IlTrue if the value is a bitmap.
IlBoolean	isStringType ()
	Returns IlTrue if the value is a bitmap file name.
IlBoolean	isTransparentColorEnabled () const
	Returns IlTrue if the transparent color is enabled.
void	setAdjustedBitmap (IlBoolean adj)
	Stretches the bitmap in the rectangle of the gadget.
void	setBitmap (IlvBitmap *bmp)
	Sets the bitmap displayed by this gadget.
IlBoolean	setBitmapName (const char *name, IlBoolean readbmp=IlTrue)
	Sets the file name of the bitmap displayed by this gadget.
void	setBitmapType (IlBoolean str)
	Sets value type.

---

Detailed Description

Field picture class.

Library: dbgadget

The IliDbPicture class defines a gadget to display a picture. This gadget can be linked to a data source.

See also:

IlvBitmap.

---

Constructor & Destructor Documentation

IliDbPicture::IliDbPicture	(	IlvDisplay *	display,
		const char *	bitmapName,
		const IlvRect &	rect,
		IlUShort	thickness = IlvDefaultGadgetThickness,
		IlvPalette *	palette = 0
	)

Initializes a new IliDbPicture instance.

Parameters:

	display	The display.
	bitmapName	The bitmap file name.
	rect	The location.
	thickness	The border thickness.
	palette	The palette.

IliDbPicture::IliDbPicture	(	IlvDisplay *	display,
		const IlvPoint &	at,
		const char *	bitmapName,
		IlUShort	thickness = IlvDefaultGadgetThickness,
		IlvPalette *	palette = 0
	)

Initializes a new IliDbPicture instance.

Parameters:

	display	The display.
	at	The position.
	bitmapName	The bitmap file name.
	thickness	The border thickness.
	palette	The palette.

IliDbPicture::IliDbPicture	(	IlvDisplay *	display,
		IlvBitmap *	bitmap,
		const IlvRect &	rect,
		IlUShort	thickness = IlvDefaultGadgetThickness,
		IlvPalette *	palette = 0
	)

Initializes a new IliDbPicture instance.

Parameters:

	display	The display.
	bitmap	The bitmap.
	rect	The location.
	thickness	The border thickness.
	palette	The palette.

IliDbPicture::IliDbPicture	(	IlvDisplay *	display,
		const IlvPoint &	at,
		IlvBitmap *	bitmap,
		IlUShort	thickness = IlvDefaultGadgetThickness,
		IlvPalette *	palette = 0
	)

Initialize a new IliDbPicture instance.

Parameters:

	display	The display.
	at	The position.
	bitmap	The bitmap.
	thickness	The border thickness.
	palette	The palette.

---

Member Function Documentation

void IliDbPicture::enableTransparentColor

(

IlBoolean

enable

)

Enables/Disables the transparent color usage.

Parameters:

enable

If IlTrue, the transparent color is enabled. The default value is IlFalse.

virtual IlBoolean IliDbPicture::f_externalToInternal

(

)

[virtual]

Updates the internal value of a field according to its current external representation.

Returns:

IlTrue if successful and IlFalse otherwise. Note that this may fail due to the fact that not all external representations can be converted to a value object. For example, this is especially true for text fields that are used to edit numeric or date values.

Reimplemented from IliFieldItf.

virtual IlvAlignment IliDbPicture::f_getAlignment

(

)

const [virtual]

Returns the text alignment of the field.

Returns:

The alignment.

Reimplemented from IliFieldItf.

virtual const IliValue& IliDbPicture::f_getValue

(

IlBoolean

internal = IlFalse

)

const [virtual]

Returns the value of the field.

Parameters:

internal

If IlTrue, the returned value does not necessarily reflect the state of the field as the user sees it.

Returns:

The value.

Reimplemented from IliFieldItf.

virtual IlBoolean IliDbPicture::f_isConsistent

(

)

const [virtual]

Returns IlTrue if the internal value of the field corresponds to its current external representation.

A return value of IlFalse means that the external representation of the field has been edited by the end-user since the last time one of the member functions, f_setValue, f_externalToInternal, f_internalToExternal or f_complete was successfully called.

Returns:

IlTrue if the internal value of the field corresponds to its current external representation.

Reimplemented from IliFieldItf.

virtual IlBoolean IliDbPicture::f_isReadOnly

(

)

const [virtual]

Returns IlTrue if the field is read-only.

Returns:

IlTrue if the field is read-only.

Reimplemented from IliFieldItf.

virtual void IliDbPicture::f_setAlignment

(

IlvAlignment

align

)

[virtual]

Sets the text alignment of the field.

Parameters:

align

The alignment.

Reimplemented from IliFieldItf.

virtual void IliDbPicture::f_setReadOnly

(

IlBoolean

flag

)

[virtual]

Sets the read-only property for the field.

Parameters:

flag

The read-only flag.

Reimplemented from IliFieldItf.

virtual IlBoolean IliDbPicture::f_setValue	(	const IliValue &	val,
		IlBoolean	internal = IlFalse
	)			[virtual]

Sets the value of the field.

Parameters:

	val	The value.
	internal	If IlFalse, then the external representation and the display of the field are automatically updated.

Returns:

IlTrue if successful, and IlFalse otherwise.

Reimplemented from IliFieldItf.

virtual IlBoolean IliDbPicture::f_supportsTableProperties

(

)

const [virtual]

Returns IlTrue if this gadget supports table properties.

Returns:

IlTrue if this gadget supports table properties.

Reimplemented from IliFieldItf.

IlvBitmap* IliDbPicture::getBitmap

(

)

const

Returns the bitmap displayed by this gadget.

Returns:

The bitmap.

const char* IliDbPicture::getBitmapName

(

)

const

Returns the file name of the displayed bitmap.

Returns:

The file name.

IlBoolean IliDbPicture::isAdjustedBitmap

(

)

const

Returns IlTrue if the bitmap is stretched in the gadget rectangle.

The default value is IlFalse.

Returns:

IlTrue if the bitmap is stretched in the gadget rectangle.

IlBoolean IliDbPicture::isBitmapType

(

)

Returns IlTrue if the value is a bitmap.

Returns:

IlTrue if the value is a bitmap.

IlBoolean IliDbPicture::isStringType

(

)

Returns IlTrue if the value is a bitmap file name.

Returns:

IlTrue if the value is a bitmap file name.

IlBoolean IliDbPicture::isTransparentColorEnabled

(

)

const

Returns IlTrue if the transparent color is enabled.

Returns:

IlTrue if the transparent color is enabled.

void IliDbPicture::setAdjustedBitmap

(

IlBoolean

adj

)

Stretches the bitmap in the rectangle of the gadget.

Parameters:

adj

If IlTrue, the bitmap is stretched in the rectangle of the gadget.

void IliDbPicture::setBitmap

(

IlvBitmap *

bmp

)

Sets the bitmap displayed by this gadget.

Parameters:

bmp

The bitmap.

IlBoolean IliDbPicture::setBitmapName	(	const char *	name,
		IlBoolean	readbmp = IlTrue
	)

Sets the file name of the bitmap displayed by this gadget.

Parameters:

	name	The bitmap file name.
	readbmp	If IlTrue, the file contents is read.

Returns:

IlFalse if the file name cannot be read.

void IliDbPicture::setBitmapType

(

IlBoolean

str

)

Sets value type.

Parameters:

str

If IlTrue, the value type is a bitmap file name. Otherwise it is a bitmap, however this type (bitmap) does not work when the gadget is connected to a data source, only the bitmap file name type works in this case.