rwlogo
Rogue Wave Views 5.5.1

Rogue Wave Views
Foundation Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

IlvGraphicHolderToolTipHandler Class Reference

Tooltip handler class. More...

#include <ilviews/graphics/tooltip.h>

Inheritance diagram for IlvGraphicHolderToolTipHandler:
IlvToolTipHandler IlvViewHandler

List of all members.

Public Member Functions

 IlvGraphicHolderToolTipHandler ()
 Constructor.
IlvGraphicHoldergetGraphicHolder () const
 Returns the graphic holder associated with the tooltip handler.
virtual IlvGraphiclastContains (const IlvPoint &point) const
 Is called to find the IlvGraphic object located at the specified point.

Static Public Member Functions

static
IlvGraphicHolderToolTipHandler
Get (const IlvView *view)
 Returns the tooltip handler instance associated with the specified view.
static
IlvGraphicHolderToolTipHandler
Set (IlvView *view, IlvGraphicHolderToolTipHandler *handler)
 Sets the specified tooltip handler to the specified view.

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:
view The 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:
point The 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:
view The 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.