Rogue Wave Views Data Access Package API Reference Guide |
Rogue Wave Views Documentation Home |
Interface class. More...
#include <ilviews/dataccess/gadgets/repview.h>
Public Member Functions | |
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 | addDataSource (IliDataSource *ds) |
Called each time a valid data source has been found and must be displayed. 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... | |
virtual IlvGraphicHolder * | getSelectedHolder () |
Returns the holder selected into the gadget. 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... | |
virtual void | justAfterBuild () |
Called just after the data sources have been browsed. More... | |
virtual void | justBeforeBuild () |
Called just before data source browsing begins. 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... | |
Static Public Member Functions | |
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 | |
static IlvBitmap * | GetDataSourceBitmap (IlvDisplay *) |
Returns the bitmap of the data sources that are not global. More... | |
static IlvBitmap * | GetGlobalDataSourceBitmap (IlvDisplay *) |
Returns the bitmap of the data sources that are global. More... | |
static IlvBitmap * | GetHolderBitmap (IlvDisplay *) |
Returns the bitmap of the holders. More... | |
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::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::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
.
autoBuild | If IlTrue , the auto-build mode is on. |
|
virtual |
Called each time a valid data source has been found and must be displayed.
By default this function does nothing.
ds | The data source. |
Reimplemented in IliDataSourcesUsesGadget, IliTableRepositoryGadget, IliTreeRepositoryGadget, and IliSQLTablesUsesGadget.
|
virtual |
Manages data source browsing.
Browsing involves the following three steps:
justBeforeBuild
. addDataSource
for each valid data source which has a valid holder. justAfterBuild
. void IliRepositoryService::filterOn | ( | IliRepositFilterOn | filter | ) |
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.
filter | The filter type. |
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.
|
staticprotected |
Returns the bitmap of the data sources that are not global.
|
staticprotected |
Returns the bitmap of the data sources that are global.
|
staticprotected |
Returns the bitmap of the holders.
|
static |
Returns the callback function used to get the holder's name.
|
virtual |
Returns the holder selected into the gadget.
By default, this function returns 0
.
Reimplemented in IliDataSourcesUsesGadget, IliTableRepositoryGadget, IliTreeRepositoryGadget, and IliSQLTablesUsesGadget.
|
static |
Returns the string Untitled
.
const char* IliRepositoryService::holderToName | ( | IlvGraphicHolder * | holder | ) |
Returns the holder name.
If a callback has been defined with the function SetHolderToNameCallback
this function returns the result of the callback function.
holder | The holder. |
IlBoolean IliRepositoryService::isAutoBuild | ( | ) | const |
Returns IlTrue
if the auto-build flag is on.
IlTrue
if the auto-build flag is at IlTrue
, otherwise returns IlFalse
. IlBoolean IliRepositoryService::isFilterOn | ( | IliRepositFilterOn | filter | ) | const |
Returns IlTrue
, if the filter is on a specific type.
filter | The filter type. |
IlTrue
if the filter is on filter
. Otherwise this function returns IlFalse
. IlBoolean IliRepositoryService::isValidHolder | ( | IlvGraphicHolder * | , |
IlBoolean | = IlTrue |
||
) | const |
Returns IlTrue
if the holder is valid.
A holder is valid if these conditions are met:
null
. IlTrue
if the holder is valid.
|
virtual |
Called just after the data sources have been browsed.
By default this function does nothing.
Reimplemented in IliDataSourcesUsesGadget, IliTableRepositoryGadget, IliTreeRepositoryGadget, and IliSQLTablesUsesGadget.
|
virtual |
Called just before data source browsing begins.
By default this function does nothing.
Reimplemented in IliDataSourcesUsesGadget, IliTableRepositoryGadget, IliTreeRepositoryGadget, and IliSQLTablesUsesGadget.
void IliRepositoryService::read | ( | IlvInputFile & | input | ) |
Reads the data from the input file stream.
input | The input file stream. |
|
static |
Sets the callback function used to get the holder's name.
cb | The callback. |
void IliRepositoryService::write | ( | IlvOutputFile & | output | ) | const |
Writes the data to an output file stream.
output | The output file stream. |
© Copyright 2016, Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.