VXPLib Documentation: COM
IVXPTooltip
IVXPTooltip implements a tooltip window with customizable appearance, shape and behavour. The tooltip window draws its contents by using interface IVXPQuickHTML. The instance of IVXPQuickHTML used for drawing is accessible through property html of the interface. Using this interface directly instead of through IVXPTooltipManager gives the client application full control over displaying tooltips - it is possible to specify every time where and how to show/hide the tooltip window. In other words, IVXPTooltip represents a low level of working with tooltips.
MethodsDescription
Show Shows the tooltip window at the current mouse cursor position.
ShowAt Show the tooltip window at the specified {x,y} position.
Hide Hides the tooltip window.
Create Creates the tooltip window explicitly for easier handling WM_CREATE, WM_NCCREATE and subsequent events through OnWndMsg.
Destroy Destroys the tooltip window explicitly to be able to handle events WM_DESTROY and WM_NCDESTROY via OnWndMsg.
Subscribe Subscribes the tooltip for a window event that will be called through OnWndMsg with up to 20 events at the same time.
UnSubscribe Unsubscribes the tooltip from a window event called through OnWndMsg. Passing 0 will unsubscrive from all events at once.
DefWndProc Calls the default window procedure of the tooltip window. It can only be called within a handler of event OnWndMsg.

PropertiesDescription
Autohide Indicates whether or not the tooltip window must hide itself automatically whenever the mouse cursor moves.
FadeShow Length in milliseconds of the fading effect when the tooltip is being shown.
FadeHide Length in milliseconds of the fading effect when the tooltip is being hidden.
Transparency The level of the tooltip window transparency when it acquires its state ttsShown.
HasTail Specifies whether the tooltip has a triangular quote tail that points at the mouse cursor.
Round Defines how much corners of the tooltip are rounded.
State Current state of the tooltip window.
HasBorder Specifies whether the tooltip window has a border around it.
BorderColor Specifies color for the tooltip's border, if such presents.
HasShadow Specifies whether the tooltip will have a shadow on Windows XP.
TraceMode Specifies whether the tooltip window must follow the mouse cursor whenever it moves.
ShowWhenEmpty Specifies whether the tooltip window must be shown even when its contents is empty.
hWnd Handle of the tooltip window.
FadeSound Specifies how many times the sound effect must be adjusted while the tooltip is being shown or hidden.
Theme Selects a tooltip theme to be active.
MouseClickResponse Specifies behavior of the tooltip window in response to any mouse-click event.

All events described in the following table are available through interface _IVXPTooltipEvents. The present VXPLib Documentation doesn't consider event interfaces separately from the main interface, and, therefore methods of such event interface represented here for simplicity as events of the IVXPTooltip interface.
EventsDescription
OnStateChanged Notifies the client about the tooltip window having changed its state.
OnSoundPlay Called to initiate a sound effect when the tooltip is shown.
OnSoundAdjust Notifies the client to adjust the sound according to the current fading percent of the tooltip window.
OnSoundStop Notifies the client that any sound effect associated with the tooltip window must be ceased.
OnWndMsg Notifies the client with a subscribed tooltip window message.
OnMouseClick Notifies the client about mouse-click events.

This document was last updated on 27/05/2003
Copyright © 2003 Tooltips.NET