Rogue Wave Views Data Access Package API Reference Guide |
Rogue Wave Views Documentation Home |
Gadget class. More...
#include <ilviews/dataccess/gadgets/sqlrepvw.h>
Public Member Functions | |
IliTreeSQLTablesGadget (IlvDisplay *display, const IlvRect &rect, IliSQLSession *session=0, const char *owner=0, IlUShort thickness=IlvDefaultGadgetThickness, IlvPalette *palette=0) | |
Initializes a tree gadget to display the tables of one owner or all tables (when the owner is null ). More... | |
virtual void | build () |
Builds the tree then displays it. More... | |
const char * | getOwner () const |
Returns the owner's name. More... | |
IliSQLSession * | getSession () const |
Returns the SQL session that is used to communicate with the database. More... | |
IlBoolean | isSynonym (const char *name) const |
Specifies whether a given name recorded in the tree is a synonym or a basic table. Both table and synonym names are stored within the tree. This member function will tell for each names if it represents a basic table, or a synonym. | |
void | setOwner (const char *name) |
Sets the owner's name. More... | |
void | setSession (IliSQLSession *session) |
Sets the session that is used to communicate with the database. More... | |
Gadget class.
Library: dbsqlgad
The IliTreeSQLTablesGadget
class defines a tree gadget class that displays the tables of one owner or all the tables. For each table, the tree gadget can display the list of columns and the column type.
IliTreeSQLTablesGadget::IliTreeSQLTablesGadget | ( | IlvDisplay * | display, |
const IlvRect & | rect, | ||
IliSQLSession * | session = 0 , |
||
const char * | owner = 0 , |
||
IlUShort | thickness = IlvDefaultGadgetThickness , |
||
IlvPalette * | palette = 0 |
||
) |
Initializes a tree gadget to display the tables of one owner or all tables (when the owner is null
).
display | The display. |
rect | The location. |
session | The session used to communicate with the database. |
owner | The owner's name. |
thickness | The border thickness. |
palette | The palette. |
|
virtual |
Builds the tree then displays it.
When you change the session or the owner, you must call this function to rebuild the tree.
const char* IliTreeSQLTablesGadget::getOwner | ( | ) | const |
Returns the owner's name.
IliSQLSession* IliTreeSQLTablesGadget::getSession | ( | ) | const |
Returns the SQL session that is used to communicate with the database.
void IliTreeSQLTablesGadget::setOwner | ( | const char * | name | ) |
Sets the owner's name.
If the owner is null
, all the database tables are displayed. To rebuild the tree, you must call the function build
.
name | The owner name. |
void IliTreeSQLTablesGadget::setSession | ( | IliSQLSession * | session | ) |
Sets the session that is used to communicate with the database.
To rebuild the tree, you must call the function build
.
session | The SQL session. |
© 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.