IliDbPicture Class Reference

Field picture class. More...

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

Inheritance diagram for IliDbPicture:

Public Member Functions
	IliDbPicture (IlvDisplay *display, const char *bitmapName, const IlvRect &rect, IlUShort thickness=IlvDefaultGadgetThickness, IlvPalette *palette=0)
	Initializes a new IliDbPicture instance. More...
	IliDbPicture (IlvDisplay *display, const IlvPoint &at, const char *bitmapName, IlUShort thickness=IlvDefaultGadgetThickness, IlvPalette *palette=0)
	Initializes a new IliDbPicture instance. More...
	IliDbPicture (IlvDisplay *display, IlvBitmap *bitmap, const IlvRect &rect, IlUShort thickness=IlvDefaultGadgetThickness, IlvPalette *palette=0)
	Initializes a new IliDbPicture instance. More...
	IliDbPicture (IlvDisplay *display, const IlvPoint &at, IlvBitmap *bitmap, IlUShort thickness=IlvDefaultGadgetThickness, IlvPalette *palette=0)
	Initialize a new IliDbPicture instance. More...
void	enableTransparentColor (IlBoolean enable)
	Enables/Disables the transparent color usage. More...
virtual IlBoolean	f_externalToInternal ()
	Updates the internal value of a field according to its current external representation. More...
virtual IlvAlignment	f_getAlignment () const
	Returns the text alignment of the field. More...
virtual const IliValue &	f_getValue (IlBoolean internalP=IlFalse) const
	Returns the value of the field. More...
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. More...
virtual IlBoolean	f_isReadOnly () const
	Returns IlTrue if the field is read-only. More...
virtual void	f_setAlignment (IlvAlignment)
	Sets the text alignment of the field. More...
virtual void	f_setReadOnly (IlBoolean)
	Sets the read-only property for the field. More...
virtual IlBoolean	f_setValue (const IliValue &, IlBoolean internalP=IlFalse)
	Sets the value of the field. More...
virtual IlBoolean	f_supportsTableProperties () const
	Returns IlTrue if this gadget supports table properties. More...
IlvBitmap *	getBitmap () const
	Returns the bitmap displayed by this gadget. More...
const char *	getBitmapName () const
	Returns the file name of the displayed bitmap. More...
IlBoolean	isAdjustedBitmap () const
	Returns IlTrue if the bitmap is stretched in the gadget rectangle. More...
IlBoolean	isBitmapType ()
	Returns IlTrue if the value is a bitmap. More...
IlBoolean	isStringType ()
	Returns IlTrue if the value is a bitmap file name. More...
IlBoolean	isTransparentColorEnabled () const
	Returns IlTrue if the transparent color is enabled. More...
void	setAdjustedBitmap (IlBoolean adj)
	Stretches the bitmap in the rectangle of the gadget. More...
void	setBitmap (IlvBitmap *bmp)
	Sets the bitmap displayed by this gadget. More...
IlBoolean	setBitmapName (const char *name, IlBoolean readbmp=IlTrue)
	Sets the file name of the bitmap displayed by this gadget. More...
void	setBitmapType (IlBoolean str)
	Sets value type. More...
Public Member Functions inherited from IliFieldItf
void	f_applyReferences (IlvApplyObject f, IlAny a)
	Should be called when the applyReferences() member function, of the gadget class, is called. More...
virtual IlBoolean	f_complete ()
	Updates the internal value of the field, according to its current external representation and its foreign table, provided completion is enabled for the field. More...
virtual void	f_enableCompletion (IlBoolean flag)
	Sets the completion property of the field. More...
const IliDataSource *	f_getDataSource () const
	Returns the data source. More...
IliDataSource *	f_getDataSource ()
	Returns the data source. More...
const char *	f_getDataSourceColumnName () const
	Returns the name of the column. More...
const char *	f_getDataSourceName () const
	Returns the name of the data source, which this field is (or must be) connected to. More...
virtual const IliTablePropertyManager *	f_getEffectiveTablePropertyManager () const
	Returns the effective table property manager. More...
virtual IliTablePropertyManager *	f_getEffectiveTablePropertyManager ()
	Returns the effective table property manager. More...
const char *	f_getForeignDataSourceName () const
	Returns the name of the foreign data source. More...
const char *	f_getForeignDisplayColumnName () const
	Returns the name of the column of the foreign table that will serve as a result. More...
const IliTable *	f_getForeignTable () const
	Returns the foreign table. More...
IliTable *	f_getForeignTable ()
	Returns the foreign table. More...
const char *	f_getForeignValueColumnName () const
	Returns the name of the column of the foreign table that will serve as a key. More...
virtual const IliFormat &	f_getFormat () const
	Returns the format used to derive the external representation of the field from its internal value. More...
const IlvGadget *	f_getGadget () const
	Returns the constant gadget associated with this field through multiple inheritance. More...
IlvGadget *	f_getGadget ()
	Returns the gadget associated with this field through multiple inheritance. More...
const IlvGraphic *	f_getGraphic () const
	Returns the constant graphic associated with this field through multiple inheritance. More...
IlvGraphic *	f_getGraphic ()
	Returns the graphic associated with this field through multiple inheritance. More...
virtual const char *	f_getLabel () const
	Returns the label displayed by the field gadget. More...
virtual const IliInputMask &	f_getMask () const
	Returns the input mask used to edit values in the field. More...
virtual IlShort	f_getMaxLength () const
	Returns the maximum length allowed for the external representation of the field. More...
const char *	f_getTablePropertyManagerName () const
	Returns the name of the table property manager used by this field. More...
IlInt	f_getVisibleRowsCount () const
	Returns the number of rows that will be displayed when the foreign table is displayed. More...
virtual IlBoolean	f_hasLabel () const
	Returns IlTrue if the field gadget can display a label. More...
virtual void	f_ignoreModifiedState (IlBoolean ignore)
	Sets the ignore modified state attribute of the field. More...
virtual IlBoolean	f_isAutoFitPullDown () const
	Returns IlTrue if the width of the pull-down menu is automatically computed so that its contents fit. More...
IlBoolean	f_isCompletionEnabled () const
	Returns IlTrue if completion is enabled. More...
IlBoolean	f_isConnectedToDataSource () const
	Returns IlTrue if the field is currently connected to a column of a data source. More...
IlBoolean	f_isConstrained () const
	Returns IlTrue if the foreign table limits the set of possible internal values for this field. More...
IlBoolean	f_isDataSourceOwner () const
	Returns IlTrue if the field owns the data source. More...
IlBoolean	f_isForeignTableOwner () const
	Returns IlTrue if the field owns its foreign table. More...
virtual IlBoolean	f_isInputModified () const
	Returns IlTrue if the external representation has been edited by the end-user. More...
virtual IlBoolean	f_isModifiedStateIgnored () const
	Returns IlTrue if the modified states are ignored when the f_setValue() function is called. More...
IlBoolean	f_isUsingTableProperties () const
	Returns IlTrue if the field uses table properties. More...
void	f_killFocus ()
	Should be called when the gadget loses the focus.
virtual void	f_selectTextForAppend ()
	Deselects all the text and positions the editing caret at the end of the text, provided the field gadget supports text selection.
virtual void	f_selectTextForOverwrite ()
	Selects all the text, provided the field gadget supports text selection.
virtual void	f_setAutoFitPullDown (IlBoolean flag)
	Enables/disables the automatic width computing of the pull-down menu. More...
virtual void	f_setConstrained (IlBoolean flag)
	Sets the constrained property of the field. More...
virtual void	f_setDataSourceColumnName (const char *name)
	Sets the name of the column. More...
virtual void	f_setDataSourceName (const char *name)
	Sets the name of the data source. More...
void	f_setFocus ()
	Should be called when the gadget receives the focus.
virtual void	f_setForeignDataSourceName (const char *name)
	Sets the name of the foreign data source. More...
virtual void	f_setForeignDisplayColumnName (const char *name)
	Sets the name of the column of the foreign table that will serve as a result, when the table is used as a map to convert internal values into external representations. More...
virtual void	f_setForeignTable (IliTable *tbl, IlBoolean owner=IlFalse)
	Sets the foreign table of the field. More...
virtual void	f_setForeignValueColumnName (const char *name)
	Sets the name of the column of the foreign table that will serve as a key, when the table is used as a map to convert internal values into external representations. More...
virtual void	f_setFormat (const IliFormat &fmt)
	Sets the format used to derive the external representation of the field from its internal value. More...
virtual void	f_setInputModified (IlBoolean flag)
	Sets the input-modified attribute of the field. More...
virtual void	f_setLabel (const char *label)
	Sets the label of the field gadget. More...
virtual void	f_setMask (const IliInputMask &msk)
	Sets the input mask. More...
virtual void	f_setMaxLength (IlShort vmax)
	Sets the maximum length allowed for the external representation of the field. More...
virtual void	f_setTablePropertyManagerName (const char *name)
	Sets the name of the table property manager to use. More...
virtual void	f_setVisibleRowsCount (IlInt count)
	Sets the number of rows to be displayed when the foreign table is displayed. More...
virtual void	f_useTableProperties (IlBoolean flag)
	Enables/Disables the use of the table properties. More...

Additional Inherited Members
Static Public Member Functions inherited from IliFieldItf
static IlvSymbol *	InputModifiedSymbol ()
	Returns the name of the callback that the field gadget will invoke every time the field input-modified property changes from IlFalse to IlTrue. More...
Protected Member Functions inherited from IliFieldItf
void	f_read (IlvInputFile &input)
	Should be called by the stream-based constructor of the gadget. More...
void	f_set (IlvGraphic *g, const IliFieldItf &other)
	Should be called by the copy constructor of the graphic class that is passed. More...
void	f_setGraphic (IlvGraphic *g)
	Should be called by all constructors of the graphic class (except the copy constructor). More...
void	f_subscribe ()
	Should be called after the setHolder() member function of the gadget class.
void	f_unsubscribe ()
	Should be called before the setHolder() member function of the gadget class. More...
void	f_write (IlvOutputFile &output) const
	Should be called by the write() member function of the gadget class. More...

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.

Accessors

Accessors provide a scriptable and uniform way to inspect and modify an object by using its base class methods IlvValueInterface::queryValue(), IlvValueInterface::queryValues(), IlvValueInterface::changeValue(), IlvValueInterface::changeValues(). This class inherits the accessors of its superclasses IlvGadget and IliFieldItf, and adds the following ones:

Data accessors

Name	Type	Equivalent methods
adjust	Boolean	isAdjustedBitmap(), setAdjustedBitmap()
bitmapName	String	getBitmapName(), setBitmapName()
transparentColor	Boolean	isTransparentColorEnabled(), enableTransparentColor()

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.