Rogue Wave Views
Foundation Package API Reference Guide
Product Documentation:

Rogue Wave Views
Documentation Home
List of all members | Public Member Functions
IlvToolTipHandler Class Referenceabstract

Tooltip handler class. More...

#include <ilviews/graphics/tooltip.h>

Inheritance diagram for IlvToolTipHandler:
IlvViewHandler IlvGraphicHolderToolTipHandler

Public Member Functions

 IlvToolTipHandler (IlvView *view=0)
 Constructor. More...
 
IlvGraphicgetLastPointedGraphic () const
 Returns a pointer to the last IlvGraphic object returned by lastContains(). More...
 
virtual void handleInput (IlvEvent &event)
 Is called when the view observed by the view handler receives an input event. More...
 
virtual IlvGraphiclastContains (const IlvPoint &point) const =0
 Is called to find the IlvGraphic object located at the specified point. More...
 
virtual void setView (IlvView *view)
 Sets the view object observed by the view handler. More...
 
virtual void viewDeleted ()
 Is called when the view observed by the view handler is deleted. More...
 
- Public Member Functions inherited from IlvViewHandler
IlUInt getMask () const
 Returns the event mask of the view handler. More...
 
IlvViewgetView () const
 Returns the view object observed by the view handler. More...
 
virtual void handleDestroy ()
 Is called when the view observed by the view handler is being destroyed. More...
 
virtual void handleExpose (IlvEvent &event)
 Is called when the view observed by the view handler receives an expose event. More...
 
virtual void handleResize (const IlvRect &rect)
 Is called when the view observed by the view handler is resized. More...
 
void setMask (IlUInt mask)
 Sets the event mask of the view handler. More...
 

Additional Inherited Members

- Public Types inherited from IlvViewHandler
enum  EventType {
  NoEvent, InputEvent, ExposeEvent, ResizeEvent,
  DestroyEvent
}
 This enumeration defines the possible values for the event mask of an IlvViewHandler object. More...
 

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::IlvToolTipHandler ( IlvView view = 0)

Constructor.

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

Parameters
viewThe view connected with this tooltip handler.

Member Function Documentation

§ getLastPointedGraphic()

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().

§ handleInput()

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
eventThe input event.
See also
IlvEvent.

Reimplemented from IlvViewHandler.

§ lastContains()

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
pointThe point in view coordinates.

Implemented in IlvGraphicHolderToolTipHandler.

§ setView()

virtual void IlvToolTipHandler::setView ( IlvView view)
virtual

Sets the view object observed by the view handler.

Parameters
viewThe new view object observed by the view handler.
See also
setView()

Reimplemented from IlvViewHandler.

§ viewDeleted()

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 2018, 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.