rwlogo
Rogue Wave Views 5.6

Rogue Wave Views
Data Access Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

IliDbTreeItemDialogModel Class Reference

Model class. More...

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

Inheritance diagram for IliDbTreeItemDialogModel:
IliModel

List of all members.

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).
IliDbTreeGadgetgetDbTreeGadget () const
 Returns the IliDbTreeGadget object which uses the model.
const char * getNewItemBitmap () const
 Returns the new item bitmap file name.
IlInt getNewItemDataSourceIndex () const
 Returns the data source index of the new item.
const IliValuegetNewItemIdentifier () const
 Returns the new item identifier.
const char * getNewItemLabel () const
 Returns the new item label.
const IliValuegetNewItemParent () const
 Returns the parent identifier of the new item.
void setNewItemBitmap (const char *bmp)
 Sets the new item bitmap file name.
void setNewItemIdentifier (const IliValue &val)
 Sets the new item identifier.
void setNewItemLabel (const char *label)
 Sets new item label.

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:
display The display.
view The view of the tree gadget.
edit If 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:
bmp The bitmap file name.
void IliDbTreeItemDialogModel::setNewItemIdentifier ( const IliValue val  ) 

Sets the new item identifier.

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

Sets new item label.

Parameters:
label The new label.
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends

© Copyright 2012, 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.