IliDataGem Class Reference

Gadget class. More...

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

Inheritance diagram for IliDataGem:

List of all members.

Public Member Functions
virtual IlvBitmap *	getBitmap () const
	Returns the bitmap that is displayed during the design phase in Rogue Wave Views Data Access.
IlBoolean	hasGlobalScope () const
	Returns IlFalse if the scope of the name of the data gem is limited to the container in which it is located.
IlBoolean	isSystemUsage () const
	Returns IlTrue if the object is used by the system.
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.
virtual void	usedBySystem (IlBoolean usage)
	Specifies if the object is a system object.
Protected Member Functions
	IliDataGem (IlvDisplay *display, const IlvPoint &at, IlUShort thickness=IlvDefaultGadgetThickness, IlvPalette *palette=0)
	The constructor initializes a data gem.

---

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

---

Constructor & Destructor Documentation

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

The constructor initializes a data gem.

This constructor is protected.

Parameters:

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

---

Member Function Documentation

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 IliDataSource, IliDbTimer, IliHTMLReporter, IliXML, IliMemoryDataSource, and IliSQLDataSource.

IlBoolean IliDataGem::hasGlobalScope

(

)

const

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

Returns:

The data source scope.

IlBoolean IliDataGem::isSystemUsage

(

)

const

Returns IlTrue if the object is used by the system.

Returns:

The system usage flag.

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.

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.