Views
Data Access Package API Reference Guide
Product Documentation:
Views Documentation Home
List of all members | Public Member Functions | Protected Member Functions
IliDataGem Class Reference

Gadget class. More...

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

Inheritance diagram for IliDataGem:
IlvGadget IlvSimpleGraphic IlvStylable IlvGraphic IlvValueInterface IliDataSource IliDbTimer IliHTMLReporter IliXML IliMemoryDataSource IliSQLDataSource

Public Member Functions

virtual IlvBitmapgetBitmap () 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\nAccessors provide a scriptable and uniform way to inspect and modify an object by using its base class methods <tt>IlvValueInterface::queryValue()</tt>, <tt>IlvValueInterface::queryValues()</tt>, <tt>IlvValueInterface::changeValue()</tt>, <tt>IlvValueInterface::changeValues()</tt>.\n\n\nThis class inherits the accessors of its superclass \c 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
displayThe display.
atThe position.
thicknessThe border thickness.
paletteThe 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 IliSQLDataSource, IliMemoryDataSource, IliXML, IliHTMLReporter, IliDbTimer, and IliDataSource.

◆ 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
globalThe 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
usageThe system object flag.