rwlogo
Rogue Wave Views 5.6

Rogue Wave Views
Foundation Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

List of all members | Public Member Functions | Static Public Member Functions
IlvGraphicHolderToolTipHandler Class Reference

Tooltip handler class. More...

#include <ilviews/graphics/tooltip.h>

Inheritance diagram for IlvGraphicHolderToolTipHandler:
IlvToolTipHandler IlvViewHandler

Public Member Functions

 IlvGraphicHolderToolTipHandler ()
 Constructor. More...
 
IlvGraphicHoldergetGraphicHolder () const
 Returns the graphic holder associated with the tooltip handler. More...
 
virtual IlvGraphiclastContains (const IlvPoint &point) const
 Is called to find the IlvGraphic object located at the specified point. More...
 
- Public Member Functions inherited from IlvToolTipHandler
 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 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...
 

Static Public Member Functions

static
IlvGraphicHolderToolTipHandler
Get (const IlvView *view)
 Returns the tooltip handler instance associated with the specified view. More...
 
static
IlvGraphicHolderToolTipHandler
Set (IlvView *view, IlvGraphicHolderToolTipHandler *handler)
 Sets the specified tooltip handler to the specified view. 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 IlvGraphicHolderToolTipHandler manages tooltips in a view connected to an IlvGraphicHolder object ( (IlvContainer objects or IlvView objects connected to an IlvManager).

See Also
IlvToolTip, IlvView, IlvGraphicHolder

Constructor & Destructor Documentation

IlvGraphicHolderToolTipHandler::IlvGraphicHolderToolTipHandler ( )

Constructor.

Initializes a new instance of the class IlvGraphicHolderToolTipHandler. To connect it to a view, use the IlvGraphicHolderToolTipHandler::Set static member function.

Member Function Documentation

static IlvGraphicHolderToolTipHandler* IlvGraphicHolderToolTipHandler::Get ( const IlvView view)
static

Returns the tooltip handler instance associated with the specified view.

Parameters
viewThe view.
Returns
The tooltip handler instance associated with view or 0 if there is none.
See Also
Set
IlvGraphicHolder* IlvGraphicHolderToolTipHandler::getGraphicHolder ( ) const

Returns the graphic holder associated with the tooltip handler.

Returns
The graphic holder associated with the tooltip handler.
virtual IlvGraphic* IlvGraphicHolderToolTipHandler::lastContains ( const IlvPoint point) const
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.

Implements IlvToolTipHandler.

static IlvGraphicHolderToolTipHandler* IlvGraphicHolderToolTipHandler::Set ( IlvView view,
IlvGraphicHolderToolTipHandler handler 
)
static

Sets the specified tooltip handler to the specified view.

Connects handler to view. If an instance of IlvToolTipHandler was already connected with view, it is removed, but not deleted.

Parameters
viewThe view.
Returns
The old tooltip handler instance, if any, 0 otherwise.
See Also
Get

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