Rogue Wave Views
Gadgets Package API Reference Guide
Product Documentation:

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

Matrix Item Editor class. More...

#include <ilviews/gadgets/matrix.h>

Inheritance diagram for IlvDefaultMatrixItemEditor:
IlvMatrixItemEditor

Public Member Functions

 IlvDefaultMatrixItemEditor (IlvMatrix *matrix, IlUShort col, IlUShort row, IlvTextField *tfd=0)
 Constructor. More...
 
virtual void applyTo () const
 Is called to apply the editor value into the matrix. More...
 
IlvTextFieldgetTextField () const
 Returns the text field used for editing. More...
 
virtual void initFrom () const
 Is called to initialize the editor. More...
 
- Public Member Functions inherited from IlvMatrixItemEditor
 IlvMatrixItemEditor (IlvMatrix *matrix, IlUShort col, IlUShort row)
 Constructor. More...
 
virtual void cancel ()
 Cancels the editing. More...
 
IlUShort getColumn () const
 Returns the edited column. More...
 
IlvGraphicgetEditorField () const
 Returns the graphic object used to edit. More...
 
IlvMatrixgetMatrix () const
 Returns the matrix being edited. More...
 
IlUShort getRow () const
 Returns the edited row. More...
 
virtual IlBoolean handleEvent (IlvEvent &event)
 Is called by the matrix when an event occurs while editing. More...
 
virtual void validate ()
 Validates the editing. More...
 

Additional Inherited Members

- Protected Member Functions inherited from IlvMatrixItemEditor
void setEditorField (IlvGraphic *g)
 Sets the graphic object used to edit the item. More...
 

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
matrixThe matrix where the editor will be used for editing.
colThe column of the matrix where the editor will be used for editing.
tfdThe 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.
rowThe 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.


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