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

Gadget class. More...

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

Inheritance diagram for IliDataSourcesUsesGadget:
IlvTreeGadget IliRepositoryService IlvScrolledGadget IlvTreeGadgetItemHolder IlvGadget IlvGadgetItemHolder IlvSimpleGraphic IlvStylable IlvGraphic IlvValueInterface

Public Member Functions

 IliDataSourcesUsesGadget (IlvDisplay *display, const IlvRect &rect, IlBoolean autoBuild, IlUShort thickness=IlvDefaultGadgetThickness, IlvPalette *palette=0)
 Initializes an IlvDataSourcesUsesGadget with the auto-build flag set to autoBuild (see the class IliRepositoryService). More...
 
 IliDataSourcesUsesGadget (IlvDisplay *display, const IlvRect &rect, IlUShort thickness=IlvDefaultGadgetThickness, IlvPalette *palette=0)
 Initializes an IlvDataSourcesUsesGadget with the auto-build flag set to IlTrue (see the class IliRepositoryService). More...
 
virtual void addDataSource (IliDataSource *)
 Called each time a valid data source has been found and must be displayed. More...
 
virtual IlvGraphicHoldergetSelectedHolder ()
 Returns the holder selected into the gadget. More...
 
virtual void justAfterBuild ()
 Called just after the data sources have been browsed. More...
 
virtual void justBeforeBuild ()
 Called just before data source browsing begins. More...
 
- Public Member Functions inherited from IliRepositoryService
 IliRepositoryService ()
 Initializes an instance of IliRepositoryService class. More...
 
 IliRepositoryService (IlBoolean autoBuild)
 Initializes an instance of IliRepositoryService class with your auto-build flag value. More...
 
virtual void build ()
 Manages data source browsing. More...
 
void filterOn (IliRepositFilterOn filter)
 Defines the filter for the holder type. More...
 
void firstBuild ()
 Calls the function build if the auto-build flag is at IlTrue, otherwise it does nothing. More...
 
const char * holderToName (IlvGraphicHolder *holder)
 Returns the holder name. More...
 
IlBoolean isAutoBuild () const
 Returns IlTrue if the auto-build flag is on. More...
 
IlBoolean isFilterOn (IliRepositFilterOn filter) const
 Returns IlTrue, if the filter is on a specific type. More...
 
IlBoolean isValidHolder (IlvGraphicHolder *, IlBoolean=IlTrue) const
 Returns IlTrue if the holder is valid. More...
 
void read (IlvInputFile &input)
 Reads the data from the input file stream. More...
 
void write (IlvOutputFile &output) const
 Writes the data to an output file stream. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from IliRepositoryService
static IliHolderToNameCallback GetHolderToNameCallback ()
 Returns the callback function used to get the holder's name. More...
 
static const char * GetUntitledString (IlvDisplay *)
 Returns the string Untitled. More...
 
static void SetHolderToNameCallback (IliHolderToNameCallback cb)
 Sets the callback function used to get the holder's name. More...
 
- Static Protected Member Functions inherited from IliRepositoryService
static IlvBitmapGetDataSourceBitmap (IlvDisplay *)
 Returns the bitmap of the data sources that are not global. More...
 
static IlvBitmapGetGlobalDataSourceBitmap (IlvDisplay *)
 Returns the bitmap of the data sources that are global. More...
 
static IlvBitmapGetHolderBitmap (IlvDisplay *)
 Returns the bitmap of the holders. More...
 

Detailed Description

Gadget class.

Library: dbgadget

The IliDataSourcesUsesGadget class defines a tree gadget class, which can display up to three levels of information for each valid data source of the application. The levels are:

Each data source has a bitmap showing if the data source is global. If the data source is global the bitmap is green. If the data source is not global, the bitmap is red.

See also
IliRepositoryService.

Constructor & Destructor Documentation

◆ IliDataSourcesUsesGadget() [1/2]

IliDataSourcesUsesGadget::IliDataSourcesUsesGadget ( IlvDisplay display,
const IlvRect rect,
IlUShort  thickness = IlvDefaultGadgetThickness,
IlvPalette palette = 0 
)

Initializes an IlvDataSourcesUsesGadget with the auto-build flag set to IlTrue (see the class IliRepositoryService).

Parameters
displayThe display.
rectThe location.
thicknessThe border thickness.
paletteThe palette.

◆ IliDataSourcesUsesGadget() [2/2]

IliDataSourcesUsesGadget::IliDataSourcesUsesGadget ( IlvDisplay display,
const IlvRect rect,
IlBoolean  autoBuild,
IlUShort  thickness = IlvDefaultGadgetThickness,
IlvPalette palette = 0 
)

Initializes an IlvDataSourcesUsesGadget with the auto-build flag set to autoBuild (see the class IliRepositoryService).

Parameters
displayThe display.
rectThe location.
autoBuildThe auto-build flag.
thicknessThe border thickness.
paletteThe palette.

Member Function Documentation

◆ addDataSource()

virtual void IliDataSourcesUsesGadget::addDataSource ( IliDataSource ds)
virtual

Called each time a valid data source has been found and must be displayed.

By default this function does nothing.

Parameters
dsThe data source.

Reimplemented from IliRepositoryService.

◆ getSelectedHolder()

virtual IlvGraphicHolder* IliDataSourcesUsesGadget::getSelectedHolder ( )
virtual

Returns the holder selected into the gadget.

By default, this function returns 0.

Returns
The holder.

Reimplemented from IliRepositoryService.

◆ justAfterBuild()

virtual void IliDataSourcesUsesGadget::justAfterBuild ( )
virtual

Called just after the data sources have been browsed.

By default this function does nothing.

Reimplemented from IliRepositoryService.

◆ justBeforeBuild()

virtual void IliDataSourcesUsesGadget::justBeforeBuild ( )
virtual

Called just before data source browsing begins.

By default this function does nothing.

Reimplemented from IliRepositoryService.