Interface class.
More...
#include <ilviews/dataccess/gadgets/repview.h>
Interface class.
Library: dbgadget
IliRepositoryService The IliRepositoryService
class defines a set of functions for the following classes:
These classes are gadgets that browse the list of valid data sources and that will later display information from these data sources. The IliRepositoryService
class manages the building of these gadget classes. These high-level functions concern holders, data sources, and browsing data sources.
◆ IliRepositoryService() [1/2]
IliRepositoryService::IliRepositoryService |
( |
| ) |
|
Initializes an instance of IliRepositoryService
class.
This constructor sets the auto-build flag to IlTrue
. Each gadget that inherits from this class must call the function firstBuild
in its constructor code. The function firstBuild
calls the functions to browse the data sources and displays the result if the auto-build flag is IlTrue
.
◆ IliRepositoryService() [2/2]
IliRepositoryService::IliRepositoryService |
( |
IlBoolean |
autoBuild | ) |
|
Initializes an instance of IliRepositoryService
class with your auto-build flag value.
This constructor sets the auto-build flag to autoBuild
. Each gadget that inherits from this class must call the function firstBuild
in its constructor code. The function firstBuild
calls the functions to browse the data sources and displays the result if the auto-build flag is IlTrue
.
- Parameters
-
autoBuild | If IlTrue , the auto-build mode is on. |
◆ addDataSource()
virtual void IliRepositoryService::addDataSource |
( |
IliDataSource * |
ds | ) |
|
|
virtual |
◆ build()
virtual void IliRepositoryService::build |
( |
| ) |
|
|
virtual |
Manages data source browsing.
Browsing involves the following three steps:
-
Before: calls the function
justBeforeBuild
.
-
During: calls the function
addDataSource
for each valid data source which has a valid holder.
-
After: calls the function
justAfterBuild
.
◆ filterOn()
Defines the filter for the holder type.
There are three types of holders: Container, Composite, and Manager. This filter goes through data sources by holder type.
- Parameters
-
◆ firstBuild()
void IliRepositoryService::firstBuild |
( |
| ) |
|
Calls the function build
if the auto-build flag is at IlTrue
, otherwise it does nothing.
All gadgets inheriting from this class must call this function from its constructor.
◆ GetDataSourceBitmap()
Returns the bitmap of the data sources that are not global.
- Returns
- The bitmap.
◆ GetGlobalDataSourceBitmap()
Returns the bitmap of the data sources that are global.
- Returns
- The bitmap.
◆ GetHolderBitmap()
Returns the bitmap of the holders.
- Returns
- The bitmap.
◆ GetHolderToNameCallback()
Returns the callback function used to get the holder's name.
- Returns
- The callback.
◆ getSelectedHolder()
◆ GetUntitledString()
static const char* IliRepositoryService::GetUntitledString |
( |
IlvDisplay * |
| ) |
|
|
static |
Returns the string Untitled
.
- Returns
- The string.
◆ holderToName()
Returns the holder name.
If a callback has been defined with the function SetHolderToNameCallback
this function returns the result of the callback function.
- Parameters
-
- Returns
- The name.
◆ isAutoBuild()
IlBoolean IliRepositoryService::isAutoBuild |
( |
| ) |
const |
Returns IlTrue
if the auto-build flag is on.
- Returns
IlTrue
if the auto-build flag is at IlTrue
, otherwise returns IlFalse
.
◆ isFilterOn()
Returns IlTrue
, if the filter is on a specific type.
- Parameters
-
- Returns
IlTrue
if the filter is on filter
. Otherwise this function returns IlFalse
.
◆ isValidHolder()
Returns IlTrue
if the holder is valid.
A holder is valid if these conditions are met:
-
The holder is not
null
.
-
The holder and filter type are the same.
- Returns
IlTrue
if the holder is valid.
◆ justAfterBuild()
virtual void IliRepositoryService::justAfterBuild |
( |
| ) |
|
|
virtual |
◆ justBeforeBuild()
virtual void IliRepositoryService::justBeforeBuild |
( |
| ) |
|
|
virtual |
◆ read()
Reads the data from the input file stream.
- Parameters
-
input | The input file stream. |
◆ SetHolderToNameCallback()
Sets the callback function used to get the holder's name.
- Parameters
-
◆ write()
Writes the data to an output file stream.
- Parameters
-
output | The output file stream. |