rwlogo
Rogue Wave Views 5.5.1

Rogue Wave Views
Foundation Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

IlvToolTipHandler Class Reference

Tooltip handler class. More...

#include <ilviews/graphics/tooltip.h>

Inheritance diagram for IlvToolTipHandler:
IlvViewHandler IlvGraphicHolderToolTipHandler

List of all members.

Public Member Functions

 IlvToolTipHandler (IlvView *view=0)
 Constructor.
IlvGraphicgetLastPointedGraphic () const
 Returns a pointer to the last IlvGraphic object returned by lastContains.
virtual void handleInput (IlvEvent &event)
 Is called when the view observed by the view handler receives an input event.
virtual IlvGraphiclastContains (const IlvPoint &point) const =0
 Is called to find the IlvGraphic object located at the specified point.
virtual void setView (IlvView *view)
 Sets the view object observed by the view handler.
virtual void viewDeleted ()
 Is called when the view observed by the view handler is deleted.

Detailed Description

Tooltip handler class.

Library: views

The class IlvToolTipHandler is an abstract class for handling tooltips. A tooltip handler can be set to any existing IlvView object. This handler installs an input callback on the specified view and tracks the IlvPointerMoved events to determine whether tooltips should be displayed. When subclassing IlvToolTipHandler, you must provide the implementation of the lastContains method. You can also use the predefined class IlvGraphicHolderToolTipHandler class that can be used to manage tooltips in a view connected to an IlvGraphicHolder instance (IlvContainer objects or IlvView objects connected to an IlvManager).

See also:
IlvToolTip, IlvView, IlvGraphicHolder, IlvGraphicHolderToolTipHandler

Constructor & Destructor Documentation

IlvToolTipHandler::IlvToolTipHandler ( IlvView view = 0  ) 

Constructor.

Initializes a new instance of the class IlvToolTipHandler connected to view.

Parameters:
view The view connected with this tooltip handler.

Member Function Documentation

IlvGraphic* IlvToolTipHandler::getLastPointedGraphic (  )  const

Returns a pointer to the last IlvGraphic object returned by lastContains.

Returns:
A pointer to the last IlvGraphic object returned by IlvToolTipHandler::lastContains.
virtual void IlvToolTipHandler::handleInput ( IlvEvent event  )  [virtual]

Is called when the view observed by the view handler receives an input event.

The default implementation does nothing.

Parameters:
event The input event.
See also:
IlvEvent.

Reimplemented from IlvViewHandler.

virtual IlvGraphic* IlvToolTipHandler::lastContains ( const IlvPoint point  )  const [pure virtual]

Is called to find the IlvGraphic object located at the specified point.

This method must be redefined in subclasses to return the graphic object located at point in the view associated with this tooltip handler.

Parameters:
point The point in view coordinates.

Implemented in IlvGraphicHolderToolTipHandler.

virtual void IlvToolTipHandler::setView ( IlvView view  )  [virtual]

Sets the view object observed by the view handler.

Parameters:
view The new view object observed by the view handler.
See also:
setView

Reimplemented from IlvViewHandler.

virtual void IlvToolTipHandler::viewDeleted (  )  [virtual]

Is called when the view observed by the view handler is deleted.

The default implementation does nothing.

Reimplemented from IlvViewHandler.


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