rwlogo
Rogue Wave Views 5.6

Rogue Wave Views
Data Access Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

IliDbTreePopupMenuModel Class Reference

Model class. More...

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

Inheritance diagram for IliDbTreePopupMenuModel:
IliModel

List of all members.

Public Member Functions

 IliDbTreePopupMenuModel ()
 The default constructor.
void addDeletePopupItem (const char *label=0) const
 Adds the popup menu item to delete the selected item.
void addEditPopupItem (const char *label=0) const
 Adds the popup menu item to edit the selected item.
void addInsertChildPopupItem (const char *label=0) const
 Adds the popup menu item to insert a child.
void addInsertSiblingPopupItem (const char *label=0) const
 Adds the popup menu item to insert a sibling.
void addPopupItem (const char *label, IlvGraphicCallback cb, IlAny arg=0) const
 Adds a popup menu item.
void addPopupSeparator () const
 Adds a popup menu item separator.
IliDbTreeGadgetgetDbTreeGadget () const
 Returns the IliDbTreeGadget object which uses the model.
IlBoolean isItemDeletionEnabled () const
 Returns IlTrue if the selected item can be deleted.
IlBoolean isItemEditionEnabled () const
 Returns IlTrue if the selected item can be edited.
IlBoolean isItemInsertionChildEnabled () const
 Returns IlTrue if the insertion of a child is possible.
IlBoolean isItemInsertionSiblingEnabled () const
 Returns IlTrue if the insertion of a sibling is possible.
virtual void makePopupMenu (IlvDisplay *display) const
 Called to creates the popup menu items of the popup menu.

Detailed Description

Model class.

Library: dbgadget

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

See also:
IliModel, IliDbTreeGadget.

Member Function Documentation

void IliDbTreePopupMenuModel::addDeletePopupItem ( const char *  label = 0  )  const

Adds the popup menu item to delete the selected item.

Parameters:
label The popup menu item label. If it is NULL, the default label is used.
void IliDbTreePopupMenuModel::addEditPopupItem ( const char *  label = 0  )  const

Adds the popup menu item to edit the selected item.

Parameters:
label The popup menu item label. If it is NULL, the default label is used.
void IliDbTreePopupMenuModel::addInsertChildPopupItem ( const char *  label = 0  )  const

Adds the popup menu item to insert a child.

Parameters:
label The popup menu item label. If it is NULL, the default label is used.
void IliDbTreePopupMenuModel::addInsertSiblingPopupItem ( const char *  label = 0  )  const

Adds the popup menu item to insert a sibling.

Parameters:
label The popup menu item label. If it is NULL, the default label is used.
void IliDbTreePopupMenuModel::addPopupItem ( const char *  label,
IlvGraphicCallback  cb,
IlAny  arg = 0 
) const

Adds a popup menu item.

Parameters:
label The label.
cb The callback which is called when the popup menu item is chosen.
arg The user data.
IliDbTreeGadget* IliDbTreePopupMenuModel::getDbTreeGadget (  )  const

Returns the IliDbTreeGadget object which uses the model.

Returns:
The IliDbTreeGadget object.
IlBoolean IliDbTreePopupMenuModel::isItemDeletionEnabled (  )  const

Returns IlTrue if the selected item can be deleted.

Returns:
IlTrue if the selected item can be deleted.
IlBoolean IliDbTreePopupMenuModel::isItemEditionEnabled (  )  const

Returns IlTrue if the selected item can be edited.

Returns:
IlTrue if the selected item can be edited.
IlBoolean IliDbTreePopupMenuModel::isItemInsertionChildEnabled (  )  const

Returns IlTrue if the insertion of a child is possible.

Returns:
IlTrue if the insertion of a child is possible.
IlBoolean IliDbTreePopupMenuModel::isItemInsertionSiblingEnabled (  )  const

Returns IlTrue if the insertion of a sibling is possible.

Returns:
IlTrue if the insertion of a sibling is possible.
virtual void IliDbTreePopupMenuModel::makePopupMenu ( IlvDisplay display  )  const [virtual]

Called to creates the popup menu items of the popup menu.

To create the popup menu, you should use the add....PopupItem functions.

Parameters:
display The display.
 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.