IliDataGem Class Reference

Gadget class. More...

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

Inheritance diagram for IliDataGem:

Public Member Functions
virtual IlvBitmap *	getBitmap () const
	Returns the bitmap that is displayed during the design phase in Rogue Wave Views Data Access. More...
IlBoolean	hasGlobalScope () const
	Indicates the data source scope. More...
IlBoolean	isSystemUsage () const
	Indicates the system usage flag. More...
virtual void	setGlobalScope (IlBoolean global)
	Specifies whether the scope of the name of the data gem is local to the container in which it is located or globally visible. More...
virtual void	usedBySystem (IlBoolean usage)
	Specifies if the object is a system object. More...

Protected Member Functions
	IliDataGem (IlvDisplay *display, const IlvPoint &at, IlUShort thickness=IlvDefaultGadgetThickness, IlvPalette *palette=0)
	Initializes a new data gem. More...

Detailed Description

Gadget class.

Library: dbgadget

The IliDataGem class defines gadgets that are only visible during the design phase in Rogue Wave Views Data Access. At run time, they cannot be seen by the user. This class serves as a base class for the IliDataSource class, for example.

See also

IliDataSource.

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 superclass IlvGadget and adds the following ones:

Data accessors

Name	Type	Equivalent methods
globalScope	Boolean	hasGlobalScope(), setGlobalScope()

Constructor & Destructor Documentation

IliDataGem()

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

protected

Initializes a new data gem.

Parameters

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

Member Function Documentation

getBitmap()

virtual IlvBitmap* IliDataGem::getBitmap ( ) const

virtual

Returns the bitmap that is displayed during the design phase in Rogue Wave Views Data Access.

Returns

The bitmap.

Reimplemented in IliXML, IliDataSource, IliHTMLReporter, IliDbTimer, IliMemoryDataSource, and IliSQLDataSource.

hasGlobalScope()

IlBoolean IliDataGem::hasGlobalScope

(

)

const

Indicates the data source scope.

Returns

IlFalse if the scope of the name of the data gem is limited to the container in which it is located.

isSystemUsage()

IlBoolean IliDataGem::isSystemUsage

(

)

const

Indicates the system usage flag.

Returns

Returns IlTrue if the object is used by the system.

setGlobalScope()

virtual void IliDataGem::setGlobalScope ( IlBoolean  global )

virtual

Specifies whether the scope of the name of the data gem is local to the container in which it is located or globally visible.

Parameters

global

The data source scope (IlTrue for global).

Reimplemented in IliDataSource.

usedBySystem()

virtual void IliDataGem::usedBySystem ( IlBoolean  usage )

virtual

Specifies if the object is a system object.

While users cannot see the system object, they can use it. By default, an object is not a system object.

Parameters

usage

The system object flag.