Rogue Wave Views Data Access Package API Reference Guide |
Rogue Wave Views Documentation Home |
Gadget class. More...
#include <ilviews/dataccess/gadgets/repview.h>
Public Member Functions | |
IliTreeClassesGadget (IlvDisplay *display, const IlvRect &rect, IlBoolean enableExpand=IlFalse, IlUShort thickness=IlvDefaultGadgetThickness, IlvPalette *palette=0) | |
Initializes a tree gadget to display a list of classes with their data if the parameter enableExpand is IlTrue . More... | |
virtual void | build () |
Builds the tree, then displays it. More... | |
void | enableExpand (IlBoolean enable) |
Enables or disables the display of data for the classes. More... | |
virtual char ** | getClassesList (IlInt &count) |
Returns the class names list. More... | |
IliGetClassesListCallback | getClassesListCallback () const |
Returns the callback used to get the list of classes. More... | |
IlAny | getClassesListCallbackData () const |
Returns the user data used to get the list of classes. More... | |
virtual char ** | getDataList (const char *cl, IlInt &count) |
Returns the list of data for a class. More... | |
IliGetDataListCallback | getDataListCallback () const |
Returns the callback used to get the list of data for a class. More... | |
IlAny | getDataListCallbackData () const |
Returns the user data used to get the list of data for a class. More... | |
IliTreeEventCallback | getDragDropCallback () |
Returns the callback used to handle the drag-and-drop event. More... | |
IlAny | getDragDropCallbackData () |
Returns the user data used to handle the drag-and-drop event. More... | |
IlBoolean | isExpandEnabled () const |
Returns the display status of data for the classes. More... | |
void | setClassesListCallback (IliGetClassesListCallback cb, IlAny any=0) |
Sets the callback used to get the list of classes. More... | |
void | setDataListCallback (IliGetDataListCallback cb, IlAny any=0) |
Sets the callback used to get the list of data for a class. More... | |
void | setDragDropCallback (IliTreeEventCallback cb, IlAny any=0) |
Sets the callback to handle the drag-and-drop event. More... | |
Gadget class.
Library: dbgadget
The IliTreeClassesGadget
class defines a tree gadget that displays the list of classes. For each class, the tree gadget can display the list of data. This class is a generic class. For example, it can be used to display a list of SQL tables (classes) and for each table, the list of columns with their type (data).
IliTreeClassesGadget::IliTreeClassesGadget | ( | IlvDisplay * | display, |
const IlvRect & | rect, | ||
IlBoolean | enableExpand = IlFalse , |
||
IlUShort | thickness = IlvDefaultGadgetThickness , |
||
IlvPalette * | palette = 0 |
||
) |
Initializes a tree gadget to display a list of classes with their data if the parameter enableExpand
is IlTrue
.
display | The display. |
rect | The location. |
enableExpand | The enable-expand flag. |
thickness | The border thickness. |
palette | The palette. |
|
virtual |
Builds the tree, then displays it.
If your list of classes or the data of a class changes, you must call this function to rebuild the tree. This function calls the function getClassesList
to build the list of classes.
void IliTreeClassesGadget::enableExpand | ( | IlBoolean | enable | ) |
Enables or disables the display of data for the classes.
enable | The display is enabled if the value is IlTrue . |
|
virtual |
Returns the class names list.
By default, this function calls the defined callback if there is one.
count | Contains the number of classes. |
IliGetClassesListCallback IliTreeClassesGadget::getClassesListCallback | ( | ) | const |
Returns the callback used to get the list of classes.
IlAny IliTreeClassesGadget::getClassesListCallbackData | ( | ) | const |
Returns the user data used to get the list of classes.
|
virtual |
Returns the list of data for a class.
By default, this function calls the defined callback if there is one. This function is called when you expand a class for the first time.
cl | The class name |
count | Contains the number of data. |
IliGetDataListCallback IliTreeClassesGadget::getDataListCallback | ( | ) | const |
Returns the callback used to get the list of data for a class.
IlAny IliTreeClassesGadget::getDataListCallbackData | ( | ) | const |
Returns the user data used to get the list of data for a class.
IliTreeEventCallback IliTreeClassesGadget::getDragDropCallback | ( | ) |
Returns the callback used to handle the drag-and-drop event.
IlAny IliTreeClassesGadget::getDragDropCallbackData | ( | ) |
Returns the user data used to handle the drag-and-drop event.
IlBoolean IliTreeClassesGadget::isExpandEnabled | ( | ) | const |
Returns the display status of data for the classes.
The default value is IlTrue
.
void IliTreeClassesGadget::setClassesListCallback | ( | IliGetClassesListCallback | cb, |
IlAny | any = 0 |
||
) |
Sets the callback used to get the list of classes.
cb | The callback. |
any | The user data. |
void IliTreeClassesGadget::setDataListCallback | ( | IliGetDataListCallback | cb, |
IlAny | any = 0 |
||
) |
Sets the callback used to get the list of data for a class.
cb | The callback. |
any | The user data. |
void IliTreeClassesGadget::setDragDropCallback | ( | IliTreeEventCallback | cb, |
IlAny | any = 0 |
||
) |
Sets the callback to handle the drag-and-drop event.
cb | The callback. |
any | The user data. |
© 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.