IlvManagerMakeStringInteractor Class Reference

Manager view interactor class. More...

#include <ilviews/gadmgr/strinter.h>

Inheritance diagram for IlvManagerMakeStringInteractor:

Public Member Functions
	IlvManagerMakeStringInteractor (IlvManager *manager, IlvView *view)
	Constructor. More...
virtual void	abort ()
	Aborts the interaction. More...
virtual IlBoolean	accept (IlvPoint &p)
	Called to start the interaction with the text field object. More...
virtual void	doIt (const char *label)=0
	Finalizes the interaction. More...
const char *	getLabel ()
	Returns the string being edited. More...
IlBoolean	handleEvent (IlvEvent &event)
	Handles events for the manager view. More...
void	handleExpose (IlvRegion *clip)
	Called when the manager view receives an expose event. More...
void	reDraw ()
	Redraws the text field.
void	setLabel (const char *label, IlBoolean redraw=IlTrue)
	Sets the contents of the text field to the specified string. More...
Public Member Functions inherited from IlvManagerViewInteractor
	IlvManagerViewInteractor (IlvManager *manager, IlvView *view)
	Initializes a new IlvManagerViewInteractor. More...
virtual void	drawGhost ()
	Visual feedback during the interaction. More...
virtual void	ensureVisible (const IlvPoint &point)
	Ensures the visibility of a given location. More...
IlvDisplay *	getDisplay () const
	Returns the display of the manager view. More...
IlvManager *	getManager () const
	Returns the manager. More...
IlvTransformer *	getTransformer () const
	Returns the transformer used with the manager view. More...
IlvView *	getView () const
	Returns the manager view. More...
virtual void	init ()
	Initialization, when the interactor is attached to a view. More...

Detailed Description

Manager view interactor class.

Library: ilvgadmgr

The IlvManagerMakeStringInteractor abstract class creates new single-line text entities, or edits single-line text objects. The interactor creates a text field object when the user presses the left mouse button in the view to which this interactor is connected. The user can then enter a new string.

See also

IlvLabel, IlvListLabel, IlvManagerMakeLabelInteractor, IlvManagerMakeListLabelInteractor, IlvStringList, IlvText.

Constructor & Destructor Documentation

IlvManagerMakeStringInteractor::IlvManagerMakeStringInteractor	(	IlvManager *	manager,
		IlvView *	view
	)

Constructor.

Calls the constructor of the superclass and initializes the interactor.

Parameters

manager	The manager.
view	The manager view.

Member Function Documentation

virtual void IlvManagerMakeStringInteractor::abort ( )

virtual

Aborts the interaction.

Called by the manager when the user changes the current interactor. It resets the interactor to a state in which it appears to have never been launched. A common implementation is to erase the ghost image. Call this member function to inhibit the interactor action in particular circumstances.

Reimplemented from IlvManagerViewInteractor.

virtual IlBoolean IlvManagerMakeStringInteractor::accept ( IlvPoint &  p )

virtual

Called to start the interaction with the text field object.

Called when the user presses the left mouse button in the working view. The default implementation creates the text field and returns IlTrue. If you create subtypes of this class, always call this function to create the text field.

Returns

IlTrue if the interactor accepts the point as a valid position to start the interaction.

Reimplemented in IlvManagerMakeLabelInteractor.

virtual void IlvManagerMakeStringInteractor::doIt ( const char *  label )

pure virtual

Finalizes the interaction.

Called when the user validates the text field. This function declaration makes this class a pure abstract class.

Parameters

label

The string contained in the text field.

Implemented in IlvManagerMakeLabelInteractor.

const char* IlvManagerMakeStringInteractor::getLabel

(

)

Returns the string being edited.

Returns

The current edited label.

IlBoolean IlvManagerMakeStringInteractor::handleEvent ( IlvEvent &  event )

virtual

Handles events for the manager view.

Called by the manager for which the interactor was created with every event it receives in the interactor view.

Returns

IlTrue if the event is consumed, IlFalse otherwise.

Implements IlvManagerViewInteractor.

void IlvManagerMakeStringInteractor::handleExpose ( IlvRegion *  clip )

virtual

Called when the manager view receives an expose event.

Called by the manager when an exposure request occurs in the interactor view to redraw shapes handled by the interactor, such as a ghost image. The basic implementation calls the member function IlvManagerViewInteractor::drawGhost() after the clipping region has been set to the exposed area.

Parameters

clip	Specifies the exposed area.

Reimplemented from IlvManagerViewInteractor.

void IlvManagerMakeStringInteractor::setLabel	(	const char *	label,
		IlBoolean	redraw = IlTrue
	)

Sets the contents of the text field to the specified string.

Parameters

label	The new string.
redraw	If set to IlTrue, the text field object is redrawn.