IliTreeSQLTablesGadget Class Reference

Gadget class. More...

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

Inheritance diagram for IliTreeSQLTablesGadget:

List of all members.

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).
virtual void	build ()
	Builds the tree then displays it.
const char *	getOwner () const
	Returns the owner's name.
IliSQLSession *	getSession () const
	Returns the SQL session that is used to communicate with the database.
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.
void	setSession (IliSQLSession *session)
	Sets the session that is used to communicate with the database.

---

Detailed Description

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.

See also:

IliRepositoryService.

---

Constructor & Destructor Documentation

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).

Parameters:

	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.

---

Member Function Documentation

virtual void IliTreeSQLTablesGadget::build

(

)

[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.

Returns:

The name.

IliSQLSession* IliTreeSQLTablesGadget::getSession

(

)

const

Returns the SQL session that is used to communicate with the database.

Returns:

The session.

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.

Parameters:

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.

Parameters:

session

The SQL session.