rwlogo
Rogue Wave Views 5.6

Rogue Wave Views
Gadgets Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

IlvDefaultMatrixItemEditor Class Reference

Matrix Item Editor class. More...

#include <ilviews/gadgets/matrix.h>

Inheritance diagram for IlvDefaultMatrixItemEditor:
IlvMatrixItemEditor

List of all members.

Public Member Functions

 IlvDefaultMatrixItemEditor (IlvMatrix *matrix, IlUShort col, IlUShort row, IlvTextField *tfd=0)
 Constructor.
virtual void applyTo () const
 Is called to apply the editor value into the matrix.
IlvTextFieldgetTextField () const
 Returns the text field used for editing.
virtual void initFrom () const
 Is called to initialize the editor.

Detailed Description

Matrix Item Editor class.

Library: ilvadvgdt

The default matrix item editor used by the matrix. This editor uses a text field to edit matrix items.

See also:
IlvMatrixItemEditorFactory.

Constructor & Destructor Documentation

IlvDefaultMatrixItemEditor::IlvDefaultMatrixItemEditor ( IlvMatrix matrix,
IlUShort  col,
IlUShort  row,
IlvTextField tfd = 0 
)

Constructor.

Parameters:
matrix The matrix where the editor will be used for editing.
col The column of the matrix where the editor will be used for editing.
tfd The text field that will be used for editing. This parameter can be omitted. In this case, an IlvTextField instance will be automatically created by calling the IlvMatrix::createEditionField method.
row The row of the matrix where the editor will be used for editing.

Member Function Documentation

virtual void IlvDefaultMatrixItemEditor::applyTo (  )  const [virtual]

Is called to apply the editor value into the matrix.

The implementation must change the edited matrix item using the editor field.

See also:
getMatrix, getColumn, getRow.

Implements IlvMatrixItemEditor.

IlvTextField* IlvDefaultMatrixItemEditor::getTextField (  )  const

Returns the text field used for editing.

Returns:
The text field used for editing.
virtual void IlvDefaultMatrixItemEditor::initFrom (  )  const [virtual]

Is called to initialize the editor.

The implementation must initialize the editor field using the data located in the matrix.

See also:
getMatrix, getColumn, getRow.

Implements IlvMatrixItemEditor.

 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

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