Rogue Wave Views
Data Access Package API Reference Guide
Product Documentation:

Rogue Wave Views
Documentation Home
List of all members | Public Member Functions
IliDbTreeItemDialogModel Class Reference

Model class. More...

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

Inheritance diagram for IliDbTreeItemDialogModel:
IliModel

Public Member Functions

 IliDbTreeItemDialogModel ()
 The default constructor.
 
virtual IlBoolean editValues (IlvDisplay *display, IlvAbstractView *view, IlBoolean edit)
 Called to display the dialog and to edit the data. You should use the setNewItem... functions to indicates the new values of the new item (if insertion) or the edited item (if editing). More...
 
IliDbTreeGadgetgetDbTreeGadget () const
 Returns the IliDbTreeGadget object which uses the model. More...
 
const char * getNewItemBitmap () const
 Returns the new item bitmap file name. More...
 
IlInt getNewItemDataSourceIndex () const
 Returns the data source index of the new item. More...
 
const IliValuegetNewItemIdentifier () const
 Returns the new item identifier. More...
 
const char * getNewItemLabel () const
 Returns the new item label. More...
 
const IliValuegetNewItemParent () const
 Returns the parent identifier of the new item. More...
 
void setNewItemBitmap (const char *bmp)
 Sets the new item bitmap file name. More...
 
void setNewItemIdentifier (const IliValue &val)
 Sets the new item identifier. More...
 
void setNewItemLabel (const char *label)
 Sets new item label. More...
 
- Public Member Functions inherited from IliModel
 IliModel ()
 The constructor initializes a new IliModel instance.
 
IlInt declareProperty (const IliDatatype *typ, const char *name, const char *title, IlBoolean pub)
 Declares a new property. More...
 
virtual void defineProperties ()
 Called to define the list of properties. More...
 
virtual const char * getLabel () const =0
 Returns the model label, it is used by the gadget inspector. More...
 
virtual const char * getMappingInspectorModelName () const
 Returns the mapping inspector model name. More...
 
virtual const char * getName () const
 Returns the model name. More...
 
IlInt getPropertyCount () const
 Returns the property count. More...
 
IlInt getPropertyIndex (const char *name) const
 Returns a property index. More...
 
const char * getPropertyName (IlInt index) const
 Returns a property name. More...
 
const IliValuegetPropertyValue (const char *name) const
 Returns a property value. More...
 
const IliValuegetPropertyValue (IlInt index) const
 Returns a property value. More...
 
virtual IlBoolean isPublic () const
 Returns the model visibility. More...
 
void setPropertyValue (const char *name, const IliValue &val)
 Sets a property value. More...
 
void setPropertyValue (IlInt index, const IliValue &val)
 Sets a property value. More...
 

Detailed Description

Model class.

Library: dbgadget

This class of model is used by the IliDbTreeGadget to display a dialog. This dialog is used to edit or to create a tree item. If you want to change the dialog, you must create a sub-class of this class and register it (see macro IliRegisterDbTreeItemDialogModel). After you can use the setItemDialogModelName function to specify your dialog model to your IliDbTreeGadget object.

See also
IliModel, IliDbTreeGadget.

Member Function Documentation

virtual IlBoolean IliDbTreeItemDialogModel::editValues ( IlvDisplay display,
IlvAbstractView view,
IlBoolean  edit 
)
virtual

Called to display the dialog and to edit the data. You should use the setNewItem... functions to indicates the new values of the new item (if insertion) or the edited item (if editing).

The data source index and the parent identifier of one item can not change.

Parameters
displayThe display.
viewThe view of the tree gadget.
editIf IlTrue, the dialog is called to edit, otherwise to insert.
Returns
IlTrue if successful.
IliDbTreeGadget* IliDbTreeItemDialogModel::getDbTreeGadget ( ) const

Returns the IliDbTreeGadget object which uses the model.

Returns
The IliDbTreeGadget object.
const char* IliDbTreeItemDialogModel::getNewItemBitmap ( ) const

Returns the new item bitmap file name.

Returns
The file name.
IlInt IliDbTreeItemDialogModel::getNewItemDataSourceIndex ( ) const

Returns the data source index of the new item.

Returns
The index.
const IliValue& IliDbTreeItemDialogModel::getNewItemIdentifier ( ) const

Returns the new item identifier.

Returns
The identifier.
const char* IliDbTreeItemDialogModel::getNewItemLabel ( ) const

Returns the new item label.

Returns
The label.
const IliValue& IliDbTreeItemDialogModel::getNewItemParent ( ) const

Returns the parent identifier of the new item.

Returns
The identifier.
void IliDbTreeItemDialogModel::setNewItemBitmap ( const char *  bmp)

Sets the new item bitmap file name.

Parameters
bmpThe bitmap file name.
void IliDbTreeItemDialogModel::setNewItemIdentifier ( const IliValue val)

Sets the new item identifier.

Parameters
valThe new identifier.
void IliDbTreeItemDialogModel::setNewItemLabel ( const char *  label)

Sets new item label.

Parameters
labelThe new label.

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